summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-06-18 22:00:18 +0000
committerKarl Berry <karl@freefriends.org>2016-06-18 22:00:18 +0000
commita2108d8fb8bcdf43db03cb2bd3a7d9ebde44e634 (patch)
treeda8b60a49916f9313a9325943dd48c8250f5ef06 /Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
parent0bac232781697b3a0f1796a6264fd68bffc4a6ee (diff)
glossaries-extra (18jun16)
git-svn-id: svn://tug.org/texlive/trunk@41486 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex557
1 files changed, 412 insertions, 145 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
index 25976384568..cf93ca072a9 100644
--- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
+++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
@@ -143,28 +143,28 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{glossaries-extra.sty v1.05:
+ \title{glossaries-extra.sty v1.06:
an extension to the glossaries package}
\author{Nicola L.C. Talbot\\[10pt]
Dickimaw Books\\
\url{http://www.dickimaw-books.com/}}
- \date{2016-06-10}
+ \date{2016-06-18}
\maketitle
\begin{abstract}
The \styfmt{glossaries-extra} package is an extension to the
-\sty{glossaries} package, providing additional features.
+\styfmt{glossaries} package, providing additional features.
Some of the features provided by this package are only available
-with \sty{glossaries} version 4.19 (or above).
-This document assumes familiarity with the \sty{glossaries} package.
+with \styfmt{glossaries} version 4.19 (or above).
+This document assumes familiarity with the \styfmt{glossaries} package.
\end{abstract}
\begin{important}
-Since \styfmt{glossaries-extra} internally loads the \sty{glossaries}
-package, you also need to have \sty{glossaries} installed and
-all the packages that \sty{glossaries} depends on (including, but
+Since \styfmt{glossaries-extra} internally loads the \styfmt{glossaries}
+package, you also need to have \styfmt{glossaries} installed and
+all the packages that \styfmt{glossaries} depends on (including, but
not limited to, \sty{tracklang}, \sty{mfirstuc}, \sty{etoolbox},
\sty{xkeyval} (at least version dated 2006/11/18), \sty{textcase},
\sty{xfor}, \sty{datatool-base} and \sty{amsgen}. These
@@ -184,7 +184,7 @@ or
\chapter{Introduction}
\label{sec:intro}
-The \sty{glossaries} package is a flexible package, but it's also a
+The \styfmt{glossaries} package is a flexible package, but it's also a
heavy-weight package that uses a lot of resources. As package
developer, I'm caught between those users who complain about the
drawbacks of a heavy-weight package with a large user manual and
@@ -209,7 +209,7 @@ chance of getting their feature requests accepted.
\label{sec:defaults}
I'm not happy with some of the default settings assumed by the
-\sty{glossaries} package, and, judging from code I've seen, other
+\styfmt{glossaries} package, and, judging from code I've seen, other
users also seem unhappy with them, as certain package options are
often used in questions posted on various sites. I can't change the default
behaviour of \styfmt{glossaries} as it would break backward
@@ -228,11 +228,11 @@ after the description in the glossary). Use
\pkgopt[false]{nopostdot} to restore the terminating full stop
(period).
-\item \pkgopt[true]{noredefwarn} (suppress warnings when
+\item \pkgopt[true]{noredefwarn} (suppress the warnings that occur when
the \env{theglossary} environment and \cs{printglossary} are redefined while
-\sty{glossaries} is loading). To restore the warnings, use
+\styfmt{glossaries} is loading). To restore the warnings, use
\pkgopt[false]{noredefwarn}. Note that this won't have any effect if
-the \sty{glossaries} package has already been loaded before you use
+the \styfmt{glossaries} package has already been loaded before you use
the \styfmt{glossaries-extra} package.
\item If \sty{babel} has been loaded, the \pkgopt[babel]{translate}
@@ -294,7 +294,7 @@ This is like:
\usepackage{glossaries-extra}
\end{verbatim}
Since by the time \styfmt{glossaries-extra} has been loaded,
-\sty{glossaries} has already redefined \cls{memoir}'s
+\styfmt{glossaries} has already redefined \cls{memoir}'s
glossary-related commands.
\end{enumerate}
@@ -352,7 +352,7 @@ No file test.gls.
This doesn't occur with \gls{makeglossaries} as it will create
the \texttt{.gls} file containing the single command \cs{null}.
-If you simply change from \sty{glossaries} to
+If you simply change from \styfmt{glossaries} to
\styfmt{glossaries-extra} in this document, you'll find a change in the
resulting PDF if you don't use \gls{makeglossaries} and you only
generate the \texttt{.acr} file with \gls{makeindex}.
@@ -385,13 +385,13 @@ emission of radiation}
\section{New or Modified Package Options}
\label{sec:pkgopts}
-If you haven't already loaded \sty{glossaries}, you can use any of
-the package options provided by \sty{glossaries} when you load
+If you haven't already loaded \styfmt{glossaries}, you can use any of
+the package options provided by \styfmt{glossaries} when you load
\styfmt{glossaries-extra} and they will automatically be passed to
-\sty{glossaries} (which \styfmt{glossaries-extra} will load). If
-\sty{glossaries} has already been loaded, then those options will be
+\styfmt{glossaries} (which \styfmt{glossaries-extra} will load). If
+\styfmt{glossaries} has already been loaded, then those options will be
passed to \ics{setupglossaries}, but remember that not all of the
-\sty{glossaries} package options may be used in that command.
+\styfmt{glossaries} package options may be used in that command.
\begin{important}
This section only lists options that are either unrecognised by
@@ -436,14 +436,55 @@ option, which has two allowed values: \pkgoptfmt{warn} and
\pkgoptfmt{error}. This indicates what to do if an undefined
glossary entry is referenced. The default behaviour is
\pkgopt[error]{undefaction}, which produces an error message (the
-default for \sty{glossaries}). You can switch this to a warning
+default for \styfmt{glossaries}). You can switch this to a warning
message (and ?? appearing in the text) with
\pkgopt[warn]{undefaction}.
-\item[{\pkgopt{docdef}}] This is a boolean option, which indicates
-whether or not it's permitted for the command \ics{newglossaryentry}
-to be used in the
-\env{document} environment. The \sty{glossaries} package allows
+\item[{\pkgopt{docdef}}] This option governs the use of
+\cs{newglossaryentry}. It was originally a boolean option,
+but as from version 1.06, it can now take one of three values (if
+the value is omitted, \pkgoptfmt{true} is assumed):
+\begin{itemize}
+\item[{\pkgopt[false]{docdef}}] \ics{newglossaryentry} is not
+permitted in the \env{document} environment (default).
+\item[{\pkgopt[true]{docdef}}] \cs{newglossaryentry} behaves as it
+does in the base \styfmt{glossaries} package. That is, where
+its use is permitted in the \env{document} environment, it
+uses the \texttt{.glsdefs} temporary file to store the entry
+definitions so that on the next \LaTeX\ run the entries are
+defined at the beginning of the \env{document} environment.
+This allows the entry information to be referenced in the glossary,
+even if the glossary occurs before \cs{newglossaryentry}.
+(For example, when the glossary is displayed in the front matter.)
+This method of saving the definitions for the next \LaTeX\ run
+has drawbacks that are detailed in the \styfmt{glossaries} user
+manual.
+\item[{\pkgopt[restricted]{docdef}}] (new to version 1.06)
+\ics{newglossaryentry} is permitted in the \env{document}
+environment without using the \texttt{.glsdefs} file. This means
+that all entries must be defined before the glossary is displayed,
+but it avoids the complications associated with saving the
+entry details in a temporary file. You will still need to take
+care about any changes made to characters that are required
+by the \meta{key}=\meta{value} mechanism (that is, the comma and
+equal sign) and any \gls{makeindex} or \gls{xindy} character that
+occurs in the \gloskey{sort} key or label. If any of those
+characters are made active in the document, then it can cause
+problems with the entry definition. This option will allow
+\cs{newglossaryentry} to be used in the document with
+\cs{makenoidxglossaries}, but note that \cs{longnewglossaryentry}
+remains a preamble-only command.
+
+With this option, if an entry appears in the glossary before
+it has been defined, an error will occur (or a warning if
+the \pkgopt[warn]{undefaction} option is used.) If you edit your
+document and either remove an entry or change its label, you may
+need to delete the document's temporary files (such as the
+\texttt{.aux} and \texttt{.gls} files).
+
+\end{itemize}
+
+The \styfmt{glossaries} package allows
\cs{newglossaryentry} within the \env{document} environment (when
used with \gls{makeindex} or \gls{xindy}) but the user manual warns
against this usage. By default the \styfmt{glossaries-extra} package
@@ -451,13 +492,19 @@ against this usage. By default the \styfmt{glossaries-extra} package
preamble. If you are really determined to define entries in the
\env{document} environment, despite all the associated drawbacks,
you can restore this with \pkgopt[true]{docdef}. Note that this
-doesn't change the prohibitions that the \sty{glossaries}
+doesn't change the prohibitions that the \styfmt{glossaries}
package has in certain circumstances (for example, when using
-\qt{option~1}). See the \sty{glossaries} user manual for further details.
+\qt{option~1}). See the \styfmt{glossaries} user manual for further
+details. A better option if document definitions are required
+is \pkgopt[restricted]{docdef}. Only use \pkgopt[true]{docdef}
+if document definitions are necessary and one or more of the
+glossaries occurs in the front matter.
+\begin{sloppypar}
This option affects commands that internally use
\cs{newglossaryentry}, such as \cs{newabbreviation}, but not
the \qt{on-the-fly} commands described in \sectionref{sec:onthefly}.
+\end{sloppypar}
\item[{\pkgopt{nomissingglstext}}] This is a boolean option.
If true, this will suppress the warning text that will appear in the
@@ -505,7 +552,7 @@ defined by an included language file).
\end{important}
If the \pkgopt{abbreviations} option is used and the
-\pkgopt{acronym} option provided by the \sty{glossaries}
+\pkgopt{acronym} option provided by the \styfmt{glossaries}
package hasn't been used, then \ics{acronymtype}
will be set to \ics{glsxtrabbrvtype} so that acronyms defined with
\ics{newacronym} can be added to the list of abbreviations. If you
@@ -516,12 +563,12 @@ want acronyms in the \texttt{main} glossary and other abbreviations in the
\renewcommand*{\acronymtype}{main}
\end{verbatim}
-Note that there are no analogous options to the \sty{glossaries}
+Note that there are no analogous options to the \styfmt{glossaries}
package's \pkgopt{acronymlists} option (or associated commands)
as the abbreviation mechanism is handled differently with
\styfmt{glossaries-extra}.
-\item[{\pkgopt{symbols}}] This is passed to \sty{glossaries} but
+\item[{\pkgopt{symbols}}] This is passed to \styfmt{glossaries} but
will additionally define
\begin{definition}[\DescribeMacro\glsxtrnewsymbol]
\cs{glsxtrnewsymbol}\oarg{options}\marg{label}\marg{symbol}
@@ -534,7 +581,7 @@ which is equivalent to
Note that the \gloskey{sort} key is set to the \meta{label}
not the \meta{symbol} as the symbol will likely contain commands.
-\item[{\pkgopt{numbers}}] This is passed to \sty{glossaries} but
+\item[{\pkgopt{numbers}}] This is passed to \styfmt{glossaries} but
will additionally define
\begin{definition}[\DescribeMacro\glsxtrnewnumber]
\cs{glsxtrnewnumber}\oarg{options}\marg{number}
@@ -545,22 +592,22 @@ which is equivalent to
sort=\marg{label},type=numbers,category=number,\meta{options}\}
\end{alltt}
-\item[{\pkgopt{shortcuts}}] Unlike the \sty{glossaries} package
+\item[{\pkgopt{shortcuts}}] Unlike the \styfmt{glossaries} package
option of the same name, this option isn't boolean but has multiple
values:
\begin{itemize}
\item \pkgopt[acronyms]{shortcuts} (or \pkgopt[acro]{shortcuts}):
-set the shortcuts provided by the \sty{glossaries} package for acronyms (such as \cs{ac}).
+set the shortcuts provided by the \styfmt{glossaries} package for acronyms (such as \cs{ac}).
\item \pkgopt[abbreviations]{shortcuts} (or
\pkgopt[abbr]{shortcuts}):
set the abbreviation shortcuts provided by \styfmt{glossaries-extra}. (See
\sectionref{sec:abbrshortcuts}.) These settings don't switch on the
-acronym shortcuts provided by the \sty{glossaries} package.
+acronym shortcuts provided by the \styfmt{glossaries} package.
\item \pkgopt[other]{shortcuts}: set the \qt{other}
shortcut commands, but not the shortcut commands for abbreviations
-or the acronym shortcuts provided by \sty{glossaries}.
+or the acronym shortcuts provided by \styfmt{glossaries}.
The \qt{other} shortcuts are:
\begin{itemize}
\item \ics{newentry} equivalent to \ics{newglossaryentry}
@@ -586,12 +633,14 @@ set available options using
\begin{definition}[\DescribeMacro\glossariesextrasetup]
\cs{glossariesextrasetup}\marg{options}
\end{definition}
-The \pkgopt{abbreviations} option may only be used in the preamble.
+The \pkgopt{abbreviations} and \pkgopt{docdef} options may only be
+used in the preamble. Additionally, \pkgopt{docdef} can't be used
+after \ics{makenoidxglossaries}.
-\section{Modifications to Existing Commands or Styles}
+\chapter{Modifications to Existing Commands and Styles}
\label{sec:modifications}
-The commands used by \sty{glossaries} to automatically produce an
+The commands used by \styfmt{glossaries} to automatically produce an
error if an entry is undefined (such as \ics{glsdoifexists}) are
changed to take the \pkgopt{undefaction} option into account.
@@ -607,7 +656,7 @@ The \ics{newacronym} command is modified to use the new abbreviation
interface provided by \styfmt{glossaries-extra}.
(See \sectionref{sec:abbreviations}.)
-\subsection{Entry Indexing}
+\section{Entry Indexing}
\label{sec:wrglossary}
The \styfmt{glossaries-extra} package provides an extra key for
@@ -616,7 +665,7 @@ commands like \cs{gls} and \cs{glstext} called
this suppresses the indexing. (That is, it prevents \cs{gls} or
whatever from adding a line to the external glossary file.)
This is more useful than the \pkgopt{indexonlyfirst} package option
-provided by \sty{glossaries}, as the \gls{firstuse} might not be the most
+provided by \styfmt{glossaries}, as the \gls{firstuse} might not be the most
pertinent use. (If you want to apply \pkgopt{indexonlyfirst}
to selected entries, rather than all of them, you can use
the \catattr{indexonlyfirst} attribute, see
@@ -637,16 +686,16 @@ which uses this hook to determine which entries haven't been
indexed.)
The value of the \gloskey{see} key is now saved
-as a field. This isn't the case with \sty{glossaries}, where
+as a field. This isn't the case with \styfmt{glossaries}, where
the \gloskey{see} attribute is simply used to directly
write a line to the corresponding glossary file and is then
discarded. This is why the \gloskey{see} key can't be
used before \ics{makeglossaries} (since the file hasn't been opened
-yet). It's also the reason why the \gloskey{see} key doesn't
-have any effect when used in entries that are defined in the
-\env{document} environment. Since the value isn't saved, it's not
-available when the \texttt{.glsdefs} file is created at the end
-of the document and so isn't available at the start of the
+yet). It's also the reason why the \gloskey{see} key doesn't have
+any effect when used in entries that are defined in the
+\env{document} environment. Since the value isn't saved,
+it's not available when the \texttt{.glsdefs} file is created at the
+end of the document and so isn't available at the start of the
\env{document} environment on the next run.
This modification allows \styfmt{glossaries-extra} to provide
@@ -658,15 +707,57 @@ any unused cross-references unless the package option
\pkgopt{indexcrossrefs} was set to false.
As a by-product of this enhancement, the \gloskey{see} key will now
-work for entries defined in the document environment, but it's still
+work for entries defined in the \env{document} environment, but it's still
best to define entries in the preamble, and the \gloskey{see} key
-still can't work before the file has been opened by
-\cs{makeglossaries}.
+still can't perform any indexing before the file has been opened by
+\cs{makeglossaries}. Note that \styfmt{glossaries} v4.24 introduced
+the \pkgopt{seenoindex} package option, which can be used to
+suppress the error when the \gloskey{see} key is used before
+\cs{makeglossaries}, so \pkgopt[ignore]{seenoindex} will allow the
+\gloskey{see} value to be stored even though it may not be possible
+to index it at that point.
+
+As from version 1.06, you can display the cross-referenced
+information for a given entry using
+\begin{definition}[\DescribeMacro\glsxtrusesee]
+\cs{glsxtrusesee}\marg{label}
+\end{definition}
+This internally uses
+\begin{definition}[\DescribeMacro\glsxtruseseeformat]
+\cs{glsxtruseseeformat}\marg{tag}\marg{xr list}
+\end{definition}
+where \meta{tag} and \meta{xr list} are obtained from the value of
+the entry's \gloskey{see} field (if non-empty).
+By default, this just does \cs{glsseeformat}\oarg{tag}\marg{xr
+list}\verb|{}|, which is how the cross-reference is displayed in the
+\gls{numberlist}. Note that \cs{glsxtrusesee} does nothing if the
+\gloskey{see} field hasn't been set for the entry given by
+\meta{label}.
+
+Suppose you want to suppress the \gls*{numberlist}
+using \pkgopt{nonumberlist}. This will automatically prevent the
+cross-references from being displayed. The
+\pkgopt{seeautonumberlist} package option will automatically
+enable the \gls*{numberlist} for entries that have the \gloskey{see}
+key set, but this will also show the rest of the \gls*{numberlist}.
+
+Another approach in this situation is to use the post description
+hook with \cs{glsxtrusesee} to append the cross-reference after
+the description. For example:
+\begin{verbatim}
+\renewcommand*{\glsxtrpostdescgeneral}{%
+ \ifglshasfield{see}{\glscurrententrylabel}
+ {, \glsxtrusesee{\glscurrententrylabel}}%
+ {}%
+}
+\end{verbatim}
+Now the cross-references can appear even though the \gls{numberlist}
+has been suppressed.
-\subsection{Entry Display Style Modifications}
+\section{Entry Display Style Modifications}
\label{sec:entryfmtmods}
-Recall from the \sty{glossaries} package that commands such as \cs{gls}
+Recall from the \styfmt{glossaries} package that commands such as \cs{gls}
display text at that point in the document (optionally with a
hyperlink to the relevant line in the glossary). This text is
referred to as the \qt{\gls{linktext}} regardless of whether or not it
@@ -684,7 +775,7 @@ regular entries, which are determined as follows:
\catattr{regular} attribute set (see \sectionref{sec:categories}), the entry is considered a~regular
entry, even if it has a~value for the \gloskey{short} key.
In this case \cs{glsentryfmt} uses \ics{glsgenentryfmt}
-(provided by \sty{glossaries}), which uses the \gloskey{first}
+(provided by \styfmt{glossaries}), which uses the \gloskey{first}
(or \gloskey{firstplural}) value on \gls{firstuse} and the
\gloskey{text} (or \gloskey{plural}) value on subsequent use.
@@ -754,7 +845,7 @@ for the \category{acronym} category in the above example changes
the regular attribute to \qt{false}, \cs{glsxtrregularfont} will
no longer apply.)
-The \cs{glspostlinkhook} provided by the \sty{glossaries} package to
+The \cs{glspostlinkhook} provided by the \styfmt{glossaries} package to
insert information after the \gls{linktext} produced by commands like \cs{gls} and \cs{glstext} is
redefined to
\begin{definition}[\DescribeMacro\glsxtrpostlinkhook]
@@ -777,6 +868,7 @@ By default \cs{glsxtrpostlink} just does \postlinkcat\ if it exists, where
(For example, for the \category{general} category,
\cs{glsxtrpostlinkgeneral} if it has been defined.)
+\begin{sloppypar}
The sentence-ending hook is slightly more complicated.
If the command \postlinkcat\ is defined the hook will do that
and then insert a full stop with the space factor adjusted to match
@@ -788,6 +880,7 @@ discarded and the space factor adjusted (in case the entry is in
uppercase) unless the entry is followed by additional material, in
which case the following full stop is no longer redundant and needs
to be reinserted.
+\end{sloppypar}
There are some convenient commands you might want to use
when customizing the post-\gls{linktext} category hooks:
@@ -820,7 +913,7 @@ the \gls{firstuseflag} will have been unset. Instead you can use
This will do \meta{true} if the last used entry was the
\gls{firstuse}
for that entry, otherwise it will do \meta{false}. (Requires at
-least \sty{glossaries} v4.19 to work properly.) This command is
+least \styfmt{glossaries} v4.19 to work properly.) This command is
locally set by commands like \cs{gls}, so don't rely on it outside
of the post-\gls{linktext} hook.
@@ -899,7 +992,7 @@ you can use \verb|\gls*[noindex]{sample}| or
\verb|\gls![hyper=false]{sample}| but you can't combine the
\texttt{*} and \texttt{!} modifiers.
-\subsection{Entry Counting Modifications}
+\section{Entry Counting Modifications}
\label{sec:entrycountmods}
The \ics{glsenableentrycount} command is modified to allow
@@ -924,7 +1017,7 @@ other categories will be unchanged.
Further information about entry counting, including the
new per-unit feature, is described in \sectionref{sec:entrycount}.
-\subsection{Nested Links}
+\section{Nested Links}
\label{sec:nested}
Complications arise when you use \ics{gls} in the
@@ -936,7 +1029,7 @@ is an abbreviation for Server Side Includes and HTML
is an abbreviation for Hypertext Markup Language.
Things can go wrong if we try the following with the
-\sty{glossaries} package:
+\styfmt{glossaries} package:
\begin{verbatim}
\newacronym{ssi}{SSI}{Server Side Includes}
\newacronym{html}{HTML}{Hypertext Markup Language}
@@ -1067,7 +1160,7 @@ Alternatively use something like:
[description={\acrshort{ssi} enabled \acrshort{html}}]
{shtml}{SHTML}{SSI enabled HTML}
\end{verbatim}
-with \sty{glossaries} or:
+with \styfmt{glossaries} or:
\begin{verbatim}
\newabbreviation
[description={\glsxtrshort{ssi} enabled \glsxtrshort{html}}]
@@ -1171,26 +1264,26 @@ command that breaks the first letter uppercasing commands like
\cs{Gls}, but you still won't be able to use the all caps commands,
such as \cs{GLS}.
-\subsection{Acronym Style Modifications}
+\section{Acronym Style Modifications}
\label{sec:acronymmods}
The \styfmt{glossaries-extra} package provides a new way of dealing
with abbreviations and redefines \ics{newacronym} to
use \cs{newabbreviation} (see \sectionref{sec:abbreviations}).
If you want to restore the generic acronym function provided
-by \sty{glossaries} you need to use
+by \styfmt{glossaries} you need to use
\begin{definition}[\DescribeMacro\RestoreAcronyms]
\cs{RestoreAcronyms}
\end{definition}
but be careful using this if you also want abbreviations as
they will clash if you attempt to use them in the same glossary as
-generic acronyms from the \sty{glossaries} package.
+generic acronyms from the \styfmt{glossaries} package.
\begin{definition}[\DescribeMacro\glsacspace]
\cs{glsacspace}\marg{label}
\end{definition}
The space command \cs{glsacspace} used by the
-\acrstyle{long-sp-short} acronym style provided by \sty{glossaries}
+\acrstyle{long-sp-short} acronym style provided by \styfmt{glossaries}
is modified so that it uses
\begin{definition}[\DescribeMacro\glsacspacemax]
\cs{glsacspacemax}
@@ -1214,7 +1307,7 @@ is redefined to use the subsequent use abbreviation font command
\ics{glsabbrvfont}. This will be reset if you use
\cs{RestoreAcronyms}.
-\subsection{Glossary Style Modifications}
+\section{Glossary Style Modifications}
\label{sec:glosstylemods}
The default value of \ics{glslistdottedwidth} is changed so that
@@ -1222,6 +1315,9 @@ it's set at the start of the document (if it hasn't been changed in
the preamble). This should take into account situations where
\cs{hsize} isn't set until the start of the document.
+\subsection{Style Hooks}
+\label{sec:stylehooks}
+
The commands \ics{glossentryname} and \ics{glossentrydesc} are
modified to take into account the \catattr{glossname},
\catattr{glossdesc} and \catattr{glossdescfont} attributes (see \sectionref{sec:categories}).
@@ -1241,13 +1337,15 @@ then the name is automatically indexed using
\end{definition}
See \sectionref{sec:autoindex} for further details.
+\begin{sloppypar}
As from version 1.04, the post-name hook \cs{glsxtrpostnamehook}
-will also do \cs{glsxtrpostname}\meta{category} if it exists.
+will also use \cs{glsxtrpostname}\meta{category} if it exists.
You can use \ics{glscurrententrylabel} to obtain the entry label
with the definition of this command. For example, suppose you are
using a glossary style the doesn't display the symbol, you can
insert the symbol after the name for a particular category, say,
the \qt{symbol} category:
+\end{sloppypar}
\begin{verbatim}
\newcommand*{\glsxtrpostnamesymbol}{\space
(\glsentrysymbol{\glscurrententrylabel})}
@@ -1294,14 +1392,64 @@ This feature can't be used for glossary styles that ignore
\cs{glspostdescription} without including \cs{glsxtrpostdescription}.
(For example, if you redefine \cs{glspostdescription} to do
nothing instead of using the \pkgopt{nopostdot} option to suppress
-the terminating full stop.)
+the terminating full stop.) See \sectionref{sec:stylemods} to patch
+the predefined styles provided by \styfmt{glossaries} that are missing
+\cs{glspostdescription}.
+\end{important}
+
+\subsection{Number List}
+\label{sec:glosstylenumlist}
+
+The \gls{numberlist} is now placed inside the argument of
+\begin{definition}[\DescribeMacro\GlsXtrFormatLocationList]
+\cs{GlsXtrFormatLocationList}\marg{number list}
+\end{definition}
+This is internally used by \cs{glossaryentrynumbers}. The
+\pkgopt{nonumberlist} option redefines \cs{glossaryentrynumbers} so that it
+doesn't display the \gls{numberlist}, but it still saves the
+\gls{numberlist} in case it's required.
+
+\begin{important}
+If you want to suppress the \gls{numberlist} always use the
+\pkgopt{nonumberlist} option instead of redefining
+\cs{glossaryentrynumbers} to do nothing.
\end{important}
+If you want to, for example, change the font for the entire
+\gls{numberlist} then redefine \cs{GlsXtrFormatLocationList} as
+appropriate. Don't modify \cs{glossaryentrynumbers}.
+
+Sometimes users like to insert \qt{page} or \qt{pages} in front of
+the \gls{numberlist}. This is quite fiddly to do with the base
+\styfmt{glossaries} package, but \styfmt{glossaries-extra}
+provides a way of doing this. First you need to enable this
+option and specify the text to display using:
+\begin{definition}[\DescribeMacro\GlsXtrEnablePreLocationTag]
+\cs{GlsXtrEnablePreLocationTag}\marg{page}\marg{pages}
+\end{definition}
+where \meta{page} is the text to display if the \gls{numberlist} only
+contains a single location and \meta{pages} is the text to display
+otherwise. For example:
+\begin{verbatim}
+\GlsXtrEnablePreLocationTag{Page: }{Pages: }
+\end{verbatim}
+An extra run is required when using this command.
+
+\begin{important}
+Use \texttt{glsignore} not \texttt{@gobble} as the format if you
+want to suppress the page number (and only index the entry once).
+\end{important}
+
+See the accompanying sample file \texttt{sample-pages.tex}.
+
+\subsection{The \styfmt{glossaries-extra-stylemods} Package}
+\label{sec:stylemods}
+
As from v1.02, \styfmt{glossaries-extra} now includes the package
\sty{glossaries-extra-stylemods} that will redefine the predefined
styles to include the post-description hook (for those that are
missing it). You will need to make sure the styles have already
-been defined before loading \sty{glossaries-extra}. For example:
+been defined before loading \styfmt{glossaries-extra}. For example:
\begin{verbatim}
\usepackage{glossaries-extra}
\usepackage{glossary-longragged}
@@ -1346,47 +1494,151 @@ that the modified \glostyle{inline} style isn't affected by the
\pkgopt{nopostdot} option, but the post-description category hook
can still be used.
-The \gls{numberlist} is now placed inside the argument of
-\begin{definition}[\DescribeMacro\GlsXtrFormatLocationList]
-\cs{GlsXtrFormatLocationList}\marg{number list}
+As from version 1.05, the \styfmt{glossaries-extra-stylemods}
+package provides some additional commands for use with the
+\glostyle{alttree} style to make it easier to modify.
+These commands are only defined if the
+\sty{glossary-tree} package has already been loaded, which is
+typically the case unless the \pkgopt{notree} option has been used
+when loading \styfmt{glossaries}.
+
+\begin{definition}[\DescribeMacro\eglssetwidest]
+\cs{eglssetwidest}\oarg{level}\marg{name}
\end{definition}
-This is internally used by \cs{glossaryentrynumbers}. The
-\pkgopt{nonumberlist} redefines \cs{glossaryentrynumbers} so that it
-doesn't display the \gls{numberlist}, but it still saves the
-\gls{numberlist} in case it's required.
+This is like \cs{glssetwidest} (provided by \sty{glossary-tree})
+but performs a protected expansion on \meta{name}. This has
+a localised effect. For a global setting, use
+\begin{definition}[\DescribeMacro\xglssetwidest]
+\cs{xglssetwidest}\oarg{level}\marg{name}
+\end{definition}
+The widest entry value can later be retrieved using
+\begin{definition}[\DescribeMacro\glsgetwidestname]
+\cs{glsgetwidestname}
+\end{definition}
+for the top-level entries and
+\begin{definition}[\DescribeMacro\glsgetwidestsubname]
+\cs{glsgetwidestsubname}\marg{level}
+\end{definition}
+for sub-entries, where \meta{level} is the level number.
-\begin{important}
-If you want to suppress the \gls{numberlist} always use the
-\pkgopt{nonumberlist} option instead of redefining
-\cs{glossaryentrynumbers} to do nothing.
-\end{important}
+The command \cs{glsfindwidesttoplevelname} provided by
+\sty{glossary-tree} has a CamelCase synonym:
+\begin{definition}[\DescribeMacro\glsFindWidestTopLevelName]
+\cs{glsFindWidestTopLevelName}\oarg{glossary list}
+\end{definition}
+Similar commands are also provided:
+\begin{definition}[\DescribeMacro\glsFindWidestUsedTopLevelName]
+\cs{glsFindWidestUsedTopLevelName}\oarg{glossary list}
+\end{definition}
+This has an additional check that the entry has been used.
+Naturally this is only useful if the glossaries that use
+the \glostyle{alttree} style occur at the end of the document.
+This command should be placed just before the start of the glossary.
+(Alternatively, place it at the end of the document and save
+the value in the auxiliary file for the next run.)
-If you want to, for example, change the font for the entire
-\gls{numberlist} then redefine \cs{GlsXtrFormatLocationList} as
-appropriate. Don't modify \cs{glossaryentrynumbers}.
+\begin{definition}[\DescribeMacro\glsFindWidestUsedAnyName]
+\cs{glsFindWidestUsedAnyName}\oarg{glossary list}
+\end{definition}
+This is like the previous command but if doesn't check the
+\gloskey{parent} key. This is useful if all levels should have the
+same width for the name.
-Sometimes users like to insert \qt{page} or \qt{pages} in front of
-the \gls{numberlist}. This is quite fiddly to do with the base
-\styfmt{glossaries} package, but \styfmt{glossaries-extra}
-provides a way of doing this. First you need to enable this
-option and specify the text to display using:
-\begin{definition}[\DescribeMacro\GlsXtrEnablePreLocationTag]
-\cs{GlsXtrEnablePreLocationTag}\marg{page}\marg{pages}
+\begin{definition}[\DescribeMacro\glsFindWidestAnyName]
+\cs{glsFindWidestAnyName}\oarg{glossary list}
\end{definition}
-where \meta{page} is the text to display if the \gls{numberlist} only
-contains a single location and \meta{pages} is the text to display
-otherwise. For example:
-\begin{verbatim}
-\GlsXtrEnablePreLocationTag{Page: }{Pages: }
-\end{verbatim}
-An extra run is required when using this command.
+This is like the previous command but doesn't check if the entry
+has been used.
-\begin{important}
-Use \texttt{glsignore} not \texttt{@gobble} as the format if you
-want to suppress the page number (and only index the entry once).
-\end{important}
+\begin{definition}[\DescribeMacro\glsFindWidestUsedLevelTwo]
+\cs{glsFindWidestUsedLevelTwo}\oarg{glossary list}
+\end{definition}
+This is like \cs{glsFindWidestUsedTopLevelName} but also sets
+the first two sub-levels as well. Any entry that has a
+great-grandparent is ignored.
-See the accompanying sample file \texttt{sample-pages.tex}.
+\begin{definition}[\DescribeMacro\glsFindWidestLevelTwo]
+\cs{glsFindWidestLevelTwo}\oarg{glossary list}
+\end{definition}
+This is like the previous command but doesn't check if the entry has
+been used.
+
+\begin{definition}[\DescribeMacro\glsFindWidestUsedAnyNameSymbol]
+\cs{glsFindWidestUsedAnyNameSymbol}\oarg{glossary
+list}\marg{register}
+\end{definition}
+This is like \cs{glsFindWidestUsedAnyName} but also measures the
+symbol. The length of the widest symbol is stored in
+\meta{register}.
+
+\begin{definition}[\DescribeMacro\glsFindWidestAnyNameSymbol]
+\cs{glsFindWidestAnyNameSymbol}\oarg{glossary list}\marg{register}
+\end{definition}
+This is like the previous command but it doesn't check if the entry
+has been used.
+
+\begin{definition}[\DescribeMacro\glsFindWidestUsedAnyNameSymbolLocation]
+\cs{glsFindWidestUsedAnyNameSymbolLocation}\oarg{glossary
+list}\marg{symbol register}\marg{location register}
+\end{definition}
+This is like \cs{glsFindWidestUsedAnyNameSymbol} but also
+measures the \gls{numberlist}. This requires
+\ics{glsentrynumberlist} (see the \styfmt{glossaries} user manual).
+The length of the widest symbol is stored in \meta{symbol register}
+and the length of the widest \gls*{numberlist} is stored in
+\meta{location register}.
+
+\begin{definition}[\DescribeMacro\glsFindWidestAnyNameSymbolLocation]
+\cs{glsFindWidestAnyNameSymbolLocation}\oarg{glossary
+list}\marg{symbol register}\marg{location register}
+\end{definition}
+This is like the previous command but it doesn't check if the entry
+has been used.
+
+\begin{definition}[\DescribeMacro\glsFindWidestUsedAnyNameLocation]
+\cs{glsFindWidestUsedAnyNameLocation}\oarg{glossary
+list}\marg{register}
+\end{definition}
+This is like \cs{glsFindWidestUsedAnyNameSymbolLocation} but doesn't
+measure the symbol. The length of the widest \gls{numberlist}
+is stored in \meta{register}.
+
+\begin{definition}[\DescribeMacro\glsFindWidestAnyNameLocation]
+\cs{glsFindWidestAnyNameLocation}\oarg{glossary
+list}\marg{register}
+\end{definition}
+This is like the previous command but doesn't check if the entry has
+been used.
+
+The layout of the symbol, description and \gls{numberlist}
+is governed by
+\begin{definition}[\DescribeMacro\glsxtralttreeSymbolDescLocation]
+\cs{glsxtralttreeSymbolDescLocation}\marg{label}\marg{number list}
+\end{definition}
+for top-level entries and
+\begin{definition}[\DescribeMacro\glsxtralttreeSubSymbolDescLocation]
+\cs{glsxtralttreeSubSymbolDescLocation}\marg{label}\marg{number list}
+\end{definition}
+for sub-entries.
+
+There is now a user level command that performs the initialisation
+for the \glostyle{alttree} style:
+\begin{definition}[\DescribeMacro\glsxtralttreeInit]
+\cs{glsxtralttreeInit}
+\end{definition}
+
+The paragraph indent for subsequent paragraphs in multi-paragraph
+descriptions is provided by the length
+\begin{definition}[\DescribeMacro\glsxtrAltTreeIndent]
+\cs{glsxtrAltTreeIndent}
+\end{definition}
+
+For additional commands that are available with the
+\glostyle{alttree} style, see the documented code
+(\texttt{glossaries-extra-code.pdf}). For examples, see
+the accompanying sample files \texttt{sample-alttree.tex},
+\texttt{sample-alttree-sym.tex} and
+\texttt{sample-alttree-marginpar.tex}.
\chapter{Abbreviations}
\label{sec:abbreviations}
@@ -1397,7 +1649,7 @@ initialisms (initial letters of a phrase, such as \qt{html}, that
aren't pronounced as words) and contractions (where
parts of words are omitted, often replaced by an apostrophe, such as
\qt{don't}).
-The \qt{acronym} code provided by the \sty{glossaries} package is
+The \qt{acronym} code provided by the \styfmt{glossaries} package is
misnamed as it's more often than not used for initialisms instead.
Acronyms tend not to be \emph{expanded} on \gls{firstuse} (although they may
need to be \emph{described} for readers unfamiliar with the term). They are therefore more like a regular term,
@@ -1428,11 +1680,11 @@ Make sure that you set the category attributes before defining new
abbreviations or they may not be correctly applied.
\end{important}
-The \ics{newacronym} command provided by the \sty{glossaries}
-package is redefined to use
+The \ics{newacronym} command provided by the \styfmt{glossaries}
+package is redefined by \styfmt{glossaries-extra} to use
\cs{newabbreviation} with the \gloskey{category} set to
\texttt{acronym}. If you want to restore the original behaviour of
-acronyms (as implemented by the \sty{glossaries} package's
+acronyms (as implemented by the \styfmt{glossaries} package's
\cs{newacronym}, \ics{setacronymstyle} and \ics{newacronymstyle})
you need to use
\begin{definition}[\DescribeMacro\RestoreAcronyms]
@@ -1442,14 +1694,16 @@ However, if you do this take care not to mix acronyms with other
types of entries within the same glossary. (You may also need to
redefine \ics{acronymtype}.)
+\begin{sloppypar}
The \cs{newabbreviation} command is superficially similar to the
-\sty{glossaries} package's \cs{newacronym} but you can apply
+\styfmt{glossaries} package's \cs{newacronym} but you can apply
different styles to different categories. The default style is
\abbrstyle{short-nolong} for entries in the \category{acronym} category and
\abbrstyle{short-long} for entries in the \category{abbreviation}
category. (These aren't the same as the acronym styles provided by
-the \sty{glossaries} package, although they may produce similar
+the \styfmt{glossaries} package, although they may produce similar
results.)
+\end{sloppypar}
The short form is displayed within commands like \cs{gls} using
\begin{definition}[\DescribeMacro\glsfirstabbrvfont]
@@ -1664,7 +1918,7 @@ Note that \ics{setacronymstyle} is disabled by
instead. The original acronym interface can be restored with
\cs{RestoreAcronyms} (see \sectionref{sec:acronymmods}).
-Abbreviations can be used with the standard \sty{glossaries}
+Abbreviations can be used with the standard \styfmt{glossaries}
commands, such as \ics{gls}, but don't use the acronym commands
like \ics{acrshort} (which use \ics{acronymfont}). The short form can be
produced with:
@@ -1874,7 +2128,7 @@ This just defined as
\begin{verbatim}
\newcommand*{\glsxtrscsuffix}{\glstextup{\glspluralsuffix}}
\end{verbatim}
-The \ics{glstextup} command is provided by \sty{glossaries}
+The \ics{glstextup} command is provided by \styfmt{glossaries}
and is used to switch off the small caps font for the suffix.
If you override the default short plural using the
\gloskey{shortplural} key when you define the abbreviation
@@ -2230,11 +2484,11 @@ This style was introduced in version 1.04. It's like the
\abbrstyle{long-short} style but additional information can be
inserted into the parenthetical material. This checks the value
of the field given by
-\begin{definition}[DescribeMacro\glsxtruserfield]
+\begin{definition}[\DescribeMacro\glsxtruserfield]
\cs{glsxtruserfield}
\end{definition}
(which defaults to \texttt{useri}) using \ics{ifglshasfield}
-(provided by \sty{glossaries}). If the field hasn't been set,
+(provided by \styfmt{glossaries}). If the field hasn't been set,
the style behaves like the \abbrstyle{long-short} style and
produces \meta{long} (\meta{short}) but if the field has been set,
the contents of that field are inserted within the parentheses in
@@ -2482,17 +2736,19 @@ New abbreviation styles may be defined using:
\begin{definition}[\DescribeMacro\newabbreviationstyle]
\cs{newabbreviationstyle}\marg{name}\marg{setup}\marg{fmts}
\end{definition}
+\begin{sloppypar}\noindent
where \meta{name} is the name of the new style (as used in the
mandatory argument of \ics{setabbreviationstyle}). This is similar
-but not identical to the \sty{glossaries} package's
+but not identical to the \styfmt{glossaries} package's
\ics{newacronymstyle} command.
+\end{sloppypar}
\begin{important}
You can't use styles defined by
\cs{newacronymstyle} with \styfmt{glossaries-extra} unless you have
-reverted \ics{newacronym} back to its generic definition from \sty{glossaries}
+reverted \ics{newacronym} back to its generic definition from \styfmt{glossaries}
(using \ics{RestoreAcronyms}). The acronym styles from the
-\sty{glossaries} package can't be used with abbreviations defined
+\styfmt{glossaries} package can't be used with abbreviations defined
with \cs{newabbreviation}.
\end{important}
@@ -2559,7 +2815,7 @@ not to switch styles for the same category.
You can access the short, long, short plural and long plural
values through the following token registers.
-Short value (defined by \sty{glossaries}):
+Short value (defined by \styfmt{glossaries}):
\begin{definition}[\DescribeMacro\glsshorttok]
\cs{glsshorttok}
\end{definition}
@@ -2572,7 +2828,7 @@ Short plural value (defined by \styfmt{glossaries-extra}):
through the \gloskey{shortplural} key in the optional argument
of \ics{newabbreviation}.)
-Long value (defined by \sty{glossaries}):
+Long value (defined by \styfmt{glossaries}):
\begin{definition}[\DescribeMacro\glslongtok]
\cs{glslongtok}
\end{definition}
@@ -2586,7 +2842,7 @@ through the \gloskey{longplural} key in the optional argument
of \ics{newabbreviation}.)
There are two other registers available that are defined by
-\sty{glossaries}:
+\styfmt{glossaries}:
\begin{definition}[\DescribeMacro\glslabeltok]
\cs{glslabeltok}
@@ -2782,7 +3038,7 @@ existing style are the \qt{em} styles, such as the
\chapter{Entries in Sectioning Titles, Headers, Captions and Contents}
\label{sec:headtitle}
-The \sty{glossaries} user manual cautions against using commands
+The \styfmt{glossaries} user manual cautions against using commands
like \cs{gls} in chapter or section titles. The principle problems
are:
\begin{itemize}
@@ -2806,8 +3062,8 @@ in the table of contents.
Similar problems can also occur with captions (except for the page
header and bookmark issues).
-To get around all these problems, the \sty{glossaries} user manual
-recommends using the expandable non-hyperlink commands, like
+To get around all these problems, the \styfmt{glossaries} user manual
+recommends using the expandable non-hyperlink commands, such as
\ics{glsentrytext} (for regular entries) or \ics{glsentryshort}
(for abbreviations). This is the simplest solution, but doesn't
allow for special formatting that's applied to the entry through
@@ -2843,13 +3099,12 @@ change, you can restore their former definitions using
\begin{definition}[\DescribeMacro\glsxtrRevertMarks]
\cs{glsxtrRevertMarks}
\end{definition}
-In this case, you'll have to use the \sty{glossaries} manual's
+In this case, you'll have to use the \styfmt{glossaries} manual's
recommendations of either simply using \cs{glsentryshort} (as above)
or use the sectioning command's option argument to provide an
alternative for the table of contents and page header. For example:
\begin{verbatim}
-\chapter[A Chapter about \glsentryshort{html}]{A Chapter about
-\gls{html}}
+\chapter[A Chapter about \glsentryshort{html}]{A Chapter about \gls{html}}
\end{verbatim}
If you don't revert the mark commands back with
@@ -3000,8 +3255,8 @@ and
\chapter{Categories}
\label{sec:categories}
-Each entry defined by \cs{newglossaryentry} (or commands that
-internally use \cs{newglossaryentry} such as \cs{newabbreviation})
+Each entry defined by \ics{newglossaryentry} (or commands that
+internally use it such as \ics{newabbreviation})
is assigned a category
through the \gloskey{category} key. You may add any category that
you like, but since the category is a label used in the creation
@@ -3163,7 +3418,7 @@ for categories that shouldn't have this facility enabled. The
value of this attribute is used by \ics{glsxtrifcounttrigger}
to determine how commands such as \ics{cgls} should behave.
-With \sty{glossaries}, commands like \cs{cgls} use \cs{cglsformat}
+With \styfmt{glossaries}, commands like \cs{cgls} use \cs{cglsformat}
only if the previous usage count for that entry was equal to~1.
With \styfmt{glossaries-extra} the test is now for entries that
have the \catattr{entrycount} attribute set and
@@ -3375,18 +3630,20 @@ for the \catattr{entrycount} attribute. This means that
you not only need to enable entry counting with
\ics{glsenableentrycount}, but you also need
to set the appropriate attribute (see \sectionref{sec:categories}).
-
-You may now use \ics{cgls} instead of \ics{gls} even if
-you haven't enabled entry counting. You will only get a warning
-if you use \cs{glsenableentrycount} without setting the
-\catattr{entrycount} attribute.
-(With \sty{glossaries}, commands like \ics{cgls} will generate
-a warning if \cs{glsenableentrycount} hasn't been used.)
-The abbreviation shortcut \ics{ab} uses \cs{cgls}
-(see \sectionref{sec:abbrshortcuts}) unlike the acronym shortcut
-\ics{ac} which uses \cs{gls}.
-
-All upper case versions (not provided by \sty{glossaries}) are
+Remember that entry counting only counts the number of times an
+entry is used by commands that change the \gls{firstuseflag}.
+
+With \styfmt{glossaries-extra}, you may use \ics{cgls} instead of
+\ics{gls} even if you haven't enabled entry counting. You will only
+get a warning if you use \cs{glsenableentrycount} without setting
+the \catattr{entrycount} attribute. (With \styfmt{glossaries},
+commands like \ics{cgls} will generate a warning if
+\cs{glsenableentrycount} hasn't been used.) The abbreviation
+shortcut \ics{ab} uses \cs{cgls} (see
+\sectionref{sec:abbrshortcuts}) unlike the acronym shortcut \ics{ac}
+which uses \cs{gls}.
+
+All upper case versions (not provided by \styfmt{glossaries}) are
also available:
\begin{definition}[\DescribeMacro\cGLS]
\cs{cGLS}\oarg{options}\marg{label}\oarg{insert}
@@ -3407,10 +3664,9 @@ and
which convert the analogous \cs{cglsformat} and
\cs{cglsplformat} to upper case.
-[TODO: work out what to do about other commands such
-as \verb|\glsdisp| and \verb|\glstext|.]
+%[TODO: work out what to do about \verb|\glsdisp|.]
-Just using \sty{glossaries}:
+Just using \styfmt{glossaries}:
\begin{verbatim}
\documentclass{article}
@@ -3722,6 +3978,7 @@ added to the index (as in this document).
There are two attributes that govern this: \catattr{indexname}
and \catattr{dualindex}.
+\begin{sloppypar}
The \ics{glsxtrpostnamehook} macro, used
at the end of \ics{glossentryname} and \ics{Glossentryname},
checks the \catattr{indexname} attribute for the category
@@ -3730,8 +3987,9 @@ Since \cs{glossentryname} is used in the default glossary
styles, this makes a convenient way of automatically indexing
each entry name at its location in the glossary without
fiddling around with the value of the \gloskey{name} key.
+\end{sloppypar}
-The internal macro used by the \sty{glossaries} package to
+The internal macro used by the \styfmt{glossaries} package to
write the information to the external glossary file is
modified to check for the \catattr{dualindex} attribute.
@@ -3825,7 +4083,7 @@ differently. If you want to use \cs{index} then just use
\cs{index}.
\end{important}
-The \sty{glossaries} package advises against defining entries
+The \styfmt{glossaries} package advises against defining entries
in the \env{document} environment. As mentioned in
\sectionref{sec:pkgopts} above, this ability is disabled by
default with \styfmt{glossaries-extra} but can be enabled using
@@ -3932,7 +4190,7 @@ to just text.
\chapter{Supplemental Packages}
\label{sec:supplemental}
-The \sty{glossaries} bundle provides additional support packages
+The \styfmt{glossaries} bundle provides additional support packages
\sty{glossaries-prefix} (for prefixing) and \sty{glossaries-accsupp}
(for accessibility support). These packages aren't automatically
loaded.
@@ -4167,7 +4425,7 @@ letter converted to upper case.
The following sample files are provided with this package:
\begin{description}
\item[sample.tex] Simple sample file that uses one of the dummy
-files provided by the \sty{glossaries} package for testing.
+files provided by the \styfmt{glossaries} package for testing.
\item[sample-mixture.tex] General entries, acronyms and initialisms
all treated differently.
@@ -4234,6 +4492,15 @@ to only have one hyperlink per entry per page.
\item[sample-altmodifier.tex] Set the default options for
commands like \cs{gls} and add an alternative modifier.
+\item[sample-alttree.tex] Uses the \sty{glossaries-extra-stylemods}
+package with the \glostyle{alttree} style (see \sectionref{sec:stylemods}).
+
+\item[sample-alttree-sym.tex] Another \glostyle{alttree} example
+that measures the symbol widths.
+
+\item[sample-alttree-marginpar.tex] Another \glostyle{alttree} example
+that puts the \gls{numberlist} in the margin.
+
\item[sample-onthefly.tex] Using on-the-fly commands. Terms with
accents must have the \gloskey{name} key explicitly set.
@@ -4267,7 +4534,7 @@ create the glossary labelled \texttt{abbreviations}. If this
command doesn't already exist, it will be defined to
\qt{Abbreviations} if \sty{babel} hasn't been loaded, otherwise
it will be defined as \cs{acronymname} (provided by
-\sty{glossaries}).
+\styfmt{glossaries}).
You can redefine it in the usual way. For example:
\begin{verbatim}