summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex296
1 files changed, 249 insertions, 47 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 18d96dbad06..54223c8dc9a 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -388,11 +388,11 @@ and~\hyperlink{option#2}{#2}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v4.21}
+ \title{User Manual for glossaries.sty v4.22}
\author{Nicola L.C. Talbot\\%
\url{http://www.dickimaw-books.com/}}
- \date{2016-01-24}
+ \date{2016-04-19}
\maketitle
\begin{abstract}
@@ -467,16 +467,10 @@ glossaries package}{glossary2glossaries}.
This document is the main user guide for the \styfmt{glossaries}
package.
-\item[\url{mfirstuc-manual.pdf}]
-The commands provided by the \sty{mfirstuc} package are briefly
-described in \htmldoc{mfirstuc.sty: uppercasing first
-letter}{mfirstuc-manual}.
-
\item[\url{glossaries-code.pdf}]
Advanced users wishing to know more about the inner workings of all the
packages provided in the \styfmt{glossaries} bundle should read
-\qt{Documented Code for glossaries v4.21}.
-This includes the documented code for the \sty{mfirstuc} package.
+\qt{Documented Code for glossaries v4.22}.
\item[INSTALL] Installation instructions.
@@ -485,6 +479,24 @@ This includes the documented code for the \sty{mfirstuc} package.
\item[README] Package summary.
\end{description}
+Related resources:
+\begin{itemize}
+\item \href{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{\styfmt{glossaries}
+FAQ}
+
+\item \href{http://www.dickimaw-books.com/gallery/glossaries-styles/}{\styfmt{glossaries}
+gallery}
+
+\item \href{http://www.dickimaw-books.com/latex/thesis/}{Using LaTeX to Write a PhD Thesis}
+(chapter 6).
+
+\item
+\href{http://www.latex-community.org/know-how/latex/55-latex-general/263-glossaries-nomenclature-lists-of-symbols-and-acronyms}{Glossaries,
+Nomenclature, Lists of Symbols and Acronyms}
+
+\item The
+\href{http://ctan.org/pkg/glossaries-extra}{\styfmt{glossaries-extra} package}
+\end{itemize}
\begin{important}
If you use \sty{hyperref} and \styfmt{glossaries}, you must load
@@ -503,12 +515,6 @@ subscripts or superscripts. This is an issue with the DVI format not
with \styfmt{glossaries}.
\end{important}
-Other documents that describe using the \styfmt{glossaries} package include:
-\href{http://www.dickimaw-books.com/latex/thesis/}{Using LaTeX to Write a PhD Thesis}
-and
-\href{http://www.latex-community.org/know-how/latex/55-latex-general/263-glossaries-nomenclature-lists-of-symbols-and-acronyms}{Glossaries,
-Nomenclature, Lists of Symbols and Acronyms}.
-
\clearpage
\pdfbookmark[0]{Contents}{contents}
\tableofcontents
@@ -581,7 +587,8 @@ difficult. There are three options:
This option works best with the \pkgopt[def]{sort} setting. For any
other setting, be prepared for a long document build time,
- especially if you have a lot of entries defined.
+ especially if you have a lot of entries defined. \textbf{This
+option is intended as a last resort for alphabetical sorting.}
\begin{enumerate}
\item Add \cs{makenoidxglossaries} to your preamble (before you
@@ -1450,8 +1457,7 @@ description=\verb|{select group or class}}|
\end{alltt}
\end{important}
(For further details, see the section
-\qtdocref{UTF-8}{mfirstuc-manual} in the
-\sty{mfirstuc} user manual.)
+\qt{UTF-8} section in the \sty{mfirstuc} user manual.)
If you use the \sty{inputenc} package, \gls{makeglossaries}
will pick up the encoding from the auxiliary file. If you use
@@ -4041,8 +4047,7 @@ package:
description=\verb|{select group or class}}|
\end{alltt}
(This doesn't apply for \XeLaTeX\ documents using the \sty{fontspec}
-package. For further details,
-see the section \qtdocref{UTF-8}{mfirstuc-manual} in the
+package. For further details, see the \qt{UTF-8} section in the
\sty{mfirstuc} user manual.)
Note that in both of the above examples, you will also need to
@@ -4996,7 +5001,17 @@ for example,
if you're on an odd or an even page}) the \texttt{page} counter
(represented internally as \cs{c@page}) can be unreliable.
This can cause problems when glossary entries are referenced in a
-paragraph that spans a page break. To compensate, the
+paragraph that spans a page break. The standard \cs{label} mechanism
+deals with this by deferring the write until the end of the
+paragraph, but the \styfmt{glossaries} indexing mechanism
+needs to take into account the possibility that the location might
+contain any of \gls{xindy}['s] special characters which will need to
+be escaped before the write can be performed. (This isn't a problem
+with \gls{makeindex} as that places restrictions on the location
+format which prevent this from happening, but these very
+restrictions can make \gls*{xindy} preferable.)
+
+To compensate, the
\styfmt{glossaries} package has to make some adjustments to ensure
the location number is correct for this situation. By default,
the adjustments only affect the counter styles: \texttt{roman},
@@ -5007,6 +5022,9 @@ If you have a different numbering system where
\begin{definition}[\DescribeMacro\glsaddprotectedpagefmt]
\cs{glsaddprotectedpagefmt}\marg{internal cs name}
\end{definition}
+Note that the backslash must be omitted from \meta{internal cs name}
+and the corresponding command must be able to process a count
+register as the (sole) argument.
For example, suppose you have a style \texttt{samplenum} that is
implemented as follows:
@@ -5087,6 +5105,13 @@ the file. (So don't, for example, hide \cs{c@page} inside a robust
command.)
\end{important}
+The mechanism that allows this to work temporarily redefines
+\ics{the} and \ics{number} while it processes the location. If this
+causes a problem you can disallow it using
+\begin{definition}[\DescribeMacro\glswrallowprimitivemodsfalse]
+\cs{glswrallowprimitivemodsfalse}
+\end{definition}
+
Both \gls{makeindex} and \gls{xindy} (\optsand23) concatenate a
sequence of~3 or more consecutive pages into~a range. With
\gls*{xindy} (\opt3) you can vary the minimum sequence length using
@@ -5761,6 +5786,14 @@ These convert the first character or all the characters to
uppercase, respectively. See the note on \cs{Gls} above for details
on the limitations of converting the first letter to upper case.
+There's no equivalent command for title-casing, but you
+can use the more generic command \ics{glsentrytitlecase}
+in combination with \cs{glslink}. For example:
+\begin{verbatim}
+\glslink{sample}{\glsentrytitlecase{sample}{text}}
+\end{verbatim}
+(See \sectionref{sec:glsnolink}.)
+
\begin{definition}[\DescribeMacro{\glsfirst}]
\cs{glsfirst}\oarg{options}\marg{label}\oarg{insert}
\end{definition}
@@ -5862,6 +5895,11 @@ There are also analogous uppercasing commands:
\cs{GLSdesc}\oarg{options}\marg{text}\oarg{insert}
\end{definition}
+If you want the title case version you can use
+\begin{verbatim}
+\glslink{sample}{\glsentrytitlecase{sample}{desc}}
+\end{verbatim}
+
\begin{definition}[\DescribeMacro{\glsuseri}]
\cs{glsuseri}\oarg{options}\marg{label}\oarg{insert}
\end{definition}
@@ -6655,15 +6693,20 @@ The other commands depend on whether their corresponding keys were
assigned non-expandable values.
\end{important}
-If you want each word in a given entry field capitalised, you can
-use \ics{ecapitalisewords}\meta{text} defined by the \sty{mfirstuc}
-package, but make sure you use one of the expandable commands within
-\meta{text}. For example:
+If you want to title case a field, you can use:
+\begin{definition}[\DescribeMacro\glsentrytitlecase]
+\cs{glsentrytitlecase}\marg{label}\marg{field}
+\end{definition}
+where \meta{label} is the label identifying the glossary entry,
+\meta{field} is the field label (see \tableref{tab:fieldmap}).
+For example:
\begin{verbatim}
-\ecaptialisewords{\glsentrytext{somelabel}}
+\glsentrytitlecase{sample}{desc}
\end{verbatim}
-Note that \cs{ecapitalisewords} is not expandable. Note that
-this command has the same limitations as \cs{makefirstuc} which is
+(If you want title-casing in your glossary style, you might want to
+investigate the \sty{glossaries-extra} package.)
+
+Note that this command has the same limitations as \cs{makefirstuc} which is
used by commands like \cs{Gls} and \cs{Glsentryname} to upper-case
the first letter (see the notes about \cs{Gls} in \sectionref{sec:gls-like}).
@@ -6684,7 +6727,7 @@ to use \cs{glsentrytext} or \cs{glsentryfirst} instead of
\cs{glsentryname}.
\begin{important}
-In general it's best to avoid \cs{Glsentryname} with acronyms. Instead,
+In general it's best to avoid \cs{Glsentryname} with abbreviations. Instead,
consider using \cs{Glsentrylong}, \cs{Glsentryshort} or \cs{Glsentryfull}.
\end{important}
@@ -7072,6 +7115,13 @@ letter ordering taken from the \pkgopt{order} package option),
\texttt{use} (order of use), \texttt{def} (order of definition)
\texttt{nocase} (case-insensitive) or \texttt{case} (case-sensitive).
+\begin{important}
+If you use the \texttt{use} or \texttt{def} values make sure
+that you select a glossary style that doesn't have a visual
+indicator between groups, as the grouping no longer makes sense.
+Consider using the \pkgopt{nogroupskip} option.
+\end{important}
+
{\raggedright
The word and letter order sort methods use
\sty{datatool}'s
@@ -9402,7 +9452,9 @@ with a number of pre-defined glossary styles, described in
\sectionref{sec:predefinedstyles}. You can choose one of these that
best suits your type of glossary or, if none of them suit your
document, you can defined your own style (see
-\sectionref{sec:newglossarystyle}).
+\sectionref{sec:newglossarystyle}). There are some examples
+of glossary styles available at
+\url{http://www.dickimaw-books.com/gallery/#glossaries}.
The glossary style can be set using the \gloskey[printglossary]{style} key in the optional
argument to \ics{printnoidxglossary} (\opt1) or \ics{printglossary}
@@ -9417,6 +9469,7 @@ package option, it depends if the package in which they are defined
is automatically loaded by the \styfmt{glossaries} package.
You can use the lorum ipsum dummy entries provided in the
+accompanying
\texttt{example-glossaries-*.tex} files (described in
\sectionref{sec:lipsum}) to test the different styles.
@@ -9429,13 +9482,20 @@ package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and
\pkgopt{subentrycounter} described in
\sectionref{sec:pkgopts-printglos}. There is a summary
of available styles in \tableref{tab:styles}.
+You can view samples of all the predefined styles at
+\url{http://www.dickimaw-books.com/gallery/glossaries-styles/}.
\begin{important}
Note that the group styles (such as \glostyle{listgroup}) will
have unexpected results if used with the \pkgopt[def]{sort}
-or \pkgopt[use]{sort} options.
+or \pkgopt[use]{sort} options. If you don't sort your entries
+alphabetically, it's best to set the \pkgopt{nogroupskip}
+package option to prevent odd vertical gaps appearing.
\end{important}
+The group title is obtained using \cs{glsgetgrouptitle}\marg{label},
+which is described in \sectionref{sec:newglossarystyle}.
+
\begin{table}[htbp]
\caption[Glossary Styles]{Glossary Styles. An asterisk in the style
name indicates anything that matches that doesn't match any
@@ -9536,7 +9596,8 @@ the glossary is displayed. Alternatively, you can suppress it for a
given entry by placing \ics{nopostdesc} in the entry's description.
As from version 3.03 you can now use the package option
-\pkgopt{nopostdot} to suppress this full stop.
+\pkgopt{nopostdot} to suppress this full stop. This is the better
+option if you want to use the \sty{glossaries-extra} package.
\subsection{List Styles}
\label{sec:liststyles}
@@ -9558,7 +9619,9 @@ the description and number list follows (but not the name) for each
child entry. Groups are separated using \ics{indexspace}.
\item[listgroup] The \glostyle{listgroup} style is like
-\glostyle{list} but the glossary groups have headings.
+\glostyle{list} but the glossary groups have headings
+obtained using \cs{glsgetgrouptitle}\marg{label},
+which is described in \sectionref{sec:newglossarystyle}.
\item[listhypergroup] The \glostyle{listhypergroup} style is like
\glostyle{listgroup} but has a navigation line at the start of the
@@ -9577,9 +9640,20 @@ example, to simply have a space separating each group, do:
Note that the hyper-navigation line is now (as from version 1.14)
set inside the optional argument to \ics{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.
+to prevent a spurious space at the start. This can cause a problem
+if the navigation line is too long.
+As from v4.22, if you need to adjust this, you can redefine
+\begin{definition}[\DescribeMacro\glslistnavigationitem]
+\cs{glslistnavigationitem}\marg{navigation line}
+\end{definition}
+The default definition is \cs{item}\oarg{navigation line} but may
+be redefined independently of setting the style. For example:
+\begin{verbatim}
+\renewcommand*{\glslistnavigationitem}[1]{\item \textbf{#1}}
+\end{verbatim}
+
+You may prefer to use the tree-like styles, such as
+\glostyle{treehypergroup} instead.
\item[altlist] The \glostyle{altlist} style is like \glostyle{list}
but the description starts on the line following the name. (As
@@ -10072,7 +10146,20 @@ This defaults to \cs{textbf}\marg{name}, but note that \meta{name}
includes \ics{glsnamefont} so the bold setting in \cs{glstreenamefont}
may be counteracted by another font change in \cs{glsnamefont} (or
in \cs{acronymfont}). The tree-like styles that also display the
-header use \cs{glstreenamefmt} to format the heading.
+header use
+\begin{definition}[\DescribeMacro\glstreegroupheaderfmt]
+\cs{glstreegroupheaderfmt}\marg{text}
+\end{definition}
+to format the heading. This defaults to
+\cs{glstreenamefmt}\marg{text}. The tree-like styles that display
+navigation links to the groups (such as \glostyle{indexhypergroup}), format
+the navigation line using
+\begin{definition}[\DescribeMacro\glstreenavigationfmt]
+\cs{glstreenavigationfmt}\marg{text}
+\end{definition}
+which defaults to \cs{glstreenamefmt}\marg{text}. Note that this is
+different from \cs{glslistnavigationitem}, provided with the styles
+such as \glostyle{listhypergroup}, as that also includes \cs{item}.
\begin{description}
\item[index] The \glostyle{index} style is similar to the way
@@ -10085,12 +10172,15 @@ in brackets (if present) and the description. Groups are separated
using \ics{indexspace}.
\item[indexgroup] The \glostyle{indexgroup} style is similar to
-the \glostyle{index} style except that each group has a heading.
+the \glostyle{index} style except that each group has a heading
+obtained using \cs{glsgetgrouptitle}\marg{label},
+which is described in \sectionref{sec:newglossarystyle}.
\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.
+\glostyle{listhypergroup}, described above, but is formatted using
+\cs{glstreenavigationfmt}.
\item[tree] The \glostyle{tree} style is similar to the
\glostyle{index} style except that it can have arbitrary levels.
@@ -10108,7 +10198,8 @@ 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.
+\glostyle{listhypergroup}, described above, but is formatted using
+\cs{glstreenavigationfmt}.
\item[treenoname] The \glostyle{treenoname} style is like
the \glostyle{tree} style except that the name for each sub-entry
@@ -10121,7 +10212,8 @@ 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.
+\glostyle{listhypergroup}, described above, but is formatted using
+\cs{glstreenavigationfmt}.
\item[alttree] The \glostyle{alttree} style is similar to the
\glostyle{tree} style except that the indentation for each level
@@ -10135,11 +10227,54 @@ 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.
+As from v4.22, the \sty{glossary-tree} package also provides
+\begin{definition}[\DescribeMacro\glsfindwidesttoplevelname]
+\cs{glsfindwidesttoplevelname}\oarg{glossary list}
+\end{definition}
+This iterates over all parentless entries in the given glossary
+lists and determines the widest entry. If the optional argument is
+omitted, all glossaries are assumed (as per \cs{forallglossaries}).
+
+For example, to have the same name width for all glossaries:
+\begin{verbatim}
+\glsfindwidesttoplevelname
+\setglossarystyle{alttree}
+\printglossaries
+\end{verbatim}
+Alternatively, to compute the widest entry for each glossary
+before it's displayed:
+\begin{verbatim}
+\renewcommand{\glossarypreamble}{%
+ \glsfindwidesttoplevelname[\currentglossary]}
+\setglossarystyle{alttree}
+\printglossaries
+\end{verbatim}
+
+\begin{important}
+These commands only affects the \glostyle{alttree} styles, including those
+listed below and the ones in the \sty{glossary-mcols} package.
+If you forget to set the widest entry name, the description will
+overwrite the name.
+\end{important}
+
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.
+The name is placed inside a left-aligned \cs{makebox}. As from
+v4.19, this can now be adjusted by redefining
+\begin{definition}[\DescribeMacro\glstreenamebox]
+\cs{glstreenamebox}\marg{width}\marg{text}
+\end{definition}
+where \meta{width} is the width of the box and \meta{text} is the
+contents of the box. For example, to make the name right-aligned:
+\begin{verbatim}
+\renewcommand*{\glstreenamebox}[2]{%
+ \makebox[#1][r]{#2}%
+}
+\end{verbatim}
+
\item[alttreegroup] The \glostyle{alttreegroup} is like the
\glostyle{alttree} style except that each group has a heading.
@@ -10160,7 +10295,13 @@ defined in \sectionref{sec:treestyles}) but are prefixed with
\qt{mcol}.
For example, the \glostyle{mcolindex} style is essentially the
\glostyle{index} style but put in a \env{multicols} environment.
-For the complete list, see \tableref{tab:mcols}.
+For the complete list, see \tableref{tab:mcols}. The
+\sty{glossary-tree} package is automatically loaded by
+\sty{glossary-mcols} (even if the \pkgopt{notree} package option is
+used when loading \styfmt{glossaries}). The formatting commands
+\cs{glstreenamefmt}, \cs{glstreegroupheaderfmt} and
+\cs{glstreenavigationfmt} are all used by the corresponding
+\sty{glossary-mcols} styles.
\begin{important}
Note that \sty{glossary-mcols} is not loaded by \styfmt{glossaries}. If
@@ -10191,19 +10332,28 @@ to the required number. For example, for a three column glossary:
Analogous Tree Style\\
\glostyle{mcolindex} & \glostyle{index}\\
\glostyle{mcolindexgroup} & \glostyle{indexgroup}\\
-\glostyle{mcolindexhypergroup} & \glostyle{indexhypergroup}\\
+\glostyle{mcolindexhypergroup} or \glostyle{mcolindexspannav} & \glostyle{indexhypergroup}\\
\glostyle{mcoltree} & \glostyle{tree}\\
\glostyle{mcoltreegroup} & \glostyle{treegroup}\\
-\glostyle{mcoltreehypergroup} & \glostyle{treehypergroup}\\
+\glostyle{mcoltreehypergroup} or \glostyle{mcoltreespannav} & \glostyle{treehypergroup}\\
\glostyle{mcoltreenoname} & \glostyle{treenoname}\\
\glostyle{mcoltreenonamegroup} & \glostyle{treenonamegroup}\\
-\glostyle{mcoltreenonamehypergroup} & \glostyle{treenonamehypergroup}\\
+\glostyle{mcoltreenonamehypergroup} or
+\glostyle{mcoltreenonamespannav} & \glostyle{treenonamehypergroup}\\
\glostyle{mcolalttree} & \glostyle{alttree}\\
\glostyle{mcolalttreegroup} & \glostyle{alttreegroup}\\
-\glostyle{mcolalttreehypergroup} & \glostyle{alttreehypergroup}
+\glostyle{mcolalttreehypergroup} or \glostyle{mcolalttreespannav} & \glostyle{alttreehypergroup}
\end{tabular}
\end{table}
+The styles with a navigation line, such as
+\glostyle{mcoltreehypergroup}, now have a variant (as from v4.22)
+with \qt{hypergroup} replaced with \qt{spannav} in the style name.
+The original \qt{hypergroup} styles place the navigation line at the
+start of the first column. The newer \qt{spannav} styles put the
+navigation line in the optional argument of the \env{multicols}
+environment so that it spans across all the columns.
+
\subsection{In-Line Style}
\label{sec:inline}
@@ -10255,6 +10405,52 @@ a parent main entry and its first sub-entry.
\end{definition}
This defaults to \qt{\texttt{\glsinlineseparator}} and is used at the end
of the glossary.
+\begin{definition}[\DescribeMacro\glsinlinenameformat]
+\cs{glsinlinenameformat}\marg{label}\marg{name}
+\end{definition}
+This is used to format the entry name and defaults to
+\cs{glstarget}\marg{label}\marg{name}, where \meta{name} is provided
+in the form \cs{glossentryname}\marg{label} and \meta{label} is the
+entry's label. For example, if you want the name to appear in
+smallcaps:
+\begin{verbatim}
+\renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}}
+\end{verbatim}
+Sub-entry names are formatted according to
+\begin{definition}[\DescribeMacro\glsinlinesubnameformat]
+\cs{glsinlinesubnameformat}\marg{label}\marg{name}
+\end{definition}
+This defaults to \cs{glstarget}\marg{label}\verb|{}| so the
+sub-entry name is ignored.
+
+If the description has been suppressed (according to
+\cs{ifglsdescsuppressed}) then
+\begin{definition}[\DescribeMacro\glsinlineemptydescformat]
+\cs{glsinlineemptydescformat}\marg{symbol}\marg{number list}
+\end{definition}
+(which defaults to nothing) is used,
+otherwise the description is formatted according to
+\begin{definition}[\DescribeMacro\glsinlinedescformat]
+\cs{glsinlinedescformat}\marg{description}\marg{symbol}\marg{number
+list}
+\end{definition}
+This defaults to just \cs{space}\meta{description} so the symbol and
+location list are ignored. If the description is missing (according
+to \cs{ifglshasdesc}), then \cs{glsinlineemptydescformat} is used
+instead.
+
+For example, if you want a colon between the name and the
+description:
+\begin{verbatim}
+\renewcommand*{\glsinlinedescformat}[3]{: #1}
+\end{verbatim}
+
+The sub-entry description is formatted according to:
+\begin{definition}[\DescribeMacro\glsinlinesubdescformat]
+\cs{glsinlinesubdescformat}\marg{description}\marg{symbol}\marg{number
+list}
+\end{definition}
+This defaults to just \meta{description}.
\section{Defining your own glossary style}
\label{sec:newglossarystyle}
@@ -10325,6 +10521,12 @@ A navigation hypertarget can be created using
\begin{definition}[\DescribeMacro{\glsnavhypertarget}]
\cs{glsnavhypertarget}\marg{label}\marg{text}
\end{definition}
+This typically requires \cs{glossaryheader} to be redefined to use
+\begin{definition}[\DescribeMacro\glsnavigation]
+\cs{glsnavigation}
+\end{definition}
+which displays the navigation line.
+
For further details about \cs{glsnavhypertarget}, see
\ifpdf section~\ref*{sec:code:hypernav} in \fi the documented code
(\texttt{glossaries-code.pdf}).
@@ -10354,7 +10556,7 @@ used to suppress this default gap for the predefined styles.
\begin{definition}[\DescribeMacro{\glossentry}]
\cs{glossentry}\marg{label}\marg{number list}
\end{definition}
-This macro indicates what to do for each level~0 glossary entry.
+This macro indicates what to do for each top-level (level~0) glossary entry.
The entry label is given by \meta{label} and the associated
\gls{numberlist} is given by \meta{number list}. You can redefine
\ics{glossentry} to use commands like \ics{glossentryname}\marg{label},