From 14ce8b68fe7df49e8a8891bb94c63b9a846da232 Mon Sep 17 00:00:00 2001
From: Norbert Preining
User Manual for glossaries.sty v4.42
+class="cmr-17">User Manual for glossaries.sty v4.43
2019-01-06http://www.dickimaw-books.com/
Earlier versions of Earlier versions of glossaries used this technique to write information to the files
used by the indexing applications to prevent problems caused by fragile commands.
Now, this is only used for the Requires
✔ Requires
✔ Requires
✘ Requires
✔ Can
✔ Efficient
✔ Can
✔ Any
✘‡ Are
✔ Can
✔ Can
✔¶ Maximum
∞ Requires
✘⋆ Default
makeindex’s quote character using:
- Translator
Key
Word Purpose Glossary Title
of
the
@@ -4659,9 +4661,9 @@ class="td10"> Title
style="vertical-align:baseline;" id="TBL-3-3-"> Acronyms Title
of
the
@@ -4680,11 +4682,11 @@ class="cmss-10">acronym Notation
(glossaries) Header
for
first
@@ -4706,11 +4708,11 @@ class="td10"> Header
style="vertical-align:baseline;" id="TBL-3-5-"> Description
(glossaries) Header
for
second
@@ -4732,11 +4734,11 @@ class="td10"> Header
style="vertical-align:baseline;" id="TBL-3-6-"> Symbol
(glossaries) Header
for
symbol
@@ -4755,13 +4757,13 @@ class="td10"> Header
style="vertical-align:baseline;" id="TBL-3-7-"> Page
List
(glossaries) Header
for
page
@@ -4780,11 +4782,11 @@ class="td10"> Header
style="vertical-align:baseline;" id="TBL-3-8-"> Symbols
(glossaries) Header
for
symbols
@@ -4803,11 +4805,11 @@ class="td10"> Header
style="vertical-align:baseline;" id="TBL-3-9-"> Numbers
(glossaries) Header
for
numbers
@@ -6320,7 +6322,7 @@ information can be gathered by a front-end, editor or script to make the glossar
appropriate. This section describes how the information is stored in the auxiliary
file.
The file extensions used by each defined glossary are given by
-
The indexing application’s style file is specified by
- Word or letter ordering is specified by:
- If you’re sure that your locations will always expand to an acceptable format (or you’re
+ prepared to post-process the glossary file before passing it to the relevant indexing
+ application) then use esclocations=false to avoid the complex escaping of location values.
+ (See “Writing information to associated files” in the documented code for further
+ details.)
+
- You can also reduce the number of write registers by using Options
+
+
+ You can also reduce the number of write registers by using Options 1 or 4 or by
ensuring you define all your glossary entries in the preamble.
-
+
In general, this package option is best avoided.
+ id="dx1-23082">.
If If translate is specified without a value, is specified without a value, translate=true is assumed. If is assumed. If translate isn’t
+ id="dx1-23085"> isn’t
specified, translate=true is assumed if is assumed if babel, , polyglossia or or translator have been loaded.
+ id="dx1-23089"> have been loaded.
Otherwise translate=false is assumed.
- See §1.4.1 Changing the Fixed Names for further details.
@@ -6995,23 +7039,23 @@ href="#sec:fixednames">Changing the Fixed Names The values must be fully expanded, so The values must be fully expanded, so don’t try nohypertypes=\acronymtype. You
+ id="dx1-23095">. You
may also use
-
+
instead or additionally. See §6 Links to Glossary Entries for further details.
The ).
+ The hyperfirst setting applies to all glossary types (unless identified by setting applies to all glossary types (unless identified by nohypertypes or
+ id="dx1-23108"> or
defined with \newignoredglossary). It can be overridden on an individual basis by
+ id="dx1-23109">). It can be overridden on an individual basis by
explicitly setting the hyper key when referencing an entry (or by using the plus or
+ id="dx1-23110"> key when referencing an entry (or by using the plus or
starred version of the referencing command).
- It may be that you only want to apply this to just the acronyms (where the first use
+ It may be that you only want to apply this to just the acronyms (where the first use
explains the meaning of the acronym) but not for ordinary glossary entries (where the
first use is identical to subsequent uses). In this case, you can use hyperfirst=false
+ id="dx1-23111">
and apply \glsunsetall to all the regular (non-acronym) glossaries. For
example:
@@ -7104,32 +7148,32 @@ class="cmtt-10">\glsunsetall
- Alternatively you can redefine the hook
-
+ Alternatively you can redefine the hook
+
+
which is used by the commands that check the first use flag, such as \gls. Within the
+ id="dx1-23113">. Within the
definition of this command, you can use \glslabel to reference the entry label and
+ id="dx1-23114"> to reference the entry label and
\glstype to reference the glossary type. You can also use to reference the glossary type. You can also use \ifglsused to determine if
+ id="dx1-23116"> to determine if
the entry has been used. You can test if an entry is an acronym by checking if it has the
long key set using key set using \ifglshaslong. For example, to switch off the hyperlink on first use
+ id="dx1-23118">. For example, to switch off the hyperlink on first use
just for acronyms:
@@ -7142,14 +7186,14 @@ class="cmtt-10">\ifglshaslong }%
- Note that this hook isn’t used by the commands that don’t check the
+ Note that this hook isn’t used by the commands that don’t check the first use flag, such
as \glstext. (You can, instead, redefine You can customise this by redefining
- You can customise this by redefining
+
+
where ⟨label⟩ is the entry’s label and ⟨wr-code⟩ is the code that writes the entry’s
@@ -7206,16 +7250,16 @@ class="cmtt-10">\glswriteentry This checks the This checks the indexonlyfirst package option (using package option (using \ifglsindexonlyfirst) and does
⟨wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry hasn’t been
used.
- For example, suppose you only want to index the first use for entries in the For example, suppose you only want to index the first use for entries in the acronym
glossary and not in the main (or any other) glossary:
@@ -7229,64 +7273,64 @@ class="cmtt-10">main Here I’ve used Here I’ve used \ifthenelse to ensure the arguments of \equal are fully expanded
before the comparison is made.
+
+
and
-
+
You can omit the value if you want to use sections, i.e.
+ You can omit the value if you want to use sections, i.e.
is equivalent to
+ is equivalent to
You can change this value later in the document using
- You can change this value later in the document using
+
+
where ⟨name⟩ is the sectional unit.
- The start of each glossary adds information to the page header via
- The start of each glossary adds information to the page header via
+
+ or to prevent it from changing the headers:
+ or to prevent it from changing the headers:
If you want If you want \glsglossarymark to use \MakeUppercase in the header, use the ucmark
option described below.
- Occasionally you may find that another package defines Occasionally you may find that another package defines \cleardoublepage when it is
not required. This may cause an unwanted blank page to appear before each glossary.
- This can be fixed by redefining \glsclearpage \glsclearpage:
+
+
For example:
@@ -7439,7 +7483,7 @@ class="cmtt-10">\fi If If memoir has been loaded and ucfirst\memUChead
+
where ⟨type⟩ is the label identifying that glossary. The default value of
glossaries using:
\usepackage[section,numberedsection=autolabel]
then each glossary will appear in a numbered section, and can be referenced using
+ then each glossary will appear in a numbered section, and can be referenced using
something like:
@@ -7512,7 +7556,7 @@ class="cmss-10">glossaries using:
The main glossary is in section~\ref{main} and
If you can’t decide whether to have the acronyms in the main glossary or a
+ If you can’t decide whether to have the acronyms in the main glossary or a
separate list of acronyms, you can use \acronymtype which is set to acronym
The list of acronyms is in section~\ref{\acronymtype}.
You can redefine the prefix if the default label clashes with another label in your
+ You can redefine the prefix if the default label clashes with another label in your
document. For example:
@@ -7538,7 +7582,7 @@ class="cmss-10">acronym will add will add glo: to the automatically generated label, so you can then, for example,
refer to the list of acronyms as follows:
@@ -7548,7 +7592,7 @@ class="cmtt-10">glo: Or, if you are undecided on a prefix:
+ Or, if you are undecided on a prefix:
+
Now Now \nameref{main} will display the (TOC) section title associated with the
main glossary. As above, you can redefine \glsautoprefix to provide a prefix for
the label.
+
If you use this option, you can reference the entry number within the document
+ If you use this option, you can reference the entry number within the document
using
-
+
where ⟨label⟩ is the label associated with that glossary entry. The labelling
systems uses ⟨label⟩, where ⟨label⟩ is the entry’s label and ⟨prefix⟩ is given
by
-
+
(which defaults to glsentry-).
-
+
- If you want the counter reset at the start of each glossary, you can redefine
+
+ If you want the counter reset at the start of each glossary, you can redefine
\glossarypreamble to use
-
+
which sets glossaryentry to zero:
@@ -7692,7 +7736,7 @@ class="cmss-10">glossaryentry or if you are using or if you are using \setglossarypreamble, add it to each glossary preamble, as
required. For example:
@@ -7709,17 +7753,17 @@ class="cmtt-10">\setglossarypreamble
+
+
(See §15 Glossary Styles for further details.)
- If you’re sure that your locations will always expand to an acceptable format (or you’re
- prepared to post-process the glossary file before passing it to the relevant indexing
- application) then use esclocations=false to avoid the complex escaping of location values.
- (See “Writing information to associated files” in the documented code for further
- details.)
+
where ⟨sort cs⟩ is a temporary control sequence that stores the sort value (which was
@@ -8187,7 +8191,7 @@ class="cmtt-10">xindy
It will also define
-
You can use
-
You can determine if a glossary has been identified as being a list of acronyms
using:
-
Other available options that don’t fit any of the above categories are:
It also defines
- It also defines
- It also defines
- Some of the options described above may also be set after the glossaries package has been
loaded using
- The command
- The command
- If you use Option 3, you can have a different compositor for page numbers starting with
an upper case alphabetical character using:
- New glossary entries are defined using the command:
- If you have a long description that needs to span multiple paragraphs, use
- There are also commands that will only define the entry if it hasn’t already been
defined:
-
and
- You may have noticed from above that you can specify the plural form when you define a
term. If you omit this, the plural will be obtained by appending
-
and
- You can store all your glossary entry definitions in another file and use:
- Example 7 (Loading Entries from Another File)terms.tex As from version 3.02, you can move an entry from one glossary to another using:
-
- There is a predefined handler that’s used to display the number list in the glossary:
-
If you want the ⟨code⟩ to write any information to the file, you need to use
- The way the link text is displayed depends on
- There are two upper case variants:
-
and
- There are plural forms that are analogous to \gls:
-
-
-
-
- There are also analogous commands:
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
- There are also analogous uppercasing commands:
-
-
This may be redefined but if you only want the change the display style for a given glossary,
then you need to use
- Option 5
✔
✘
✘
✘
N/A
N/A
N/A
✔
✘
∞
✘
✔⁑
Command Name Command Name Word
class="cmtt-10">\glssetexpandfield or
\glssetnoexpandfield are governed by
-\glossaryname Glossary \acronymname Acronyms \entryname (glossaries) \descriptionname (glossaries) \symbolname (glossaries) \pagelistname (glossaries) \glssymbolsgroupname (glossaries) \glsnumbersgroupname (glossaries)
debug=showtargets option will additionally
use
- General Options
-t \jobname.glg -o \jobname.gls \jobname}
\let\glswritefiles\relax
-
-
% at the end of the preamble
\glsunsetall[main]
-
}
-
\fi
}
{#2}%
}
2.2 Sectioning, Headings and TOC Options
-
-
-
-
-
\markright{#1}%
\fi}
-
{glossaries}
the list of acronyms is in section~\ref{acronym}.
section~\ref{glo:\acronymtype}.
section~\ref{\glsautoprefix\acronymtype}.
2.3 Glossary Appearance Options
-
-
-
}
}
-
\setglossarystyle{mcoltree}
Sorting Options
+
+
. This is equivalent
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
Acronym Options
{Statistical Acronyms}
and
- 3.1 Option 1
3.2 Options 2 and 3
description={\nopostdesc}. If you want a paragraph break in the description
use
- Plurals
4.6 Loading Entries From a File
4.7 Moving Entries to Another Glossary
\writeist before the file is
closed. You can set the code to be performed then using:
-