From 7051fa90f609a783739882d5f945d4c11bf44c48 Mon Sep 17 00:00:00 2001
From: "Dr. Clea F. Rees" <cfrees@imapmail.org>
Date: Sun, 28 Dec 2008 23:49:33 +0000
Subject: glossaries update 2008/12/28

git-svn-id: svn://tug.org/texlive/trunk@11739 c570f23f-e606-0410-a88d-b1316a301751
---
 .../doc/latex/glossaries/glossaries-manual.tex     | 2275 +++++++++++++++++---
 1 file changed, 1938 insertions(+), 337 deletions(-)

(limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex')

diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
index 52a7a33f3c1..55746a63862 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-manual.tex
@@ -1,6 +1,8 @@
 \documentclass[a4paper]{ltxdoc}
 \usepackage{ifthen}
 \usepackage{alltt}
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
 \usepackage[colorlinks,
             bookmarks,
             hyperindex=false,
@@ -23,7 +25,7 @@
 \makeatother
 \RecordChanges
 \PageIndex
-\CheckSum{5329}
+\CheckSum{7758}
 \CodelineNumbered
 \newcommand*{\termdef}[1]{\emph{#1}\iterm{#1}}
 \newcommand*{\term}[1]{#1\iterm{#1}}
@@ -61,46 +63,54 @@
 
 \ifmakedtx{
 \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=\textsf{#2}|hyperpage}}{%
-\index{package options>#2=\textsf{#2}>#1=\textsf{#1}|hyperpage}}}
+\index{package options>#2=\pkgoptni{#2}|hyperpage}}{%
+\index{package options>#2=\pkgoptni{#2}>#1=\pkgoptni{#1}|hyperpage}}}
 \newcommand*{\pkgopt}[2][]{%
 \ifthenelse{\equal{#1}{}}{%
-\textsf{#2}\index{package options>#2=\textsf{#2}|hyperpage}}{%
-\textsf{#2=#1}\index{package options>#2=\textsf{#2}>#1=\textsf{#1}|hyperpage}}}
-\newcommand*{\pkgoptval}[2]{\textsf{#1}\index{package options>#2=\textsf{#2}>#1=\textsf{#1}|hyperpage}}
+\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{\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}{}}{%
-\texttt{#2}\index{package options!#2}}{%
-\texttt{#2=#1}\index{package options!#2!#1}}}
-\newcommand{\pkgoptval}[2]{\texttt{#1}\index{package options!#2!#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}}
 }
@@ -109,7 +119,7 @@
 \MakeShortVerb{"}
 \DeleteShortVerb{\|}
 
- \title{glossaries.sty v 1.16: \LaTeXe\ Package to Assist Generating Glossaries}
+ \title{glossaries.sty v 1.17: \LaTeXe\ Package to Assist Generating Glossaries}
  \author{Nicola L.C. Talbot\\[10pt]
 School of Computing Sciences\\
 University of East Anglia\\
@@ -117,7 +127,7 @@ Norwich. Norfolk\\
 NR4 7TJ. United Kingdom.\\
 \url{http://theoval.cmp.uea.ac.uk/~nlct/}}
 
- \date{27th August 2008}
+ \date{26th December 2008}
  \maketitle
 \tableofcontents
 
@@ -125,31 +135,412 @@ NR4 7TJ. United Kingdom.\\
 
  \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
+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
 where only those terms used in the text are added to the glossary.
-This package replaces the \isty{glossary} package which is now
-obsolete.
-
-This documentation is structured as follows: \ifmakedtx{\autoref{sec:quick}}{\htmlref{{A Quick Guide For The Impatient}}{sec:quick}} is for 
-people who want a few quick pointers of how to get started,
-without having to read through lengthy descriptions, 
-\ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview}{sec:overview}} gives an overview of available commands 
-and their syntax\ifmakedtx{, \autoref{sec:mfirstuc}}{ and 
-\htmlref{Mfirstuc}{sec:mfirstuc}} describes the associated
-\sty{mfirstuc} 
-package\ifmakedtx{, \autoref{sec:code} contains the documented 
-source code for those who want to know more about how the
-package works and \autoref{sec:code:mfirstuc} contains the documented
-code for the \sty{mfirstuc} package}{}.
+
+\textbf{This package replaces the \isty{glossary} package which is
+now obsolete. Please see the file 
+\ifmakedtx{\url{glossary2glossaries.pdf}}{%
+\url{glossary2glossaries.html}} for assistance in upgrading.} 
+
+\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 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}
+
+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. The documentation is
+therefore structured as follows:
+\begin{itemize}
+\item \ifmakedtx{\autoref{sec:quick}}{\htmlref{{A Quick Guide For
+The Impatient}}{sec:quick}} is for people who want a few quick
+pointers of how to get started creating a basic glossary, without
+having to read through lengthy descriptions.
+
+\item \ifmakedtx{\autoref{sec:overview}}{\htmlref{Overview}{sec:overview}} 
+gives an overview of available 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.
+
+\item \autoref{sec:code:mfirstuc} contains the documented code for 
+the \sty{mfirstuc} package.}{} 
+\end{itemize}
+
+\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.
+
+The sample documents are as follows:
+\begin{description}
+\item[minimalgls.tex] 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.
+
+  \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] 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] 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] 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] 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] This document illustrates how to load 
+an 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 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 using \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] 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] 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] 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] 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 using \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] 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] 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] 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] 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 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œ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}
+
+\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 non-Latin 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 
@@ -166,6 +557,14 @@ text is not translated, you may need to explicitly load the
 \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 
@@ -177,10 +576,12 @@ to provide the translations. For example:
 \usepackage{glossaries}
 \end{verbatim}
 
-The following languages are currently supported:
+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\\
@@ -207,15 +608,15 @@ glossaries package are listed in \tableref{tab:predefinednames}.
 \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 glossary (for 2, 3 or 4 column 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 glossary (for 2, 3 or 4 column 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 glossary for glossary styles that support this option.\\
+column in the glossary for glossary styles that support this option.\\
 \ics{pagelistname} & \texttt{Page List (glossaries)} & 
-Header for page list column in glossary for glossaries that support 
+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 
@@ -243,55 +644,281 @@ in your document preamble:
 \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} on
-all the glossary files using a customized \appname{makeindex}
-\filetype{.ist} style file (which is created by \ics{makeglossaries}). 
-The relevant extensions are obtained from the
-auxiliary file, so you should only pass the basename as the
-argument. For example, if your document is called 
-\texttt{myfile.tex}, do:
+\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 
+Table~\ref{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}
-latex myfile
-makeglossaries myfile
-latex myfile
+\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 whether the indexing style file ends with
+\filetype{.xdy} or \filetype{.ist}. 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 myfile
+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 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 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. 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}
 
-If you don't have Perl installed, you will have to run 
-\appname{makeindex} for each glossary type you have defined.
-For example, if you have used the \pkgopt{acronym} package option
-then you will have both a main glossary as well as a list of acronyms, so you
-will need to do (assuming your document is called \texttt{myfile.tex}):
+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}
-makeindex -s myfile.ist -t myfile.glg -o myfile.gls myfile.glo
-makeindex -s myfile.ist -t myfile.alg -o myfile.acr myfile.acn
+xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn
 \end{verbatim}
-This requires remembering all extensions for each of the glossaries
-defined in your document, so where possible you should use
-\appname{makeglossaries} instead to reduce the possibility of error.
-Don't pass all the glossary files in a single call to 
-\appname{makeindex} or it will merge all your glossaries into a
-single glossary.
+For additional glossaries, the extensions are those supplied
+when you created the glossary with \ics{newglossary}.
 
-If any problems occur, remember to check the transcript files 
-(e.g.\ \filetype{.glg} or \filetype{.alg}) for messages.\ifmakedtx{}{\toTop}
+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 
+Table~\ref{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 
+Table~\ref{tab:makeglossariesCmds}.
+\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 \texttt{texmf/doc/latex/glossaries/samples/}. 
+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/}.
 
@@ -337,8 +964,11 @@ but use the surrounding font for subsequent use, you can do:
 \item I don't have Perl installed, do I have to use 
 \appname{makeglossaries}?
 
-Read \ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{the previous
-section}{sec:makeglossaries}}.
+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 I'm used to using the \sty{glossary} package: are there any
@@ -354,9 +984,10 @@ same location as this document.
 translated.
 
 The \sty{glossaries} package currently only supports the following
-languages: 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.
+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
@@ -367,9 +998,9 @@ package). For example:
 \usepackage[ngerman]{translator}
 \usepackage{glossaries}
 \end{verbatim}
-Alternatively, you may be able to add the language as a global option
-to the class file. Check the \sty{translator} package documentation for
-further details.
+Alternatively, you can add the language as a global option
+to the class file. Check the \sty{translator} package documentation 
+for further details.
 
 \item My glossaries haven't appeared.
 
@@ -380,15 +1011,26 @@ Remember to do the following:
 \item Use either \ics{printglossary} for each glossary that has
 been defined or \ics{printglossaries}.
 
-\item Use \ics{gls}, \ics{Gls}, \ics{GLS}, \ics{glspl}, \ics{Glspl},
-\ics{GLSpl}, \ics{glslink}, \ics{glsadd} or \ics{glsaddall} in the
-document.
+\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:glssee}}{\htmlref{Cross-Referencing 
+Entries}{sec:glssee}} 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.
+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
+run \appname{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.
 \end{enumerate}
 \ifmakedtx{}{\toTop}
 
@@ -398,7 +1040,11 @@ run.
 This section is for people who want a few quick pointers
 of how to get started. However it is recommended that you read 
 \ifmakedtx{\autoref{sec:overview}}{\htmlref{the overview section}{sec:overview}} 
-for additional commands and advice not listed here.
+for additional commands and advice not listed here. There are
+also some sample files to help you get started, listed in
+\ifmakedtx{\autoref{sec:samples}}{\htmlref{Sample 
+Documents}{sec:samples}}.
+
 
 \begin{enumerate}
 \item Load \sty{glossaries} \emph{after} \isty{hyperref}:
@@ -415,7 +1061,6 @@ Similarly for the \isty{html} package:
 \item Always use \ics{makeglossaries} if you want the glossary
 entries to be written to the glossary file:
 \begin{verbatim}
-\documentclass{article}
 \usepackage{glossaries}
 \makeglossaries
 \end{verbatim}
@@ -440,35 +1085,54 @@ latex myfile
 makeglossaries myfile
 latex myfile
 \end{verbatim}
-(You may need to run \LaTeX\ again if you have used the \pkgopt{toc}
-package option.)
+(You need to run \LaTeX\ again if you have used the \pkgopt{toc}
+package option. You may also need an extra \appname{makeglossaries} 
+run and another \LaTeX\ run if an entry is only referenced in the
+glossary, or if including the glossary has caused the 
+number lists\iterm{number list} to change.)
+
 If you use Windows, there is a batch file called 
 \texttt{makeglossaries.bat} which you can use, but you will
-still need Perl installed.
+still need Perl installed. Alternatively, you can call
+\appname{makeindex} directly. See
+\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the 
+Associated Glossary Files}{sec:makeglossaries}} for 
+further details.
+
+\item If you want to use \appname{xindy} instead of
+\appname{makeindex}, you must specify it in the package option:
+\begin{verbatim}
+\usepackage[xindy]{glossaries}
+\end{verbatim}
+See
+\ifmakedtx{\autoref{sec:makeglossaries}}{\htmlref{Generating the 
+Associated Glossary Files}{sec:makeglossaries}} for 
+further details.
 
 \item New glossaries can be defined using:\par
 \ics{newglossary}\oarg{log-ext}%
 \marg{label}\marg{in-ext}\marg{out-ext}%
 \marg{title}\par where \meta{label} is an identifying label,
 \meta{in-ext} is the extension of the file to be created
-by \appname{makeindex} (called by \appname{makeglossaries}),
+by \appname{makeindex} or \appname{xindy} (called by 
+\appname{makeglossaries}),
 \meta{out-ext} is the extension of the file to be read by
-\appname{makeindex} and \meta{title} is the title for this
+\appname{makeindex} or \appname{xindy} and \meta{title} is the title for this
 new glossary. The first optional argument \meta{log-ext} specifies
-the extension of the \appname{makeindex} transcript file. Example:
+the extension of the \appname{makeindex} or \appname{xindy} 
+transcript file. Example:
 \begin{verbatim}
 \newglossary[nlg]{notation}{not}{ntn}{Notation}
 \end{verbatim}
 This glossary's label is \texttt{notation} and its title
 will be Notation. If you use \appname{makeglossaries}, the 
-\appname{makeindex} transcript will be written to a file with the
+\appname{makeindex} or \appname{xindy} transcript will be written to a file with the
 extension \filetype{.nlg}. If \meta{log-ext} is omitted, the extension
 \filetype{.glg} will be used.
 
 \item Any new glossaries must be defined before 
-\cs{makeglossaries}
+\ics{makeglossaries}:
 \begin{verbatim}
-\documentclass{article}
 \usepackage{glossaries}
 \newglossary{notation}{not}{ntn}{Notation}
 \makeglossaries
@@ -483,12 +1147,12 @@ will automatically create a new glossary type labelled
 \end{verbatim}
 
 \item If your pages have a hyphen compositor (i.e.\ your page
-numbers appear in the form 2-1), redefine \ics{glscompositor}
+numbers appear in the form 2-1), use \ics{glsSetCompositor}
 \emph{before} \ics{makeglossaries}:
 \begin{verbatim}
 \documentclass{article}
 \usepackage{glossaries}
-\renewcommand{\glscompositor}{-}
+\glsSetCompositor{-}
 \makeglossaries
 \end{verbatim}
 
@@ -497,6 +1161,10 @@ numbers appear in the form 2-1), redefine \ics{glscompositor}
 \begin{verbatim}
 \usepackage[toc]{glossaries}
 \end{verbatim}
+This will require an extra \LaTeX\ run. Note that if the table
+of contents affects the subsequent page numbering (i.e.\ the
+page numbers are not reset after the table of contents) then you
+may need to rerun \appname{makeglossaries} and \LaTeX.
 
 \item Define a new entry with:\par
 \ics{newglossaryentry}\marg{label}\marg{key-val list}\par
@@ -511,20 +1179,96 @@ In this example, I have given the entry the label \texttt{perl}.
 Whenever I want to use this entry, that is the label I need
 to use to identify it.
 
-\item If the entry name starts with an accented letter, you will
-need to group the first letter (otherwise it will cause a
-problem for \ics{Gls} and \ics{Glspl}):
+\item To define a sub-entry, use the \gloskey{parent} key. For
+example:
+\begin{verbatim}
+\newglossaryentry{fruit}{name={fruit}, % parent entry
+description={tree product that contains seeds}}
+
+\newglossaryentry{apple}{name={apple}, % sub-entry
+description={firm, round fruit},
+parent=fruit}
+\end{verbatim}
+
+\item To change the sorting order, use the \gloskey{sort} key.
+For example:
+\begin{verbatim}
+\newglossaryentry{tex}{name={\TeX},
+description={A typesetting language},
+sort=tex}
+\end{verbatim}
+This will put the entry in the \dq{T} group (entries starting with
+the letter \dq{t} or \dq{T}) rather than the
+\dq{symbols} group (entries starting with a symbol).
+Similarly, the following example puts the entry in the \dq{U}
+group instead of the \dq{symbol} group.
+\begin{verbatim}
+\newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}},
+description=The universal set,
+sort=U}
+\end{verbatim}
+
+Note that if you use \appname{xindy} instead of \appname{makeindex},
+characters such as a backslash are ignored, so if you have used
+the \pkgopt{xindy} package option, you can just do:
+\begin{verbatim}
+\newglossaryentry{tex}{name={\TeX},
+description={A typesetting language},
+}
+\end{verbatim}
+
+\item Sub-entries may have the same name as the parent entry:
+\begin{verbatim}
+\newglossaryentry{glossary}{name=glossary, % parent entry
+description={\nopostdesc},
+plural={glossaries}}
+
+\newglossaryentry{glossarylist}{% first child entry 
+description={1) list of technical words},
+sort={1},
+parent={glossary}}
+
+\newglossaryentry{glossarycol}{% second child entry
+description={2) collection of glosses},
+sort={2},
+parent={glossary}}
+\end{verbatim}
+Note that in this instance the \gloskey{name} key is not 
+required for the child entries, but the \gloskey{sort} key is
+needed to sort the sub-entries. The parent entry has no 
+description, so the description terminator is suppressed using
+\ics{nopostdesc}.
+
+\item If the entry name starts with an accented letter or 
+non-Latin character, you will need to group the first letter 
+(otherwise it will cause a problem for commands like \ics{Gls} and 
+\ics{Glspl}):
 \begin{verbatim}
 \newglossaryentry{elite}{name={{\'e}lite},
+sort=elite,
 description={select group or class}}
 \end{verbatim}
 Likewise with commands such as \cs{ae} and \cs{oe}:
 \begin{verbatim}
 \newglossaryentry{oesophagus}{%
 name={{\oe}sophagus},
+sort=oesophagus,
 description={canal from mouth to stomach}}
 \end{verbatim}
 
+\item If you use \appname{xindy}, you can specify the accented
+or non-Latin character directly (in combination with the 
+\isty{inputenc} and \isty{fontenc} packages) but you still 
+need to group the first letter (otherwise it will cause a
+problem for commands like \ics{Gls} and \ics{Glspl} due to
+expansion issues):
+\begin{verbatim}
+\newglossaryentry{elite}{name={{é}lite},
+description={select group or class}}
+\end{verbatim}
+Note that in this case the \gloskey{sort} key is not required
+as \appname{xindy} knows how to sort the letter \'e.
+
 \item If you have multiple glossaries, use the \gloskey{type}
 key to specify in which glossary the entry belongs. For example:
 \begin{verbatim}
@@ -546,6 +1290,27 @@ description={A list of individual pages or page ranges
 (e.g.\ 1,2,4,7--9)}}
 \end{verbatim}
 
+\item You can cross-reference an entry using the 
+\gloskey{see} key when you define it. For example, suppose
+you have defined an entry whose label is \texttt{taylorstheorem},
+then you can cross-reference it:
+\begin{verbatim}
+\newglossaryentry{maclaurinseries}{name={Maclaurin series},
+description={Series expansion},
+see={taylorstheorem}}
+\end{verbatim}
+Alternatively, you can use \ics{glssee} after you have defined
+the entry:
+\begin{verbatim}
+\glssee{maclaurinseries}{taylorstheorem}
+\end{verbatim}
+(The final argument may be a comma-separated list of labels.)
+The \dq{see} tag may be overridden for a given entry:
+\begin{verbatim}
+\glssee[see also]{maclaurinseries}{taylorstheorem}
+\end{verbatim}
+or it can be changed for all entries by redefining \ics{seename}.
+
 \item Plural forms are assumed to be the singular form with an
 \dq{s} appended, unless otherwise specified. To specify an
 irregular plural, use the \gloskey{plural} key. For example:
@@ -610,11 +1375,11 @@ in a medium sans-serif font do:
 \begin{verbatim}
 \renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}}
 \end{verbatim}
-Note that the list-like glossary styles defined in the
-\isty{glossary-list} package place the entry name in
+Note that the list-like glossary styles place the entry name in
 the optional argument to \ics{item}, so they will
-appear in bold, unless you redefine \ics{glsnamefont} to counteract the
-bold font.
+appear in bold, unless you redefine \ics{glsnamefont} to counteract 
+the bold font. Similarly, the tree-like styles display the
+entry name in bold.
 
 \item In the document use \ics{gls}\marg{label}
 to use a predefined term (this will also enter the term into 
@@ -671,9 +1436,10 @@ form \cs{text}\meta{xx}, as well as \ics{hyperemph}
 The primary definition of \glspl[format=hyperbf]{singmtx}.
 \end{verbatim}
 
-\item Don't use declarations in \gloskey[glslink]{format} as this can
-cause unpredictable results, as there is no guarantee that the effect
-will be localised to the required text.
+\item Don't use declarations in \gloskey[glslink]{format} (e.g.\
+\texttt{format=bfseries}) as this can cause unpredictable results,
+since there is no guarantee that the effect will be localised to the
+required text.
 
 \item Entries can be added to the glossary without producing
 any text using \ics{glsadd}\marg{label} or
@@ -688,7 +1454,7 @@ any text where the command occurs.
 
 \item A number range can be entered using \verb|format=(| and
 \verb"format=)" to mark the beginning and ending of the
-range\footnote{This is new to version 1.01}. For example:
+range. For example:
 \begin{verbatim}
  \glsadd[format=(]{singmtx}
  This is a very long section all about \glspl{singmtx}.
@@ -698,7 +1464,8 @@ range\footnote{This is new to version 1.01}. For example:
  \glsadd[format=)]{singmtx}
 \end{verbatim}
 This is equivalent to \appname{makeindex}'s \verb"|(" and \verb"|)" 
-formats.
+formats or \appname{xindy}'s \texttt{:open-range} and 
+\texttt{:close-range} tags.
 
 \item You can combine the range markers with a formatting command
 (again without the preceding backslash). For example:
@@ -716,26 +1483,8 @@ formats.
 document will be placed in the glossary. If you have defined
 a term that doesn't appear in the document, then it means
 you haven't used it in the text (either via \ics{glslink}
-or \ics{gls} and related commands, or via \ics{glsadd}
-or \ics{glsaddall}).
-
-\item To change the sorting order, use the \gloskey{sort} key.
-For example:
-\begin{verbatim}
-\newglossaryentry{tex}{name={\TeX},
-description={A typesetting language},
-sort=tex}
-\end{verbatim}
-This will put the entry in the \dq{T} group (entries starting with
-the letter \dq{t} or \dq{T}) rather than the
-\dq{symbols} group (entries starting with a symbol).
-Similarly, the following example puts the entry in the \dq{U}
-group instead of the \dq{symbol} group.
-\begin{verbatim}
-\newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}},
-description=The universal set,
-sort=U}
-\end{verbatim}
+or \ics{gls} and related commands or via \ics{glsadd}
+or \ics{glsaddall} or via \ics{glssee}).
 
 \item You don't need to escape \appname{makeindex}'s special characters:
 \begin{verbatim}
@@ -756,17 +1505,9 @@ For example:
 description={A metric measurement of length},
 symbol={m}}
 \end{verbatim}
-The predefined glossary styles that display the entry symbol
-are: \glostyle{long4col}, \glostyle{long4colheader},
-\glostyle{long4colborder}, \glostyle{long4colheaderborder},
- \glostyle{altlong4col}, \glostyle{altlong4colheader},
-\glostyle{altlong4colborder}, \glostyle{altlong4colheaderborder},
-\glostyle{super4col}, \glostyle{super4colheader}, 
-\glostyle{super4colborder}, \glostyle{super4colheaderborder}.
-\glostyle{altsuper4col}, \glostyle{altsuper4colheader}, 
-\glostyle{altsuper4colborder} and \glostyle{altsuper4colheaderborder}.
-All the other styles supplied by this package ignore the associated 
-symbol.
+See \ifmakedtx{\autoref{sec:styles}}{\htmlref{Glossary 
+Styles}{sec:styles}} for a list of predefined glossary 
+styles.
 
 \item Glossary styles can be set using the \pkgopt{style} 
 package option. For example:
@@ -778,7 +1519,9 @@ or using \ics{glossarystyle}\marg{style}. For example:
 \glossarystyle{altlist}
 \end{verbatim}
 The predefined glossary styles provided by the \sty{glossaries}
-bundle are listed in \ifmakedtx{\autoref{sec:styles}}{\htmlref{{Glossary Styles}}{sec:styles}}.
+bundle are listed in \ifmakedtx{\autoref{sec:styles}}{\htmlref{{Glossary 
+Styles}}{sec:styles}}.
+
 
 \item The list of numbers associated with each glossary entry
 can be suppressed using the package option \pkgopt{nonumberlist}:
@@ -786,7 +1529,7 @@ can be suppressed using the package option \pkgopt{nonumberlist}:
 \usepackage[nonumberlist]{glossaries}
 \end{verbatim}
 
-\item By default, the glossaries will appear in an unnumbered 
+\item By default, the glossary will appear in an unnumbered 
 chapter if chapters are defined, otherwise in an unnumbered
 section. This can be changed using the \pkgopt{section} package
 option. For example, to make the glossaries appear in an unnumbered
@@ -812,6 +1555,7 @@ appear in unnumbered subsections:
 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 
@@ -821,13 +1565,25 @@ 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}] Make a separate glossary for acronyms.
+\item[\pkgopt{acronym}] This creates a new glossary with the
+label \texttt{acronym}:
+\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}.
 
 \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
-exists, otherwise in a section. Unnumbered sectional units will be used
+exist, otherwise in a section. Unnumbered sectional units will be used
 by default. Example:
 \begin{verbatim}
 \usepackage[section=subsection]{glossaries}
@@ -840,8 +1596,9 @@ is equivalent to
 \begin{verbatim}
 \usepackage[section=section]{glossaries}
 \end{verbatim}
-You can change this value later in the document using
-\ics{setglossarysection}\marg{type}.
+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.
 
 \item[\pkgopt{numberedsection}]
 The glossaries are placed in unnumbered sectional units by default,
@@ -960,6 +1717,42 @@ 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 key=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}.
+
 \end{description}\ifmakedtx{}{\toTop}
 
 \subsection{Defining Glossary Entries}
@@ -973,29 +1766,79 @@ was removed in version 1.13, but the restriction remains for
 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}} and 
 \ifmakedtx{\autoref{sec:glsadd}}{\htmlref{Adding an entry to the glossary without generating text}{sec:glsadd}}) will appear in the glossary. Each time an entry 
-is used in this way, a line is added to an associated glossary
-(\filetype{.glo}) file, 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}, using a customised
-\filetype{.ist} 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.
+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}
+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 file. If you omit \cs{makeglossaries} none of the
-glossaries will be created. Note that if your page numbers use a 
-hyphen compositor, you must set this by redefining 
-\DescribeMacro{\glscompositor}\cs{glscompositor} \emph{before}
-using \cs{makeglossaries}:
+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}
-\renewcommand*{\glscompositor}{-}
+\glsSetCompositor{.}
+\glsSetAlphaCompositor{-}
 \end{verbatim}
-(The default value of \cs{glscompositor} is a full stop.)
+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]
@@ -1004,14 +1847,29 @@ 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}. Available fields are listed below:
+\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).
+\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).
+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.
+
+\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}
@@ -1046,8 +1904,9 @@ or by appending \ics{glspluralsuffix} to the value of the
 used the \gloskey{first} key.
 
 \item[{\gloskey{symbol}}] This field is provided to allow the user to
-specify an associated symbol, but most glossary styles ignore
-this value. If omitted, the value is set to \cs{relax}.
+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}
@@ -1055,42 +1914,65 @@ 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}
-should sort this entry. If omitted, the value is given by the
-\gloskey{name} field.  This value is equivalent to
-\appname{makeindex}'s \dq{actual} character (which is usually the
-at-sign @ although the \sty{glossaries} package uses a different
-symbol).
-
-\item[{\gloskey{type}}] This is the glossary type to which this entry
-belongs. If omitted, the default glossary is assumed.
-The list of acronyms type is given by
+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 key starts with an accented letter,
-you must group the accented letter, otherwise it will cause a
-problem for commands like \cs{Gls} and \cs{Glspl}. For example:
+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 
-\DescribeMacro{\glspluralsuffix}by appending \cs{glspluralsuffix} to 
-the singular form. This command defaults to \texttt{s}. For example:
+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 \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:
+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}}
@@ -1121,6 +2003,115 @@ 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},
+text={Greek letter},
+description={\nopostdesc}}
+
+\newglossaryentry{romanletter}{name={Roman letters},
+text={Roman letter},
+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}
 
@@ -1173,7 +2164,9 @@ then (supposing I have defined a new glossary type called
 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. In this instance,
+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}
@@ -1200,7 +2193,54 @@ 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.\ifmakedtx{}{\toTop}
+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
+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}
@@ -1212,10 +2252,20 @@ 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} to generate the relevant entry in the
-glossary. It is strongly recommended that you don't use the commands
+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. This is particularly important if you are using the
+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
@@ -1238,97 +2288,103 @@ font, do:
 \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. The optional argument
-\meta{options} must be a \meta{key}=\meta{value} list which can take
-any of the following keys:
+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. 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 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
-number).  Be careful not to use a declaration (such as \cs{bfseries})
-instead of a text block command (such as \cs{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.\ 
+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 Table~\ref{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}. For example
+\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
-hyperlink, don't use \cs{hyperpage} (provided by the \isty{hyperref}
-package) as the numbers may not refer to a page number.
-Instead, the \sty{glossaries} package provides the following 
-number formats:
-\begin{center}
-\ifmakedtx{\begin{tabular}{@{\sffamily}lp{0.8\linewidth}}
-hyperrm & The number is a serif hyperlink to the relevant part of the 
-document\\
-hypersf & The number is a sans-serif hyperlink to the relevant part 
-of the document\\
-hypertt & The number is a monospaced hyperlink to the relevant part 
-of the document\\
-hyperbf & The number is a bold hyperlink to the relevant part of the 
-document\\
-hypermd & The number is a medium weight hyperlink to the relevant 
-part of the document\\
-hyperit & The number is an italic hyperlink to the relevant 
-part of the document\\
-hypersl & The number is a slanted hyperlink to the relevant 
-part of the document\\
-hyperup & The number is an upright hyperlink to the relevant 
-part of the document\\
-hypersc & The number is a small caps hyperlink to the relevant 
-part of the document\\
-hyperemph & The number is an emphasized hyperlink to the relevant 
-part of the document
-\end{tabular}}{\begin{tabular}{ll}
-\texttt{hyperrm} & The number is a serif hyperlink to the relevant part of the 
-document\\
-\texttt{hypersf} & The number is a sans-serif hyperlink to the relevant part 
-of the document\\
-\texttt{hypertt} & The number is a monospaced hyperlink to the relevant part 
-of the document\\
-\texttt{hyperbf} & The number is a bold hyperlink to the relevant part of the 
-document\\
-\texttt{hypermd} & The number is a medium weight hyperlink to the relevant 
-part of the document\\
-\texttt{hyperit} & The number is an italic hyperlink to the relevant 
-part of the document\\
-\texttt{hypersl} & The number is a slanted hyperlink to the relevant 
-part of the document\\
-\texttt{hyperup} & The number is an upright hyperlink to the relevant 
-part of the document\\
-\texttt{hypersc} & The number is a small caps hyperlink to the relevant 
-part of the document\\
-\texttt{hyperemph} & The number is an emphasized hyperlink to the relevant 
-part of the document
-\end{tabular}}
-\end{center}
-Note that if the \cs{hyperlink} command hasn't been defined,
+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 Table~\ref{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 \cs{text}\meta{xx} font commands. If you want to
+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 associated 
-number in the glossary to be in a bold sans-serif font, you can define a
+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:printglos}.)}{}
+key.\ifmakedtx{  (See also \autoref{sec: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 the associated number for this glossary entry. (See also
+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
@@ -1524,7 +2580,9 @@ 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. Note that \ics{glslink} (which
+The remaining arguments are ignored.
+
+Note that \ics{glslink} (which
 is used by commands like \cs{gls} and \cs{glspl}) sets 
 \DescribeMacro{\glslabel}\ics{glslabel} to the label for the given
 entry (i.e.\ the label supplied to the mandatory argument to
@@ -1564,7 +2622,7 @@ 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 commands \cs{gls}, \cs{glspl} and their
+glossaries appear when using the commands \cs{gls}, \cs{glspl} and their
 uppercase variants.  If you only
 want the change to affect entries for a given glossary, then you need
 to use \DescribeMacro{\defglsdisplay}\cs{defglsdisplay} and
@@ -1656,6 +2714,76 @@ do:
 \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}
 
@@ -1663,7 +2791,8 @@ 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 flag that determines if the term has been
-used and they don't produce hyperlinks.
+used 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
@@ -1716,10 +2845,25 @@ These commands display the symbol for the glossary entry given by
 \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 \texttt{glossaries.pdf}}.
+the glossary} in the document \url{glossaries.pdf}}.
 \ifmakedtx{}{\toTop}
 
 \subsection{Displaying a glossary}
@@ -1729,12 +2873,14 @@ 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} (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} 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.
+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]
@@ -1776,7 +2922,8 @@ assumed.
 \end{description}
 
 \DescribeMacro{\glossarypreamble}
-Information can be added to the start of the glossary by redefining
+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
@@ -1814,13 +2961,17 @@ glossary.\ifmakedtx{}{\toTop}
 \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 styles the name will appear in bold, since the name is placed in
-the optional argument of \cs{item}, whereas in the tabular styles the
-name will appear in the normal font.
+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:
@@ -1829,6 +2980,259 @@ medium weight small caps, then you can do:
 \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 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}\\[10pt]
+where each location name is delimited by double quote marks.
+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}
 
 \DescribeMacro{\newglossary}
@@ -1841,9 +3245,9 @@ 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} transcript file (this information is only used by
-\appname{makeglossaries} which picks up the information from the
-auxiliary file).
+\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}
@@ -1874,7 +3278,7 @@ 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=\cs{acronymtype},\\
+\cs{newglossaryentry}\textrm{\marg{label}}\{type=\ics{acronymtype},\\
 name=\textrm{\marg{abbrv}},\\
 description=\textrm{\marg{long}},\\
 text=\textrm{\marg{abbrv}},\\
@@ -1885,18 +3289,20 @@ firstplural=\{\textrm{\meta{long}}\cs{glspluralsuffix}\cs{space}
 \textrm{\meta{key-val list}}\}\par
 \end{ttfamily}
 \vskip5pt
-As mentioned in the previous section, the command \cs{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.
+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|. See \ifmakedtx{\autoref{sec:loadglsentries}}{\htmlref{earlier}{sec:loadglsentries} for details}.
+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:
@@ -1920,12 +3326,12 @@ 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}, \pkgopt{footnote} and
-\pkgopt{shortcuts}, 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
+\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 new commands described in this section,
+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
 \cs{newacronym}.
 
@@ -2058,6 +3464,12 @@ 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 
@@ -2073,7 +3485,16 @@ entry in the form:\\[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.
+\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 first use as:\\[10pt]
@@ -2085,25 +3506,74 @@ 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 first use 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}
+\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 first use, 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 first use 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 first use 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 \url{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 first use 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}|, so \meta{abbrv}
-should be specified in lower case.
+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 
@@ -2117,9 +3587,13 @@ have been set, this option displays the entry on first use as:\\[10pt]
 while subsequent use displays the entry as:\\[10pt]
 \cs{acronymfont}\marg{abbrv}\meta{insert}\\[10pt]
 where \cs{acronymfont} is set to \verb|{\smaller #1}|.
+The entries will be sorted according to the short form.
 
+\begin{important}
 Remember to load a package that defines \ics{smaller} (such as
-\isty{relsize}) if you want to use this option.
+\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 
@@ -2132,7 +3606,8 @@ If none of the package options \pkgopt{smallcaps}, \pkgopt{smaller},
 then on first use 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}
+\meta{abbrv}\meta{insert}\\[10pt]
+Entries will be sorted according to the short form.
 \end{description}
 
 Recall from \ifmakedtx{\autoref{sec:glslink}}{\htmlref{earlier}{sec:glslink}} 
@@ -2179,7 +3654,7 @@ relevant entry in the glossary.
 
 Note that if you change the definition of \ics{newacronym}, you
 may additionally need to change the above commands as well as
-the changing way the text is displayed using \ics{defglsdisplay}
+changing the way the text is displayed using \ics{defglsdisplay}
 and \ics{defglsdisplayfirst}.
 
 The package option \pkgopt{shortcuts} provides the synonyms listed
@@ -2190,7 +3665,7 @@ 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 \pkgopt{shortcuts}}
+\caption[Synonyms provided by the package option shortcuts]{Synonyms provided by the package option \pkgopt{shortcuts}}
 \label{tab:shortcuts}
 \begin{center}
 \begin{tabular}{ll}
@@ -2242,23 +3717,33 @@ entry has been used, \meta{true part} will be done, otherwise
 \subsection{Glossary Styles}
 \label{sec:styles}
 The \sty{glossaries} package comes with some pre-defined
-glossary styles. These are as follows:
+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.
+The predefined styles are as follows:
+
 \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 number
-list for that entry. Sub groups are separated using \cs{indexspace}.
+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 set of links to the glossary 
-groups. The start of the glossary has a navigation panel 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 panel, each group is separated
+\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:
@@ -2266,21 +3751,24 @@ to simply have a space separating each group, do:
 \renewcommand*{\glshypernavsep}{\space}
 \end{verbatim}
 
-Note that the hyper-navigation panel is now (as from version 1.14) 
+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 is placed on the following line.
+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 panel is the same as that for 
+groups. The navigation line is the same as that for 
 \glostyle{listhypergroup}, described above.
 
 \item[listdotted] This style uses the \envname{description}
@@ -2289,16 +3777,19 @@ 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.\footnote{This style was
-supplied by Axel~Menzel.}
+supplied by Axel~Menzel.} This is a flat style, so child
+entries are formatted in the same way as the parent entries.
 
 \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}.
+\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.
@@ -2313,10 +3804,11 @@ 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 width of the
-first column is governed by the widest entry in that column. The
+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
+\ics{glsdescwidth}, and the width of the third column is governed by the
 length \ics{glspagelistwidth}.
 
 \item[long3colborder] The \glostyle{long3colborder} style is like
@@ -2334,8 +3826,8 @@ around it.
 \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 long
-descriptions.
+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
@@ -2348,12 +3840,12 @@ lines around it.
 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 width of the name 
-and symbol columns is governed by the widest entry in the 
+\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
@@ -2372,10 +3864,12 @@ descriptions and page lists.
 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}.
+\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.
@@ -2390,7 +3884,8 @@ 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 \iterm{number list}. The width of the
+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
@@ -2412,7 +3907,7 @@ lines around it.
 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 longer descriptions.
+for multi-line descriptions.
 
 \item[super4colborder] The \glostyle{super4colborder} style is like
 the \glostyle{super4col} style but has horizontal and vertical
@@ -2446,6 +3941,76 @@ page lists.
 style is like \glostyle{super4colheaderborder} but allows multi-line
 descriptions and page lists.
 
+\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 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 (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}
 
 The glossary style can be set using the \pkgopt{style} package option
@@ -2462,6 +4027,9 @@ width of the page list column. These will need to be changed using
 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.
+Note that if you want to explicitly create a line-break within
+a multi-line description 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 
@@ -2483,7 +4051,11 @@ 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}.
+\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
@@ -2492,9 +4064,13 @@ All the styles except for the three- and four-column styles and 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.\ifmakedtx{}{\toTop}
+displayed. Alternatively, you can suppress it for a given entry
+by placing \ics{nopostdesc} in the entry's 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]
@@ -2533,7 +4109,8 @@ within the main body of the glossary. The glossary is sub-divided into
 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. Note that the argument to \cs{glsgroupheading}
+numbers, A, \ldots, Z\@. (This may be different if you use
+\appname{xindy}.) Note that the argument to \cs{glsgroupheading}
 is a label \emph{not} the group title. The group title can be obtained
 via \cs{glsgetgrouptitle}\marg{label}, and a navigation hypertarget can
 be created using \cs{glsnavhypertarget}\marg{label}. Most of the
@@ -2545,14 +4122,16 @@ ignore its argument.  The \glostyle{listhypergroup} style redefines
 \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
 \end{verbatim}
 See also \cs{glsgroupskip} below. (Note that command definitions within 
-\cs{newglossarystyle} must use \verb|##1| etc instead of \verb|#1| etc.)
+\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}.
+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}
@@ -2599,6 +4178,17 @@ 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}\ifmakedtx{}{\toTop}
 
 \subsubsection{Example: creating a completely new style}
@@ -2638,8 +4228,13 @@ at the end. Then you can create this new glossary style, called, say,
  \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
@@ -2666,7 +4261,7 @@ follows:
 \section{Mfirstuc Package}
 \label{sec:mfirstuc}
 
-The \sty{glossaries} package is supplied with the package 
+The \sty{glossaries} bundle is supplied with the package 
 \isty{mfirstuc} which provides the command:\\[10pt]
 \DescribeMacro{\makefirstuc}
 \cs{makefirstuc}\marg{stuff}\\[10pt]
@@ -2681,12 +4276,18 @@ object in the group is converted to uppercase. Examples:
 (\ics{MakeUppercase} has been applied to the letter \dq{a} rather
 than \cs{emph}.)
 
-\item \verb|\makefirstuc{{\'a}bc}| produces {\'A}bc
+\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{\ae bc}| produces \AE bc
+\item \verb|\makefirstuc{{ä}bc}| produces \ifmakedtx{\MakeUppercase{ä}bc}{\MakeUppercase{\"a}bc}
 
-\item \verb|\makefirstuc{{\ae}bc}| produces {\AE}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
@@ -2702,7 +4303,7 @@ Note also that
 \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}|.
+\cs{makefirstuc} is \cs{abc}, so it does \verb|\MakeUppercase\abc|.
 Whereas:
 \begin{verbatim}
 \newcommand{\abc}{abc}
@@ -2719,8 +4320,8 @@ This is equivalent to \cs{expandafter}\cs{makefirstuc}\cs{expandafter}\marg{stuf
 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
+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}
-- 
cgit v1.2.3

