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 | 41 |
1 files changed, 35 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 0a4fe4c5b69..4693eca3c88 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -364,11 +364,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.09} + \title{User Manual for glossaries.sty v4.10} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2014-08-12} + \date{2014-08-27} \maketitle \begin{abstract} @@ -421,7 +421,7 @@ letter}{mfirstuc-manual}. \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.09}. +\qt{Documented Code for glossaries v4.10}. This includes the documented code for the \sty{mfirstuc} package. \item[INSTALL] Installation instructions. @@ -1301,6 +1301,9 @@ of citation keys). The citations are defined in \texttt{xampl.bib}, which should be available on all modern \TeX\ distributions. One entry doesn't have an associated citation to help test for a~missing key. + +\item[example-glossaries-url.tex] These entries use the +\gloskey{user1} key to store an URL associated with the entry. \end{description} The sample file \texttt{glossary-lipsum-examples.tex} in the @@ -4690,7 +4693,9 @@ There are also analogous uppercasing commands: \cs{glsname}\oarg{options}\marg{label}\oarg{insert} \end{definition} This command always uses the value of the \gloskey{name} key as the -\gls{linktext}. +\gls{linktext}. Note that this may be different from the values of +the \gloskey{text} or \gloskey{first} keys. In general it's better +to use \cs{glstext} or \cs{glsfirst} instead of \cs{glsname}. There are also analogous uppercasing commands: \begin{definition}[\DescribeMacro{\Glsname}] @@ -4700,6 +4705,11 @@ There are also analogous uppercasing commands: \cs{GLSname}\oarg{options}\marg{text}\oarg{insert} \end{definition} +\begin{important} +In general it's best to avoid \cs{Glsname} with acronyms. Instead, +consider using \cs{Acrlong}, \cs{Acrshort} or \cs{Acrfull}. +\end{important} + \begin{definition}[\DescribeMacro{\glssymbol}] \cs{glssymbol}\oarg{options}\marg{label}\oarg{insert} \end{definition} @@ -5456,7 +5466,15 @@ These commands display the name of the glossary entry given by \cs{Glsentryname} makes the first letter upper case. Neither of these commands check for the existence of \meta{label}. The first form \cs{glsentryname} is expandable (unless the name -contains unexpandable commands). +contains unexpandable commands). Note that this may be different from the values of +the \gloskey{text} or \gloskey{first} keys. In general it's better +to use \cs{glsentrytext} or \cs{glsentryfirst} instead of +\cs{glsentryname}. + +\begin{important} +In general it's best to avoid \cs{Glsentryname} with acronyms. Instead, +consider using \cs{Glsentrylong}, \cs{Glsentryshort} or \cs{Glsentryfull}. +\end{important} \begin{definition}[\DescribeMacro{\glossentryname}] \cs{glossentryname}\marg{label} @@ -5967,7 +5985,18 @@ commands: \end{definition} which produce an open and closing brace. (This is needed because \verb|\{| and \verb|\}| don't expand to a simple brace character -when written to a file.) +when written to a file.) Similarly, you can write a percent +character using: +\begin{definition}[\DescribeMacro{\glspercentchar}] +\cs{glspercentchar} +\end{definition} +and a tilde character using: +\begin{definition}[\DescribeMacro{\glstildechar}] +\cs{glstildechar} +\end{definition} +For example, a newline character is specified in a \gls{xindy} style +file using \verb|~n| so you can use \texttt{\cs{glstildechar} n} +to write this correctly (or you can do \verb|\string~n|). In addition, if you are using a package that makes the double quote character active (e.g. \sty{ngerman}) you can use: |