diff options
author | Karl Berry <karl@freefriends.org> | 2017-01-07 23:39:19 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2017-01-07 23:39:19 +0000 |
commit | 734a944ad1d694094e6cac8d4ce2c1f2c8adfb71 (patch) | |
tree | 168c93d9699c0900906a6d1a1f6fa7655b5ce9ad /Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex | |
parent | c4bd7c61c3f6687a0dac0043d47e727b5e5814b7 (diff) |
glossaries (8jan17)
git-svn-id: svn://tug.org/texlive/trunk@42894 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex | 52 |
1 files changed, 37 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 9f6dfdf6a92..df3bf87c9b7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -398,11 +398,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.27} + \title{User Manual for glossaries.sty v4.28} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2016-12-16} + \date{2017-01-07} \maketitle \begin{abstract} @@ -480,7 +480,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.27}. +\qt{Documented Code for glossaries v4.28}. \item[INSTALL] Installation instructions. @@ -700,9 +700,9 @@ makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo \gls{xindy} to sort the entries. This application is more flexible than \texttt{makeindex} and is able to sort \glspl{exlatinalph} or \glspl{nonlatinalph}. The \gls{xindy} application comes with \TeX~Live - but not with MiK\TeX. Since \gls{xindy} is a Perl script, if you are - using MiK\TeX\ you will not only need to install \gls{xindy}, you - will also need to install Perl. In a~similar way to \opt2, this + and now also with MiK\TeX. Since \gls{xindy} is a Perl script, you + will also need to install Perl, if you don't already have it. + In a~similar way to \opt2, this option involves making \LaTeX\ write the glossary information to a~temporary file which \gls{xindy} reads. Then \gls{xindy} writes a~new file containing the code to typeset the glossary. @@ -769,6 +769,11 @@ xindy -L english -C utf8 -I xindy -M myDoc \end{description} +There is a fourth option available if you use the extension package +\sty{glossaries-extra} (as from v1.08). See the \pkgoptfmt{record} +package option in the \sty{glossaries-extra} user manual for +further details. + For \optsand23, it can be difficult to remember all the parameters required for \gls{makeindex} or \gls{xindy}, so the \styfmt{glossaries} package provides a~Perl script called @@ -957,20 +962,20 @@ There are three other files that can be used as a example}: \texttt{mwe-gls.tex}, \texttt{mwe-acr.tex} and \texttt{mwe-acr-desc.tex}. -\exitem{-noidx} This document illustrates how to use the +\exitem{-noidxapp} This document illustrates how to use the \styfmt{glossaries} package without an external \gls{indexingapp} (\opt1). To create the complete document, you need to do: \begin{prompt} -latex sample-noidx -latex sample-noidx +latex sample-noidxapp +latex sample-noidxapp \end{prompt} -\exitem{-noidx-utf8} As the previous example, except that it uses +\exitem{-noidxapp-utf8} As the previous example, except that it uses the \sty{inputenc} package. To create the complete document, you need to do: \begin{prompt} -latex sample-noidx-utf8 -latex sample-noidx-utf8 +latex sample-noidxapp-utf8 +latex sample-noidxapp-utf8 \end{prompt} \exitem{4col} This document illustrates @@ -2313,8 +2318,8 @@ makeglossaries-lite.lua -{}-help \gls{xindy} explicitly (\ifpdf \opt3\else Option 3\fi)} \label{sec:xindyapp} -\Gls{xindy} comes with \TeX~Live, but not with MiK\TeX. However -Mik\TeX\ users can install it. See +\Gls{xindy} comes with \TeX~Live. It has also been added +to Mik\TeX, but if you don't have it installed, see \href{http://tex.stackexchange.com/questions/71167/how-to-use-xindy-with-miktex}{How to use Xindy with MikTeX} on \urlfootref{http://www.stackexchange.com/}{\TeX\ on StackExchange}. @@ -5722,6 +5727,21 @@ Don't use any of the \glslike\ or \glstextlike\ commands in the \meta{insert} argument. \end{important} +Take care using these commands within commands or environments that +are processed multiple times as this can confuse the first use flag +query and state change. This includes frames with overlays in +\cls{beamer} and the \envfmt{tabularx} environment provided by \sty{tabularx}. +The \styfmt{glossaries} package automatically deals with this issue +in \sty{amsmath}'s \envfmt{align} environment. You can apply a patch +to \sty{tabularx} by placing the following command (new to v4.28) in +the preamble: +\begin{definition}[\DescribeMacro\glspatchtabularx] +\cs{glspatchtabularx} +\end{definition} +This does nothing if \sty{tabularx} hasn't been loaded. There's no +patch available for \cls{beamer}. See \sectionref{sec:glsunset} for +more details. + \begin{definition}[\DescribeMacro{\gls}] \cs{gls}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -9474,7 +9494,9 @@ typesetting. The \sty{amsmath} environments, such as \env{align}, also process their contents multiple times, but the \styfmt{glossaries} package now -checks for this. +checks for this. For \sty{tabularx}, you need to explicitly patch it +by placing \cs{glspatchtabularx} in the preamble (or anywhere +before the problematic use of \envfmt{tabularx}). \section{Counting the Number of Times an Entry has been Used (First Use Flag Unset)} |