summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex65
1 files changed, 39 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
index bc8c925513b..8e950f6edd1 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.11:
+\title{The glossaries package v4.12:
a guide for beginners}
\author{Nicola L.C. Talbot}
-\date{2014-09-01}
+\date{2014-11-22}
\ifpdf
\externaldocument{glossaries-user}
@@ -49,16 +49,16 @@ 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
-just to help get you started. If you find yourself saying, ``Yeah,
-but how can I do\ldots?'' then it's time to move on to the
+just to help get you started. If you find yourself saying, \qt{Yeah,
+but how can I do\ldots?} then it's time to move on to the
\docref{main user manual}{glossaries-user}.
I've made some statements in this document that don't actually tell
you the full truth, but it would clutter the document and cause
-confusion if I keep writing ``except when \ldots'' or ``but you can
-also do this, that or the other'' or ``you can do it this way but
+confusion if I keep writing \qt{except when \ldots} or \qt{but you can
+also do this, that or the other} or \qt{you can do it this way but
you can also do it that way, but that way may cause complications
-under certain circumstances''.
+under certain circumstances}.
\end{abstract}
\tableofcontents
@@ -73,6 +73,16 @@ before \styfmt{glossaries}, if they are required: \sty{hyperref},
(You don't have to load these packages, but if you want them, you
must load them before \styfmt{glossaries}.)
+\begin{important}
+If you require multilingual support you must also install
+the relevant language module. Each language module is called
+\texttt{glossaries-}\meta{language}, where \meta{language} is the
+root language name. For example, \texttt{glossaries-french}
+or \texttt{glossaries-german}. If a language module is required,
+the \styfmt{glossaries} package will automatically try to load it
+and will give a warning if the module isn't found.
+\end{important}
+
Once you have loaded \styfmt{glossaries}, you need to define
your terms in the preamble and then you can use them throughout the
document. Here's a simple example:
@@ -202,8 +212,8 @@ Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}.
\end{verbatim}
Try this out and run \LaTeX\ (or pdf\LaTeX) \emph{twice}. The first
run won't show the glossary. It will only appear on the second run.
-The glossary has a vertical gap between the ``carrot'' term and the
-``potato'' term. This is because the entries in the glossaries are
+The glossary has a vertical gap between the \qt{carrot} term and the
+\qt{potato} term. This is because the entries in the glossaries are
grouped according to their first letter. If you don't want this gap,
just add \texttt{nogroupskip} to the package options:
\begin{verbatim}
@@ -226,8 +236,8 @@ with the \texttt{nopostdot} package option:
You may have noticed that I've used another command in the above example:
\cs{glspl}. This displays the plural form. By default, this is just
-the singular form with the letter ``s'' appended, but in the case of
-``potato'' I had to specify the correct plural using the
+the singular form with the letter \qt{s} appended, but in the case of
+\qt{potato} I had to specify the correct plural using the
\texttt{plural} key.
As I mentioned earlier, using \TeX\ to sort the entries is the
@@ -267,7 +277,7 @@ The \meta{name} is the word, phrase or symbol you are defining,
and \meta{description} is the description to be displayed in the
glossary.
-This command is a ``short'' command, which means that
+This command is a \qt{short} command, which means that
\meta{description} can't contain a~paragraph break. If you have
a~long description, you can instead use:
\begin{definition}
@@ -283,7 +293,7 @@ a~long description, you can instead use:
Examples:
\begin{enumerate}
-\item Define the term ``set'' with the label \texttt{set}:
+\item Define the term \qt{set} with the label \texttt{set}:
\begin{verbatim}
\newglossaryentry{set}
{
@@ -302,7 +312,7 @@ Examples:
}
\end{verbatim}
-\item Define the phrase ``Fish Age'' with the label
+\item Define the phrase \qt{Fish Age} with the label
\texttt{fishage}:
\begin{verbatim}
\longnewglossaryentry{fishage}
@@ -356,9 +366,9 @@ acronym and \meta{long} is the long form. For example:
\newacronym{svm}{svm}{support vector machine}
\end{verbatim}
This defines a glossary entry with the label \texttt{svm}. By
-default, the \meta{name} is set to \meta{short} (``svm'' in the
+default, the \meta{name} is set to \meta{short} (\qt{svm} in the
above example) and the \meta{description} is set to \meta{long}
-(``support vector machine'' in the above example). If, instead, you
+(\qt{support vector machine} in the above example). If, instead, you
want to be able to specify your own description you can do this
using the optional argument:
\begin{verbatim}
@@ -404,7 +414,7 @@ the glossary as \qt{Latin Alphabet}.
Another commonly used key is \texttt{plural} for specifying the
plural of the term. This defaults to the value of the \texttt{text}
-key with an ``s'' appended, but if this is incorrect, just use the
+key with an \qt{s} appended, but if this is incorrect, just use the
\texttt{plural} key to override it:
\begin{verbatim}
\newglossaryentry{oesophagus}
@@ -424,7 +434,7 @@ The plural forms for acronyms can be specified using the
[longplural={diagonal matrices}]
{dm}{DM}{diagonal matrix}
\end{verbatim}
-If omitted, the defaults are again obtained by appending an ``s'' to
+If omitted, the defaults are again obtained by appending an \qt{s} to
the singular versions.
It's also possible to have both a~name and a~corresponding symbol.
@@ -530,7 +540,7 @@ a little more detail:
\item Run \LaTeX\ twice on your document. (As you would do to
make a~table of contents appear.) For example, click twice on
- the ``typeset'' or ``build'' or ``PDF\LaTeX'' button in your editor.
+ the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor.
\end{enumerate}
\item[]\optionlabel2:
@@ -583,7 +593,8 @@ makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
different method of doing this, so I~can't give a~general
description. You will have to check your editor's manual.
- The default sort is word order (``sea lion'' comes before ``seal'').
+ The default sort is word order (\qt{sea lion} comes before
+\qt{seal}).
If you want letter ordering you need to add the \texttt{-l}
switch:
\begin{verbatim}
@@ -657,7 +668,8 @@ xindy -L english -C utf8 -I xindy -M myDoc
different method of doing this, so I~can't give a~general
description. You will have to check your editor's manual.
- The default sort is word order (``sea lion'' comes before ``seal'').
+ The default sort is word order (\qt{sea lion} comes before
+\qt{seal}).
If you want letter ordering you need to add the
\texttt{order=letter} package option:
\begin{verbatim}
@@ -745,7 +757,8 @@ this entry before the \qt{A} letter group since it starts with a symbol.
\item[\opt2:] The sort key will be interpreted the sequence of characters:
\verb|{| \verb|\| \verb|'| \texttt{e} \verb|}| \texttt{l} \texttt{i} \texttt{t}
and \texttt{e}. The first character is an opening curly brace
-\verb|{| so \texttt{makeindex} will put this entry in the ``symbols'' group.
+\verb|{| so \texttt{makeindex} will put this entry in the
+\qt{symbols} group.
\item[\opt3:]
\texttt{xindy} disregards \LaTeX\ commands so it sorts on
@@ -870,14 +883,14 @@ style using:
There are a~number of predefined styles. Glossaries can vary from
a~list of symbols with a~terse description to a~list of words or
phrases with descriptions that span multiple paragraphs, so there's
-no ``one style fits all'' solution. You need to choose a~style that
+no \qt{one style fits all} solution. You need to choose a~style that
suits your document.
Examples:
\begin{enumerate}
\item You have entries where the name is a~symbol and the
description is a~brief phrase or short sentence. Try one of the
- ``mcol'' styles defined in the \sty{glossary-mcols} package. For example:
+ \qt{mcol} styles defined in the \sty{glossary-mcols} package. For example:
\begin{verbatim}
\usepackage[nogroupskip,nopostdot]{glossaries}
\usepackage{glossary-mcols}
@@ -885,7 +898,7 @@ Examples:
\end{verbatim}
\item You have entries where the name is a~word or phrase and the
-description spans multiple paragraphs. Try one of the ``altlist'' styles. For
+description spans multiple paragraphs. Try one of the \qt{altlist} styles. For
example:
\begin{verbatim}
\usepackage[nopostdot]{glossaries}
@@ -900,7 +913,7 @@ example:
\usepackage[nopostdot,nonumberlist]{glossaries}
\setglossarystyle{long4col}
\end{verbatim}
-or one of the ``tree'' styles:
+or one of the \qt{tree} styles:
\begin{verbatim}
\usepackage[nopostdot,nonumberlist]{glossaries}
\setglossarystyle{tree}