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 | 65 |
1 files changed, 42 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 79edf330817..5c01b412636 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -149,7 +149,8 @@ description={A custom designed Perl script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} package. \TeX\ distributions on Windows convert the original \texttt{makeglossaries} script into an executable -\texttt{makeglossaries.exe} for convenience.} +\texttt{makeglossaries.exe} for convenience (but Perl is still +required).} } \newglossaryentry{makeglossaries-lite.lua}{% @@ -447,11 +448,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.36} + \title{User Manual for glossaries.sty v4.37} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2018-03-07} + \date{2018-04-07} \maketitle \begin{abstract} @@ -491,12 +492,12 @@ including, but not limited to, \sty{tracklang}, \sty{mfirstuc}, packages are all available in the latest \TeX~Live and Mik\TeX\ distributions. If any of them are missing, please update your \TeX\ distribution using your update manager. -(For help on this see, for example, +For help on this see, for example, \href{http://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \TeX\ distribution?} -or +or (for Linux users) \href{http://tex.stackexchange.com/questions/14925/updating-tex-on-linux}{Updating -\TeX\ on Linux}.) +\TeX\ on Linux}. \begin{important} Documents have wide-ranging styles when it comes to presenting glossaries @@ -536,7 +537,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.36}. +\qt{Documented Code for glossaries v4.37}. \item[INSTALL] Installation instructions. @@ -550,10 +551,14 @@ Related resources: \item \href{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{\styfmt{glossaries} FAQ} -\item \href{http://www.dickimaw-books.com/gallery/glossaries-styles/}{\styfmt{glossaries} +\item \href{http://www.dickimaw-books.com/gallery/#glossaries}{\styfmt{glossaries} gallery} \item +\href{http://www.dickimaw-books.com/gallery/glossaries-styles/}{a +summary of all glossary styles provided by \styfmt{glossaries}} + +\item \href{http://www.dickimaw-books.com/gallery/glossaries-performance.shtml}{\styfmt{glossaries} performance} (comparing document build times for the different options provided by \styfmt{glossaries} and \styfmt{glossaries-extra}). @@ -611,7 +616,9 @@ for problematic entries. \label{sec:intro} The \styfmt{glossaries} package is provided to assist generating -lists of terms, symbols or abbreviations (glossaries). It has a certain amount of flexibility, allowing the +lists of terms, symbols or abbreviations. (For convenience, these +lists are all referred to as glossaries in this manual.) +The package has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports glossary styles that include symbols (in addition to a name and description) for glossary @@ -621,6 +628,7 @@ referenced using any of the commands described in \sectionref{sec:glslink} and \sectionref{sec:glsadd} or via \ics{glssee} (or the \gloskey{see} key) or commands such as \ics{acrshort}.}\ in the document will be added to the glossary. + The \styfmt{glossaries-extra} package, which is distributed as a separated bundle, extends the capabilities of the \styfmt{glossaries} package. The simplest document can be @@ -661,10 +669,10 @@ Next use: \gls{cafe}, \gls{html}, \gls{pi}. \end{document} \end{verbatim} -\textbf{This package replaces the \sty{glossary} package which is -now obsolete.} Please see the document \qtdocref{Upgrading from the -glossary package to the glossaries package}{glossary2glossaries} for -assistance in upgrading. +\textbf{The \styfmt{glossaries} package replaces the \sty{glossary} +package which is now obsolete.} Please see the document +\qtdocref{Upgrading from the glossary package to the glossaries +package}{glossary2glossaries} for assistance in upgrading. One of the strengths of this package is its flexibility, however the drawback of this is the necessity of having a large manual @@ -828,7 +836,7 @@ If you want a sorted list, it doesn't work well for the \pkgopt[false]{sanitizesort} package option (the default for Option~1) then the \glslink{latexexlatinchar}{standard \LaTeX\ accent commands} will be ignored, so if an entry's name is set to -\verb|{\'e}lite| then the sort will default to \texttt{elite} if +\verb|{\'e}lite| then the sort value will default to \texttt{elite} if \pkgopt[false]{sanitizesort} is used and will default to \verb|\'elite| if \pkgopt[true]{sanitizesort} is used. If you have any other kinds of commands that don't expand to ASCII characters, @@ -2838,7 +2846,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.36. +4.37. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -5607,7 +5615,7 @@ automatically at the start of the document, add the \cs{AtBeginDocument} command \emph{before} you load the \sty{glossaries} package (and \sty{babel}, if you are also loading that) to avoid the creation of the -\texttt{.glsdefs} file and any associated problems that are caused +\filetype{.glsdefs} file and any associated problems that are caused by defining commands in the \env{document} environment. (See \sectionref{sec:docdefs}.) \end{important} @@ -9361,7 +9369,7 @@ formatting commands. \label{sec:setacronymstyle} It may be that the default style doesn't suit your requirements in -which case you can switch to another styles using +which case you can switch to another style using \begin{definition}[\DescribeMacro{\setacronymstyle}] \cs{setacronymstyle}\marg{style name} \end{definition} @@ -9369,16 +9377,27 @@ where \meta{style name} is the name of the required style. \begin{important} You must use \cs{setacronymstyle} \emph{before} you define the -acronyms with \cs{newacronym}. If you have multiple glossaries -representing lists of acronyms, you must use \cs{setacronymstyle} -\emph{after} using \cs{DeclareAcronymList}. +acronyms with \cs{newacronym}. \end{important} -The \styfmt{glossaries} package has the restriction that only one -style may be in use that applies to all entries defined with -\cs{newacronym}. If you need multiple abbreviation styles, then try +For example: +\begin{verbatim} +\usepackage[acronym]{glossaries} + +\makeglossaries + +\setacronymstyle{long-sc-short} + +\newacronym{html}{html}{hypertext markup language} +\newacronym{xml}{xml}{extensible markup language} +\end{verbatim} +Unpredictable results can occur if you try to use multiple styles. + +\begin{important} +If you need multiple abbreviation styles, then try using the \gls{glossaries-extra} package, which has better abbreviation management. +\end{important} Note that unlike the default behaviour of \cs{newacronym}, the styles used via \cs{setacronymstyle} don't use the \gloskey{first} |