\documentclass[a4paper]{ltxdoc}
\usepackage{ifthen}
\usepackage{alltt}
\usepackage{pifont}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{cmap}
\usepackage[colorlinks,
            bookmarks,
            hyperindex=false,
            pdfauthor={Nicola L.C. Talbot},
            pdftitle={glossaries.sty: LaTeX2e Package to Assist Generating Glossaries},
            pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref}

 %hyperindex conflicts with doc
 %(end up with |usage|hyperpage in indexentry)
 %This unfortunately means that the changes section doesn't
 %have active links, but at least it will keep makeindex happy.

\usepackage{creatdtx}
\ifmakedtx{
\renewcommand{\usage}[1]{\textit{\hyperpage{#1}}}
\renewcommand{\main}[1]{\hyperpage{#1}}
\newcommand{\see}[2]{\emph{see} #1}
\makeatletter
\def\index@prologue{\section*{Index}}
\makeatother
\RecordChanges
\PageIndex
\CheckSum{8711}
\CodelineNumbered
\newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}}
\newcommand*{\term}[1]{#1\iterm{#1}}
\newcommand*{\iterm}[1]{\index{#1|main}}
\newcommand{\dq}[1]{``#1''}
\newcommand*{\tableref}[1]{\hyperref[#1]{table~\ref*{#1}}}
\newcommand*{\Tableref}[1]{\hyperref[#1]{Table~\ref*{#1}}}
\newlength\boxlength
\newsavebox\importantbox
\newenvironment{important}{%
\setlength{\fboxrule}{4pt}%
\setlength\boxlength{\linewidth}%
\addtolength\boxlength{-2\fboxsep}%
\addtolength\boxlength{-2\fboxrule}%
\begin{lrbox}{\importantbox}%
\begin{minipage}{\boxlength}%
}{\end{minipage}\end{lrbox}%
\par\vskip10pt\noindent
\fcolorbox{red}{white}{\usebox{\importantbox}}\par\vskip10pt}
\newcommand*{\tick}{\ding{51}}
}
{
\usepackage{html}
\usepackage{makeidx}
\renewcommand{\LaTeX}{LaTeX}
\renewcommand{\LaTeXe}{LaTeX2e}
\newcommand*{\termdef}[1]{\emph{#1}\index{#1}}
\newcommand*{\term}[1]{#1\index{#1}}
\newcommand*{\iterm}[1]{\index{#1}}
\newcommand{\dq}[1]{"#1"}
\newcommand*{\tableref}[1]{\htmlref{table~}{#1}\ref{#1}}
\newcommand*{\Tableref}[1]{\htmlref{Table~}{#1}\ref{#1}}
\newenvironment{important}{}{}
\newcommand*{\tick}{X}
}


\newcommand*{\ifirstuse}{\iterm{first use}}
\newcommand*{\firstuse}{first use\ifirstuse}
\newcommand*{\firstuseflag}{first use flag\ifirstuseflag}
\newcommand*{\firstusetext}{first use text\ifirstusetext}
\ifmakedtx{
\newcommand*{\ifirstuseflag}{\iterm{first use>flag}}
\newcommand*{\ifirstusetext}{\iterm{first use>text}}
\newcommand*{\istkey}[1]{\texttt{#1}\index{makeindex=\texttt{makeindex}>#1=\texttt{#1}|hyperpage}}
\newcommand*{\locfmt}[1]{\texttt{#1}\SpecialMainIndex{#1}}
\newcommand*{\ics}[1]{\texttt{\char`\\#1}\SpecialMainIndex{#1}}
\newcommand*{\appname}[1]{\texttt{#1}\index{#1=\texttt{#1}|hyperpage}}
\newcommand*{\mkidxspch}{\index{makeindex=\texttt{makeindex}>special characters|hyperpage}}
\newcommand*{\igloskey}[2][newglossaryentry]{\index{#1 options=\cs{#1} options>#2=\textsf{#2}|hyperpage}}
\newcommand*{\gloskey}[2][newglossaryentry]{\textsf{#2}\igloskey[#1]{#2}}
\newcommand*{\pkgoptni}[1]{\textsf{#1}}
\newcommand*{\ipkgopt}[2][]{%
\ifthenelse{\equal{#1}{}}{%
\index{package options>#2=\pkgoptni{#2}|hyperpage}}{%
\index{package options>#2=\pkgoptni{#2}>#1=\pkgoptni{#1}|hyperpage}}}
\newcommand*{\pkgopt}[2][]{%
\ifthenelse{\equal{#1}{}}{%
\pkgoptni{#2}\index{package options>#2=\pkgoptni{#2}|hyperpage}}{%
\pkgoptni{#2=#1}\index{package options>#2=\pkgoptni{#2}>#1=\pkgoptni{#1}|hyperpage}}}
\newcommand*{\pkgoptval}[2]{\pkgoptni{#1}\index{package options>#2=\pkgoptni{#2}>#1=\pkgoptni{#1}|hyperpage}}
\newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles>#1|hyperpage}}
\newcommand*{\filetype}[1]{\texttt{#1}\index{file types>#1|hyperpage}}
\newcommand*{\sty}[1]{\textsf{#1}}
\newcommand*{\isty}[1]{\sty{#1}\index{#1 package=\sty{#1} package|hyperpage}}
\newcommand*{\cls}[1]{\textsf{#1}}
\newcommand*{\icls}[1]{\cls{#1}\index{#1 class=\cls{#1} class|hyperpage}}
\newcommand*{\envname}[1]{\textsf{#1}}
}
{
\newcommand*{\ifirstuseflag}{\iterm{first use!flag}}
\newcommand*{\ifirstusetext}{\iterm{first use!text}}
\newcommand{\istkey}[1]{\texttt{#1}\index{makeindex key!#1}}
\newcommand{\locfmt}[1]{\texttt{#1}\index{#1@\cs{#1}}}
\newcommand{\ics}[1]{\texttt{\char`\\#1}\index{#1@\cs{#1}}}
\html{\newcommand{\SpecialMainIndex}[1]{\index{#1@\cs{#1}}}}
\newcommand{\appname}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
\newcommand*{\mkidxspch}{\index{makeindex@\texttt{makeindex}!special characters|hyperpage}}
\newcommand{\gloskey}[2][newglossaryentry]{\texttt{#2}\index{#1 keys@\cs{#1} keys!#2}}
\newcommand*{\pkgoptni}[1]{\texttt{#1}}
\newcommand{\ipkgopt}[2][]{%
\ifthenelse{\equal{#1}{}}{%
\index{package options!#2}}{%
\index{package options!#2!#1}}}
\newcommand{\pkgopt}[2][]{%
\ifthenelse{\equal{#1}{}}{%
\pkgoptni{#2}\index{package options!#2}}{%
\pkgoptni{#2=#1}\index{package options!#2!#1}}}
\newcommand{\pkgoptval}[2]{\pkgoptni{#1}\index{package options!#2!#1}}
\newcommand{\glostyle}[1]{\texttt{#1}\index{glossary styles!#1}}
\newcommand{\filetype}[1]{\texttt{#1}\index{file types!#1}}
\newcommand{\sty}[1]{\texttt{#1}}
\newcommand{\isty}[1]{\sty{#1}\index{#1@\sty{#1}}}
\newcommand{\cls}[1]{\texttt{#1}}
\newcommand{\icls}[1]{\cls{#1}\index{#1@\cls{#1}}}
\newcommand{\envname}[1]{\texttt{#1}}
\newcommand{\toTop}{\mbox{}\par\htmlref{Top}{top}}
}

\begin{document}\ifmakedtx{}{\label{top}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}

 \title{glossaries.sty v 2.02: \LaTeXe\ Package to Assist Generating Glossaries}
 \author{Nicola L.C. Talbot\\[10pt]
School of Computing Sciences\\
University of East Anglia\\
Norwich. Norfolk\\
NR4 7TJ. United Kingdom.\\
\url{http://theoval.cmp.uea.ac.uk/~nlct/}}

 \date{13th July 2009}
 \maketitle
\tableofcontents

 \section{Introduction}

 \changes{1.0}{2007 May 16}{Initial version}
The \sty{glossaries} package is provided to assist generating
glossaries.  It has a certain amount of flexibility, allowing the
user to customize the format of the glossary and define multiple
glossaries.  It also supports acronyms and glossary styles that
include symbols (in addition to a name and description) for glossary
entries. There is provision for loading a database of glossary terms.
Only those terms used\footnote{that is, if the term has been
referenced using any of the commands described in \ifmakedtx{\autoref{sec:glslink}}{%
\htmlref{Links to Glossary Entries}{sec:glslink}}, 
\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an Entry to the 
Glossary Without Generating Text}{sec:glsadd}} or 
via \ics{glssee} (or the \gloskey{see} key)} in the document will be 
added to the glossary.

\textbf{This package replaces the \isty{glossary} package which is
now obsolete.} Please see 
\ifmakedtx{the document \dq{Upgrading from the glossary package to 
the glossaries package} (\href{glossary2glossaries.pdf}{glossary2glossaries.pdf})}{\htmladdnormallink{Upgrading from the glossary package 
to the glossaries package}{glossary2glossaries.html}} 
for assistance in upgrading. 

One of the strengths of this package is its flexibility, however
the drawback of this is the necessity of having a large manual
that can cover all the various settings. If you are daunted by the
size of the manual, try starting off with the much shorter
\ifmakedtx{guide for beginners (\href{glossariesbegin.pdf}{glossariesbegin.pdf})}{%
\htmladdnormallink{guide for beginners}{glossariesbegin.html}}.

\begin{important}
The \sty{glossaries} package comes with a 
\htmladdnormallink{Perl}{http://www.perl.org/about.html} script 
called \appname{makeglossaries}. This provides a convenient interface
to \appname{makeindex} or \appname{xindy}. It is strongly
recommended that you use this script, but \emph{it is not
essential}. If you are reluctant to install Perl, or for any
other reason you don't want to use \appname{makeglossaries}, you
can called \appname{makeindex} or \appname{xindy} explicitly.
See \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the
Associated Glossary Files}{sec:makeglossaries}} for 
further details.
\end{important}

This manual is structured as follows:
\begin{itemize}
\item \ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview of Main User Commands}{sec:overview}} 
gives an overview of the main user commands and their syntax.

\item \ifmakedtx{\autoref{sec:mfirstuc}}{\htmlref{Mfirstuc}{sec:mfirstuc}} 
describes the associated \sty{mfirstuc} package.

\ifmakedtx{\item
\autoref{sec:code} contains the documented source code for those who
want to know more about how the package works. This describes more
advanced commands, such as determining if an entry or a glossary
exists and commands that iterate through defined terms or glossaries.

\item \autoref{sec:code:mfirstuc} contains the documented code for 
the \sty{mfirstuc} package.}{} 
\end{itemize}
\ifmakedtx{}{The \htmladdnormallink{PDF version}{glossaries.pdf} of 
this manual also describes more advanced commands in the documented 
code section (such as determining if an entry or a glossary exists
and commands that iterate through defined terms or glossaries).}

\noindent The remainder of this introductory section covers the
following:
\begin{itemize}
\item \ifmakedtx{\autoref{sec:samples}}{\htmlref{Sample 
Documents}{sec:samples}} lists the sample documents provided 
with this package.

\item \ifmakedtx{\autoref{sec:languages}}{\htmlref{Multi-Lingual 
Support}{sec:languages}} provides information for users who
wish to write in a language other than English.

\item \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating 
the Associated Glossary Files}{sec:makeglossaries}} 
describes how to use a post-processor to create the sorted glossaries
for your document.

\item \ifmakedtx{\autoref{sec:trouble}}{\htmlref{Troubleshooting}{sec:trouble}} provides some assistance in the event that you 
encounter a problem.
\end{itemize}
\ifmakedtx{}{\toTop}

\subsection{Sample Documents}
\label{sec:samples}

The \sty{glossaries} package is provided with some sample
documents that illustrate the various functions. These should
be located in the \texttt{samples} subdirectory (folder) of the
\sty{glossaries} documentation directory. This location varies
according to your operating system and \TeX\ distribution. You
can use \texttt{texdoc} to locate the main glossaries documentation.
For example, in a terminal or command prompt, type:
\begin{verbatim}
texdoc -l glossaries
\end{verbatim}
This should display the full pathname of the file 
\texttt{glossaries.pdf}. View the contents of that directory and
see if it contains the \texttt{samples} subdirectory.

If you can't find the sample files, they are available in the
subdirectory \texttt{doc/latex/glossaries/samples/} in the
\texttt{glossaries.tds.zip} archive which can be downloaded from
\ifmakedtx{\href{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}{CTAN}}{\htmladdnormallink{CTAN}{http://tug.ctan.org/tex-archive/macros/latex/contrib/glossaries/}}.


The sample documents are as follows:
\begin{description}
\item[minimalgls.tex]\label{ex:minimalgls} This document is a minimal working example.
You can test your installation using this file. To create the
complete document you will need to do the following steps:
  \begin{enumerate}
  \item Run \texttt{minimalgls.tex} through \LaTeX\ by either 
  typing
\begin{verbatim}
latex minimalgls
\end{verbatim}
  in a terminal or by using the relevant button or menu item in
  your text editor or front-end. This will create the required 
  associated files but you will not see the glossary. If you use 
  PDF\LaTeX\ you will also get warnings about non-existent 
  references. These warnings may be ignored on the first run.

  If you get a \verb"Missing \begin{document}" error, then 
  it's most likely that your version of \isty{xkeyval} is 
  out of date. Check the log file for a warning of that nature. 
  If this is the case, you will need to update the \sty{xkeyval}
  package.

  \item Run \appname{makeglossaries} on the document. This can
  be done on a terminal by either typing
\begin{verbatim}
makeglossaries minimalgls
\end{verbatim}
  or by typing
\begin{verbatim}
perl makeglossaries minimalgls
\end{verbatim}
  If your system doesn't recognise the command \texttt{perl} then
  it's likely you don't have Perl installed. In which case you
  will need to use \appname{makeindex} directly. You can do this
  in a terminal by typing (all on one line):
\begin{verbatim}
makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls
minimalgls.glo
\end{verbatim}
  (See
\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{later}{sec:makeindexapp}} 
  for further details on using \appname{makeindex} explicitly.)

  Note that if you need to specify the full path and the path
  contains spaces, you will need to delimit the file names with
  the double-quote character.

  \item Run \texttt{minimalgls.tex} through \LaTeX\ again (as step~1)
  \end{enumerate}
You should now have a complete document. The number following
each entry in the glossary is the location number. By default, this 
is the page number where the entry was referenced.

\item[sample4col.tex]\label{ex:sample4col} This document illustrates a four column
glossary where the entries have a symbol in addition to the
name and description. To create the complete document, you need
to do:
\begin{verbatim}
latex sample4col
makeglossaries sample4col
latex sample4col
\end{verbatim}
As before, if you don't have Perl installed, you will need to 
use \appname{makeindex} directly instead of using 
\appname{makeglossaries}. The vertical gap between entries 
is the gap created at the start of each group. This can be
suppressed by redefining \ics{glsgroupskip} after the glossary
style has been set:
\begin{verbatim}
\renewcommand*{\glsgroupskip}{}
\end{verbatim}

\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some sample acronyms. It
also adds the glossary to the table of contents, so an extra
run through \LaTeX\ is required to ensure the document is up to date:
\begin{verbatim}
latex sampleAcr
makeglossaries sampleAcr
latex sampleAcr
latex sampleAcr
\end{verbatim}

\item[sampleAcrDesc.tex]\label{ex:sampleAcrDesc} This is similar to the previous example,
except that the acronyms have an associated description. As with
the previous example, the glossary is added to the table of
contents, so an extra run through \LaTeX\ is required:
\begin{verbatim}
latex sampleAcrDesc
makeglossaries sampleAcrDesc
latex sampleAcrDesc
latex sampleAcrDesc
\end{verbatim}

\item[sampleDesc.tex]\label{ex:sampleDesc} This is similar to the previous example, 
except that it defines the acronyms using \ics{newglossaryentry}
instead of \ics{newacronym}. As with
the previous example, the glossary is added to the table of
contents, so an extra run through \LaTeX\ is required:
\begin{verbatim}
latex sampleDesc
makeglossaries sampleDesc
latex sampleDesc
latex sampleDesc
\end{verbatim}

\item[sampleDB.tex]\label{ex:sampleDB} This document illustrates how to load 
external files containing the glossary definitions. It also
illustrates how to define a new glossary type. This document
has the \term{number list} suppressed and uses \ics{glsaddall} to add
all the entries to the glossaries without referencing each one
explicitly. To create the document do:
\begin{verbatim}
latex sampleDB
makeglossaries sampleDB
latex sampleDB
\end{verbatim}
The glossary definitions are stored in the accompanying files 
\texttt{database1.tex} and \texttt{database2.tex}. Note that if
you don't have Perl installed, you will need to use
\appname{makeindex} twice instead of a single call to 
\appname{makeglossaries}:
\begin{enumerate}
\item Create the main glossary:
\begin{verbatim}
makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo
\end{verbatim}
\item Create the secondary glossary:
\begin{verbatim}
makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn
\end{verbatim}
\end{enumerate}

\item[sampleEq.tex]\label{ex:sampleEq} This document illustrates how to change the
location to something other than the page number. In this case,
the \texttt{equation} counter is used since all glossary entries
appear inside an \envname{equation} environment. To create the
document do:
\begin{verbatim}
latex sampleEq
makeglossaries sampleEq
latex sampleEq
\end{verbatim}

\item[sampleEqPg.tex]\label{ex:sampleEqPg} This is similar to the previous example,
but the number lists\iterm{number list} are a mixture of page 
numbers and equation numbers. This example adds the glossary to the 
table of contents, so an extra \LaTeX\ run is required:
\begin{verbatim}
latex sampleEqPg
makeglossaries sampleEqPg
latex sampleEqPg
latex sampleEqPg
\end{verbatim}

\item[sampleSec.tex]\label{ex:sampleSec} This document also illustrates how to change
the location to something other than the page number. In this case,
the \texttt{section} counter is used.  This example adds the 
glossary to the table of contents, so an extra \LaTeX\ run is 
required:
\begin{verbatim}
latex sampleSec
makeglossaries sampleSec
latex sampleSec
latex sampleSec
\end{verbatim}

\item[sampleNtn.tex]\label{ex:sampleNtn} This document illustrates how to create
an additional glossary type. This example adds the glossary to the 
table of contents, so an extra \LaTeX\ run is required:
\begin{verbatim}
latex sampleNtn
makeglossaries sampleNtn
latex sampleNtn
latex sampleNtn
\end{verbatim}
Note that if you don't have Perl installed, you will need to use
\appname{makeindex} twice instead of a single call to 
\appname{makeglossaries}:
\begin{enumerate}
\item Create the main glossary:
\begin{verbatim}
makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo
\end{verbatim}
\item Create the secondary glossary:
\begin{verbatim}
makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn
\end{verbatim}
\end{enumerate}

\item[sample.tex]\label{ex:sample} This document illustrates some of the basics,
including how to create child entries that use the same name as the 
parent entry.  This example adds the glossary to the table of 
contents, so an extra \LaTeX\ run is required:
\begin{verbatim}
latex sample
makeglossaries sample
latex sample
latex sample
\end{verbatim}
You can see the difference between word and letter ordering
if you substitute \pkgopt[word]{order} with
\pkgopt[letter]{order}. (Note that this will only have an
effect if you use \appname{makeglossaries}. If you use
\appname{makeindex} explicitly, you will need to use the
\texttt{-l} switch to indicate letter ordering.)

\item[sampletree.tex]\label{ex:sampletree} This document illustrates a hierarchical
glossary structure where child entries have different names
to their corresponding parent entry. To create the document do:
\begin{verbatim}
latex sampletree
makeglossaries sampletree
latex sampletree
\end{verbatim}

\item[samplexdy.tex]\label{ex:samplexdy} This document illustrates how to use the
\sty{glossaries} package with \appname{xindy} instead of
\appname{makeindex}. The document uses UTF8 encoding (with the
\isty{inputenc} package). The encoding is picked up by 
\appname{makeglossaries}. By default, this document will create
a \appname{xindy} style file called \texttt{samplexdy.xdy}, but
if you uncomment the lines
\begin{verbatim}
\setStyleFile{samplexdy-mc}
\noist
\GlsSetXdyLanguage{}
\end{verbatim}
it will set the style file to \texttt{samplexdy-mc.xdy} instead.
This provides an additional letter group for entries starting
with \dq{Mc} or \dq{Mac}. If you use \appname{makeglossaries}, 
you don't need to supply any additional information. If you
don't use \appname{makeglossaries}, you will need to specify the
required information. Note that if you set the style file to
\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, 
otherwise the \isty{glossaries} package will overwrite 
\texttt{samplexdy-mc.xdy} and you will lose the \dq{Mc} letter group.

To create the document do:
\begin{verbatim}
latex samplexdy
makeglossaries samplexdy
latex samplexdy
\end{verbatim}
If you don't have Perl installed, you will have to call 
\appname{xindy} explicitly instead of using \appname{makeglossaries}.
If you are using the default style file \texttt{samplexdy.xdy}, then
do (no line breaks):
\begin{verbatim}
xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg
-o samplexdy.gls samplexdy.glo
\end{verbatim}
otherwise, if you are using \texttt{samplexdy-mc.xdy}, then do
(no line breaks):
\begin{verbatim}
xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls
samplexdy.glo
\end{verbatim}

\item[sampleutf8.tex]\label{ex:sampleutf8} This is another example that uses 
\appname{xindy}. Unlike \appname{makeindex}, \appname{xindy} can
cope with accented or non-Latin characters. This document uses
UTF8 encoding. To create the document do:
\begin{verbatim}
latex sampleutf8
makeglossaries sampleutf8
latex sampleutf8
\end{verbatim}
If you don't have Perl installed, you will have to call 
\appname{xindy} explicitly instead of using \appname{makeglossaries}
(no line breaks):
\begin{verbatim}
xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg
-o sampleutf8.gls sampleutf8.glo
\end{verbatim}

If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} 
and do:
\begin{verbatim}
latex sampleutf8
makeglossaries sampleutf8
latex sampleutf8
\end{verbatim}
you will see that the entries that start with a non-Latin character
now appear in the symbols group, and the word \dq{man\oe uvre} is now 
after \dq{manor} instead of before it. If you are unable to use
\appname{makeglossaries}, the call to \appname{makeindex} is as
follows (no line breaks):
\begin{verbatim}
makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls
sampleutf8.glo
\end{verbatim}

\item[sampleaccsupp.tex]\label{ex:sampleaccsupp} This document
uses the experimental \isty{glossaries-accsupp} package. The
symbol is set to the replacement text. Note that some PDF
viewers don't use the accessibility support. Information 
about the \sty{glossaries-accsupp} package can be found in
\ifmakedtx{\autoref{sec:accsupp}}{\htmlref{\dq{Accessibility Support}}{sec:accsupp}}.


\end{description}
\ifmakedtx{}{\toTop}

\subsection{Multi-Lingual Support}
\label{sec:languages}

As from version 1.17, the \sty{glossaries} package can now be
used with \appname{xindy} as well as \appname{makeindex}. If you
are writing in a language that uses accented characters or
non-Latin characters it is recommended that you use \appname{xindy}
as \appname{makeindex} is hard-coded for Latin languages. This
means that you are not restricted to the A, \ldots, Z letter groups.
If you want to use \appname{xindy}, remember to use the
\pkgopt{xindy} package option. For example:
\begin{verbatim}
\documentclass[frenchb]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{babel}
\usepackage[xindy]{glossaries}
\end{verbatim}

\begin{important}
If you use an accented or other expandable character at the start of
an entry name, you must place it in a group, or it will cause
a problem for commands that convert the first letter to uppercase
(e.g.\ \ics{Gls}) due to expansion issues. For example:
\begin{verbatim}
\newglossaryentry{elite}{name={{é}lite},
description={select group or class}}
\end{verbatim}
\end{important}

If you use the \isty{inputenc} package, \appname{makeglossaries}
will pick up the encoding from the auxiliary file. If you use
\appname{xindy} explicitly instead of via \appname{makeglossaries},
you may need to specify the encoding using the \texttt{-C} 
option. Read the \appname{xindy} manual for further details.

\subsubsection{Changing the Fixed Names}
\label{sec:fixednames}

As from version 1.08, the \sty{glossaries} package now has
limited multi-lingual support, thanks to all the people who have sent
me the relevant translations either via email or via 
\texttt{comp.text.tex}.
However you must load \isty{babel} \emph{before} 
\sty{glossaries} to enable this. Note that if \isty{babel} is loaded 
and the \isty{translator} package is detected on \TeX's path, then the
\isty{translator} package will be loaded automatically, however,
it may not pick up on the required languages, so if the predefined
text is not translated, you may need to explicitly load the
\isty{translator} package with the required languages. For example:
\begin{verbatim}
\usepackage[spanish]{babel}
\usepackage[spanish]{translator}
\usepackage{glossaries}
\end{verbatim}
Alternatively, specify the language as a class option rather
than a package option. For example:
\begin{verbatim}
\documentclass[spanish]{report}

\usepackage{babel}
\usepackage{glossaries}
\end{verbatim}

If you want to use \isty{ngerman} or \isty{german} instead
of \isty{babel}, you will need to include the \isty{translator} package 
to provide the translations. For example:
\begin{verbatim}
\documentclass[ngerman]{article}
\usepackage{ngerman}
\usepackage{translator}
\usepackage{glossaries}
\end{verbatim}

The following languages are currently supported by the
\isty{glossaries} package:
\begin{center}
\begin{tabular}{lc}
\bfseries Language & \bfseries As from version\\
Brazilian Portuguese & 1.17\\
Danish & 1.08\\
Dutch & 1.08\\
English & 1.08\\
French & 1.08\\
German & 1.08\\
Irish & 1.08\\
Italian & 1.08\\
Hungarian & 1.08\\
Polish & 1.13\\
Spanish & 1.08
\end{tabular}
\end{center}
The language dependent commands and \isty{translator} keys used by the 
glossaries package are listed in \tableref{tab:predefinednames}.

\begin{table}[htbp]
\caption{Customised Text}
\label{tab:predefinednames}
\begin{center}
\begin{tabular}{@{}llp{0.4\linewidth}@{}}
\bfseries Command Name & \bfseries Translator Key Word &
\bfseries Purpose\\
\ics{glossaryname} & \texttt{Glossary} & Title of the main glossary.\\
\ics{acronymname} & \texttt{Acronyms} & Title of the list of acronyms
(when used with package option \pkgopt{acronym}).\\
\ics{entryname} & \texttt{Notation (glossaries)} & 
Header for first column in the glossary (for 2, 3 or 4 column glossaries 
that support headers).\\
\ics{descriptionname} & \texttt{Description (glossaries)} &
Header for second column in the glossary (for 2, 3 or 4 column glossaries
that support headers).\\
\ics{symbolname} & \texttt{Symbol (glossaries)} & Header for symbol
column in the glossary for glossary styles that support this option.\\
\ics{pagelistname} & \texttt{Page List (glossaries)} & 
Header for page list column in the glossary for glossaries that support 
this option.\\
\ics{glssymbolsgroupname} & \texttt{Symbols (glossaries)} & 
Header for symbols section of the glossary for glossary styles that 
support this option.\\
\ics{glsnumbersgroupname} & \texttt{Numbers (glossaries)} & Header for
numbers section of the glossary for glossary styles that support
this option.
\end{tabular}
\end{center}
\end{table}

Due to the varied nature of glossaries, it's likely that the
predefined translations may not be appropriate. If you are using
the \isty{babel} package and do not have the \isty{translator} package
installed, you need to be familiar with the 
\ifmakedtx{ advice given in 
\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}}{advice on \htmladdnormallink{changing the words babel uses}{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}}. 

If you have the \isty{translator} package installed, then it becomes
much easier to change the default translations. For example, if you
are writing in Irish and you want \cs{symbolname} to produce
\dq{Siombail} instead of \dq{Comhartha}, then you can put the following
in your document preamble:
\begin{verbatim}
\deftranslation[to=Irish]{Symbol (glossaries)}{Siombail}
\end{verbatim}

Note that \appname{xindy} provides much better multi-lingual
support than \appname{makeindex}, so it's recommended that you
use \appname{xindy} if you have glossary entries that contain
accented characters or non-Roman letters. See
\ifmakedtx{\autoref{sec:xindy}}{\htmladdnormallink{Xindy}{sec:xindy}} 
for further details.\ifmakedtx{}{\toTop}

\subsection{Generating the Associated Glossary Files}
\label{sec:makeglossaries}

In order to generate a sorted glossary with compact location lists,
it is necessary to use an external indexing application as an
intermediate step. It is this application that creates the file
containing the code that typesets the glossary. If this step
is omitted, the glossaries will not appear in your document. The
two indexing applications that are most commonly used with
\LaTeX\ are \appname{makeindex} and \appname{xindy}. As
from version 1.17, the \sty{glossaries} package can be used
with either of these applications. Previous versions were designed
to be used with \appname{makeindex} only. Note that 
\appname{xindy} has much better multi-lingual support than
\appname{makeindex}, so \appname{xindy} is recommended if you're 
not writing in English. Commands that only have an
effect when \appname{xindy} is used are described
\ifmakedtx{in \autoref{sec:xindy}}{\htmlref{later}{sec:xindy}}.


The \sty{glossaries} package comes with the Perl script
\appname{makeglossaries} which will run \appname{makeindex} or
\appname{xindy} on all the glossary files using a customized style
file (which is created by \ics{makeglossaries}). See
\ifmakedtx{\autoref{sec:makeglossariesapp}}{\htmlref{Using the
makeglossaries Perl script}{sec:makeglossariesapp}} for further
details. Perl is stable, cross-platform, open source software that
is used by a number of \TeX-related applications. Further
information is available at \url{http://www.perl.org/about.html}.  
However, whilst it is strongly recommended that you use the
\appname{makeglossaries} script, it is possible to use the
\sty{glossaries} package without having Perl installed.  In which
case, if you have used the \pkgopt{xindy} package option, you will
need to use \appname{xindy} (see
\ifmakedtx{\autoref{sec:xindyapp}}{\htmlref{Using xindy 
explicitly}{sec:xindyapp}}), otherwise you will need to use 
\appname{makeindex} (see
\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{Using makeindex 
explicitly}{sec:makeindexapp}}). Note that some commands and
package options have no effect if you don't use
\appname{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 \appname{makeglossaries}, \appname{makeindex}
or \appname{xindy} run, as appropriate. For example,
suppose you have defined the following entries:
\begin{verbatim}
\newglossaryentry{citrusfruit}{name={citrus fruit},
description={fruit of any citrus tree. (See also 
\gls{orange})}}

\newglossaryentry{orange}{name={orange},
description={an orange coloured fruit.}}
\end{verbatim}
and suppose you have \verb|\gls{citrusfruit}| in your document
but don't reference the \texttt{orange} entry, then the
\texttt{orange} entry won't appear in your glossary until
you first create the glossary and then do another run
of \appname{makeglossaries}, \appname{makeindex} or \appname{xindy}.
For example, if the document is called \texttt{myDoc.tex}, then
you must do:
\begin{verbatim}
latex myDoc
makeglossaries myDoc
latex myDoc
makeglossaries myDoc
latex myDoc
\end{verbatim}

Likewise, an additional \appname{makeglossaries} and \LaTeX\ run
may be required if the document pages shift with re-runs. For
example, if the page numbering is not reset after the table of
contents, the insertion of the table of contents on the second
\LaTeX\ run may push glossary entries across page boundaries, which
means that the number lists\iterm{number list} in the glossary may 
need updating.

The examples in this document assume that you are accessing
\appname{makeglossaries}, \appname{xindy} or \appname{makeindex} via
a terminal. Windows users can use the MSDOS Prompt which
is usually accessed via the 
\textsf{Start}\ifmakedtx{$\to$}{-\textgreater}\textsf{All Programs} 
menu or 
\textsf{Start}\ifmakedtx{$\to$}{-\textgreater}\textsf{All Programs}%
\ifmakedtx{$\to$}{-\textgreater}\textsf{Accessories} 
menu. Alternatively, your text editor may have the
facility to create a function that will call the 
required application. See your editor's user manual for further
details.

If any problems occur, remember to check the transcript files 
(e.g.\ \filetype{.glg} or \filetype{.alg}) for messages.

\begin{table}[htbp]
\caption{Commands and package options that have no effect when
using \texttt{xindy} or \texttt{makeindex} explicity}
\label{tab:makeglossariesCmds}
\vskip\baselineskip
\begin{tabular}{@{}lll@{}}
\bfseries Command or Package Option & \appname{makeindex} & 
\appname{xindy}\\
\pkgopt[letter]{order} & use \texttt{-l} &
 use \texttt{-M ord/letorder}\\
\pkgopt[word]{order} & default & default\\
\pkgopt{xindy}=\{\pkgoptni{language=}\meta{lang}\pkgoptni{,codename=}\meta{code}\} &
N/A & use \texttt{-L} \meta{lang} \texttt{-C} \meta{code}\\
\ics{GlsSetXdyLanguage}\marg{lang} & N/A &
use \texttt{-L} \meta{lang}\\
\ics{GlsSetXdyCodePage}\marg{code} & N/A &
use \texttt{-C} \meta{code}
\end{tabular}
\par
\end{table}
\ifmakedtx{}{\toTop}

\subsubsection{Using the makeglossaries Perl Script}
\label{sec:makeglossariesapp}

The \appname{makeglossaries} script picks up the relevant 
information from the auxiliary (\filetype{.aux}) file and
will either call \appname{xindy} or \appname{makeindex}, 
depending on the supplied information. Therefore, you only need to
pass the document's name without the extension to
\appname{makeglossaries}.
For example, if your document is called \texttt{myDoc.tex}, 
type the following in your terminal:
\begin{verbatim}
latex myDoc
makeglossaries myDoc
latex myDoc
\end{verbatim}
You may need to explicitly load \appname{makeglossaries} into
Perl:
\begin{verbatim}
perl makeglossaries myDoc
\end{verbatim}
There is a batch file called \texttt{makeglossaries.bat} which
does this for Windows users, but you must have Perl installed to
be able to use it.
\ifmakedtx{}{\toTop}

\subsubsection{Using xindy explicitly}
\label{sec:xindyapp}

If you want to use \appname{xindy} to process the glossary
files, you must make sure you have used the 
\pkgopt{xindy} package option:
\begin{verbatim}
\usepackage[xindy]{glossaries}
\end{verbatim}
This is required regardless of whether you use \appname{xindy}
explicitly or whether it's called implicitly via 
\appname{makeglossaries}. This causes the glossary 
entries to be written in raw \appname{xindy} format, so you need to
use \texttt{-I xindy} \emph{not} \texttt{-I tex}.

To run \appname{xindy} type the following in your terminal 
(all on one line):\\[10pt]
\begin{ttfamily}
xindy -L \textrm{\meta{language}} -C \textrm{\meta{encoding}} -I xindy 
-M \textrm{\meta{style}} -t \textrm{\meta{base}}.glg\newline
-o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo
\end{ttfamily}
\\[10pt]
where \meta{language} is the required language name, \meta{encoding}
is the encoding, \meta{base} is the name of the document without the
\filetype{.tex} extension and \meta{style} is the name of the
\appname{xindy} style file without the \filetype{.xdy} extension.
The default name for this style file is \meta{base}\filetype{.xdy}
but can be changed via \ics{setStyleFile}\marg{style}. You may need
to specify the full path name depending on the current working
directory. If any of the file names contain spaces, you must delimit
them using double-quotes.

For example, if your document is called \texttt{myDoc.tex} and
you are using UTF8 encoding in English, then type the
following in your terminal:
\begin{verbatim}
xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo
\end{verbatim}

Note that this just creates the main glossary. You need to do
the same for each of the other glossaries (including the
list of acronyms if you have used the \pkgopt{acronym}
package option), substituting \filetype{.glg}, \filetype{.gls}
and \filetype{.glo} with the relevant extensions. For example,
if you have used the \pkgopt{acronym} package option, then 
you would need to do:
\begin{verbatim}
xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn
\end{verbatim}
For additional glossaries, the extensions are those supplied
when you created the glossary with \ics{newglossary}.

Note that if you use \appname{makeglossaries} instead, you can
replace all those calls to \appname{xindy} with just one call
to \appname{makeglossaries}:
\begin{verbatim}
makeglossaries myDoc
\end{verbatim}
Note also that some commands and package options have no effect if 
you use \appname{xindy} explicitly instead of using 
\appname{makeglossaries}. These are listed in 
\tableref{tab:makeglossariesCmds}.
\ifmakedtx{}{\toTop}

\subsubsection{Using makeindex explicitly}
\label{sec:makeindexapp}

If you want to use \appname{makeindex} explicitly, you must
make sure that you haven't used the \pkgopt{xindy} package
option or the glossary entries will be written in the wrong
format. To run \appname{makeindex}, type the following in
your terminal:\\[10pt]
\begin{ttfamily}
makeindex -s \textrm{\meta{style}}.ist -t \textrm{\meta{base}}.glg 
-o \textrm{\meta{base}}.gls \textrm{\meta{base}}.glo
\end{ttfamily}\\[10pt]
where \meta{base} is the name of your document without the
\filetype{.tex} extension and \meta{style}\filetype{.ist} is the 
name of the \appname{makeindex} style file. By default, this is
\meta{base}\filetype{.ist}, but may be changed via
\ics{setStyleFile}\marg{style}. Note that there are other options, 
such as \texttt{-l} (letter ordering). See the \appname{makeindex}
manual for further details.

For example, if your document is called \texttt{myDoc.tex}, then
type the following at the terminal:
\begin{verbatim}
makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo
\end{verbatim}
Note that this only creates the main glossary. If you have
additional glossaries (for example, if you have used the
\pkgopt{acronym} package option) then you must call 
\appname{makeindex} for each glossary, substituting 
\filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the
relevant extensions. For example, if you have used the
\pkgopt{acronym} package option, then you need to type the
following in your terminal:
\begin{verbatim}
makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn
\end{verbatim}
For additional glossaries, the extensions are those supplied
when you created the glossary with \ics{newglossary}.

Note that if you use \appname{makeglossaries} instead, you can
replace all those calls to \appname{makeindex} with just one call
to \appname{makeglossaries}:
\begin{verbatim}
makeglossaries myDoc
\end{verbatim}
Note also that some commands and package options have no effect if 
you use \appname{makeindex} explicitly instead of using 
\appname{makeglossaries}. These are listed in 
\tableref{tab:makeglossariesCmds}.
\ifmakedtx{}{\toTop}

\subsubsection{Note to Front-End and Script Developers}

The information needed to determine whether to use \appname{xindy}
or \appname{makeindex} and the information needed to call those
applications is stored in the auxiliary file. This information can
be gathered by a front-end, editor or script to make the glossaries
where appropriate. This section describes how the information is
stored in the auxiliary file.

The file extensions used by each defined glossary are given by\\[10pt]
\cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext}\\[10pt]
where \meta{in-ext} is the extension of the \emph{indexing
application's} input file (the output file from the \sty{glossaries}
package's point of view), \meta{out-ext} is the extension of the
\emph{indexing application's} output file (the input file from
the \sty{glossaries} package's point of view) and \meta{log} is the
extension of the indexing application's transcript file. The label
for the glossary is also given for information purposes only, but
is not required by the indexing applications. For example, the
information for the main glossary is written as:
\begin{verbatim}
\@newglossary{main}{glg}{gls}{glo}
\end{verbatim}

The indexing application's style file is specified by\\[10pt]
\cs{@istfilename}\marg{filename}\\[10pt]
The file extension indicates whether to use \appname{makeindex}
(\filetype{.ist}) or \appname{xindy} (\filetype{.xdy}). Note that
the glossary information is formatted differently depending on
which indexing application is supposed to be used, so it's 
important to call the correct one.

Word or letter ordering is specified by:\\[10pt]
\cs{@glsorder}\marg{order}\\[10pt]
where \meta{order} can be either \texttt{word} or \texttt{letter}.

If \appname{xindy} should be used, the language and code page
for each glossary is specified by\\[10pt]
\cs{@xdylanguage}\marg{label}\marg{language}\\
\cs{@gls@codepage}\marg{label}\marg{code}\\[10pt]
where \meta{label} identifies the glossary, \meta{language} is
the root language (e.g.\ \texttt{english}) and \meta{code}
is the encoding (e.g.\ \texttt{utf8}). These commands are omitted
if \appname{makeindex} should be used.
\ifmakedtx{}{\toTop}

\subsection{Troubleshooting}
\label{sec:trouble}

The \sty{glossaries} package comes with a minimal file called 
\texttt{minimalgls.tex} which can be used for testing. This
should be located in the \texttt{samples} subdirectory (folder)
of the \sty{glossaries} documentation directory. The location
varies according to your operating system and \TeX\ installation.
For example, on my Linux partition it can be found in
\texttt{/usr/local/texlive/2008/texmf-dist/doc/latex/glossaries/}. 
Further information on debugging \LaTeX\ code is available at
\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/}.

Below is a list of the most frequently asked questions. For
other queries, consult the \sty{glossaries} FAQ at
\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}. 

\begin{enumerate}
\item \textbf{Q.} I get the error message:
\begin{verbatim}
Missing \begin{document}
\end{verbatim}

\textbf{A.} Check you are using an up to date version of the \isty{xkeyval}
package.

\item \textbf{Q.} I've used the \pkgopt{smallcaps} option, but the acronyms
are displayed in normal sized upper case letters.

\textbf{A.} The \pkgopt{smallcaps} package option uses \cs{textsc} to typeset
the acronyms. This command converts lower case letters to small 
capitals, while upper case letters remain their usual size. Therefore
you need to specify the acronym in lower case letters.

\item \textbf{Q.} How do I change the font that the acronyms are displayed in?

\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package
option and redefine \cs{acronymfont} to use the required typesetting
command.  For example, suppose you would like the acronyms displayed in 
a sans-serif font, then you can do:
\begin{verbatim}
\usepackage[smaller]{glossaries}
\renewcommand*{\acronymfont}[1]{\textsf{#1}}
\end{verbatim}

\item \textbf{Q.} How do I change the font that the acronyms are displayed in
on \firstuse?

\textbf{A.} The easiest way to do this is to specify the \pkgopt{smaller} package
option and redefine \cs{firstacronymfont} to use the required 
command. Note that if you don't want the acronym on subsequent use
to use \cs{textsmaller}, you will also need to redefine \cs{acronymfont},
as above. For example to make the acronym emphasized on 
\firstuse, but use the surrounding font for subsequent use, you can do:
\begin{verbatim}
\usepackage[smaller]{glossaries}
\renewcommand*{\firstacronymfont}[1]{\emph{#1}}
\renewcommand*{\acronymfont}[1]{#1}
\end{verbatim}

\item \textbf{Q.} I don't have Perl installed, do I have to use 
\appname{makeglossaries}?

\textbf{A.} Although it is strongly recommended that you use 
\appname{makeglossaries}, you don't have to use it.
For further details, read 
\ifmakedtx{\autoref{sec:xindyapp}}{\htmlref{Using 
xindy explicitly}{sec:xindyapp}} or 
\ifmakedtx{\autoref{sec:makeindexapp}}{\htmlref{Using
makeindex explicitly}{sec:makeindexapp}}, depending on
whether you want to use \appname{xindy} or \appname{makeindex}.


\item \textbf{Q.} I'm used to using the \sty{glossary} package: are there any
instructions on migrating from the \isty{glossary} package to the
\sty{glossaries} package?

\textbf{A.} Read \ifmakedtx{the file \texttt{glossary2glossaries.pdf}}{\htmladdnormallink{Upgrading 
from the glossary package to the glossaries 
package}{glossary2glossaries.html}} which should be available from the 
same location as this document.

\item \textbf{Q.} I'm using \isty{babel} but the fixed names haven't been 
translated.

\textbf{A.} The \sty{glossaries} package currently only supports the following
languages: Brazilian Portuguese, Danish, Dutch, English, French,
German, Irish, Italian, Hungarian, Polish and Spanish. If you want
to add another language, send me the translations, and I'll add them
to the next version.

If you are using one of the above languages, but the text hasn't been
translated, try adding the \isty{translator} package with the
required languages explicitly (before you load the \sty{glossaries}
package). For example:
\begin{verbatim}
\usepackage[ngerman]{babel}
\usepackage[ngerman]{translator}
\usepackage{glossaries}
\end{verbatim}
Alternatively, you can add the language as a global option
to the class file. Check the \sty{translator} package documentation 
for further details.

\item \textbf{Q.} My acronyms contain strange characters when I use commands
like \ics{acrlong}.

\textbf{A.} Switch off the sanitization:
\begin{verbatim}
\usepackage[sanitize=none]{glossaries}
\end{verbatim}
and protect fragile commands.

\item \textbf{Q.} My glossaries haven't appeared.

\textbf{A.} Remember to do the following:
\begin{itemize}
\item Add \ics{makeglossaries} to the document preamble.

\item Use either \ics{printglossary} for each glossary that has
been defined or \ics{printglossaries}.

\item Use the commands listed in 
\ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary 
Entries}{sec:glslink}}, 
\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an Entry to the 
Glossary Without Generating Text}{sec:glsadd}} or 
\ifmakedtx{\autoref{sec:crossref}}{\htmlref{Cross-Referencing 
Entries}{sec:crossref}} for each entry 
that you want to appear in the glossary.

\item Run \LaTeX\ on your document, then run \appname{makeglossaries},
then run \LaTeX\ on your document again. If you want the glossaries
to appear in the table of contents, you will need an extra \LaTeX\
run. If any of your entries cross-reference an entry that's not
referenced in the main body of the document, you will need to
\ifmakedtx{run \appname{makeglossaries} (see \autoref{sec:makeglossaries})}{\htmlref{run \appname{makeglossaries}}{sec:makeglossaries}} 
after the second \LaTeX\ run, followed by another \LaTeX\ run.
\end{itemize}

Check the log files (\filetype{.log}, \filetype{.glg} etc) for any 
warnings.

\item \textbf{Q.} It is possible to change the rules used to sort
the glossary entries?

\textbf{A.} If it's for an individual entry, then you can
use the entry's \gloskey{sort} key to sort it according to a
different term. If it's for the entire alphabet, then you will need
to use \appname{xindy} (instead of \appname{makeindex}) and use an 
appropriate \appname{xindy} language module. Writing \appname{xindy}
modules or styles is beyond the scope of this manual. Further
information about \appname{xindy} can be found at the
\ifmakedtx{\href{http://xindy.sourceforge.net/}{Xindy Web 
Site}.\footnote{\texttt{http://xindy.sourceforge.net/}}}{\htmladdnormallink{Xindy Web Site}{http://xindy.sourceforge.net/}.}  
There is also a link to the \appname{xindy} mailing list from that 
site.

\end{enumerate}
\ifmakedtx{}{\toTop}

\section{Overview of Main User Commands}\label{sec:overview}
 \changes{1.02}{2007 May 25}{added overview section}

\subsection{Package Options}
\label{sec:pkgopts}

The \sty{glossaries} package options are as follows:
\begin{description}
\item[\pkgopt{toc}] Add the glossaries to the table of contents.
Note that an extra \LaTeX\ run is required with this option.

\item[\pkgopt{numberline}] When used with \pkgopt{toc}, this will
add \cs{numberline}\verb|{}| in the final argument of 
\cs{addcontentsline}. This will align the table of contents entry 
with the numbered section titles. Note that this option has no
effect if the \pkgopt{toc} option is omitted. If \pkgopt{toc} is
used without \pkgopt{numberline}, the title will be aligned with
the section numbers rather than the section titles.

\item[\pkgopt{acronym}] This creates a new glossary with the
label \texttt{acronym}. This is equivalent to:
\begin{verbatim}
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
\end{verbatim}
If the \pkgopt{acronym} package option is used, \ics{acronymtype}
is set to \texttt{acronym} otherwise it is set to 
\texttt{main}.\footnote{Actually it sets \ics{acronymtype} to
\ics{glsdefaulttype} if the \pkgopt{acronym} package option is
not used, but \ics{glsdefaulttype} usually has the value
\texttt{main}.} 
Entries that are defined using \ics{newacronym} are placed in
the glossary whose label is given by \ics{acronymtype}, unless
another glossary is explicitly specified.

\item[\pkgopt{nomain}] This suppresses the creation of the main
glossary. Note that if you use this option, you must create another
glossary in which to put all your entries (either via the
\pkgopt{acronym} package option described above or via
\ics{newglossary} described in
\ifmakedtx{\autoref{sec:newglossary}}{\htmlref{Defining New
Glossaries}{sec:newglossary}}).


\item[\pkgopt{section}] This is a \meta{key}=\meta{value} option.  Its
value should be the name of a sectional unit (e.g.\ chapter).
This will make the glossaries appear in the named sectional unit,
otherwise each glossary will appear in a chapter, if chapters
exist, otherwise in a section. Unnumbered sectional units will be used
by default. Example:
\begin{verbatim}
\usepackage[section=subsection]{glossaries}
\end{verbatim}
You can omit the value if you want to use sections, i.e.\
\begin{verbatim}
\usepackage[section]{glossaries}
\end{verbatim}
is equivalent to
\begin{verbatim}
\usepackage[section=section]{glossaries}
\end{verbatim}
You can change this value later in the document using\\[10pt]
\DescribeMacro{\setglossarysection}\cs{setglossarysection}\marg{name}\\[10pt]
where \meta{name} is the sectional unit. The start of each glossary
adds information to the page header via
\DescribeMacro{glossarymark}\cs{glossarymark}\marg{glossary title}.
This defaults to \cs{@mkboth}, but you may need to redefine it.
For example, to only change the right header:
\begin{verbatim}
\renewcommand{\glossarymark}[1]{\markright{#1}}
\end{verbatim}
or to prevent it from changing the headers:
\begin{verbatim}
\renewcommand{\glossarymark}[1]{}
\end{verbatim}

Note that if you are using the \isty{hyperref} package and the
glossaries are put in chapters, you may need to redefine
\ics{glsclearpage} to do \ics{clearpage} instead of
\cs{cleardoublepage} to prevent an unwanted blank page appearing
before the glossary:
\begin{verbatim}
\renewcommand*{\glsclearpage}{\clearpage}
\end{verbatim}

\item[\pkgopt{numberedsection}]
The glossaries are placed in unnumbered sectional units by default,
but this can be changed using \pkgopt{numberedsection}. This option can take
three possible values: \pkgoptval{false}{numberedsection} (no
number, i.e.\ use starred form), \pkgoptval{nolabel}{numberedsection}
(numbered, i.e.\ unstarred form, but not labelled) and
\pkgoptval{autolabel}{numberedsection} (numbered with automatic
labelling). If \pkgopt[autolabel]{numberedsection} is used, each
glossary is given a label that matches the glossary type, so the
main (default) glossary is labelled \texttt{main}, the list of
acronyms is labelled \texttt{acronym}\footnote{if the
\pkgopt{acronym} option is used, otherwise the list of
acronyms is the main glossary} and additional glossaries are labelled
using the value specified in the first mandatory argument to 
\cs{newglossary}. For example, if you load \sty{glossaries}
using:
\begin{verbatim}
\usepackage[section,numberedsection=autolabel]{glossaries}
\end{verbatim}
then each glossary will appear in a numbered section, and can
be referenced using something like:
\begin{verbatim}
The main glossary is in section~\ref{main} and the list of
acronyms is in section~\ref{acronym}.
\end{verbatim}
If you can't decide whether to have the acronyms in the main
glossary or a separate list of acronyms, you can use
\ics{acronymtype} which is set to \texttt{main} if the
\pkgopt{acronym} option is not used and is set to \texttt{acronym}
if the \pkgopt{acronym} option is used. For example:
\begin{verbatim}
The list of acronyms is in section~\ref{\acronymtype}.
\end{verbatim}

As from version 1.14, you can add a prefix to the label by
redefining \DescribeMacro{\glsautoprefix}\cs{glsautoprefix}.
For example:
\begin{verbatim}
\renewcommand*{\glsautoprefix}{glo:}
\end{verbatim}
will add \texttt{glo:} to the automatically generated label, so
you can then, for example, refer to the list of acronyms as follows:
\begin{verbatim}
The list of acronyms is in section~\ref{glo:\acronymtype}.
\end{verbatim}
Or, if you are undecided on a prefix:
\begin{verbatim}
The list of acronyms is in section~\ref{\glsautoprefix\acronymtype}.
\end{verbatim}


\item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. Its 
value should be the name of the glossary style to use. Predefined 
glossary styles are listed \ifmakedtx{in \autoref{sec:styles}}{\htmlref{later}{sec:styles}}.

\item[\pkgopt{nolong}] This prevents the \sty{glossaries} package
from automatically loading \isty{glossary-long} (which means that
the \isty{longtable} package also won't be loaded). This reduces
overhead by not defining unwanted styles and commands. Not that if
you use this option, you won't be able to use any of the
glossary styles defined in the \sty{glossary-long} package.

\item[\pkgopt{nosuper}] This prevents the \sty{glossaries} package
from automatically loading \isty{glossary-super} (which means that
the \isty{supertabular} package also won't be loaded). This reduces
overhead by not defining unwanted styles and commands. Not that if
you use this option, you won't be able to use any of the
glossary styles defined in the \sty{glossary-super} package.

\item[\pkgopt{nolist}] This prevents the \sty{glossaries} package
from automatically loading \isty{glossary-list}. This reduces
overhead by not defining unwanted styles. Not that if
you use this option, you won't be able to use any of the
glossary styles defined in the \sty{glossary-list} package.
Note that since the default style is \glostyle{list}, you will 
also need to use the \pkgopt{style} option to set the style to
something else.

\item[\pkgopt{notree}] This prevents the \sty{glossaries} package
from automatically loading \isty{glossary-tree}. This reduces
overhead by not defining unwanted styles. Not that if
you use this option, you won't be able to use any of the
glossary styles defined in the \sty{glossary-tree} package.

\item[\pkgopt{nostyles}] This prevents all the predefined styles
from being loaded. This option is provided in the event that the
user has custom styles that are not dependent on the styles
provided by the \sty{glossaries} package. Note that if you use
this option, you can't use the \pkgopt{style} package option. Instead
you must either use \ics{glossarystyle}\marg{style} or
the \gloskey[printglossary]{style} key in the
optional argument to \ics{printglossary}.

\item[\pkgopt{nonumberlist}] This option will suppress the 
associated number lists\iterm{number list} in the glossaries (see also 
\ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}).

\item[\pkgopt{counter}] This is a \meta{key}=\meta{value} option. The
value should be the name of the default counter to use in the number
lists\iterm{number list}.

\ifmakedtx{\hypertarget{sanitize}{}\relax}{\label{sanitize}}
\item[\pkgopt{sanitize}] This is a \meta{key}=\meta{value} option whose
value is also a \meta{key}=\meta{value} list. By default, the
\sty{glossaries} package sanitizes the values of the
\gloskey{name}, \gloskey{description} and \gloskey{symbol} keys used
when defining a new glossary entry. This means that you can use 
fragile commands in those keys, but it may lead to unexpected results
if you try to display these values within the document text. This
sanitization can be switched off using the \pkgopt{sanitize} package
option. \ifmakedtx{(See \autoref{sec:pkgopt} and \autoref{sec:newentry} for 
further details.)}{} For example, to switch off the sanitization for the
\gloskey{description} and \gloskey{name} keys, but not for the
\gloskey{symbol} key, do:
\begin{verbatim}
\usepackage[sanitize={name=false,description=false,%
symbol=true}]{glossaries}
\end{verbatim}
You can use \pkgopt[none]{sanitize} as a shortcut for\newline
\pkgoptni{sanitize=\{name=false,description=false,symbol=false\}}.

\begin{important}%
\textbf{Note}: this sanitization only applies to the \gloskey{name}, 
\gloskey{description} and \gloskey{symbol} keys. It doesn't apply
to any of the other keys (except the \gloskey{sort} key which is
always sanitized) so fragile commands contained in the value of
the other keys must always be protected using \cs{protect}.
Since the value of the \gloskey{text} key is obtained from the
\gloskey{name} key, you will still need to protect fragile commands
in the \gloskey{name} key if you don't use the \gloskey{text} key. 
\end{important}

\item[\pkgopt{description}] This option changes the definition of
\ics{newacronym} to allow a description. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{footnote}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{smallcaps}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{smaller}] This option changes the definition of
\ics{newacronym} and the way that acronyms are displayed. See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{dua}] This option changes the definition of
\ics{newacronym} so that acronyms are always expanded. 
See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{shortcuts}] This option provides shortcut commands
for acronyms.
See \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}} 
for further details.

\item[\pkgopt{makeindex}] (Default) The glossary information and
indexing style file will be written in \appname{makeindex} format. If you use
\appname{makeglossaries}, it will automatically detect that it needs
to call \appname{makeindex}. If you don't use
\appname{makeglossaries}, you need to remember to use
\appname{makeindex} not \appname{xindy}. The indexing style file 
will been given a \filetype{.ist} extension.

\item[\pkgopt{xindy}] The glossary information and indexing style file will
be written in \appname{xindy} format. If you use
\appname{makeglossaries}, it will automatically detect that it needs
to call \appname{xindy}. If you don't use \appname{makeglossaries},
you need to remember to use \appname{xindy} not \appname{makeindex}.
The indexing style file will been given a \filetype{.xdy} extension.

The \pkgopt{xindy} package option may additionally have a 
value that is a \meta{key}=\meta{value} comma-separated list to override 
the language and codepage. For example:
\begin{verbatim}
\usepackage[xindy={language=english,codepage=utf8}]{glossaries}
\end{verbatim}
You can also specify whether you want a number group in 
the glossary. This defaults to true, but can be suppressed. For
example:
\begin{verbatim}
\usepackage[xindy={glsnumbers=false}]{glossaries}
\end{verbatim}
See \ifmakedtx{\autoref{sec:xindy}}{\htmlref{Xindy}{sec:xindy}} 
for further details on using \appname{xindy} with the 
\sty{glossaries} package.

\item[\pkgopt{order}] This may take two values: 
\pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default
is word ordering. Note that this option has no effect if you
don't use \appname{makeglossaries}.

\item[\pkgopt{nowarn}] This suppresses all warnings generated by
the \sty{glossaries} package.

\end{description}\ifmakedtx{}{\toTop}

\subsection{Defining Glossary Entries}
\label{sec:newglosentry}

All glossary entries must be defined before they are used, so it
is better to define them in the preamble to ensure this.\footnote{The
only preamble restriction on \cs{newglossaryentry} and \cs{newacronym}
was removed in version 1.13, but the restriction remains for
\cs{loadglsentries}.} However
only those entries that occur in the document
(using any of the commands described in \ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary Entries}{sec:glslink}}, 
\ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}} or 
\ifmakedtx{\autoref{sec:crossref}}{\htmlref{Cross-Referencing 
Entries}{sec:crossref}}) will appear in the glossary. Each time an entry 
is used in this way, a line is added to an associated glossary file
(\filetype{.glo}), which then needs to be converted into a
corresponding \filetype{.gls} file which contains the typeset
glossary which is input by \ics{printglossary} or
\ics{printglossaries}.  The Perl script \appname{makeglossaries} can
be used to call \appname{makeindex} or \appname{xindy}, using a
customised indexing style file, for each of the glossaries that are
defined in the document.  Note that there should be no need for you
to explicitly edit or input any of these external files.  See
\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the
Associated Glossary Files}{sec:makeglossaries}} 
for further details.

\DescribeMacro{\makeglossaries}
The command \cs{makeglossaries} must be placed in the preamble in
order to create the customised \appname{makeindex} (\filetype{.ist})
or \appname{xindy} (\filetype{.xdy})
style file and to ensure that glossary entries are written to the
appropriate output files. If you omit \cs{makeglossaries} none of the
glossaries will be created.

\begin{important}
Note that some of the commands provided by the \sty{glossaries}
package must be placed before \cs{makeglossaries} as they are
required when creating the customised style file. If you attempt
to use those commands after \cs{makeglossaries} you will generate
an error.
\end{important}

\DescribeMacro{\noist}
You can suppress the creation of the customised \appname{xindy}
or \appname{makeindex} style file using \cs{noist}. Note that this
command must be used before \cs{makeglossaries}.

The default name for the customised style file is given by
\ics{jobname}\filetype{.ist} (for \appname{makeindex}) or 
\ics{jobname}\filetype{.xdy} (for \appname{xindy}). This name may be
changed using:\\[10pt]
\DescribeMacro{\setStyleFile}
\cs{setStyleFile}\marg{name}\\[10pt]
where \meta{name} is the name of the style file without the 
extension. Note that this command must be used before
\cs{makeglossaries}.

Each glossary entry is assigned a \term{number list} that lists all 
the locations in the document where that entry was used. By default,
the location refers to the page number but this may be overridden
using the \pkgopt{counter} package option. The default form of
the location number assumes a full stop compositor (e.g.\ 1.2),
but if your location numbers use a different compositor (e.g. 1-2)
you need to set this using\\[10pt]
\DescribeMacro{\glsSetCompositor}\cs{glsSetCompositor}\marg{symbol}\\[10pt]
For example:
\begin{verbatim}
\glsSetCompositor{-}
\end{verbatim}
Note that this command must be used before \cs{makeglossaries}.

If you use \appname{xindy}, you can have a different compositor
for page numbers starting with an uppercase alphabetical 
character using:\\[10pt]
\DescribeMacro{\glsSetAlphaCompositor}\cs{glsSetAlphaCompositor}\marg{symbol}\\[10pt]
Note that this command has no effect if you haven't used the
\pkgopt{xindy} package option. For example, if you want 
number lists\iterm{number list} containing a mixture of A-1 and 2.3 
style formats, then do:
\begin{verbatim}
\glsSetCompositor{.}
\glsSetAlphaCompositor{-}
\end{verbatim}
See \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number 
lists}{sec:numberlists}} for 
further information about number lists\iterm{number list}.

\DescribeMacro{\newglossaryentry}
New glossary entries are defined using the command:\\[10pt]
\cs{newglossaryentry}\marg{label}\marg{key-val list}\\[10pt] The first
argument, \meta{label}, must be a unique label with which to identify
this entry. The second argument, \meta{key-val list}, is a
\meta{key}=\meta{value} list that supplies the relevant information
about this entry. There are two required fields: \gloskey{name} and
\gloskey{description}, except for sub-entries where the
\gloskey{name} field may be omitted. Available fields are listed 
below:

\begin{description}
\item[{\gloskey{name}}] The name of the entry (as it will appear in 
the glossary). If this key is omitted and the \gloskey{parent}
key is supplied, this value will be the same as the parent's name.

\item[{\gloskey{description}}] A brief description of this term (to
appear in the glossary). Within this value, you can use 
\DescribeMacro{\nopostdesc}\cs{nopostdesc} to suppress the
description terminator for this entry. For example, if this
entry is a parent entry that doesn't require a description, you
can do \verb|description={\nopostdesc}|. If you want a paragraph
break in the description use \DescribeMacro{\glspar}\cs{glspar}.
However, note that not all glossary styles support multi-line
descriptions. If you are using one of the tabular-like glossary
styles that permit multi-line descriptions, use \ics{newline}
not \verb"\\" if you want to force a line break.

\item[{\gloskey{parent}}] The label of the parent entry. Note that
the parent entry must be defined before its sub-entries.
See \ifmakedtx{\autoref{sec:subentries}}{\htmlref{Sub-Entries}{sec:subentries}} for 
further details.

\item[{\gloskey{descriptionplural}}] The plural form of the 
description (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst}
by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value
is set to the same as the \gloskey{description} key.

\item[{\gloskey{text}}] How this entry will appear in the document text
when using \ics{gls} (or one of its uppercase variants). If this
field is omitted, the value of the \gloskey{name} key is used.

\item[{\gloskey{first}}] How the entry will appear in the document text
the first time it is used with \ics{gls}\ifirstusetext\ (or one of its uppercase
variants). If this field is omitted, the value of the \gloskey{text}
key is used.

\item[{\gloskey{plural}}] How the entry will appear in the document text
when using \ics{glspl} (or one of its uppercase variants).
If this field is omitted, the value is obtained by appending 
\ics{glspluralsuffix} to the value of the \gloskey{text} field.
The default value of \cs{glspluralsuffix} is the letter
\dq{s}.

\item[{\gloskey{firstplural}}] How the entry will appear in the
document text the first time it is used with \ics{glspl}\ifirstusetext\ (or one of its
uppercase variants). If this field is omitted, the value is obtained
from the \gloskey{plural} key, if the \gloskey{first} key is omitted,
or by appending \ics{glspluralsuffix} to the value of the
\gloskey{first} field, if the \gloskey{first} field is present.

\textbf{Note:} prior to version 1.13, the default value of 
\gloskey{firstplural} was always taken by appending \dq{s} to the
\gloskey{first} key, which meant that you had to specify both
\gloskey{plural} and \gloskey{firstplural}, even if you hadn't
used the \gloskey{first} key.

\item[{\gloskey{symbol}}] This field is provided to allow the user to
specify an associated symbol. If omitted, the value is set to 
\cs{relax}. Note that not all glossary styles display the
symbol.

\item[{\gloskey{symbolplural}}] This is the plural form of the
symbol (as passed to \ics{glsdisplay} and \ics{glsdisplayfirst}
by \ics{glspl}, \ics{Glspl} and \ics{GLSpl}). If omitted, the value
is set to the same as the \gloskey{symbol} key.

\item[{\gloskey{sort}}] This value indicates how \appname{makeindex}
or \appname{xindy} should sort this entry. If omitted, the value is 
given by the \gloskey{name} field.

\item[{\gloskey{type}}] This specifies the label of the glossary in 
which this entry belongs. If omitted, the default glossary is 
assumed.  The list of acronyms type is given by
\ics{acronymtype} which will either be \texttt{main} or
\texttt{acronym}, depending on whether the \pkgopt{acronym} package
option was used.

\item[{\gloskey{nonumberlist}}] Suppress the \term{number list} for
this entry.

\item[{\gloskey{see}}] Cross-reference another entry. Using the
\gloskey{see} key will automatically add this entry to the
glossary, but will not automatically add the cross-referenced entry.
The referenced entry should be supplied as the value to this key.
If you want to override the \dq{see} tag, you can supply the new
tag in square brackets before the label. For example
\verb|see=[see also]{anotherlabel}|. For further details,
see \ifmakedtx{\autoref{sec:crossref}}{\htmlref{later}{sec:crossref}}.

\end{description}
Note that if the name starts with an accented letter or non-Latin
character, you must group the accented letter, otherwise it will 
cause a problem for commands like \cs{Gls} and \cs{Glspl}. 
For example:
\begin{verbatim}
\newglossaryentry{elite}{name={{\'e}lite},
description={select group or class}}
\end{verbatim}
Note that the same applies if you are using the \isty{inputenc}
package:
\begin{verbatim}
\newglossaryentry{elite}{name={{é}lite},
description={select group or class}}
\end{verbatim}
Note that in both of the above examples, you will also need to
supply the \gloskey{sort} key if you are using \appname{makeindex}
whereas \appname{xindy} is usually able to sort accented letters
correctly.

\ifmakedtx{}{\toTop}


\subsubsection{Plurals}
You may have noticed from above that you can specify the plural form
when you define a term. If you omit this, the plural will be 
obtained by appending 
\DescribeMacro{\glspluralsuffix}\cs{glspluralsuffix} to 
the singular form. This command defaults to the letter \dq{s}. 
For example:
\begin{verbatim}
\newglossaryentry{cow}{name=cow,description={a fully grown
female of any bovine animal}}
\end{verbatim}
defines a new entry whose singular form is \dq{cow} and plural form
is \dq{cows}. However, if you are writing in archaic English, you
may want to use \dq{kine} as the plural form, in which case you
would have to do:
\begin{verbatim}
\newglossaryentry{cow}{name=cow,plural=kine,
description={a fully grown female of any bovine animal}}
\end{verbatim}

If you are writing in a language that supports
multiple plurals (for a given term) then use the \gloskey{plural} key
for one of them (typically the one you are most likely to use) and
for the others you will need to explicitly write the plural form using
\ics{glslink} or \ics{glsdisp} rather than using \cs{glspl}. Returning to the cow 
example above, suppose you will mostly be using \dq{cows} as the
plural, but occasionally you want to use \dq{kine} as the plural,
then define the term as
\begin{verbatim}
\newglossaryentry{cow}{name=cow,description={a fully grown
female of any bovine animal (plural cows, archaic plural kine)}}
\end{verbatim}
and use \verb|\glspl{cow}| to produce \dq{cows} and use
\verb|\glslink{cow}{kine}| to produce \dq{kine}.

If you are using a language that usually forms plurals
by appending a different letter, or sequence of letters, you can
redefine \cs{glspluralsuffix} as required. However, this must be
done \emph{before} the entries are defined. For languages that don't
form plurals by simply appending a suffix, all the plural forms must be 
specified using the \gloskey{plural} key (and the \gloskey{firstplural}
key where necessary). 

\ifmakedtx{}{\toTop}

\subsubsection{Sub-Entries}
\label{sec:subentries}

As from version 1.17, it is possible to specify sub-entries. These
may be used to order the glossary into categories, in which case
the sub-entry will have a different name to its parent entry, or
it may be used to distinguish different definitions for the same
word, in which case the sub-entries will have the same name as
the parent entry. Note that not all glossary styles support
hierarchical entries and may display all the entries in a flat
format. Of the styles that support sub-entries, some display the
sub-entry's name whilst others don't. Therefore you need to
ensure that you use a suitable style. See \ifmakedtx{\autoref{sec:styles}}{\htmlref{later}{sec:styles}} 
for a list of predefined 
styles.

Note that the parent entry will automatically be added to the
glossary if any of its child entries are used in the document.
If the parent entry is not referenced in the document, it will not
have a \term{number list}.
\ifmakedtx{}{\toTop}

\paragraph{Hierarchical Categories} To arrange a glossary
with hierarchical categories, you need to first define the
category and then define the sub-entries using the relevant 
category entry as the value of the \gloskey{parent} key. For
example, suppose I want a glossary of mathematical symbols that
are divided into Greek letters and Roman letters. Then I can
define the categories as follows:
\begin{verbatim}
\newglossaryentry{greekletter}{name={Greek letters},
description={\nopostdesc}}

\newglossaryentry{romanletter}{name={Roman letters},
description={\nopostdesc}}
\end{verbatim}

Note that in this example, the category entries don't need a
description so I have set the descriptions to \ics{nopostdesc}.
This gives a blank description and suppresses the
description terminator.

I can now define my sub-entries as follows:
\begin{verbatim}
\newglossaryentry{pi}{name={pi},
description={ratio of the circumference of a circle to the diameter},
parent=greekletter}

\newglossaryentry{C}{name=C,
description={Euler's constant},
parent=romanletter}
\end{verbatim}
\ifmakedtx{}{\toTop}

\paragraph{Homographs} Sub-entries that have the same name as
the parent entry, don't need to have the \gloskey{name} key.
For example, the word \dq{glossary} can mean a list of technical
words or a collection of glosses. In both cases the plural is
\dq{glossaries}. So first define the parent entry:
\begin{verbatim}
\newglossaryentry{glossary}{name=glossary,
description={\nopostdesc},
plural={glossaries}}
\end{verbatim}
Again, the parent entry has no description, so the description
terminator needs to be suppressed using \ics{nopostdesc}.

Now define the two different meanings of the word:
\begin{verbatim}
\newglossaryentry{glossarylist}{
description={1) list of technical words},
sort={1},
parent={glossary}}

\newglossaryentry{glossarycol}{
description={2) collection of glosses},
sort={2},
parent={glossary}}
\end{verbatim}
Note that if I reference the parent entry, the location will be
added to the parent's \term{number list}, whereas if I reference 
any of the child entries, the location will be added to the child
entry's number list.  Note also that since the sub-entries have the
same name, the \gloskey{sort} key is required.

In the above example, the plural form for both of the child entries
is the same as the parent entry, so the \gloskey{plural} key was
not required for the child entries. However, if the sub-entries
have different plurals, they will need to be specified. For example:
\begin{verbatim}
\newglossaryentry{bravo}{name={bravo},
description={\nopostdesc}}

\newglossaryentry{bravocry}{description={1) cry of approval (pl.\ bravos)},
sort={1},
plural={bravos},
parent=bravo}

\newglossaryentry{bravoruffian}{description={2) hired ruffian or
killer (pl.\ bravoes)},
sort={2},
plural={bravoes},
parent=bravo}
\end{verbatim}
\ifmakedtx{}{\toTop}

\subsubsection{Loading Entries From a File}
\label{sec:loadglsentries}

\DescribeMacro{\loadglsentries}
You can store all your glossary entry definitions in another
file and use:\\[10pt]
\cs{loadglsentries}\oarg{type}\marg{filename}\\[10pt]
where \meta{filename} is the name of the file containing all the
\cs{newglossaryentry} commands. The optional argument
\meta{type} is the name of the glossary to which those entries
should belong, for those entries where the \gloskey{type} key has 
been omitted (or, more specifically, for those entries whose
type has been specified by \cs{glsdefaulttype}, which is what
\cs{newglossaryentry} uses by default). For example, suppose I have
a file called \texttt{myentries.tex} which contains:
\begin{verbatim}
\newglossaryentry{perl}{type=main,
name={Perl},
description={A scripting language}}

\newglossaryentry{tex}{name={\TeX},
description={A typesetting language},sort={TeX}}

\newglossaryentry{html}{type=\glsdefaulttype,
name={html},
description={A mark up language}}
\end{verbatim}
and suppose in my document preamble I use the command:
\begin{verbatim}
\loadglsentries[languages]{myentries}
\end{verbatim}
then this will add the entries \texttt{tex} and \texttt{html}
to the glossary whose type is given by \texttt{languages}, but
the entry \texttt{perl} will be added to the main glossary, since
it explicitly sets the type to \texttt{main}.

\textbf{Note:} if you
use \cs{newacronym} (see \ifmakedtx{\autoref{sec:acronyms}}{\htmlref{later}{sec:acronyms}}) 
the type is set as \verb|type=\acronymtype| 
unless you explicitly override it. For example, if my file
\texttt{myacronyms.tex} contains:
\begin{verbatim}
\newacronym{aca}{aca}{a contrived acronym}
\end{verbatim}
then (supposing I have defined a new glossary type called
\texttt{altacronym})
\begin{verbatim}
\loadglsentries[altacronym]{myacronyms}
\end{verbatim}
will add \texttt{aca} to the glossary type \texttt{acronym}, if the
package option \pkgopt{acronym} has been specified, or will add
\texttt{aca} to the glossary type \texttt{altacronym}, if the
package option \pkgopt{acronym} is not specified.\footnote{This
is because \cs{acronymtype} is set to \cs{glsdefaulttype} if
the \pkgopt{acronym} package option is not used.} In this instance,
it is better to change \texttt{myacronyms.tex} to:
\begin{verbatim}
\newacronym[type=\glsdefaulttype]{aca}{aca}{a contrived acronym}
\end{verbatim}
and now
\begin{verbatim}
\loadglsentries[altacronym]{myacronyms}
\end{verbatim}
will add \texttt{aca} to the glossary type \texttt{altacronym},
regardless of whether or not the package option \pkgopt{acronym} is
used.

Note that only those entries that have been used
in the text will appear in the relevant glossaries.
Note also that \cs{loadglsentries} may only be used in the 
preamble.\ifmakedtx{}{\toTop}

\subsection{Number lists}
\label{sec:numberlists}

Each entry in the glossary has an associated \termdef{number list}. 
By default,
these numbers refer to the pages on which that entry has been used
(using any of the commands described in \ifmakedtx{\autoref{sec:glslink}}{\htmlref{Links to Glossary Entries}{sec:glslink}} 
and \ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}}). The number list can be suppressed using 
the \pkgopt{nonumberlist} package option, or an alternative counter
can be set as the default using the \pkgopt{counter} package option.
The number list is also referred to as the location 
list\index{location list|see{number list}}.

Both \appname{makeindex} and \appname{xindy} concatenate a
sequence of 3 or more consecutive pages into a range. With 
\appname{xindy} you can vary the minimum sequence length using
\ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either
an integer or the keyword \texttt{none} which indicates that there
should be no range formation.

\begin{important}
Note that \cs{GlsSetXdyMinRangeLength} must be used before
\ics{makeglossaries} and has no effect if \ics{noist} is used.
\end{important}

With both \appname{makeindex} and \appname{xindy}, you can replace
the separator and the closing number in the range using:\\[10pt]
\DescribeMacro{\glsSetSuffixF}\cs{glsSetSuffixF}\marg{suffix}\\
\DescribeMacro{\glsSetSuffixFF}\cs{glsSetSuffixFF}\marg{suffix}\\[10pt]
where the former command specifies the suffix to use for a 2 page
list and the latter specifies the suffix to use for longer lists.
For example:
\begin{verbatim}
\glsSetSuffixF{f.}
\glsSetSuffixFF{ff.}
\end{verbatim}
Note that if you use \appname{xindy}, you will also need to
set the minimum range length to 1 if you want to change these
suffixes:
\begin{verbatim}
\GlsSetXdyMinRangeLength{1}
\end{verbatim}
Note that if you use the \isty{hyperref} package, you will need
to use \ics{nohyperpage} in the suffix to ensure that the hyperlinks
work correctly. For example:
\begin{verbatim}
\glsSetSuffixF{\nohyperpage{f.}}
\glsSetSuffixFF{\nohyperpage{ff.}}
\end{verbatim}

\begin{important}
Note that \cs{glsSetSuffixF} and \cs{glsSetSuffixFF} must be used 
before \ics{makeglossaries} and have no effect if \ics{noist} is 
used.
\end{important}

\ifmakedtx{}{\toTop}

\subsection{Links to Glossary Entries}
\label{sec:glslink}

Once you have defined a glossary entry using 
\ics{newglossaryentry}, you can refer to that entry in the
document using one of the commands listed in this section. The
text which appears at that point in the document when using 
one of these commands is referred to as the 
\termdef{link text} (even if there are no hyperlinks). The commands
in this section also add a line to an external file that is used
by \appname{makeindex} or \appname{xindy} to generate the relevant 
entry in the glossary. This information includes an
associated location that is added to the \term{number list} for that
entry. By default, the location refers to the page number. For
further information on number lists, see \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}.


\begin{important}
It is strongly recommended that you don't use the commands
defined in this section in the arguments of sectioning or caption
commands.
\end{important}

The above warning is particularly important if you are using the
\sty{glossaries} package in conjunction with the \isty{hyperref} package.
Instead, use one of the commands listed in 
\ifmakedtx{\autoref{sec:glsnolink}}{\htmlref{Using Glossary Terms
Without Links}{sec:glsnolink}} (such as \cs{glsentrytext}) or provide an alternative via
the optional argument to the sectioning/caption command.
Examples:
\begin{verbatim}
\section{An overview of \glsentrytext{perl}}
\section[An overview of Perl]{An overview of \gls{perl}}
\end{verbatim}

The way the \term{link text} is displayed 
depends on \DescribeMacro{\glstextformat}\cs{glstextformat}\marg{text}.
For example, to make all \term{link text} appear in a sans-serif
font, do:
\begin{verbatim}
\renewcommand*{\glstextformat}[1]{\textsf{#1}}
\end{verbatim}

Each entry has an associated conditional referred to as the
\firstuseflag. This determines whether \ics{gls}, 
\ics{glspl} (and their uppercase variants) should use the
value of the \gloskey{first} or \gloskey{text} keys. Note that an 
entry can be used without affecting the \firstuseflag\ (for example,
when used with \cs{glslink}). See \ifmakedtx{\autoref{sec:glsunset}}{\htmlref{later}{sec:glsunset}} for 
commands that unset or reset this conditional.

\DescribeMacro{\glslink}
The command:\\[10pt]
\cs{glslink}\oarg{options}\marg{label}\marg{text}\\[10pt]
will place \cs{glstextformat}\marg{text} in the document at that
point and add a line into the associated glossary file for the
glossary entry given by \meta{label}. If hyperlinks are supported,
\meta{text} will be a hyperlink to the relevant line in the
glossary. (Note that this command doesn't affect the \firstuseflag:
use \ics{glsdisp} instead.) The optional argument \meta{options}
must be a \meta{key}=\meta{value} list which can take any of the
following keys:

\begin{description}
\item[{\gloskey[glslink]{format}}] This specifies how to format the
associated location number for this entry in the glossary. This 
value is equivalent to the \appname{makeindex} encap value, and (as
with \cs{index}) the value needs to be the name of a command
\emph{without} the initial backslash. As with \cs{index}, the
characters \verb"(" and \verb")" can also be used to specify the
beginning and ending of a number range.  Again as with \cs{index},
the command should be the name of a command which takes an argument
(which will be the associated location).  Be careful not to use a
declaration (such as \texttt{bfseries}) instead of a text block command
(such as \texttt{textbf}) as the effect is not guaranteed to be
localised. If you want to apply more than one style to a given entry
(e.g.\ \textbf{bold} and \emph{italic}) you will need to create a
command that applies both formats, e.g.\ 
\begin{verbatim}
\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
\end{verbatim}
and use that command.

In this document, the standard formats refer to the standard text 
block commands such as \ics{textbf} or \ics{emph} or any of the 
commands listed in \tableref{tab:hyperxx}.

\begin{important}
If you use \appname{xindy} instead of \appname{makeindex}, you
must specify any non-standard formats that you want to use
with the \gloskey[glslink]{format} key using
\ics{GlsAddXdyAttribute}\marg{name}. So if you use
\appname{xindy} with the above example, you would need to add:
\begin{verbatim}
\GlsAddXdyAttribute{textbfem}
\end{verbatim}
\end{important}

Note that unlike \cs{index}, you can't have
anything following the command name, such as an asterisk or
arguments. If you want to cross-reference another entry, either
use the \gloskey{see} key when you define the entry or use
\ics{glssee} (described \ifmakedtx{in \autoref{sec:crossref}}{\htmlref{later}{sec:crossref}}).


If you are using hyperlinks and you want to change the font of the
hyperlinked location, don't use \ics{hyperpage} (provided by the
\isty{hyperref} package) as the locations may not refer to a page
number.  Instead, the \sty{glossaries} package provides number
formats listed in \tableref{tab:hyperxx}.

\begin{table}[htbp]
\caption{Predefined Hyperlinked Location Formats}
\label{tab:hyperxx}
\centering
\vskip\baselineskip
\begin{tabular}{ll}
\locfmt{hyperrm} & serif hyperlink\\
\locfmt{hypersf} & sans-serif hyperlink\\
\locfmt{hypertt} & monospaced hyperlink\\
\locfmt{hyperbf} & bold hyperlink\\
\locfmt{hypermd} & medium weight hyperlink\\
\locfmt{hyperit} & italic hyperlink\\
\locfmt{hypersl} & slanted hyperlink\\
\locfmt{hyperup} & upright hyperlink\\
\locfmt{hypersc} & small caps hyperlink\\
\locfmt{hyperemph} & emphasized hyperlink
\end{tabular}
\par
\end{table}

Note that if the \ics{hyperlink} command hasn't been defined,
the \texttt{hyper}\meta{xx} formats are equivalent to the
analogous \texttt{text}\meta{xx} font commands (and \texttt{hyperemph}
is equivalent to \texttt{emph}). If you want to
make a new format, you will need to define a command which takes
one argument and use that; for example, if you want the location
number to be in a bold sans-serif font, you can define a
command called, say, \cs{hyperbsf}:
\begin{verbatim}
\newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
\end{verbatim}
and then use \texttt{hyperbsf} as the value for the \gloskey{format}
key.\ifmakedtx{  (See also \autoref{sec:code:printglos}.)}{} 
Remember that if you use \appname{xindy}, you will need to add
this to the list of location attributes:
\begin{verbatim}
\GlsAddXdyAttribute{hyperbsf}
\end{verbatim}

\item[{\gloskey[glslink]{counter}}] This specifies which counter
to use for this location. This overrides the default counter
used by this entry. (See also
\ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}.)

\item[{\gloskey[glslink]{hyper}}] This is a boolean key which can
be used to enable/disable the hyperlink to the relevant entry
in the glossary. (Note that setting \texttt{hyper=true} will have no
effect if \cs{hyperlink} has not been defined.) The default
value is \texttt{hyper=true}.

\end{description}
\DescribeMacro{\glslink*}
There is also a starred version:\\[10pt]
\cs{glslink*}\oarg{options}\marg{label}\marg{text}\\[10pt]
which is equivalent to \cs{glslink}, except it sets
\texttt{hyper=false}. Similarly, all the following commands 
described in this section also have a starred version that disables
the hyperlink.

\DescribeMacro{\gls}
The command:\\[10pt]
\cs{gls}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is the same as \cs{glslink}, except that the \term{link text}
is determined from the values of the \gloskey{text} and 
\gloskey{first} keys supplied when the entry was defined using
\ics{newglossaryentry}. If the entry has been marked as having
been used\ifirstuseflag, the value of the \gloskey{text} key will be used, otherwise
the value of the \gloskey{first} key will be used. 
On completion, \cs{gls} will mark the entry's first use flag\ifirstuseflag\ as
used.

There are two uppercase variants:\\[10pt]
\DescribeMacro{\Gls}
\cs{Gls}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
and\\[10pt]
\DescribeMacro{\GLS}
\cs{GLS}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
which make the first letter of the link text or all the link text
uppercase, respectively.

The final optional argument \meta{insert}, allows you to insert
some additional text into the link text. By default, this will
append \meta{insert} at the end of the link text, but this
can be changed (see 
\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{later}{sec:glsdisplay}}). 


The first optional argument \meta{options} is the same as the optional
argument to \ics{glslink}. As with \cs{glslink}, these commands also
have a starred version that disable the hyperlink.

There are also analogous plural forms:\\[10pt]
\DescribeMacro{\glspl}
\cs{glspl}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
\DescribeMacro{\Glspl}
\cs{Glspl}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSpl}
\cs{GLSpl}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
These determine the link text from the \gloskey{plural} and
\gloskey{firstplural} keys supplied when the entry was first
defined. As before, these commands also have
a starred version that disable the hyperlink.

Note that \cs{glslink} doesn't use or affect the \firstuseflag,
nor does it use \ics{glsdisplay} or \ics{glsdisplayfirst} (see 
\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{later}{sec:glsdisplay}}). 
Instead, you can use:\\[10pt]
\DescribeMacro{\glsdisp}
\cs{glsdisp}\oarg{options}\marg{label}\marg{link text}\\[10pt]
This behaves in the same way as \cs{gls}, except that it uses
\meta{link text} instead of the value of the \gloskey{first}
or \gloskey{text} key. (Note that this command always sets
\meta{insert} to nothing.) This command affects the \firstuseflag,
and uses \ics{glsdisplay} or \ics{glsdisplayfirst}.

\DescribeMacro{\glstext}The command:\\[10pt]
\cs{glstext}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{gls} except that it always uses the value
of the \gloskey{text} key and does not affect the 
\firstuseflag. 
Unlike \cs{gls}, the inserted text \meta{insert} 
is always appended to the link text since \cs{glstext} doesn't
use \ics{glsdisplay} or \ics{glsdisplayfirst}. (The same is 
true for all the following commands described in this section.)

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glstext}
\cs{Glstext}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLStext}
\cs{GLStext}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glsfirst}The command:\\[10pt]
\cs{glsfirst}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value
of the \gloskey{first} key. Again, \meta{insert} is always appended
to the end of the link text and does not affect the 
\firstuseflag.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glsfirst}
\cs{Glsfirst}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSfirst}
\cs{GLSfirst}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glsplural}The command:\\[10pt]
\cs{glsplural}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value
of the \gloskey{plural} key. Again, \meta{insert} is always appended
to the end of the link text and does not mark the entry as having
been used.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glsplural}
\cs{Glsplural}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSplural}
\cs{GLSplural}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glsfirstplural}The command:\\[10pt]
\cs{glsfirstplural}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value
of the \gloskey{firstplural} key. Again, \meta{insert} is always 
appended to the end of the link text and does not mark the entry as
having been used.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glsfirstplural}
\cs{Glsfirstplural}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSfirstplural}
\cs{GLSfirstplural}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glsname}The command:\\[10pt]
\cs{glsname}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value of the
\gloskey{name} key. Again, \meta{insert} is always appended to the end
of the link text and does not mark the entry as having
been used.  Note: if you want to use this command and the
\gloskey{name} key contains commands, you will have to disable the
\ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} 
of the \gloskey{name} key and protect fragile commands.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glsname}
\cs{Glsname}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSname}
\cs{GLSname}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glssymbol}The command:\\[10pt]
\cs{glssymbol}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value of the
\gloskey{symbol} key. Again, \meta{insert} is always appended to the
end of the link text and does not mark the entry as having
been used.  Note: if you want to use this command and the
\gloskey{symbol} key contains commands, you will have to disable the
\ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} 
of the \gloskey{symbol} key and protect fragile commands.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glssymbol}
\cs{Glssymbol}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSsymbol}
\cs{GLSsymbol}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\DescribeMacro{\glsdesc}The command:\\[10pt]
\cs{glsdesc}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
is similar to \ics{glstext} except that it always uses the value
of the \gloskey{description} key. Again, \meta{insert} is always
appended to the end of the link text and does not mark the entry as 
having been used.  Note: if you want to use this
command and the \gloskey{description} key contains commands, you will
have to disable the
\ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} 
of the \gloskey{description} key and protect fragile commands.

There are also analogous commands:\\[10pt]
\DescribeMacro{\Glsdesc}
\cs{Glsdesc}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
\DescribeMacro{\GLSdesc}
\cs{GLSdesc}\oarg{options}\marg{text}\oarg{insert}\\[10pt]
As before, these commands also have a starred version that disable
the hyperlink.

\ifmakedtx{}{\toTop}

\subsubsection{Changing the format of the link text}
\label{sec:glsdisplay}

The format of the \term{link text} for \ics{gls}, \ics{glspl}
and their uppercase variants is governed by two commands:
\DescribeMacro{\glsdisplayfirst}\cs{glsdisplayfirst}, which is used the
first time a glossary entry is used\ifirstuse\ in the text and
\DescribeMacro{\glsdisplay}\cs{glsdisplay}, which is used subsequently.
Both commands take four arguments: the first is either the singular or
plural form given by the \gloskey{text}, \gloskey{plural},
\gloskey{first} or \gloskey{firstplural} keys (set when the term was
defined) depending on context; the second argument is the term's
description (as supplied by the \gloskey{description} or
\gloskey{descriptionplural} keys); the third
argument is the symbol associated with the term (as supplied by the
\gloskey{symbol} or \gloskey{symbolplural} keys) and the fourth argument is the additional text
supplied in the final optional argument to \cs{gls} or
\cs{glspl} (or their uppercase variants). The default definitions
of \cs{glsdisplay} and \cs{glsdisplayfirst} simply
print the first argument immediately followed by the fourth argument.
The remaining arguments are ignored.

If required, you can access the label for the given entry via
\DescribeMacro{\glslabel}\ics{glslabel}, so it is possible to use
this label in the definition of \cs{glsdisplay} or
\cs{glsdisplayfirst} to supply additional information using any of
the commands described in
\ifmakedtx{\autoref{sec:glsnolink}}{\htmlref{Using Glossary Terms
Without Links}{sec:glsnolink}}, if required. 

Note that \cs{glsdisplay} and \cs{glsdisplayfirst} are not used
by \ics{glslink}. If you want to supply your own link text, you
need to use \ics{glsdisp} instead.

For example, suppose you want a glossary of measurements and
units, you can use the \gloskey{symbol} key to store the unit:
\begin{verbatim}
\newglossaryentry{distance}{name=distance,
description={The length between two points},
symbol={km}}
\end{verbatim}
and now suppose you want \verb|\gls{distance}| to produce
\dq{distance (km)} on \firstuse, then you can redefine
\cs{glsdisplayfirst} as follows:
\begin{verbatim}
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
\end{verbatim}
Note that the additional text is placed after \verb|#1|, so
\verb|\gls{distance}['s]| will produce \dq{distance's (km)}
rather than \dq{distance (km)'s} which looks a bit odd (even though
it may be in the context of \dq{the distance (km) is measured between
the two points} --- but in this instance it would be better not to
use a contraction).

Note also that all of the \term{link text} will be formatted according
to \ics{glstextformat} (described earlier). So if you do, say:
\begin{verbatim}
\renewcommand{\glstextformat}[1]{\textbf{#1}}
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
\end{verbatim}
then \verb|\gls{distance}| will produce \dq{\textbf{distance (km)}}.

If you have multiple glossaries, changing \cs{glsdisplayfirst} and
\cs{glsdisplay} will change the way entries for all of the
glossaries appear when using the commands \ics{gls}, \ics{glspl}, their
uppercase variants and \ics{glsdisp}.  If you only
want the change to affect entries for a given glossary, then you need
to use\\[10pt]
\DescribeMacro{\defglsdisplay}\cs{defglsdisplay}\oarg{type}\marg{definition}\\[10pt]
and\\[10pt]
\DescribeMacro{\defglsdisplayfirst}\cs{defglsdisplayfirst}\oarg{type}\marg{definition}\\[10pt]
instead of redefining \cs{glsdisplay} and \cs{glsdisplayfirst}.

Both \cs{defglsdisplay} and \cs{defglsdisplayfirst} take two arguments:
the first (which is optional) is the glossary's label\footnote{\texttt{main} for the main
(default) glossary, \cs{acronymtype} for the list of acronyms, or the
name supplied in the first mandatory argument to \cs{newglossary} for
additional glossaries.} and the second is how the term should be
displayed when it is invoked using commands \cs{gls}, 
\cs{glspl}, their uppercase variants and \cs{glsdisp}. This is similar to the way \cs{glsdisplayfirst} was
redefined above.

For example, suppose you have created a new glossary called
\texttt{notation} and you want to change the way the entry is
displayed on \firstuse\ so that it includes the symbol, you can
do:
\begin{verbatim}
\defglsdisplayfirst[notation]{#1#4 (denoted #3)}
\end{verbatim}
Now suppose you have defined an entry as follows:
\begin{verbatim}
\newglossaryentry{set}{type=notation,
name=set,
description={A collection of objects},
symbol={$S$}
}
\end{verbatim}
The first time you reference this entry using \cs{gls} it
will be displayed as: \dq{set (denoted \ifmakedtx{$S$}{\textit{S}})} 
(similarly for \cs{glspl} and the uppercase variants).

Remember that if you use the \gloskey{symbol} key, you need to use a
glossary style that displays the symbol, as many of the styles ignore
it. In addition, if you want either the description or symbol to appear
in the \term{link text}, you will have to disable the
\ifmakedtx{\hyperlink{sanitize}{sanitization}}{\htmlref{sanitization}{sanitize}} 
of these keys and protect fragile commands.\ifmakedtx{}{\toTop}

\subsubsection{Enabling and disabling hyperlinks to glossary entries}

If you load the \isty{hyperref} or \isty{html} packages prior to
loading the \sty{glossaries} package, commands such as \ics{glslink}
and \ics{gls}, described above, will automatically have hyperlinks
to the relevant glossary entry, unless the \gloskey[glslink]{hyper}
option has been set to \texttt{false}. You can disable or enable links using:\\[10pt]
\DescribeMacro{\glsdisablehyper}\cs{glsdisablehyper}\\[10pt]
and\\[10pt]
\DescribeMacro{\glsenablehyper}\cs{glsenablehyper}\\[10pt]
respectively. The effect can be localised by placing the commands
within a group. Note that you should only use \cs{glsenablehyper}
if the commands \ics{hyperlink} and \ics{hypertarget} have been
defined (for example, by the \isty{hyperref} package).\ifmakedtx{}{\toTop}

\subsection{Adding an Entry to the Glossary Without Generating Text}
\label{sec:glsadd}

\DescribeMacro{\glsadd}
It is possible to add a line in the glossary file without
generating any text at that point in the document using:\\[10pt]
\cs{glsadd}\oarg{options}\marg{label}\\[10pt]
This is similar to \ics{glslink}, only it doesn't produce
any text (so therefore, there is no \gloskey[glslink]{hyper} key
available in \meta{options} but all the other options that can
be used with \cs{glslink} can be passed to \cs{glsadd}).
For example, to add a page range to the glossary number list for the
entry whose label is given by \texttt{set}:
\begin{verbatim}
\glsadd[format=(]{set}
Lots of text about sets spanning many pages.
\glsadd[format=)]{set}
\end{verbatim}

\DescribeMacro{\glsaddall}
To add all entries that have been defined, use:\\[10pt]
\cs{glsaddall}\oarg{options}\\[10pt]
The optional argument is the same as for \cs{glsadd}, except
there is also a key \gloskey[glsaddall]{types} which can be
used to specify which glossaries to use. This should be a
comma separated list. For example, if you only want to add
all the entries belonging to the list of acronyms (specified by
the glossary type \cs{acronymtype}) and a list of
notation (specified by the glossary type \texttt{notation}) then you can
do:
\begin{verbatim}
\glsaddall[types={\acronymtype,notation}]
\end{verbatim}
\ifmakedtx{}{\toTop}

\subsection{Cross-Referencing Entries}
\label{sec:crossref}

There are several ways of cross-referencing entries in the 
glossary: 

\begin{enumerate}
\item You can use commands such as \ics{gls} in the
entries description. For example:
\begin{verbatim}
\newglossaryentry{apple}{name=apple,
description={firm, round fruit. See also \gls{pear}}}
\end{verbatim}
Note that with this method, if you don't use the 
cross-referenced term in the glossary, you will need two runs of
\appname{makeglossaries}:
\begin{verbatim}
latex filename
makeglossaries filename
latex filename
makeglossaries filename
latex filename
\end{verbatim}

\item As described \ifmakedtx{in 
\autoref{sec:newglosentry}}{\htmlref{earlier}{sec:newglosentry}}, 
you can use the \gloskey{see} key when you define the entry. For
example:
\begin{verbatim}
\newglossaryentry{MaclaurinSeries}{name={Maclaurin series},
description={Series expansion},
see={TaylorsTheorem}}
\end{verbatim}
Note that in this case, the entry with the \gloskey{see} key will
automatically be added to the glossary, but the cross-referenced
entry won't. You therefore need to ensure that you use the
cross-referenced term with the commands described in 
\ifmakedtx{\autoref{sec:glslink}}{Links to Glossary Entries} or 
\ifmakedtx{\autoref{sec:glsadd}}{Adding an Entry to the Glossary 
Without Generating Text}.


You can optionally override the \dq{see} tag using square brackets
at the start of the \gloskey{see} value. For example:
\begin{verbatim}
\newglossaryentry{MaclaurinSeries}{name={Maclaurin series},
description={Series expansion},
see=[see also]{TaylorsTheorem}}
\end{verbatim}

\item After you have defined the entry, use\\[10pt]
\DescribeMacro{\glssee}\cs{glssee}\oarg{tag}\marg{label}\marg{xr label list}\\[10pt]
where \meta{xr label list} is a comma-separated list of entry 
labels to be cross-referenced, \meta{label} is the label of the
entry doing the cross-referencing and \meta{tag} is the \dq{see} tag.
For example:
\begin{verbatim}
\glssee[see also]{series}{FourierSeries,TaylorsTheorem}
\end{verbatim}
Note that this automatically adds the entry given by \meta{label} to
the glossary but doesn't add the cross-referenced entries (specified
by \meta{xr label list}) to the glossary.
\end{enumerate}

In both cases~2 and 3 above, the cross-referenced information appears
in the \term{number list}, whereas in case~1, the cross-referenced 
information appears in the description. In cases~2 and~3, the
default text for the \dq{see} tag is given by \ics{seename}.
\ifmakedtx{}{\toTop}

\subsection{Using Glossary Terms Without Links}
\label{sec:glsnolink}

The commands described in this section display entry details without
adding any information to the glossary. They don't use 
\cs{glstextformat}, they don't have any optional arguments,
they don't affect the \firstuseflag\ and, apart from \ics{glshyperlink}, they don't produce 
hyperlinks.
\par\vskip10pt\noindent
\DescribeMacro{\glsentryname}\cs{glsentryname}\marg{label}\\
\DescribeMacro{\Glsentryname}\cs{Glsentryname}\marg{label}\par\vskip10pt\noindent
These commands display the name of the glossary entry given by
\meta{label}, as specified by the \gloskey{name} key. 
\cs{Glsentryname} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentrytext}\cs{glsentrytext}\marg{label}\\
\DescribeMacro{\Glsentrytext}\cs{Glsentrytext}\marg{label}\par\vskip10pt\noindent
These commands display the subsequent use text for the glossary entry 
given by \meta{label}, as specified by the \gloskey{text} key. 
\cs{Glsentrytext} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentryplural}\cs{glsentryplural}\marg{label}\\
\DescribeMacro{\Glsentryplural}\cs{Glsentryplural}\marg{label}\par\vskip10pt\noindent
These commands display the subsequent use plural text for the glossary 
entry given by \meta{label}, as specified by the \gloskey{plural} key. 
\cs{Glsentryplural} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentryfirst}\cs{glsentryfirst}\marg{label}\\
\DescribeMacro{\Glsentryfirst}\cs{Glsentryfirst}\marg{label}\par\vskip10pt\noindent
These commands display the \firstusetext\ for the glossary entry 
given by \meta{label}, as specified by the \gloskey{first} key. 
\cs{Glsentryfirst} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentryfirstplural}\cs{glsentryfirstplural}\marg{label}\\
\DescribeMacro{\Glsentryfirstplural}\cs{Glsentryfirstplural}\marg{label}\par\vskip10pt\noindent
These commands display the plural form of the \firstusetext\ for the 
glossary entry given by \meta{label}, as specified by the 
\gloskey{firstplural} key.  \cs{Glsentryfirstplural} makes the first 
letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentrydesc}\cs{glsentrydesc}\marg{label}\\
\DescribeMacro{\Glsentrydesc}\cs{Glsentrydesc}\marg{label}\par\vskip10pt\noindent
These commands display the description for the glossary entry given by
\meta{label}. \cs{Glsentrydesc} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentrydescplural}\cs{glsentrydescplural}\marg{label}\\
\DescribeMacro{\Glsentrydescplural}\cs{Glsentrydescplural}\marg{label}\par\vskip10pt\noindent
These commands display the plural description for the glossary entry 
given by \meta{label}. \cs{Glsentrydescplural} makes the first letter 
uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentrysymbol}\cs{glsentrysymbol}\marg{label}\\
\DescribeMacro{\Glsentrysymbol}\cs{Glsentrysymbol}\marg{label}\par\vskip10pt\noindent
These commands display the symbol for the glossary entry given by
\meta{label}. \cs{Glsentrysymbol} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glsentrysymbolplural}\cs{glsentrysymbolplural}\marg{label}\\
\DescribeMacro{\Glsentrysymbolplural}\cs{Glsentrysymbolplural}\marg{label}\par\vskip10pt\noindent
These commands display the plural symbol for the glossary entry given by
\meta{label}. \cs{Glsentrysymbolplural} makes the first letter uppercase.
\par\vskip10pt\noindent
\DescribeMacro{\glshyperlink}\cs{glshyperlink}\oarg{link text}\marg{label}\par\vskip10pt\noindent
This command provides a hyperlink to the glossary entry given by
\meta{label} \textbf{but does not add any information to the
glossary file}. The link text is given by
\ics{glsentryname}\marg{label} by default, but can be overridden
using the optional argument.
\begin{important}
If you use \cs{glshyperlink}, you need to ensure that the relevant
entry has been added to the glossary using any of the 
commands described in \ifmakedtx{\autoref{sec:glslink} or \autoref{sec:glsadd}}{\htmlref{Links to Glossary Entries}{sec:glslink} or 
\htmlref{Adding an Entry to the Glossary Without Generating 
Text}{sec:glsadd}} otherwise you will end up with a broken
link.
\end{important}

For further information see \ifmakedtx{\autoref{sec:code:glsnolink}}{the
section \dq{Displaying entry details without adding information to
the glossary} in the document \url{glossaries.pdf}}.
\ifmakedtx{}{\toTop}

\subsection{Displaying a glossary}
\label{sec:printglossary}

\DescribeMacro{\printglossaries}
The command \cs{printglossaries} will display all the
glossaries in the order in which they were defined. 
Note that no glossaries will appear until
you have either used the Perl script \appname{makeglossaries}
or have directly used \appname{makeindex} or \appname{xindy} (as
described in
\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the 
Associated Glossary Files}{sec:makeglossaries}}). If the glossary 
still does not appear after you re-\LaTeX\ your document, check the
\appname{makeindex}/\appname{xindy} log files to see if there is a
problem.  Remember that you also need to use the command
\ics{makeglossaries} in the preamble to enable the glossaries.

\DescribeMacro{\printglossary}
An individual glossary can be displayed using:\\[10pt]
\cs{printglossary}\oarg{options}\\[10pt]
where \meta{options} is a \meta{key}=\meta{value} list of options. 
The following keys are available:
\begin{description}
\item[{\gloskey[printglossary]{type}}] The value of this key
specifies which glossary to print. If omitted, the default
glossary is assumed. For example, to print the list of acronyms:
\begin{verbatim}
\printglossary[type=\acronymtype]
\end{verbatim}

\item[{\gloskey[printglossary]{title}}] This is the glossary's
title (overriding the title specified when the glossary was 
defined).

\item[{\gloskey[printglossary]{toctitle}}] This is the title
to use for the table of contents (if the \pkgopt{toc} package
option has been used). If omitted, the glossary title is used.

\item[{\gloskey[printglossary]{style}}] This specifies which
glossary style to use for this glossary, overriding the effect
of the \pkgopt{style} package option or \ics{glossarystyle}.

\item[{\gloskey[printglossary]{numberedsection}}] This specifies
whether to use a numbered section for this glossary, overriding
the effect of the \pkgopt{numberedsection} package option. This
key has the same syntax as the \pkgopt{numberedsection} package
option, described \ifmakedtx{in \autoref{sec:pkgopts}}{\htmlref{earlier}{sec:pkgopts}}.

\item[{\gloskey[printglossary]{nonumberlist}}] Unlike the package option
of the same name, this key is a boolean key. If true (\verb|nonumberlist=true|) the numberlist
is suppressed for this glossary. If false (\verb|nonumberlist=false|) the numberlist is
displayed for this glossary. If no value is supplied, true is 
assumed.

\end{description}

\DescribeMacro{\glossarypreamble}
Information can be added to the start of the glossary (after the
title and before the main body of the glossary) by redefining
\cs{glossarypreamble}. For example:
\begin{verbatim}
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
\end{verbatim}
This needs to be done before the glossary is displayed using
\cs{printglossaries} or \cs{printglossary}. Note that if you
want a different preamble for each glossary, you will need to
use a separate \cs{printglossary} for each glossary and change
the definition of \cs{glossarypreamble} between each glossary.
For example:
\begin{verbatim}
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
\printglossary
\renewcommand{\glossarypreamble}{}
\printglossary[type=acronym]
\end{verbatim}
Alternatively, you can do something like:
\begin{verbatim}
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.\gdef\glossarypreamble{}}
\printglossaries
\end{verbatim}
which will print the preamble text for the first glossary and 
change the preamble to do nothing for subsequent glossaries.
(Note that \cs{gdef} is required as the glossary is placed within
a group.)

\DescribeMacro{\glossarypostamble}There is an analogous command
called \cs{glossarypostamble} which is placed at the end of each
glossary.\ifmakedtx{}{\toTop}

\subsubsection{Changing the way the entry name appears in the glossary}
\label{sec:glsnamefont}

\DescribeMacro{\glsnamefont}Within each glossary, each entry name is
formatted according to \cs{glsnamefont} which takes one argument:
the entry name. This command is always used regardless of the
glossary style.  By default, \cs{glsnamefont} simply displays its
argument in whatever the surrounding font happens to be. This means
that in the list-like glossary styles (defined in the
\isty{glossary-list} style file) the name will appear in bold, since
the name is placed in the optional argument of \cs{item}, whereas in
the tabular styles (defined in the \isty{glossary-long} and
\isty{glossary-super} style files) the name will appear in the
normal font. The hierarchical glossary styles (defined in the
\isty{glossary-tree} style file) also set the name in bold.

For example, suppose you want all the entry names to appear in 
medium weight small caps, then you can do:
\begin{verbatim}
\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
\end{verbatim}
\ifmakedtx{}{\toTop}

\subsubsection{Xindy}
\label{sec:xindy}

If you want to use \appname{xindy} to sort the glossary, you
must use the package option \pkgopt{xindy}:
\begin{verbatim}
\usepackage[xindy]{glossaries}
\end{verbatim}
This ensures that the glossary information is written in 
\appname{xindy} syntax.

\ifmakedtx{Section~\ref{sec:makeglossaries}}{The section
\htmlref{Generating the Associated Glossary 
Files}{sec:makeglossaries}} covers how to use the external
indexing application. This section covers the commands provided
by the \sty{glossaries} package that allow you to adjust the
\appname{xindy} style file (\filetype{.xdy}) and parameters.

To assist writing information to the \appname{xindy} style
file, the \sty{glossaries} package provides the following
commands:\\[10pt]
\DescribeMacro{\glsopenbrace}\cs{glsopenbrace}\\
\DescribeMacro{\glsclosebrace}\cs{glsclosebrace}\\[10pt]
which produce an open and closing brace. (This is needed because
\verb|\{| and \verb|\}| don't expand to a simple brace character
when written to a file.)

In addition, if you are using a package that makes the double
quote character active (e.g. \isty{ngerman}) you can use:\\[10pt]
\DescribeMacro{\glsquote}\cs{glsquote}\marg{text}\\[10pt]
which will produce \verb|"|\meta{text}\verb|"|. Alternatively,
you can use \verb|\string"| to write the double-quote character. 
This document assumes that the double quote character has not been
made active, so the examples just use \verb|"| for clarity.

If you want greater control over the \appname{xindy} style file than
is available through the \LaTeX\ commands provided by the
\sty{glossaries} package, you will need to edit the \appname{xindy} 
style file. In
which case, you must use \ics{noist} to prevent the style file from
being overwritten by the \sty{glossaries} package. For additional
information about \appname{xindy}, read the \appname{xindy}
documentation.\ifmakedtx{}{\toTop}

\paragraph{Language and Encodings}
When you use \appname{xindy}, you need to specify the language
and encoding used (unless you have written your own custom
\appname{xindy} style file that defines the relevant alphabet
and sort rules). If you use \appname{makeglossaries},
this information is obtained from the document's auxiliary 
(\filetype{.aux}) file.  The \sty{glossaries} package attempts to 
find the root language, but in the event that it gets it wrong or if 
\appname{xindy} doesn't support that language, then you can
specify the language using:\\[10pt]
\DescribeMacro{\GlsSetXdyLanguage}
\cs{GlsSetXdyLanguage}\oarg{glossary type}\marg{language}\\[10pt]
where \meta{language} is the name of the language. The
optional argument can be used if you have multiple glossaries
in different languages. If \meta{glossary type} is omitted, it
will be applied to all glossaries, otherwise the language
setting will only be applied to the glossary given by
\meta{glossary type}.

If the \isty{inputenc} package is used, the encoding will be
obtained from the value of \ics{inputencodingname}. 
Alternatively, you can specify the encoding using:\\[10pt]
\DescribeMacro{\GlsSetXdyCodePage}
\cs{GlsSetXdyCodePage}\marg{code}\\[10pt]
where \meta{code} is the name of the encoding. For example:
\begin{verbatim}
\GlsSetXdyCodePage{utf8}
\end{verbatim}

Note that you can also specify the language and encoding using
the package option 
\verb|xindy={language=|\meta{lang}\verb|,codepage=|\meta{code}\verb|}|.
For example:
\begin{verbatim}
\usepackage[xindy={language=english,codepage=utf8}]{glossaries}
\end{verbatim}

If you write your own custom \appname{xindy} style file that 
includes the language settings, you need to set the language
to nothing:
\begin{verbatim}
\GlsSetXdyLanguage{}
\end{verbatim}
(and remember to use \ics{noist} to prevent the style file from
being overwritten).

\begin{important}
The commands \cs{GlsSetXdyLanguage} and \cs{GlsSetXdyCodePage}
have no effect if you don't use \appname{makeglossaries}. If
you call \appname{xindy} without \appname{makeglossaries} you
need to remember to set the language and encoding using the
\texttt{-L} and \texttt{-C} switches.
\end{important}
\ifmakedtx{}{\toTop}

\paragraph{Locations and Number lists}

The most likely attributes used in the \gloskey[glslink]{format} 
key (\locfmt{textrm}, \locfmt{hyperrm} etc) are automatically added 
to the \appname{xindy} style file, but if you want to use another 
attribute, you need to add it using:\\[10pt]
\DescribeMacro{\GlsAddXdyAttribute}
\cs{GlsAddXdyAttribute}\marg{name}\\[10pt]
where \meta{name} is the name of the attribute, as used in
the \gloskey[glslink]{format} key. For example, suppose I want a
bold, italic, hyperlinked location. I first need to define a
command that will do this:
\begin{verbatim}
\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
\end{verbatim}
but with \appname{xindy}, I also need to add this as an allowed
attribute:
\begin{verbatim}
\GlsAddXdyAttribute{hyperbfit}
\end{verbatim}

\begin{important}
Note that \cs{GlsAddXdyAttribute} has no effect if \ics{noist} is
used or if \ics{makeglossaries} is omitted.

\cs{GlsAddXdyAttribute} must be used before \ics{makeglossaries}.
\end{important}

If the location numbers don't get expanded to a simple Arabic or 
Roman number or a letter from a, \ldots, z or A, \ldots, Z, then
you need to add a location style in the appropriate format.

For example, suppose you want the page numbers written as words
rather than digits and you use the \isty{fmtcount} package to
do this. You can redefine \ics{thepage} as follows:
\begin{verbatim}
\renewcommand*{\thepage}{\Numberstring{page}}
\end{verbatim}
This gets expanded to \verb|\protect \Numberstringnum |\marg{n}
where \meta{n} is the Arabic page number. This means that you need to
define a new location that has that form:
\begin{verbatim}
\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space
  \string\Numberstringnum\space\glsopenbrace"
  "arabic-numbers" :sep "\glsclosebrace"}
\end{verbatim}
Note that it's necessary to use \cs{space} to indicate that 
spaces also appear in the format, since, unlike \TeX,
\appname{xindy} doesn't ignore spaces after control sequences.

\begin{important}
Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is
used or if \ics{makeglossaries} is omitted.

\cs{GlsAddXdyLocation} must be used before \ics{makeglossaries}.
\end{important}

In the \term{number list}, the locations are sorted according to 
type. The default ordering is: 
\texttt{roman-page-numbers} (e.g.\ i),
\texttt{arabic-page-numbers} (e.g.\ 1),
\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor
is a full stop or 1-1 if the compositor is a hyphen\footnote{see
\ics{setCompositor} described in 
\ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary 
Entries}{sec:newglosentry}}}), 
\texttt{alpha-page-numbers} (e.g.\ a),
\texttt{Roman-page-numbers} (e.g.\ I),
\texttt{Alpha-page-numbers} (e.g.\ A),
\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor
is a full stop or A-1 if the Alpha compositor is a 
hyphen\footnote{see \ics{setAlphaCompositor} described in 
\ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary 
Entries}{sec:newglosentry}}}),
user defined location names (as specified by
\ics{GlsAddXdyLocation} in the order in which they were defined),
\texttt{see} (cross-referenced entries).
This ordering can be changed using:\\[10pt]
\DescribeMacro{\GlsSetXdyLocationClassOrder}
\cs{GlsSetXdyLocationClassOrder}\marg{location names}\\[10pt]
where each location name is delimited by double quote marks and
separated by white space.
For example:
\begin{verbatim}
\GlsSetXdyLocationClassOrder{
  "arabic-page-numbers"
  "arabic-section-numbers"
  "roman-page-numbers"
  "Roman-page-numbers"
  "alpha-page-numbers"
  "Alpha-page-numbers"
  "Appendix-page-numbers"
  "see"
}
\end{verbatim}

\begin{important}
Note that \cs{GlsSetXdyLocationClassOrder} has no effect if 
\ics{noist} is used or if \ics{makeglossaries} is omitted.

\cs{GlsSetXdyLocationClassOrder} must be used before 
\ics{makeglossaries}.
\end{important}

If a \term{number list} consists of a sequence of consecutive 
numbers, the range will be concatenated. The 
number of consecutive locations that causes a range formation 
defaults to 2, but can be changed using:\\[10pt]
\DescribeMacro{\GlsSetXdyMinRangeLength}
\cs{GlsSetXdyMinRangeLength}\marg{n}\\[10pt]
For example:
\begin{verbatim}
\GlsSetXdyMinRangeLength{3}
\end{verbatim}
The argument may also be the keyword \texttt{none}, to indicate that
there should be no range formations. See the \appname{xindy}
manual for further details on range formations.

\begin{important}
Note that \cs{GlsSetXdyMinRangeLength} has no effect if \ics{noist}
is used or if \ics{makeglossaries} is omitted.

\cs{GlsSetXdyMinRangeLength} must be used before 
\ics{makeglossaries}.
\end{important}

See \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}} for 
further details.
\ifmakedtx{}{\toTop}

\paragraph{Glossary Groups}
The glossary is divided into groups according to the first
letter of the sort key. The \sty{glossaries} package also adds
a number group by default, unless you suppress it in the
\pkgopt{xindy} package option. For example:
\begin{verbatim}
\usepackage[xindy={glsnumbers=false}]{glossaries}
\end{verbatim}
Any entry that doesn't go in one of the letter groups or the
number group is placed in the default group.

If you have a number group, the default behaviour is to locate
it before the \dq{A} letter group. If you are not using a
Roman alphabet, you can change this using\\[10pt]
\cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter}

\begin{important}
Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if 
\ics{noist} is used or if \ics{makeglossaries} is omitted.

\cs{GlsSetXdyFirstLetterAfterDigits} must be used before 
\ics{makeglossaries}.
\end{important}
\ifmakedtx{}{\toTop}

\subsection{Defining New Glossaries}
\label{sec:newglossary}

\DescribeMacro{\newglossary}
A new glossary can be defined using:\\[10pt]
\cs{newglossary}\oarg{log-ext}\marg{name}\marg{in-ext}\marg{out-ext}\marg{title}\oarg{counter}\\[10pt]
where \meta{name} is the label to assign to this glossary. The arguments
\meta{in-ext} and \meta{out-ext} specify the extensions to give to the
input and output files for that glossary, \meta{title} is the default
title for this new glossary and the final optional argument
\meta{counter} specifies which counter to use for the associated number
lists\iterm{number list} (see also \ifmakedtx{\autoref{sec:numberlists}}{\htmlref{Number Lists}{sec:numberlists}}). The 
first optional argument specifies the extension for the
\appname{makeindex} or \appname{xindy} transcript file (this 
information is only used by \appname{makeglossaries} which picks up 
the information from the auxiliary file).

Note that the main (default) glossary is automatically created as:
\begin{verbatim}
\newglossary{main}{gls}{glo}{\glossaryname}
\end{verbatim}
so it can be identified by the label \texttt{main} (unless the
\pkgopt{nomain} package option is used). Using the
\pkgopt{acronym} package option is equivalent to:
\begin{verbatim}
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
\end{verbatim}
so it can be identified by the label \texttt{acronym}. If you are
not sure whether the \pkgopt{acronym} option has been used, you
can identify the list of acronyms by the command 
\DescribeMacro{\acronymtype}\cs{acronymtype} which is set to
\texttt{acronym}, if the \pkgopt{acronym} option has been used,
otherwise it is set to \texttt{main}.

\begin{important}
All glossaries must be defined before \ics{makeglossaries} to 
ensure that the relevant output files are opened.
\end{important}
\ifmakedtx{}{\toTop}

\subsection{Acronyms}
\label{sec:acronyms}

\DescribeMacro{\newacronym}
You may have noticed in \ifmakedtx{\autoref{sec:newglosentry}}{\htmlref{Defining Glossary Entries}{sec:newglosentry}} that when you 
specify a new entry, you can specify alternate text to use when
the term is first used\ifirstuse\ in the document. This provides a useful
means to define acronyms. For convenience, the \sty{glossaries} package
defines the command:\\[10pt]
\cs{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt]
By default, this is equivalent to:\vskip5pt
\begin{ttfamily}\par\noindent
\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype},\\
name=\textrm{\marg{abbrv}},\\
description=\textrm{\marg{long}},\\
text=\textrm{\marg{abbrv}},\\
first=\{\textrm{\meta{long}} (\textrm{\meta{abbrv}})\},\\
plural=\{\textrm{\meta{abbrv}}\cs{glspluralsuffix}\},\\
firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space}
(\textrm{\meta{abbrv}}\cs{glspluralsuffix})\},\\
\textrm{\meta{key-val list}}\}\par
\end{ttfamily}
\vskip5pt
As mentioned in the previous section, the command \ics{acronymtype}
is the name of the glossary in which the acronyms should appear. If
the \pkgopt{acronym} package option has been used, this will be
\texttt{acronym}, otherwise it will be \texttt{main}. The acronyms
can then be used in exactly the same way as any other glossary
entry.

\begin{important}%
\textbf{Note:} since \cs{newacronym} sets \verb|type=\acronymtype|,
if you want to load a file containing acronym definitions using
\cs{loadglsentries}\oarg{type}\marg{filename}, the optional argument 
\meta{type} will not have an effect unless you explicitly set the
type as \verb|type=\glsdefaulttype| in the optional argument to
\ics{newacronym}. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.
\end{important}

For example, the following defines the acronym IDN:
\begin{verbatim}
\newacronym{idn}{IDN}{identification number}
\end{verbatim}
This is equivalent to:
\begin{verbatim}
\newglossaryentry{idn}{type=\acronymtype,
name={IDN},
description={identification number},
text={IDN},
first={identification number (IDN)},
plural={IDNs},
firstplural={identification numbers (IDNs)}}
\end{verbatim}
so \verb|\gls{idn}| will produce \dq{identification number (IDN)} on
\firstuse\ and \dq{IDN} on subsequent uses.

This section describes acronyms that have been defined using
\cs{newacronym}. If you prefer to define all your acronyms using
\cs{newglossaryentry} explicitly, then you should skip this section
and ignore the package options: \pkgopt{smallcaps}, \pkgopt{smaller},
\pkgopt{description}, \pkgopt{dua} and \pkgopt{footnote}, as these 
options change the definition of \ics{newacronym} for common acronym 
formats as well as the way that the link text is displayed (see
\ifmakedtx{\autoref{sec:glsdisplay}}{\htmlref{earlier}{sec:glsdisplay}}). 
Likewise you should ignore the package option \pkgopt{shortcuts}
and the new commands described in this section,
such as \cs{acrshort}, as they vary according to the definition of
\ics{newacronym}.

If you use any of the package options \pkgopt{smallcaps}, 
\pkgopt{smaller}, \pkgopt{description} or 
\pkgopt{footnote}, the acronyms will be displayed in the document
using:\\[10pt]
\DescribeMacro{\acronymfont}\cs{acronymfont}\marg{text}\\[10pt]
and\\[10pt]
\DescribeMacro{\firstacronymfont}\cs{firstacronymfont}\marg{text}\\[10pt]
where \cs{firstacronymfont} is applied on \firstuse\ and
\cs{acronymfont} is applied on subsequent use. Note that if you
don't use any of the above package options, changing the definition
of \cs{acronymfont} or \cs{firstacronymfont} will have no effect. In
this case, the recommended route is to use either the
\pkgopt{smaller} or the \pkgopt{smallcaps} package option and
redefine \cs{acronymfont} and \cs{firstacronymfont} as required.
(The \pkgopt{smallcaps} option sets the default plural suffix in an
upright font to cancel the effect of \cs{textsc}, whereas
\pkgopt{smaller} sets the suffix in the surrounding font.)
For example, if you want acronyms in a normal font on first use and
emphasized on subsequent use, do:
\begin{verbatim}
\usepackage[smaller]{glossaries}
\renewcommand*{\firstacronymfont}[1]{#1}
\renewcommand*{\acronymfont}[1]{\emph{#1}}
\end{verbatim}
(Note that it is for this reason that the \isty{relsize} package
is not automatically loaded when selecting the
\pkgopt{smaller} package option.)

\Tableref{tab:acronymsettings} lists the package options that govern
the acronym styles and how the \ics{newglossaryentry} keys are used
to store \meta{long} (the long form) and \meta{abbrv} (the short
form). Note that the \pkgopt{smallcaps} option redefines
\cs{acronymfont} so that it sets its argument using \cs{textsc} (so
you should use lower case characters in \meta{abbrv}) and the
\pkgopt{smaller} option redefines \cs{acronymfont} to use
\cs{textsmaller},\footnote{you will need to load a package, such as
\sty{relsize}, that defines \cs{textsmaller} if you use this
option.}\ otherwise \cs{acronymfont} simply displays its argument in
the surrounding font.

\begin{table}[htbp]
\caption{Package options governing \cs{newacronym} and how the 
information is stored in the keys for \cs{newglossaryentry}}
\label{tab:acronymsettings}
\begin{center}
\begin{tabular}{lllll}
\bfseries Package Option &
\gloskey{first} key &
\gloskey{text} key &
\gloskey{description} key &
\gloskey{symbol} key\\
\pkgopt{description},\pkgopt{footnote} &
\meta{abbrv} &
\meta{abbrv} &
user supplied &
\meta{long}\\
\pkgopt{description},\pkgopt{dua} &
\meta{long} &
\meta{long} &
user supplied &
\meta{abbrv}\\
\pkgopt{description} &
\meta{long} &
\meta{abbrv} &
user supplied &
\meta{abbrv}\\
\pkgopt{footnote} &
\meta{abbrv} &
\meta{abbrv} &
\meta{long} &
 \\
\pkgopt{smallcaps} &
\meta{long} &
\meta{abbrv} &
\meta{long} &
\meta{abbrv}\\
\pkgopt{smaller} &
\meta{long} &
\meta{abbrv} &
\meta{long} &
\meta{abbrv}\\
\pkgopt{dua} &
\meta{long} &
\meta{long} &
\meta{long} &
\meta{abbrv}\\
None of the above&
\meta{long} (\meta{abbrv}) &
\meta{abbrv} &
\meta{long} &
\end{tabular}
\end{center}
\end{table}

In case you can't remember which key stores the long or short forms
(or their plurals) the \sty{glossaries} package provides the 
commands:
\begin{itemize}
\item\DescribeMacro{\glsshortkey}\cs{glsshortkey}
The key used to store the short form.
\item\DescribeMacro{\glsshortpluralkey}\cs{glsshortpluralkey}
The key used to store the plural version of the short form.
\item\DescribeMacro{\glslongkey}\cs{glslongkey}
The key used to store the long form.
\item\DescribeMacro{\glslongpluralkey}\cs{glslongpluralkey}
The key used to store the plural version of the long form.
\end{itemize}
These can be used in the optional argument of \cs{newacronym}
to override the defaults. For example:
\begin{verbatim}
\newacronym[\glslongpluralkey={diagonal matrices}]{dm}{DM}{diagonal 
matrix}
\end{verbatim}
If the \firstuse\ uses the plural form, \verb|\glspl{dm}| will
display: diagonal matrices (DMs).

Each of the package options \pkgopt{smallcaps}, \pkgopt{smaller}, 
\pkgopt{footnote}, \pkgopt{dua}
and \pkgopt{description} use \ics{defglsdisplay} and 
\ics{defglsdisplayfirst} (described \ifmakedtx{in 
\autoref{sec:glsdisplay}}{\htmlref{earlier}{sec:glsdisplay}}) 
to change the way the link text is displayed. This means that these
package options only work for the glossary type given by
\cs{acronymtype}. If you have multiple lists of acronyms, you
will need to make the appropriate changes for each additional
glossary type.

\begin{description}
\item[\pkgopt{description},\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} 
When these two package options are used together, the \firstuse\ displays
the entry as:\\[10pt]
\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long} 
\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
where \meta{insert} indicates the text supplied in the final
optional argument to \cs{gls}, \cs{glspl} or their uppercase 
variants.

In this case, the long form is stored in the \gloskey{symbol} key.
This means that the long form will not be displayed in the list of
acronyms unless you use a glossary style that displays the entry's
symbol (for example, the \glostyle{index} style). Entries will 
be sorted according to the short form.

Note also that when these two package options are used (in the
given order), the \sty{glossaries} package additionally implements the
\pkgopt{sanitize} option using 
\ipkgopt[description]{sanitize}\ipkgopt[symbol]{sanitize}\verb|sanitize={description=false,symbol=false}|, so 
remember to protect fragile commands when defining acronyms.

\item[\pkgopt{dua}]\ifmakedtx{\mbox{}\par}{} 
The \pkgopt{dua} package option always displays the expanded
form and so may not be used with \pkgopt{footnote}, \pkgopt{smaller} or 
\pkgopt{smallcaps}. Both \firstuse\ and subsequent use displays the
entry in the form:\\[10pt]
\meta{long}\meta{insert}\\[10pt]
If the \pkgopt{description} package option is also used, the 
\gloskey{name} key is set to the long form, otherwise the
\gloskey{name} key is set to the short form and the
\gloskey{description} key is set to the long form. In both
cases the \gloskey{symbol} is set to the short form. Therefore,
if you use the \pkgopt{description} package option and you want
the short form to appear in the list of acronyms, you will need
to use a glossary style that displays the entry's symbol (for 
example, the \glostyle{index} style). Entries will be sorted
according to the long form if the \pkgopt{description} option
is used, otherwise they will be sorted according to the
short form (unless overridden by the \gloskey{sort} key in 
the optional argument of \ics{newacronym}).

\item[\pkgopt{description}]\ifmakedtx{\mbox{}\par}{} 
This package option displays the entry on \firstuse\ as:\\[10pt]
\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
Note also that if this package option is used, the \sty{glossaries}
package additionally implements the option 
\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so
remember to protect fragile commands when defining acronyms.

Note that with this option, you need to specify the description
using the \gloskey{description} key in the optional argument
of \ics{newacronym}. When this option is used without 
the \pkgopt{footnote} or \pkgopt{dua} options, the name field
is specified as
\DescribeMacro{\acrnameformat}\ics{acrnameformat}\marg{short}\marg{long}. This
defaults to \ics{acronymfont}\marg{short}, which means that the
long form will not appear in the list of acronyms by default.
To change this, you need to redefine \ics{acrnameformat} as
appropriate. For example, to display the long form followed
by the short form in parentheses do:
\begin{verbatim}
\renewcommand*{\acrnameformat}[2]{#2 (\acronymfont{#1})}
\end{verbatim}
Note that even if you redefine \ics{acrnameformat}, the
entries will be sorted according to the short form, unless you
override this using the \gloskey{sort} key in the optional
argument to \ics{newacronym}.

\item[\pkgopt{footnote}]\ifmakedtx{\mbox{}\par}{} 
This package option displays the entry on \firstuse\ as:\\[10pt]
\cs{firstacronymfont}\marg{abbrv}\meta{insert}\cs{footnote}\marg{long}\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
Acronyms will be sorted according to the short form.

Note also that if this package option is used, the \sty{glossaries}
package additionally implements the option 
\ipkgopt[description]{sanitize}\verb|sanitize={description=false}|, so
remember to protect fragile commands when defining acronyms.

Note that on \firstuse, it is the long form in the footnote that
links to the relevant glossary entry (where hyperlinks are enabled),
whereas on subsequent use, the acronym links to the relevant
glossary entry. It is possible to change this to make the acronym
on \firstuse\ have the hyperlink instead of the footnote, but 
since the footnote marker will also be a hyperlink, you will
have two hyperlinks in immediate succession. This can be
ambiguous where the hyperlinks are coloured rather than boxed.
The code required to change the \firstuse\ to make the
acronym a hyperlink is as follows:
\begin{verbatim}
 \defglsdisplayfirst[\acronymtype]{%
 \noexpand\protect\noexpand
    \glslink[\@gls@link@opts]{\@gls@link@label}{\firstacronymfont{#1}#4}%
    \noexpand\protect\noexpand\footnote{#2}}%
\end{verbatim}
\textbf{Note} that this involves using internal commands
(i.e.\ commands whose name contains an \verb|@| character), so
if this code is place in a \texttt{.tex} file it needs to be
placed within a \cs{makeatletter} \ldots\ \cs{makeatother} pair.
(See \ifmakedtx{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}}{\htmladdnormallink{\cs{@} and \texttt{@} in macro names}{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=atsigns}} 
for further details.)

\item[\pkgopt{smallcaps}]\ifmakedtx{\mbox{}\par}{} 
If neither the \pkgopt{footnote} nor \pkgopt{description} options
have been set, this option displays the entry on \firstuse\ as:\\[10pt]
\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
where \cs{acronymfont} is set to \verb|\textsc{#1}|.

\begin{important}
Note that since the acronym is displayed using \ics{textsc}, 
the short form, \meta{abbrv}, should be specified in lower case.
\ifmakedtx{(Recall that "\textsc{abc}" produces \textsc{abc} whereas 
"\textsc{ABC}" produces \textsc{ABC}.)}{}
\end{important}

Note also that if this package option is used, the \sty{glossaries}
package additionally implements the option 
\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so
remember to protect fragile commands when defining acronyms.

\item[\pkgopt{smaller}]\ifmakedtx{\mbox{}\par}{} 
If neither the \pkgopt{footnote} nor \pkgopt{description} options
have been set, this option displays the entry on \firstuse\ as:\\[10pt]
\meta{long}\meta{insert} (\cs{firstacronymfont}\marg{abbrv})\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
where \cs{acronymfont} is set to 
\verb|\textsmaller{#1}|.\footnote{not that this was change from 
using \ics{smaller} to \ics{textsmaller} as declarations
cause a problem for \ics{makefirstuc}.}
The entries will be sorted according to the short form.

\begin{important}
Remember to load a package that defines \ics{textsmaller} (such as
\isty{relsize}) if you want to use this option, unless you want
to redefine \ics{acronymfont} to use some other formatting command.
\end{important}

Note also that if this package option is used, the \sty{glossaries}
package additionally implements the option 
\ipkgopt[symbol]{sanitize}\verb|sanitize={symbol=false}|, so
remember to protect fragile commands when defining acronyms.

\item[None of the above]\ifmakedtx{\mbox{}\par}{} 
If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller},
\pkgopt{footnote}, \pkgopt{dua} or \pkgopt{description} are used, 
then on \firstuse\ the entry is displayed as:\\[10pt]
\meta{long} (\meta{abbrv})\meta{insert}\\[10pt]
while subsequent use displays the entry as:\\[10pt]
\meta{abbrv}\meta{insert}\\[10pt]
Entries will be sorted according to the short form.
Note that if none of the acronym-related package options are used,
the \pkgopt{sanitize} option will not be affected.
\end{description}

Recall from \ifmakedtx{\autoref{sec:glslink}}{\htmlref{earlier}{sec:glslink}} 
that you can access the values of individual keys using commands
like \ics{glstext}, so it is possible to use these commands to
print just the long form or just the abbreviation without affecting
the flag that determines whether the entry has been used. However
the keys that store the long and short form vary depending on
the acronym style, so the \sty{glossaries} package provides
commands that are set according to the package options. These are
as follows:
\vspace{10pt}\par\noindent
\DescribeMacro{\acrshort}
\cs{acrshort}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\Acrshort}
\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\ACRshort}
\cs{ACRshort}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
Print the abbreviated version with (if required) a hyperlink to the
relevant entry in the glossary. This is usually equivalent to
\ics{glstext} (or its uppercase variants) but may additionally
put the link text within the argument to \ics{acronymfont}.
\vspace{10pt}\par\noindent
\DescribeMacro{\acrlong}
\cs{acrlong}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\Acrlong}
\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\ACRlong}
\cs{ACRlong}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
Print the long version with (if required) a hyperlink to the
relevant entry in the glossary. This is may be equivalent to
\ics{glsdesc},  \ics{glssymbol} or \ics{glsfirst} (or their uppercase 
variants), depending on package options.
\vspace{10pt}\par\noindent
\DescribeMacro{\acrfull}
\cs{acrfull}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\Acrfull}
\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert}\\
\DescribeMacro{\ACRfull}
\cs{ACRfull}\oarg{options}\marg{label}\oarg{insert}\\[10pt]
Print the long version followed by the abbreviation in brackets 
with (if required) a hyperlink to the
relevant entry in the glossary.

\begin{important}
Note that if any of the above commands produce unexpected output
and you haven't used any of the acronym-related package options,
you will need to switch off the sanitization\ipkgopt{sanitize}. 
For example:
\begin{verbatim}
\usepackage[sanitize=none]{glossaries}
\end{verbatim}
However, if you do this, you must remember to protect fragile
commands when defining acronyms or glossary entries.
\end{important}

Note that if you change the definition of \ics{newacronym}, you
may additionally need to change the above commands as well as
changing the way the text is displayed using \ics{defglsdisplay}
and \ics{defglsdisplayfirst}.

The package option \pkgopt{shortcuts} provides the synonyms listed
in \tableref{tab:shortcuts}. If any of those commands generate
an \dq{undefined control sequence} error message, check that you
have enabled the shortcuts using the \pkgopt{shortcuts} package 
option. Note that there are no shortcuts for the commands that
produce all upper case text.

\begin{table}[htbp]
\caption[Synonyms provided by the package option shortcuts]{Synonyms provided by the package option \pkgopt{shortcuts}}
\label{tab:shortcuts}
\begin{center}
\begin{tabular}{ll}
\bfseries Shortcut Command & \bfseries Equivalent Command\\
\ics{acs} & \ics{acrshort}\\
\ics{Acs} & \ics{Acrshort}\\
\ics{acsp} & \ics{acrshortpl}\\
\ics{Acsp} & \ics{Acrshortpl}\\
\ics{acl} & \ics{acrlong}\\
\ics{Acl} & \ics{Acrlong}\\
\ics{aclp} & \ics{acrlongpl}\\
\ics{Aclp} & \ics{Acrlongpl}\\
\ics{acf} & \ics{acrfull}\\
\ics{Acf} & \ics{Acrfull}\\
\ics{acfp} & \ics{acrfullpl}\\
\ics{Acfp} & \ics{Acrfullpl}\\
\ics{ac} & \ics{gls}\\
\ics{Ac} & \ics{Gls}\\
\ics{acp} & \ics{glspl}\\
\ics{Acp} & \ics{Glspl}
\end{tabular}
\end{center}
\end{table}

\ifmakedtx{}{\toTop}

\subsubsection{Upgrading From the glossary Package}
\label{sec:oldacronym}
Users of the obsolete \isty{glossary} package may recall that
the syntax used to define new acronyms has changed with the
replacement \sty{glossaries} package. In addition, the old
\isty{glossary} package created the command 
\cs{}\meta{acr-name} when defining the acronym \meta{acr-name}.

In order to facilitate migrating from the old package to the new
one, the \isty{glossaries} package\footnote{as from version 1.18} 
provides the command:\\[10pt]
\DescribeMacro{\oldacronym}\cs{oldacronym}\oarg{label}\marg{abbrv}\marg{long}\marg{key-val list}\\[10pt]
This uses the same syntax as the \isty{glossary} package's
method of defining acronyms. It is equivalent to:\\[10pt]
\ics{newacronym}\oarg{key-val list}\marg{label}\marg{abbrv}\marg{long}\\[10pt]
In addition, \ics{oldacronym} also defines the commands
\cs{}\meta{label}, which is equivalent to \ics{gls}\marg{label},
and \cs{}\meta{label}\texttt{*}, which is equivalent to
\ics{Gls}\marg{label}. If \meta{label} is omitted, \meta{abbrv}
is used. Since commands names must consist only of alphabetical
characters, \meta{label} must also only consist of alphabetical
characters. Note that \cs{}\meta{label} doesn't allow you to use
the first optional argument of \ics{gls} or \ics{Gls} --- you will
need to explicitly use \ics{gls} or \ics{Gls} to change the
settings.

\begin{important}
Recall that, in general, \LaTeX\ ignores spaces following command 
names consisting of alphabetical characters. This is also true for 
\cs{}\meta{label} unless you additionally load the
\isty{xspace} package.
\end{important}

The \isty{glossaries} package doesn't load the \isty{xspace} package
since there are both advantages and disadvantages to using
\ics{xspace} in \cs{}\meta{label}. If you don't use the 
\isty{xspace} package you need to explicitly force a space using
\verb*|\ | (backslash space) however you can follow \cs{}\meta{label}
with additional text in square brackets (the final optional
argument to \ics{gls}). If you use the \isty{xspace} package
you don't need to escape the spaces but you can't use
the optional argument to insert text (you will have to explicitly
use \ics{gls}).

To illustrate this, suppose I define the acronym \dq{abc} as
follows:
\begin{verbatim}
\oldacronym{abc}{example acronym}{}
\end{verbatim}
This will create the command \cs{abc} and its starred version
\cs{abc*}. \Tableref{tab:xspace} illustrates the effect of
\cs{abc} (on subsequent use) according to whether or not the
\isty{xspace} package has been loaded. As can be seen from the
final row in the table, the \isty{xspace} package prevents the
optional argument from being recognised.

\begin{table}[htbp]
\caption[The effect of using xspace]{The effect of using 
\sty{xspace} with \cs{oldacronym}}
\label{tab:xspace}
\vskip\baselineskip
\centering
\begin{tabular}{lll}
\bfseries Code & \bfseries With \sty{xspace} &
\bfseries Without \sty{xspace}\\
\verb|\abc.| & abc. & abc.\\
\verb|\abc xyz| & abc xyz & abcxyz\\
\verb|\abc\ xyz| & abc xyz & abc xyz\\
\verb|\abc* xyz| & Abc xyz & Abc xyz\\
\verb|\abc['s] xyz| & abc ['s] xyz & abc's xyz
\end{tabular}
\par
\end{table}

\ifmakedtx{}{\toTop}

\subsection{Unsetting and Resetting Entry Flags}
\label{sec:glsunset}

When using \ics{gls}, \ics{glspl} and their uppercase variants it is
possible that you may want to use the value given by the
\gloskey{first} key, even though you have already used the glossary
entry\ifirstuse. Conversely, you may want to use the value given by the
\gloskey{text} key, even though you haven't used the glossary entry.
The former can be achieved by one of the following commands:\\[10pt]
\DescribeMacro{\glsreset}\cs{glsreset}\marg{label}\\
\DescribeMacro{\glslocalreset}\cs{glslocalreset}\marg{label}\\[10pt]
while the latter can be achieved by one of the following commands:\\[10pt]
\DescribeMacro{\glsunset}\cs{glsunset}\marg{label}\\
\DescribeMacro{\glslocalunset}\cs{glslocalunset}\marg{label}
\\[10pt]
You can also reset or unset all entries for a given glossary or list of
glossaries using:\\[10pt]
\DescribeMacro{\glsresetall}\cs{glsresetall}\oarg{glossary list}\\
\DescribeMacro{\glslocalresetall}\cs{glslocalresetall}\oarg{glossary list}\\
\DescribeMacro{\glsunsetall}\cs{glsunsetall}\oarg{glossary list}\\
\DescribeMacro{\glslocalunsetall}\cs{glslocalunsetall}\oarg{glossary list}\\[10pt]
where \meta{glossary list} is a comma-separated list of 
glossary labels. If omitted, all defined glossaries are assumed.
For example, to reset all entries in the main glossary and the
list of acronyms:
\begin{verbatim}
\glsresetall[main,acronym]
\end{verbatim}

You can determine whether an entry's first use flag is set using:\\[10pt]
\DescribeMacro{\ifglsused}
\cs{ifglsused}\marg{label}\marg{true part}\marg{false part}\\[10pt]
where \meta{label} is the label of the required entry. If the
entry has been used, \meta{true part} will be done, otherwise
\meta{false part} will be done.
\ifmakedtx{}{\toTop}

\subsection{Glossary Styles}
\label{sec:styles}
The \sty{glossaries} package comes with some pre-defined
glossary styles. Note that the styles are suited to different
types of glossaries: some styles ignore the associated
symbol; some styles are not designed for hierarchical entries,
so they display sub-entries in the same way as they display top
level entries; some styles are designed for homographs, so they 
ignore the name for sub-entries. You should therefore pick a style 
that suits your type of glossary. See \tableref{tab:styles} for
a summary of the available styles.

\begin{table}[htbp]
\caption[Glossary Styles]{Glossary Styles. An asterisk in the style 
name indicates anything that matches that doesn't match any
previously listed style (e.g.\ \texttt{long3col*}
matches \glostyle{long3col}, \glostyle{long3colheader}, 
\glostyle{long3colborder} and \glostyle{long3colheaderborder}).
A maximum level of 0 indicates a flat glossary (sub-entries
are displayed in the same way as main entries). Where the maximum
level is given as --- there is no limit, but note that 
\appname{makeindex} imposes a limit of 2 sub-levels. If the
homograph column is checked, then the name is not displayed for
sub-entries. If the symbol column is checked, then the symbol will
be displayed if it has been defined.}
\label{tab:styles}
\vskip\baselineskip
\centering
\begin{tabular}{lccc}
\bfseries Style & \bfseries Maximum Level &
\bfseries Homograph & \bfseries Symbol\\
\ttfamily listdotted & 0 & & \\
\ttfamily sublistdotted & 1 & & \\
\ttfamily list* & 1 & \tick & \\
\ttfamily altlist* & 1 & \tick & \\
\ttfamily long*3col* & 1 & \tick & \\
\ttfamily long4col* & 1 & \tick & \tick \\
\ttfamily altlong*4col* & 1 & \tick & \tick \\
\ttfamily long* & 1 & \tick & \\
\ttfamily super*3col* & 1 & \tick & \\
\ttfamily super4col* & 1 & \tick & \tick \\
\ttfamily altsuper*4col* & 1 & \tick & \tick \\
\ttfamily super* & 1 & \tick & \\
\ttfamily index* & 2 & & \tick\\
\ttfamily treenoname* & --- & \tick & \tick\\
\ttfamily tree* & --- & & \tick\\
\ttfamily alttree* & --- & & \tick
\end{tabular}
\par
\end{table}

The glossary style can be set using the \gloskey[printglossary]{style} key in the optional
argument to \ics{printglossary} or using the command:\\[10pt]
\DescribeMacro{\glossarystyle}\cs{glossarystyle}\marg{style-name}\\[10pt]
Some of the glossary styles may also be set using the \pkgopt{style} 
package option, it depends if the package in which they are defined
is automatically loaded by the \sty{glossaries} package.

The tabular-like styles that allow multi-line descriptions and page
lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth}
to set the width of the description column and the length
\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the
width of the page list column.\footnote{these lengths will not be
available if you use both the \pkgopt{nolong} and \pkgopt{nosuper}
package options or if you use the \pkgopt{nostyles} package option
unless you explicitly load the relevant package.}
These will need to be changed using \cs{setlength} if the glossary
is too wide. Note that the \glostyle{long4col} and
\glostyle{super4col} styles (and their header and border variations)
don't use these lengths as they are designed for single line
entries. Instead you should use the analogous \glostyle{altlong4col}
and \glostyle{altsuper4col} styles.  If you want to
explicitly create a line-break within a multi-line description in
a tabular-like style you should use \ics{newline} instead of
\verb|\\|.

Note that if you use the \gloskey[printglossary]{style} key in the
optional argument to \ics{printglossary}, it will override any 
previous style settings for the given glossary, so if, for example,
you do
\begin{verbatim}
\renewcommand*{\glsgroupskip}{}
\printglossary[style=long]
\end{verbatim}
then the new definition of \ics{glsgroupskip} will not have an affect
for this glossary, as \cs{glsgroupskip} is redefined by 
\verb|style=long|. Likewise, \ics{glossarystyle} will also
override any previous style definitions, so, again
\begin{verbatim}
\renewcommand*{\glsgroupskip}{}
\glossarystyle{long}
\end{verbatim}
will reset \cs{glsgroupskip} back to its default definition for the
named glossary style (\glostyle{long} in this case). If you want to 
modify the styles, either use \ics{newglossarystyle} (described
in the next section) or make the modifications after 
\ics{glossarystyle}, e.g.:
\begin{verbatim}
\glossarystyle{long}
\renewcommand*{\glsgroupskip}{}
\end{verbatim}

 \changes{1.03}{2007 July 4}{'glspostdescription added}
All the styles except for the three- and four-column styles and the
\glostyle{listdotted} style use the command
\DescribeMacro{\glspostdescription}\cs{glspostdescription} after the
description. This simply displays a full stop by default.  To eliminate
this full stop (or replace it with something else, say, a comma) you
will need to redefine \cs{glspostdescription} before the glossary is
displayed. Alternatively, you can suppress it for a given entry
by placing \ics{nopostdesc} in the entry's description.
\ifmakedtx{}{\toTop}

\subsubsection{List Styles}
\label{sec:liststyles}

The styles described in this section are all defined in the package
\isty{glossary-list}. Since they all use the \envname{description}
environment, they are governed by the same parameters as that
environment. These styles all ignore the entry's symbol.  Note that
these styles will automatically be available unless you use the
\pkgopt{nolist} or \pkgopt{nostyles} package options.

\begin{description}
\item[list] The \glostyle{list} style uses the \envname{description}
environment. The entry name is placed in the optional argument of
the \cs{item} command (so it will appear in bold by default). The
description follows, and then the associated \term{number list} for 
that entry. The symbol is ignored.  If the entry has child entries,
the description and number list follows (but not the name) for each
child entry.  Groups are separated using \cs{indexspace}.

\item[listgroup] The \glostyle{listgroup} style is like 
\glostyle{list} but the glossary groups have headings.

\item[listhypergroup] The \glostyle{listhypergroup} style is like 
\glostyle{listgroup} but has a navigation line at the start of
the glossary with links to each group that is present in the 
glossary. This requires an additional run through \LaTeX\ to ensure 
the group information is up to date.  In the navigation line, each 
group is separated
by \DescribeMacro{\glshypernavsep}\cs{glshypernavsep} which 
defaults to a vertical bar with a space on either side. For example,
to simply have a space separating each group, do:
\begin{verbatim}
\renewcommand*{\glshypernavsep}{\space}
\end{verbatim}

Note that the hyper-navigation line is now (as from version 1.14) 
set inside the optional argument to \cs{item} instead of after it
to prevent a spurious space at the start. This can be changed
by redefining \ics{glossaryheader}, but note that this needs to
be done \emph{after} the glossary style has been set.

\item[altlist] The \glostyle{altlist} style is like \glostyle{list}
but the description starts on the line following the name. (As
with the \glostyle{list} style, the symbol is ignored.) Each child
entry starts a new line, but as with the \glostyle{list} style,
the name associated with each child entry is ignored.

\item[altlistgroup] The \glostyle{altlistgroup} style is like 
\glostyle{altlist} but the glossary groups have headings.

\item[altlisthypergroup] The \glostyle{altlisthypergroup} style is like 
\glostyle{altlistgroup} but has a set of links to the glossary 
groups. The navigation line is the same as that for 
\glostyle{listhypergroup}, described above.

\item[listdotted] This style uses the \envname{description}
environment.\footnote{This style was supplied by Axel~Menzel.}  Each
entry starts with \verb|\item[]|, followed by the name followed by a
dotted line, followed by the description. Note that this style
ignores both the \term{number list} and the symbol. The length
\DescribeMacro{\glslistdottedwidth}\cs{glslistdottedwidth} governs
where the description should start. This is a flat style, so child
entries are formatted in the same way as the parent entries.

\item[sublistdotted] This is a variation on the \glostyle{listdotted}
style designed for hierarchical glossaries. The main entries
have just the name displayed. The sub entries are displayed in
the same manner as \glostyle{listdotted}.
\end{description}
\ifmakedtx{}{\toTop}

\subsubsection{Longtable Styles}
\label{sec:longstyles}

The styles described in this section are all defined in the package
\isty{glossary-long}. Since they all use the \envname{longtable}
environment, they are governed by the same parameters as that
environment.  Note that these styles will automatically be available
unless you use the \pkgopt{nolong} or \pkgopt{nostyles} package
options.  These styles fully justify the description and page list
columns.  If you want ragged right formatting instead, use the
analogous styles described in
\ifmakedtx{\autoref{sec:longraggedstyles}}{\htmlref{Longtable Styles
(Ragged Right)}{sec:longraggedstyles}}.


\begin{description}
\item[long] The \glostyle{long} style uses the \envname{longtable}
environment (defined by the \isty{longtable} package). It has two
columns: the first column contains the entry's name and the second
column contains the description followed by the \term{number list}.
The entry's symbol is ignored.
Sub groups are separated with a blank row. The width of the
first column is governed by the widest entry in that column. The
width of the second column is governed by the length
\ics{glsdescwidth}. Child entries have a similar format to the
parent entries except that their name is suppressed.

\item[longborder] The \glostyle{longborder} style is like
\glostyle{long} but has horizontal and vertical lines around it.

\item[longheader] The \glostyle{longheader} style is like
\glostyle{long} but has a header row.

\item[longheaderborder] The \glostyle{longheaderborder} style is
like \glostyle{longheader} but has horizontal and vertical lines
around it.

\item[long3col] The \glostyle{long3col} style is like
\glostyle{long} but has three columns. The first column contains
the entry's name, the second column contains the description
and the third column contains the \term{number list}.
The entry's symbol is ignored. The width of the
first column is governed by the widest entry in that column, the
width of the second column is governed by the length
\ics{glsdescwidth}, and the width of the third column is governed by the
length \ics{glspagelistwidth}.

\item[long3colborder] The \glostyle{long3colborder} style is like
the \glostyle{long3col} style but has horizontal and vertical
lines around it.

\item[long3colheader] The \glostyle{long3colheader} style is like
\glostyle{long3col} but has a header row.

\item[long3colheaderborder] The \glostyle{long3colheaderborder} style is
like \glostyle{long3colheader} but has horizontal and vertical lines
around it.

\item[long4col] The \glostyle{long4col} style is like 
\glostyle{long3col} but has an additional column in which the
entry's associated symbol appears. This style is used for brief
single line descriptions. The column widths are governed by the
widest entry in the given column. Use \glostyle{altlong4col} for 
multi-line descriptions.

\item[long4colborder] The \glostyle{long4colborder} style is like
the \glostyle{long4col} style but has horizontal and vertical
lines around it.

\item[long4colheader] The \glostyle{long4colheader} style is like
\glostyle{long4col} but has a header row.

\item[long4colheaderborder] The \glostyle{long4colheaderborder} style is
like \glostyle{long4colheader} but has horizontal and vertical lines
around it.

\item[altlong4col] The \glostyle{altlong4col} style is like
\glostyle{long4col} but allows multi-line descriptions and page
lists.  The width of the description column is governed by the
length \ics{glsdescwidth} and the width of the page list column is
governed by the length \ics{glspagelistwidth}. The widths of the
name and symbol columns are governed by the widest entry in the
given column.

\item[altlong4colborder] The \glostyle{altlong4colborder} style is like
the \glostyle{long4colborder} but allows multi-line descriptions and
page lists.

\item[altlong4colheader] The \glostyle{altlong4colheader} style is like
\glostyle{long4colheader} but allows multi-line descriptions and
page lists.

\item[altlong4colheaderborder] The \glostyle{altlong4colheaderborder} 
style is like \glostyle{long4colheaderborder} but allows multi-line
descriptions and page lists.
\end{description}
\ifmakedtx{}{\toTop}

\subsubsection{Longtable Styles (Ragged Right)}
\label{sec:longraggedstyles}

The styles described in this section are all defined in the package
\isty{glossary-longragged}. These styles are analogous to those
defined in \isty{glossary-long} but the multiline columns are left
justified instead of fully justified. Since these styles all use the
\envname{longtable} environment, they are governed by the same
parameters as that environment. The \isty{glossary-longragged}
package additionally requires the \isty{array} package.  Note that
these styles will only be available if you explicitly load
\isty{glossary-longragged}:
\begin{verbatim}
\usepackage{glossaries}
\usepackage{glossary-longragged}
\end{verbatim}
Note that you can't set these styles using the \pkgopt{style}
package option since the styles aren't defined until after
the \sty{glossaries} package has been loaded.

\begin{description}
\item[longragged] The \glostyle{longragged} style has two
columns: the first column contains the entry's name and the second
column contains the (left-justified) description followed by the 
\term{number list}.  The entry's symbol is ignored.
Sub groups are separated with a blank row. The width of the
first column is governed by the widest entry in that column. The
width of the second column is governed by the length
\ics{glsdescwidth}. Child entries have a similar format to the
parent entries except that their name is suppressed.

\item[longraggedborder] The \glostyle{longraggedborder} style is like
\glostyle{longragged} but has horizontal and vertical lines around it.

\item[longraggedheader] The \glostyle{longraggedheader} style is like
\glostyle{longragged} but has a header row.

\item[longraggedheaderborder] The \glostyle{longraggedheaderborder} 
style is like \glostyle{longraggedheader} but has horizontal and 
vertical lines around it.

\item[longragged3col] The \glostyle{longragged3col} style is like
\glostyle{longragged} but has three columns. The first column
contains the entry's name, the second column contains the (left
justified) description and the third column contains the (left
justified) \term{number list}.  The entry's symbol is ignored. The
width of the first column is governed by the widest entry in that
column, the width of the second column is governed by the length
\ics{glsdescwidth}, and the width of the third column is governed by
the length \ics{glspagelistwidth}.

\item[longragged3colborder] The \glostyle{longragged3colborder}
style is like the \glostyle{longragged3col} style but has horizontal
and vertical lines around it.

\item[longragged3colheader] The \glostyle{longragged3colheader} style is like
\glostyle{longragged3col} but has a header row.

\item[longragged3colheaderborder] The \glostyle{longragged3colheaderborder} style is
like \glostyle{longragged3colheader} but has horizontal and vertical lines
around it.

\item[altlongragged4col] The \glostyle{altlongragged4col} style is
like \glostyle{longragged3col} but has an additional column in which
the entry's associated symbol appears. The width of the description
column is governed by the length \ics{glsdescwidth} and the width of
the page list column is governed by the length
\ics{glspagelistwidth}. The widths of the name and symbol columns
are governed by the widest entry in the given column.

\item[altlongragged4colborder] The
\glostyle{altlongragged4colborder} style is like the
\glostyle{altlongragged4col} but has horizontal and vertical lines
around it.

\item[altlongragged4colheader] The
\glostyle{altlongragged4colheader} style is like
\glostyle{altlongragged4col} but has a header row.

\item[altlongragged4colheaderborder] The
\glostyle{altlongragged4colheaderborder} style is like
\glostyle{altlongragged4colheader} but has horizontal and vertical
lines around it.

\end{description}
\ifmakedtx{}{\toTop}

\subsubsection{Supertabular Styles}
\label{sec:superstyles}

The styles described in this section are all defined in the package
\isty{glossary-super}. Since they all use the \envname{supertabular}
environment, they are governed by the same parameters as that
environment.  Note that these styles will automatically be available
unless you use the \pkgopt{nosuper} or \pkgopt{nostyles} package
options.  In general, the \envname{longtable} environment is better,
but there are some circumstances where it is better to use
\envname{supertabular}.\footnote{e.g.\ with the \isty{flowfram}
package.} These styles fully justify the description and page list
columns.  If you want ragged right formatting instead, use the
analogous styles described in
\ifmakedtx{\autoref{sec:superraggedstyles}}{\htmlref{Supertabular
Styles (Ragged Right)}{sec:superraggedstyles}}.


\begin{description}
\item[super] The \glostyle{super} style uses the \envname{supertabular}
environment (defined by the \isty{supertabular} package). It has two
columns: the first column contains the entry's name and the second
column contains the description followed by the \term{number list}.
The entry's symbol is ignored.
Sub groups are separated with a blank row. The width of the
first column is governed by the widest entry in that column. The
width of the second column is governed by the length
\ics{glsdescwidth}. Child entries have a similar format to the
parent entries except that their name is suppressed.

\item[superborder] The \glostyle{superborder} style is like
\glostyle{super} but has horizontal and vertical lines around it.

\item[superheader] The \glostyle{superheader} style is like
\glostyle{super} but has a header row.

\item[superheaderborder] The \glostyle{superheaderborder} style is
like \glostyle{superheader} but has horizontal and vertical lines
around it.

\item[super3col] The \glostyle{super3col} style is like
\glostyle{super} but has three columns. The first column contains
the entry's name, the second column contains the description
and the third column contains the \term{number list}. The
entry's symbol is ignored. The width of the
first column is governed by the widest entry in that column. The
width of the second column is governed by the length
\ics{glsdescwidth}. The width of the third column is governed by the
length \ics{glspagelistwidth}.

\item[super3colborder] The \glostyle{super3colborder} style is like
the \glostyle{super3col} style but has horizontal and vertical
lines around it.

\item[super3colheader] The \glostyle{super3colheader} style is like
\glostyle{super3col} but has a header row.

\item[super3colheaderborder] The \glostyle{super3colheaderborder} style
is like \glostyle{super3colheader} but has horizontal and vertical
lines around it.

\item[super4col] The \glostyle{super4col} style is like 
\glostyle{super3col} but has an additional column in which the
entry's associated symbol appears. This style is designed for
entries with brief single line descriptions. The column widths are governed by the
widest entry in the given column. Use \glostyle{altsuper4col}
for multi-line descriptions.

\item[super4colborder] The \glostyle{super4colborder} style is like
the \glostyle{super4col} style but has horizontal and vertical
lines around it.

\item[super4colheader] The \glostyle{super4colheader} style is like
\glostyle{super4col} but has a header row.

\item[super4colheaderborder] The \glostyle{super4colheaderborder} style
is like \glostyle{super4colheader} but has horizontal and vertical
lines around it.

\item[altsuper4col] The \glostyle{altsuper4col} style is like 
\glostyle{super4col} but allows multi-line descriptions and page
lists.
The width of the description column is governed by the length
\ics{glsdescwidth} and the width of the page list column is
governed by the length \ics{glspagelistwidth}. The width of the name 
and symbol columns is governed by the widest entry in the 
given column.

\item[altsuper4colborder] The \glostyle{altsuper4colborder} style is like
the \glostyle{super4colborder} style but allows multi-line descriptions
and page lists.

\item[altsuper4colheader] The \glostyle{altsuper4colheader} style is like
\glostyle{super4colheader} but allows multi-line descriptions and
page lists.

\item[altsuper4colheaderborder] The \glostyle{altsuper4colheaderborder}
style is like \glostyle{super4colheaderborder} but allows multi-line
descriptions and page lists.
\end{description}
\ifmakedtx{}{\toTop}

\subsubsection{Supertabular Styles (Ragged Right)}
\label{sec:superraggedstyles}

The styles described in this section are all defined in the package
\isty{glossary-superragged}. These styles are analogous to those
defined in \isty{glossary-super} but the multiline columns are left
justified instead of fully justified. Since these styles all use the
\envname{supertabular} environment, they are governed by the same
parameters as that environment. The \isty{glossary-superragged}
package additionally requires the \isty{array} package.  Note that
these styles will only be available if you explicitly load
\isty{glossary-superragged}:
\begin{verbatim}
\usepackage{glossaries}
\usepackage{glossary-superragged}
\end{verbatim}
Note that you can't set these styles using the \pkgopt{style}
package option since the styles aren't defined until after
the \sty{glossaries} package has been loaded.

\begin{description}
\item[superragged] The \glostyle{superragged} style uses the
\envname{supertabular} environment (defined by the
\isty{supertabular} package). It has two columns: the first column
contains the entry's name and the second column contains the (left
justified) description followed by the \term{number list}.  The
entry's symbol is ignored.  Sub groups are separated with a blank
row. The width of the first column is governed by the widest entry
in that column. The width of the second column is governed by the
length \ics{glsdescwidth}. Child entries have a similar format to
the parent entries except that their name is suppressed.

\item[superraggedborder] The \glostyle{superraggedborder} style is
like \glostyle{superragged} but has horizontal and vertical lines
around it.

\item[superraggedheader] The \glostyle{superraggedheader} style is
like \glostyle{superragged} but has a header row.

\item[superraggedheaderborder] The
\glostyle{superraggedheaderborder} style is like
\glostyle{superraggedheader} but has horizontal and vertical lines
around it.

\item[superragged3col] The \glostyle{superragged3col} style is like
\glostyle{superragged} but has three columns. The first column
contains the entry's name, the second column contains the (left
justified) description and the third column contains the (left
justified) \term{number list}. The entry's symbol is ignored. The
width of the first column is governed by the widest entry in that
column. The width of the second column is governed by the length
\ics{glsdescwidth}. The width of the third column is governed by the
length \ics{glspagelistwidth}.

\item[superragged3colborder] The \glostyle{superragged3colborder}
style is like the \glostyle{superragged3col} style but has
horizontal and vertical lines around it.

\item[superragged3colheader] The \glostyle{superragged3colheader}
style is like \glostyle{superragged3col} but has a header row.

\item[superragged3colheaderborder] The
\glostyle{superragged3colheaderborder} style is like
\glostyle{superragged3colheader} but has horizontal and vertical
lines around it.

\item[altsuperragged4col] The \glostyle{altsuperragged4col} style is
like \glostyle{superragged3col} but has an additional column in
which the entry's associated symbol appears. The column widths for
the name and symbol column are governed by the widest entry in the
given column.

\item[altsuperragged4colborder] The
\glostyle{altsuperragged4colborder} style is like the
\glostyle{altsuperragged4col} style but has horizontal and vertical
lines around it.

\item[altsuperragged4colheader] The
\glostyle{altsuperragged4colheader} style is like
\glostyle{altsuperragged4col} but has a header row.

\item[altsuperragged4colheaderborder] The
\glostyle{altsuperragged4colheaderborder} style is like
\glostyle{altsuperragged4colheader} but has horizontal and vertical
lines around it.

\end{description}
\ifmakedtx{}{\toTop}

\subsubsection{Tree-Like Styles}
\label{sec:treestyles}

The styles described in this section are all defined in the package
\isty{glossary-tree}. These styles are designed for hierarchical
glossaries but can also be used with glossaries that don't have
sub-entries. These styles will display the entry's symbol if it
exists. Note that these styles will automatically be available
unless you use the \pkgopt{notree} or \pkgopt{nostyles} package
options.

\begin{description}
\item[index] The \glostyle{index} style is similar to the way
indices are usually formatted in that it has a hierarchical
structure up to three levels (the main level plus two sub-levels).
The name is typeset in bold, and if the symbol is present it is set
in parentheses after the name and before the description.
Sub-entries are indented and also include the name, the symbol
in brackets (if present) and the description.  Groups are separated
using \ics{indexspace}.

\item[indexgroup] The \glostyle{indexgroup} style is similar to
the \glostyle{index} style except that each group has a heading.

\item[indexhypergroup] The \glostyle{indexhypergroup} style is like 
\glostyle{indexgroup} but has a set of links to the glossary 
groups. The navigation line is the same as that for 
\glostyle{listhypergroup}, described above.

\item[tree] The \glostyle{tree} style is similar to the
\glostyle{index} style except that it can have arbitrary levels.
(Note that \appname{makeindex} is limited to three levels, so
you will need to use \appname{xindy} if you want more than 
three levels.) Each sub-level is indented by 
\DescribeMacro{\glstreeindent}\cs{glstreeindent}. Note that the
name, symbol (if present) and description are placed in the
same paragraph block. If you want the name to be apart from the
description, use the \glostyle{alttree} style instead. (See below.)

\item[treegroup] The \glostyle{treegroup} style is similar to
the \glostyle{tree} style except that each group has a heading.

\item[treehypergroup] The \glostyle{treehypergroup} style is like 
\glostyle{treegroup} but has a set of links to the glossary 
groups. The navigation line is the same as that for 
\glostyle{listhypergroup}, described above.

\item[treenoname] The \glostyle{treenoname} style is like
the \glostyle{tree} style except that the name for each sub-entry
is ignored.

\item[treenonamegroup] The \glostyle{treenonamegroup} style is 
similar to the \glostyle{treenoname} style except that each group 
has a heading.

\item[treenonamehypergroup] The \glostyle{treenonamehypergroup} 
style is like \glostyle{treenonamegroup} but has a set of links to 
the glossary groups. The navigation line is the same as that for 
\glostyle{listhypergroup}, described above.

\item[alttree] The \glostyle{alttree} style is similar to the
\glostyle{tree} style except that the indentation for each level
is determined by the width of the text specified by\\[10pt]
\DescribeMacro{\glssetwidest}\cs{glssetwidest}\oarg{level}\marg{text}\\[10pt]
The optional argument \meta{level} indicates the level, where
0 indicates the top-most level, 1 indicates the first level 
sub-entries, etc. If \cs{glssetwidest} hasn't been used for a 
given sub-level, the level~0 widest text is used instead. If
\meta{level} is omitted, 0 is assumed.

For each level, the name is placed to the left of the paragraph
block containing the symbol (optional) and the description. If the
symbol is present, it is placed in parentheses before the
description.

\item[alttreegroup] The \glostyle{alttreegroup} is like the
\glostyle{alttree} style except that each group has a heading.

\item[alttreehypergroup] The \glostyle{alttreehypergroup} style is 
like \glostyle{alttreegroup} but has a set of links to the glossary 
groups. The navigation line is the same as that for 
\glostyle{listhypergroup}, described above.

\end{description}

\ifmakedtx{}{\toTop}

\subsection{Defining your own glossary style}
\label{sec:newglossarystyle}

If the predefined styles don't fit your requirements, you can
define your own style using\DescribeMacro{\newglossarystyle}:\\[10pt]
\cs{newglossarystyle}\marg{name}\marg{definitions}\\[10pt]
where \meta{name} is the name of the new glossary style (to be
used in \cs{glossarystyle}). The second argument \meta{definitions}
needs to redefine all of the following:

\begin{description}
\item
\DescribeEnv{theglossary}
\envname{theglossary}\par\noindent
This environment defines how the main body of the glossary should
be typeset. Note that this does not include the section heading,
the glossary preamble (defined by \cs{glossarypreamble}) or the
glossary postamble (defined by \cs{glossarypostamble}). For example,
the \glostyle{list} style uses the \envname{description} environment,
so the \envname{theglossary} environment is simply redefined to begin
and end the \envname{description} environment.

\item
\DescribeMacro{\glossaryheader}
\cs{glossaryheader}\par\noindent
This macro indicates what to do at the start of the main body
of the glossary. Note that this is not the same as 
\cs{glossarypreamble}, which should not be affected by changes in
the glossary style. The \glostyle{list} glossary style redefines
\cs{glossaryheader} to do nothing, whereas the \glostyle{longheader}
glossary style redefines \cs{glossaryheader} to do a header row.

\item
\DescribeMacro{\glsgroupheading}
\cs{glsgroupheading}\marg{label}\par\noindent This macro indicates
what to do at the start of each logical block within the main body
of the glossary. If you use \appname{makeindex} the glossary is
sub-divided into a maximum of twenty-eight logical blocks that are
determined by the first character of the \gloskey{sort} key (or
\gloskey{name} key if the \gloskey{sort} key is omitted). The
sub-divisions are in the following order: symbols, numbers, A,
\ldots, Z\@. If you use \appname{xindy}, the sub-divisions depend on
the language settings.

Note that the argument to \cs{glsgroupheading}
is a label \emph{not} the group title. The group title can be obtained
via

\DescribeMacro{\glsgetgrouptitle}\cs{glsgetgrouptitle}\marg{label}

This obtains the title as follows: if 
\cs{}\meta{label}\texttt{groupname} exists, this is taken to be the 
title, otherwise the title is just \meta{label}.

A navigation hypertarget can be created using

\DescribeMacro{\glsnavhypertarget}\cs{glsnavhypertarget}\marg{label}\marg{text}

For further details about \cs{glsnavhypertarget}, see 
\ifmakedtx{\autoref{sec:code:hypernav}}{the documented code of \isty{glossary-hypernav}
in \texttt{glossaries.pdf}}.


Most of the predefined glossary styles redefine \cs{glsgroupheading}
to simply ignore its argument.  The \glostyle{listhypergroup} style
redefines \cs{glsgroupheading} as follows:
\begin{verbatim}
\renewcommand*{\glsgroupheading}[1]{%
\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
\end{verbatim}
See also \cs{glsgroupskip} below. (Note that command definitions within 
\cs{newglossarystyle} must use \verb|##1| instead of \verb|#1| etc.)

\item
\DescribeMacro{\glsgroupskip}
\cs{glsgroupskip}\par\noindent
This macro determines what to do after one logical group but before
the header for the next logical group. The \glostyle{list} glossary
style simply redefines \cs{glsgroupskip} to be \cs{indexspace},
whereas the tabular-like styles redefine \cs{glsgroupskip} to
produce a blank row.

\item
\DescribeMacro{\glossaryentryfield}
\cs{glossaryentryfield}\marg{label}\marg{formatted
name}\marg{description}\marg{symbol}
\marg{number list}\par\noindent
This macro indicates what to do for a given glossary entry.
Note that \meta{formatted name} will always be in the form
\cs{glsnamefont}\marg{name}. This allows the user to set a given
font for the entry name, regardless of the glossary style used.
Note that \meta{label} is the label used when the glossary entry
was defined via either \cs{newglossaryentry} or \cs{newacronym}. 

Each time you use a glossary entry it creates a hyperlink (if
hyperlinks are enabled) to the relevant line in the glossary.
Your new glossary style must therefore redefine
\cs{glossaryentryfield} to set the appropriate target. This
is done using

\DescribeMacro{\glstarget}\cs{glstarget}\marg{label}\marg{text}

where \meta{label} is the entry's label. Note that you
don't need to worry about whether the \isty{hyperref} package has
been loaded, as \cs{glstarget} won't create a target if
\cs{hypertarget} hasn't been defined.

For example, the 
\glostyle{list} style defines \cs{glossaryentryfield} as follows:
\begin{verbatim}
\renewcommand*{\glossaryentryfield}[5]{%
\item[\glstarget{##1}{##2}] ##3\glspostdescription\space ##5}
\end{verbatim}

Note also that \meta{number list} will always be of the form\\[10pt]
\cs{glossaryentrynumbers}\{\cs{relax}\\
\cs{setentrycounter}\marg{counter name}\cs{glsnumberformat}\marg{number(s)}\}\\[10pt]
where \meta{number(s)}
may contain \cs{delimN} (to delimit individual numbers) and/or
\cs{delimR} (to indicate a range of numbers). There may be 
multiple occurrences of 
\cs{setentrycounter}\marg{counter name}\cs{glsnumberformat}\marg{number(s)}, but note
that the entire number list is enclosed within the argument
to \ics{glossaryentrynumbers}. The user can redefine this to change
the way the entire number list is formatted, regardless of 
the glossary style. However the most common use of
\cs{glossaryentrynumbers} is to provide a means of suppressing the
number list altogether. (In fact, the \pkgopt{nonumberlist} option 
redefines \cs{glossaryentrynumbers} to ignore its argument.)
Therefore, when you define a new glossary style, you don't need
to worry about whether the user has specified the 
\pkgopt{nonumberlist} package option.

\item
\DescribeMacro{\glossarysubentryfield}
\cs{glossarysubentryfield}\marg{level}\marg{label}\marg{formatted
name}\marg{description}\marg{symbol}
\marg{number list}\par\noindent
This is new to version 1.17, and is used to display sub-entries.
The first argument, \meta{level}, indicates the sub-entry level.
This must be an integer from 1 (first sub-level) onwards. The
remaining arguments are analogous to those for
\ics{glossaryentryfield} described above.
\end{description}

For further details of these commands, see
\ifmakedtx{\autoref{sec:code:printglos}}{the documented code in \texttt{glossaries.pdf}}.
\ifmakedtx{}{\toTop}

\subsubsection{Example: creating a completely new style}

If you want a completely new style, you will need to redefine all
of the commands and the environment listed above. 

For example, suppose you want each entry to start with a bullet point.
This means that the glossary should be placed in the \envname{itemize}
environment, so \envname{theglossary} should start and end that
environment. Let's also suppose that you don't want anything between
the glossary groups (so \ics{glsgroupheading} and \ics{glsgroupskip}
should do nothing) and suppose you don't want anything to appear
immediately after \verb|\begin{theglossary}| (so \ics{glossaryheader}
should do nothing). In addition, let's suppose the symbol should
appear in brackets after the name, followed by the description and
last of all the \term{number list} should appear within square brackets
at the end. Then you can create this new glossary style, called, say,
\texttt{mylist}, as follows:
\begin{verbatim}
 \newglossarystyle{mylist}{%
 % put the glossary in the itemize environment:
 \renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}%
 % have nothing after \begin{theglossary}:
 \renewcommand*{\glossaryheader}{}%
 % have nothing between glossary groups:
 \renewcommand*{\glsgroupheading}[1]{}%
 \renewcommand*{\glsgroupskip}{}%
 % set how each entry should appear:
 \renewcommand*{\glossaryentryfield}[5]{%
 \item % bullet point
 \glstarget{##1}{##2}% the entry name
 \space (##4)% the symbol in brackets
 \space ##3% the description
 \space [##5]% the number list in square brackets
 }%
 % set how sub-entries appear:
 \renewcommand*{\glossarysubentryfield}[6]{%
   \glossaryentryfield{##2}{##3}{##4}{##5}{##6}}%
 }
\end{verbatim}
Note that this style creates a flat glossary, where sub-entries
are displayed in exactly the same way as the top level entries.
\ifmakedtx{}{\toTop}

\subsubsection{Example: creating a new glossary style based on an
existing style}

\changes{1.11}{2008 March 1}{Fixed error in manual (glossary style
is set using 'glossarystyle not 'setglossarystyle)}%
If you want to define a new style that is a slightly modified
version of an existing style, you can use \cs{glossarystyle}
within the second argument of \cs{newglossarystyle} followed by
whatever alterations you require. For example, suppose you want 
a style like the \glostyle{list} style but you don't want the extra
vertical space created by \cs{indexspace} between groups, then you
can create a new glossary style called, say, \texttt{mylist} as
follows:
\begin{verbatim}
\newglossarystyle{mylist}{%
\glossarystyle{list}% base this style on the list style
\renewcommand{\glsgroupskip}{}% make nothing happen between groups
}
\end{verbatim} 
\ifmakedtx{}{\toTop}

\subsection{Accessibility Support}\label{sec:accsupp}
Limited accessibility support is provided by the accompanying
\isty{glossaries-accsupp} package, but note that this package is
experimental and it requires the \isty{accsupp} package 
which is also listed as experimental. The \gloskey{symbol} key
is used to specify the replacement text. For example:
\begin{verbatim}
\newglossaryentry{tex}{name={\TeX},description={Document preparation
language},symbol={TeX}}
\end{verbatim}
When you reference this entry using \ics{gls}, \ics{glspl} or
their uppercase variants, the symbol is used as the replacement
text. For example, \verb|\gls{tex}| would be equivalent to
\begin{verbatim}
\BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{}
\end{verbatim}
See \ifmakedtx{\autoref{sec:code:accsupp}}{the section 
\dq{glossaries-accsupp code} in
the document \texttt{glossaries.pdf} } for further details. It is
recommended that you also read the \isty{accsupp} documentation.
\ifmakedtx{}{\toTop}

\section{Mfirstuc Package}
\label{sec:mfirstuc}

The \sty{glossaries} bundle is supplied with the package 
\isty{mfirstuc} which provides the command:\\[10pt]
\DescribeMacro{\makefirstuc}
\cs{makefirstuc}\marg{stuff}\\[10pt]
which makes the first object of
\meta{stuff} uppercase unless \meta{stuff} starts with a control
sequence followed by a non-empty group, in which case the first
object in the group is converted to uppercase. Examples:
\begin{itemize}
\item \verb|\makefirstuc{abc}| produces Abc

\item \verb|\makefirstuc{\emph{abc}}| produces \emph{Abc} 
(\ics{MakeUppercase} has been applied to the letter \dq{a} rather
than \cs{emph}.) Note however that 
\verb|\makefirstuc{{\em abc}}| produces \emph{ABC} and 
\verb|{\makefirstuc{\em abc}}| produces abc.

\item \verb|\makefirstuc{{\'a}bc}| produces \MakeUppercase{\'a}bc

\item \verb|\makefirstuc{\ae bc}| produces \ifmakedtx{\MakeUppercase{\ae}bc}{\AE bc}

\item \verb|\makefirstuc{{\ae}bc}| produces \ifmakedtx{\MakeUppercase{\ae}bc}{\AE bc}

\item \verb|\makefirstuc{{ä}bc}| produces \ifmakedtx{\MakeUppercase{ä}bc}{\MakeUppercase{\"a}bc}

\end{itemize}
Note that non-Latin or accented characters appearing at the
start of the text must be placed in a group (even if you are
using the \isty{inputenc} package) due to expansion issues.

\begin{important}
In version 1.02 of \sty{mfirstuc}, a bug fix resulted in a change
in output if the first object is a control sequence followed by
an empty group. Prior to version 1.02, \verb|\makefirstuc{\ae{}bc}|
produced \ae Bc. However as from version 1.02, it now produces
\AE bc.
\end{important}

Note also that
\begin{verbatim}
\newcommand{\abc}{abc}
\makefirstuc{\abc}
\end{verbatim}
produces: ABC. This is because the first object in the argument of
\cs{makefirstuc} is \cs{abc}, so it does \verb|\MakeUppercase\abc|.
Whereas:
\begin{verbatim}
\newcommand{\abc}{abc}
\expandafter\makefirstuc\expandafter{\abc}
\end{verbatim}
produces: Abc. There is a short cut command which will do this:\\[10pt]
\DescribeMacro{\xmakefirstuc}
\cs{xmakefirstuc}\marg{stuff}\\[10pt]
This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuff}. So
\begin{verbatim}
\newcommand{\abc}{abc}
\xmakefirstuc{\abc}
\end{verbatim}
produces: Abc.

If you want to use an alternative command to convert to uppercase,
for example \cs{MakeTextUppercase},\footnote{defined in the 
\sty{textcase} package} you can redefine the internal
command \cs{@gls@makefirstuc}. For example:
\begin{verbatim}
\renewcommand{\@gls@makefirstuc}[1]{\MakeTextUppercase #1}
\end{verbatim}
(Remember that command names that contain the @ character must
either be placed in packages or be placed between \cs{makeatletter} 
and \cs{makeatother}.)

\ifmakedtx{}{\toTop}

 \StopEventually{\clearpage\phantomsection\addcontentsline{toc}{section}{Index}\PrintIndex}

\ifmakedtx{}{\printindex\toTop}

\end{document}
