summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-07-08 22:32:47 +0000
committerKarl Berry <karl@freefriends.org>2015-07-08 22:32:47 +0000
commite1218e4d5ddcb68ac921c718bbe7a537af862583 (patch)
treeb77730b9572c833245ca5b3a0f4389e16dd72fa3 /Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
parent4cc63125c198c95120c614619f6adca51ed8b7e3 (diff)
glossaries (8jul15)
git-svn-id: svn://tug.org/texlive/trunk@37808 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.tex39
1 files changed, 23 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
index 3d4b4c47515..1797987e369 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
@@ -20,10 +20,10 @@
\newcommand*{\yes}{\ding{52}}
\newcommand*{\no}{\ding{56}}
-\title{The glossaries package v4.15:
+\title{The glossaries package v4.16:
a guide for beginners}
\author{Nicola L.C. Talbot}
-\date{2015-03-16}
+\date{2015-07-08}
\ifpdf
\externaldocument{glossaries-user}
@@ -45,7 +45,7 @@ and~\hyperlink{option#2}{#2}}
\begin{abstract}
The \styfmt{glossaries} package is very flexible, but this means
-that it has a lot options, and since a user guide is supposed to
+that it has a~lot options, and since a user guide is supposed to
provide a complete list of all the high-level user commands, the main
user manual is quite big. This can be rather
daunting for beginners, so this document is a brief introduction
@@ -68,7 +68,7 @@ under certain circumstances}.
As with all packages, you need to load \styfmt{glossaries} with
\cs{usepackage}, but there are certain packages that must be loaded
-before \styfmt{glossaries}, if they are required: \sty{hyperref},
+before \styfmt{glossaries}, \emph{if} they are required: \sty{hyperref},
\sty{babel}, \sty{polyglossia}, \sty{inputenc} and \sty{fontenc}.
(You don't have to load these packages, but if you want them, you
must load them before \styfmt{glossaries}.)
@@ -185,7 +185,8 @@ three options: use \TeX\ to perform the sorting; use
perform the sorting.
The first option (using \TeX) is the simplest and easiest method,
-but it's inefficient. To use this method, add \cs{makenoidxglossaries}
+but it's inefficient and the sorting is done according to the English
+alphabet. To use this method, add \cs{makenoidxglossaries}
to the preamble and put \cs{printnoidxglossaries} at the place where
you want your glossary. For example:
\begin{verbatim}
@@ -242,11 +243,12 @@ the singular form with the letter \qt{s} appended, but in the case of
As I mentioned earlier, using \TeX\ to sort the entries is the
simplest but least efficient method. If you have a large glossary or
-if your terms contain non-Latin characters, then you will have a much
-faster build time if you use \texttt{makeindex} or \texttt{xindy}.
-If you are using extended Latin or non-Latin characters, then
-\texttt{xindy} is the recommended method. These two methods are
-described in more detail in \sectionref{sec:printglossaries}.
+if your terms contain non-Latin or extended Latin characters, then
+you will have a much faster build time if you use \texttt{makeindex}
+or \texttt{xindy}. If you are using extended Latin or non-Latin
+characters, then \texttt{xindy} is the recommended method. These two
+methods are described in more detail in
+\sectionref{sec:printglossaries}.
The rest of this document briefly describes the main commands
provided by the \styfmt{glossaries} package.
@@ -355,13 +357,14 @@ or
\qtdocref{UTF-8}{mfirstuc-manual} in the
\sty{mfirstuc} user manual.)
-Acronyms or abbreviations can be defined using
+Acronyms (or other abbreviations) can be defined using
\begin{definition}
\cs{newacronym}\marg{label}\marg{short}\marg{long}
\end{definition}
where \meta{label} is the label (as with the \cs{newglossaryentry}
-and the \cs{longnewglossaryentry} commands), \meta{short} is the abbreviation or
-acronym and \meta{long} is the long form. For example:
+and the \cs{longnewglossaryentry} commands), \meta{short} is the
+short form and \meta{long} is the long form. For example, the
+following defines an abbreviation:
\begin{verbatim}
\newacronym{svm}{svm}{support vector machine}
\end{verbatim}
@@ -377,8 +380,8 @@ using the optional argument:
{svm}{svm}{support vector machine}
\end{verbatim}
-Before you define your acronyms, you need to specify which acronym
-style to use with
+Before you define your acronyms (or other types of abbreviations), you
+need to specify which style to use with
\begin{definition}
\cs{setacronymstyle}\marg{style name}
\end{definition}
@@ -716,7 +719,11 @@ If you are using \opt3, then you need to do this anyway as
\texttt{xindy} is also written in Perl. If you are using \opt2
and can't work out how to install Perl (or for some reason don't
want to install it) then just use \texttt{makeindex} directly, as
-described above.
+described above, or you can use a~Lua alternative to
+\texttt{makeglossaries} called \texttt{makeglossaries-lite.lua}:
+\begin{verbatim}
+makeglossaries-lite.lua myDoc
+\end{verbatim}
As a last resort you can try the package option \texttt{automake}:
\begin{verbatim}