diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 698933ac277..7aeaac090d5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -450,11 +450,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.42} + \title{User Manual for glossaries.sty v4.43} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2019-01-06} + \date{2019-09-28} \maketitle \begin{abstract} @@ -545,7 +545,7 @@ package. \item[\url{glossaries-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v4.42}. +\qt{Documented Code for glossaries v4.43}. \item[INSTALL] Installation instructions. @@ -3257,6 +3257,24 @@ is sorted according to \texttt{AAA}, then use the package option The default for \optsand23 is \pkgopt[true]{sanitizesort}, and the default for \opt1 is \pkgopt[false]{sanitizesort}. +\item[\pkgoptdef{esclocations}] This is a boolean option. (The default +is \pkgopt[true]{esclocations}, but \ics{makenoidxglossaries} +changes it to \pkgopt[false]{esclocations}.) Both \gls{makeindex} and \gls{xindy} +are fussy about the location formats (\gls{makeindex} more so than +\gls{xindy}) so the \styfmt{glossaries} package tries to ensure that +special characters are escaped and allows for the location to be +substituted for a format that's more acceptable to the indexing +application. This requires a bit of trickery to circumvent the +problem posed by \TeX's asynchronous output routine, which can go +wrong and also adds to the complexity of the document build. + +If you're sure that your locations will always expand to an +acceptable format (or you're prepared to post-process the glossary +file before passing it to the relevant indexing application) then +use \pkgopt[false]{esclocations} to avoid the complex escaping +of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented +code for further details.) + \item[\pkgoptdef{savewrites}] This is a boolean option to minimise the number of write registers used by the \styfmt{glossaries} package. (Default is \pkgopt[false]{savewrites}.) There are only a limited @@ -3782,24 +3800,6 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the \setglossarystyle{mcoltree} \end{verbatim} -\item[\pkgoptdef{esclocations}] This is a boolean option. (The default -is \pkgopt[true]{esclocations}, but \ics{makenoidxglossaries} -changes it to \pkgopt[false]{esclocations}.) Both \gls{makeindex} and \gls{xindy} -are fussy about the location formats (\gls{makeindex} more so than -\gls{xindy}) so the \styfmt{glossaries} package tries to ensure that -special characters are escaped and allows for the location to be -substituted for a format that's more acceptable to the indexing -application. This requires a bit of trickery to circumvent the -problem posed by \TeX's asynchronous output routine, which can go -wrong and also adds to the complexity of the document build. - -If you're sure that your locations will always expand to an -acceptable format (or you're prepared to post-process the glossary -file before passing it to the relevant indexing application) then -use \pkgopt[false]{esclocations} to avoid the complex escaping -of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented -code for further details.) - \item[\pkgoptdef{nonumberlist}] This option will suppress the associated \glspl{numberlist} in the glossaries (see also \sectionref{sec:numberlists}). Note that if you use \optsor23 |