summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex37
1 files changed, 20 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 0c1a701352c..4a4039b46f2 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -62,7 +62,7 @@ name={\appfmt{xindy}\index{xindy|htextbf}},
sort={xindy},
text={\protect\app{xindy}},
description={An flexible indexing application with multilingual
-support}
+support written in Perl}
}
\newglossaryentry{makeindex}{%
@@ -214,7 +214,7 @@ package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v3.0}
+ \title{User Manual for glossaries.sty v3.01}
\author{Nicola L.C. Talbot\\[10pt]
School of Computing Sciences\\
University of East Anglia\\
@@ -222,7 +222,7 @@ Norwich. Norfolk\\
NR4 7TJ. United Kingdom.\\
\url{http://theoval.cmp.uea.ac.uk/~nlct/}}
- \date{2011-04-02}
+ \date{2011-04-12}
\maketitle
\noindent
@@ -250,7 +250,7 @@ letter}{mfirstuc-manual}.
\item[\url{glossaries.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 v3.0}.
+\qt{Documented Code for glossaries v3.01}.
This includes how to iterate over all entry labels defined in a
given glossary or how to iterate over all glossary types, as well as
the documented code for the \sty{mfirstuc} package.
@@ -972,22 +972,18 @@ file and see if you can work it out from the \gls*{makeindex} or
Whilst it is strongly recommended that you use the
\gls{makeglossaries} script, it is possible to use the
-\styfmt{glossaries} package without having Perl installed. In which
-case, if you have used the \pkgopt{xindy} package option, you will
-need to use \gls{xindy} (see \sectionref{sec:xindyapp}), otherwise
-you will need to use \gls{makeindex} (see
-\sectionref{sec:makeindexapp}). Note that some commands and package
-options have no effect if you don't use \gls*{makeglossaries}. These
-are listed in \tableref{tab:makeglossariesCmds}.
+\styfmt{glossaries} package without having Perl installed. However,
+you will only be able to use \gls{makeindex} as \gls{xindy} also
+requires Perl. Note that some commands and package options have no
+effect if you don't use \gls*{makeglossaries}. These are listed in
+\tableref{tab:makeglossariesCmds}.
Note that if any of your entries use an entry
that is not referenced outside the glossary, you will need to
do an additional \gls{makeglossaries}, \gls{makeindex}
or \gls{xindy} run, as appropriate. For example,
-suppose you have defined the following entries:\footnote{Note that
-I'm assuming the \glsation{sanitize} has been switched on for the
-\gloskey{description} key, which is why I haven't used
-\cs{protect}\cs{gls} in the description.}
+suppose you have defined the following entries:\footnote{As from
+v3.01 \ics{gls} is no longer fragile and doesn't need protecting.}
\begin{verbatim}
\newglossaryentry{citrusfruit}{name={citrus fruit},
description={fruit of any citrus tree. (See also
@@ -1095,12 +1091,19 @@ 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
-2.02.
+2.03.
\end{important}
\subsubsection{Using xindy explicitly}
\label{sec:xindyapp}
+\Gls{xindy} comes with TeXLive, but not with MiKTeX. However MikTeX
+users can install it. There is
+\href{http://www.latex-community.org/forum/viewtopic.php?f=51&t=5383}{a
+thread} in the Makeindex section of the
+\urlfootref{http://www.latex-community.org/}{\LaTeX\ Community} that
+describes how to do this.
+
If you want to use \gls{xindy} to process the glossary
files, you must make sure you have used the
\pkgopt{xindy} package option:
@@ -3046,7 +3049,7 @@ latex filename
\begin{important}
If you switch off the description
\glsation{sanitize}, you must protect fragile
-commands like \ics{gls}:
+commands:\footnote{As from v3.01, \ics{gls} is no longer fragile.}
\begin{verbatim}
\newglossaryentry{apple}{name=apple,
description={firm, round fruit. See also