From 5ed74e52078fd4969d9d48a906b911b9e34aad27 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 6 Jan 2019 22:03:35 +0000 Subject: glossaries (6jan19) git-svn-id: svn://tug.org/texlive/trunk@49618 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 17 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 1189043 -> 1195352 bytes .../doc/latex/glossaries/glossaries-user.html | 6618 ++++++++++---------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 890942 -> 893233 bytes .../doc/latex/glossaries/glossaries-user.tex | 56 +- .../doc/latex/glossaries/glossariesbegin.html | 4 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 186467 -> 186454 bytes .../doc/latex/glossaries/glossariesbegin.tex | 4 +- .../doc/latex/glossaries/glossary2glossaries.html | 2 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 143144 -> 143132 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 248680 -> 248669 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49969 -> 49958 bytes .../doc/latex/glossaries/samples/mwe-acr-desc.pdf | Bin 37969 -> 37957 bytes .../doc/latex/glossaries/samples/mwe-acr.pdf | Bin 33661 -> 33649 bytes .../doc/latex/glossaries/samples/mwe-gls.pdf | Bin 29951 -> 29939 bytes .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58829 -> 58817 bytes .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 54834 -> 54822 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53468 -> 53456 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82197 -> 82185 bytes .../latex/glossaries/samples/sample-dot-abbr.pdf | Bin 52806 -> 52796 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36467 -> 36455 bytes .../latex/glossaries/samples/sample-entrycount.pdf | Bin 36851 -> 36839 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 34916 -> 34904 bytes .../latex/glossaries/samples/sample-font-abbr.pdf | Bin 50715 -> 50703 bytes .../latex/glossaries/samples/sample-ignored.pdf | Bin 31821 -> 31810 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 43388 -> 43379 bytes .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 146996 -> 147381 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 38866 -> 38855 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 39209 -> 39198 bytes .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 96013 -> 96000 bytes .../latex/glossaries/samples/sample-noidxapp.pdf | Bin 67092 -> 67077 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 41759 -> 41745 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 41990 -> 41979 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 43273 -> 43259 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 21722 -> 21710 bytes .../samples/sample-storage-abbr-desc.pdf | Bin 39905 -> 39892 bytes .../glossaries/samples/sample-storage-abbr.pdf | Bin 37671 -> 37659 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 103884 -> 104265 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43333 -> 43320 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 65517 -> 65506 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 65625 -> 65613 bytes .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 93623 -> 93612 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47055 -> 47043 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48407 -> 48396 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155767 -> 155760 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169230 -> 169225 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91355 -> 91343 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98622 -> 99000 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 47470 -> 47459 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65680 -> 65669 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 95008 -> 95383 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41167 -> 41155 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 37213 -> 37201 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 66925 -> 66912 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44951 -> 44939 bytes .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 133786 -> 133968 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 68412 -> 68399 bytes .../doc/latex/glossaries/samples/samplexdy3.pdf | Bin 178829 -> 178997 bytes 60 files changed, 3411 insertions(+), 3296 deletions(-) (limited to 'Master/texmf-dist/doc/latex') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index ce2d02c15b1..fb9bc0861aa 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,22 @@ glossaries change log: +v4.42 (2019-01-06): + + * glossaries.sty: + + - changed \edef to \protected@csedef in \glsfieldedef + + - changed \xdef to \protected@csxdef in \glsfieldxdef + + - added package option 'noglossaryindex' to counteract 'index' + (if 'index' happens to be supplied as a global option) + + - automake option now takes 'immediate' as a value. + + * glossary-longbooktabs.sty: + + - removed superfluous \glspatchLToutput + v4.41 (2018-07-23): * glossaries.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 96b344a9582..4f0e0ea8e5a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ b/Master/texmf-dist/doc/latex/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v4.41 +LaTeX Package : glossaries v4.42 -Last Modified : 2018-07-23 +Last Modified : 2019-01-06 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf index 1e9003ea886..4401858727e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index 12696ebe9a0..df8866e01c8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -309,7 +309,7 @@ span#textcolor62{color:#00FF00} >

User Manual for glossaries.sty v4.41 +class="cmr-17">User Manual for glossaries.sty v4.42

http://www.dickimaw-books.com/

2018-07-23

+class="cmr-12">2019-01-06

@@ -482,7 +482,7 @@ class="cmtt-10">glossaries-code.pdf
Advanced users wishing to know more about the inner workings of all the packages provided in the glossaries bundle should read “Documented - Code for glossaries v4.41”. + Code for glossaries v4.42”.
INSTALL
xindy={glsnumbers=false} and may id="pkgopt:automake">automake
This is a boolean option (new to version 4.08) that will attempt to run This is option was introduced to version 4.08 as a boolean option. As from version + 4.42 it may now take three values: false (default), true or immediate. If no option is + supplied, immediate is assumed. The option automake=true will attempt to run + makeindex - or or xindy using T using TEX’s \write18 mechanism at the end of the document. Since this - mechanism can be a security risk, some TEX distributions disable it completely, in - which case this option won’t have an effect. (If this option doesn’t appear to work, - search the log file for “runsystem” and see if it is followed by “enabled” or + id="dx1-26081"> mechanism at the end of the document. + The option automake=immediate will attempt to run makeindex or xindy at the start + of \makeglossaries using \immediate (before the glossary files have been + opened). +

In the case of automake=true, the associated files are created at the end of the + document ready for the next LATEX run. Since there is a possibility of commands such + as \gls occurring on the last page of the document, it’s not possible to use \immediate + to close the associated file or with \write18 since the writing of the final + indexing lines may have been delayed. In certain situations this can mean that + the \write18 fails. In such cases, you will need to use automake=immediate + instead. +

With automake=immediate, you will get a warning on the first LATEX run as the + associated glossary files don’t exist yet. +

Since this mechanism can be a security risk, some TEX distributions disable it + completely, in which case this option won’t have an effect. (If this option doesn’t appear + to work, search the log file for “runsystem” and see if it is followed by “enabled” or “disabled”.) -

Some distributions allow

Some distributions allow \write18 in a restricted mode. This mode has a limited number of trusted applications, which usually includes makeindex but may not include + id="dx1-26089"> but may not include xindy. So if you have the restricted mode on, . So if you have the restricted mode on, automake should work with should work with makeindex + id="dx1-26092"> but may not work with xindy. -

However even in unrestricted mode this option may not work with . + + +

However even in unrestricted mode this option may not work with xindy as as xindy uses + id="dx1-26095"> uses language names that don’t always correspond with \babel’s language names. (The + id="dx1-26096">’s language names. (The makeglossaries script applies mappings to assist you.) Note that you still need + id="dx1-26097"> script applies mappings to assist you.) Note that you still need at least two LATEX runs to ensure the document is up-to-date with this setting. -

Since this package option attempts to run the

Since this package option attempts to run the indexing application on every LATEX run, its use should be considered a last resort for those who can’t work out how to incorporate the indexing application into their document build. The default value for this option is automake=false. + id="dx1-26098">.

- - -

+

-

Top

2.5 Acronym Options

@@ -8644,15 +8687,15 @@ class="cmtt-10">acronym. This is equivalent
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-

It will also define -

It will also define +

\printacronyms  \printacronyms[⟨options⟩]
-

+

that’s equivalent to

] package option compatible-3.07 is used). -

If you are using

If you are using Option 1, you need to use

options⟩]
to display the list of acronyms. -

If the

If the acronym package option is used, \acronymtype\newacronym\acronymtype, unless another glossary is explicitly specified. -

Remember to use the

Remember to use the nomain package option if you’re only interested in using this acronym glossary. (That is, you don’t intend to use the main glossary.)
-

+

main glossary to also contain a list of acronyms,
\usepackage[acronym,acronymlists={main}]{glossaries}
-

No check is performed to determine if the listed glossaries exist, so you can add +

No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined yet. For example: @@ -8742,32 +8785,32 @@ class="cmtt-10">main glossary to also contain a list of acronyms,  
\newglossary[alg2]{acronym2}{acr2}{acn2}%  
  {Statistical Acronyms}

-

You can use -

You can use +

\DeclareAcronymList  \DeclareAcronymList{⟨list⟩}
-

+

instead of or in addition to the acronymlists option. This will add the glossaries given in ⟨list⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list use: -

\SetAcronymLists  \SetAcronymLists{⟨list⟩}
-

-

You can determine if a glossary has been identified as being a list of acronyms +

+

You can determine if a glossary has been identified as being a list of acronyms using: -

\glsIfListOfAcronyms  }{⟨false part⟩}
-

+

§13 Acronyms and Other Abbreviations for further details. Alternatively you can use: -

\DefineAcronymSynonyms  \DefineAcronymSynonyms
-

+

-

+

-

Top

2.5.1 Deprecated Acronym Style Options

-

The package options listed in this section are now deprecated but are kept for +

The package options listed in this section are now deprecated but are kept for backward-compatibility. Use \setacronymstyle instead. See \newacronym \setacronymstyle{long-short-desc}

-

or (with

or (with smallcaps) @@ -8833,7 +8876,7 @@ class="cmss-10">smallcaps \setacronymstyle{long-sc-short-desc}

-

or (with

or (with smaller) @@ -8842,7 +8885,7 @@ class="cmss-10">smaller \setacronymstyle{long-sm-short-desc}

-

or (with

or (with footnote) @@ -8851,7 +8894,7 @@ class="cmss-10">footnote \setacronymstyle{footnote-desc}

-

or (with

or (with footnote and smallcapssmallcaps \setacronymstyle{footnote-sc-desc} -

or (with

or (with footnote and smallersmaller \setacronymstyle{footnote-sm-desc} -

or (with

or (with dua) @@ -8882,7 +8925,7 @@ class="cmss-10">dua \setacronymstyle{dua-desc} -

+

\newacronym \setacronymstyle{long-sc-short} -

or (with

or (with description) @@ -8906,7 +8949,7 @@ class="cmss-10">description \setacronymstyle{long-sc-short-desc} -

or (with

or (with description and footnotefootnote \setacronymstyle{footnote-sc-desc} -

+

This option changes the definition of \newacronym and the way that acronyms are displayed. -

If you use this option, you will need to include the

If you use this option, you will need to include the relsize package or otherwise define \textsmaller or redefine \acronymfont.
-

+

This option may be replaced by: @@ -8943,7 +8986,7 @@ class="cmtt-10">\acronymfont \setacronymstyle{long-sm-short}

-

or (with

or (with description) @@ -8952,7 +8995,7 @@ class="cmss-10">description \setacronymstyle{long-sm-short-desc} -

or (with

or (with description and footnotefootnote \setacronymstyle{footnote-sm-desc} -

+

\newacronym \setacronymstyle{footnote} -

or (with

or (with smallcaps) @@ -8987,7 +9030,7 @@ class="cmss-10">smallcaps \setacronymstyle{footnote-sc} -

or (with

or (with smaller) @@ -8996,7 +9039,7 @@ class="cmss-10">smaller \setacronymstyle{footnote-sm} -

or (with

or (with description) @@ -9005,7 +9048,7 @@ class="cmss-10">description \setacronymstyle{footnote-desc} -

or (with

or (with smallcaps and descriptiondescription \setacronymstyle{footnote-sc-desc} -

or (with

or (with smaller and descriptiondescription \setacronymstyle{footnote-sm-desc} -

+

\newacronym \setacronymstyle{dua} -

or (with

or (with description) @@ -9051,15 +9094,15 @@ class="cmss-10">description \setacronymstyle{dua-desc} -

+

-

+

-

Top

2.6 Other Options

-

Other available options that don’t fit any of the above categories are: +

Other available options that don’t fit any of the above categories are:

symbols via
\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-

It also defines -

It also defines +

\printsymbols  \printsymbols[⟨options⟩]
-

+

which is a synonym for

options⟩]
-

If you use

If you use Option 1, you need to use:

options⟩]
to display the list of symbols. -

Remember to use the

Remember to use the nomain package option if you’re only interested in using this symbols glossary and don’t intend to use the main glossary.
-

-

The

+

The glossaries-extra package has a slightly modified version of this option which additionally provides \glsxtrnewsymbolnumbers via

-

It also defines -

It also defines +

\printnumbers  \printnumbers[⟨options⟩]
-

+

which is a synonym for

options⟩]
-

If you use

If you use Option 1, you need to use:

options⟩]
to display the list of numbers. -

Remember to use the

Remember to use the nomain package option if you’re only interested in using this numbers glossary and don’t intend to use the main glossary.
-

-

The

+

The glossaries-extra package has a slightly modified version of this option which additionally provides \glsxtrnewnumberindex via

-

It also defines -

It also defines +

\newterm  options⟩]{⟨term⟩}
-

+

which is a synonym for

options⟩]
and -

\printindex  \printindex[⟨options⟩]
-

+

which is a synonym for

options⟩]
-

If you use

If you use Option 1, you need to use:

options⟩]
to display this glossary. -

Remember to use the

Remember to use the nomain package option if you’re only interested in using this glossaries without the index package option.)
-

+

-

Since the index isn’t designed for terms with descriptions, you might also want to +

Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for this glossary using the package option nohypertypes=index or @@ -9277,34 +9320,47 @@ class="cmtt-10">\GlsDeclareNoHyperList{index}
-

The example file

The example file sample-index.tex illustrates the use of the index package option.

+noglossaryindex
This option switches off index if index has been passed implicitly (for + example, through global document options). This option can’t be used in + \setupglossaries. +
compatible-2.07
Compatibility mode for old documents created using version 2.07 or below.
compatible-3.07
Compatibility mode for old documents created using version 3.07 or below.
kernelglossredefs
As a legacy from the precursor glossary package, the standard glossary + id="dx1-29035"> package, the standard glossary commands provided by the LATEX kernel (\makeglossary and glossaries package’s commands. However, they were n href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”) explicitly discourages their use. -

The use of those kernel commands (instead of the appropriate commands documented +

The use of those kernel commands (instead of the appropriate commands documented in this user guide) are deprecated, and you will now get a warning if you try using them. -

In the event that you require the original form of these kernel commands, +

In the event that you require the original form of these kernel commands, for example, if you need to use the glossaries package with another class or package that also performs glossary-style indexing, then you can restore these @@ -9326,68 +9382,68 @@ class="cmss-10">glossaries package with another class or glossaries package) with the package option kernelglossredefs=false. You may + id="dx1-29036">. You may also need to use the nomain option in the event of file extension conflicts. (In + id="dx1-29037"> option in the event of file extension conflicts. (In which case, you must provide a new default glossary for use with the glossaries + id="dx1-29038"> package.) -

This option may take one of three values:

This option may take one of three values: true (redefine with warnings, default), false (restore previous definitions) or nowarn (redefine without warnings, not recommended). -

Note that the only glossary-related commands provided by the LAT

Note that the only glossary-related commands provided by the LATEX kernel are \makeglossary and \glossary. Other packages or classes may provide additional + + glossary-related commands or environments that conflict with glossaries (such as \printglossary and theglossary). These non-kernel commands aren’t affected by this + id="dx1-29039">). These non-kernel commands aren’t affected by this package option, and you will have to find some way to resolve the conflict if you require both glossary mechanisms. (The glossaries package will override the existing definitions + id="dx1-29041"> package will override the existing definitions of \printglossary and theglossary.) - - -

In general, if possible, it’s best to stick with just one package that provides a glossary + id="dx1-29042">.) +

In general, if possible, it’s best to stick with just one package that provides a glossary mechanism. (The glossaries package does check for the doc package and patches + id="dx1-29044"> package and patches \PrintChanges.)

-

+

-

Top

2.7 Setting Options After the Package is Loaded

-

Some of the options described above may also be set after the

Some of the options described above may also be set after the glossaries package has been loaded using -

\setupglossaries  \setupglossaries{⟨key-val list⟩}
-

+

The following package options can’t be used in \setupglossaries: \GlsSetXdyLanguage§11 Xindy (Option 3) for further details). -

If you need to use this command, use it as soon as possible after loading

If you need to use this command, use it as soon as possible after loading glossaries otherwise you might end up using it too late for the change to take effect. For example, if you try changing the acronym styles (such as smallcaps -

+

-

-

+

Top

3. Setting Up

-

In the preamble you need to indicate whether you want to use

In the preamble you need to indicate whether you want to use Option 1, Option 2 or bib2glsglossaries-extra manuals.)

-

Top

3.1 Option 1

-

The command -

The command +

\makenoidxglossaries  \makenoidxglossaries
-

+

must be placed in the preamble. This sets up the internal commands required to make Option 1 work. \makenoidxglossaries none of the glossaries will be displayed. -

+

-

Top

3.2 Options 2 and 3

-

The command -

The command +

\makeglossaries  \makeglossaries
-

+

must be placed in the preamble in order to create the customised makeindex\makeglossaries none of the glossary files will be created. -

Note that some of the commands provided by the

Note that some of the commands provided by the glossaries package must not be used after \makeglossaries as they are required when creating the customised style file. If you attempt to use those commands after \makeglossaries you will generate an error. -

Similarly, there are some commands that must not be used before

Similarly, there are some commands that must not be used before \makeglossaries.

-

-

You can suppress the creation of the customised

+

You can suppress the creation of the customised xindy or makeindex style file using -

\noist  \noist
-

+

That this command must not be used after \makeglossaries. -

Note that if you have a custom

Note that if you have a custom .xdy file created when using glossaries version 2.07 or below, you will need to use the compatible-2.07 package option with it.
-

+

-

The default name for the customised style file is given by

The default name for the customised style file is given by \jobname.ist\jobname.xdy (Option 3). This name may be changed using: -

\setStyleFile  \setStyleFile{⟨name⟩}
-

+

where ⟨name⟩ is the name of the style file without the extension. Note that this command must not be used after \makeglossaries. -

Each glossary entry is assigned a

Each glossary entry is assigned a 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 @@ -9583,14 +9639,14 @@ class="cmss-10">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 -

\glsSetCompositor  \glsSetCompositor{⟨symbol⟩}
-

+

For example: @@ -9598,19 +9654,19 @@ For example:

\glsSetCompositor{-}
-

This command must not be used after

This command must not be used after \makeglossaries. -

If you use

If you use Option 3, you can have a different compositor for page numbers starting with an upper case alphabetical character using: -

\glsSetAlphaCompositor  \glsSetAlphaCompositor{⟨symbol⟩}
-

+

This command has no effect if you use Option 2. For example, if you want number list \glsSetCompositor{.}\glsSetAlphaCompositor{-}

-

See

See §5 Number lists for further information about number list -

-

+

Top

4. Defining Glossary Entries

-

All glossary entries must be defined before they are used, so it is better to define them in +

All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this. In fact, some commands such as \longnewglossaryentry may only be used in the preamble. See §4.8 Drawbacks With Defining Entries in the Document Environment.) -

Option 1 enforces the preamble-only restriction on \newglossaryentry. glossaries-extra package option docdef=restricted.
-

-

Only those entries that are indexed in the document (using any of the commands +

+

Only those entries that are indexed in the document (using any of the commands described in §6 §10 Displaying a glossary to find out how to display the glossary. -

New glossary entries are defined using the command: -

New glossary entries are defined using the command: +

\newglossaryentry  label⟩}{⟨key=value list⟩}
-

+

This is a short command, so values in ⟨key-val list⟩ can’t contain any paragraph breaks. Take care to enclose values containing any commas (,) or equal signs (=) with braces to hide them from the key=value list parser. Be careful to ensure that no spurious spaces are included at the start and end of the braces. -

If you have a long description that needs to span multiple paragraphs, use -

If you have a long description that needs to span multiple paragraphs, use +

\longnewglossaryentry  long description⟩}
-

+

instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \longnewglossaryentry will remove trailing spaces in the description (via \longnewglossaryentry that doesn’t append either \unskip or \nopostdesc. -

There are also commands that will only define the entry if it hasn’t already been +

There are also commands that will only define the entry if it hasn’t already been defined: -

\provideglossaryentry  }{⟨key=value list⟩}
-

+

and -

\longprovideglossaryentry  } class="cmtt-10">{⟨long description⟩}
-

+

(These are both preamble-only commands.) -

For all the above commands, the first argument, ⟨

For all the above commands, the first argument, ⟨label⟩, must be a unique label with which to identify this entry. This can’t contain any non-expandable commands @@ -9772,7 +9828,7 @@ construct internal commands that store the associated information (similarly to commands like \label) and therefore must be able to expand to a valid control sequence name. -

Note that although an

Note that although an extended Latin character or other non-Latin characterbabel: or -) to active characters.
-

-

The second argument, ⟨

+

The second argument, ⟨key=value list⟩, is a ⟨key⟩=⟨value⟩ list that supplies the relevant @@ -9835,39 +9891,39 @@ class="description">The name of the entry (as it will appear in the glossary). I and the parent key is supplied, this value will be the same as the parent’s name. -

If the

If the name key contains any commands, you must also use the sort key (described below) if you intend sorting the entries alphabetically, otherwise the entries can’t be sorted correctly.
-

+

description
A brief description of this term (to appear in the glossary). Within this value, you can use -

\nopostdesc  \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 description={\nopostdesc}. If you want a paragraph break in the description use -

\glspar  \glspar
-

+

or, better, use \longnewglossaryentry. However, note that not all glossary styles support multi-line descriptions. If you are using one of the tabular-like glossary styles @@ -9983,7 +10039,7 @@ class="cmss-10">firstplural\glspl. -

Note: prior to version 1.13, the default value of firstplural was always taken by @@ -10053,7 +10109,7 @@ class="cmtt-10">\glsprestandardsort§2.4 Sorting Options). -

Option 1 by default strips the standard LATEX accents (that is, accents generated by @@ -10074,7 +10130,7 @@ href="#option1">Option 1:  
  description={select group of people}  
}

-

This is equivalent to: +

This is equivalent to:

@@ -10085,7 +10141,7 @@ href="#option1">Option 1:  
  sort={elite}  
}
-

Unless you use the package option

Unless you use the package option sanitizesort=true, in which case it’s equivalent to: @@ -10099,9 +10155,9 @@ class="cmss-10">sanitizesort=true  sort={\'elite}  
}

-

This will place the entry before the “A” letter group since the sort value starts with a +

This will place the entry before the “A” letter group since the sort value starts with a symbol. -

Similarly if you use the

Similarly if you use the inputenc package:

@@ -10188,7 +10244,7 @@ class="cmtt-10">}
Again, this will place the entry before the “A” group. -

With Options 

With Options 2 and 3, the default value of sortnamesanitizesort=false). -

Take care with

Take care with xindy (name={\alpha}). -

Take care if you use

Take care if you use Option 1 and the name contains fragile commands. You will either @@ -10237,7 +10293,7 @@ class="cmss-10">sanitizesort=truedef or use sort methods).

-

+

type§8 Cross-Referencing Entries. -

This key essentially provides a convenient shortcut that performs

+

This key essentially provides a convenient shortcut that performs

\glssee[⟨}
after the entry has been defined. -

For Options 

For Options 2 and 3, \makeglossariesseedocument environment.
-

+

Since it’s useful to suppress the indexing while working on a draft document, consider using the seenoindexsee key while \makeglossaries is commented out. -

If you use the

If you use the see key, you may want to consider using the seeOption 4.

-

The following keys are reserved for

The following keys are reserved for \newacronym (see short and shortplural. -

Avoid using any of the

Avoid using any of the \gls-like or \glsdesc. Additionally, they’ll confuse the entry formatting commands, such as \glslabel.
-

-

Note that if the name starts with

+

Note that if the name starts with non-Latin character, you must group the character, otherwise it will cause a problem for commands like description={select group or class}}

-

Note that the same applies if you are using the

Note that the same applies if you are using the inputenc package:

@@ -10460,7 +10516,7 @@ class="cmss-10">fontspecmfirstuc user manual.) -

Note that in both of the above examples, you will also need to supply the

Note that in both of the above examples, you will also need to supply the sort key if you are using sanitizesort=true.

-

Top

4.1 Plurals

-

You may have noticed from above that you can specify the plural form when you define a +

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 -

\glspluralsuffix  \glspluralsuffix
-

+

to the singular form. This command defaults to the letter “s”. For example: @@ -10499,7 +10555,7 @@ to the singular form. This command defaults to the letter “s”. For e \newglossaryentry{cow}{name=cow,description={a fully grown  
female of any bovine animal}}

-

defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you +

defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in archaic English, you may want to use “kine” as the plural form, in which case you would have to do: @@ -10509,8 +10565,8 @@ you would have to do: \newglossaryentry{cow}{name=cow,plural=kine,  
description={a fully grown female of any bovine animal}}

-

-

If you are writing in a language that supports multiple plurals (for a given term) then use +

+

If you are writing in a language that supports multiple plurals (for a given term) then use the plural key for one of them and one of the user keys to specify the other plural form. For @@ -10525,7 +10581,7 @@ example:  
               (plural cows, archaic plural kine)},%  
  user1={kine}}

-

You can then use

You can then use \glspl{cow} to produce “cows” and \glsuseri{cow} to produce “kine”. You can, of course, define an easy to remember synonym. For example: @@ -10535,7 +10591,7 @@ You can, of course, define an easy to remember synonym. For example:

\let\glsaltpl\glsuseri
-

Then you don’t have to remember which key you used to store the second plural. +

Then you don’t have to remember which key you used to store the second plural. Alternatively, you can define your own keys using \glsaddkey, described in §4.3 Additional Keys. -

If you are using a language that usually forms plurals by appending a different letter, or +

If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, you can redefine \glspluralsuffix as required. However, this must be done pluralfirstplural key where necessary). -

+

-

Top

4.2 Other Grammatical Constructs

-

You can use the six user keys to provide alternatives, such as participles. For example: +

You can use the six user keys to provide alternatives, such as participles. For example:

@@ -10577,7 +10633,7 @@ href="#top">Top

  }%  
}

-

With the above definitions, I can now define terms like this: +

With the above definitions, I can now define terms like this:

@@ -10586,7 +10642,7 @@ href="#top">Top

\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using  
the legs}

-

and use them in the text: +

and use them in the text:

@@ -10595,23 +10651,23 @@ Peter is \glsing{play} in the park tod  
Jane \glsd{play} in the park yesterday.  
Peter and Jane \glsd{run} in the park last week.
-

-

Alternatively, you can define your own keys using

+

Alternatively, you can define your own keys using \glsaddkey, described below in §4.3 Additional Keys. -

+

-

Top

4.3 Additional Keys

-

You can now also define your own custom keys using the commands described in this section. +

You can now also define your own custom keys using the commands described in this section. There are two types of keys: those for use within the document and those to store information used behind the scenes by other commands. -

For example, if you want to add a key that indicates the associated unit for a term, you +

For example, if you want to add a key that indicates the associated unit for a term, you might want to reference this unit in your document. In this case use \glsaddkey described in §4.3.2 Storage Keys. -

In both cases, a new command ⟨

In both cases, a new command ⟨no link cs⟩ will be defined that can be used to access the value of this key (analogous to commands such as \glsentrytext). This can be used in an @@ -10634,13 +10690,13 @@ The new keys must be added using \glsaddkey or \glsaddstoragekey before glossary entries are defined. -

+

-

Top

4.3.1 Document Keys

-

A custom key that can be used in the document is defined using: -

A custom key that can be used in the document is defined using: +

\glsaddkey  link ucfirst cs⟩}{⟨link allcaps cs⟩}
-

+

where:

⟨link allcaps cs⟩
is the control sequence to use analogous to commands like \GLStext.
-

The starred version of

The starred version of \glsaddkey switches on expansion for this key. The unstarred version doesn’t override the current expansion setting. -

Example 3 (Defining Custom Keys) -

Suppose I want to define two new keys,

Suppose I want to define two new keys, ed and ing, that default to the entry text followed by “ed” and “ing”, respectively. The default value will need expanding in both cases, so I @@ -10751,7 +10807,7 @@ need to use the starred form:  
  {\Glsing}% command analogous to \Glstext  
  {\GLSing}% command analogous to \GLStext

-

Now I can define some entries: +

Now I can define some entries:

@@ -10768,8 +10824,8 @@ need to use the starred form:  
   ing={waddling},%  
   description={}}
-

-

These entries can later be used in the document: +

+

These entries can later be used in the document:

@@ -10778,20 +10834,20 @@ The dog \glsed{jump} over the duck.  
The duck was \glsing{waddle} round the dog.  
The dog \glsed{run} away from the duck.
-

For a complete document, see the sample file

For a complete document, see the sample file sample-newkeys.tex.

-

-

____________________________

-

+

+

____________________________

+

-

Top

4.3.2 Storage Keys

-

A custom key that can be used for simply storing information is defined using: -

A custom key that can be used for simply storing information is defined using: +

\glsaddstoragekey  }{⟨no link cs⟩}
-

+

where the arguments are as the first three arguments of \glsaddkey, described above in §4.3.1 Document Keys. -

This is essentially the same as

This is essentially the same as \glsaddkey except that it doesn’t define the additional commands. You can access or update the value of your new field using the commands described in §16.3 Fetching and Updating the Value of a Field. -

Example 4 (Defining Custom Storage Key (Acronyms and Initialisms)) -

Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, +

Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all in the same glossary and I want the acronyms on first use to be displayed with the short form followed by the long form in parentheses, but the opposite way round for other forms of abbreviations. (The glossaries-extra package provides a simpler way of achieving this.) -

Here I can define a new key that determines whether the term is actually an acronym +

Here I can define a new key that determines whether the term is actually an acronym rather than some other form of abbreviation. I’m going to call this key abbrtype (since type @@ -10846,8 +10902,8 @@ already exists):  
 {word}% default value if not explicitly set  
 {\abbrtype}% custom command to access the value if required

-

-

Now I can define a style that looks up the value of this new key to determine how to +

+

Now I can define a style that looks up the value of this new key to determine how to display the full form: @@ -10926,15 +10982,15 @@ display the full form:  
  \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%  
 }

-

Remember that the new style needs to be set before defining any terms: +

Remember that the new style needs to be set before defining any terms:

\setacronymstyle{mystyle}
-

-

Since it’s a bit confusing to use

+

Since it’s a bit confusing to use \newacronym for something that’s not technically an acronym, let’s define a new command for initialisms: @@ -10946,7 +11002,7 @@ acronym, let’s define a new command for initialisms:  
  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%  
}

-

Now the entries can all be defined: +

Now the entries can all be defined:

@@ -10959,19 +11015,19 @@ acronym, let’s define a new command for initialisms:  
\newinitialism{dsp}{DSP}{digital signal processing}  
\newinitialism{atm}{ATM}{automated teller machine}
-

On

On first use, \gls{radar} will produce “radar (radio detecting and ranging)” but \gls{dsp} will produce “DSP (digital signal processing)”. -

For a complete document, see the sample file

For a complete document, see the sample file sample-storage-abbr.tex.

-

-

____________________________

-

In the above example, if

+

____________________________

+

In the above example, if \newglossaryentry is explicitly used (instead of through \newacronym) the abbrtype field. -

Example 5 (Defining Custom Storage Key (Acronyms and Non-Acronyms with Descriptions)) -

The previous example can be modified if the

The previous example can be modified if the description also needs to be provided. Here I’ve changed “word” to “acronym”: @@ -11005,14 +11061,14 @@ I’ve changed “word” to “acronym”:  
 {acronym}% default value if not explicitly set  
 {\abbrtype}% custom command to access the value if required

-

This may seem a little odd for non-abbreviated entries defined using

This may seem a little odd for non-abbreviated entries defined using \newglossaryentry directly, but \ifglshaslong can be used to determine whether or not to reference the value of this new abbrtype field. -

The new acronym style has a minor modification that forces the user to specify a +

The new acronym style has a minor modification that forces the user to specify a description. In the previous example, the line: @@ -11021,14 +11077,14 @@ description. In the previous example, the line:    \renewcommand*{\GenericAcronymFields}{%  
     description={\the\glslongtok}}%

-

needs to be changed to: +

needs to be changed to:

   \renewcommand*{\GenericAcronymFields}{}%
-

Additionally, to accommodate the change in the default value of the

Additionally, to accommodate the change in the default value of the abbrtype key, all instances of @@ -11037,15 +11093,15 @@ instances of

    \ifglsfieldeq{##1}{abbrtype}{word}
-

need to be changed to: +

need to be changed to:

    \ifglsfieldeq{##1}{abbrtype}{acronym}
-

-

Once this new style has been set, the new acronyms can be defined using the optional +

+

Once this new style has been set, the new acronyms can be defined using the optional argument to set the description: @@ -11055,8 +11111,8 @@ argument to set the description:  
speed of aircraft, ships, etc}]{radar}{radar}{radio detecting  
and ranging}

-

-

No change is required for the definition of

+

No change is required for the definition of \newinitialism but again the optional argument is required to set the description: @@ -11066,8 +11122,8 @@ argument is required to set the description: \newinitialism[description={mathematical manipulation of an  
information signal}]{dsp}{DSP}{digital signal processing}

-

-

We can also accommodate contractions in a similar manner to the initialisms: +

+

We can also accommodate contractions in a similar manner to the initialisms:

@@ -11076,7 +11132,7 @@ argument is required to set the description:  
  \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%  
}
-

The contractions can similarly been defined using this new command: +

The contractions can similarly been defined using this new command:

@@ -11084,22 +11140,22 @@ argument is required to set the description: \newcontraction[description={front part of a ship below the  
deck}]{focsle}{fo'c's'le}{forecastle}
-

-

Since the custom acronym style just checks if

+

Since the custom acronym style just checks if abbrtype is acronym, the contractions will be treated the same as the initialisms, but the style could be modified by a further test of the abbrtype value if required. -

To test regular non-abbreviated entries, I’ve also defined a simple word: +

To test regular non-abbreviated entries, I’ve also defined a simple word:

\newglossaryentry{apple}{name={apple},description={a fruit}}
-

-

Now for a new glossary style that provides information about the abbreviation (in +

+

Now for a new glossary style that provides information about the abbreviation (in addition to the description): @@ -11117,52 +11173,52 @@ addition to the description):  
       \glossentrydesc{##1}\glspostdescription\space ##2}%  
 }

-

This uses

This uses \ifglshaslong to determine whether or not the term is an abbreviation. If it has an abbreviation, the full form is supplied in parentheses and \abbrtype (defined by \glsaddstoragekey earlier) is used to indicate the type of abbreviation. -

With this style set, the

With this style set, the apple entry is simply displayed in the glossary as

apple
a fruit.
-

but the abbreviations are displayed in the form +

but the abbreviations are displayed in the form

laser
(acronym: light amplification by stimulated emission of radiation) device that creates a narrow beam of intense light.
-

(for acronyms) or +

(for acronyms) or

DSP
(initialism: digital signal processing) mathematical manipulation of an information signal.
-

(for initalisms) or +

(for initalisms) or

fo’c’s’le
(contraction: forecastle) front part of a ship below the deck.
-

(for contractions). -

For a complete document, see

(for contractions). +

For a complete document, see sample-storage-abbr-desc.tex.

-

-

____________________________

+

+

____________________________

-

+

-

Top

4.4 Expansion

-

When you define new glossary entries expansion is performed by default, except for the

When you define new glossary entries expansion is performed by default, except for the name, sort keys (these keys all have expansion suppressed via \glssetnoexpandfield). -

You can switch expansion on or off for individual keys using -

You can switch expansion on or off for individual keys using +

\glssetexpandfield  \glssetexpandfield{⟨field⟩}
-

+

or -

\glssetnoexpandfield  \glssetnoexpandfield{⟨field⟩}
-

+

respectively, where ⟨field⟩ is the field tag corresponding to the key. In most cases, this is the same as the name of the key except for those listed in table 4.1.

-

@@ -11310,31 +11366,31 @@ class="cmtt-10">shortpl
-

Any keys that haven’t had the expansion explicitly set using

Any keys that haven’t had the expansion explicitly set using \glssetexpandfield or \glssetnoexpandfield are governed by -

\glsexpandfields  \glsexpandfields
-

+

and -

\glsnoexpandfields  \glsnoexpandfields
-

-

If your entries contain any fragile commands, I recommend you switch off expansion via +

+

If your entries contain any fragile commands, I recommend you switch off expansion via \glsnoexpandfields. (This should be used before you define the entries.)

-

Top

4.5 Sub-Entries

-

As from version 1.17, it is possible to specify sub-entries. These may be used to order the +

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 @@ -11353,7 +11409,7 @@ href="#sec:pkgopts-printglos">§2.3 Glossary Appearance Options for further details). -

Note that the parent entry will automatically be added to the glossary if any of its child +

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 number listmakeindex has a restriction on the maximum sub-entry depth. -

+

-

Top

4.5.1 Hierarchical Categories

-

To arrange a glossary with hierarchical categories, you need to first define the category and +

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 parent key. -

Example 6 (Hierarchical Categories—Greek and Roman Mathematical Symbols) -

Suppose I want a glossary of mathematical symbols that are divided into Greek letters +

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: @@ -11393,13 +11449,13 @@ and Roman letters. Then I can define the categories as follows:  
\newglossaryentry{romanletter}{name={Roman letters},  
description={\nopostdesc}}

-

-

Note that in this example, the category entries don’t need a description so I have set the +

+

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

I can now define my sub-entries as follows: +

I can now define my sub-entries as follows:

@@ -11412,19 +11468,19 @@ terminator.  
description={Euler's constant},  
parent=romanletter}
-

For a complete document, see the sample file

For a complete document, see the sample file sampletree.tex.

-

-

____________________________

-

+

+

____________________________

+

-

Top

4.5.2 Homographs

-

Sub-entries that have the same name as the parent entry, don’t need to have the +

Sub-entries that have the same name as the parent entry, don’t need to have the name key. For example, the word “glossary” can mean a list of technical words or a @@ -11438,11 +11494,11 @@ entry:  
description={\nopostdesc},  
plural={glossaries}}

-

Again, the parent entry has no description, so the description terminator needs to be +

Again, the parent entry has no description, so the description terminator needs to be suppressed using \nopostdesc. -

Now define the two different meanings of the word: +

Now define the two different meanings of the word:

@@ -11456,7 +11512,7 @@ class="cmtt-10">\nopostdescsort={2},  
parent={glossary}}
-

Note that if I reference the parent entry, the location will be added to the parent’s

Note that if I reference the parent entry, the location will be added to the parent’s number list, whereas if I reference any of the child entries, the location will be added to the child @@ -11479,7 +11535,7 @@ href="#sec:pkgopts-printglos">§2.3 Glossary Appearance Options for further details. -

In the above example, the plural form for both of the child entries is the same as the +

In the above example, the plural form for both of the child entries is the same as the parent entry, so the plural key was not required for the child entries. However, if the @@ -11501,14 +11557,14 @@ sub-entries have different plurals, they will need to be specified. For example:  
plural={bravoes},  
parent=bravo} -

-

+

+

-

Top

4.6 Loading Entries From a File

-

You can store all your glossary entry definitions in another file and use: -

You can store all your glossary entry definitions in another file and use: +

\loadglsentries  type⟩]{⟨filename⟩}
-

+

where ⟨filename⟩ is the name of the file containing all the \newglossaryentry\glsdefaulttype\newglossaryentry uses by default). -

This is a preamble-only command. You may also use

This is a preamble-only command. You may also use \input to load the file but don’t use bib2gls and use an application such as JabRef to manage the entry definitions. -

If you want to use

If you want to use \AtBeginDocument to \input all your entries automatically at the @@ -11569,16 +11625,16 @@ href="#sec:docdefs">§4.8 Drawbacks With Defining Entries in the Document Environment.)
-

+

-

Example 7 (Loading Entries from Another File) -

Suppose I have a file called

Suppose I have a file called myentries.tex which contains: @@ -11593,14 +11649,14 @@ class="cmtt-10">myentries.tex which contains:  
name={html},  
description={A mark up language}}

-

and suppose in my document preamble I use the command: +

and suppose in my document preamble I use the command:

\loadglsentries[languages]{myentries}
-

then this will add the entries

then this will add the entries tex and html to the glossary whose type is given by main.

-

-

____________________________

-

+

____________________________

+

Note: if you use \newacronym (see myacronyms.tex contains:

-

then (supposing I have defined a new glossary type called

then (supposing I have defined a new glossary type called altacronym) @@ -11637,7 +11693,7 @@ class="cmtt-10">altacronym)

\loadglsentries[altacronym]{myacronyms}
-

will add

will add aca to the glossary type acronym, if the package option acronymacronym4.1 -

If you have used the

If you have used the acronym package option, there are two possible solutions to this problem: @@ -11664,14 +11720,14 @@ class="cmtt-10">myacronyms.tex so that entries are defined in the form: \newacronym[type=\glsdefaulttype]{aca}{aca}{a  
contrived acronym} -

and do: +

and do:

\loadglsentries[altacronym]{myacronyms}
-

+

  • Temporarily change \acronymtype to the target glossary:  
    \loadglsentries{myacronyms}  
    \let\acronymtype\orgacronymtype -

    • -

    Note that only those entries that have been used in the text will appear in the relevant +

    +

    Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also that \loadglsentries may only be used in the preamble. -

    Remember that you can use

    Remember that you can use \provideglossaryentry rather than \newglossaryentryterms.tex) contains: \provideglossaryentry{mallard}{name=mallard,  
     description={a type of duck}} -

    but suppose your document requires a more detailed description, you can do: +

    but suppose your document requires a more detailed description, you can do:

    @@ -11720,16 +11776,16 @@ class="cmtt-10">terms.tex) contains:  
     description={a dabbling duck where the male has a green head}}  
    \loadglsentries{terms} -

    Now the

    Now the mallard definition in the terms.tex file will be ignored. -

    +

    -

    Top

    4.7 Moving Entries to Another Glossary

    -

    As from version 3.02, you can move an entry from one glossary to another using: -

    As from version 3.02, you can move an entry from one glossary to another using: +

    \glsmoveentry  label⟩}{⟨target glossary label⟩}
    -

    +

    where ⟨label⟩ is the unique label identifying the required entry and ⟨target glossary label⟩ is the unique label identifying the glossary in which to put the entry. -

    Note that no check is performed to determine the existence of the target glossary. If +

    Note that no check is performed to determine the existence of the target glossary. If you want to move an entry to a glossary that’s skipped by \printglossaries, @@ -11754,15 +11810,15 @@ href="#sec:newglossary">§12 Defining New Glossaries.) -

    Unpredictable results may occur if you move an entry to a different glossary from its +

    Unpredictable results may occur if you move an entry to a different glossary from its parent or children.
    -

    -

    +

    +

    -

    Top

    4.8 Drawbacks With Defining Entries in the Document Environment

    -

    Originally,

    Originally, \newglossaryentry (and \newacronym3 but provides a package option to allow document definitions.) -

    +

    -

    Top

    4.8.1 Technical Issues

    -

    +

    1. If you define an entry mid-way through your document, but subsequently shuffle @@ -11826,7 +11882,7 @@ class="cmtt-10">= character should not be active when using class="cmti-10">key⟩=⟨value⟩ arguments.
    -

    To overcome the first two problems, as from version 4.0 the

    To overcome the first two problems, as from version 4.0 the glossaries package modifies the definition of \newglossaryentry at the beginning of the document environment if it doesn’t already exist. This means that the entry can now be looked up in the glossary, even if the glossary occurs at the beginning of the document. -

    There are drawbacks to this mechanism: if you modify an entry definition, you need a +

    There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the effect of your modification; this method requires an extra \newwrite, which may exceed T.glsdefs file when it’s created at the end of the document (and therefore won’t be present on subsequent runs). -

    The

    The glossaries-extra package provides a setting (but only for Options 2 and 

    +

    -

    Top

    4.8.2 Good Practice Issues

    -

    The above section covers technical issues that can cause your document to have compilation +

    The above section covers technical issues that can cause your document to have compilation errors or produce incorrect output. This section focuses on good writing practice. The main reason cited by users wanting to define entries within the document

    When you write technical documents, regardless of whether it’s a PhD thesis or an article +

    When you write technical documents, regardless of whether it’s a PhD thesis or an article for a journal or proceedings, you must plan what you write in advance. If you plan in advance, you should have a fairly good idea of the type of terminology that your document will contain, so while you are planning, create a new file with all your @@ -11898,11 +11954,11 @@ definition.

    -

    -

    +

    Top

    5. Number lists

    -

    Each entry in the glossary has an associated

    Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been indexed (using any of the commands described in @@ -11921,7 +11977,7 @@ class="cmss-10">counter package option. The number list is also referred to as the location list. -

    Number lists are more common with indexes rather than glossaries (although you can use the indexonlyfirstfirst use of each term. -

    The

    The \glsaddall command (see number list, which looks weird if the number list hasn’t been suppressed. -

    With

    With Option 4, the indexing is performed by bib2glsOption 1 also allows any location but it doesn’t form ranges.

    -

    Top

    5.1 Encap Values

    -

    Each location in the

    Each location in the number list is encapsulated with a command formed from the encap( this signifies the start of a range and i with close parenthesis ) this signifies the end of a range. These must always occur in matching pairs. -

    The

    The glossaries package provides the command \glsignore which ignores its argument. @@ -12037,7 +12093,7 @@ class="cmtt-10">sample will be 2, \glsignore{10} which will result in “2, ” which has a spurious comma. -

    This isn’t a problem with

    This isn’t a problem with bib2gls because you’d use number listOption 5, which doesn’t perform any indexing). -

    Complications can arise if you use different encap values for the same location. For +

    Complications can arise if you use different encap values for the same location. For example, suppose on page 10 you have both the default glsnumberformat and textbf @@ -12072,7 +12128,7 @@ be careful about if you use the format key or if you use a command that implicitly sets it. -

    In the case of

    In the case of xindy, it only accepts one encap (according to the order of precedence given @@ -12082,7 +12138,7 @@ class="cmtt-10">xindy module) and discards the others for identical locations (for the same entry). This can cause a problem if a discarded location forms the start or end of a range. -

    In the case of

    In the case of makeindex, it accepts different encaps for the same location, but warns @@ -12102,7 +12158,7 @@ class="cmtt-10">glsnumberformat encap always has the least precedence unless it includes a range identifier. Other conflicting encaps will have the last one override earlier ones for the same location with range identifiers taking priority. -

    No discard occurs with

    No discard occurs with Option 1 so again you get the same location repeated in different formats. With Option 4, bib2gls manual for further details.) -

    +

    -

    Top

    5.2 Locations

    -

    Neither

    Neither Option 1 nor Option 4 care about the location syntax as long as it’s valid LAT2 and 3 are far more problematic and need some complex code to deal with awkward locations. -

    If you know that your locations will always expand to a format acceptable to your chosen +

    If you know that your locations will always expand to a format acceptable to your chosen indexing application then use the package option esclocations=false3 as the problem doesn’t arise with the other indexing options. -

    Both

    Both makeindex and \\the\\c@page and \number\c@page mustn’t be converted to \\number\\c@page etc). -

    There’s a certain amount of trickery needed to deal with this conflict and the code requires +

    There’s a certain amount of trickery needed to deal with this conflict and the code requires the location to be in a form that doesn’t embed the counter’s internal register in commands like \value. For example, suppose you have a robust command called @@ -12214,7 +12270,7 @@ number:

    -

    Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a +

    Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a paragraph that started on page 1. With xindy\c@page:

    -

    +

  • The form \expandafter\the\csname\the \newcommand{\tally}[1]{%  
     \tallynum{\expandafter\the\csname c@#1\endcsname}}
    • -

    +

  • \expandafter\the\value} now also works (with the same condition as
    \newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}}
    -

    +

  • Another variation that will work: @@ -12284,7 +12340,7 @@ class="cmtt-10">} now also works (with the same condition as \newcommand{\tally}[1]{%  
      \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}} -

    +

  • and also: @@ -12292,8 +12348,8 @@ class="cmtt-10">} now also works (with the same condition as
    \newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}}
    -

    • -

    The following

    +

    The following don’t work:

    • This definition leads to the premature expansion of \c@page to “1” when, in this case,
      \newcommand{\tally}[1]{\tallynum{\the\value{#1}}}
      -

      +

    • This definition leads to \\c@page in the glossary file: @@ -12313,8 +12369,8 @@ class="cmtt-10">\\c@page in the glossary file:
      \newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}}
      -

    -

    If you have a numbering system where

    +

    If you have a numbering system where \⟨cs name⟩{page} expands to \c@page class="cmtt-10">\tally{page} expands to \tallynum\c@page) then you need to use: -

    \glsaddprotectedpagefmt  \glsaddprotectedpagefmt{⟨internal cs name⟩}
    -

    +

    Note that the backslash must be omitted from ⟨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

    For example, suppose you have a style samplenum that is implemented as follows: @@ -12347,7 +12403,7 @@ class="cmtt-10">samplenum that is implemented as follows:  
       \expandafter\@samplenum\csname c@#1\endcsname}  
     \newcommand*{\@samplenum}[1]{\two@digits{#1}}

    -

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure the +

    (That is, it displays the value of the counter as a two-digit number.) Then to ensure the location is correct for entries in page-spanning paragraphs, you need to do: @@ -12355,11 +12411,11 @@ location is correct for entries in page-spanning paragraphs, you need to do:

    \glsaddprotectedpagefmt{@samplenum}
    -

    (If you are using a different counter for the location, such as

    (If you are using a different counter for the location, such as section or equation, you don’t need to worry about this provided the inner command is expandable.) -

    If the inner macro (as given by

    If the inner macro (as given by \⟨internal cs name⟩) contains non-expandable commands then you may need to redefine   \expandafter\@samplenum\csname c@#1\endcsname}  
     \newcommand*{\@samplenum}[1]{\textsc{\romannumeral#1}} -

    Again, the inner macro needs to be identified using: +

    Again, the inner macro needs to be identified using:

    \glsaddprotectedpagefmt{@samplenum}
    -

    However, since

    However, since \textsc isn’t fully expandable, the location is written to the file as \textsc \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page} -

    While this modification means that the

    While this modification means that the number list in the glossary won’t exactly match the format of the page numbers (displaying lower case Roman numbers instead of small cap @@ -12437,7 +12493,7 @@ class="cmtt-10">xindy   \glsbackslash\string\textsc{\romannumeral\c@page}} -

    combined with +

    combined with

    @@ -12445,7 +12501,7 @@ class="cmtt-10">xindy "roman-numbers-lowercase" :sep "\glsclosebrace"} -

    will now have lowercase Roman numerals in the location list (see

    will now have lowercase Roman numerals in the location list (see §11.2 Locations and @@ -12456,7 +12512,7 @@ class="cmtt-10">\\ but the location class (identified with \GlsAddXdyLocation) just has a single backslash. Note that this example will cause problems if your locations should be hyperlinks. -

    Another possibility that may work with both

    Another possibility that may work with both makeindex and \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}} -

    -

    If you redefine

    +

    If you redefine \gls⟨internal cs name⟩page, you must make sure that \c@page is expanded when it’s written to the file. (So don’t, for example, hide \c@page inside a robust command.)
    -

    -

    The mechanism that allows this to work temporarily redefines

    +

    The mechanism that allows this to work temporarily redefines \the and \number while it processes the location. If this causes a problem you can disallow it using -

    \glswrallowprimitivemodsfalse  \glswrallowprimitivemodsfalse
    -

    +

    but you will need to find some other way to ensure the location expands correctly. -

    +

    -

    Top

    5.3 Range Formations

    -

    Both

    Both makeindex and §11.2 Locations and Number lists for further details). -

    Note that

    Note that \GlsSetXdyMinRangeLength must be used before \makeglossaries and has no effect if \noist is used.
    -

    -

    With both

    +

    With both makeindex and xindy2 and 3), you can replace the separator and the closing number in the range using: -

    \glsSetSuffixF  \glsSetSuffixF{⟨suffix⟩}
    -

    -

    +

    \glsSetSuffixFF  \glsSetSuffixFF{⟨suffix⟩}
    -

    +

    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: @@ -12577,7 +12633,7 @@ the suffix to use for longer lists. For example: \glsSetSuffixF{f.}  
    \glsSetSuffixFF{ff.}

    -

    Note that if you use

    Note that if you use xindy ( \GlsSetXdyMinRangeLength{1}

    -

    Note that if you use the

    Note that if you use the hyperref package, you will need to use \nohyperpage\glsSetSuffixFF{\nohyperpage{ff.}}

    -

    -

    Note that

    +

    Note that \glsSetSuffixF and \glsSetSuffixFF must be used before \makeglossaries\makeglossaries\noist is used.
    -

    -

    It’s also possible to concatenate a sequence of consecutive locations into a range or have +

    +

    It’s also possible to concatenate a sequence of consecutive locations into a range or have suffixes with Option 4, but with bib2gls manual for further details. -

    Option 1 doesn’t form ranges. However, with this option you can iterate over an entry’s number list using: -

    \glsnumberlistloop  }{⟨xr handler cs⟩}
    -

    +

    where ⟨label⟩ is the entry’s label and ⟨handler cs⟩ is a handler control sequence of the form: -

    ⟨

    ⟨handler cs⟩{⟨prefix⟩format⟩}{⟨location⟩}
    -

    +

    where ⟨prefix⟩ is the hyperreftextbf) and ⟨location⟩ is the location. The third argument is the control sequence to use for any cross-references in the list. This handler should have the syntax: -

    ⟨

    ⟨xr handler cs⟩[⟨tag⟩]{⟨xr list⟩}
    -

    +

    where ⟨tag⟩ is the cross-referenced text (e.g. “see”) and ⟨xr list⟩ is a comma-separated list of labels. (This actually has a third argument but it’s always empty when used with Option 1.) -

    For example, if on page 12 I have used +

    For example, if on page 12 I have used

    \gls[format=textbf]{apple}
    -

    and on page 18 I have used +

    and on page 18 I have used

    \gls[format=emph]{apple}
    -

    then +

    then

    \glsnumberlistloop{apple}{\myhandler}
    -

    will be equivalent to: +

    will be equivalent to:

    @@ -12713,10 +12769,10 @@ href="#option1">Option 1.) \myhandler{}{page}{textbf}{12}%  
    \myhandler{}{page}{emph}{18}%
    -

    There is a predefined handler that’s used to display the

    There is a predefined handler that’s used to display the number list in the glossary: -

    \glsnoidxdisplayloc  }{⟨location⟩}
    -

    +

    The predefined handler used for the cross-references in the glossary is: -

    \glsseeformat[⟨tag⟩]{⟨xr list⟩}{⟨location⟩}
    -

    +

    which is described in §8.1 Customising Cross-reference Text. -

    \glsnumberlistloop is not available for Options 2 and 3.
    -

    -

    +

    +

    -

    Top

    5.4 Style Hook

    -

    As from version 4.24, there’s a hook that’s used near the end of

    As from version 4.24, there’s a hook that’s used near the end of \writeist before the file is closed. You can set the code to be performed then using: -

    \GlsSetWriteIstHook  \GlsSetWriteIstHook{⟨code⟩}
    -

    +

    If you want the ⟨code⟩ to write any information to the file, you need to use -

    \glswrite  \write\glswrite{⟨style information⟩}
    -

    +

    Make sure you use the correct format within ⟨style information⟩. For example, if you are using makeindex \write\glswrite{line_max 80}%  
    }

    -

    This changes the page type precedence

    This changes the page type precedence and the maximum line length used by makeindex. -

    Remember that if you switch to

    Remember that if you switch to xindy, this will no longer be valid code.

    -

    -

    +

    Top

    6. Links to Glossary Entries

    -

    Once you have defined a glossary entry using

    Once you have defined a glossary entry using \newglossaryentry (4 write the information to the .aux file.) -

    Note that repeated use of these commands for the same entry can cause the

    Note that repeated use of these commands for the same entry can cause the number list to become quite long, which may not be particular helpful to the reader. In this case, @@ -12872,10 +12928,10 @@ href="#glo:glossaries-extra">glossaries-extra package, which provides a means to suppress the automated indexing of the commands listed in this chapter. -

    I strongly recommend that you don’t use the commands defined in this chapter in the +

    I strongly recommend that you don’t use the commands defined in this chapter in the arguments of sectioning or caption commands or any other command that has a moving argument. -

    Aside from problems with expansion issues, PDF bookmarks and possible nested +

    Aside from problems with expansion issues, PDF bookmarks and possible nested hyperlinks in the table of contents (or list of whatever) any use of the commands described in \gls-Like Commands (First Use Flag Queried)

    -

    The above warning is particularly important if you are using the

    +

    The above warning is particularly important if you are using the glossaries package in conjunction with the hyperref\chapter[An overview of Perl]{An overview of \gls{perl}}  
    \chapter{An overview of \texorpdfstring{\gls{perl}}{Perl}}

    -

    If you want to retain the formatting that’s available through commands like

    If you want to retain the formatting that’s available through commands like \acrshort (for example, if you are using one of the small caps styles), then you might want to consider the glossaries-extra package which provides commands for this purpose. -

    If you want the

    If you want the link text to produce a hyperlink to the corresponding entry details in the glossary, you should load the link text, you can click on the word or phrase and it will take you to a brief description in this document’s glossary. -

    If you use the

    If you use the hyperref package, I strongly recommend you use pdflatex

    These are limitations of the DVI format not of the

    These are limitations of the DVI format not of the glossaries package.

    -

    -

    It may be that you only want terms in certain glossaries to have hyperlinks, but not for +

    +

    It may be that you only want terms in certain glossaries to have hyperlinks, but not for other glossaries. In this case, you can use the package option nohypertypes to identify the @@ -12968,17 +13024,17 @@ href="#sec:pkgopts-general">§2.1 General Options for further details. -

    The way the

    The way the link text is displayed depends on -

    \glstextformat  \glstextformat{⟨text⟩}
    -

    +

    For example, to make all link text appear in a sans-serif font, do: @@ -12988,7 +13044,7 @@ href="#glo:linktext">link text \renewcommand*{\glstextformat}[1]{\textsf{#1}}

    -

    Further customisation can be done via

    Further customisation can be done via \defglsentryfmt or by redefining \glsentryfmt\glsentryfmt§6.3 Changing the format of the link text for further details. -

    Each entry has an associated conditional referred to as the

    Each entry has an associated conditional referred to as the first use flag. Some of the commands described in this chapter automatically unset this flag and can also use it to determine what text should be displayed. These types of commands are the @@ -13024,7 +13080,7 @@ href="#sec:glsunset">Unsetting and Resetting Entry Flags

    The

    The \gls-like and glossaries-extra package provides the option to add a third custom variant. -

    Avoid nesting these commands. For example don’t do

    Avoid nesting these commands. For example don’t do \glslink{⟨label⟩}symbol key if you intend to use \glssymbol.)
    -

    -

    The keys listed below are available for the optional argument. The

    +

    The keys listed below are available for the optional argument. The glossaries-extra package provides additional keys. (See the italic) you will need to create a command that applies bo

    \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
    -

    and use that command. -

    In this document, the standard formats refer to the standard text block commands such +

    and use that command. +

    In this document, the standard formats refer to the standard text block commands such as \textbf or format⟩ part must match. For example, format={(emph} and format={)emph}. -

    If you use

    If you use xindy instead of xindy \GlsAddXdyAttribute{textbfem}
    -

    See

    See §11 Xindy (Option 3) for further details.

    -

    -

    If you are using hyperlinks and you want to change the font of the hyperlinked location, +

    +

    If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use \hyperpage (provided by the glossaries package provides number formats listed in href="#tab:hyperxx">table 6.1.

    -

    emphasized hyperlink
    -

    Note that if the

    Note that if the \hyperlink command hasn’t been defined, the hyper⟨\hyperbsf \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}

    -

    and then use

    and then use hyperbsf as the value for the format @@ -13326,7 +13382,7 @@ class="cmtt-10">xindy \GlsAddXdyAttribute{hyperbsf}

    -

    +

    counterlocal=true, the change to the first use flag will be localised to the current scope. The default is local=false. -

    The

    The link text isn’t scoped by default. Any unscoped declarations in the link text may affect subsequent text.
    -

    +

    -

    Top

    6.1 The \gls-Like Commands (First Use Flag Queried)

    -

    This section describes the commands that unset (mark as used) the

    This section describes the commands that unset (mark as used) the first use flag on completion, and in most cases they use the current state of the flag to determine the text to be displayed. As described above, these commands all have a star-variant (hyper=true) and have an optional first argument that is a class="cmti-10">key⟩=⟨value⟩ list. -

    These commands use

    These commands use \glsentryfmt or the equivalent definition provided by §6.3 Changing the format of the link text). -

    Apart from

    Apart from \glsdisp, the commands described in this section also have a final optional argument ⟨insert⟩ which may be used to insert material into the automatically generated text. -

    Since the commands have a final optional argument, take care if you actually want to +

    Since the commands have a final optional argument, take care if you actually want to display an open square bracket after the command when the final optional argument is absent. Insert an empty set of braces {} immediately before the opening square bracket to @@ -13399,16 +13455,16 @@ prevent it from being interpreted as the final argument. For example:
    \gls{sample} {}[Editor's comment]
    -

    -

    Don’t use any of the

    +

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨insert⟩ argument.

    -

    -

    Take care using these commands within commands or environments that are processed +

    +

    Take care using these commands within commands or environments that are processed multiple times as this can confuse the first use flag query and state change. This includes frames with overlays in beamertabularx by placing the following command (new to v4.28) in the preamble: -

    \glspatchtabularx  \glspatchtabularx
    -

    +

    This does nothing if tabularx hasn’t been loaded. There’s no patch available for beamer§14 Unsetting and Resetting Entry Flags for more details. -

    \gls  label⟩}[⟨insert⟩]
    -

    +

    This command typically determines the link text from the values of the long or short keys. -

    There are two upper case variants: -

    There are two upper case variants: +

    \Gls  label⟩}[⟨insert⟩]
    -

    +

    and -

    \GLS  label⟩}[⟨insert⟩]
    -

    +

    which make the first letter of the link text or all the link text upper case, respectively. For the former, the uppercasing of the first letter is performed by \makefirstuc. -

    The first letter uppercasing command

    The first letter uppercasing command \makefirstuc has limitations which must be taken into account if you use \Gls or any of the other commands that convert the first letter to uppercase.
    -

    +

    The upper casing is performed as follows:

    -

    Then

    Then \Gls{sample} will set the link text6.2 \emph{\MakeUppercase sample} phrase

    -

    which will appear as

    which will appear as Sample phrase.

  • If the first thing in the link text  description={an example}  
    }
    • -

    Then

    Then \Gls{sample} will set the link textlink text \MakeUppercase \oe-ligature

    -

    which will appear as Œ-ligature. +

    which will appear as Œ-ligature.

  • If you have mfirstucmfirstuc\protect it will be discarded and the above rules will then be tried.
    • -

    (Note the use of the

    (Note the use of the sort key in the above examples.) -

    There are hundreds of LAT

    There are hundreds of LATEX packages that altogether define thousands of commands with various syntax and it’s impossible for mfirstuclink textmfirstuc’s assumptions then things are likely to go wrong. -

    For example, starting with a math-shift symbol: +

    For example, starting with a math-shift symbol:

    @@ -13605,7 +13661,7 @@ things are likely to go wrong.  
      description={an example}  
    }
    -

    This falls into case 2 above, so the

    This falls into case 2 above, so the link text will be set to @@ -13614,7 +13670,7 @@ href="#glo:linktext">link text \MakeUppercase $a$

    -

    This attempts to uppercase the math-shift

    This attempts to uppercase the math-shift $, which will go wrong. In this case it’s not appropriate to perform any case-changing, but it may be that you want to use \Gls @@ -13630,7 +13686,7 @@ solution is to insert an empty brace at the start:  
      description={an example}  
    }

    -

    Now the

    Now the link text will be set to @@ -13639,9 +13695,9 @@ href="#glo:linktext">link text \MakeUppercase{}$a$

    -

    and the

    and the \uppercase becomes harmless. -

    Another issue occurs when the

    Another issue occurs when the link text starts with a command followed by an argument (case 1) but the argument is a label, identifier or something else that shouldn’t have a @@ -13668,7 +13724,7 @@ example:  
       description={another example}  
     }

    -

    Now the

    Now the link text will be set to: @@ -13677,7 +13733,7 @@ href="#glo:linktext">link text \glsentrytext{\MakeUppercase sample} two

    -

    This will generate an error because there’s no entry with the label given by +

    This will generate an error because there’s no entry with the label given by \MakeUppercase sample. The best solution here is to write the term out in the name   description={another example}  
     }

    -

    -

    If the

    +

    If the link text starts with a command that has an optional argument or with multiple arguments where the actual text isn’t in the first argument, then  sort={sample phrase},  
     description={an example}}

    -

    Now the

    Now the link text will be set to: @@ -13728,7 +13784,7 @@ href="#glo:linktext">link text \textcolor{\MakeUppercase blue}{sample} phrase

    -

    This won’t work because

    This won’t work because \MakeUppercase blue isn’t a recognised colour name. In this case you will have to define a helper command where the first argument is the text. For @@ -13743,7 +13799,7 @@ example:  
     sort={sample phrase},  
     description={an example}}

    -

    In fact, since the whole design ethos of LAT

    In fact, since the whole design ethos of LATEX is the separation of content and style, it’s better to use a semantic command. For example: @@ -13756,12 +13812,12 @@ better to use a semantic command. For example:  
     sort={sample phrase},  
     description={an example}}

    -

    For further details see the

    For further details see the mfirstuc user manual. -

    There are plural forms that are analogous to

    There are plural forms that are analogous to \gls: -

    \glspl  label⟩}[⟨insert⟩]
    -

    -

    +

    \Glspl  label⟩}[⟨insert⟩]
    -

    -

    +

    \GLSpl  label⟩}[⟨insert⟩]
    -

    +

    These typically determine the link text from the plural or longplural or shortplural keys. -

    Be careful when you use glossary entries in math mode especially if you are using

    Be careful when you use glossary entries in math mode especially if you are using hyperref as it can affect the spacing of subscripts and superscripts. For example, suppose you have @@ -13823,14 +13879,14 @@ defined the following entry: \newglossaryentry{Falpha}{name={F_\alpha},  
    description=sample}
    -

    and later you use it in math mode: +

    and later you use it in math mode:

    $\gls{Falpha}^2$
    -

    This will result in

    This will result in Fα2 instead of insert⟩ optional argument:

    $\gls{Falpha}[^2]$
    -

    -

    -

    +

    +

    \glsdisp  label⟩}{⟨link text⟩}
    -

    +

    This behaves in the same way as the above commands, except that the ⟨link text⟩ is explicitly set. There’s no final optional argument as any inserted material can be added to the ⟨link text⟩ argument. -

    Don’t use any of the

    Don’t use any of the \gls-like or \glstext-like commands in the ⟨link text⟩ argument of \glsdisp.
    -

    -

    +

    +

    -

    Top

    6.2 The \glstext-Like Commands (First Use Flag Not Queried)

    -

    This section describes the commands that don’t change or reference the

    This section describes the commands that don’t change or reference the first use flag. As described above, these commands all have a star-variant (hyper=false) and a @@ -13901,7 +13957,7 @@ href="#sec:acronyms">§13 Acronyms and Other Abbreviations. -

    Apart from

    Apart from \glslink, the commands described in this section also have a final @@ -13913,7 +13969,7 @@ class="tcrm-1000">§6.1 The \gls-Like Commands (First Use Flag Queried). -

    \glslink  label⟩}{⟨link text⟩}
    -

    +

    This command explicitly sets the link text as given in the final argument. -

    Don’t use any of the

    Don’t use any of the \gls-like or \glslink. By extension, this means that you can’t u used to form link text.
    -

    -

    +

    \glstext  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the text key as the link text. -

    There are also analogous commands: -

    There are also analogous commands: +

    \Glstext  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLStext  text⟩}[⟨insert⟩]
    -

    +

    These convert the first character or all the characters to uppercase, respectively. See the note on \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 +

    There’s no equivalent command for title-casing, but you can use the more generic command \glsentrytitlecase in combination with \glslink. For example:

    \glslink{sample}{\glsentrytitlecase{sample}{text}}
    -

    (See

    (See §9 Using Glossary Terms Without Links.) -

    \glsfirst  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the first key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsfirst  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSfirst  text⟩}[⟨insert⟩]
    -

    -

    The value of the

    +

    The value of the first key (and firstplural\gls or \glspl on subsequent use.)
    -

    -

    +

    \glsplural  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the plural key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsfirstplural  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the firstplural key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsfirstplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSfirstplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsname  insert⟩]
    -

    +

    This command always uses the value of the name key as the \glstext or \glsfirst instead of \glsname. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsname  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSname  text⟩}[⟨insert⟩]
    -

    -

    In general it’s best to avoid

    +

    In general it’s best to avoid \Glsname with acronyms. Instead, consider using \Acrlong, \Acrshort or \Acrfull.
    -

    -

    +

    \glssymbol  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the symbol key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glssymbol  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSsymbol  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsdesc  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the description key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsdesc  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSdesc  text⟩}[⟨insert⟩]
    -

    -

    If you want the title case version you can use +

    +

    If you want the title case version you can use

    \glslink{sample}{\glsentrytitlecase{sample}{desc}}
    -

    -

    +

    \glsuseri  label⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user1 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseri  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseri  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuserii  text⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user2 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuserii  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuserii  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuseriii  text⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user3 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseriii  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseriii  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuseriv  text⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user4 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseriv  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseriv  insert⟩]
    -

    -

    +

    \glsuserv  text⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user5 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuserv  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuserv  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuservi  text⟩}[⟨insert⟩]
    -

    +

    This command always uses the value of the user6 key as the link text. -

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuservi  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuservi  text⟩}[⟨insert⟩]
    -

    -

    +

    +

    -

    Top

    6.3 Changing the format of the link text

    -

    The default format of the

    The default format of the link text for the \gls-like commands is governed by6.3: -

    \glsentryfmt  \glsentryfmt
    -

    +

    This may be redefined but if you only want the change the display style for a given glossary, then you need to use -

    \defglsentryfmt  type⟩]{⟨definition⟩}
    -

    +

    instead of redefining \glsentryfmt. The optional first argument ⟨type⟩ is the glossary type. @@ -14600,7 +14656,7 @@ This defaults to \glsdefaulttype if omitted. The second argument is the entry format definition. -

    Note that

    Note that \glsentryfmt is the default display format for entries. Once the display format has been changed for an individual glossary using \defglsentryfmtAcronym Options

    -

    Within the ⟨

    +

    Within the ⟨definition⟩ argument of \defglsentryfmt, or if you want to redefine \glsentryfmt, you may use the following commands: -

    \glslabel  \glslabel
    -

    +

    This is the label of the entry being referenced. As from version 4.08, you can also access the glossary entry type using: -

    \glstype  \glstype
    -

    +

    This is defined using \edef so the replacement text is the actual glossary type rather than \glsentrytype{\glslabel}. -

    \glscustomtext  \glscustomtext
    -

    +

    This is the custom text supplied in \glsdisp. It’s always empty for \glsetoolbox\ifdefempty to determine if \glscustomtext is empty.) -

    \glsinsert  \glsinsert
    -

    +

    The custom text supplied in the final optional argument to \gls, \glspl and their upper case variants. -

    \glsifplural  true text⟩}{⟨false text⟩}
    -

    +

    If \glspl, \Glspl or true text⟩ otherwise it does ⟨false text⟩. -

    \glscapscase  first uc⟩}{⟨all caps⟩}
    -

    +

    If \gls, \glspl or first uc⟩. If \GLS or \GLSpl were used, this does ⟨all caps⟩. -

    \glsifhyperon  hyper true⟩}{⟨hyper false⟩}
    -

    +

    This will do ⟨hyper true⟩ if the hyperlinks are on for the current reference, otherwise it will do ⟨nohypertypes) or because it’s the first use and the hyperlinks have been suppressed on first use. -

    Note that

    Note that \glsifhyper is now deprecated. If you want to know if the command used to reference this entry was used with the star or plus variant, you can use: -

    \glslinkvar  star⟩}{⟨plus⟩}
    -

    +

    This will do ⟨unmodified⟩ if the unmodified version was used, or will do ⟨star⟩ if the starred @@ -14772,7 +14828,7 @@ command shouldn’t be used to guess whether or not the hyperlink is on for reference. -

    Note that you can also use commands such as

    Note that you can also use commands such as \ifglsused within the definition of \glsentryfmt (see §14 Unsetting and Resetting Entry Flags). -

    The commands

    The commands \glslabel, \glstype\glspostlinkhook\glslinkpostsetkeys. -

    This means that using commands like

    This means that using commands like \gls within the fields that are accessed using the \glspostlinkhook which may need to look ahead as well as look behind). This means that any nested commands will, at the very least, change the label stored in \glslabel.
    -

    -

    If you only want to make minor modifications to

    +

    If you only want to make minor modifications to \glsentryfmt, you can use -

    \glsgenentryfmt  \glsgenentryfmt
    -

    +

    This uses the above commands to display just the first, pluralfirstplural keys (or the custom text) with the insert text appended. -

    Alternatively, if want to change the entry format for abbreviations (defined via +

    Alternatively, if want to change the entry format for abbreviations (defined via \newacronym) you can use: -

    \glsgenacfmt  \glsgenacfmt
    -

    +

    This uses the values from the long, firstfirstplural keys. The first use singular text is obtained via: -

    \genacrfullformat  label⟩}{⟨insert⟩}
    -

    +

    instead of from the first key, and the first use plural text is obtained via: -

    \genplacrfullformat  label⟩}{⟨insert⟩}
    -

    +

    instead of from the firstplural key. In both cases, ⟨\firstacronymfont. There are also first letter upper case versions: -

    \Genacrfullformat  label⟩}{⟨insert⟩}
    -

    +

    and -

    \Genplacrfullformat  label⟩}{⟨insert⟩}
    -

    +

    By default these perform a protected expansion on their no-case-change equivalents and then use \makefirstuc§13 Acronyms and Other Abbreviations for further details on changing the style of acronyms. -

    Note that

    Note that \glsentryfmt (or the formatting given by \defglsentryfmt) is not used by the \glstext-like commands.
    -

    -

    As from version 4.16, both the

    +

    As from version 4.16, both the \gls-like and \glstext-like commands use -

    \glslinkpostsetkeys  \glslinkpostsetkeys
    -

    +

    after the ⟨options⟩ are set. This macro does nothing by default but can be redefined. (For example, to switch off the hyperlink under certain conditions.) This version also introduces -

    \glspostlinkhook  \glspostlinkhook
    -

    +

    which is done after the link text has been displayed and also after the first use flag has been @@ -14994,11 +15050,11 @@ unset (see example 25). -

    Example 8 (Custom Entry Display in Text) -

    Suppose you want a glossary of measurements and units, you can use the

    Suppose you want a glossary of measurements and units, you can use the symbol key to store the unit: @@ -15010,7 +15066,7 @@ store the unit:  
    description={The length between two points},  
    symbol={km}}

    -

    and now suppose you want

    and now suppose you want \gls{distance} to produce “distance (km)” on first use, then you can redefine \glsentryfmt  \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%  
    }

    -

    -

    (Note that I’ve used

    +

    (Note that I’ve used \glsentrysymbol rather than \glssymbol to avoid nested hyperlinks.) -

    Note also that all of the

    Note also that all of the link text will be formatted according to \glstextformat\glstextformat  \ifglsused{\glslabel}{}{\space(\glsentrysymbol{\glslabel})}%  
    }

    -

    then

    then \gls{distance} will produce “distance (km)”. -

    For a complete document, see the sample file

    For a complete document, see the sample file sample-entryfmt.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 9 (Custom Format for Particular Glossary) -

    Suppose you have created a new glossary called

    Suppose you have created a new glossary called notation and you want to change the way the entry is displayed on first use so that it includes the symbol, you can @@ -15077,7 +15133,7 @@ do:  
     \ifglsused{\glslabel}{}{\space  
       (denoted \glsentrysymbol{\glslabel})}}

    -

    Now suppose you have defined an entry as follows: +

    Now suppose you have defined an entry as follows:

    @@ -15088,13 +15144,13 @@ do:  
      symbol={$S$}  
    }
    -

    The

    The first time you reference this entry it will be displayed as: “set (denoted S)” (assuming \gls was used). -

    Alternatively, if you expect all the symbols to be set in math mode, you can +

    Alternatively, if you expect all the symbols to be set in math mode, you can do: @@ -15104,7 +15160,7 @@ do:  
     \ifglsused{\glslabel}{}{\space  
       (denoted $\glsentrysymbol{\glslabel}$)}}

    -

    and define entries like this: +

    and define entries like this:

    @@ -15115,21 +15171,21 @@ do:  
      symbol={S}  
    }
    -

    +

    -

    -

    ____________________________

    -

    Remember that if you use the

    +

    ____________________________

    +

    Remember that if you use the symbol key, you need to use a glossary style that displays the symbol, as many of the styles ignore it. -

    +

    -

    Top

    6.4 Enabling and disabling hyperlinks to glossary entries

    -

    If you load the

    If you load the hyperref or htmlhypernohypertypes package option). -

    You can disable or enable links using: -

    You can disable or enable links using: +

    \glsdisablehyper  \glsdisablehyper
    -

    +

    and -

    \glsenablehyper  \glsenablehyper
    -

    +

    respectively. The effect can be localised by placing the commands within a group. Note that you should only use \glsenablehyper if the commands \hypertargethyperref package). -

    You can disable just the

    You can disable just the first use links using the package option hyperfirst=false. Note @@ -15181,11 +15237,11 @@ href="#glo:firstuseflag">first use flag. -

    Example 10 (First Use With Hyperlinked Footnote Description) -

    Suppose I want the first use to have a hyperlink to the description in a footnote instead of +

    Suppose I want the first use to have a hyperlink to the description in a footnote instead of hyperlinking to the relevant place in the glossary. First I need to disable the hyperlinks on first use via the package option hyperfirst=falsehyperfirst=false \usepackage[hyperfirst=false]{glossaries}

    -

    Now I need to redefine

    Now I need to redefine \glsentryfmt (see ):  
      \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%  
    }

    -

    -

    Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the +

    +

    Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file sample-FnDesc.tex for a complete document.

    -

    -

    ____________________________

    -

    Note that the

    +

    ____________________________

    +

    Note that the hyperfirst option applies to all defined glossaries. It may be that you only want to disable the hyperlinks on hyperfirst -

    Example 11 (Suppressing Hyperlinks on First Use Just For Acronyms) -

    Suppose I want to suppress the hyperlink on

    Suppose I want to suppress the hyperlink on first use for acronyms but not for entries in the main glossary. I can load the glossaries package using: @@ -15255,20 +15311,20 @@ class="cmss-10">glossaries package using:

    \usepackage[hyperfirst=false,acronym]{glossaries}
    -

    Once all glossary entries have been defined I then do: +

    Once all glossary entries have been defined I then do:

    \glsunsetall[main]
    -

    +

    -

    -

    ____________________________

    -

    For more complex requirements, you might find it easier to switch off all hyperlinks via +

    +

    ____________________________

    +

    For more complex requirements, you might find it easier to switch off all hyperlinks via \glsdisablehyper and put the hyperlinks (where required) within the definition of @@ -15286,11 +15342,11 @@ class="tcrm-1000">§9 href="#sec:glsnolink">Using Glossary Terms Without Links). -

    Example 12 (Only Hyperlink in Text Mode Not Math Mode) -

    This is a bit of a contrived example, but suppose, for some reason, I only want the +

    This is a bit of a contrived example, but suppose, for some reason, I only want the \gls-like commands to have hyperlinks when used in text mode, but not in math mode. @@ -15313,24 +15369,24 @@ class="cmtt-10">\glsentryfmt  \fi  
    }

    -

    Note that this doesn’t affect the

    Note that this doesn’t affect the \glstext-like commands, which will have the hyperlinks off unless they’re forced on using the plus variant. -

    See the sample file

    See the sample file sample-nomathhyper.tex for a complete document.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 13 (One Hyper Link Per Entry Per Chapter) -

    Here’s a more complicated example that will only have the hyperlink on the first time an +

    Here’s a more complicated example that will only have the hyperlink on the first time an entry is used per chapter. This doesn’t involve resetting the first use flag. Instead it adds a new key using \glsaddstoragekey{chapter}{0}{\glschapnum}

    -

    This creates a new user command called

    This creates a new user command called \glschapnum that’s analogous to \glsentrytext. The default value for this key is 0. I then define my glossary entries as usual. -

    Next I redefine the hook

    Next I redefine the hook \glslinkpostsetkeys (see \glsifhyperon.  
     \fi  
    }

    -

    Note that this will be confused if you use

    Note that this will be confused if you use \gls etc when the chapter counter is 0. (That is, before the first \chapter.) -

    See the sample file

    See the sample file sample-chap-hyperfirst.tex for a complete document.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    7. Adding an Entry to the Glossary Without Generating Text

    -

    It is possible to add a line to the glossary file without generating any text at that point in +

    It is possible to add a line to the glossary file without generating any text at that point in the document using: -

    \glsadd  options⟩]{⟨label⟩}
    -

    +

    This is similar to the \glstext-like commands, only it doesn’t produce any text (so @@ -15442,16 +15498,16 @@ class="cmtt-10">set:  
    Lots of text about sets spanning many pages.  
    \glsadd[format=)]{set}

    -

    -

    To add all entries that have been defined, use: -

    +

    To add all entries that have been defined, use: +

    \glsaddall  \glsaddall[⟨options⟩]
    -

    +

    The optional argument is the same as for \glsadd, except there is also a key typesnotation) then you can do:

    -

    -

    Note that

    +

    Note that \glsadd and \glsaddall add the current location to the number listnonumberlist2.3 and 5.)
    -

    -

    There is now a variation of

    +

    There is now a variation of \glsaddall that skips any entries that have already been used: -

    \glsaddallunused  \glsaddallunused[⟨list⟩]
    -

    +

    This command uses \glsadd[format=@gobble] which will ignore this location in the number list. The optional argument ⟨list⟩ is a comma-separated list of glossary types. If omitted, it defaults to the list of all defined glossaries. -

    If you want to use

    If you want to use \glsaddallunused, it’s best to place the command at the end of the document to ensure that all the commands you intend to use have already been used. Otherwise you could end up with a spurious comma or dash in the location list. -

    Example 14 (Dual Entries) -

    The example file

    The example file sample-dual.tex makes use of \glsadd to allow for an entry that @@ -15526,7 +15582,7 @@ class="cmss-10">acronym \usepackage[acronym]{glossaries}

    -

    A new command is then defined to make it easier to define dual entries: +

    A new command is then defined to make it easier to define dual entries:

    @@ -15540,7 +15596,7 @@ class="cmss-10">acronym      \newacronym{#2}{#3\glsadd{main-#2}}{#4}%  
    }
    -

    This has the following syntax:

    +

    This has the following syntax:

    \newdualentry}  
      {support vector machine}% long form  
      {Statistical pattern recognition technique}% description
    -

    Now you can reference the acronym with

    Now you can reference the acronym with \gls{svm} or you can reference the entry in the main glossary with \gls{main-svm}.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    8. Cross-Referencing Entries

    -

    You must use

    You must use \makeglossaries (Options 2 or \makenoidxglossaries before all entry definitions. The glossaries-extra package provides better cross-reference handling.
    -

    -

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

    +

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

    1. You can use commands such as \glsdescription={firm, round fruit. See also \gls{pear}}}
    -

    Note that with this method, if you don’t use the cross-referenced term in the main part +

    Note that with this method, if you don’t use the cross-referenced term in the main part of the document, you will need two runs of makeglossariesmakeglossariesmakeglossaries filename  
    latex filename

    -

    +

  • As described in seedescription={Series expansion},  
    see={TaylorsTheorem}}
    • -

    Note that in this case, the entry with the

    Note that in this case, the entry with the see key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you @@ -15656,7 +15712,7 @@ href="#sec:glsadd">§7 Adding an Entry to the Glossary Without Generating Text. -

    The “see” tag is produce using

    The “see” tag is produce using \seename, but can be overridden in specific instances using square brackets at the start of the seedescription={Series expansion},  
    see=[see also]{TaylorsTheorem}}

    -

    Take care if you want to use the optional argument of commands such as

    Take care if you want to use the optional argument of commands such as \newacronym or \newterm\newterm[see={[see also]seal}]{sea lion}

    -

    Similarly if the value contains a list. For example: +

    Similarly if the value contains a list. For example:

    @@ -15705,11 +15761,11 @@ class="cmtt-10">\newterm      see={lemon,lime}  
    }
    -

    +

  • After you have defined the entry, use -

    \glssee  label⟩}{⟨xr label list⟩}
    -

    +

    where ⟨xr label list⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨label⟩ @@ -15736,12 +15792,12 @@ class="cmtt-10">\seename \glssee[see also]{series}{FourierSeries,TaylorsTheorem}

    -

    Note that this automatically adds the entry given by ⟨

    Note that this automatically adds the entry given by ⟨label⟩ to the glossary but doesn’t add the cross-referenced entries (specified by ⟨xr label list⟩) to the glossary.

    • -

    In both cases 2 and 3 above, the cross-referenced information appears in the

    In both cases 2 and 3 above, the cross-referenced information appears in the number list, whereas in case 1, the cross-referenced information appears in the description. (See the @@ -15765,15 +15821,15 @@ class="cmss-10">seeautonumberlist package option.

    -

    Top

    8.1 Customising Cross-reference Text

    -

    When you use either the

    When you use either the see key or the command \glssee, the cross-referencing information will be typeset in the glossary according to: -

    \glsseeformat  label-list⟩}{⟨location⟩}
    -

    +

    The default definition of \glsseeformat is:
    8.2 \glsseelist{#2}}

    -

    -

    The list of labels is dealt with by

    +

    The list of labels is dealt with by \glsseelist, which iterates through the list and typesets each entry in the label. The entries are separated by -

    \glsseesep  \glsseesep
    -

    +

    or (for the last pair) -

    \glsseelastsep  \glsseelastsep
    -

    +

    These default to “,\space” and “\space\andname\space” respectively. The list entry text is displayed using: -

    \glsseeitemformat  \glsseeitemformat{⟨label⟩}
    -

    +

    This defaults to \glsentrytext  \textsc{\glsentrytext{#1}}}

    -

    -

    You can use

    +

    You can use \glsseeformat and \glsseelist\glsseelist{FourierSeries,TaylorsTheorem}%  
    \glsadd{FourierSeries}\glsadd{TaylorsTheorem}).
    -

    -

    +

    +

    -

    -

    +

    Top

    9. Using Glossary Terms Without Links

    -

    The commands described in this section display entry details without adding any +

    The commands described in this section display entry details without adding any information to the glossary. They don’t use \glstextformat, they don’t have any optional @@ -15889,7 +15945,7 @@ href="#glo:firstuseflag">first use flag and, apart from \glshyperlink, they don’t produce hyperlinks. -

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need +

    Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need to provide an alternative via hyperref’s hyperref -

    -

    If you want to title case a field, you can use: -

    +

    If you want to title case a field, you can use: +

    \glsentrytitlecase  label⟩}{⟨field⟩}
    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see \glsentrytitlecase{sample}{desc}

    -

    (If you want title-casing in your glossary style, you might want to investigate the +

    (If you want title-casing in your glossary style, you might want to investigate the glossaries-extra package.) -

    Note that this command has the same limitations as

    Note that this command has the same limitations as \makefirstuc which is used by commands like \Gls and §6.1 The \gls-Like Commands (First Use Flag Queried)). -

    \glsentryname  \glsentryname{⟨label⟩}
    -

    -

    +

    \Glsentryname  \Glsentryname{⟨label⟩}
    -

    +

    These commands display the name of the glossary entry given by ⟨label⟩, as specified by the \glsentrytext or \glsentryfirst instead of \glsentryname. -

    In general it’s best to avoid

    In general it’s best to avoid \Glsentryname with abbreviations. Instead, consider using \Glsentrylong, \Glsentryshort or \Glsentryfull.
    -

    -

    +

    \glossentryname  \glossentryname{⟨label⟩}
    -

    +

    This is like \glsnamefont{ \renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}}

    -

    -

    +

    \Glossentryname  \Glossentryname{⟨label⟩}
    -

    +

    This is like \glossentryname but makes the first letter of the name upper case. -

    \glsentrytext  \glsentrytext{⟨label⟩}
    -

    -

    +

    \Glsentrytext  \Glsentrytext{⟨label⟩}
    -

    +

    These commands display the subsequent use text for the glossary entry given by ⟨label⟩, as specified by the \Glsentrytext makes the first letter upper case. The firs expandable (unless the text contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsentryplural  \glsentryplural{⟨label⟩}
    -

    -

    +

    \Glsentryplural  \Glsentryplural{⟨label⟩}
    -

    +

    These commands display the subsequent use plural text for the glossary entry given by ⟨label⟩, as specified by the label⟩. -

    \glsentryfirst  \glsentryfirst{⟨label⟩}
    -

    -

    +

    \Glsentryfirst  \Glsentryfirst{⟨label⟩}
    -

    +

    These commands display the first use text for the glossary entry given by ⟨label⟩, @@ -16096,22 +16152,22 @@ The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsentryfirstplural  \glsentryfirstplural{⟨label⟩}
    -

    -

    +

    \Glsentryfirstplural  \Glsentryfirstplural{⟨label⟩}
    -

    +

    These commands display the plural form of the first use text for the glossary entry given by ⟨label⟩. -

    \glsentrydesc  \glsentrydesc{⟨label⟩}
    -

    -

    +

    \Glsentrydesc  \Glsentrydesc{⟨label⟩}
    -

    +

    These commands display the description for the glossary entry given by ⟨label⟩. \Glsentrydesc @@ -16148,14 +16204,14 @@ makes the first letter upper case. The first form is expandable (unless the valu contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glossentrydesc  \glossentrydesc{⟨label⟩}
    -

    +

    This is like \glsentrydesc{⟨label⟩} but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in the predefined glossary styles to display the description. -

    \Glossentrydesc  \Glossentrydesc{⟨label⟩}
    -

    +

    This is like \glossentrydesc but converts the first letter to upper case. This command is not expandable. -

    \glsentrydescplural  \glsentrydescplural{⟨label⟩}
    -

    -

    +

    \Glsentrydescplural  \Glsentrydescplural{⟨label⟩}
    -

    +

    These commands display the plural description for the glossary entry given by ⟨label⟩. \Glsentrydescplural makes the first letter upper case. Th the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsentrysymbol  \glsentrysymbol{⟨label⟩}
    -

    -

    +

    \Glsentrysymbol  \Glsentrysymbol{⟨label⟩}
    -

    +

    These commands display the symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbol @@ -16220,7 +16276,7 @@ makes the first letter upper case. The first form is expandable (unless the valu contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsletentryfield  label⟩}{⟨field⟩}
    -

    +

    This command doesn’t display anything. It merely fetches the value associated with the given field (where the available field names are listed in table 4.1) and stores the result in the @@ -16245,15 +16301,15 @@ class="cmtt-10">\tmp:

    \glsletentryfield{\tmp}{apple}{desc}
    -

    -

    +

    \glossentrysymbol  \glossentrysymbol{⟨label⟩}
    -

    +

    This is like \glsentrysymbol{⟨label⟩} but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in some of the predefined glossary styles to display the symbol. -

    \Glossentrysymbol  \Glossentrysymbol{⟨label⟩}
    -

    +

    This is like \glossentrysymbol but converts the first letter to upper case. This command is not expandable. -

    \glsentrysymbolplural  \glsentrysymbolplural{⟨label⟩}
    -

    -

    +

    \Glsentrysymbolplural  \Glsentrysymbolplural{⟨label⟩}
    -

    +

    These commands display the plural symbol for the glossary entry given by ⟨label⟩. \Glsentrysymbolplural makes the first letter upper case. (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsentryuseri  \glsentryuseri{⟨label⟩}
    -

    -

    +

    \Glsentryuseri  \Glsentryuseri{⟨label⟩}
    -

    -

    +

    \glsentryuserii  \glsentryuserii{⟨label⟩}
    -

    -

    +

    \Glsentryuserii  \Glsentryuserii{⟨label⟩}
    -

    -

    +

    \glsentryuseriii  \glsentryuseriii{⟨label⟩}
    -

    -

    +

    \Glsentryuseriii  \Glsentryuseriii{⟨label⟩}
    -

    -

    +

    \glsentryuseriv  \glsentryuseriv{⟨label⟩}
    -

    -

    +

    \Glsentryuseriv  label⟩}
    -

    -

    +

    \glsentryuserv  \glsentryuserv{⟨label⟩}
    -

    -

    +

    \Glsentryuserv  \Glsentryuserv{⟨label⟩}
    -

    -

    +

    \glsentryuservi  \glsentryuservi{⟨label⟩}
    -

    -

    +

    \Glsentryuservi  \Glsentryuservi{⟨label⟩}
    -

    +

    These commands display the value of the user keys for the glossary entry given by ⟨label⟩. The lower case forms are expandable (unless the value of the key contains unexpandable @@ -16400,7 +16456,7 @@ commands). The commands beginning with an upper case letter convert the first le required value to upper case and are not expandable. None of these commands check for the existence of ⟨label⟩. -

    \glshyperlink  link text⟩]{⟨label⟩}
    -

    +

    This command provides a hyperlink to the glossary entry given by ⟨label⟩ but does not add @@ -16430,7 +16486,7 @@ class="cmtt-10">\glsdisablehyperhyperref package. -

    If you use

    If you use \glshyperlink, you need to ensure that the relevant entry has been added to the glossary using any of the commands described in §7 Adding an Entry to the Glossary Without Generating Text otherwise you will end up with an undefined link.
    -

    -

    The next two commands are only available with

    +

    The next two commands are only available with Option 1 or with the savenumberlist package option: -

    \glsentrynumberlist  \glsentrynumberlist{⟨label⟩}
    -

    -

    +

    \glsdisplaynumberlist  \glsdisplaynumberlist{⟨label⟩}
    -

    +

    Both display the number list for the entry given by ⟨xindy) followed by one or two runs of LATEX is required. -

    The first command,

    The first command, \glsentrynumberlist, simply displays the number list as is. The second command, \glsdisplaynumberlist, formats the list using: -

    \glsnumlistsep  \glsnumlistsep
    -

    +

    as the separator between all but the last two elements and -

    \glsnumlistlastsep  \glsnumlistlastsep
    -

    +

    between the final two elements. The defaults are ,␣ and ␣\&␣, respectively. -

    \glsdisplaynumberlist is fairly experimental. It works with Option 1, but for Options hyperref, \glsentrynumberlist will be used instead.
    -

    -

    For further information see “Displaying entry details without adding information to the +

    +

    For further information see “Displaying entry details without adding information to the glossary” in the documented code (glossaries-code.pdf).

    -

    -

    +

    Top

    10. Displaying a glossary

    -

    All defined glossaries may be displayed using: +

    All defined glossaries may be displayed using:

    Option 1:
    -

    \printnoidxglossaries  \printnoidxglossaries
    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) @@ -16565,16 +16621,16 @@ href="#option3">3:

    -

    \printglossaries  \printglossaries
    -

    +

    (Must be used with \makeglossaries in the preamble.)

    -

    These commands will display all the glossaries in the order in which they were defined. +

    These commands will display all the glossaries in the order in which they were defined. Note that, in the case of Options 2 and 3, no glossaries will appear until you have either used @@ -16608,7 +16664,7 @@ class="cmtt-10">\printunsrtglossaries as an alternative. See the glossaries-extra manual for further details.) -

    If the glossary still does not appear after you re-LAT

    If the glossary still does not appear after you re-LATEX your document, check the makeindexEX runs to make the glossaries appear, but number lists up-to-date. -

    An individual glossary can be displayed using: +

    An individual glossary can be displayed using:

    Option 1:
    -

    \printnoidxglossary  \printnoidxglossary[⟨options⟩]
    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) @@ -16652,18 +16708,18 @@ href="#option3">3:

    -

    \printglossary  \printglossary[⟨options⟩]
    -

    +

    (Must be used with \makeglossaries in the preamble.)

    -

    where ⟨

    where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. (Again, when the associated external file is missing, @@ -16671,7 +16727,7 @@ class="cmti-10">value⟩ list of options. (Again, when the associate class="cmtt-10">\null is inserted into the document.) -

    The following keys are available: +

    The following keys are available:

    typeThe value of this key specifies which glossary to print. If
    \printglossary[type=\acronymtype]
    -

    Note that you can’t display an ignored glossary, so don’t try setting

    Note that you can’t display an ignored glossary, so don’t try setting type to the name of a glossary that was defined using Option 4). href="#glo:bib2gls">bib2gls provides many other sort options. -

    If you use the

    If you use the use or 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 nogroupskip option.
    -

    -

    The +

    +

    The word and letter @@ -16883,7 +16939,7 @@ class="cmss-10">datatool

    If you don’t get an error with

    If you don’t get an error with sort=use and sort=def but you do get an error with one of the other sort options, then you probably need to use the sanitizesort=truesort field.

    -

    By default, the glossary is started either by

    By default, the glossary is started either by \chapter* or by \section*numberedsection package option. Each glossary sets the page header via the command -

    \glsglossarymark  \glsglossarymark{⟨title⟩}
    -

    +

    If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine \glsglossarymark§2.2 Sectioning, Headings and TOC Options. -

    Information can be added to the start of the glossary (after the title and before the main +

    Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -

    \glossarypreamble  \glossarypreamble
    -

    +

    For example: @@ -16944,9 +17000,9 @@ For example: \renewcommand{\glossarypreamble}{Numbers in italic  
    indicate primary definitions.}

    -

    This needs to be done before the glossary is displayed. -

    If you want a different preamble per glossary you can use -

    This needs to be done before the glossary is displayed. +

    If you want a different preamble per glossary you can use +

    \setglossarypreamble  type⟩]{⟨preamble text⟩}
    -

    +

    If ⟨type⟩ is omitted, \glsdefaulttype is used. -

    For example: +

    For example:

    @@ -16967,24 +17023,24 @@ class="cmtt-10">\glsdefaulttype     is used. \setglossarypreamble{Numbers in italic  
    indicate primary definitions.}
    -

    This will print the given preamble text for the main glossary, but not have any preamble text +

    This will print the given preamble text for the main glossary, but not have any preamble text for any other glossaries. -

    There is an analogous command to

    There is an analogous command to \glossarypreamble called -

    \glossarypostamble  \glossarypostamble
    -

    +

    which is placed at the end of each glossary. -

    Example 15 (Switch to Two Column Mode for Glossary) -

    Suppose you are using the

    Suppose you are using the superheaderborder style}  
    \renewcommand*{\glossarypostamble}{\onecolumn}

    -

    +

    -

    -

    ____________________________

    -

    Within each glossary, each entry name is formatted according to -

    +

    ____________________________

    +

    Within each glossary, each entry name is formatted according to +

    \glsnamefont  \glsnamefont{⟨name⟩}
    -

    +

    which takes one argument: the entry name. This command is always used regardless of the glossary style. By default, \glsnamefont simply displays its argument in whatever the @@ -17036,20 +17092,20 @@ hierarchical glossary styles (defined in the glossary-tree style file) also set the name in bold. -

    If you want to change the font for the description, or if you only want to change the name +

    If you want to change the font for the description, or if you only want to change the name font for some types of entries but not others, you might want to consider using the glossaries-extra package. -

    Example 16 (Changing the Font Used to Display Entry Names in the Glossary) -

    Suppose you want all the entry names to appear in medium weight small caps in your +

    Suppose you want all the entry names to appear in medium weight small caps in your glossaries, then you can do: @@ -17057,18 +17113,18 @@ glossaries, then you can do:

    \renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    11. Xindy (Option 3)

    -

    If you want to use

    If you want to use xindy to sort the glossary, you must use the package option @@ -17081,10 +17137,10 @@ class="cmss-10">xindy \usepackage[xindy]{glossaries}

    -

    This ensures that the glossary information is written in

    This ensures that the glossary information is written in xindy syntax. -

    §1.5 Generating the Associated Glossary Files covers how to use the external xindy.xdy) and parameters. -

    To assist writing information to the

    To assist writing information to the xindy style file, the glossaries package provides the following commands: -

    \glsopenbrace  \glsopenbrace
    -

    -

    +

    \glsclosebrace  \glsclosebrace
    -

    +

    which produce an open and closing brace. (This is needed because \{ and \} don’t expand to a simple brace character when written to a file.) Similarly, you can write a percent character using: -

    \glspercentchar  \glspercentchar
    -

    +

    and a tilde character using: -

    \glstildechar  \glstildechar
    -

    +

    For example, a newline character is specified in a xindy~n so you can use class="cmtt-10">\glstildechar n to write this correctly (or you can do \string~n). A backslash can be written to a file using -

    \glsbackslash  \glsbackslash
    -

    -

    In addition, if you are using a package that makes the double quote character active (e.g. +

    +

    In addition, if you are using a package that makes the double quote character active (e.g. ngerman) you can use: -

    \glsquote  \glsquote{⟨text⟩}
    -

    +

    which will produce "⟨text⟩\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 " for clarity. -

    If you want greater control over the

    If you want greater control over the xindy style file than is available through the @@ -17202,10 +17258,10 @@ class="cmtt-10">http://xindy.sourceforge.net/mailing-list.html).

    -

    Top

    11.1 Language and Encodings

    -

    When you use

    When you use xindy, you need to specify the language and encoding used (unless you @@ -17227,7 +17283,7 @@ language given your document settings, but in the event that it gets it wrong or class="cmtt-10">xindy doesn’t support that language, then you can specify the required language using: -

    \GlsSetXdyLanguage  glossary type⟩]{⟨language⟩}
    -

    +

    where ⟨language⟩ is the name of the language. The optional argument can be used if you have multiple glossaries in different languages. If ⟨glossary type⟩ is omitted, it will be applied to a glossaries, otherwise the language setting will only be applied to the glossary given by ⟨glossary type⟩. -

    If the

    If the inputenc package is used, the encoding will be obtained from the value of \inputencodingname. Alternatively, you can specify the encoding using: -

    \GlsSetXdyCodePage  \GlsSetXdyCodePage{⟨code⟩}
    -

    +

    where ⟨code⟩ is the name of the encoding. For example: @@ -17266,8 +17322,8 @@ class="cmti-10">code⟩ is the name of the encoding. For example:

    \GlsSetXdyCodePage{utf8}
    -

    -

    Note that you can also specify the language and encoding using the package option +

    +

    Note that you can also specify the language and encoding using the package option xindy={language=⟨lang⟩}. For example:

    \usepackage[xindy={language=english,codepage=utf8}]{glossaries}
    -

    -

    If you write your own custom

    +

    If you write your own custom xindy style file that includes the language settings, you need @@ -17292,10 +17348,10 @@ to set the language to nothing:

    \GlsSetXdyLanguage{}
    -

    (and remember to use

    (and remember to use \noist to prevent the style file from being overwritten). -

    The commands

    The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have no effect if you don’t use -L-C switches.
    -

    -

    +

    +

    -

    Top

    11.2 Locations and Number lists

    -

    If you use

    If you use xindy, the glossaries package needs to know which counters you will be using in the @@ -17345,17 +17401,17 @@ class="cmti-10">before \makeglossaries using: -

    \GlsAddXdyCounters  \GlsAddXdyCounters{⟨counter list⟩}
    -

    +

    where ⟨counter list⟩ is a comma-separated list of counter names. -

    The most likely attributes used in the

    The most likely attributes used in the format key (textrmxindy style file, but if you want to use another attribute, you need to add it using: -

    \GlsAddXdyAttribute  \GlsAddXdyAttribute{⟨name⟩}
    -

    +

    where ⟨name⟩ is the name of the attribute, as used in the format key. -

    Take care if you have multiple instances of the same location with different formats. The +

    Take care if you have multiple instances of the same location with different formats. The duplicate locations will be discarded according to the order in which the attributes are listed. Consider defining semantic commands to use for primary references. For example: @@ -17390,7 +17446,7 @@ example: \newcommand*{\primary}[1]{\textbf{#1}}  
    \GlsAddXdyAttribute{primary}

    -

    Then in the document: +

    Then in the document:

    @@ -17398,18 +17454,18 @@ example: A \gls[format=primary]{duck} is an aquatic bird.  
    There are lots of different types of \gls{duck}.
    -

    This will give the

    This will give the format=primary instance preference over the next use that doesn’t use the format key. -

    Example 17 (Custom Font for Displaying a Location) -

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that +

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this: @@ -17417,7 +17473,7 @@ will do this:

    \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}
    -

    but with

    but with xindy, I also need to add this as an allowed attribute: @@ -17427,7 +17483,7 @@ class="cmtt-10">xindy \GlsAddXdyAttribute{hyperbfit}

    -

    Now I can use it in the optional argument of commands like

    Now I can use it in the optional argument of commands like \gls: @@ -17436,13 +17492,13 @@ class="cmtt-10">\gls Here is a \gls[format=hyperbfit]{sample} entry.

    -

    (where

    (where sample is the label of the required entry).

    -

    -

    ____________________________

    -

    Note that

    +

    ____________________________

    +

    Note that \GlsAddXdyAttribute has no effect if \noist is used or if \makeglossaries\GlsAddXdyCounters must come before \GlsAddXdyAttribute.
    -

    -

    If the location numbers include formatting commands, then you need to add a location +

    +

    If the location numbers include formatting commands, then you need to add a location style in the appropriate format using -

    \GlsAddXdyLocation  }{⟨definition⟩}
    -

    +

    where ⟨name⟩ is the name of the format and ⟨definition⟩ is the §5.2 Locations for some issues that you may encounter. -

    Note that

    Note that \GlsAddXdyLocation has no effect if \noist is used or if \GlsAddXdyLocation must be used before \makeglossaries.
    -

    +

    -

    Example 18 (Custom Numbering System for Locations) -

    Suppose I decide to use a somewhat eccentric numbering system for sections where I +

    Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine \thesection as follows: @@ -17514,7 +17570,7 @@ class="cmtt-10">\thesection as follows:

    \renewcommand*{\thesection}{[\thechapter]\arabic{section}}
    -

    If I haven’t done

    If I haven’t done counter=section in the package option, I need to specify that the counter will be used as a location number: @@ -17523,7 +17579,7 @@ will be used as a location number:

    \GlsAddXdyCounters{section}
    -

    Next I need to add the location style (

    Next I need to add the location style (\thechapter is assumed to be the standard \arabic{chapter}): @@ -17535,7 +17591,7 @@ class="cmtt-10">\arabic{chapter}):  
      "arabic-numbers"  
    }

    -

    Note that if I have further decided to use the

    Note that if I have further decided to use the hyperref package and want to redefine \theHsection as: \renewcommand*{\theHsection}{\thepart.\thesection}  
    \renewcommand*{\thepart}{\Roman{part}}

    -

    then I need to modify the

    then I need to modify the \GlsAddXdyLocation code above to: @@ -17557,7 +17613,7 @@ class="cmtt-10">\GlsAddXdyLocation code above to:  
      "arabic-numbers" :sep "]" "arabic-numbers"  
    }

    -

    Since

    Since \Roman will result in an empty string if the counter is zero, it’s a good idea to add an extra location to catch this: @@ -17569,20 +17625,20 @@ extra location to catch this:  
      "arabic-numbers" :sep "]" "arabic-numbers"  
    }

    -

    This example is illustrated in the sample file

    This example is illustrated in the sample file samplexdy2.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 19 (Locations as Dice) -

    Suppose I want a rather eccentric page numbering system that’s represented by the +

    Suppose I want a rather eccentric page numbering system that’s represented by the number of dots on dice. The stix package provides Locations:  
     \fi  
    }

    -

    Here’s the counter command: +

    Here’s the counter command:

    newcommand{\tally}[1]{\tallynum{\arabic{#1}}}
    -

    The

    The page counter representation (\thepage) needs to be changed to use this command: @@ -17634,7 +17690,7 @@ class="cmtt-10">\thepage) needs to be changed to use this command:

    \renewcommand*{\thepage}{\tally{page}}
    -

    The

    The \tally command expands to \tallynum {⟨number⟩ :sep "\glsclosebrace"  
    }

    -

    The space between

    The space between \tallynum and {⟨number⟩xindy so \space is required. -

    Note that

    Note that \GlsAddXdyLocation{⟨name⟩}{⟨definition⟩} will define commands in the form: -

    \glsX⟨counter⟩X⟨Hprefix⟩}{⟨location⟩}
    -

    +

    for each counter that has been identified either by the counter package option, the ⟨\Hprefix.\the⟨counter⟩. -

    The sample file

    The sample file samplexdy.tex, which comes with the glossaries package, uses the default @@ -17732,7 +17788,7 @@ commands:  
    }  
    \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}}

    -

    Note that the second argument of

    Note that the second argument of \glsXpageXglsnumberformat is in the format \tallynum } so the line

     \linkpagenumber#2%
    -

    does

    +

    does

     \linkpagenumber\tallynum{⟨number⟩ is the second argument.
    -

    -

    ____________________________

    -

    This method is very sensitive to the internal definition of the location command. +

    +

    ____________________________

    +

    This method is very sensitive to the internal definition of the location command.
    -

    +

    -

    Example 20 (Locations as Words not Digits) -

    Suppose I want the page numbers written as words rather than digits and I use the +

    Suppose I want the page numbers written as words rather than digits and I use the fmtcount package to do this. I can redefine \thepage \renewcommand*{\thepage}{\Numberstring{page}}

    -

    This

    This used to get expanded to \protect \Numberstringnum  \string\Numberstringnum\space\glsopenbrace"  
      "arabic-numbers" :sep "\glsclosebrace"}

    -

    and if I’d used the

    and if I’d used the \linkpagenumber command from the previous example, it would need three arguments (the first being \protect):

    \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}
    -

    -

    The internal definition of

    +

    The internal definition of \Numberstring has since changed so that it now expands to \Numberstringnum  :sep "\string\Numberstringnum\space\glsopenbrace"  
      "arabic-numbers" :sep "\glsclosebrace"}

    -

    and

    and \linkpagenumber goes back to only two arguments: @@ -17839,7 +17895,7 @@ class="cmtt-10">\linkpagenumber goes back to only two arguments:

    \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}}
    -

    The other change is that

    The other change is that \Numberstring uses

    §5.2 Locations). This means that the page number may be incorrect if the indexing occurs during the output routine. -

    A more recent change to

    A more recent change to fmtcount (v3.03) now puts three instances of \expandafter @@ -17873,10 +17929,10 @@ the page numbers should once more be correct. Further changes to the fmtcount package may cause a problem again. -

    When dealing with custom formats where the internal definitions are outside of your +

    When dealing with custom formats where the internal definitions are outside of your control and liable to change, it’s best to provide a wrapper command.
    -

    -

    Instead of directly using

    +

    Instead of directly using \Numberstring in the definition of \thepage, I can provide a custom command in the same form as the earlier \tally command: \newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}}  
    \newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}}

    -

    This ensures that the location will always be written to the indexing file in the form: +

    This ensures that the location will always be written to the indexing file in the form:

    }}"  
     "arabic-numbers"  
     :sep "\glsclosebrace"}
    -

    -

    The sample file

    +

    The sample file samplexdy3.tex illustrates this.

    -

    -

    ____________________________

    -

    In the

    +

    ____________________________

    +

    In the number list, the locations are sorted according to the list of provided location classes. The default ordering is: 11.3 This ordering can be changed using: -

    \GlsSetXdyLocationClassOrder  \GlsSetXdyLocationClassOrder{⟨location names⟩}
    -

    +

    where each location name is delimited by double quote marks and separated by white space. For example: @@ -17971,11 +18027,11 @@ For example:  
      "see"  
    }

    -

    (Remember to add

    (Remember to add "seealso" if you’re using glossaries-extra.) -

    Note that

    Note that \GlsSetXdyLocationClassOrder has no effect if \noist is used or if @@ -17986,20 +18042,20 @@ class="cmtt-10">\GlsSetXdyLocationClassOrder must be used before \makeglossaries.
    -

    -

    If a

    +

    If a 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: -

    \GlsSetXdyMinRangeLength  \GlsSetXdyMinRangeLength{⟨n⟩}
    -

    +

    For example: @@ -18007,13 +18063,13 @@ For example:

    \GlsSetXdyMinRangeLength{3}
    -

    The argument may also be the keyword

    The argument may also be the keyword none, to indicate that there should be no range formations. See the xindy manual for further details on range formations. -

    Note that

    Note that \GlsSetXdyMinRangeLength has no effect if \noist is used or if @@ -18024,17 +18080,17 @@ class="cmtt-10">\GlsSetXdyMinRangeLength must be used before \makeglossaries.
    -

    +

    See also §5.3 Range Formations. -

    +

    -

    Top

    11.3 Glossary Groups

    -

    The glossary is divided into groups according to the first letter of the sort key. The

    The glossary is divided into groups according to the first letter of the sort key. The glossaries package also adds a number group by default, unless you suppress it in the xindy \usepackage[xindy={glsnumbers=false}]{glossaries}

    -

    Any entry that doesn’t go in one of the letter groups or the number group is placed in the +

    Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group. If you want xindynumeric-sort module:

    -

    -

    If you don’t use

    +

    If you don’t use glsnumbers=false, the default behaviour is to locate the number group before the “A” letter group. If you are not using a Roman alphabet, you need to change this using: -

    \GlsSetXdyFirstLetterAfterDigits  \GlsSetXdyFirstLetterAfterDigits{⟨letter⟩}
    -

    +

    where ⟨letter⟩ is the first letter of your alphabet. Take care if you’re using inputencfontspec.) The starred form will sanitize the argument to prevent expansion. Alternatively you can use: -

    \GlsSetXdyNumberGroupOrder  \GlsSetXdyNumberGroupOrder{⟨relative location⟩}
    -

    +

    to change the default

    relative location⟩. For example:
    \GlsSetXdyNumberGroupOrder{:after \string"Z\string"}
    -

    will put the number group after the “Z” letter group. Again take care of active characters. +

    will put the number group after the “Z” letter group. Again take care of active characters. There’s a starred version that sanitizes the argument (so don’t use \string in it).

    @@ -18124,7 +18180,7 @@ class="cmtt-10">"}
    -

    Note that these commands have no effect if

    Note that these commands have no effect if \noist is used or if \makeglossaries\GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries.
    -

    +

    -

    -

    +

    Top

    12. Defining New Glossaries

    -

    A new glossary can be defined using: -

    A new glossary can be defined using: +

    \newglossary  title⟩}[⟨counter⟩]
    -

    +

    where ⟨name⟩ is the label to assign to this glossary. The arguments ⟨in-ext⟩ and ⟨log-ext⟩, ⟨in-ext⟩ and ⟨out-ext⟩ arguments are ignored. -

    The glossary label ⟨

    The glossary label ⟨name⟩ must not contain any active characters. It’s generally best to stick with just characters that have category code 11 (typically the non-extended Latin characters for standard LATEX).
    -

    -

    There is also a starred version (new to v4.08): -

    +

    There is also a starred version (new to v4.08): +

    \newglossary*  title⟩}[⟨counter⟩]
    -

    +

    which is equivalent to

    counter⟩]
    or you can also use: -

    \altnewglossary  title⟩}[⟨counter⟩]
    -

    +

    which is equivalent to

    counter⟩]
    -

    It may be that you have some terms that are so common that they don’t need to be listed. +

    It may be that you have some terms that are so common that they don’t need to be listed. In this case, you can define a special type of glossary that doesn’t create any associated files. This is referred to as an “ignored glossary” and it’s ignored by commands that iterate over all the glossaries, such as \printglossaries. To define an ignored glossary, use -

    \newignoredglossary  \newignoredglossary{⟨name⟩}
    -

    +

    where ⟨name⟩ is the name of the glossary (as above). This glossary type will automatically be @@ -18301,8 +18357,8 @@ an ignored glossary. (The sample file sample-entryfmt.tex defines an ignored glossary.) -

    You can test if a glossary is an ignored one using: -

    You can test if a glossary is an ignored one using: +

    \ifignoredglossary  true⟩}{⟨false⟩}
    -

    +

    This does ⟨true⟩ if ⟨name⟩ was defined as an ignored glossary, otherwise it does ⟨false⟩. -

    Note that the main (default) glossary is automatically created as: +

    Note that the main (default) glossary is automatically created as:

    \newglossary{main}{gls}{glo}{\glossaryname}
    -

    so it can be identified by the label

    so it can be identified by the label main (unless the nomain package option is used). Using @@ -18338,7 +18394,7 @@ class="cmss-10">acronym \newglossary[alg]{acronym}{acr}{acn}{\acronymname}

    -

    so it can be identified by the label

    so it can be identified by the label acronym. If you are not sure whether the acronym @@ -18357,7 +18413,7 @@ acronyms, you need to declare it as a list of acronyms using the package option acronymlists. -

    The

    The symbols package option creates a new glossary with the label symbols using: @@ -18367,7 +18423,7 @@ class="cmtt-10">symbols using:

    \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
    -

    The

    The numbers package option creates a new glossary with the label numbers using: @@ -18377,7 +18433,7 @@ class="cmtt-10">numbers using:

    \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
    -

    The

    The index package option creates a new glossary with the label index using: @@ -18387,14 +18443,14 @@ class="cmtt-10">index using:

    \newglossary[ilg]{index}{ind}{idx}{\indexname}
    -

    -

    Options 

    +

    Options 2 and 3: all glossaries must be defined before \makeglossaries to ensure that the relevant output files are opened. -

    See

    See §1.4.1 Changing the Fixed Names if you want to redefine \indexname, just follow the advice in How to change LaTeX’s “fixed names”.

    -

    +

    -

    -

    +

    Top

    13. Acronyms and Other Abbreviations

    -

    The

    The glossaries-extra package provides superior abbreviation handling. You may want to consider using that package instead of the commands described here. -

    Note that although this chapter uses the term “acronym”, you can also use the +

    Note that although this chapter uses the term “acronym”, you can also use the commands described here for initialisms or contractions (as in the case of some of the examples given below). If the glossary title is no longer applicable (for example, it should be “Abbreviations” rather than “Acronyms”) then you can change the @@ -18445,8 +18501,8 @@ class="cmss-10">glossaries-extra package’s abbreviations option instead.
    -

    -

    You may have noticed in

    +

    You may have noticed in §4 Defining Glossary Entries that when you specify a new entry, @@ -18455,7 +18511,7 @@ href="#glo:firstuse">first used in the document. This provides a useful means to define abbreviations. For convenience, the glossaries package defines the command: -

    \newacronym  abbrv⟩}{⟨long⟩}
    -

    -

    This uses

    +

    This uses \newglossaryentry to create an entry with the given label in the glossary given by shortplural\newglossaryentry to store the long and abbreviated forms and their plurals. -

    Note that the same restrictions on the entry ⟨

    Note that the same restrictions on the entry ⟨label⟩ in \newglossaryentry also apply to @@ -18499,7 +18555,7 @@ class="cmtt-10">\newacronym (see §4 Defining Glossary Entries). -

    If you haven’t identified the specified glossary type as a list of acronyms (via +

    If you haven’t identified the specified glossary type as a list of acronyms (via the package option acronymlists or the command \defglsentryfmt\glsentryfmt) before defining your entries.
    -

    -

    The optional argument

    +

    The optional argument {⟨key-val list⟩} allows you to specify additional information. Any @@ -18553,7 +18609,7 @@ example: \newacronym[longplural={diagonal matrices}]%  
      {dm}{DM}{diagonal matrix}

    -

    If the

    If the first use uses the plural form, \glspl{dm} will display: diagonal matrices (DMs). If you want to use the shortplural\setacronymstyle to set the display style rather than using one of the pre-version 4.02 acronym styles. -

    As with

    As with plural and firstpluralshortplural. -

    Since

    Since \newacronym uses \newglossaryentry\gls\glsreset as with any other glossary entry. -

    Since

    Since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using §4.6 Loading Entries From a File.
    -

    +

    -

    Example 21 (Defining an Abbreviation) -

    The following defines the abbreviation IDN: +

    The following defines the abbreviation IDN:

    \newacronym{idn}{IDN}{identification number}
    -

    \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses. If you want to use one of the smallcaps acronym styles, described in \newacronym{idn}{idn}{identification number}

    -

    Now

    Now \gls{idn} will produce “identification number (in” on subsequent uses.

    -

    -

    ____________________________

    -

    Avoid nested definitions.
    -

    -

    Recall from the warning in

    +

    ____________________________

    +

    Avoid nested definitions.
    +

    +

    Recall from the warning in §4 Defining Glossary Entries that you should avoid using the @@ -18683,7 +18739,7 @@ class="cmss-10">first\newacronym. -

    For example, suppose you have defined: +

    For example, suppose you have defined:

    @@ -18691,14 +18747,14 @@ class="cmtt-10">\newacronym. \newacronym{ssi}{SSI}{server side includes}  
    \newacronym{html}{HTML}{hypertext markup language}
    -

    you may be tempted to do: +

    you may be tempted to do:

    \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}
    -

    Don’t! This will break the case-changing commands, such as \Gls, it will cause @@ -18707,7 +18763,7 @@ href="#glo:firstuse">first use, and, if hyperlinks are enabled, will cause n also confuse the commands used by the entry formatting (such as \glslabel). -

    Instead, consider doing: +

    Instead, consider doing:

    @@ -18716,7 +18772,7 @@ class="cmtt-10">\glslabel [description={\gls{ssi} enabled \gls{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}
    -

    or +

    or

    @@ -18726,15 +18782,15 @@ class="cmtt-10">\glslabel     {shtml}{SHTML}  
     {server side includes enabled hypertext markup language}
    -

    Similarly for the

    Similarly for the \glstext-like commands. -

    Other approaches are available with

    Other approaches are available with glossaries-extra. See the section “Nested Links” in the glossaries-extra user manual. -

    The commands described below are similar to the

    The commands described below are similar to the \glstext-like commands in that they don’t modify the \glstext-like commands also apply to the following commands. (Including the warning immediately above this box.)
    -

    -

    The optional arguments are the same as those for the

    +

    The optional arguments are the same as those for the \glstext-like commands, and there are similar star and plus variants that switch off or on the hyperlinks. @@ -18761,7 +18817,7 @@ href="#glo:linktext">link text\glstextformat. -

    \acrshort  label⟩}[⟨insert⟩]
    -

    +

    This sets the link text to the short form (within the argument of short\newacronym implicitly sets. -

    There are also analogous upper case variants: -

    There are also analogous upper case variants: +

    \Acrshort  label⟩}[⟨insert⟩]
    -

    -

    +

    \ACRshort  label⟩}[⟨insert⟩]
    -

    +

    There are also plural versions: -

    \acrshortpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \Acrshortpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \ACRshortpl  label⟩}[⟨insert⟩]
    -

    +

    The short plural form is as supplied by the shortplural key, which \newacronym implicitly sets. -

    \acrlong  insert⟩]
    -

    +

    This sets the link text to the long form for the entry given by ⟨long key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -

    There are also analogous upper case variants: +

    \Acrlong  label⟩}[⟨insert⟩]
    -

    -

    +

    \ACRlong  label⟩}[⟨insert⟩]
    -

    +

    Again there are also plural versions: -

    \acrlongpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \Acrlongpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \ACRlongpl  label⟩}[⟨insert⟩]
    -

    +

    The long plural form is as supplied by the longplural key, which \newacronym implicitly sets. -

    The commands below display the full form of the acronym, but note that this isn’t +

    The commands below display the full form of the acronym, but note that this isn’t necessarily the same as the form used on first use. These full-form commands are shortcuts that use the above commands, rather than creating the link text from the complete full form. These full-form commands have star and plus variants and optional arguments that are passed to the above commands. -

    \acrfull  label⟩}[⟨insert⟩]
    -

    +

    This is a shortcut for -

    \acrfullfmt  label⟩}{⟨insert⟩}
    -

    +

    which by default does

    }}
    where -

    \acrfullformat  long⟩}{⟨short⟩}
    -

    +

    by default does ⟨long⟩ (⟨short⟩). This command is now deprecated for new acronym styles but is @@ -19024,8 +19080,8 @@ href="#sec:setacronymstyle">Changing the Abbreviation Style) hasn’t been used. (For further details of these format commands see the documented code, glossaries-code.pdf.) -

    There are also analogous upper case variants: -

    There are also analogous upper case variants: +

    \Acrfull  insert⟩]
    -

    -

    +

    \ACRfull  label⟩}[⟨insert⟩]
    -

    +

    and plural versions: -

    \acrfullpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \Acrfullpl  label⟩}[⟨insert⟩]
    -

    -

    +

    \ACRfullpl  label⟩}[⟨insert⟩]
    -

    -

    If you find the above commands too cumbersome to write, you can use the

    +

    If you find the above commands too cumbersome to write, you can use the shortcuts package option to activate the shorter command names listed in table 13.1.

    -

    @@ -19249,7 +19305,7 @@ class="cmtt-10">\Glspl
    -

    It is also possible to access the long and short forms without adding information to the +

    It is also possible to access the long and short forms without adding information to the glossary using commands analogous to \glsentrytext (described in §9 Using Glossary Terms Without Links). -

    The commands that convert the first letter to upper case come with the same caveats as +

    The commands that convert the first letter to upper case come with the same caveats as those for analogous commands like \Glsentrytext (non-expandable, can’t be used in PDF @@ -19266,95 +19322,95 @@ href="#sec:glsnolink">§9 Using Glossary Terms Without Links.
    -

    -

    The long form can be accessed using: -

    +

    The long form can be accessed using: +

    \glsentrylong  \glsentrylong{⟨label⟩}
    -

    +

    or, with the first letter converted to upper case: -

    \Glsentrylong  \Glsentrylong{⟨label⟩}
    -

    +

    Plural forms: -

    \glsentrylongpl  \glsentrylongpl{⟨label⟩}
    -

    -

    +

    \Glsentrylongpl  \Glsentrylongpl{⟨label⟩}
    -

    -

    Similarly, to access the short form: -

    +

    Similarly, to access the short form: +

    \glsentryshort  \glsentryshort{⟨label⟩}
    -

    +

    or, with the first letter converted to upper case: -

    \Glsentryshort  \Glsentryshort{⟨label⟩}
    -

    +

    Plural forms: -

    \glsentryshortpl  \glsentryshortpl{⟨label⟩}
    -

    -

    +

    \Glsentryshortpl  \Glsentryshortpl{⟨label⟩}
    -

    -

    And the full form can be obtained using: -

    +

    And the full form can be obtained using: +

    \glsentryfull  \glsentryfull{⟨label⟩}
    -

    -

    +

    \Glsentryfull  \Glsentryfull{⟨label⟩}
    -

    -

    +

    \glsentryfullpl  label⟩}
    -

    -

    +

    \Glsentryfullpl  \Glsentryfullpl{⟨label⟩}
    -

    +

    These again use \acrfullformat by default, but the new styles described in the section below use different formatting commands.

    -

    Top

    13.1 Changing the Abbreviation Style

    -

    It may be that the default style doesn’t suit your requirements in which case you can switch +

    It may be that the default style doesn’t suit your requirements in which case you can switch to another style using -

    \setacronymstyle  \setacronymstyle{⟨style name⟩}
    -

    +

    where ⟨style name⟩ is the name of the required style. -

    You must use

    You must use \setacronymstyle before you define the acronyms with \newacronym.
    -

    -

    For example: +

    +

    For example:

    @@ -19409,13 +19465,13 @@ class="cmtt-10">\newacronym    .  
    \newacronym{html}{html}{hypertext markup language}  
    \newacronym{xml}{xml}{extensible markup language}
    -

    Unpredictable results can occur if you try to use multiple styles. -

    If you need multiple abbreviation styles, then try using the

    Unpredictable results can occur if you try to use multiple styles. +

    If you need multiple abbreviation styles, then try using the glossaries-extra package, which has better abbreviation management.
    -

    -

    Note that unlike the default behaviour of

    +

    Note that unlike the default behaviour of \newacronym, the styles used via \setacronymstyle don’t use the \glsgenacfmt\genacrfullformat. -

    Note that when you use

    Note that when you use \setacronymstyle the name key is set to -

    \acronymentry  \acronymentry{⟨label⟩}
    -

    +

    and the sort key is set to -

    \acronymsort  short⟩}{⟨long⟩}
    -

    +

    These commands are redefined by the acronym styles. However, you can redefine them again after the style has been set but before you use \newacronym. Protected expansion is performed on \acronymsort when the entry is defined. -

    +

    -

    Top

    13.1.1 Predefined Acronym Styles

    -

    The

    The glossaries package provides a number of predefined styles. These styles apply -

    \firstacronymfont  \firstacronymfont{⟨text⟩}
    -

    +

    to the short form on first use and -

    \acronymfont  \acronymfont{⟨text⟩}
    -

    +

    on subsequent use. The styles modify the definition of \acronymfont as required, but \firstacronymfont independently of the acronym style. -

    The predefined styles that contain

    The predefined styles that contain sc in their name (for example long-sc-short) redefine @@ -19522,9 +19578,9 @@ class="cmtt-10">\acronymfont to use \textsc, which means that the short form needs to be specified in lower case. -

    -

    Some fonts don’t support bold smallcaps, so you may need to redefine

    Some fonts don’t support bold smallcaps, so you may need to redefine \glsnamefont (see \textsc.
    -

    -

    The predefined styles that contain

    +

    The predefined styles that contain sm in their name (for example long-sm-short) redefine @@ -19544,9 +19600,9 @@ class="cmss-10">long-sm-short\acronymfont to use \textsmaller. -

    -

    Note that the

    Note that the glossaries package doesn’t define or load any package that defines \textsmallerrelsize package or otherwise define \textsmaller.
    -

    -

    The remaining predefined styles redefine

    +

    The remaining predefined styles redefine \acronymfont{⟨text⟩} to simply do its argument ⟨text⟩. -

    In most cases, the predefined styles adjust

    In most cases, the predefined styles adjust \acrfull and \glsentryfullduafootnote styles (and their variants).
    -

    -

    The following styles are supplied by the

    +

    The following styles are supplied by the glossaries package:

    • long-sm-short, long-sp-short: -

      With these three styles, acronyms are displayed in the form -

      ⟨

      With these three styles, acronyms are displayed in the form +

      ⟨long⟩ (\firstacronymfont{⟨short⟩})
      -

      +

      on first use and -

      \acronymfont{⟨short⟩}
      -

      +

      on subsequent use. They also set \acronymsort{⟨short⟩\acronymfont) and the description key is set to the long form. -

      The

      The long-sp-short style was introduced in version 4.16 and uses -

      \glsacspace  label⟩}
      -

      +

      for the space between the long and short forms. This defaults to a non-breakable space (~) if (}) is less than 3em, otherwise it uses a normal sp

      \renewcommand*{\glsacspace}[1]{~}
      -

      +

    • short-longsc-short-long, sm-short-long: -

      These three styles are analogous to the above three styles, except the display order is +

      These three styles are analogous to the above three styles, except the display order is swapped to -

      \firstacronymfont{⟨short⟩} (⟨long⟩)
      -

      +

      on first use. -

      Note, however, that

      Note, however, that \acronymsort and \acronymentrylong-sm-short-desc, long-sp-short-desc: -

      These are like the

      These are like the long-short, long-sc-shortsc-short-long-desc, sm-short-long-desc: -

      These styles are analogous to the above three styles, but the first use display style +

      These styles are analogous to the above three styles, but the first use display style is: -

      \firstacronymfont{⟨short⟩} (⟨long⟩)
      -

      +

      The definitions of \acronymsort and \acronymentry are the same as those for @@ -19760,7 +19816,7 @@ class="cmss-10">dua-desc: -

      With these styles, the

      With these styles, the \gls-like commands always display the long form regardless of whether the entry has been used or not. However, footnote-sc, footnote-sm: -

      With these three styles, on first use the

      With these three styles, on first use the \gls-like commands display: -

      \firstacronymfont{⟨short⟩}\footnote}\footnote{⟨long⟩}
      -

      +

      However, \acrfull and short⟩} (⟨long⟩). On subsequent use the display is: -

      \acronymfont{⟨short⟩}
      -

      +

      The sort and namedescription is set to the long form. -

      In order to avoid nested hyperlinks on

      In order to avoid nested hyperlinks on first use the footnote styles automatically implement hyperfirst=false for the acronym lists.
      -

      +

    • footnote-descfootnote-sc-desc, footnote-sm-desc: -

      These three styles are similar to the previous three styles, but the description +

      These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The altlist

    -

    Example 22 (Adapting a Predefined Acronym Style) -

    Suppose I want to use the

    Suppose I want to use the footnote-sc-desc style, but I want the namefootnote-sc-desc \setacronymstyle{footnote-sc-desc}

    -

    and then redefine

    and then redefine \acronymsort and \acronymentry\acronymentry\renewcommand*{\acronymentry}[1]{%  
      \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%

    -

    (I’ve used

    (I’ve used \space for extra clarity, but you can just use an actual space instead.) -

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to +

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to redefine \acronymfont so that it always switches to medium weight to ensure the smallcaps @@ -19915,24 +19971,24 @@ setting is used:

    \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}}
    -

    This isn’t necessary if you use a font that supports bold smallcaps. -

    The sample file

    This isn’t necessary if you use a font that supports bold smallcaps. +

    The sample file sampleFnAcrDesc.tex illustrates this example.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.1.2 Defining A Custom Acronym Style

    -

    You may find that the predefined acronyms styles that come with the

    You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style using: -

    \newacronymstyle  }{⟨definitions⟩}
    -

    +

    where ⟨style name⟩ is the name of the new style (avoid active characters). The second argument, ⟨ \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%

    -

    (You can use

    (You can use \ifglshasshort instead of \ifglshaslong to test if the entry is an acronym if you prefer.) -

    The third argument, ⟨

    The third argument, ⟨definitions⟩, can be used to redefine the commands that affect the display style, such as \acronymfont\glsgenacfmt, \genacrfullformat and its variants. -

    Note that

    Note that \setacronymstyle redefines \glsentryfulldua\newacronymstyle should redefine these commands within ⟨definitions⟩. -

    Within

    Within \newacronymstyle’s ⟨definitions⟩ argument you can also redefine -

    \GenericAcronymFields  \GenericAcronymFields
    -

    +

    This is a list of additional fields to be set in \newacronym. You can use the following token @@ -20060,7 +20116,7 @@ does: \renewcommand*{\GenericAcronymFields}{%  
       description={\the\glslongtok}}%

    -

    which sets the

    which sets the description field to the long form of the acronym whereas the long-short-desc \renewcommand*{\GenericAcronymFields}{}%

    -

    since the description needs to be specified by the user. -

    It may be that you want to define a new acronym style that’s based on an existing style. +

    since the description needs to be specified by the user. +

    It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨display⟩ you can use -

    \GlsUseAcrEntryDispStyle  \GlsUseAcrEntryDispStyle{⟨style name⟩}
    -

    +

    to use the ⟨display⟩ definition from the style given by ⟨style name⟩. Within ⟨definitions⟩ you can use -

    \GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs{⟨style name⟩}
    -

    +

    to use the ⟨definitions⟩ from the style given by ⟨style name⟩. For example, the definitions⟩):  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
    }

    -

    (

    (\glstextup ms.) -

    Example 23 (Defining a Custom Acronym Style) -

    Suppose I want my acronym on

    Suppose I want my acronym on first use to have the short form in the text and the long form with the description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of the document, but I want it in normal capitals in the list of @@ -20191,7 +20247,7 @@ class="cmti-10">long⟩ (⟨short⟩) ⟨description⟩
    -

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second +

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of \newacronymstyle using: @@ -20201,7 +20257,7 @@ class="cmtt-10">\newacronymstyle \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%

    -

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use #):  
       \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%  
      }%

    -

    If you think it inappropriate for the short form to be capitalised at the start of a sentence +

    If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the above to: @@ -20262,7 +20318,7 @@ you can change the above to:  
     \let\Genacrfullformat\genacrfullformat  
     \let\Genplacrfullformat\genplacrfullformat

    -

    Another variation is to use

    Another variation is to use \Glsentrylong and \Glsentrylongpl\glsentrylong and \glsentrylongpl. -

    Now let’s suppose that commands such as

    Now let’s suppose that commands such as \glsentryfull and \acrfull\glsentryfull, \acrfullfmt and their plural and upper case variants. -

    First, the non-linking commands: +

    First, the non-linking commands:

    @@ -20307,7 +20363,7 @@ variants.  
          (\acronymfont{\glsentryshortpl{##1}})%  
      }%
    -

    Now for the linking commands: +

    Now for the linking commands:

    @@ -20353,11 +20409,11 @@ variants.  
        }%  
      }%
    -

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, +

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only the short form is inside the argument of \glslink.) -

    The style also needs to redefine

    The style also needs to redefine \acronymsort so that the acronyms are sorted according to the long form: @@ -20367,7 +20423,7 @@ to the long form:

      \renewcommand*{\acronymsort}[2]{##2}%
    -

    If you prefer them to be sorted according to the short form you can change the above +

    If you prefer them to be sorted according to the short form you can change the above to: @@ -20375,7 +20431,7 @@ to:

      \renewcommand*{\acronymsort}[2]{##1}%
    -

    The acronym font needs to be set to

    The acronym font needs to be set to \textsc and the plural suffix adjusted so that the “s” suffix in the plural short form doesn’t get converted to smallcaps: @@ -20386,7 +20442,7 @@ suffix in the plural short form doesn’t get converted to smallcaps:   \renewcommand*{\acronymfont}[1]{\textsc{##1}}%  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%

    -

    There are a number of ways of dealing with the format in the list of acronyms. The simplest +

    There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine \acronymentry to the long form followed by the upper case short form in @@ -20399,13 +20455,13 @@ parentheses:  
       \Glsentrylong{##1}\space  
         (\MakeTextUppercase{\glsentryshort{##1}})}%

    -

    (I’ve used

    (I’ve used \Glsentrylong instead of \glsentrylong to capitalise the name in the glossary.) -

    An alternative approach is to set

    An alternative approach is to set \acronymentry to just the long form and redefine  \renewcommand*{\GenericAcronymFields}{%  
        symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}%

    -

    I’m going to use the first approach and set

    I’m going to use the first approach and set \GenericAcronymFields to do nothing: @@ -20436,8 +20492,8 @@ class="cmtt-10">\GenericAcronymFields  \renewcommand*{\GenericAcronymFields}{}%

    -

    -

    Finally, this style needs to switch off hyperlinks on first use to avoid nested +

    +

    Finally, this style needs to switch off hyperlinks on first use to avoid nested links: @@ -20445,7 +20501,7 @@ links:

     \glshyperfirstfalse
    -

    Putting this all together: +

    Putting this all together:

    @@ -20539,15 +20595,15 @@ links:  
         (\MakeTextUppercase{\glsentryshort{##1}})}%  
    }
    -

    -

    Now I need to specify that I want to use this new style: +

    +

    Now I need to specify that I want to use this new style:

    \setacronymstyle{custom-fn}
    -

    I also need to use a glossary style that suits this acronym style, for example

    I also need to use a glossary style that suits this acronym style, for example altlist: @@ -20556,8 +20612,8 @@ class="cmss-10">altlist \setglossarystyle{altlist}

    -

    -

    Once the acronym style has been set, I can define my acronyms: +

    +

    Once the acronym style has been set, I can define my acronyms:

    @@ -20569,26 +20625,26 @@ class="cmss-10">altlist    layout of a document written in a markup language}]{css}  
    {css}{Cascading Style Sheet}
    -

    -

    The sample file

    +

    The sample file sample-custom-acronym.tex illustrates this example.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 24 (Italic and Upright Abbreviations) -

    Suppose I want to have some abbreviations in italic and some that just use the +

    Suppose I want to have some abbreviations in italic and some that just use the surrounding font. Hard-coding this into the ⟨short⟩ argument of \newacronym can cause complications. -

    This example uses

    This example uses \glsaddstoragekey to add an extra field that can be used to store the formatting declaration (such as \em).

    \glsaddstoragekey{font}{}{\entryfont}
    -

    This defines a new field/key called

    This defines a new field/key called font, which defaults to nothing if it’s not explicitly set. This also defines a command called \entryfont that’s analogous to \glsentrytext. A new style is then created to format abbreviations that access this field. -

    There are two ways to do this. The first is to create a style that doesn’t use

    There are two ways to do this. The first is to create a style that doesn’t use \glsgenacfmt but instead provides a modified version that doesn’t use \genacrfullformat need to be similarly adjusted. For exam  
       ({\entryfont{##1}\glsentryshort{##1}})%  
      }%

    -

    This will deal with commands like

    This will deal with commands like \gls but not commands like \acrshort \renewcommand*{\acronymfont}[1]{{\entryfont{\glslabel}#1}}%

    -

    So the new style can be defined as: +

    So the new style can be defined as:

    @@ -20686,23 +20742,23 @@ now:  
      \renewcommand*{\acronymentry}[1]{{\entryfont{##1}\glsentryshort{##1}}}%  
    }
    -

    Remember the style needs to be set before defining the entries: +

    Remember the style needs to be set before defining the entries:

    \setacronymstyle{long-font-short}
    -

    -

    The complete document is contained in the sample file

    +

    The complete document is contained in the sample file sample-font-abbr.tex.

    -

    -

    ____________________________

    -

    Some writers and publishing houses have started to drop full stops (periods) from upper +

    +

    ____________________________

    +

    Some writers and publishing houses have started to drop full stops (periods) from upper case initials but may still retain them for lower case abbreviations, while others may still use them for both upper and lower case. This can cause complications. Chapter 12 of ␣ (back slash space) in place of jus inter-word mid-sentence space and use \@ before the full stop to indicate the end of the sentence. -

    For example: +

    For example:

    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    The spacing is more noticeable with the typewriter font: @@ -20740,7 +20796,7 @@ The spacing is more noticeable with the typewriter font: \ttfamily  
    I was awarded a B.Sc. and a Ph.D. (From the same place.)

    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    @@ -20756,8 +20812,8 @@ These can be corrected:

    I was awarded a B.Sc.\ and a Ph.D\@. (From the same place.)
    -

    -

    This situation is a bit problematic for

    +

    This situation is a bit problematic for glossaries. The full stops can form part of the ⟨short⟩ argument of \@ before the full stop. -

    The next example shows one way of achieving this. (Note that the supplemental +

    The next example shows one way of achieving this. (Note that the supplemental glossaries-extra package provides a much simpler way of doing this, which you may prefer to @@ -20779,11 +20835,11 @@ use. See the initialisms example.) -

    Example 25 (Abbreviations with Full Stops (Periods)) -

    As from version 4.16, there’s now a hook (

    As from version 4.16, there’s now a hook (\glspostlinkhook) that’s called at the very end of the amsgen documentation.) -

    It’s possible that I may also want acronyms or contractions in my document, so I need +

    It’s possible that I may also want acronyms or contractions in my document, so I need some way to differentiate between them. Here I’m going to use the same method as in example 4 where a new field is defined to indicate the type of abbreviation: @@ -20812,7 +20868,7 @@ href="#x1-39002r4">4 where a new \glsaddstoragekey{abbrtype}{word}{\abbrtype}  
    \newcommand*{\newabbr}[1][]{\newacronym[abbrtype=initials,#1]}

    -

    Now I just use

    Now I just use \newacronym for the acronyms, for example, @@ -20822,7 +20878,7 @@ class="cmtt-10">\newacronymemission of radiation}

    -

    and my new command

    and my new command \newabbr for initials, for example, @@ -20834,7 +20890,7 @@ class="cmtt-10">\newabbr for initials, for example,  
    \newabbr{ba}{B.A.}{Bachelor of Arts}  
    \newabbr{agm}{A.G.M.}{annual general meeting}

    -

    Within

    Within \glspostlinkhook the entry’s label can be accessed using \glslabel and @@ -20845,7 +20901,7 @@ class="cmtt-10">abbrtype field set to “initials”. If it doesn’t, then nothing needs to happen, but if it does, a check is performed to see if the next character is a full stop. If it is, this signals the end of a sentence otherwise it’s mid-sentence. -

    Remember that internal commands within the document file (rather than in a class or +

    Remember that internal commands within the document file (rather than in a class or package) need to be placed between \makeatletter and \makeatother}  
    \makeatother

    -

    In the event that a full stop is found

    In the event that a full stop is found \doendsentence is performed but it will be followed by the full stop, which needs to be discarded. Otherwise \doendword will be done but it won’t be @@ -20876,7 +20932,7 @@ are: \newcommand{\doendsentence}[1]{\spacefactor=10000{}}  
    \newcommand{\doendword}{\spacefactor=1000{}}

    -

    Now, I can just do

    Now, I can just do \gls{bsc} mid-sentence and \gls{phd}. at the end of the sentence. The terminating full stop will be discarded in the latter case, but it won’t be @@ -20884,7 +20940,7 @@ discarded in, say, \gls{laser}. as that doesn’t have the abbrtype field set to “initials”. -

    This also works on first use when the style is set to one of the ⟨

    This also works on first use when the style is set to one of the ⟨long⟩ (⟨short⟩) styles but it will fail with the ⟨first use flag and define a macro that can then be used in \glspostlinkhook. -

    The other thing to consider is what to do with plurals. One possibility is to check for +

    The other thing to consider is what to do with plurals. One possibility is to check for plural use within \doendsentence (using \glsifplural) and put the full stop back if the plural has been used. -

    The complete document is contained in the sample file

    The complete document is contained in the sample file sample-dot-abbr.tex.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.2 Displaying the List of Acronyms

    -

    The list of acronyms is just like any other type of glossary and can be displayed on its own +

    The list of acronyms is just like any other type of glossary and can be displayed on its own using:

    [type=\acronymtype]
    -

    (If you use the

    (If you use the acronym package option you can also use

    @@ -20993,7 +21049,7 @@ href="#sec:pkgopts-acronym">§2.5 Acronym Options.) -

    Alternatively the list of acronyms can be displayed with all the other glossaries using: +

    Alternatively the list of acronyms can be displayed with all the other glossaries using:

    :
    \printglossaries
    -

    However, care must be taken to choose a glossary style that’s appropriate to your acronym +

    However, care must be taken to choose a glossary style that’s appropriate to your acronym style. Alternatively, you can define your own custom style (see §15.2 Defining your own glossary style for further details). -

    +

    -

    Top

    13.3 Upgrading From the glossary Package

    -

    Users of the obsolete

    Users of the obsolete glossary package may recall that the syntax used to define new acronyms has changed with the replacement acr-name⟩ when defining the acronym class="cmti-10">acr-name⟩. -

    In order to facilitate migrating from the old package to the new one, the

    In order to facilitate migrating from the old package to the new one, the glossaries package13.1 provides the command: -

    \oldacronym  long⟩}{⟨key-val list⟩}
    -

    +

    This uses the same syntax as the glossary package’s method of defining acronyms. It is @@ -21115,7 +21171,7 @@ class="cmtt-10">\gls\Gls to change the settings. -

    Recall that, in general, LAT

    Recall that, in general, LATEX ignores spaces following command names consisting of alphabetical characters. This is also true for \⟨xspace.13.2
    -

    +

    -

    The

    The glossaries package doesn’t load the xspace package since there are both advantages @@ -21154,14 +21210,14 @@ you can’t use the optional argument to insert text (you will have to expli \gls). -

    To illustrate this, suppose I define the acronym “abc” as follows: +

    To illustrate this, suppose I define the acronym “abc” as follows:

    \oldacronym{abc}{example acronym}{}
    -

    This will create the command

    This will create the command \abc and its starred version \abc*. Table 13.2 illustrates the @@ -21177,7 +21233,7 @@ optional argument from being recognised.

    -

    @@ -21243,11 +21299,11 @@ class="td11"> abc’s xyz
    -

    -

    +

    Top

    14. Unsetting and Resetting Entry Flags

    -

    When using the

    When using the \gls-like commands it is possible that you may want to use the value given by the text key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands: -

    \glsreset  \glsreset{⟨label⟩}
    -

    -

    +

    \glslocalreset  \glslocalreset{⟨label⟩}
    -

    +

    while the latter can be achieved by one of the following commands: -

    \glsunset  \glsunset{⟨label⟩}
    -

    -

    +

    \glslocalunset  \glslocalunset{⟨label⟩}
    -

    +

    You can also reset or unset all entries for a given glossary or list of glossaries using: -

    \glsresetall  \glsresetall[⟨glossary list⟩]
    -

    -

    +

    \glslocalresetall  \glslocalresetall[⟨glossary list⟩]
    -

    -

    +

    \glsunsetall  \glsunsetall[⟨glossary list⟩]
    -

    -

    +

    \glslocalunsetall  \glslocalunsetall[⟨glossary list⟩]
    -

    +

    where ⟨glossary list⟩ is a comma-separated list of glossary labels. If omitted, all defined glossaries are assumed (except for the ignored ones). For example, to reset all entries in the @@ -21335,10 +21391,10 @@ main glossary and the list of acronyms:

    \glsresetall[main,acronym]
    -

    -

    You can determine whether an entry’s

    +

    You can determine whether an entry’s first use flag is set using: -

    \ifglsused  true part⟩}{⟨false part⟩}
    -

    +

    where ⟨label⟩ is the label of the required entry. If the entry has been used, ⟨true part⟩ will be done, otherwise ⟨false part⟩ will be done. -

    Be careful when using

    Be careful when using \gls-like commands within an environment or command argument that gets processed multiple times as it can cause unwanted side-effects when the first use displayed text is different from subsequent use.
    -

    -

    For example, the

    +

    For example, the frame environment in beamerfirst use flag will be unset on the first overlay and subsequent overlays will use the non-first use form. -

    Consider the following example: +

    Consider the following example:

    @@ -21388,15 +21444,15 @@ will use the non-first use form.  
    \end{frame}  
    \end{document}
    -

    -

    On the first overlay,

    +

    On the first overlay, \gls{svm} produces “support vector machine (SVM)” and then unsets the first use flag. When the second overlay is processed, \gls{svm} now produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and I can only offer two suggestions. -

    Firstly, unset all acronyms at the start of the document and explicitly use

    Firstly, unset all acronyms at the start of the document and explicitly use \acrfull when you want the full version to be displayed: @@ -21418,8 +21474,8 @@ you want the full version to be displayed:  
    \end{frame}  
    \end{document}

    -

    -

    Secondly, explicitly reset each acronym on first use: +

    +

    Secondly, explicitly reset each acronym on first use:

    @@ -21432,7 +21488,7 @@ you want the full version to be displayed:  
     \end{itemize}  
    \end{frame}
    -

    These are non-optimal, but the

    These are non-optimal, but the beamer class is too complex for me to provide a programmatic solution. Other potentially problematic environments are some @@ -21445,7 +21501,7 @@ class="cmss-10">tabular itself) that process the contents in order to work out the column widths and then reprocess the contents to do the actual typesetting. -

    The

    The amsmath environments, such as align\glspatchtabularx in the preamble (or anywhere before the tabularx).

    -

    Top

    14.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)

    -

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. +

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. That is, how many times the first use flag is unset. Note that the supplemental glossaries-extra package improves this function and also provides per-unit counting, which isn’t available with the glossaries package. -

    This function is disabled by default as it adds extra overhead to the document build time +

    This function is disabled by default as it adds extra overhead to the document build time and also switches \newglossaryentry (and therefore \newacronym) into a preamble-only command.
    -

    -

    To enable this function, use -

    +

    To enable this function, use +

    \glsenableentrycount  \glsenableentrycount
    -

    +

    before defining your entries. This adds two extra (internal) fields to entries: currcount and prevcount. -

    The

    The currcount field keeps track of how many times \glsunset is used within the document. A local unset (using \glsreset and \glslocalreset reset this field back to zero (where \glslocalreset performs a local change). -

    The

    The prevcount field stores the final value of the currcount field from the previous run. @@ -21517,32 +21573,32 @@ class="cmss-10">document environment. -

    You can access these fields using -

    You can access these fields using +

    \glsentrycurrcount  \glsentrycurrcount{⟨label⟩}
    -

    +

    for the currcount field, and -

    \glsentryprevcount  \glsentryprevcount{⟨label⟩}
    -

    +

    for the prevcount field. These commands are only defined if you have used \glsenableentrycount. -

    For example: +

    For example:

    @@ -21559,7 +21615,7 @@ class="cmbx-10">.      
    Number of times apple has been used: \glsentrycurrcount{apple}.  
    \end{document}
    -

    On the first LAT

    On the first LATEX run, \glsentryprevcount{apple} produces 0. At the end of the document, \glsentryprevcount{apple} now produces� class="cmtt-10">currcount field for the apple entry at the end of the document on the previous run. -

    When you enable the entry count using

    When you enable the entry count using \glsenableentrycount, you also enable the following commands: -

    \cgls  label⟩}[⟨insert⟩]
    -

    +

    (no case-change, singular) -

    \cglspl  label⟩}[⟨insert⟩]
    -

    +

    (no case-change, plural) -

    \cGls  label⟩}[⟨insert⟩]
    -

    +

    (first letter uppercase, singular), and -

    \cGlspl  label⟩}[⟨insert⟩]
    -

    +

    (first letter uppercase, plural). These all have plus and starred variants like the analogous \gls, \glspl, \Gls and \Glspl commands. -

    If you don’t use

    If you don’t use \glsenableentrycount, these commands behave like \gls, \glspl, \cgls, \cglspl, \cGls or \cGlspl. -

    \cglsformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cgls and defaults to

    @@ -21709,7 +21765,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cglsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cglspl and defaults to

    @@ -21738,7 +21794,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGls and defaults to

    @@ -21769,7 +21825,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGlspl and defaults to

    @@ -21798,7 +21854,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    This means that if the previous count for the given entry was 1, the entry won’t be +

    This means that if the previous count for the given entry was 1, the entry won’t be hyperlinked with the \cgls-like commands and they won’t add a line to the external glossary file. If you haven’t used any of the other commands that add information to glossary file (such @@ -21807,7 +21863,7 @@ class="cmtt-10">\glsadd or the \glstext-like commands) then the entry won’t appear in the glossary. -

    Remember that since these commands use

    Remember that since these commands use \glsentryprevcount you need to run LATEX twice to ensure they work correctly. The document build order is now (at least): @@ -21818,11 +21874,11 @@ class="cmtt-10">makeglossaries, (pdf)latex. -

    Example 26 (Don’t index entries that are only used once) -

    In this example, the abbreviations that have only been used once (on the previous run) +

    In this example, the abbreviations that have only been used once (on the previous run) only have their long form shown with \cgls. @@ -21849,7 +21905,7 @@ class="cmtt-10">\cgls.  
    \printglossaries  
    \end{document}

    -

    After a complete document build (

    After a complete document build (latex, latex, makeglossaries,

    -

    -

    ____________________________

    -

    Remember that if you don’t like typing

    +

    ____________________________

    +

    Remember that if you don’t like typing \cgls you can create a synonym. For example @@ -21870,15 +21926,15 @@ example

    \let\ac\cgls
    -

    +

    -

    -

    +

    Top

    15. Glossary Styles

    -

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of +

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The Defining your own glossary style

    The glossary style can be set using the

    The glossary style can be set using the style key in the optional argument to \printglossary2 and 3) or using the command: -

    \setglossarystyle  \setglossarystyle{⟨style-name⟩}
    -

    +

    (before the glossary is displayed). -

    Some of the predefined glossary styles may also be set using the

    Some of the predefined glossary styles may also be set using the style package option, it depends if the package in which they are defined is automatically loaded by the glossaries package. -

    You can use the lorum ipsum dummy entries provided in the accompanying +

    You can use the lorum ipsum dummy entries provided in the accompanying example-glossaries-*.tex files (described in §1.3 Dummy Entries for Testing) to test the different styles.

    -

    Top

    15.1 Predefined Styles

    -

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the +

    The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options entrycounter, http://www.dickimaw-books.com/gallery/glossaries-styles/. Note that glossaries-extra provides an additional style bookindex in the supplementary package +class="cmss-10">glossaries-extra provides additional styles in the supplementary packages glossary-bookindex, which is designed for indexes (rather than glossaries). See the - and glossary-longnoloc. See the glossaries-extra manual for further details. -

    Note that the group styles (such as glossaries-extra manual for further +details. +

    Note that the group styles (such as listgroup) will have unexpected results if used with the nogroupskip package option to prevent odd vertical gaps appearing.
    -

    -

    The group title is obtained using

    +

    The group title is obtained using \glsgetgrouptitle{⟨label⟩}, which is described in Defining your own glossary style

    @@ -22171,7 +22227,7 @@ class="td11">
    -

    The tabular-like styles that allow multi-line descriptions and page lists use the length +

    The tabular-like styles that allow multi-line descriptions and page lists use the length \glsdescwidth \newline instead of \\. -

    Remember that a cell within a tabular-like environment can’t be broken across a page, so +

    Remember that a cell within a tabular-like environment can’t be broken across a page, so even if a tabular-like style, such as long, allows multilined descriptions, you’ll probably @@ -22211,8 +22267,8 @@ encounter page-breaking problems if you have entries with long descriptions. You consider using the alttree style instead.
    -

    -

    Note that if you use the

    +

    Note that if you use the style key in the optional argument to \printnoidxglossary\printglossary[style=long]

    -

    then the new definition of

    then the new definition of \glsgroupskip will not have an affect for this glossary, as \setglossarystyle{long}

    -

    will reset

    will reset \glsgroupskip back to its default definition for the named glossary style (long\renewcommand*{\glsgroupskip}{}

    -

    As from version 3.03, you can now use the package option

    As from version 3.03, you can now use the package option nogroupskip to suppress the gap between groups for the default styles instead of redefining \glsgroupskip. -

    All the styles except for the three- and four-column styles and the

    All the styles except for the three- and four-column styles and the listdotted style use the command -

    \glspostdescription  \glspostdescription
    -

    +

    after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with something else, say, a comma) you will need to redefine \nopostdesc at the end of the description. The glossaries-extra package provides a starred version that doesn’t. -

    As from version 3.03 you can now use the package option

    As from version 3.03 you can now use the package option nopostdot to suppress this full stop. This is the better option if you want to use the glossaries-extra documentation for further details.

    -

    Top

    15.1.1 List Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-list. Since they all use the nolistnostyles package options. -

    Note that, except for the

    Note that, except for the listdotted style, these list styles are incompatible with classicthesisdescription environment.
    -

    +

    list
    \indexspace. -

    The closest matching non-list style is the

    The closest matching non-list style is the index style.

    @@ -22390,12 +22446,12 @@ class="cmss-10">listgroupEX to ensure the group information is up to date. In the navigation line, each group is separated by -

    \glshypernavsep  \glshypernavsep
    -

    +

    which defaults to a vertical bar with a space on either side. For example, to simply have a space separating each group, do: @@ -22404,21 +22460,21 @@ class="cmtt-10">\glshypernavsep

    \renewcommand*{\glshypernavsep}{\space}
    -

    -

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional +

    +

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to \item instead of after it 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 -

    \glslistnavigationitem  \glslistnavigationitem{⟨navigation line⟩}
    -

    +

    The default definition is \item[⟨navigation line⟩] but may be redefined independently of

    \renewcommand*{\glslistnavigationitem}[1]{\item \textbf{#1}}
    -

    -

    You may prefer to use the tree-like styles, such as

    +

    You may prefer to use the tree-like styles, such as treehypergroup instead.

    @@ -22449,7 +22505,7 @@ class="cmss-10">listlist style, the name associated with each child entry is ignored. -

    The closest matching non-list style is the

    The closest matching non-list style is the index style with the following adjustment: @@ -22459,7 +22515,7 @@ class="cmss-10">index \glstreeitem\parindent\hangindent}

    -

    +

    altlistgroup
    \item[], followed by the name followed by a href="#glo:numberlist">number list and the symbol. The length -

    \glslistdottedwidth  \glslistdottedwidth
    -

    +

    governs where the description should start. This is a flat style, so child entries are formatted in the same way as the parent entries. -

    A non-list alternative is to use the

    A non-list alternative is to use the index style with @@ -22514,7 +22570,7 @@ class="cmss-10">index\renewcommand{\glstreechildpredesc}{\dotfill}

    -

    Note that this doesn’t use

    Note that this doesn’t use \glslistdottedwidth and causes the description to be flush-right and will display the symbol, if provided. (It also doesn’t suppress the number listlistdottedclassicthesis.

    -

    +

    -

    Top

    15.1.2 Longtable Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-long. Since they all use the altlong4colheaderborderlong4colheaderborder but allows multi-line descriptions and page lists. -

    +

    -

    Top

    15.1.3 Longtable Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longragged. These styles are analogous to those defined in glossary-longragged\usepackage{glossary-longragged}

    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the altlongragged4colheaderborderaltlongragged4colheader but has horizontal and vertical lines around it. -

    +

    -

    Top

    15.1.4 Longtable Styles (booktabs)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longbooktabs. -

    Since these styles all use the

    Since these styles all use the longtable environment, they are governed by the same @@ -22964,12 +23020,12 @@ class="cmss-10">glossary-longbooktabs\usepackage{glossary-longbooktabs}

    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the glossaries package has been loaded. -

    These styles are similar to the “header” styles in the

    These styles are similar to the “header” styles in the glossary-long and glossary-ragged\printglossary. (The nogroupskip package option is checked by these styles.) -

    Alternatively, you can restore the original

    Alternatively, you can restore the original longtable behaviour with: -

    \glsrestoreLToutput  \glsrestoreLToutput
    -

    +

    For more information about the patch, see the documented code (glossaries-code.pdf).

    @@ -23076,12 +23132,12 @@ class="cmss-10">altlongragged4colheader style but adds rules as above.
    -

    +

    -

    Top

    15.1.5 Supertabular Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-super. Since they all use the super4colheaderborder but allows multi-line descriptions and page lists. -

    +

    -

    Top

    15.1.6 Supertabular Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-superragged. These styles are analogous to those defined in glossary-superragged\usepackage{glossary-superragged}

    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the altsuperragged4colheaderborderaltsuperragged4colheader but has horizontal and vertical lines around it. -

    +

    -

    Top

    15.1.7 Tree-Like Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-tree. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have @@ -23478,15 +23534,15 @@ class="cmss-10">notreenostyles package options. -

    These styles all format the entry name using: -

    These styles all format the entry name using: +

    \glstreenamefmt  \glstreenamefmt{⟨name⟩}
    -

    +

    This defaults to \textbf{⟨name⟩\glstreenamefont may be counteracted by another font chan class="cmtt-10">\glsnamefont (or in \acronymfont). The tree-like styles that also display the header use -

    \glstreegroupheaderfmt  \glstreegroupheaderfmt{⟨text⟩}
    -

    +

    to format the heading. This defaults to \glstreenamefmt{⟨text⟩indexhypergroup), format the navigation line using -

    \glstreenavigationfmt  text⟩}
    -

    +

    which defaults to \glstreenamefmt{⟨text⟩listhypergroup, as that also includes \item. -

    With the exception of the

    With the exception of the alttree style (and those derived from it), the space before the description for top-level entries is produced with -

    \glstreepredesc  \glstreepredesc
    -

    +

    This defaults to \space. -

    With the exception of the

    With the exception of the treenoname and alttree styles (and those derived from them), the space before the description for child entries is produced with -

    \glstreechildpredesc  \glstreechildpredesc
    -

    +

    This defaults to \space. -

    Most of these styles are not designed for multi-paragraph descriptions. (The

    Most of these styles are not designed for multi-paragraph descriptions. (The tree style isn’t too bad for multi-paragraph top-level entry descriptions, or you can use the index style with the adjustment shown below.)
    -

    +

    index
    index\indexspace. -

    Each main level item is started with -

    Each main level item is started with +

    \glstreeitem  \glstreeitem
    -

    +

    The level 1 entries are started with -

    \glstreesubitem  \glstreesubitem
    -

    -

    The level 2 entries are started with -

    +

    The level 2 entries are started with +

    \glstreesubsubitem  \glstreesubsubitem
    -

    -

    Note that the

    +

    Note that the index style automatically sets @@ -23615,8 +23671,8 @@ class="cmss-10">index\let\subitem\glstreesubitem  
    \let\subsubitem\glstreesubsubitem

    -

    at the start of the glossary for backward compatibility. -

    The

    at the start of the glossary for backward compatibility. +

    The index style isn’t suitable for multi-paragraph descriptions, but this limitation can be overcome by redefining the above commands. For example: @@ -23628,7 +23684,7 @@ class="cmss-10">index \parindent0pt\par\hangindent40pt  
     \everypar{\parindent50pt\hangindent40pt}}

    -

    +

    indexgroup
    alttreetree style except that the indentation for each level is determined by the width of the text specified by -

    \glssetwidest  level⟩]{⟨text⟩}
    -

    +

    The optional argument ⟨level⟩ indicates the level, where 0 indicates the top-most level, 1 indicates the first level sub-entries, etc. If \glssetwidest hasn’t been used for a given sub-level, the level 0 widest text is used instead. If ⟨level⟩ is omitted, 0 is assumed. -

    As from v4.22, the

    As from v4.22, the glossary-tree package also provides -

    \glsfindwidesttoplevelname  \glsfindwidesttoplevelname[⟨glossary list⟩]
    -

    +

    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 \forallglossaries). -

    For example, to have the same name width for all glossaries: +

    For example, to have the same name width for all glossaries:

    @@ -23789,7 +23845,7 @@ class="cmtt-10">\forallglossaries    ).  
    \setglossarystyle{alttree}  
    \printglossaries
    -

    Alternatively, to compute the widest entry for each glossary before it’s displayed: +

    Alternatively, to compute the widest entry for each glossary before it’s displayed:

    @@ -23799,22 +23855,22 @@ class="cmtt-10">\forallglossaries    ).  
    \setglossarystyle{alttree}  
    \printglossaries
    -

    -

    These commands only affects the

    +

    These commands only affects the alttree styles, including those listed below and the ones in the glossary-mcols package. If you forget to set the widest entry name, the description will overwrite the name.
    -

    -

    For each level, the name is placed to the left of the paragraph block containing the +

    +

    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

    The name is placed inside a left-aligned \makebox. As from v4.19, this can now be adjusted by redefining -

    \glstreenamebox  width⟩}{⟨text⟩}
    -

    +

    where ⟨width⟩ is the width of the box and ⟨text⟩ is the contents of the box. For example, to @@ -23836,7 +23892,7 @@ class="cmti-10">text⟩ is the contents of the box. For example, to  
      \makebox[#1][r]{#2}%  
    }

    -

    +

    alttreegroup
    listhypergroup, described above.
    -

    +

    -

    Top

    15.1.8 Multicols Style

    -

    The

    The glossary-mcols package provides tree-like styles that are in the multicols\glstreenavigationfmt are all used by the corresponding glossary-mcols styles. -

    Note that

    Note that glossary-mcols is not loaded by glossaries. If you want to use any of the multicol @@ -23911,14 +23967,14 @@ class="cmtt-10">\usepackage and set the required glossary style using \setglossarystyle.
    -

    -

    The default number of columns is 2, but can be changed by redefining -

    +

    The default number of columns is 2, but can be changed by redefining +

    \glsmcols  \glsmcols
    -

    +

    to the required number. For example, for a three column glossary: @@ -23928,12 +23984,12 @@ to the required number. For example, for a three column glossary:  
    \renewcommand*{\glsmcols}{3}  
    \setglossarystyle{mcolindex}

    -

    +

    -

    @@ -24059,7 +24115,7 @@ class="cmss-10">alttreehypergroup
    -

    The styles with a navigation line, such as

    The styles with a navigation line, such as mcoltreehypergroup, now have a variant (as from v4.22) with “hypergroup” replaced with “spannav” in the style name. The original @@ -24070,10 +24126,10 @@ class="cmss-10">multicols environment so that it spans across all the columns.

    -

    Top

    15.1.9 In-Line Style

    -

    This section covers the

    This section covers the glossary-inline package that supplies the inlinenumber list. -

    You will most likely need to redefine

    You will most likely need to redefine \glossarysection with this style. For example, suppose you are required to have your glossaries and list of acronyms in a footnote, you can @@ -24095,8 +24151,8 @@ do:  
     \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }  
     \setglossarystyle{inline}

    -

    -

    Note that you need to include

    +

    Note that you need to include glossary-inline with \usepackage as it’s not automatically @@ -24105,55 +24161,55 @@ class="cmss-10">glossaries package and then set the style using \setglossarystyle.
    -

    -

    Where you need to include your glossaries as a footnote you can do: +

    +

    Where you need to include your glossaries as a footnote you can do:

    \footnote{\printglossaries}
    -

    -

    The

    +

    The inline style is governed by the following: -

    \glsinlineseparator  \glsinlineseparator
    -

    +

    This defaults to “; ” and is used between main (i.e. level 0) entries. -

    \glsinlinesubseparator  \glsinlinesubseparator
    -

    +

    This defaults to “, ” and is used between sub-entries. -

    \glsinlineparentchildseparator  \glsinlineparentchildseparator
    -

    +

    This defaults to “: ” and is used between a parent main entry and its first sub-entry. -

    \glspostinline  \glspostinline
    -

    +

    This defaults to “; ” and is used at the end of the glossary. -

    \glsinlinenameformat  label⟩}{⟨name⟩}
    -

    +

    This is used to format the entry name and defaults to \glstarget{⟨label⟩ \renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}}

    -

    Sub-entry names are formatted according to -

    Sub-entry names are formatted according to +

    \glsinlinesubnameformat  label⟩}{⟨name⟩}
    -

    +

    This defaults to \glstarget{⟨label⟩}{} so the sub-entry name is ignored. -

    If the description has been suppressed (according to

    If the description has been suppressed (according to \ifglsdescsuppressed) then -

    \glsinlineemptydescformat  }{⟨number list⟩}
    -

    +

    (which defaults to nothing) is used, otherwise the description is formatted according to -

    \glsinlinedescformat  }{⟨number list⟩}
    -

    +

    This defaults to just \space⟨description⟩ so the symbol and location list are ignored. If the @@ -24234,16 +24290,16 @@ description is missing (according to \ifglshasdesc), then \glsinlineemptydescformat is used instead. -

    For example, if you want a colon between the name and the description: +

    For example, if you want a colon between the name and the description:

    \renewcommand*{\glsinlinedescformat}[3]{: #1}
    -

    -

    The sub-entry description is formatted according to: -

    +

    The sub-entry description is formatted according to: +

    \glsinlinesubdescformat  number list⟩}
    -

    +

    This defaults to just ⟨description⟩. -

    +

    -

    Top

    15.2 Defining your own glossary style

    -

    If the predefined styles don’t fit your requirements, you can define your own style +

    If the predefined styles don’t fit your requirements, you can define your own style using: -

    \newglossarystyle  name⟩}{⟨definitions⟩}
    -

    +

    where ⟨name⟩ is the name of the new glossary style (to be used in \setglossarystyle). The second argument ⟨definitions⟩ needs to redefine all of the following: -

    theglossary  theglossary
    -

    +

    This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreambledescription environment. -

    \glossaryheader  \glossaryheader
    -

    +

    This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamblelongheader glossary style redefines \glossaryheader to do a header row. -

    \glsgroupheading  \glsgroupheading{⟨label⟩}
    -

    +

    This macro indicates what to do at the start of each logical block within the main body of the glossary. If you use xindy

    Note that the argument to

    Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via -

    \glsgetgrouptitle  \glsgetgrouptitle{⟨label⟩}
    -

    +

    This obtains the title as follows: if ⟨label⟩ consists of a single non-active character or ⟨label⟩ is @@ -24398,8 +24454,8 @@ to just ⟨label⟩. You can redefine \glsgetgrouptitle if this is unsuitable for your document. -

    A navigation hypertarget can be created using -

    A navigation hypertarget can be created using +

    \glsnavhypertarget  label⟩}{⟨text⟩}
    -

    +

    This typically requires \glossaryheader to be redefined to use -

    \glsnavigation  \glsnavigation
    -

    +

    which displays the navigation line. -

    For further details about

    For further details about \glsnavhypertarget, see the documented code (glossaries-code.pdf). -

    Most of the predefined glossary styles redefine

    Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The listhypergroup\glsgroupheading as follows: \renewcommand*{\glsgroupheading}[1]{%  
    \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}

    -

    See also

    See also \glsgroupskip below. (Note that command definitions within \newglossarystyle must use ##1 instead of #1 etc.) -

    \glsgroupskip  \glsgroupskip
    -

    +

    This macro determines what to do after one logical group but before the header for the next logical group. The list\indexspace, whereas the tabular-like styles redefine \glsgroupskip to produce a blank row. -

    As from version 3.03, the package option

    As from version 3.03, the package option nogroupskip can be used to suppress this default gap for the predefined styles. -

    \glossentry  label⟩}{⟨number list⟩}
    -

    +

    This macro indicates what to do for each top-level (level 0) glossary entry. The entry label is given by ⟨label⟩ and the associated §9 Using Glossary Terms Without Links for further details.) You can also use the following commands: -

    \glsentryitem  \glsentryitem{⟨label⟩}
    -

    +

    This macro will increment and display the associated counter for the main (level 0) entries if the entrycounter\glossentry before \glstarget. The format of the counter is controlled by the macro -

    \glsentrycounterlabel  \glsentrycounterlabel
    -

    -

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the +

    +

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

    \glstarget  label⟩}{⟨text⟩}
    -

    +

    where ⟨label⟩ is the entry’s label. Note that you don’t need to worry about whether the hyperref\glstarget won’t create a target if \hypertarget hasn’t been defined. -

    For example, the

    For example, the list style defines \glossentry as follows: @@ -24567,10 +24623,10 @@ class="cmtt-10">\glossentry as follows:  
              \glstarget{##1}{\glossentryname{##1}}]  
           \glossentrydesc{##1}\glspostdescription\space ##2}

    -

    -

    Note also that ⟨

    +

    Note also that ⟨number list⟩ will always be of the form -

    \glossaryentrynumbers{{⟨number(s)⟩}}
    -

    +

    where ⟨number(s)⟩ may contain \delimNnonumberlist package option. -

    \subglossentry  label⟩}{⟨number list⟩}
    -

    +

    This is used to display sub-entries. The first argument, ⟨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 \glossentry described above. -

    \glssubentryitem  \glssubentryitem{⟨label⟩}
    -

    +

    This macro will increment and display the associated counter for the level 1 entries if the subentrycounter\subglossentry before \glstarget. The format of the counter is controlled by the macro -

    \glssubentrycounterlabel  \glssubentrycounterlabel
    -

    -

    Note that

    +

    Note that \printglossary (which \printglossaries calls) sets -

    \currentglossary  \currentglossary
    -

    +

    to the current glossary label, so it’s possible to create a glossary style that varies according to the glossary type. -

    For further details of these commands, see “Displaying the glossary” in the documented +

    For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf). -

    Example 27 (Creating a completely new style) -

    If you want a completely new style, you will need to redefine all of the commands and the +

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

    For example, suppose you want each entry to start with a bullet point. This +

    For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the itemize   \glossentry{##2}{##3}}%  
     }

    -

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the +

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries. It also hasn’t used \glsentryitem or counterwithinsubentrycounter package options. -

    Variations:

    +

    Variations:

    • You might want the entry name to be capitalised, in which case use Utilities):  
       \space [##2]% the number list in square brackets  
       }%
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 28 (Creating a new glossary style based on an existing style) -

    If you want to define a new style that is a slightly modified version of an existing style, +

    If you want to define a new style that is a slightly modified version of an existing style, you can use \setglossarystyle within the second argument of                               % between groups  
    }

    -

    (In this case, you can actually achieve the same effect using the

    (In this case, you can actually achieve the same effect using the list style in combination with the package option nogroupskip.)

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 29 (Example: creating a glossary style that uses the user1user6 keys) -

    Suppose each entry not only has an associated symbol, but also units (stored in

    Suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension (stored in longtable \renewcommand*{\glsgroupskip}{}%  
    }

    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    16. Utilities

    -

    This section describes some utility commands. Additional commands can be found in the +

    This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf).

    -

    Top

    16.1 Loops

    -

    Some of the commands described here take a comma-separated list as an argument. As with +

    Some of the commands described here take a comma-separated list as an argument. As with LATEX’s \@for command, make sure your list doesn’t have any unwanted spaces in it as @@ -24930,8 +24986,8 @@ href="http://www.dickimaw-books.com/latex/admin/html/docsvlist.shtml#spacesinlis class="tcrm-1000">§2.7.2 of “LATEX for Administrative Work”.)
    -

    -

    +

    \forallglossaries  cs⟩}{⟨body⟩}
    -

    +

    This iterates through ⟨glossary list⟩, a comma-separated list of glossary labels (as supplied when the glossary was defined). At each iteration ⟨body⟩ is performed. If ⟨glossary list⟩ is omitted, the default is to iterate over all glossaries (except the ignored ones). -

    \forallacronyms  cs⟩}{⟨body⟩}
    -

    +

    This is like \forallglossaries but only iterates over the lists of acronyms (that have previously been declared using acronymlists\forallglossaries. -

    \forglsentries  cs⟩}{⟨body⟩}
    -

    +

    This iterates through all entries in the glossary given by ⟨glossary label⟩. At each iteration ⟨cs⟩ @@ -24994,7 +25050,7 @@ class="cmti-10">glossary label⟩ is omitted, \glsdefaulttype (usually the main glossary) is used. -

    \forallglsentries  cs⟩}{⟨body⟩}
    -

    +

    This is like \forglsentries but for each glossary in ⟨glossary list⟩ (a comma-separated list of @@ -25020,12 +25076,12 @@ class="cmti-10">cs⟩} within ⟨body⟩.) -

    +

    -

    Top

    16.2 Conditionals

    -

    \ifglossaryexists  true part⟩⟨false part⟩
    -

    +

    This checks if the glossary given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglsentryexists  \ifglsentryexists⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, @@ -25067,7 +25123,7 @@ href="#sec:techissues">§4.8.1 Technical Issues for further details.) -

    \glsdoifexists  label⟩}{⟨code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists. If it doesn’t exist, an error is generated. (This command uses \ifglsentryexists.) -

    \glsdoifnoexists  label⟩}{⟨code⟩}
    -

    +

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -

    \glsdoifexistsorwarn  label⟩}{⟨code⟩}
    -

    +

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -

    \glsdoifexistsordo  code⟩}{⟨else code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists otherwise generate an error and do ⟨else code⟩. -

    \glsdoifnoexistsordo  code⟩}{⟨else code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ doesn’t exist otherwise generate an error and do ⟨else code⟩. -

    \ifglsused  \ifglsused⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    See §14 Unsetting and Resetting Entry Flags. -

    \ifglshaschildren  \ifglshaschildren⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has any sub-entries. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshasparent  \ifglshasparent⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has a parent entry. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshassymbol  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the symbolsymboltrue part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshaslong  false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the longfalse part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -

    \ifglshasshort  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the shortfalse part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -

    \ifglshasdesc  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the description field is non-empty for the entry given by ⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. Compare with: -

    \ifglsdescsuppressed  }{⟨false part⟩}
    -

    +

    This checks if the description field has been set to just true part⟩ is performed, otherwise ⟨false part⟩. There is no check for the existence of ⟨label⟩. -

    For all other fields you can use: -

    For all other fields you can use: +

    \ifglshasfield  }{⟨false part⟩}
    -

    +

    This tests the value of the field given by ⟨field⟩ for the entry identified by ⟨label⟩. If the value is @@ -25323,14 +25379,14 @@ class="cmti-10">false part⟩ is performed and a warning is issued. Unlike the above commands, such as \ifglshasshort, an error occurs if the entry is undefined. -

    As from version 4.23, within ⟨

    As from version 4.23, within ⟨true part⟩ you can use -

    \glscurrentfieldvalue  \glscurrentfieldvalue
    -

    +

    to access the field value. This command is initially defined to nothing but has no relevance outside ⟨true part⟩. This saves re-accessing the field if the test is true. For @@ -25341,13 +25397,13 @@ example:

    \ifglshasfield{useri}{sample}{, \glscurrentfieldvalue}{}
    -

    will insert a comma, space and the field value if the

    will insert a comma, space and the field value if the user1 key has been set for the entry whose label is sample. -

    You can test if the value of the field is equal to a given string using: -

    You can test if the value of the field is equal to a given string using: +

    \ifglsfieldeq  }{⟨false⟩}
    -

    +

    In this case the ⟨field⟩ must be the field name not the key (see table 4.1). If the @@ -25375,7 +25431,7 @@ class="cmtt-10">\ifcsstring to perform the comparison. The string is not expanded during the test. -

    The result may vary depending on whether or not expansion is on for the given field +

    The result may vary depending on whether or not expansion is on for the given field (when the entry was defined). For example: @@ -25393,7 +25449,7 @@ class="cmti-10">test.  
    \ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  
    \end{document}

    -

    This will produce “TRUE” in both cases since expansion is on, so

    This will produce “TRUE” in both cases since expansion is on, so \foo was expanded to “FOO” when sample2 was defined. If the tests are changed to: @@ -25404,7 +25460,7 @@ class="cmtt-10">sample2 was defined. If the tests are changed to: \ifglsfieldeq{sample1}{useri}{\foo}{TRUE}{FALSE}.  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.

    -

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the +

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the user1 key: @@ -25425,10 +25481,10 @@ class="cmss-10">user1\ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  
    \end{document}

    -

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and +

    This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and “FALSE” for the second case (comparing “\foo” with “FOO”). -

    The reverse happens in the following: +

    The reverse happens in the following:

    @@ -25446,14 +25502,14 @@ class="cmtt-10">\foo    ” with “FOO”).  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    This now produces “FALSE” for the first case (comparing “FOO” with “

    This now produces “FALSE” for the first case (comparing “FOO” with “\foo”) and “TRUE” for the second case (comparing “\foo” with “\foo”). -

    You can test if the value of a field is equal to the replacement text of a command +

    You can test if the value of a field is equal to the replacement text of a command using: -

    \ifglsfielddefeq  }{⟨false⟩}
    -

    +

    This internally uses etoolbox’s \ifdefstrequal command to perform the comparison. The argument ⟨command⟩ must be a macro. -

    For example: +

    For example:

    @@ -25494,14 +25550,14 @@ class="cmti-10">command⟩ must be a macro.  
    \ifglsfielddefeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    Here, the first case produces “TRUE” since the value of the

    Here, the first case produces “TRUE” since the value of the useri field (“FOO”) is the same as the replacement text (definition) of \foo (“FOO”). We have the result “FOO” is equal to “FOO”. -

    The second case produces “FALSE” since the value of the

    The second case produces “FALSE” since the value of the useri field (“\foo”) is not the same as the replacement text (definition) of useri field. We have the result “\foo” is not equal to “FOO”. -

    If we add: +

    If we add:

    @@ -25519,7 +25575,7 @@ class="cmtt-10">FOO    ”. \newcommand{\FOO}{\foo}  
    \ifglsfielddefeq{sample2}{useri}{\FOO}{TRUE}{FALSE}.
    -

    we now get “TRUE” since the value of the

    we now get “TRUE” since the value of the useri field (“\foo”) is the same as the replacement text (definition) of \foo”). We have the result “\foo” is equal to “\foo”. -

    There is a similar command that requires the control sequence name (without the leading +

    There is a similar command that requires the control sequence name (without the leading backslash) instead of the actual control sequence: -

    \ifglsfieldcseq  }{⟨false⟩}
    -

    +

    This internally uses etoolbox’s \ifcsstrequal command instead of \ifdefstrequal. -

    +

    -

    Top

    16.3 Fetching and Updating the Value of a Field

    -

    You can fetch the value of a given field and store it in a control sequence using: -

    You can fetch the value of a given field and store it in a control sequence using: +

    \glsfieldfetch  field⟩}{⟨cs⟩}
    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see @@ -25582,7 +25638,7 @@ that field in the argument of \newglossaryentry (or the optional argument of \newacronym). -

    You can change the value of a given field using one of the following commands. Note that +

    You can change the value of a given field using one of the following commands. Note that these commands only change the value of the given field. They have no affect on any related field. For example, if you change the value of the textplural, first or any other related key. -

    In all the four related commands below, ⟨

    In all the four related commands below, ⟨label⟩ and ⟨field⟩ are as above and ⟨definition⟩ is the new value of the field. -

    \glsfielddef  field⟩}{⟨definition⟩}
    -

    +

    This uses \def to change the value of the field (so it will be localised by any grouping). -

    \glsfieldedef  field⟩}{⟨definition⟩}
    -

    +

    This uses \edef to change the value of the field (so it will be localised by any grouping). Any fragile commands contained in the ⟨definition⟩ must be protected. -

    \glsfieldgdef  field⟩}{⟨definition⟩}
    -

    +

    This uses \gdef to change the value of the field. -

    \glsfieldxdef  field⟩}{⟨definition⟩}
    -

    +

    This uses \xdef to change the value of the field. Any fragile commands contained in the ⟨definition⟩ must be protected.

    -

    -

    +

    Top

    17. Prefixes or Determiners

    -

    The

    The glossaries-prefix package that comes with the glossaries package provides additional @@ -25677,7 +25733,7 @@ keys that can be used as prefixes. For example, if you want to specify determine class="cmss-10">glossaries-prefix package automatically loads the glossaries package and has the same package options. -

    The extra keys for

    The extra keys for \newglossaryentry are as follows:

    @@ -25716,11 +25772,11 @@ class="cmss-10">prefixplural key.
    -

    Example 30 (Defining Determiners) -

    Here’s the start of my example document: +

    Here’s the start of my example document:

    @@ -25729,7 +25785,7 @@ documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage[toc,acronym]{glossaries-prefix}
    -

    Note that I’ve simply replaced

    Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample definition17.1  
      prefixplural={the\space}%  
    }

    -

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility +

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility of prefixes that shouldn’t have a space, such as: @@ -25757,7 +25813,7 @@ of prefixes that shouldn’t have a space, such as:  
      prefix={l'},  
      prefixplural={les\space}}

    -

    Where a space is required at the end of the prefix, you must use a spacing command, such as +

    Where a space is required at the end of the prefix, you must use a spacing command, such as \space, \␣ (backslash space) or ~ due to the automatic spacing trimming per ⟨key⟩=⟨value⟩ options. -

    The prefixes can also be used with acronyms. For example: +

    The prefixes can also be used with acronyms. For example:

    @@ -25775,12 +25831,12 @@ class="cmti-10">value    ⟩ options.  
       prefix={an\space},prefixfirst={a~}%  
     ]{svm}{SVM}{support vector machine}
    -

    +

    -

    -

    ____________________________

    -

    The

    +

    ____________________________

    +

    The glossaries-prefix package provides convenient commands to use these prefixes with commands such as §6 Links to Glossary Entries for further details.) -

    \pgls  label⟩}[⟨insert⟩]
    -

    +

    This is inserts the value of the prefix key (or label⟩}[⟨insert⟩]. -

    \Pgls  label⟩}[⟨insert⟩]
    -

    +

    If the prefix key (or } class="cmtt-10">[⟨insert⟩]. -

    \PGLS  label⟩}[⟨insert⟩]
    -

    +

    As \pgls but converts the prefix to upper case and uses \GLS instead of \gls. -

    \pglspl  label⟩}[⟨insert⟩]
    -

    +

    This is inserts the value of the prefixplural key (or label⟩}[⟨insert⟩]. -

    \Pglspl  label⟩}[⟨insert⟩]
    -

    +

    If the prefixplural key (or } class="cmtt-10">[⟨insert⟩]. -

    \PGLSpl  label⟩}[⟨insert⟩]
    -

    +

    As \pglspl but converts the prefix to upper case and uses \GLSpl\glspl. -

    Example 31 (Using Prefixes) -

    Continuing from Example 

    Continuing from Example 30, now that I’ve defined my entries, I can use them in the text via the above commands: @@ -25978,20 +26034,20 @@ First use: \pgls{svm}. Next use: \pgls{svm}.  
    Singular: \pgls{sample}, \pgls{oeil}.  
    Plural: \pglspl{sample}, \pglspl{oeil}.

    -

    which produces: +

    which produces:

    -

    First use: a support vector machine (SVM). Next use: an SVM. Singular: +

    First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. Plural: the samples, les yeux.

    -

    For a complete document, see

    For a complete document, see sample-prefix.tex.

    -

    -

    ____________________________

    -

    This package also provides the commands described below, none of which perform any +

    +

    ____________________________

    +

    This package also provides the commands described below, none of which perform any check to determine the entry’s existence. -

    \ifglshasprefix  true part⟩}{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefix key. -

    This package also provides the following commands: -

    This package also provides the following commands: +

    \ifglshasprefixplural  }{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixplural key. -

    \ifglshasprefixfirst  }{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirst key. -

    \ifglshasprefixfirstplural  } class="cmtt-10">{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirstplural key. -

    \glsentryprefix  \glsentryprefix{⟨label⟩}
    -

    +

    Displays the value of the prefix key for the entry given by ⟨label⟩. -

    \glsentryprefixfirst  \glsentryprefixfirst{⟨label⟩}
    -

    +

    Displays the value of the prefixfirst key for the entry given by ⟨label⟩. -

    \glsentryprefixplural  \glsentryprefixplural{⟨label⟩}
    -

    +

    Displays the value of the prefixplural key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    \glsentryprefixfirstplural  \glsentryprefixfirstplural{⟨label⟩}
    -

    +

    Displays the value of the prefixfirstplural key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    There are also variants that convert the first letter to upper +

    There are also variants that convert the first letter to upper case17.2: -

    \Glsentryprefix  \Glsentryprefix{⟨label⟩}
    -

    -

    +

    \Glsentryprefixfirst  \Glsentryprefixfirst{⟨label⟩}
    -

    -

    +

    \Glsentryprefixplural  \Glsentryprefixplural{⟨label⟩}
    -

    -

    +

    \Glsentryprefixfirstplural  \Glsentryprefixfirstplural{⟨label⟩}
    -

    -

    As with analogous commands such as

    +

    As with analogous commands such as \Glsentrytext, these commands aren’t expandable so can’t be used in PDF bookmarks.
    -

    +

    -

    Example 32 (Adding Determiner to Glossary Style) -

    You can use the above commands to define a new glossary style that uses the determiner. +

    You can use the above commands to define a new glossary style that uses the determiner. For example, the following style is a slight modification of the list style that inserts the prefix @@ -26185,18 +26241,18 @@ before the name:  
           \glossentrydesc{##1}\glspostdescription\space ##2}%  
    }

    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    18. Accessibility Support

    -

    Limited accessibility support is provided by the accompanying

    Limited accessibility support is provided by the accompanying glossaries-accsupp package, but note that this package is experimental and it requires the shortplural\newacronym). -

    For example: +

    For example:

    @@ -26316,7 +26372,7 @@ class="cmtt-10">\newacronympreparation language},access={TeX}}
    -

    Now

    Now \gls{tex} will be equivalent to @@ -26324,12 +26380,12 @@ class="cmtt-10">\gls{tex} will be equivalent to

    \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{}
    -

    The sample file

    The sample file sampleaccsupp.tex illustrates the glossaries-accsupp package. -

    See the documented code (

    See the documented code (glossaries-code.pdf) for further details. I recommend that you also read the accsuppaccsupp -

    -

    +

    Top

    19. Troubleshooting

    -

    In addition to the sample files listed in

    In addition to the sample files listed in §1.2 Sample Documents, the EX code is available at http://www.dickimaw-books.com/latex/minexample/. -

    If you have any problems, please first consult the

    If you have any problems, please first consult the glossaries FAQ. If that doesn’t help, try posting your query to somewhere like the doc package  181, 182, 183, 184
    +href="glossaries-user.html#dx1-29044" >184

    E encap  glossaries package  261, 262, 263, 264, 265, 264, 265, 266, 267, 268, 309
    class="cmss-10">glossary package  310, 311, 312, 312, 313, 314, 315
    @@ -27126,388 +27182,388 @@ class="cmtt-10">alttreehypergroup  365, 366
        bookindex  367
    -    index  368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379
    +href="glossaries-user.html#dx1-25051" >367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378
        indexgroup  380, 381, 382
    +href="glossaries-user.html#dx1-85024" >379, 380, 381
        indexhypergroup  383, 384, 385
    +href="glossaries-user.html#dx1-85007" >382, 383, 384
        inline  386, 387, 388
    +href="glossaries-user.html#dx1-11067" >385, 386, 387
        list  389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401
    +href="glossaries-user.html#dx1-25044" >388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400
        listdotted  402, 403, 404, 405, 406
    +href="glossaries-user.html#dx1-78038" >401, 402, 403, 404, 405
        listgroup  407, 408, 409, 410
    +href="glossaries-user.html#dx1-26022" >406, 407, 408, 409
        listhypergroup  411, 412, 413, 414, 415, 416, 417, 418
    +href="glossaries-user.html#dx1-79019" >410, 411, 412, 413, 414, 415, 416, 417
        long  419, 420, 421, 422, 423, 424
    +href="glossaries-user.html#dx1-78027" >418, 419, 420, 421, 422, 423
        long-booktabs  425, 426
    +href="glossaries-user.html#dx1-82024" >424, 425
        long3col  427, 428, 429, 430, 431
    +href="glossaries-user.html#dx1-78011" >426, 427, 428, 429, 430
        long3col-booktabs  432
    +href="glossaries-user.html#dx1-82026" >431
        long3colborder  433, 434
    +href="glossaries-user.html#dx1-78013" >432, 433
        long3colheader  435, 436, 437, 438
    +href="glossaries-user.html#dx1-78012" >434, 435, 436, 437
        long3colheaderborder  439, 440
    +href="glossaries-user.html#dx1-78014" >438, 439
        long4col  441, 442, 443, 444, 445
    +href="glossaries-user.html#dx1-78022" >440, 441, 442, 443, 444
        long4col-booktabs  446
    +href="glossaries-user.html#dx1-82029" >445
        long4colborder  447, 448
    +href="glossaries-user.html#dx1-80033" >446, 447
        long4colheader  449, 450, 451, 452
    +href="glossaries-user.html#dx1-80035" >448, 449, 450, 451
        long4colheaderborder  453, 454
    +href="glossaries-user.html#dx1-80037" >452, 453
        longborder  455
    +href="glossaries-user.html#dx1-80013" >454
        longheader  456, 457, 458, 459
    +href="glossaries-user.html#dx1-80015" >455, 456, 457, 458
        longheaderborder  460, 461
    +href="glossaries-user.html#dx1-80017" >459, 460
        longragged  462, 463, 464, 465
    +href="glossaries-user.html#dx1-81010" >461, 462, 463, 464
        longragged-booktabs  466
    +href="glossaries-user.html#dx1-82033" >465
        longragged3col  467, 468, 469, 470
    +href="glossaries-user.html#dx1-81019" >466, 467, 468, 469
        longragged3col-booktabs  471
    +href="glossaries-user.html#dx1-82035" >470
        longragged3colborder  472
    +href="glossaries-user.html#dx1-81024" >471
        longragged3colheader  473, 474, 475
    +href="glossaries-user.html#dx1-81026" >472, 473, 474
        longragged3colheaderborder  476
    +href="glossaries-user.html#dx1-81028" >475
        longraggedborder  477
    +href="glossaries-user.html#dx1-81013" >476
        longraggedheader  478, 479, 480
    +href="glossaries-user.html#dx1-81015" >477, 478, 479
        longraggedheaderborder  481
    +href="glossaries-user.html#dx1-81017" >480
        mcolalttree  482
    +href="glossaries-user.html#dx1-86039" >481
        mcolalttreegroup  483
    +href="glossaries-user.html#dx1-86041" >482
        mcolalttreehypergroup  484
    +href="glossaries-user.html#dx1-86043" >483
        mcolalttreespannav  485
    +href="glossaries-user.html#dx1-86044" >484
        mcolindex  486, 487
    +href="glossaries-user.html#dx1-86005" >485, 486
        mcolindexgroup  488
    +href="glossaries-user.html#dx1-86020" >487
        mcolindexhypergroup  489
    +href="glossaries-user.html#dx1-86022" >488
        mcolindexspannav  490
    +href="glossaries-user.html#dx1-86023" >489
        mcoltree  491
    - - +href="glossaries-user.html#dx1-86025" >490
        mcoltreegroup  492
    +href="glossaries-user.html#dx1-86027" >491
    + +     mcoltreehypergroup  493, 494
    +href="glossaries-user.html#dx1-86029" >492, 493
        mcoltreenoname  495
    +href="glossaries-user.html#dx1-86032" >494
        mcoltreenonamegroup  496
    +href="glossaries-user.html#dx1-86034" >495
        mcoltreenonamehypergroup  497
    +href="glossaries-user.html#dx1-86036" >496
        mcoltreenonamespannav  498
    +href="glossaries-user.html#dx1-86037" >497
        mcoltreespannav  499
    +href="glossaries-user.html#dx1-86030" >498
        super  500, 501, 502, 503
    +href="glossaries-user.html#dx1-83012" >499, 500, 501, 502
        super3col  504, 505, 506, 507
    +href="glossaries-user.html#dx1-83024" >503, 504, 505, 506
        super3colborder  508
    +href="glossaries-user.html#dx1-83029" >507
        super3colheader  509, 510
    +href="glossaries-user.html#dx1-83031" >508, 509
        super3colheaderborder  511
    +href="glossaries-user.html#dx1-83033" >510
        super4col  512, 513, 514, 515, 516
    +href="glossaries-user.html#dx1-78023" >511, 512, 513, 514, 515
        super4colborder  517, 518
    +href="glossaries-user.html#dx1-83038" >516, 517
        super4colheader  519, 520, 521
    +href="glossaries-user.html#dx1-83040" >518, 519, 520
        super4colheaderborder  522, 523
    +href="glossaries-user.html#dx1-83042" >521, 522
        superborder  524
    +href="glossaries-user.html#dx1-83018" >523
        superheader  525, 526
    +href="glossaries-user.html#dx1-83020" >524, 525
        superheaderborder  527, 528
    +href="glossaries-user.html#dx1-63069" >526, 527
        superragged  529, 530, 531, 532
    +href="glossaries-user.html#dx1-84009" >528, 529, 530, 531
        superragged3col  533, 534, 535, 536
    +href="glossaries-user.html#dx1-84021" >532, 533, 534, 535
        superragged3colborder  537
    +href="glossaries-user.html#dx1-84026" >536
        superragged3colheader  538, 539
    +href="glossaries-user.html#dx1-84028" >537, 538
        superragged3colheaderborder  540
    +href="glossaries-user.html#dx1-84030" >539
        superraggedborder  541
    +href="glossaries-user.html#dx1-84015" >540
        superraggedheader  542, 543
    +href="glossaries-user.html#dx1-84017" >541, 542
        superraggedheaderborder  544
    +href="glossaries-user.html#dx1-84019" >543
        tree  545, 546, 547, 548, 549, 550, 551
    +href="glossaries-user.html#dx1-72066" >544, 545, 546, 547, 548, 549, 550
        treegroup  552, 553, 554
    +href="glossaries-user.html#dx1-85035" >551, 552, 553
        treehypergroup  555, 556, 557
    +href="glossaries-user.html#dx1-79024" >554, 555, 556
        treenoname  558, 559, 560, 561
    +href="glossaries-user.html#dx1-85012" >557, 558, 559, 560
        treenonamegroup  562, 563, 564
    +href="glossaries-user.html#dx1-85042" >561, 562, 563
        treenonamehypergroup  565, 566
    +href="glossaries-user.html#dx1-85044" >564, 565
    glossary-bookindex package  567
    +href="glossaries-user.html#dx1-78004" >566
    glossary-inline package  568, 569
    +href="glossaries-user.html#dx1-87001" >567, 568
    glossary-list package  570, 571, 572, 573, 574
    +href="glossaries-user.html#dx1-25029" >569, 570, 571, 572, 573
    glossary-long package  575, 576, 577, 578, 579, 580, 581, 582
    +href="glossaries-user.html#dx1-25030" >574, 575, 576, 577, 578, 579, 580, 581
    glossary-longbooktabs package  583, 584, 585
    +href="glossaries-user.html#dx1-82001" >582, 583, 584
    +glossary-longnoloc package  585
    glossary-longragged package  586, 1089, 1090, 1091, 1092, 1093, 1093, 1094, 1095, 1096, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244
    +href="glossaries-user.html#dx1-26079" >1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245
        -g  1245, 1246, 1247
    +href="glossaries-user.html#dx1-7014" >1246, 1247, 1248
        -l  1248, 1249, 1250, 1251, 1252
    +href="glossaries-user.html#dx1-7029" >1249, 1250, 1251, 1252, 1253
    \makenoidxglossaries  1253
    +class="cmti-10">1254
    memoir class  1254, 1255, 1256, 1257
    +href="glossaries-user.html#dx1-24021" >1255, 1256, 1257, 1258
    mfirstuc package  1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265
    +href="glossaries-user.html#dx1-7" >1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266
    multicol package  1266
    +href="glossaries-user.html#dx1-86004" >1267
    mwe package  1267
    +href="glossaries-user.html#dx1-12008" >1268

    N nameref package  1268
    +href="glossaries-user.html#dx1-24049" >1269
    \newacronym  1269
    +class="cmti-10">1270
    \newacronymstyle  1270
    +class="cmti-10">1271
    \newglossary  1271
    +class="cmti-10">1272
    \newglossary*  1272
    +class="cmti-10">1273
    \newglossaryentry  1273
    +class="cmti-10">1274
    \newglossaryentry options
         access  1274
    +href="glossaries-user.html#dx1-94003" >1275
        description  1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292
    +href="glossaries-user.html#dx1-12009" >1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293
        descriptionaccess  1293
    +href="glossaries-user.html#dx1-94017" >1294
        descriptionplural  1294, 1295, 1296, 1297
    +href="glossaries-user.html#dx1-34026" >1295, 1296, 1297, 1298
        descriptionpluralaccess  1298
    +href="glossaries-user.html#dx1-94019" >1299
        entrycounter  1299, 1300
    +href="glossaries-user.html#dx1-63035" >1300, 1301
        first  1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325
    +href="glossaries-user.html#dx1-3020" >1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326
        firstaccess  1326
    +href="glossaries-user.html#dx1-94007" >1327
        firstplural  1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344
    +href="glossaries-user.html#dx1-3021" >1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345
        firstpluralaccess  1345
    +href="glossaries-user.html#dx1-94011" >1346
        format  1346
    +href="glossaries-user.html#dx1-54068" >1347
        long  1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359
    +href="glossaries-user.html#dx1-23108" >1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360
        longaccess  1360
    +href="glossaries-user.html#dx1-94021" >1361
        longplural  1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371
    +href="glossaries-user.html#dx1-15007" >1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372
        longpluralaccess  1372
    +href="glossaries-user.html#dx1-94027" >1373
        name  1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408
    +href="glossaries-user.html#dx1-12006" >1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409
        nonumberlist  1409
    +href="glossaries-user.html#dx1-34107" >1410
        parent  1410, 1411, 1412, 1413
    +href="glossaries-user.html#dx1-34013" >1411, 1412, 1413, 1414
        plural  1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430
    +href="glossaries-user.html#dx1-15006" >1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431
        pluralaccess  1431
    +href="glossaries-user.html#dx1-94009" >1432
        prefix  1432, 1433, 1434, 1435, 1436, 1437, 1438
    +href="glossaries-user.html#dx1-93003" >1433, 1434, 1435, 1436, 1437, 1438, 1439
        prefixfirst  1439, 1440, 1441, 1442, 1443
    +href="glossaries-user.html#dx1-93007" >1440, 1441, 1442, 1443, 1444
        prefixfirstplural  1444, 1445, 1446, 1447, 1448
    +href="glossaries-user.html#dx1-93010" >1445, 1446, 1447, 1448, 1449
        prefixplural  1449, 1450, 1451, 1452, 1453, 1454
    +href="glossaries-user.html#dx1-93005" >1450, 1451, 1452, 1453, 1454, 1455
        see  1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473
    +href="glossaries-user.html#dx1-23018" >1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474
        short  1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484
    +href="glossaries-user.html#dx1-34130" >1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485
        shortaccess  1485
    +href="glossaries-user.html#dx1-94024" >1486
        shortplural  1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497
    +href="glossaries-user.html#dx1-15008" >1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498
        shortpluralaccess  1498
    +href="glossaries-user.html#dx1-94030" >1499
        sort  1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532
    +href="glossaries-user.html#dx1-3050" >1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532, 1533
        subentrycounter  1533
    +href="glossaries-user.html#dx1-63036" >1534
        symbol  1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546
    +href="glossaries-user.html#dx1-12004" >1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547
        symbolaccess  1547
    +href="glossaries-user.html#dx1-94013" >1548
        symbolplural  1548, 1549, 1550
    +href="glossaries-user.html#dx1-34065" >1549, 1550, 1551
        symbolpluralaccess  1551
    +href="glossaries-user.html#dx1-94015" >1552
        text  1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572
    +href="glossaries-user.html#dx1-34028" >1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573
        textaccess  1573
    +href="glossaries-user.html#dx1-94005" >1574
        type  1574, 1575, 1576
    +href="glossaries-user.html#dx1-34097" >1575, 1576, 1577
        user1  1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587
    +href="glossaries-user.html#dx1-12007" >1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588
        user2  1588, 1589, 1590, 1591
    +href="glossaries-user.html#dx1-34101" >1589, 1590, 1591, 1592
        user3  1592, 1593, 1594
    +href="glossaries-user.html#dx1-34102" >1593, 1594, 1595
        user4  1595, 1596, 1597
    +href="glossaries-user.html#dx1-34103" >1596, 1597, 1598
        user5  1598, 1599, 1600
    +href="glossaries-user.html#dx1-34104" >1599, 1600, 1601
        user6  1601, 1602, 1603, 1604
    +href="glossaries-user.html#dx1-34100" >1602, 1603, 1604, 1605
    \newglossarystyle  1605
    +class="cmti-10">1606
    \newignoredglossary  1606
    +class="cmti-10">1607
    \newterm  1607
    +class="cmti-10">1608
    ngerman package  1608, 1609, 1610, 1611
    +href="glossaries-user.html#dx1-13031" >1609, 1610, 1611, 1612
    \noist  1612
    +class="cmti-10">1613
    Non-Latin Alphabet  1613
    +class="cmbx-10">1614
    non-Latin character  1614, 1615, 1615, 1616, 1616, 1617, 1618, 1619, 1620, 1621, 1622, 1623, 1624
    +class="cmbx-10">1617, 1618, 1619, 1620, 1621, 1622, 1623, 1624, 1625
    \nopostdesc  1625
    +class="cmti-10">1626
    number list  1626, 1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635, 1636, 1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656, 1657, 1658, 1659, 1660, 1661, 1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692
    +class="cmbx-10">1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635, 1636, 1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656, 1657, 1658, 1659, 1660, 1661, 1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693

    O \oldacronym  1693
    +class="cmti-10">1694

    P package options:
         acronym  1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717
    +href="glossaries-user.html#dx1-14026" >1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718
            true  1718, 1719
    +href="glossaries-user.html#dx1-22002" >1719, 1720
        acronymlists  1720, 1721, 1722, 1723, 1724, 1725, 1726
    +href="glossaries-user.html#dx1-27019" >1721, 1722, 1723, 1724, 1725, 1726, 1727
        acronyms  1727, 1728
    +href="glossaries-user.html#dx1-23028" >1728, 1729
        automake  1729, 1730, 1731, 1732
    +href="glossaries-user.html#dx1-7006" >1730, 1731, 1732, 1733
            false  1733
    +href="glossaries-user.html#dx1-26098" >1734
    +        immediate  1735, 1736, 1737
    +        true  1738, 1739
        compatible-2.07  1734, 1735, 1736
    +href="glossaries-user.html#dx1-29032" >1740, 1741, 1742
        compatible-3.07  1737, 1738, 1739
    +href="glossaries-user.html#dx1-27004" >1743, 1744, 1745
        counter  1740, 1741, 1742, 1743, 1744
    +href="glossaries-user.html#dx1-25086" >1746, 1747, 1748, 1749, 1750
            page  1745
    +href="glossaries-user.html#dx1-25087" >1751
        counterwithin  1746, 1747, 1748, 1749, 1750
    +href="glossaries-user.html#dx1-25010" >1752, 1753, 1754, 1755, 1756
        debug  1751, 1752, 1753
    +href="glossaries-user.html#dx1-23008" >1757, 1758, 1759
            false  1754
    +href="glossaries-user.html#dx1-23009" >1760
            showtargets  1755, 1756, 1757
    +href="glossaries-user.html#dx1-23004" >1761, 1762, 1763
            true  1758, 1759, 1760
    +href="glossaries-user.html#dx1-23003" >1764, 1765, 1766
        description  1761, 1762, 1763, 1764, 1765, 1766, 1767, 1768, 1769
    +href="glossaries-user.html#dx1-28002" >1767, 1768, 1769, 1770, 1771, 1772, 1773, 1774, 1775
        dua  1770, 1771
    +href="glossaries-user.html#dx1-28011" >1776, 1777
        entrycounter  1772, 1773, 1774, 1775, 1776
    +href="glossaries-user.html#dx1-25001" >1778, 1779, 1780, 1781, 1782
            false  1777
    +href="glossaries-user.html#dx1-25002" >1783
            true  1778
    +href="glossaries-user.html#dx1-25011" >1784
        esclocations  1779
    +href="glossaries-user.html#dx1-25059" >1785
            false  1780, 1781, 1782
    +href="glossaries-user.html#dx1-25062" >1786, 1787, 1788
            true  1783
    +href="glossaries-user.html#dx1-25060" >1789
        footnote  1784, 1785, 1786, 1787, 1788, 1789
    +href="glossaries-user.html#dx1-28006" >1790, 1791, 1792, 1793, 1794, 1795
        hyperfirst  1790, 1791, 1792, 1793
    +href="glossaries-user.html#dx1-23088" >1796, 1797, 1798, 1799
            false  1794, 1795, 1796, 1797, 1798
    +href="glossaries-user.html#dx1-23102" >1800, 1801, 1802, 1803, 1804
            true  1799, 1800
    +href="glossaries-user.html#dx1-23089" >1805, 1806
        index  1801, 1802, 1803, 1804, 1805
    +href="glossaries-user.html#dx1-23031" >1807, 1808, 1809, 1810, 1811, 1812, 1813
        indexonlyfirst  1806, 1807, 1808
    +href="glossaries-user.html#dx1-23112" >1814, 1815, 1816
            false  1809
    +href="glossaries-user.html#dx1-23113" >1817
        kernelglossredefs  1810
    +href="glossaries-user.html#dx1-29034" >1818
            false  1811
    +href="glossaries-user.html#dx1-29036" >1819
        makeindex  1812, 1813, 1814
    +href="glossaries-user.html#dx1-22004" >1820, 1821, 1822
        ngerman  1815
    +href="glossaries-user.html#dx1-13034" >1823
    +    noglossaryindex  1824
        nogroupskip  1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823
    +href="glossaries-user.html#dx1-11018" >1825, 1826, 1827, 1828, 1829, 1830, 1831, 1832
            false  1824
    +href="glossaries-user.html#dx1-25092" >1833
        nohypertypes  1825, 1826, 1827, 1828, 1829, 1830, 1831, 1832, 1833
    +href="glossaries-user.html#dx1-23084" >1834, 1835, 1836, 1837, 1838, 1839, 1840, 1841, 1842
            index  1834
    +href="glossaries-user.html#dx1-29026" >1843
        nolangwarn  1835, 1836
    +href="glossaries-user.html#dx1-4" >1844, 1845
        nolist  1837, 1838, 1839
    +href="glossaries-user.html#dx1-25041" >1846, 1847, 1848
        nolong  1840, 1841, 1842, 1843
    +href="glossaries-user.html#dx1-25033" >1849, 1850, 1851, 1852
        nomain  1844, 1845, 1846, 1847, 1848, 1849, 1850, 1851, 1852
    +href="glossaries-user.html#dx1-23026" >1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861
        nonumberlist  1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862
    +href="glossaries-user.html#dx1-3048" >1862, 1863, 1864, 1865, 1866, 1867, 1868, 1869, 1870, 1871
        nopostdot  1863, 1864
    +href="glossaries-user.html#dx1-25089" >1872, 1873
            false  1865
    +href="glossaries-user.html#dx1-25090" >1874
    + +     noredefwarn  1866
    +href="glossaries-user.html#dx1-23006" >1875
        nostyles  1867, 1868, 1869, 1870, 1871, 1872, 1873
    +href="glossaries-user.html#dx1-25053" >1876, 1877, 1878, 1879, 1880, 1881, 1882
        nosuper  1874, 1875, 1876, 1877
    - - +href="glossaries-user.html#dx1-25037" >1883, 1884, 1885, 1886
        notranslate  1878, 1879, 1880
    +href="glossaries-user.html#dx1-14010" >1887, 1888, 1889
        notree  1881, 1882, 1883, 1884
    +href="glossaries-user.html#dx1-25047" >1890, 1891, 1892, 1893
        nowarn  1885, 1886, 1887
    +href="glossaries-user.html#dx1-23001" >1894, 1895, 1896
        numberedsection  1888, 1889, 1890, 1891, 1892
    +href="glossaries-user.html#dx1-24035" >1897, 1898, 1899, 1900, 1901
            autolabel  1893, 1894
    +href="glossaries-user.html#dx1-24039" >1902, 1903
            false  1895
    +href="glossaries-user.html#dx1-24037" >1904
            nameref  1896
    +href="glossaries-user.html#dx1-24045" >1905
            nolabel  1897
    +href="glossaries-user.html#dx1-24038" >1906
        numberline  1898, 1899
    +href="glossaries-user.html#dx1-24004" >1907, 1908
        numbers  1900, 1901, 1902
    +href="glossaries-user.html#dx1-23030" >1909, 1910, 1911
        order  1903, 1904, 1905
    +href="glossaries-user.html#dx1-26047" >1912, 1913, 1914
            letter  1906, 1907, 1908, 1909, 1910
    +href="glossaries-user.html#dx1-7034" >1915, 1916, 1917, 1918, 1919
            word  1911, 1912, 1913
    +href="glossaries-user.html#dx1-11060" >1920, 1921, 1922
        record  1914
    +href="glossaries-user.html#dx1-13010" >1923
        sanitizesort  1915, 1916, 1917
    +href="glossaries-user.html#dx1-5006" >1924, 1925, 1926
            false  1918, 1919, 1920, 1921, 1922, 1923
    +href="glossaries-user.html#dx1-6001" >1927, 1928, 1929, 1930, 1931, 1932
            true  1924, 1925, 1926, 1927, 1928, 1929, 1930, 1931, 1932
    +href="glossaries-user.html#dx1-6003" >1933, 1934, 1935, 1936, 1937, 1938, 1939, 1940, 1941
        savenumberlist  1933, 1934
    +href="glossaries-user.html#dx1-23118" >1942, 1943
            false  1935
    +href="glossaries-user.html#dx1-23120" >1944
        savewrites  1936, 1937, 1938
    +href="glossaries-user.html#dx1-23040" >1945, 1946, 1947
            false  1939
    +href="glossaries-user.html#dx1-23041" >1948
        section  1940, 1941
    +href="glossaries-user.html#dx1-24011" >1949, 1950
        seeautonumberlist  1942, 1943, 1944, 1945
    +href="glossaries-user.html#dx1-25077" >1951, 1952, 1953, 1954
        seenoindex  1946, 1947
    +href="glossaries-user.html#dx1-23021" >1955, 1956
            ignore  1948
    +href="glossaries-user.html#dx1-23025" >1957
            warn  1949
    +href="glossaries-user.html#dx1-23024" >1958
        shortcuts  1950, 1951
    +href="glossaries-user.html#dx1-27026" >1959, 1960
        smallcaps  1952, 1953, 1954, 1955, 1956, 1957
    +href="glossaries-user.html#dx1-28004" >1961, 1962, 1963, 1964, 1965, 1966
        smaller  1958, 1959, 1960, 1961, 1962
    +href="glossaries-user.html#dx1-28005" >1967, 1968, 1969, 1970, 1971
        sort  1963
    +href="glossaries-user.html#dx1-26001" >1972
            def  1964, 1965, 1966, 1967, 1968, 1969, 1970, 1971, 1972, 1973, 1974
    +href="glossaries-user.html#dx1-6006" >1973, 1974, 1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983
            none  1975, 1976, 1977, 1978
    +href="glossaries-user.html#dx1-5009" >1984, 1985, 1986, 1987
            standard  1979, 1980, 1981
    +href="glossaries-user.html#dx1-26006" >1988, 1989, 1990
            use  1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992
    +href="glossaries-user.html#dx1-6005" >1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
        style  1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000
    +href="glossaries-user.html#dx1-25025" >2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
            index  2001
    +href="glossaries-user.html#dx1-25028" >2010
            list  2002
    +href="glossaries-user.html#dx1-25026" >2011
        subentrycounter  2003, 2004, 2005, 2006, 2007, 2008
    +href="glossaries-user.html#dx1-25019" >2012, 2013, 2014, 2015, 2016, 2017
            false  2009
    +href="glossaries-user.html#dx1-25020" >2018
        symbols  2010, 2011, 2012
    +href="glossaries-user.html#dx1-23029" >2019, 2020, 2021
        toc  2013, 2014, 2015, 2016, 2017, 2018
    +href="glossaries-user.html#dx1-7038" >2022, 2023, 2024, 2025, 2026, 2027
        translate  2019, 2020, 2021, 2022
    +href="glossaries-user.html#dx1-23051" >2028, 2029, 2030, 2031
            babel  2023, 2024, 2025, 2026, 2027, 2028
    +href="glossaries-user.html#dx1-14012" >2032, 2033, 2034, 2035, 2036, 2037
    + +         false  2029, 2030, 2031, 2032
    +href="glossaries-user.html#dx1-14011" >2038, 2039, 2040, 2041
            true  2033, 2034, 2035, 2036
    +href="glossaries-user.html#dx1-23052" >2042, 2043, 2044, 2045
        ucfirst  2037
    - - +href="glossaries-user.html#dx1-24032" >2046
        ucmark  2038, 2039
    +href="glossaries-user.html#dx1-24017" >2047, 2048
            false  2040
    +href="glossaries-user.html#dx1-24020" >2049
            true  2041
    +href="glossaries-user.html#dx1-24022" >2050
        xindy  2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055
    +href="glossaries-user.html#dx1-8015" >2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062, 2063, 2064
        xindygloss  2056, 2057
    +href="glossaries-user.html#dx1-26072" >2065, 2066
        xindynoglsnumbers  2058, 2059
    +href="glossaries-user.html#dx1-26076" >2067, 2068
    page (counter)  2060, 2061
    +href="glossaries-user.html#dx1-66036" >2069, 2070
    page type precedence  2062
    +href="glossaries-user.html#dx1-53005" >2071
    pdflatex  2063, 2064
    +href="glossaries-user.html#dx1-28" >2072, 2073
    \PGLS  2065
    +class="cmti-10">2074
    \Pgls  2066
    +class="cmti-10">2075
    \pgls  2067
    +class="cmti-10">2076
    \PGLSpl  2068
    +class="cmti-10">2077
    \Pglspl  2069
    +class="cmti-10">2078
    \pglspl  2070
    +class="cmti-10">2079
    pod2man  2071
    +href="glossaries-user.html#dx1-17036" >2080
    polyglossia package  2072, 2073, 2074, 2075, 2076, 2077, 2078
    +href="glossaries-user.html#dx1-14002" >2081, 2082, 2083, 2084, 2085, 2086, 2087
    \printacronyms  2079
    +class="cmti-10">2088
    \printglossaries  2080
    +class="cmti-10">2089
    \printglossary  2081
    +class="cmti-10">2090
    \printglossary options
         entrycounter  2082
    +href="glossaries-user.html#dx1-63032" >2091
        nogroupskip  2083
    +href="glossaries-user.html#dx1-63030" >2092
        nonumberlist  2084
    +href="glossaries-user.html#dx1-63029" >2093
        nopostdot  2085
    +href="glossaries-user.html#dx1-63031" >2094
        numberedsection  2086
    +href="glossaries-user.html#dx1-63026" >2095
        style  2087, 2088, 2089, 2090, 2091
    +href="glossaries-user.html#dx1-25057" >2096, 2097, 2098, 2099, 2100
        subentrycounter  2092
    +href="glossaries-user.html#dx1-63034" >2101
        title  2093, 2094, 2095, 2096, 2097
    +href="glossaries-user.html#dx1-5" >2102, 2103, 2104, 2105, 2106
        toctitle  2098
    +href="glossaries-user.html#dx1-63020" >2107
        type  2099, 2100
    +href="glossaries-user.html#dx1-63016" >2108, 2109
    \printindex  2101
    +class="cmti-10">2110
    \printnoidxglossaries  2102
    +class="cmti-10">2111
    \printnoidxglossary  2103
    +class="cmti-10">2112
    \printnoidxglossary options
         sort  2104, 2105, 2106, 2107
    +href="glossaries-user.html#dx1-26002" >2113, 2114, 2115, 2116
    \printnumbers  2108
    +class="cmti-10">2117
    \printsymbols  2109
    +class="cmti-10">2118
    \provideglossaryentry  2110
    +class="cmti-10">2119

    R relsize package  2111, 2112
    +href="glossaries-user.html#dx1-28019" >2120, 2121
    + +

    S sanitize  2113, 2114, 2115, 2116, 2117
    - - +class="cmbx-10">2122, 2123, 2124, 2125, 2126
    scrwfile package  2118
    +href="glossaries-user.html#dx1-23044" >2127
    \SetAcronymLists  2119
    +class="cmti-10">2128
    \setacronymstyle  2120
    +class="cmti-10">2129
    \setglossarypreamble  2121
    +class="cmti-10">2130
    \setglossarysection  2122
    +class="cmti-10">2131
    \setglossarystyle  2123
    +class="cmti-10">2132
    \setStyleFile  2124
    +class="cmti-10">2133
    \setupglossaries  2125
    +class="cmti-10">2134
    stix package  2126
    +href="glossaries-user.html#dx1-66035" >2135
    \subglossentry  2127
    +class="cmti-10">2136
    supertabular package  2128, 2129, 2130
    +href="glossaries-user.html#dx1-25039" >2137, 2138, 2139

    T tabularx package  2131, 2132, 2133, 2134
    +href="glossaries-user.html#dx1-55005" >2140, 2141, 2142, 2143
    textcase package  2135, 2136, 2137
    +href="glossaries-user.html#dx1-10" >2144, 2145, 2146
    theglossary (environment)  2138
    +class="cmti-10">2147
    tracklang package  2139, 2140, 2141
    +href="glossaries-user.html#dx1-6" >2148, 2149, 2150
    translator package  2142, 2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164, 2165, 2166
    +href="glossaries-user.html#dx1-14009" >2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164, 2165, 2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2175

    X xfor package  2167
    +href="glossaries-user.html#dx1-11" >2176
    xindy  2168, 2169, 2170, 2177, 2178, 2179, 2171, 2172, 2173, 2174, 2175, 2176, 2177, 2178, 2179, 2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277, 2278, 2279, 2280, 2281, 2282, 2283, 2284, 2285, 2286, 2287, 2288, 2289, 2290, 2291, 2292, 2293, 2294, 2295, 2296, 2297, 2298, 2299, 2300, 2301, 2302, 2303, 2304, 2305, 2306, 2307, 2308, 2309, 2310, 2311, 2312, 2313, 2314, 2315, 2316, 2317, 2318, 2319, 2320, 2321, 2322
    +class="cmbx-10">2180, 2181, 2182, 2183, 2184, 2185, 2186, 2187, 2188, 2189, 2190, 2191, 2192, 2193, 2194, 2195, 2196, 2197, 2198, 2199, 2200, 2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208, 2209, 2210, 2211, 2212, 2213, 2214, 2215, 2216, 2217, 2218, 2219, 2220, 2221, 2222, 2223, 2224, 2225, 2226, 2227, 2228, 2229, 2230, 2231, 2232, 2233, 2234, 2235, 2236, 2237, 2238, 2239, 2240, 2241, 2242, 2243, 2244, 2245, 2246, 2247, 2248, 2249, 2250, 2251, 2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265, 2266, 2267, 2268, 2269, 2270, 2271, 2272, 2273, 2274, 2275, 2276, 2277, 2278, 2279, 2280, 2281, 2282, 2283, 2284, 2285, 2286, 2287, 2288, 2289, 2290, 2291, 2292, 2293, 2294, 2295, 2296, 2297, 2298, 2299, 2300, 2301, 2302, 2303, 2304, 2305, 2306, 2307, 2308, 2309, 2310, 2311, 2312, 2313, 2314, 2315, 2316, 2317, 2318, 2319, 2320, 2321, 2322, 2323, 2324, 2325, 2326, 2327, 2328, 2329, 2330, 2331, 2332
        -C  2323, 2324, 2325, 2326, 2327
    +href="glossaries-user.html#dx1-8025" >2333, 2334, 2335, 2336, 2337
        -I  2328, 2329
    +href="glossaries-user.html#dx1-19007" >2338, 2339
        -L  2330, 2331, 2332, 2333
    +href="glossaries-user.html#dx1-8024" >2340, 2341, 2342, 2343
        -M  2334
    +href="glossaries-user.html#dx1-16087" >2344
    xkeyval package  2335, 2336, 2337
    +href="glossaries-user.html#dx1-9" >2345, 2346, 2347
    xspace package  2338, 2339, 2340, 2341, 2342, 2343, 2344
    +href="glossaries-user.html#dx1-74014" >2348, 2349, 2350, 2351, 2352, 2353, 2354

    @@ -30855,7 +30927,7 @@ class="cmr-8">package is automatically loaded by     glossaries.)

    -

    2.4Actually it sets \acronymtypeunless the nomain option has been used.

    -

    4.1This is because \acronymtypeacronympackage option is not used.

    -

    6.1See also “Displaying the glossary” in the documented code, glossaries-code.pdf.

    -

    6.2I’ve used \MakeUppercase in all the examples for clarity, but it will actually use \mfirstucMakeUppercase.

    -

    6.3\glsdisplayfirst but you may need to use the compatible-3.07 option

    -

    8.1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.

    discarded.

    8.2If you redefine \glsseeformat[\seename] in the output file if no optional argument is given.

    -

    8.3In versions before 3.0, \glsentryname key was href="#glo:sanitize">sanitized.

    .

    9.1versions before 3.0 used \glsentrynamebeen sanitized.

    .

    10.1you can’t use the longheaderborderlongtable environment in two column mode.

    two column mode.

    11.1see \glsSetCompositor§3 Setting Up

    -

    11.2see \glsSetAlphaCompositor§3 Setting Up

    -

    11.3With glossaries-extra seealso is appended to the end of the list.

    -

    13.1as from version 1.18

    as from version 1.18

    13.2See David Carlisle’sexplanation in http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace

    -

    15.1These lengths will not be available if you use both the nolonguse the nostyles package option unless you explicitly load the relevant package.

    -

    15.2This style was supplied by Axel Menzel.

    -

    15.3e.g. with the flowfram package.

    -

    17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after “a” in the prefix field.

    -

    17.2The earlier caveats about initial non-Latin characters apply.

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index 69d610481ce..7f160c9fb70 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index fcb488792cd..698933ac277 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -450,11 +450,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.41} + \title{User Manual for glossaries.sty v4.42} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2018-07-23} + \date{2019-01-06} \maketitle \begin{abstract} @@ -545,7 +545,7 @@ package. \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.41}. +\qt{Documented Code for glossaries v4.42}. \item[INSTALL] Installation instructions. @@ -4089,13 +4089,35 @@ and code page can be set via \ics{GlsSetXdyLanguage} and \verb|xindy={glsnumbers=false}| and may be used as a document class option. -\item[\pkgoptdef{automake}] This is a boolean option (new to version -4.08) that will attempt to run \gls{makeindex} or \gls{xindy} using -\TeX's \ics{write18} mechanism at the end of the document. Since -this mechanism can be a security risk, some \TeX\ distributions -disable it completely, in which case this option won't have an -effect. (If this option doesn't appear to work, search the log file -for \qt{runsystem} and see if it is followed by +\item[\pkgoptdef{automake}] This is option was introduced to +version 4.08 as a boolean option. As from version 4.42 it may now +take three values: \texttt{false} (default), \texttt{true} +or \texttt{immediate}. If no option is supplied, \texttt{immediate} +is assumed. +The option \pkgopt[true]{automake} will attempt to run \gls{makeindex} or \gls{xindy} using +\TeX's \ics{write18} mechanism at the end of the document. +The option \pkgopt[immediate]{automake} will attempt to +run \gls{makeindex} or \gls{xindy} at the start of +\ics{makeglossaries} using \cs{immediate} (before the glossary files have been opened). + +In the case of \pkgopt[true]{automake}, the associated files +are created at the end of the document ready for the next \LaTeX\ +run. Since there is a possibility of commands such as \cs{gls} +occurring on the last page of the document, it's not possible +to use \cs{immediate} to close the associated file or with +\cs{write18} since the writing of the final indexing lines may +have been delayed. In certain situations this can mean that +the \cs{write18} fails. In such cases, you will need to use +\pkgopt[immediate]{automake} instead. + +With \pkgopt[immediate]{automake}, you will get a warning on +the first \LaTeX\ run as the associated glossary files don't exist +yet. + +Since this mechanism can be a security risk, some \TeX\ +distributions disable it completely, in which case this option won't +have an effect. (If this option doesn't appear to work, search the +log file for \qt{runsystem} and see if it is followed by \qt{enabled} or \qt{disabled}.) Some distributions allow \cs{write18} in a restricted mode. @@ -4441,6 +4463,11 @@ the package option \pkgopt[index]{nohypertypes} or the command The example file \samplefile{-index} illustrates the use of the \pkgopt{index} package option. +\item[\pkgoptdef{noglossaryindex}] This option switches off \pkgopt{index} +if \pkgopt{index} has been passed implicitly (for example, +through global document options). This option can't be used +in \cs{setupglossaries}. + \item[\pkgoptdef{compatible-2.07}] Compatibility mode for old documents created using version 2.07 or below. @@ -10883,11 +10910,10 @@ package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and 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/}. -Note that \gls{glossaries-extra} provides an additional style -\glostyle{bookindex} in the supplementary package -\sty{glossary-bookindex}, which is designed for indexes (rather than -glossaries). See the \gls{glossaries-extra} manual for further -details. +Note that \gls{glossaries-extra} provides additional styles +in the supplementary packages \sty{glossary-bookindex} and +\sty{glossary-longnoloc}. See the \gls{glossaries-extra} manual for +further details. \begin{important} Note that the group styles (such as \glostyle{listgroup}) will diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index d2d59070d32..ff79fcb0efa 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -255,7 +255,7 @@ span#textcolor40{color:#00FF00} >

    The glossaries package v4.41: a guide for +class="cmr-17">The glossaries package v4.42: a guide for beginners

    @@ -268,7 +268,7 @@ class="td11"> Nicola L.C. Talbot

    2018-07-23

    +class="cmr-12">2019-01-06

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 72795fb5f94..456669e4059 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 86891f9caed..d6300312053 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -31,10 +31,10 @@ \texorpdfstring{{\frenchspacing\obeyspaces\ttfamily#1}}{#1}} \newcommand*{\file}[1]{\texorpdfstring{\texttt{#1}}{#1}} -\title{The glossaries package v4.41: +\title{The glossaries package v4.42: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2018-07-23} +\date{2019-01-06} \ifpdf \externaldocument{glossaries-user} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index e820cca6764..56312bb11a1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -200,7 +200,7 @@ class="td11">Nicola L.C. Talbot

    2018-07-23

    +class="cmr-12">2019-01-06

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 1c9cafaa6a5..3300082598f 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index 6cfef8116ba..f555c71db59 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -34,7 +34,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2018-07-23} +\date{2019-01-06} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf index a27b6857e9c..e42dac13055 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index 322ff852d46..fc55ed55750 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf index 7290eee7f05..7d39d828cb7 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf index 982b4a650a9..0056b9f4af4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf index db142d64df8..4a1f8d25161 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf index f9f15be033f..00eaff2cf33 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf index fcb122fbf4f..8ad12720ae8 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf index e14c20aa3b7..1037320f513 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf index 399f0676669..f84073b018d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf index d279e2c3c6b..c5a28552ae6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf index 424b3ffa774..a2061a2b9ba 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf index c5647bf639f..af2438de510 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf index 83e4b498a22..407ea6961fa 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf index ff977e5ec27..8a9ee959e11 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf index fb8f489c64b..23bf60a9380 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf index 2f9cc05b274..80f293a51b4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf index 22bcdec8163..b6050b20ccf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf index c1f0d8b1940..300afc33cf8 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf index 323b84d0e8e..300767a45d6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf index 6a2e85589ea..7a922cd6ea6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf index 9b2e0cb3894..9ed8e6191aa 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf index cf0ac9e26d6..68f48c57abf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf index 0b845f0d98a..b9a77de1ad1 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf index 7d7c67881e8..661bdee4eb6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf index 95536a0993f..f8214a62e4c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf index 193823e3865..85f8fdb628a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf index 7df6ac3a156..8b5d4e4ff9a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf index 8efc1cf0833..9b1748e0da7 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf index f0562ac8174..be3e4a1b2ad 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf index 76a13f047e3..94e1cad38a3 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf index 9bab22798ae..e5e2bc6c4a3 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf index 58cc1ef5173..04654f3a9e1 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf index 7aaa7e5a43a..6845e69acaf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf index 8ef7463a22a..e7c833d7a24 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf index 080d88485b6..37a7d5cfe86 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf index d65206103d5..48cf778f0af 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf index 05bacf4227d..72b64c8359c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf index 5bc4c5924bf..27c58518cc5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf index 0d34834addb..48760f5264b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf index 761b146893c..cd9ac522fe6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf index 34c93081edd..107107912e6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf index 53fe1a5b95d..13b261d8353 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf index f391ceb2f0d..3c1aef61156 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf index 1bc4fb63da1..ff20680ff18 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf index 8a2cea90f1c..935922047ac 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf index b0789014e01..09ed5d568e2 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf index 7a3131627b6..029f4bfb799 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf index 227d1fc55a6..14c420dcf3c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf and b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf differ -- cgit v1.2.3