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 | 71 |
1 files changed, 66 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index cefb8116a9c..fdb8721a031 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -682,11 +682,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.47} + \title{User Manual for glossaries.sty v4.48} \author{Nicola L.C. Talbot\\% \href{http://www.dickimaw-books.com/contact}{\nolinkurl{dickimaw-books.com/contact}}} - \date{2021-09-20} + \date{2021-10-19} \maketitle \begin{abstract} @@ -775,7 +775,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.47}. +\qt{Documented Code for glossaries v4.48}. \item[CHANGES] Change log. @@ -1057,6 +1057,29 @@ wish to write in a language other than English. There are some sample documents provided with this package. They are described in \sectionref{sec:samples}. +\section{Rollback} +\label{sec:rollback} + +There is one rollback release: v4.46 (2020-03-19) for +\styfmt{glossaries.sty} and \styfmt{glossary-list.sty}. +The other associated packages haven't been changed since that +release (apart from the version numbers, which are always updated +for each new release, regardless of whether or not the file has +otherwise been changed). If you rollback to v4.46 using: +\begin{verbatim} +\usepackage{glossaries}[=v4.46] +\end{verbatim} +then the 4.46 version of \sty{glossary-list.sty} will automatically be +loaded. If you use \pkgopt{nostyles} and subsequently load +\sty{glossary-list} you will also need to add the rollback version: +\begin{verbatim} +\usepackage[nostyles]{glossaries}[=v4.46] +\usepackage{glossary-list}[=v4.46] +\end{verbatim} +If you rollback using \sty{latexrelease} to an earlier date, then +you will need to specify v4.46 for \sty{glossaries} as there are no +earlier rollback versions available. + \section{Indexing Options} \label{sec:indexingoptions} @@ -3253,7 +3276,7 @@ For a complete list of options do \texttt{makeglossaries -{}-help}. \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -4.47. +4.48. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -8260,6 +8283,15 @@ If you want to title case a field, you can use: \end{definition} where \meta{label} is the label identifying the glossary entry, \meta{field} is the field label (see \tableref{tab:fieldmap}). +This internally uses: +\begin{definition}[\DescribeMacro\glscapitalisewords] +\cs{glscapitalisewords}\marg{text} +\end{definition} +which defaults to \cs{capitalisewords}\marg{text}. If your field +contains formatting commands, you will need to redefine this to use +\cs{capitalisefmtwords}. See the \sty{mfirstuc} manual for further +details. + For example: \begin{verbatim} \glsentrytitlecase{sample}{desc} @@ -11900,6 +11932,24 @@ may also be incompatible with other classes or packages that modify the \env{description} environment. \end{important} +As from v4.48, there is an initialisation hook that provides a patch +if the \sty{gettitlestring} package is loaded, since this is used by +\sty{hyperref}. +\begin{definition}[\DescribeMacro\glslistinit] +\cs{glslistinit} +\end{definition} +This patch should ensure that the combination of \sty{hyperref} and +\pkgopt{entercounter} should correctly expand the entry name to the +\filetype{aux} file. The name is expanded using: +\begin{definition}[\DescribeMacro\glslistexpandedname] +\cs{glslistexpandedname}\marg{label} +\end{definition} +This uses \ics{glsunexpandedfieldvalue}. If you need the name to +fully expand, you can redefine this. For example: +\begin{verbatim} +\newcommand{\glslistexpandedname}[1]{\glsentryname{#1}} +\end{verbatim} + \begin{description} \item[list] The \glostyle{list} style uses the \env{description} environment. The entry name is placed in the optional argument of @@ -14155,7 +14205,18 @@ and \meta{cs} is the control sequence in which to store the value. Remember that \meta{field} is the internal label and is not necessarily the same as the key used to set that field in the argument of \cs{newglossaryentry} (or the optional argument of -\cs{newacronym}). +\cs{newacronym}). This command uses \cs{glsdoifexists} so an error +will occur if the entry hasn't been defined. + +If you need to expand to the field value without expanding the +contents you can use: +\begin{definition}[\DescribeMacro\glsunexpandedfieldvalue] +\cs{glsunexpandedfieldvalue}\marg{label}\marg{field} +\end{definition} +where \meta{label} is the label identifying the glossary entry, +\meta{field} is the internal field label (see +\tableref{tab:fieldmap}). If the entry doesn't exist or if the field +isn't defined or hasn't been set this expands to nothing. You can change the value of a given field using one of the following commands. Note that these commands only change the value of the |