diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex | 83 |
1 files changed, 33 insertions, 50 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 6c2899afc2f..750445bdd81 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -4,7 +4,7 @@ \ifpdf \usepackage[T1]{fontenc} \usepackage{mathpazo} -\usepackage[scaled=.86]{helvet} +\usepackage[scaled=.88]{helvet} \usepackage{courier} \usepackage{xr-hyper} \fi @@ -13,12 +13,12 @@ \title{The glossaries package: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2010-05-28} +\date{2011-04-02} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} -\ifpdf\externaldocument{glossaries}\fi +\ifpdf\externaldocument{glossaries-user}\fi \begin{document} \maketitle @@ -27,7 +27,7 @@ This document is a brief guide to the \styfmt{glossaries} package for beginners who find the size of the main user manual daunting and, as such, it only covers the basics. For more advanced topics, see the -\altdocref{main user manual}{glossaries}{glossaries-manual}. +\docref{main user manual}{glossaries-user}. \end{abstract} \tableofcontents @@ -37,7 +37,8 @@ such, it only covers the basics. For more advanced topics, see the You need to have the \styfmt{glossaries} package installed. You also need to have the following packages installed: \sty{ifthen}, -\sty{xkeyval} (at least version 2.5f), \sty{xfor} and \sty{amsgen}. +\sty{xkeyval} (at least version 2.5f), \sty{xfor}, \sty{amsgen} and +\sty{etoolbox}. You may also need \sty{longtable}, \sty{supertabular} and \sty{array}, depending on what glossary style you want to use. All these packages can be downloaded from CTAN if you don't have them @@ -64,11 +65,13 @@ The most obvious things to do is to remember to load the \begin{verbatim} \usepackage{glossaries} \end{verbatim} +\begin{important} 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}. +\end{important} If you want to use \app{xindy} rather than \app{makeindex} to sort the glossaries, you need to specify this in the package options: @@ -76,9 +79,7 @@ glossaries, you need to specify this in the package options: \usepackage[xindy]{glossaries} \end{verbatim} Other package options are described in -%\latexhtml{section~\ref{sec:pkgopts}}{the section -%\htmladdnormallink{\qt{Package Options}}{glossaries-manual.html#sec:pkgopts}} -\xrsectionref{sec:pkgopts}{glossaries-manual}{Package Options} +\xrsectionref{sec:pkgopts}{glossaries-user}{Package Options} in the main \sty{glossaries} user manual. Next, you need to enable the creation of the various external @@ -100,9 +101,8 @@ where \meta{label} is a unique label used to identify the term. The second argument, \meta{settings}, is a key=value comma separated list that is used to set the required information for the term. A full list of available keys can be found in -\xrsectionref{sec:newglosentry}{glossaries-manual}{Defining Glossary +\xrsectionref{sec:newglosentry}{glossaries-user}{Defining Glossary Entries} -%\latexhtml{section~\ref{sec:newglosentry}}{\htmladdnormallink{\qt{Defining Glossary Entries}}{glossaries-manual.html#sec:newglosentry}} in the main \sty{glossaries} user manual. The principle keys are \gloskey{name} and \gloskey{description}. @@ -136,7 +136,8 @@ specify how to sort the term: \begin{verbatim} \newglossaryentry{oesophagus}{name=\oe sophagus, description={canal from mouth to stomach}, -plural=\oe sophagi,sort=oesophagus} +plural=\oe sophagi, +sort=oesophagus} \end{verbatim} Note, however, that if you use the \sty{inputenc} package and \app{xindy}, you can use the encoded character \texttt{œ} rather than @@ -181,11 +182,8 @@ in the glossary. Once you have defined a term, you can use it in the document. The \sty{glossaries} package provides a number of commands that are -described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to -Glossary Entries} -%\latexhtml{section~\ref{sec:glslink}}{the section -%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} - in the main \sty{glossaries} user manual. +described in \xrsectionref{sec:glslink}{glossaries-user}{Links to +Glossary Entries} in the main \sty{glossaries} user manual. Here, I shall just cover the main commands: \begin{definition} \cs{gls}\marg{label} @@ -218,25 +216,21 @@ For example: bases or acids. \end{verbatim} -Note that these commands all have two optional arguments that -aren't discussed here, but they are -described in \xrsectionref{sec:glslink}{glossaries-manual}{Links to -Glossary Entries} -%\latexhtml{section~\ref{sec:glslink}}{the section -%\htmladdnormallink{\qt{Links to Glossary Entries}}{glossaries-manual.html#sec:glslink}} -in the main \sty{glossaries} user manual. +Note that these commands all have two optional arguments that aren't +discussed here, but they are described in +\xrsectionref{sec:glslink}{glossaries-user}{Links to Glossary +Entries} in the main \sty{glossaries} user manual. -\textbf{Caveat:} don't use these commands in moving arguments, such +\begin{important} +Don't use these commands in moving arguments, such as those used by \cs{chapter}, \cs{section} and \cs{caption}. +\end{important} You can, instead, use commands such as \begin{definition} \cs{glsentrytext}\marg{label} \end{definition} -See \xrsectionref{sec:glsnolink}{glossaries-manual}{Using Glossary -Terms Without Links} -%\latexhtml{section~\ref{sec:glsnolink}}{the section -%\htmladdnormallink{\qt{Using Glossary Terms Without Links}}{glossaries-manual.html#sec:glsnolink}} -in the main \sty{glossaries} user manual. +See \xrsectionref{sec:glsnolink}{glossaries-user}{Using Glossary +Terms Without Links} in the main \sty{glossaries} user manual. \section{Acronyms} \label{acronyms} @@ -249,11 +243,8 @@ placed in a separate list of acronyms: \usepackage[acronym]{glossaries} \end{verbatim} There are other options that govern how acronyms appear. For further -details, see \xrsectionref{sec:acronyms}{glossaries-manual}{Acronyms} -%\latexhtml{section~\ref{sec:acronyms}}{the section -%\htmladdnormallink{\qt{Acronyms}}{glossaries-manual.html#sec:acronyms}} -in -the main \sty{glossaries} user manual. +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} @@ -293,10 +284,8 @@ or you can reset all acronyms using \cs{glsresetall} \end{definition} For further details on resetting and unsetting acronyms, see -\xrsectionref{sec:glsunset}{glossaries-manual}{Unsetting and +\xrsectionref{sec:glsunset}{glossaries-user}{Unsetting and Resetting Entry Flags} -%\latexhtml{section~\ref{sec:glsunset}}{the section -%\htmladdnormallink{\qt{Unsetting and Resetting Entry Flags}}{glossaries-manual.html#sec:glsunset}} in the main \sty{glossaries} user manual. \section{Displaying the Glossary or List of Acronyms} @@ -339,13 +328,11 @@ as WinEdt or TeXnicCenter) and you want it to automatically run makeglossaries when you build your document, you will need to consult the front-end's documentation. -If you don't have Perl installed, you will need to call \app{makeindex} -or \app{xindy} explicitly. This is more complicated and is described in -\xrsectionref{sec:makeglossaries}{glossaries-manual}{Generating the -Associated Glossary Files} -%\latexhtml{section~\ref{sec:makeglossaries}}{the section -%\htmladdnormallink{\qt{Generating the Associated Glossary Files}}{glossaries-manual.html#sec:makeglossaries}} -in the main \sty{glossaries} user manual. +If you don't have Perl installed, you will need to call +\app{makeindex} or \app{xindy} explicitly. This is more complicated +and is described in +\xrsectionref{sec:makeglossaries}{glossaries-user}{Generating the +Associated Glossary Files} in the main \sty{glossaries} user manual. \item Once you have successfully run the indexing application, you need to build/\LaTeX\ your document again (see step~1). @@ -355,9 +342,7 @@ Note that sometimes you may have to repeat steps~2 and~3. The appearance of the glossary depends on the glossary style in use. The default style uses the \env{description} environment, but there are many other styles available. These are described -in \xrsectionref{sec:styles}{glossaries-manual}{Glossary Styles} -%\latexhtml{section~\ref{sec:styles}}{the section -%\htmladdnormallink{\qt{Glossary Styles}}{glossaries-manual.html#sec:styles}} +in \xrsectionref{sec:styles}{glossaries-user}{Glossary Styles} in the main \sty{glossaries} user manual. By default, a number or list of numbers will appear after each entry in the glossary. This indicates the page (or pages) @@ -368,9 +353,7 @@ the \pkgopt{nonumberlist} package option: \end{verbatim} Further information can be found in the main \sty{glossaries} -\altdocref{user manual}{glossaries}{glossaries-manual} -%\latexhtml{user manual (\href{glossaries.pdf}{glossaries.pdf})}{\htmladdnormallink{user -%manual}{glossaries-manual.html}} +\docref{user manual}{glossaries-user} and there is also an \href{http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{article on the glossaries package} on the \urlfootref{http://www.latex-community.org/}{\LaTeX\ Community's} |