From 320de2fb6cc56296c3f8887976eff1088c204664 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 1 Jun 2018 21:42:34 +0000 Subject: glossaries (1jun18) git-svn-id: svn://tug.org/texlive/trunk@47898 c570f23f-e606-0410-a88d-b1316a301751 --- .../linked_scripts/glossaries/makeglossaries | 6 +- .../glossaries/makeglossaries-lite.lua | 4 +- .../texk/texlive/linked_scripts/texlive/tlmgr.pl | 133 +- Master/texmf-dist/doc/latex/glossaries/CHANGES | 5 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 1185632 -> 1188527 bytes .../doc/latex/glossaries/glossaries-user.html | 9787 ++++++++++---------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 885120 -> 886781 bytes .../doc/latex/glossaries/glossaries-user.tex | 54 +- .../doc/latex/glossaries/glossariesbegin.html | 614 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 186056 -> 186628 bytes .../doc/latex/glossaries/glossariesbegin.tex | 10 +- .../doc/latex/glossaries/glossary2glossaries.html | 2 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 142462 -> 142462 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 248680 -> 248680 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49969 -> 49969 bytes .../doc/latex/glossaries/samples/mwe-acr-desc.pdf | Bin 37969 -> 37969 bytes .../doc/latex/glossaries/samples/mwe-acr.pdf | Bin 33661 -> 33661 bytes .../doc/latex/glossaries/samples/mwe-gls.pdf | Bin 29951 -> 29951 bytes .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58829 -> 58829 bytes .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 54834 -> 54834 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53468 -> 53468 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82197 -> 82197 bytes .../latex/glossaries/samples/sample-dot-abbr.pdf | Bin 52806 -> 52806 bytes .../doc/latex/glossaries/samples/sample-dual.pdf | Bin 36467 -> 36467 bytes .../latex/glossaries/samples/sample-entrycount.pdf | Bin 36851 -> 36851 bytes .../latex/glossaries/samples/sample-entryfmt.pdf | Bin 34916 -> 34916 bytes .../latex/glossaries/samples/sample-font-abbr.pdf | Bin 50715 -> 50715 bytes .../latex/glossaries/samples/sample-ignored.pdf | Bin 31821 -> 31821 bytes .../doc/latex/glossaries/samples/sample-index.pdf | Bin 43388 -> 43388 bytes .../doc/latex/glossaries/samples/sample-inline.pdf | Bin 146967 -> 146899 bytes .../latex/glossaries/samples/sample-langdict.pdf | Bin 38866 -> 38866 bytes .../latex/glossaries/samples/sample-newkeys.pdf | Bin 39209 -> 39209 bytes .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 96013 -> 96013 bytes .../latex/glossaries/samples/sample-noidxapp.pdf | Bin 67092 -> 67092 bytes .../glossaries/samples/sample-nomathhyper.pdf | Bin 41759 -> 41759 bytes .../latex/glossaries/samples/sample-numberlist.pdf | Bin 41990 -> 41990 bytes .../doc/latex/glossaries/samples/sample-prefix.pdf | Bin 43273 -> 43273 bytes .../doc/latex/glossaries/samples/sample-si.pdf | Bin 21722 -> 21722 bytes .../samples/sample-storage-abbr-desc.pdf | Bin 39905 -> 39905 bytes .../glossaries/samples/sample-storage-abbr.pdf | Bin 37671 -> 37671 bytes .../doc/latex/glossaries/samples/sample.pdf | Bin 102643 -> 102575 bytes .../doc/latex/glossaries/samples/sample4col.pdf | Bin 43333 -> 43333 bytes .../doc/latex/glossaries/samples/sampleAcr.pdf | Bin 65517 -> 65517 bytes .../doc/latex/glossaries/samples/sampleAcrDesc.pdf | Bin 65625 -> 65625 bytes .../latex/glossaries/samples/sampleCustomAcr.pdf | Bin 93623 -> 93623 bytes .../doc/latex/glossaries/samples/sampleDB.pdf | Bin 47055 -> 47055 bytes .../doc/latex/glossaries/samples/sampleDesc.pdf | Bin 48407 -> 48407 bytes .../doc/latex/glossaries/samples/sampleEq.pdf | Bin 155612 -> 155767 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169071 -> 169231 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91355 -> 91355 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98595 -> 98514 bytes .../doc/latex/glossaries/samples/samplePeople.pdf | Bin 47470 -> 47470 bytes .../doc/latex/glossaries/samples/sampleSec.pdf | Bin 65680 -> 65680 bytes .../doc/latex/glossaries/samples/sampleSort.pdf | Bin 94975 -> 94902 bytes .../doc/latex/glossaries/samples/sampleaccsupp.pdf | Bin 41167 -> 41167 bytes .../latex/glossaries/samples/sampleacronyms.pdf | Bin 37213 -> 37213 bytes .../doc/latex/glossaries/samples/sampletree.pdf | Bin 66925 -> 66925 bytes .../doc/latex/glossaries/samples/sampleutf8.pdf | Bin 44951 -> 44951 bytes .../doc/latex/glossaries/samples/samplexdy.pdf | Bin 133661 -> 133641 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 68412 -> 68412 bytes .../doc/latex/glossaries/samples/samplexdy3.pdf | Bin 178704 -> 178683 bytes .../doc/latex/glossaries/samples/samplexdy3.tex | 153 +- .../texmf-dist/doc/man/man1/makeglossaries-lite.1 | 2 +- .../doc/man/man1/makeglossaries-lite.man1.pdf | Bin 23998 -> 23855 bytes Master/texmf-dist/doc/man/man1/makeglossaries.1 | 2 +- .../doc/man/man1/makeglossaries.man1.pdf | Bin 24792 -> 24650 bytes .../texmf-dist/scripts/glossaries/makeglossaries | 6 +- .../scripts/glossaries/makeglossaries-lite.lua | 4 +- .../source/latex/glossaries/glossaries.dtx | 259 +- .../source/latex/glossaries/glossaries.ins | 2 +- .../tex/latex/glossaries/base/glossaries-babel.sty | 2 +- .../glossaries/base/glossaries-compatible-207.sty | 2 +- .../glossaries/base/glossaries-compatible-307.sty | 2 +- .../glossaries/base/glossaries-polyglossia.sty | 2 +- .../latex/glossaries/base/glossaries-prefix.sty | 2 +- .../tex/latex/glossaries/base/glossaries.sty | 10 +- .../latex/glossaries/expl/glossaries-accsupp.sty | 2 +- .../latex/glossaries/styles/glossary-hypernav.sty | 2 +- .../latex/glossaries/styles/glossary-inline.sty | 2 +- .../tex/latex/glossaries/styles/glossary-list.sty | 2 +- .../tex/latex/glossaries/styles/glossary-long.sty | 2 +- .../glossaries/styles/glossary-longbooktabs.sty | 2 +- .../glossaries/styles/glossary-longragged.sty | 2 +- .../tex/latex/glossaries/styles/glossary-mcols.sty | 2 +- .../tex/latex/glossaries/styles/glossary-super.sty | 2 +- .../glossaries/styles/glossary-superragged.sty | 2 +- .../tex/latex/glossaries/styles/glossary-tree.sty | 2 +- Master/tlpkg/libexec/ctan2tds | 1 + 90 files changed, 5673 insertions(+), 5419 deletions(-) diff --git a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries index 218dfc921a5..081265d32e3 100755 --- a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries +++ b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 4.39 +# Version : 4.40 # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -31,9 +31,11 @@ # glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl. # Also makeglossaries and makeglossaries-lite.lua. -my $version="4.39 (2018-05-23)"; +my $version="4.40 (2018-06-01)"; # History: +# v4.40: +# * No change. # v4.39: # * No change. # v4.38: diff --git a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua index 77da25667b3..aff87e481e1 100755 --- a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua +++ b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua @@ -36,6 +36,8 @@ Also makeglossaries and makeglossaries-lite.lua. History: + * 4.40: + - no change. * 4.39: - corrected script name in version and help messages * 4.38: @@ -60,7 +62,7 @@ - changed first line from lua to texlua --]] -thisversion = "4.39 (2018-05-23)" +thisversion = "4.40 (2018-06-01)" quiet = false dryrun = false diff --git a/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl b/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl index d92a26f784b..a8148833412 100755 --- a/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl +++ b/Build/source/texk/texlive/linked_scripts/texlive/tlmgr.pl @@ -1,12 +1,12 @@ #!/usr/bin/env perl -# $Id: tlmgr.pl 47833 2018-05-25 02:27:29Z preining $ +# $Id: tlmgr.pl 47874 2018-05-30 01:33:07Z preining $ # # Copyright 2008-2018 Norbert Preining # This file is licensed under the GNU General Public License version 2 # or any later version. -my $svnrev = '$Revision: 47833 $'; -my $datrev = '$Date: 2018-05-25 04:27:29 +0200 (Fri, 25 May 2018) $'; +my $svnrev = '$Revision: 47874 $'; +my $datrev = '$Date: 2018-05-30 03:33:07 +0200 (Wed, 30 May 2018) $'; my $tlmgrrevision; my $tlmgrversion; my $prg; @@ -7471,6 +7471,8 @@ L action). For backward compatibility and convenience, C<--location> and C<--repo> are accepted as aliases for this option. +See L for details on the supported schemata. + =item B<--gui> [I] C has a graphical interface as well as the command line @@ -8957,8 +8959,9 @@ above) to succeed, and a working GnuPG (C) program (see below for search method). Then, unless cryptographic verification has been disabled, a signature file (C) of the checksum file is downloaded and the signature verified. The signature is created by -the TeX Live Distribution GPG key 0x06BAB6BC, which in turn is signed by -Karl Berry's key 0x30D155AD and Norbert Preining's key 0x6CACA448. All +the TeX Live Distribution GPG key 0x0D5E5D9106BAB6BC, which in turn is +signed by Karl Berry's key 0x0716748A30D155AD and +Norbert Preining's key 0x6CACA448860CDC13. All of these keys are obtainable from the standard key servers. Additional trusted keys can be added using the C action. @@ -9531,13 +9534,131 @@ If a value is not saved in the database the string C<(not set)> is shown. If you are developing a program that uses this output, and find that changes would be helpful, do not hesitate to write the mailing list. +=head1 SUPPORTED URL SCHEMATA + +The following URL schemata are supported + +=over 4 + +=item C + +Standard schema, is supported without any restrictions. If the (default) +LWP method is used, this schema supports persistent connections. + +=item C + +If the (default) LWP method is used, this schema supports persistent connections. + +=item C + +If the (default) LWP method is used, this schema supports persistent connections. +Some versions of C do not support this schema. Furthermore, even if +C supports https, it might check the certificate. C generally +supports https. + +=item C + +=item C + +=item C + +These schemata use C to transfer files. The use of an C +is highly recommended. + +=back + + +=head1 ENVIRONMENT VARIABLES + +For ease in scripting and debugging, C will look for the +following environment variables. They are not of interest for normal +user installations. + +=over 4 + +=item C + +This option allows selecting a different compressor program for +backups and intermediate rollback containers. The order of selection is: + +=over 8 + +=item 1. + +If the environment variable C is +defined, use it; abort if it doesn't work. Possible values: +C, C, C. + + +=item 2. + +If lz4 is available (either from the system or TL) and working, use that. + +=item 3. + +If gzip is available (from the system) and working, use that. + +=item 4. + +If xz is available (either from the system or TL) and working, use that. + +=back + +lz4 and gzip are much faster in creating tlmgr's local backups. +The unconditional use of xz for the tlnet containers is unaffected, +to minimize download sizes. + +=item C + +=item C + +=item C + +These options allow selecting different download programs then the ones +automatically selected by the installer. The order of selection is: + +=over 8 + +=item 1. + +If the environment variable C is +defined, use it; abort if the specified program doesn't work. +Possible values: C, C. + +=item 2. + +If the environment variable C is +defined (can be any value), use it together with +C; abort if it doesn't work. + +=item 3. + +If LWP is available and working, use that (by far the most +efficient method, as it supports persistent downloads). + +=item 4. + +If curl is available (from the system) and working, use that. + +=item 5. + +If wget is available (either from the system or TL) and working, use that. + +=back + +TL still provides C binaries for some platforms, so +some download method should always be available. + +=back + + =head1 AUTHORS AND COPYRIGHT This script and its documentation were written for the TeX Live distribution (L) and both are licensed under the GNU General Public License Version 2 or later. -$Id: tlmgr.pl 47833 2018-05-25 02:27:29Z preining $ +$Id: tlmgr.pl 47874 2018-05-30 01:33:07Z preining $ =cut # to remake HTML version: pod2html --cachedir=/tmp tlmgr.pl >/tmp/tlmgr.html diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index edca389b78d..ed66d6c5567 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,10 @@ glossaries change log: +v4.40 (2018-06-01): + + * bug fix: corrected page number reference when + using \makenoidxglossaries + v4.39 (2018-05-23): * makeglossaries-lite.lua: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 4d270c7eb38..82fe355e35d 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.39 +LaTeX Package : glossaries v4.40 -Last Modified : 2018-05-23 +Last Modified : 2018-06-01 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 95f55921d80..7ef85f9c259 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 98de2e04daa..2423f1d9d3a 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.39 +class="cmr-17">User Manual for glossaries.sty v4.40

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

2018-05-23

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

@@ -421,7 +421,20 @@ class="E">EX distribution? or (for Linux users) Updating TEX on Linux. -

Documents have wide-ranging styles when it comes to presenting glossaries or lists of +

Note that occasionally you may find that certain packages need to be loaded after +packages that are required by glossaries. For example, a package ⟨X⟩ might need to be loaded +after amsgen. In which case, load the required package first (for example, amsgen), then ⟨X⟩, +and finally load glossaries. +

Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and to a large extent this is determined by the kind of information that needs to go in the glossary. They may just have symbols with terse descriptions or they may have long technical @@ -429,15 +442,15 @@ words with complicated descriptions. The glossaries package is flexible enough to accommodate such varied requirements, but this flexibility comes at a price: a big manual. -

😱 If you’re freaking out at the size of this manual, start with

😱 If you’re freaking out at the size of this manual, start with glossariesbegin.pdf (“The glossaries package: a guide for beginnners”). You should find it in the same directory as this document or try texdoc glossariesbegin.pdf. Once you’ve got to grips with the basics, then come back to this manual to find out how to adjust the settings.

-

-

The

+

The glossaries bundle comes with the following documentation:

glossary2glossaries.pdf
If you are moving over from the obsolete glossary package, + id="dx1-17"> package, read “Upgrading from the glossary package to the glossaries package”.
@@ -460,6 +473,8 @@ href="glossary2glossaries.html" >“Upgrading from the glossary package to t class="cmbx-10">glossaries-user.pdf
This document is the main user guide for the glossaries package. + +
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.39”. - - + Code for glossaries v4.40”.
INSTALL
Change log. class="cmbx-10">README
Package summary.
-

Related resources:

+

Related resources:

  • glossaries-extra and bib2gls: An Introductory Guide. (: An Introductory Guide. (bib2gls-begin.pdf).
    • @@ -526,37 +539,39 @@ class="cmss-10">glossaries-extra package
  • bib2gls
-

If you use

If you use hyperref and and glossaries, you must load hyperref first. Similarly the doc package + id="dx1-21"> package must also be loaded before glossaries. (If doc is loaded, the file extensions for the default main + id="dx1-22"> is loaded, the file extensions for the default main glossary are changed to gls2, , glo2 and and .glg2 to avoid conflict with to avoid conflict with doc’s changes + id="dx1-26">’s changes glossary.) -

If you are using

If you are using hyperref, it’s best to use , it’s best to use pdflatex rather than rather than latex (DVI format) as + id="dx1-29"> (DVI format) as pdflatex deals with hyperlinks much better. If you use the DVI format, you will encounter problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is @@ -569,9 +584,7 @@ class="cmss-10">glossaries-extra with the class="cmtt-10">hyperoutside and textformat attributes set to appropriate values for problematic entries.

- - -

+

@@ -1170,7 +1183,7 @@ class="cmtt-10">o. Depending on the font, the backslash character may appear as a dash when used in the main document text, so \foo will appear as: —foo. -

Earlier versions of

Earlier versions of glossaries used this technique to write information to the files used by the indexing applications to prevent problems caused by fragile commands. Now, this is only used for the indexing application with multilingual support writt class="newline" /> -

1.

1. Introduction

-

The

The glossaries package is provided to assist generating lists of terms, symbols or abbreviations. (For convenience, these lists are all referred to as glossaries in this manual.) The package has a certain amount of flexibility, allowing the user to customize @@ -1223,7 +1236,7 @@ indexed1.1 in the document will be added to the glossary. -

The

The glossaries-extra package, which is distributed as a separated bundle, extends the capabilities of the glossaries package. The simplest document can be created with @@ -1261,8 +1274,8 @@ class="cmss-10">glossaries package):  
\printunsrtglossaries % list all defined entries  
\end{document}

-

-

+

The glossaries package replaces the package which is now obsolete. Please see the document “Upgrading from the glossary package to the glossaries package” for assistance in upgrading. -

One of the strengths of this package is its flexibility, however the drawback of this is the +

One of the strengths of this package is its flexibility, however the drawback of this is the necessity of having a large manual that covers all the various settings. If you are daunted by the size of the manual, try starting off with the much shorter guide for beginners. -

There’s a common misconception that you have to have Perl installed in order to use +

There’s a common misconception that you have to have Perl installed in order to use the glossaries package. Perl is not a requirement but it does increase the available @@ -1287,8 +1300,8 @@ href="#glo:nonlatinalph">non-Latin alphabet.
-

-

This document uses the

+

This document uses the glossaries package. For example, when viewing the PDF version of this document in a hyperlinked-enabled PDF viewer (such as Adobe Reader or Okular) if you click on the word “arara to run them. -

The remainder of this introductory section covers the following:

+

The remainder of this introductory section covers the following:

-

Top

1.1 Indexing Options

-

The basic idea behind the

The basic idea behind the glossaries package is that you first define your entries (terms, symbols or abbreviations). Then you can reference these within your document (like \cite or @@ -1359,7 +1372,7 @@ href="#glo:glossaries-extra">glossaries-extra. An overview of these options is given in table 1.1. -

If you are developing a class or package that loads

If you are developing a class or package that loads glossaries, I recommend that you don’t force the user into a particular indexing method by adding an unconditional \makeglossaries (such as \newglossary) and they can’t switch off the indexing whilst working on a draft document. -

For a comparison of the various methods when used with large entry sets or when used +

For a comparison of the various methods when used with large entry sets or when used with symbols such as \alpha, see the glossaries performance page.

-

@@ -1400,7 +1413,7 @@ id="TBL-2-4" />

OptionOption 5

Requires ✔

Requires an @@ -1461,7 +1474,7 @@ class="td10"> ✘

Requires Perl?

✘

Requires Java?

✘

Can sort @@ -1524,7 +1537,7 @@ class="pzdr-">✔ N/A

Efficient sort @@ -1541,7 +1554,7 @@ class="pzdr-">✔ N/A

Can use @@ -1572,7 +1585,7 @@ class="pzdr-">✔ N/A

Any problematic @@ -1593,7 +1606,7 @@ class="pzdr-">✘‡

Are entries @@ -1628,7 +1641,7 @@ class="td10"> ✔

Can automatically @@ -1656,7 +1669,7 @@ class="td10"> ✘

Can have @@ -1686,7 +1699,7 @@ class="pzdr-">✔

Maximum hierarchical @@ -1706,7 +1719,7 @@ class="td10"> ∞

\glsdisplaynumberlist ✘

\newglossaryentry ✔⁑

Requires additional @@ -1774,7 +1787,7 @@ class="pzdr-">✘⋆

Default value @@ -1802,8 +1815,8 @@ class="pzdr-x-x-90">✾

-

________________________________________________________________________ -

________________________________________________________________________ +

* Strips standard Lexample, \AA is treated the same as A. -

† Only with the hybrid method provided with glossaries-extra. -

‡ Provided sort=none is used. -

§ Entries with the same sort value are merged. -

♢ Requires some setting up. -

The locations must be set explicitly through the custom locationlocationfield provided by glossaries-extra. -

# Unlimited but unreliable. -

※ Entries are defined in .bib format. \newglossaryentry should not be used explicitly. -

⁑

⁑ Provided docdefs=true or docdefs=restricted but not recommended. -

⋆ Provided docdefs=false or docdefs=restricted. -

✾ Irrelevant with sort=noneoption automatically switches this on.) id="x1-60001">Option 1 (TEX)

-

This option doesn’t require an external

This option doesn’t require an external indexing application but, with the default alphabetic sorting, it’s very slow with severe limitations. If you want a sorted list, it doesn’t work well for  sort={alpha},description={...}}

-

-

This option works best with the

+

This option works best with the sort=def or sort=usenumber listindexing application consider using Option 5 instead. -

+

  1. Add @@ -1962,7 +1975,7 @@ href="#option5">Option 5 instead.
    \makenoidxglossaries
    -

    to your preamble (before you start defining your entries, as described in

    to your preamble (before you start defining your entries, as described in §4 Defining @@ -1975,7 +1988,7 @@ href="#sec:newglosentry">Defining

    -

    where you want your list of entries to appear (described in

    where you want your list of entries to appear (described in §10 Displaying a glossary). @@ -1986,7 +1999,7 @@ href="#sec:printglossary">Displaying a glossary

    +

  2. Run LATEX twice on your document. (As you would d appear.) For example, click twice on the “typeset” or “build” or “PDFLATEX” button in your editor.
-

Complete example: +

Complete example:

@@ -2009,16 +2022,16 @@ class="E">EX” button  
\printnoidxglossary  
\end{document}
-

+

-

+

Option 2 (makeindex)

-

This option uses a 

This option uses a CLI application called makeindexmakeindex\printglossary reads this file in on the next run. -

This option works best if you want to sort entries according to the English alphabet and +

This option works best if you want to sort entries according to the English alphabet and you don’t want to install Perl (or Java or you don’t want to use glossaries-extra). This method @@ -2055,7 +2068,7 @@ application. (So you should be able to use the automake package option provided the shell escape hasn’t been completely disabled.) -

This method can form ranges in the

This method can form ranges in the number list but only accepts limited number formats: \roman, \Roman, \alph and \Alph. -

This option does not allow a mixture of sort methods. All glossaries must be sorted +

This option does not allow a mixture of sort methods. All glossaries must be sorted according to the same method: word/letter ordering or order of use or order of definition. If you need word ordering for one glossary and letter ordering for another you’ll have to explicitly call Option 1. See the glossaries-extra documentation for further details.) -

+

  1. If you want to use \GlsSetQuote \GlsSetQuote{+}
-

This must be used before

This must be used before \makeglossaries. Note that if you are using babel, the @@ -2115,7 +2128,7 @@ class="cmss-10">babel \makeglossaries

-

to your preamble (before you start defining your entries, as described in

to your preamble (before you start defining your entries, as described in §4 Defining @@ -2128,7 +2141,7 @@ href="#sec:newglosentry">Defining

-

where you want your list of entries to appear (described in

where you want your list of entries to appear (described in §10 Displaying a glossary). @@ -2139,7 +2152,7 @@ href="#sec:printglossary">Displaying a glossary

+

  • Run LAT.gls. If you have access to a
    makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
    -

    (Replace

    (Replace myDoc with the base name of your LATEX document file. Avoid spaces in the file name if possible.) If you don’t know how to use the command prompt, @@ -2207,7 +2220,7 @@ class="cmtt-10"> pdflatex class="cmtt-10">makeglossaries with makeglossaries-lite if you don’t have Perl installed.) -

    The default sort is word order (“sea lion” comes before “seal”). If you want letter +

    The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the -l switch: @@ -2217,7 +2230,7 @@ class="cmtt-10">-l makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo -

    (See

    (See §1.5.4 Using glossaries-extra -

    Complete example: +

    Complete example:

    @@ -2267,16 +2280,16 @@ class="cmss-10">glossaries-extra    \printglossary  
    \end{document} -

    +

    -

    +

    Option 3 (xindy)

    -

    This option uses a 

    This option uses a CLI application called xindymakeindex and is able to sort extended Latin alphabets or non-Latin alphabets, however it does still have some limitations. -

    The

    The xindy application comes with both Txindy\printglossary reads this file in on the next run. -

    This is the best option with just the base

    This is the best option with just the base glossaries package if you want to sort according to a language other than English or if you want non-standard location lists, but it can require some setting up (see {} from the sort value, which is usually de value to collapse to an empty string which xindy forbids.

    • -

    In these problematic cases, you must set the

    In these problematic cases, you must set the sort field explicitly. For example: @@ -2346,8 +2359,8 @@ class="cmss-10">sort sort={alpha},description={...}} -

    -

    All glossaries must be sorted according to the same method (word/letter ordering, order +

    +

    All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of definition). (The glossaries-extra package allows a hybrid mix @@ -2360,7 +2373,7 @@ href="#option1">Option 1. See the glossaries-extra documentation for further details.) -

    +

    1. Add the glossaries package option list:
      \usepackage[xindy]{glossaries}
      -

      If you are using a non-Latin script you’ll also need to either switch off the creation of +

      If you are using a non-Latin script you’ll also need to either switch off the creation of the number group: @@ -2380,7 +2393,7 @@ class="cmss-10">glossaries package option list:

      \usepackage[xindy={glsnumbers=false}]{glossaries}
      -

      or use either

      or use either \GlsSetXdyFirstLetterAfterDigits{⟨letter⟩} or .gls. You also need to set the language name xindy -L english -C utf8 -I xindy -M myDoc  
      -t myDoc.glg -o myDoc.gls myDoc.glo -

      (Replace

      (Replace myDoc with the base name of your LATEX document file. Avoid spaces in the file name. If necessary, also replace makeglossaries makeglossaries myDoc -

      (Remember that

      (Remember that xindy is a Perl script so if you can use makeglossariesxindy either.) -

      If you don’t know how to use the command prompt, then you can probably +

      If you don’t know how to use the command prompt, then you can probably access xindy arara: pdflatex -

      The default sort is word order (“sea lion” comes before “seal”). If you want letter +

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the order=letter package option: @@ -2516,7 +2529,7 @@ class="cmss-10">order=letter \usepackage[xindy,order=letter]{glossaries} -

      (and return to the previous step). This option is picked up by

      (and return to the previous step). This option is picked up by makeglossaries. If you @@ -2543,7 +2556,7 @@ class="E">EX on your document again. As with the pre repeat the process to ensure the table of contents and cross-references are resolved.

    -

    Complete example: +

    Complete example:

    @@ -2558,16 +2571,16 @@ class="E">EX on your document again. As with the pre  
    \printglossary  
    \end{document} -

    +

    -

    +

    Option 4 (bib2gls)

    -

    This option is only available with the extension package

    This option is only available with the extension package glossaries-extra. This method uses bib2gls to both fetch entry definitions from .bib files and to hierarchically sort and collate. -

    All entries must be provided in one or more

    All entries must be provided in one or more .bib files. (See the bib2gls \usepackage[record]{glossaries-extra} -

    or (equivalently) +

    or (equivalently)

    \usepackage[record=only]{glossaries-extra}
    -

    (It’s possible to use a hybrid of this method and Options 

    (It’s possible to use a hybrid of this method and Options 2 or 3 with record=alsoindex but in general there is little need for this and it complicates the build process.) -

    Each resource set is loaded with

    Each resource set is loaded with \GlsXtrLoadResources[⟨options⟩]. For example: @@ -2618,22 +2631,22 @@ class="cmtt-10">]. For example:  
     sort={de-CH-1996}% sort according to this locale  
    ] -

    You can have multiple resource commands. -

    The glossary is displayed using +

    You can have multiple resource commands. +

    The glossary is displayed using

    \printunsrtglossary
    -

    Alternatively all glossaries can be displayed using the iterative command: +

    Alternatively all glossaries can be displayed using the iterative command:

    \printunsrtglossaries
    -

    The document is build using: +

    The document is build using:

    @@ -2642,7 +2655,7 @@ pdflatex myDoc  
    bib2gls myDoc  
    pdflatex myDoc -

    If letter groups are required, you need the

    If letter groups are required, you need the --group switch: @@ -2650,7 +2663,7 @@ class="cmtt-10">--group switch:

    bib2gls --group myDoc
    -

    Unlike Options 

    Unlike Options 2 and 3, this method doesn’t create a file containing the typeset glossary but simply determines which entries are needed for the document, their associated locations and @@ -2658,7 +2671,7 @@ simply determines which entries are needed for the document, their associated lo (For example, sorting by word order for one glossary and order of use for another or even sorting one block of the glossary differently to another block in the same glossary.) -

    This method supports Unicode and (with at least Java 8) uses the Common +

    This method supports Unicode and (with at least Java 8) uses the Common Locale Data Repository, which provides more extensive language support than bib2gls can deduce a numerical value it will attempt to form ranges otherwise it will simply list the locations. -

    Complete example: +

    Complete example:

    @@ -2686,7 +2699,7 @@ will attempt to form ranges otherwise it will simply list the locations.  
    \printunsrtglossary  
    \end{document} -

    where

    where entries.bib contains @@ -2697,18 +2710,18 @@ class="cmtt-10">entries.bib contains  
     description={an example}  
    } -

    See the

    See the bib2gls user manual for further details. -

    +

    Option 5 (no sorting)

    -

    This option is only available with the extension package

    This option is only available with the extension package glossaries-extra. No indexing @@ -2721,28 +2734,28 @@ class="cmss-10">sort=none \usepackage[sort=none]{glossaries-extra} -

    There’s no “activation” command (such as

    There’s no “activation” command (such as \makeglossaries for Options 2 and 3). -

    All entries must be defined before the glossary is displayed (preferably in the preamble) in +

    All entries must be defined before the glossary is displayed (preferably in the preamble) in the required order, and child entries must be defined immediately after their parent entry if they must be kept together in the glossary -

    The glossary is displayed using +

    The glossary is displayed using

    \printunsrtglossary
    -

    Alternatively all glossaries can be displayed using the iterative command: +

    Alternatively all glossaries can be displayed using the iterative command:

    \printunsrtglossaries
    -

    This will display

    This will display all defined entries, regardless of whether or not they have been used in the document. The number listbib2gls takes advantage of this method by defining the wanted entries in the required order and setting the locations (and letter group information, if required). -

    This just requires a single LAT

    This just requires a single LATEX call @@ -2763,7 +2776,7 @@ class="E">EX call

    pdflatex myDoc
    -

    unless the glossary needs to appear in the table of contents, in which case a second run is +

    unless the glossary needs to appear in the table of contents, in which case a second run is required. @@ -2772,9 +2785,9 @@ required. pdflatex myDoc  
    pdflatex myDoc -

    (Naturally if the document also contains citations, and so on, then additional steps are +

    (Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all the other options above.) -

    Complete example: +

    Complete example:

    @@ -2788,15 +2801,15 @@ required. Similarly for all the other options above.)  
    \printunsrtglossary  
    \end{document} -

    See the

    See the glossaries-extra documentation for further details. -

    +

    -

    Top

    1.2 Sample Documents

    -

    The

    The glossaries package is provided with some sample documents that illustrate the various functions. These should be located in the samples subdirectory (folder) @@ -2810,16 +2823,16 @@ href="http://www.dickimaw-books.com/latex/novices/html/terminal.html" >terminal
    texdoc -l glossaries     -

    +

    This should display a list of all the files in the glossaries documentation directory with their full pathnames. (The GUI version of texdoc may also provide you with the information.) -

    If you can’t find the sample files on your computer, they are also available from your nearest +

    If you can’t find the sample files on your computer, they are also available from your nearest CTAN mirror at http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/. -

    The sample documents are listed +

    The sample documents are listed below1.3 If @@ -2849,7 +2862,7 @@ class="E">EX either by typing latex minimalgls -

    +

    in a terminal or by using the relevant button or menu item in your text editor or front-end. This will create the required associated files but you will not see the glossary. If you use PDFLATEX you will also get warnings about non-ex  
    referenced but does not exist,  
    replaced by a fixed one -

    These warnings may be ignored on the first run. -

    If you get a

    These warnings may be ignored on the first run. +

    If you get a Missing \begin{document} error, then it’s most likely that your version of Generating
    makeglossaries minimalgls     -

    +

    otherwise do
    makeglossaries-lite minimalgls     -

    +

    If for some reason you want to call makeindexmakeindexmakeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo -

    +

    (See §1.5.4 makeindexmakeindex explicitly.) -

    Note that if the file name contains spaces, you will need to use the double-quote +

    Note that if the file name contains spaces, you will need to use the double-quote character to delimit the name.

  • Run minimalgls.tex through LATEX again (as step 1)
    • -

    You should now have a complete document. The number following each entry in the +

    You should now have a complete document. The number following each entry in the glossary is the location number. By default, this is the page number where the entry was referenced. -

    There are three other files that can be used as a

    There are three other files that can be used as a minimal working example: mwe-gls.tex, latex sample-noidxapp
    latex sample-noidxapp -

    +

    sample-noidxapp-utf8.tex
    inputenclatex sample-noidxapp-utf8
    latex sample-noidxapp-utf8 -

    +

    sample4col.tex
    latex sample4col class="cmtt-10">makeglossaries sample4col
    latex sample4col -

    +

    or
    latex sample4col @@ -2978,7 +2991,7 @@ class="cmtt-10">latex sample4col     class="cmtt-10">makeglossaries-lite sample4col
    latex sample4col -

    +

    The vertical gap between entries is the gap created at the start of each group. This can be suppressed using the nogroupskipmakeglossaries sampleAcr class="cmtt-10">latex sampleAcr
    latex sampleAcr -

    +

    (or use makeglossaries-litemakeglossaries sampleAcrDesc class="cmtt-10">latex sampleAcrDesc
    latex sampleAcrDesc -

    +

    sampleDesc.tex
    makeglossaries sampleDesc class="cmtt-10">latex sampleDesc
    latex sampleDesc -

    +

    sampleCustomAcr.tex
    makeglossaries sampleCustomAcr class="cmtt-10">latex sampleCustomAcr
    latex sampleCustomAcr -

    +

    sampleFnAcrDesc.tex
    makeglossaries sampleFnAcrDesc class="cmtt-10">latex sampleFnAcrDesc
    latex sampleFnAcrDesc -

    +

    @@ -3098,7 +3111,7 @@ class="cmtt-10">latex sample-FnDesc class="cmtt-10">makeglossaries sample-FnDesc
    latex sample-FnDesc -

    +

    sample-custom-acronym.tex
    latex sample-custom-acronym class="cmtt-10">makeglossaries sample-custom-acronym
    latex sample-custom-acronym -

    +

    sample-crossref.tex
    latex sample-crossref class="cmtt-10">makeglossaries sample-crossref
    latex sample-crossref -

    +

    sample-dot-abbr.tex
    latex sample-dot-abbr class="cmtt-10">makeglossaries sampledot-abbrf
    latex sample-dot-abbr -

    +

    sampleDB.tex
    latex sampleDB class="cmtt-10">makeglossaries sampleDB
    latex sampleDB -

    +

    or
    latex sampleDB @@ -3167,7 +3180,7 @@ class="cmtt-10">latex sampleDB     class="cmtt-10">makeglossaries-lite sampleDB
    latex sampleDB -

    +

    The glossary definitions are stored in the accompanying files database1.tex and -o class="cmtt-10">sampleDB.gls sampleDB.glo -

    +

  • @@ -3235,7 +3248,7 @@ class="cmtt-10">-o class="cmtt-10">sampleDB.not sampleDB.ntn -

    +

    Note that both makeglossarieslatex sampleEq class="cmtt-10">makeglossaries sampleEq
    latex sampleEq -

    +

    • sampleEqPg.tex
    makeglossaries sampleEqPg class="cmtt-10">latex sampleEqPg
    latex sampleEqPg -

    +

    sampleSec.tex
    makeglossaries sampleSec class="cmtt-10">latex sampleSec
    latex sampleSec -

    +

    sampleNtn.tex
    makeglossaries sampleNtn class="cmtt-10">latex sampleNtn
    latex sampleNtn -

    +

    Note that if you want to call makeindex-o class="cmtt-10">sampleNtn.gls sampleNtn.glo -

    +

    @@ -3399,7 +3412,7 @@ class="cmtt-10">-o class="cmtt-10">sampleNtn.not sampleNtn.ntn -

    +

    makeglossaries sample class="cmtt-10">latex sample
    latex sample -

    +

    You can see the difference between word and letter ordering if you substitute order=wordlatex sampletree class="cmtt-10">makeglossaries sampletree
    latex sampletree -

    +

    sample-dual.tex
    latex sample-dual class="cmtt-10">makeglossaries sample-dual
    latex sample-dual -

    +

    sample-langdict.tex
    latex sample-langdict class="cmtt-10">makeglossaries sample-langdict
    latex sample-langdict -

    +

    samplexdy.tex
    samplexdy.xdy, but if you uncomment the  
    \noist  
    \GlsSetXdyLanguage{} -

    it will set the style file to

    it will set the style file to samplexdy-mc.xdy instead. This provides an additional letter group for entries starting with “Mc” or “Mac”. If you use \noistglossaries package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter group. -

    To create the document do: +

    To create the document do:
    latex samplexdy
    makeglossaries samplexdy
    latex samplexdy     -

    +

    If you don’t have Perl installed then you can’t use makeglossaries-o class="cmtt-10">samplexdy.gls samplexdy.glo -

    +

  • if @@ -3655,7 +3668,7 @@ class="cmtt-10">-o class="cmtt-10">samplexdy.gls samplexdy.glo -

    +

    • pdflatex samplexdy2 class="cmtt-10">makeglossaries samplexdy2
    pdflatex samplexdy2 -

    +

    The explicit -o class="cmtt-10">samplexdy2.gls samplexdy2.glo -

    +

    See §11.2 samplexdy.tex but uses the command \Numberstring from the fmtcount package to format the page numbers. This requires at - least version 3.03 of fmtcount to work correctly. + id="dx1-11090"> package to format the page numbers.

    sampleutf8.tex
    This is another example that uses This is another example that uses xindy. Unlike . Unlike makeindex, , xindy can + id="dx1-11094"> can cope with non-Latin characters. This document uses UTF8 encoding. To create the + id="dx1-11095">s. This document uses UTF8 encoding. To create the document do:
    latex sampleutf8 @@ -3757,16 +3767,16 @@ class="cmtt-10">latex sampleutf8     class="cmtt-10">makeglossaries sampleutf8
    latex sampleutf8 -

    +

    The explicit xindy + id="dx1-11096"> + call - call is (no line @@ -3800,10 +3810,10 @@ class="cmtt-10">-o class="cmtt-10">sampleutf8.gls sampleutf8.glo -

    -

    If you remove the

    +

    If you remove the xindy option from option from sampleutf8.tex and do:
    latex sampleutf8 @@ -3811,7 +3821,7 @@ class="cmtt-10">latex sampleutf8     class="cmtt-10">makeglossaries sampleutf8
    latex sampleutf8 -

    +

    or
    latex sampleutf8 @@ -3819,7 +3829,7 @@ class="cmtt-10">latex sampleutf8     class="cmtt-10">makeglossaries-lite sampleutf8
    latex sampleutf8 -

    +

    you will see @@ -3830,13 +3840,13 @@ class="cmtt-10">latex sampleutf8 start with an - - extended + + Latin character + id="dx1-11098"> now appear in @@ -3864,7 +3874,7 @@ href="#glo:exlatinchar">extended makeindex + id="dx1-11099"> (no line breaks): @@ -3885,23 +3895,23 @@ class="cmtt-10">-o class="cmtt-10">sampleutf8.gls sampleutf8.glo -

    +

    sample-index.tex
    This document uses the This document uses the glossaries package to create both a glossary and an index. This requires two makeglossaries (or (or makeglossaries-lite) calls to ensure + id="dx1-11102">) calls to ensure + the document is up to date: - the document is up to date:
    latex sample-index
    latex sample-index class="cmtt-10">makeglossaries sample-index
    latex sample-index     -

    +

    sample-newkeys.tex
    This document illustrates how add custom keys (using This document illustrates how add custom keys (using \glsaddkey).
    sample-storage-abbr.tex
    This document illustrates how add custom storage keys (using + id="x1-11104r30"> This document illustrates how add custom storage keys (using \glsaddstoragekey).
    sample-storage-abbr-desc.tex
    An extension of the previous example where the user + id="x1-11105r31"> An extension of the previous example where the user needs to provide a description.
    sample-chap-hyperfirst.tex
    This document illustrates how to add a custom key using + id="x1-11106r32"> This document illustrates how to add a custom key using \glsaddstoragekey and hook into the \glstext-like mechanism used to sample-font-abbr.tex
    This document illustrates how to different fonts for abbreviations + id="x1-11107r33"> This document illustrates how to different fonts for abbreviations within the style.
    sample-numberlist.tex
    This document illustrates how to reference the This document illustrates how to reference the number list in the + id="dx1-11109"> in the document text. This requires an additional LATEX run:
    makeglossaries sample-numberlist class="cmtt-10">latex sample-numberlist
    latex sample-numberlist -

    +

    samplePeople.tex
    This document illustrates how you can hook into the standard sort + id="x1-11110r35"> This document illustrates how you can hook into the standard sort mechanism to adjust the way the sort key is set. This requires an additional run to ensure the table of contents is up-to-date:
    latex samplePeople
    makeglossaries samplePeople - -
    latex samplePeople + +
    latex samplePeople     -

    +

    sampleSort.tex
    This is another document that illustrates how to hook into the standard + id="x1-11111r36"> This is another document that illustrates how to hook into the standard sort mechanism. An additional run is required to ensure the table of contents is up-to-date:
    makeglossaries sampleSort class="cmtt-10">latex sampleSort
    latex sampleSort -

    +

    sample-nomathhyper.tex
    This document illustrates how to selectively enable and disable + id="x1-11112r37"> This document illustrates how to selectively enable and disable entry hyperlinks in \glsentryfmt. + id="dx1-11113">.
    sample-entryfmt.tex
    This document illustrates how to change the way an entry is + id="x1-11114r38"> This document illustrates how to change the way an entry is displayed in the text.
    sample-prefix.tex
    This document illustrates the use of the This document illustrates the use of the glossaries-prefix package. + id="dx1-11116"> package. An additional run is required to ensure the table of contents is up-to-date:
    makeglossaries sample-prefix class="cmtt-10">latex sample-prefix
    latex sample-prefix     -

    +

    sampleaccsupp.tex
    This document uses the experimental This document uses the experimental glossaries-accsupp package. The + id="dx1-11118"> package. The symbol is set to the replacement text. Note that some PDF viewers don’t use the accessibility support. Information about the glossaries-accsupp package can be found in @@ -4052,7 +4062,7 @@ href="#sec:accsupp">Accessibility Support. sample-ignored.tex
    This document defines an ignored glossary for common terms that + id="x1-11119r41"> This document defines an ignored glossary for common terms that don’t need a definition. @@ -4060,23 +4070,23 @@ class="description">sample-entrycount.tex
    This document uses This document uses \glsenableentrycount and and \cgls (described + id="dx1-11122"> (described in §14.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)) so that acronyms only used once don’t appear in the list of acronyms.
    -

    +

    -

    Top

    1.3 Dummy Entries for Testing

    -

    In addition to the sample files described above,

    In addition to the sample files described above, glossaries also provides some files containing lorum ipsum dummy entries. These are provided for testing purposes and are on TThese entries all have brief descriptions. For example:

    \newglossaryentry{lorem}{name={lorem},description={ipsum}}
    -

    +

    example-glossaries-long.tex
    These entries all have long descriptions. For example:  
    adipiscing vitae, felis. Curabitur dictum gravida  
    mauris.}} -

    +

    example-glossaries-multipar.tex
    symbolsymbol={\ensuremath{\alpha}},  
    description={Quisque ullamcorper placerat ipsum.}} -

    +

    example-glossaries-symbolnames.tex
    namename={\ensuremath{\alpha}},  
    description={Quisque ullamcorper placerat ipsum.}} -

    +

    example-glossaries-images.tex
    These entries are all abbreviations. For example: \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum  
    dolor} -

    +

    example-glossaries-acronym-desc.tex
    description  description={fringilla a, euismod sodales,  
      sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} -

    +

    example-glossaries-acronyms-lang.tex
    user1 {li}{LI}{lorem ipsum} -

    +

    example-glossaries-parent.tex
    name\newglossaryentry{gravida}{parent={sedmattis},  
      name={gravida},description={malesuada}} -

    +

    example-glossaries-childnoname.tex
    name  description={at}} -

    +

    example-glossaries-cite.tex
    EX distributions. One \newglossaryentry{fusce}{name={fusce},  
    description={suscipit cursus sem},user1={article-minimal}} -

    +

    example-glossaries-url.tex
    user1 description={adipiscing auctor est},  
     user1={http://uk.tug.org/}} -

    -

    The sample file

    +

    The sample file glossary-lipsum-examples.tex in the doc/latex/glossaries/samples directory uses all these files. See also http://www.dickimaw-books.com/gallery/#glossaries. The glossaries-extra package provides additional test files. -

    +

    -

    Top

    1.4 Multi-Lingual Support

    -

    As from version 1.17, the

    As from version 1.17, the glossaries package can be used with xindyLatin alphabet and Option 1 can performed limited ASCII comparisons. -

    This means that with Options 

    This means that with Options 3 or 4 you are not restricted to the A, …, Z letter groups. If you want to use \usepackage{babel}  
    \usepackage[xindy]{glossaries} -

    If you want to use

    If you want to use bib2gls, you need to use the recordbib2gls user manual for further details.) -

    Note that although a 

    Note that although a non-Latin character, such as é, looks like a plain character in your \glsnoexpandfields. This issue doesn’t occur with XeLaTeX or LuaLATEX.
    -

    -

    With

    +

    With inputenc, if you use a non-Latin characterdatatool-basemfirstuc user manual. -

    If you are using

    If you are using xindy or -Cxindy manual for further details of this option. -

    As from v4.24, if you are writing in German (for example, using the

    As from v4.24, if you are writing in German (for example, using the ngerman packagemakeindex’s quote character using: -

    \GlsSetQuote  \GlsSetQuote{⟨character⟩}
    -

    +

    Note that ⟨character⟩ may not be one of ? (question mark), \GlsSetQuote{+}

    -

    This must be done before

    This must be done before \makeglossaries and any entry definitions. It’s only applicable for -g switch when invoking makeindex. -

    Be careful of

    Be careful of babel’s shorthands. These aren’t switched on until the start of the document, so any entries defined in the preamble won’t be able to use those shorthands. @@ -4480,8 +4490,8 @@ with code that tries to escape any of those characters that occur in the sort key.
    -

    -

    In general, it’s best not to use

    +

    In general, it’s best not to use babel’s shorthands in entry definitions. For example: @@ -4501,8 +4511,8 @@ class="cmss-10">babel\printglossaries  
    \end{document}

    -

    -

    The

    +

    The ngerman package has the shorthands on in the preamble, so they can be used if makeindex\printglossaries  
    \end{document}

    -

    -

    +

    +

    -

    Top

    1.4.1 Changing the Fixed Names

    -

    The fixed names are produced using the commands listed in

    The fixed names are produced using the commands listed in table 1.2. If you aren’t using a language package such as babeltranslate=babel\usepackage{babel}  
    \usepackage[translate=babel]{glossaries} -

    and then use

    and then use babel’s caption hook mechanism. Note that if you pass the language options directly to babel -

    @@ -4625,22 +4635,22 @@ id="TBL-3-3" />Command Name

    Translator Key Word

    Purpose

    \glossaryname

    Glossary

    Title +class="td10">

    Title of the main @@ -4650,9 +4660,9 @@ class="td10">

    Title class="td01">\acronymname

    Acronyms

    Title +class="td10">

    Title of the list @@ -4671,11 +4681,11 @@ class="cmss-10">acronym\entryname

    Notation (glossaries)

    Header +class="td10">

    Header for first column @@ -4697,11 +4707,11 @@ class="td10">

    Header class="td01">\descriptionname

    Description (glossaries)

    Header +class="td10">

    Header for second column @@ -4723,11 +4733,11 @@ class="td10">

    Header class="td01">\symbolname

    Symbol (glossaries)

    Header +class="td10">

    Header for symbol column @@ -4746,13 +4756,13 @@ class="td10">

    Header class="td01">\pagelistname

    Page List (glossaries)

    Header +class="td10">

    Header for page list @@ -4771,11 +4781,11 @@ class="td10">

    Header class="td01">\glssymbolsgroupname

    Symbols (glossaries)

    Header +class="td10">

    Header for symbols section @@ -4794,11 +4804,11 @@ class="td10">

    Header class="td01">\glsnumbersgroupname

    Numbers (glossaries)

    Header +class="td10">

    Header for numbers section @@ -4819,7 +4829,7 @@ class="td10">

    Header

    -

    As from version 4.12, multilingual support is provided by separate language modules that +

    As from version 4.12, multilingual support is provided by separate language modules that need to be installed in addition to installing the glossaries package. You only need to install the modules for the languages that you require. If the language module has an @@ -4833,7 +4843,7 @@ class="cmss-10">glossaries are now provided by the appropriate language module. For further details about information specific to a given language, please see the documentation for that language module. -

    Examples of use:

    +

    Examples of use:

    -

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not +

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the babel package and the title\printglossary (but not the iterative commands like \printglossaries). -

    Note that the

    Note that the translator dictionaries are loaded at the beginning of the document, so it won’t have any effect if you put translatorbeamer documentation.)
    -

    -

    Your custom dictionary doesn’t have to be just a translation from English to another +

    +

    Your custom dictionary doesn’t have to be just a translation from English to another language. You may prefer to have a dictionary for a particular type of document. For example, suppose your institution’s in-house reports have to have the glossary labelled as “Nomenclature” and the page list should be labelled “Location”, then you can create a file @@ -4924,7 +4934,7 @@ called, say,

    myinstitute-glossaries-dictionary-English.dict
    -

    that contains the following: +

    that contains the following:

    @@ -4933,20 +4943,20 @@ myinstitute-glossaries-dictionary-English.dict  
    \deftranslation{Glossary}{Nomenclature}  
    \deftranslation{Page List (glossaries)}{Location}
    -

    You can now load it using: +

    You can now load it using:

    \usedictionary{myinstitute-glossaries-dictionary}
    -

    (Make sure that

    (Make sure that myinstitute-glossaries-dictionary-English.dict can be found by TEX.) If you want to share your custom dictionary, you can upload it to CTAN. -

    If you are using

    If you are using babel and don’t want to use the translatortranslate=babel    \renewcommand*{\acronymname}{List of Acronyms}%  
    } -

    -

    Note that

    +

    Note that xindy and bib2gls

    Creating a New Language Module
    -

    The

    The glossaries package now uses the tracklang package to determine which language modules @@ -5004,7 +5014,7 @@ need to be loaded. If you want to create a new language module, you should first tracklang documentation. -

    To create a new language module, you need to at least create two files:

    To create a new language module, you need to at least create two files: glossaries-⟨lang⟩.ldf @@ -5020,7 +5030,7 @@ class="cmss-10">translator (for example, English). -

    Here’s an example of

    Here’s an example of glossaries-dictionary-English.dict: @@ -5036,7 +5046,7 @@ class="cmtt-10">glossaries-dictionary-English.dict:  
    \providetranslation{Symbols (glossaries)}{Symbols}  
    \providetranslation{Numbers (glossaries)}{Numbers} -

    You can use this as a template for your dictionary file. Change

    You can use this as a template for your dictionary file. Change English to the translator name @@ -5047,7 +5057,7 @@ class="cmtt-10">.dict) and, for each \providetranslation, change the second argument to the appropriate translation. -

    Here’s an example of

    Here’s an example of glossaries-english.ldf: @@ -5111,7 +5121,7 @@ class="cmtt-10">glossaries-english.ldf:  
    \renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}  
    \renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}} -

    This is a somewhat longer file, but again you can use it as a template. Replace

    This is a somewhat longer file, but again you can use it as a template. Replace English with the translatorlang⟩. Within the definition of \glossariescaptions⟨lang⟩, replace the English text (such as “Glossaries”) with the appropriate translation. -

    Note: the suffixes used to generate the plural forms when the plural hasn’t been specified are given by \glspluralsuffix (for general entries) and \glsacrpluralsuffix for other acronym styles. There’ these commands will be expanded. They may be expanded on definition or they may be expanded on use, depending on the glossaries configuration. -

    Therefore these plural suffix command definitions aren’t included in the caption +

    Therefore these plural suffix command definitions aren’t included in the caption mechanism as that’s typically not switched on until the start of the document. This means longpluralshortplural etc keys to override exceptions.
    -

    -

    If you want to add a regional variation, create a file called

    +

    If you want to add a regional variation, create a file called glossaries-⟨iso lang⟩-⟨   }%  
     }

    -

    -

    If the translations includes

    +

    If the translations includes non-Latin characters, it’s necessary to provide code that’s independent of the input encoding. Remember that while some users may use UTF-8, others may use Latin-1 or any other supported encoding, but while users won’t appreciate you enforcing your preference on them, it’s useful to provide a UTF-8 version for XeLaTeX users. -

    The

    The glossaries-irish.ldf file provides this as follows: @@ -5237,16 +5247,16 @@ class="cmtt-10">glossaries-irish.ldf file provides this as follows:  
      \glossariescaptionsirish  
    } -

    (Again you can use this as a template. Replace

    (Again you can use this as a template. Replace irish with your root language label and Irish with the translator dictionary label.) -

    There are now two extra files:

    There are now two extra files: glossaries-irish-noenc.ldf and glossaries-irish-utf8.ldf. -

    These both define

    These both define \glossariescaptionsirish but the *-noenc.ldf uses LATEX accent @@ -5281,15 +5291,15 @@ commands:  
      }%  
    } -

    whereas the

    whereas the *-utf8.ldf replaces the accent commands with the appropriate UTF-8 characters. -

    +

    -

    Top

    1.5 Generating the Associated Glossary Files

    -

    This section is only applicable if you have chosen Options 

    This section is only applicable if you have chosen Options 2 or 3. You can ignore this section if you have chosen any of the other options. If you want to alphabetically sort your entries @@ -5300,8 +5310,8 @@ class="cmss-10">name contains any LATEX commands.
    -

    -

    If this section seriously confuses you, and you can’t work out how to run external +

    +

    If this section seriously confuses you, and you can’t work out how to run external tools like makeglossariesEX’s shell escape enabled. -

    In order to generate a sorted glossary with compact

    In order to generate a sorted glossary with compact number lists, it is necessary to use an external §11 Xindy (Option 3). -

    This is a multi-stage process, but there are methods of automating document compilation +

    This is a multi-stage process, but there are methods of automating document compilation using applications such as latexmk and  pdflatex
    With latexmk you need to set up the required dependencies.
    -

    -

    The

    +

    The glossaries package comes with the Perl script makeglossarieshttp://www.perl.org/about.html and MiKTeX and Perl scripts (and one Python script). -

    The advantages of using

    The advantages of using makeglossaries:

    -

    As from version 4.16, the

    As from version 4.16, the glossaries package also comes with a Lua script called Option 2 href="#glo:makeindex">makeindex). -

    If things go wrong and you can’t work out why your glossaries aren’t being generated +

    If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use makeglossariesguimakeglossariesmakeglossaries-lite. -

    Whilst I strongly recommended that you use the

    Whilst I strongly recommended that you use the makeglossaries Perl script or @@ -5571,7 +5581,7 @@ class="cmtt-10">xindy. These are listed in table 1.3. -

    If you are choosing not to use

    If you are choosing not to use makeglossaries because you don’t want to install Perl, you will only be able to use epstopdf and latexmk, so it’s well-worth the effort to install Perl.)
    -

    -

    Note that if any of your entries use an entry that is not referenced outside +

    +

    Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an additional makeglossaries1.6\newglossaryentry{orange}{name={orange},  
    description={an orange coloured fruit.}}

    -

    and suppose you have

    and suppose you have \gls{citrusfruit} in your document but don’t reference the orange entry, then the latex myDoc class="cmtt-10">makeglossaries myDoc
    latex myDoc -

    +

    (Note that if you use glossaries-extra, this will be done automatically for you if @@ -5645,7 +5655,7 @@ the indexcrossrefs feature is enabled. See the glossaries-extra user guide for further details.) -

    Likewise, an additional

    Likewise, an additional makeglossaries and LATnumber lists in the glossary may need updating. -

    The examples in this document assume that you are accessing

    The examples in this document assume that you are accessing makeglossaries, All Programs->Accessories menu. -

    Alternatively, your text editor may have the facility to create a function that will call the +

    Alternatively, your text editor may have the facility to create a function that will call the required application. See Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build. -

    If any problems occur, remember to check the transcript files (e.g. 

    If any problems occur, remember to check the transcript files (e.g. .glg or .alg -

    @@ -5793,10 +5803,10 @@ class="cmti-10">code⟩
    -

    Top

    1.5.1 Using the makeglossaries Perl Script

    -

    The

    The makeglossaries script picks up the relevant information from the auxiliary (latex myDoc class="cmtt-10">makeglossaries myDoc
    latex myDoc -

    +

    You may need to explicitly load makeglossaries into Perl:
    perl makeglossaries myDoc     -

    -

    Windows users: T

    +

    Windows users: TEX Live on Windows has its own internal Perl interpreter and provides makeglossaries.exe as a convenient wrapper for the http://tex.stackexchange.com/q/158796/19862 on the TeX.SX site. -

    The

    The makeglossaries script attempts to fork the -q (quiet) switch doesn’t work as well. -

    You can specify in which directory the

    You can specify in which directory the .aux, .glo class="cmtt-10">pdflatex -output-directory myTmpDir myDoc
    makeglossaries -d myTmpDir myDoc -

    +

    Note that makeglossaries assumes by default that -xpath/to/xindy⟩ for xindy. -

    As from

    As from makeglossaries v2.18, if you are using \printglossaries  
    \end{document} -

    If you explicitly use

    If you explicitly use makeindex, this will cause a warning and the location list @@ -5956,7 +5966,7 @@ class="cmtt-10">xindyxindy won’t produce any warning and will simply discard duplicates. -

    The

    The makeglossaries script contains POD (Plain Old Documentation). If you want, you @@ -5969,19 +5979,19 @@ the man path. Alternatively do makeglossaries --help for a list of all options or makeglossaries --version for the version number. -

    When upgrading the

    When upgrading the glossaries package, make sure you also upgrade your version of makeglossaries. The current version is 4.39.
    -

    -

    + id="dx1-17037">. The current version is 4.40.

    +

    +

    -

    Top

    1.5.2 Using the makeglossaries-lite Lua Script

    -

    The Lua alternative to the

    The Lua alternative to the makeglossaries Perl script requires a Lua interpreter, which @@ -6001,17 +6011,17 @@ class="cmtt-10">makeglossaries-d option.) -

    Note that T

    Note that TEX Live on Unix-like systems creates a symbolic link called makeglossaries-lite (without the .lua extension) to the actual makeglossaries-lite.lua script, so you may not need to supply the extension.
    -

    +

    -

    The

    The makeglossaries-lite script can be invoked in the same way as myDoc.tex, then do
    makeglossaries-lite.lua myDoc     -

    +

    or
    makeglossaries-lite myDoc     -

    -

    +

    Some of the options available with makeglossariesmakeglossaries-lite. For a complete list of available options, do
    makeglossaries-lite.lua --help     -

    -

    +

    +

    -

    Top

    1.5.3 Using xindy explicitly (Option 3)

    -

    Xindy comes with THow to use Xindy with MikTeX on TEX on StackExchange. -

    If you want to use

    If you want to use xindy to process the glossary files, you must make sure you have used @@ -6069,7 +6079,7 @@ class="cmss-10">xindy \usepackage[xindy]{glossaries}

    -

    This is required regardless of whether you use

    This is required regardless of whether you use xindy explicitly or whether it’s @@ -6088,7 +6098,7 @@ class="cmtt-10">-I tex. -

    To run

    To run xindy type the following in your terminal (all on one line): @@ -6107,7 +6117,7 @@ class="cmtt-10">.gls ⟨base⟩.glo -

    +

    where ⟨language⟩ is the required language name, ⟨encoding⟩ is the encoding, ⟨style⟩}. You may need to specify the full path name depending on the current working directory. If any of the file names contain spaces, you must delimit them using double-quotes. -

    For example, if your document is called

    For example, if your document is called myDoc.tex and you are using UTF8 encoding in English, then type the following in your terminal:
    xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo     -

    -

    Note that this just creates the main glossary. You need to do the same for each of +

    +

    Note that this just creates the main glossary. You need to do the same for each of the other glossaries (including the list of acronyms if you have used the acronym @@ -6160,12 +6170,12 @@ class="cmss-10">acronymxindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn -

    +

    For additional glossaries, the extensions are those supplied when you created the glossary with \newglossary. -

    Note that if you use

    Note that if you use makeglossaries instead, you can replace all those calls to makeglossaries:
    makeglossaries myDoc     -

    +

    Note also that some commands and package options have no effect if you use xindymakeglossaries. These are listed in table 1.3. -

    +

    -

    Top

    1.5.4 Using makeindex explicitly (Option 2)

    -

    If you want to use

    If you want to use makeindex explicitly, you must make sure that you haven’t used the base⟩.gls ⟨base⟩.glo -

    +

    where ⟨base⟩ is the name of your document without the .tex-lmakeindex manual for further details. -

    For example, if your document is called

    For example, if your document is called myDoc.tex, then type the following at the terminal:
    makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo     -

    +

    Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the acronymacronym
    makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn     -

    +

    For additional glossaries, the extensions are those supplied when you created the glossary with \newglossary. -

    Note that if you use

    Note that if you use makeglossaries instead, you can replace all those calls to makeglossaries:
    makeglossaries myDoc     -

    +

    Note also that some commands and package options have no effect if you use makeindex @@ -6293,12 +6303,12 @@ href="#glo:makeglossaries">makeglossaries. These are listed in table 1.3. -

    +

    -

    Top

    1.5.5 Note to Front-End and Script Developers

    -

    The information needed to determine whether to use

    The information needed to determine whether to use xindy or

    The file extensions used by each defined glossary are given by -

    -

    -

    The

    +

    The indexing application’s style file is specified by -

    \@istfilename  \@istfilename{⟨filename⟩}
    -

    +

    The file extension indicates whether to use makeindex.xdy

    Word or letter ordering is specified by: -

    Word or letter ordering is specified by: +

    \@glsorder  \@glsorder{⟨order⟩}
    -

    +

    where ⟨order⟩ can be either word or letter. -

    If

    If xindy should be used, the language and code page for each glossary is specified by -

    \@xdylanguage label⟩}{⟨code⟩}
    -

    +

    where ⟨label⟩ identifies the glossary, ⟨language⟩ is the root language (e.g. makeindex should be used. -

    If

    If Option 1 has been used, the .aux file will contain -

    \@gls@reference{⟨type⟩}{⟨label⟩}{⟨location⟩}
    -

    +

    for every time an entry has been referenced. If Option 4 has been used, the .aux file will contain one or more instances of -

    \glsxtr@resource{⟨options⟩}{⟨basename⟩}
    -

    +

    -

    -

    +

    Top

    2. Package Options

    -

    This section describes the available

    This section describes the available glossaries package options. You may omit the =true for boolean options. (For example, glossaries-extra package has additional options described in the glossaries-extra manual. -

    Note that ⟨

    Note that ⟨key⟩=⟨value⟩ package options can’t be passed via the document class options. (This includes options where the ⟨value⟩ (such as makeindex) may be passed via the document class options.
    -

    +

    -

    Top

    2.1 General Options

    @@ -6544,14 +6554,14 @@ class="cmss-10">nowarndebug=showtargets option will additionally use -

    \glsshowtarget  \glsshowtarget{⟨target name⟩}
    -

    +

    to show the hypertarget or hyperlink name in the margin when \glsdohypertarget is used by commands like glossaries-extra package provides an additional setti href="#glo:glossaries-extra">glossaries-extra manual for further details. -

    The purpose of the debug mode can be demonstrated with the following example +

    The purpose of the debug mode can be demonstrated with the following example document: @@ -6590,7 +6600,7 @@ class="cmss-10">glossaries-extra manual for further  
    \printglossaries  
    \end{document}

    -

    In this case, only the

    In this case, only the sample1 entry has been indexed, even though \glsadd{sample2} appears in the source code. This is because \makeglossariessample2 entry doesn’t appear in the glossary. -

    This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user +

    This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use glossaries to format the entries (e.g. abbreviation expansion) but not display any lists of terms, abbreviations, symbols etc. Without \glsadd. They must be enabled by default. (It class="cmss-10">see key as that’s a more common problem. See below.) -

    The debug mode, enabled with the

    The debug mode, enabled with the debug option, @@ -6629,16 +6639,16 @@ class="cmss-10">debug \usepackage[debug]{glossaries}

    -

    will write information to the log file when the indexing can’t occur because the +

    will write information to the log file when the indexing can’t occur because the associated file isn’t open. The message is written in the form

    -

    Package glossaries Info: wrglossary(⟨

    Package glossaries Info: wrglossary(⟨type⟩)(⟨text⟩) on input line ⟨line number⟩.

    -

    where ⟨

    where ⟨type⟩ is the glossary label and ⟨text⟩ is the line of text that would’ve been written to the associated file if it had been open. So if any entries haven’t appeared in the glossary @@ -6710,12 +6720,12 @@ href="#sec:newglossary">§12 Defining New Glossaries). -

    If you don’t use the main glossary and you don’t use this option,

    If you don’t use the main glossary and you don’t use this option, makeglossaries will produce a warning.
    -

    +

    @@ -6777,7 +6787,7 @@ href="#glo:sanitize">sanitize description={hash symbol}}
    -

    The sort value (

    The sort value (#) must be sanitized before writing it to the glossary file, otherwise LATEX will try to interpret it as a parameter reference. If, on the other hand, you @@ -6793,13 +6803,13 @@ class="E">EX will try to interpret it as a parameter  
      sort={\mysortvalue},  
      description={an example}}

    -

    and you actually want

    and you actually want \mysortvalue expanded, so that the entry is sorted according to AAA, then use the package option sanitizesort=false. -

    The default for Options 

    The default for Options 2 and 3 is sanitizesort=truesavewrites is set, the glossary information will be stored in token registers until the end of the document when they will be written to the external files. -

    This option can significantly slow document compilation and may cause the indexing to +

    This option can significantly slow document compilation and may cause the indexing to fail. Page numbers in the number list will be incorrect on page boundaries due @@ -6834,12 +6844,12 @@ class="E">EX’s asynchronous output routine. As an alternativ class="cmss-10">scrwfile package (part of the KOMA-Script bundle) and not use this option.
    -

    -

    You can also reduce the number of write registers by using Options 

    +

    You can also reduce the number of write registers by using Options 1 or 4 or by ensuring you define all your glossary entries in the preamble. -

    If you want to use T

    If you want to use TEX’s \write18 mechanism to call \relax before the end of the document to avoid rewriting  
    -t \jobname.glg -o \jobname.gls \jobname}  
    \let\glswritefiles\relax
    -

    -

    +

    +

    In general, this package option is best avoided.

    translator package. Instead load glossaries-babel. -

    I recommend you use

    I recommend you use translate=babel if you have any problems with the translations or with PDF bookmarks, but to maintain backward compatibility, if @@ -6946,10 +6956,10 @@ class="cmss-10">babel has been loaded the default is translate=true.
    -

    +

    -

    If

    If translate is specified without a value, translate=truetranslatortranslate=false is assumed. -

    See

    See §1.4.1 Changing the Fixed Names for further details. @@ -7000,18 +7010,18 @@ class="cmtt-10">\gls  {glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}

    -

    The values must be fully expanded, so

    The values must be fully expanded, so don’t try nohypertypes=\acronymtype. You may also use -

    \GlsDeclareNoHyperList{⟨list⟩}
    -

    +

    instead or additionally. See §6 \glslink\glstext). -

    The

    The hyperfirst setting applies to all glossary types (unless identified by nohypertypes\newignoredglossaryhyper key when referencing an entry (or by using the plus or starred version of the referencing command). -

    It may be that you only want to apply this to just the acronyms (where the first use +

    It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of the acronym) but not for ordinary glossary entries (where the first use is identical to subsequent uses). In this case, you can use hyperfirst=false\glsunsetall to all the regular (non-acronym) glossaries.  
     % at the end of the preamble  
     \glsunsetall[main]

    -

    -

    Alternatively you can redefine the hook -

    +

    Alternatively you can redefine the hook +

    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook
    -

    +

    which is used by the commands that check the first use flag, such as \gls\ifglshaslong }%  
    }

    -

    -

    Note that this hook isn’t used by the commands that don’t check the

    +

    Note that this hook isn’t used by the commands that don’t check the first use flag, such as \glstext\glsadd2.1 (since that’s the purpose of that command). -

    You can customise this by redefining -

    You can customise this by redefining +

    \glswriteentry  label⟩}{⟨wr-code⟩}
    -

    +

    where ⟨label⟩ is the entry’s label and ⟨wr-code⟩ is the code that writes the entry’s @@ -7183,7 +7193,7 @@ class="cmtt-10">\glswriteentry  
      \fi  
    }

    -

    This checks the

    This checks the indexonlyfirst package option (using \ifglsindexonlyfirst) and does @@ -7192,7 +7202,7 @@ class="cmti-10">wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry hasn’t been used. -

    For example, suppose you only want to index the first use for entries in the

    For example, suppose you only want to index the first use for entries in the acronym glossary and not in the main (or any other) glossary: @@ -7206,7 +7216,7 @@ class="cmtt-10">main (or any other) glossary:  
     {#2}%  
    }

    -

    Here I’ve used

    Here I’ve used \ifthenelse to ensure the arguments of \equal are fully expanded before the comparison is made. @@ -7231,9 +7241,9 @@ href="#sec:glsnolink">Using Glossary Terms Without Links.) This is always true if you use Option 1. -

    +

    -

    Top

    2.2 Sectioning, Headings and TOC Options

    @@ -7244,19 +7254,19 @@ class="description">Add the glossaries to the table of contents. Note that an ex class="E">EX run is required with this option. Alternatively, you can switch this function on and off using -

    \glstoctrue  \glstoctrue
    -

    +

    and -

    \glstocfalse  \glstocfalse
    -

    +

    numberlinevalue⟩ option. Its value should be the name of a s
    \usepackage[section=subsection]{glossaries}
    -

    You can omit the value if you want to use sections, i.e.  +

    You can omit the value if you want to use sections, i.e. 

    \usepackage[section]{glossaries}
    -

    is equivalent to +

    is equivalent to

    \usepackage[section=section]{glossaries}
    -

    You can change this value later in the document using -

    You can change this value later in the document using +

    \setglossarysection  \setglossarysection{⟨name⟩}
    -

    +

    where ⟨name⟩ is the sectional unit. -

    The start of each glossary adds information to the page header via -

    The start of each glossary adds information to the page header via +

    \glsglossarymark  \glsglossarymark{⟨glossary title⟩}
    -

    +

    By default this uses \@mkboth2.22.2 \renewcommand{\glsglossarymark}[1]{\markright{#1}}

    -

    or to prevent it from changing the headers: +

    or to prevent it from changing the headers:

    \renewcommand{\glsglossarymark}[1]{}
    -

    If you want

    If you want \glsglossarymark to use \MakeUppercase in the header, use the ucmark option described below. -

    Occasionally you may find that another package defines

    Occasionally you may find that another package defines \cleardoublepage when it is not required. This may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining \glsclearpage:

    \renewcommand*{\glsclearpage}{\clearpage}
    -

    +

    ucmark\MakeTextUppercase2.3. You can test whether this option has been set or not using -

    \ifglsucmark  true part⟩\else ⟨false part⟩\fi
    -

    +

    For example: @@ -7411,7 +7421,7 @@ class="cmtt-10">\fi

     
        \markright{#1}%  
      \fi}
    -

    If

    If memoir has been loaded and ucfirst\section) and is assigned a label (via \label). The label is formed from -

    \glsautoprefix  \glsautoprefix ⟨type⟩
    -

    +

    where ⟨type⟩ is the label identifying that glossary. The default value of glossaries using: \usepackage[section,numberedsection=autolabel]  
      {glossaries}

    -

    then each glossary will appear in a numbered section, and can be referenced using +

    then each glossary will appear in a numbered section, and can be referenced using something like: @@ -7483,7 +7493,7 @@ class="cmss-10">glossaries using: The main glossary is in section~\ref{main} and  
    the list of acronyms is in section~\ref{acronym}.

    -

    If you can’t decide whether to have the acronyms in the main glossary or a +

    If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use \acronymtype which is set to acronym The list of acronyms is in section~\ref{\acronymtype}.

    -

    You can redefine the prefix if the default label clashes with another label in your +

    You can redefine the prefix if the default label clashes with another label in your document. For example: @@ -7509,7 +7519,7 @@ class="cmss-10">acronym \renewcommand*{\glsautoprefix}{glo:} -

    will add

    will add glo: to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows: @@ -7519,7 +7529,7 @@ class="cmtt-10">glo: to the automatically generated label, so you can the The list of acronyms is in  
    section~\ref{glo:\acronymtype}. -

    Or, if you are undecided on a prefix: +

    Or, if you are undecided on a prefix:

    @@ -7527,7 +7537,7 @@ class="cmtt-10">glo: to the automatically generated label, so you can the The list of acronyms is in  
    section~\ref{\glsautoprefix\acronymtype}. -

    +

  • namerefnameref\usepackage[numberedsection=nameref]{glossaries} -

    Now

    Now \nameref{main} will display the (TOC) section title associated with the main glossary. As above, you can redefine \glsautoprefix to provide a prefix for the label.

    • -

    +

    -

    Top

    2.3 Glossary Appearance Options

    @@ -7574,16 +7584,16 @@ class="cmtt-9"> glossaryentry. -

    If you use this option, you can reference the entry number within the document +

    If you use this option, you can reference the entry number within the document using -

    \glsrefentry  \glsrefentry{⟨label⟩}
    -

    +

    where ⟨label⟩ is the label associated with that glossary entry. The labelling systems uses ⟨label⟩, where ⟨label⟩ is the entry’s label and ⟨prefix⟩ is given by -

    \GlsEntryCounterLabelPrefix  \GlsEntryCounterLabelPrefix
    -

    +

    (which defaults to glsentry-). -

    If you use

    If you use \glsrefentry, you must run LATEX twice after creating the glossary files using xindy to ensure the cross-references are up-to-date.
    -

    +

    counterwithinglossaryentry counter will be reset every time ⟨value⟩ is incremented. -

    The

    The glossaryentry counter isn’t automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by counterwithin -

    -

    If you want the counter reset at the start of each glossary, you can redefine +

    +

    If you want the counter reset at the start of each glossary, you can redefine \glossarypreamble to use -

    \glsresetentrycounter  \glsresetentrycounter
    -

    +

    which sets glossaryentry to zero: @@ -7661,7 +7671,7 @@ class="cmss-10">glossaryentry  \glsresetentrycounter  
    }

    -

    or if you are using

    or if you are using \setglossarypreamble, add it to each glossary preamble, as required. For example: @@ -7678,7 +7688,7 @@ class="cmtt-10">\setglossarypreamble  The preamble text here for the main glossary.  
    }

    -

    +

    subentrycounterglossary-superglossary-tree. Alternatively, you can set the style using -

    -

    +

    esclocations
    This is a boolean option. (The default is esclocations=true.) Both , but + \makenoidxglossaries changes it to esclocations=false.) Both makeindex - and and xindy are fussy about the location formats ( + are fussy about the location formats (makeindex more so than more so than xindy) so the - glossaries package tries to ensure that special characters are escaped and allows for the - location to be substituted for a format that’s more acceptable to the indexing - application. This requires a bit of trickery to circumvent the problem posed by TEX’s - asynchronous output routine, which can go wrong and also adds to the complexity of - the document build. -

    If you’re sure that your locations will always expand to an acceptable format (or you’re + id="dx1-25066">) so the glossaries + package tries to ensure that special characters are escaped and allows for the location to + be substituted for a format that’s more acceptable to the indexing application. This + requires a bit of trickery to circumvent the problem posed by TEX’s asynchronous + output routine, which can go wrong and also adds to the complexity of the document + build. +

    If you’re sure that your locations will always expand to an acceptable format (or you’re prepared to post-process the glossary file before passing it to the relevant indexing application) then use esclocations=false to avoid the complex escaping of location - values. + id="dx1-25067"> to avoid the complex escaping of location values. + (See “Writing information to associated files” in the documented code for further + details.)

    nonumberlist
    This option will suppress the associated number lists in the glossaries (see also + id="dx1-25069">s in the glossaries (see also §5 2 or 3 (makeindex or or xindy) then the + id="dx1-25071">) then the locations must still be valid. This package option merely prevents the number list from + id="dx1-25072"> from being displayed, but both makeindex and and xindy still require a location or + id="dx1-25074"> still require a location or cross-reference for each term that’s indexed. Remember that number list includes any + id="dx1-25075"> includes any cross-references, so suppressing the number list will also hide the cross-references (see + id="dx1-25076"> will also hide the cross-references (see below).
    seeautonumberlist
    If you suppress the number lists with s with nonumberlist, described + id="dx1-25079">, described above, this will also suppress any cross-referencing information supplied by the see key in key in \newglossaryentry or or \glssee. If you use . If you use seeautonumberlist, + id="dx1-25083">, the see key will automatically implement key will automatically implement nonumberlist=false for that entry. + id="dx1-25085"> for that entry. (Note this doesn’t affect \glssee.) For further details see Cross-Referencing
    counter
    This is a ⟨key⟩=⟨value⟩ option. (Default is counter=page.) The value should be + id="dx1-25087">.) The value should be the name of the default counter to use in the number lists (see s (see §5 Number lists). + +
    nopostdot
    This is a boolean option. If no value is specified, true is assumed. When set to true, this option suppresses the default post description dot used by some of the predefined styles. The default setting is nopostdot=false. - - + id="dx1-25090">.
    nogroupskip
    This is a boolean option. If no value is specified, true is assumed. When set to true, this option suppresses the default vertical gap between groups used by some of the predefined styles. The default setting is nogroupskip=false. + id="dx1-25092">.
    -

    +

    -

    Top

    2.4 Sorting Options

    @@ -8017,7 +8033,7 @@ class="cmss-10">sort=use if you want to set this sort method for all your glossaries. -

    This is a ⟨

    This is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ may be one of the following:

    @@ -8050,19 +8066,19 @@ class="cmss-10">usesort key in \newglossaryentry is ignored). -

    Both

    Both sort=def and sort=use set the sort key to a six digit number via -

    \glssortnumberfmt  \glssortnumberfmt{⟨number⟩}
    -

    +

    (padded with leading zeros, where necessary). This can be redefined, if required, before the entries are defined (in the case of sort=def2 or 3) or \makenoidxglossaries (Option 1). It + + omits the code used to sanitize or escape the sort value, since it’s not required. This can help to improve the document build speed, especially if there are a large number of entries. This option can’t be used with @@ -8094,9 +8112,7 @@ class="cmss-10">glossaries-extra’s \printunsrtglossary (Option 5). - - -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) are incompatible with the sort=usesort=usesort=def options. -

    The default is

    The default is sort=standard. When the standard sort option is in use, you can hook into the sort mechanism by redefining: -

    \glsprestandardsort  type⟩}{⟨label⟩}
    -

    +

    where ⟨sort cs⟩ is a temporary control sequence that stores the sort value (which was either explicitly set via the xindy special characters is performed. By default \glsprestandardsort just does: -

    \glsdosanitizesort  \glsdosanitizesort
    -

    +

    which sanitizes ⟨sanitizesortsanitizesort=false is used). -

    The other arguments, ⟨

    The other arguments, ⟨type⟩ and ⟨label⟩, are the glossary type and the entry label for the current entry. Note that ⟨label⟩ will be in the form used in the first argument of \newglossaryentry. -

    Redefining

    Redefining \glsprestandardsort won’t affect any entries that have already been defined and will have no effect at all if you are using sort=defsort=defsort=use.
    -

    +

    -

    Example 1 (Mixing Alphabetical and Order of Definition Sorting) -

    Suppose I have three glossaries:

    Suppose I have three glossaries: main, acronym and notation, and let’s suppose I want @@ -8186,7 +8202,7 @@ class="cmtt-10">main and acronym glossaries to be sorted alphabetically, but the notation type should be sorted in order of definition. -

    For

    For Option 1, I just need to set the sort key in the optional argument of @@ -8201,8 +8217,8 @@ class="cmtt-10">\printnoidxglossary\printnoidxglossary[type=acronym,sort=word]  
    \printnoidxglossary[type=notation,sort=def]

    -

    -

    For Options 

    +

    For Options 2 or 3, I can set the sort to standard (which is the default, but can be @@ -8222,7 +8238,7 @@ class="cmti-10">sort cs⟩ if ⟨type⟩ is notation. -

    The first option can be achieved as follows: +

    The first option can be achieved as follows:

    @@ -8233,7 +8249,7 @@ class="cmtt-10">notation    .  
      \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%  
    }
    -

    The second option can be achieved as follows: +

    The second option can be achieved as follows:

    @@ -8250,26 +8266,26 @@ class="cmtt-10">notation    .  
      }%  
    }
    -

    (

    (\ifdefstring is defined by the etoolbox package.) For a complete document, see the sample file sampleSort.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 2 (Customizing Standard Sort (Options 2 or 3)) -

    Suppose you want a glossary of people and you want the names listed as ⟨

    Suppose you want a glossary of people and you want the names listed as ⟨first-name⟩ ⟨surname⟩ in the glossary, but you want the names sorted by ⟨name\name while the sort value is being set. -

    First, define two commands to set the person’s name: +

    First, define two commands to set the person’s name:

    @@ -8295,7 +8311,7 @@ class="cmtt-10">\name while the sort value is being \newcommand{\sortname}[2]{#2, #1}  
    \newcommand{\textname}[2]{#1 #2} -

    and

    and \name needs to be initialised to \textname: @@ -8304,7 +8320,7 @@ class="cmtt-10">\textname:

    \let\name\textname
    -

    Now redefine

    Now redefine \glsprestandardsort so that it temporarily sets \name to \sortname @@ -8325,10 +8341,10 @@ class="cmti-10">surname⟩ in the text:  
     \glsdosanitizesort  
    } -

    (The somewhat complicate use of

    (The somewhat complicate use of \expandafter etc helps to protect fragile commands, but care is still needed.) -

    Now the entries can be defined: +

    Now the entries can be defined:

    @@ -8338,13 +8354,13 @@ class="cmtt-10">\expandafter etc helps to protect fragile commands,  
    \newglossaryentry{johnsmith}{name={\name{John}{Smith}},  
      description={some information about John Smith}} -

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    orderword or letter. The default is word ordering. -

    Note that the

    Note that the order option has no effect if you don’t use makeglossaries.
    -

    -

    If you use

    +

    If you use Option 1, this setting will be used if you use sort\printnoidxglossary \printnoidxglossary[sort=standard]

    -

    Alternatively, you can specify the order for individual glossaries: +

    Alternatively, you can specify the order for individual glossaries:

    @@ -8384,7 +8400,7 @@ class="cmtt-10">\printnoidxglossary    \printnoidxglossary[type=acronym,sort=letter] -

    +

    makeindexxindy.ist extension. -

    You may omit this package option if you are using

    You may omit this package option if you are using Option 2 as this is the default. It’s available in case you need to override the effect of an earlier occurrence of xindymakeindex.xdy extension. -

    This package option may additionally have a value that is a ⟨

    This package option may additionally have a value that is a ⟨key⟩=⟨value⟩ comma-separated list to override the language and codepage. For example: @@ -8456,7 +8472,7 @@ class="cmti-10">value⟩ comma-separated \usepackage[xindy={language=english,codepage=utf8}]  
      {glossaries} -

    You can also specify whether you want a number group in the glossary. This defaults to +

    You can also specify whether you want a number group in the glossary. This defaults to true, but can be suppressed. For example: @@ -8464,7 +8480,7 @@ class="cmti-10">value⟩ comma-separated

    \usepackage[xindy={glsnumbers=false}]{glossaries}
    -

    If no value is supplied to this package option (either simply writing

    If no value is supplied to this package option (either simply writing xindy or writing xindy={}) then the language, codepage and number group settings are unchanged. See @@ -8524,7 +8540,7 @@ class="E">EX 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 makeindexxindy. -

    However even in unrestricted mode this option may not work with

    However even in unrestricted mode this option may not work with xindy as xindymakeglossariesLATEX 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 @@ -8569,9 +8585,9 @@ class="cmss-10">automake=false

    -

    +

    -

    Top

    2.5 Acronym Options

    @@ -8586,15 +8602,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.)
    -

    +

    acronymsmain 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: @@ -8682,32 +8698,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⟩}
    -

    +

    shortcuts§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) @@ -8771,7 +8787,7 @@ class="cmss-10">smallcaps \setacronymstyle{long-sc-short-desc} -

    or (with

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

    or (with

    or (with footnote) @@ -8789,7 +8805,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) @@ -8820,7 +8836,7 @@ class="cmss-10">dua \setacronymstyle{dua-desc} -

    +

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

    or (with

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

    or (with

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

    +

    smallerThis 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: @@ -8879,7 +8895,7 @@ class="cmtt-10">\acronymfont \setacronymstyle{long-sm-short}

    -

    or (with

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

    or (with

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

    +

    footnote\newacronym \setacronymstyle{footnote} -

    or (with

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

    or (with

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

    or (with

    or (with description) @@ -8940,7 +8956,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} -

    +

    dua\newacronym \setacronymstyle{dua} -

    or (with

    or (with description) @@ -8985,15 +9001,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:

    symbolssymbols 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 @@ -9208,8 +9224,8 @@ class="cmtt-10">\GlsDeclareNoHyperList{index}
    -

    The example file

    The example file sample-index.tex illustrates the use of the index package @@ -9227,22 +9243,22 @@ class="cmssbx-10">compatible-3.07Compatibility mode for old documents created using version 3.07 or below.

    -

    +

    -

    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 @@ -9438,14 +9454,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: @@ -9453,19 +9469,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 @@ -9627,7 +9643,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 @@ -9690,39 +9706,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 @@ -9838,7 +9854,7 @@ class="cmss-10">firstplural\glspl. -

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

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

    -

    This is equivalent to: +

    This is equivalent to:

    @@ -9940,7 +9956,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: @@ -9954,9 +9970,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:

    @@ -10043,7 +10059,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 @@ -10092,7 +10108,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:

    @@ -10315,7 +10331,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: @@ -10354,7 +10370,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: @@ -10364,8 +10380,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 @@ -10380,7 +10396,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: @@ -10390,7 +10406,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:

    @@ -10432,7 +10448,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:

    @@ -10441,7 +10457,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:

    @@ -10450,23 +10466,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 @@ -10489,13 +10505,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 @@ -10606,7 +10622,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:

    @@ -10623,8 +10639,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:

    @@ -10633,20 +10649,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 @@ -10701,8 +10717,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: @@ -10781,15 +10797,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: @@ -10801,7 +10817,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:

    @@ -10814,19 +10830,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”: @@ -10860,14 +10876,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: @@ -10876,14 +10892,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 @@ -10892,15 +10908,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: @@ -10910,8 +10926,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: @@ -10921,8 +10937,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:

    @@ -10931,7 +10947,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:

    @@ -10939,22 +10955,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): @@ -10972,52 +10988,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.

    -

    @@ -11165,31 +11181,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 @@ -11208,7 +11224,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: @@ -11248,13 +11264,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:

    @@ -11267,19 +11283,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 @@ -11293,11 +11309,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:

    @@ -11311,7 +11327,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 @@ -11334,7 +11350,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 @@ -11356,14 +11372,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 @@ -11424,16 +11440,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: @@ -11448,14 +11464,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) @@ -11492,7 +11508,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: @@ -11519,14 +11535,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:

    @@ -11575,16 +11591,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, @@ -11609,15 +11625,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 @@ -11681,7 +11697,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 @@ -11753,11 +11769,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 @@ -11776,7 +11792,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. @@ -11892,7 +11908,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 @@ -11927,7 +11943,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 @@ -11937,7 +11953,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 @@ -11957,7 +11973,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 @@ -12069,7 +12085,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: @@ -12139,7 +12155,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: @@ -12147,8 +12163,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: @@ -12168,8 +12184,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: @@ -12202,7 +12218,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: @@ -12210,11 +12226,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 @@ -12292,7 +12308,7 @@ class="cmtt-10">xindy   \glsbackslash\string\textsc{\romannumeral\c@page}} -

    combined with +

    combined with

    @@ -12300,7 +12316,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 @@ -12311,7 +12327,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: @@ -12432,7 +12448,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:

    @@ -12568,10 +12584,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, @@ -12727,10 +12743,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 @@ -12823,17 +12839,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: @@ -12843,7 +12859,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 @@ -12879,7 +12895,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 @@ -13181,7 +13197,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 @@ -13254,16 +13270,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:

    @@ -13460,7 +13476,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 @@ -13469,7 +13485,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 @@ -13485,7 +13501,7 @@ solution is to insert an empty brace at the start:  
      description={an example}  
    }

    -

    Now the

    Now the link text will be set to @@ -13494,9 +13510,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 @@ -13523,7 +13539,7 @@ example:  
       description={another example}  
     } -

    Now the

    Now the link text will be set to: @@ -13532,7 +13548,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: @@ -13583,7 +13599,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 @@ -13598,7 +13614,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: @@ -13611,12 +13627,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 @@ -13678,14 +13694,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 @@ -13756,7 +13772,7 @@ href="#sec:acronyms">§13 Acronyms and Other Abbreviations. -

    Apart from

    Apart from \glslink, the commands described in this section also have a final @@ -13768,7 +13784,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. @@ -14455,7 +14471,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 @@ -14627,7 +14643,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 @@ -14849,11 +14865,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: @@ -14865,7 +14881,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 @@ -14932,7 +14948,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:

    @@ -14943,13 +14959,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: @@ -14959,7 +14975,7 @@ do:  
     \ifglsused{\glslabel}{}{\space  
       (denoted $\glsentrysymbol{\glslabel}$)}}

    -

    and define entries like this: +

    and define entries like this:

    @@ -14970,21 +14986,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 @@ -15036,11 +15052,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: @@ -15110,20 +15126,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 @@ -15141,11 +15157,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. @@ -15168,24 +15184,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 @@ -15297,16 +15313,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 @@ -15381,7 +15397,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:

    @@ -15395,7 +15411,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 @@ -15511,7 +15527,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:

    @@ -15560,11 +15576,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⟩ @@ -15591,12 +15607,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 @@ -15620,15 +15636,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 @@ -15744,7 +15760,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⟩, @@ -15951,22 +15967,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 @@ -16003,14 +16019,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 @@ -16075,7 +16091,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 @@ -16100,15 +16116,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 @@ -16255,7 +16271,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 @@ -16285,7 +16301,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.) @@ -16420,16 +16436,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 @@ -16463,7 +16479,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.) @@ -16507,18 +16523,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, @@ -16526,7 +16542,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 @@ -16738,7 +16754,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: @@ -16799,9 +16815,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:

    @@ -16822,24 +16838,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 @@ -16891,20 +16907,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: @@ -16912,18 +16928,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 @@ -16936,10 +16952,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 @@ -17057,10 +17073,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 @@ -17082,7 +17098,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: @@ -17121,8 +17137,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 @@ -17147,10 +17163,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 @@ -17200,17 +17216,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: @@ -17245,7 +17261,7 @@ example: \newcommand*{\primary}[1]{\textbf{#1}}  
    \GlsAddXdyAttribute{primary}

    -

    Then in the document: +

    Then in the document:

    @@ -17253,18 +17269,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: @@ -17272,7 +17288,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: @@ -17282,7 +17298,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: @@ -17291,13 +17307,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: @@ -17369,7 +17385,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: @@ -17378,7 +17394,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}): @@ -17390,7 +17406,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: @@ -17412,7 +17428,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: @@ -17424,20 +17440,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: @@ -17489,7 +17505,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 @@ -17587,7 +17603,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: @@ -17694,7 +17710,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 before \the\value which no longer hides \c@page from the location escaping mechanism, so -the page numbers should once more be correct. The sample file fmtcount package may +cause a problem again. +

    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 \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: +

    +
    +:locref "{}{\\customfmtnum {⟨n⟩}}" +
    +
    So the location class can be defined as: + + +
    +\GlsAddXdyLocation{customfmt}{ + 
     :sep "\string\customfmtnum\space\glsopenbrace" + 
     "arabic-numbers" + 
     :sep "\glsclosebrace"} +
    +

    +

    The sample file samplexdy3.tex illustrates -this.

    +class="cmtt-10">samplexdy3.tex illustrates this.

    -

    -

    ____________________________

    -

    In the

    +

    ____________________________

    +

    In the number list, the locations are sorted according to the list of provided location classes. + id="dx1-66051">, the locations are sorted according to the list of provided location classes. The default ordering is: roman-page-numbers (i, ii, …), arabic-page-numbers (1, 2, …), @@ -17742,7 +17796,7 @@ class="cmtt-10">arabic-page-numbers (1, 2, …), class="cmtt-10">arabic-section-numbers (for example, 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen11.1), + id="x1-66052f1">), alpha-page-numbers (a, b, …), Roman-page-numbers (I, II, …), @@ -17752,31 +17806,31 @@ class="cmtt-10">Appendix-page-numbers (for example, A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen11.2), + id="x1-66054f2">), user defined location names (as specified by \GlsAddXdyLocation in + id="dx1-66056"> in the order in which they were defined), and finally see (cross-referenced entries).11.3 + id="x1-66057f3"> 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:

    -
    +
    \GlsSetXdyLocationClassOrder{  
      "arabic-page-numbers"  
      "arabic-section-numbers" @@ -17788,70 +17842,70 @@ 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 + id="dx1-66059"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyLocationClassOrder must be used before \makeglossaries.
    -

    -

    If a .

    +

    +

    If a number list consists of a sequence of consecutive numbers, the range will be + id="dx1-66062"> 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:

    -
    +
    \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 manual for further details on range formations. +

    Note that \GlsSetXdyMinRangeLength has no effect if \noist is used or if + id="dx1-66065"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyMinRangeLength must be used before \makeglossaries.
    -

    + id="dx1-66067">.

    +

    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:

    -
    +
    \GlsAddXdyStyle{numeric-sort}
    -

    -

    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

    \string" class="cmti-10">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).

    @@ -17941,7 +17995,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 @@ -18115,11 +18169,11 @@ added to the nohypertypes list, since there are no hypertargets for the entries in 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 @@ -18152,10 +18206,10 @@ 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 @@ -18174,44 +18228,44 @@ 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:

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

    The

    The numbers package option creates a new glossary with the label numbers using:

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

    The

    The index package option creates a new glossary with the label 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 @@ -18262,8 +18316,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, @@ -18272,7 +18326,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 @@ -18316,7 +18370,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 @@ -18366,11 +18420,11 @@ 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 -

    +

    Avoid nested definitions.
    +

    +

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

    For example, suppose you have defined: +

    For example, suppose you have defined:

    -
    +
    \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 @@ -18524,34 +18578,34 @@ 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:

    -
    +
    \newacronym  
     [description={\gls{ssi} enabled \gls{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}
    -

    or +

    or

    -
    +
    \newacronym  
     [description={\gls{ssi} enabled \gls{html}}]  
     {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. @@ -18578,7 +18632,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 @@ -18841,8 +18895,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.

    -

    @@ -19066,7 +19120,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 @@ -19083,95 +19137,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:

    -
    +
    \usepackage[acronym]{glossaries}  
    \makeglossaries  
    \setacronymstyle{long-sc-short}  
    \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 @@ -19339,9 +19393,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 @@ -19361,9 +19415,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 @@ -19577,7 +19631,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*{\acronymsort}[2]{#1}% sort by short form  
    \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 @@ -19729,27 +19783,27 @@ 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 @@ -19873,11 +19927,11 @@ 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⟩):

    -
    +
    \newacronymstyle{long-sc-short}%  
    {% use the same display as "long-short"  
      \GlsUseAcrEntryDispStyle{long-short}% @@ -19941,7 +19995,7 @@ class="cmti-10">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 @@ -20008,17 +20062,17 @@ 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:

    -
    +
    \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
    -

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use #):

    -
    +
     % No case change, singular first use:  
      \renewcommand*{\genacrfullformat}[2]{%  
       \firstacronymfont{\glsentryshort{##1}}##2% @@ -20060,12 +20114,12 @@ class="cmtt-10">#):  
       \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:

    -
    +
     % No case change, singular first use:  
      \renewcommand*{\genacrfullformat}[2]{%  
       \firstacronymfont{\glsentryshort{##1}}##2% @@ -20079,7 +20133,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:

    -
    +
      \renewcommand*{\glsentryfull}[1]{%  
        \glsentrylong{##1}\space  
          (\acronymfont{\glsentryshort{##1}})% @@ -20124,11 +20178,11 @@ variants.  
          (\acronymfont{\glsentryshortpl{##1}})%  
      }%
    -

    Now for the linking commands: +

    Now for the linking commands:

    -
    +
      \renewcommand*{\acrfullfmt}[3]{%  
        \glslink[##1]{##2}{%  
         \glsentrylong{##2}##3\space @@ -20170,40 +20224,40 @@ 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:

    -
    +
      \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:

    -
    +
      \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:

    -
    +
      \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 @@ -20211,18 +20265,18 @@ parentheses:

    -
    +
     \renewcommand*{\acronymentry}[1]{%  
       \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*{\acronymentry}[1]{\Glsentrylong{##1}}%  
     \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:

    -
    +
     \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:

    -
    +
     \glshyperfirstfalse
    -

    Putting this all together: +

    Putting this all together:

    -
    +
    \newacronymstyle{custom-fn}% new style name  
    {%  
      \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% @@ -20356,29 +20410,29 @@ 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:

    -
    +
    \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:

    -
    +
    \newacronym[description={set of tags for use in  
    developing hypertext documents}]{html}{html}{Hyper  
    Text Markup Language} @@ -20386,26 +20440,26 @@ class="cmss-10">altlistlayout 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

    -
    +
      \renewcommand*{\genacrfullformat}[2]{%  
       \glsentrylong{##1}##2\space  
       ({\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:

    -
    +
    \newacronymstyle{long-font-short}  
    {%  
      \GlsUseAcrEntryDispStyle{long-short}% @@ -20503,23 +20557,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:

    -
    +
    \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.)
    @@ -20570,11 +20624,11 @@ 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 @@ -20596,11 +20650,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:

    -
    +
    \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,

    -
    +
    \newacronym{laser}{laser}{light amplification by stimulated  
    emission of radiation}
    -

    and my new command

    and my new command \newabbr for initials, for example,

    -
    +
    \newabbr{eg}{e.g.}{exempli gratia}  
    \newabbr{ie}{i.e.}{id est}  
    \newabbr{bsc}{B.Sc.}{Bachelor of Science}  
    \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 @@ -20662,7 +20716,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 -

    + -

    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 @@ -20689,11 +20743,11 @@ 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 @@ -20701,7 +20755,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

    @@ -20810,7 +20864,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 @@ -20932,7 +20986,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 @@ -20971,14 +21025,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 @@ -20994,7 +21048,7 @@ optional argument from being recognised.

    -

    @@ -21060,11 +21114,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 @@ -21149,13 +21203,13 @@ 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:

    -
    +
    \documentclass{beamer}  
    \usepackage{glossaries}  
    \newacronym{svm}{SVM}{support vector machine} @@ -21205,22 +21259,22 @@ 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:

    -
    +
    \documentclass{beamer}  
    \usepackage{glossaries}  
    \newacronym{svm}{SVM}{support vector machine} @@ -21235,12 +21289,12 @@ 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:

    -
    +
    \begin{frame}  
     \frametitle{Frame 1}  
     \begin{itemize} @@ -21249,7 +21303,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 @@ -21262,7 +21316,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. @@ -21334,36 +21388,36 @@ 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:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \makeglossaries @@ -21376,7 +21430,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

    @@ -21526,7 +21580,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cglsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cglspl and defaults to

    @@ -21555,7 +21609,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGls and defaults to

    @@ -21586,7 +21640,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGlspl and defaults to

    @@ -21615,7 +21669,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 @@ -21624,7 +21678,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): @@ -21635,17 +21689,17 @@ 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.

    -
    +
    \documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage[acronym]{glossaries} @@ -21666,7 +21720,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

    -
    +
    \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, glossary-bookindexglossaries-extra manual for further details. -

    Note that the group styles (such as

    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

    @@ -21988,7 +22042,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 @@ -22028,8 +22082,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 -

    +
    \renewcommand*{\glsgroupskip}{}  
    \printglossary[style=long]
    -

    then the new definition of

    then the new definition of \glsgroupskip will not have an affect for this glossary, as -

    +
    \renewcommand*{\glsgroupskip}{}  
    \setglossarystyle{long}
    -

    will reset

    will reset \glsgroupskip back to its default definition for the named glossary style (long -

    +
    \setglossarystyle{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.

    @@ -22207,35 +22261,35 @@ 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:

    -
    +
    \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.

    @@ -22266,17 +22320,17 @@ 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:

    -
    +
    \renewcommand{\glstreepredesc}{%  
     \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

    -
    +
    \renewcommand{\glstreepredesc}{\dotfill}  
    \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{glossaries}  
    \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 @@ -22777,16 +22831,16 @@ class="cmss-10">glossary-longbooktabs -

    +
    \usepackage{glossaries}  
    \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).

    @@ -22893,12 +22947,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{glossaries}  
    \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 @@ -23295,15 +23349,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

    -
    +
    \let\item\glstreeitem  
    \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:

    -
    +
    \renewcommand{\glstreeitem}{%  
     \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:

    -
    +
    \glsfindwidesttoplevelname  
    \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:

    -
    +
    \renewcommand{\glossarypreamble}{%  
      \glsfindwidesttoplevelname[\currentglossary]}  
    \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 @@ -23648,12 +23702,12 @@ class="cmti-10">text⟩ is the contents of the box. For example, to

    -
    +
    \renewcommand*{\glstreenamebox}[2]{%  
      \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 @@ -23728,29 +23782,29 @@ 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:

    -
    +
    \usepackage{glossary-mcols}  
    \renewcommand*{\glsmcols}{3}  
    \setglossarystyle{mcolindex}
    -

    +

    -

    @@ -23876,7 +23930,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 @@ -23887,10 +23941,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 @@ -23907,13 +23961,13 @@ do:

    -
    +
     \usepackage{glossary-inline}  
     \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 @@ -23922,55 +23976,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 @@ -24051,16 +24105,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 @@ -24215,8 +24269,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:

    -
    +
      \renewcommand*{\glossentry}[2]{%  
        \item[\glsentryitem{##1}%  
              \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 -

    +
     \newglossarystyle{mylist}{%  
     % put the glossary in the itemize environment:  
     \renewenvironment{theglossary}% @@ -24561,7 +24615,7 @@ follows:  
       \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 §16 href="#sec:utilities">Utilities): -
      +
       \renewcommand*{\glossentry}[2]{%  
       \item % bullet point  
       \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -24607,20 +24661,20 @@ href="#sec:utilities">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 -

    +
    \newglossarystyle{mylist}{%  
    \setglossarystyle{list}% base this style on the list style  
    \renewcommand{\glsgroupskip}{}% make nothing happen  
                                  % 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 -

    -

    -

    +

    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 @@ -24747,8 +24801,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⟩ @@ -24811,7 +24865,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 @@ -24837,12 +24891,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, @@ -24884,7 +24938,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 @@ -25140,14 +25194,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 @@ -25155,16 +25209,16 @@ 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 @@ -25192,12 +25246,12 @@ 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:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -25210,25 +25264,25 @@ 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:

    -
    +
    \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:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -25242,14 +25296,14 @@ 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:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -25263,14 +25317,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:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -25311,14 +25365,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:

    -
    +
    \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 @@ -25399,7 +25453,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 @@ -25494,7 +25548,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:

    @@ -25533,20 +25587,20 @@ 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:

    -
    +
    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

    -
    +
    \newglossaryentry{sample}{name={sample},%  
      description={an example},%  
      prefix={a~},%  
      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:

    -
    +
    \newglossaryentry{oeil}{name={oeil},  
      plural={yeux},  
      description={eye},  
      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:

    -
    +
    \newacronym  
     [%  
       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:

    -
    +
    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 @@ -25992,7 +26046,7 @@ before the name:

    -
    +
    \newglossarystyle{plist}{%  
      \setglossarystyle{list}%  
      \renewcommand*{\glossentry}[2]{% @@ -26002,18 +26056,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:

    -
    +
    \newglossaryentry{tex}{name={\TeX},description={Document  
    preparation language},access={TeX}}
    -

    Now

    Now \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 77
    amsgen package  78, 79, 80
    +href="glossaries-user.html#dx1-15" >79, 80, 81, 82
    amsmath package  81, 82
    +href="glossaries-user.html#dx1-55006" >83, 84
    arara  83, 84, 85, 86
    +href="glossaries-user.html#dx1-4008" >85, 86, 87, 88
    array package  87, 88
    +href="glossaries-user.html#dx1-81006" >89, 90

    B babel package  89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115
    +href="glossaries-user.html#dx1-7016" >91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117
    beamer class  116, 117, 118, 119
    +href="glossaries-user.html#dx1-55004" >118, 119, 120, 121
    beamer package  120
    +href="glossaries-user.html#dx1-14046" >122
    bib2gls  121, 122, 123, 124, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151
    +class="cmbx-10">125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153
    booktabs package  152, 153, 154
    +href="glossaries-user.html#dx1-80006" >154, 155, 156

    C \cGls  155
    +class="cmti-10">157
    \cgls  156
    +class="cmti-10">158
    \cGlsformat  157
    +class="cmti-10">159
    \cglsformat  158
    +class="cmti-10">160
    \cGlspl  159
    +class="cmti-10">161
    \cglspl  160
    +class="cmti-10">162
    \cGlsplformat  161
    +class="cmti-10">163
    \cglsplformat  162
    +class="cmti-10">164
    classicthesis package  163, 164, 165, 166, 167
    +href="glossaries-user.html#dx1-25027" >165, 166, 167, 168, 169
    \currentglossary  168
    +class="cmti-10">170

    D datatool package  169, 170, 171, 172, 173
    +href="glossaries-user.html#dx1-13" >171, 172, 173, 174, 175
    datatool-base package  174, 175
    +href="glossaries-user.html#dx1-12" >176, 177
    \DeclareAcronymList  176
    +class="cmti-10">178
    \defglsentryfmt  177
    +class="cmti-10">179
    \DefineAcronymSynonyms  178
    +class="cmti-10">180
    doc package  179, 180, 181
    +href="glossaries-user.html#dx1-21" >181, 182, 183

    E encap  182
    +href="glossaries-user.html#dx1-50002" >184
    entry location  183
    +class="cmbx-10">185
    environments:
         theglossary  184
    +class="cmti-10">186
    etoolbox package  185, 186, 187, 188, 189, 190
    +href="glossaries-user.html#dx1-8" >187, 188, 189, 190, 191, 192
    Extended Latin Alphabet  191
    +class="cmbx-10">193
    extended Latin character  192, 194, 193, 194, 195, 196, 197, 198
    +class="cmbx-10">195, 196, 197, 198, 199, 200

    F file types
         .alg  199
    +href="glossaries-user.html#dx1-16079" >201
        .aux  200, 201, 202, 203, 204
    +href="glossaries-user.html#dx1-13024" >202, 203, 204, 205, 206
        .glg  205, 206, 207
    +href="glossaries-user.html#dx1-16078" >207, 208, 209
        .glg2  208
    +href="glossaries-user.html#dx1-25" >210
        .glo  209, 210, 211
    +href="glossaries-user.html#dx1-17019" >211, 212, 213
        .gls  212, 213
    +href="glossaries-user.html#dx1-19017" >214, 215
        .glsdefs  214, 215, 216, 217
    +href="glossaries-user.html#dx1-44013" >216, 217, 218, 219
        .ist  218, 219, 220, 221, 222, 223
    +href="glossaries-user.html#dx1-20005" >220, 221, 222, 223, 224, 225
        .tex  224, 225, 226, 227
    +href="glossaries-user.html#dx1-13014" >226, 227, 228, 229
        .xdy  228, 229, 230, 231, 232, 233, 234, 235
    +href="glossaries-user.html#dx1-19012" >230, 231, 232, 233, 234, 235, 236, 237
        glo2  236
    +href="glossaries-user.html#dx1-24" >238
        gls2  237
    +href="glossaries-user.html#dx1-23" >239
    first use  238
    +href="glossaries-user.html#dx1-3010" >240
        flag  239
    +href="glossaries-user.html#dx1-3018" >241
        text  240
    +href="glossaries-user.html#dx1-3019" >242
    \firstacronymfont  241
    +class="cmti-10">243
    flowfram package  242
    +href="glossaries-user.html#dx1-83011" >244
    fmtcount package  243, 244, 245, 246
    +href="glossaries-user.html#dx1-11090" >245, 246, 247, 248
    fontspec package  247, 248
    +href="glossaries-user.html#dx1-34142" >249, 250
    \forallacronyms  249
    +class="cmti-10">251
    \forallglossaries  250
    +class="cmti-10">252
    \forallglsentries  251
    +class="cmti-10">253
    \forglsentries  252
    +class="cmti-10">254

    G \Genacrfullformat  253
    +class="cmti-10">255
    \genacrfullformat  254
    +class="cmti-10">256
    \GenericAcronymFields  255
    +class="cmti-10">257
    \Genplacrfullformat  256
    +class="cmti-10">258
    \genplacrfullformat  257
    +class="cmti-10">259
    glossaries package  258, 259, 260, 261, 262, 263, 264, 265
    +href="glossaries-user.html#dx1-3" >260, 261, 262, 263, 264, 265, 266, 267
    glossaries-accsupp package  266, 267, 268, 269
    +href="glossaries-user.html#dx1-11118" >268, 269, 270, 271
    glossaries-babel package  270, 271
    +href="glossaries-user.html#dx1-23059" >272, 273
    glossaries-extra package  272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296
    +href="glossaries-user.html#dx1-5008" >274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298
    glossaries-extra-stylemods package  297
    +href="glossaries-user.html#dx1-78045" >299
    glossaries-polyglossia package  298
    +href="glossaries-user.html#dx1-23061" >300
    glossaries-prefix package  299, 300, 301, 302
    +href="glossaries-user.html#dx1-11116" >301, 302, 303, 304
    glossary counters:
         glossaryentry  303
    +class="cmti-10">305
        glossarysubentry  304
    +class="cmti-10">306
    glossary package  305, 306, 307, 308, 309
    +href="glossaries-user.html#dx1-17" >307, 308, 309, 310, 311
    glossary styles:
         altlist  310, 311, 312, 313, 314
    +href="glossaries-user.html#dx1-71047" >312, 313, 314, 315, 316
        altlistgroup  315, 316
    +href="glossaries-user.html#dx1-79030" >317, 318
        altlisthypergroup  317
    +href="glossaries-user.html#dx1-79032" >319
        altlong4col  318, 319, 320
    +href="glossaries-user.html#dx1-78024" >320, 321, 322
        altlong4col-booktabs  321
    +href="glossaries-user.html#dx1-82031" >323
        altlong4colborder  322
    +href="glossaries-user.html#dx1-80043" >324
        altlong4colheader  323, 324
    +href="glossaries-user.html#dx1-80045" >325, 326
        altlong4colheaderborder  325
    +href="glossaries-user.html#dx1-80047" >327
        altlongragged4col  326, 327, 328
    +href="glossaries-user.html#dx1-81030" >328, 329, 330
        altlongragged4col-booktabs  329
    +href="glossaries-user.html#dx1-82037" >331
        altlongragged4colborder  330
    +href="glossaries-user.html#dx1-81034" >332
        altlongragged4colheader  331, 332, 333
    +href="glossaries-user.html#dx1-81036" >333, 334, 335
        altlongragged4colheaderborder  334
    +href="glossaries-user.html#dx1-81038" >336
        altsuper4col  335, 336, 337
    +href="glossaries-user.html#dx1-78025" >337, 338, 339
        altsuper4colborder  338
    +href="glossaries-user.html#dx1-83048" >340
        altsuper4colheader  339
    +href="glossaries-user.html#dx1-83050" >341
        altsuper4colheaderborder  340
    +href="glossaries-user.html#dx1-83052" >342
        altsuperragged4col  341, 342, 343
    +href="glossaries-user.html#dx1-84032" >343, 344, 345
        altsuperragged4colborder  344
    +href="glossaries-user.html#dx1-84034" >346
        altsuperragged4colheader  345, 346
    +href="glossaries-user.html#dx1-84036" >347, 348
        altsuperragged4colheaderborder  347
    +href="glossaries-user.html#dx1-84038" >349
        alttree  348, 349, 350, 351, 352, 353, 354, 355
    +href="glossaries-user.html#dx1-78028" >350, 351, 352, 353, 354, 355, 356, 357
        alttreegroup  356, 357, 358
    +href="glossaries-user.html#dx1-85055" >358, 359, 360
        alttreehypergroup  359, 360
    +href="glossaries-user.html#dx1-85057" >361, 362
        bookindex  361
    +href="glossaries-user.html#dx1-78004" >363
        index  362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373
    +href="glossaries-user.html#dx1-25051" >364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375
        indexgroup  374, 375, 376
    +href="glossaries-user.html#dx1-85024" >376, 377, 378
        indexhypergroup  377, 378, 379
    +href="glossaries-user.html#dx1-85007" >379, 380, 381
        inline  380, 381, 382
    +href="glossaries-user.html#dx1-11067" >382, 383, 384
        list  383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395
    +href="glossaries-user.html#dx1-25044" >385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397
        listdotted  396, 397, 398, 399, 400
    +href="glossaries-user.html#dx1-78038" >398, 399, 400, 401, 402
        listgroup  401, 402, 403, 404
    +href="glossaries-user.html#dx1-26022" >403, 404, 405, 406
        listhypergroup  405, 406, 407, 408, 409, 410, 411, 412
    +href="glossaries-user.html#dx1-79019" >407, 408, 409, 410, 411, 412, 413, 414
        long  413, 414, 415, 416, 417, 418
    +href="glossaries-user.html#dx1-78027" >415, 416, 417, 418, 419, 420
        long-booktabs  419, 420
    +href="glossaries-user.html#dx1-82024" >421, 422
        long3col  421, 422, 423, 424, 425
    +href="glossaries-user.html#dx1-78011" >423, 424, 425, 426, 427
        long3col-booktabs  426
    +href="glossaries-user.html#dx1-82026" >428
        long3colborder  427, 428
    +href="glossaries-user.html#dx1-78013" >429, 430
        long3colheader  429, 430, 431, 432
    +href="glossaries-user.html#dx1-78012" >431, 432, 433, 434
        long3colheaderborder  433, 434
    +href="glossaries-user.html#dx1-78014" >435, 436
        long4col  435, 436, 437, 438, 439
    +href="glossaries-user.html#dx1-78022" >437, 438, 439, 440, 441
        long4col-booktabs  440
    +href="glossaries-user.html#dx1-82029" >442
        long4colborder  441, 442
    +href="glossaries-user.html#dx1-80033" >443, 444
        long4colheader  443, 444, 445, 446
    +href="glossaries-user.html#dx1-80035" >445, 446, 447, 448
        long4colheaderborder  447, 448
    +href="glossaries-user.html#dx1-80037" >449, 450
        longborder  449
    +href="glossaries-user.html#dx1-80013" >451
        longheader  450, 451, 452, 453
    +href="glossaries-user.html#dx1-80015" >452, 453, 454, 455
        longheaderborder  454, 455
    +href="glossaries-user.html#dx1-80017" >456, 457
        longragged  456, 457, 458, 459
    +href="glossaries-user.html#dx1-81010" >458, 459, 460, 461
        longragged-booktabs  460
    +href="glossaries-user.html#dx1-82033" >462
        longragged3col  461, 462, 463, 464
    +href="glossaries-user.html#dx1-81019" >463, 464, 465, 466
        longragged3col-booktabs  465
    +href="glossaries-user.html#dx1-82035" >467
        longragged3colborder  466
    +href="glossaries-user.html#dx1-81024" >468
        longragged3colheader  467, 468, 469
    +href="glossaries-user.html#dx1-81026" >469, 470, 471
        longragged3colheaderborder  470
    +href="glossaries-user.html#dx1-81028" >472
        longraggedborder  471
    +href="glossaries-user.html#dx1-81013" >473
        longraggedheader  472, 473, 474
    +href="glossaries-user.html#dx1-81015" >474, 475, 476
        longraggedheaderborder  475
    +href="glossaries-user.html#dx1-81017" >477
        mcolalttree  476
    +href="glossaries-user.html#dx1-86039" >478
        mcolalttreegroup  477
    +href="glossaries-user.html#dx1-86041" >479
        mcolalttreehypergroup  478
    +href="glossaries-user.html#dx1-86043" >480
        mcolalttreespannav  479
    +href="glossaries-user.html#dx1-86044" >481
        mcolindex  480, 481
    +href="glossaries-user.html#dx1-86005" >482, 483
        mcolindexgroup  482
    +href="glossaries-user.html#dx1-86020" >484
        mcolindexhypergroup  483
    +href="glossaries-user.html#dx1-86022" >485
        mcolindexspannav  484
    +href="glossaries-user.html#dx1-86023" >486
        mcoltree  485
    +href="glossaries-user.html#dx1-86025" >487
        mcoltreegroup  486
    +href="glossaries-user.html#dx1-86027" >488
        mcoltreehypergroup  487, 488
    +href="glossaries-user.html#dx1-86029" >489, 490
        mcoltreenoname  489
    +href="glossaries-user.html#dx1-86032" >491
        mcoltreenonamegroup  490
    +href="glossaries-user.html#dx1-86034" >492
        mcoltreenonamehypergroup  491
    +href="glossaries-user.html#dx1-86036" >493
        mcoltreenonamespannav  492
    +href="glossaries-user.html#dx1-86037" >494
        mcoltreespannav  493
    +href="glossaries-user.html#dx1-86030" >495
        super  494, 495, 496, 497
    +href="glossaries-user.html#dx1-83012" >496, 497, 498, 499
        super3col  498, 499, 500, 501
    +href="glossaries-user.html#dx1-83024" >500, 501, 502, 503
        super3colborder  502
    +href="glossaries-user.html#dx1-83029" >504
        super3colheader  503, 504
    +href="glossaries-user.html#dx1-83031" >505, 506
        super3colheaderborder  505
    +href="glossaries-user.html#dx1-83033" >507
        super4col  506, 507, 508, 509, 510
    +href="glossaries-user.html#dx1-78023" >508, 509, 510, 511, 512
        super4colborder  511, 512
    +href="glossaries-user.html#dx1-83038" >513, 514
        super4colheader  513, 514, 515
    +href="glossaries-user.html#dx1-83040" >515, 516, 517
        super4colheaderborder  516, 517
    +href="glossaries-user.html#dx1-83042" >518, 519
        superborder  518
    +href="glossaries-user.html#dx1-83018" >520
        superheader  519, 520
    +href="glossaries-user.html#dx1-83020" >521, 522
        superheaderborder  521, 522
    +href="glossaries-user.html#dx1-63069" >523, 524
        superragged  523, 524, 525, 526
    +href="glossaries-user.html#dx1-84009" >525, 526, 527, 528
        superragged3col  527, 528, 529, 530
    +href="glossaries-user.html#dx1-84021" >529, 530, 531, 532
        superragged3colborder  531
    +href="glossaries-user.html#dx1-84026" >533
        superragged3colheader  532, 533
    +href="glossaries-user.html#dx1-84028" >534, 535
        superragged3colheaderborder  534
    +href="glossaries-user.html#dx1-84030" >536
        superraggedborder  535
    +href="glossaries-user.html#dx1-84015" >537
        superraggedheader  536, 537
    +href="glossaries-user.html#dx1-84017" >538, 539
        superraggedheaderborder  538
    +href="glossaries-user.html#dx1-84019" >540
        tree  539, 540, 541, 542, 543, 544, 545
    +href="glossaries-user.html#dx1-72066" >541, 542, 543, 544, 545, 546, 547
        treegroup  546, 547, 548
    +href="glossaries-user.html#dx1-85035" >548, 549, 550
        treehypergroup  549, 550, 551
    +href="glossaries-user.html#dx1-79024" >551, 552, 553
        treenoname  552, 553, 554, 555
    +href="glossaries-user.html#dx1-85012" >554, 555, 556, 557
        treenonamegroup  556, 557, 558
    +href="glossaries-user.html#dx1-85042" >558, 559, 560
        treenonamehypergroup  559, 560
    +href="glossaries-user.html#dx1-85044" >561, 562
    glossary-bookindex package  561
    +href="glossaries-user.html#dx1-78005" >563
    glossary-inline package  562, 563
    +href="glossaries-user.html#dx1-87001" >564, 565
    glossary-list package  564, 565, 566, 567, 568
    +href="glossaries-user.html#dx1-25029" >566, 567, 568, 569, 570
    glossary-long package  569, 570, 571, 572, 573, 574, 575, 576
    +href="glossaries-user.html#dx1-25030" >571, 572, 573, 574, 575, 576, 577, 578
    glossary-longbooktabs package  577, 578, 579
    +href="glossaries-user.html#dx1-82001" >579, 580, 581
    glossary-longragged package  580, 581, 582, 583
    +href="glossaries-user.html#dx1-81001" >582, 583, 584, 585
    glossary-mcols package  584, 585, 586, 587, 588, 589, 590
    +href="glossaries-user.html#dx1-25054" >586, 587, 588, 589, 590, 591, 592
    glossary-ragged package  591
    +href="glossaries-user.html#dx1-82010" >593
    glossary-super package  592, 593, 594, 595, 596, 597
    +href="glossaries-user.html#dx1-25031" >594, 595, 596, 597, 598, 599
    glossary-superragged package  598, 599, 600
    +href="glossaries-user.html#dx1-84001" >600, 601, 602
    glossary-tree package  601, 602, 603, 604, 605, 606, 607, 608
    +href="glossaries-user.html#dx1-25032" >603, 604, 605, 606, 607, 608, 609, 610
    glossaryentry (counter)  609, 610, 611, 612
    +class="cmti-10">611, 612, 613, 614
    \glossaryheader  613
    +class="cmti-10">615
    \glossarypostamble  614
    +class="cmti-10">616
    \glossarypreamble  615
    +class="cmti-10">617
    glossarysubentry (counter)  616
    +class="cmti-10">618
    \glossentry  617
    +class="cmti-10">619
    \Glossentrydesc  618
    +class="cmti-10">620
    \glossentrydesc  619
    +class="cmti-10">621
    \Glossentryname  620
    +class="cmti-10">622
    \glossentryname  621
    +class="cmti-10">623
    \Glossentrysymbol  622
    +class="cmti-10">624
    \glossentrysymbol  623
    +class="cmti-10">625
    \GLS  624
    +class="cmti-10">626
    \Gls  625
    +class="cmti-10">627
    \gls  626
    +class="cmti-10">628
    \glsacspace  627
    +class="cmti-10">629
    \glsadd  628
    +class="cmti-10">630
    \glsaddall  629
    +class="cmti-10">631
    \glsaddall options
         types  630
    +href="glossaries-user.html#dx1-59004" >632
    \glsaddallunused  631
    +class="cmti-10">633
    \glsaddkey  632
    +class="cmti-10">634
    \glsaddprotectedpagefmt  633
    +class="cmti-10">635
    \glsaddstoragekey  634
    +class="cmti-10">636
    \GlsAddXdyAttribute  635
    +class="cmti-10">637
    \GlsAddXdyCounters  636
    +class="cmti-10">638
    \GlsAddXdyLocation  637
    +class="cmti-10">639
    \glsautoprefix  638
    +class="cmti-10">640
    \glsbackslash  639
    +class="cmti-10">641
    \glscapscase  640
    +class="cmti-10">642
    \glsclearpage  641
    +class="cmti-10">643
    \glsclosebrace  642
    +class="cmti-10">644
    \glscurrentfieldvalue  643
    +class="cmti-10">645
    \glscustomtext  644
    +class="cmti-10">646
    \GLSdesc  645
    +class="cmti-10">647
    \Glsdesc  646
    +class="cmti-10">648
    \glsdesc  647
    +class="cmti-10">649
    \glsdescwidth  648
    +class="cmti-10">650
    \glsdisablehyper  649
    +class="cmti-10">651
    \glsdisp  650
    +class="cmti-10">652
    \glsdisplaynumberlist  651
    +class="cmti-10">653
    \glsdoifexists  652
    +class="cmti-10">654
    \glsdoifexistsordo  653
    +class="cmti-10">655
    \glsdoifexistsorwarn  654
    +class="cmti-10">656
    \glsdoifnoexists  655
    +class="cmti-10">657
    \glsdoifnoexistsordo  656
    +class="cmti-10">658
    \glsdosanitizesort  657
    +class="cmti-10">659
    \glsenableentrycount  658
    +class="cmti-10">660
    \glsenablehyper  659
    +class="cmti-10">661
    \glsentrycounterlabel  660
    +class="cmti-10">662
    \GlsEntryCounterLabelPrefix  661
    +class="cmti-10">663
    \glsentrycurrcount  662
    +class="cmti-10">664
    \Glsentrydesc  663
    +class="cmti-10">665
    \glsentrydesc  664
    +class="cmti-10">666
    \Glsentrydescplural  665
    +class="cmti-10">667
    \glsentrydescplural  666
    +class="cmti-10">668
    \Glsentryfirst  667
    +class="cmti-10">669
    \glsentryfirst  668
    +class="cmti-10">670
    \Glsentryfirstplural  669
    +class="cmti-10">671
    \glsentryfirstplural  670
    +class="cmti-10">672
    \glsentryfmt  671
    +class="cmti-10">673
    \Glsentryfull  672
    +class="cmti-10">674
    \glsentryfull  673
    +class="cmti-10">675
    \Glsentryfullpl  674
    +class="cmti-10">676
    \glsentryfullpl  675
    +class="cmti-10">677
    \glsentryitem  676
    +class="cmti-10">678
    \Glsentrylong  677
    +class="cmti-10">679
    \glsentrylong  678
    +class="cmti-10">680
    \Glsentrylongpl  679
    +class="cmti-10">681
    \glsentrylongpl  680
    +class="cmti-10">682
    \Glsentryname  681
    +class="cmti-10">683
    \glsentryname  682
    +class="cmti-10">684
    \glsentrynumberlist  683
    +class="cmti-10">685
    \Glsentryplural  684
    +class="cmti-10">686
    \glsentryplural  685
    +class="cmti-10">687
    \Glsentryprefix  686
    +class="cmti-10">688
    \glsentryprefix  687
    +class="cmti-10">689
    \Glsentryprefixfirst  688
    +class="cmti-10">690
    \glsentryprefixfirst  689
    +class="cmti-10">691
    \Glsentryprefixfirstplural  690
    +class="cmti-10">692
    \glsentryprefixfirstplural  691
    +class="cmti-10">693
    \Glsentryprefixplural  692
    +class="cmti-10">694
    \glsentryprefixplural  693
    +class="cmti-10">695
    \glsentryprevcount  694
    +class="cmti-10">696
    \Glsentryshort  695
    +class="cmti-10">697
    \glsentryshort  696
    +class="cmti-10">698
    \Glsentryshortpl  697
    +class="cmti-10">699
    \glsentryshortpl  698
    +class="cmti-10">700
    \Glsentrysymbol  699
    +class="cmti-10">701
    \glsentrysymbol  700
    +class="cmti-10">702
    \Glsentrysymbolplural  701
    +class="cmti-10">703
    \glsentrysymbolplural  702
    +class="cmti-10">704
    \Glsentrytext  703
    +class="cmti-10">705
    \glsentrytext  704
    +class="cmti-10">706
    \glsentrytitlecase  705
    +class="cmti-10">707
    \Glsentryuseri  706
    +class="cmti-10">708
    \glsentryuseri  707
    +class="cmti-10">709
    \Glsentryuserii  708
    +class="cmti-10">710
    \glsentryuserii  709
    +class="cmti-10">711
    \Glsentryuseriii  710
    +class="cmti-10">712
    \glsentryuseriii  711
    +class="cmti-10">713
    \Glsentryuseriv  712
    +class="cmti-10">714
    \glsentryuseriv  713
    +class="cmti-10">715
    \Glsentryuserv  714
    +class="cmti-10">716
    \glsentryuserv  715
    +class="cmti-10">717
    \Glsentryuservi  716
    +class="cmti-10">718
    \glsentryuservi  717
    +class="cmti-10">719
    \glsexpandfields  718
    +class="cmti-10">720
    \glsfielddef  719
    +class="cmti-10">721
    \glsfieldedef  720
    +class="cmti-10">722
    \glsfieldfetch  721
    +class="cmti-10">723
    \glsfieldgdef  722
    +class="cmti-10">724
    \glsfieldxdef  723
    +class="cmti-10">725
    \glsfindwidesttoplevelname  724
    +class="cmti-10">726
    \GLSfirst  725
    +class="cmti-10">727
    \Glsfirst  726
    +class="cmti-10">728
    \glsfirst  727
    +class="cmti-10">729
    \GLSfirstplural  728
    +class="cmti-10">730
    \Glsfirstplural  729
    +class="cmti-10">731
    \glsfirstplural  730
    +class="cmti-10">732
    \glsgenacfmt  731
    +class="cmti-10">733
    \glsgenentryfmt  732
    +class="cmti-10">734
    \glsgetgrouptitle  733
    +class="cmti-10">735
    \glsglossarymark  734, 736, 735
    +class="cmti-10">737
    \glsgroupheading  736
    +class="cmti-10">738
    \glsgroupskip  737
    +class="cmti-10">739
    \glshyperlink  738
    +class="cmti-10">740
    \glshypernavsep  739
    +class="cmti-10">741
    \glsifhyperon  740
    +class="cmti-10">742
    \glsIfListOfAcronyms  741
    +class="cmti-10">743
    \glsifplural  742
    +class="cmti-10">744
    \glsinlinedescformat  743
    +class="cmti-10">745
    \glsinlineemptydescformat  744
    +class="cmti-10">746
    \glsinlinenameformat  745
    +class="cmti-10">747
    \glsinlineparentchildseparator  746
    +class="cmti-10">748
    \glsinlineseparator  747
    +class="cmti-10">749
    \glsinlinesubdescformat  748
    +class="cmti-10">750
    \glsinlinesubnameformat  749
    +class="cmti-10">751
    \glsinlinesubseparator  750
    +class="cmti-10">752
    \glsinsert  751
    +class="cmti-10">753
    \glslabel  752
    +class="cmti-10">754
    \glslabeltok  753
    +class="cmti-10">755
    \glsletentryfield  754
    +class="cmti-10">756
    \glslink  755
    +class="cmti-10">757
    \glslink options
         counter  756, 757
    +href="glossaries-user.html#dx1-54071" >758, 759
        format  758, 759, 760, 761, 762, 763, 764, 765
    +href="glossaries-user.html#dx1-50004" >760, 761, 762, 763, 764, 765, 766, 767
        hyper  766, 767, 768, 769, 770, 771, 772
    +href="glossaries-user.html#dx1-23101" >768, 769, 770, 771, 772, 773, 774
        local  773
    +href="glossaries-user.html#dx1-54072" >775
    \glslinkcheckfirsthyperhook  774
    +class="cmti-10">776
    \glslinkpostsetkeys  775
    +class="cmti-10">777
    \glslinkvar  776
    +class="cmti-10">778
    \glslistdottedwidth  777
    +class="cmti-10">779
    \glslistnavigationitem  778
    +class="cmti-10">780
    \glslocalreset  779
    +class="cmti-10">781
    \glslocalresetall  780
    +class="cmti-10">782
    \glslocalunset  781
    +class="cmti-10">783
    \glslocalunsetall  782
    +class="cmti-10">784
    \glslongtok  783
    +class="cmti-10">785
    \glsmcols  784
    +class="cmti-10">786
    \glsmoveentry  785
    +class="cmti-10">787
    \GLSname  786
    +class="cmti-10">788
    \Glsname  787
    +class="cmti-10">789
    \glsname  788
    +class="cmti-10">790
    \glsnamefont  789
    +class="cmti-10">791
    \glsnavhypertarget  790
    +class="cmti-10">792
    \glsnavigation  791
    +class="cmti-10">793
    \glsnoexpandfields  792
    +class="cmti-10">794
    \glsnoidxdisplayloc  793
    +class="cmti-10">795
    \glsnumberlistloop  794
    +class="cmti-10">796
    \glsnumlistlastsep  795
    +class="cmti-10">797
    \glsnumlistsep  796
    +class="cmti-10">798
    \glsopenbrace  797
    +class="cmti-10">799
    \glspagelistwidth  798
    +class="cmti-10">800
    \glspar  799
    +class="cmti-10">801
    \glspatchtabularx  800
    +class="cmti-10">802
    \glspercentchar  801
    +class="cmti-10">803
    \GLSpl  802
    +class="cmti-10">804
    \Glspl  803
    +class="cmti-10">805
    \glspl  804
    +class="cmti-10">806
    \GLSplural  805
    +class="cmti-10">807
    \Glsplural  806
    +class="cmti-10">808
    \glsplural  807
    +class="cmti-10">809
    \glspluralsuffix  808
    +class="cmti-10">810
    \glspostdescription  809
    +class="cmti-10">811
    \glspostinline  810
    +class="cmti-10">812
    \glspostlinkhook  811
    +class="cmti-10">813
    \glsprestandardsort  812
    +class="cmti-10">814
    \glsquote  813
    +class="cmti-10">815
    \glsrefentry  814
    +class="cmti-10">816
    \glsreset  815
    +class="cmti-10">817
    \glsresetall  816
    +class="cmti-10">818
    \glsresetentrycounter  817
    +class="cmti-10">819
    \glsrestoreLToutput  818
    +class="cmti-10">820
    \glssee  819
    +class="cmti-10">821
    \glsseeformat  820
    +class="cmti-10">822
    \glsseeitemformat  821
    +class="cmti-10">823
    \glsseelastsep  822
    +class="cmti-10">824
    \glsseesep  823
    +class="cmti-10">825
    \glsSetAlphaCompositor  824
    +class="cmti-10">826
    \glsSetCompositor  825
    +class="cmti-10">827
    \glssetexpandfield  826
    +class="cmti-10">828
    \glssetnoexpandfield  827
    +class="cmti-10">829
    \GlsSetQuote  828
    +class="cmti-10">830
    \glsSetSuffixF  829
    +class="cmti-10">831
    \glsSetSuffixFF  830
    +class="cmti-10">832
    \glssetwidest  831
    +class="cmti-10">833
    \GlsSetWriteIstHook  832
    +class="cmti-10">834
    \GlsSetXdyCodePage  833
    +class="cmti-10">835
    \GlsSetXdyFirstLetterAfterDigits  834
    +class="cmti-10">836
    \GlsSetXdyLanguage  835
    +class="cmti-10">837
    \GlsSetXdyLocationClassOrder  836
    +href="glossaries-user.html#dx1-66058" >838
    \GlsSetXdyMinRangeLength  837
    +href="glossaries-user.html#dx1-66063" >839
    \GlsSetXdyNumberGroupOrder  838
    +class="cmti-10">840
    \glsshorttok  839
    +class="cmti-10">841
    \glsshowtarget  840
    +class="cmti-10">842
    \glssortnumberfmt  841
    +class="cmti-10">843
    \glssubentrycounterlabel  842
    +class="cmti-10">844
    \glssubentryitem  843
    +class="cmti-10">845
    \GLSsymbol  844
    +class="cmti-10">846
    \Glssymbol  845
    +class="cmti-10">847
    \glssymbol  846
    +class="cmti-10">848
    \glstarget  847
    +class="cmti-10">849
    \GLStext  848
    +class="cmti-10">850
    \Glstext  849
    +class="cmti-10">851
    \glstext  850
    +class="cmti-10">852
    \glstextformat  851
    +class="cmti-10">853
    \glstextup  852
    +class="cmti-10">854
    \glstildechar  853
    +class="cmti-10">855
    \glstocfalse  854
    +class="cmti-10">856
    \glstoctrue  855
    +class="cmti-10">857
    \glstreechildpredesc  856
    +class="cmti-10">858
    \glstreegroupheaderfmt  857
    +class="cmti-10">859
    \glstreeindent  858
    +class="cmti-10">860
    \glstreeitem  859
    +class="cmti-10">861
    \glstreenamebox  860
    +class="cmti-10">862
    \glstreenamefmt  861
    +class="cmti-10">863
    \glstreenavigationfmt  862
    +class="cmti-10">864
    \glstreepredesc  863
    +class="cmti-10">865
    \glstreesubitem  864
    +class="cmti-10">866
    \glstreesubsubitem  865
    +class="cmti-10">867
    \glstype  866
    +class="cmti-10">868
    \glsunset  867
    +class="cmti-10">869
    \glsunsetall  868
    +class="cmti-10">870
    \GlsUseAcrEntryDispStyle  869
    +class="cmti-10">871
    \GlsUseAcrStyleDefs  870
    +class="cmti-10">872
    \GLSuseri  871
    +class="cmti-10">873
    \Glsuseri  872
    +class="cmti-10">874
    \glsuseri  873
    +class="cmti-10">875
    \GLSuserii  874
    +class="cmti-10">876
    \Glsuserii  875
    +class="cmti-10">877
    \glsuserii  876
    +class="cmti-10">878
    \GLSuseriii  877
    +class="cmti-10">879
    \Glsuseriii  878
    +class="cmti-10">880
    \glsuseriii  879
    +class="cmti-10">881
    \GLSuseriv  880
    +class="cmti-10">882
    \Glsuseriv  881
    +class="cmti-10">883
    \glsuseriv  882
    +class="cmti-10">884
    \GLSuserv  883
    +class="cmti-10">885
    \Glsuserv  884
    +class="cmti-10">886
    \glsuserv  885
    +class="cmti-10">887
    \GLSuservi  886
    +class="cmti-10">888
    \Glsuservi  887
    +class="cmti-10">889
    \glsuservi  888
    +class="cmti-10">890
    \glswrallowprimitivemodsfalse  889
    +class="cmti-10">891
    \glswrite  890
    +class="cmti-10">892
    \glswriteentry  891
    +class="cmti-10">893

    H html package  892
    +href="glossaries-user.html#dx1-58002" >894
    hyperref package  893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907, 908, 909, 910, 911, 912, 913, 914, 915
    +href="glossaries-user.html#dx1-19" >895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907, 908, 909, 910, 911, 912, 913, 914, 915, 916, 917

    I \ifglossaryexists  916
    +class="cmti-10">918
    \ifglsdescsuppressed  917
    +class="cmti-10">919
    \ifglsentryexists  918
    +class="cmti-10">920
    \ifglsfieldcseq  919
    +class="cmti-10">921
    \ifglsfielddefeq  920
    +class="cmti-10">922
    \ifglsfieldeq  921
    +class="cmti-10">923
    \ifglshaschildren  922
    +class="cmti-10">924
    \ifglshasdesc  923
    +class="cmti-10">925
    \ifglshasfield  924
    +class="cmti-10">926
    \ifglshaslong  925
    +class="cmti-10">927
    \ifglshasparent  926
    +class="cmti-10">928
    \ifglshasprefix  927
    +class="cmti-10">929
    \ifglshasprefixfirst  928
    +class="cmti-10">930
    \ifglshasprefixfirstplural  929
    +class="cmti-10">931
    \ifglshasprefixplural  930
    +class="cmti-10">932
    \ifglshasshort  931
    +class="cmti-10">933
    \ifglshassymbol  932
    +class="cmti-10">934
    \ifglsucmark  933
    +class="cmti-10">935
    \ifglsused  934, 936, 935
    +class="cmti-10">937
    \ifignoredglossary  936
    +class="cmti-10">938
    imakeidx package  937
    +href="glossaries-user.html#dx1-29024" >939
    index package  938
    +href="glossaries-user.html#dx1-29023" >940
    inputenc package  939, 940, 941, 942, 943, 944, 945
    +href="glossaries-user.html#dx1-11016" >941, 942, 943, 944, 945, 946, 947
    internal fields:
         location  946
    +href="glossaries-user.html#dx1-5010" >948

    L latex  947, 948
    +href="glossaries-user.html#dx1-29" >949, 950
    latexmk  949, 950, 951
    +href="glossaries-user.html#dx1-16020" >951, 952, 953
    Latin alphabet  952, 953, 954
    +class="cmbx-10">954, 955, 956
    Latin character  955, 956, 957, 958, 957, 958, 959, 960, 959, 960, 961
    +class="cmbx-10">961, 962, 963
    link text  962, 963, 964, 965, 966, 967, 968, 969, 970, 971, 972, 973, 974, 975, 976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010
    +class="cmbx-10">964, 965, 966, 967, 968, 969, 970, 971, 972, 973, 974, 975, 976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012
    \loadglsentries  1011
    +class="cmti-10">1013
    location list  see number list
    \longnewglossaryentry  1013
    +class="cmti-10">1015
    \longprovideglossaryentry  1014
    +class="cmti-10">1016
    longtable package  1015, 1016
    +href="glossaries-user.html#dx1-25035" >1017, 1018

    M makeglossaries  1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097
    +class="cmbx-10">1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099
        -d  1098
    +href="glossaries-user.html#dx1-18004" >1100
        -k  1099
    +href="glossaries-user.html#dx1-17015" >1101
        -m  1100
    +href="glossaries-user.html#dx1-17023" >1102
        -Q  1101
    +href="glossaries-user.html#dx1-17014" >1103
        -q  1102
    +href="glossaries-user.html#dx1-17017" >1104
        -x  1103
    +href="glossaries-user.html#dx1-17025" >1105
    \makeglossaries  1104
    +class="cmti-10">1106
    makeglossaries-lite  1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121
    +class="cmbx-10">1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123
    makeglossariesgui  1122, 1123, 1124
    +class="cmbx-10">1124, 1125, 1126
    makeidx package  1125
    +href="glossaries-user.html#dx1-29022" >1127
    makeindex  1126, 1127, 1128, 1128, 1129, 1130, 1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 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
    +class="cmbx-10">1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 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
        -g  1239, 1240, 1241
    +href="glossaries-user.html#dx1-7014" >1241, 1242, 1243
        -l  1242, 1243, 1244, 1245, 1246
    +href="glossaries-user.html#dx1-7029" >1244, 1245, 1246, 1247, 1248
    \makenoidxglossaries  1247
    +class="cmti-10">1249
    memoir class  1248, 1249, 1250, 1251
    +href="glossaries-user.html#dx1-24021" >1250, 1251, 1252, 1253
    mfirstuc package  1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259
    +href="glossaries-user.html#dx1-7" >1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261
    multicol package  1260
    +href="glossaries-user.html#dx1-86004" >1262
    mwe package  1261
    +href="glossaries-user.html#dx1-12008" >1263

    N nameref package  1262
    +href="glossaries-user.html#dx1-24049" >1264
    \newacronym  1263
    +class="cmti-10">1265
    \newacronymstyle  1264
    +class="cmti-10">1266
    \newglossary  1265
    +class="cmti-10">1267
    \newglossary*  1266
    +class="cmti-10">1268
    \newglossaryentry  1267
    +class="cmti-10">1269
    \newglossaryentry options
         access  1268
    +href="glossaries-user.html#dx1-94003" >1270
        description  1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286
    +href="glossaries-user.html#dx1-12009" >1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288
        descriptionaccess  1287
    +href="glossaries-user.html#dx1-94017" >1289
        descriptionplural  1288, 1289, 1290, 1291
    +href="glossaries-user.html#dx1-34026" >1290, 1291, 1292, 1293
        descriptionpluralaccess  1292
    +href="glossaries-user.html#dx1-94019" >1294
        entrycounter  1293, 1294
    +href="glossaries-user.html#dx1-63035" >1295, 1296
        first  1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319
    +href="glossaries-user.html#dx1-3020" >1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321
        firstaccess  1320
    +href="glossaries-user.html#dx1-94007" >1322
        firstplural  1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338
    +href="glossaries-user.html#dx1-3021" >1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340
        firstpluralaccess  1339
    +href="glossaries-user.html#dx1-94011" >1341
        format  1340
    +href="glossaries-user.html#dx1-54068" >1342
        long  1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353
    +href="glossaries-user.html#dx1-23108" >1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355
        longaccess  1354
    +href="glossaries-user.html#dx1-94021" >1356
        longplural  1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365
    +href="glossaries-user.html#dx1-15007" >1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367
        longpluralaccess  1366
    +href="glossaries-user.html#dx1-94027" >1368
        name  1367, 1368, 1369, 1370, 1371, 1372, 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
    +href="glossaries-user.html#dx1-12006" >1369, 1370, 1371, 1372, 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
        nonumberlist  1403
    +href="glossaries-user.html#dx1-34107" >1405
        parent  1404, 1405, 1406, 1407
    +href="glossaries-user.html#dx1-34013" >1406, 1407, 1408, 1409
        plural  1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424
    +href="glossaries-user.html#dx1-15006" >1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426
        pluralaccess  1425
    +href="glossaries-user.html#dx1-94009" >1427
        prefix  1426, 1427, 1428, 1429, 1430, 1431, 1432
    +href="glossaries-user.html#dx1-93003" >1428, 1429, 1430, 1431, 1432, 1433, 1434
        prefixfirst  1433, 1434, 1435, 1436, 1437
    +href="glossaries-user.html#dx1-93007" >1435, 1436, 1437, 1438, 1439
        prefixfirstplural  1438, 1439, 1440, 1441, 1442
    +href="glossaries-user.html#dx1-93010" >1440, 1441, 1442, 1443, 1444
        prefixplural  1443, 1444, 1445, 1446, 1447, 1448
    +href="glossaries-user.html#dx1-93005" >1445, 1446, 1447, 1448, 1449, 1450
        see  1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467
    +href="glossaries-user.html#dx1-23018" >1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469
        short  1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478
    +href="glossaries-user.html#dx1-34130" >1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480
        shortaccess  1479
    +href="glossaries-user.html#dx1-94024" >1481
        shortplural  1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491
    +href="glossaries-user.html#dx1-15008" >1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493
        shortpluralaccess  1492
    +href="glossaries-user.html#dx1-94030" >1494
        sort  1493, 1494, 1495, 1496, 1497, 1498, 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
    +href="glossaries-user.html#dx1-3050" >1495, 1496, 1497, 1498, 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
        subentrycounter  1527
    +href="glossaries-user.html#dx1-63036" >1529
        symbol  1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537, 1538, 1539, 1540
    +href="glossaries-user.html#dx1-12004" >1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542
        symbolaccess  1541
    +href="glossaries-user.html#dx1-94013" >1543
        symbolplural  1542, 1543, 1544
    +href="glossaries-user.html#dx1-34065" >1544, 1545, 1546
        symbolpluralaccess  1545
    +href="glossaries-user.html#dx1-94015" >1547
        text  1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566
    +href="glossaries-user.html#dx1-34028" >1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568
        textaccess  1567
    +href="glossaries-user.html#dx1-94005" >1569
        type  1568, 1569, 1570
    +href="glossaries-user.html#dx1-34097" >1570, 1571, 1572
        user1  1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581
    +href="glossaries-user.html#dx1-12007" >1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583
        user2  1582, 1583, 1584, 1585
    +href="glossaries-user.html#dx1-34101" >1584, 1585, 1586, 1587
        user3  1586, 1587, 1588
    +href="glossaries-user.html#dx1-34102" >1588, 1589, 1590
        user4  1589, 1590, 1591
    +href="glossaries-user.html#dx1-34103" >1591, 1592, 1593
        user5  1592, 1593, 1594
    +href="glossaries-user.html#dx1-34104" >1594, 1595, 1596
        user6  1595, 1596, 1597, 1598
    +href="glossaries-user.html#dx1-34100" >1597, 1598, 1599, 1600
    \newglossarystyle  1599
    +class="cmti-10">1601
    \newignoredglossary  1600
    +class="cmti-10">1602
    \newterm  1601
    +class="cmti-10">1603
    ngerman package  1602, 1603, 1604, 1605
    +href="glossaries-user.html#dx1-13031" >1604, 1605, 1606, 1607
    \noist  1606
    +class="cmti-10">1608
    Non-Latin Alphabet  1607
    +class="cmbx-10">1609
    non-Latin character  1608, 1609, 1610, 1611, 1610, 1611, 1612, 1613, 1614, 1615, 1616, 1617, 1618
    +class="cmbx-10">1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619, 1620
    \nopostdesc  1619
    +class="cmti-10">1621
    number list  1620, 1621, 1622, 1623, 1624, 1625, 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
    +class="cmbx-10">1622, 1623, 1624, 1625, 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

    O \oldacronym  1687
    +class="cmti-10">1689

    P package options:
         acronym  1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711
    +href="glossaries-user.html#dx1-14026" >1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713
            true  1712, 1713
    +href="glossaries-user.html#dx1-22002" >1714, 1715
        acronymlists  1714, 1715, 1716, 1717, 1718, 1719, 1720
    +href="glossaries-user.html#dx1-27019" >1716, 1717, 1718, 1719, 1720, 1721, 1722
        acronyms  1721, 1722
    +href="glossaries-user.html#dx1-23028" >1723, 1724
        automake  1723, 1724, 1725, 1726
    +href="glossaries-user.html#dx1-7006" >1725, 1726, 1727, 1728
            false  1727
    +href="glossaries-user.html#dx1-26090" >1729
        compatible-2.07  1728, 1729, 1730
    +href="glossaries-user.html#dx1-29029" >1730, 1731, 1732
        compatible-3.07  1731, 1732, 1733
    +href="glossaries-user.html#dx1-27004" >1733, 1734, 1735
        counter  1734, 1735, 1736, 1737, 1738
    +href="glossaries-user.html#dx1-25086" >1736, 1737, 1738, 1739, 1740
            page  1739
    +href="glossaries-user.html#dx1-25087" >1741
        counterwithin  1740, 1741, 1742, 1743, 1744
    +href="glossaries-user.html#dx1-25010" >1742, 1743, 1744, 1745, 1746
        debug  1745, 1746, 1747
    +href="glossaries-user.html#dx1-23008" >1747, 1748, 1749
            false  1748
    +href="glossaries-user.html#dx1-23009" >1750
            showtargets  1749, 1750, 1751
    +href="glossaries-user.html#dx1-23004" >1751, 1752, 1753
            true  1752, 1753, 1754
    +href="glossaries-user.html#dx1-23003" >1754, 1755, 1756
        description  1755, 1756, 1757, 1758, 1759, 1760, 1761, 1762, 1763
    +href="glossaries-user.html#dx1-28002" >1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1765
        dua  1764, 1765
    +href="glossaries-user.html#dx1-28011" >1766, 1767
        entrycounter  1766, 1767, 1768, 1769, 1770
    +href="glossaries-user.html#dx1-25001" >1768, 1769, 1770, 1771, 1772
            false  1771
    +href="glossaries-user.html#dx1-25002" >1773
            true  1772
    +href="glossaries-user.html#dx1-25011" >1774
        esclocations  1773
    +href="glossaries-user.html#dx1-25059" >1775
            false  1774, 1775
    +href="glossaries-user.html#dx1-25062" >1776, 1777, 1778
            true  1776
    +href="glossaries-user.html#dx1-25060" >1779
        footnote  1777, 1778, 1779, 1780, 1781, 1782
    +href="glossaries-user.html#dx1-28006" >1780, 1781, 1782, 1783, 1784, 1785
        hyperfirst  1783, 1784, 1785, 1786
    +href="glossaries-user.html#dx1-23088" >1786, 1787, 1788, 1789
            false  1787, 1788, 1789, 1790, 1791
    +href="glossaries-user.html#dx1-23102" >1790, 1791, 1792, 1793, 1794
            true  1792, 1793
    +href="glossaries-user.html#dx1-23089" >1795, 1796
        index  1794, 1795, 1796, 1797, 1798
    +href="glossaries-user.html#dx1-23031" >1797, 1798, 1799, 1800, 1801
        indexonlyfirst  1799, 1800, 1801
    +href="glossaries-user.html#dx1-23112" >1802, 1803, 1804
            false  1802
    +href="glossaries-user.html#dx1-23113" >1805
        makeindex  1803, 1804, 1805
    +href="glossaries-user.html#dx1-22004" >1806, 1807, 1808
        ngerman  1806
    +href="glossaries-user.html#dx1-13034" >1809
        nogroupskip  1807, 1808, 1809, 1810, 1811, 1812, 1813, 1814
    +href="glossaries-user.html#dx1-11018" >1810, 1811, 1812, 1813, 1814, 1815, 1816, 1817
            false  1815
    +href="glossaries-user.html#dx1-25092" >1818
        nohypertypes  1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823, 1824
    +href="glossaries-user.html#dx1-23084" >1819, 1820, 1821, 1822, 1823, 1824, 1825, 1826, 1827
            index  1825
    +href="glossaries-user.html#dx1-29026" >1828
        nolangwarn  1826, 1827
    +href="glossaries-user.html#dx1-4" >1829, 1830
        nolist  1828, 1829, 1830
    +href="glossaries-user.html#dx1-25041" >1831, 1832, 1833
        nolong  1831, 1832, 1833, 1834
    +href="glossaries-user.html#dx1-25033" >1834, 1835, 1836, 1837
        nomain  1835, 1836, 1837, 1838, 1839, 1840, 1841, 1842
    +href="glossaries-user.html#dx1-23026" >1838, 1839, 1840, 1841, 1842, 1843, 1844, 1845
        nonumberlist  1843, 1844, 1845, 1846, 1847, 1848, 1849, 1850, 1851, 1852
    +href="glossaries-user.html#dx1-3048" >1846, 1847, 1848, 1849, 1850, 1851, 1852, 1853, 1854, 1855
        nopostdot  1853, 1854
    +href="glossaries-user.html#dx1-25089" >1856, 1857
            false  1855
    +href="glossaries-user.html#dx1-25090" >1858
        noredefwarn  1856
    +href="glossaries-user.html#dx1-23006" >1859
        nostyles  1857, 1858, 1859, 1860, 1861, 1862, 1863
    +href="glossaries-user.html#dx1-25053" >1860, 1861, 1862, 1863, 1864, 1865, 1866
        nosuper  1864, 1865, 1866, 1867
    +href="glossaries-user.html#dx1-25037" >1867, 1868, 1869, 1870
        notranslate  1868, 1869, 1870
    +href="glossaries-user.html#dx1-14010" >1871, 1872, 1873
        notree  1871, 1872, 1873, 1874
    +href="glossaries-user.html#dx1-25047" >1874, 1875, 1876, 1877
        nowarn  1875, 1876, 1877
    +href="glossaries-user.html#dx1-23001" >1878, 1879, 1880
        numberedsection  1878, 1879, 1880, 1881, 1882
    +href="glossaries-user.html#dx1-24035" >1881, 1882, 1883, 1884, 1885
            autolabel  1883, 1884
    +href="glossaries-user.html#dx1-24039" >1886, 1887
            false  1885
    +href="glossaries-user.html#dx1-24037" >1888
            nameref  1886
    +href="glossaries-user.html#dx1-24045" >1889
            nolabel  1887
    +href="glossaries-user.html#dx1-24038" >1890
        numberline  1888, 1889
    +href="glossaries-user.html#dx1-24004" >1891, 1892
        numbers  1890, 1891, 1892
    +href="glossaries-user.html#dx1-23030" >1893, 1894, 1895
        order  1893, 1894, 1895
    +href="glossaries-user.html#dx1-26047" >1896, 1897, 1898
            letter  1896, 1897, 1898, 1899, 1900
    +href="glossaries-user.html#dx1-7034" >1899, 1900, 1901, 1902, 1903
            word  1901, 1902, 1903
    +href="glossaries-user.html#dx1-11060" >1904, 1905, 1906
        record  1904
    +href="glossaries-user.html#dx1-13010" >1907
        sanitizesort  1905, 1906, 1907
    +href="glossaries-user.html#dx1-5006" >1908, 1909, 1910
            false  1908, 1909, 1910, 1911, 1912, 1913
    +href="glossaries-user.html#dx1-6001" >1911, 1912, 1913, 1914, 1915, 1916
            true  1914, 1915, 1916, 1917, 1918, 1919, 1920, 1921, 1922
    +href="glossaries-user.html#dx1-6003" >1917, 1918, 1919, 1920, 1921, 1922, 1923, 1924, 1925
        savenumberlist  1923, 1924
    +href="glossaries-user.html#dx1-23118" >1926, 1927
            false  1925
    +href="glossaries-user.html#dx1-23120" >1928
        savewrites  1926, 1927, 1928
    +href="glossaries-user.html#dx1-23040" >1929, 1930, 1931
            false  1929
    +href="glossaries-user.html#dx1-23041" >1932
        section  1930, 1931
    +href="glossaries-user.html#dx1-24011" >1933, 1934
        seeautonumberlist  1932, 1933, 1934, 1935
    +href="glossaries-user.html#dx1-25077" >1935, 1936, 1937, 1938
        seenoindex  1936, 1937
    +href="glossaries-user.html#dx1-23021" >1939, 1940
            ignore  1938
    +href="glossaries-user.html#dx1-23025" >1941
            warn  1939
    +href="glossaries-user.html#dx1-23024" >1942
        shortcuts  1940, 1941
    +href="glossaries-user.html#dx1-27026" >1943, 1944
        smallcaps  1942, 1943, 1944, 1945, 1946, 1947
    +href="glossaries-user.html#dx1-28004" >1945, 1946, 1947, 1948, 1949, 1950
        smaller  1948, 1949, 1950, 1951, 1952
    +href="glossaries-user.html#dx1-28005" >1951, 1952, 1953, 1954, 1955
        sort  1953
    +href="glossaries-user.html#dx1-26001" >1956
            def  1954, 1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964
    +href="glossaries-user.html#dx1-6006" >1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965, 1966, 1967
            none  1965, 1966, 1967, 1968
    +href="glossaries-user.html#dx1-5009" >1968, 1969, 1970, 1971
            standard  1969, 1970, 1971
    +href="glossaries-user.html#dx1-26006" >1972, 1973, 1974
            use  1972, 1973, 1974, 1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982
    +href="glossaries-user.html#dx1-6005" >1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985
        style  1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990
    +href="glossaries-user.html#dx1-25025" >1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993
            index  1991
    +href="glossaries-user.html#dx1-25028" >1994
            list  1992
    +href="glossaries-user.html#dx1-25026" >1995
        subentrycounter  1993, 1994, 1995, 1996, 1997, 1998
    +href="glossaries-user.html#dx1-25019" >1996, 1997, 1998, 1999, 2000, 2001
            false  1999
    +href="glossaries-user.html#dx1-25020" >2002
        symbols  2000, 2001, 2002
    +href="glossaries-user.html#dx1-23029" >2003, 2004, 2005
        toc  2003, 2004, 2005, 2006, 2007, 2008
    +href="glossaries-user.html#dx1-7038" >2006, 2007, 2008, 2009, 2010, 2011
        translate  2009, 2010, 2011, 2012
    +href="glossaries-user.html#dx1-23051" >2012, 2013, 2014, 2015
            babel  2013, 2014, 2015, 2016, 2017, 2018
    +href="glossaries-user.html#dx1-14012" >2016, 2017, 2018, 2019, 2020, 2021
            false  2019, 2020, 2021, 2022
    +href="glossaries-user.html#dx1-14011" >2022, 2023, 2024, 2025
            true  2023, 2024, 2025, 2026
    +href="glossaries-user.html#dx1-23052" >2026, 2027, 2028, 2029
        ucfirst  2027
    +href="glossaries-user.html#dx1-24032" >2030
        ucmark  2028, 2029
    +href="glossaries-user.html#dx1-24017" >2031, 2032
            false  2030
    +href="glossaries-user.html#dx1-24020" >2033
            true  2031
    +href="glossaries-user.html#dx1-24022" >2034
        xindy  2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045
    +href="glossaries-user.html#dx1-8015" >2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048
        xindygloss  2046, 2047
    +href="glossaries-user.html#dx1-26072" >2049, 2050
        xindynoglsnumbers  2048, 2049
    +href="glossaries-user.html#dx1-26076" >2051, 2052
    page (counter)  2050, 2051
    +href="glossaries-user.html#dx1-66036" >2053, 2054
    page type precedence  2052
    +href="glossaries-user.html#dx1-53005" >2055
    pdflatex  2053, 2054
    +href="glossaries-user.html#dx1-28" >2056, 2057
    \PGLS  2055
    +class="cmti-10">2058
    \Pgls  2056
    +class="cmti-10">2059
    \pgls  2057
    +class="cmti-10">2060
    \PGLSpl  2058
    +class="cmti-10">2061
    \Pglspl  2059
    +class="cmti-10">2062
    \pglspl  2060
    +class="cmti-10">2063
    pod2man  2061
    +href="glossaries-user.html#dx1-17036" >2064
    polyglossia package  2062, 2063, 2064, 2065, 2066, 2067, 2068
    +href="glossaries-user.html#dx1-14002" >2065, 2066, 2067, 2068, 2069, 2070, 2071
    \printacronyms  2069
    +class="cmti-10">2072
    \printglossaries  2070
    +class="cmti-10">2073
    \printglossary  2071
    +class="cmti-10">2074
    \printglossary options
         entrycounter  2072
    +href="glossaries-user.html#dx1-63032" >2075
        nogroupskip  2073
    +href="glossaries-user.html#dx1-63030" >2076
        nonumberlist  2074
    +href="glossaries-user.html#dx1-63029" >2077
        nopostdot  2075
    +href="glossaries-user.html#dx1-63031" >2078
        numberedsection  2076
    +href="glossaries-user.html#dx1-63026" >2079
        style  2077, 2078, 2079, 2080, 2081
    +href="glossaries-user.html#dx1-25057" >2080, 2081, 2082, 2083, 2084
        subentrycounter  2082
    +href="glossaries-user.html#dx1-63034" >2085
        title  2083, 2084, 2085, 2086, 2087
    +href="glossaries-user.html#dx1-5" >2086, 2087, 2088, 2089, 2090
        toctitle  2088
    +href="glossaries-user.html#dx1-63020" >2091
        type  2089, 2090
    +href="glossaries-user.html#dx1-63016" >2092, 2093
    \printindex  2091
    +class="cmti-10">2094
    \printnoidxglossaries  2092
    +class="cmti-10">2095
    \printnoidxglossary  2093
    +class="cmti-10">2096
    \printnoidxglossary options
         sort  2094, 2095, 2096, 2097
    +href="glossaries-user.html#dx1-26002" >2097, 2098, 2099, 2100
    \printnumbers  2098
    +class="cmti-10">2101
    \printsymbols  2099
    +class="cmti-10">2102
    \provideglossaryentry  2100
    +class="cmti-10">2103

    R relsize package  2101, 2102
    +href="glossaries-user.html#dx1-28019" >2104, 2105

    S sanitize  2103, 2104, 2105, 2106, 2107
    +class="cmbx-10">2106, 2107, 2108, 2109, 2110
    scrwfile package  2108
    +href="glossaries-user.html#dx1-23044" >2111
    \SetAcronymLists  2109
    +class="cmti-10">2112
    \setacronymstyle  2110
    +class="cmti-10">2113
    \setglossarypreamble  2111
    +class="cmti-10">2114
    \setglossarysection  2112
    +class="cmti-10">2115
    \setglossarystyle  2113
    +class="cmti-10">2116
    \setStyleFile  2114
    +class="cmti-10">2117
    \setupglossaries  2115
    +class="cmti-10">2118
    stix package  2116
    +href="glossaries-user.html#dx1-66035" >2119
    \subglossentry  2117
    +class="cmti-10">2120
    supertabular package  2118, 2119, 2120
    +href="glossaries-user.html#dx1-25039" >2121, 2122, 2123

    T tabularx package  2121, 2122, 2123, 2124
    +href="glossaries-user.html#dx1-55005" >2124, 2125, 2126, 2127
    textcase package  2125, 2126, 2127
    +href="glossaries-user.html#dx1-10" >2128, 2129, 2130
    theglossary (environment)  2128
    +class="cmti-10">2131
    tracklang package  2129, 2130, 2131
    +href="glossaries-user.html#dx1-6" >2132, 2133, 2134
    translator package  2132, 2133, 2134, 2135, 2136, 2137, 2138, 2139, 2140, 2141, 2142, 2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156
    +href="glossaries-user.html#dx1-14009" >2135, 2136, 2137, 2138, 2139, 2140, 2141, 2142, 2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159

    X xfor package  2157
    +href="glossaries-user.html#dx1-11" >2160
    xindy  2158, 2159, 2160, 2161, 2162, 2163, 2161, 2162, 2163, 2164, 2165, 2166, 2167, 2168, 2169, 2170, 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
    +class="cmbx-10">2164, 2165, 2166, 2167, 2168, 2169, 2170, 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
        -C  2313, 2314, 2315, 2316, 2317
    +href="glossaries-user.html#dx1-8025" >2316, 2317, 2318, 2319, 2320
        -I  2318, 2319
    +href="glossaries-user.html#dx1-19007" >2321, 2322
        -L  2320, 2321, 2322, 2323
    +href="glossaries-user.html#dx1-8024" >2323, 2324, 2325, 2326
        -M  2324
    +href="glossaries-user.html#dx1-16087" >2327
    xkeyval package  2325, 2326, 2327
    +href="glossaries-user.html#dx1-9" >2328, 2329, 2330
    xspace package  2328, 2329, 2330, 2331, 2332, 2333, 2334
    +href="glossaries-user.html#dx1-74014" >2331, 2332, 2333, 2334, 2335, 2336, 2337

    -

    1.1That is, if the term has been referenced using any of the commands described in commands such as \acrshort.

    -

    1.2Except for Klingon, which is supported by xindy, but not by the CLDR.

    -

    1.3Note that although I’ve written latex the reasons given earlier.

    -

    1.4deprecated, use babel instead

    -

    1.5Added to version makeglossaries 2.18.

    -

    1.6As from v3.01 \gls is no longer fragile and doesn’t need protecting.

    -

    1.7The batch file makeglossaries.bat  distributions for Windows class="cmr-8">provide makeglossaries.exe.

    -

    2.1bug fix in v4.16 has corrected the code to ensure this.

    -

    2.2unless memoirmemoiris loaded, which case it uses \markboth

    -

    2.3Actually it uses \mfirstucMakeUppercasepackage 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 described in §3 Setting Up

    -

    11.2see \glsSetAlphaCompositor described in §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 68f9a92e7c8..bed85c25ecd 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 58e8b5c263e..21cad036a5d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -448,11 +448,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.39} + \title{User Manual for glossaries.sty v4.40} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2018-05-23} + \date{2018-06-01} \maketitle \begin{abstract} @@ -499,6 +499,12 @@ or (for Linux users) \href{http://tex.stackexchange.com/questions/14925/updating-tex-on-linux}{Updating \TeX\ on Linux}. +Note that occasionally you may find that certain packages need to be +loaded \emph{after} packages that are required by \styfmt{glossaries}. For +example, a package \meta{X} might need to be loaded after \sty{amsgen}. In +which case, load the required package first (for example, +\sty{amsgen}), then \meta{X}, and finally load \styfmt{glossaries}. + \begin{important} Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or notation. People have their own preferences and @@ -537,7 +543,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.39}. +\qt{Documented Code for glossaries v4.40}. \item[INSTALL] Installation instructions. @@ -1755,8 +1761,7 @@ See \sectionref{sec:xindyloc} for further details. \exitem{xdy3} This document is like \samplefile{xdy} but uses the command \cs{Numberstring} from the \sty{fmtcount} package to -format the page numbers. This requires at least version 3.03 of -\sty{fmtcount} to work correctly. +format the page numbers. \exitem{utf8} This is another example that uses \gls{xindy}. Unlike \gls{makeindex}, @@ -2839,7 +2844,7 @@ resulting file onto the man path. Alternatively do \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -4.39. +4.40. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -3776,7 +3781,8 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the \end{verbatim} \item[\pkgopt{esclocations}] This is a boolean option. (The default -is \pkgopt[true]{esclocations}.) Both \gls{makeindex} and \gls{xindy} +is \pkgopt[true]{esclocations}, but \ics{makenoidxglossaries} +changes it to \pkgopt[false]{esclocations}.) Both \gls{makeindex} and \gls{xindy} are fussy about the location formats (\gls{makeindex} more so than \gls{xindy}) so the \styfmt{glossaries} package tries to ensure that special characters are escaped and allows for the location to be @@ -3789,7 +3795,8 @@ If you're sure that your locations will always expand to an acceptable format (or you're prepared to post-process the glossary file before passing it to the relevant indexing application) then use \pkgopt[false]{esclocations} to avoid the complex escaping -of location values. +of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented +code for further details.) \item[\pkgopt{nonumberlist}] This option will suppress the associated \glspl{numberlist} in the glossaries (see also @@ -8753,7 +8760,36 @@ routine. A more recent change to \sty{fmtcount} (v3.03) now puts three instances of \cs{expandafter} before \verb|\the\value| which no longer hides \cs{c@page} from the location escaping mechanism, so -the page numbers should once more be correct. The sample file +the page numbers should once more be correct. Further changes +to the \sty{fmtcount} package may cause a problem again. + +\begin{important} +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. +\end{important} + +Instead of directly using \cs{Numberstring} in the definition of +\cs{thepage}, I can provide a custom command in the same form +as the earlier \cs{tally} command: +\begin{verbatim} +\newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}} +\newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}} +\end{verbatim} +This ensures that the location will always be written to +the indexing file in the form: +\begin{alltt} +:locref "\glsopenbrace\glsclosebrace\glsopenbrace\string\\customfmtnum \marg{n}\glsclosebrace" +\end{alltt} +So the location class can be defined as: +\begin{verbatim} +\GlsAddXdyLocation{customfmt}{ + :sep "\string\customfmtnum\space\glsopenbrace" + "arabic-numbers" + :sep "\glsclosebrace"} +\end{verbatim} + +The sample file \samplefile{xdy3} illustrates this. \end{example} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index ea9e0762cbf..8933ab09d4e 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.39: a guide for +class="cmr-17">The glossaries package v4.40: a guide for beginners

    @@ -268,7 +268,7 @@ class="td11"> Nicola L.C. Talbot

    2018-05-23

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

    @@ -422,7 +422,13 @@ class="cmtt-10">.log file and search for the line that starts with Package: glossaries followed by a date and version.) -

    Abbreviations are slightly different if you use the extension package

    Be careful of fragile commands. If a command causes a problem when used in one +of the \newglossaryentry fields, consider adding \glsnoexpandfields before you +start defining your entries.
    +

    +

    Abbreviations are slightly different if you use the extension package glossaries-extra (which needs to be installed separately): @@ -439,7 +445,7 @@ class="cmss-10">glossaries-extra First use: \gls{svm}. Second use: \gls{svm}.  
     \end{document}

    -

    If you still want to use

    If you still want to use \newacronym (rather than \newabbreviation) then you need the optional argument of \setabbreviationstyle:  
     First use: \gls{svm}. Second use: \gls{svm}.  
     \end{document}

    -

    -

    You can’t use

    +

    You can’t use \setacronymstyle with glossaries-extra.
    -

    -

    If you like, you can put all your definitions in another file (for example, +

    +

    If you like, you can put all your definitions in another file (for example, defns.tex) and load that file in the preamble using \loadglsentries with the @@ -475,7 +481,7 @@ filename as the argument. For example:

    \loadglsentries{defns}
    -

    If you find you have a really large number of definitions that are hard to manage in a +

    If you find you have a really large number of definitions that are hard to manage in a .tex file, you might want to have a look at bib2glsbib2gls.bib format instead that can be managed by an application such as JabRef. -

    Don’t try inserting formatting commands into the definitions as they can interfere +

    Don’t try inserting formatting commands into the definitions as they can interfere with the underlying mechanism. Instead, the formatting should be done by the style. For example, suppose I want to replace SVM with  First use: \gls{svm}. Second use: \gls{svm}.  
     \end{document}

    -

    The abbreviation styles have a different naming scheme with

    The abbreviation styles have a different naming scheme with glossaries-extra: @@ -521,7 +527,7 @@ class="cmss-10">glossaries-extra First use: \gls{svm}. Second use: \gls{svm}.  
     \end{document}

    -

    With

    With glossaries-extra you can have multiple abbreviation styles for different categories. Many of these styles have their own associated formatting commands that @@ -556,22 +562,22 @@ can be redefined for minor adjustments. For example:  
     Next use: \gls{svm}, \gls{cbot}.  
     \end{document}

    -

    This produces: +

    This produces:

    -

    First use: support vector machine (

    First use: support vector machine (svm), Clostridium botulinum. -

    Next use:

    Next use: svm, C. botulinum.

    -

    As you can hopefully see from the above examples, there are two main ways of +

    As you can hopefully see from the above examples, there are two main ways of defining a term: as a general entry (\newglossaryentry) or as an abbreviation (\newacronym or, with glossaries-extra, \newabbreviation). -

    Regardless of the method of defining a term, the term is always given a label. In +

    Regardless of the method of defining a term, the term is always given a label. In @@ -608,7 +614,7 @@ class="cmss-10">inputenc (for example, é or ß) or things will go horribly wrong. This warning only applies to the label. It doesn’t apply to the text that appears in the document. -

    Don’t use

    Don’t use \gls in chapter or section headings as it can have some unpleasant side-effects. Instead use \glsentrytext for regular entries and one of \glsfmtshort class="cmtt-10">{⟨label⟩}.
    -

    -

    The above examples are reasonably straightforward. The difficulty comes if you +

    +

    The above examples are reasonably straightforward. The difficulty comes if you want to display a sorted list of all the entries you have used in the document. The  \printunsrtglossaries % list all entries  
     \end{document}

    -

    However this method doesn’t sort the entries (they’re listed in order of definition) +

    However this method doesn’t sort the entries (they’re listed in order of definition) and it will display all the defined entries, regardless of whether or not you’ve used them all in the document, so “turnip” appears in the glossary even though there’s no \gls{turnip} (or similar) in the document. -

    The

    The sort=none option isn’t essential in this case (there’s no other sort option available for this document), but it prevents the automatic construction of the sort value and so slightly improves the document build time. -

    Note that this example document uses the same command (

    Note that this example document uses the same command (\printunsrtglossaries) that’s used with bib2glsrecord package option and one or more instances of \GlsXtrLoadResources in the preamble (see below). -

    Most users prefer to have an automatically sorted list that only contains entries +

    Most users prefer to have an automatically sorted list that only contains entries that have been used in the document. The glossaries package provides three options: use Tbib2gls (Option 4). -

    The first option (using T

    The first option (using TEX) is the simplest method, as it doesn’t require an external tool, but it’s very inefficient and the sorting is done according to the English alphabet. To use this method, add  \printnoidxglossaries  
     \end{document}

    -

    -

    The

    +

    The \makenoidxglossaries method is very slow, uses an ASCII comparator and often breaks if there are commands in the name key.
    -

    -

    Try this out and run LAT

    +

    Try this out and run LATEX (or pdfLATEX) twice. The first run won’t show the @@ -741,7 +747,7 @@ glossary. It will only appear on the second run. This doesn’t include R glossary because that term hasn’t been used (with commands like \gls{turnip}) in the document. -

    The glossary has a vertical gap between the “carrot” term and the “potato” term. +

    The glossary has a vertical gap between the “carrot” term and the “potato” term. This is because the entries in the glossaries are grouped according to their first letter. If you don’t want this gap, just add nogroupskip \usepackage[nogroupskip]{glossaries}

    -

    or you may want to try out a style that shows the group headings: +

    or you may want to try out a style that shows the group headings: @@ -762,7 +768,7 @@ options:

    \usepackage[style=indexgroup]{glossaries}
    -

    If you try out this example you may also notice that the description is followed by a +

    If you try out this example you may also notice that the description is followed by a full stop (period) and a number. The number is the location in the document where the entry was used (page 1 in this case), so you can lookup the term in the glossary and be directed to the relevant pages. It may be that you don’t want this @@ -777,7 +783,7 @@ option:

    \usepackage[nonumberlist]{glossaries}
    -

    If you don’t like the terminating full stop, you can suppress that with the

    If you don’t like the terminating full stop, you can suppress that with the nopostdot package option: @@ -788,8 +794,8 @@ package option:

    \usepackage[nopostdot]{glossaries}
    -

    -

    If you tried out the previous example with

    +

    If you tried out the previous example with glossaries-extra and \printunsrtglossaries @@ -802,7 +808,7 @@ full stop back with

    \usepackage[nopostdot=false]{glossaries-extra}
    -

    or +

    or @@ -810,14 +816,14 @@ full stop back with

    \usepackage[postdot]{glossaries-extra}
    -

    If you want the number lists then you need to use an indexing option. -

    You may have noticed that I’ve used another command in the above example: +

    If you want the number lists then you need to use an indexing option. +

    You may have noticed that I’ve used another command in the above example: \glspl. This displays the plural form. By default, this is just the singular form with the letter “s” appended, but in the case of “potato” I had to specify the correct plural using the plural key. -

    As I mentioned earlier, using T

    As I mentioned earlier, using TEX to sort the entries is the simplest but least efficient method. If you have a large glossary or if your terms contain non-Latin or extended Latin characters, then you will have a much faster build time if you use @@ -841,25 +847,25 @@ href="#sec:printglossaries">§4 Displaying a List of Entries. -

    The rest of this document briefly describes the main commands provided by the +

    The rest of this document briefly describes the main commands provided by the glossaries package. (Most of these are also available with glossaries-extra but may behave slightly differently.) -

    +

    -

    Top

    2 Defining Terms

    -

    When you use the

    When you use the glossaries package, you need to define glossary entries in the document preamble. These entries could be a word, phrase, abbreviation or symbol. They’re usually accompanied by a description, which could be a short sentence or an in-depth explanation that spans multiple paragraphs. The simplest method of defining an entry is to use: -

    +

    \newglossaryentry{⟨} -

    +

    where ⟨label⟩ is a unique label that identifies this entry. (Don’t include the angle brackets ⟨ ⟩. They just indicate the parts of the code you need to change when you use @@ -898,11 +904,11 @@ class="cmti-10">name⟩ is the word, phrase or symbol you are defining, and ⟨description⟩ is the description to be displayed in the glossary. -

    This command is a “short” command, which means that ⟨

    This command is a “short” command, which means that ⟨description⟩ can’t contain a paragraph break. If you have a long description, you can instead use: -

    +

    \longnewglossaryentry{⟨description⟩}
    -

    -

    Examples: +

    +

    Examples:

    1. Define the term “set” with the label set:  
        description={a collection of objects}  
      }
    -

    +

  • Define the symbol emptyset:  
      description={the empty set}  
    }
    • -

    (This will also need a

    (This will also need a sort key if you use Options 1 or 3, see below.) @@ -982,7 +988,7 @@ class="cmtt-10">fishage:  
      fish species.  
    }

    -

    (The percent character discards the end of line character that would otherwise +

    (The percent character discards the end of line character that would otherwise cause an unwanted space to appear at the start of the description.)

  • é). This first letter must be placed in a g  
      description={select group or class}  
    }
    • -

    or

    +

    or

    \newglossaryentry{elite} @@ -1027,10 +1033,10 @@ class="cmtt-10"> class} class="cmtt-10">}
    -

    (For further details, see the section “UTF-8” of the

    (For further details, see the section “UTF-8” of the mfirstuc user manual.) -

    If you use

    If you use bib2gls with glossaries-extra \usepackage[record]{glossaries-extra}

    -

    and the

    and the .bib file is specified in the resource command. For example, if the .bib file is called \GlsXtrLoadResources[src={entries}]

    -

    You can have a comma-separated list. For example, if you also have entries defined +

    You can have a comma-separated list. For example, if you also have entries defined in the file entries2.bib: @@ -1212,8 +1218,8 @@ class="cmtt-10">entries2.bib:

    \GlsXtrLoadResources[src={entries,entries2.bib}]
    -

    -

    There are other keys you can use when you define an entry. For example, the

    +

    There are other keys you can use when you define an entry. For example, the name key indicates how the term should appear in the list of entries (glossary), but if the term should appear differently when you reference it with label⟩} in the document, you need to use the text key as well. -

    For example: +

    For example: @@ -1236,7 +1242,7 @@ class="cmtt-10">text key as well.  
      a, \ldots, z, A, \ldots, Z}  
    }

    -

    This will appear in the text as “Latin alphabet” but will be listed in the glossary +

    This will appear in the text as “Latin alphabet” but will be listed in the glossary as “Latin Alphabet”. With bib2gls this entry is defined in the   a, \ldots, z, A, \ldots, Z}  
    }

    -

    -

    Another commonly used key is

    +

    Another commonly used key is plural for specifying the plural of the term. This defaults to the value of the text key with an “s” appended, but if this is incorrect, @@ -1273,10 +1279,10 @@ class="cmtt-10">plural key to override it:  
      description={canal from mouth to stomach}  
    }

    -

    (Remember from earlier that the initial ligature

    (Remember from earlier that the initial ligature \oe needs to be grouped.) -

    Abbreviations can be defined using -

    Abbreviations can be defined using +

    \newacronym[⟨options⟩]{⟨short⟩}{⟨long⟩}
    -

    +

    where ⟨label⟩ is the label (as per \newglossaryentry), ⟨long⟩ is the long form. For example, the following

    \newacronym{svm}{SVM}{support vector machine}
    -

    This internally uses

    This internally uses \newglossaryentry to define an entry with the label svm. By default, the  [description={statistical pattern recognition technique}]  
     {svm}{SVM}{support vector machine}

    -

    -

    Before you define your acronyms (or other types of abbreviations), you need to +

    +

    Before you define your acronyms (or other types of abbreviations), you need to specify which style to use with -

    \setacronymstyle{⟨style name⟩}
    -

    +

    where ⟨style name⟩ is the name of the style. There are a number of predefined styles, such as: \textsc to typeset the acronym or that use a footnote on first use. See the main user guide for further details. -

    The

    The glossaries-extra package provides improved abbreviation handling with a lot more predefined styles. With this extension package, abbreviations are defined using: -

    \newabbreviation[⟨options⟩]{⟨short⟩}{⟨long⟩}
    -

    +

    You can still use \newacronym but it’s redefined to use the new abbreviation interface. The style must now be set using: -

    \setabbreviationstyle[⟨category⟩]{⟨style name⟩}
    -

    +

    The default ⟨category⟩ is abbreviation. If you use } class="cmsy-10">}

    -

    The plural forms for abbreviations can be specified using the

    The plural forms for abbreviations can be specified using the longplural and shortplural keys. For example: @@ -1431,7 +1437,7 @@ class="cmtt-10">shortplural keys. For example:  
     [longplural={diagonal matrices}]  
     {dm}{DM}{diagonal matrix}

    -

    or (with

    or (with glossaries-extra): @@ -1443,7 +1449,7 @@ class="cmss-10">glossaries-extra [longplural={diagonal matrices}]  
     {dm}{DM}{diagonal matrix}

    -

    If omitted, the defaults are again obtained by appending an “s” to the singular +

    If omitted, the defaults are again obtained by appending an “s” to the singular versions. With bib2gls, the definition in the .bib file is:  
      longplural={diagonal matrices}  
    }

    -

    -

    It’s also possible to have both a name and a corresponding symbol. +

    +

    It’s also possible to have both a name and a corresponding symbol. Just use the name key for the name and the symbol key for the symbol. For @@ -1477,7 +1483,7 @@ example:  
      description={the set containing no elements}  
    }

    -

    or with

    or with bib2gls the definition in the .bib file is: @@ -1492,8 +1498,8 @@ class="cmtt-10">.bib file is:  
      description={the set containing no elements}  
    }

    -

    -

    If you want the symbol in the

    +

    If you want the symbol in the name field then you must supply a sort value with Options   description={the set containing no elements}  
    }

    -

    This displays the symbol as

    This displays the symbol as ∅ but sorts according to “empty set”. You may want to consider using glossaries-extraglossaries-extrasymbols package option which provides -

    \glsxtrnewsymbol[⟨options⟩]{⟨label⟩}{⟨symbol⟩}
    -

    +

    This internally uses \newglossaryentry but automatically sets the sort key to the @@ -1558,8 +1564,8 @@ class="cmti-10">label⟩. For example:  
    \printglossaries  
    \end{document}

    -

    Now the sort value is “emptyset” rather than the previous “empty set”. -

    With

    Now the sort value is “emptyset” rather than the previous “empty set”. +

    With bib2gls you can define this in the .bib file as @@ -1573,7 +1579,7 @@ class="cmtt-10">.bib file as  
      description={the set containing no elements}  
    }

    -

    in which case

    in which case bib2gls will try to interpret the name field to determine the sort @@ -1588,7 +1594,7 @@ value. Alternatively you can use:  
      description={the set containing no elements}  
    }

    -

    which will use the label (

    which will use the label (emptyset) as the sort value. (You don’t need the symbols @@ -1609,20 +1615,20 @@ now:  
    \printunsrtglossaries  
    \end{document}

    -

    -

    +

    +

    -

    Top

    3 Using Entries

    -

    Once you have defined your entries, as described above, you can reference them in +

    Once you have defined your entries, as described above, you can reference them in your document. There are a number of commands to do this, but the most common one is: -

    \gls{⟨label⟩}
    -

    +

    where ⟨label⟩ is the label you assigned to the entry when you defined it. For example, bib2gls has created the relevant files and LATEX is rerun. -

    If you are using the

    If you are using the hyperref package (remember to load it before glossaries) \gls* for example, \gls*{fishage}. The other commands described in this section all have a similar starred form. -

    If the entry was defined as an acronym (using

    If the entry was defined as an acronym (using \newacronym with glossaries described above) or an abbreviation (using

    If you want the plural form, you can use: -

    If you want the plural form, you can use: +

    \glspl{⟨label⟩}
    -

    +

    instead of \gls{⟨label⟩}. For example, \glspl{set} displays “sets”. -

    If the term appears at the start of a sentence, you can convert the first letter to +

    If the term appears at the start of a sentence, you can convert the first letter to upper case using: -

    \Gls{⟨label⟩}
    -

    +

    for the singular form or -

    \Glspl{⟨label⟩}
    -

    +

    for the plural form. For example: @@ -1704,21 +1710,21 @@ for the plural form. For example:

    \Glspl{set} are collections.
    -

    produces “Sets are collections”. -

    If you’ve specified a symbol using the

    produces “Sets are collections”. +

    If you’ve specified a symbol using the symbol key, you can display it using: -

    \glssymbol{⟨label⟩}
    -

    -

    +

    +

    -

    Top

    4 Displaying a List of Entries

    -

    In

    In §1 Getting Started, I mentioned that there are three options you can @@ -1739,7 +1745,7 @@ build. -

    @@ -1757,7 +1763,7 @@ id="TBL-2-3" />

    OptionOption 4

    Requires +class="td11">

    Requires glossaries-extra?

    ✔

    Requires +class="td11">

    Requires an external application?

    ✔

    Requires +class="td11">

    Requires Perl?

    ✘ ✘

    Requires +class="td11">

    Requires Java?

    ✘ ✔

    Can +class="td11">

    Can sort extended Latin @@ -1845,7 +1851,7 @@ class="td11"> ✔

    Efficient +class="td11">

    Efficient sort algorithm?

    ✔

    Can +class="td11">

    Can use different sort @@ -1876,7 +1882,7 @@ class="td11"> ✔

    Any +class="td11">

    Any problematic sort values?

    ✘

    Can +class="td11">

    Can form ranges in @@ -1907,7 +1913,7 @@ class="td11"> ✔

    Can +class="td11">

    Can have non-standard locations?

    †     ✔
    -

    † Requires some setting up. @@ -1936,7 +1942,7 @@ class="description">Option 1: -

    This is the simplest option but it’s slow and if you want a sorted +

    This is the simplest option but it’s slow and if you want a sorted list, it doesn’t work for non-Latin alphabets. The name mustn’t contain commands (or, if it does, the Defining Terms).

  • Put -

    \printnoidxglossary[sort=⟨order⟩,⟨other options⟩]
    -

    +

    where you want your list of entries to appear. The sort ⟨order⟩ may be one of: case (case-sensitive class="cmtt-10">def (in order of definition) or use (in order of use). Alternatively, use -

    \printnoidxglossaries
    -

    +

    to display all your glossaries (if you have more than one). This command doesn’t have any arguments. -

    This option allows you to have different sort methods. For example: +

    This option allows you to have different sort methods. For example: @@ -1990,7 +1996,7 @@ class="cmtt-10">\printnoidxglossaries

    \printnoidxglossary[sort=word]% main glossary  
    \printnoidxglossary[type=symbols,sort=use]% symbols glossary
    -

    +

  • Run LATEX twice on your document. (As you would d of contents appear.) For example, click twice on the “typeset” or “build” or “PDFLATEX” button in your editor.
    • -

    Here’s a complete document (

    Here’s a complete document (myDoc.tex): @@ -2015,7 +2021,7 @@ class="cmtt-10">myDoc.tex):  
    \printnoidxglossaries % iterate over all indexed entries  
    \end{document}

    -

    Document build: +

    Document build: @@ -2024,14 +2030,14 @@ class="cmtt-10">myDoc.tex): pdflatex myDoc  
    pdflatex myDoc

    -

    +

    Option 2: -

    This option uses an application called

    This option uses an application called makeindex to sort the entries. This application comes with all modern T\GlsSetQuote to change this to some other character.

    \GlsSetQuote{+}
    -

    Use this as soon as possible after you’ve loaded the

    Use this as soon as possible after you’ve loaded the glossaries package.

    @@ -2083,21 +2089,21 @@ class="cmtt-10">\makeglossaries to your preamble (before you start defini
  • Put -

    \printglossary[⟨options⟩]
    -

    +

    where you want your list of entries (glossary) to appear. (The sort key isn’t available in ⟨options⟩.) Alternatively, use -

    \printglossaries
    -

    +

    which will display all glossaries (if you have more than one). This command doesn’t have any arguments. -

    All glossaries are sorted using the same method which may be identified +

    All glossaries are sorted using the same method which may be identified with one of the package options: sort=standard (default), sort=usesort=def.
    -

    +

  • Run LAT.tex) extension. If you have access to a terminal or a co
    makeglossaries myDoc
    -

    (Replace

    (Replace myDoc with the base name of your LATEX document file without the makeglossaries-lite makeglossaries-lite myDoc

    • -

    -

    Some beginners get confused by

    +

    Some beginners get confused by makeglossaries the application (run as a system command) and EX command which should be typed in the document preamble. These are two different concepts that happen to have similar looking names.
    -

    -

    If you don’t know how to use the command prompt, then you can +

    +

    If you don’t know how to use the command prompt, then you can probably configure your text editor to add makeglossaries (or @@ -2182,8 +2188,8 @@ class="cmss-10">automake \usepackage[automake]{glossaries}

    -

    -

    The default sort is word order (“sea lion” comes before “seal”). If you +

    +

    The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the order=letter package @@ -2195,13 +2201,13 @@ class="cmss-10">order=letter \usepackage[order=letter]{glossaries}

    -

    +

  • Once you have successfully completed the previous step, you can now run LATEX on your document again.
    • -

    Here’s a complete document (

    Here’s a complete document (myDoc.tex): @@ -2218,7 +2224,7 @@ class="cmtt-10">myDoc.tex):  
    \printglossaries % input files created by makeindex  
    \end{document}

    -

    Document build: +

    Document build: @@ -2228,7 +2234,7 @@ class="cmtt-10">myDoc.tex):  
    makeglossaries myDoc  
    pdflatex myDoc

    -

    or +

    or @@ -2238,14 +2244,14 @@ class="cmtt-10">myDoc.tex):  
    makeglossaries-lite myDoc  
    pdflatex myDoc

    -

    +

    Option 3: -

    This option uses an application called

    This option uses an application called xindy to sort the entries. This application is more flexible than glossaries \usepackage[xindy]{glossaries}

    -

    +

  • Add \makeglossaries to your preamble (before you start defini
  • Put -

  • Run LAT.tex extension). If you have access to a terminal or a co
    makeglossaries myDoc
    -

    (Replace

    (Replace myDoc with the base name of your LATEX document file without the .tex extension. Avoid spaces in the file name. If you don class="cmtt-10">makeglossaries as a build tool. -

    The default sort is word order (“sea lion” comes before “seal”). If you +

    The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the order=letter package option: @@ -2371,14 +2377,14 @@ class="cmtt-10">order=letter package

    \usepackage[xindy,order=letter]{glossaries}
    -

    +

  • Once you have successfully completed the previous step, you can now run LATEX on your document again.
    • -

    Here’s a complete document (

    Here’s a complete document (myDoc.tex): @@ -2395,7 +2401,7 @@ class="cmtt-10">myDoc.tex):  
    \printglossaries % input files created by xindy  
    \end{document}

    -

    Document build: +

    Document build: @@ -2405,14 +2411,14 @@ class="cmtt-10">myDoc.tex):  
    makeglossaries myDoc  
    pdflatex myDoc

    -

    +

    Option 4: -

    This requires the extension package

    This requires the extension package glossaries-extra and an application called glossaries-extra \usepackage[record]{glossaries-extra}

    -

    +

  • Add one or more -

    \GlsXtrLoadResources[src={⟨bib list⟩},⟨options⟩]
    -

    +

    to your preamble where ⟨bib list⟩ is the list of .bib files containing the @@ -2496,7 +2502,7 @@ class="cmtt-10">.bib files containing the  
      sort={double}% double-precision sort  
    ]

    -

    The last resource set assumes that the entries defined in the file +

    The last resource set assumes that the entries defined in the file constants.bib have a number stored in the user1 field. For @@ -2512,26 +2518,26 @@ class="cmtt-10">user1 field. For  
      user1={3.141592654}  
    }

    • -

    +

  • Put -

    \printunsrtglossary[type={⟨type⟩},⟨options⟩]
    -

    +

    where you want your list of entries (glossary) to appear. (The sort key isn’t available in ⟨options⟩. It needs to be used in \GlsXtrLoadResources instead.) Alternatively, use -

    \printunsrtglossaries
    -

    +

  • Run LATmyDoc.tex:
    pdflatex myDoc
    -

    +

  • Run bib2gls bib2gls myDoc
    • -

    or (if you need letter groups) +

    or (if you need letter groups) @@ -2570,12 +2576,12 @@ class="cmtt-10">bib2gls bib2gls --group myDoc

    -

    +

  • Run LATEX again.
    • -

    Here’s a complete document (

    Here’s a complete document (myDoc.tex): @@ -2596,7 +2602,7 @@ class="cmtt-10">myDoc.tex):  
    \printunsrtglossaries % iterate over all defined entries  
    \end{document}

    -

    The accompanying

    The accompanying entries.bib file: @@ -2608,7 +2614,7 @@ class="cmtt-10">entries.bib file:  
      description = {an example}  
    }

    -

    Document build: +

    Document build: @@ -2618,10 +2624,10 @@ class="cmtt-10">entries.bib file:  
    bib2gls myDoc  
    pdflatex myDoc

    -

    +

    -

    If you are having difficulty integrating

    If you are having difficulty integrating makeglossaries into your document build process, you may want to consider using myDoc.tex might start with:  
     \usepackage{glossaries}  
     \makeglossaries

    -

    then to build the document you just need the single system call: +

    then to build the document you just need the single system call: @@ -2652,7 +2658,7 @@ class="cmtt-10">myDoc.tex might start with:

     arara myDoc
    -

    (The currently pending version 4.0 of

    (The currently pending version 4.0 of arara has directives for makeglossaries-litemakeglossaries.yaml file and replace makeglossaries as appropriate.) -

    When sorting the entries, the string comparisons are made according to each +

    When sorting the entries, the string comparisons are made according to each entry’s sort key. If this is omitted, the name key is used. For example, recall the @@ -2681,7 +2687,7 @@ earlier definition:  
       description={select group or class}  
     }

    -

    No

    No sort key was used, so it’s set to the same as the name key: {\’e}lite. How this @@ -2746,7 +2752,7 @@ class="cmtt-10">sort value that xindy will accept. -

    xindy merges entries with duplicate sort values. xindyxindyxindy has stripped all commands and braces.
    -

    +

    lite. It disregards unknown class="cmtt-10">bib2gls doesn’t mind that. -

    Note that even if the name is given as

    Note that even if the name is given as {\’e}lite, the letter group heading (if the --group switch is used) may end up with the character É @@ -2791,7 +2797,7 @@ class="E">EX engine with native UTF-8 support.

    -

    If the

    If the inputenc package is used: @@ -2801,7 +2807,7 @@ class="cmss-10">inputenc  \usepackage[utf8]{inputenc}

    -

    and the entry is defined as:

    +

    and the entry is defined as:

      UTF-8
    -

    With the correct encoding set up,

    With the correct encoding set up, bib2gls will determine that the sort value is lite in the group.

    -

    Therefore if you have extended Latin or non-Latin characters, your best option is +

    Therefore if you have extended Latin or non-Latin characters, your best option is to use either xindy (  description={select group or class}  
    }

    -

    or

    +

    or

    \newglossaryentryname key if you don’t set the sort key. -

    If you use

    If you use Option 3 and the name only contains a command or commands (such as   description={paragraph symbol}}

    -

    +

    -

    Top

    5 Customising the Glossary

    -

    The default glossary style uses the

    The default glossary style uses the description environment to display the entry list. @@ -3031,14 +3037,14 @@ class="cmtt-10">\glsnamefont:

    \renewcommand*{\glsnamefont}[1]{\textmd{#1}}
    -

    Some classes and packages redefine the

    Some classes and packages redefine the description environment in such as way that’s incompatible with the glossaries package. In which case you’ll need to select a different glossary style (see below). -

    By default, a full stop is appended to the description (unless you use +

    By default, a full stop is appended to the description (unless you use glossaries-extra). To prevent this from happening use the \usepackage[nopostdot]{glossaries}

    -

    or to add it with

    or to add it with glossaries-extra: @@ -3061,8 +3067,8 @@ class="cmss-10">glossaries-extra:

    \usepackage[postdot]{glossaries-extra}
    -

    -

    By default, a location list is displayed for each entry (unless you use +

    +

    By default, a location list is displayed for each entry (unless you use \printunsrtglossary without bib2gls \usepackage[nonumberlist]{glossaries}

    -

    or with

    or with bib2gls use save-locations=false in the optional argument of the appropriate \GlsXtrLoadResources (it’s possible to have some resource sets with locations and some without). -

    Entries are grouped according to the first letter of each entry’s

    Entries are grouped according to the first letter of each entry’s sort key. By default a vertical gap is placed between letter groups. You can suppress this with the nogroupskip \usepackage[nogroupskip]{glossaries}

    -

    -

    If the default style doesn’t suit your document, you can change the style +

    +

    If the default style doesn’t suit your document, you can change the style using: -

    \setglossarystyle{⟨style name⟩}
    -

    +

    There are a number of predefined styles. Glossaries can vary from a list of symbols with a terse description to a list of words or phrases with descriptions that span @@ -3137,7 +3143,7 @@ a style that suits your document. For example:

    \setglossarystyle{index}
    -

    You can also use the

    You can also use the style package option for the preloaded styles. For example: @@ -3147,8 +3153,8 @@ class="cmss-10">style \usepackage[style=index]{glossaries}

    -

    -

    Examples: +

    +

    Examples:

    1. You have entries where the name is a symbol and the description is a brief @@ -3164,7 +3170,7 @@ class="cmss-10">glossary-mcols\usepackage{glossary-mcols}  
      \setglossarystyle{mcolindex}
    -

    or +

    or @@ -3172,7 +3178,7 @@ class="cmss-10">glossary-mcols \usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra}

    -

    +

  • You have entries where the name is a word or phrase and the description spans @@ -3184,7 +3190,7 @@ class="cmss-10">glossary-mcols\setglossarystyle{altlist}
    • -

    or +

    or @@ -3192,7 +3198,7 @@ class="cmss-10">glossary-mcols \usepackage[stylemods,style=altlist]{glossaries-extra}

    -

    +

  • You have entries where the name is a single word, the description is @@ -3206,7 +3212,7 @@ class="cmss-10">glossary-mcols\setglossarystyle{long4col}
    • -

    or one of the “tree” styles: +

    or one of the “tree” styles: @@ -3215,8 +3221,8 @@ class="cmss-10">glossary-mcols\setglossarystyle{tree}

    -

    -

    If your glossary consists of a list of abbreviations and you also want to specify +

    +

    If your glossary consists of a list of abbreviations and you also want to specify a description as well as the long form, then you need to use an abbreviation style that will suit the glossary style. For example, use the long-short-desc acronym @@ -3228,7 +3234,7 @@ style:

    \setacronymstyle{long-short-desc}
    -

    Define the acronyms with a description: +

    Define the acronyms with a description: @@ -3238,7 +3244,7 @@ style:  
     [description={statistical pattern recognition technique}]  
     {svm}{SVM}{support vector machine}

    -

    Alternatively with

    Alternatively with glossaries-extra: @@ -3251,8 +3257,8 @@ class="cmss-10">glossaries-extra [description={statistical pattern recognition technique}]  
     {svm}{SVM}{support vector machine}

    -

    -

    Choose a glossary style that suits wide entry names. For example: +

    +

    Choose a glossary style that suits wide entry names. For example: @@ -3260,13 +3266,13 @@ class="cmss-10">glossaries-extra \setglossarystyle{altlist}

    -

    -

    +

    +

    -

    Top

    6 Multiple Glossaries

    -

    The

    The glossaries package predefines a default main glossary. When you define an entry @@ -3278,7 +3284,7 @@ automatically assigned to the default glossary, unless you indicate otherwise us type key. However you first need to make sure the desired glossary has been defined. This is done using: -

    \newglossary[⟨glg⟩]{⟨glo⟩}{⟨title⟩}
    -

    +

    The ⟨label⟩ is a label that uniquely identifies this new glossary. As with other types of identifying labels, be careful not to use active characters in ⟨gls⟩ and ⟨glo⟩ arguments are ignored, in which case you may prefer to use the starred version where you don’t specify the extensions: -

    \newglossary*{⟨label⟩}{⟨title⟩}
    -

    -

    In the case of Options 

    +

    In the case of Options 2 or 3, all glossary definitions must come before Option 4, all glossary definitions must come before any \GlsXtrLoadResources that requires them. -

    Since it’s quite common for documents to have both a list of terms and a list of +

    Since it’s quite common for documents to have both a list of terms and a list of abbreviations, the glossaries package provides the package option acronyms \newglossary[alg]{acronym}{acr}{acn}{\acronymname}

    -

    The option also changes the behaviour of

    The option also changes the behaviour of \newacronym so that acronyms are automatically put in the list of acronyms instead of the main glossary. The abbreviations to create a list of abbreviations for \newabbreviation. -

    There are some other package options for creating commonly used lists:

    There are some other package options for creating commonly used lists: symbols (lists of symbols), options⟩]{⟨label⟩}). -

    For example, suppose you want a main glossary for terms, a list of acronyms and +

    For example, suppose you want a main glossary for terms, a list of acronyms and a list of notation: @@ -3387,7 +3393,7 @@ a list of notation:  \usepackage[acronyms]{glossaries}  
     \newglossary[nlg]{notation}{not}{ntn}{Notation}

    -

    After

    After \makeglossaries (or \makenoidxglossaries) you can define the entries in the preamble. For example: @@ -3410,7 +3416,7 @@ the preamble. For example:  
       description={A set},  
       sort={S}}

    -

    or if you don’t like using

    or if you don’t like using \ensuremath: @@ -3425,34 +3431,34 @@ class="cmtt-10">\ensuremath:  
       description={A set},  
       sort={S}}

    -

    -

    Each glossary is displayed using: -

    +

    Each glossary is displayed using: +

    \printnoidxglossary[type=⟨type⟩]
    -

    +

    (Option 1) or -

    \printglossary[type=⟨type⟩]
    -

    +

    (Options 2 and 3). Where ⟨type⟩ is the glossary label. If the type is omitted the default main glossary is assumed. -

    If you’re using

    If you’re using bib2gls then each glossary is displayed using: -

    \printunsrtglossary[type=⟨type⟩]
    -

    +

    With this method you don’t use \makeglossaries or \makenoidxglossaries. @@ -3476,7 +3482,7 @@ Instead you can assign the entry type with the resource command. For example:  
      type={symbols}% put in symbols glossary  
     ]

    -

    Later in the document: +

    Later in the document: @@ -3486,26 +3492,26 @@ Instead you can assign the entry type with the resource command. For example:  
     \printunsrtglossary[type=abbreviations]  
     \printunsrtglossary[type=symbols]

    -

    -

    There’s a convenient shortcut that will display all the defined glossaries +

    +

    There’s a convenient shortcut that will display all the defined glossaries depending on the indexing method: -

    \printnoidxglossaries
    -

    +

    (Option 1) or -

    \printglossaries
    -

    +

    (Options 2 and 3) or (glossaries-extra only) -

    \printunsrtglossaries
    -

    -

    If you use

    +

    If you use Option 1, you don’t need to do anything else. If you use Options 2 or makeindexxindy errors or warnings if things go wrong. -

    For example, suppose you have three glossaries in your document (

    For example, suppose you have three glossaries in your document (main, acronym and notation), specified using: \usepackage[acronyms]{glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}

    -

    Then (assuming your LAT

    Then (assuming your LATEX document is in a file called myDoc.tex): -

    +

    makeglossaries-lite makeglossaries myDoc
    -

    or +

    or @@ -3579,7 +3585,7 @@ class="cmtt-10">makeglossaries-lite makeglossaries-lite myDoc

    -

    Or you need to run

    Or you need to run makeindex three times: @@ -3591,7 +3597,7 @@ class="cmtt-10">makeindexmakeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn  
    makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn

    -

    +

    makeglossaries makeglossaries myDoc
    -

    Or you need to run

    Or you need to run xindy three times (be careful not to insert line breaks where the line has wrapped.) @@ -3620,7 +3626,7 @@ class="cmtt-10">xindyxindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg  
    -o myDoc.not myDoc.ntn

    -

    +

    bib2glsbib2gls --group myDoc  
    pdflatex myDoc
    -

    (Omit

    (Omit --group if you don’t need letter groups.)

    -

    +

    -

    Top

    7 glossaries and hyperref

    -

    Take care if you use the

    Take care if you use the glossaries package with hyperrefhyperref\usepackage{glossaries}

    -

    If you use

    If you use hyperref make sure you use PDFLATEX rather than the LAT

    By default, if the

    By default, if the hyperref package has been loaded, commands like \gls will form a hyperlink to the relevant entry in the glossary. If you to disable this for all your glossaries, then use -

    \glsdisablehyper
    -

    +

    If you want hyperlinks suppressed for entries in specific glossaries, then use the nohypertypes\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}  
    \newglossary[nlg]{notation}{not}{ntn}{Notation}

    -

    -

    If you want the hyperlinks suppressed the first time an entry is used, but you +

    +

    If you want the hyperlinks suppressed the first time an entry is used, but you want hyperlinks for subsequence references then use the hyperfirst=false package @@ -3719,8 +3725,8 @@ option: \usepackage[colorlinks]{hyperref}  
    \usepackage[hyperfirst=false]{glossaries}

    -

    -

    Take care not to use non-expandable commands in PDF bookmarks. This isn’t +

    +

    Take care not to use non-expandable commands in PDF bookmarks. This isn’t specific to the glossaries package but is a limitation of PDF bookmarks. @@ -3741,15 +3747,15 @@ class="cmtt-10">\texorpdfstring. For example:

    \section{The \texorpdfstring{\gls{fishage}}{Fish Age}}
    -

    However, it’s not a good idea to use commands like

    However, it’s not a good idea to use commands like \gls in a section heading as you’ll end up with the table of contents in your location list. Instead you can use -

    \glsentrytext{⟨label⟩}
    -

    +

    This is expandable provided that the text key doesn’t contain non-expandable code. For example, the following works: @@ -3760,8 +3766,8 @@ For example, the following works:

    \section{The \glsentrytext{fishage}}
    -

    and it doesn’t put the table of contents in the location list. -

    If you use

    and it doesn’t put the table of contents in the location list. +

    If you use glossaries-extra then use the commands that are provided specifically for use in section headers. For example: @@ -3772,19 +3778,19 @@ use in section headers. For example:

    \section{The \glsfmttext{fishage}}
    -

    -

    +

    +

    -

    Top

    8 Cross-References

    -

    You can add a reference to another entry in a location list using the

    You can add a reference to another entry in a location list using the see={⟨label list⟩} key when you define an entry. The referenced entry (or entries) must also be defined. -

    For example: +

    For example: @@ -3804,7 +3810,7 @@ defined.  
      see={devonian}  
    }

    -

    The cross-reference will appear as “

    The cross-reference will appear as “see Devonian”. You can change the “see” tag using the format see=[⟨label⟩. For example:  
       other letters such as ligatures or diacritics.}  
    }

    -

    If you use the

    If you use the see key in the optional argument of \newacronym, make sure you enclose the value in braces. For example: @@ -3844,7 +3850,7 @@ enclose the value in braces. For example:  
     [see={[see also]{ksvm}}]  
     {svm}{svm}{support vector machine}

    -

    The

    The glossaries-extra package provides a seealso key. This doesn’t allow a tag but @@ -3865,8 +3871,8 @@ class="cmsy-10">}. For example:  
     [seealso={ksvm}]  
     {svm}{svm}{support vector machine}

    -

    -

    Since the cross-reference appears in the location list, if you suppress the +

    +

    Since the cross-reference appears in the location list, if you suppress the location list using the nonumberlist package option, then the cross-reference @@ -3898,10 +3904,10 @@ example:  
     type={symbols}% put in symbols glossary  
    ]

    -

    -

    +

    +

    -

    Top

    9 Further Information

      @@ -3929,7 +3935,7 @@ class="cmss-10">glossaries-extra package.
    • The bib2gls application.
    -

    1deprecated, use babelNicola L.C. Talbot

    2018-05-23

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

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index 0370b51788f..6403fd17947 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 17e406a2a91..f4d9b09679d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -33,7 +33,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2018-05-23} +\date{2018-06-01} \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 2647f785e1f..49da7e89a17 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 ef5b166e148..d8f753fbebc 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 af38dffec95..8e0ef7d1041 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 9a8c23e78fb..fe953afa699 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 a6246b8d260..b5ce0c8cc50 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 94fb44d416c..9a72d0b3cd5 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 86f39fb1bd2..63c8d2dc72f 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 7b236afb14f..e0ab902d774 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 0859b63b0af..acccf332111 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 dd5b2516bff..13ca205620a 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 476ad27c4a6..66dd4262679 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 fc4881f8065..ec49088b0a4 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 79d84f9d895..af50b4c9014 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 b483ea1b7f1..4110ba90ca5 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 b82b1ebbc41..75d5cd5152b 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 2fb16d0baf9..68de13799b8 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 afc3bd7b0af..00ebb765719 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 a4a2a949f10..bd81700e896 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 0eb3d3f0795..c524dbc4bcb 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 4ac46045891..c57db027aa4 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 bb41b6c23b5..8a38aec0c10 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 0e2c027ac9c..d737f45a205 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 1d25c93337d..f93cb707055 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 c343324aced..3003b3af7a8 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 8d76225ac36..bf29c210e2f 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 00ebef0f478..d74eb16faea 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 1c66394c900..12406abe544 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 ae9ce6c8102..938b0f7440e 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 1fa11017729..5b82defe3b5 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 b55ed545aa3..f940f313458 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 5dcb2c58cbf..5fccfaeb024 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 b06a9bd8d0b..97a2539216e 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 84fe2de3cc6..dbbf9fb89f0 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 9c90989ec91..12b6f93a52e 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 bad86cb6ed7..d33189e04c7 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 3fa7a3dd391..ce6b0045c6d 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 9f39b985fa0..ac2d3ea8c30 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 ed6b45efaeb..5f8c7ecff9c 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 dcb93879f23..ebf910fc1ed 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 80d2dae1395..de509e3892f 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 6471380ea26..7b45ed0bc59 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 d3b1b5e2bcf..67841e20638 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 134c643ebf0..d124dd347bb 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 8c01c48538c..e83f3fae144 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 d423213090f..a5bb987c2d6 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 732b7b71613..1d8608247ab 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 4d58af0679b..78c28d145b7 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 50133372056..219945856c4 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 diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex index 06ffd8b3343..dcdc327b377 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex @@ -1,90 +1,93 @@ - % This file is public domain. - % - % This is a sample document illustrating how to use the - % glossaries package with xindy. To create the document: - % - % latex samplexdy - % makeglossaries samplexdy - % latex samplexdy - % - % If you don't have Perl installed, then use one of the - % following instead of makeglossaries: - % - % If you want to have a separate "Mc" letter group do: - % - % xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo - % - % Otherwise do: - % - % xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo - % - % If you want to use arara, you need the following directives: - % arara: pdflatex: { synctex: on } - % arara: makeglossaries - % arara: pdflatex: { synctex: on } +% This file is public domain. +% +% This is a sample document illustrating how to use the +% glossaries package with xindy. To create the document: +% +% latex samplexdy +% makeglossaries samplexdy +% latex samplexdy +% +% If you don't have Perl installed, then use one of the +% following instead of makeglossaries: +% +% If you want to have a separate "Mc" letter group do: +% +% xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo +% +% Otherwise do: +% +% xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo +% +% If you want to use arara, you need the following directives: +% arara: pdflatex: { synctex: on } +% arara: makeglossaries +% arara: pdflatex: { synctex: on } \documentclass{article} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} -\usepackage{fmtcount}[2017/09/16] +\usepackage{fmtcount} \usepackage[colorlinks,plainpages]{hyperref} \usepackage[xindy,style=altlistgroup]{glossaries} - % Define a new command to do bold italic: +% Define a new command to do bold italic: \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} - % Need to add this to the list of attributes in order - % to use it with xindy: - % (This command will have no effect if \noist is used) +% Need to add this to the list of attributes in order +% to use it with xindy: +% (This command will have no effect if \noist is used) \GlsAddXdyAttribute{hyperbfit} - % Redefine the page numbers so that they appear as a word: +% Redefine the page numbers so that they appear as a word: - \renewcommand*{\thepage}{\texorpdfstring{\Numberstring{page}}{\arabic{page}}} +\renewcommand*{\thepage}{\texorpdfstring{\customfmt{page}}{\arabic{page}}} - % Need to add this to the list of location styles. - % \Numberstring{page} (with fmtcount.sty v3.04) gets expanded to - % \Numberstringnum {} (where is the page number) - % so need to define the location in that format: - % (This command will have no effect if \noist is used) +\newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}} +\newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}} -\GlsAddXdyLocation{Numberstring}{:sep "\string\Numberstringnum\space\glsopenbrace" +% Need to add this to the list of location styles. +% \customfmt{page} gets expanded to +% \custommfmtnum {} (where is the page number) +% so need to define the location in that format: +% (This command will have no effect if \noist is used) + +\GlsAddXdyLocation{customfmt}{:sep "\string\customfmtnum\space\glsopenbrace" "arabic-numbers" :sep "\glsclosebrace"} - % (Need to redefine \glsXpageXhyperbfit and - % \glsXpageXglsnumberformat after \makeglossaries to get the - % hyperlinks working correctly.) +% (Need to redefine \glsXpageXhyperbfit and +% \glsXpageXglsnumberformat after \makeglossaries to get the +% hyperlinks working correctly.) - % To have Mc as a separate group uncomment the following three - % lines: +% To have Mc as a separate group uncomment the following three +% lines: - %\setStyleFile{samplexdy-mc} % note no extension - %\noist - %\GlsSetXdyLanguage{} +%\setStyleFile{samplexdy-mc} % note no extension +%\noist +%\GlsSetXdyLanguage{} - % The above three lines specify to use samplexdy-mc.xdy (supplied - % with this file) and don't overwrite it. The language is - % unset using \GlsSetXdyLanguage{} as all the language - % dependent information is contained in samplexdy-mc.xdy - % Note that using \noist means that commands like - % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have - % an effect. +% The above three lines specify to use samplexdy-mc.xdy (supplied +% with this file) and don't overwrite it. The language is +% unset using \GlsSetXdyLanguage{} as all the language +% dependent information is contained in samplexdy-mc.xdy +% Note that using \noist means that commands like +% \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have +% an effect. - % Write the style file (if \noist isn't used) - % and activate glossary entries +% Write the style file (if \noist isn't used) +% and activate glossary entries \makeglossaries - % Each page location will be specified in the form: - % - % "\glsXpageXglsnumberformat{}{\Numberstringnum "\marg{n}"}" - % or - % "\glsXpageXhyperbfit{}{\Numberstringnum "\marg{n}"}" - % - % Redefine to allow hyperlinks: +% Each page location will be specified in the form: +% +% "\glsXpageXglsnumberformat{}{\customfmtnum "\marg{n}"}" +% or +% "\glsXpageXhyperbfit{}{\customfmtnum "\marg{n}"}" +% +% Redefine to allow hyperlinks: \renewcommand{\glsXpageXglsnumberformat}[2]{% \linkpagenumber#2% @@ -94,18 +97,18 @@ \textbf{\em\linkpagenumber#2}% } - % The arguments of \linkpagenumber will be - % #1 -> \Numberstringnum - % #2 -> n - % This means that the page number (n) can be used to - % form the hyperlink target. +% The arguments of \linkpagenumber will be +% #1 -> \customfmtnum +% #2 -> n +% This means that the page number (n) can be used to +% form the hyperlink target. \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} - % Define glossary entries - % \glshyperlink is used instead of \gls to prevent the glossary - % page numbers also appear in the locations, however I need - % to ensure that the referenced entries are added to the - % glossary via commands that use \glslink, \glsadd or \glssee +% Define glossary entries +% \glshyperlink is used instead of \gls to prevent the glossary +% page numbers also appear in the locations, however I need +% to ensure that the referenced entries are added to the +% glossary via commands that use \glslink, \glsadd or \glssee \newglossaryentry{mcadam}{name={McAdam, John Loudon}, first={John Loudon McAdam},text={McAdam}, @@ -146,14 +149,14 @@ description={A nonparametric test introduced by \newglossaryentry{mach}{name={Mach, Ernst}, first={Ernst Mach},text={Mach}, - % if using samplexdy-mc.xdy, the following line is needed - % to prevent this entry being put in the "Mc" group +% if using samplexdy-mc.xdy, the following line is needed +% to prevent this entry being put in the "Mc" group sort={mach, Ernst}, description={Czech/Austrian physicist and philosopher}} \newglossaryentry{machnumber}{name={Mach number}, - % if using samplexdy-mc.xdy, the following line is needed - % to prevent this entry being put in the "Mc" group +% if using samplexdy-mc.xdy, the following line is needed +% to prevent this entry being put in the "Mc" group sort={mach number}, description={Ratio of the speed of a body in a fluid to the speed of sound in that fluid named after \gls{mach}}} diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 index 62b9c5c98e9..afec44d223f 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 +++ b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES-LITE 1" -.TH MAKEGLOSSARIES-LITE 1 "2018-05-23" "perl v5.26.2" "makeglossaries-lite Lua Script" +.TH MAKEGLOSSARIES-LITE 1 "2018-06-01" "perl v5.26.2" "makeglossaries-lite Lua Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf index 636adde57bb..421832b6d75 100644 Binary files a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf and b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf differ diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries.1 b/Master/texmf-dist/doc/man/man1/makeglossaries.1 index 9f72290d219..2bc11e72a32 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries.1 +++ b/Master/texmf-dist/doc/man/man1/makeglossaries.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES 1" -.TH MAKEGLOSSARIES 1 "2018-05-23" "perl v5.26.2" "makeglossaries Perl Script" +.TH MAKEGLOSSARIES 1 "2018-06-01" "perl v5.26.2" "makeglossaries Perl Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf b/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf index 62b699eede9..7911c9f3678 100644 Binary files a/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf and b/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf differ diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries b/Master/texmf-dist/scripts/glossaries/makeglossaries index 218dfc921a5..081265d32e3 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 4.39 +# Version : 4.40 # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -31,9 +31,11 @@ # glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl. # Also makeglossaries and makeglossaries-lite.lua. -my $version="4.39 (2018-05-23)"; +my $version="4.40 (2018-06-01)"; # History: +# v4.40: +# * No change. # v4.39: # * No change. # v4.38: diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua b/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua index 77da25667b3..aff87e481e1 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua @@ -36,6 +36,8 @@ Also makeglossaries and makeglossaries-lite.lua. History: + * 4.40: + - no change. * 4.39: - corrected script name in version and help messages * 4.38: @@ -60,7 +62,7 @@ - changed first line from lua to texlua --]] -thisversion = "4.39 (2018-05-23)" +thisversion = "4.40 (2018-06-01)" quiet = false dryrun = false diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index d063abc2371..5868f244d56 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -1,18 +1,16 @@ %\iffalse % glossaries.dtx generated using makedtx version 1.2 (c) Nicola Talbot % Command line args: -% -section "chapter" -% -comment ".*\.perl" -% -comment ".*\.tex" -% -comment ".*\.xdy" -% -setambles ".*\.perl=>\nopreamble\nopostamble" -% -setambles ".*\.tex=>\nopreamble\nopostamble" -% -setambles ".*\.xdy=>\nopreamble\nopostamble" % -macrocode ".*\.perl" % -macrocode ".*\.tex" % -macrocode ".*\.xdy" % -codetitle "Main Package Code" +% -doc "glossaries-manual.tex" +% -section "chapter" % -author "Nicola Talbot" +% -comment ".*\.perl" +% -comment ".*\.tex" +% -comment ".*\.xdy" % -src "glossaries\.sty\Z=>glossaries.sty" % -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty" % -src "(glossary-.+)\.(sty)\Z=>\1.\2" @@ -29,9 +27,11 @@ % -src "(samplexdy-mc.*\.xdy)\Z=>\1" % -src "(database.*\.tex)\Z=>\1" % -src "(.*\.perl)\Z=>\1" -% -doc "glossaries-manual.tex" +% -setambles ".*\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" +% -setambles ".*\.xdy=>\nopreamble\nopostamble" % glossaries -% Created on 2018/5/23 15:06 +% Created on 2018/6/1 13:57 %\fi %\iffalse %<*package> @@ -145,7 +145,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{19427} +\CheckSum{19428} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -172,12 +172,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\fi %\MakeShortVerb{"} % -% \title{Documented Code For glossaries v4.39} +% \title{Documented Code For glossaries v4.40} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2018-05-23} +% \date{2018-06-01} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -193,7 +193,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %glossaries package}. % %\item[\url{glossaries-user.pdf}] -%For the main user guide, read \qt{glossaries.sty v4.39: +%For the main user guide, read \qt{glossaries.sty v4.40: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -248,7 +248,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} %\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle} % Required packages: @@ -12984,10 +12984,15 @@ false,nolabel,autolabel,nameref}[nolabel]{% commands like \string\gls)}% }% % \end{macrocode} -% Don't escape makeindex/xindy characters +% Don't escape makeindex/xindy characters: % \begin{macrocode} \let\@gls@checkmkidxchars\@gobble % \end{macrocode} +% Don't escape locations: +%\changes{4.40}{2018-06-01}{added esclocations=false} +% \begin{macrocode} + \glsesclocationsfalse +% \end{macrocode} % Write glossary information to aux instead of glossary files % \begin{macrocode} \let\@@do@@wrglossary\gls@noidxglossary @@ -13192,8 +13197,12 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % +%\section{Writing information to associated files} +%\label{sec:wrgloss} +% %\begin{macro}{\gls@noidxglossary} -% Write the glossary information to the aux file: +% Write the glossary information to the aux file (for the `noidx' +% method): % \begin{macrocode} \newcommand*{\gls@noidxglossary}{% \protected@write\@auxout{}{% @@ -13211,14 +13220,12 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % -%\section{Writing information to associated files} -% -% %\begin{macro}{\istfile} %\changes{3.0}{2011-04-02}{deprecated} +%\changes{4.40}{2018-06-01}{changed \cs{def} to \cs{providecommand}} % Deprecated. % \begin{macrocode} -\def\istfile{\glswrite} +\providecommand\istfile{\glswrite} % \end{macrocode} %\end{macro} % @@ -13230,14 +13237,14 @@ false,nolabel,autolabel,nameref}[nolabel]{% } % \end{macrocode} %\begin{macro}{\@glswritefiles} -% Only write the files if \pkgopt[true]{savewrites} +% Only write the files if \pkgopt[true]{savewrites}. %\changes{3.14a}{2013-11-12}{renamed \cs{glswritefiles} to %\cs{@glswritefiles} and used ``savewrites'' option to set %\cs{glswritefiles}} % \begin{macrocode} \newcommand*{\@glswritefiles}{% % \end{macrocode} -% Iterate through all the glossaries +% Iterate through all the glossaries. %\changes{3.01}{2011-04-12}{added check for empty glossaries} %\changes{3.02}{2012-05-21}{added check for existence of token % in case \cs{makeglossaries has been omitted}} @@ -13276,7 +13283,7 @@ you % \end{macrocode} %\end{macro} % -% As from v4.10, the \cs{glossary} command is +% As from v4.10, the \cs{glossary} command isn't % used by the \styfmt{glossaries} package. Since the % user isn't expected to use this command (as \styfmt{glossaries} % takes care of the particular format required for @@ -13285,12 +13292,12 @@ you % with other packages (and with the \cs{mark} mechanism). % % In v4.10, the redefinition of \cs{glossary} was removed since it -% wasn't intended as a user level command, however it -% seems there are packages that have hacked the internal macros used -% by \styfmt{glossaries} and no longer work with this redefinition -% removed, so it's been restored in v4.11 but is not used at all by -% \styfmt{glossaries}. (This may be removed or moved to a -% compatibility mode in future.) +% was never intended as a user level command (and wasn't documented +% in the user manual), however it seems there are packages that have +% hacked the internal macros used by \styfmt{glossaries} and no longer +% work with this redefinition removed, so it's been restored in v4.11 +% but is not used at all by \styfmt{glossaries}. +% (This may be removed or moved to a compatibility mode in future.) %\begin{macro}{\glossary} % \begin{macrocode} \if@gls@docloaded @@ -13438,9 +13445,8 @@ you % List of page formats to be protected against expansion. %\changes{4.22}{2016-04-19}{added arabic to list} % \begin{macrocode} -\newcommand{\gls@protected@pagefmts}{% - \gls@numberpage,\gls@alphpage,\gls@Alphpage,\gls@romanpage,\gls@Romanpage,\gls@arabicpage% -} +\newcommand{\gls@protected@pagefmts}{\gls@numberpage,\gls@alphpage,% + \gls@Alphpage,\gls@romanpage,\gls@Romanpage,\gls@arabicpage} % \end{macrocode} %\end{macro} %\begin{macro}{\gls@disablepagerefexpansion} @@ -13578,7 +13584,7 @@ you \@do@gls@getcounterprefix \fi % \end{macrocode} -% De-tok label if required +% De-tok label if required. %\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} % \begin{macrocode} \edef\@gls@label{\glsdetoklabel{#1}}% @@ -18927,7 +18933,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \cs{gls}\marg{label}} on subsequent use. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Pass all options to \sty{glossaries}: % \begin{macrocode} @@ -19342,7 +19348,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} -\ProvidesPackage{glossary-hypernav}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % % The commands defined in this package are provided to @@ -19535,7 +19541,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % This defines an in-line style where the entries are % comma-separated with just the name and description displayed. % \begin{macrocode} -\ProvidesPackage{glossary-inline}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-inline}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % %\begin{style}{inline} @@ -19726,7 +19732,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-list}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} %\begin{macro}{\indexspace} %\changes{4.13}{2015-02-03}{new} @@ -20008,7 +20014,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % The glossary styles defined in the \isty{glossary-long} package % used the \env{longtable} environment in the glossary. % \begin{macrocode} -\ProvidesPackage{glossary-long}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-long}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} @@ -20505,7 +20511,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \url{http://tex.stackexchange.com/a/56890} % % \begin{macrocode} -\ProvidesPackage{glossary-longbooktabs}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Requires \sty{booktabs} package: % \begin{macrocode} @@ -20846,7 +20852,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % used the \env{longtable} environment in the glossary and use % ragged right formatting for the multiline columns. % \begin{macrocode} -\ProvidesPackage{glossary-longragged}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-longragged}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -21279,7 +21285,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %use the \sty{multicol} package. These use the tree-like glossary %styles in a multicol environment. % \begin{macrocode} -\ProvidesPackage{glossary-mcols}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-mcols}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -21716,7 +21722,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % The glossary styles defined in the \isty{glossary-super} package % use the \env{supertabular} environment. % \begin{macrocode} -\ProvidesPackage{glossary-super}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-super}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} @@ -22248,7 +22254,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % are like those provided by the \isty{glossary-super} package, % except that the multiline columns have ragged right justification. % \begin{macrocode} -\ProvidesPackage{glossary-superragged}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-superragged}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -22688,7 +22694,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-tree}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % %\begin{macro}{\indexspace} @@ -23409,7 +23415,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % hyperlinks may not work properly. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} %\begin{macro}{\GlsAddXdyAttribute} % Adds an attribute in old format. @@ -23770,7 +23776,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\section{glossaries-compatible-307} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % % Compatibility macros for predefined glossary styles: @@ -24578,7 +24584,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} % Package version number now in line with main glossaries package number. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2018/05/23 v4.39 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2018/06/01 v4.40 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -27021,7 +27027,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-babel}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -27065,7 +27071,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2018/06/01 v4.40 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -33039,93 +33045,97 @@ brackets. %\fi %\iffalse % \begin{macrocode} - % This file is public domain. - % - % This is a sample document illustrating how to use the - % glossaries package with xindy. To create the document: - % - % latex samplexdy - % makeglossaries samplexdy - % latex samplexdy - % - % If you don't have Perl installed, then use one of the - % following instead of makeglossaries: - % - % If you want to have a separate "Mc" letter group do: - % - % xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo - % - % Otherwise do: - % - % xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo - % - % If you want to use arara, you need the following directives: - % arara: pdflatex: { synctex: on } - % arara: makeglossaries - % arara: pdflatex: { synctex: on } +%<} (where is the page number) - % so need to define the location in that format: - % (This command will have no effect if \noist is used) +\newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}} +\newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}} -\GlsAddXdyLocation{Numberstring}{:sep "\string\Numberstringnum\space\glsopenbrace" +% Need to add this to the list of location styles. +% \customfmt{page} gets expanded to +% \custommfmtnum {} (where is the page number) +% so need to define the location in that format: +% (This command will have no effect if \noist is used) + +\GlsAddXdyLocation{customfmt}{:sep "\string\customfmtnum\space\glsopenbrace" "arabic-numbers" :sep "\glsclosebrace"} - % (Need to redefine \glsXpageXhyperbfit and - % \glsXpageXglsnumberformat after \makeglossaries to get the - % hyperlinks working correctly.) +% (Need to redefine \glsXpageXhyperbfit and +% \glsXpageXglsnumberformat after \makeglossaries to get the +% hyperlinks working correctly.) - % To have Mc as a separate group uncomment the following three - % lines: +% To have Mc as a separate group uncomment the following three +% lines: - %\setStyleFile{samplexdy-mc} % note no extension - %\noist - %\GlsSetXdyLanguage{} +%\setStyleFile{samplexdy-mc} % note no extension +%\noist +%\GlsSetXdyLanguage{} - % The above three lines specify to use samplexdy-mc.xdy (supplied - % with this file) and don't overwrite it. The language is - % unset using \GlsSetXdyLanguage{} as all the language - % dependent information is contained in samplexdy-mc.xdy - % Note that using \noist means that commands like - % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have - % an effect. +% The above three lines specify to use samplexdy-mc.xdy (supplied +% with this file) and don't overwrite it. The language is +% unset using \GlsSetXdyLanguage{} as all the language +% dependent information is contained in samplexdy-mc.xdy +% Note that using \noist means that commands like +% \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have +% an effect. - % Write the style file (if \noist isn't used) - % and activate glossary entries +% Write the style file (if \noist isn't used) +% and activate glossary entries \makeglossaries - % Each page location will be specified in the form: - % - % "\glsXpageXglsnumberformat{}{\Numberstringnum "\marg{n}"}" - % or - % "\glsXpageXhyperbfit{}{\Numberstringnum "\marg{n}"}" - % - % Redefine to allow hyperlinks: +% Each page location will be specified in the form: +% +% "\glsXpageXglsnumberformat{}{\customfmtnum "\marg{n}"}" +% or +% "\glsXpageXhyperbfit{}{\customfmtnum "\marg{n}"}" +% +% Redefine to allow hyperlinks: \renewcommand{\glsXpageXglsnumberformat}[2]{% \linkpagenumber#2% @@ -33135,18 +33145,18 @@ brackets. \textbf{\em\linkpagenumber#2}% } - % The arguments of \linkpagenumber will be - % #1 -> \Numberstringnum - % #2 -> n - % This means that the page number (n) can be used to - % form the hyperlink target. +% The arguments of \linkpagenumber will be +% #1 -> \customfmtnum +% #2 -> n +% This means that the page number (n) can be used to +% form the hyperlink target. \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} - % Define glossary entries - % \glshyperlink is used instead of \gls to prevent the glossary - % page numbers also appear in the locations, however I need - % to ensure that the referenced entries are added to the - % glossary via commands that use \glslink, \glsadd or \glssee +% Define glossary entries +% \glshyperlink is used instead of \gls to prevent the glossary +% page numbers also appear in the locations, however I need +% to ensure that the referenced entries are added to the +% glossary via commands that use \glslink, \glsadd or \glssee \newglossaryentry{mcadam}{name={McAdam, John Loudon}, first={John Loudon McAdam},text={McAdam}, @@ -33187,14 +33197,14 @@ description={A nonparametric test introduced by \newglossaryentry{mach}{name={Mach, Ernst}, first={Ernst Mach},text={Mach}, - % if using samplexdy-mc.xdy, the following line is needed - % to prevent this entry being put in the "Mc" group +% if using samplexdy-mc.xdy, the following line is needed +% to prevent this entry being put in the "Mc" group sort={mach, Ernst}, description={Czech/Austrian physicist and philosopher}} \newglossaryentry{machnumber}{name={Mach number}, - % if using samplexdy-mc.xdy, the following line is needed - % to prevent this entry being put in the "Mc" group +% if using samplexdy-mc.xdy, the following line is needed +% to prevent this entry being put in the "Mc" group sort={mach number}, description={Ratio of the speed of a body in a fluid to the speed of sound in that fluid named after \gls{mach}}} @@ -33305,6 +33315,7 @@ This page discusses \gls{mcnemar} who introduced \printglossaries \end{document} +%COMMENT % \end{macrocode} %\fi %\iffalse diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index c69ea3755d6..e9cae23b25f 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins @@ -1,4 +1,4 @@ -% glossaries.ins generated using makedtx version 1.2 2018/5/23 15:06 +% glossaries.ins generated using makedtx version 1.2 2018/6/1 13:57 \input docstrip \preamble diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty index 9c414362604..3260ffda8aa 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-babel}[2018/06/01 v4.40 (NLCT)] \RequirePackage{tracklang} \let\glsifusetranslator\@secondoftwo \AnyTrackedLanguages diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty index d8340716492..e44b2fb558c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2018/06/01 v4.40 (NLCT)] \ifglsxindy \renewcommand*\GlsAddXdyAttribute[1]{% \edef\@xdyattributes{\@xdyattributes ^^J \string"#1\string"}% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty index b17d0e81eb7..c6cd1d0f6ac 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2018/06/01 v4.40 (NLCT)] \newcommand{\compatglossarystyle}[2]{% \ifcsundef{@glscompstyle@#1}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty index 1b0f91c1201..042c9c783d7 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2018/06/01 v4.40 (NLCT)] \RequirePackage{tracklang} \let\glsifusetranslator\@secondoftwo \AnyTrackedLanguages diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty index 2992b136cef..e3e9ef20912 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2018/06/01 v4.40 (NLCT)] \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}} \ProcessOptions \RequirePackage{glossaries} diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index 476aa4a0382..e7aecc10164 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossaries}[2018/06/01 v4.40 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -5257,6 +5257,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% commands like \string\gls)}% }% \let\@gls@checkmkidxchars\@gobble + \glsesclocationsfalse \let\@@do@@wrglossary\gls@noidxglossary \let\@gls@getgrouptitle\@gls@noidx@getgrouptitle \let\gls@checkseeallowed\relax @@ -5390,7 +5391,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% }% }% } -\def\istfile{\glswrite} +\providecommand\istfile{\glswrite} \AtEndDocument{% \glswritefiles } @@ -5469,9 +5470,8 @@ you #2% \fi } -\newcommand{\gls@protected@pagefmts}{% - \gls@numberpage,\gls@alphpage,\gls@Alphpage,\gls@romanpage,\gls@Romanpage,\gls@arabicpage% -} +\newcommand{\gls@protected@pagefmts}{\gls@numberpage,\gls@alphpage,% + \gls@Alphpage,\gls@romanpage,\gls@Romanpage,\gls@arabicpage} \newcommand*{\gls@disablepagerefexpansion}{% \@for\@gls@this:=\gls@protected@pagefmts\do {% diff --git a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty index b3aa616b893..14297278db9 100644 --- a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty +++ b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-accsupp}[2018/05/23 v4.39 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2018/06/01 v4.40 (NLCT) Experimental glossaries accessibility] \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}} \ProcessOptions diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty index b8795631328..e36c76c2316 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-hypernav}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2018/06/01 v4.40 (NLCT)] \newcommand*{\glsnavhyperlink}[3][\@glo@type]{% \edef\gls@grplabel{#2}\protected@edef\@gls@grptitle{#3}% \@glslink{\glsnavhyperlinkname{#1}{#2}}{#3}} diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty index 24cfa5f079d..55e44a59dcd 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-inline}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-inline}[2018/06/01 v4.40 (NLCT)] \newglossarystyle{inline}{% \renewenvironment{theglossary}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty index 21568d13dab..551a72aa047 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-list}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-list}[2018/06/01 v4.40 (NLCT)] \providecommand{\indexspace}{% \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax } diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty index 1abb137b99a..3212c62bcb2 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-long}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-long}[2018/06/01 v4.40 (NLCT)] \RequirePackage{longtable} \@ifundefined{glsdescwidth}{% \newlength\glsdescwidth diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty index 5ad75990f6b..86fe4fbce68 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-longbooktabs}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2018/06/01 v4.40 (NLCT)] \RequirePackage{booktabs} \RequirePackage{glossary-long} \RequirePackage{glossary-longragged} diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty index 71092a19d0d..ba275b46d28 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-longragged}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-longragged}[2018/06/01 v4.40 (NLCT)] \RequirePackage{array} \RequirePackage{longtable} \@ifundefined{glsdescwidth}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty index 2d4d47847e0..b7111a1811a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-mcols}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-mcols}[2018/06/01 v4.40 (NLCT)] \RequirePackage{multicol} \RequirePackage{glossary-tree} \providecommand{\indexspace}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty index 5956f27e426..4fdc9aa869a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-super}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-super}[2018/06/01 v4.40 (NLCT)] \RequirePackage{supertabular} \@ifundefined{glsdescwidth}{% \newlength\glsdescwidth diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty index 55fd9bec191..31feeec7a1b 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-superragged}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-superragged}[2018/06/01 v4.40 (NLCT)] \RequirePackage{array} \RequirePackage{supertabular} \@ifundefined{glsdescwidth}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty index e68d2d2daf5..10754d07ff4 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-tree}[2018/05/23 v4.39 (NLCT)] +\ProvidesPackage{glossary-tree}[2018/06/01 v4.40 (NLCT)] \providecommand{\indexspace}{% \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax } diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index 59558b49986..dbb6d1eac5a 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -206,6 +206,7 @@ chomp ($Build = `cd $Master/../Build/source && pwd`); 'cantarell', "&MAKEcopy", 'cascover', "die 'skipping, license unclear, ancient'", 'camel', "die 'skipping, nosell license'", + 'casiofont', "die 'skipping, nonfree font'", 'cassette', "die 'skipping, nonfree license'", 'cassette-shipunov', "die 'skipping, use shipunov'", 'cassette209', "die 'skipping, latex 2.09'", -- cgit v1.2.3