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 | 54 |
1 files changed, 45 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 58e8b5c263e..21cad036a5d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -448,11 +448,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.39} + \title{User Manual for glossaries.sty v4.40} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2018-05-23} + \date{2018-06-01} \maketitle \begin{abstract} @@ -499,6 +499,12 @@ or (for Linux users) \href{http://tex.stackexchange.com/questions/14925/updating-tex-on-linux}{Updating \TeX\ on Linux}. +Note that occasionally you may find that certain packages need to be +loaded \emph{after} packages that are required by \styfmt{glossaries}. For +example, a package \meta{X} might need to be loaded after \sty{amsgen}. In +which case, load the required package first (for example, +\sty{amsgen}), then \meta{X}, and finally load \styfmt{glossaries}. + \begin{important} Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and @@ -537,7 +543,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.39}. +\qt{Documented Code for glossaries v4.40}. \item[INSTALL] Installation instructions. @@ -1755,8 +1761,7 @@ See \sectionref{sec:xindyloc} for further details. \exitem{xdy3} This document is like \samplefile{xdy} but uses the command \cs{Numberstring} from the \sty{fmtcount} package to -format the page numbers. This requires at least version 3.03 of -\sty{fmtcount} to work correctly. +format the page numbers. \exitem{utf8} This is another example that uses \gls{xindy}. Unlike \gls{makeindex}, @@ -2839,7 +2844,7 @@ resulting file onto the man path. Alternatively do \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -4.39. +4.40. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -3776,7 +3781,8 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the \end{verbatim} \item[\pkgopt{esclocations}] This is a boolean option. (The default -is \pkgopt[true]{esclocations}.) Both \gls{makeindex} and \gls{xindy} +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 @@ -3789,7 +3795,8 @@ 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. +of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented +code for further details.) \item[\pkgopt{nonumberlist}] This option will suppress the associated \glspl{numberlist} in the glossaries (see also @@ -8753,7 +8760,36 @@ routine. A more recent change to \sty{fmtcount} (v3.03) now puts three instances of \cs{expandafter} before \verb|\the\value| which no longer hides \cs{c@page} from the location escaping mechanism, so -the page numbers should once more be correct. The sample file +the page numbers should once more be correct. Further changes +to the \sty{fmtcount} package may cause a problem again. + +\begin{important} +When dealing with custom formats where the internal definitions +are outside of your control and liable to change, it's best +to provide a wrapper command. +\end{important} + +Instead of directly using \cs{Numberstring} in the definition of +\cs{thepage}, I can provide a custom command in the same form +as the earlier \cs{tally} command: +\begin{verbatim} +\newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}} +\newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}} +\end{verbatim} +This ensures that the location will always be written to +the indexing file in the form: +\begin{alltt} +:locref "\glsopenbrace\glsclosebrace\glsopenbrace\string\\customfmtnum \marg{n}\glsclosebrace" +\end{alltt} +So the location class can be defined as: +\begin{verbatim} +\GlsAddXdyLocation{customfmt}{ + :sep "\string\customfmtnum\space\glsopenbrace" + "arabic-numbers" + :sep "\glsclosebrace"} +\end{verbatim} + +The sample file \samplefile{xdy3} illustrates this. \end{example} |