summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-12-06 22:12:47 +0000
committerKarl Berry <karl@freefriends.org>2013-12-06 22:12:47 +0000
commitcfbdc127e742f1a0758482a6e7c5f00985127ff6 (patch)
treea4c682376d022ca5c3c73595a489e32f26c66948 /Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
parent7f304fc721af7e006a9209f30840ad96bfab1e9f (diff)
glossaries (6dec13)
git-svn-id: svn://tug.org/texlive/trunk@32341 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex25
1 files changed, 17 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
index 266d26c8d43..7c13c105bd2 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
@@ -13,7 +13,7 @@
\title{The glossaries package: a guide for beginners}
\author{Nicola L.C. Talbot}
-\date{2013-11-16}
+\date{2013-12-05}
\newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}}
\newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}}
@@ -36,7 +36,7 @@ such, it only covers the basics. For more advanced topics, see the
\label{requirements}
You need to have the \styfmt{glossaries} package installed. You also
-need to have the following packages installed: \sty{ifthen},
+need to have the following packages installed: \sty{datatool}, \sty{ifthen},
\sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and
\sty{etoolbox}.
You may also need \sty{longtable}, \sty{supertabular},
@@ -74,7 +74,13 @@ Note that the \styfmt{glossaries} package must be loaded \emph{after}
the \sty{hyperref} package (contrary to the general advice that
\sty{hyperref} should be loaded last). The \sty{glossaries} package
should also be loaded after \sty{html}, \sty{inputenc},
-\sty{babel} and \sty{ngerman}.
+\sty{babel} and \sty{ngerman}. If you are using \sty{babel} I
+recommend you use the \sty{glossaries} package option
+\pkgopt[babel]{translate}:
+\begin{verbatim}
+\usepackage{babel}
+\usepackage[translate=babel]{glossaries}
+\end{verbatim}
\end{important}
If you want to use \app{xindy} rather than \app{makeindex} to sort the
@@ -129,11 +135,11 @@ since it isn't formed by simply appending the letter \qt{s}.
When you define terms, it is important to remember that they will
be sorted by an external application that doesn't interpret \LaTeX\
-commands. \app{Xindy} is a little more \TeX-aware than \app{makeindex}, but
+commands. \app{xindy} is a little more \TeX-aware than \app{makeindex}, but
for this example they will both mis-sort \verb|\oe sophagus|.
Xindy will ignore the \verb*|\oe | part and will sort it according
to \texttt{sophagus}, so it will be placed with the terms starting
-with an \qt{s}. \app{Makeindex}, on the other hand, will sort it according
+with an \qt{s}. \app{makeindex}, on the other hand, will sort it according
to \verb*|\oe sophagus| which starts with a symbol (the backslash),
so it will end up in the symbol group. You therefore need to
specify how to sort the term:
@@ -246,9 +252,6 @@ placed in a separate list of acronyms:
\begin{verbatim}
\usepackage[acronym]{glossaries}
\end{verbatim}
-There are other options that govern how acronyms appear. For further
-details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms}
-in the main \sty{glossaries} user manual.
Acronyms must be defined before use and are defined using:
\begin{definition}
@@ -278,6 +281,12 @@ otherwise it would produce:
\begin{display}
A svm was implemented.
\end{display}
+If you prefer a different way of displaying the acronyms (for
+example, putting the long form in a footnote on first use) it's
+possible to change the acronym style. For further
+details, see \xrsectionref{sec:acronyms}{glossaries-user}{Acronyms}
+in the main \sty{glossaries} user manual.
+
You can reset an acronym so that the next use fully
expands it again using:
\begin{definition}