summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/glossaries
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-07-23 21:07:56 +0000
committerKarl Berry <karl@freefriends.org>2018-07-23 21:07:56 +0000
commit1e9c91674124fe8a6274515c661e0ee5e0582bf4 (patch)
tree66270c56225a11a8f56b0b587db55d6154583723 /Master/texmf-dist/source/latex/glossaries
parent52ec2695fa42fcdb25837a134919d298f848f41d (diff)
glossaries (23jul18)
git-svn-id: svn://tug.org/texlive/trunk@48258 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/glossaries')
-rw-r--r--Master/texmf-dist/source/latex/glossaries/glossaries.dtx314
-rw-r--r--Master/texmf-dist/source/latex/glossaries/glossaries.ins2
2 files changed, 224 insertions, 92 deletions
diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
index 5868f244d56..687c7b54bff 100644
--- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
+++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
@@ -1,16 +1,18 @@
%\iffalse
% glossaries.dtx generated using makedtx version 1.2 (c) Nicola Talbot
% Command line args:
+% -comment ".*\.perl"
+% -comment ".*\.tex"
+% -comment ".*\.xdy"
+% -codetitle "Main Package Code"
+% -doc "glossaries-manual.tex"
% -macrocode ".*\.perl"
% -macrocode ".*\.tex"
% -macrocode ".*\.xdy"
-% -codetitle "Main Package Code"
-% -doc "glossaries-manual.tex"
+% -setambles ".*\.perl=>\nopreamble\nopostamble"
+% -setambles ".*\.tex=>\nopreamble\nopostamble"
+% -setambles ".*\.xdy=>\nopreamble\nopostamble"
% -section "chapter"
-% -author "Nicola Talbot"
-% -comment ".*\.perl"
-% -comment ".*\.tex"
-% -comment ".*\.xdy"
% -src "glossaries\.sty\Z=>glossaries.sty"
% -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty"
% -src "(glossary-.+)\.(sty)\Z=>\1.\2"
@@ -27,11 +29,9 @@
% -src "(samplexdy-mc.*\.xdy)\Z=>\1"
% -src "(database.*\.tex)\Z=>\1"
% -src "(.*\.perl)\Z=>\1"
-% -setambles ".*\.perl=>\nopreamble\nopostamble"
-% -setambles ".*\.tex=>\nopreamble\nopostamble"
-% -setambles ".*\.xdy=>\nopreamble\nopostamble"
+% -author "Nicola Talbot"
% glossaries
-% Created on 2018/6/1 13:57
+% Created on 2018/7/23 12:54
%\fi
%\iffalse
%<*package>
@@ -145,7 +145,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
\setcounter{IndexColumns}{2}
-\CheckSum{19428}
+\CheckSum{19510}
\newcommand*{\ifirstuse}{\iterm{first use}}
\newcommand*{\firstuse}{\gls{firstuse}}
@@ -172,12 +172,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%\fi
%\MakeShortVerb{"}
%
-% \title{Documented Code For glossaries v4.40}
+% \title{Documented Code For glossaries v4.41}
% \author{Nicola L.C. Talbot\\[10pt]
%Dickimaw Books\\
%\url{http://www.dickimaw-books.com/}}
%
-% \date{2018-06-01}
+% \date{2018-07-23}
% \maketitle
%
%This is the documented code for the \styfmt{glossaries} package.
@@ -193,7 +193,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%glossaries package}.
%
%\item[\url{glossaries-user.pdf}]
-%For the main user guide, read \qt{glossaries.sty v4.40:
+%For the main user guide, read \qt{glossaries.sty v4.41:
%\LaTeX2e\ Package to Assist Generating Glossaries}.
%
%\item[\url{mfirstuc-manual.pdf}]
@@ -248,7 +248,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
% This package requires \LaTeXe.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle}
% Required packages:
@@ -347,10 +347,13 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%\changes{4.24}{2016-05-27}{new}
% Switch on debug mode. This will also cancel the \pkgopt{nowarn}
% option. This is now a choice key.
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@debug@val} and \cs{gls@debug@nr}}
% \begin{macrocode}
\newif\if@gls@debug
-\define@choicekey{glossaries.sty}{debug}[\val\nr]{true,false,showtargets}[true]{%
- \ifcase\nr\relax
+\define@choicekey{glossaries.sty}{debug}[\gls@debug@val\gls@debug@nr]%
+ {true,false,showtargets}[true]{%
+ \ifcase\gls@debug@nr\relax
\@gls@debugtrue
\renewcommand*{\GlossariesWarning}[1]{%
\PackageWarning{glossaries}{##1}%
@@ -430,9 +433,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%\end{macro}
%\begin{option}{seenoindex}
%\changes{4.24}{2016-05-27}{new}
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@seenoindex@val} and \cs{gls@seenoindex@nr}}
% \begin{macrocode}
-\define@choicekey{glossaries.sty}{seenoindex}[\val\nr]{error,warn,ignore}{%
- \ifcase\nr
+\define@choicekey{glossaries.sty}{seenoindex}%
+ [\gls@seenoindex@val\gls@seenoindex@nr]{error,warn,ignore}{%
+ \ifcase\gls@seenoindex@nr
\renewcommand*{\@gls@see@noindex}{%
\PackageError{glossaries}%
{`\gls@xr@key' key may only be used after \string\makeglossaries\space
@@ -519,10 +525,13 @@ subsection,subsubsection,paragraph,subparagraph}[section]{%
%\begin{option}{numberedsection}
%\changes{1.1}{2008-02-22}{numberedsection package option added}
%\changes{4.02}{2013-12-05}{added nameref option}
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@numberedsection@val} and \cs{gls@numberedsection@nr}}
% \begin{macrocode}
-\define@choicekey{glossaries.sty}{numberedsection}[\val\nr]{%
+\define@choicekey{glossaries.sty}{numberedsection}%
+ [\gls@numberedsection@val\gls@numberedsection@nr]{%
false,nolabel,autolabel,nameref}[nolabel]{%
- \ifcase\nr\relax
+ \ifcase\gls@numberedsection@nr\relax
\renewcommand*{\@@glossarysecstar}{*}%
\renewcommand*{\@@glossaryseclabel}{}%
\or
@@ -1956,11 +1965,14 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\changes{1.1}{2008-02-22}{translate option added}
% Define \pkgopt{translate} option. If false don't set up
% multi-lingual support.
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@translate@val} and \cs{gls@translate@nr}}
% \begin{macrocode}
-\define@choicekey{glossaries.sty}{translate}[\val\nr]%
+\define@choicekey{glossaries.sty}{translate}%
+ [\gls@translate@val\gls@translate@nr]%
{true,false,babel}[true]%
{%
- \ifcase\nr\relax
+ \ifcase\gls@translate@nr\relax
\glstranslatetrue
\renewcommand*\@gls@usetranslator{%
\@ifpackageloaded{polyglossia}%
@@ -2302,6 +2314,120 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \end{macrocode}
%\end{option}
%
+%\begin{macro}{\gls@original@makeglossary}
+%Store the original definition.
+%\changes{4.41}{2018-07-23}{new}
+% \begin{macrocode}
+\let\gls@original@makeglossary\makeglossary
+% \end{macrocode}
+%\end{macro}
+%
+%\begin{macro}{\gls@original@glossary}
+%Store the original definition.
+%\changes{4.41}{2018-07-23}{new}
+% \begin{macrocode}
+\let\gls@original@glossary\glossary
+% \end{macrocode}
+%\end{macro}
+%
+%\begin{macro}{\makeglossary}
+% The \cs{makeglossary} command is redefined to be
+% identical to \cs{makeglossaries}. (This is done partly to
+% reinforce the message that you must either use
+% \cs{@makeglossary} for all the glossaries or for none
+% of them, but is also a legacy from the old \styfmt{glossary} package.)
+%\changes{4.41}{2018-07-23}{added warning}
+% \begin{macrocode}
+\def\makeglossary{%
+ \GlossariesWarning{Use of \string\makeglossary\space with
+ glossaries.sty is \MessageBreak deprecated. Use \string\makeglossaries\space
+ instead. If you \MessageBreak need the original definition of
+ \string\makeglossary\space use \MessageBreak the package options
+ kernelglossredefs=false (to \MessageBreak restore the former definition of
+ \string\makeglossary) and \MessageBreak nomain (if the file extensions cause a
+ conflict)}%
+ \makeglossaries
+}
+% \end{macrocode}
+%\end{macro}
+%
+%\begin{macro}{\@gls@override@glossary}
+%\changes{4.41}{2018-07-23}{new}
+% \begin{macrocode}
+\newcommand*{\@gls@override@glossary}[1][main]{%
+ \GlossariesWarning{Use of \string\glossary\space with
+ glossaries.sty is deprecated. \MessageBreak Indexing should be performed
+ with the user level \MessageBreak commands, such as \string\gls\space or
+ \string\glsadd. If you need the \MessageBreak original definition of
+ \string\glossary\space use the package \MessageBreak options
+ kernelglossredefs=false (to restore the \MessageBreak former definition of
+ \string\glossary) and nomain (if the \MessageBreak file extensions cause a
+ conflict)}%
+ \gls@glossary{#1}%
+}
+% \end{macrocode}
+%\end{macro}
+%
+% In v4.10, the redefinition of \cs{glossary} was removed since it
+% was never intended as a user level command (and wasn't documented
+% in the user manual), however it seems there are packages that have
+% hacked the internal macros used by \styfmt{glossaries} and no longer
+% work with this redefinition removed, so it's been restored in v4.11
+% but is not used at all by \styfmt{glossaries}.
+% (This may be removed or moved to a compatibility mode in future.)
+% As from v4.41, the use of \cs{glossary} now triggers a warning.
+% The package option \pkgopt[nowarn]{kernelglossredefs} may be used to
+% remove the warning, but it's better not to use \cs{glossary}.
+%\begin{macro}{\glossary}
+%\changes{4.41}{2018-07-23}{added warning}
+% \begin{macrocode}
+\if@gls@docloaded
+\else
+ \def\glossary{\@gls@override@glossary}
+\fi
+% \end{macrocode}
+%\end{macro}
+%
+%\begin{option}{kernelglossredefs}
+%\changes{4.41}{2018-07-23}{new}
+%The \sty{glossaries} package redefines the kernel commands
+%\cs{makeglossary} and \cs{glossary} as a legacy action from the
+%former \sty{glossary} package. In hindsight that wasn't a good idea
+%as it's possible that the \sty{glossaries} package may need to be
+%used with another class or package that needs these commands.
+%Neither of these commands are documented in the main user manual
+%and their use is not encouraged. The preferred commands are
+%\cs{makeglossaries} (to open all associated glossary files) and
+%\cs{gls}, \cs{glstext} etc or \cs{glsadd} for indexing.
+% \begin{macrocode}
+\define@choicekey{glossaries.sty}{kernelglossredefs}%
+ [\gls@debug@val\gls@debug@nr]{true,false,nowarn}[true]%
+{%
+ \ifcase\gls@debug@nr\relax
+ \def\glossary{\@gls@override@glossary}%
+ \def\makeglossary{%
+ \GlossariesWarning{Use of \string\makeglossary\space with
+ glossaries.sty is deprecated. Use \string\makeglossaries\space
+ instead. If you need the original definition of
+ \string\makeglossary\space use the package options
+ kernelglossredefs=false (to prevent redefinition of
+ \string\makeglossary) and nomain (if the file extensions cause a
+ conflict)}%
+ \makeglossaries
+ }%
+ \or
+ \let\glossary\gls@original@glossary
+ \let\makeglossary\gls@original@makeglossary
+ \or
+ \def\makeglossary{\makeglossaries}%
+ \renewcommand*{\@gls@override@glossary}[1][main]{%
+ \gls@glossary{##1}%
+ }%
+ \fi
+}
+% \end{macrocode}
+%\end{option}
+%
%\begin{option}{symbols}
% Create a \qt{symbols} glossary type
%\changes{3.11a}{2013-10-15}{new}
@@ -4916,11 +5042,15 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\begin{key}{nonumberlist}
% The \gloskey{nonumberlist} key suppresses or activates the number list
% for the given entry.
-% \changes{1.17}{2008-12-26}{new}
+%\changes{1.17}{2008-12-26}{new}
%\changes{3.0}{2011-04-02}{now boolean}
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@nonumberlist@val} and \cs{gls@nonumberlist@nr}}
% \begin{macrocode}
-\define@choicekey{glossentry}{nonumberlist}[\val\nr]{true,false}[true]{%
- \ifcase\nr\relax
+\define@choicekey{glossentry}{nonumberlist}%
+ [\gls@nonumberlist@val\gls@nonumberlist@nr]{true,false}[true]%
+{%
+ \ifcase\gls@nonumberlist@nr\relax
\def\@glo@prefix{\glsnonextpages}%
\@gls@savenonumberlist{true}%
\else
@@ -12718,7 +12848,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
{%
\PackageError{glossaries}%
{Glossary type `#1' not defined}%
- {New glossaries must be defined before using \string\makeglossary}%
+ {New glossaries must be defined before using \string\makeglossaries}%
}%
}
% \end{macrocode}
@@ -12867,10 +12997,13 @@ false,nolabel,autolabel,nameref}[nolabel]{%
to move \string\makeglossaries\space after all your
\string\newglossary\space commands}}%
% \end{macrocode}
-% Any subsequence instances of this command should have no effect
+% Any subsequence instances of this command should have no effect.
+% The deprecated \cs{makeglossary} is not redefined here as it either
+% implements \cs{makeglossaries} or has been restored to its original
+% definition (in which case it shouldn't be changed).
+%\changes{4.41}{2018-07-23}{removed redefinition of \cs{makeglossary}}
% \begin{macrocode}
\let\@makeglossary\relax
- \let\makeglossary\relax
\let\makeglossaries\relax
% \end{macrocode}
% Disable all commands that have no effect after \cs{makeglossaries}
@@ -12947,17 +13080,6 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \cs{makeglossaries} so that it's only defined if needed.
%\end{macro}
%
-% The \cs{makeglossary} command is redefined to be
-% identical to \cs{makeglossaries}. (This is done to
-% reinforce the message that you must either use
-% \cs{@makeglossary} for all the glossaries or for none
-% of them.)
-%\begin{macro}{\makeglossary}
-% \begin{macrocode}
-\let\makeglossary\makeglossaries
-% \end{macrocode}
-%\end{macro}
-%
% If \ics{makeglossaries} hasn't been used, issue a warning.
% Also issue a warning if neither \ics{printglossaries} nor
% \ics{printglossary} have been used.
@@ -13291,22 +13413,6 @@ you
% command. Using a custom internal command prevents any conflict
% with other packages (and with the \cs{mark} mechanism).
%
-% In v4.10, the redefinition of \cs{glossary} was removed since it
-% was never intended as a user level command (and wasn't documented
-% in the user manual), however it seems there are packages that have
-% hacked the internal macros used by \styfmt{glossaries} and no longer
-% work with this redefinition removed, so it's been restored in v4.11
-% but is not used at all by \styfmt{glossaries}.
-% (This may be removed or moved to a compatibility mode in future.)
-%\begin{macro}{\glossary}
-% \begin{macrocode}
-\if@gls@docloaded
-\else
- \renewcommand*{\glossary}[1][main]{\gls@glossary{#1}}
-\fi
-% \end{macrocode}
-%\end{macro}
-%
% The associated number should be stored in \cs{theglsentrycounter}
% before using \cs{gls@glossary}.
%\begin{macro}{\gls@glossary}
@@ -15059,10 +15165,14 @@ you
% \cs{printglossary}}
% The \gloskey[printglossary]{numberedsection} key determines if this
% glossary should be in a numbered section.
+%\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to
+%\cs{gls@numberedsection@val} and \cs{gls@numberedsection@nr}}
% \begin{macrocode}
-\define@choicekey{printgloss}{numberedsection}[\val\nr]{%
-false,nolabel,autolabel,nameref}[nolabel]{%
- \ifcase\nr\relax
+\define@choicekey{printgloss}{numberedsection}%
+ [\gls@numberedsection@val\gls@numberedsection@nr]%
+ {false,nolabel,autolabel,nameref}[nolabel]%
+{%
+ \ifcase\gls@numberedsection@nr\relax
\renewcommand*{\@@glossarysecstar}{*}%
\renewcommand*{\@@glossaryseclabel}{}%
\or
@@ -18933,7 +19043,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \cs{gls}\marg{label}} on subsequent use.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-prefix}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries-prefix}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Pass all options to \sty{glossaries}:
% \begin{macrocode}
@@ -19348,7 +19458,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\label{sec:code:hypernav}
% Package Definition:
% \begin{macrocode}
-\ProvidesPackage{glossary-hypernav}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-hypernav}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%
% The commands defined in this package are provided to
@@ -19541,7 +19651,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% This defines an in-line style where the entries are
% comma-separated with just the name and description displayed.
% \begin{macrocode}
-\ProvidesPackage{glossary-inline}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-inline}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%
%\begin{style}{inline}
@@ -19732,7 +19842,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \ics{item} command, it will appear in a bold font by
% default.
% \begin{macrocode}
-\ProvidesPackage{glossary-list}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-list}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%\begin{macro}{\indexspace}
%\changes{4.13}{2015-02-03}{new}
@@ -20014,7 +20124,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% The glossary styles defined in the \isty{glossary-long} package
% used the \env{longtable} environment in the glossary.
% \begin{macrocode}
-\ProvidesPackage{glossary-long}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-long}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Requires the \isty{longtable} package:
% \begin{macrocode}
@@ -20511,7 +20621,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \url{http://tex.stackexchange.com/a/56890}
%
% \begin{macrocode}
-\ProvidesPackage{glossary-longbooktabs}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-longbooktabs}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Requires \sty{booktabs} package:
% \begin{macrocode}
@@ -20852,7 +20962,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% used the \env{longtable} environment in the glossary and use
% ragged right formatting for the multiline columns.
% \begin{macrocode}
-\ProvidesPackage{glossary-longragged}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-longragged}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Requires the \isty{array} package:
% \begin{macrocode}
@@ -21285,7 +21395,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%use the \sty{multicol} package. These use the tree-like glossary
%styles in a multicol environment.
% \begin{macrocode}
-\ProvidesPackage{glossary-mcols}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-mcols}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Required packages:
% \begin{macrocode}
@@ -21722,7 +21832,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% The glossary styles defined in the \isty{glossary-super} package
% use the \env{supertabular} environment.
% \begin{macrocode}
-\ProvidesPackage{glossary-super}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-super}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Requires the \isty{supertabular} package:
% \begin{macrocode}
@@ -22254,7 +22364,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% are like those provided by the \isty{glossary-super} package,
% except that the multiline columns have ragged right justification.
% \begin{macrocode}
-\ProvidesPackage{glossary-superragged}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-superragged}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Requires the \isty{array} package:
% \begin{macrocode}
@@ -22694,7 +22804,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% that have a tree-like structure. These are designed for
% hierarchical glossaries.
% \begin{macrocode}
-\ProvidesPackage{glossary-tree}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossary-tree}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%
%\begin{macro}{\indexspace}
@@ -23415,7 +23525,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% hyperlinks may not work properly.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-compatible-207}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries-compatible-207}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%\begin{macro}{\GlsAddXdyAttribute}
% Adds an attribute in old format.
@@ -23776,7 +23886,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\section{glossaries-compatible-307}
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-compatible-307}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries-compatible-307}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
%
% Compatibility macros for predefined glossary styles:
@@ -24584,7 +24694,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \end{macrocode}
% Package version number now in line with main glossaries package number.
% \begin{macrocode}
-\ProvidesPackage{glossaries-accsupp}[2018/06/01 v4.40 (NLCT)
+\ProvidesPackage{glossaries-accsupp}[2018/07/23 v4.41 (NLCT)
Experimental glossaries accessibility]
% \end{macrocode}
% Pass all options to \sty{glossaries}:
@@ -27027,7 +27137,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% modules.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-babel}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries-babel}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Load \sty{tracklang} to obtain language settings.
% \begin{macrocode}
@@ -27071,7 +27181,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% modules.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-polyglossia}[2018/06/01 v4.40 (NLCT)]
+\ProvidesPackage{glossaries-polyglossia}[2018/07/23 v4.41 (NLCT)]
% \end{macrocode}
% Load \sty{tracklang} to obtain language settings.
% \begin{macrocode}
@@ -30745,11 +30855,17 @@ description={rectangular array of quantities},
% plural is not simply obtained by appending an s, so specify
plural=matrices}
- % entry with a paragraph break in the description
+ % Entry with a paragraph break in the description:
+ % (If you use \newglossaryentry, the paragraph break
+ % must be identified with \glspar not with \par or a blank line.
+ % It's easier to use \longnewglossaryentry.)
-\newglossaryentry{par}{name=paragraph,
-description={distinct section of piece of
-writing.\glspar Beginning on new, usually indented, line}}
+\longnewglossaryentry{par}% label
+{name=paragraph}% options
+{% multi-paragraph description
+distinct section of a piece of writing.
+
+Beginning on new, usually indented, line}
% entry with two types of plural. Set the plural form to the
% form most likely to be used. If you want to use a different
@@ -30785,6 +30901,19 @@ parent=bravo}
description={large seal}%
}
+ % If a value contains a comma, you must use braces to hide
+ % it from the key=value list parser. Take care to avoid
+ % accidentally introducing unwanted space as leading and trailing
+ % spaces within the braces aren't stripped. For example,
+ % text={ spurious space } will result in extra space appearing
+ % when the entry is referenced.
+\newglossaryentry{spuriousspace}{%
+ name={space, spurious},
+ text={spurious space},
+ description={unwanted spaces accidentally introduced by
+uncommented line breaks or attempts to pretty-print the \LaTeX\ code}
+}
+
\begin{document}
\title{Sample Document Using the glossaries Package}
@@ -30804,20 +30933,21 @@ very useful addition to any technical document, although a
simply be a collection of glosses, which is another thing entirely.
Some documents have multiple \glspl{glossarylist}.
-Once you have run your document through \LaTeX, you
-will then need to run the \texttt{.glo} file through
-\texttt{makeindex}. You will need to set the output
-file so that it creates a \texttt{.gls} file instead
-of an \texttt{.ind} file, and change the name of
-the log file so that it doesn't overwrite the index
-log file (if you have an index for your document).
-Rather than having to remember all the command line
-switches, you can call the \gls{Perl} script
-\texttt{makeglossaries} which provides a convenient
-wrapper.
+Once you have run your document through \LaTeX, you will then need
+to run the \texttt{.glo} file through \texttt{makeindex} (default)
+or \texttt{xindy}. You will need to set the output file so that the
+indexing application
+creates a \texttt{.gls} file instead of an \texttt{.ind} file, and
+change the name of the log file so that it doesn't overwrite the
+index log file (if you have an index for your document). Rather
+than having to remember all the command line switches, you can call
+the \gls{Perl} script \texttt{makeglossaries} which provides a
+convenient wrapper. See
+\href{https://www.dickimaw-books.com/latex/buildglossaries}{Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build} for help.
If a comma appears within the name or description, grouping
must be used, e.g.\ in the description of \gls{pagelist}.
+Be careful about \glspl{spuriousspace} appearing in your code.
\chapter{Plurals and Paragraphs}
@@ -30826,7 +30956,9 @@ not the case, as in \glspl{mtrx}, then you need to specify the
plural when you define the entry. If a term may have multiple
plurals (for example \glspl{cow}/\glslink{cow}{kine}) then
define the entry with the plural form most likely to be used and
-explicitly specify the alternative form using \verb|\glslink|.
+explicitly specify the alternative form using \verb|\glslink|
+(e.g.\ \glslink{cow}{kine})
+or \verb|\glsdisp| (e.g.\ \glsdisp{cow}{kine}).
\Glspl{seal} and \glspl{sealion} have regular plural forms.
\Gls{bravo} is a homograph, but the plural forms are spelt
diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins
index e9cae23b25f..51d869b112a 100644
--- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins
+++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins
@@ -1,4 +1,4 @@
-% glossaries.ins generated using makedtx version 1.2 2018/6/1 13:57
+% glossaries.ins generated using makedtx version 1.2 2018/7/23 12:54
\input docstrip
\preamble