From f342995fd14216326b21b0f6542db9df58bc224d Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 21 Sep 2017 21:04:31 +0000 Subject: glossaries (21sep17) git-svn-id: svn://tug.org/texlive/trunk@45373 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 29 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 1167039 -> 1179271 bytes .../doc/latex/glossaries/glossaries-user.html | 21576 +++++++++++-------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 767626 -> 880568 bytes .../doc/latex/glossaries/glossaries-user.tex | 1967 +- .../doc/latex/glossaries/glossariesbegin.html | 3500 ++- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 156676 -> 186433 bytes .../doc/latex/glossaries/glossariesbegin.tex | 1649 +- .../doc/latex/glossaries/glossary2glossaries.html | 2 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 142454 -> 142462 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 252930 -> 248656 bytes .../samples/glossary-lipsum-examples.tex | 25 +- .../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 82200 -> 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 147229 -> 147264 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 102910 -> 102932 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 155610 -> 155622 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169073 -> 169079 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91354 -> 91355 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98865 -> 98894 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 95251 -> 95276 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 179029 -> 133806 bytes .../doc/latex/glossaries/samples/samplexdy.tex | 189 +- .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 68412 -> 68412 bytes .../doc/latex/glossaries/samples/samplexdy3.pdf | Bin 0 -> 178558 bytes .../doc/latex/glossaries/samples/samplexdy3.tex | 266 + 63 files changed, 17692 insertions(+), 11517 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex (limited to 'Master/texmf-dist/doc/latex/glossaries') diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index 5fdc2ea070b..ea5fa1af3cc 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,34 @@ glossaries change log: +v4.33 (2017-09-20): + + * Removed makeglossaries.bat (TeX distributions on Windows + convert the Perl script to makeglossaries.exe, so the + .bat file isn't needed.) + + * makeglossaries and makeglossaries-lite.lua now have their + version numbers synchronised with glossaries.sty + + * Added makeglossaries-lite.pod (to provide the + makeglossaries-lite.1 man file) + + * Updated POD at the end of makeglossaries + + * Added example-glossaries-symbolnames.tex for use in any MWE + requiring symbols in the name fields. + + * Tidied up the user manual and guide for beginners. + + * glossaries.sty: + + - added package option nolangwarn + + - added package option esclocations + + - added \GlsSetXdyNumberGroupOrder + + - added starred form of \GlsSetXdyFirstLetterAfterDigits + v4.32 (2017-08-24): * glossaries.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index 912b5a1f63a..6f8770253f1 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.32 +LaTeX Package : glossaries v4.33 -Last Modified : 2017-08-24 +Last Modified : 2017-09-20 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 166baab76b7..a825ead85d1 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 101a969b633..8dc71ce82e9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -21,7 +21,6 @@ .cmr-17{font-size:170%;} .cmr-12{font-size:120%;} .cmr-8{font-size:80%;} -.cmsy-8{font-size:80%;} .cmtt-12{font-size:120%;font-family: monospace;} .cmtt-12{font-family: monospace;} .cmtt-12{font-family: monospace;} @@ -33,6 +32,7 @@ .cmss-10{ font-family: sans-serif;} .cmss-10{ font-family: sans-serif;} .cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} .cmtt-10{font-family: monospace;} .cmtt-10{font-family: monospace;} .cmtt-10{font-family: monospace;} @@ -43,7 +43,9 @@ .cmssbx-10{ font-family: sans-serif; font-weight: bold;} .cmssbx-10{ font-family: sans-serif; font-weight: bold;} .cmssbx-10{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10{ font-family: sans-serif; font-weight: bold;} .cmr-9{font-size:90%;} +.tcrm-0800{font-size:80%;} .cmtt-8{font-size:80%;font-family: monospace;} .cmtt-8{font-family: monospace;} .cmtt-8{font-family: monospace;} @@ -53,20 +55,30 @@ .cmss-8{ font-family: sans-serif;} .cmss-8{ font-family: sans-serif;} .cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-9{font-size:90%; font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} +.tcrm-0900{font-size:90%;} +.cmmi-9{font-size:90%;font-style: italic;} +.msam-10x-x-90{font-size:90%;} .cmtt-9{font-size:90%;font-family: monospace;} .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} -.cmsy-9{font-size:90%;} -.cmitt-10{font-family: monospace; font-style: italic;} +.pzdr-x-x-90{font-size:90%;} .cmbx-12{font-size:120%; font-weight: bold;} .cmbx-12{ font-weight: bold;} +.cmitt-10{font-family: monospace; font-style: italic;} .cmbxti-10{ font-weight: bold; font-style: italic;} .cmssbx-10x-x-120{font-size:120%; font-family: sans-serif; font-weight: bold;} .cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} .cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} .cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} +.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} .small-caps{font-variant: small-caps; } p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } @@ -201,7 +213,7 @@ div.array {text-align:center;} .equation-star td{text-align:center; } table.equation-star { width:100%; } table.equation { width:100%; } -table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:100%; margin-left:5%; white-space: nowrap;} +table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:95%; margin-left:5%; white-space: nowrap;} table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;} td.align-label { width:5%; text-align:center; } td.align-odd { text-align:right; padding-right:0.3em;} @@ -215,6 +227,68 @@ div.longtable{text-align:center;} .supertabular {text-align:center} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} +span#textcolor1{color:#00FF00} +span#textcolor2{color:#00FF00} +span#textcolor3{color:#00FF00} +span#textcolor4{color:#FF0000} +span#textcolor5{color:#FF0000} +span#textcolor6{color:#00FF00} +span#textcolor7{color:#FF0000} +span#textcolor8{color:#FF0000} +span#textcolor9{color:#FF0000} +span#textcolor10{color:#00FF00} +span#textcolor11{color:#00FF00} +span#textcolor12{color:#00FF00} +span#textcolor13{color:#FF0000} +span#textcolor14{color:#00FF00} +span#textcolor15{color:#00FF00} +span#textcolor16{color:#00FF00} +span#textcolor17{color:#00FF00} +span#textcolor18{color:#00FF00} +span#textcolor19{color:#FF0000} +span#textcolor20{color:#00FF00} +span#textcolor21{color:#FF0000} +span#textcolor22{color:#FF0000} +span#textcolor23{color:#00FF00} +span#textcolor24{color:#00FF00} +span#textcolor25{color:#FF0000} +span#textcolor26{color:#00FF00} +span#textcolor27{color:#00FF00} +span#textcolor28{color:#00FF00} +span#textcolor29{color:#00FF00} +span#textcolor30{color:#FF0000} +span#textcolor31{color:#FF0000} +span#textcolor32{color:#00FF00} +span#textcolor33{color:#FF0000} +span#textcolor34{color:#FF0000} +span#textcolor35{color:#FF0000} +span#textcolor36{color:#00FF00} +span#textcolor37{color:#00FF00} +span#textcolor38{color:#00FF00} +span#textcolor39{color:#00FF00} +span#textcolor40{color:#FF0000} +span#textcolor41{color:#00FF00} +span#textcolor42{color:#00FF00} +span#textcolor43{color:#FF0000} +span#textcolor44{color:#00FF00} +span#textcolor45{color:#00FF00} +span#textcolor46{color:#00FF00} +span#textcolor47{color:#FF0000} +span#textcolor48{color:#00FF00} +span#textcolor49{color:#FF0000} +span#textcolor50{color:#00FF00} +span#textcolor51{color:#00FF00} +span#textcolor52{color:#00FF00} +span#textcolor53{color:#00FF00} +span#textcolor54{color:#FF0000} +span#textcolor55{color:#FF0000} +span#textcolor56{color:#00FF00} +span#textcolor57{color:#FF0000} +span#textcolor58{color:#00FF00} +span#textcolor59{color:#FF0000} +span#textcolor60{color:#FF0000} +span#textcolor61{color:#00FF00} +span#textcolor62{color:#00FF00} /* end css.sty */ @@ -222,20 +296,20 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle -

-

+

-

+

-

-

User Manual for glossaries.sty v4.32 +

+

User Manual for glossaries.sty v4.33

-

2017-08-24

+

2017-09-20

-

+

-

-

+

Abstract

-

The

The glossaries package provides a means to define terms or abbreviations or symbols that can be referenced within your document. Sorted lists with collated locations can be generated either using TEX or using a supplementary indexing application. -

Additional features not provided here may be available through the supplemental package +

Additional features not provided here may be available through the supplemental package glossaries-extra which, if required, needs to be installed separately. New features will be added to glossaries-extra. Versions of the glossaries package after v4.21 will mostly be just bug -fixes. -

+class="cmss-10">glossaries package after v4.21 will mostly be just bug fixes. +Note that glossaries-extra provides an extra indexing option (bib2gls) which isn’t available +with just the base glossaries package. +

-

If you require multilingual support you must also separately install the relevant language -module. Each language module is called

If you require multilingual support you must also separately install the relevant language +module. Each language module is distributed under the name glossaries-language⟩, where ⟨language⟩ is the root -language name. For example, glossaries-french or glossaries-german. If a language -module is required, the glossaries package will automatically try to load it and will give -a warning if the module isn’t found. See language⟩, +where ⟨language⟩ is the root language name. For example, glossaries-french or +glossaries-german. If a language module is required, the glossaries package will +automatically try to load it and will give a warning if the module isn’t found. See §1.3 Multi-Lingual Support for further -details. -

The §1.4 +Multi-Lingual Support for further details. If there isn’t any support available for your +language, use the nolangwarn package option to suppress the warning and provide your own +translations. (For example, use the title key in \printglossary.) +

The glossaries package requires a number of other packages including, but not limited to, tracklang, , mfirstuc, , etoolbox, , xkeyval (at least version dated 2006/11/18), (at least version dated 2006/11/18), textcase, , xfor, + id="dx1-11">, datatool-base (part of the (part of the datatool bundle) and bundle) and amsgen. These packages are all available + id="dx1-14">. These packages are all available in the latest TEX Live and MikTEX distributions. If any of them are missing, @@ -332,7 +421,7 @@ class="E">EX distribution? or Updating TEX on Linux.) -

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

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 @@ -340,15 +429,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-15"> package, read “Upgrading from the glossary package to the glossaries package”.
@@ -378,13 +467,13 @@ class="cmtt-10">glossaries-code.pdf
Advanced users wishing to know more about the inner workings of all the packages provided in the glossaries bundle should read “Documented - Code for glossaries v4.32”. + Code for glossaries v4.33”. + +
INSTALL
Installation instructions. - -
CHANGES
Change log. class="cmbx-10">README
Package summary.
-

Related resources:

+

Related resources:

-

If you use glossaries-extra package + +
  • bib2gls
  • +

    If you use hyperref and and glossaries, you must load hyperref first. Similarly the doc package + id="dx1-18"> package must also be loaded before glossaries. (If doc is loaded, the file extensions for the default main + id="dx1-19"> 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-23">’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-26"> (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 an issue with the DVI format not with glossaries.

    -

    +

    @@ -463,172 +556,182 @@ href="#Q1-1-3">Glossary
    1 Introduction
     1.1 Sample Documents +href="#sec:indexingoptions" id="QQ2-1-6">Indexing Options
     1.2 Dummy Entries for Testing +href="#sec:samples" id="QQ2-1-13">Sample Documents
     1.3 Multi-Lingual Support -
      1.3.1 Changing the Fixed Names +href="#sec:lipsum" id="QQ2-1-14">Dummy Entries for Testing
     1.4 Generating the Associated Glossary Files +href="#sec:languages" id="QQ2-1-15">Multi-Lingual Support
      1.4.1 Using the makeglossaries Perl Script -
      1.4.2 Using the makeglossaries-lite.lua Lua Script -
      1.4.3 Using xindy explicitly (Option 3) -
      1.4.4 Using makeindex explicitly (Option 2) -
      1.4.5 Note to Front-End and Script Developers +href="#sec:fixednames" id="QQ2-1-16">Changing the Fixed Names +
     1.5 Generating the Associated Glossary Files +
      1.5.1 Using the makeglossaries Perl Script +
      1.5.2 Using the makeglossaries-lite Lua Script +
      1.5.3 Using xindy explicitly (Option 3) +
      1.5.4 Using makeindex explicitly (Option 2) +
      1.5.5 Note to Front-End and Script Developers
    2 Package Options +href="#sec:pkgopts" id="QQ2-1-26">Package Options
     2.1 General Options +href="#sec:pkgopts-general" id="QQ2-1-27">General Options
     2.2 Sectioning, Headings and TOC Options +href="#sec:pkgopts-sec" id="QQ2-1-28">Sectioning, Headings and TOC Options
     2.3 Glossary Appearance Options +href="#sec:pkgopts-printglos" id="QQ2-1-29">Glossary Appearance Options
     2.4 Sorting Options +href="#sec:pkgopts-sort" id="QQ2-1-30">Sorting Options
     2.5 Acronym Options +href="#sec:pkgopts-acronym" id="QQ2-1-31">Acronym Options
      2.5.1 Deprecated Acronym Style Options +href="#sec:pkgopts-old-acronym" id="QQ2-1-32">Deprecated Acronym Style Options
     2.6 Other Options +href="#sec:pkgopts-other" id="QQ2-1-33">Other Options
     2.7 Setting Options After the Package is Loaded +href="#sec:setupglossaries" id="QQ2-1-34">Setting Options After the Package is Loaded
    3 Setting Up +href="#sec:setup" id="QQ2-1-35">Setting Up
     3.1 Option 1 +href="#sec:setupopt1" id="QQ2-1-36">Option 1
     3.2 Options 2 and 3 +href="#sec:setupopt23" id="QQ2-1-37">Options 2 and 3
    4 Defining Glossary Entries +href="#sec:newglosentry" id="QQ2-1-38">Defining Glossary Entries
     4.1 Plurals +href="#sec:plurals" id="QQ2-1-39">Plurals
     4.2 Other Grammatical Constructs +href="#sec:grammar" id="QQ2-1-40">Other Grammatical Constructs
     4.3 Additional Keys +href="#sec:addkey" id="QQ2-1-41">Additional Keys
      4.3.1 Document Keys +href="#sec:glsaddkey" id="QQ2-1-42">Document Keys
      4.3.2 Storage Keys +href="#sec:glsaddstoragekey" id="QQ2-1-43">Storage Keys
     4.4 Expansion +href="#sec:expansion" id="QQ2-1-44">Expansion
     4.5 Sub-Entries +href="#sec:subentries" id="QQ2-1-46">Sub-Entries
      4.5.1 Hierarchical Categories +href="#sec:hierarchical" id="QQ2-1-47">Hierarchical Categories
      4.5.2 Homographs -
     4.6 Loading Entries From a File +href="#sec:homographs" id="QQ2-1-48">Homographs +
     4.6 Loading Entries From a File
     4.7 Moving Entries to Another Glossary +href="#sec:moveentry" id="QQ2-1-50">Moving Entries to Another Glossary
     4.8 Drawbacks With Defining Entries in the Document Environment +href="#sec:docdefs" id="QQ2-1-51">Drawbacks With Defining Entries in the Document Environment
      4.8.1 Technical Issues +href="#sec:techissues" id="QQ2-1-52">Technical Issues
      4.8.2 Good Practice Issues +href="#sec:goodpractice" id="QQ2-1-53">Good Practice Issues
    5 Number lists +href="#sec:numberlists" id="QQ2-1-54">Number lists +
     5.1 Encap Values +
     5.2 Locations +
     5.3 Range Formations +
     5.4 Style Hook
    6 Links to Glossary Entries +href="#sec:glslink" id="QQ2-1-59">Links to Glossary Entries
     6.1 The The \gls-Like Commands (First Use Flag Queried)
     6.2 The The \glstext-Like Commands (First Use Flag Not Queried)
     6.3 Changing the format of the link text +href="#sec:glsdisplay" id="QQ2-1-63">Changing the format of the link text
     6.4 Enabling and disabling hyperlinks to glossary entries +href="#sec:disablehyperlinks" id="QQ2-1-64">Enabling and disabling hyperlinks to glossary entries
    7 Adding an Entry to the Glossary Without Generating Text +href="#sec:glsadd" id="QQ2-1-65">Adding an Entry to the Glossary Without Generating Text
    8 Cross-Referencing Entries +href="#sec:crossref" id="QQ2-1-66">Cross-Referencing Entries
     8.1 Customising Cross-reference Text +href="#sec:customxr" id="QQ2-1-67">Customising Cross-reference Text
    9 Using Glossary Terms Without Links +href="#sec:glsnolink" id="QQ2-1-68">Using Glossary Terms Without Links
    10 Displaying a glossary +href="#sec:printglossary" id="QQ2-1-69">Displaying a glossary
    11 Xindy (Option 3) +href="#sec:xindy" id="QQ2-1-70">Xindy (Option 3)
     11.1 Language and Encodings +href="#sec:langenc" id="QQ2-1-71">Language and Encodings
     11.2 Locations and Number lists +href="#sec:xindyloc" id="QQ2-1-72">Locations and Number lists
     11.3 Glossary Groups +href="#sec:groups" id="QQ2-1-73">Glossary Groups
    12 Defining New Glossaries +href="#sec:newglossary" id="QQ2-1-74">Defining New Glossaries
    13 Acronyms and Other Abbreviations +href="#sec:acronyms" id="QQ2-1-75">Acronyms and Other Abbreviations
     13.1 Changing the Abbreviation Style +href="#sec:setacronymstyle" id="QQ2-1-77">Changing the Abbreviation Style
      13.1.1 Predefined Acronym Styles +href="#sec:predefinedacrstyles" id="QQ2-1-78">Predefined Acronym Styles
      13.1.2 Defining A Custom Acronym Style +href="#sec:customacronym" id="QQ2-1-79">Defining A Custom Acronym Style
     13.2 Displaying the List of Acronyms +href="#sec:disploa" id="QQ2-1-80">Displaying the List of Acronyms
     13.3 Upgrading From the glossary Package +href="#sec:oldacronym" id="QQ2-1-81">Upgrading From the glossary Package
    14 Unsetting and Resetting Entry Flags +href="#sec:glsunset" id="QQ2-1-83">Unsetting and Resetting Entry Flags
     14.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset) +href="#sec:enableentrycount" id="QQ2-1-84">Counting the Number of Times an Entry has been Used (First Use Flag Unset)
    15 Glossary Styles +href="#sec:styles" id="QQ2-1-85">Glossary Styles
     15.1 Predefined Styles +href="#sec:predefinedstyles" id="QQ2-1-86">Predefined Styles
      15.1.1 List Styles +href="#sec:liststyles" id="QQ2-1-88">List Styles
      15.1.2 Longtable Styles +href="#sec:longstyles" id="QQ2-1-89">Longtable Styles
      15.1.3 Longtable Styles (Ragged Right) +href="#sec:longraggedstyles" id="QQ2-1-90">Longtable Styles (Ragged Right)
      15.1.4 Longtable Styles (Longtable Styles (booktabs)
      15.1.5 Supertabular Styles +href="#sec:superstyles" id="QQ2-1-92">Supertabular Styles
      15.1.6 Supertabular Styles (Ragged Right) +href="#sec:superraggedstyles" id="QQ2-1-93">Supertabular Styles (Ragged Right)
      15.1.7 Tree-Like Styles +href="#sec:treestyles" id="QQ2-1-94">Tree-Like Styles
      15.1.8 Multicols Style +href="#sec:mcolstyles" id="QQ2-1-95">Multicols Style
      15.1.9 In-Line Style +href="#sec:inline" id="QQ2-1-97">In-Line Style
     15.2 Defining your own glossary style +href="#sec:newglossarystyle" id="QQ2-1-98">Defining your own glossary style
    16 Utilities +href="#sec:utilities" id="QQ2-1-99">Utilities + +
     16.1 Loops +href="#sec:loops" id="QQ2-1-100">Loops
     16.2 Conditionals +href="#sec:conditionals" id="QQ2-1-101">Conditionals
     16.3 Fetching and Updating the Value of a Field +href="#sec:fetchset" id="QQ2-1-102">Fetching and Updating the Value of a Field
    17 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-103">Prefixes or Determiners
    18 Accessibility Support - - +href="#sec:accsupp" id="QQ2-1-104">Accessibility Support
    19 Troubleshooting +href="#sec:trouble" id="QQ2-1-105">Troubleshooting

    @@ -717,6 +820,26 @@ class="cmtt-10">glossaries}

    +bib2gls

    An indexing application that combines two functions in one: (1) fetches entry + definition from a .bib file based on information provided in the .aux file (similar + to bibtex); (2) hierarchically sorts and collates location lists (similar to makeindex + and xindy). This application is designed for use with glossaries-extra and can’t be + used with just the base glossaries package.
    +
    Command Line Interface (CLI)
    Entry location

    The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple locations.
    Extended Latin Alphabet

    An alphabet consisting of Latin characters and s and extended Latin characters.
    s.
    + +
    Extended Latin Character

    A character that’s created by combining Latin characters to form ligatures (e.g. æ) + id="dx1-3007">s to form ligatures (e.g. æ) or by applying diacritical marks to a Latin character or characters (e.g. á or ø). + id="dx1-3008"> or characters (e.g. á or ø). See also non-Latin character.
    .
    - - First use

    The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \gls, \Gls, \GLS\Gls, \glspl\GLS, \glspl, \Glspl, + id="dx1-3015">, \GLSpl or or \glsdisp. (See . (See first use flag & first use text.)
    @@ -794,36 +917,36 @@ class="newline" /> First use flag

    A conditional that determines whether or not the entry has been used according to the rules of first use. Commands to unset or reset this conditional are described in §14 §14 Unsetting and Resetting Entry Flags.
    First use text

    The text that is displayed on first use, which is governed by the first and + id="dx1-3020"> and firstplural keys of keys of \newglossaryentry. (May be overridden by . (May be overridden by \glsdisp or by + id="dx1-3023"> or by \defglsentry.)
    .)
    EX that collates and class="E">EX: makeindex and and xindy. + id="dx1-3026">. These are both command line interface (CLI) applications.
    @@ -863,18 +986,20 @@ class="newline" /> Latin Alphabet

    The alphabet consisting of Latin characters. See also s. See also extended Latin alphabet.
    + +
    Latin Character

    One of the letters a, …, z, A, …, Z. See also extended Latin character.
    .
    Link text

    The text produced by commands such as \gls. It may or may not be a hyperlink - - + id="dx1-3032">. It may or may not be a hyperlink to the glossary.
    makeglossaries

    A custom designed Perl script interface to A custom designed Perl script interface to xindy and and makeindex provided with - the glossaries package.
    provided + with the glossaries package. TEX distributions on Windows convert the original + makeglossaries script into an executable makeglossaries.exe for convenience. +
    makeglossariesgui

    A Java GUI alternative to makeglossaries that also provides diagnostic tools. + id="dx1-3037"> that also provides diagnostic tools. Available separately on CTAN.
    makeglossaries-lite.lua
    makeglossaries-lite

    A custom designed Lua script interface to xindy and and makeindex provided with + id="dx1-3040"> provided with the glossaries package. This is a cut-down alternative to the Perl makeglossaries - script. If you have Perl installed, use the Perl script instead. Note that TEX Live - creates a symbolic link called makeglossaries-lite (without the .lua extension) - to the actual makeglossaries-lite.lua, but TEX Live (on + Unix-like systems) creates a symbolic link called makeglossaries-lite (without + the .lua extension) to the actual makeglossaries-lite.lua script.
    makeindex

    An indexing application.
    Non-Latin Alphabet

    An alphabet consisting of non-Latin characters.
    s.
    Non-Latin Character

    An extended Latin character or a character that isn’t a  or a character that isn’t a Latin character.
    .
    + +
    Number list

    A list of entry locations (also called a location list). The number list can be suppressed using the nonumberlist package option.
    package option.
    Sanitize

    Converts command names into character sequences. That is, a command called, say, \, f, o, 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 sort key.
    key.

    EX Extended Latin Character

    An extended Latin character that can be created by a core LAT that can be created by a core LATEX command, such as \o (ø) or xindy

    A flexible indexing application with multilingual support written in Perl.
    -

    1.

    1. Introduction

    -

    The

    The glossaries package is provided to assist generating lists of terms, symbols or abbreviations (glossaries). It has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports glossary styles that include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary terms. Only those terms -used1.1 in the document will be added to the glossary. -

    This package replaces the glossary 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 @@ -1084,692 +1214,1516 @@ options, particularly if you use an extended Latin alphabet or a non-Latin alphabet.
    -

    -

    The basic idea behind 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 “xindy” you’ll be taken to the entry in the glossary +where there’s a brief description of the term “xindy”. This is the way the glossaries +mechanism works. An indexing application is used to generated the sorted list of +terms. The indexing applications are command line interface (CLI) tools, which +means they can be run directly from a command prompt or terminal, or can be +integrated into some text editors, or you can use a build tool such as arara to run +them. +

    The remainder of this introductory section covers the following:

    + +

    Top

    1.1 Indexing Options

    +

    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 \ref). You can also, optionally, display a list of the entries you have referenced in your document (the glossary). This last part, displaying the glossary, is the part that most new -users find difficult. There are three options: -

    -
    glossaries package and two +further options with the extension package glossaries-extra. An overview of these options is +given in table 1.1. +

    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 into your class or package code. Aside from forcing the user into a +particular indexing method, it means that they’re unable to use any commands that must +come before \makeglossaries (such as \newglossary) and they can’t switch off the indexing +whilst working on a draft document. +

    +
    + + +


    + + +
    Table 1.1: Glossary Options: Pros and Cons
    + + +
    + + + + + + + + + + + + + + + + +

    Option 1 Option 2 Option 3 Option 4 Option 1: -

    This is the simplest option but it’s slow and if you want a sorted list, it doesn’t - work well for  5

    Requires +glossaries-extra?

    Requires +an +external +application?

    Requires +Perl?

    Requires +Java?

    Can +sort +extended +Latin +alphabets +or +non-Latin +alphabets?

    * N/A

    Efficient +sort +algorithm?

    N/A

    Can +use +a +different +sort +method +for +each +glossary?

    N/A

    Any +problematic +sort +values?

    Are +entries +with +identical +sort +values +treated +as +separate +unique +entries?

    §

    Can +automatically +form +ranges +in +the +location +lists?

    Can +have +non-standard +locations +in +the +location +lists?

    Maximum +hierarchical +depth +(style-dependent)

    # 3

    \glsdisplaynumberlist +reliable?

    \newglossaryentry +allowed +in +document +environment? +(Not +recommended.)

    *
+*

    Requires +additional +write +registers?

    Default +value +of +sanitizesort +package +option

    false true true true true
    + +
    +

    ________________________________________________________________________ +

    * Strips standard LATEX accents (that is, accents generated by core LATEX commands) so, for +example, \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 location field 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=none. (The record=only option automatically switches this on.) + + +

    +

    +
    + +

    Option 1 (TEX)

    +

    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 extended Latin alphabets or non-Latin alphabets. However, if you - use the non-Latin alphabets. However, if +you use the sanitizesort=false package option (the default for Option 1) then the - package option (the default for Option 1) then the +standard LATEX accent commands will be ignored, so if an entry’s name is set - to {\’e}lite then the sort will default to elite if sanitizesort=false is used and - will default to is used and +will default to \’elite if sanitizesort=true is used. -

    This option works best with the is used. If you have any other kinds of +commands that don’t expand to ASCII characters, such as \alpha or \si, then you +must use sanitizesort=true or change the sort method (sort=use or sort=def setting. For any other setting, be - prepared for a long document build time, especially if you have a lot of entries - defined. This option is intended as a last resort for alphabetical sorting. - This option is not suitable for hierarchical glossaries. -

      -
    1. Add \makenoidxglossaries to your preamble (before you start defining - your entries, as described in §4 Defining Glossary Entries). -
    2. -
    3. Put -


      \printnoidxglossary

      + id="dx1-6006">) in the +package options or explicitly set the sort key when you define the relevant entries. For +example: -

      - where you want your list of entries to appear (described in §10 Displaying a - glossary). -

    4. -
    5. Run LATEX twice on your document. (As you would do to make a table of - contents appear.) For example, click twice on the “typeset” or “build” or - “PDFLATEX” button in your editor.
    -
    -
    Option 2: -

    This option uses a command line interface (CLI) application called makeindex to sort - the entries. This application comes with all modern TEX distributions, but it’s - hard-coded for the non-extended Latin alphabet, so it doesn’t work well for extended - Latin alphabets or non-Latin alphabets. This process involves making LATEX write - the glossary information to a temporary file which +

    +

    +

    This option works best with the sort=def or sort=use setting. For any other setting, be +prepared for a long document build time, especially if you have a lot of entries defined. This +option is intended as a last resort for alphabetical sorting. This option allows a +mixture of sort methods. (For example, sorting by word order for one glossary and order of +use for another.) This option is not suitable for hierarchical glossaries and does not form +ranges in the number lists. If you really can’t use an indexing application consider using +Option 5 instead. +

    +

      +
    1. Add + + +
      + \makenoidxglossaries +
      +

      to your preamble (before you start defining your entries, as described in §4 Defining + Glossary Entries). +

    2. +
    3. Put + + +
      + \printnoidxglossary +
      +

      where you want your list of entries to appear (described in §10 Displaying a glossary). + Alternatively, to display all glossaries use the iterative command: + + +

      +
      + \printnoidxglossaries +
      +

      +

    4. +
    5. Run LATEX twice on your document. (As you would do to make a table of contents + appear.) For example, click twice on the “typeset” or “build” or “PDFLATEX” button + in your editor.
    +

    Complete example: + + +

    +
    +\documentclass{article} + 
    \usepackage{glossaries} + 
    \makenoidxglossaries % use TeX to sort + 
    \newglossaryentry{sample}{name={sample}, + 
      description={an example}} + 
    \begin{document} + 
    \gls{sample}. + 
    \printnoidxglossary + 
    \end{document} +
    +

    + +

    +

    +

    Option 2 (makeindex)

    +

    This option uses a CLI application called makeindex reads. Then to sort the entries. This application +comes with all modern TEX distributions, but it’s hard-coded for the non-extended Latin +alphabet. It can’t correctly sort accent commands (such as \’ or \c) and fails with UTF-8 +characters, especially for any sort values that start with a UTF-8 character (as it separates +the octets resulting in an invalid file encoding). This process involves making LATEX write +the glossary information to a temporary file which makeindex - writes a new file containing the code to typeset the glossary. LATEX then reads this - file in on the next run. -

    This option works best if you want to sort entries according to the English alphabet and - you don’t want to install Perl. -

      -
    1. If you want to use reads. Then makeindex writes +a new file containing the code to typeset the glossary. Then \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 +you don’t want to install Perl (or Java or you don’t want to use glossaries-extra). This method +can also work with the restricted shell escape since makeindex’s is considered a trusted +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 number list but only accepts limited number formats: +\arabic, \roman, \Roman, \alph and \Alph. +

      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 makeindex for each glossary type. (The glossaries-extra package allows a hybrid +mix of Options 1 and 2 to provide word/letter ordering with Option 2 and order of +use/definition with Option 1. See the glossaries-extra documentation for further +details.) +

      +

        +
      1. If you want to use makeindex’s -g option you must change the quote character - using option you must change the quote character using + + + \GlsSetQuote. For example: + id="dx1-7015">. For example: -
        - \GlsSetQuote{+} +
        + \GlsSetQuote{+}
        -

        This must be used before \makeglossaries. Note that if you are using -

        This must be used before \makeglossaries. Note that if you are using babel, the shorthands aren’t enabled until the start of the document, - so you won’t be able to use the shorthands in definitions made in the - preamble. -

      2. -
      3. Add \makeglossaries to your preamble (before you start defining your entries, as - described in , the + shorthands aren’t enabled until the start of the document, so you won’t be able to use + the shorthands in definitions made in the preamble. +

      4. +
      5. Add + + +
        + \makeglossaries +
        +

        to your preamble (before you start defining your entries, as described in §4 Defining Glossary Entries). -

      6. -
      7. Put -


        \printglossary

        -

        - where you want your list of entries to appear (described in §4 Defining + Glossary Entries). +

      8. +
      9. Put + + +
        + \printglossary +
        +

        where you want your list of entries to appear (described in §10 Displaying a - glossary). -

      10. -
      11. Run LAT§10 Displaying a glossary). + Alternatively, to display all glossaries use the iterative command: + + +

        +
        + \printglossaries +
        +

        +

      12. +
      13. Run LATEX on your document. This creates files with the extensions .glo and - .ist (for example, if your LAT.glo and .ist + (for example, if your LATEX document is called myDoc.tex, then you’ll have - two extra files called myDoc.tex, then you’ll have two + extra files called myDoc.glo and myDoc.ist). If you look at your - document at this point, you won’t see the glossary as it hasn’t been created - yet. -
      14. -
      15. Run myDoc.ist). If you look at your document + at this point, you won’t see the glossary as it hasn’t been created yet. (If + you use glossaries-extra you’ll see the section heading and some boilerplate + text.) +
      16. +
      17. Run makeindex with the with the .glo file as the input file and the .ist file as the style so - that it creates an output file with the extension .gls. If you have access to a - terminal or a command prompt (for example, the MSDOS command prompt for - Windows users or the bash console for Unix-like users) then you need to run the - command: + terminal or a command prompt (for example, the MSDOS command prompt for + Windows users or the bash console for Unix-like users) then you need to run the + command: -
        - makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +
        + 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 you don’t know how to use the command prompt, then you can - probably access EX document file. Avoid spaces in the + file name if possible.) If you don’t know how to use the command prompt, + then you can probably access makeindex via your text editor, but each editor has a different - method of doing this, so I can’t give a general description. You will have to check - your editor’s manual. -

        The default sort is word order (“sea lion” comes before “seal”). If you want letter - ordering you need to add the via your text editor, but each editor + has a different method of doing this, so I can’t give a general description. + You will have to check your editor’s manual. The simplest approach is to use + arara and add the following comment lines to the start of your document: +

        +
        + % arara: pdflatex +
        % arara: makeglossaries +
        % arara: pdflatex +
        +
        (Replace 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 + ordering you need to add the -l switch: + id="dx1-7029"> switch:

        -
        - makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo +
        + makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
        -

        (See

        (See §1.4.4 §1.5.4 Using makeindex explicitly (Option 2) for further details on using - explicitly (Option 2) for further details on using + makeindex explicitly.) -

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

      This is the default option (although you still need to use \makeglossaries to ensure - the glossary files are created). -

    -
    Option 3: -

    This option uses a  explicitly.) If you use makeglossaries or makeglossaries-lite + then use the order=letter package option and the -l option will be added + automatically. +

    +
  • Once you have successfully completed the previous step, you can now run LATEX on + your document again. You’ll need to repeat the process if you have used the toc option + (unless you’re using glossaries-extra) to ensure the section heading is added + to the table of contents. You’ll also need to repeat the process if you have + any cross-references which can’t be indexed until the glossary file has been + created.
  • +

    Complete example: + + +

    +
    +\documentclass{article} + 
    \usepackage{glossaries} + 
    \makeglossaries % open glossary files + 
    \newglossaryentry{sample}{name={sample}, + 
     description={an example}} + 
    \begin{document} + 
    \gls{sample}. + 
    \printglossary + 
    \end{document} +
    +

    + +

    +

    +

    Option 3 (xindy)

    +

    This option uses a CLI application called xindy to sort the entries. This application is - more flexible than to sort the entries. This application is more +flexible than makeindex and is able to sort extended Latin alphabets or non-Latin - alphabets. The non-Latin alphabets, +however it does still have some limitations. +

    The xindy application comes with TEX Live and now also with MiKTEX. - Since application comes with both TEX Live and MiKTEX, but since xindy is a Perl script, you will also need to install Perl, if you don’t already have - it. In a similar way to is a +Perl script, you will also need to install Perl, if you don’t already have it. In a similar way to +Option 2, this option involves making LATEX write the - glossary information to a temporary file which EX write the glossary information to +a temporary file which xindy reads. Then reads. Then xindy writes a new - file containing the code to typeset the glossary. LATEX then reads this file in on the - next run. -

    This is the best option if you want to sort according to a language other than English or - if you want non-standard location lists. -

      -
    1. Add the writes a new file containing the +code to typeset the glossary. Then \printglossary reads this file in on the next +run. +

      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 §11 Xindy (Option 3)). There are some problems with certain sort +values:

      +
        +
      • entries with the same sort value are merged by xindy into a single glossary line + so you must make sure that each entry has a unique sort value; +
      • +
      • xindy forbids empty sort values; +
      • +
      • xindy automatically strips control sequences, the math-shift character $ and + braces {} from the sort value, which is usually desired but this can cause the sort + value to collapse to an empty string which xindy forbids.
      +

      In these problematic cases, you must set the sort field explicitly. For example: + + +

      +
      +\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + 
       sort={alpha},description={...}} +
      +

      +

      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 +of Options 1 and 3 to provide word/letter ordering with Option 3 and order of +use/definition with Option 1. See the glossaries-extra documentation for further +details.) +

      +

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

        -

      2. -
      3. Add

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

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

        or use either \GlsSetXdyFirstLetterAfterDigits{letter} or \GlsSetXdyNumberGroupOrder + {spec} to indicate where the number group should be placed (see §11 Xindy (Option + 3)). +

      4. +
      5. Add \makeglossaries to your preamble (before you start defining your entries, as - described in §4 §4 Defining Glossary Entries). -
      6. -
      7. Run LAT +
      8. Run LATEX on your document. This creates files with the extensions .glo and - .xdy (for example, if your LAT.glo and .xdy + (for example, if your LATEX document is called myDoc.tex, then you’ll have - two extra files called myDoc.tex, then you’ll have two extra + files called myDoc.glo and myDoc.xdy). If you look at your - document at this point, you won’t see the glossary as it hasn’t been created - yet. -
      9. -
      10. Run myDoc.xdy). If you look at your document at this point, you + won’t see the glossary as it hasn’t been created yet. (If you’re using the extension + package glossaries-extra, you’ll see the section header and some boilerplate + text.) +
      11. +
      12. Run xindy with the with the .glo file as the input file and the .xdy file as a module so - that it creates an output file with the extension .gls. You also need to set the - language name and input encoding. If you have access to a terminal or a command - prompt (for example, the MSDOS command prompt for Windows users or the - bash console for Unix-like users) then you need to run the command (all on one - line): +class="cmtt-10">.xdy file as a module so that it + creates an output file with the extension .gls. You also need to set the language name + and input encoding. If you have access to a terminal or a command prompt + (for example, the MSDOS command prompt for Windows users or the bash + console for Unix-like users) then you need to run the command (all on one + line): -
        - xindy -L english -C utf8 -I xindy -M myDoc -  
        -t myDoc.glg -o myDoc.gls myDoc.glo +
        + 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 english with the name of your language - and utf8 with your input encoding, for example, EX document file. Avoid spaces in the + file name. If necessary, also replace english with the name of your language and utf8 + with your input encoding, for example, -L german -C din5007-utf8.) If - you don’t know how to use the command prompt, then you can probably access - din5007-utf8.) Note that it’s + much simpler to use makeglossaries instead: + + +

        +
        + makeglossaries myDoc +
        +

        (Remember that xindy is a Perl script so if you can use xindy then you can also use + makeglossaries, and if you don’t want to use makeglossaries because you don’t want + to install Perl, then you can’t use xindy via your text editor, but each editor has a different method of doing this, so - I can’t give a general description. You will have to check your editor’s - manual. -

        The default sort is word order (“sea lion” comes before “seal”). If you want letter - ordering you need to add the either.) +

        If you don’t know how to use the command prompt, then you can probably + access xindy or makeglossaries via your text editor, but each editor has a + different method of doing this, so I can’t give a general description. You + will have to check your editor’s manual. Again, a convenient method is to + use arara and add the follow comment lines to the start of your document: +

        +
        + % arara: pdflatex +
        % arara: makeglossaries +
        % arara: pdflatex +
        +
        +

        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: + id="dx1-8034"> package option:

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

        (and return to the previous step.) See

        (and return to the previous step). This option is picked up by makeglossaries. If you + are explicitly using xindy then you’ll need to add -M ord/letorder to the options list. + See §1.4.3 §1.5.3 Using xindy explicitly (Option 3) for - further details on using explicitly (Option 3) for further details on using xindy explicitly. -

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

    There is a fourth option available if you use the extension package glossaries-extra (as from -v1.08). See the record package option in the glossaries-extra user manual for further -details. -

    For Options 2 and 3, it can be difficult to remember all the parameters required for + id="dx1-8038"> + explicitly. +

    +
  • Once you have successfully completed the previous step, you can now run + LATEX on your document again. As with the previous option, you may need to + repeat the process to ensure the table of contents and cross-references are + resolved. +
  • +

    Complete example: + + +

    +
    +\documentclass{article} + 
    \usepackage[xindy]{glossaries} + 
    \makeglossaries % open glossary files + 
    \newglossaryentry{sample}{name={sample}, + 
     description={an example}} + 
    \begin{document} + 
    \gls{sample}. + 
    \printglossary + 
    \end{document} +
    +

    makeindex or xindy, so the glossaries package provides a Perl script called makeglossaries -that reads the .aux file to determine what settings you have used and will then run + id="x1-8041r4"> +

    +

    +

    Option 4 (bib2gls)

    +

    This option is only available with the extension package glossaries-extra. This method uses makeindex or xindy. Again, this is a command line application and can be run in a terminal -or command prompt. For example, if your LATEX document is in the file myDoc.tex, then -run: +href="#glo:bib2gls">bib2gls to both fetch entry definitions from .bib files and to hierarchically sort and +collate. +

    All entries must be provided in one or more .bib files. (See the bib2gls user manual for +the required format.) The glossaries-extra package needs to be loaded with the record package +option

    -
    -makeglossaries myDoc +
    +\usepackage[record]{glossaries-extra}
    -

    (Replace myDoc with the base name of your LATEX document file. Avoid spaces in the file -name.) This is described in more detail in §1.4 Generating the Associated Glossary -Files. -

    If you don’t have Perl installed you can use the Lua script instead: +

    or (equivalently)

    -
    -makeglossaries-lite.lua myDoc +
    +\usepackage[record=only]{glossaries-extra}
    -

    This script doesn’t have the full functionality of the Perl script, but since modern -TEX distributions come with Lua, you shouldn’t need to install anything extra to make it -run. Remember that since xindy is also a Perl script, if you want to use xindy you’ll need -Perl installed anyway, so there’s no point using this Lua script if you’re using

    (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 \GlsXtrLoadResources[options]. For example: + + +

    +
    +\GlsXtrLoadResources + 
    [% definitions in entries1.bib and entries2.bib: + 
     src={entries1,entries2}, + 
     sort={de-CH-1996}% sort according to this locale + 
    ] +
    +

    You can have multiple resource commands. +

    The glossary is displayed using + + +

    +
    +\printunsrtglossary +
    +

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

    +
    +\printunsrtglossaries +
    +

    The document is build using: + + +

    +
    +pdflatex myDoc + 
    bib2gls myDoc + 
    pdflatex myDoc +
    +

    If letter groups are required, you need the --group switch: + + +

    +
    +bib2gls --group myDoc +
    +

    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 +(if required) their associated letter group. This option allows a mixture of sort methods. +(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 +Locale Data Repository, which provides more extensive language support than +xindy. Note -that TEX Live 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 .gls and .glo are temporary files created to help build your document. You should -not edit or explicitly input them. However, you may need to delete them if something goes -wrong and you need to do a fresh build.
    -

    -

    An overview of these three options is given in table 1.1. + id="dx1-9004">.1.2 The +locations in the number list may be in any format. If bib2gls can deduce a numerical value it +will attempt to form ranges otherwise it will simply list the locations. +

    Complete example: + +

    -
    +
    +\documentclass{article} + 
    \usepackage[record]{glossaries-extra} + 
    \GlsXtrLoadResources[src={entries}] + 
    \begin{document} + 
    \gls{sample}. + 
    \printunsrtglossary + 
    \end{document} +
    +

    where entries.bib contains -


    +

    +
    +@entry{sample, + 
     name={sample}, + 
     description={an example} + 
    } +
    +

    See the bib2gls user manual for further details. + +

    +

    +

    Option 5 (no sorting)

    +

    This option is only available with the extension package glossaries-extra. No indexing +application is required. This method is best used with the package option sort=none. -

    Table 1.1: Glossary Options: Pros and Cons
    +

    +
    +\usepackage[sort=none]{glossaries-extra} +
    +

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

    - - - - - - - - - - - - -

    Option 1 Option 2 Option 3

    Requires - an - external - application?

    Requires - Perl?

    Can - sort - extended - Latin - alphabets - or - non-Latin - alphabets?

    Efficient - sort - algorithm?

    Can - use - a - different - sort - method - for - each - glossary?

    Can - form - ranges - in - the - location - lists?

    Can - have - non-standard - locations - in - the - location - lists?

    Maximum - hierarchical - depth

    Unlimited but unreliable 3 Unlimited

    \glsdisplaynumberlist - reliable?

    \newglossaryentry - restricted - to - preamble?

    Requires - additional - write - registers?

    Default - value - of - sanitizesort - package - option

    false true true
    +

    +
    +\printunsrtglossary +
    +

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

    +
    +\printunsrtglossaries
    -

    Strips standard LATEX accents (that is, accents generated by core LATEX commands) so, -for example, \AA is treated the same as A. +

    This will display all defined entries, regardless of whether or not they have been used in the +document. The number lists have to be set explicitly otherwise they won’t appear. Note +that this uses the same command for displaying the glossary as Option 4. This is +because bib2gls 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 LATEX call

    -

    -
    -

    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 “xindy” you’ll be taken to the entry in the glossary where there’s a brief -description of the term “xindy”. -

    The remainder of this introductory section covers the following:

    - -

    Top

    1.1 +pdflatex myDoc +

    +

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

    +
    +pdflatex myDoc + 
    pdflatex myDoc +
    +

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

    Complete example: + + +

    +
    +\documentclass{article} + 
    \usepackage[sort=none]{glossaries-extra} + 
    \newglossaryentry{sample}{name={sample}, + 
     description={an example}} + 
    \begin{document} + 
    \gls{sample}. + 
    \printunsrtglossary + 
    \end{document} +
    +

    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) @@ -1783,33 +2737,46 @@ 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. -

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

    +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 CTAN mirror at http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/. -

    The sample documents are as follows1.2: +

    The sample documents are listed +below1.3 If +you prefer to use UTF-8 aware engines (xelatex or lualatex) remember that you’ll need to +switch from fontenc & inputenc to fontspec where appropriate. The glossaries-extra package +provides some additional sample files.

    minimalgls.tex
    This document is a minimal working example. You can test your + id="x1-11002r1"> This document is a minimal working example. You can test your installation using this file. To create the complete document you will need to do the following steps:
    1. Run Run minimalgls.tex through LATEX 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

      -
      +
      pdfTeX warning (dest): name{glo:aca} has been  
      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 xkeyval is out of date. Check the log file for a warning + id="dx1-11005"> is out of date. Check the log file for a warning of that nature. If this is the case, you will need to update the xkeyval package.

    2. Run If you have Perl installed, run makeglossaries on the document ( on the document (§1.4 Generating the Associated Glossary - Files). This can be done on a terminal either by typing +class="tcrm-1000">§1.5 Generating + the Associated Glossary Files). This can be done on a terminal by typing +
      makeglossaries minimalgls
      -

      - or by typing +

      + otherwise do
      perl makeglossaries minimalgls
      -

      - If your system doesn’t recognise the command perl then it’s likely you don’t have - Perl installed. In which case you will need to use makeglossaries-lite minimalgls +

      + If for some reason you want to call makeindex directly. You can do - this in a terminal by typing (all on one line): + id="dx1-11009"> explicitly, you can do this in a + terminal by typing (all on one line):
      makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo
      -

      +

      (See §1.4.4 §1.5.4 Using makeindex explicitly (Option 2) for further details on using + id="dx1-11010"> explicitly (Option 2) for further details on using makeindex explicitly.) -

      Note that if you need to specify the full path and the path contains - spaces, you will need to delimit the file names with the double-quote - character. + id="dx1-11011"> explicitly.) +

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

    3. Run 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, mwe-acr-desc.tex. sample-noidxapp.tex

    This document illustrates how to use the This document illustrates how to use the glossaries package without an external indexing application (Option 1). To create the complete document, you need to do: - -
    latex sample-noidxapp + +
    latex sample-noidxapp
    -

    +

    sample-noidxapp-utf8.tex
    As the previous example, except that it uses the As the previous example, except that it uses the inputenc + id="dx1-11016"> package. To create the complete document, you need to do:
    latex sample-noidxapp-utf8
    latex sample-noidxapp-utf8
    -

    +

    sample4col.tex
    This document illustrates a four column glossary where the entries have a + id="x1-11017r4"> This document illustrates a four column glossary where the entries have a symbol in addition to the name and description. To create the complete document, you need to do:
    latex sample4col class="cmtt-10">makeglossaries sample4col

    latex sample4col -

    - As before, if you don’t have Perl installed, you will need to use makeindex directly - instead of using makeglossaries. The vertical gap between entries is the gap created at - the start of each group. This can be suppressed using the

    + or +
    latex sample4col +
    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 nogroupskip package - option. + id="dx1-11018"> package option.

    sampleAcr.tex
    This document has some sample acronyms. It also adds the glossary to the - table of contents, so an extra run through LATEX is required to ensure the document - is up to date: + id="x1-11019r5"> This document has some sample abbreviations. It also adds the glossary to + the table of contents, so an extra run through LATEX is required to ensure the + document is up to date:
    latex sampleAcr
    makeglossaries sampleAcr class="cmtt-10">latex sampleAcr

    latex sampleAcr
    -

    +

    + (or use makeglossaries-lite).

    sampleAcrDesc.tex
    This is similar to the previous example, except that the acronyms + id="x1-11021r6"> This is similar to the previous example, except that the abbreviations have an associated description. As with the previous example, the glossary is + + added to the table of contents, so an extra run through LATEX is required:
    latex sampleAcrDesc - -
    makeglossaries sampleAcrDesc
    latex sampleAcrDesc
    latex sampleAcrDesc
    -

    +

    sampleDesc.tex
    This is similar to the previous example, except that it defines the acronyms - using This is similar to the previous example, except that it defines the + abbreviations using \newglossaryentry instead of instead of \newacronym. As with the previous example, the - glossary is added to the table of contents, so an extra run through LATEX is required: - + id="dx1-11024">. As with the previous + example, the glossary is added to the table of contents, so an extra run through + LATEX is required:
    latex sampleDesc
    makeglossaries sampleDesc class="cmtt-10">latex sampleDesc

    latex sampleDesc
    -

    +

    sampleCustomAcr.tex
    This document has some sample acronyms with a custom acronym - style. It also adds the glossary to the table of contents, so an extra run through + id="x1-11025r8"> This document has some sample abbreviations with a custom + acronym style. It also adds the glossary to the table of contents, so an extra run through LATEX is required:
    makeglossaries sampleCustomAcr class="cmtt-10">latex sampleCustomAcr

    latex sampleCustomAcr -

    +

    sampleFnAcrDesc.tex
    This is similar to This is similar to sampleAcrDesc.tex, except that it uses the footnote-sc-desc style. As with the previous example, the glossary is added to the table + id="dx1-11027"> style. As with the previous example, the glossary is added to the table of contents, so an extra run through LATEX is required:
    makeglossaries sampleFnAcrDesc class="cmtt-10">latex sampleFnAcrDesc

    latex sampleFnAcrDesc -

    +

    sample-FnDesc.tex
    This example defines a custom display format that puts the description + id="x1-11028r10"> This example defines a custom display format that puts the description in a footnote on first use.
    latex sample-FnDesc @@ -2056,12 +3025,12 @@ class="cmtt-10">latex sample-FnDesc
    class="cmtt-10">makeglossaries sample-FnDesc
    latex sample-FnDesc -

    +

    sample-custom-acronym.tex
    This document illustrates how to define your own acronym + id="x1-11029r11"> This document illustrates how to define your own acronym style if the predefined styles don’t suit your requirements.
    latex sample-custom-acronym @@ -2069,12 +3038,12 @@ class="cmtt-10">latex sample-custom-acronym
    class="cmtt-10">makeglossaries sample-custom-acronym
    latex sample-custom-acronym -

    +

    sample-crossref.tex
    This document illustrates how to cross-reference entries in the + id="x1-11030r12"> This document illustrates how to cross-reference entries in the glossary.
    latex sample-crossref @@ -2082,12 +3051,12 @@ class="cmtt-10">latex sample-crossref
    class="cmtt-10">makeglossaries sample-crossref
    latex sample-crossref -

    +

    sample-dot-abbr.tex
    This document illustrates how to use the post link hook to adjust the + id="x1-11031r13"> This document illustrates how to use the post link hook to adjust the space factor after abbreviations.
    latex sample-dot-abbr @@ -2095,18 +3064,18 @@ class="cmtt-10">latex sample-dot-abbr
    class="cmtt-10">makeglossaries sampledot-abbrf
    latex sample-dot-abbr -

    +

    sampleDB.tex
    This document illustrates how to load external files containing the glossary + id="x1-11032r14"> This document illustrates how to load external files containing the glossary definitions. It also illustrates how to define a new glossary type. This document has the number list suppressed and uses suppressed and uses \glsaddall to add all the entries to the + id="dx1-11034"> to add all the entries to the glossaries without referencing each one explicitly. To create the document do: @@ -2117,46 +3086,107 @@ class="cmtt-10">latex sampleDB class="cmtt-10">makeglossaries sampleDB
    latex sampleDB -

    +

    + or +
    latex sampleDB +
    makeglossaries-lite sampleDB +
    latex sampleDB
    +

    The glossary definitions are stored in the accompanying files database1.tex and database2.tex. Note that if you don’t have Perl installed, you will need to use - database2.tex. If for some reason you want to call makeindex twice instead of a single call to makeglossaries: + id="dx1-11035"> explicitly you must have + a separate call for each glossary:

    1. Create the main glossary (all on one line): + class="enumerate" id="x1-11037x1"> + Create + the + main + glossary + (all + on + one + line): +
      makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls +class="cmtt-10">makeindex
      + -s + sampleDB.ist + -t + sampleDB.glg + -o + sampleDB.gls sampleDB.glo
      -

      +

    2. Create the secondary glossary (all on one line): + class="enumerate" id="x1-11039x2"> + Create + the + secondary + glossary + (all + on + + + one + line): +
      makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not +class="cmtt-10">makeindex
      + -s + sampleDB.ist + -t + sampleDB.nlg + -o + sampleDB.not sampleDB.ntn
      -

      -

    +

    + Note that both makeglossaries and makeglossaries-lite do this all in one call, + so they not only make it easier because you don’t need to supply all the switches + and remember all the extensions but they also call makeindex the appropriate + number of times.

    sampleEq.tex
    This document illustrates how to change the location to something other + id="x1-11043r15"> This document illustrates how to change the location to something other than the page number. In this case, the equation counter is used since all glossary entries appear inside an equation environment. To create the document do: + id="dx1-11044"> environment. To create the document do:
    latex sampleEq @@ -2164,14 +3194,14 @@ class="cmtt-10">latex sampleEq
    class="cmtt-10">makeglossaries sampleEq
    latex sampleEq -

    +

    sampleEqPg.tex
    This is similar to the previous example, but the This is similar to the previous example, but the number lists + id="dx1-11047">s are a mixture of page numbers and equation numbers. This example adds the glossary to the table of contents, so an extra LATEX run is required: @@ -2184,19 +3214,19 @@ class="cmtt-10">makeglossaries sampleEqPg class="cmtt-10">latex sampleEqPg
    latex sampleEqPg -

    - - +

    sampleSec.tex
    This document also illustrates how to change the location to something + id="x1-11048r17"> This document also illustrates how to change the location to something other than the page number. In this case, the section counter is used. This example adds the glossary to the table of contents, so an extra LATEX run is required: + +
    latex sampleSec
    makeglossaries sampleSec class="cmtt-10">latex sampleSec

    latex sampleSec -

    +

    sampleNtn.tex
    This document illustrates how to create an additional glossary type. This + id="x1-11049r18"> This document illustrates how to create an additional glossary type. This example adds the glossary to the table of contents, so an extra LATEX run is required: @@ -2222,98 +3252,151 @@ class="cmtt-10">makeglossaries sampleNtn class="cmtt-10">latex sampleNtn
    latex sampleNtn -

    - Note that if you don’t have Perl installed, you will need to use

    + Note that if you want to call makeindex twice instead - of a single call to explicitly instead of using makeglossaries: + id="dx1-11051"> or + makeglossaries-lite then you need to call makeindex twice:

    1. Create the main glossary (all on one line): + class="enumerate" id="x1-11055x1"> + Create + the + main + glossary + (all + on + one + line): +
      makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls +class="cmtt-10">makeindex
      + -s + sampleNtn.ist + -t + sampleNtn.glg + -o + sampleNtn.gls sampleNtn.glo
      -

      +

    2. + +
    3. Create the secondary glossary (all on one line): + class="enumerate" id="x1-11057x2"> + Create + the + secondary + glossary + (all + on + one + line): +
      makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not +class="cmtt-10">makeindex
      + -s + sampleNtn.ist + -t + sampleNtn.nlg + -o + sampleNtn.not sampleNtn.ntn
      -

      +

    sample.tex
    This document illustrates some of the basics, including how to create child + id="x1-11058r19"> This document illustrates some of the basics, including how to create child entries that use the same name as the parent entry. This example adds the glossary to the table of contents and it also uses \glsrefentry, so an extra LAT, so an extra LATEX run is required:
    latex sample - -
    makeglossaries sample
    latex sample
    latex sample
    -

    +

    You can see the difference between word and letter ordering if you substitute order=word with with order=letter. (Note that this will only have an effect if you use + id="dx1-11061">. (Note that this will only have an effect if you use makeglossaries. If you use or makeglossaries-lite. If you use makeindex explicitly, you will need to use the explicitly, you will + need to use the -l switch to - indicate letter ordering.) + id="dx1-11065"> switch to indicate letter ordering.)

    sample-inline.tex
    This document is like This document is like sample.tex, above, but uses the inline glossary + id="dx1-11067"> glossary style to put the glossary in a footnote.
    sampletree.tex
    This document illustrates a hierarchical glossary structure where child + id="x1-11068r21"> This document illustrates a hierarchical glossary structure where child entries have different names to their corresponding parent entry. To create the document do:
    latex sampletree + +
    makeglossaries sampletree
    latex sampletree
    -

    +

    sample-dual.tex
    This document illustrates how to define an entry that both appears in + id="x1-11069r22"> This document illustrates how to define an entry that both appears in the list of acronyms and in the main glossary. To create the document do:
    latex sample-dual class="cmtt-10">makeglossaries sample-dual

    latex sample-dual -

    +

    sample-langdict.tex
    This document illustrates how to use the glossaries package to create + id="x1-11070r23"> This document illustrates how to use the glossaries package to create English to French and French to English dictionaries. To create the document do:
    latex sample-langdict class="cmtt-10">makeglossaries sample-langdict

    latex sample-langdict -

    - - +

    samplexdy.tex
    This document illustrates how to use the This document illustrates how to use the glossaries package with xindy + id="dx1-11072"> instead of makeindex. The document uses UTF8 encoding (with the . The document uses UTF8 encoding (with the inputenc package). + id="dx1-11074"> package). The encoding is picked up by makeglossaries. By default, this document will + id="dx1-11075">. By default, this document will create a xindy style file called style file called samplexdy.xdy, but if you uncomment the lines -
    +
    \setStyleFile{samplexdy-mc}  
    \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 makeglossaries, you don’t - need to supply any additional information. If you don’t use or + makeglossaries-lite, you don’t need to supply any additional information. If you + don’t use makeglossaries, you will - need to specify the required information. Note that if you set the style file to - , you will need to specify the required information. Note that + if you set the style file to samplexdy-mc.xdy you must also specify \noist, otherwise the glossaries - package will overwrite samplexdy-mc.xdy and you will lose the “Mc” letter - group. -

    To create the document do: + id="dx1-11080">, otherwise + the glossaries package will overwrite samplexdy-mc.xdy and you will lose the “Mc” + letter group. +

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

    - If you don’t have Perl installed, you will have to call

    + If you don’t have Perl installed then you can’t use makeglossaries, but you also can’t + use xindy! However, if for some reason you want to call xindy explicitly instead of using + id="dx1-11083"> explicitly instead of using makeglossaries. If you are using the default style file samplexdy.xdy, then do (no line - breaks): -
    xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o - samplexdy.gls samplexdy.glo
    -

    - otherwise, if you are using samplexdy-mc.xdy, then do (no line breaks): -
    xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls - (or makeglossaries-lite):

    +
      +
    • + if + you + are + using + the + default + style + file + samplexdy.xdy, + then + do + (no + line + breaks): + +
      xindy + -L + english + + + -C + utf8 + -I + xindy + -M + samplexdy + -t + samplexdy.glg + -o + samplexdy.gls + samplexdy.glo
      -

      -

    +

    +

    +
  • + if + you + are + using + samplexdy-mc.xdy, + then + do + (no + line + breaks): + +
    xindy + -I + xindy + -M + samplexdy-mc + -t + samplexdy.glg + -o + samplexdy.gls + samplexdy.glo
    +

    +

  • +
    samplexdy2.tex
    This document illustrates how to use the This document illustrates how to use the glossaries package where the location numbers don’t follow a standard format. This example will only work with xindy. To create the document do: + id="dx1-11087">. To create the document do:
    pdflatex samplexdy2 + +
    makeglossaries samplexdy2
    pdflatex samplexdy2
    -

    - If you can’t use makeglossaries then you need to do (all on one line): +

    + The + explicit + xindy + call + is: +
    xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o +class="cmtt-10">xindy
    samplexdy2.gls samplexdy2.glo - - -

    +class="cmtt-10">-L + english + -C + utf8 + -I + xindy + -M + samplexdy2 + -t + samplexdy2.glg + -o + samplexdy2.gls + samplexdy2.glo +

    See §11.2 §11.2 Locations and Number lists for further details.

    samplexdy3.tex
    This document is like 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. +
    +sampleutf8.tex
    This is another example that uses This is another example that uses xindy. Unlike . Unlike makeindex, , xindy can + id="dx1-11095"> can cope with non-Latin characters. This document uses UTF8 encoding. To create the + id="dx1-11096">s. This document uses UTF8 encoding. To create the document do:
    latex sampleutf8 @@ -2476,23 +3684,53 @@ class="cmtt-10">latex sampleutf8
    class="cmtt-10">makeglossaries sampleutf8
    latex sampleutf8 -

    - If you don’t have Perl installed, you will have to call

    + The + explicit + xindy explicitly instead of using - makeglossaries (no line breaks): + id="dx1-11097"> + + + call + is + (no + line + breaks): +
    xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o +class="cmtt-10">xindy
    + -L sampleutf8.gls sampleutf8.glo
    -

    -

    If you remove the english + -C + utf8 + -I + xindy + -M + sampleutf8 + -t + sampleutf8.glg + -o + sampleutf8.gls + sampleutf8.glo +

    +

    If you remove the xindy option from option from sampleutf8.tex and do:
    latex sampleutf8 @@ -2500,35 +3738,97 @@ class="cmtt-10">latex sampleutf8
    class="cmtt-10">makeglossaries sampleutf8

    latex sampleutf8 -

    - you will see that the entries that start with an extended Latin character now appear in - the symbols group, and the word “manœuvre” is now after “manor” instead of before it. - If you are unable to use makeglossaries, the call to

    + or +
    latex sampleutf8 +
    makeglossaries-lite sampleutf8 +
    latex sampleutf8
    +

    + you + will + see + that + the + entries + that + start + with + an + + + extended + Latin + character + now + appear + in + the + symbols + group, + and + the + word + “manœuvre” + is + now + after + “manor” + instead + of + before + it. + If + you + want + to + explicitly + call + makeindex is as follows (no line - breaks): + id="dx1-11100"> + (no + line + breaks): +
    makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls +class="cmtt-10">makeindex
    + -s + sampleutf8.ist + -t + sampleutf8.glg + -o + 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 calls to ensure the document is up to date: - + id="dx1-11102"> (or makeglossaries-lite) calls to ensure + + + 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-11105r30"> 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-11106r31"> 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-11107r32"> 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-11108r33"> 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-11110"> 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-11111r35"> 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-11112r36"> 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: - -
    latex sampleSort
    makeglossaries sampleSort class="cmtt-10">latex sampleSort

    latex sampleSort -

    +

    sample-nomathhyper.tex
    This document illustrates how to selectively enable and disable + id="x1-11113r37"> This document illustrates how to selectively enable and disable entry hyperlinks in \glsentryfmt. + id="dx1-11114">.
    sample-entryfmt.tex
    This document illustrates how to change the way an entry is + id="x1-11115r38"> 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-11117"> 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-11119"> 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 §18 §18 Accessibility Support.
    sample-ignored.tex
    This document defines an ignored glossary for common terms that + id="x1-11120r41"> This document defines an ignored glossary for common terms that don’t need a definition. + +
    sample-entrycount.tex
    This document uses This document uses \glsenableentrycount and and \cgls (described + id="dx1-11123"> (described in §14.1 §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.2

    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 + id="dx1-12001"> also provides some files containing lorum ipsum dummy entries. These are provided for testing purposes and are on TEX’s path (in tex/latex/glossaries/test-entries) so they can be included via \input or + id="dx1-12002"> or \loadglsentries. The files are as follows: + id="dx1-12003">. The files are as follows:

    example-glossaries-brief.tex
    These entries all have brief descriptions. -
    +class="description">These entries all have brief descriptions. For example: + + +
    + \newglossaryentry{lorem}{name={lorem},description={ipsum}} +
    +

    +

    example-glossaries-long.tex
    These entries all have long descriptions. -
    +class="description">These entries all have long descriptions. For example: + + +
    + \newglossaryentry{loremipsum}{name={lorem ipsum}, +  
    description={dolor sit amet, consectetuer adipiscing +  
    elit. Ut purus elit, vestibulum ut, placerat ac, +  
    adipiscing vitae, felis. Curabitur dictum gravida +  
    mauris.}} +
    +

    +

    example-glossaries-multipar.tex
    These entries all have multi-paragraph - descriptions. +class="description">These entries all have multi-paragraph descriptions.
    example-glossaries-symbols.tex
    These entries all use the symbol key. -
    + id="dx1-12004"> key. For example: + + +
    + \newglossaryentry{alpha}{name={alpha}, +  
    symbol={\ensuremath{\alpha}}, +  
    description={Quisque ullamcorper placerat ipsum.}} +
    +

    +

    +example-glossaries-symbolnames.tex
    Similar to the previous file but the symbol key isn’t + used. Instead the symbol is stored in the name key. For example: + + +
    + \newglossaryentry{sym.alpha}{sort={alpha}, +  
    name={\ensuremath{\alpha}}, +  
    description={Quisque ullamcorper placerat ipsum.}} +
    +

    +

    example-glossaries-images.tex
    These entries use the user1 key to store the name - of an image file. (The images are provided by the key to store the name of an + image file. (The images are provided by the mwe package and should be - on TEX’s path.) One entry doesn’t have an associated image to help test for - a missing key. + id="dx1-12008"> package and should be on TEX’s + path.) One entry doesn’t have an associated image to help test for a missing + key.
    example-glossaries-acronym.tex
    These entries are all acronyms. -
    +class="description">These entries are all abbreviations. For example: + + +
    + \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum +  
    dolor} +
    +

    +

    example-glossaries-acronym-desc.tex
    These entries are all acronyms that use the +class="description">These entries are all abbreviations that use the description key. -
    + id="dx1-12009"> key. For example: + + +
    + \newacronym[type=\glsdefaulttype, +  
      description={fringilla a, euismod sodales, +  
      sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} +
    +

    +

    example-glossaries-acronyms-lang.tex
    These entries are all acronyms, where some - of them have a translation supplied in the These entries are all abbreviations, where some of + them have a translation supplied in the user1 key. -
    + id="dx1-12010"> key. For example: + + +
    + \newacronym[type=\glsdefaulttype,user1={love itself}] +  
     {li}{LI}{lorem ipsum} +
    +

    +

    example-glossaries-parent.tex
    These are hierarchical entries where the child entries - use the These are hierarchical entries where the child entries use + the name key. -
    + id="dx1-12011"> key. For example: + + +
    + \newglossaryentry{sedmattis}{name={sed mattis}, +  
    description={erat sit amet} +  
    \newglossaryentry{gravida}{parent={sedmattis}, +  
      name={gravida},description={malesuada}} +
    +

    +

    example-glossaries-childnoname.tex
    These are hierarchical entries where the child entries don’t use the name key. -
    + id="dx1-12012"> key. For example: + + +
    + \newglossaryentry{scelerisque}{name={scelerisque}, +  
      description={at}} +
    +

    +

    example-glossaries-cite.tex
    These entries use the user1 key to store a citation key - (or comma-separated list of citation keys). The citations are defined in xampl.bib, - which should be available on all modern TEX distributions. One entry doesn’t - have an associated citation to help test for a missing key. + id="dx1-12013"> key to store a citation + key (or comma-separated list of citation keys). The citations are defined in + xampl.bib, which should be available on all modern TEX distributions. One + entry doesn’t have an associated citation to help test for a missing key. For + example: -
    +
    + \newglossaryentry{fusce}{name={fusce}, +  
    description={suscipit cursus sem},user1={article-minimal}} +
    +

    +

    example-glossaries-url.tex
    These entries use the These entries use the user1 key to store an URL - associated with the entry.
    -

    The sample file key to store an URL associated + with the entry. For example: + + +

    + \newglossaryentry{aenean-url}{name={aenean}, +  
     description={adipiscing auctor est}, +  
     user1={http://uk.tug.org/}} +
    +

    +

    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.3

    Top

    1.4 Multi-Lingual Support

    -

    As from version 1.17, the glossaries package can now be used with

    As from version 1.17, the glossaries package can be used with xindy as well as - as well as makeindex. If you are writing in a language that uses an extended Latin alphabet or -non-Latin alphabet it is recommended that you use . If +you are writing in a language that uses an extended Latin alphabet or non-Latin alphabet it’s +best to use Option 3 (xindy as ) or Option 4 (bib2gls) as makeindex is hard-coded for the -non-extended (Option 2) is hard-coded +for the non-extended Latin alphabet. This means that you are not restricted to the A, …, Z letter + id="dx1-13006"> and Option 1 can performed limited ASCII +comparisons. +

    This means that with Options 3 or 4 you are not restricted to the A, …, Z letter groups. If you want to use xindy, remember to use the , remember to use the xindy package option. For + id="dx1-13008"> package option. For example:

    -
    +
    \documentclass[frenchb]{article}  
    \usepackage[utf8]{inputenc}  
    \usepackage[T1]{fontenc}  
    \usepackage{babel}  
    \usepackage[xindy]{glossaries}
    -

    -

    Note that although a 

    If you want to use bib2gls, you need to use the record option with glossaries-extra +and supply the definitions in .bib files. (See the bib2gls user manual for further +details.) +

    Note that although a non-Latin character, such as é, looks like a plain character in your -tex file, with standard LATEX it’s actually a macro and can therefore cause expansion -problems. You may need to switch off the field expansions with \glsnoexpandfields. This -issue doesn’t occur with XeLaTeX. -

    If you use a , such as é, looks like a plain character +in your .tex file, with standard LATEX it’s actually a macro and can therefore +cause expansion problems. You may need to switch off the field expansions with +\glsnoexpandfields. This issue doesn’t occur with XeLaTeX or LuaLATEX. +

    +

    +

    With inputenc, if you use a non-Latin character (or other expandable) character at the start of an entry -name, you must place it in a group, or it will cause a problem for commands that convert the -first letter to upper case (e.g.  (or other expandable) character at the +start of an entry name, you must place it in a group, or it will cause a problem for +commands that convert the first letter to upper case (e.g. \Gls). For example:

    + id="dx1-13017">). For example: +

    \newglossaryentry}{elite}{name={{ group or class}}
    -
    -

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

    If you use the inputenc package, and datatool-base you may be able to omit this grouping.) +For further details, see the “UTF-8” section in the mfirstuc user manual. +

    If you are using xindy or bib2gls, the application needs to know the encoding of the +.tex file. This information is added to the .aux file and can be picked up by makeglossaries will pick up the encoding from the -auxiliary file. If you use +and bib2gls. If you use xindy explicitly instead of via explicitly instead of via makeglossaries, you may need -to specify the encoding using the , you may need to +specify the encoding using the -C option. Read the option. Read the xindy manual for further -details. -

    As from v4.24, if you are writing in German (for example, using the manual for further details of this +option. +

    As from v4.24, if you are writing in German (for example, using the ngerman package or - +package1.4 +or babel with the with the ngerman package option), and you want to use package option), and you want to use makeindex’s ’s -g option, you’ll + id="dx1-13036"> option, you’ll need to change makeindex’s quote character using: -


    ’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 + id="dx1-13039"> and any entry definitions. It’s only applicable for makeindex. This option in conjunction with . This option in conjunction with ngerman will also cause will also cause makeglossaries to + id="dx1-13042"> to use the -g switch when invoking switch when invoking makeindex. -

    Be careful of . +

    Be careful of babel’s shorthands. These aren’t switched on until the start of the + id="dx1-13045">’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. However, if you define the entries in the document and any of those shorthands happen to be special characters for makeindex or or xindy (such as the double-quote) then this will interfere + id="dx1-13047"> (such as the double-quote) then this will interfere with code that tries to escape any of those characters that occur in the sort key. + id="dx1-13048"> 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: + id="dx1-13049">’s shorthands in entry definitions. For example:

    -
    +
    \documentclass{article}  
    \usepackage[ngerman]{babel}  
    \usepackage{glossaries} @@ -2986,19 +4428,19 @@ class="cmss-10">babel\printglossaries  
    \end{document}
    -

    -

    The

    +

    The ngerman package has the shorthands on in the preamble, so they can be used if + id="dx1-13050"> package has the shorthands on in the preamble, so they can be used if \GlsSetQuote has changed the makeindex quote character. Example: + id="dx1-13051"> quote character. Example:

    -
    +
    \documentclass{article}  
    \usepackage[ngerman]{babel}  
    \usepackage{glossaries} @@ -3011,94 +4453,94 @@ class="cmtt-10">makeindex\printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    1.3.1

    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 babel or or polyglossia that uses caption hooks, you can just redefine + id="dx1-14002"> that uses caption hooks, you can just redefine these commands as appropriate. If you are using babel or or polyglossia, you need to use their + id="dx1-14004">, you need to use their caption hooks to change the defaults. See changing the words babel uses or read the babel or + id="dx1-14005"> or polyglossia documentation. If you have loaded documentation. If you have loaded babel, then , then glossaries will attempt to load + id="dx1-14008"> will attempt to load translator, unless you have used the , unless you have used the notranslate, , translate=false or or translate=babel package + id="dx1-14012"> package options. If the translator package is loaded, the translations are provided by dictionary files + id="dx1-14013"> package is loaded, the translations are provided by dictionary files (for example, glossaries-dictionary-English.dict). See the translator package for advice + id="dx1-14014"> package for advice on changing translations provided by translator dictionaries. If you can’t work out + id="dx1-14015"> dictionaries. If you can’t work out how to modify these dictionary definitions, try switching to babel’s interface using + id="dx1-14016">’s interface using translate=babel: + id="dx1-14017">:

    -
    +
    \documentclass[english,french]{article}  
    \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 + id="dx1-14018">’s caption hook mechanism. Note that if you pass the language options directly to babel rather that using the document class options or otherwise passing the same + id="dx1-14019"> rather that using the document class options or otherwise passing the same options to translator, then , then translator won’t pick up the language and no dictionaries will be + id="dx1-14021"> won’t pick up the language and no dictionaries will be loaded and babel’s caption hooks will be used instead. + id="dx1-14022">’s caption hooks will be used instead.

    -


    Table 1.2: Customised Text
    +class="content">Customised Text
    + id="dx1-14026">).

    Command Name

    Translator Key Word

    Purpose

    \glossaryname

    Glossary

    Title +class="td10">

    Title of the main @@ -3134,10 +4576,10 @@ class="td10">

    Title style="vertical-align:baseline;" id="TBL-3-3-">

    \acronymname

    Acronyms

    Title +class="td10">

    Title of the list @@ -3150,17 +4592,17 @@ class="td10">

    Title option acronym).

    \entryname

    Notation (glossaries)

    Header +class="td10">

    Header for first column @@ -3181,12 +4623,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-5-">

    \descriptionname

    Description (glossaries)

    Header +class="td10">

    Header for second column @@ -3207,12 +4649,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-6-">

    \symbolname

    Symbol (glossaries)

    Header +class="td10">

    Header for symbol column @@ -3230,14 +4672,14 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-7-">

    \pagelistname

    Page List (glossaries)

    Header +class="td10">

    Header for page list @@ -3255,12 +4697,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-8-">

    \glssymbolsgroupname

    Symbols (glossaries)

    Header +class="td10">

    Header for symbols section @@ -3278,12 +4720,12 @@ class="td10">

    Header style="vertical-align:baseline;" id="TBL-3-9-">

    \glsnumbersgroupname

    Numbers (glossaries)

    Header +class="td10">

    Header for numbers section @@ -3304,7 +4746,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 @@ -3313,98 +4755,92 @@ unmaintained status, you can volunteer to take over the maintenance by contactin href="http://www.dickimaw-books.com/contact.html" class="url" >http://www.dickimaw-books.com/contact.html. The translator dictionary files for dictionary files for 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:

    • Using babel and and translator: + id="dx1-14035">: -
      +
      \documentclass[english,french]{article}  
      \usepackage{babel}  
      \usepackage{glossaries}
      -

      (

      (translator is automatically loaded). + id="dx1-14036"> is automatically loaded).

    • Using babel: + id="dx1-14037">: -
      +
      \documentclass[english,french]{article}  
      \usepackage{babel}  
      \usepackage[translate=babel]{glossaries}
      -

      (

      (translator isn’t loaded). + id="dx1-14038"> isn’t loaded).

    • Using polyglossia: + id="dx1-14039">: -
      +
      \documentclass{article}  
      \usepackage{polyglossia}  
      \setmainlanguage{english}  
      \usepackage{glossaries}
      -

      -

    • -
    • Using ngerman: - - -
      - \documentclass{article} -  
      \usepackage{ngerman} -  
      \usepackage{glossaries} -
      -

      +

    -

    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 package and the glossaries package option translate=babel, you need to be familiar with the advice given in , you need to be familiar with the advice given in changing the words babel uses. If you are using the translator package, then you can provide your own + id="dx1-14042"> package, then you can provide your own dictionary with the necessary modifications (using \deftranslation) and load it using \usedictionary. -

    Note that the \usedictionary. If you simply want to change the title of a glossary, you can use the +title key in commands like \printglossary (but not the iterative commands like +\printglossaries). +

    Note that the translator dictionaries are loaded at the beginning of the document, so it + id="dx1-14044"> dictionaries are loaded at the beginning of the document, so it won’t have any effect if you put \deftranslation in the preamble. It should be put in your personal dictionary instead (as in the example below). See the translator documentation for + id="dx1-14045"> documentation for further details. (Now with beamer documentation.)
    -

    -

    Your custom dictionary doesn’t have to be just a translation from English to another + id="dx1-14046"> documentation.)

    +

    +

    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 @@ -3412,43 +4848,43 @@ called, say,

    -
    +
    myinstitute-glossaries-dictionary-English.dict
    -

    that contains the following: +

    that contains the following:

    -
    +
    \ProvidesDictionary{myinstitute-glossaries-dictionary}{English}  
    \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 and don’t want to use the translator interface, you can use the + id="dx1-14048"> interface, you can use the package option translate=babel. For example: + id="dx1-14049">. For example:

    -
    +
    \documentclass[british]{article}  
    \usepackage{babel}  
    \usepackage[translate=babel]{glossaries} @@ -3457,35 +4893,45 @@ class="cmss-10">translate=babel    \renewcommand*{\acronymname}{List of Acronyms}%  
    }
    -

    -

    Note that

    +

    Note that xindy provides much better multi-lingual support than and bib2gls provide much better multi-lingual support than makeindex, so -I recommend that you use xindy if you have glossary entries that contain non-Latin -characters. See , +so I recommend that you use Options 3 or 4 if you have glossary entries that contain +non-Latin characters. See §11 Xindy (Option 3) for further details. +class="tcrm-1000">§11 Xindy (Option 3) for further details on xindy, and see the +bib2gls user manual for further details of that application.

    Creating a New Language Module
    -

    The

    The glossaries package now uses the tracklang package to determine which language modules + id="dx1-15001"> package to determine which language modules need to be loaded. If you want to create a new language module, you should first read the tracklang documentation. -

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

    To create a new language module, you need to at least create two files: glossaries-lang.ldf @@ -3498,15 +4944,15 @@ example, english) and ⟨Lang⟩ is the language name used by translator (for example, + id="dx1-15003"> (for example, English). -

    Here’s an example of

    Here’s an example of glossaries-dictionary-English.dict:

    -
    +
    \ProvidesDictionary{glossaries-dictionary}{English}  
    \providetranslation{Glossary}{Glossary}  
    \providetranslation{Acronyms}{Acronyms} @@ -3517,10 +4963,10 @@ 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 + id="dx1-15004"> name for your language (so that it matches the file name glossaries-dictionary-Lang.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:

    -
    +
    \ProvidesGlossariesLang{english}  
    \glsifusedtranslatordict{English}  
    {% @@ -3592,11 +5038,11 @@ 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 translator language label ⟨ language label ⟨Lang⟩ used for the dictionary file and replace english with the root language name ⟨lang⟩. Within the definition of \glossariescaptionslang⟩, 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. These comma set before the entry is defined and so the definitions aren’t included in the caption mechanism as that’s not switched on until the start of the document. This means that the suffix in effect will be for the last loaded language. -

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

    +
     \ProvidesGlossariesLang{en-GB}  
     \RequireGlossariesLang{english}  
     \glsifusedtranslatordict{British} @@ -3653,20 +5099,20 @@ make the appropriate changes, for example:  
       }%  
     }
    -

    -

    If the translations includes

    +

    If the translations includes non-Latin characters, it’s necessary to provide code that’s + id="dx1-15006">s, 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:

    -
    +
    \ProvidesGlossariesLang{irish}  
    \glsifusedtranslatordict{Irish}  
    {% @@ -3702,16 +5148,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: dictionary label.) +

    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 @@ -3719,7 +5165,7 @@ commands:

    -
    +
    \@ifpackageloaded{polyglossia}%  
    {%  
      \newcommand*{\glossariescaptionsirish}{% @@ -3746,211 +5192,248 @@ commands:  
      }%  
    }
    -

    whereas the

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

    +

    -

    Top

    1.4

    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 Option 1. If you want to alphabetically sort your entries +href="#option3">3. You can ignore this section +if you have chosen any of the other options. If you want to alphabetically sort your entries always remember to use the sort key if the key if the name contains any LAT contains any LATEX commands.
    -

    -

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

    +

    If this section seriously confuses you, and you can’t work out how to run external +tools like makeglossaries or - or makeindex, you can try using the , you can try using the automake package option, described in package +option, described in §2.4 Sorting Options, -but you will need TEX’s shell escape enabled. -

    In order to generate a sorted glossary with compact number lists, it is necessary to use an +class="tcrm-1000">§2.4 Sorting Options, but you will need TEX’s shell escape +enabled. +

    In order to generate a sorted glossary with compact number lists, it is necessary to use an external indexing application as an intermediate step (unless you have chosen Option 1, which uses TEX to do the sorting). It is this application that creates the file containing the -code that typesets the glossary. If this step is omitted, the glossaries will not appear +class="E">EX to do the sorting or Option 5, which doesn’t perform any sorting). It is this +application that creates the file containing the code required to typeset the glossary. If this in your document. The two indexing applications that are most commonly used with -LATstep is omitted, the glossaries will not appear in your document. The two +indexing applications that are most commonly used with LATEX are makeindex and and +xindy. As from version 1.17, the glossaries package can be -used with either of these applications. Previous versions were designed to be used -with . As from version 1.17, the glossaries package can be used with either of these +applications. Previous versions were designed to be used with makeindex only. Note that xindy has much better multi-lingual support than + id="dx1-16009"> only. With +the glossaries-extra package, you can also use bib2gls as the indexing application. +(See the glossaries-extra and bib2gls user manuals for further details.) Note that xindy and bib2gls have much better multi-lingual support than makeindex, so , so +xindy is recommended if you’re not writing in English. Commands + id="dx1-16017"> or bib2gls are recommended if you’re not writing in English. Commands that only have an effect when xindy is used are described in is used are described in §11 §11 Xindy (Option 3). -

    This is a multi-stage process, but there are methods of automating -document compilation using applications such as

    This is a multi-stage process, but there are methods of automating document compilation +using applications such as latexmk and and arara. See -http://www.dickimaw-books.com/latex/thesis/html/build.html for more information. + id="dx1-16021">. With arara you can just add special +comments to your document source:

    +
    +% arara: pdflatex +
    % arara: makeglossaries +
    % arara: pdflatex
    -

    -

    The With latexmk you need to set up the required dependencies.

    +

    +

    The glossaries package comes with the Perl script makeglossaries which will run + id="dx1-16024"> which will run makeindex or or xindy on all the glossary files using a customized style file (which is created -by on all the glossary files using a customized style file (which is created by +\makeglossaries). See ). See §1.4.1 Using the makeglossaries Perl Script for further -details. Perl is stable, cross-platform, open source software that is used by a number -of TEX-related applications. Most Unix-like operating systems come with a Perl -interpreter. T§1.5.1 Using the makeglossaries Perl Script for further details. Perl is +stable, cross-platform, open source software that is used by a number of TEX-related +applications (including xindy and latexmk). Most Unix-like operating systems come with +a Perl interpreter. TEX Live also comes with a Perl interpreter. MiKTEX doesn’t come with a Perl interpreter so if you are a Windows MiKTEX user you will need to -install Perl if you want to use EX user you will need to install Perl if +you want to use makeglossaries. Further information is available at + id="dx1-16030"> or xindy. Further information is available at http://www.perl.org/about.html and MiKTeX and Perl scripts (and one Python script). -

    The advantages of using

    The advantages of using makeglossaries:

    + id="dx1-16032">:

    • It automatically detects whether to use makeindex or or xindy and sets the relevant + id="dx1-16034"> and sets the relevant application switches.
    • One call of makeglossaries will run will run makeindex//xindy for each glossary type. + id="dx1-16037"> for each glossary type.
    • + +
    • If things go wrong, makeglossaries will scan the messages from will scan the messages from makeindex or + id="dx1-16039"> or xindy and attempt to diagnose the problem in relation to the and attempt to diagnose the problem in relation to the glossaries package. This will hopefully provide more helpful messages in some cases. If it can’t diagnose the problem, you will have to read the relevant transcript file and see if you can work it out from the makeindex or or xindy messages. + id="dx1-16042"> messages.
    • If makeindex warns about multiple encap values, warns about multiple encap values, makeglossaries will detect this + id="dx1-16044"> will detect this and attempt to correct the problem.1.3 - Since xindy doesn’t warn about this, this correction is only provided by - 1.5 + This correction is only provided by makeglossaries when when makeindex is used. ( is used since + xindy uses the order of the attributes - list to determine which format should take precedence. See \GlsAddXdyAttribute - - - in uses the order of the attributes list to determine which format should take + precedence. (See \GlsAddXdyAttribute in §11.2 §11.2 Locations and Number lists.)
    -

    As from version 4.16, the

    As from version 4.16, the glossaries package also comes with a Lua script called makeglossaries-lite.lua. This is a makeglossaries-lite. This is a trimmed-down alternative to the makeglossaries Perl + id="dx1-16051"> Perl script. It doesn’t have some of the options that the Perl version has and it doesn’t attempt to diagnose any problems, but since modern TEX distributions come with LuaTEX (and therefore have a Lua interpreter) you don’t need to install anything else in order to use makeglossaries-lite.lua so it’s an alternative to makeglossaries-lite so it’s an alternative to makeglossaries if you want to use -Option 2 ( if you want to use Option 2 +(makeindex). -

    If things go wrong and you can’t work out why your glossaries aren’t being generated + id="dx1-16054">). +

    If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use makeglossariesgui as a diagnostic tool. Once you’ve fixed the + id="dx1-16055"> as a diagnostic tool. Once you’ve fixed the problem, you can then go back to using makeglossaries or or makeglossaries-lite.lua. -

    Whilst I strongly recommended that you use the makeglossaries-lite. +

    Whilst I strongly recommended that you use the makeglossaries Perl script or the - Perl script or +the makeglossaries-lite.lua Lua script, it is possible to use the makeglossaries-lite Lua script, it is possible to use the glossaries package without using those applications. However, note that some commands and package options have no effect if you explicitly run makeindex//xindy. These are listed in + id="dx1-16061">. 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, + id="dx1-16062"> because you don’t want to install Perl, you will only be able to use makeindex as as xindy also requires Perl. (Other useful Perl + id="dx1-16064"> also requires Perl. (Other useful Perl scripts include 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 makeglossaries, , makeindex or + id="dx1-16066"> or xindy run, as appropriate. For example, suppose you have defined the following + id="dx1-16067"> run, as appropriate. For example, suppose you have defined the following entries:1.4 +href="#fn6x1" id="fn6x1-bk">1.6

    -
    +
    \newglossaryentry{citrusfruit}{name={citrus fruit},  
    description={fruit of any citrus tree. (See also  
    \gls{orange})}}  
    \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 orange entry won’t appear in your glossary until yo first create the glossary and then do another run of makeglossaries, , makeindex + id="dx1-16071"> or xindy. For example, if the document is called . For example, if the document is called myDoc.tex, then you must do:
    latex myDoc class="cmtt-10">makeglossaries myDoc

    latex myDoc
    -

    +

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

    Likewise, an additional

    Likewise, an additional makeglossaries and LAT and LATEX run may be required if the document pages shift with re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of contents on the second LATEX run may push glossary entries across page boundaries, which means that the number lists in the glossary + id="dx1-16074">s 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, , xindy or + id="dx1-16076"> or makeindex via a terminal. Windows users can use the MSDOS Prompt which is usually + id="dx1-16077"> via a terminal. Windows users can use the MSDOS Prompt which is usually accessed via the Start->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. The article “Glossaries, Nomenclature, List of Symbols and Acronyms” in the “Using EX to Write a PhD Thesis” describes how to do it for TeXWorks. For other editors see the editor’s user manual for further details. -

    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 or .alg) for + id="dx1-16079">) for messages.

    -


    @@ -4142,11 +5625,11 @@ messages. class="content">Commands and package options that have no effect when using xindy or + id="dx1-16081"> or makeindex explicitly
    + id="dx1-16082"> explicitly
    Command or Package Option + id="dx1-16084">
    makeindex xindy
    order=letter use -l use -M ord/letorder
    order=word default default
    xindy=={language=lang} N/A use -Llang-Ccode
    \GlsSetXdyLanguage{lang} N/A use -Llang
    \GlsSetXdyCodePage{code} N/A use -Ccode

    -

    Top

    1.4.1

    Top

    1.5.1 Using the makeglossaries Perl Script

    -

    The

    The makeglossaries script picks up the relevant information from the auxiliary ( script picks up the relevant information from the auxiliary (.aux) file + id="dx1-17002">) file and will either call xindy or or makeindex, depending on the supplied information. Therefore, + id="dx1-17004">, depending on the supplied information. Therefore, you only need to pass the document’s name without the extension to makeglossaries. For + id="dx1-17005">. For example, if your document is called myDoc.tex, type the following in your terminal: @@ -4261,62 +5744,42 @@ class="cmtt-10">latex myDoc class="cmtt-10">makeglossaries myDoc
    latex myDoc -

    +

    You may need to explicitly load makeglossaries into Perl: + id="dx1-17006"> 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 makeglossaries Perl script. -MiKTeX also provides a wrapper makeglossaries.exe but doesn’t provide a Perl -interpreter, which is still required even if you run MiKTeX’s makeglossaries.exe, so -with MiKTeX you’ll need to install Perl. There’s more information about this at - Perl script. MiKTeX also +provides a wrapper makeglossaries.exe but doesn’t provide a Perl interpreter, which is still +required even if you run MiKTeX’s makeglossaries.exe, so with MiKTeX you’ll need to install +Perl.1.7 +There’s more information about this at http://tex.stackexchange.com/q/158796/19862 on the TeX.SX site. Alternatively, there -is a batch file called makeglossaries.bat that should be located in the same folder as the -makeglossaries Perl script. This just explicitly loads the script into Perl. If you’ve installed -Perl but for some reason your operating system can’t find perl.exe, you can edit the -makeglossaries.bat file to include the full path to perl.exe (but take care as this file will -be overwritten next time you update the glossaries package). If you move the .bat file to a -new location, you will also need to supply the full path to the makeglossaries Perl -script. (Don’t also move the Perl script as well or you may miss out on updates to -makeglossaries.) -

    The http://tex.stackexchange.com/q/158796/19862 +on the TeX.SX site. +

    The makeglossaries script attempts to fork the script attempts to fork the makeindex//xindy process + id="dx1-17011"> process using open() on the piped redirection 2>&1 | and parses the processor output t help diagnose problems. If this method fails makeglossaries will print an “Unable + id="dx1-17012"> will print an “Unable to fork” warning and will retry without redirection. If you run makeglossaries + id="dx1-17013"> on an operating system that doesn’t support this form of redirection, then you can use the -Q switch to suppress this warning or you can use the switch to suppress this warning or you can use the -k switch to + id="dx1-17015"> switch to make makeglossaries automatically use the fallback method without attempting + id="dx1-17016"> automatically use the fallback method without attempting the redirection. Without this redirection, the -q (quiet) switch doesn’t work as + id="dx1-17017"> (quiet) switch doesn’t work as well. -

    You can specify in which directory the

    You can specify in which directory the .aux, , .glo etc files are located using the etc files are located using the -d switch. For example:
    pdflatex -output-directory myTmpDir myDoc
    makeglossaries -d myTmpDir myDoc
    - - -

    +

    Note that makeglossaries assumes by default that assumes by default that makeindex//xindy is on your operating + id="dx1-17022"> is on your operating system’s path. If this isn’t the case, you can specify the full pathname using -m + id="dx1-17023"> ⟨path/to/makeindex⟩ for makeindex or or -xpath/to/xindy⟩ for xindy. -

    As from . +

    As from makeglossaries v2.18, if you are using v2.18, if you are using makeindex, there’s a check for + id="dx1-17028">, there’s a check for makeindex’s multiple encap warning. This is where different encap values (location formats) + id="dx1-17029">’s multiple encap warning. This is where different encap values (location formats) are used on the same location for the same entry. For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \makeglossaries @@ -4400,53 +5861,53 @@ are used on the same location for the same entry. For example:  
    \printglossaries  
    \end{document}
    -

    If you explicitly use

    If you explicitly use makeindex, this will cause a warning and the location list + id="dx1-17030">, this will cause a warning and the location list will be “1, 1”. That is, the page number will be repeated with each format. As from v2.18, makeglossaries will check for this warning and, if found, will attempt + id="dx1-17031"> will check for this warning and, if found, will attempt to correct the problem by removing duplicate locations and retrying. There’s no similar check for xindy as as xindy won’t produce any warning and will simply discard + id="dx1-17033"> won’t produce any warning and will simply discard duplicates. -

    The

    The makeglossaries script contains POD (Plain Old Documentation). If you want, you + id="dx1-17034"> script contains POD (Plain Old Documentation). If you want, you can create a man page for makeglossaries using using pod2man and move the resulting file onto + id="dx1-17036"> and move the resulting file onto 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 2.21.
    -

    -

    -

    -

    Top

    1.4.2 Using the makeglossaries-lite.lua Lua Script

    -

    The Lua alternative to the . The current version is 4.33.

    +

    +

    +

    +

    Top

    1.5.2 Using the makeglossaries-lite Lua Script

    +

    The Lua alternative to the makeglossaries Perl script requires a Lua interpreter, which + id="dx1-18001"> Perl script requires a Lua interpreter, which should already be available if you have a modern TEX distribution that includes LuaTEX. @@ -4454,109 +5915,106 @@ Lua is a light-weight, cross-platform scripting language, but because it& doesn’t have the full-functionality of heavy-weight scripting languages, such as Perl. The makeglossaries-lite.lua script is therefore limited by this and some of the options +class="cmtt-10">makeglossaries-lite script is therefore limited by this and some of the options available to the makeglossaries Perl script aren’t available here. (In particular the Perl script aren’t available here. (In particular the -d + id="dx1-18004"> 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.lua script can be invoked in the same way as makeglossaries-lite script can be invoked in the same way as makeglossaries. + id="dx1-18006">. For example, if your document is called myDoc.tex, then do
    makeglossaries-lite.lua myDoc
    -

    +

    or
    makeglossaries-lite myDoc
    -

    -

    +

    Some of the options available with makeglossaries are also available with + id="dx1-18007"> are also available with makeglossaries-lite.lua. For a complete list of available options, do +class="cmtt-10">makeglossaries-lite. For a complete list of available options, do
    makeglossaries-lite.lua --help
    -

    -

    +

    +

    -

    Top

    1.4.3

    Top

    1.5.3 Using xindy explicitly (Option 3)

    -

    Xindy comes with T comes with TEX Live. It has also been added to MikTEX, but if you don’t have it installed, see How 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 + id="dx1-19002"> to process the glossary files, you must make sure you have used the xindy package option: + id="dx1-19003"> package option:

    -
    +
    \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 called -implicitly via applications such as explicitly or whether it’s +called implicitly via applications such as makeglossaries or makeglossariesgui. This causes the -glossary entries to be written in raw . This causes the glossary +entries to be written in raw xindy format, so you need to use format, so you need to use -I xindy not -I + id="dx1-19008"> tex. -

    To run

    To run xindy type the following in your terminal (all on one line): + id="dx1-19009"> type the following in your terminal (all on one line):
    xindy -L language.glsbase.glo
    -

    +

    where ⟨language⟩ is the required language name, ⟨encoding⟩ is the encoding, ⟨base⟩ is the name of the document without the .tex extension and ⟨ extension and ⟨style⟩ is the name of the xindy style file + id="dx1-19011"> style file without the .xdy extension. The default name for this style file is ⟨ extension. The default name for this style file is ⟨base.xdy but can be + id="dx1-19013"> but can be changed via \setStyleFile{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 + id="dx1-19015"> package option), substituting .glg, , .gls and and .glo with the relevant extensions. For + id="dx1-19018"> with the relevant extensions. For example, if you have used the acronym package option, then you would need to do: + id="dx1-19019"> package option, then you would need to do:
    xindy -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 instead, you can replace all those calls to xindy + id="dx1-19022"> with just one call to makeglossaries: + id="dx1-19023">:
    makeglossaries myDoc
    -

    +

    Note also that some commands and package options have no effect if you use xindy explicitly + id="dx1-19024"> explicitly instead of using makeglossaries. These are listed in . These are listed in table 1.3. -

    +

    -

    Top

    1.4.4

    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 explicitly, you must make sure that you haven’t used the xindy + id="dx1-20002"> package option or the glossary entries will be written in the wrong format. To run makeindex, + id="dx1-20003">, type the following in your terminal:
    makeindex -s base.gls base.glo
    -

    +

    where ⟨base⟩ is the name of your document without the .tex extension and ⟨ extension and ⟨style.ist is the + id="dx1-20005"> is the name of the makeindex style file. By default, this is ⟨ style file. By default, this is ⟨base.ist, but may be changed via + id="dx1-20007">, but may be changed via \setStyleFile{style}. Note that there are other options, such as -l (letter ordering). See + id="dx1-20009"> (letter ordering). See the makeindex manual for further details. -

    For example, if your document is called manual for further details. +

    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 acronym package option) then you must call package option) then you must call makeindex for each glossary, + id="dx1-20012"> for each glossary, substituting .glg, , .gls and and .glo with the relevant extensions. For example, if you have used + id="dx1-20015"> with the relevant extensions. For example, if you have used the acronym package option, then you need to type the following in your terminal: + id="dx1-20016"> package option, then you need to type the following in your terminal:
    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 instead, you can replace all those calls to makeindex + id="dx1-20019"> with just one call to makeglossaries: + id="dx1-20020">:
    makeglossaries myDoc
    -

    +

    Note also that some commands and package options have no effect if you use makeindex + id="dx1-20021"> explicitly instead of using makeglossaries. These are listed in . These are listed in table 1.3. -

    +

    -

    Top

    1.4.5

    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 or makeindex and the + id="dx1-21002"> and the information needed to call those applications is stored in the auxiliary file. This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This section describes how the information is stored in the auxiliary file. -

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


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


    \@newglossary  \@newglossary{label}{out-ext}{in-ext}

    -

    +

    where ⟨in-ext⟩ is the extension of the -

    +
    \@newglossary{main}{glg}{gls}{glo}
    -

    -

    The

    +

    The indexing application’s style file is specified by -



    \@istfilename  \@istfilename{filename}

    -

    +

    The file extension indicates whether to use makeindex ( (.ist) or ) or xindy ( (.xdy). + id="dx1-21008">). Note that the glossary information is formatted differently depending on which indexing application is supposed to be used, so it’s important to call the correct one. -

    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 + id="dx1-21010"> should be used, the language and code page for each glossary is specified by -



    \@xdylanguage \@gls@codepage  \@xdylanguage{label}{label}{code}

    -

    +

    where ⟨label⟩ identifies the glossary, ⟨language⟩ is the root language (e.g. utf8). These commands are omitted if makeindex should be + id="dx1-21013"> 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. +

    +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 glossaries package options. You may omit the =true for -boolean options. (For example,

    This section describes the available glossaries package options. You may omit the +=true for boolean options. (For example, acronym is equivalent to is equivalent to acronym=true). -

    Note that ⟨). +The glossaries-extra package has additional options described in the glossaries-extra +manual. +

    Note that ⟨key⟩=⟨value⟩ package options can’t be passed via the document class options. (This includes options where the ⟨value⟩ part may be omitted, such as acronym.) + id="dx1-22003">.) This is a general limitation not restricted to the glossaries package. Options that aren’t ⟨key⟩=⟨value⟩ (such as makeindex) may be passed via the document class options. + id="dx1-22004">) may be passed via the document class options.
    -

    +

    -

    Top

    2.1 General Options

    nowarn
    This suppresses all warnings generated by the glossaries package. Don’t use this option if you’re new to using glossaries as the warnings are designed to help detect common mistakes (such as forgetting to use \makeglossaries). Note that the + id="dx1-23002">). Note that the debug=true and and debug=showtargets will override this option. + id="dx1-23004"> will override this option. +
    +nolangwarn
    This suppresses the warning generated by a missing language module.
    noredefwarn
    If you load glossaries with a class or another package that already defines glossary related commands, by default glossaries with that suppress those warnings. Other warnings will still be issued unless you use the nowarn option described above. + id="dx1-23007"> option described above.
    debug
    Introduced in version 4.24. This was a boolean option but as from v4.32 it’s now a - choice option. If no value is given,
    Introduced in version 4.24. The default setting is debug=false. This was a + boolean option but as from v4.32 it now accepts the values: false, true and + showtargets. If no value is given, debug=true is assumed. Both is assumed. Both debug=true + id="dx1-23011"> and debug=showtargets switch on the debug mode (and will automatically + id="dx1-23012"> switch on the debug mode (and will automatically cancel the nowarn option). The option). The debug=showtargets option will additionally + id="dx1-23014"> option will additionally use -



    \glsshowtarget  \glsshowtarget{target name}

    -

    - to show the hypertarget/hyperlink name in the margin when

    + to show the hypertarget or hyperlink name in the margin when \glsdohypertarget is used by commands like \glstarget and when \glsdohyperlink is used by commands + + like \gls. -

    Consider the following example document: +class="cmtt-10">\gls. This puts the information in the margin using \marginpar. If this causes a + problem, you’ll need to redefine \glsshowtarget. For example: + + +

    +
    + \renewcommand*{\glsshowtarget}[1]{\texttt{\small [#1]}} +
    +

    +

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

    -
    +
    \documentclass{article}  
    \usepackage{glossaries} -  
    \newglossaryentry{sample1}{name={sample1},description={example}} -  
    \newglossaryentry{sample2}{name={sample2},description={example}} +  
    \newglossaryentry{sample1}{name={sample1}, +  
      description={example}} +  
    \newglossaryentry{sample2}{name={sample2}, +  
      description={example}}  
    \glsadd{sample2}  
    \makeglossaries  
    \begin{document} @@ -5014,114 +6514,135 @@ class="cmtt-10">\gls.  
    \printglossaries  
    \end{document}
    -

    Here, only the

    In this case, only the sample1 entry has been indexed, even though \glsadd{sample2} - appears in the source code. This is because the associated file is opened by - \glsadd{sample2} has been used before the + associated file is opened by \makeglossaries, but \glsadd{sample2} has been used before this command. Since - the file isn’t open yet, the information can’t be written to it, which is why the sample2 - entry doesn’t appear in the glossary. -

    This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user + id="dx1-23017">. Since the file isn’t open yet, the + information can’t be written to it, which is why the sample2 entry doesn’t appear in + the glossary. +

    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 \makeglossaries (or +class="cmtt-10">\makeglossaries the + indexing is suppressed but, other than that, commands like \gls behave as + usual. It’s also possible that the user may want to temporarily comment out \makenoidxglossaries) the indexing is suppressed but, other than that, commands - like \gls behave as usual. -

    The debug mode, enabled with the \makeglossaries in order to suppress the indexing while working on a draft + version to speed compilation. Therefore \makeglossaries can’t be used to + enable \newglossaryentry and \glsadd. They must be enabled by default. (It + does, however, enable the see key as that’s a more common problem. See + below.) +

    The debug mode, enabled with the debug option, 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 + id="dx1-23019"> option, + + +

    +
    + \usepackage[debug]{glossaries} +
    +

    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⟩)(⟨line⟩) on input line ⟨text⟩) on input line ⟨line number⟩.

    -

    where ⟨

    where ⟨type⟩ is the glossary label and ⟨line⟩ is the line of text that would’ve been written to +class="cmti-10">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 but you’re sure you used commands like \glsadd or \glsaddall, try switching on the debug option and see if any information has been written to the log + id="dx1-23020"> option and see if any information has been written to the log file.

    seenoindex
    Introduced in version 4.24, this option may take one of three values: error, warn or ignore. The see key automatically indexes the cross-referenced entry using key automatically indexes the cross-referenced entry using \glsadd. This means that it suffers from the same problem as the above. If used before the relevant glossary file has been opened, the indexing can’t be performed. Since this is easy to miss, the glossaries package by default issues an error - - message if the see key is used before key is used before \makeglossaries. This option allows you to change the error into just a warning (seenoindex=warn) or ignore it + id="dx1-23024">) or ignore it (seenoindex=ignore). + id="dx1-23025">) if, for example, you want to temporarily comment out + \makeglossaries to speed up the compilation of a draft document by omitting the + indexing.
    nomain
    This suppresses the creation of the main glossary and associated .glo file, if unrequired. Note that if you use this option, you must create another glossary in which to put all your entries (either via the acronym (or (or acronyms) package option described in + id="dx1-23028">) package option described in §2.5 §2.5 Acronym Options or via the symbols, , numbers or or index options described + id="dx1-23031"> options described in §2.6 §2.6 Other Options or via \newglossary described in described in §12 §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 the following warning:

    + id="dx1-23033"> will + produce a warning.
    +

    +

    + +
    Warning: the main glossary.
    -
    If you did actually want to use the main glossary and you see this warning, check that - you have referenced the entries in that glossary via commands such as If you did actually want to use the main glossary and you see this warning, check + that you have referenced the entries in that glossary via commands such as + \gls. -
    -

    -

    + id="dx1-23034">. +
    sanitizesort
    This is a boolean option that determines whether or not to sanitize the sort + id="dx1-23036"> the sort value when writing to the external glossary file. For example, suppose you define an entry as follows: -
    +
    \newglossaryentry{hash}{name={\#},sort={#},  
     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 @@ -5190,75 +6710,78 @@ class="E">EX will try to interpret it as a parameter

    -
    +
    \newcommand{\mysortvalue}{AAA}  
    \newglossaryentry{sample}{%  
      name={sample},  
      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=true, and the default for , and the default for Option 1 is sanitizesort=false. + id="dx1-23039">.

    savewrites
    This is a boolean option to minimise the number of write registers used by the glossaries package. (Default is savewrites=false.) There are only a limited number of + id="dx1-23041">.) There are only a limited number of write registers, and if you have a large number of glossaries or if you are using a class or other packages that create a lot of external files, you may exceed the maximum number of available registers. If savewrites 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. If you run out of token registers, you can use + id="dx1-23042"> 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 + fail. Page numbers in the number list will be incorrect on page boundaries due + to TEX’s asynchronous output routine. As an alternative, you can use the etex. -

    This option can significantly slow document compilation. As an alternative, you can - use the scrwfile package (part of the KOMA-Script bundle) and not use this option. + id="dx1-23044"> package (part of the KOMA-Script bundle) and not use this option.
    -

    -

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

    If you want to use T

    +

    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 TEX’s \write18 mechanism to call mechanism to call makeindex or or xindy from + id="dx1-23047"> from your document and use savewrites, you must create the external files with + id="dx1-23048">, you must create the external files with \glswritefiles before you call makeindex//xindy. Also set . Also set \glswritefiles to nothing or \relax before the end of the document to avoid rewriting the files. For @@ -5266,253 +6789,254 @@ class="cmtt-10">\relax before the end of the document to avoid rewriting

    -
    +
    \glswritefiles  
    \write18{makeindex -s \istfilename\space  
    -t \jobname.glg -o \jobname.gls \jobname}  
    \let\glswritefiles\relax
    -

    -

    +

    +

    + In general, this package option is best avoided.

    translate
    This can take the following values:
    translate=true
    If babel has been loaded and the has been loaded and the translator package is installed, + id="dx1-23054"> package is installed, translator will be loaded and the translations will be provided by the will be loaded and the translations will be provided by the translator + id="dx1-23056"> package interface. You can modify the translations by providing your own dictionary. If the translator package isn’t installed and package isn’t installed and babel is loaded, the + id="dx1-23058"> is loaded, the glossaries-babel package will be loaded and the translations will be provided + id="dx1-23059"> package will be loaded and the translations will be provided using babel’s \addto\captionlanguage⟩ mechanism. If polyglossia has been + id="dx1-23060"> has been loaded, glossaries-polyglossia will be loaded. + id="dx1-23061"> will be loaded.
    translate=false
    Don’t provide translations, even if babel or or polyglossia has been + id="dx1-23064"> has been loaded. (Note that babel provides the command provides the command \glossaryname so that will + id="dx1-23066"> so that will still be translated if you have loaded babel.) + id="dx1-23067">.)
    translate=babel
    Don’t load the translator package. Instead load package. Instead load glossaries-babel. -

    I recommend you use . +

    I recommend you use translate=babel if you have any problems with the + id="dx1-23071"> if you have any problems with the translations or with PDF bookmarks, but to maintain backward compatibility, if babel has been loaded the default is has been loaded the default is translate=true.
    -

    + id="dx1-23073">.

    +

    -

    If

    If translate is specified without a value, is specified without a value, translate=true is assumed. If is assumed. If translate isn’t + id="dx1-23076"> isn’t specified, translate=true is assumed if is assumed if babel, , polyglossia or or translator have been loaded. + id="dx1-23080"> have been loaded. Otherwise translate=false is assumed. -

    See is assumed. +

    See §1.3.1 §1.4.1 Changing the Fixed Names for further details.

    notranslate
    This is equivalent to translate=false and may be passed via the document class + id="dx1-23083"> and may be passed via the document class options.
    nohypertypes
    Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular glossary or glossaries. The value of this option should be a comma-separated list of glossary types where \gls etc shouldn’t have hyperlinks + id="dx1-23085"> etc shouldn’t have hyperlinks by default. Make sure you enclose the value in braces if it contains any commas. Example: -
    +
    \usepackage[acronym,nohypertypes={acronym,notation}]  
      {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 + id="dx1-23086">. You may also use -



    \GlsDeclareNoHyperList{list}

    -

    +

    instead or additionally. See §6 §6 Links to Glossary Entries for further details.

    hyperfirst
    This is a boolean option that specifies whether each term has a hyperlink on first use. The default is hyperfirst=true (terms on (terms on first use have a hyperlink, unless explicitly suppressed using starred versions of commands such as \gls* or + id="dx1-23090"> or by identifying the glossary with nohypertypes, described above). Note that + id="dx1-23091">, described above). Note that nohypertypes overrides overrides hyperfirst=true. This option only affects commands that + id="dx1-23093">. This option only affects commands that check the first use flag, such as the \gls-like commands (for example, \gls or + id="dx1-23094"> or \glsdisp), but not the ), but not the \glstext-like commands (for example, \glslink or + id="dx1-23096"> or \glstext). -

    The ). +

    The hyperfirst setting applies to all glossary types (unless identified by setting applies to all glossary types (unless identified by nohypertypes or + id="dx1-23099"> or defined with \newignoredglossary). It can be overridden on an individual basis by + id="dx1-23100">). It can be overridden on an individual basis by explicitly setting the hyper key when referencing an entry (or by using the plus or + id="dx1-23101"> key when referencing an entry (or by using the plus or starred version of the referencing command). -

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

    It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of the acronym) but not for ordinary glossary entries (where the first use is identical to subsequent uses). In this case, you can use hyperfirst=false + id="dx1-23102"> and apply \glsunsetall to all the regular (non-acronym) glossaries. For example:

    -
    +
     \usepackage[acronym,hyperfirst=false]{glossaries}  
     % acronym and glossary entry definitions  
     % 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. Within the + id="dx1-23104">. Within the definition of this command, you can use \glslabel to reference the entry label and + id="dx1-23105"> to reference the entry label and \glstype to reference the glossary type. You can also use to reference the glossary type. You can also use \ifglsused to determine if + id="dx1-23107"> to determine if the entry has been used. You can test if an entry is an acronym by checking if it has the long key set using key set using \ifglshaslong. For example, to switch off the hyperlink on first use + id="dx1-23109">. For example, to switch off the hyperlink on first use just for acronyms:

    -
    +
    \renewcommand*{\glslinkcheckfirsthyperhook}{%  
     \ifglsused{\glslabel}{}%  
     {% @@ -5520,14 +7044,14 @@ class="cmtt-10">\ifglshaslong }%  
    }
    -

    -

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

    +

    Note that this hook isn’t used by the commands that don’t check the first use flag, such as \glstext. (You can, instead, redefine . (You can, instead, redefine \glslinkpostsetkeys, which is used by both + id="dx1-23111">, which is used by both the \gls-like and \glstext-like commands.)

    indexonlyfirst
    This is a boolean option that specifies whether to only add information to the external glossary file on first use. The default is indexonlyfirst=false, which will add a + id="dx1-23113">, which will add a line to the file every time one of the \gls-like or \glstext-like commands are used. Note that \glsadd will always add information to the external glossary + id="dx1-23114"> will always add information to the external glossary file2.1 (since + id="x1-23115f1"> (since that’s the purpose of that command). -

    You can customise this by redefining -


    You can customise this by redefining +


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

    -

    +

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

    -
    +
    \newcommand*{\glswriteentry}[2]{%  
      \ifglsindexonlyfirst  
        \ifglsused{#1}{}{#2}% @@ -5583,108 +7107,108 @@ class="cmtt-10">\glswriteentry  
      \fi  
    }
    -

    This checks the

    This checks the indexonlyfirst package option (using package option (using \ifglsindexonlyfirst) and does ⟨wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry hasn’t been used. -

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

    For example, suppose you only want to index the first use for entries in the acronym glossary and not in the main (or any other) glossary:

    -
    +
    \renewcommand*{\glswriteentry}[2]{%  
     \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}  
     {\ifglsused{#1}{}{#2}}%  
     {#2}%  
    }
    -

    Here I’ve used

    Here I’ve used \ifthenelse to ensure the arguments of \equal are fully expanded before the comparison is made.

    savenumberlist
    This is a boolean option that specifies whether or not to gather and store the number list for each entry. The default is for each entry. The default is savenumberlist=false. (See + id="dx1-23120">. (See \glsentrynumberlist and and \glsdisplaynumberlist in in §9 §9 Using Glossary Terms Without Links.) This is always true if you use Option 1.
    -

    +

    -

    Top

    2.2 Sectioning, Headings and TOC Options

    toc
    Add the glossaries to the table of contents. Note that an extra LATEX run is required with this option. Alternatively, you can switch this function on and off using -



    \glstoctrue  \glstoctrue

    -

    +

    and -



    \glstocfalse  \glstocfalse

    -

    +

    numberline
    When used with toc, this will add , this will add \numberline{} in the final argument of \addcontentsline. This will align the table of contents entry with the numbered + id="dx1-24007">. This will align the table of contents entry with the numbered section titles. Note that this option has no effect if the toc option is omitted. If option is omitted. If toc is + id="dx1-24009"> is used without numberline, the title will be aligned with the section numbers rather than + id="dx1-24010">, the title will be aligned with the section numbers rather than the section titles.
    section
    This is a ⟨key⟩=⟨value⟩ option. Its value should be the name of a sectional unit @@ -5693,117 +7217,117 @@ class="cmti-10">value⟩ option. Its value should be the name of a s Unnumbered sectional units will be used by default. Example: -
    +
    \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.2 + id="x1-24014f2"> but you may need to redefine it. For example, to only change the right header:

    -
    +
    \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 + id="dx1-24017"> option described below. -

    Occasionally you may find that another package defines

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

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

    +

    ucmark
    This is a boolean option (default: ucmark=false, unless , unless memoir has been loaded, + id="dx1-24021"> has been loaded, in which case it defaults to ucmark=true). If set, ). If set, \glsglossarymark uses + id="dx1-24023"> uses \MakeTextUppercase2.3. + id="x1-24025f3">. You can test whether this option has been set or not using -



    \ifglsucmark  \ifglsucmark true part\else false part\fi

    -

    +

    For example:

    -
    +
    \renewcommand{\glsglossarymark}[1]{%  
      \ifglsucmark  
        \markright{\MakeTextUppercase{#1}}% @@ -5811,29 +7335,29 @@ class="cmtt-10">\fi

     
        \markright{#1}%  
      \fi}
    -

    If

    If memoir has been loaded and has been loaded and ucfirst is set, then is set, then memoir’s ’s \memUChead is + id="dx1-24034"> is used.

    numberedsection
    The glossaries are placed in unnumbered sectional units by default, but this can be changed using numberedsection. This option can take one of the following + id="dx1-24036">. This option can take one of the following values:
    • false: + id="dx1-24037">: no number, i.e. use starred form of sectioning command (e.g. \chapter* or \section*);
    • nolabel: use a numbered section, i.e. the unstarred form of sectioning + id="dx1-24038">: use a numbered section, i.e. the unstarred form of sectioning command (e.g. \chapter or \section), but the section not labelled;
    • autolabel: numbered with automatic labelling. Each glossary uses the unstarred + id="dx1-24039">: numbered with automatic labelling. Each glossary uses the unstarred form of a sectioning command (e.g. \chapter or \section) and is assigned a label (via \label). The label is formed from -


      ). 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:

      -
      +
      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 which is set to main if the acronym option is not used and is set to option is not used and is set to acronym if the acronym option is used. For + id="dx1-24044"> option is used. For example:

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

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

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

      -
      +
      The list of acronyms is in  
      section~\ref{\glsautoprefix\acronymtype}.
      -

      +

    • nameref: this is like : this is like autolabel but uses an unnumbered sectioning command + id="dx1-24046"> but uses an unnumbered sectioning command (e.g. \chapter* or or \section*). It’s designed for use with the ). It’s designed for use with the nameref package. + id="dx1-24049"> package. For example: -
      +
      \usepackage{nameref}  
      \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

    entrycounter
    This is a boolean option. (Default is entrycounter=false.) If set, each main + id="dx1-25002">.) If set, each main (level 0) glossary entry will be numbered when using the standard glossary styles. This option creates the counter glossaryentry 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. -

    If you use

    If you use \glsrefentry, you must run LATEX twice after creating the glossary files using makeglossaries, , makeindex or or xindy to ensure the cross-references are + id="dx1-25008"> to ensure the cross-references are up-to-date.
    -

    +

    counterwithin
    This is a ⟨key⟩=⟨value⟩ option where ⟨value⟩ is the name of a counter. If used, this option will automatically set entrycounter=true and the and the glossaryentry counter will be + id="dx1-25011"> counter will be reset every time ⟨value⟩ is incremented. -

    The

    The glossaryentry counter isn’t automatically reset at the start of each glossary, except + id="dx1-25012"> counter isn’t automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by counterwithin is the + id="dx1-25013"> is the same as the counter used in the glossary’s sectioning command.
    -

    -

    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 + id="dx1-25014"> to use -



    \glsresetentrycounter  \glsresetentrycounter

    -

    +

    which sets glossaryentry to zero: + id="dx1-25016"> to zero:

    -
    +
    \renewcommand{\glossarypreamble}{%  
      \glsresetentrycounter  
    }
    -

    or if you are using

    or if you are using \setglossarypreamble, add it to each glossary preamble, as + id="dx1-25017">, add it to each glossary preamble, as required. For example:

    -
    +
    \setglossarypreamble[acronym]{%  
      \glsresetentrycounter  
      The preamble text here for the list of acronyms. @@ -6064,28 +7588,28 @@ class="cmtt-10">\setglossarypreamble  The preamble text here for the main glossary.  
    }
    -

    +

    subentrycounter
    This is a boolean option. (Default is subentrycounter=false.) If set, each + id="dx1-25019">.) If set, each level 1 glossary entry will be numbered when using the standard glossary styles. This option creates the counter glossarysubentry glossarysubentry. The counter is reset with each main (level 0) entry. Note that this package option is independent of entrycounter. You can reference the number within the + id="dx1-25022">. You can reference the number within the document using \glsrefentry{label} where ⟨label⟩ is the label associated with the
    style
    This is a ⟨key⟩=⟨value⟩ option. (Default is style=list, unless , unless classicthesis has been loaded, in + id="dx1-25026"> has been loaded, in which case the default is style=index.) Its value should be the name of the + id="dx1-25027">.) Its value should be the name of the glossary style to use. This key may only be used for styles defined in glossary-list, + id="dx1-25028">, glossary-long, , glossary-super or or glossary-tree. Alternatively, you can set the style + id="dx1-25031">. Alternatively, you can set the style using -



    \setglossarystyle{style name}

    -

    +

    (See §15 §15 Glossary Styles for further details.)

    nolong
    This prevents the glossaries package from automatically loading glossary-long (which + id="dx1-25033"> (which means that the longtable package also won’t be loaded). This reduces overhead by not + id="dx1-25034"> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-long package (unless you explicitly load glossary-long). + id="dx1-25035">).
    nosuper
    This prevents the glossaries package from automatically loading glossary-super (which + id="dx1-25037"> (which means that the supertabular package also won’t be loaded). This reduces overhead by + id="dx1-25038"> package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-super package (unless you explicitly load glossary-super). + id="dx1-25039">).
    nolist
    This prevents the glossaries package from automatically loading glossary-list. This + id="dx1-25041">. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-list package (unless you explicitly load glossary-list). Note that since the default style is ). Note that since the default style is list (unless + id="dx1-25043"> (unless classicthesis has been loaded), you will also need to use the has been loaded), you will also need to use the style option to set the style + id="dx1-25045"> option to set the style to something else.
    notree
    This prevents the glossaries package from automatically loading glossary-tree. This + id="dx1-25047">. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the glossary-tree package (unless you explicitly load glossary-tree). Note that if + id="dx1-25048">). Note that if classicthesis has been loaded, the default style is has been loaded, the default style is index, which is provided by + id="dx1-25050">, which is provided by glossary-tree. + id="dx1-25051">.
    nostyles
    This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary style package (such as glossary-mcols). Also if you use + id="dx1-25053">). Also if you use this option, you can’t use the style package option. Instead you must either + id="dx1-25054"> package option. Instead you must either use \setglossarystyle{style} or the style key in the optional argument to + id="dx1-25056"> key in the optional argument to \printglossary. Example: + id="dx1-25057">. Example: -
    +
    \usepackage[nostyles]{glossaries}  
    \usepackage{glossary-mcols}  
    \setglossarystyle{mcoltree}
    -

    +

    +

    +esclocations
    This is a boolean option. (The default is esclocations=true.) Both makeindex + and xindy are fussy about the location formats (makeindex 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 + 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.

    nonumberlist
    This option will suppress the associated number lists in the glossaries (see also + id="dx1-25066">s in the glossaries (see also §5 Number lists). +class="tcrm-1000">§5 Number lists). Note that if you use Options 2 or 3 (makeindex or xindy) then the + locations must still be valid. This package option merely prevents the number list from + being displayed, but both makeindex and xindy still require a location or + cross-reference for each term that’s indexed. Remember that number list includes any + cross-references, so suppressing the number list will also hide the cross-references (see + below).
    seeautonumberlist
    If you suppress the number lists with s with nonumberlist, described + id="dx1-25076">, 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-25080">, the see key will automatically implement key will automatically implement nonumberlist=false for that entry. + id="dx1-25082"> for that entry. (Note this doesn’t affect \glssee.) For further details see §8 §8 Cross-Referencing Entries.
    counter
    This is a ⟨key⟩=⟨value⟩ option. (Default is counter=page.) The value should be + id="dx1-25084">.) The value should be the name of the default counter to use in the number lists (see s (see §5 §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-25087">. + +
    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-25089">.
    -

    +

    -

    Top

    2.4 Sorting Options

    - -
    sort
    If you use Options 2 or 3, this package option is the only way of specifying how to @@ -6333,79 +7915,84 @@ href="#option3">3, this package option is the only way of specifying how to href="#option1">Option 1 allows you to specify sort methods for individual glossaries via the sort key in the optional argument of key in the optional argument of \printnoidxglossary. If + id="dx1-26003">. If you have multiple glossaries in your document and you are using Option 1, only use the package options sort=def or or sort=use if you want to set this sort method + id="dx1-26005"> 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:

    • standard : entries are sorted according to the value of the : entries are sorted according to the value of the sort key used in + id="dx1-26007"> key used in \newglossaryentry (if present) or the (if present) or the name key (if key (if sort key is missing); + id="dx1-26010"> key is missing);
    • def : entries are sorted in the order in which they were defined (the : entries are sorted in the order in which they were defined (the sort key + id="dx1-26012"> key in \newglossaryentry is ignored);
    • use : entries are sorted according to the order in which they are used in the + id="dx1-26013"> : entries are sorted according to the order in which they are used in the document (the sort key in key in \newglossaryentry is ignored). -

      Both

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


      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=def) or before the entries are + id="dx1-26018">) or before the entries are used (in the case of sort=use). + id="dx1-26019">).

    • none : this option is new to version 4.30 and is only for documents that don’t use + id="dx1-26020"> : this setting is new to version 4.30 and is only for documents that don’t use \makeglossaries or \makenoidxglossaries. It omits the code used to sanitize or - escape the sort value, since it’s not required. This option can’t be used with +class="cmtt-10">\makeglossaries (Options 2 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 \printglossary or \printnoidxglossary (or the iterative versions @@ -6414,24 +8001,27 @@ class="cmtt-10">\printglossaries or \printnoidxglossaries). It may be used with glossaries-extra’s \printunsrtglossary.
    -

    Note that the group styles (such as ’s \printunsrtglossary (Option 5). + + +

    Note that the group styles (such as listgroup) are incompatible with the ) are incompatible with the sort=use and + id="dx1-26023"> and sort=def options. -

    The default is options. +

    The default is sort=standard. When the standard sort option is in use, you can hook into + id="dx1-26025">. When the standard sort option is in use, you can hook into the sort mechanism by redefining: -



    \glsprestandardsort  \glsprestandardsort{sort cs}{type}{label}

    -

    +

    where ⟨sort cs⟩ is a temporary control sequence that stores the sort value (which was either explicitly set via the sort key or implicitly set via the key or implicitly set via the name key) before any + id="dx1-26028"> key) before any escaping of the makeindex//xindy special characters is performed. By default + id="dx1-26030"> special characters is performed. By default \glsprestandardsort just does: -



    \glsdosanitizesort  \glsdosanitizesort

    - - -

    +

    which sanitizes ⟨s ⟨sort cs⟩ if the sanitizesort package option is set (or does nothing if the + id="dx1-26033"> package option is set (or does nothing if the package option sanitizesort=false is used). -

    The other arguments, ⟨ is used). +

    The other arguments, ⟨type⟩ and ⟨label⟩, are the glossary type and the entry label for the current entry. Note that ⟨type⟩ will always be a control sequence, but ' class="cmti-10">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=def or or sort=use. + id="dx1-26037">.
    -

    +

    -

    +

    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 @@ -6508,29 +8096,29 @@ 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 + id="dx1-26040"> key in the optional argument of \printnoidxglossary: + id="dx1-26041">:

    -
    +
    \printnoidxglossary[sort=word]  
    \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 explicitly set via the package option sort=standard), and I can either define all my ), and I can either define all my main and acronym entries, then redefine sort cs⟩ if ⟨type⟩ is notation. -

    The first option can be achieved as follows: +

    The first option can be achieved as follows:

    -
    +
    \newcounter{sortcount}  
    \renewcommand{\glsprestandardsort}[3]{%  
      \stepcounter{sortcount}%  
      \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%  
    }
    -

    The second option can be achieved as follows: +

    The second option can be achieved as follows:

    -
    +
    \newcounter{sortcount}  
    \renewcommand{\glsprestandardsort}[3]{%  
      \ifdefstring{#2}{notation}% @@ -6572,26 +8160,26 @@ class="cmtt-10">notation.  
      }%  
    }
    -

    (

    (\ifdefstring is defined by the etoolbox package.) For a complete document, see the + id="dx1-26043"> 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 ⟨surname} that you can use in the name key when you define the entry, but hook into the standard + id="dx1-26046"> key when you define the entry, but hook into the standard sort mechanism to temporarily redefine \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:

    -
    +
    \newcommand{\sortname}[2]{#2, #1}  
    \newcommand{\textname}[2]{#1 #2}
    -

    and

    and \name needs to be initialised to \textname:

    -
    +
    \let\name\textname
    -

    Now redefine

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

    -
    +
    \renewcommand{\glsprestandardsort}[3]{%  
     \let\name\sortname  
     \edef#1{\expandafter\expandonce\expandafter{#1}}% @@ -6647,181 +8235,181 @@ 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:

    -
    +
    \newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},  
      description={some information about Joe Bloggs}}  
    \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.

    -

    -

    ____________________________

    +

    +

    ____________________________

    order
    This may take two values: word or or letter. The default is word ordering. -

    Note that the . The default is word ordering. +

    Note that the order option has no effect if you don’t use option has no effect if you don’t use makeglossaries. + id="dx1-26051">.
    -

    -

    If you use

    +

    If you use Option 1, this setting will be used if you use sort=standard in the optional argument of \printnoidxglossary: + id="dx1-26053">:

    -
    +
    \printnoidxglossary[sort=standard]
    -

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

    Alternatively, you can specify the order for individual glossaries:

    -
    +
    \printnoidxglossary[sort=word]  
    \printnoidxglossary[type=acronym,sort=letter]
    -

    +

    makeindex
    (Option 2) The glossary information and indexing style file will be written in makeindex format. If you use format. If you use makeglossaries, it will automatically detect that it + id="dx1-26056">, it will automatically detect that it needs to call makeindex. If you don’t use . If you don’t use makeglossaries, you need to remember + id="dx1-26058">, you need to remember to use makeindex not not xindy. The indexing style file will been given a . The indexing style file will been given a .ist + id="dx1-26061"> 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 xindy in the + id="dx1-26062"> in the package option list.

    xindy
    (Option 3) The glossary information and indexing style file will be written in xindy format. If you use format. If you use makeglossaries, it will automatically detect that it + id="dx1-26065">, it will automatically detect that it needs to call xindy. If you don’t use . If you don’t use makeglossaries, you need to remember + id="dx1-26067">, you need to remember to use xindy not not makeindex. The indexing style file will been given a . The indexing style file will been given a .xdy + id="dx1-26070"> 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:

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

    -
    +
    \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 §11 §11 Xindy (Option 3) for further details on using xindy with the with the glossaries package.

    xindygloss
    (Option 3) This is equivalent to xindy={} (that is, the xindy option without any + id="dx1-26073"> option without any value supplied) and may be used as a document class option. The language and code page can be set via \GlsSetXdyLanguage and and \GlsSetXdyCodePage (see (see §11.1 +class="tcrm-1000">§11.1 Language and Encodings.)
    xindynoglsnumbers
    (Option 3) This is equivalent to xindy={glsnumbers=false} and may @@ -6829,99 +8417,99 @@ class="cmtt-10">xindy={glsnumbers=false} and may
    automake
    This is a boolean option (new to version 4.08) that will attempt to run makeindex + id="dx1-26078"> or xindy using T using TEX’s \write18 mechanism at the end of the document. Since this + id="dx1-26080"> mechanism at the end of the document. Since this mechanism can be a security risk, some TEX distributions disable it completely, in which case this option won’t have an effect. (If this option doesn’t appear to work, search the log file for “runsystem” and see if it is followed by “enabled” or “disabled”.) -

    Some distributions allow

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

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

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

    Since this package option attempts to run the

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

    -

    +

    -

    Top

    2.5 Acronym Options

    acronym
    This creates a new glossary with the label acronym. This is equivalent to: -
    +
    \newglossary[alg]{acronym}{acr}{acn}{\acronymname}
    -

    It will also define -


    It will also define +


    \printacronyms  \printacronyms[options]

    -

    +

    that’s equivalent to

    \printglossary[type=acronym,options] @@ -6929,110 +8517,110 @@ class="cmtt-10">]
    (unless that command is already defined before the beginning of the document or the package option compatible-3.07 is used). -

    If you are using is used). +

    If you are using Option 1, you need to use

    \printnoidxglossary[type=acronym,options]
    to display the list of acronyms. -

    If the

    If the acronym package option is used, package option is used, \acronymtype is set to is set to acronym otherwise it is set to main.2.4 + id="x1-27008f4"> Entries that are defined using \newacronym are placed in the glossary whose label is + id="dx1-27014"> are placed in the glossary whose label is given by \acronymtype, unless another glossary is explicitly specified. -

    Remember to use the , unless another glossary is explicitly specified. +

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

    +

    acronyms
    This is equivalent to acronym=true and may be used in the document class option + id="dx1-27018"> and may be used in the document class option list.
    acronymlists
    By default, only the \acronymtype glossary is considered to be a list of acronyms. If you have other lists of acronyms, you can specify them as a comma-separated list in the value of acronymlists. For example, if you use the . For example, if you use the acronym + id="dx1-27021"> package option but you also want the main glossary to also contain a list of acronyms, you can do: -
    +
    \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:

    -
    +
    \usepackage[acronym,acronymlists={main,acronym2}]  
      {glossaries}  
    \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 + id="dx1-27023"> 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  \glsIfListOfAcronyms{label}{}{false part}

    -

    +

    shortcuts
    This option provides shortcut commands for acronyms. See §13 §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 instead. See §13 §13 Acronyms and Other Abbreviations for further details.

    description
    This option changes the definition of \newacronym to allow a description. This + id="dx1-28003"> to allow a description. This option may be replaced by -
    +
    \setacronymstyle{long-short-desc}
    -

    or (with

    or (with smallcaps) + id="dx1-28004">)

    -
    +
    \setacronymstyle{long-sc-short-desc}
    -

    or (with

    or (with smaller) + id="dx1-28005">)

    -
    +
    \setacronymstyle{long-sm-short-desc}
    -

    or (with

    or (with footnote) + id="dx1-28006">)

    -
    +
    \setacronymstyle{footnote-desc}
    -

    or (with

    or (with footnote and and smallcaps) + id="dx1-28008">)

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    or (with

    or (with footnote and and smaller) + id="dx1-28010">)

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    or (with

    or (with dua) + id="dx1-28011">)

    -
    +
    \setacronymstyle{dua-desc}
    -

    +

    smallcaps
    This option changes the definition of \newacronym and the way that acronyms are + id="dx1-28013"> and the way that acronyms are displayed. This option may be replaced by: -
    +
    \setacronymstyle{long-sc-short}
    -

    or (with

    or (with description) + id="dx1-28014">)

    -
    +
    \setacronymstyle{long-sc-short-desc}
    -

    or (with

    or (with description and and footnote) + id="dx1-28016">)

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    +

    smaller
    This option changes the definition of \newacronym and the way that acronyms are + id="dx1-28018"> 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 + id="dx1-28019"> package or otherwise define \textsmaller or redefine or redefine \acronymfont.
    -

    + id="dx1-28021">.

    +

    This option may be replaced by:

    -
    +
    \setacronymstyle{long-sm-short}
    -

    or (with

    or (with description) + id="dx1-28022">)

    -
    +
    \setacronymstyle{long-sm-short-desc}
    -

    or (with

    or (with description and and footnote) + id="dx1-28024">)

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    +

    footnote
    This option changes the definition of \newacronym and the way that acronyms are + id="dx1-28026"> and the way that acronyms are displayed. This option may be replaced by: -
    +
    \setacronymstyle{footnote}
    -

    or (with

    or (with smallcaps) + id="dx1-28027">)

    -
    +
    \setacronymstyle{footnote-sc}
    -

    or (with

    or (with smaller) + id="dx1-28028">)

    -
    +
    \setacronymstyle{footnote-sm}
    -

    or (with

    or (with description) + id="dx1-28029">)

    -
    +
    \setacronymstyle{footnote-desc}
    -

    or (with

    or (with smallcaps and and description) + id="dx1-28031">)

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    or (with

    or (with smaller and and description) + id="dx1-28033">)

    -
    +
    \setacronymstyle{footnote-sm-desc}
    -

    +

    dua
    This option changes the definition of \newacronym so that acronyms are always + id="dx1-28035"> so that acronyms are always expanded. This option may be replaced by: -
    +
    \setacronymstyle{dua}
    -

    or (with

    or (with description) + id="dx1-28036">)

    -
    +
    \setacronymstyle{dua-desc}
    -

    +

    -

    +

    -

    Top

    2.6 Other Options

    -

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

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

    symbols
    This option defines a new glossary type with the label symbols via -
    +
    \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
    -

    It also defines -


    It also defines +


    \printsymbols  \printsymbols[options]

    -

    +

    which is a synonym for

    \printglossary[type=symbols,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=symbols,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 + id="dx1-29005"> package option if you’re only interested in using this symbols glossary and don’t intend to use the main glossary.
    -

    +

    numbers
    This option defines a new glossary type with the label numbers via -
    +
    \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
    -

    It also defines -


    It also defines +


    \printnumbers  \printnumbers[options]

    -

    +

    which is a synonym for

    \printglossary[type=numbers,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=numbers,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 + id="dx1-29010"> package option if you’re only interested in using this numbers glossary and don’t intend to use the main glossary.
    -

    +

    index
    This option defines a new glossary type with the label index via -
    +
    \newglossary[ilg]{index}{ind}{idx}{\indexname}%
    -

    It also defines -


    It also defines +


    \newterm  \newterm[options]{term}

    -

    +

    which is a synonym for

    \newglossaryentry{term}[type=index,name={term},%
    description=\nopostdesc,options]
    and -



    \printindex  \printindex[options]

    -

    +

    which is a synonym for

    \printglossary[type=index,options]
    -

    If you use

    If you use Option 1, you need to use:

    \printnoidxglossary[type=index,options]
    to display this glossary. -

    Remember to use the

    Remember to use the nomain package option if you’re only interested in using this + id="dx1-29018"> package option if you’re only interested in using this index glossary and don’t intend to use the main glossary. Note that you can’t mix this option with \index. Either use . Either use glossaries for the indexing or use a custom indexing package, such as makeidx, , index or or imakeidx. (You can, of course, load + id="dx1-29022">. (You can, of course, load one of those packages and load glossaries without the index package option.) + id="dx1-29023"> 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 + id="dx1-29024"> or the command
    \GlsDeclareNoHyperList{index}
    -

    The example file

    The example file sample-index.tex illustrates the use of the index package + id="dx1-29026"> package option.

    compatible-2.07
    Compatibility mode for old documents created using version 2.07 or below.
    compatible-3.07
    Compatibility mode for old documents created using version 3.07 or below.
    -

    +

    -

    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: xindy, , xindygloss, + id="dx1-30003">, xindynoglsnumbers, , makeindex, , nolong, , nosuper, , nolist, , notree, , nostyles, , nomain, , compatible-2.07, + id="dx1-30012">, translate, , notranslate, , acronym. These options have to be set while the package is loading, + id="dx1-30015">. These options have to be set while the package is loading, except for the xindy sub-options which can be set using commands like sub-options which can be set using commands like \GlsSetXdyLanguage + id="dx1-30017"> (see §11 §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) after you have started defining your + id="dx1-30018">) after you have started defining your acronyms, you are likely to get unexpected results. If you try changing the sort option after you have started to define entries, you may get unexpected results.
    -

    +

    -

    -

    +

    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 Option 3. It’s not possible to mix these options within a document. +href="#option3">Option 3. It’s not possible to mix these options within a document, although some +combinations are possible with glossaries-extra. (For Options 4 and 5 see the bib2gls and +glossaries-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 ( (.ist) or ) or xindy + id="dx1-33004"> (.xdy) style file (for Options ) style file (for Options 2 or 3, respectively) and to ensure that glossary entries are written to the appropriate output files. \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 or makeindex style file + id="dx1-33007"> 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 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 package option with it.

    +

    + + +

    The default name for the customised style file is given by \jobname.ist ( (Option 2) or \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 + id="dx1-33016"> 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 be overridden using the counter package option. The default form of the location number + id="dx1-33017"> 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:

    -
    +
    \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 lists + id="dx1-33020">s containing a mixture of A-1 and 2.3 style formats, then do:

    -
    +
    \glsSetCompositor{.}\glsSetAlphaCompositor{-}
    -

    See

    See §5 §5 Number lists for further information about number lists. + id="dx1-33021">s.

    -

    -

    +

    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 \longnewglossaryentry +may only be used in the preamble. See §4.8 Drawbacks With Defining Entries in +the Document Environment for a discussion of the problems with defining entries +within the document instead of in the preamble. (The glossaries-extra package has an +option that provides a restricted form of document definitions that avoids some of +the issues discussed in §4.8 §4.8 Drawbacks With Defining Entries in the Document -Environment for a discussion of the problems with defining entries within the document -instead of in the preamble. -

    .) +

    Option 1 enforces the preamble-only restriction on \newglossaryentry.
    -

    -

    Only those entries that are referenced in the document (using any of the commands + id="dx1-34001">. Option 4 +requires that definitions are provided in .bib format. Option 5 requires either +preamble-only definitions or the use of the glossaries-extra package option docdef=restricted. +

    +

    +

    Only those entries that are indexed in the document (using any of the commands described in §6 §6 Links to Glossary Entries, §7 §7 Adding an Entry to the Glossary Without Generating Text or §8 §8 Cross-Referencing Entries) will appear in the glossary. See §10 +class="tcrm-1000">§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  \newglossaryentry{label}{key=value list}

    -

    +

    This is a short command, so values in ⟨key-val list⟩ can’t contain any paragraph breaks. If you have a long description that needs to span multiple paragraphs, use -



    \longnewglossaryentry  \longnewglossaryentry{label}{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 \unskip) but won’t remove leading spaces (otherwise it would interfere with commands like \Glsentrydesc). -

    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  \provideglossaryentry{label}{key=value list}

    -

    +

    and -


    \longprovideglossaryentry  -


    \longprovideglossaryentry{label}{key=value list}{long description} -

    -

    +{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 or active characters. The reason for this restriction is that the label is used to + + 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 or other non-Latin character, such as é + id="dx1-34008">, such as é or ß, looks like a plain character in your .tex file, it’s actually a macro (an active character) - - and therefore can’t be used in the label. (This applies to LATEX rather than XeLaTeX.) Also be careful of babel’s options that change certain punctuation characters (such as ’s options that change certain punctuation characters (such as : or -) to active characters.
    -

    -

    The second argument, ⟨

    +

    The second argument, ⟨key=value list⟩, is a ⟨key⟩=⟨value⟩ list that supplies the relevant information about this entry. There are two required fields: description and either and either name or + id="dx1-34011"> or parent. The description is set in the third argument of . The description is set in the third argument of \longnewglossaryentry and \longprovideglossaryentry. With the other commands it’s set via the description key. As is + id="dx1-34013"> key. As is typical with ⟨key⟩=⟨value⟩ lists, values that contain a comma or equal sign must be enclosed in -braces. Available fields are listed below: +braces. Available fields are listed below. Additional fields are provided by the supplementary +packages glossaries-prefix (§17 Prefixes or Determiners) and glossaries-accsupp (§18 +Accessibility Support) and also by glossaries-extra. You can also define your own custom keys +(see §4.3 Additional Keys).

    name
    The name of the entry (as it will appear in the glossary). If this key is omitted and the parent key is supplied, this value will be the same as the parent’s name. -

    If the key is supplied, this value will be the same as the parent’s name. +

    If the name key contains any commands, you must also use the key contains any commands, you must also use the sort key (described + id="dx1-34019"> 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 that permit multi-line descriptions, use \newline not not \\ if you want to force a line break.

    + + parent
    The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See §4.5 §4.5 Sub-Entries for further details.
    descriptionplural
    The plural form of the description, if required. If omitted, the value is set to the same as the description key. + id="dx1-34026"> key.
    text
    How this entry will appear in the document text when using \gls (or one of its - - + id="dx1-34028"> (or one of its upper case variants). If this field is omitted, the value of the name key is + id="dx1-34029"> key is used.
    first
    How the entry will appear in the document text on first use with \gls (or one of its + id="dx1-34031"> (or one of its upper case variants). If this field is omitted, the value of the text key is used. Note that + id="dx1-34032"> key is used. Note that if you use \glspl, , \Glspl, , \GLSpl, , \glsdisp before using before using \gls, the , the firstplural value + id="dx1-34038"> value won’t be used with \gls. + id="dx1-34039">.
    plural
    How the entry will appear in the document text when using \glspl (or one + id="dx1-34041"> (or one of its upper case variants). If this field is omitted, the value is obtained by appending \glspluralsuffix to the value of the to the value of the text field. The default value of + id="dx1-34043"> field. The default value of \glspluralsuffix is the letter “s”. + id="dx1-34044"> is the letter “s”.
    firstplural
    How the entry will appear in the document text on first use with \glspl (or one + id="dx1-34046"> (or one of its upper case variants). If this field is omitted, the value is obtained from the plural + id="dx1-34047"> key, if the first key is omitted, or by appending key is omitted, or by appending \glspluralsuffix to the value of + id="dx1-34049"> to the value of the first field, if the field, if the first field is present. Note that if you use field is present. Note that if you use \gls, , \Gls, + id="dx1-34053">, \GLS, , \glsdisp before using \glspl, the , the firstplural value won’t be used with + id="dx1-34056"> value won’t be used with \glspl. -

    . +

    Note: prior to version 1.13, the default value of firstplural was always taken by + id="dx1-34058"> was always taken by appending “s” to the first key, which meant that you had to specify both key, which meant that you had to specify both plural and + id="dx1-34060"> and firstplural, even if you hadn’t used the , even if you hadn’t used the first key. + id="dx1-34062"> key.

    symbol
    This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to \relax. Note that not all glossary styles display the @@ -8112,100 +9745,102 @@ class="cmtt-10">\relax. Note that not all glossary styles display the
    symbolplural
    This is the plural form of the symbol (as passed to \glsdisplay and + id="dx1-34065"> and \glsdisplayfirst by by \glspl, , \Glspl and and \GLSpl). If omitted, the value is set to the + id="dx1-34069">). If omitted, the value is set to the same as the symbol key. + id="dx1-34070"> key.
    sort
    This value indicates how this entry should be sorted. If omitted, the value is given by the name field unless one of the package options field unless one of the package options sort=def and and sort=use have been + id="dx1-34074"> have been used. In general, it’s best to use the sort key if the key if the name contains commands + id="dx1-34076"> contains commands + + (e.g. \ensuremath{\alpha}). You can also override the sort key by redefining + id="dx1-34077"> key by redefining \glsprestandardsort (see (see §2.4 §2.4 Sorting Options). -

    Option 1 by default strips the standard LATEX accents (that is, accents generated by core LATEX commands) from the name key when it sets the key when it sets the sort key. So with + id="dx1-34080"> key. So with Option 1:

    -
    +
    \newglossaryentry{elite}{%  
      name={{\'e}lite},  
      description={select group of people}  
    }
    -

    This is equivalent to: +

    This is equivalent to:

    -
    +
    \newglossaryentry{elite}{%  
      name={{\'e}lite},  
      description={select group of people},  
      sort={elite}  
    }
    -

    Unless you use the package option

    Unless you use the package option sanitizesort=true, in which case it’s equivalent + id="dx1-34081">, in which case it’s equivalent to:

    -
    +
    \newglossaryentry{elite}{%  
      name={{\'e}lite},  
      description={select group of people},  
      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:

    + id="dx1-34082"> package:

    \newglossaryentry{elite}{% @@ -8257,7 +9892,7 @@ class="cmtt-10">}
    Unless you use the package option sanitizesort=true, in which case it’s equivalent to: + id="dx1-34083">, in which case it’s equivalent to:
    }
    Again, this will place the entry before the “A” group. -

    With Options 

    With Options 2 and 3, the default value of sort will either be set to the will either be set to the name + id="dx1-34085"> key (if sanitizesort=true) or it will set it to the expansion of the ) or it will set it to the expansion of the name key (if + id="dx1-34087"> key (if sanitizesort=false). -

    Take care with ). +

    Take care with xindy ( (Option 3): if you have entries with the same sort value they will + id="dx1-34090"> value they will be treated as the same entry. If you use xindy and aren’t using the and aren’t using the def or use sort methods, always use the sort key for entries where the name just consists of a control + id="dx1-34092"> key for entries where the name just consists of a control sequence (for example name={\alpha}). -

    Take care if you use

    Take care if you use Option 1 and the name contains fragile commands. You will either + id="dx1-34093"> contains fragile commands. You will either need to explicitly set the sort key or use the key or use the sanitizesort=true package option (unless you + id="dx1-34095"> package option (unless you use the def or use sort methods).

    -

    +

    type
    This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is assumed unless \newacronym is used (see is used (see §13 §13 Acronyms and Other Abbreviations).
    user1, …, user6
    Six keys provided for any additional information the user may want to specify. (For example, an associated dimension or an alternative plural or some other grammatical construct.) Alternatively, you can add new keys using \glsaddkey or + id="dx1-34104"> or \glsaddstoragekey (see (see §4.3 Additional Keys). Other keys are also provided by the - glossaries-prefix (§17 Prefixes or Determiners) and glossaries-accsupp (§18 Accessibility - Support) packages. +class="tcrm-1000">§4.3 Additional Keys).
    nonumberlist
    A boolean key. If the value is missing or is true, this will suppress the number list just for this entry. Conversely, if you have used the package option just for this entry. Conversely, if you have used the package option nonumberlist, you + id="dx1-34108">, you can activate the number list just for this entry with just for this entry with nonumberlist=false. (See . (See §5 §5 Number lists.)
    see
    Cross-reference another entry. Using the see key will automatically add this entry to the - glossary, but will not automatically add the cross-referenced entry. The referenced entry + id="dx1-34112"> key will automatically add this entry to the + glossary, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. If you want to override the “see” tag, you can supply the new tag in square brackets before the label. For example number list, the cross-referencing information won’t appear in the glossary, as it forms part of the number list. You can override this for individual glossary entries using nonumberlist=false (see above). Alternatively, you can use the + id="dx1-34115"> (see above). Alternatively, you can use the seeautonumberlist package option. For further details, see package option. For further details, see §8 §8 Cross-Referencing Entries. -

    This key essentially provides a convenient shortcut that performs

    - - +

    This key essentially provides a convenient shortcut that performs

    \glssee[xr-label list}
    + +
    after the entry has been defined. -

    For Options 

    For Options 2 and 3, \makeglossaries must be used before any occurrence of + id="dx1-34117"> must be used before any occurrence of \newglossaryentry that contains the that contains the see key. This key has no effect for entries defined - in the key. This key should not be used with entries + defined in the document environment.
    -

    -

    If you use the environment.

    +

    + Since it’s useful to suppress the indexing while working on a draft document, + consider using the seenoindex package option to warn or ignore the see key while + \makeglossaries is commented out. +

    If you use the see key, you may want to consider using the supplementary key, you may want to consider using the glossaries-extra - package. +class="cmss-10">glossaries-extra package which + additionally provides a seealso and alias key. If you want to avoid the automatic + indexing triggered by the see key, consider using Option 4.

    -

    The following keys are reserved for

    The following keys are reserved for \newacronym (see (see §13 §13 Acronyms and Other Abbreviations): long, , longplural, , short and and shortplural. Additional keys are provided by the -glossaries-prefix (§17 Prefixes or Determiners) and the glossaries-accsupp (§18 Accessibility -Support) packages. You can also define your own custom keys (see §4.3 Additional -Keys). -

    Avoid using any of the . +

    Avoid using any of the \gls-like or \glstext-like commands within the text, , first, , short + id="dx1-34133"> or long keys (or their plural equivalent) or any other key that you plan to access through + id="dx1-34134"> keys (or their plural equivalent) or any other key that you plan to access through those commands. (For example, the symbol key if you intend to use key if you intend to use \glssymbol.) Otherwise you end up with nested links, which can cause complications and they won’t work with the case-changing commands. You can use them within the value of keys that won’t be accessed through those commands. For example, the description key if you don’t use key if you don’t use \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 + id="dx1-34137">, you must group the character, otherwise it will cause a problem for commands like \Gls and and \Glspl. For + id="dx1-34139">. For example:

    -
    +
    \newglossaryentry{elite}{name={{\'e}lite},  
    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:

    + id="dx1-34140"> package:

    \newglossaryentry{elite}{name={{ class}}
    (This doesn’t apply for XeLaTeX documents using the fontspec package. For further details, + id="dx1-34141"> package. For further details, see the “UTF-8” section in the mfirstuc user manual.) -

    Note that in both of the above examples, you will also need to supply the user manual.) +

    Note that in both of the above examples, you will also need to supply the sort key if you + id="dx1-34143"> key if you are using Option 2 whereas xindy ( (Option 3) is usually able to sort non-Latin characters + id="dx1-34145">s correctly. Option 1 discards accents from standard LATEX extended Latin characters unless + id="dx1-34146">s unless you use the sanitizesort=true. + id="dx1-34147">.

    -

    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:

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

    -
    +
    \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 + id="dx1-35002"> key for one of them and one of the user keys to specify the other plural form. For example:

    -
    +
    \newglossaryentry{cow}{%  
      name=cow,%  
      description={a fully grown female of any bovine animal  
                   (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:

    -
    +
    \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 , described in §4.3 §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 before the entries are defined. For languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the plural key (and the + id="dx1-35004"> key (and the firstplural key where necessary). -

    + id="dx1-35005"> 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:

    -
    +
    \let\glsing\glsuseri  
    \let\glsd\glsuserii  
    \newcommand*{\ingkey}{user1} @@ -8691,55 +10314,55 @@ 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:

    -
    +
    \newword{play}{to take part in activities for enjoyment}  
    \newword[\edkey={ran},\ingkey={running}]{run}{to move fast using  
    the legs}
    -

    and use them in the text: +

    and use them in the text:

    -
    +
    Peter is \glsing{play} in the park today.  
    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 , described below in §4.3 +class="tcrm-1000">§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.1 §4.3.1 Document Keys. If, on the other hand, you want to add a key to indicate to a glossary style or acronym style that this entry should be formatted differently to other entries, then you can use \glsaddstoragekey described in §4.3.2 §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 @@ -8748,16 +10371,16 @@ 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  \glsaddkey{key}{link ucfirst cs}{link allcaps cs}

    -

    +

    where:

    key
    is the new key to use in \newglossaryentry (or similar commands such as + id="dx1-38002"> (or similar commands such as \longnewglossaryentry); + id="dx1-38003">);
    @@ -8802,42 +10425,42 @@ class="cmtt-10">\glsaddkey and protect fragile class="cmbxti-10">no link cs⟩
    is the control sequence to use analogous to commands like \glsentrytext; + id="dx1-38004">;
    no link ucfirst cs
    is the control sequence to use analogous to commands like \Glsentrytext; + id="dx1-38005">;
    link cs
    is the control sequence to use analogous to commands like \glstext; + id="dx1-38006">;
    link ucfirst cs
    is the control sequence to use analogous to commands like \Glstext; + id="dx1-38007">;
    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 @@ -8845,7 +10468,7 @@ need to use the starred form:

    -
    +
     % Define "ed" key:  
     \glsaddkey*  
      {ed}% key @@ -8865,11 +10488,11 @@ 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:

    -
    +
     % No need to override defaults for this entry:  
     \newglossaryentry{jump}{name={jump},description={}}  
     % Need to override defaults on these entries: @@ -8882,33 +10505,33 @@ 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:

    -
    +
    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  \glsaddstoragekey{key}{}{no link cs}

    -

    +

    where the arguments are as the first three arguments of \glsaddkey, described above in §4.3.1 §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 §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, 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.4.1 -

    Here I can define a new key that determines whether the term is actually an acronym + id="x1-39003"> +

    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 rather than some other form of abbreviation. I’m going to call this key abbrtype (since type @@ -8953,26 +10577,27 @@ already exists):

    -
    +
    \glsaddstoragekey  
     {abbrtype}% key/field name  
     {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:

    -
    +
    \newacronymstyle  
     {mystyle}% style name  
     {% Use the generic display  
       \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%  
     }  
     {% Put the long form in the description - 
       \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + 
       \renewcommand*{\GenericAcronymFields}{% + 
           description={\the\glslongtok}}%  
       % For the full format, test the value of the "abbrtype" key.  
       % If it's set to "word" put the short form first with  
       % the long form in brackets. @@ -9011,9 +10636,9 @@ display the full form:  
          (\protect\firstacronymfont{\glsentryshortpl{##1}})%  
        }%  
      }% - 
      % plural and first letter upper case + 
      % plural and first letter upper case  
      \renewcommand*{\Genplacrfullformat}[2]{%  
        \ifglsfieldeq{##1}{abbrtype}{word}  
        {% is a proper acronym @@ -9026,7 +10651,8 @@ display the full form:  
        }%  
      }%  
      % Just use the short form as the name part in the glossary: - 
      \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}}% + 
      \renewcommand*{\acronymentry}[1]{% + 
         \acronymfont{\glsentryshort{##1}}}%  
      % Sort by the short form:  
      \renewcommand*{\acronymsort}[2]{##1}%  
      % Just use the surrounding font for the short form: @@ -9037,31 +10663,31 @@ 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 + id="dx1-39004"> for something that’s not technically an acronym, let’s define a new command for initialisms:

    -
    +
    \newcommand*{\newinitialism}[4][]{%  
      \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%  
    }
    -

    Now the entries can all be defined: +

    Now the entries can all be defined:

    -
    +
    \newacronym{radar}{radar}{radio detecting and ranging}  
    \newacronym{laser}{laser}{light amplification by stimulated  
    emission of radiation} @@ -9070,19 +10696,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 key will be set to its default value of “w \ifglshaslong test in the custom acronym style will be false (since the long key hasn’t been + id="dx1-39005"> key hasn’t been set) so the display style will switch to that given by \glsgenentryfmt and they’ll be no test performed on 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 + id="dx1-39008"> also needs to be provided. Here I’ve changed “word” to “acronym”:

    -
    +
    \glsaddstoragekey  
     {abbrtype}% key/field name  
     {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 + id="dx1-39009"> 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:

    -
    -   \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% +
    +   \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

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

    -
    +
    \newacronym[description={system for detecting the position and  
    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:

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

    -
    +
    \newcommand*{\newcontraction}[4][]{%  
      \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:

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

    -
    +
    \newglossarystyle  
     {mystyle}% style name  
     {% base it on the "list" style @@ -9227,86 +10854,85 @@ 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 + id="dx1-39010"> 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 the sample file sample-storage-abbr-desc.tex. -

    +

    (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, + id="dx1-40001">, description, , descriptionplural, , symbol, , symbolplural and and sort keys (these keys all have expansion + id="dx1-40006"> 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.

    -


    Table 4.1: Key to Field Mappings
    +class="content">Key to Field Mappings
    Field style="vertical-align:baseline;" id="TBL-5-2-">
    sort sortvalue
    firstplural firstpl
    description desc
    descriptionplural descplural
    user1 useri
    user2 userii
    user3 useriii
    user4 useriv
    user5 userv
    user6 uservi
    longplural longpl
    shortplural shortpl
    @@ -9421,31 +11047,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 @@ -9454,67 +11080,67 @@ flat format. Of the styles that support sub-entries, some display the sub-entry& name whilst others don’t. Therefore you need to ensure that you use a suitable style. (See §15 §15 Glossary Styles for a list of predefined styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles if you use the subentrycounter package option (see package option (see §2.3 §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 list. Note also that . Note also that makeindex has a restriction on the maximum + id="dx1-41003"> 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 + id="dx1-42001"> key. -

    +

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

    Suppose I want a glossary of mathematical symbols that are divided into Greek letters + id="x1-42003"> +

    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:

    -
    +
    \newglossaryentry{greekletter}{name={Greek letters},  
    description={\nopostdesc}}  
    \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 + id="dx1-42004">. 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:

    -
    +
    \newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},  
    description={ratio of the circumference of a circle to  
    the diameter}, @@ -9523,41 +11149,41 @@ 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 + id="dx1-43001"> key. For example, the word “glossary” can mean a list of technical words or a collection of glosses. In both cases the plural is “glossaries”. So first define the parent entry:

    -
    +
    \newglossaryentry{glossary}{name=glossary,  
    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: + id="dx1-43002">. +

    Now define the two different meanings of the word:

    -
    +
    \newglossaryentry{glossarylist}{  
    description={list of technical words},  
    sort={1}, @@ -9567,38 +11193,38 @@ 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 + id="dx1-43003">, whereas if I reference any of the child entries, the location will be added to the child entry’s number list. Note also that since the sub-entries have the same name, the sort key is + id="dx1-43004"> key is required unless you are using the sort=use or or sort=def package options (see package options (see §2.4 +class="tcrm-1000">§2.4 Sorting Options). You can use the subentrycounter package option to automatically + id="dx1-43007"> package option to automatically number the first-level child entries. See §2.3 §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 + id="dx1-43008"> key was not required for the child entries. However, if the sub-entries have different plurals, they will need to be specified. For example:

    -
    +
    \newglossaryentry{bravo}{name={bravo},  
    description={\nopostdesc}}  
    \newglossaryentry{bravocry}{description={cry of approval @@ -9612,83 +11238,88 @@ 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  \loadglsentries[type]{filename}

    -

    +

    where ⟨filename⟩ is the name of the file containing all the \newglossaryentry or + id="dx1-44002"> or \longnewglossaryentry commands. The optional argument ⟨ commands. The optional argument ⟨type⟩ is the name of the glossary to which those entries should belong, for those entries where the type key has been omitted + id="dx1-44004"> key has been omitted (or, more specifically, for those entries whose type has been specified by \glsdefaulttype, + id="dx1-44005">, which is what \newglossaryentry uses by default). -

    This is a preamble-only command. You may also use uses by default). +

    This is a preamble-only command. You may also use \input to load the file but don’t use + id="dx1-44007"> to load the file but don’t use \include. -

    If you want to use . If you find that your file is becoming unmanageably large, you may want to +consider switching to bib2gls and use an application such as JabRef to manage the entry +definitions. +

    If you want to use \AtBeginDocument to to \input all your entries automatically at the start of the document, add the \AtBeginDocument command before you load the glossaries + id="dx1-44011"> package (and babel, if you are also loading that) to avoid the creation of the , if you are also loading that) to avoid the creation of the .glsdefs file and any associated problems that are caused by defining commands in the document + id="dx1-44013"> environment. (See §4.8 §4.8 Drawbacks With Defining Entries in the Document Environment.)
    -

    +

    + id="x1-44015r7"> -

    Example 7 (Loading Entries from Another File) -

    Suppose I have a file called +

    Suppose I have a file called myentries.tex which contains:

    -
    +
    \newglossaryentry{perl}{type=main,  
    name={Perl},  
    description={A scripting language}} @@ -9698,14 +11329,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 (see §13 §13 Acronyms and Other Abbreviations) the type is set as type=\acronymtype unless you explicitly override it. For example, if my file @@ -9731,73 +11362,73 @@ class="cmtt-10">myacronyms.tex contains:

    -
    +
    \newacronym{aca}{aca}{a contrived acronym}
    -

    then (supposing I have defined a new glossary type called

    then (supposing I have defined a new glossary type called altacronym)

    -
    +
    \loadglsentries[altacronym]{myacronyms}
    -

    will add

    will add aca to the glossary type acronym, if the package option acronym has been specified, + id="dx1-44018"> has been specified, or will add aca to the glossary type altacronym, if the package option acronym is not + id="dx1-44019"> is not specified.4.2 -

    If you have used the 4.1 +

    If you have used the acronym package option, there are two possible solutions to this + id="dx1-44024"> package option, there are two possible solutions to this problem:

    1. Change Change 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}
      -

      +

    2. Temporarily change Temporarily change \acronymtype to the target glossary: -
      +
      \let\orgacronymtype\acronymtype  
      \renewcommand{\acronymtype}{altacronym}  
      \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 rather than \newglossaryentry. + id="dx1-44030">. Suppose you want to maintain a large database of acronyms or terms that you’re likely to use in your documents, but you may want to use a modified version of some of those entries. (Suppose, for example, one document may require a more detailed description.) Then if you @@ -9810,73 +11441,73 @@ class="cmtt-10">terms.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:

    -
    +
    \usepackage{glossaries}  
    \makeglossaries  
    \newglossaryentry{mallard}{name=mallard,  
     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  \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, + id="dx1-45002">, then define an ignored glossary with \newignoredglossary. (See . (See §12 §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 (and \newacronym) could only be used in the preamble. I + id="dx1-46002">) could only be used in the preamble. I reluctantly removed this restriction in version 1.13, but there are issues with defining commands in the document environment instead of the preamble, which is why the restriction + id="dx1-46003"> environment instead of the preamble, which is why the restriction is maintained for newer commands. This restriction is also reimposed for \newglossaryentry by the new 3 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 + class="enumerate" id="x1-47002x1">If you define an entry mid-way through your document, but subsequently shuffle sections around, you could end up using an entry before it has been defined.
    2. Entry information is required when displaying the glossary. If this occurs at the + class="enumerate" id="x1-47004x2">Entry information is required when displaying the glossary. If this occurs at the start of the document, but the entries aren’t defined until later, then the entry details are being looked up before the entry has been defined.
    3. If you use a package, such as If you use a package, such as babel, that makes certain characters active at the start + id="dx1-47007">, that makes certain characters active at the start of the document environment, there will be a problem if those characters have + id="dx1-47008"> environment, there will be a problem if those characters have a special significance when defining glossary entries. These characters include the double-quote " character, the exclamation mark ? character, and the pipe | character. They must not be active when defining a glossary entry where they occur in the sort key (and they should be avoided in + id="dx1-47010"> key (and they should be avoided in the label if they may be active at any point in the document). Additionally, the comma , character and the equals = 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 so that the + id="dx1-47011"> environment so that the definitions are written to an external file (\jobname.glsdefs) which is then read in at the + id="dx1-47013">) which is then read in at the start of the document on the next run. The entry will then only be defined in the document environment if it doesn’t already exist. This means that the entry can now + id="dx1-47014"> 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 TEX’s maximum allocation; unexpected expansion issues could occur; the see key isn’t stored, which means it can’t be added to the key isn’t stored, which means it can’t be added to the .glsdefs file when it’s + id="dx1-47017"> file when it’s created at the end of the document (and therefore won’t be present on subsequent runs). -

    +

    The glossaries-extra package provides a setting (but only for Options 2 and 3) that allows +\newglossaryentry to occur in the document environment but doesn’t create the +.glsdefs file. This circumvents some problems but it means that you can’t display +any of the glossaries before all the entries have been defined (so it’s all right if all +the glossaries are at the end of the document but not if any occur in the front +matter). + + +

    -

    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 environment - - + id="dx1-48001"> environment rather than in the preamble is that they want to write the definition as they type in their document text. This suggests a “stream of consciousness” style of writing that may be acceptable in certain literary genres but is inappropriate for factual documents. -

    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 @@ -9990,185 +11634,468 @@ 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 used (using any of the commands described in . By default, these numbers refer +to the pages on which that entry has been indexed (using any of the commands described in +§6 -§6 Links to Glossary Entries and §7 Adding an Entry to the Glossary Without Generating Text). -The number list can be suppressed using the §7 Adding an Entry to the Glossary Without Generating +Text). The number list can be suppressed using the nonumberlist package option, or an alternative -counter can be set as the default using the package option, or an +alternative counter can be set as the default using the counter package option. The number list is also -referred to as the location list. -

    Each location in the 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 glossaries package for indexes as well). However, the glossaries package makes use of +makeindex or xindy to hierarchically sort and collate the entries since they are readily +available with most modern TEX distributions. Since these are both designed as indexing +applications they both require that terms either have a valid location or a cross-reference. +Even if you use nonumberlist, the locations must still be provided and acceptable +to the indexing application or they will cause an error during the indexing stage, +which will interrupt the document build. However, if you’re not interested in the +locations, each entry only needs to be indexed once, so consider using indexonlyfirst, +which can improve the document build time by only indexing the first use of each +term. +

    The \glsaddall command (see §7 Adding an Entry to the Glossary Without Generating +Text), which is used to automatically index all entries, iterates over all defined entries and +does \glsadd{label} for each entry (where ⟨label⟩ is that entry’s label). This means that +\glsaddall automatically adds the same location to every entry’s number list, which looks +weird if the number list hasn’t been suppressed. +

    With Option 4, the indexing is performed by bib2gls, which was specifically designed for +the glossaries-extra package. So it will allow any location format, and its selection=all +option will select all entries without adding an unwanted location to the number list. If +bib2gls can deduce a numerical value for a location, it will attempt to form a range over +consecutive locations, otherwise it won’t try to form a range and the location will just form +an individual item in the list. Option 1 also allows any location but it doesn’t form +ranges. +

    +

    Top

    5.1 Encap Values

    +

    Each location in the number list is encapsulated with a command. (The is encapsulated with a command formed from the encap value.) By -default this is the +value. By default this is the \glsnumberformat command, but may be overridden using the command, which corresponds to the encap +glsnumberformat, but this may be overridden using the format key -in the optional argument to commands like key in the optional argument +to commands like \gls. (See §6 Links to Glossary Entries.) For -example, you may want the location to appear in bold to indicate the principle use of a term -or symbol. 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 encaps. While it may seem apparent that \textbf should override +class="tcrm-1000">§6 Links to Glossary Entries.) For example, you may want the +location to appear in bold to indicate the principle use of a term or symbol. If the encap +starts with an open parenthesis ( this signifies the start of a range and if the encap starts +with close parenthesis ) this signifies the end of a range. These must always occur in +matching pairs. +

    The glossaries package provides the command \glsignore which ignores its argument. +This is the format used by \glsaddallunused to suppress the location, which works fine as +long as no other locations are added to the number list. For example, if you use + + +\gls{sample} on page 2 then reset the first use flag and then use \glsaddallunused on +page 10, the number list for sample will be 2, \glsignore{10} which will result in “2, ” +which has a spurious comma. +

    This isn’t a problem with bib2gls because you’d use selection=all instead of +\glsaddallunused, but even if you explicitly had, for example, \gls[format=glsignore] \glsnumberformat in this situation, neither makeindex nor {⟨label} for some reason, bib2gls will recognise glsignore as a special encap indicating an +ignored location, so it will select the entry but not add that location to the number list. It’s a +problem for all the other options (except Option 5, which doesn’t perform any +indexing). +

    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 +encaps. While it may seem apparent that textbf should override glsnumberformat in this +situation, the indexing application may not know it. This is therefore something you need to +be careful about if you use the format key or if you use a command that implicitly sets +it. +

    In the case of xindy know this. In -the case of , it only accepts one encap (according to the order of precedence given +in the xindy, it only accepts one encap and discards the other for identical -locations. The encap it chooses to keep may not necessarily be the one you want. In the -case of 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 makeindex, it accepts different encaps for the same location, but warns + id="dx1-50014">, it accepts different encaps for the same location, but warns about it. This leads to a number list with the same location repeated in different -fonts. -

    This is something you need to be careful about, but if you use the - with the same location repeated in different formats. If +you use the makeglossaries Perl script it will detect Perl script with Option 2 it will detect makeindex’s warning and attempt to fix the -problem.5.1 -Since xindy doesn’t generate a warning, makeglossaries won’t do anything about it if you -are using ’s warning +and attempt to fix the problem, ensuring that the 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 Option 1 so again you get the same location repeated in different +formats. With Option 4, bib2gls will discard according to order of precedence, +giving priority to start and end range encaps. (See the bib2gls manual for further +details.) +

    +

    +

    Top

    5.2 Locations

    +

    Neither Option 1 nor Option 4 care about the location syntax as long as it’s valid +LATEX code (and doesn’t contain fragile commands). In both cases, the indexing is +performed by writing a line to the .aux file. The write operation is deferred to avoid the +problems associated with TEX’s asynchronous output routine. (See, for example, Finding if +you’re on an odd or an even page for more details on this issue.) Unfortunately Options 2 +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 +indexing application then use the package option esclocations=false to bypass this operation. +This setting only affects Options 2 and 3 as the problem doesn’t arise with the other + + +indexing options. +

    Both makeindex and xindy. With are fussy about the syntax of the locations. In the +case of makeindex, makeglossaries will let the encaps override each other, -similar to , only the numbering system obtained with \arabic, \roman, +\Roman, \alph and \Alph or composites formed from them with the same separator +(set with \glsSetCompositor{char}) are accepted. (makeindex won’t accept an +empty location.) In the case of xindy, except that the \glsnumberformat encap will always have the least -precedence. Other conflicting encaps will have the last one override earlier ones for the same -location. -

    Due to the asynchronous nature of TEX’s output routine (see, for example, Finding if -you’re on an odd or an even page) the page counter (represented internally as \c@page) can -be unreliable. This can cause problems when glossary entries are referenced in a paragraph -that spans a page break. The standard \label mechanism deals with this by deferring the -write until the end of the paragraph, but the glossaries indexing mechanism needs to take -into account the possibility that the location might contain any of , you can define your own location classes, +but if the location contains a robust command then the leading backslash must be +escaped. The glossaries package tries to do this, but it’s caught between two conflicting +requirements: +

      +
    1. The location must be fully expanded before \ can be converted to \\ (there’s no + point converting \thepage to \\thepage); +
    2. +
    3. The page number can’t be expanded until the deferred write operation (so \c@page + mustn’t expand in the previous step but \the\c@page mustn’t be converted to + \\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 +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 +\tallynum that takes a number as the argument and an expandable command called +\tally that converts a counter name into the associated register or number to +pass to \tallynum. Let’s suppose that this command is used to represent the page +number: + + +

    +
    +\renewcommand{\thepage}{\tally{page}} +
    +

    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’s special -characters which will need to be escaped before the write can be performed. (This -isn’t a problem with makeindex as that places restrictions on the location format -which prevent this from happening, but these very restrictions can make , the location \tally{page} needs to be +written to the file as \\tallynum{2}. If it’s written as \tallynum{2} then xindy -preferable.) -

    To compensate, the glossaries package has to make some adjustments to ensure the -location number is correct for this situation. By default, the adjustments only affect the -counter styles: roman, Roman, alph, Alph and arabic. If you have a different numbering -system where will +interpret \t as the character “t” (which means the location would appear as “tallynum2”). So +glossaries tries to expand \thepage without expanding \c@page and then escapes all the +backslashes, except for the page counter’s internal command. The following definitions of +\tally will work:

    +
      +
    • In the following, \arabic works as its internal command \c@arabic is temporarily + redefined to check for \c@page: + + +
      + \newcommand{\tally}[1]{\tallynum{\arabic{#1}}} +
      +

      +

    • +
    • The form \expandafter\the\csname c@counter\endcsname also works (provided \the + is allowed to be temporarily redefined, see below): + + +
      + \newcommand{\tally}[1]{% +  
       \tallynum{\expandafter\the\csname c@#1\endcsname}} +
      +

      +

    • +
    • \expandafter\the\value{counter} now also works (with the same condition as + above): + + +
      + \newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}} +
      +

      +

    • +
    • Another variation that will work: + + +
      + \newcommand{\tally}[1]{% +  
        \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}} +
      +

      +

    • +
    • and also: + + +
      + \newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}} +
      +

    +

    The following don’t work:

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

      +

    • +
    • This definition leads to \\c@page in the glossary file: + + +
      + \newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}} +
      +

    +

    If you have a numbering system where \cs name{page} expands to \internal cs name\c@page you need to +class="cmtt-10">\c@page +(for example, if \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:

    -
    +
     \newcommand*{\samplenum}[1]{%  
       \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:

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

    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 page after using class="cmtt-10">\glsaddprotectedpagefmt{⟨internal cs name}. This command doesn’t take any arguments as -the location is assumed to be given by \c@page. For example, suppose now my page counter -format uses small caps Roman numerals: +the location is assumed to be given by \c@page because that’s the only occasion this +command should be used. For example, suppose now my page counter format uses small caps +Roman numerals:

    -
    +
     \newcommand*{\samplenum}[1]{%  
      \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 \textscindexing application (particularly for makeindex). To compensate for this, + id="dx1-51016">). To compensate for this, the \glsinternal cs name -

    +
    \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page}
    -

    While this modification means that the location list in the glossary won’t exactly match 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 Roman numerals) this method will at least work correctly for both makeindex and and xindy. If + id="dx1-51019">. If you are using xindy, the following definition: + id="dx1-51020">, the following definition:

    -
    +
     \renewcommand*{\gls@samplenumpage}{%  
       \glsbackslash\string\textsc{\romannumeral\c@page}}
    -

    combined with +

    combined with

    -
    +
    \GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace"  
     "roman-numbers-lowercase" :sep "\glsclosebrace"}
    -

    will now have lowercase Roman numerals in the location list. (This option may cause -problems if your locations should be hyperlinks.) -

    Another possibility that will work with both

    will now have lowercase Roman numerals in the location list (see §11.2 Locations and +Number lists for further details on that command). Take care of the backslashes. The location +(which ends up in the :locref attribute) needs \\ 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 makeindex and and xindy is to redefine + id="dx1-51022"> is to redefine \glsinternal cs namepage (\gls@samplenumpage in this example) to just expand to -the decimal page number and redefine \gls@samplenumpage in this example) to just expand to the +decimal page number (\number\c@page) and redefine \glsnumberformat to change the displayed -format: + id="dx1-51023"> to change the +displayed format:

    -
    -  \renewcommand*{\gls@samplenumpage}{\number\c@page} - 
      \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}} +
    +\renewcommand*{\gls@samplenumpage}{\number\c@page} + 
    \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}}
    -

    -

    If you redefine

    +

    If you redefine \glsinternal cs namepage, 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 and \number while it + id="dx1-51025"> while it processes the location. If this causes a problem you can disallow it using -



    \glswrallowprimitivemodsfalse  \glswrallowprimitivemodsfalse

    -

    -

    Both

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

    +

    +

    Top

    5.3 Range Formations

    +

    Both makeindex and and xindy (Options  (Options 2 and 3) concatenate a sequence of 3 or more consecutive pages into a range. With xindy ( (Option 3) you can vary the minimum sequence length using \GlsSetXdyMinRangeLength{n} where ⟨n⟩ is either an integer or the keyword none which indicates that there should be no range formation. -

    Note that none which indicates that there should be no range formation (see §11.2 Locations and +Number lists for further details). +

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

    -

    With both is used.

    +

    +

    With both makeindex and and xindy (Options  (Options 2 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:

    -
    +
    \glsSetSuffixF{f.}  
    \glsSetSuffixFF{ff.}
    -

    Note that if you use

    Note that if you use xindy ( (Option 3), you will also need to set the minimum range length to 1 if you want to change these suffixes:

    -
    +
    \GlsSetXdyMinRangeLength{1}
    -

    Note that if you use the

    Note that if you use the hyperref package, you will need to use package, you will need to use \nohyperpage in the suffix to + id="dx1-52013"> in the suffix to ensure that the hyperlinks work correctly. For example:

    -
    +
    \glsSetSuffixF{\nohyperpage{f.}}  
    \glsSetSuffixFF{\nohyperpage{ff.}}
    -

    -

    Note that

    +

    Note that \glsSetSuffixF and \glsSetSuffixFF must be used before \makeglossaries + id="dx1-52014"> and have no effect if \noist is used.
    -

    -

    is used.

    +

    +

    It’s also possible to concatenate a sequence of consecutive locations into a range or have +suffixes with Option 4, but with bib2gls these implicit ranges can’t be merged with +explicit ranges (created with the ( and ) encaps). See the 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: -


    using: +


    \glsnumberlistloop  \glsnumberlistloop{label}{}{xr handler cs}

    -

    +

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



    handler cs{prefixformat}{location}

    -

    +

    where ⟨prefix⟩ is the hyperref prefix, ⟨ prefix, ⟨counter⟩ is the name of the counter used for the location, ⟨format⟩ is the format used to display the location (e.g. textbf) 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:

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


    in the glossary: +


    \glsnoidxdisplayloc  \glsnoidxdisplayloc{prefix}{}{location}

    -

    +

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



    \glsseeformat[tag]{xr list}{location}

    -

    +

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

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

    -

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

    +

    +

    +

    Top

    5.4 Style Hook

    +

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


    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: + id="dx1-53004">:

    -
    +
    \GlsSetWriteIstHook{%  
     \write\glswrite{page_precedence "arnAR"}%  
     \write\glswrite{line_max 80}%  
    }
    -

    This changes the page type precedence and the maximum line length used by +

    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. + id="dx1-53007">, 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 or (§4 Defining +Glossary Entries) or \newacronym (see - (see §13 Acronyms and Other Abbreviations), you can refer to that entry in the document using -one of the commands listed in §13 Acronyms and Other Abbreviations), you +can refer to that entry in the document using one of the commands listed in §6.1 §6.1 +The \gls-Like Commands (First Use Flag Queried) or -\gls-Like Commands (First Use Flag Queried) or §6.2 §6.2 The \glstext-Like Commands (First Use Flag Not Queried). The text which appears at -that point in the document when using one of these commands is referred to as the \glstext-Like +Commands (First Use Flag Not Queried). The text which appears at that point in the +document when using one of these commands is referred to as the link text -(even if there are no hyperlinks). These commands also add a line to an external file that is -used to generate the relevant entry in the glossary. This information includes an associated -location that is added to the (even if +there are no hyperlinks). These commands also add a line to an external file that is +used to generate the relevant entry in the glossary. This information includes an +associated location that is added to the number list for that entry. By default, the location refers to the -page number. For further information on number lists, see for that entry. By default, the +location refers to the page number. For further information on number lists, see §5 Number lists. These -external files need to be post-processed by §5 +Number lists. These external files need to be post-processed by makeindex or or xindy unless you have -chosen Option 1. If you don’t use +unless you have chosen Options 1 or 4. If you don’t use \makeglossaries these external files won’t be -created. -

    Note that repeated use of these commands for the same entry can cause the these +external files won’t be created. (Options 1 and 4 write the information to the .aux +file.) +

    Note that repeated use of these commands for the same entry can cause the number list to + id="dx1-54009"> to become quite long, which may not be particular helpful to the reader. In this case, you can use the non-indexing commands described in §9 §9 Using Glossary Terms Without Links or you can use the supplemental 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 §6.1 §6.1 The \gls-Like Commands (First Use Flag Queried) will have their first use flag unset when they appear in the table of contents (or list of whatever).

    -

    -

    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 package. Instead, use one of the package. Instead, use one of the expandable commands listed in §9 §9 Using Glossary Terms Without Links (such as \glsentrytext but not the non-expandable case changing versions like \Glsentrytext). Alternatively, provide an alternative via the + id="dx1-54012">). Alternatively, provide an alternative via the optional argument to the sectioning/caption command or use hyperref’s ’s \texorpdfstring. + id="dx1-54014">. Examples:

    -
    +
    \chapter{An overview of \glsentrytext{perl}}  
    \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 + id="dx1-54015"> to produce a hyperlink to the corresponding entry details in the glossary, you should load the hyperref package package before the glossaries package. That’s what I’ve done in this document, so if you see a hyperlinked term, such as link text, you can click on + id="dx1-54017">, 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 package, I strongly recommend you use pdflatex rather than + id="dx1-54019"> rather than latex to compile your document, if possible. The DVI format of LAT to compile your document, if possible. The DVI format of LATEX has limitations with the hyperlinks that can cause a problem when used with the glossaries package. Firstly, the @@ -10710,51 +12689,51 @@ a line with the DVI format. Secondly, the DVI format doesn’t correctly siz subscripts or superscripts. This means that if you define a term that may be used as a subscript or superscript, if you use the DVI format, it won’t come out the correct size. -

    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 + id="dx1-54021"> package.

    +

    +

    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 + id="dx1-54022"> to identify the glossary lists that shouldn’t have hyperlinked link text. See . See §2.1 §2.1 General Options for further details. -

    The way the

    The way the link text is displayed depends on -


    is displayed depends on +


    \glstextformat  \glstextformat{text}

    -

    +

    For example, to make all link text appear in a sans-serif font, do: + id="dx1-54026"> appear in a sans-serif font, do:

    -
    +
    \renewcommand*{\glstextformat}[1]{\textsf{#1}}
    -

    Further customisation can be done via

    Further customisation can be done via \defglsentryfmt or by redefining or by redefining \glsentryfmt. See + id="dx1-54028">. See §6.3 §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 @@ -10762,7 +12741,7 @@ to determine what text should be displayed. These types of commands are the href="#sec:gls-like">\gls-like commands and are described in §6.1 §6.1 The \gls-Like Commands (First Use Flag Queried). The commands that don’t reference or change the first use flag are href="#sec:glstext-like">\glstext-like commands and are described in §6.2 §6.2 The \glstext-Like Commands (First Use Flag Not Queried). See §14 §14 Unsetting and Resetting Entry Flags for commands that unset (mark the entry as having been used) or reset (mark the entry as not used) the first use flag without referencing the entries. -

    The

    The \gls-like and \gls{sample} will use the default hyperlink setting which depends on a number of factors (such as whether the entry is in a glossary that has been identified in the nohypertypes list). You can override the list). You can override the hyper key in the variant’s + id="dx1-54030"> key in the variant’s optional argument, for example, \gls*[hyper=true]{sample} but this creates redundancy and is best avoided. The 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}}} as this is likely to cause problems. By implication, this means that you should avoid using any of these commands within the text, , first, , short or or long + id="dx1-54034"> keys (or their plural equivalent) or any other key that you plan to access through these commands. (For example, the symbol key if you intend to use key if you intend to use \glssymbol.)
    -

    -

    The following keys are available for the optional argument: +

    +

    The keys listed below are available for the optional argument. The glossaries-extra package +provides additional keys. (See the glossaries-extra manual for further details.)

    hyper
    This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in the glossary. If this key is omitted, the value is determined by current settings, as indicated above. For example, when used with @@ -10851,44 +12834,48 @@ class="description">This is a boolean key which can be used to enable/ href="#sec:gls-like">\gls-like command, if this is the first use and the hyperfirst=false package + id="dx1-54037"> package option has been used, then the default value is hyper=false. The hyperlink can be forced on using hyper=true unless the hyperlinks have been suppressed using \glsdisablehyper. You must load the . You must load the hyperref package before the package before the glossaries + id="dx1-54040"> package to ensure the hyperlinks work.
    format
    This specifies how to format the associated location number for this entry in the glossary. This value is equivalent to the makeindex encap value, and (as with \index) - the value needs to be the name of a command without the initial backslash. As with + id="dx1-54042"> encap value, and (as with \index, the characters ) the value needs to be the name of a command without the initial + backslash. As with \index, the characters ( and ) can also be used to specify the beginning and - ending of a number range. Again as with ) can also be used to specify the + beginning and ending of a number range and they must be in matching pairs. (For + example, \gls[format={(}]{sample} on one page to start the range and later + \gls[format={)}]{sample} to close the range.) Again as with \index, the command should be the - name of a command which takes an argument (which will be the associated - location). Be careful not to use a declaration (such as , the command + should be the name of a command which takes an argument (which will be the + associated location). Be careful not to use a declaration (such as bfseries) instead of a text block command (such as textbf) as the effect is not guaranteed to be @@ -10899,65 +12886,75 @@ class="cmti-10">italic) you will need to create a command that applies bo e.g.  -
    +
    \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 or \emph or any of the commands listed in table 6.1. -

    If you use or any of the commands listed in table 6.1. You can combine + a range and format using (format⟩ to start the range and )format⟩ to end + the range. The ⟨format⟩ part must match. For example, format={(emph} and + format={)emph}. +

    If you use xindy instead of instead of makeindex, you must specify any non-standard + id="dx1-54049">, you must specify any non-standard formats that you want to use with the format key using key using \GlsAddXdyAttribute + id="dx1-54051"> {name}. So if you use xindy with the above example, you would need to + id="dx1-54052"> with the above example, you would need to add:

    -
    +
    \GlsAddXdyAttribute{textbfem}
    -

    See

    See §11 §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 (provided by the hyperref package) as the locations may not refer + id="dx1-54054"> package) as the locations may not refer to a page number. Instead, the glossaries package provides number formats listed in table 6.1.

    -


    Table 6.1: Predefined Hyperlinked Location Formats
    +class="content">Predefined Hyperlinked Location Formats
    hyperrm serif hyperlink
    hypersf sans-serif hyperlink
    hypertt monospaced hyperlink
    hyperbf bold hyperlink
    hypermd medium weight hyperlink
    hyperit italic hyperlink
    hypersl slanted hyperlink
    hyperup upright hyperlink
    hypersc small caps hyperlink
    hyperemph emphasized hyperlink

    -

    Note that if the

    Note that if the \hyperlink command hasn’t been defined, the command hasn’t been defined, the hyperxx⟩ formats are equivalent to the analogous emph). If you want to make a new format, you will need to number to be in a bold sans-serif font, you can define a command called, say, \hyperbsf: + id="dx1-54067">:

    -
    +
    \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
    -

    and then use

    and then use hyperbsf as the value for the format key. (See also “Displaying the - glossary” in the documented code, glossaries-code.pdf.) Remember that if you use - + key.6.1 + Remember that if you use xindy, you will need to add this to the list of location attributes: + id="dx1-54070">, you will need to add this to the list of location + attributes:

    -
    +
    \GlsAddXdyAttribute{hyperbsf}
    -

    +

    counter
    This specifies which counter to use for this location. This overrides the default counter used by this entry. (See also §5 §5 Number lists.)
    local
    This is a boolean key that only makes a difference when used with \gls-like commands @@ -11086,25 +13085,19 @@ class="cmtt-10">local=true, the change to the first use flag will be localised to the current scope. The default is local=false.
    -

    The glossaries-extra package provides an additional key. Please see the glossaries-extra user manual -for further details. -

    The

    The link text isn’t scoped by default. Any unscoped declarations in the isn’t scoped by default. Any unscoped declarations in the link text may + id="dx1-54074"> 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 + id="dx1-55001"> or the equivalent definition provided by \defglsentryfmt to determine the automatically generated text and its format (see to determine the automatically generated text and its format (see §6.3 +class="tcrm-1000">§6.3 Changing the format of the link text). -

    Apart from

    Apart from \glsdisp, the commands described in this section also have a , 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 @@ -11139,54 +13132,54 @@ 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 beamer and the and the tabularx environment provided by tabularx. The + id="dx1-55005">. The glossaries package automatically deals with this issue in amsmath’s ’s align environment. You can apply a patch to tabularx by placing the following command (new to v4.28) in the + id="dx1-55007"> 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 hasn’t been loaded. There’s no patch available for beamer. See + id="dx1-55010">. See §14 §14 Unsetting and Resetting Entry Flags for more details. -



    \gls  \gls[options]{label}[insert]

    -

    +

    This command typically determines the link text from the values of the from the values of the text or or first keys + id="dx1-55014"> keys supplied when the entry was defined using \newglossaryentry. However, if the entry was + id="dx1-55015">. However, if the entry was defined using \newacronym and and \setacronymstyle was used, then the link text will usually + id="dx1-55017"> was used, then the link text will usually be determined from the long or or short keys. -

    There are two upper case variants: -


    keys. +

    There are two upper case variants: +


    \Gls  \Gls[options]{label}[insert]

    -

    +

    and -



    \GLS  \GLS[options]{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:

    • If the first thing in the link text is a command follow by a group, the upper casing is + id="dx1-55024"> is a command follow by a group, the upper casing is performed on the first object of the group. For example, if an entry has been defined as -
      +
      \newglossaryentry{sample}{  
       name={\emph{sample} phrase},  
       sort={sample phrase},  
       description={an example}}
      -

      Then

      Then \Gls{sample} will set the link text + id="dx1-55025"> to6.1 +href="#fn2x6" id="fn2x6-bk">6.2

      -
      +
      \emph{\MakeUppercase sample} phrase
      -

      which will appear as

      which will appear as Sample phrase.

    • If the first thing in the link text isn’t a command or is a command but isn’t followed by + id="dx1-55027"> isn’t a command or is a command but isn’t followed by a group, then the upper casing will be performed on that first thing. For example, if an entry has been defined as: -
      +
      \newglossaryentry{sample}{  
        name={\oe-ligature},  
        sort={oe-ligature},  
        description={an example}  
      }
      -

      Then

      Then \Gls{sample} will set the link text to + id="dx1-55028"> to

      -
      +
      \MakeUppercase \oe-ligature
      -

      which will appear as Œ-ligature. +

      which will appear as Œ-ligature.

    • If you have mfirstuc v2.01 or above, an extra case is added. If the first thing is v2.01 or above, an extra case is added. If the first thing is \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 key in the above examples.) +

    There are hundreds of LATEX packages that altogether define thousands of commands with various syntax and it’s impossible for mfirstuc to take them all into account. The above + id="dx1-55031"> to take them all into account. The above rules are quite simplistic and are designed for link text that starts with a text-block + id="dx1-55032"> that starts with a text-block command (such as \emph) or a command that produces a character (such as \oe). This means that if your link text starts with something that doesn’t adhere to starts with something that doesn’t adhere to mfirstuc’s assumptions then + id="dx1-55034">’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:

    -
    +
    \newglossaryentry{sample}{  
      name={$a$},  
      sort={a},  
      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 + id="dx1-55035"> will be set to

    -
    +
    \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 @@ -11366,44 +13359,44 @@ solution is to insert an empty brace at the start:

    -
    +
    \newglossaryentry{sample}{  
      name={{}$a$},  
      sort={a},  
      description={an example}  
    }
    -

    Now the

    Now the link text will be set to + id="dx1-55036"> will be set to

    -
    +
    \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 + id="dx1-55037"> 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 case-change. A common example is when the link text starts with one of the commands + id="dx1-55038"> starts with one of the commands described in this chapter. (But you haven’t done that, have you? What with the warning not to do it at the beginning of the chapter.) Or when the link text starts with one of the + id="dx1-55039"> starts with one of the non-linking commands described in §9 §9 Using Glossary Terms Without Links. For example:

    -
    +
    \newglossaryentry{sample}{name={sample},description={an example}}  
    \newglossaryentry{sample2}{  
       name={\glsentrytext{sample} two}, @@ -11411,33 +13404,33 @@ example:  
       description={another example}  
     }
    -

    Now the

    Now the link text will be set to: + id="dx1-55040"> will be set to:

    -
    +
    \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 text field and + id="dx1-55041"> field and use the command in the name field. If you don’t use field. If you don’t use \glsname anywhere in your document, you can use \gls in the name field: + id="dx1-55043"> field:

    -
    +
    \newglossaryentry{sample}{name={sample},description={an example}}  
    \newglossaryentry{sample2}{  
       name={\gls{sample} two}, @@ -11446,32 +13439,32 @@ class="cmss-10">name   description={another example}  
     }
    -

    -

    If the

    +

    If the link text starts with a command that has an optional argument or with multiple + id="dx1-55044"> starts with a command that has an optional argument or with multiple arguments where the actual text isn’t in the first argument, then \makefirstuc will also fail. For example:

    -
    +
    \newglossaryentry{sample}{  
     name={\textcolor{blue}{sample} phrase},  
     sort={sample phrase},  
     description={an example}}
    -

    Now the

    Now the link text will be set to: + id="dx1-55045"> will be set to:

    -
    +
    \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 @@ -11479,35 +13472,35 @@ example:

    -
    +
    \newglossaryentry{sample}{  
    \newcommand*{\blue}[1]{\textcolor{blue}{#1}}  
     name={\blue{sample} phrase},  
     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:

    -
    +
    \newglossaryentry{sample}{  
    \newcommand*{\keyword}[1]{\textcolor{blue}{#1}}  
     name={\keyword{sample} phrase},  
     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 user manual. +

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



    \glspl  \glspl[options]{label}[insert]

    -

    -


    +


    \Glspl  \Glspl[options]{label}[insert]

    -

    -


    +


    \GLSpl  \GLSpl[options]{label}[insert]

    -

    +

    These typically determine the link text from the plural or or firstplural keys supplied when the + id="dx1-55051"> keys supplied when the entry was defined using \newglossaryentry or, if the entry is an abbreviation and + id="dx1-55052"> or, if the entry is an abbreviation and \setacronymstyle was used, from the longplural or or shortplural keys. -

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

    Be careful when you use glossary entries in math mode especially if you are using hyperref + id="dx1-55055"> as it can affect the spacing of subscripts and superscripts. For example, suppose you have 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  \glsdisp[options]{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 @@ -11632,34 +13625,34 @@ class="cmti-10">key⟩=⟨value⟩ list. These commands also don’t use \glsentryfmt or the equivalent definition + id="dx1-56001"> or the equivalent definition provided by \defglsentryfmt (see (see §6.3 §6.3 Changing the format of the link text). Additional commands for abbreviations are described in §13 §13 Acronyms and Other Abbreviations. -

    Apart from

    Apart from \glslink, the commands described in this section also have a , 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. See the caveat above in §6.1 §6.1 The \gls-Like Commands (First Use Flag Queried). -



    \glslink  \glslink[options]{label}{link text}

    -

    +

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

    Don’t use any of the as given in the final argument. +

    Don’t use any of the \gls-like or \glstext-like commands in the argument of class="cmtt-10">\glslink. By extension, this means that you can’t use them in the value of fields that are used to form link text.
    -

    -


    .
    +

    +


    \glstext  \glstext[options]{label}[insert]

    -

    +

    This command always uses the value of the text key as the key as the link text. + id="dx1-56009">. -

    There are also analogous commands: -


    There are also analogous commands: +


    \Glstext  \Glstext[options]{text}[insert]

    -

    -


    +


    \GLStext  \GLStext[options]{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 in combination with \glslink. For example:

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

    (See

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



    \glsfirst  \glsfirst[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsfirst  \Glsfirst[options]{text}[insert]

    -

    -


    +


    \GLSfirst  \GLSfirst[options]{text}[insert]

    -

    -

    The value of the

    +

    The value of the first key (and key (and firstplural key) doesn’t necessarily match the text produced + id="dx1-56019"> key) doesn’t necessarily match the text produced by \gls (or (or \glspl) on ) on first use as the link text used by used by \gls may be modified + id="dx1-56023"> may be modified through commands like \defglsentry. (Similarly, the value of the . (Similarly, the value of the text and and plural keys + id="dx1-56026"> keys don’t necessarily match the link text used by used by \gls or \glspl on subsequent use.)
    -

    -


    +


    \glsplural  \glsplural[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsplural  \Glsplural[options]{text}[insert]

    -

    -


    +


    \GLSplural  \GLSplural[options]{text}[insert]

    -

    -


    +


    \glsfirstplural  \glsfirstplural[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsfirstplural  \Glsfirstplural[options]{text}[insert]

    -

    -


    +


    \GLSfirstplural  \GLSfirstplural[options]{text}[insert]

    -

    -


    +


    \glsname  \glsname[options]{insert]

    -

    +

    This command always uses the value of the name key as the key as the link text. Note that this may be + id="dx1-56040">. Note that this may be different from the values of the text or or first keys. In general it’s better to use keys. In general it’s better to use \glstext or \glsfirst instead of \glsname. -

    There are also analogous uppercasing commands: -


    There are also analogous uppercasing commands: +


    \Glsname  \Glsname[options]{text}[insert]

    -

    -


    +


    \GLSname  \GLSname[options]{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  \glssymbol[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glssymbol  \Glssymbol[options]{text}[insert]

    -

    -


    +


    \GLSsymbol  \GLSsymbol[options]{text}[insert]

    -

    -


    +


    \glsdesc  \glsdesc[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsdesc  \Glsdesc[options]{text}[insert]

    -

    -


    +


    \GLSdesc  \GLSdesc[options]{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  \glsuseri[options]{label}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseri  \Glsuseri[options]{text}[insert]

    -

    -


    +


    \GLSuseri  \GLSuseri[options]{text}[insert]

    -

    -


    +


    \glsuserii  \glsuserii[options]{text}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuserii  \Glsuserii[options]{text}[insert]

    -

    -


    +


    \GLSuserii  \GLSuserii[options]{text}[insert]

    -

    -


    +


    \glsuseriii  \glsuseriii[options]{text}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseriii  \Glsuseriii[options]{text}[insert]

    -

    -


    +


    \GLSuseriii  \GLSuseriii[options]{text}[insert]

    -

    -


    +


    \glsuseriv  \glsuseriv[options]{text}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuseriv  \Glsuseriv[options]{text}[insert]

    -

    -


    +


    \GLSuseriv  \GLSuseriv[options]{insert]

    -

    -


    +


    \glsuserv  \glsuserv[options]{text}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuserv  \Glsuserv[options]{text}[insert]

    -

    -


    +


    \GLSuserv  \GLSuserv[options]{text}[insert]

    -

    -


    +


    \glsuservi  \glsuservi[options]{text}[insert]

    -

    +

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

    There are also analogous uppercasing commands: -


    . +

    There are also analogous uppercasing commands: +


    \Glsuservi  \Glsuservi[options]{text}[insert]

    -

    -


    +


    \GLSuservi  \GLSuservi[options]{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 for the \gls-like commands is governed by6.2: -


    6.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  \defglsentryfmt[type]{definition}

    -

    +

    instead of redefining \glsentryfmt. The optional first argument ⟨type⟩ is the glossary type. This defaults to \glsdefaulttype if omitted. The second argument is the entry format + id="dx1-57008"> 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 \defglsentryfmt, redefining + id="dx1-57009">, redefining \glsentryfmt won’t have an effect on that glossary, you must instead use \defglsentryfmt again. Note that glossaries that have been identified as lists of acronyms (via the package option acronymlists or the command or the command \DeclareAcronymList, see , see §2.5 §2.5 Acronym Options) use \defglsentryfmt to set their display style.
    -

    -

    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 + id="dx1-57014"> 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 \gls, , \glspl and their + id="dx1-57017"> and their upper case variants. (You can use etoolbox’s ’s \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  \glsifplural{true text}{false text}

    -

    +

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



    \glscapscase  \glscapscase{no case}{first uc}{all caps}

    -

    +

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



    \glsifhyperon  \glsifhyperon{hyper true}{hyper false}

    -

    +

    This will do ⟨hyper true⟩ if the hyperlinks are on for the current reference, otherwise it will do ⟨hyper false⟩. The hyperlink may be off even if it wasn’t explicitly switched off with the hyper key or the use of a starred command. It may be off because the + id="dx1-57023"> key or the use of a starred command. It may be off because the hyperref package hasn’t been loaded or because package hasn’t been loaded or because \glsdisablehyper has been used or + id="dx1-57025"> has been used or because the entry is in a glossary type that’s had the hyperlinks switched off (using nohypertypes) or because it’s the ) 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 + id="dx1-57027"> 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  \glslinkvar{unmodified}{star}{plus}

    -

    +

    This will do ⟨unmodified⟩ if the unmodified version was used, or will do ⟨star⟩ if the starred @@ -12510,59 +14503,59 @@ version was used, or will do ⟨plus⟩ if the plus version was used. Note that this doesn’t take into account if the hyper key was used to override the default setting, so this + id="dx1-57029"> key was used to override the default setting, so this command shouldn’t be used to guess whether or not the hyperlink is on for this reference. -

    Note that you can also use commands such as

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

    The commands

    The commands \glslabel, , \glstype, , \glsifplural, , \glscapscase, , \glscustomtext and + id="dx1-57035"> and \glsinsert are typically updated at the start of the are typically updated at the start of the \gls-like and \glstext-like commands so they can usually be accessed in the hook user commands, such as \glspostlinkhook and + id="dx1-57037"> and \glslinkpostsetkeys. -

    This means that using commands like . +

    This means that using commands like \gls within the fields that are accessed using the + id="dx1-57039"> within the fields that are accessed using the \gls-like or \glstext-like commands (such as the first, , text, , long or or short keys) will cause a + id="dx1-57043"> keys) will cause a problem. The entry formatting performed by \glsentryfmt and related commands isn’t scoped (otherwise if would cause problems for \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, , text, , plural or or firstplural keys (or the + id="dx1-57048"> 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: -


    ) you can use: +


    \glsgenacfmt  \glsgenacfmt

    -

    +

    This uses the values from the long, , short, , longplural and and shortplural keys, rather than + id="dx1-57054"> keys, rather than using the text, , plural, , first and and firstplural keys. The first use singular text is obtained + id="dx1-57058"> keys. The first use singular text is obtained via: -



    \genacrfullformat  \genacrfullformat{label}{insert}

    -

    +

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


    key, and the first use plural text is obtained via: +


    \genplacrfullformat  \genplacrfullformat{label}{insert}

    -

    +

    instead of from the firstplural key. In both cases, ⟨ key. In both cases, ⟨label⟩ is the entry’s label and ⟨insert⟩ is the insert text provided in the final optional argument of commands like \gls. The default + id="dx1-57063">. The default behaviour is to do the long form (or plural long form) followed by ⟨insert⟩ and a space and the short form (or plural short form) in parentheses, where the short form is in the argument of \firstacronymfont. There are also first letter upper case + id="dx1-57064">. There are also first letter upper case versions: -



    \Genacrfullformat  \Genacrfullformat{label}{insert}

    -

    +

    and -



    \Genplacrfullformat  \Genplacrfullformat{label}{insert}

    -

    +

    By default these perform a protected expansion on their no-case-change equivalents and then use \makefirstuc to convert the first character to upper case. If there are issues + id="dx1-57067"> to convert the first character to upper case. If there are issues caused by this expansion, you will need to redefine those commands to explicitly use commands like \Glsentrylong (which is what the predefined acronym styles, + id="dx1-57068"> (which is what the predefined acronym styles, such as long-short, do). Otherwise, you only need to redefine , do). Otherwise, you only need to redefine \genacrfullformat + id="dx1-57070"> and \genplacrfullformat to change the behaviour of to change the behaviour of \glsgenacfmt. See . See §13 +class="tcrm-1000">§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 unset (see example 24). +href="#x1-72077r25">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 + id="dx1-57077"> key to store the unit:

    -
    +
    \newglossaryentry{distance}{name=distance,  
    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 as follows: + id="dx1-57078"> as follows:

    -
    +
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%  
    }
    -

    -

    (Note that I’ve used

    +

    (Note that I’ve used \glsentrysymbol rather than rather than \glssymbol to avoid nested + id="dx1-57080"> to avoid nested hyperlinks.) -

    Note also that all of the

    Note also that all of the link text will be formatted according to will be formatted according to \glstextformat + id="dx1-57082"> (described earlier). So if you do, say:

    -
    +
    \renewcommand{\glstextformat}[1]{\textbf{#1}}  
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \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 @@ -12815,68 +14808,68 @@ do:

    -
    +
    \defglsentryfmt[notation]{\glsgenentryfmt  
     \ifglsused{\glslabel}{}{\space  
       (denoted \glsentrysymbol{\glslabel})}}
    -

    Now suppose you have defined an entry as follows: +

    Now suppose you have defined an entry as follows:

    -
    +
    \newglossaryentry{set}{type=notation,  
      name=set,  
      description={A collection of objects},  
      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 + id="dx1-57085"> was used). +

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

    -
    +
    \defglsentryfmt[notation]{\glsgenentryfmt  
     \ifglsused{\glslabel}{}{\space  
       (denoted $\glsentrysymbol{\glslabel}$)}}
    -

    and define entries like this: +

    and define entries like this:

    -
    +
    \newglossaryentry{set}{type=notation,  
      name=set,  
      description={A collection of objects},  
      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 + id="dx1-57086"> 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 or html packages prior to loading the packages prior to loading the glossaries package, the \glstext-like commands will automatically have hyperlinks to the relevant glossary entry, unless the hyper option has been switched off (either explicitly or through + id="dx1-58003"> option has been switched off (either explicitly or through implicit means, such as via the nohypertypes package option). -

    You can disable or enable links using: -


    package option). +

    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 \hyperlink and and \hypertarget have + id="dx1-58008"> have been defined (for example, by the hyperref package). -

    You can disable just the package). +

    You can disable just the first use links using the package option hyperfirst=false. Note + id="dx1-58010">. Note that this option only affects the \gls-like commands that recognise the 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 + id="x1-58012"> +

    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=false: + id="dx1-58013">:

    -
    +
    \usepackage[hyperfirst=false]{glossaries}
    -

    Now I need to redefine

    Now I need to redefine \glsentryfmt (see (see §6.3 §6.3 Changing the format of the link text):

    -
    +
    \renewcommand*{\glsentryfmt}{%  
      \glsgenentryfmt  
      \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 + id="dx1-58015"> option applies to all defined glossaries. It may be that you only want to disable the hyperlinks on first use for glossaries that have a different form on first use. This can be achieved by noting that since the entries that require hyperlinking for all instances have identical first and subsequent text, they can be unset via \glsunsetall (see + id="dx1-58016"> (see §14 §14 Unsetting and Resetting Entry Flags) so that the hyperfirst option doesn’t get + id="dx1-58017"> option doesn’t get applied. -

    +

    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:

    -
    +
    \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 + id="dx1-58020"> and put the hyperlinks (where required) within the definition of \glsentryfmt (see (see §6.3 §6.3 Changing the format of the link text) via \glshyperlink (see (see §9 +class="tcrm-1000">§9 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 + id="x1-58024"> +

    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. I can do this by adding the glossary to the list of nohypertypes and redefining \glsentryfmt: + id="dx1-58025">:

    -
    +
    \GlsDeclareNoHyperList{main}  
    \renewcommand*{\glsentryfmt}{%  
      \ifmmode @@ -13056,48 +15049,48 @@ 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 + id="x1-58027"> +

    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 (see (see §4.3.2 §4.3.2 Storage Keys) that keeps track of the chapter number that the entry was last used in:

    -
    +
    \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 (see §6.3 §6.3 Changing the format of the link text) so that it determines the current chapter number (which is stored in \currentchap @@ -13107,15 +15100,15 @@ class="cmtt-10">chapter key that I defined earlier. If they’re the same, this entry has already been used in this chapter so the hyperlink is switched off using xkeyval’s ’s \setkeys command. If the chapter number isn’t the same, then this entry hasn’t been used in the current chapter. The chapter field is updated using \glsfieldxdef ( (§16.3 §16.3 Fetching and Updating the Value of a Field) provided the user hasn’t switched off the hyperlink. (This test is performed using \glsifhyperon.

    -
    +
    \renewcommand*{\glslinkpostsetkeys}{%  
     \edef\currentchap{\arabic{chapter}}%  
     \ifnum\currentchap=\glschapnum{\glslabel}\relax @@ -13133,42 +15126,42 @@ class="cmtt-10">\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  \glsadd[options]{label}

    -

    +

    This is similar to the \glstext-like commands, only it doesn’t produce any text (so therefore, there is no hyper key available in ⟨ key available in ⟨options⟩ but all the other options that can be used with set:

    -
    +
    \glsadd[format=(]{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 types which can + id="dx1-59004"> which can be used to specify which glossaries to use. This should be a comma separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type \acronymtype) and a list of notation (specified by the glossary type + id="dx1-59005">) and a list of notation (specified by the glossary type notation) then you can do:

    -
    +
    \glsaddall[types={\acronymtype,notation}]
    -

    -

    Note that

    +

    Note that \glsadd and \glsaddall add the current location to the number list. In the + id="dx1-59006">. In the case of \glsaddall, all entries in the glossary will have the same location in the number list. If you want to use \glsaddall, it’s best to suppress the number list with the nonumberlist + id="dx1-59007"> package option. (See sections 2.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 should appear both in the main glossary and in the list of acronyms. This example sets up the list of acronyms using the acronym package option: + id="dx1-59011"> package option:

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

    -
    +
    \newcommand*{\newdualentry}[5][]{%  
      \newglossaryentry{main-#2}{name={#4},%  
      text={#3\glsadd{#2}},% @@ -13283,11 +15276,11 @@ class="cmss-10">acronym  \newacronym{#2}{#3\glsadd{main-#2}}{#4}%  
    }
    -

    This has the following syntax:

    +

    This has the following syntax:

    \newdualentry[options]{}
    You can then define a new dual entry: -
    +
    \newdualentry{svm}% label  
      {SVM}% abbreviation  
      {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  (Options 2 or 3) or \makenoidxglossaries + id="dx1-60002"> (Option 1) before defining any terms that cross-reference entries. If any of the terms that you have cross-referenced don’t appear in the glossary, check that you have put \makeglossaries/\makenoidxglossaries before all entry definitions.
    -

    -

    There are several ways of cross-referencing entries in the glossary: +class="cmtt-10">\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:

    1. You can use commands such as You can use commands such as \gls in the entries description. For example: + id="dx1-60005"> in the entries description. For example: -
      +
      \newglossaryentry{apple}{name=apple,  
      description={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 makeglossaries: + id="dx1-60006">:

      -
      +
      latex filename  
      makeglossaries filename  
      latex filename  
      makeglossaries filename  
      latex filename
      -

      +

    2. As described in As described in §4 §4 Defining Glossary Entries, you can use the see key when you define + id="dx1-60009"> key when you define the entry. For example: -
      +
      \newglossaryentry{MaclaurinSeries}{name={Maclaurin  
      series},  
      description={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 + id="dx1-60010"> key will automatically be added to the glossary, but the cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the commands described in §6 §6 Links to Glossary Entries or §7 §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 + id="dx1-60011">, but can be overridden in specific instances using square brackets at the start of the see value. For example: + id="dx1-60012"> value. For example:

      -
      +
      \newglossaryentry{MaclaurinSeries}{name={Maclaurin  
      series},  
      description={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 + id="dx1-60013"> or \newterm as the value will need to be grouped. For example: + id="dx1-60014"> as the value will need to be grouped. For example:

      -
      +
      \newterm{seal}  
      \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:

      -
      +
      \glossaryentry{lemon}{  
        name={lemon},  
        description={Yellow citrus fruit} @@ -13445,14 +15441,14 @@ class="cmtt-10">\newterm  see={lemon,lime}  
      }
      -

      +

    3. After you have defined the entry, use -


      After you have defined the entry, use +


      \glssee  \glssee[tag]{label}{xr label list}

      -

      +

      where ⟨xr label list⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨label⟩ @@ -13469,54 +15465,54 @@ class="cmti-10">tag⟩ is the “see” tag. (The default value of ⟨tag⟩ is \seename.) For example: + id="dx1-60018">.) For example:

      -
      +
      \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, + id="dx1-60019">, whereas in case 1, the cross-referenced information appears in the description. (See the sample-crossref.tex example file that comes with this package.) This means that in cases 2 and 3, the cross-referencing information won’t appear if you have suppressed the number list. In this case, you will need to activate the number list for the given entries using + id="dx1-60020">. In this case, you will need to activate the number list for the given entries using nonumberlist=false. Alternatively, if you just use the . Alternatively, if you just use the see key instead of key instead of \glssee, you + id="dx1-60024">, you can automatically activate the number list using the using the seeautonumberlist package + id="dx1-60026"> package option.

    -

    Top

    8.1 Customising Cross-reference Text

    -

    When you use either the

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



    \glsseeformat  \glsseeformat[tag]{label-list}{location}

    -

    +

    The default definition of \glsseeformat is:
    }
    Note that the location is always ignored.8.1 + id="x1-61003f1"> For example, if you want the tag to appear in bold, you can do:8.2 + id="x1-61005f2">

    -
    +
    \renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1}  
     \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{label}.8.3 + id="x1-61013f3"> For example, to make the cross-referenced list use small caps:

    -
    +
    \renewcommand{\glsseeitemformat}[1]{%  
      \textsc{\glsentrytext{#1}}}
    -

    -

    You can use

    +

    You can use \glsseeformat and and \glsseelist in the main body of the text, but they + id="dx1-61017"> in the main body of the text, but they won’t automatically add the cross-referenced entries to the glossary. If you want them added with that location, you can do:

    -
    +
    Some information (see also  
    \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 + id="dx1-62001">, they don’t have any optional arguments, they don’t affect the first use flag and, apart from \glshyperlink, they don’t + id="dx1-62002">, 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 ’s \texorpdfstring if you want to use them in sectioning commands. (This isn’t specific to the glossaries package.) See the hyperref + id="dx1-62004"> documentation for further details. All the commands that convert the first letter to upper case aren’t expandable. The other commands depend on whether their corresponding keys were assigned non-expandable values.
    -

    -

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


    +

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


    \glsentrytitlecase  \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 package.) +

    Note that this command has the same limitations as \makefirstuc which is used by commands like \Gls and \Glsentryname to upper-case the first letter (see the not \Gls in §6.1 §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 name key. key. \Glsentryname makes the first letter upper case. Neither of these commands check for the existence of ⟨label⟩. The first form \glsentryname is expandable (unless the name contains unexpandable commands). Note that this may be different from the values of the text or or first keys. In general it’s better to use keys. In general it’s better to use \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 text key. key. \Glsentrytext makes the first letter upper case. The first form is 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 plural key. key. \Glsentryplural makes the first letter upper case. 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⟩. -



    \glsentryfirst  \glsentryfirst{label}

    -

    -


    +


    \Glsentryfirst  \Glsentryfirst{label}

    -

    +

    These commands display the first use text for the glossary entry given by ⟨label⟩, as specified by the first key. key. \Glsentryfirst makes the first letter upper case. 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⟩, as specified by the firstplural key. key. \Glsentryfirstplural makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable @@ -13865,22 +15861,22 @@ case. The first form is expandable (unless the value of that key contains unexpa commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentrydesc  \glsentrydesc{label}

    -

    -


    +


    \Glsentrydesc  \Glsentrydesc{label}

    -

    +

    These commands display the description for the glossary entry given by ⟨label⟩. \Glsentrydesc @@ -13888,14 +15884,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 @@ -13960,10 +15956,10 @@ 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  \glsletentryfield{cs}{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 @@ -13982,18 +15978,18 @@ 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  \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 @@ -14140,72 +16136,72 @@ 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  \glshyperlink[link text]{label}

    -

    +

    This command provides a hyperlink to the glossary entry given by ⟨labelbut does not add any information to the glossary file. The link text is given by \glsentrytext{label} by default9.1, + id="x1-62053f1">, but can be overridden using the optional argument. Note that the hyperlink will be suppressed if you have used \glsdisablehyper or if you haven’t loaded the or if you haven’t loaded the hyperref + id="dx1-62058"> 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 §6 §6 Links to Glossary Entries or §7 +class="tcrm-1000">§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 + id="dx1-62059"> package option: -



    \glsentrynumberlist  \glsentrynumberlist{label}

    -

    -


    +


    \glsdisplaynumberlist  \glsdisplaynumberlist{label}

    -

    +

    Both display the number list for the entry given by ⟨ for the entry given by ⟨label⟩. When used with Option 1 a rerun is required to ensure this list is up-to-date, when used with Options 3 a run of makeglossaries (or (or makeindex//xindy) followed by one or two runs of LAT) 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 2 or 3 it only works when the default counter format is used (that is, when the format key is set to key is set to glsnumberformat). This command will only work with hyperref if you + id="dx1-62069"> if you choose Option 1. If you try using this command with Options 2 or 3 and hyperref, + id="dx1-62070">, \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

    @@ -14283,15 +16279,15 @@ class="cmbx-10">Option 1:
    -



    \printnoidxglossaries  \printnoidxglossaries

    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) + id="dx1-63002"> in the preamble.)

    Options3:
    -



    \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. + id="dx1-63004"> in the preamble.)

    +

    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 the Perl script makeglossaries or Lua script or Lua script makeglossaries-lite.lua or have directly -used makeglossaries-lite or have directly used +makeindex or or xindy (as described in (as described in §1.4 Generating the Associated Glossary Files). -(While the external files are missing, these commands will just do \null for each missing -glossary to assist dictionary style documents that just use \glsaddall without inserting any -text.) -

    If the glossary still does not appear after you re-LAT§1.5 Generating the Associated Glossary Files). (While +the external files are missing, these commands will just do \null for each missing glossary to +assist dictionary style documents that just use \glsaddall without inserting any text. If you +use glossaries-extra, it will insert a heading and boilerplate text when the external files are +missing.) +

    If the glossary still does not appear after you re-LATEX your document, check the makeindex//xindy log files to see if there is a problem. With log files to see if there is a problem. With Option 1, you just need two LATEX runs to make the glossaries appear, but you may need further runs to make the number lists up-to-date. -

    An individual glossary can be displayed using: + id="dx1-63011">s up-to-date. +

    An individual glossary can be displayed using:

    Option 1:
    -



    \printnoidxglossary  \printnoidxglossary[options]

    -

    +

    (Must be used with \makenoidxglossaries in the preamble.) + id="dx1-63013"> in the preamble.)

    Options3:
    -



    \printglossary  \printglossary[options]

    -

    +

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

    -

    where ⟨ in the preamble.)

    +

    where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. (Again, when the associated external file is missing, \null is inserted into the document.) -

    The following keys are available: +

    The following keys are available:

    type
    The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For example, to print the list of acronyms: -
    +
    \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 + id="dx1-63017"> to the name of a glossary that was defined using \newignoredglossary. (See . (See §12 §12 Defining New Glossaries.)

    title
    This is the glossary’s title (overriding the title specified when the glossary was defined).
    toctitle
    This is the title to use for the table of contents (if the toc package option has been + id="dx1-63021"> package option has been used). It may also be used for the page header, depending on the page style. If omitted, the value of title is used. + id="dx1-63022"> is used.
    style
    This specifies which glossary style to use for this glossary, overriding the effect of the style package option or package option or \glossarystyle. + id="dx1-63025">.
    numberedsection
    This specifies whether to use a numbered section for this glossary, overriding the effect of the numberedsection package option. This key has the same + id="dx1-63027"> package option. This key has the same syntax as the numberedsection package option, described in package option, described in §2.2 §2.2 Sectioning, Headings and TOC Options.
    nonumberlist
    This is a boolean key. If true (nonumberlist=true) the numberlist is suppressed for this glossary. If false (nonumberlist=false) the numberlist is displ
    nogroupskip
    This is a boolean key. If true the vertical gap between groups is suppressed for this glossary.
    nopostdot
    This is a boolean key. If true the full stop after the description is suppressed for this glossary.
    entrycounter
    This is a boolean key. Behaves similar to the package option of the same name. The corresponding package option must be used to make \glsrefentry work + id="dx1-63033"> work correctly.
    subentrycounter
    This is a boolean key. Behaves similar to the package option of the same name. If you want to set both entrycounter and and subentrycounter, make sure you specify + id="dx1-63036">, make sure you specify entrycounter first. The corresponding package option must be used to make + id="dx1-63037"> first. The corresponding package option must be used to make \glsrefentry work correctly. + id="dx1-63038"> work correctly.
    sort
    This key is only available for Option 1. Possible values are: word (word order), letter (letter order), standard (word or letter ordering taken from the order package option), + id="dx1-63040"> package option), use (order of use), def (order of definition) nocase (case-insensitive) or case (case-sensitive). -

    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 + id="dx1-63041"> option.

    +

    +

    The word and letter @@ -14548,14 +16547,14 @@ class="cmss-10">nogroupskipdatatool’s + id="dx1-63042">’s \dtlwordindexcompare + id="dx1-63043"> and \dtlletterindexcompare + id="dx1-63044"> handlers. The case-insensitive @@ -14564,10 +16563,10 @@ class="cmtt-10">\dtlletterindexcomparedatatool’s + id="dx1-63045">’s \dtlicompare + id="dx1-63046"> handler. The case-sensitive @@ -14576,135 +16575,135 @@ class="cmtt-10">\dtlicomparedatatool’s + id="dx1-63047">’s \dtlcompare + id="dx1-63048"> handler. See the datatool + id="dx1-63049"> documentation for further details. -

    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=true package + id="dx1-63050"> package option or make sure none of the entries have fragile commands in their sort + id="dx1-63051"> field.

    -

    By default, the glossary is started either by

    By default, the glossary is started either by \chapter* or by or by \section*, depending on + id="dx1-63053">, depending on whether or not \chapter is defined. This can be overridden by the is defined. This can be overridden by the section package option or + id="dx1-63055"> package option or the \setglossarysection command. Numbered sectional units can be obtained using + id="dx1-63056"> command. Numbered sectional units can be obtained using the numberedsection package option. Each glossary sets the page header via the + id="dx1-63057"> 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. Further information about these options and commands is + id="dx1-63060">. Further information about these options and commands is given in §2.2 §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:

    -
    +
    \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  \setglossarypreamble[type]{preamble text}

    -

    +

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

    For example: +

    For example:

    -
    +
    \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 + id="dx1-63066"> style10.1, + id="x1-63067f1">, and you want the glossary to be in two columns, but after the glossary you want to switch back to one column mode, you could do:

    -
    +
    \renewcommand*{\glossarysection}[2][]{%  
      \twocolumn[{\chapter*{#2}}]%  
      \setlength\glsdescwidth{0.6\linewidth}% @@ -14712,163 +16711,167 @@ back to one column mode, you could do:  
    }  
    \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 surrounding font happens to be. This means that in the list-like glossary styles (defined in the glossary-list style file) the name will appear in bold, since the name is placed + id="dx1-63072"> style file) the name will appear in bold, since the name is placed in the optional argument of \item, whereas in the tabular styles (defined in the glossary-long and and glossary-super style files) the name will appear in the normal font. The + id="dx1-63074"> style files) the name will appear in the normal font. The hierarchical glossary styles (defined in the glossary-tree style file) also set the name in + id="dx1-63075"> 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. + id="dx1-63076"> 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 + id="x1-63078"> +

    Suppose you want all the entry names to appear in medium weight small caps in your 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 + id="dx1-64001"> to sort the glossary, you must use the package option xindy: + id="dx1-64002">:

    -
    +
    \usepackage[xindy]{glossaries}
    -

    This ensures that the glossary information is written in

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

    syntax. +

    §1.4 §1.5 Generating the Associated Glossary Files covers how to use the external indexing -application. This section covers the commands provided by the glossaries package that allow -you to adjust the , and §5.2 Locations covers the issues involved in the location syntax. This section +covers the commands provided by the glossaries package that allow you to adjust the xindy style file ( +style file (.xdy) and parameters. -

    To assist writing information to the ) and parameters. +

    To assist writing information to the xindy style file, the 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 style file using style file using ~n so you can use \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: -


    ) 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 + id="dx1-64015"> style file than is available through the LATEX commands provided by the glossaries package, you will need to edit the xindy + id="dx1-64016"> style file. In which case, you must use \noist to prevent the style file from being + id="dx1-64017"> to prevent the style file from being overwritten by the glossaries package. For additional information about xindy, read + id="dx1-64018">, read the xindy documentation. I’m sorry I can’t provide any assistance with writing + id="dx1-64019"> documentation. I’m sorry I can’t provide any assistance with writing xindy style files. If you need help, I recommend you ask on the style files. If you need help, I recommend you ask on the xindy mailing list + id="dx1-64021"> mailing list (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 + id="dx1-65001">, you need to specify the language and encoding used (unless you have written your own custom xindy style file that defines the relevant alphabet + id="dx1-65002"> style file that defines the relevant alphabet and sort rules). If you use makeglossaries, this information is obtained from the + id="dx1-65003">, this information is obtained from the document’s auxiliary (.aux) file. The ) file. The makeglossaries script attempts to find the root + id="dx1-65005"> script attempts to find the root language given your document settings, but in the event that it gets it wrong or if xindy doesn’t support that language, then you can specify the required language + id="dx1-65006"> doesn’t support that language, then you can specify the required language using: -



    \GlsSetXdyLanguage  \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 + id="dx1-65008"> package is used, the encoding will be obtained from the value of \inputencodingname. Alternatively, you can specify the encoding using: -


    . Alternatively, you can specify the encoding using: +


    \GlsSetXdyCodePage  \GlsSetXdyCodePage{code}

    -

    +

    where ⟨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 + id="dx1-65011"> style file that includes the language settings, you need 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 to prevent the style file from being overwritten). +

    The commands \GlsSetXdyLanguage and \GlsSetXdyCodePage have no effect if you don’t use makeglossaries. If you call . If you call xindy without without makeglossaries you + id="dx1-65015"> you need to remember to set the language and encoding using the -L and and -C switches. + id="dx1-65017"> switches.
    -

    -

    +

    +

    -

    Top

    11.2 Locations and Number lists

    -

    If you use

    If you use xindy, the , the glossaries package needs to know which counters you will be using in the number list in order to correctly format the in order to correctly format the xindy style file. Counters specified using the + id="dx1-66003"> style file. Counters specified using the counter package option or the ⟨ package option or the ⟨counter⟩ option of \newglossary are automatically taken + id="dx1-66005"> are automatically taken care of, but if you plan to use a different counter in the counter key for commands + id="dx1-66006"> key for commands like \glslink, then you need to identify these counters , then you need to identify these counters before \makeglossaries + id="dx1-66008"> 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 ( key (textrm, , hyperrm etc) are automatically + id="dx1-66012"> etc) are automatically added to the xindy style file, but if you want to use another attribute, you need to add it + id="dx1-66013"> 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 + id="dx1-66015"> key. +

    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:

    -
    +
    \newcommand*{\primary}[1]{\textbf{#1}}  
    \GlsAddXdyAttribute{primary}
    -

    Then in the document: +

    Then in the document:

    -
    +
    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. + id="dx1-66016"> 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 + id="x1-66018"> +

    Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do this:

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

    but with

    but with xindy, I also need to add this as an allowed attribute: + id="dx1-66019">, I also need to add this as an allowed attribute:

    -
    +
    \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: + id="dx1-66020">:

    -
    +
    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 is used or if \makeglossaries is + id="dx1-66022"> is omitted. \GlsAddXdyAttribute must be used before \makeglossaries. Additionally, + id="dx1-66023">. Additionally, \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  \GlsAddXdyLocation[prefix-location]{}{definition}

    -

    +

    where ⟨name⟩ is the name of the format and ⟨definition⟩ is the xindy definition. The optional + id="dx1-66025"> definition. The optional argument ⟨prefix-location⟩ is needed if \theHcounter⟩ either isn’t defined or is different -from counter⟩ either isn’t defined or is different from +\thecounter⟩. (See also \glsaddprotectedpagefmt described in §5 Number -lists.) -

    Note that counter⟩. Be sure to also read §5.2 Locations for some issues that you may +encounter. +

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

    + id="dx1-66028">.

    +

    -

    +

    Example 18 (Custom Numbering System for Locations) -

    Suppose I decide to use a somewhat eccentric numbering system for sections where I + id="x1-66030"> +

    Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine \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:

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

    -
    +
    \GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]"  
      "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 + id="dx1-66031"> 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:

    -
    +
    \GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["  
      "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 + id="dx1-66032"> will result in an empty string if the counter is zero, it’s a good idea to add an extra location to catch this:

    -
    +
    \GlsAddXdyLocation{zero.section}{:sep "["  
      "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 Words not Digits) -

    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 as follows: +class="cmbx-12"> (Locations as Dice) +

    Suppose I want a rather eccentric page numbering system that’s represented by the +number of dots on dice. The stix package provides \dicei, …, \dicevi that represent the six +sides of a die. I can define a command that takes a number as its argument. If the +number is less than seven, the appropriate \dicen⟩ command is used otherwise it +does \dicevi the required number of times with the leftover in a final \dicen⟩. For +example, the number 16 is represented by \dicevi\dicevi\diceiv (6 + 6 + 4 = 16). +I’ve called this command \tallynum to match the example given earlier in §5.2 +Locations:

    -
    -\renewcommand*{\thepage}{\Numberstring{page}} +
    +\newrobustcmd{\tallynum}[1]{% + 
     \ifnum\number#1<7 + 
      $\csname dice\romannumeral#1\endcsname$% + 
     \else + 
      $\dicevi$% + 
      \expandafter\tallynum\expandafter{\numexpr#1-6}% + 
     \fi + 
    }
    -

    This gets expanded to \protect \Numberstringnum {n} where ⟨n⟩ is the Arabic page -number. This means that I need to define a new location that has that form: +

    Here’s the counter command:

    -
    -\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space - 
      \string\Numberstringnum\space\glsopenbrace" - 
      "arabic-numbers" :sep "\glsclosebrace"} +
    +newcommand{\tally}[1]{\tallynum{\arabic{#1}}} +
    +

    The page counter representation (\thepage) needs to be changed to use this command: + + +

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

    The \tally command expands to \tallynum {number} so this needs a location class that +matches this format: + + +

    +
    +\GlsAddXdyLocation{tally}{% + 
     :sep "\string\tallynum\space\glsopenbrace" + 
     "arabic-numbers" + 
     :sep "\glsclosebrace" + 
    }
    -

    Note that it’s necessary to use \space to indicate that spaces also appear in the format, -since, unlike TEX,

    The space between \tallynum and {number} is significant to xindy doesn’t ignore spaces after control sequences. -

    Note that so \space is +required. +

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



    \glsXcounterXHprefix}{location}

    -

    +

    for each counter that has been identified either by the counter package option, the ⟨ package option, the ⟨counter⟩ option for \newglossary or in the argument of or in the argument of \GlsAddXdyCounters. -

    The first argument ⟨. The first argument +⟨Hprefix⟩ is only relevant when used with the hyperref package and -indicates that \theHcounter⟩ is given by package and indicates that \theHcounter⟩ +is given by \Hprefix.\thecounter⟩. The sample file -counter⟩. +

    The sample file samplexdy.tex, which comes with the glossaries package, uses the default glossaries package, uses the default +page counter for -locations, and it uses the default counter for locations, and it uses the default \glsnumberformat and a custom \hyperbfit format. A -new and a custom +\hyperbfit format. A new xindy location called Numberstring, as illustrated above, is defined to make the -page numbers appear as “One”, “Two”, etc. In order for the location numbers to + id="dx1-66044"> location called tallynum, as illustrated above, is defined +to make the page numbers appear as dice. In order for the location numbers to hyperlink to the relevant pages, I need to redefine the necessary \glsXcounter -

    +
    \renewcommand{\glsXpageXglsnumberformat}[2]{%  
     \linkpagenumber#2%  
    }  
    \renewcommand{\glsXpageXhyperbfit}[2]{%  
     \textbf{\em\linkpagenumber#2}%  
    } - 
    \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} + 
    \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} +
    +

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

    +
    + \linkpagenumber#2% +
    +

    does

    +
    + \linkpagenumber\tallynum{number} +
    +
    so \tallynum is the first argument of \linkpagenumber and ⟨number⟩ is the second +argument. +
    +

    +

    ____________________________

    +

    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 +fmtcount package to do this. I can redefine \thepage as follows: + + +

    +
    +\renewcommand*{\thepage}{\Numberstring{page}} +
    +

    This used to get expanded to \protect \Numberstringnum {n} where ⟨n⟩ is the +Arabic page number. This means that I needed to define a new location with the +form: + + +

    +
    +\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space + 
      \string\Numberstringnum\space\glsopenbrace" + 
      "arabic-numbers" :sep "\glsclosebrace"} +
    +

    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 \Numberstring has since changed so that it now expands to +\Numberstringnum {n} (no \protect). This means that the location class definition must be +changed to: + + +

    +
    +\GlsAddXdyLocation{Numberstring}{% no \protect now! + 
      :sep "\string\Numberstringnum\space\glsopenbrace" + 
      "arabic-numbers" :sep "\glsclosebrace"} +
    +

    and \linkpagenumber goes back to only two arguments: + + +

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

    The other change is that \Numberstring uses

    +
    +\the\value{counter}
    -

    +
    instead of
    +
    +\expandafter\the\csname c@counter\endcsname +
    +
    so it hides \c@page from the location escaping mechanism (see §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 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 samplexdy3.tex illustrates +this.

    -

    -

    ____________________________

    -

    In the

    +

    ____________________________

    +

    In the number list, the locations are sorted according to type. The default -ordering is: roman-page-numbers (e.g. i), arabic-page-numbers (e.g. 1), + id="dx1-66050">, 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, …), arabic-section-numbers (e.g. 1.1 if the compositor is a full stop or 1-1 if the compositor is a +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-66051f1">), alpha-page-numbers (e.g. a), Roman-page-numbers (e.g. I), Alpha-page-numbers (e.g. A), +class="cmtt-10">alpha-page-numbers (a, b, …), Roman-page-numbers (I, II, …), Appendix-page-numbers (e.g. A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor -is a hyphenAlpha-page-numbers (A, B, …), 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-66053f2">), user defined location names (as specified by \GlsAddXdyLocation in the order in which -they were defined), see (cross-referenced entries). This ordering can be changed -using: -

    in +the order in which they were defined), and finally see (cross-referenced +entries).11.3 +This ordering can be changed using: +


    \GlsSetXdyLocationClassOrder  -


    \GlsSetXdyLocationClassOrder{location names}

    -

    +class="cmtt-10">} +


    +

    where each location name is delimited by double quote marks and separated by white space. For example:

    -
    +
    \GlsSetXdyLocationClassOrder{  
      "arabic-page-numbers"  
      "arabic-section-numbers" @@ -15454,118 +17641,182 @@ For example:  
      "see"  
    }
    -

    -

    Note that

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

    Note that \GlsSetXdyLocationClassOrder has no effect if \noist is used or if + id="dx1-66058"> 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-66061"> 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-66064"> is used or if \makeglossaries is omitted. is omitted. \GlsSetXdyMinRangeLength must be used before \makeglossaries.
    -

    -

    See §5 Number lists for further details. -

    -

    .

    +

    +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 package + id="dx1-67001"> package option. For example:

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

    If you have a number group, the default behaviour is to locate it before the “A” letter -group. If you are not using a Roman alphabet, you can change this using: -

    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 xindy to sort the number group numerically (rather than by a +string sort) then you need to use xindy’s numeric-sort module: + + +

    +
    +\GlsAddXdyStyle{numeric-sort} +
    +

    +

    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}

    -

    -

    Note that \GlsSetXdyFirstLetterAfterDigits has no effect if \noist is used or if +class="cmtt-10">} +

    +

    +where ⟨letter⟩ is the first letter of your alphabet. Take care if you’re using inputenc as +non-ASCII characters are actually active characters that expand. (This isn’t a problem with +the native UTF-8 engines and fontspec.) The starred form will sanitize the argument to +prevent expansion. Alternatively you can use: +


    \GlsSetXdyNumberGroupOrder  \GlsSetXdyNumberGroupOrder{relative location} +

    +

    +to change the default

    +
    \makeglossaries is omitted. \GlsSetXdyFirstLetterAfterDigits must be used before +class="cmtt-10">:before \string"letter\string" +
    +
    to ⟨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. +There’s a starred version that sanitizes the argument (so don’t use \string in it). +

    +
    \GlsSetXdyNumberGroupOrder*{:after "Ö"} +
    +
    +

    Note that these commands have no effect if \noist is used or if \makeglossaries is +omitted. \GlsSetXdyFirstLetterAfterDigits must be used before \makeglossaries. + id="dx1-67010">.
    -

    +

    -

    -

    +

    Top

    12. Defining New Glossaries

    -

    A new glossary can be defined using: -


    A new glossary can be defined using: +


    \newglossary  \newglossary[log-ext]{title}[counter]

    -

    +

    where ⟨name⟩ is the label to assign to this glossary. The arguments ⟨in-ext⟩ and ⟨counter⟩ specifies which counter to use for the associated number lists (see also s (see also §5 §5 Number lists). The first optional argument specifies the extension for the makeindex ( (Option 2) or xindy ( (Option 3) transcript file (this information is only used by makeglossaries which picks up the information from the + id="dx1-68005"> which picks up the information from the auxiliary file). If you use Option 1, the ⟨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 LATs for standard LATEX).
    -

    -

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


    +

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


    \newglossary*  \newglossary*{name}{title}[counter]

    -

    +

    which is equivalent to

    counter]
    or you can also use: -



    \altnewglossary  \altnewglossary{name}{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, + id="dx1-68009">. 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 added to the nohypertypes list, since there are no hypertargets for the entries in + id="dx1-68011"> 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  \ifignoredglossary{name}{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 + id="dx1-68013"> package option is used). Using the acronym package option is equivalent to: + id="dx1-68014"> package option is equivalent to:

    -
    +
    \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 + id="dx1-68015"> option has been used, you can identify the list of acronyms by the command \acronymtype \acronymtype which is set to acronym, if the acronym option has been used, + id="dx1-68017"> option has been used, otherwise it is set to main. Note that if you are using the main glossary as your list of 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 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 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 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 + id="dx1-68022"> to ensure that the relevant output files are opened. -

    See

    See §1.3.1 §1.4.1 Changing the Fixed Names if you want to redefine \glossaryname, especially if you are using babel or or translator. (Similarly for . (Similarly for \glssymbolsgroupname and \glsnumbersgroupname.) If you want to redefine \indexname, just follow the advice in , 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 + id="dx1-69001"> 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 title either by redefining \acronymname (see (see §1.3 §1.4 Multi-Lingual Support) or by using the title in the optional argument of in the optional argument of \printglossary (or (or \printacronym). + id="dx1-69005">). Alternatively consider using the glossaries-extra package’s package’s abbreviations option instead.
    -

    -

    You may have noticed in

    +

    You may have noticed in §4 §4 Defining Glossary Entries that when you specify a new entry, you can specify alternate text to use when the term is first used in the document. This provides a useful means to define abbreviations. For convenience, the glossaries package defines the command: -



    \newacronym  \newacronym[key-val list]{abbrv}{long}

    -

    -

    This uses

    +

    This uses \newglossaryentry to create an entry with the given label in the glossary given + id="dx1-69008"> to create an entry with the given label in the glossary given by \acronymtype. You can specify a different glossary using the . You can specify a different glossary using the type key within the optional + id="dx1-69010"> key within the optional argument. The \newacronym command also uses the long, , longplural, , short and and shortplural + id="dx1-69014"> keys in \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 + id="dx1-69015"> also apply to \newacronym (see §4 §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 or the command \DeclareAcronymList, see , see §2.5 +class="tcrm-1000">§2.5 Acronym Options) \newacronym will add it to the list and reset the display style for that glossary via \defglsentryfmt. If you have a mixture of acronyms and + id="dx1-69018">. If you have a mixture of acronyms and regular entries within the same glossary, care is needed if you want to change the display style: you must first identify that glossary as a list of acronyms and then use \defglsentryfmt (not redefine (not redefine \glsentryfmt) before defining your entries. + id="dx1-69020">) before defining your entries.
    -

    -

    The optional argument

    +

    The optional argument {key-val list} allows you to specify additional information. Any key that can be used in the second argument of \newglossaryentry can also be used + id="dx1-69021"> can also be used here in ⟨key-val list⟩. For example, description (when used with one of the styles that + id="dx1-69022"> (when used with one of the styles that require a description, described in §13.1 §13.1 Changing the Abbreviation Style) or you can override plural forms of ⟨abbrv⟩ or ⟨long⟩ using the shortplural or or longplural keys. For + id="dx1-69024"> keys. For 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 longplural or or shortplural keys, I recommend you use + id="dx1-69026"> keys, I recommend you use \setacronymstyle to set the display style rather than using one of the pre-version 4.02 + id="dx1-69027"> to set the display style rather than using one of the pre-version 4.02 acronym styles. -

    Since

    Since \newacronym uses uses \newglossaryentry, you can use commands like , you can use commands like \gls and + id="dx1-69030"> and \glsreset as with any other glossary entry. -

    Since as with any other glossary entry. +

    Since \newacronym sets type=\acronymtype, if you want to load a file containing acronym definitions using \loadglsentries[type]{type=\glsdefaulttype in the optional argument to \newacronym. See . See §4.6 §4.6 Loading Entries From a File.
    -

    +

    -

    Example 20 +

    Example 21 (Defining an Abbreviation) -

    The following defines the abbreviation IDN: + id="x1-69035"> +

    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 §13.1 +class="tcrm-1000">§13.1 Changing the Abbreviation Style, you need to use lower case characters for the shortened form:

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

    Now

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

    -

    -

    ____________________________

    -

    Avoid nested definitions.
    -

    -

    Recall from the warning in

    +

    ____________________________

    +

    Avoid nested definitions.
    +

    +

    Recall from the warning in §4 §4 Defining Glossary Entries that you should avoid using the \gls-like and \glstext-like commands within the value of keys like text and and first due to + id="dx1-69037"> due to complications arising from nested links. The same applies to abbreviations defined using \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 + id="dx1-69038">, it will cause inconsistencies on first use, and, if hyperlinks are enabled, will cause nested hyperlinks. It will also confuse the commands used by the entry formatting (such as \glslabel). -

    Instead, consider doing: + id="dx1-69039">). +

    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 + id="dx1-69040">. 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 first use flag. However, their display is governed by \defentryfmt with + id="dx1-69041"> with \glscustomtext set as appropriate. All caveats that apply to the set as appropriate. All caveats that apply to 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. @@ -16152,14 +18403,14 @@ As with the \glstext-like commands, the link text is placed in the argument of + id="dx1-69043"> is placed in the argument of \glstextformat. -


    . +


    \acrshort  \acrshort[options]{label}[insert]

    -

    +

    This sets the link text to the short form (within the argument of to the short form (within the argument of \acronymfont) for the entry + id="dx1-69047">) for the entry given by ⟨label⟩. The short form is as supplied by the short key, which key, which \newacronym implicitly + id="dx1-69049"> implicitly sets. -

    There are also analogous upper case variants: -


    There are also analogous upper case variants: +


    \Acrshort  \Acrshort[options]{label}[insert]

    -

    -


    +


    \ACRshort  \ACRshort[options]{label}[insert]

    -

    +

    There are also plural versions: -



    \acrshortpl  \acrshortpl[options]{label}[insert]

    -

    -


    +


    \Acrshortpl  \Acrshortpl[options]{label}[insert]

    -

    -


    +


    \ACRshortpl  \ACRshortpl[options]{label}[insert]

    -

    +

    The short plural form is as supplied by the shortplural key, which key, which \newacronym implicitly + id="dx1-69056"> implicitly sets. -



    \acrlong  \acrlong[options]{insert]

    -

    +

    This sets the link text to the long form for the entry given by ⟨ to the long form for the entry given by ⟨label⟩. The long form is as supplied by the long key, which key, which \newacronym implicitly sets. -

    There are also analogous upper case variants: -


    implicitly sets. +

    There are also analogous upper case variants: +


    \Acrlong  \Acrlong[options]{label}[insert]

    -

    -


    +


    \ACRlong  \ACRlong[options]{label}[insert]

    -

    +

    Again there are also plural versions: -



    \acrlongpl  \acrlongpl[options]{label}[insert]

    -

    -


    +


    \Acrlongpl  \Acrlongpl[options]{label}[insert]

    -

    -


    +


    \ACRlongpl  \ACRlongpl[options]{label}[insert]

    -

    +

    The long plural form is as supplied by the longplural key, which key, which \newacronym implicitly + id="dx1-69067"> 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. + id="dx1-69068"> 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  \acrfull[options]{label}[insert]

    -

    +

    This is a shortcut for -



    \acrfullfmt  \acrfullfmt{options}{label}{insert}

    -

    +

    which by default does

    }}
    where -



    \acrfullformat  \acrfullformat{long}{short}

    -

    +

    by default does ⟨long⟩ (⟨short⟩). This command is now deprecated for new acronym styles but is used by the default for backward compatibility if \setacronymstyle (§13.1 §13.1 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  \Acrfull[options]{insert]

    -

    -


    +


    \ACRfull  \ACRfull[options]{label}[insert]

    -

    +

    and plural versions: -



    \acrfullpl  \acrfullpl[options]{label}[insert]

    -

    -


    +


    \Acrfullpl  \Acrfullpl[options]{label}[insert]

    -

    -


    +


    \ACRfullpl  \ACRfullpl[options]{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 + id="dx1-69077"> package option to activate the shorter command names listed in table 13.1.

    -


    @@ -16500,7 +18751,7 @@ href="#tab:shortcuts">table 13.1.
    Table 13.1: Synonyms provided by the package option shortcuts
    +class="cmss-10">shortcuts
    Equivalent Command style="vertical-align:baseline;" id="TBL-7-2-"> + id="dx1-69080"> + id="dx1-69082"> + id="dx1-69084"> + id="dx1-69086"> + id="dx1-69088"> + id="dx1-69090"> + id="dx1-69092"> + id="dx1-69094"> + id="dx1-69096"> + id="dx1-69098"> + id="dx1-69100"> + id="dx1-69102"> + id="dx1-69104"> + id="dx1-69106"> + id="dx1-69108">
    \acs \acrshort
    \Acs \Acrshort
    \acsp \acrshortpl
    \Acsp \Acrshortpl
    \acl \acrlong
    \Acl \Acrlong
    \aclp \acrlongpl
    \Aclp \Acrlongpl
    \acf \acrfull
    \Acf \Acrfull
    \acfp \acrfullpl
    \Acfp \Acrfullpl
    \ac \gls
    \Ac \Gls
    \acp \glspl
    \Acp \Glspl
    + id="dx1-69110">

    -

    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 (described in §9 §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 + id="dx1-69112"> (non-expandable, can’t be used in PDF bookmarks, care needs to be taken if the first letter is an accented character etc). See §9 +class="tcrm-1000">§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  \glsentryfullpl{label}

    -

    -


    +


    \Glsentryfullpl  \Glsentryfullpl{label}

    -

    +

    These again use \acrfullformat by default, but the new styles described in the section + id="dx1-69125"> 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 styles 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. If @@ -16796,8 +19047,8 @@ class="cmtt-10">\setacronymstyle after using \DeclareAcronymList.
    -

    -

    The

    +

    The glossaries package has the restriction that only one style may be in use that applies to all entries defined with \newacronym. If you need multiple abbreviation @@ -16805,199 +19056,199 @@ 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 first or or text keys, but instead they use keys, but instead they use \defglsentryfmt to + id="dx1-70004"> to set a custom format that uses the long and and short keys (or their plural equivalents). This + id="dx1-70006"> keys (or their plural equivalents). This means that these styles cope better with plurals that aren’t formed by simply appending the singular form with the letter “s”. In fact, most of the predefined styles use \glsgenacfmt and + id="dx1-70007"> and modify the definitions of commands like \genacrfullformat. -

    Note that when you use . +

    Note that when you use \setacronymstyle the name key is set to -


    key is set to +


    \acronymentry  \acronymentry{label}

    -

    +

    and the sort key is set to -


    key is set to +


    \acronymsort  \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 is only set once by the package when it’s loaded. By default + id="dx1-71003"> is only set once by the package when it’s loaded. By default \firstacronymfont{text} is the same as \acronymfont{text}. If you want the short form displayed differently on first use, you can redefine \firstacronymfont independently of the + id="dx1-71006"> 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 + id="dx1-71007">) redefine \acronymfont to use \textsc, which means that the short form needs to be specified in lower + id="dx1-71008">, 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 + id="dx1-71009"> (see §10 §10 Displaying a glossary) to switch to medium weight if you are using a glossary style that displays entry names in bold and you have chosen an acronym style that uses \textsc. + id="dx1-71010">.
    -

    -

    The predefined styles that contain

    +

    The predefined styles that contain sm in their name (for example long-sm-short) redefine + id="dx1-71011">) redefine \acronymfont to use \textsmaller. -

    . +

    -

    Note that the

    Note that the glossaries package doesn’t define or load any package that defines \textsmaller. If you use one of the acronym styles that set . If you use one of the acronym styles that set \acronymfont to to \textsmaller you must explicitly load the relsize package or otherwise define 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 and \glsentryfull (and their + id="dx1-71017"> (and their plural and upper case variants) to reflect the style. The only exceptions to this are the dua + id="dx1-71018"> and footnote styles (and their variants).
    -

    -

    The following styles are supplied by the styles (and their variants).

    +

    +

    The following styles are supplied by the glossaries package:

    • long-short, , long-sc-short, , 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{shortlabel} is set to just the short form (enclosed in \acronymfont) and the description key + id="dx1-71026"> key is set to the long form. -

      The

      The long-sp-short style was introduced in version 4.16 and uses -


      style was introduced in version 4.16 and uses +


      \glsacspace  \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-long, , sc-short-long, , sm-short-long: -

      These three styles are analogous to the above three styles, except the display order is + id="dx1-71031">: +

      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 and \acronymentry are the same as for the ⟨ are the same as for the ⟨long⟩ (⟨short⟩) styles above, so the acronyms are still sorted according to the short @@ -17073,30 +19324,30 @@ class="cmti-10">short⟩) styles above, so the acronyms are still so

    • long-short-desc, , long-sc-short-desc, , long-sm-short-desc, , long-sp-short-desc: -

      These are like the : +

      These are like the long-short, , long-sc-short, , long-sm-short and and long-sp-short styles + id="dx1-71042"> styles described above, except that the description key must be supplied in the optional + id="dx1-71043"> key must be supplied in the optional argument of \newacronym. They also redefine . They also redefine \acronymentry to to {long} ({short}) and redefine \acronymsort{short}{long⟩. This means that the field has the long form followed by the short form in parentheses. I recommend you use a glossary style such as altlist with these acronym styles to allow for the long name + id="dx1-71047"> with these acronym styles to allow for the long name field.

    • short-long-desc, , sc-short-long-desc, , sm-short-long-desc: -

      These styles are analogous to the above three styles, but the first use display style + id="dx1-71050">: +

      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 long-short-desc etc. + id="dx1-71051"> etc.

    • dua, , dua-desc: + id="dx1-71053">: -

      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, \acrfull and and \glsentryfull will + id="dx1-71055"> will display ⟨long⟩ (\acronymfont{short}). In the case of dua, the , the name and and sort keys are set + id="dx1-71058"> keys are set to the short form and the description is set to the long form. In the case of dua-desc, the + id="dx1-71059">, the name and and sort keys are set to the long form and the description is supplied in the + id="dx1-71061"> keys are set to the long form and the description is supplied in the optional argument of \newacronym. + id="dx1-71062">.

    • footnote, , 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{long}

      -

      +

      However, \acrfull and and \glsentryfull are set to are set to \acronymfont{short} (⟨long⟩). On subsequent use the display is: -



      \acronymfont{short}

      -

      +

      The sort and and name keys are set to the short form, and the keys are set to the short form, and the description is set to the long + id="dx1-71071"> 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.
      -

      + id="dx1-71072"> for the acronym lists.

      +

    • footnote-desc, , footnote-sc-desc, , footnote-sm-desc: -

      These three styles are similar to the previous three styles, but the description + id="dx1-71075">: +

      These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The . The name key + id="dx1-71077"> key is set to the long form followed by the short form in parentheses and the sort key is set to the long form. This means that the acronyms will be sorted + id="dx1-71078"> key is set to the long form. This means that the acronyms will be sorted according to the long form. In addition, since the name will typically be quite + id="dx1-71079"> will typically be quite wide it’s best to choose a glossary style that can accommodate this, such as altlist. + id="dx1-71080">.

    -

    Example 21 +

    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 style, but I want the name key set to the short + id="dx1-71084"> key set to the short form followed by the long form in parentheses and the sort key set to the short form. Then I + id="dx1-71085"> key set to the short form. Then I need to specify the footnote-sc-desc style: + id="dx1-71086"> style:

    -
    +
    \setacronymstyle{footnote-sc-desc}
    -

    and then redefine

    and then redefine \acronymsort and and \acronymentry: + id="dx1-71088">:

    -
    +
    \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 + id="dx1-71089"> so that it always switches to medium weight to ensure the smallcaps 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  \newacronymstyle{style name}{}{definitions}

    -

    +

    where ⟨style name⟩ is the name of the new style (avoid active characters). The second argument, ⟨display⟩, is equivalent to the mandatory argument of \defglsentryfmt. You can + id="dx1-72002">. You can simply use \glsgenacfmt or you can customize the display using commands like + id="dx1-72003"> or you can customize the display using commands like \ifglsused, , \glsifplural and and \glscapscase. (See . (See §6.3 §6.3 Changing the format of the link text for further details.) If the style is likely to be used with a mixed glossary (that is entries in that glossary are defined both with \newacronym and + id="dx1-72007"> and \newglossaryentry) then you can test if the entry is an acronym and use ) then you can test if the entry is an acronym and use \glsgenacfmt if it + id="dx1-72009"> if it is or \glsgenentryfmt if it isn’t. For example, the if it isn’t. For example, the long-short style sets ⟨ style sets ⟨display⟩ as

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

    (You can use

    (You can use \ifglshasshort instead of instead of \ifglshaslong to test if the entry is an acronym if + id="dx1-72013"> 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 or, if ⟨ or, if ⟨display⟩ uses \glsgenacfmt, \genacrfullformat + id="dx1-72015"> and its variants. -

    Note that

    Note that \setacronymstyle redefines redefines \glsentryfull and and \acrfullfmt to use + id="dx1-72018"> to use \genacrfullformat (and similarly for the plural and upper case variants). If this isn’t + id="dx1-72019"> (and similarly for the plural and upper case variants). If this isn’t appropriate for the style (as in the case of styles like footnote and and dua) ) \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 + id="dx1-72023">. You can use the following token registers to access the entry label, long form and short form: \glslabeltok \glslabeltok, \glslongtok \glslongtok and \glsshorttok \glsshorttok. As with all TEX registers, you can access their values by preceding the register with \the. For example, the . For example, the long-short style + id="dx1-72028"> style does:

    -
    +
    \renewcommand*{\GenericAcronymFields}{%  
       description={\the\glslongtok}}%
    -

    which sets the

    which sets the description field to the long form of the acronym whereas the field to the long form of the acronym whereas the long-short-desc + id="dx1-72030"> style does:

    -
    +
    \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 long-sc-short + id="dx1-72033"> acronym style is based on the long-short style with minor modifications (remember to use style with minor modifications (remember to use ## instead of # within ⟨definitions⟩):

    -
    +
    \newacronymstyle{long-sc-short}%  
    {% use the same display as "long-short"  
      \GlsUseAcrEntryDispStyle{long-short}% @@ -17515,18 +19765,18 @@ class="cmti-10">definitions⟩):  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
    }
    -

    (

    (\glstextup \glstextup is used to cancel the effect of \textsc. This defaults to . This defaults to \textulc, + id="dx1-72037">, if defined, otherwise \textup. For example, the plural of . For example, the plural of svvms.) -

    Example 22 +

    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 acronyms. In my list of acronyms, I want the long form as the name with the short form in brackets followed by the description. That is, in the text I want \gls on on first use to display:
    \textsc{abbrv}\footnote} on subsequent use:
    \textsc{abbrv} @@ -17582,28 +19832,28 @@ 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: + id="dx1-72044"> using:

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

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use + id="dx1-72045"> if the entry isn’t an acronym, otherwise it will use \glsgenacfmt. The third argument (⟨. The third argument (⟨definitions⟩) of \newacronymstyle needs to redefine + id="dx1-72047"> needs to redefine \genacrfullformat etc so that the etc so that the first use displays the short form in the text with the long form in a footnote followed by the description. This is done as follows (remember to use ## @@ -17612,7 +19862,7 @@ class="cmtt-10">#):

    -
    +
     % No case change, singular first use:  
      \renewcommand*{\genacrfullformat}[2]{%  
       \firstacronymfont{\glsentryshort{##1}}##2% @@ -17634,12 +19884,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% @@ -17653,34 +19903,34 @@ you can change the above to:  
     \let\Genacrfullformat\genacrfullformat  
     \let\Genplacrfullformat\genplacrfullformat
    -

    Another variation is to use

    Another variation is to use \Glsentrylong and and \Glsentrylongpl in the footnote instead of + id="dx1-72050"> in the footnote instead of \glsentrylong and and \glsentrylongpl. -

    Now let’s suppose that commands such as . +

    Now let’s suppose that commands such as \glsentryfull and and \acrfull shouldn’t use + id="dx1-72054"> shouldn’t use a footnote, but instead use the format: ⟨long⟩ (⟨short⟩). This means that the style needs to redefine \glsentryfull, \acrfullfmt and their plural and upper case + id="dx1-72055"> 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}})% @@ -17698,11 +19948,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 @@ -17744,103 +19994,103 @@ 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 + id="dx1-72057"> 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” + id="dx1-72058"> 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 + id="dx1-72059"> to the long form followed by the upper case short form in parentheses:

    -
    +
     \renewcommand*{\acronymentry}[1]{%  
       \Glsentrylong{##1}\space  
         (\MakeTextUppercase{\glsentryshort{##1}})}%
    -

    (I’ve used

    (I’ve used \Glsentrylong instead of instead of \glsentrylong to capitalise the name in the + id="dx1-72061"> 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 + id="dx1-72062"> to just the long form and redefine \GenericAcronymFields to set the to set the symbol key to the short form and use a glossary style + id="dx1-72064"> key to the short form and use a glossary style that displays the symbol in parentheses after the name (such as the (such as the tree style) like + id="dx1-72066"> style) like this:

    -
    +
     \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: + id="dx1-72067"> 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}% @@ -17930,29 +20180,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: + id="dx1-72068">:

    -
    +
    \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} @@ -17960,45 +20210,45 @@ 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 23 +

    Example 24 (Italic and Upright Abbreviations) -

    Suppose I want to have some abbreviations in italic and some that just use the + id="x1-72070"> +

    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 + id="dx1-72071"> 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 + id="dx1-72072"> but instead provides a modified version that doesn’t use \acronymfont{short\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 but not commands like \acrshort which still use + id="dx1-72074"> which still use \acronymfont. Another approach is to redefine . Another approach is to redefine \acronymfont to look up the required font declaration. Since \acronymfont doesn’t take the entry label as an argument, the following @@ -18035,7 +20285,7 @@ will only work if \acronymfont is used in a context where the label is provided by \glslabel. This is true in . This is true in \gls, \acrshort and \acrfull. The redefinition is @@ -18043,14 +20293,14 @@ now:

    -
    +
    \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}% @@ -18077,23 +20327,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.)
    @@ -18144,11 +20394,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 use. See the initialisms example.) -

    Example 24 +

    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 + id="dx1-72079">) that’s called at the very end of the \gls-like and \glstext-like commands. This can be redefined to check if the following character is a full stop. The amsgen package (which is automatically loaded by + id="dx1-72080"> package (which is automatically loaded by glossaries) provides an internal command called \new@ifnextchar that can be used to determine if the given character appears next. (For more information see the amsgen + id="dx1-72081"> 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: +href="#x1-39002r4">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, + id="dx1-72082"> 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 + id="dx1-72083"> and \ifglsfieldeq can be used to determine if the current entry has the new can be used to determine if the current entry has the new 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 and \makeatother: + id="dx1-72086">:

    -
    +
    \makeatletter  
    \renewcommand{\glspostlinkhook}{%  
     \ifglsfieldeq{\glslabel}{abbrtype}{initials}% @@ -18254,7 +20504,7 @@ class="cmtt-10">\makeatother}  
    \makeatother
    -

    In the event that a full stop is found

    In the event that a full stop is found \doendsentence is performed but it will be followed by the full stop, which needs to be discarded. Otherwise \doendword will be done but it won’t be @@ -18263,11 +20513,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 @@ -18275,7 +20525,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 ⟨short⟩ (⟨long⟩) styles as in this case the terminating full stop shouldn’t be discarded. Since \glspostlinkhook is used after the is used after the first use flag has been unset for the entry, this can’t be fixed by simply checking with \ifglsused. One possible solution to this is + id="dx1-72088">. One possible solution to this is to redefine \glslinkpostsetkeys to check for the to check for 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 + id="dx1-72090">. +

    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 + id="dx1-72091">) 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:

    \printnoidxglossary[type=\acronymtype]
    @@ -18351,19 +20601,19 @@ class="description">
    \printglossary[type=\acronymtype]
    -

    (If you use the

    (If you use the acronym package option you can also use

    + id="dx1-73005"> package option you can also use

    \printacronyms[options] @@ -18372,19 +20622,19 @@ class="cmtt-10">]
    \printglossary[type=\acronymtype,options]
    See §2.5 §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:

     1:
    \printnoidxglossaries + id="dx1-73009">
    Options3:
    \printglossaries
    -

    However, care must be taken to choose a glossary style that’s appropriate to your acronym + id="dx1-73010"> +

    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 §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 + id="dx1-74001"> package may recall that the syntax used to define new acronyms has changed with the replacement glossaries package. In addition, the old glossary package created the command package created the command \acr-name⟩ when defining the acronym ⟨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 + id="x1-74003f1"> provides the command: -



    \oldacronym  \oldacronym[label]{long}{key-val list}

    -

    +

    This uses the same syntax as the glossary package’s method of defining acronyms. It is + id="dx1-74005"> package’s method of defining acronyms. It is equivalent to:
    \newacronym[key-val list]{}
    In addition, \oldacronym also defines the commands also defines the commands \label⟩, which is equivalent to \gls + id="dx1-74008"> {label\label*, which is equivalent to \Gls{label}. If ⟨\label⟩ doesn’t allow you to use the first optional argument of \gls or or \Gls — you will need to explicitly use — you will need to explicitly use \gls or or \Gls to change the + id="dx1-74013"> 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 \label⟩ unless you additionally load the xspace + id="dx1-74014"> package, but be aware that there are some issues with using xspace..13.2
    -

    +

    -

    The +

    The glossaries package doesn’t load the xspace package since there are both advantages + id="dx1-74017"> package since there are both advantages and disadvantages to using \xspace in in \label⟩. If you don’t use the xspace package + id="dx1-74019"> package you need to explicitly force a space using \␣ (backslash space) however you can follow \label⟩ with additional text in square brackets (the final optional argument to \gls). If you use the ). If you use the xspace package you don’t need to escape the spaces but + id="dx1-74021"> package you don’t need to escape the spaces but you can’t use the optional argument to insert text (you will have to explicitly use \gls). -

    To illustrate this, suppose I define the acronym “abc” as follows: + id="dx1-74022">). +

    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 effect of \abc (on subsequent use) according to whether or not the xspace package has been + id="dx1-74023"> package has been loaded. As can be seen from the final row in the table, the xspace package prevents the + id="dx1-74024"> package prevents the optional argument from being recognised.

    -


    @@ -18577,7 +20827,7 @@ optional argument from being recognised. >Table 13.2: The effect of using xspace with \oldacronym
    +class="cmtt-10">\oldacronym
    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 first key, even though you have already key, even though you have already used the glossary entry. Conversely, you may want to use the value given by the text key, even though you + id="dx1-75002"> 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 @@ -18723,16 +20973,16 @@ 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  \ifglsused{label}{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 environment in beamer processes its argument for each overlay. + id="dx1-75014"> processes its argument for each overlay. This means that the first 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} @@ -18779,22 +21029,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 + id="dx1-75015"> when you want the full version to be displayed:

    -
    +
    \documentclass{beamer}  
    \usepackage{glossaries}  
    \newacronym{svm}{SVM}{support vector machine} @@ -18809,12 +21059,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} @@ -18823,39 +21073,39 @@ 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 + id="dx1-75016"> class is too complex for me to provide a programmatic solution. Other potentially problematic environments are some tabular-like environments (but not -like environments (but not tabular itself) that process the contents in order + id="dx1-75019"> 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 environments, such as align, also process their contents multiple times, but + id="dx1-75022">, also process their contents multiple times, but the glossaries package now checks for this. For tabularx, you need to explicitly patch it by + id="dx1-75024">, you need to explicitly patch it by placing \glspatchtabularx in the preamble (or anywhere before the problematic use of 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 (and therefore \newacronym) into a preamble-only + id="dx1-76002">) 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. This value is read from the .aux file at the beginning of the document environment. + id="dx1-76004"> 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 @@ -18950,7 +21200,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  \cgls[options]{label}[insert]

    -

    +

    (no case-change, singular) -



    \cglspl  \cglspl[options]{label}[insert]

    -

    +

    (no case-change, plural) -



    \cGls  \cGls[options]{label}[insert]

    -

    +

    (first letter uppercase, singular), and -



    \cGlspl  \cGlspl[options]{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  \cglsformat{label}{insert}

    -

    +

    This command is used by \cgls and defaults to

    @@ -19100,16 +21350,16 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cglsplformat  \cglsplformat{label}{insert}

    -

    +

    This command is used by \cglspl and defaults to

    @@ -19129,16 +21379,16 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cGlsformat  \cGlsformat{label}{insert}

    -

    +

    This command is used by \cGls and defaults to

    @@ -19160,16 +21410,16 @@ class="cmtt-10">}⟨insert
    otherwise. -



    \cGlsplformat  \cGlsplformat{label}{insert}

    -

    +

    This command is used by \cGlspl and defaults to

    @@ -19189,7 +21439,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 @@ -19198,7 +21448,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): @@ -19208,18 +21458,18 @@ class="cmtt-10">(pdf)latex, makeglossaries, (pdf)latex. -

    Example 25 +

    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) + id="x1-76017"> +

    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} @@ -19240,7 +21490,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 glossaries package comes with a number of pre-defined glossary styles, described in §15.1 §15.1 Predefined Styles. You can choose one of these that best suits your type of glossary or, if none of them suit your document, you can defined your own style (see §15.2 +class="tcrm-1000">§15.2 Defining your own glossary style). There are some examples of glossary styles available at http://www.dickimaw-books.com/gallery/#glossaries. -

    The glossary style can be set using the

    The glossary style can be set using the style key in the optional argument to + id="dx1-77001"> key in the optional argument to \printnoidxglossary ( (Option 1) or \printglossary (Options  (Options 2 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 + id="dx1-77005"> 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.2 §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, , counterwithin and and subentrycounter described in described in §2.3 §2.3 Glossary Appearance Options. There is a summary of available styles in table 15.1. You can view samples of all the predefined styles at http://www.dickimaw-books.com/gallery/glossaries-styles/. -

    Note that the group styles (such as

    Note that the group styles (such as listgroup) will have unexpected results if used with + id="dx1-78004">) will have unexpected results if used with the sort=def or or sort=use options. If you don’t sort your entries alphabetically, it’s + id="dx1-78006"> options. If you don’t sort your entries alphabetically, it’s best to set the nogroupskip package option to prevent odd vertical gaps appearing. + id="dx1-78007"> 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 §15.2 +class="tcrm-1000">§15.2 Defining your own glossary style.

    -


    @@ -19377,22 +21627,22 @@ matches that doesn’t match any previously listed style (e.g. class="cmtt-10">long3col* matches long3col, , long3colheader, , long3colborder and and long3colheaderborder). A maximum level of + id="dx1-78012">). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). Where the maximum level is given as — there is no limit, but note that makeindex + id="dx1-78013"> (Option 2) imposes a limit of 2 sub-levels. If the homograph column is checked, then the name is not displayed for sub-entries. If the symbol column is checked, then the -symbol will be displayed.
    +symbol will be displayed.

    -

    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 \glsdescwidth to set the width of the description column and the length \glspagelistwidth \glspagelistwidth to set the width of the page list column.15.1 + id="x1-78016f1"> These will need to be changed using \setlength if the glossary is too wide. Note that the long4col and and super4col styles (and their header and border variations) don’t use these lengths + id="dx1-78021"> styles (and their header and border variations) don’t use these lengths as they are designed for single line entries. Instead you should use the analogous altlong4col and and altsuper4col styles. If you want to explicitly create a line-break within a + id="dx1-78023"> styles. If you want to explicitly create a line-break within a multi-line description in a tabular-like style it’s better to use \newline instead of + id="dx1-78024"> 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 + id="dx1-78025">, allows multilined descriptions, you’ll probably encounter page-breaking problems if you have entries with long descriptions. You may want to consider using the alttree style instead.
    -

    -

    Note that if you use the style instead.

    +

    +

    Note that if you use the style key in the optional argument to key in the optional argument to \printnoidxglossary + id="dx1-78028"> (Option 1) or \printglossary (Options  (Options 2 and 3), it will override any previous style settings for the given glossary, so if, for example, you do

    -
    +
    \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 + id="dx1-78030"> will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also override + id="dx1-78031"> will also override any previous style definitions, so, again

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

    will reset

    will reset \glsgroupskip back to its default definition for the named glossary style (long in this case). If you want to modify the styles, either use in this case). If you want to modify the styles, either use \newglossarystyle + id="dx1-78033"> (described in the next section) or make the modifications after \setglossarystyle, + id="dx1-78034">, e.g.:

    -
    +
    \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 + id="dx1-78035"> 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 + id="dx1-78036"> 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 \glspostdescription before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \nopostdesc in the entry’s description. -

    As from version 3.03 you can now use the package option in the entry’s description. +

    As from version 3.03 you can now use the package option nopostdot to suppress this full + id="dx1-78039"> to suppress this full stop. This is the better option if you want to use the glossaries-extra package. + id="dx1-78040"> package. The +glossaries-extra-stylemods package provides some adjustments some of to the predefined styles +listed here, allowing for greater flexibility. See 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 + id="dx1-79001">. Since they all use the description environment, they are governed by the same parameters + id="dx1-79002"> environment, they are governed by the same parameters as that environment. These styles all ignore the entry’s symbol. Note that these styles will automatically be available unless you use the nolist or or nostyles package + id="dx1-79005"> package options. -

    Note that, except for the

    Note that, except for the listdotted style, these list styles are incompatible with + id="dx1-79006"> style, these list styles are incompatible with classicthesis.
    -

    + id="dx1-79007">. They may also be incompatible with other classes or packages that modify the +description environment.

    +

    list
    The list style uses the style uses the description environment. The entry name is placed in the + id="dx1-79011"> environment. The entry name is placed in the optional argument of the \item command (so it will usually appear in bold by + id="dx1-79013"> command (so it will usually appear in bold by default). The description follows, and then the associated number list for that + id="dx1-79014"> for that entry. The symbol is ignored. If the entry has child entries, the description and number list follows (but not the name) for each child entry. Groups are separated using \indexspace. -

    The closest matching non-list style is the . +

    The closest matching non-list style is the index style. + id="dx1-79016"> style. + +

    listgroup
    The listgroup style is like style is like list but the glossary groups have headings obtained + id="dx1-79018"> but the glossary groups have headings obtained using \glsgetgrouptitle{label}, which is described in §15.2 §15.2 Defining your own glossary style. - -
    listhypergroup
    The listhypergroup style is like style is like listgroup but has a navigation line + id="dx1-79020"> but has a navigation line at the start of the glossary with links to each group that is present in the glossary. This requires an additional run through LATEX 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 + id="dx1-79022"> 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. + id="dx1-79024"> instead.

    altlist
    The altlist style is like style is like list but the description starts on the line following the name. + id="dx1-79026"> but the description starts on the line following the name. (As with the list style, the symbol is ignored.) Each child entry starts a new + id="dx1-79027"> style, the symbol is ignored.) Each child entry starts a new line, but as with the list style, the name associated with each child entry is + id="dx1-79028"> 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: + id="dx1-79029"> style with the following adjustment:

    -
    +
    \renewcommand{\glstreepredesc}{%  
     \glstreeitem\parindent\hangindent}
    -

    +

    altlistgroup
    The altlistgroup style is like style is like altlist but the glossary groups have headings. + id="dx1-79031"> but the glossary groups have headings.
    altlisthypergroup
    The altlisthypergroup style is like style is like altlistgroup but has a set of links to the + id="dx1-79033"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-79034">, described above.
    listdotted
    This style uses the description + id="dx1-79035"> environment.15.2 + id="x1-79037f2"> Each entry starts with \item[], followed by the name followed by a dotted line, followed by the description. Note that this style ignores both the number list and the + id="dx1-79038"> 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 + id="dx1-79040"> 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 list, but that can be achieved with the , but that can be achieved with the nonumberlist + id="dx1-79042"> option.)

    sublistdotted
    This is a variation on the listdotted style designed for hierarchical glossaries. + id="dx1-79043"> style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as listdotted. Unlike the . Unlike the listdotted style, this style is incompatible with + id="dx1-79045"> style, this style is incompatible with classicthesis.
    -

    + id="dx1-79046">. +

    -

    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 + id="dx1-80001">. Since they all use the longtable environment, they are governed by the same parameters as that + id="dx1-80002"> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nolong or or nostyles package options. These styles fully justify the description and page + id="dx1-80005"> package options. These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §15.1.3 §15.1.3 Longtable Styles (Ragged Right). If you want to incorporate rules from the booktabs package, try the styles described in package, try the styles described in §15.1.4 §15.1.4 Longtable Styles (booktabs). @@ -19935,30 +22196,30 @@ class="cmss-10">booktabs). class="cmbx-10">long

    The long style uses the style uses the longtable environment (defined by the environment (defined by the longtable package). + id="dx1-80010"> package). It has two columns: the first column contains the entry’s name and the second column contains the description followed by the number list. The entry’s symbol is + id="dx1-80011">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a similar format to + id="dx1-80012">. Child entries have a similar format to the parent entries except that their name is suppressed.
    longborder
    The longborder style is like style is like long but has horizontal and vertical lines around + id="dx1-80014"> but has horizontal and vertical lines around it. @@ -19967,117 +22228,117 @@ class="cmss-10">longlongheader
    The longheader style is like style is like long but has a header row. + id="dx1-80016"> but has a header row.
    longheaderborder
    The longheaderborder style is like style is like longheader but has horizontal + id="dx1-80018"> but has horizontal and vertical lines around it.
    long3col
    The long3col style is like style is like long but has three columns. The first column contains + id="dx1-80020"> but has three columns. The first column contains the entry’s name, the second column contains the description and the third column contains the number list. The entry’s symbol is ignored. The width of the first + id="dx1-80021">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length \glsdescwidth, and the width of the third + id="dx1-80022">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-80023">.
    long3colborder
    The long3colborder style is like the style is like the long3col style but has horizontal + id="dx1-80025"> style but has horizontal and vertical lines around it.
    long3colheader
    The long3colheader style is like style is like long3col but has a header row. + id="dx1-80027"> but has a header row.
    long3colheaderborder
    The long3colheaderborder style is like style is like long3colheader but has + id="dx1-80029"> but has horizontal and vertical lines around it.
    long4col
    The long4col style is like style is like long3col but has an additional column in which + id="dx1-80031"> but has an additional column in which the entry’s associated symbol appears. This style is used for brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altlong4col for multi-line descriptions. + id="dx1-80032"> for multi-line descriptions.
    long4colborder
    The long4colborder style is like the style is like the long4col style but has horizontal + id="dx1-80034"> style but has horizontal and vertical lines around it.
    long4colheader
    The long4colheader style is like style is like long4col but has a header row. + id="dx1-80036"> but has a header row.
    long4colheaderborder
    The long4colheaderborder style is like style is like long4colheader but has + id="dx1-80038"> but has horizontal and vertical lines around it.
    altlong4col
    The altlong4col style is like style is like long4col but allows multi-line descriptions + id="dx1-80040"> but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page list column is governed by the length + id="dx1-80041"> and the width of the page list column is governed by the length \glspagelistwidth. The widths of the name and symbol columns are governed + id="dx1-80042">. The widths of the name and symbol columns are governed by the widest entry in the given column. @@ -20086,69 +22347,69 @@ class="cmtt-10">\glspagelistwidthaltlong4colborder
    The altlong4colborder style is like the style is like the long4colborder but allows + id="dx1-80044"> but allows multi-line descriptions and page lists.
    altlong4colheader
    The altlong4colheader style is like style is like long4colheader but allows + id="dx1-80046"> but allows multi-line descriptions and page lists.
    altlong4colheaderborder
    The altlong4colheaderborder style is like + id="dx1-80047"> style is like long4colheaderborder but allows multi-line descriptions and page lists.
    -

    + id="dx1-80048"> 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 + id="dx1-81001">. These styles are analogous to those defined in glossary-long but the multiline columns are left + id="dx1-81002"> but the multiline columns are left justified instead of fully justified. Since these styles all use the longtable environment, they are + id="dx1-81003"> environment, they are governed by the same parameters as that environment. The glossary-longragged package + id="dx1-81005"> package additionally requires the array package. Note that these styles will only be available if you + id="dx1-81006"> package. Note that these styles will only be available if you explicitly load glossary-longragged: + id="dx1-81007">:

    -
    +
    \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 + id="dx1-81008"> package option since the styles aren’t defined until after the glossaries package has been loaded. If you want to incorporate rules from the booktabs package, try the styles described in package, try the styles described in §15.1.4 §15.1.4 Longtable Styles (booktabs). @@ -20157,15 +22418,15 @@ class="cmss-10">booktabs). class="cmbx-10">longragged

    The longragged style has two columns: the first column contains the entry’s + id="dx1-81010"> style has two columns: the first column contains the entry’s name and the second column contains the (left-justified) description followed by the number list. The entry’s symbol is ignored. Sub groups are separated with a + id="dx1-81011">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. + id="dx1-81012">. Child entries have a similar format to the parent entries except that their name is suppressed.
    @@ -20173,64 +22434,64 @@ class="cmtt-10">\glsdescwidthlongraggedborder
    The longraggedborder style is like style is like longragged but has horizontal + id="dx1-81014"> but has horizontal and vertical lines around it.
    longraggedheader
    The longraggedheader style is like style is like longragged but has a header row. + id="dx1-81016"> but has a header row.
    longraggedheaderborder
    The longraggedheaderborder style is like style is like longraggedheader + id="dx1-81018"> but has horizontal and vertical lines around it.
    longragged3col
    The longragged3col style is like style is like longragged but has three columns. + id="dx1-81020"> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the (left justified) number list. The entry’s symbol is ignored. The width of the first column is governed by + id="dx1-81021">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column, the width of the second column is governed by the length \glsdescwidth, and the width of the third column is governed by the + id="dx1-81022">, and the width of the third column is governed by the length \glspagelistwidth. + id="dx1-81023">.
    longragged3colborder
    The longragged3colborder style is like the style is like the longragged3col style + id="dx1-81025"> style but has horizontal and vertical lines around it.
    longragged3colheader
    The longragged3colheader style is like style is like longragged3col but has + id="dx1-81027"> but has a header row. @@ -20239,25 +22500,25 @@ class="cmss-10">longragged3collongragged3colheaderborder
    The longragged3colheaderborder style is like + id="dx1-81028"> style is like longragged3colheader but has horizontal and vertical lines around it. + id="dx1-81029"> but has horizontal and vertical lines around it.
    altlongragged4col
    The altlongragged4col style is like style is like longragged3col but has an + id="dx1-81031"> but has an additional column in which the entry’s associated symbol appears. The width of the description column is governed by the length \glsdescwidth and the width of + id="dx1-81032"> and the width of the page list column is governed by the length \glspagelistwidth. The widths + id="dx1-81033">. The widths of the name and symbol columns are governed by the widest entry in the given column.
    @@ -20265,121 +22526,121 @@ class="cmtt-10">\glspagelistwidthaltlongragged4colborder
    The altlongragged4colborder style is like the + id="dx1-81034"> style is like the altlongragged4col but has horizontal and vertical lines around it. + id="dx1-81035"> but has horizontal and vertical lines around it.
    altlongragged4colheader
    The altlongragged4colheader style is like style is like altlongragged4col + id="dx1-81037"> but has a header row.
    altlongragged4colheaderborder
    The altlongragged4colheaderborder style is like + id="dx1-81038"> style is like altlongragged4colheader but has horizontal and vertical lines around it. + id="dx1-81039"> 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 + id="dx1-82002"> environment, they are governed by the same parameters as that environment. The glossary-longbooktabs package automatically loads the + id="dx1-82004"> package automatically loads the glossary-long ( (§15.1.2 §15.1.2 Longtable Styles) and glossary-longragged ( (§15.1.3 §15.1.3 Longtable Styles (Ragged Right)) packages. Note that these styles will only be available if you explicitly load glossary-longbooktabs: + id="dx1-82007">:

    -
    +
    \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 + id="dx1-82008"> 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 and glossary-ragged + id="dx1-82010"> packages, but they add the rules provided by the booktabs package, package, \toprule, , \midrule and + id="dx1-82013"> and \bottomrule. Additionally these styles patch the . Additionally these styles patch the longtable environment to check for instances + id="dx1-82015"> environment to check for instances of the group skip occurring at a page break. If you don’t want this patch to affect any other use of longtable in your document, you can scope the effect by only setting the style through + id="dx1-82017"> in your document, you can scope the effect by only setting the style through the style key in the optional argument of key in the optional argument of \printglossary. (The nogroupskip package option + id="dx1-82020"> package option is checked by these styles.) -

    Alternatively, you can restore the original

    Alternatively, you can restore the original longtable behaviour with: -


    behaviour with: +


    \glsrestoreLToutput  \glsrestoreLToutput

    -

    +

    For more information about the patch, see the documented code (glossaries-code.pdf).

    long-booktabs
    This style is similar to the longheader style but adds rules above and + id="dx1-82025"> style but adds rules above and below the header (\toprule and \midrule) and inserts a rule at the bottom of @@ -20388,88 +22649,88 @@ class="cmtt-10">\bottomrule).
    long3col-booktabs
    This style is similar to the long3colheader style but adds rules as + id="dx1-82027"> style but adds rules as per long-booktabs. + id="dx1-82028">.
    long4col-booktabs
    This style is similar to the long4colheader style but adds rules as + id="dx1-82030"> style but adds rules as above.
    altlong4col-booktabs
    This style is similar to the altlong4colheader style but adds rules + id="dx1-82032"> style but adds rules as above.
    longragged-booktabs
    This style is similar to the longraggedheader style but adds rules + id="dx1-82034"> style but adds rules as above.
    longragged3col-booktabs
    This style is similar to the longragged3colheader style but + id="dx1-82036"> style but adds rules as above.
    altlongragged4col-booktabs
    This style is similar to the altlongragged4colheader style + id="dx1-82038"> 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. + id="dx1-83001">. Since they all use the supertabular environment, they are governed by the same + id="dx1-83002"> environment, they are governed by the same parameters as that environment. Note that these styles will automatically be available unless you use the nosuper or or nostyles package options. In general, the package options. In general, the longtable + id="dx1-83006"> environment is better, but there are some circumstances where it is better to use supertabular..15.3 + id="x1-83010f3"> These styles fully justify the description and page list columns. If you want ragged right formatting instead, use the analogous styles described in §15.1.6 §15.1.6 Supertabular Styles (Ragged Right).

    @@ -20477,67 +22738,67 @@ Right). class="cmbx-10">super
    The super style uses the style uses the supertabular environment (defined by the environment (defined by the supertabular + id="dx1-83015"> package). It has two columns: the first column contains the entry’s name and the second column contains the description followed by the number list. The entry’s + id="dx1-83016">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. Child entries have a + id="dx1-83017">. Child entries have a similar format to the parent entries except that their name is suppressed.
    superborder
    The superborder style is like style is like super but has horizontal and vertical lines + id="dx1-83019"> but has horizontal and vertical lines around it.
    superheader
    The superheader style is like style is like super but has a header row. + id="dx1-83021"> but has a header row.
    superheaderborder
    The superheaderborder style is like style is like superheader but has horizontal + id="dx1-83023"> but has horizontal and vertical lines around it.
    super3col
    The super3col style is like style is like super but has three columns. The first column + id="dx1-83025"> but has three columns. The first column contains the entry’s name, the second column contains the description and the third column contains the number list. The entry’s symbol is ignored. The width + id="dx1-83026">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of the + id="dx1-83027">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-83028">.
    @@ -20545,145 +22806,145 @@ class="cmtt-10">\glspagelistwidthsuper3colborder
    The super3colborder style is like the style is like the super3col style but has + id="dx1-83030"> style but has horizontal and vertical lines around it.
    super3colheader
    The super3colheader style is like style is like super3col but has a header row. + id="dx1-83032"> but has a header row.
    super3colheaderborder
    The super3colheaderborder style is like the style is like the super3colheader + id="dx1-83034"> style but has horizontal and vertical lines around it.
    super4col
    The super4col style is like style is like super3col but has an additional column in which + id="dx1-83036"> but has an additional column in which the entry’s associated symbol appears. This style is designed for entries with brief single line descriptions. The column widths are governed by the widest entry in the given column. Use altsuper4col for multi-line descriptions. + id="dx1-83037"> for multi-line descriptions.
    super4colborder
    The super4colborder style is like the style is like the super4col style but has + id="dx1-83039"> style but has horizontal and vertical lines around it.
    super4colheader
    The super4colheader style is like style is like super4col but has a header row. + id="dx1-83041"> but has a header row.
    super4colheaderborder
    The super4colheaderborder style is like the style is like the super4colheader + id="dx1-83043"> style but has horizontal and vertical lines around it.
    altsuper4col
    The altsuper4col style is like style is like super4col but allows multi-line descriptions + id="dx1-83045"> but allows multi-line descriptions and page lists. The width of the description column is governed by the length \glsdescwidth and the width of the page list column is governed by the length + id="dx1-83046"> and the width of the page list column is governed by the length \glspagelistwidth. The width of the name and symbol columns is governed by + id="dx1-83047">. The width of the name and symbol columns is governed by the widest entry in the given column.
    altsuper4colborder
    The altsuper4colborder style is like the style is like the super4colborder style but + id="dx1-83049"> style but allows multi-line descriptions and page lists.
    altsuper4colheader
    The altsuper4colheader style is like style is like super4colheader but allows + id="dx1-83051"> but allows multi-line descriptions and page lists.
    altsuper4colheaderborder
    The altsuper4colheaderborder style is like + id="dx1-83052"> style is like super4colheaderborder but allows multi-line descriptions and page lists.
    + id="dx1-83053"> 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 + id="dx1-84001">. These styles are analogous to those defined in glossary-super but the multiline columns are left + id="dx1-84002"> but the multiline columns are left justified instead of fully justified. Since these styles all use the supertabular environment, they + id="dx1-84003"> environment, they are governed by the same parameters as that environment. The glossary-superragged package + id="dx1-84005"> package additionally requires the array package. Note that these styles will only be available if you + id="dx1-84006"> package. Note that these styles will only be available if you explicitly load glossary-superragged: + id="dx1-84007">:

    -
    +
    \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 + id="dx1-84008"> package option since the styles aren’t defined until after the glossaries package has been loaded.

    @@ -20691,21 +22952,21 @@ class="cmss-10">glossaries package has been loaded. class="cmbx-10">superragged
    The superragged style uses the style uses the supertabular environment (defined by the + id="dx1-84010"> environment (defined by the supertabular package). It has two columns: the first column contains the entry’s + id="dx1-84012"> package). It has two columns: the first column contains the entry’s name and the second column contains the (left justified) description followed by the number list. The entry’s symbol is ignored. Sub groups are separated with a + id="dx1-84013">. The entry’s symbol is ignored. Sub groups are separated with a blank row. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. + id="dx1-84014">. Child entries have a similar format to the parent entries except that their name is suppressed.
    @@ -20713,65 +22974,65 @@ class="cmtt-10">\glsdescwidthsuperraggedborder
    The superraggedborder style is like style is like superragged but has horizontal + id="dx1-84016"> but has horizontal and vertical lines around it.
    superraggedheader
    The superraggedheader style is like style is like superragged but has a header + id="dx1-84018"> but has a header row.
    superraggedheaderborder
    The superraggedheaderborder style is like + id="dx1-84019"> style is like superraggedheader but has horizontal and vertical lines around it. + id="dx1-84020"> but has horizontal and vertical lines around it.
    superragged3col
    The superragged3col style is like style is like superragged but has three columns. + id="dx1-84022"> but has three columns. The first column contains the entry’s name, the second column contains the (left justified) description and the third column contains the (left justified) number list. + id="dx1-84023">. The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that column. The width of the second column is governed by the length \glsdescwidth. The width of the third column is governed by the length + id="dx1-84024">. The width of the third column is governed by the length \glspagelistwidth. + id="dx1-84025">.
    superragged3colborder
    The superragged3colborder style is like the style is like the superragged3col + id="dx1-84027"> style but has horizontal and vertical lines around it.
    superragged3colheader
    The superragged3colheader style is like style is like superragged3col but + id="dx1-84029"> but has a header row. @@ -20781,18 +23042,18 @@ class="cmbx-10">superragged3colheaderborder
    The superragged3colheaderborder style is like style is like superragged3colheader but has horizontal + id="dx1-84031"> but has horizontal and vertical lines around it.
    altsuperragged4col
    The altsuperragged4col style is like style is like superragged3col but has an + id="dx1-84033"> but has an additional column in which the entry’s associated symbol appears. The column widths for the name and symbol column are governed by the widest entry in the given column. @@ -20801,93 +23062,93 @@ class="cmss-10">superragged3colaltsuperragged4colborder
    The altsuperragged4colborder style is like the + id="dx1-84034"> style is like the altsuperragged4col style but has horizontal and vertical lines around it. + id="dx1-84035"> style but has horizontal and vertical lines around it.
    altsuperragged4colheader
    The altsuperragged4colheader style is like + id="dx1-84036"> style is like altsuperragged4col but has a header row. + id="dx1-84037"> but has a header row.
    altsuperragged4colheaderborder
    The altsuperragged4colheaderborder style is like + id="dx1-84038"> style is like altsuperragged4colheader but has horizontal and vertical lines around it. + id="dx1-84039"> 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 + id="dx1-85001">. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have sub-entries. These styles will display the entry’s symbol if it exists. Note that these styles will automatically be available unless you use the notree or or nostyles package + id="dx1-85003"> 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}, but note that ⟨name⟩ includes \glsnamefont so the + id="dx1-85005"> so the bold setting in \glstreenamefont may be counteracted by another font change in \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}. The tree-like styles that display navigation links to the groups (such as indexhypergroup), format the navigation line + id="dx1-85007">), format the navigation line using -



    \glstreenavigationfmt  \glstreenavigationfmt{text}

    -

    +

    which defaults to \glstreenamefmt{text}. Note that this is different from \glslistnavigationitem, provided with the styles such as listhypergroup, as that also + id="dx1-85009">, 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 + id="dx1-85010"> 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 and alttree styles (and those derived from them), + id="dx1-85013"> 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 + id="dx1-85015"> style isn’t too bad for multi-paragraph top-level entry descriptions, or you can use the index style + id="dx1-85016"> style with the adjustment shown below.)
    -

    +

    index
    The index style is similar to the way indices are usually formatted in that it has + id="dx1-85017"> style is similar to the way indices are usually formatted in that it has a hierarchical structure up to three levels (the main level plus two sub-levels). The name is typeset in bold, and if the symbol is present it is set in parentheses after the name and before the description. Sub-entries are indented and also include the name, the symbol in brackets (if present) and the description. Groups are separated using \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 + id="dx1-85022"> 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 + id="dx1-85023"> 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
    The indexgroup style is similar to the style is similar to the index style except that each group has a + id="dx1-85025"> style except that each group has a heading obtained using \glsgetgrouptitle{label}, which is described in §15.2 §15.2 Defining your own glossary style.
    @@ -21012,12 +23273,12 @@ href="#sec:newglossarystyle">Defining class="cmbx-10">indexhypergroup
    The indexhypergroup style is like style is like indexgroup but has a set of links to the + id="dx1-85027"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-85028">, described above, but is formatted using \glstreenavigationfmt.
    @@ -21025,46 +23286,46 @@ class="cmtt-10">\glstreenavigationfmt. class="cmbx-10">tree
    The tree style is similar to the style is similar to the index style except that it can have arbitrary levels. (Note + id="dx1-85030"> style except that it can have arbitrary levels. (Note that makeindex is limited to three levels, so you will need to use is limited to three levels, so you will need to use xindy if you want + id="dx1-85032"> if you want more than three levels.) Each sub-level is indented by \glstreeindent \glstreeindent. Note that the name, symbol (if present) and description are placed in the same paragraph block. If you want the name to be apart from the description, use the alttree + id="dx1-85034"> style instead. (See below.)
    treegroup
    The treegroup style is similar to the style is similar to the tree style except that each group has a + id="dx1-85036"> style except that each group has a heading.
    treehypergroup
    The treehypergroup style is like style is like treegroup but has a set of links to the + id="dx1-85038"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-85039">, described above, but is formatted using \glstreenavigationfmt.
    @@ -21072,31 +23333,31 @@ class="cmtt-10">\glstreenavigationfmt. class="cmbx-10">treenoname
    The treenoname style is like the style is like the tree style except that the name for each + id="dx1-85041"> style except that the name for each sub-entry is ignored.
    treenonamegroup
    The treenonamegroup style is similar to the style is similar to the treenoname style except that + id="dx1-85043"> style except that each group has a heading.
    treenonamehypergroup
    The treenonamehypergroup style is like style is like treenonamegroup but has a + id="dx1-85045"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described above, but is formatted using , described above, but is formatted using \glstreenavigationfmt. @@ -21105,20 +23366,20 @@ class="cmtt-10">\glstreenavigationfmt. class="cmbx-10">alttree
    The alttree style is similar to the style is similar to the tree style except that the indentation for each level + id="dx1-85048"> style except that the indentation for each level is determined by the width of the text specified by -



    \glssetwidest  \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 -


    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 + id="dx1-85052"> styles, including those listed below and the ones in the glossary-mcols package. If you forget to set the widest entry name, the + id="dx1-85053"> 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  \glstreenamebox{width}{text}

    -

    +

    where ⟨width⟩ is the width of the box and ⟨text⟩ is the contents of the box. For example, to @@ -21193,69 +23454,69 @@ class="cmti-10">text⟩ is the contents of the box. For example, to

    -
    +
    \renewcommand*{\glstreenamebox}[2]{%  
      \makebox[#1][r]{#2}%  
    }
    -

    +

    alttreegroup
    The alttreegroup is like the is like the alttree style except that each group has a + id="dx1-85056"> style except that each group has a heading.
    alttreehypergroup
    The alttreehypergroup style is like style is like alttreegroup but has a set of links to + id="dx1-85058"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-85059">, described above.
    -

    +

    -

    Top

    15.1.8 Multicols Style

    -

    The

    The glossary-mcols package provides tree-like styles that are in the package provides tree-like styles that are in the multicols environment + id="dx1-86002"> environment (defined by the multicol package). The style names are as their analogous tree styles (as + id="dx1-86004"> package). The style names are as their analogous tree styles (as defined in §15.1.7 §15.1.7 Tree-Like Styles) but are prefixed with “mcol”. For example, the mcolindex + id="dx1-86005"> style is essentially the index style but put in a style but put in a multicols environment. For the complete list, see + id="dx1-86007"> environment. For the complete list, see table 15.2. The glossary-tree package is automatically loaded by package is automatically loaded by glossary-mcols (even if the + id="dx1-86010"> (even if the notree package option is used when loading package option is used when loading glossaries). The formatting commands \glstreenamefmt, \glstreegroupheaderfmt and \glstreenavigationfmt are all used by the corresponding glossary-mcols styles. -

    Note that styles. +

    Note that glossary-mcols is not loaded by is not loaded by glossaries. If you want to use any of the multicol styles in that package you need to load it explicitly with \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}
    -

    +

    -


    Table 15.2: Multicolumn Styles
    +class="content">Multicolumn Styles
    @@ -21319,212 +23580,212 @@ class="cmbx-10">Analogous Tree Style style="vertical-align:baseline;" id="TBL-10-2-"> + id="dx1-86021"> + id="dx1-86024"> + id="dx1-86028"> + id="dx1-86031"> + id="dx1-86033"> + id="dx1-86035"> + id="dx1-86038"> + id="dx1-86040"> + id="dx1-86042">
    glossary-mcols Style Analogous Tree Style mcolindex index
    mcolindexgroup indexgroup
    mcolindexhypergroup or or mcolindexspannav indexhypergroup
    mcoltree tree
    mcoltreegroup treegroup
    mcoltreehypergroup or or mcoltreespannav treehypergroup
    mcoltreenoname treenoname
    mcoltreenonamegroup treenonamegroup
    mcoltreenonamehypergroup or or mcoltreenonamespannav treenonamehypergroup
    mcolalttree alttree
    mcolalttreegroup alttreegroup
    mcolalttreehypergroup or or mcolalttreespannav alttreehypergroup
    + id="dx1-86045">

    -

    The styles with a navigation line, such as

    The styles with a navigation line, such as mcoltreehypergroup, now have a variant (as from + id="dx1-86046">, now have a variant (as from v4.22) with “hypergroup” replaced with “spannav” in the style name. The original “hypergroup” styles place the navigation line at the start of the first column. The newer “spannav” styles put the navigation line in the optional argument of the multicols + id="dx1-86047"> 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 package that supplies the inline style. This is a style that + id="dx1-87002"> style. This is a style that is designed for in-line use (as opposed to block styles, such as lists or tables). This style doesn’t display the number list. -

    You will most likely need to redefine . +

    You will most likely need to redefine \glossarysection with this style. For example, + id="dx1-87004"> with this style. For example, suppose you are required to have your glossaries and list of acronyms in a footnote, you can 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 with \usepackage as it’s not automatically included by the glossaries package and then set the style using \setglossarystyle. + id="dx1-87006">.
    -

    -

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


    style is governed by the following: +


    \glsinlineseparator  \glsinlineseparator

    -

    + id="dx1-87009">


    +

    This defaults to “; ” and is used between main (i.e. level 0) entries. -



    \glsinlinesubseparator  \glsinlinesubseparator

    -

    + id="dx1-87011">


    +

    This defaults to “, ” and is used between sub-entries. -



    \glsinlineparentchildseparator  \glsinlineparentchildseparator

    -

    + id="dx1-87013">


    +

    This defaults to “: ” and is used between a parent main entry and its first sub-entry. -



    \glspostinline  \glspostinline

    -

    + id="dx1-87015">


    +

    This defaults to “; ” and is used at the end of the glossary. -



    \glsinlinenameformat  \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  \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  \glsinlineemptydescformat{symbol}{number list}

    -

    +

    (which defaults to nothing) is used, otherwise the description is formatted according to -



    \glsinlinedescformat  \glsinlinedescformat{description}{}{number list}

    -

    +

    This defaults to just \spacedescription⟩ so the symbol and location list are ignored. If the @@ -21596,19 +23857,19 @@ 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  \glsinlinesubdescformat{description}{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  \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

    -

    + id="dx1-88004">


    +

    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 \glossarypreamble) + id="dx1-88006">) or the glossary postamble (defined by \glossarypostamble). For example, the ). For example, the list style uses + id="dx1-88008"> style uses the description environment, so the environment, so the theglossary environment is simply redefined to begin and + id="dx1-88011"> environment is simply redefined to begin and end the description environment. -


    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 \glossarypreamble, which should not be affected by changes in the + id="dx1-88016">, which should not be affected by changes in the glossary style. The list glossary style redefines glossary style redefines \glossaryheader to do nothing, + id="dx1-88018"> to do nothing, whereas the longheader glossary style redefines 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 makeindex the glossary is sub-divided into a maximum of + id="dx1-88021"> the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by the first character of the sort key (or + id="dx1-88022"> key (or name key if the key if the sort key is omitted). The sub-divisions are in the following order: + id="dx1-88024"> key is omitted). The sub-divisions are in the following order: symbols, numbers, A, …, Z. If you use xindy, the sub-divisions depend on the language + id="dx1-88025">, the sub-divisions depend on the language settings. -

    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 @@ -21746,200 +24007,200 @@ class="cmti-10">label⟩. (The “symbols” group has the l class="cmtt-10">glssymbols, so the command \glssymbolsgroupname is used, and the “numbers” group has the label + id="dx1-88027"> is used, and the “numbers” group has the label glsnumbers, so the command \glsnumbersgrouptitle is used.) If you are using is used.) If you are using xindy, + id="dx1-88029">, ⟨label⟩ may be an active character (for example ø), in which case the title will be set 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  \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 style redefines style redefines \glsgroupheading as follows:

    -
    +
    \renewcommand*{\glsgroupheading}[1]{%  
    \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
    -

    See also

    See also \glsgroupskip below. (Note that command definitions within \newglossarystyle + id="dx1-88033"> 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 glossary style simply redefines glossary style simply redefines \glsgroupskip to be \indexspace, whereas the tabular-like styles redefine , 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 + id="dx1-88037"> can be used to suppress this default gap for the predefined styles. -



    \glossentry  \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 number list is given by ⟨ is given by ⟨number list⟩. You can redefine \glossentry to use commands like to use commands like \glossentryname{label}, \glossentrydesc{label} and \glossentrysymbol{label} to display the name, description and symbol fields, or to access other fields, use commands like \glsentryuseri{label}. (See §9 §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 or or counterwithin package options have been used. This macro is typically + id="dx1-88047"> package options have been used. This macro is typically called by \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  \glstarget{label}{text}

    -

    +

    where ⟨label⟩ is the entry’s label. Note that you don’t need to worry about whether the hyperref + id="dx1-88050"> package has been loaded, as \glstarget won’t create a target if \hypertarget hasn’t been defined. -

    For example, the

    For example, the list style defines 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{\relax
    \setentrycounter[Hprefix]{{number(s)}}

    -

    +

    where ⟨number(s)⟩ may contain \delimN (to delimit individual numbers) and/or (to delimit individual numbers) and/or \delimR (to + id="dx1-88055"> (to indicate a range of numbers). There may be multiple occurrences of \setentrycounter + id="dx1-88056"> [Hprefixnumber(s)}, but note that the entire number list is enclosed within the argument of \glossaryentrynumbers. The user can redefine this to + id="dx1-88057">. The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of \glossaryentrynumbers is to provide a means of + id="dx1-88058"> is to provide a means of suppressing the number list altogether. (In fact, the nonumberlist option redefines + id="dx1-88059"> option redefines \glossaryentrynumbers to ignore its argument.) Therefore, when you define a new glossary + id="dx1-88060"> to ignore its argument.) Therefore, when you define a new glossary style, you don’t need to worry about whether the user has specified the nonumberlist package + id="dx1-88061"> package option. -



    \subglossentry  \subglossentry{level}{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. -


    described above. +


    \glssubentryitem  \glssubentryitem{label}

    -

    +

    This macro will increment and display the associated counter for the level 1 entries if the subentrycounter package option has been used. This macro is typically called by + id="dx1-88065"> package option has been used. This macro is typically called by \subglossentry before \glstarget. The format of the counter is controlled by the + id="dx1-88066">. The format of the counter is controlled by the macro -



    \glssubentrycounterlabel  \glssubentrycounterlabel

    -

    -

    Note that

    +

    Note that \printglossary (which (which \printglossaries calls) sets -


    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). + id="x1-88071r27"> -

    Example 26

    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 + id="x1-88072"> +

    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 environment, so environment, so theglossary + id="dx1-88075"> should start and end that environment. Let’s also suppose that you don’t want anything between the glossary groups (so \glsgroupheading and and \glsgroupskip + id="dx1-88078"> should do nothing) and suppose you don’t want anything to appear immediately after \begin{theglossary} (so \glossaryheader should do nothing). In addition, + id="dx1-88079"> should do nothing). In addition, let’s suppose the symbol should appear in brackets after the name, followed by the description and last of all the number list should appear within square brackets + id="dx1-88080"> should appear within square brackets at the end. Then you can create this new glossary style, called, say, mylist, as follows:

    -
    +
     \newglossarystyle{mylist}{%  
     % put the glossary in the itemize environment:  
     \renewenvironment{theglossary}% @@ -22106,40 +24367,40 @@ 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 or \glssubentryitem so + id="dx1-88082"> so it won’t be affected by the entrycounter, , counterwithin or or subentrycounter package + id="dx1-88085"> package options. -

    Variations:

    +

    Variations:

    • You might want the entry name to be capitalised, in which case use \Glossentryname instead of instead of \glossentryname. + id="dx1-88087">.
    • You might want to check if the symbol hasn’t been set and omit the parentheses if the symbol is absent. In this case you can use \ifglshassymbol (see (see §16 +class="tcrm-1000">§16 Utilities): -
      +
       \renewcommand*{\glossentry}[2]{%  
       \item % bullet point  
       \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -22152,82 +24413,82 @@ href="#sec:utilities">Utilities):  
       \space [##2]% the number list in square brackets  
       }%
      -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 27 +

    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, + id="x1-88090"> +

    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 within the second argument of \newglossarystyle followed + id="dx1-88092"> followed by whatever alterations you require. For example, suppose you want a style like the list style but you don’t want the extra vertical space created by style but you don’t want the extra vertical space created by \indexspace + id="dx1-88094"> between groups, then you can create a new glossary style called, say, mylist as follows:

    -
    +
    \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 + id="dx1-88095"> style in combination with the package option nogroupskip.)

    + id="dx1-88096">.)

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 28 +

    Example 29 (Example: creating a glossary style that uses the user1, …, user6 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 + id="dx1-88101">) and dimension (stored in user2). Then you can define a glossary style that displays each entry in a + id="dx1-88102">). Then you can define a glossary style that displays each entry in a longtable as follows: + id="dx1-88103"> as follows:

    -
    +
    \newglossarystyle{long6col}{%  
     % put the glossary in a longtable environment:  
     \renewenvironment{theglossary}% @@ -22266,37 +24527,37 @@ class="cmss-10">longtable \renewcommand*{\glsgroupskip}{}%  
    }
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    16. Utilities

    -

    This section describes some utility commands. Additional commands can be found in the +

    This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf).

    -

    Top

    16.1 Loops

    -

    Some of the commands described here take a comma-separated list as an argument. As with +

    Some of the commands described here take a comma-separated list as an argument. As with LATEX’s \@for command, make sure your list doesn’t have any unwanted spaces in it as they don’t get stripped. (Discussed in more detail in §2.7.2 of “LAT§2.7.2 of “LATEX for Administrative Work”.)
    -

    -


    +


    \forallglossaries  \forallglossaries[glossary list]{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  \forallacronyms{cs}{body}

    -

    +

    This is like \forallglossaries but only iterates over the lists of acronyms (that have previously been declared using \DeclareAcronymList or the or the acronymlists package option). + id="dx1-90004"> package option). This command doesn’t have an optional argument. If you want to explicitly say which lists to iterate over, just use the optional argument of \forallglossaries. -



    \forglsentries  \forglsentries[glossary label]{cs}{body}

    -

    +

    This iterates through all entries in the glossary given by ⟨glossary label⟩. At each iteration ⟨cs⟩ @@ -22354,12 +24615,12 @@ class="cmti-10">body⟩ is performed. If ⟨glossary label⟩ is omitted, \glsdefaulttype (usually the main glossary) is + id="dx1-90006"> (usually the main glossary) is used. -



    \forallglsentries  \forallglsentries[glossary list]{cs}{body}

    -

    +

    This is like \forglsentries but for each glossary in ⟨glossary list⟩ (a comma-separated list of @@ -22382,36 +24643,36 @@ class="cmti-10">cs⟩} within ⟨body⟩.) -

    +

    -

    Top

    16.2 Conditionals

    -



    \ifglossaryexists  \ifglossaryexistslabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglsentryexists  \ifglsentryexistslabel⟩⟨true part⟩⟨false part

    -

    +

    This checks if the glossary entry given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, @@ -22420,60 +24681,60 @@ class="cmti-10">false part⟩. (Note that \ifglsentryexists will always be true after the containing glossary has been displayed via \printglossary or or \printglossaries even if the entry is + id="dx1-91004"> even if the entry is explicitly defined later in the document. This is because the entry has to be defined before it can be displayed in the glossary, see §4.8.1 §4.8.1 Technical Issues for further details.) -



    \glsdoifexists  \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  \glsdoifnoexists{label}{code}

    -

    +

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -



    \glsdoifexistsorwarn  \glsdoifexistsorwarn{label}{code}

    -

    +

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -



    \glsdoifexistsordo  \glsdoifexistsordo{label}{code}{else code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists otherwise generate an error and do ⟨else code⟩. -



    \glsdoifnoexistsordo  \glsdoifnoexistsordo{label}{code}{else code}

    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ doesn’t exist otherwise generate an error and do ⟨else code⟩. -



    \ifglsused  \ifglsusedlabel⟩⟨true part⟩⟨false part

    -

    +

    See §14 §14 Unsetting and Resetting Entry Flags. -



    \ifglshaschildren  \ifglshaschildrenlabel⟩⟨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  \ifglshasparentlabel⟩⟨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  \ifglshassymbol{label}{true part}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the symbol field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshaslong  \ifglshaslong{label}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the long field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via \newacronym. There is no check for the existence of ⟨. There is no check for the existence of ⟨label⟩. -



    \ifglshasshort  \ifglshasshort{label}{true part}{false part}

    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the short field set. If it has, ⟨ field set. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. This should be true for any entry that has been defined via \newacronym. There is no check for the existence of ⟨. There is no check for the existence of ⟨label⟩. -



    \ifglshasdesc  \ifglshasdesc{label}{true part}{false part}

    -

    +

    This checks if the description field is non-empty for the entry given by ⟨ field is non-empty for the entry given by ⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. Compare with: -



    \ifglsdescsuppressed  \ifglsdescsuppressed{label}{}{false part}

    -

    +

    This checks if the description field has been set to just field has been set to just \nopostdesc for the entry given by + id="dx1-91025"> for the entry given by ⟨label⟩. If it has, ⟨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  \ifglshasfield{field}{}{false part}

    -

    +

    This tests the value of the field given by ⟨field⟩ for the entry identified by ⟨label⟩. If the value is @@ -22685,14 +24946,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 @@ -22700,19 +24961,19 @@ 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 + id="dx1-91028"> 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  \ifglsfieldeq{label}{}{false}

    -

    +

    In this case the ⟨field⟩ must be the field name not the key (see table 4.1). If the field isn’t recognised, an error will occur. This command internally uses etoolbox’s + id="dx1-91030">’s \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} @@ -22755,25 +25016,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: + id="dx1-91031"> key:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -22787,14 +25048,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} @@ -22808,17 +25069,17 @@ 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  \ifglsfielddefeq{label}{}{false}

    -

    +

    This internally uses etoolbox’s ’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} @@ -22856,14 +25117,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  \ifglsfieldcseq{label}{}{false}

    -

    +

    This internally uses etoolbox’s ’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  \glsfieldfetch{label}{field}{cs}

    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see @@ -22944,27 +25205,27 @@ 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 text field, it won’t modify the value given by + id="dx1-92002"> field, it won’t modify the value given by the name, , plural, , first or any other related key. -

    In all the four related commands below, ⟨ or any other related key. +

    In all the four related commands below, ⟨label⟩ and ⟨field⟩ are as above and ⟨definition⟩ is the new value of the field. -



    \glsfielddef  \glsfielddef{label}{field}{definition}

    -

    +

    This uses \def to change the value of the field (so it will be localised by any grouping). -



    \glsfieldedef  \glsfieldedef{label}{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  \glsfieldgdef{label}{field}{definition}

    -

    +

    This uses \gdef to change the value of the field. -



    \glsfieldxdef  \glsfieldxdef{label}{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 package that comes with the glossaries package provides additional keys that can be used as prefixes. For example, if you want to specify determiners (such as “a”, “an” or “the”). The 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: + id="dx1-93002"> are as follows:

    prefix
    The prefix associated with the text key. This defaults to nothing. + id="dx1-93004"> key. This defaults to nothing.
    prefixplural
    The prefix associated with the plural key. This defaults to nothing. + id="dx1-93006"> key. This defaults to nothing.
    prefixfirst
    The prefix associated with the first key. If omitted, this defaults to the value + id="dx1-93008"> key. If omitted, this defaults to the value of the prefix key. + id="dx1-93009"> key.
    prefixfirstplural
    The prefix associated with the firstplural key. If omitted, this defaults + id="dx1-93011"> key. If omitted, this defaults to the value of the prefixplural key.
    + id="dx1-93012"> key. -

    Example 29 +

    Example 30 (Defining Determiners) -

    Here’s the start of my example document: + id="x1-93014"> +

    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: + id="x1-93015f1">:

    -
    +
    \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 + id="dx1-93017"> package provides convenient commands to use these prefixes with commands such as \gls. Note that the prefix is not considered part of the . Note that the prefix is not considered part of the link text, so it’s + id="dx1-93019">, so it’s not included in the hyperlink (where hyperlinks are enabled). The options and any star or plus modifier are passed on to the \gls-like command. (See §6 §6 Links to Glossary Entries for further details.) -



    \pgls  \pgls[options]{label}[insert]

    -

    +

    This is inserts the value of the prefix key (or key (or prefixfirst key, on key, on first use) in front of \gls label}[insert]. -



    \Pgls  \Pgls[options]{label}[insert]

    -

    +

    If the prefix key (or key (or prefixfirst, on first use) has been set, this displays the value of that + id="dx1-93025">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \gls[options[insert]. If that key hasn’t been set, this is equivalent to \Gls[options]{} class="cmtt-10">[insert]. -



    \PGLS  \PGLS[options]{label}[insert]

    -

    +

    As \pgls but converts the prefix to upper case and uses \GLS instead of instead of \gls. -



    \pglspl  \pglspl[options]{label}[insert]

    -

    +

    This is inserts the value of the prefixplural key (or key (or prefixfirstplural key, on key, on first use) in front of \glspl[label}[insert]. -



    \Pglspl  \Pglspl[options]{label}[insert]

    -

    +

    If the prefixplural key (or key (or prefixfirstplural, on first use) has been set, this displays the value of + id="dx1-93034">, on first use) has been set, this displays the value of that key with the first letter converted to upper case followed by \glspl[options[insert]. If that key hasn’t been set, this is equivalent to \Glspl[options]{} class="cmtt-10">[insert]. -



    \PGLSpl  \PGLSpl[options]{label}[insert]

    -

    +

    As \pglspl but converts the prefix to upper case and uses \GLSpl instead of instead of \glspl. -

    Example 30 +

    Example 31 (Using Prefixes) -

    Continuing from Example 29, now that I’ve defined my entries, I can use them in the text + id="x1-93039"> +

    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  \ifglshasprefix{label}{true part}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefix + id="dx1-93041"> key. -

    This package also provides the following commands: -


    This package also provides the following commands: +


    \ifglshasprefixplural  \ifglshasprefixplural{label}{}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixplural + id="dx1-93043"> key. -



    \ifglshasprefixfirst  \ifglshasprefixfirst{label}{}{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirst + id="dx1-93045"> key. -


    \ifglshasprefixfirstplural  -


    \ifglshasprefixfirstplural{label}{true part}{} +{false part}

    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirstplural + id="dx1-93047"> key. -



    \glsentryprefix  \glsentryprefix{label}

    -

    +

    Displays the value of the prefix key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixfirst  \glsentryprefixfirst{label}

    -

    +

    Displays the value of the prefixfirst key for the entry given by ⟨ key for the entry given by ⟨label⟩. -



    \glsentryprefixplural  \glsentryprefixplural{label}

    -

    +

    Displays the value of the prefixplural key for the entry given by ⟨ 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 ⟨ 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 + id="dx1-93061">, these commands aren’t expandable so can’t be used in PDF bookmarks.
    -

    +

    -

    Example 31 +

    Example 32 (Adding Determiner to Glossary Style) -

    You can use the above commands to define a new glossary style that uses the determiner. + id="x1-93063"> +

    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 + id="dx1-93064"> style that inserts the prefix before the name:

    -
    +
    \newglossarystyle{plist}{%  
      \setglossarystyle{list}%  
      \renewcommand*{\glossentry}[2]{% @@ -23548,182 +25808,189 @@ 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, + id="dx1-94001"> package, but note that this package is experimental and it requires the accsupp package which is also + id="dx1-94002"> package which is also listed as experimental. This package defines additional keys that may be used when defining glossary entries. The keys are as follows:

    access
    The replacement text corresponding to the name key. + id="dx1-94004"> key.
    textaccess
    The replacement text corresponding to the text key. + id="dx1-94006"> key.
    firstaccess
    The replacement text corresponding to the first key. + id="dx1-94008"> key.
    pluralaccess
    The replacement text corresponding to the plural key. + id="dx1-94010"> key.
    firstpluralaccess
    The replacement text corresponding to the firstplural key. + id="dx1-94012"> key.
    symbolaccess
    The replacement text corresponding to the symbol key. + id="dx1-94014"> key.
    symbolpluralaccess
    The replacement text corresponding to the symbolplural key. + id="dx1-94016"> key.
    descriptionaccess
    The replacement text corresponding to the description key. + id="dx1-94018"> key.
    descriptionpluralaccess
    The replacement text corresponding to the descriptionplural + id="dx1-94020"> key.
    longaccess
    The replacement text corresponding to the long key (used by key (used by \newacronym). + id="dx1-94023">).
    shortaccess
    The replacement text corresponding to the short key (used by + id="dx1-94025"> key (used by \newacronym). + id="dx1-94026">).
    longpluralaccess
    The replacement text corresponding to the longplural key (used by + id="dx1-94028"> key (used by \newacronym). + id="dx1-94029">).
    shortpluralaccess
    The replacement text corresponding to the shortplural key (used by + id="dx1-94031"> key (used by \newacronym). + id="dx1-94032">).
    -

    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 ( package. +

    See the documented code (glossaries-code.pdf) for further details. I recommend that you also read the accsupp documentation. + id="dx1-94034"> documentation.

    -

    -

    +

    Top

    19. Troubleshooting

    -

    The glossaries package comes with some minimal example files, minimalgls.tex, -

    In addition to the sample files listed in §1.2 Sample Documents, the glossaries package +comes with some minimal example files, minimalgls.tex, mwe-gls.tex, mwe-acr.tex and mwe-acr-desc.tex, which can be used for testing. -These should be located in the samples subdirectory (folder) of the glossaries -documentation directory. The location varies according to your operating system -and TEX installation. For example, on my Linux partition it can be found in -/usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/. Further information on -debugging LATmwe-acr.tex and +mwe-acr-desc.tex, which can be used for testing. These should be located in the samples +subdirectory (folder) of the glossaries documentation directory. The location varies according to +your operating system and TEX installation. For example, on my Linux partition it can be found +in /usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/. The makeglossariesgui +application can also be used to test for various problems. Further information on debugging +LATEX 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 my package bug report form

    Top

    Index

    + id="x1-9600019">Index

    Symbols
    \@gls@codepage  1
    \@glsorder  2
    \@istfilename  3
    \@newglossary  4
    \@xdylanguage  5

    A accsupp package  6, 7
    +href="glossaries-user.html#dx1-94002" >6, 7
    \ACRfull  8
    \Acrfull  9
    \acrfull  10
    \acrfullfmt  11
    \acrfullformat  12
    \ACRfullpl  13
    \Acrfullpl  14
    \acrfullpl  15
    \ACRlong  16
    \Acrlong  17
    \acrlong  18
    \ACRlongpl  19
    \Acrlongpl  20
    \acrlongpl  21
    acronym styles:
        dua  22, 23, 24, 25
    +href="glossaries-user.html#dx1-71018" >22, 23, 24, 25
        dua-desc  26, 27
    +href="glossaries-user.html#dx1-71053" >26, 27
        footnote  28, 29, 30
    +href="glossaries-user.html#dx1-71019" >28, 29, 30
        footnote-desc  31
    +href="glossaries-user.html#dx1-71073" >31
        footnote-sc  32
    +href="glossaries-user.html#dx1-71064" >32
        footnote-sc-desc  33, 34, 35, 36
    +href="glossaries-user.html#dx1-11027" >33, 34, 35, 36
        footnote-sm  37
    +href="glossaries-user.html#dx1-71065" >37
        footnote-sm-desc  38
    +href="glossaries-user.html#dx1-71075" >38
        long-sc-short  39, 40, 41, 42
    +href="glossaries-user.html#dx1-71007" >39, 40, 41, 42
        long-sc-short-desc  43
    +href="glossaries-user.html#dx1-71036" >43
        long-short  44, 45, 46, 47, 48, 49
    +href="glossaries-user.html#dx1-57069" >44, 45, 46, 47, 48, 49
        long-short-desc  50, 51, 52
    +href="glossaries-user.html#dx1-71035" >50, 51, 52
        long-sm-short  53, 54, 55
    +href="glossaries-user.html#dx1-71011" >53, 54, 55
        long-sm-short-desc  56
    +href="glossaries-user.html#dx1-71037" >56
        long-sp-short  57, 58, 59
    +href="glossaries-user.html#dx1-71023" >57, 58, 59
        long-sp-short-desc  60
    +href="glossaries-user.html#dx1-71038" >60
        sc-short-long  61
    +href="glossaries-user.html#dx1-71030" >61
        sc-short-long-desc  62
    +href="glossaries-user.html#dx1-71049" >62
        short-long  63
    +href="glossaries-user.html#dx1-71029" >63
        short-long-desc  64
    +href="glossaries-user.html#dx1-71048" >64
        sm-short-long  65
    +href="glossaries-user.html#dx1-71031" >65
        sm-short-long-desc  66
    +href="glossaries-user.html#dx1-71050" >66
    \acronymentry  67
    \acronymfont  68
    \acronymsort  69
    \acronymtype  70
    \ACRshort  71
    \Acrshort  72
    \acrshort  73
    \ACRshortpl  74
    \Acrshortpl  75
    \acrshortpl  76
    \altnewglossary  77
    amsgen package  78, 79, 80
    +href="glossaries-user.html#dx1-14" >78, 79, 80
    amsmath package  81, 82
    +href="glossaries-user.html#dx1-55006" >81, 82
    arara  83
    +href="glossaries-user.html#dx1-4008" >83, 84, 85, 86
    array package  84, 85
    +href="glossaries-user.html#dx1-81006" >87, 88

    B babel package  86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112
    +href="glossaries-user.html#dx1-7016" >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
    beamer class  113, 114, 115, 116
    +href="glossaries-user.html#dx1-55004" >116, 117, 118, 119
    beamer package  117
    +href="glossaries-user.html#dx1-14046" >120
    +bib2gls  121, 122, 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
    booktabs package  118, 119, 120
    +href="glossaries-user.html#dx1-80006" >149, 150, 151

    C \cGls  121
    +href="glossaries-user.html#dx1-76010" >152
    \cgls  122
    +href="glossaries-user.html#dx1-76008" >153
    \cGlsformat  123
    +href="glossaries-user.html#dx1-76014" >154
    \cglsformat  124
    +href="glossaries-user.html#dx1-76012" >155
    \cGlspl  125
    +href="glossaries-user.html#dx1-76011" >156
    \cglspl  126
    +href="glossaries-user.html#dx1-76009" >157
    + + \cGlsplformat  127
    +href="glossaries-user.html#dx1-76015" >158
    \cglsplformat  128
    - - +href="glossaries-user.html#dx1-76013" >159
    classicthesis package  129, 130, 131, 132, 133
    +href="glossaries-user.html#dx1-25026" >160, 161, 162, 163, 164
    \currentglossary  134
    +href="glossaries-user.html#dx1-88070" >165

    D datatool package  135, 136, 137, 138, 139
    +href="glossaries-user.html#dx1-13" >166, 167, 168, 169, 170
    datatool-base package  140
    +href="glossaries-user.html#dx1-12" >171, 172
    \DeclareAcronymList  141
    +href="glossaries-user.html#dx1-27022" >173
    \defglsentryfmt  142
    +href="glossaries-user.html#dx1-57007" >174
    \DefineAcronymSynonyms  143
    +href="glossaries-user.html#dx1-27027" >175
    doc package  144, 145, 146
    +href="glossaries-user.html#dx1-18" >176, 177, 178

    E encap  147
    +href="glossaries-user.html#dx1-50002" >179
    entry location  148
    +href="glossaries-user.html#dx1-3002" >180
    environments:
        theglossary  149
    -etex package  150
    +href="glossaries-user.html#dx1-88003" >181
    etoolbox package  151, 152, 153, 154, 155, 156
    +href="glossaries-user.html#dx1-8" >182, 183, 184, 185, 186, 187
    Extended Latin Alphabet  157
    +href="glossaries-user.html#dx1-3003" >188
    extended Latin character  158, 159, 160, 161, 162, 163, 164
    +href="glossaries-user.html#dx1-3005" >189, 190, 191, 192, 193, 194, 195

    F file types
        .alg  165
    +href="glossaries-user.html#dx1-16079" >196
        .aux  166, 167, 168
    +href="glossaries-user.html#dx1-13024" >197, 198, 199, 200, 201
        .glg  169, 170, 171
    +href="glossaries-user.html#dx1-16078" >202, 203, 204
        .glg2  172
    +href="glossaries-user.html#dx1-22" >205
        .glo  173, 174, 175
    +href="glossaries-user.html#dx1-17019" >206, 207, 208
        .gls  176, 177
    +href="glossaries-user.html#dx1-19017" >209, 210
        .glsdefs  178, 179
    +href="glossaries-user.html#dx1-47013" >211, 212, 213
        .ist  180, 181, 182, 183, 184, 185
    +href="glossaries-user.html#dx1-20005" >214, 215, 216, 217, 218, 219
        .tex  186, 187
    +href="glossaries-user.html#dx1-13014" >220, 221, 222, 223
        .xdy  188, 189, 190, 191, 192, 193, 194, 195
    +href="glossaries-user.html#dx1-19012" >224, 225, 226, 227, 228, 229, 230, 231
        glo2  196
    +href="glossaries-user.html#dx1-21" >232
        gls2  197
    +href="glossaries-user.html#dx1-20" >233
    first use  198
    +href="glossaries-user.html#dx1-3010" >234
        flag  199
    +href="glossaries-user.html#dx1-3018" >235
        text  200
    +href="glossaries-user.html#dx1-3019" >236
    \firstacronymfont  201
    +href="glossaries-user.html#dx1-71001" >237
    flowfram package  202
    +href="glossaries-user.html#dx1-83011" >238
    fmtcount package  203
    +href="glossaries-user.html#dx1-11090" >239, 240, 241, 242
    fontspec package  204
    -\forallacronyms  205
    +href="glossaries-user.html#dx1-34141" >243, 244
    +\forallacronyms  245
    \forallglossaries  206
    +href="glossaries-user.html#dx1-90001" >246
    \forallglsentries  207
    +href="glossaries-user.html#dx1-90007" >247
    \forglsentries  208
    +href="glossaries-user.html#dx1-90005" >248

    G \Genacrfullformat  209
    +href="glossaries-user.html#dx1-57065" >249
    \genacrfullformat  210
    +href="glossaries-user.html#dx1-57059" >250
    \GenericAcronymFields  211
    +href="glossaries-user.html#dx1-72022" >251
    \Genplacrfullformat  212
    +href="glossaries-user.html#dx1-57066" >252
    \genplacrfullformat  213
    +href="glossaries-user.html#dx1-57061" >253
    glossaries package  214, 215, 216, 217, 218
    +href="glossaries-user.html#dx1-3" >254, 255, 256, 257, 258, 259, 260, 261
    glossaries-accsupp package  219, 220, 221, 222, 223
    +href="glossaries-user.html#dx1-11119" >262, 263, 264, 265
    glossaries-babel package  224, 225
    +href="glossaries-user.html#dx1-23059" >266, 267
    glossaries-extra package  226, 227, 228, 229, 230, 231, 232, 233, 234
    +href="glossaries-user.html#dx1-5008" >268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290
    +glossaries-extra-stylemods package  291
    glossaries-polyglossia package  235
    +href="glossaries-user.html#dx1-23061" >292
    glossaries-prefix package  236, 237, 238, 239, 240
    +href="glossaries-user.html#dx1-11117" >293, 294, 295, 296
    glossary counters:
        glossaryentry  241
    +href="glossaries-user.html#dx1-25004" >297
        glossarysubentry  242
    +href="glossaries-user.html#dx1-25021" >298
    glossary package  243, 244, 245, 246, 247
    +href="glossaries-user.html#dx1-15" >299, 300, 301, 302, 303
    glossary styles:
        altlist  248, 249, 250, 251, 252
    +href="glossaries-user.html#dx1-71047" >304, 305, 306, 307, 308
        altlistgroup  253, 254
    +href="glossaries-user.html#dx1-79030" >309, 310
        altlisthypergroup  255
    +href="glossaries-user.html#dx1-79032" >311
        altlong4col  256, 257, 258
    +href="glossaries-user.html#dx1-78022" >312, 313, 314
        altlong4col-booktabs  259
    +href="glossaries-user.html#dx1-82031" >315
        altlong4colborder  260
    +href="glossaries-user.html#dx1-80043" >316
        altlong4colheader  261, 262
    +href="glossaries-user.html#dx1-80045" >317, 318
        altlong4colheaderborder  263
    +href="glossaries-user.html#dx1-80047" >319
        altlongragged4col  264, 265, 266
    +href="glossaries-user.html#dx1-81030" >320, 321, 322
        altlongragged4col-booktabs  267
    +href="glossaries-user.html#dx1-82037" >323
        altlongragged4colborder  268
    +href="glossaries-user.html#dx1-81034" >324
        altlongragged4colheader  269, 270, 271
    +href="glossaries-user.html#dx1-81036" >325, 326, 327
        altlongragged4colheaderborder  272
    +href="glossaries-user.html#dx1-81038" >328
        altsuper4col  273, 274, 275
    +href="glossaries-user.html#dx1-78023" >329, 330, 331
        altsuper4colborder  276
    +href="glossaries-user.html#dx1-83048" >332
        altsuper4colheader  277
    +href="glossaries-user.html#dx1-83050" >333
        altsuper4colheaderborder  278
    +href="glossaries-user.html#dx1-83052" >334
        altsuperragged4col  279, 280, 281
    +href="glossaries-user.html#dx1-84032" >335, 336, 337
        altsuperragged4colborder  282
    +href="glossaries-user.html#dx1-84034" >338
        altsuperragged4colheader  283, 284
    +href="glossaries-user.html#dx1-84036" >339, 340
        altsuperragged4colheaderborder  285
    +href="glossaries-user.html#dx1-84038" >341
    + +     alttree  286, 287, 288, 289, 290, 291, 292, 293
    +href="glossaries-user.html#dx1-78026" >342, 343, 344, 345, 346, 347, 348, 349
        alttreegroup  294, 295, 296
    +href="glossaries-user.html#dx1-85055" >350, 351, 352
        alttreehypergroup  297, 298
    - - +href="glossaries-user.html#dx1-85057" >353, 354
        index  299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310
    +href="glossaries-user.html#dx1-25050" >355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366
        indexgroup  311, 312, 313
    +href="glossaries-user.html#dx1-85024" >367, 368, 369
        indexhypergroup  314, 315, 316
    +href="glossaries-user.html#dx1-85007" >370, 371, 372
        inline  317, 318, 319
    +href="glossaries-user.html#dx1-11067" >373, 374, 375
        list  320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332
    +href="glossaries-user.html#dx1-25043" >376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388
        listdotted  333, 334, 335, 336, 337
    +href="glossaries-user.html#dx1-78036" >389, 390, 391, 392, 393
        listgroup  338, 339, 340, 341
    +href="glossaries-user.html#dx1-26022" >394, 395, 396, 397
        listhypergroup  342, 343, 344, 345, 346, 347, 348, 349
    +href="glossaries-user.html#dx1-79019" >398, 399, 400, 401, 402, 403, 404, 405
        long  350, 351, 352, 353, 354, 355
    +href="glossaries-user.html#dx1-78025" >406, 407, 408, 409, 410, 411
        long-booktabs  356, 357
    +href="glossaries-user.html#dx1-82024" >412, 413
        long3col  358, 359, 360, 361, 362
    +href="glossaries-user.html#dx1-78009" >414, 415, 416, 417, 418
        long3col-booktabs  363
    +href="glossaries-user.html#dx1-82026" >419
        long3colborder  364, 365
    +href="glossaries-user.html#dx1-78011" >420, 421
        long3colheader  366, 367, 368, 369
    +href="glossaries-user.html#dx1-78010" >422, 423, 424, 425
        long3colheaderborder  370, 371
    +href="glossaries-user.html#dx1-78012" >426, 427
        long4col  372, 373, 374, 375, 376
    +href="glossaries-user.html#dx1-78020" >428, 429, 430, 431, 432
        long4col-booktabs  377
    +href="glossaries-user.html#dx1-82029" >433
        long4colborder  378, 379
    +href="glossaries-user.html#dx1-80033" >434, 435
        long4colheader  380, 381, 382, 383
    +href="glossaries-user.html#dx1-80035" >436, 437, 438, 439
        long4colheaderborder  384, 385
    +href="glossaries-user.html#dx1-80037" >440, 441
        longborder  386
    +href="glossaries-user.html#dx1-80013" >442
        longheader  387, 388, 389, 390
    +href="glossaries-user.html#dx1-80015" >443, 444, 445, 446
        longheaderborder  391, 392
    +href="glossaries-user.html#dx1-80017" >447, 448
        longragged  393, 394, 395, 396
    +href="glossaries-user.html#dx1-81010" >449, 450, 451, 452
        longragged-booktabs  397
    +href="glossaries-user.html#dx1-82033" >453
        longragged3col  398, 399, 400, 401
    +href="glossaries-user.html#dx1-81019" >454, 455, 456, 457
        longragged3col-booktabs  402
    +href="glossaries-user.html#dx1-82035" >458
        longragged3colborder  403
    +href="glossaries-user.html#dx1-81024" >459
        longragged3colheader  404, 405, 406
    +href="glossaries-user.html#dx1-81026" >460, 461, 462
        longragged3colheaderborder  407
    +href="glossaries-user.html#dx1-81028" >463
        longraggedborder  408
    +href="glossaries-user.html#dx1-81013" >464
        longraggedheader  409, 410, 411
    +href="glossaries-user.html#dx1-81015" >465, 466, 467
        longraggedheaderborder  412
    +href="glossaries-user.html#dx1-81017" >468
        mcolalttree  413
    +href="glossaries-user.html#dx1-86039" >469
        mcolalttreegroup  414
    +href="glossaries-user.html#dx1-86041" >470
        mcolalttreehypergroup  415
    +href="glossaries-user.html#dx1-86043" >471
        mcolalttreespannav  416
    +href="glossaries-user.html#dx1-86044" >472
        mcolindex  417, 418
    +href="glossaries-user.html#dx1-86005" >473, 474
        mcolindexgroup  419
    +href="glossaries-user.html#dx1-86020" >475
        mcolindexhypergroup  420
    +href="glossaries-user.html#dx1-86022" >476
        mcolindexspannav  421
    +href="glossaries-user.html#dx1-86023" >477
        mcoltree  422
    +href="glossaries-user.html#dx1-86025" >478
        mcoltreegroup  423
    +href="glossaries-user.html#dx1-86027" >479
    + +     mcoltreehypergroup  424, 425
    +href="glossaries-user.html#dx1-86029" >480, 481
        mcoltreenoname  426
    +href="glossaries-user.html#dx1-86032" >482
        mcoltreenonamegroup  427
    - - +href="glossaries-user.html#dx1-86034" >483
        mcoltreenonamehypergroup  428
    +href="glossaries-user.html#dx1-86036" >484
        mcoltreenonamespannav  429
    +href="glossaries-user.html#dx1-86037" >485
        mcoltreespannav  430
    +href="glossaries-user.html#dx1-86030" >486
        super  431, 432, 433, 434
    +href="glossaries-user.html#dx1-83012" >487, 488, 489, 490
        super3col  435, 436, 437, 438
    +href="glossaries-user.html#dx1-83024" >491, 492, 493, 494
        super3colborder  439
    +href="glossaries-user.html#dx1-83029" >495
        super3colheader  440, 441
    +href="glossaries-user.html#dx1-83031" >496, 497
        super3colheaderborder  442
    +href="glossaries-user.html#dx1-83033" >498
        super4col  443, 444, 445, 446, 447
    +href="glossaries-user.html#dx1-78021" >499, 500, 501, 502, 503
        super4colborder  448, 449
    +href="glossaries-user.html#dx1-83038" >504, 505
        super4colheader  450, 451, 452
    +href="glossaries-user.html#dx1-83040" >506, 507, 508
        super4colheaderborder  453, 454
    +href="glossaries-user.html#dx1-83042" >509, 510
        superborder  455
    +href="glossaries-user.html#dx1-83018" >511
        superheader  456, 457
    +href="glossaries-user.html#dx1-83020" >512, 513
        superheaderborder  458, 459
    +href="glossaries-user.html#dx1-63066" >514, 515
        superragged  460, 461, 462, 463
    +href="glossaries-user.html#dx1-84009" >516, 517, 518, 519
        superragged3col  464, 465, 466, 467
    +href="glossaries-user.html#dx1-84021" >520, 521, 522, 523
        superragged3colborder  468
    +href="glossaries-user.html#dx1-84026" >524
        superragged3colheader  469, 470
    +href="glossaries-user.html#dx1-84028" >525, 526
        superragged3colheaderborder  471
    +href="glossaries-user.html#dx1-84030" >527
        superraggedborder  472
    +href="glossaries-user.html#dx1-84015" >528
        superraggedheader  473, 474
    +href="glossaries-user.html#dx1-84017" >529, 530
        superraggedheaderborder  475
    +href="glossaries-user.html#dx1-84019" >531
        tree  476, 477, 478, 479, 480, 481, 482
    +href="glossaries-user.html#dx1-72066" >532, 533, 534, 535, 536, 537, 538
        treegroup  483, 484, 485
    +href="glossaries-user.html#dx1-85035" >539, 540, 541
        treehypergroup  486, 487, 488
    +href="glossaries-user.html#dx1-79024" >542, 543, 544
        treenoname  489, 490, 491, 492
    +href="glossaries-user.html#dx1-85012" >545, 546, 547, 548
        treenonamegroup  493, 494, 495
    +href="glossaries-user.html#dx1-85042" >549, 550, 551
        treenonamehypergroup  496, 497
    +href="glossaries-user.html#dx1-85044" >552, 553
    glossary-inline package  498, 499
    +href="glossaries-user.html#dx1-87001" >554, 555
    glossary-list package  500, 501, 502, 503, 504
    +href="glossaries-user.html#dx1-25028" >556, 557, 558, 559, 560
    glossary-long package  505, 506, 507, 508, 509, 510, 511, 512
    +href="glossaries-user.html#dx1-25029" >561, 562, 563, 564, 565, 566, 567, 568
    glossary-longbooktabs package  513, 514, 515
    +href="glossaries-user.html#dx1-82001" >569, 570, 571
    glossary-longragged package  516, 517, 518, 519
    +href="glossaries-user.html#dx1-81001" >572, 573, 574, 575
    glossary-mcols package  520, 521, 522, 523, 524, 525, 526
    +href="glossaries-user.html#dx1-25053" >576, 577, 578, 579, 580, 581, 582
    glossary-ragged package  527
    +href="glossaries-user.html#dx1-82010" >583
    glossary-super package  528, 529, 530, 531, 532, 533
    +href="glossaries-user.html#dx1-25030" >584, 585, 586, 587, 588, 589
    glossary-superragged package  534, 535, 536
    +href="glossaries-user.html#dx1-84001" >590, 591, 592
    glossary-tree package  537, 538, 539, 540, 541, 542, 543, 544
    +href="glossaries-user.html#dx1-25031" >593, 594, 595, 596, 597, 598, 599, 600
    glossaryentry (counter)  545, 546, 547, 548
    +href="glossaries-user.html#dx1-25003" >601, 602, 603, 604
    \glossaryheader  549
    +href="glossaries-user.html#dx1-88015" >605
    \glossarypostamble  550
    +href="glossaries-user.html#dx1-63063" >606
    \glossarypreamble  551
    +href="glossaries-user.html#dx1-63061" >607
    + + glossarysubentry (counter)  552
    +href="glossaries-user.html#dx1-25020" >608
    \glossentry  553
    +href="glossaries-user.html#dx1-88038" >609
    \Glossentrydesc  554
    - - +href="glossaries-user.html#dx1-62029" >610
    \glossentrydesc  555
    +href="glossaries-user.html#dx1-62028" >611
    \Glossentryname  556
    +href="glossaries-user.html#dx1-62013" >612
    \glossentryname  557
    +href="glossaries-user.html#dx1-62012" >613
    \Glossentrysymbol  558
    +href="glossaries-user.html#dx1-62036" >614
    \glossentrysymbol  559
    +href="glossaries-user.html#dx1-62035" >615
    \GLS  560
    +href="glossaries-user.html#dx1-55022" >616
    \Gls  561
    +href="glossaries-user.html#dx1-55021" >617
    \gls  562
    +href="glossaries-user.html#dx1-55011" >618
    \glsacspace  563
    +href="glossaries-user.html#dx1-71028" >619
    \glsadd  564
    +href="glossaries-user.html#dx1-59001" >620
    \glsaddall  565
    +href="glossaries-user.html#dx1-59003" >621
    \glsaddall options
        types  566
    +href="glossaries-user.html#dx1-59004" >622
    \glsaddallunused  567
    +href="glossaries-user.html#dx1-59008" >623
    \glsaddkey  568
    +href="glossaries-user.html#dx1-38001" >624
    \glsaddprotectedpagefmt  569
    +href="glossaries-user.html#dx1-51015" >625
    \glsaddstoragekey  570
    +href="glossaries-user.html#dx1-39001" >626
    \GlsAddXdyAttribute  571
    +href="glossaries-user.html#dx1-66014" >627
    \GlsAddXdyCounters  572
    +href="glossaries-user.html#dx1-66009" >628
    \GlsAddXdyLocation  573
    +href="glossaries-user.html#dx1-66024" >629
    \glsautoprefix  574
    +href="glossaries-user.html#dx1-24041" >630
    \glsbackslash  575
    +href="glossaries-user.html#dx1-64012" >631
    \glscapscase  576
    +href="glossaries-user.html#dx1-57021" >632
    \glsclearpage  577
    +href="glossaries-user.html#dx1-24018" >633
    \glsclosebrace  578
    +href="glossaries-user.html#dx1-64008" >634
    \glscurrentfieldvalue  579
    +href="glossaries-user.html#dx1-91027" >635
    \glscustomtext  580
    +href="glossaries-user.html#dx1-57015" >636
    \GLSdesc  581
    +href="glossaries-user.html#dx1-56054" >637
    \Glsdesc  582
    +href="glossaries-user.html#dx1-56053" >638
    \glsdesc  583
    +href="glossaries-user.html#dx1-56050" >639
    \glsdescwidth  584
    +href="glossaries-user.html#dx1-78014" >640
    \glsdisablehyper  585
    +href="glossaries-user.html#dx1-58005" >641
    \glsdisp  586
    +href="glossaries-user.html#dx1-55056" >642
    \glsdisplaynumberlist  587
    +href="glossaries-user.html#dx1-62061" >643
    \glsdoifexists  588
    +href="glossaries-user.html#dx1-91005" >644
    \glsdoifexistsordo  589
    +href="glossaries-user.html#dx1-91008" >645
    \glsdoifexistsorwarn  590
    +href="glossaries-user.html#dx1-91007" >646
    \glsdoifnoexists  591
    +href="glossaries-user.html#dx1-91006" >647
    \glsdoifnoexistsordo  592
    +href="glossaries-user.html#dx1-91009" >648
    \glsdosanitizesort  593
    +href="glossaries-user.html#dx1-26031" >649
    \glsenableentrycount  594
    +href="glossaries-user.html#dx1-76003" >650
    \glsenablehyper  595
    +href="glossaries-user.html#dx1-58006" >651
    \glsentrycounterlabel  596
    +href="glossaries-user.html#dx1-88048" >652
    + + \glsentrycurrcount  597
    +href="glossaries-user.html#dx1-76006" >653
    \Glsentrydesc  598
    +href="glossaries-user.html#dx1-62027" >654
    \glsentrydesc  599
    - - +href="glossaries-user.html#dx1-62026" >655
    \Glsentrydescplural  600
    +href="glossaries-user.html#dx1-62031" >656
    \glsentrydescplural  601
    +href="glossaries-user.html#dx1-62030" >657
    \Glsentryfirst  602
    +href="glossaries-user.html#dx1-62021" >658
    \glsentryfirst  603
    +href="glossaries-user.html#dx1-62020" >659
    \Glsentryfirstplural  604
    +href="glossaries-user.html#dx1-62024" >660
    \glsentryfirstplural  605
    +href="glossaries-user.html#dx1-62023" >661
    \glsentryfmt  606
    +href="glossaries-user.html#dx1-57006" >662
    \Glsentryfull  607
    +href="glossaries-user.html#dx1-69122" >663
    \glsentryfull  608
    +href="glossaries-user.html#dx1-69121" >664
    \Glsentryfullpl  609
    +href="glossaries-user.html#dx1-69124" >665
    \glsentryfullpl  610
    +href="glossaries-user.html#dx1-69123" >666
    \glsentryitem  611
    +href="glossaries-user.html#dx1-88045" >667
    \Glsentrylong  612
    +href="glossaries-user.html#dx1-69114" >668
    \glsentrylong  613
    +href="glossaries-user.html#dx1-69113" >669
    \Glsentrylongpl  614
    +href="glossaries-user.html#dx1-69116" >670
    \glsentrylongpl  615
    +href="glossaries-user.html#dx1-69115" >671
    \Glsentryname  616
    +href="glossaries-user.html#dx1-62008" >672
    \glsentryname  617
    +href="glossaries-user.html#dx1-62007" >673
    \glsentrynumberlist  618
    +href="glossaries-user.html#dx1-62060" >674
    \Glsentryplural  619
    +href="glossaries-user.html#dx1-62018" >675
    \glsentryplural  620
    +href="glossaries-user.html#dx1-62017" >676
    \Glsentryprefix  621
    +href="glossaries-user.html#dx1-93057" >677
    \glsentryprefix  622
    +href="glossaries-user.html#dx1-93048" >678
    \Glsentryprefixfirst  623
    +href="glossaries-user.html#dx1-93058" >679
    \glsentryprefixfirst  624
    +href="glossaries-user.html#dx1-93050" >680
    \Glsentryprefixfirstplural  625
    +href="glossaries-user.html#dx1-93060" >681
    \glsentryprefixfirstplural  626
    +href="glossaries-user.html#dx1-93054" >682
    \Glsentryprefixplural  627
    +href="glossaries-user.html#dx1-93059" >683
    \glsentryprefixplural  628
    +href="glossaries-user.html#dx1-93052" >684
    \glsentryprevcount  629
    +href="glossaries-user.html#dx1-76007" >685
    \Glsentryshort  630
    +href="glossaries-user.html#dx1-69118" >686
    \glsentryshort  631
    +href="glossaries-user.html#dx1-69117" >687
    \Glsentryshortpl  632
    +href="glossaries-user.html#dx1-69120" >688
    \glsentryshortpl  633
    +href="glossaries-user.html#dx1-69119" >689
    \Glsentrysymbol  634
    +href="glossaries-user.html#dx1-62033" >690
    \glsentrysymbol  635
    +href="glossaries-user.html#dx1-62032" >691
    \Glsentrysymbolplural  636
    +href="glossaries-user.html#dx1-62038" >692
    \glsentrysymbolplural  637
    +href="glossaries-user.html#dx1-62037" >693
    \Glsentrytext  638
    +href="glossaries-user.html#dx1-62015" >694
    \glsentrytext  639
    +href="glossaries-user.html#dx1-62014" >695
    \glsentrytitlecase  640
    +href="glossaries-user.html#dx1-62005" >696
    \Glsentryuseri  641
    +href="glossaries-user.html#dx1-62040" >697
    \glsentryuseri  642
    +href="glossaries-user.html#dx1-62039" >698
    + + \Glsentryuserii  643
    +href="glossaries-user.html#dx1-62042" >699
    \glsentryuserii  644
    +href="glossaries-user.html#dx1-62041" >700
    \Glsentryuseriii  645
    - - +href="glossaries-user.html#dx1-62044" >701
    \glsentryuseriii  646
    +href="glossaries-user.html#dx1-62043" >702
    \Glsentryuseriv  647
    +href="glossaries-user.html#dx1-62046" >703
    \glsentryuseriv  648
    +href="glossaries-user.html#dx1-62045" >704
    \Glsentryuserv  649
    +href="glossaries-user.html#dx1-62048" >705
    \glsentryuserv  650
    +href="glossaries-user.html#dx1-62047" >706
    \Glsentryuservi  651
    +href="glossaries-user.html#dx1-62050" >707
    \glsentryuservi  652
    +href="glossaries-user.html#dx1-62049" >708
    \glsexpandfields  653
    +href="glossaries-user.html#dx1-40022" >709
    \glsfielddef  654
    +href="glossaries-user.html#dx1-92006" >710
    \glsfieldedef  655
    +href="glossaries-user.html#dx1-92007" >711
    \glsfieldfetch  656
    +href="glossaries-user.html#dx1-92001" >712
    \glsfieldgdef  657
    +href="glossaries-user.html#dx1-92008" >713
    \glsfieldxdef  658
    +href="glossaries-user.html#dx1-92009" >714
    \glsfindwidesttoplevelname  659
    +href="glossaries-user.html#dx1-85051" >715
    \GLSfirst  660
    +href="glossaries-user.html#dx1-56017" >716
    \Glsfirst  661
    +href="glossaries-user.html#dx1-56016" >717
    \glsfirst  662
    +href="glossaries-user.html#dx1-56013" >718
    \GLSfirstplural  663
    +href="glossaries-user.html#dx1-56037" >719
    \Glsfirstplural  664
    +href="glossaries-user.html#dx1-56036" >720
    \glsfirstplural  665
    +href="glossaries-user.html#dx1-56033" >721
    \glsgenacfmt  666
    +href="glossaries-user.html#dx1-57050" >722
    \glsgenentryfmt  667
    +href="glossaries-user.html#dx1-57044" >723
    \glsgetgrouptitle  668
    +href="glossaries-user.html#dx1-88026" >724
    \glsglossarymark  669, 670
    +href="glossaries-user.html#dx1-24013" >725, 726
    \glsgroupheading  671
    +href="glossaries-user.html#dx1-88020" >727
    \glsgroupskip  672
    +href="glossaries-user.html#dx1-88034" >728
    \glshyperlink  673
    +href="glossaries-user.html#dx1-62051" >729
    \glshypernavsep  674
    +href="glossaries-user.html#dx1-79021" >730
    \glsifhyperon  675
    +href="glossaries-user.html#dx1-57022" >731
    \glsIfListOfAcronyms  676
    +href="glossaries-user.html#dx1-27025" >732
    \glsifplural  677
    +href="glossaries-user.html#dx1-57020" >733
    \glsinlinedescformat  678
    +href="glossaries-user.html#dx1-87019" >734
    \glsinlineemptydescformat  679
    +href="glossaries-user.html#dx1-87018" >735
    \glsinlinenameformat  680
    +href="glossaries-user.html#dx1-87016" >736
    \glsinlineparentchildseparator  681
    +href="glossaries-user.html#dx1-87012" >737
    \glsinlineseparator  682
    +href="glossaries-user.html#dx1-87008" >738
    \glsinlinesubdescformat  683
    +href="glossaries-user.html#dx1-87020" >739
    \glsinlinesubnameformat  684
    +href="glossaries-user.html#dx1-87017" >740
    \glsinlinesubseparator  685
    +href="glossaries-user.html#dx1-87010" >741
    \glsinsert  686
    +href="glossaries-user.html#dx1-57019" >742
    \glslabel  687
    +href="glossaries-user.html#dx1-57012" >743
    \glslabeltok  688
    +href="glossaries-user.html#dx1-72024" >744
    \glsletentryfield  689
    +href="glossaries-user.html#dx1-62034" >745
    + + \glslink  690
    +href="glossaries-user.html#dx1-56004" >746
    \glslink options
        counter  691, 692
    - - +href="glossaries-user.html#dx1-54071" >747, 748
        format  693, 694, 695, 696, 697, 698, 699
    +href="glossaries-user.html#dx1-50004" >749, 750, 751, 752, 753, 754, 755, 756
        hyper  700, 701, 702, 703, 704, 705, 706
    +href="glossaries-user.html#dx1-23101" >757, 758, 759, 760, 761, 762, 763
        local  707
    +href="glossaries-user.html#dx1-54072" >764
    \glslinkcheckfirsthyperhook  708
    +href="glossaries-user.html#dx1-23103" >765
    \glslinkpostsetkeys  709
    +href="glossaries-user.html#dx1-57073" >766
    \glslinkvar  710
    +href="glossaries-user.html#dx1-57028" >767
    \glslistdottedwidth  711
    +href="glossaries-user.html#dx1-79039" >768
    \glslistnavigationitem  712
    +href="glossaries-user.html#dx1-79023" >769
    \glslocalreset  713
    +href="glossaries-user.html#dx1-75004" >770
    \glslocalresetall  714
    +href="glossaries-user.html#dx1-75008" >771
    \glslocalunset  715
    +href="glossaries-user.html#dx1-75006" >772
    \glslocalunsetall  716
    +href="glossaries-user.html#dx1-75010" >773
    \glslongtok  717
    +href="glossaries-user.html#dx1-72025" >774
    \glsmcols  718
    +href="glossaries-user.html#dx1-86015" >775
    \glsmoveentry  719
    +href="glossaries-user.html#dx1-45001" >776
    \GLSname  720
    +href="glossaries-user.html#dx1-56044" >777
    \Glsname  721
    +href="glossaries-user.html#dx1-56043" >778
    \glsname  722
    +href="glossaries-user.html#dx1-56038" >779
    \glsnamefont  723
    +href="glossaries-user.html#dx1-63071" >780
    \glsnavhypertarget  724
    +href="glossaries-user.html#dx1-88030" >781
    \glsnavigation  725
    +href="glossaries-user.html#dx1-88031" >782
    \glsnoexpandfields  726
    +href="glossaries-user.html#dx1-40023" >783
    \glsnoidxdisplayloc  727
    +href="glossaries-user.html#dx1-52022" >784
    \glsnumberlistloop  728
    +href="glossaries-user.html#dx1-52019" >785
    \glsnumlistlastsep  729
    +href="glossaries-user.html#dx1-62067" >786
    \glsnumlistsep  730
    +href="glossaries-user.html#dx1-62066" >787
    \glsopenbrace  731
    +href="glossaries-user.html#dx1-64007" >788
    \glspagelistwidth  732
    +href="glossaries-user.html#dx1-78015" >789
    \glspar  733
    +href="glossaries-user.html#dx1-34022" >790
    \glspatchtabularx  734
    +href="glossaries-user.html#dx1-55008" >791
    \glspercentchar  735
    +href="glossaries-user.html#dx1-64009" >792
    \GLSpl  736
    +href="glossaries-user.html#dx1-55049" >793
    \Glspl  737
    +href="glossaries-user.html#dx1-55048" >794
    \glspl  738
    +href="glossaries-user.html#dx1-55047" >795
    \GLSplural  739
    +href="glossaries-user.html#dx1-56032" >796
    \Glsplural  740
    +href="glossaries-user.html#dx1-56031" >797
    \glsplural  741
    +href="glossaries-user.html#dx1-56028" >798
    \glspluralsuffix  742
    +href="glossaries-user.html#dx1-35001" >799
    \glspostdescription  743
    +href="glossaries-user.html#dx1-78037" >800
    \glspostinline  744
    +href="glossaries-user.html#dx1-87014" >801
    \glspostlinkhook  745
    +href="glossaries-user.html#dx1-57074" >802
    \glsprestandardsort  746
    +href="glossaries-user.html#dx1-26026" >803
    \glsquote  747
    +href="glossaries-user.html#dx1-64014" >804
    + + \glsrefentry  748
    +href="glossaries-user.html#dx1-25005" >805
    \glsreset  749
    +href="glossaries-user.html#dx1-75003" >806
    \glsresetall  750
    - - +href="glossaries-user.html#dx1-75007" >807
    \glsresetentrycounter  751
    +href="glossaries-user.html#dx1-25015" >808
    \glsrestoreLToutput  752
    +href="glossaries-user.html#dx1-82023" >809
    \glssee  753
    +href="glossaries-user.html#dx1-60017" >810
    \glsseeformat  754
    +href="glossaries-user.html#dx1-61002" >811
    \glsseeitemformat  755
    +href="glossaries-user.html#dx1-61011" >812
    \glsseelastsep  756
    +href="glossaries-user.html#dx1-61009" >813
    \glsseesep  757
    +href="glossaries-user.html#dx1-61008" >814
    \glsSetAlphaCompositor  758
    +href="glossaries-user.html#dx1-33019" >815
    \glsSetCompositor  759
    +href="glossaries-user.html#dx1-33018" >816
    \glssetexpandfield  760
    +href="glossaries-user.html#dx1-40007" >817
    \glssetnoexpandfield  761
    +href="glossaries-user.html#dx1-40008" >818
    \GlsSetQuote  762
    +href="glossaries-user.html#dx1-13038" >819
    \glsSetSuffixF  763
    +href="glossaries-user.html#dx1-52009" >820
    \glsSetSuffixFF  764
    +href="glossaries-user.html#dx1-52010" >821
    \glssetwidest  765
    +href="glossaries-user.html#dx1-85049" >822
    \GlsSetWriteIstHook  766
    +href="glossaries-user.html#dx1-53002" >823
    \GlsSetXdyCodePage  767
    +href="glossaries-user.html#dx1-65010" >824
    \GlsSetXdyFirstLetterAfterDigits  768
    +href="glossaries-user.html#dx1-67004" >825
    \GlsSetXdyLanguage  769
    +href="glossaries-user.html#dx1-65007" >826
    \GlsSetXdyLocationClassOrder  770
    +href="glossaries-user.html#dx1-66057" >827
    \GlsSetXdyMinRangeLength  771
    +href="glossaries-user.html#dx1-66062" >828
    +\GlsSetXdyNumberGroupOrder  829
    \glsshorttok  772
    +href="glossaries-user.html#dx1-72026" >830
    \glsshowtarget  773
    +href="glossaries-user.html#dx1-23015" >831
    \glssortnumberfmt  774
    +href="glossaries-user.html#dx1-26017" >832
    \glssubentrycounterlabel  775
    +href="glossaries-user.html#dx1-88067" >833
    \glssubentryitem  776
    +href="glossaries-user.html#dx1-88064" >834
    \GLSsymbol  777
    +href="glossaries-user.html#dx1-56049" >835
    \Glssymbol  778
    +href="glossaries-user.html#dx1-56048" >836
    \glssymbol  779
    +href="glossaries-user.html#dx1-56045" >837
    \glstarget  780
    +href="glossaries-user.html#dx1-88049" >838
    \GLStext  781
    +href="glossaries-user.html#dx1-56011" >839
    \Glstext  782
    +href="glossaries-user.html#dx1-56010" >840
    \glstext  783
    +href="glossaries-user.html#dx1-56007" >841
    \glstextformat  784
    +href="glossaries-user.html#dx1-54025" >842
    \glstextup  785
    +href="glossaries-user.html#dx1-72035" >843
    \glstildechar  786
    +href="glossaries-user.html#dx1-64010" >844
    \glstocfalse  787
    +href="glossaries-user.html#dx1-24003" >845
    \glstoctrue  788
    +href="glossaries-user.html#dx1-24002" >846
    \glstreechildpredesc  789
    +href="glossaries-user.html#dx1-85014" >847
    \glstreegroupheaderfmt  790
    +href="glossaries-user.html#dx1-85006" >848
    \glstreeindent  791
    +href="glossaries-user.html#dx1-85033" >849
    \glstreeitem  792
    +href="glossaries-user.html#dx1-85019" >850
    + + \glstreenamebox  793
    +href="glossaries-user.html#dx1-85054" >851
    \glstreenamefmt  794
    +href="glossaries-user.html#dx1-85004" >852
    \glstreenavigationfmt  795
    +href="glossaries-user.html#dx1-85008" >853
    \glstreepredesc  796
    - - +href="glossaries-user.html#dx1-85011" >854
    \glstreesubitem  797
    +href="glossaries-user.html#dx1-85020" >855
    \glstreesubsubitem  798
    +href="glossaries-user.html#dx1-85021" >856
    \glstype  799
    +href="glossaries-user.html#dx1-57013" >857
    \glsunset  800
    +href="glossaries-user.html#dx1-75005" >858
    \glsunsetall  801
    +href="glossaries-user.html#dx1-75009" >859
    \GlsUseAcrEntryDispStyle  802
    +href="glossaries-user.html#dx1-72031" >860
    \GlsUseAcrStyleDefs  803
    +href="glossaries-user.html#dx1-72032" >861
    \GLSuseri  804
    +href="glossaries-user.html#dx1-56059" >862
    \Glsuseri  805
    +href="glossaries-user.html#dx1-56058" >863
    \glsuseri  806
    +href="glossaries-user.html#dx1-56055" >864
    \GLSuserii  807
    +href="glossaries-user.html#dx1-56064" >865
    \Glsuserii  808
    +href="glossaries-user.html#dx1-56063" >866
    \glsuserii  809
    +href="glossaries-user.html#dx1-56060" >867
    \GLSuseriii  810
    +href="glossaries-user.html#dx1-56069" >868
    \Glsuseriii  811
    +href="glossaries-user.html#dx1-56068" >869
    \glsuseriii  812
    +href="glossaries-user.html#dx1-56065" >870
    \GLSuseriv  813
    +href="glossaries-user.html#dx1-56074" >871
    \Glsuseriv  814
    +href="glossaries-user.html#dx1-56073" >872
    \glsuseriv  815
    +href="glossaries-user.html#dx1-56070" >873
    \GLSuserv  816
    +href="glossaries-user.html#dx1-56079" >874
    \Glsuserv  817
    +href="glossaries-user.html#dx1-56078" >875
    \glsuserv  818
    +href="glossaries-user.html#dx1-56075" >876
    \GLSuservi  819
    +href="glossaries-user.html#dx1-56084" >877
    \Glsuservi  820
    +href="glossaries-user.html#dx1-56083" >878
    \glsuservi  821
    +href="glossaries-user.html#dx1-56080" >879
    \glswrallowprimitivemodsfalse  822
    +href="glossaries-user.html#dx1-51026" >880
    \glswrite  823
    +href="glossaries-user.html#dx1-53003" >881
    \glswriteentry  824
    +href="glossaries-user.html#dx1-23116" >882

    H html package  825
    +href="glossaries-user.html#dx1-58002" >883
    hyperref package  826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848
    +href="glossaries-user.html#dx1-16" >884, 885, 886, 887, 888, 889, 890, 891, 892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906

    I \ifglossaryexists  849
    +href="glossaries-user.html#dx1-91001" >907
    \ifglsdescsuppressed  850
    +href="glossaries-user.html#dx1-91023" >908
    \ifglsentryexists  851
    +href="glossaries-user.html#dx1-91002" >909
    \ifglsfieldcseq  852
    +href="glossaries-user.html#dx1-91034" >910
    \ifglsfielddefeq  853
    +href="glossaries-user.html#dx1-91032" >911
    \ifglsfieldeq  854
    +href="glossaries-user.html#dx1-91029" >912
    + + \ifglshaschildren  855
    +href="glossaries-user.html#dx1-91011" >913
    \ifglshasdesc  856
    +href="glossaries-user.html#dx1-91021" >914
    \ifglshasfield  857
    +href="glossaries-user.html#dx1-91026" >915
    \ifglshaslong  858
    - - +href="glossaries-user.html#dx1-91015" >916
    \ifglshasparent  859
    +href="glossaries-user.html#dx1-91012" >917
    \ifglshasprefix  860
    +href="glossaries-user.html#dx1-93040" >918
    \ifglshasprefixfirst  861
    +href="glossaries-user.html#dx1-93044" >919
    \ifglshasprefixfirstplural  862
    +href="glossaries-user.html#dx1-93046" >920
    \ifglshasprefixplural  863
    +href="glossaries-user.html#dx1-93042" >921
    \ifglshasshort  864
    +href="glossaries-user.html#dx1-91018" >922
    \ifglshassymbol  865
    +href="glossaries-user.html#dx1-91013" >923
    \ifglsucmark  866
    +href="glossaries-user.html#dx1-24030" >924
    \ifglsused  867, 868
    +href="glossaries-user.html#dx1-75011" >925, 926
    \ifignoredglossary  869
    +href="glossaries-user.html#dx1-68012" >927
    imakeidx package  870
    +href="glossaries-user.html#dx1-29022" >928
    index package  871
    +href="glossaries-user.html#dx1-29021" >929
    inputenc package  872, 873, 874, 875, 876, 877
    +href="glossaries-user.html#dx1-11016" >930, 931, 932, 933, 934, 935, 936
    +internal fields:
    +    location  937

    L latex  878, 879
    +href="glossaries-user.html#dx1-26" >938, 939
    latexmk  880
    +href="glossaries-user.html#dx1-16020" >940, 941, 942
    Latin alphabet  881, 882, 883
    +href="glossaries-user.html#dx1-3027" >943, 944, 945
    Latin character  884, 885, 886, 887, 888, 889, 890
    +href="glossaries-user.html#dx1-3004" >946, 947, 948, 949, 950, 951, 952
    link text  891, 892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902, 903, 904, 905, 906, 907, 908, 909, 910, 911, 912, 913, 914, 915, 916, 917, 918, 919, 920, 921, 922, 923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939
    +href="glossaries-user.html#dx1-3031" >953, 954, 955, 956, 957, 958, 959, 960, 961, 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
    \loadglsentries  940
    +href="glossaries-user.html#dx1-44001" >1002
    location list  see number list
    +href="glossaries-user.html#dx1-49004" >number list
    \longnewglossaryentry  942
    +href="glossaries-user.html#dx1-34004" >1004
    \longprovideglossaryentry  943
    +href="glossaries-user.html#dx1-34006" >1005
    longtable package  944, 945
    +href="glossaries-user.html#dx1-25034" >1006, 1007

    M makeglossaries  946, 947, 948, 949, 950, 951, 952, 953, 954, 955, 956, 957, 958, 959, 960, 961, 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, 1011, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030
    +href="glossaries-user.html#dx1-3033" >1008, 1009, 1010, 1011, 1012, 1013, 1014, 1015, 1016, 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
        -d  1031
    +href="glossaries-user.html#dx1-18004" >1089
        -k  1032
    +href="glossaries-user.html#dx1-17015" >1090
        -m  1033
    +href="glossaries-user.html#dx1-17023" >1091
        -Q  1034
    +href="glossaries-user.html#dx1-17014" >1092
        -q  1035
    +href="glossaries-user.html#dx1-17017" >1093
        -x  1036
    +href="glossaries-user.html#dx1-17025" >1094
    \makeglossaries  1037
    +href="glossaries-user.html#dx1-33001" >1095
    makeglossaries-lite.lua  1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046
    +class="cmtt-10">makeglossaries-lite  1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112
    makeglossariesgui  1047, 1048, 1049
    +href="glossaries-user.html#dx1-3036" >1113, 1114, 1115
    + + makeidx package  1050
    +href="glossaries-user.html#dx1-29020" >1116
    makeindex  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, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 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
    +href="glossaries-user.html#dx1-3025" >1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 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
        -g  1158, 1159, 1160
    +href="glossaries-user.html#dx1-7014" >1230, 1231, 1232
        -l  1161, 1162, 1163, 1164
    +href="glossaries-user.html#dx1-7029" >1233, 1234, 1235, 1236, 1237
    \makenoidxglossaries  1165
    - - +href="glossaries-user.html#dx1-32001" >1238
    memoir class  1166, 1167, 1168, 1169
    +href="glossaries-user.html#dx1-24021" >1239, 1240, 1241, 1242
    mfirstuc package  1170, 1171, 1172, 1173, 1174, 1175, 1176
    +href="glossaries-user.html#dx1-7" >1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250
    multicol package  1177
    +href="glossaries-user.html#dx1-86004" >1251
    mwe package  1178
    +href="glossaries-user.html#dx1-12008" >1252

    N nameref package  1179
    +href="glossaries-user.html#dx1-24049" >1253
    \newacronym  1180
    +href="glossaries-user.html#dx1-69007" >1254
    \newacronymstyle  1181
    +href="glossaries-user.html#dx1-72001" >1255
    \newglossary  1182
    +href="glossaries-user.html#dx1-68001" >1256
    \newglossary*  1183
    +href="glossaries-user.html#dx1-68007" >1257
    \newglossaryentry  1184
    +href="glossaries-user.html#dx1-34003" >1258
    \newglossaryentry options
        access  1185
    +href="glossaries-user.html#dx1-94003" >1259
        description  1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203
    +href="glossaries-user.html#dx1-12009" >1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277
        descriptionaccess  1204
    +href="glossaries-user.html#dx1-94017" >1278
        descriptionplural  1205, 1206, 1207, 1208
    +href="glossaries-user.html#dx1-34025" >1279, 1280, 1281, 1282
        descriptionpluralaccess  1209
    +href="glossaries-user.html#dx1-94019" >1283
        entrycounter  1210, 1211
    +href="glossaries-user.html#dx1-63035" >1284, 1285
        first  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
    +href="glossaries-user.html#dx1-3020" >1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310
        firstaccess  1237
    +href="glossaries-user.html#dx1-94007" >1311
        firstplural  1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
    +href="glossaries-user.html#dx1-3021" >1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328
        firstpluralaccess  1255
    +href="glossaries-user.html#dx1-94011" >1329
        format  1256
    +href="glossaries-user.html#dx1-54068" >1330
        long  1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269
    +href="glossaries-user.html#dx1-23108" >1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343
        longaccess  1270
    +href="glossaries-user.html#dx1-94021" >1344
        longplural  1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279
    +href="glossaries-user.html#dx1-34128" >1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353
        longpluralaccess  1280
    +href="glossaries-user.html#dx1-94027" >1354
        name  1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315
    +href="glossaries-user.html#dx1-12006" >1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390
        nonumberlist  1316
    +href="glossaries-user.html#dx1-34106" >1391
        parent  1317, 1318, 1319, 1320
    +href="glossaries-user.html#dx1-34012" >1392, 1393, 1394, 1395
        plural  1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335
    +href="glossaries-user.html#dx1-34040" >1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410
        pluralaccess  1336
    +href="glossaries-user.html#dx1-94009" >1411
        prefix  1337, 1338, 1339, 1340, 1341, 1342, 1343
    +href="glossaries-user.html#dx1-93003" >1412, 1413, 1414, 1415, 1416, 1417, 1418
        prefixfirst  1344, 1345, 1346, 1347, 1348
    +href="glossaries-user.html#dx1-93007" >1419, 1420, 1421, 1422, 1423
        prefixfirstplural  1349, 1350, 1351, 1352, 1353
    +href="glossaries-user.html#dx1-93010" >1424, 1425, 1426, 1427, 1428
        prefixplural  1354, 1355, 1356, 1357, 1358, 1359
    +href="glossaries-user.html#dx1-93005" >1429, 1430, 1431, 1432, 1433, 1434
    + +     see  1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375
    +href="glossaries-user.html#dx1-23018" >1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453
        short  1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386
    +href="glossaries-user.html#dx1-34129" >1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464
        shortaccess  1387
    +href="glossaries-user.html#dx1-94024" >1465
        shortplural  1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396
    +href="glossaries-user.html#dx1-34130" >1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474
        shortpluralaccess  1397
    +href="glossaries-user.html#dx1-94030" >1475
        sort  1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429
    - - +href="glossaries-user.html#dx1-3050" >1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509
        subentrycounter  1430
    +href="glossaries-user.html#dx1-63036" >1510
        symbol  1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442
    +href="glossaries-user.html#dx1-12004" >1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523
        symbolaccess  1443
    +href="glossaries-user.html#dx1-94013" >1524
        symbolplural  1444, 1445, 1446
    +href="glossaries-user.html#dx1-34064" >1525, 1526, 1527
        symbolpluralaccess  1447
    +href="glossaries-user.html#dx1-94015" >1528
        text  1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468
    +href="glossaries-user.html#dx1-34027" >1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549
        textaccess  1469
    +href="glossaries-user.html#dx1-94005" >1550
        type  1470, 1471, 1472
    +href="glossaries-user.html#dx1-34096" >1551, 1552, 1553
        user1  1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483
    +href="glossaries-user.html#dx1-12007" >1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564
        user2  1484, 1485, 1486, 1487
    +href="glossaries-user.html#dx1-34100" >1565, 1566, 1567, 1568
        user3  1488, 1489, 1490
    +href="glossaries-user.html#dx1-34101" >1569, 1570, 1571
        user4  1491, 1492, 1493
    +href="glossaries-user.html#dx1-34102" >1572, 1573, 1574
        user5  1494, 1495, 1496
    +href="glossaries-user.html#dx1-34103" >1575, 1576, 1577
        user6  1497, 1498, 1499, 1500
    +href="glossaries-user.html#dx1-34099" >1578, 1579, 1580, 1581
    \newglossarystyle  1501
    +href="glossaries-user.html#dx1-88001" >1582
    \newignoredglossary  1502
    +href="glossaries-user.html#dx1-68010" >1583
    \newterm  1503
    +href="glossaries-user.html#dx1-29012" >1584
    ngerman package  1504, 1505, 1506, 1507, 1508
    +href="glossaries-user.html#dx1-13031" >1585, 1586, 1587, 1588
    \noist  1509
    +href="glossaries-user.html#dx1-33008" >1589
    Non-Latin Alphabet  1510
    +href="glossaries-user.html#dx1-3042" >1590
    non-Latin character  1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521
    +href="glossaries-user.html#dx1-3009" >1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599, 1600, 1601
    \nopostdesc  1522
    +href="glossaries-user.html#dx1-34021" >1602
    number list  1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573
    +href="glossaries-user.html#dx1-3047" >1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619, 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

    O \oldacronym  1574
    +href="glossaries-user.html#dx1-74004" >1670

    P package options:
        acronym  1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598
    +href="glossaries-user.html#dx1-14026" >1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694
            true  1599, 1600
    +href="glossaries-user.html#dx1-22002" >1695, 1696
        acronymlists  1601, 1602, 1603, 1604, 1605, 1606, 1607
    +href="glossaries-user.html#dx1-27019" >1697, 1698, 1699, 1700, 1701, 1702, 1703
        acronyms  1608, 1609
    +href="glossaries-user.html#dx1-23028" >1704, 1705
        automake  1610, 1611, 1612
    +href="glossaries-user.html#dx1-7006" >1706, 1707, 1708, 1709
    + +         false  1613
    +href="glossaries-user.html#dx1-26090" >1710
        compatible-2.07  1614, 1615, 1616
    +href="glossaries-user.html#dx1-29027" >1711, 1712, 1713
        compatible-3.07  1617, 1618, 1619
    +href="glossaries-user.html#dx1-27004" >1714, 1715, 1716
        counter  1620, 1621, 1622, 1623, 1624
    +href="glossaries-user.html#dx1-25083" >1717, 1718, 1719, 1720, 1721
            page  1625
    +href="glossaries-user.html#dx1-25084" >1722
        counterwithin  1626, 1627, 1628, 1629, 1630
    - - +href="glossaries-user.html#dx1-25009" >1723, 1724, 1725, 1726, 1727
        debug  1631, 1632, 1633
    +href="glossaries-user.html#dx1-23008" >1728, 1729, 1730
    +        false  1731
            showtargets  1634, 1635, 1636
    +href="glossaries-user.html#dx1-23004" >1732, 1733, 1734
            true  1637, 1638, 1639
    +href="glossaries-user.html#dx1-23003" >1735, 1736, 1737
        description  1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648
    +href="glossaries-user.html#dx1-28002" >1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746
        dua  1649, 1650
    +href="glossaries-user.html#dx1-28011" >1747, 1748
        entrycounter  1651, 1652, 1653, 1654, 1655
    +href="glossaries-user.html#dx1-25001" >1749, 1750, 1751, 1752, 1753
    +        false  1754
    +        true  1755
    +    esclocations  1756
            false  1656
    +href="glossaries-user.html#dx1-25064" >1757, 1758
            true  1657
    +href="glossaries-user.html#dx1-25059" >1759
        footnote  1658, 1659, 1660, 1661, 1662, 1663
    +href="glossaries-user.html#dx1-28006" >1760, 1761, 1762, 1763, 1764, 1765
        hyperfirst  1664, 1665, 1666, 1667
    +href="glossaries-user.html#dx1-23088" >1766, 1767, 1768, 1769
            false  1668, 1669, 1670, 1671, 1672
    +href="glossaries-user.html#dx1-23102" >1770, 1771, 1772, 1773, 1774
            true  1673, 1674
    +href="glossaries-user.html#dx1-23089" >1775, 1776
        index  1675, 1676, 1677, 1678, 1679
    +href="glossaries-user.html#dx1-23031" >1777, 1778, 1779, 1780, 1781
        indexonlyfirst  1680, 1681
    +href="glossaries-user.html#dx1-23112" >1782, 1783, 1784
            false  1682
    +href="glossaries-user.html#dx1-23113" >1785
        makeindex  1683, 1684, 1685
    +href="glossaries-user.html#dx1-22004" >1786, 1787, 1788
        ngerman  1686
    +href="glossaries-user.html#dx1-13034" >1789
        nogroupskip  1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694
    +href="glossaries-user.html#dx1-11018" >1790, 1791, 1792, 1793, 1794, 1795, 1796, 1797
            false  1695
    +href="glossaries-user.html#dx1-25089" >1798
        nohypertypes  1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704
    +href="glossaries-user.html#dx1-23084" >1799, 1800, 1801, 1802, 1803, 1804, 1805, 1806, 1807
            index  1705
    +href="glossaries-user.html#dx1-29024" >1808
    +    nolangwarn  1809, 1810
        nolist  1706, 1707, 1708
    +href="glossaries-user.html#dx1-25040" >1811, 1812, 1813
        nolong  1709, 1710, 1711, 1712
    +href="glossaries-user.html#dx1-25032" >1814, 1815, 1816, 1817
        nomain  1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720
    +href="glossaries-user.html#dx1-23026" >1818, 1819, 1820, 1821, 1822, 1823, 1824, 1825
        nonumberlist  1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728, 1729
    +href="glossaries-user.html#dx1-3048" >1826, 1827, 1828, 1829, 1830, 1831, 1832, 1833, 1834, 1835
        nopostdot  1730, 1731
    +href="glossaries-user.html#dx1-25086" >1836, 1837
            false  1732
    +href="glossaries-user.html#dx1-25087" >1838
        noredefwarn  1733
    +href="glossaries-user.html#dx1-23006" >1839
        nostyles  1734, 1735, 1736, 1737, 1738, 1739, 1740
    +href="glossaries-user.html#dx1-25052" >1840, 1841, 1842, 1843, 1844, 1845, 1846
        nosuper  1741, 1742, 1743, 1744
    +href="glossaries-user.html#dx1-25036" >1847, 1848, 1849, 1850
        notranslate  1745, 1746, 1747
    +href="glossaries-user.html#dx1-14010" >1851, 1852, 1853
        notree  1748, 1749, 1750, 1751
    +href="glossaries-user.html#dx1-25046" >1854, 1855, 1856, 1857
        nowarn  1752, 1753, 1754
    +href="glossaries-user.html#dx1-23001" >1858, 1859, 1860
        numberedsection  1755, 1756, 1757, 1758, 1759
    +href="glossaries-user.html#dx1-24035" >1861, 1862, 1863, 1864, 1865
            autolabel  1760, 1761
    +href="glossaries-user.html#dx1-24039" >1866, 1867
    + +         false  1762
    +href="glossaries-user.html#dx1-24037" >1868
            nameref  1763
    +href="glossaries-user.html#dx1-24045" >1869
            nolabel  1764
    +href="glossaries-user.html#dx1-24038" >1870
        numberline  1765, 1766
    +href="glossaries-user.html#dx1-24004" >1871, 1872
        numbers  1767, 1768, 1769
    +href="glossaries-user.html#dx1-23030" >1873, 1874, 1875
        order  1770, 1771, 1772
    +href="glossaries-user.html#dx1-26047" >1876, 1877, 1878
            letter  1773, 1774, 1775, 1776
    +href="glossaries-user.html#dx1-7034" >1879, 1880, 1881, 1882, 1883
            word  1777, 1778, 1779
    +href="glossaries-user.html#dx1-11060" >1884, 1885, 1886
    +    record  1887
        sanitizesort  1780, 1781, 1782
    +href="glossaries-user.html#dx1-5006" >1888, 1889, 1890
            false  1783, 1784, 1785, 1786, 1787, 1788
    +href="glossaries-user.html#dx1-6001" >1891, 1892, 1893, 1894, 1895, 1896
            true  1789, 1790, 1791, 1792, 1793, 1794, 1795, 1796
    - - +href="glossaries-user.html#dx1-6003" >1897, 1898, 1899, 1900, 1901, 1902, 1903, 1904, 1905
        savenumberlist  1797, 1798
    +href="glossaries-user.html#dx1-23118" >1906, 1907
            false  1799
    +href="glossaries-user.html#dx1-23120" >1908
        savewrites  1800, 1801, 1802
    +href="glossaries-user.html#dx1-23040" >1909, 1910, 1911
            false  1803
    +href="glossaries-user.html#dx1-23041" >1912
        section  1804, 1805
    +href="glossaries-user.html#dx1-24011" >1913, 1914
        seeautonumberlist  1806, 1807, 1808, 1809
    +href="glossaries-user.html#dx1-25074" >1915, 1916, 1917, 1918
        seenoindex  1810
    +href="glossaries-user.html#dx1-23021" >1919, 1920
            ignore  1811
    +href="glossaries-user.html#dx1-23025" >1921
            warn  1812
    +href="glossaries-user.html#dx1-23024" >1922
        shortcuts  1813, 1814
    +href="glossaries-user.html#dx1-27026" >1923, 1924
        smallcaps  1815, 1816, 1817, 1818, 1819, 1820
    +href="glossaries-user.html#dx1-28004" >1925, 1926, 1927, 1928, 1929, 1930
        smaller  1821, 1822, 1823, 1824, 1825
    +href="glossaries-user.html#dx1-28005" >1931, 1932, 1933, 1934, 1935
        sort  1826
    +href="glossaries-user.html#dx1-26001" >1936
            def  1827, 1828, 1829, 1830, 1831, 1832, 1833, 1834, 1835, 1836
    +href="glossaries-user.html#dx1-6006" >1937, 1938, 1939, 1940, 1941, 1942, 1943, 1944, 1945, 1946, 1947
            none  1837
    +href="glossaries-user.html#dx1-5009" >1948, 1949, 1950, 1951
            standard  1838, 1839, 1840
    +href="glossaries-user.html#dx1-26006" >1952, 1953, 1954
            use  1841, 1842, 1843, 1844, 1845, 1846, 1847, 1848, 1849
    +href="glossaries-user.html#dx1-6005" >1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965
        style  1850, 1851, 1852, 1853, 1854, 1855, 1856, 1857
    +href="glossaries-user.html#dx1-25024" >1966, 1967, 1968, 1969, 1970, 1971, 1972, 1973
            index  1858
    +href="glossaries-user.html#dx1-25027" >1974
            list  1859
    +href="glossaries-user.html#dx1-25025" >1975
        subentrycounter  1860, 1861, 1862, 1863, 1864, 1865
    +href="glossaries-user.html#dx1-25018" >1976, 1977, 1978, 1979, 1980, 1981
            false  1866
    +href="glossaries-user.html#dx1-25019" >1982
        symbols  1867, 1868, 1869
    +href="glossaries-user.html#dx1-23029" >1983, 1984, 1985
        toc  1870, 1871, 1872, 1873, 1874
    +href="glossaries-user.html#dx1-7038" >1986, 1987, 1988, 1989, 1990, 1991
        translate  1875, 1876, 1877, 1878
    +href="glossaries-user.html#dx1-23051" >1992, 1993, 1994, 1995
            babel  1879, 1880, 1881, 1882, 1883, 1884
    +href="glossaries-user.html#dx1-14012" >1996, 1997, 1998, 1999, 2000, 2001
            false  1885, 1886, 1887, 1888
    +href="glossaries-user.html#dx1-14011" >2002, 2003, 2004, 2005
            true  1889, 1890, 1891, 1892
    +href="glossaries-user.html#dx1-23052" >2006, 2007, 2008, 2009
        ucfirst  1893
    +href="glossaries-user.html#dx1-24032" >2010
        ucmark  1894, 1895
    +href="glossaries-user.html#dx1-24017" >2011, 2012
            false  1896
    +href="glossaries-user.html#dx1-24020" >2013
            true  1897
    +href="glossaries-user.html#dx1-24022" >2014
        xindy  1898, 1899, 1900, 1901, 1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909, 1910, 1911
    +href="glossaries-user.html#dx1-8015" >2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028
        xindygloss  1912, 1913
    +href="glossaries-user.html#dx1-26072" >2029, 2030
    + +     xindynoglsnumbers  1914, 1915
    +href="glossaries-user.html#dx1-26076" >2031, 2032
    page (counter)  1916
    +href="glossaries-user.html#dx1-66036" >2033, 2034
    page type precedence  1917
    +href="glossaries-user.html#dx1-53005" >2035
    pdflatex  1918, 1919
    +href="glossaries-user.html#dx1-25" >2036, 2037
    \PGLS  1920
    +href="glossaries-user.html#dx1-93027" >2038
    \Pgls  1921
    +href="glossaries-user.html#dx1-93023" >2039
    \pgls  1922
    +href="glossaries-user.html#dx1-93020" >2040
    \PGLSpl  1923
    +href="glossaries-user.html#dx1-93036" >2041
    \Pglspl  1924
    +href="glossaries-user.html#dx1-93032" >2042
    \pglspl  1925
    +href="glossaries-user.html#dx1-93029" >2043
    pod2man  1926
    +href="glossaries-user.html#dx1-17036" >2044
    polyglossia package  1927, 1928, 1929, 1930, 1931, 1932, 1933
    - - +href="glossaries-user.html#dx1-14002" >2045, 2046, 2047, 2048, 2049, 2050, 2051
    \printacronyms  1934
    +href="glossaries-user.html#dx1-27002" >2052
    \printglossaries  1935
    +href="glossaries-user.html#dx1-63003" >2053
    \printglossary  1936
    +href="glossaries-user.html#dx1-63014" >2054
    \printglossary options
        entrycounter  1937
    +href="glossaries-user.html#dx1-63032" >2055
        nogroupskip  1938
    +href="glossaries-user.html#dx1-63030" >2056
        nonumberlist  1939
    +href="glossaries-user.html#dx1-63029" >2057
        nopostdot  1940
    +href="glossaries-user.html#dx1-63031" >2058
        numberedsection  1941
    +href="glossaries-user.html#dx1-63026" >2059
        style  1942, 1943, 1944, 1945, 1946
    +href="glossaries-user.html#dx1-25056" >2060, 2061, 2062, 2063, 2064
        subentrycounter  1947
    +href="glossaries-user.html#dx1-63034" >2065
        title  1948, 1949, 1950
    +href="glossaries-user.html#dx1-5" >2066, 2067, 2068, 2069, 2070
        toctitle  1951
    +href="glossaries-user.html#dx1-63020" >2071
        type  1952, 1953
    +href="glossaries-user.html#dx1-63016" >2072, 2073
    \printindex  1954
    +href="glossaries-user.html#dx1-29015" >2074
    \printnoidxglossaries  1955
    +href="glossaries-user.html#dx1-63001" >2075
    \printnoidxglossary  1956
    +href="glossaries-user.html#dx1-63012" >2076
    \printnoidxglossary options
        sort  1957, 1958, 1959, 1960
    +href="glossaries-user.html#dx1-26002" >2077, 2078, 2079, 2080
    \printnumbers  1961
    +href="glossaries-user.html#dx1-29007" >2081
    \printsymbols  1962
    +href="glossaries-user.html#dx1-29002" >2082
    \provideglossaryentry  1963
    +href="glossaries-user.html#dx1-34005" >2083

    R relsize package  1964, 1965
    +href="glossaries-user.html#dx1-28019" >2084, 2085

    S sanitize  1966, 1967, 1968, 1969, 1970
    +href="glossaries-user.html#dx1-3049" >2086, 2087, 2088, 2089, 2090
    scrwfile package  1971
    +href="glossaries-user.html#dx1-23044" >2091
    \SetAcronymLists  1972
    +href="glossaries-user.html#dx1-27024" >2092
    \setacronymstyle  1973
    +href="glossaries-user.html#dx1-70001" >2093
    \setglossarypreamble  1974
    +href="glossaries-user.html#dx1-63062" >2094
    + + \setglossarysection  1975
    +href="glossaries-user.html#dx1-24012" >2095
    \setglossarystyle  1976
    +href="glossaries-user.html#dx1-77004" >2096
    \setStyleFile  1977
    +href="glossaries-user.html#dx1-33015" >2097
    \setupglossaries  1978
    +href="glossaries-user.html#dx1-30001" >2098
    +stix package  2099
    \subglossentry  1979
    +href="glossaries-user.html#dx1-88062" >2100
    supertabular package  1980, 1981, 1982
    +href="glossaries-user.html#dx1-25038" >2101, 2102, 2103

    T tabularx package  1983, 1984, 1985, 1986
    +href="glossaries-user.html#dx1-55005" >2104, 2105, 2106, 2107
    textcase package  1987, 1988, 1989
    +href="glossaries-user.html#dx1-10" >2108, 2109, 2110
    theglossary (environment)  1990
    - - +href="glossaries-user.html#dx1-88002" >2111
    tracklang package  1991, 1992, 1993
    +href="glossaries-user.html#dx1-6" >2112, 2113, 2114
    translator package  1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018
    +href="glossaries-user.html#dx1-14009" >2115, 2116, 2117, 2118, 2119, 2120, 2121, 2122, 2123, 2124, 2125, 2126, 2127, 2128, 2129, 2130, 2131, 2132, 2133, 2134, 2135, 2136, 2137, 2138, 2139

    X xfor package  2019
    +href="glossaries-user.html#dx1-11" >2140
    xindy  2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039, 2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062, 2063, 2064, 2065, 2066, 2067, 2068, 2069, 2070, 2071, 2072, 2073, 2074, 2075, 2076, 2077, 2078, 2079, 2080, 2081, 2082, 2083, 2084, 2085, 2086, 2087, 2088, 2089, 2090, 2091, 2092, 2093, 2094, 2095, 2096, 2097, 2098, 2099, 2100, 2101, 2102, 2103, 2104, 2105, 2106, 2107, 2108, 2109, 2110, 2111, 2112, 2113, 2114, 2115, 2116, 2117, 2118, 2119, 2120, 2121, 2122, 2123, 2124, 2125, 2126, 2127, 2128, 2129, 2130, 2131, 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, 2157, 2158
    +href="glossaries-user.html#dx1-3026" >2141, 2142, 2143, 2144, 2145, 2146, 2147, 2148, 2149, 2150, 2151, 2152, 2153, 2154, 2155, 2156, 2157, 2158, 2159, 2160, 2161, 2162, 2163, 2164, 2165, 2166, 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
        -C  2159, 2160, 2161, 2162, 2163
    +href="glossaries-user.html#dx1-8025" >2295, 2296, 2297, 2298, 2299
        -I  2164, 2165
    +href="glossaries-user.html#dx1-19007" >2300, 2301
        -L  2166, 2167, 2168, 2169
    +href="glossaries-user.html#dx1-8024" >2302, 2303, 2304, 2305
        -M  2170
    +href="glossaries-user.html#dx1-16087" >2306
    xkeyval package  2171, 2172, 2173
    +href="glossaries-user.html#dx1-9" >2307, 2308, 2309
    xspace package  2174, 2175, 2176, 2177, 2178, 2179, 2180
    +href="glossaries-user.html#dx1-74014" >2310, 2311, 2312, 2313, 2314, 2315, 2316

    -

    1.1That is, if the term has been referenced using any of the commands described in §§6 Links to Glossary @@ -27912,7 +30338,7 @@ class="cmr-8">Links to Glossary class="cmr-8">Entries and §§7 Adding an Entry to the Glossary Without Generating Text 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 in this section, it’s better to use the reasons given earlier.

    -

    1.3

    1.4deprecated, use babel instead

    +

    1.5Added to version makeglossaries 2.18.

    -

    1.4

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

    -

    1.7The batch file makeglossaries.bat has been removed since the TEX distributions for Windows +provide makeglossaries.exe.

    +

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

    -

    2.2unless memoir is loaded, which case it uses \markboth

    -

    +

    2.3Actually it uses \mfirstucMakeUppercase which is set to textcase’s \MakeTextUppercase by the glossaries package. This makes it consistent with \makefirstuc. (The textcase package is automatically loaded by glossaries.)

    -

    2.4Actually it sets \acronymtype to \glsdefaulttype if the acronym package option is not used, but \glsdefaulttype usually has the value main unless the nomain option has been used.

    -

    4.1The glossaries-extra package provides a simpler way of achieving this.

    -

    4.2This is because \acronymtype is set to \glsdefaulttype if the acronym package option is not used.

    5.1This feature was introduced in makeglossaries version 2.18.

    -

    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.2

    6.3\glsdisplayfirst and \glsdisplay are now deprecated. Backwards compatibility should be preserved 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, keep the default value of the optional argument as \seename as both see and \glssee explicitly write [\seename] in the output file if no optional argument is given.

    -

    8.3In versions before 3.0, \glsentryname was used, but this could cause problems when the name key was sanitized.

    .

    9.1versions before 3.0 used \glsentryname as the default, but this could cause problems when name had been sanitized.

    .

    10.1you can’t use the longheaderborder style for this example as you can’t use the longtable environment in two column mode.

    two column mode.

    11.1see \setCompositor \glsSetCompositor described in §§3 Setting Up

    -

    11.2see \setAlphaCompositor \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 nolong and nosuper package options or if you use 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 a579066cfb0..5cdfa0b4384 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 d2680063891..33663add251 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -5,6 +5,8 @@ \usepackage{array} \usepackage{alltt} \usepackage{pifont} +\usepackage{textcomp} +\usepackage{amssymb} \ifpdf \usepackage{lmodern} \usepackage{mathpazo} @@ -18,6 +20,7 @@ \fi \usepackage[colorlinks, bookmarks, + linkcolor=blue, hyperindex=false, pdfauthor={Nicola L.C. Talbot}, pdftitle={User Manual for glossaries.sty}, @@ -122,7 +125,20 @@ name={\appfmt{makeindex}\index{makeindex=\appfmt{makeindex}|htextbf}},% sort={makeindex},% text={\appfmt{makeindex}\iapp{makeindex}},% -description={An \gls{indexingapp}.}, +description={An \gls{indexingapp}.} +} + +\newglossaryentry{bib2gls}{% +name={\appfmt{bib2gls}\index{bib2gls=\appfmt{bib2gls}|htextbf}},% +sort={bib2gls},% +text={\appfmt{bib2gls}\iapp{bib2gls}},% +description={An \gls{indexingapp} that combines two functions in +one: (1) fetches entry definition from a \texttt{.bib} file +based on information provided in the \texttt{.aux} file (similar +to \appfmt{bibtex}); (2) hierarchically sorts and collates location +lists (similar to \appfmt{makeindex} and \appfmt{xindy}). +This application is designed for use with \styfmt{glossaries-extra} +and can't be used with just the base \styfmt{glossaries} package.} } \newglossaryentry{makeglossaries}{% @@ -131,18 +147,22 @@ sort={makeglossaries},% text={\appfmt{makeglossaries}\iapp{makeglossaries}},% description={A custom designed Perl script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} -package.} +package. \TeX\ distributions on Windows convert the original +\texttt{makeglossaries} script into an executable +\texttt{makeglossaries.exe} for convenience.} } \newglossaryentry{makeglossaries-lite.lua}{% -name={\appfmt{makeglossaries-lite.lua}\index{makeglossaries-lite.lua=\appfmt{makeglossaries-lite.lua}|htextbf}},% -sort={makeglossaries-lite.lua},% -text={\appfmt{makeglossaries-lite.lua}\iapp{makeglossaries-lite.lua}},% +name={\appfmt{makeglossaries-lite}\index{makeglossaries-lite=\appfmt{makeglossaries-lite}|htextbf}},% +sort={makeglossaries-lite},% +text={\appfmt{makeglossaries-lite}\iapp{makeglossaries-lite}},% description={A custom designed Lua script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} package. This is a cut-down alternative to the Perl \appfmt{makeglossaries} script. If you have Perl installed, use the -Perl script instead. Note that \TeX~Live creates a symbolic link +Perl script instead. This script is actually distributed with the +file name \texttt{makeglossaries-lite.lua}, but \TeX~Live +(on Unix-like systems) creates a symbolic link called \texttt{makeglossaries-lite} (without the \texttt{.lua} extension) to the actual \texttt{makeglossaries-lite.lua} script.} } @@ -338,11 +358,38 @@ user2={sanitization\protect\iterm{sanitize}}% \newcommand*{\yes}{\ding{52}} \newcommand*{\no}{\ding{56}} +\newcommand*{\proyes}{\textcolor{green}{\yes}} +\newcommand*{\prono}{\textcolor{red}{\no}} + +\newcommand*{\conyes}{\textcolor{red}{\yes}} +\newcommand*{\conno}{\textcolor{green}{\no}} + \makeatletter +\newcommand{\fnsymmark}[1]{#1} +\newcommand*{\fnsym}[1]{\textsuperscript{\fnsymmark{% + \ifcase#1\or \textasteriskcentered \or \textdagger + \or \textdaggerdbl \or \textsection + \or $\lozenge$ \or \textparagraph + \or \#\or {\fontfamily{cmr}\selectfont\textreferencemark}% + \or \shortstack{*\\[-1.5ex]*}% + \or $\star$ + \or \ding{94}% + \else + \number#1 + \fi +}}}% \newcommand*{\optionlabel}[1]{% - \@glstarget{option#1}{}\textbf{Option~#1}} + \@glstarget{option#1}{Option~#1}} \makeatother +\newcounter{option} +\newcommand{\optionsec}[2][\opttitle]{% + \def\opttitle{\appfmt{#2}}% + \refstepcounter{option}% + \pdfbookmark[2]{Option~\theoption\space (#2)}{option\theoption}% + \subsection*{\protect\optionlabel{\theoption} (#1)}% +} + \newcommand*{\opt}[1]{\hyperlink{option#1}{Option~#1}} \newcommand*{\optsor}[2]{Options~\hyperlink{option#1}{#1} or~\hyperlink{option#2}{#2}} @@ -371,6 +418,8 @@ and~\hyperlink{option#2}{#2}} \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} +\newcommand*{\optfmt}[1]{\textsf{#1}} +\newcommand*{\field}[1]{\optfmt{#1}\index{internal fields:>#1=\protect\optfmt{#1}|main}} \newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles:>#1={\protect\ttfamily#1}|main}} @@ -398,11 +447,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.32} + \title{User Manual for glossaries.sty v4.33} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2017-08-24} + \date{2017-09-20} \maketitle \begin{abstract} @@ -415,17 +464,24 @@ Additional features not provided here may be available through the supplemental package \gls{glossaries-extra} which, if required, needs to be installed separately. New features will be added to \gls*{glossaries-extra}. Versions of the \styfmt{glossaries} -package after v4.21 will mostly be just bug fixes. +package after v4.21 will mostly be just bug fixes. Note that +\gls{glossaries-extra} provides an extra indexing option +(\gls{bib2gls}) which isn't available with just the base +\sty{glossaries} package. \end{abstract} If you require multilingual support you must also separately install -the relevant language module. Each language module is called -\texttt{glossaries-}\meta{language}, where \meta{language} is the +the relevant language module. Each language module is distributed +under the name \texttt{glossaries-}\meta{language}, where \meta{language} is the root language name. For example, \texttt{glossaries-french} or \texttt{glossaries-german}. If a language module is required, the \styfmt{glossaries} package will automatically try to load it and will give a warning if the module isn't found. See \sectionref{sec:languages} for further details. +If there isn't any support available for your language, use +the \pkgopt{nolangwarn} package option to suppress the warning +and provide your own translations. (For example, use +the \gloskey[printglossary]{title} key in \cs{printglossary}.) The \styfmt{glossaries} package requires a number of other packages including, but not limited to, \sty{tracklang}, \sty{mfirstuc}, @@ -480,7 +536,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.32}. +\qt{Documented Code for glossaries v4.33}. \item[INSTALL] Installation instructions. @@ -506,6 +562,8 @@ Nomenclature, Lists of Symbols and Acronyms} \item The \href{http://ctan.org/pkg/glossaries-extra}{\styfmt{glossaries-extra} package} + +\item \href{http://ctan.org/pkg/bib2gls}{\appfmt{bib2gls}} \end{itemize} \begin{important} @@ -549,7 +607,7 @@ user to customize the format of the glossary and define multiple glossaries. It also supports glossary styles that include symbols (in addition to a name and description) for glossary entries. There is provision for loading a database of glossary -terms. Only those terms used\footnote{That is, if the term has been +terms. Only those terms indexed\footnote{That is, if the term has been referenced using any of the commands described in \sectionref{sec:glslink} and \sectionref{sec:glsadd} or via \ics{glssee} (or the \gloskey{see} key) or commands such as @@ -573,69 +631,254 @@ a~requirement but it does increase the available options, particularly if you use an \gls{exlatinalph} or a~\gls{nonlatinalph}. \end{important} +This document uses the \styfmt{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 \qt{\gls{xindy}} you'll be taken to the entry +in the glossary where there's a brief description of +the term \qt{\gls*{xindy}}. This is the way the \styfmt{glossaries} +mechanism works. An \gls{indexingapp} is used to generated the +sorted list of terms. The \glspl{indexingapp} are \gls{cli} tools, +which means they can be run directly from a command prompt or terminal, or can +be integrated into some text editors, or you can use a build tool +such as \app{arara} to run them. + +The remainder of this introductory section covers the following: +\begin{itemize} +\item \sectionref{sec:indexingoptions} lists the available indexing +options. + +\item \sectionref{sec:samples} lists the sample documents provided +with this package. + +\item \sectionref{sec:lipsum} lists the dummy glossary files that +may be used for testing. + +\item \sectionref{sec:languages} provides information for users who +wish to write in a language other than English. + +\item \sectionref{sec:makeglossaries} describes how to use an +\gls{indexingapp} to create the sorted glossaries for your document +(\optsor23). + +\end{itemize} + +\section{Indexing Options} +\label{sec:indexingoptions} + The basic idea behind the \styfmt{glossaries} package is that you first define your entries (terms, symbols or abbreviations). Then you can reference these within your document (like \cs{cite} or \cs{ref}). You can also, optionally, display a~list of the entries you have referenced in your document (the glossary). This last part, displaying the glossary, is the part that most new users find -difficult. There are three options: +difficult. There are three options available with the base +\styfmt{glossaries} package and two further options with the +extension package \gls{glossaries-extra}. +An overview of these options is given in +\tableref{tab:options}. -\begin{description} -\item[]\optionlabel1: - - This is the simplest option but it's slow and if - you want a sorted list, it doesn't work well for \glspl{exlatinalph} or - \glspl{nonlatinalph}. However, if you use the - \pkgopt[false]{sanitizesort} package option (the default for - Option~1) then the \glslink{latexexlatinchar}{standard \LaTeX\ accent commands} will be - ignored, so if an entry's name is set to \verb|{\'e}lite| then the - sort will default to \texttt{elite} if - \pkgopt[false]{sanitizesort} is used - and will default to \verb|\'elite| if \pkgopt[true]{sanitizesort} - is used. - - This option works best with the \pkgopt[def]{sort} setting. For any - other setting, be prepared for a long document build time, - especially if you have a lot of entries defined. \textbf{This -option is intended as a last resort for alphabetical sorting.} -This option is not suitable for hierarchical glossaries. +If you are developing a class or package that loads +\styfmt{glossaries}, I recommend that you don't force the user into +a particular indexing method by adding an unconditional \cs{makeglossaries} +into your class or package code. Aside from forcing the user into a +particular indexing method, it means that they're unable to use any +commands that must come before \cs{makeglossaries} (such as +\cs{newglossary}) and they can't switch off the indexing whilst +working on a draft document. - \begin{enumerate} - \item Add \cs{makenoidxglossaries} to your preamble (before you - start defining your entries, as described in - \sectionref{sec:newglosentry}). +\begin{table}[htbp] + \caption{Glossary Options: Pros and Cons} + \label{tab:options} + {% + \renewcommand{\fnsymmark}[1]{\rlap{#1}}% + \setlength{\tabcolsep}{3pt}% + \centering + \begin{tabular}{@{}>{\raggedright\small}p{0.35\textwidth}ccccc@{}} + & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3 + & \bfseries \opt4 & \bfseries \opt5\\ + Requires \gls{glossaries-extra}? & + \conno & \conno & \conno & \conyes & \conyes\\ + Requires an external application? & + \conno & \conyes & \conyes & \conyes & \conno\\ + Requires Perl? & + \conno & \conno & \conyes & \conno & \conno\\ + Requires Java? & + \conno & \conno & \conno & \conyes & \conno\\ + Can sort \glspl{exlatinalph} + or \glspl{nonlatinalph}? & + \prono\fnsym{1} & \prono & \proyes & \proyes & N/A\\ + Efficient sort algorithm? & + \prono & \proyes & \proyes & \proyes & N/A\\ + Can use a different sort method for each glossary? & + \proyes + & \prono\fnsym{2} + & \prono\fnsym{2} & \proyes & N/A\\ + Any problematic sort values? & + \conyes & \conyes & \conyes & \conno & \conno\fnsym{3}\\ + Are entries with identical sort values treated as separate unique + entries? & + \proyes & \proyes & \prono\fnsym{4} & \proyes & \proyes\\ + Can automatically form ranges in the location lists? & + \prono & \proyes & \proyes & \proyes & \prono\\ + Can have non-standard locations in the location lists? & + \proyes & \prono + & \proyes\fnsym{5} + & \proyes + & \proyes\fnsym{6}\\ + Maximum hierarchical depth (style-dependent) & + $\infty$\fnsym{7} & 3 & $\infty$ & $\infty$ & $\infty$\\ + \ics{glsdisplaynumberlist} reliable? & + \proyes & \prono & \prono & \proyes & \prono\\ + \ics{newglossaryentry} allowed in \env{document} environment? + (Not recommended.) & + \no & \yes & \yes & \no\fnsym{8} & \yes\fnsym{9}\\ + Requires additional write registers? & + \conno & \conyes & \conyes & \conno & \conno\fnsym{10}\\ + Default value of \pkgopt{sanitizesort} package option & + \texttt{false} & \texttt{true} & \texttt{true} + & \texttt{true}\fnsym{11} + & \texttt{true}\fnsym{11} + \end{tabular} + \par + }\par + \smallskip + \hrulefill\par + \smallskip\footnotesize + \fnsym{1} Strips standard \LaTeX\ accents +(that is, accents generated by core \LaTeX\ commands) so, +for example, \ics{AA} is treated the same as A.\par + \fnsym{2} Only with the hybrid method provided with \sty{glossaries-extra}.\par + \fnsym{3} Provided \pkgopt[none]{sort} is used.\par + \fnsym{4} Entries with the same sort value are merged.\par + \fnsym{5} Requires some setting up.\par + \fnsym{6} The locations must be set explicitly +through the custom \field{location} field provided by +\styfmt{glossaries-extra}.\par + \fnsym{7} Unlimited but unreliable.\par + \fnsym{8} Entries are defined in \texttt{.bib} +format. \cs{newglossaryentry} should not be used explicitly.\par + \fnsym{9} Provided \pkgoptfmt{docdefs=true} or +\pkgoptfmt{docdefs=restricted} but not recommended.\par + \fnsym{10} Provided \pkgoptfmt{docdefs=false} or +\pkgoptfmt{docdefs=restricted}.\par + \fnsym{11} Irrelevant with \pkgopt[none]{sort}. (The \optfmt{record=only} + option automatically switches this on.) +\par +\end{table} - \item Put -\begin{definition} -\cs{printnoidxglossary} -\end{definition} - where you want your list of entries to appear (described in - \sectionref{sec:printglossary}). - \item Run \LaTeX\ twice on your document. (As you would do to - make a~table of contents appear.) For example, click twice on - the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor. - \end{enumerate} +\optionsec[\TeX]{TeX} + +This option doesn't require an external \gls{indexingapp} 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 +\glspl{exlatinalph} or \glspl{nonlatinalph}. However, if you use +the \pkgopt[false]{sanitizesort} package option (the default for +Option~1) then the \glslink{latexexlatinchar}{standard \LaTeX\ +accent commands} will be ignored, so if an entry's name is set to +\verb|{\'e}lite| then the sort will default to \texttt{elite} if +\pkgopt[false]{sanitizesort} is used and will default to +\verb|\'elite| if \pkgopt[true]{sanitizesort} is used. If you have +any other kinds of commands that don't expand to ASCII characters, +such as \cs{alpha} or \cs{si}, then you must use +\pkgopt[true]{sanitizesort} or change the sort method +(\pkgopt[use]{sort} or \pkgopt[def]{sort}) in the package options +or explicitly set the \gloskey{sort} key when you define the +relevant entries. For example: +\begin{verbatim} +\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + sort={alpha},description={...}} +\end{verbatim} + +This option works best with the \pkgopt[def]{sort} or +\pkgopt[use]{sort} setting. For any +other setting, be prepared for a long document build time, +especially if you have a lot of entries defined. \textbf{This +option is intended as a last resort for alphabetical sorting.} +This option allows a mixture of sort methods. (For example, +sorting by word order for one glossary and order of use for another.) +This option is not suitable for hierarchical glossaries and does +not form ranges in the \glspl{numberlist}. If you really can't use an +\gls{indexingapp} consider using \opt{5} instead. -\item\optionlabel2: + \begin{enumerate} + \item Add +\begin{verbatim} +\makenoidxglossaries +\end{verbatim} + to your preamble (before you start defining your entries, as described in + \sectionref{sec:newglosentry}). - This option uses a~\gls{cli} application called \gls{makeindex} to sort - the entries. This application comes with all modern \TeX\ distributions, - but it's hard-coded for the non-extended \gls{latinalph}, so - it doesn't work well for \glspl{exlatinalph} or - \glspl{nonlatinalph}. This process involves making \LaTeX\ write the - glossary information to a temporary file which \gls{makeindex} reads. - Then \gls{makeindex} writes a~new file containing the code to typeset - the glossary. \LaTeX\ then reads this file in on the next run. + \item Put +\begin{verbatim} +\printnoidxglossary +\end{verbatim} + where you want your list of entries to appear (described in + \sectionref{sec:printglossary}). Alternatively, to display all + glossaries use the iterative command: +\begin{verbatim} +\printnoidxglossaries +\end{verbatim} - This option works best if you want to sort entries according to the - English alphabet and you don't want to install Perl. + \item Run \LaTeX\ twice on your document. (As you would do to + make a~table of contents appear.) For example, click twice on + the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor. + \end{enumerate} + +Complete example: +\begin{verbatim} +\documentclass{article} +\usepackage{glossaries} +\makenoidxglossaries % use TeX to sort +\newglossaryentry{sample}{name={sample}, + description={an example}} +\begin{document} +\gls{sample}. +\printnoidxglossary +\end{document} +\end{verbatim} + +\optionsec{makeindex} + +This option uses a~\gls{cli} application called \gls{makeindex} to sort +the entries. This application comes with all modern \TeX\ distributions, +but it's hard-coded for the non-extended \gls{latinalph}. It can't +correctly sort accent commands (such as \cs{'} or \cs{c}) and fails +with UTF-8 characters, especially for any sort values that start +with a UTF-8 character (as it separates the octets resulting in an +invalid file encoding). This process involves making \LaTeX\ write +the glossary information to a temporary file which \gls{makeindex} +reads. Then \gls{makeindex} writes a~new file containing the code +to typeset the glossary. Then \cs{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 you don't want to install Perl (or Java or +you don't want to use \gls{glossaries-extra}). This method can +also work with the restricted shell escape since \gls{makeindex} +is considered a trusted application. (So you should be able to +use the \pkgopt{automake} package option provided the shell +escape hasn't been completely disabled.) + +This method can form ranges in the \gls{numberlist} but only +accepts limited number formats: \cs{arabic}, \cs{roman}, +\cs{Roman}, \cs{alph} and \cs{Alph}. + +This option does not allow a mixture of sort methods. +All glossaries must be sorted according to the same method: +word\slash 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 \gls{makeindex} for +each glossary type. +(The \sty{glossaries-extra} package allows a hybrid mix of +\optsand12 to provide word\slash letter ordering with \opt2 and order +of use\slash definition with \opt1. See the \sty{glossaries-extra} +documentation for further details.) \begin{enumerate} \item If you want to use \gls{makeindex}['s] \mkidxopt{g} option - you must change the quote character using \ics{GlsSetQuote}. For -example: + you must change the quote character using \ics{GlsSetQuote}. For example: \begin{verbatim} \GlsSetQuote{+} \end{verbatim} @@ -644,23 +887,33 @@ example: enabled until the start of the document, so you won't be able to use the shorthands in definitions made in the preamble. - \item Add \cs{makeglossaries} to your preamble (before you start + \item Add +\begin{verbatim} +\makeglossaries +\end{verbatim} +to your preamble (before you start defining your entries, as described in \sectionref{sec:newglosentry}). \item Put -\begin{definition} -\cs{printglossary} -\end{definition} +\begin{verbatim} +\printglossary +\end{verbatim} where you want your list of entries to appear (described in - \sectionref{sec:printglossary}). + \sectionref{sec:printglossary}). Alternatively, to display all + glossaries use the iterative command: +\begin{verbatim} +\printglossaries +\end{verbatim} \item Run \LaTeX\ on your document. This creates files with the extensions \texttt{.glo} and \texttt{.ist} (for example, if your \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have two extra files called \texttt{myDoc.glo} and \texttt{myDoc.ist}). If you look at your document at this point, you won't see the - glossary as it hasn't been created yet. + glossary as it hasn't been created yet. (If you use + \sty{glossaries-extra} you'll see the section heading and some + boilerplate text.) \item Run \gls{makeindex} with the \texttt{.glo} file as the input file and the \texttt{.ist} file as the style so that @@ -672,53 +925,113 @@ example: makeindex -s myDoc.ist -o myDoc.gls myDoc.glo \end{verbatim} (Replace \texttt{myDoc} with the base name of your \LaTeX\ - document file. Avoid spaces in the file name.) If you don't know + document file. Avoid spaces in the file name if possible.) If you don't know how to use the command prompt, then you can probably access \gls{makeindex} via your text editor, but each editor has a different method of doing this, so I~can't give a~general - description. You will have to check your editor's manual. + description. You will have to check your editor's manual. The + simplest approach is to use \app{arara} and add the following + comment lines to the start of your document: +\begin{alltt} +\% arara:\ pdflatex +\% arara:\ makeglossaries +\% arara:\ pdflatex +\end{alltt} + (Replace \texttt{makeglossaries} with + \texttt{makeglossaries-lite} if you don't have Perl installed.) - The default sort is word order (\qt{sea lion} comes before -\qt{seal}). + The default sort is word order (\qt{sea lion} comes before \qt{seal}). If you want letter ordering you need to add the \mkidxopt{l} switch: \begin{verbatim} makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo \end{verbatim} (See \sectionref{sec:makeindexapp} for further details on using - \gls*{makeindex} explicitly.) + \gls*{makeindex} explicitly.) If you use \gls{makeglossaries} + or \gls{makeglossaries-lite.lua} then use the \pkgopt[letter]{order} + package option and the \mkidxopt{l} option will be added + automatically. \item Once you have successfully completed the previous step, - you can now run \LaTeX\ on your document again. + you can now run \LaTeX\ on your document again. You'll need to + repeat the process if you have used the \pkgopt{toc} option + (unless you're using \sty{glossaries-extra}) to ensure the + section heading is added to the table of contents. You'll also + need to repeat the process if you have any cross-references + which can't be indexed until the glossary file has been created. \end{enumerate} - This is the default option (although you still need to use - \cs{makeglossaries} to ensure the glossary files are created). +Complete example: +\begin{verbatim} +\documentclass{article} +\usepackage{glossaries} +\makeglossaries % open glossary files +\newglossaryentry{sample}{name={sample}, + description={an example}} +\begin{document} +\gls{sample}. +\printglossary +\end{document} +\end{verbatim} -\item\optionlabel3: +\optionsec{xindy} - This option uses a~\gls{cli} application called - \gls{xindy} to sort the entries. This application is more flexible than - \texttt{makeindex} and is able to sort \glspl{exlatinalph} or - \glspl{nonlatinalph}. The \gls{xindy} application comes with \TeX~Live - and now also with MiK\TeX. Since \gls{xindy} is a Perl script, you - will also need to install Perl, if you don't already have it. - In a~similar way to \opt2, this - option involves making \LaTeX\ write the glossary information to - a~temporary file which \gls{xindy} reads. Then \gls{xindy} - writes a~new file containing the code to typeset the glossary. - \LaTeX\ then reads this file in on the next run. +This option uses a~\gls{cli} application called +\gls{xindy} to sort the entries. This application is more flexible than +\texttt{makeindex} and is able to sort \glspl{exlatinalph} or +\glspl{nonlatinalph}, however it does still have some limitations. - This is the best option if you want to sort according to a - language other than English or if you want non-standard location - lists. +The \gls{xindy} application comes with both \TeX~Live and +MiK\TeX, but since \gls{xindy} is a Perl script, you will also need +to install Perl, if you don't already have it. In a~similar way to +\opt2, this option involves making \LaTeX\ write the glossary +information to a~temporary file which \gls{xindy} reads. Then +\gls{xindy} writes a~new file containing the code to typeset the +glossary. Then \cs{printglossary} reads this file in on the next run. - \begin{enumerate} +This is the best option with just the base \styfmt{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 \sectionref{sec:xindy}). There are +some problems with certain sort values: +\begin{itemize} + \item entries with the same sort value are merged by \gls*{xindy} + into a single glossary line so you must make sure that each entry + has a unique sort value; + \item \gls*{xindy} forbids empty sort values; + \item \gls*{xindy} automatically strips control sequences, the math-shift + character \verb|$| and braces \verb|{}| from the sort value, + which is usually desired but this can cause the sort value to + collapse to an empty string which \gls*{xindy} forbids. +\end{itemize} +In these problematic cases, you must set the \gloskey{sort} field +explicitly. For example: +\begin{verbatim} +\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + sort={alpha},description={...}} +\end{verbatim} + +All glossaries must be sorted according to the same method +(word/letter ordering, order of use, or order of definition). +(The \sty{glossaries-extra} package allows a hybrid mix of +\optsand13 to provide word\slash letter ordering with \opt3 and order +of use\slash definition with \opt1. See the \sty{glossaries-extra} +documentation for further details.) + +\begin{enumerate} \item Add the \pkgopt{xindy} option to the \styfmt{glossaries} package option list: \begin{verbatim} \usepackage[xindy]{glossaries} \end{verbatim} + If you are using a non-Latin script you'll also need to either + switch off the creation of the number group: +\begin{verbatim} +\usepackage[xindy={glsnumbers=false}]{glossaries} +\end{verbatim} + or use either \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} or + \cs{GlsSetXdyNumberGroupOrder}\marg{spec} to indicate where the number + group should be placed (see \sectionref{sec:xindy}). \item Add \cs{makeglossaries} to your preamble (before you start defining your entries, as described in \sectionref{sec:newglosentry}). @@ -728,7 +1041,9 @@ package option list: \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have two extra files called \texttt{myDoc.glo} and \texttt{myDoc.xdy}). If you look at your document at this point, you won't see the - glossary as it hasn't been created yet. + glossary as it hasn't been created yet. (If you're using the + extension package \sty{glossaries-extra}, you'll see the section + header and some boilerplate text.) \item Run \gls{xindy} with the \texttt{.glo} file as the input file and the \texttt{.xdy} file as a~module so that @@ -746,135 +1061,209 @@ xindy -L english -C utf8 -I xindy -M myDoc document file. Avoid spaces in the file name. If necessary, also replace \texttt{english} with the name of your language and \texttt{utf8} with your input encoding, for example, - \xdyopt{L}\texttt{ german }\xdyopt{C}\texttt{ din5007-utf8}.) If you don't know - how to use the command prompt, then you can probably access - \gls{xindy} via your text editor, but each editor has a - different method of doing this, so I~can't give a~general - description. You will have to check your editor's manual. + \xdyopt{L}\texttt{ german }\xdyopt{C}\texttt{ din5007-utf8}.) + Note that it's much simpler to use \gls{makeglossaries} instead: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} + (Remember that \gls{xindy} is a Perl script so if you can use + \gls{xindy} then you can also use \gls{makeglossaries}, and if + you don't want to use \gls{makeglossaries} because you don't + want to install Perl, then you can't use \gls{xindy} either.) + + If you don't know how to use the command prompt, then you can + probably access \gls{xindy} or \gls{makeglossaries} via your text editor, + but each editor has a different method of doing this, so I~can't give + a~general description. You will have to check your editor's manual. Again, + a convenient method is to use \appfmt{arara} and add the follow comment + lines to the start of your document: +\begin{alltt} +\% arara:\ pdflatex +\% arara:\ makeglossaries +\% arara:\ pdflatex +\end{alltt} - The default sort is word order (\qt{sea lion} comes before -\qt{seal}). + The default sort is word order (\qt{sea lion} comes before \qt{seal}). If you want letter ordering you need to add the \pkgopt[letter]{order} package option: \begin{verbatim} \usepackage[xindy,order=letter]{glossaries} \end{verbatim} - (and return to the previous step.) + (and return to the previous step). This option is picked up + by \gls{makeglossaries}. If you are explicitly using \gls{xindy} + then you'll need to add \texttt{-M ord/letorder} to the options list. See \sectionref{sec:xindyapp} for further details on using \gls*{xindy} explicitly. \item Once you have successfully completed the previous step, - you can now run \LaTeX\ on your document again. + you can now run \LaTeX\ on your document again. As with the + previous option, you may need to repeat the process to ensure + the table of contents and cross-references are resolved. - \end{enumerate} +\end{enumerate} -\end{description} +Complete example: +\begin{verbatim} +\documentclass{article} +\usepackage[xindy]{glossaries} +\makeglossaries % open glossary files +\newglossaryentry{sample}{name={sample}, + description={an example}} +\begin{document} +\gls{sample}. +\printglossary +\end{document} +\end{verbatim} -There is a fourth option available if you use the extension package -\sty{glossaries-extra} (as from v1.08). See the \pkgoptfmt{record} -package option in the \sty{glossaries-extra} user manual for -further details. +\optionsec{bib2gls} -For \optsand23, it can be difficult to remember all the -parameters required for \gls{makeindex} or \gls{xindy}, so the -\styfmt{glossaries} package provides a~Perl script called -\gls{makeglossaries} that reads the \texttt{.aux} file to -determine what settings you have used and will then run -\gls{makeindex} or \gls{xindy}. Again, this is a~command line -application and can be run in a~terminal or command prompt. For -example, if your \LaTeX\ document is in the file \texttt{myDoc.tex}, -then run: +This option is only available with the extension package +\gls{glossaries-extra}. This method uses \gls{bib2gls} to both +fetch entry definitions from \texttt{.bib} files and to +hierarchically sort and collate. + +All entries must be provided in one or more \texttt{.bib} files. +(See the \gls{bib2gls} user manual for the required format.) The +\sty{glossaries-extra} package needs to be loaded with the +\pkgoptfmt{record} package option \begin{verbatim} -makeglossaries myDoc +\usepackage[record]{glossaries-extra} +\end{verbatim} +or (equivalently) +\begin{verbatim} +\usepackage[record=only]{glossaries-extra} \end{verbatim} -(Replace \texttt{myDoc} with the base name of your \LaTeX\ document -file. Avoid spaces in the file name.) This is described in more -detail in \sectionref{sec:makeglossaries}. +(It's possible to use a hybrid of this method and \optsor23 with +\pkgoptfmt{record=alsoindex} but in general there is little need +for this and it complicates the build process.) -If you don't have Perl installed you can use the Lua script instead: +Each resource set is loaded with \cs{GlsXtrLoadResources}\oarg{options}. +For example: \begin{verbatim} -makeglossaries-lite.lua myDoc +\GlsXtrLoadResources +[% definitions in entries1.bib and entries2.bib: + src={entries1,entries2}, + sort={de-CH-1996}% sort according to this locale +] \end{verbatim} -This script doesn't have the full functionality of the Perl script, -but since modern \TeX\ distributions come with Lua, you shouldn't -need to install anything extra to make it run. Remember that since -\gls{xindy} is also a~Perl script, if you want to use \gls{xindy} -you'll need Perl installed anyway, so there's no point using this -Lua script if you're using \gls{xindy}. Note that \TeX~Live creates a -symbolic link called \texttt{makeglossaries-lite} (without the -\texttt{.lua} extension) to the actual -\texttt{makeglossaries-lite.lua} script, so you may not need to -supply the extension. +You can have multiple resource commands. -\begin{important} -The \texttt{.gls} and \texttt{.glo} are temporary files -created to help build your document. You should not edit or explicitly input -them. However, you may need to delete them if something goes wrong -and you need to do a fresh build. -\end{important} +The glossary is displayed using +\begin{verbatim} +\printunsrtglossary +\end{verbatim} +Alternatively all glossaries can be displayed using the iterative +command: +\begin{verbatim} +\printunsrtglossaries +\end{verbatim} +The document is build using: +\begin{verbatim} +pdflatex myDoc +bib2gls myDoc +pdflatex myDoc +\end{verbatim} +If letter groups are required, you need the \verb|--group| switch: +\begin{verbatim} +bib2gls --group myDoc +\end{verbatim} +Unlike \optsand23, 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 (if +required) their associated letter group. This option allows +a mixture of sort methods. (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.) -An overview of these three options is given in -\tableref{tab:options}. +This method supports Unicode and (with at least Java~8) uses +the Common Locale Data Repository, which provides more extensive +language support than \gls{xindy}.\footnote{Except for Klingon, +which is supported by \gls{xindy}, but not by the +CLDR.}\ The locations in the +\gls{numberlist} may be in any format. If \gls{bib2gls} can +deduce a numerical value it will attempt to form ranges otherwise +it will simply list the locations. -\begin{table}[htbp] - \caption{Glossary Options: Pros and Cons} - \label{tab:options} - {% - \centering - \begin{tabular}{>{\raggedright}p{0.35\textwidth}ccc} - & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3\\ - Requires an external application? & - \no & \yes & \yes\\ - Requires Perl? & - \no & \no & \yes\\ - Can sort \glspl{exlatinalph} - or \glspl{nonlatinalph}? & - \no\textsuperscript{\textdagger} & \no & \yes\\ - Efficient sort algorithm? & - \no & \yes & \yes\\ - Can use a different sort method for each glossary? & - \yes & \no & \no\\ - Can form ranges in the location lists? & - \no & \yes & \yes\\ - Can have non-standard locations in the location lists? & - \yes & \no & \yes\\ - Maximum hierarchical depth & - Unlimited but unreliable & 3 & Unlimited\\ - \ics{glsdisplaynumberlist} reliable? & - \yes & \no & \no\\ - \ics{newglossaryentry} restricted to preamble? & - \yes & \no & \no\\ - Requires additional write registers? & - \no & \yes & \yes\\ - Default value of \pkgopt{sanitizesort} package option & - \texttt{false} & \texttt{true} & \texttt{true} - \end{tabular} - \par - }\textsuperscript{\textdagger} Strips standard \LaTeX\ accents -(that is, accents generated by core \LaTeX\ commands) so, -for example, \ics{AA} is treated the same as A. -\end{table} +Complete example: +\begin{verbatim} +\documentclass{article} +\usepackage[record]{glossaries-extra} +\GlsXtrLoadResources[src={entries}] +\begin{document} +\gls{sample}. +\printunsrtglossary +\end{document} +\end{verbatim} +where \texttt{entries.bib} contains +\begin{verbatim} +@entry{sample, + name={sample}, + description={an example} +} +\end{verbatim} +See the \gls{bib2gls} user manual for further details. -This document uses the \styfmt{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 \qt{\gls{xindy}} you'll be taken to the entry -in the glossary where there's a brief description of -the term \qt{\gls*{xindy}}. +\optionsec[no sorting]{no sorting} -The remainder of this introductory section covers the following: -\begin{itemize} -\item \sectionref{sec:samples} lists the sample documents provided -with this package. +This option is only available with the extension package +\gls{glossaries-extra}. No \gls{indexingapp} is required. This +method is best used with the package option \pkgopt[none]{sort}. +\begin{verbatim} +\usepackage[sort=none]{glossaries-extra} +\end{verbatim} +There's no \qt{activation} command (such as \cs{makeglossaries} +for \optsand23). -\item \sectionref{sec:languages} provides information for users who -wish to write in a language other than English. +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 -\item \sectionref{sec:makeglossaries} describes how to use an -\gls{indexingapp} to create the sorted glossaries for your document -(\optsor23). +The glossary is displayed using +\begin{verbatim} +\printunsrtglossary +\end{verbatim} +Alternatively all glossaries can be displayed using the iterative +command: +\begin{verbatim} +\printunsrtglossaries +\end{verbatim} +This will display \emph{all} defined entries, regardless of +whether or not they have been used in the document. The +\glspl{numberlist} have to be set explicitly otherwise they won't +appear. Note that this uses the same command for displaying the +glossary as \opt4. This is because \gls{bib2gls} takes advantage +of this method by defining the wanted entries in the required order and +setting the locations (and letter group information, if required). -\end{itemize} +This just requires a single \LaTeX\ call +\begin{verbatim} +pdflatex myDoc +\end{verbatim} +unless the glossary needs to appear in the table of contents, in which case +a second run is required. +\begin{verbatim} +pdflatex myDoc +pdflatex myDoc +\end{verbatim} +(Naturally if the document also contains citations, and so on, +then additional steps are required. Similarly for all the other +options above.) + +Complete example: +\begin{verbatim} +\documentclass{article} +\usepackage[sort=none]{glossaries-extra} +\newglossaryentry{sample}{name={sample}, + description={an example}} +\begin{document} +\gls{sample}. +\printunsrtglossary +\end{document} +\end{verbatim} +See the \sty{glossaries-extra} documentation for +further details. \section{Sample Documents} \label{sec:samples} @@ -891,15 +1280,22 @@ For example, in a texdoc -l glossaries \end{prompt} This should display a list of all the files in the glossaries -documentation directory with their full pathnames. +documentation directory with their full pathnames. (The GUI version +of \texttt{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 CTAN mirror at \url{http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/}. -The sample documents are as follows\footnote{Note that although I've written +The sample documents are listed below\footnote{Note that although I've written \texttt{latex} in this section, it's better to use \texttt{pdflatex}, where -possible, for the reasons given \hyperlink{pdflatexnote}{earlier}.}: +possible, for the reasons given \hyperlink{pdflatexnote}{earlier}.} +If you prefer to use UTF-8 aware engines (\texttt{xelatex} or +\texttt{lualatex}) remember that you'll need to switch from +\styfmt{fontenc} \& \styfmt{inputenc} to \styfmt{fontspec} where +appropriate. The \gls{glossaries-extra} package provides some +additional sample files. + \begin{samplelist} \exitem[minimal]{gls} This document is a minimal working example. You can test your installation using this @@ -929,18 +1325,16 @@ replaced by a fixed one If this is the case, you will need to update the \styfmt{xkeyval} package. - \item Run \gls{makeglossaries} on the document (\sectionref{sec:makeglossaries}). This can - be done on a terminal either by typing + \item If you have Perl installed, run \gls{makeglossaries} on the document (\sectionref{sec:makeglossaries}). This can + be done on a terminal by typing \begin{prompt} makeglossaries minimalgls \end{prompt} - or by typing + otherwise do \begin{prompt} -perl makeglossaries minimalgls +makeglossaries-lite minimalgls \end{prompt} - If your system doesn't recognise the command \texttt{perl} then - it's likely you don't have Perl installed. In which case you - will need to use \gls{makeindex} directly. You can do this + If for some reason you want to call \gls{makeindex} explicitly, you can do this in a terminal by typing (all on one line): \begin{prompt} makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo @@ -948,9 +1342,8 @@ makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo (See \sectionref{sec:makeindexapp} for further details on using \gls*{makeindex} explicitly.) - Note that if you need to specify the full path and the path - contains spaces, you will need to delimit the file names with - the double-quote character. + Note that if the file name contains spaces, you will need to use + the double-quote character to delimit the name. \item Run \texttt{minimalgls.tex} through \LaTeX\ again (as step~1) \end{enumerate} @@ -988,14 +1381,18 @@ latex sample4col makeglossaries sample4col latex sample4col \end{prompt} -As before, if you don't have Perl installed, you will need to use -\gls{makeindex} directly instead of using -\gls{makeglossaries}. The vertical gap between entries is the +or +\begin{prompt} +latex sample4col +makeglossaries-lite sample4col +latex sample4col +\end{prompt} +The vertical gap between entries is the gap created at the start of each group. This can be suppressed using the \pkgopt{nogroupskip} package option. \exitem{Acr} This document has some -sample acronyms. It also adds the glossary to the table of contents, +sample abbreviations. It also adds the glossary to the table of contents, so an extra run through \LaTeX\ is required to ensure the document is up to date: \begin{prompt} @@ -1004,9 +1401,10 @@ makeglossaries sampleAcr latex sampleAcr latex sampleAcr \end{prompt} +(or use \gls{makeglossaries-lite.lua}). \exitem{AcrDesc} This is similar to -the previous example, except that the acronyms have an associated +the previous example, except that the abbreviations have an associated description. As with the previous example, the glossary is added to the table of contents, so an extra run through \LaTeX\ is required: \begin{prompt} @@ -1017,7 +1415,7 @@ latex sampleAcrDesc \end{prompt} \exitem{Desc} This is similar to the -previous example, except that it defines the acronyms using +previous example, except that it defines the abbreviations using \ics{newglossaryentry} instead of \ics{newacronym}. As with the previous example, the glossary is added to the table of contents, so an extra run through \LaTeX\ is required: @@ -1028,7 +1426,7 @@ latex sampleDesc latex sampleDesc \end{prompt} -\exitem{CustomAcr} This document has some sample acronyms with a +\exitem{CustomAcr} This document has some sample abbreviations with a custom acronym style. It also adds the glossary to the table of contents, so an extra run through \LaTeX\ is required: \begin{prompt} @@ -1095,19 +1493,29 @@ latex sampleDB makeglossaries sampleDB latex sampleDB \end{prompt} +or +\begin{prompt} +latex sampleDB +makeglossaries-lite sampleDB +latex sampleDB +\end{prompt} The glossary definitions are stored in the accompanying files -\texttt{database1.tex} and \texttt{database2.tex}. Note that if you -don't have Perl installed, you will need to use \gls{makeindex} -twice instead of a single call to \gls{makeglossaries}: +\texttt{database1.tex} and \texttt{database2.tex}. If for some +reason you want to call \gls{makeindex} explicitly you must +have a separate call for each glossary: \begin{enumerate} \item Create the main glossary (all on one line): -\begin{prompt} +\begin{prompt}\raggedright makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo \end{prompt} \item Create the secondary glossary (all on one line): -\begin{prompt} +\begin{prompt}\raggedright makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn \end{prompt} +Note that both \gls{makeglossaries} and \gls{makeglossaries-lite.lua} do +this all in one call, so they not only make it easier because you +don't need to supply all the switches and remember all the +extensions but they also call \gls{makeindex} the appropriate number of times. \end{enumerate} \exitem{Eq} This document illustrates how @@ -1155,16 +1563,16 @@ makeglossaries sampleNtn latex sampleNtn latex sampleNtn \end{prompt} -Note that if you don't have Perl installed, you will need to use -\gls{makeindex} twice instead of a single call to -\gls{makeglossaries}: +Note that if you want to call \gls{makeindex} explicitly instead of +using \gls{makeglossaries} or \gls{makeglossaries-lite.lua} then you +need to call \gls{makeindex} twice: \begin{enumerate} \item Create the main glossary (all on one line): -\begin{prompt} +\begin{prompt}\raggedright makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo \end{prompt} \item Create the secondary glossary (all on one line): -\begin{prompt} +\begin{prompt}\raggedright makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn \end{prompt} \end{enumerate} @@ -1183,9 +1591,9 @@ latex sample You can see the difference between word and letter ordering if you substitute \pkgopt[word]{order} with \pkgopt[letter]{order}. (Note that this will only have an effect if you use -\gls{makeglossaries}. If you use \gls{makeindex} explicitly, -you will need to use the \mkidxopt{l} switch to indicate letter -ordering.) +\gls{makeglossaries} or \gls{makeglossaries-lite.lua}. +If you use \gls{makeindex} explicitly, you will need to use the +\mkidxopt{l} switch to indicate letter ordering.) \exitem{-inline} This document is like \texttt{sample.tex}, above, but uses the \glostyle{inline} @@ -1234,7 +1642,8 @@ uncomment the lines \end{verbatim} it will set the style file to \texttt{samplexdy-mc.xdy} instead. This provides an additional letter group for entries starting with -\qt{Mc} or \qt{Mac}. If you use \gls{makeglossaries}, you don't +\qt{Mc} or \qt{Mac}. If you use \gls{makeglossaries} or +\gls{makeglossaries-lite.lua}, you don't need to supply any additional information. If you don't use \gls*{makeglossaries}, you will need to specify the required information. Note that if you set the style file to @@ -1249,18 +1658,23 @@ latex samplexdy makeglossaries samplexdy latex samplexdy \end{prompt} -If you don't have Perl installed, you will have to call -\gls{xindy} explicitly instead of using \gls{makeglossaries}. -If you are using the default style file \texttt{samplexdy.xdy}, then +If you don't have Perl installed then you can't use +\gls{makeglossaries}, but you also can't use \gls{xindy}! +However, if for some reason you want to call +\gls{xindy} explicitly instead of using \gls{makeglossaries} (or +\gls{makeglossaries-lite.lua}): +\begin{itemize} +\item if you are using the default style file \texttt{samplexdy.xdy}, then do (no line breaks): -\begin{prompt} +\begin{prompt}\raggedright xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo \end{prompt} -otherwise, if you are using \texttt{samplexdy-mc.xdy}, then do +\item if you are using \texttt{samplexdy-mc.xdy}, then do (no line breaks): -\begin{prompt} +\begin{prompt}\raggedright xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo \end{prompt} +\end{itemize} \exitem{xdy2} This document illustrates how to use the \styfmt{glossaries} package where the location @@ -1271,13 +1685,17 @@ pdflatex samplexdy2 makeglossaries samplexdy2 pdflatex samplexdy2 \end{prompt} -If you can't use \gls{makeglossaries} then you need to do (all on -one line): -\begin{prompt} +The explicit \gls{xindy} call is: +\begin{prompt}\raggedright xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo \end{prompt} 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. + \exitem{utf8} This is another example that uses \gls{xindy}. Unlike \gls{makeindex}, \gls{xindy} can cope with \glspl{nonlatinchar}. This @@ -1287,10 +1705,9 @@ latex sampleutf8 makeglossaries sampleutf8 latex sampleutf8 \end{prompt} -If you don't have Perl installed, you will have to call -\gls{xindy} explicitly instead of using \gls{makeglossaries} +The explicit \gls{xindy} call is (no line breaks): -\begin{prompt} +\begin{prompt}\raggedright xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo \end{prompt} @@ -1301,18 +1718,24 @@ latex sampleutf8 makeglossaries sampleutf8 latex sampleutf8 \end{prompt} +or +\begin{prompt} +latex sampleutf8 +makeglossaries-lite sampleutf8 +latex sampleutf8 +\end{prompt} you will see that the entries that start with an \gls{exlatinchar} now appear in the symbols group, and the word \qt{man\oe uvre} is now -after \qt{manor} instead of before it. If you are unable to use -\gls{makeglossaries}, the call to \gls{makeindex} is as -follows (no line breaks): -\begin{prompt} +after \qt{manor} instead of before it. If you want to explicitly +call \gls{makeindex} (no line breaks): +\begin{prompt}\raggedright makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo \end{prompt} \exitem{-index} This document uses the \styfmt{glossaries} package to create both a glossary and an -index. This requires two \gls{makeglossaries} calls to ensure the +index. This requires two \gls{makeglossaries} (or +\gls{makeglossaries-lite.lua}) calls to ensure the document is up to date: \begin{prompt} latex sample-index @@ -1412,65 +1835,132 @@ for testing purposes and are on \TeX's path (in via \ics{input} or \ics{loadglsentries}. The files are as follows: \begin{description} \item[example-glossaries-brief.tex] These entries all have brief -descriptions. +descriptions. For example: +\begin{verbatim} +\newglossaryentry{lorem}{name={lorem},description={ipsum}} +\end{verbatim} \item[example-glossaries-long.tex] These entries all have long -descriptions. +descriptions. For example: +\begin{verbatim} +\newglossaryentry{loremipsum}{name={lorem ipsum}, +description={dolor sit amet, consectetuer adipiscing +elit. Ut purus elit, vestibulum ut, placerat ac, +adipiscing vitae, felis. Curabitur dictum gravida +mauris.}} +\end{verbatim} \item[example-glossaries-multipar.tex] These entries all have multi-paragraph descriptions. \item[example-glossaries-symbols.tex] These entries all use the -\gloskey{symbol} key. +\gloskey{symbol} key. For example: +\begin{verbatim} +\newglossaryentry{alpha}{name={alpha}, +symbol={\ensuremath{\alpha}}, +description={Quisque ullamcorper placerat ipsum.}} +\end{verbatim} + +\item[example-glossaries-symbolnames.tex] Similar to the previous +file but the \gloskey{symbol} key isn't used. Instead the symbol +is stored in the \gloskey{name} key. For example: +\begin{verbatim} +\newglossaryentry{sym.alpha}{sort={alpha}, +name={\ensuremath{\alpha}}, +description={Quisque ullamcorper placerat ipsum.}} +\end{verbatim} \item[example-glossaries-images.tex] These entries use the \gloskey{user1} key to store the name of an image file. (The images are provided by the \sty{mwe} package and should be on \TeX's path.) One entry doesn't have an associated image to help test for a~missing key. -\item[example-glossaries-acronym.tex] These entries are all acronyms. +\item[example-glossaries-acronym.tex] These entries are all +abbreviations. For example: +\begin{verbatim} +\newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum +dolor} +\end{verbatim} \item[example-glossaries-acronym-desc.tex] These entries are all -acronyms that use the \gloskey{description} key. +abbreviations that use the \gloskey{description} key. +For example: +\begin{verbatim} +\newacronym[type=\glsdefaulttype, + description={fringilla a, euismod sodales, + sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} +\end{verbatim} \item[example-glossaries-acronyms-lang.tex] These entries are all -acronyms, where some of them have a~translation supplied in the +abbreviations, where some of them have a~translation supplied in the \gloskey{user1} key. +For example: +\begin{verbatim} +\newacronym[type=\glsdefaulttype,user1={love itself}] + {li}{LI}{lorem ipsum} +\end{verbatim} \item[example-glossaries-parent.tex] These are hierarchical entries where the child entries use the \gloskey{name} key. +For example: +\begin{verbatim} +\newglossaryentry{sedmattis}{name={sed mattis}, +description={erat sit amet} + +\newglossaryentry{gravida}{parent={sedmattis}, + name={gravida},description={malesuada}} +\end{verbatim} \item[example-glossaries-childnoname.tex] These are hierarchical entries where the child entries don't use the \gloskey{name} key. +For example: +\begin{verbatim} +\newglossaryentry{scelerisque}{name={scelerisque}, + description={at}} +\end{verbatim} \item[example-glossaries-cite.tex] These entries use the \gloskey{user1} key to store a citation key (or comma-separated list of citation keys). The citations are defined in \texttt{xampl.bib}, which should be available on all modern \TeX\ distributions. One entry doesn't have an associated citation to help test for a~missing -key. +key. +For example: +\begin{verbatim} +\newglossaryentry{fusce}{name={fusce}, +description={suscipit cursus sem},user1={article-minimal}} +\end{verbatim} \item[example-glossaries-url.tex] These entries use the \gloskey{user1} key to store an URL associated with the entry. +For example: +\begin{verbatim} +\newglossaryentry{aenean-url}{name={aenean}, + description={adipiscing auctor est}, + user1={http://uk.tug.org/}} +\end{verbatim} \end{description} The sample file \texttt{glossary-lipsum-examples.tex} in the \texttt{doc\slash latex\slash glossaries\slash samples} directory uses all these files. See also \url{http://www.dickimaw-books.com/gallery/#glossaries}. +The \sty{glossaries-extra} package provides additional test files. \section{Multi-Lingual Support} \label{sec:languages} -As from version 1.17, the \styfmt{glossaries} package can now be +As from version 1.17, the \styfmt{glossaries} package can be used with \gls{xindy} as well as \gls{makeindex}. If you are writing in a language that uses an \gls{exlatinalph} or -\gls{nonlatinalph} it is recommended that you use \gls*{xindy} -as \gls*{makeindex} is hard-coded for the non-extended -\gls{latinalph}. This -means that you are not restricted to the A, \ldots, Z letter groups. -If you want to use \gls*{xindy}, remember to use the -\pkgopt{xindy} package option. For example: +\gls{nonlatinalph} it's best to use \opt3 (\gls*{xindy}) +or \opt4 (\gls{bib2gls}) +as \gls*{makeindex} (\opt2) is hard-coded for the non-extended +\gls{latinalph} and \opt1 can performed limited ASCII comparisons. + +This means that with \optsor34 you are not restricted to the A, +\ldots, Z letter groups. If you want to use \gls*{xindy}, remember +to use the \pkgopt{xindy} package option. For example: \begin{verbatim} \documentclass[frenchb]{article} \usepackage[utf8]{inputenc} @@ -1478,34 +1968,43 @@ If you want to use \gls*{xindy}, remember to use the \usepackage{babel} \usepackage[xindy]{glossaries} \end{verbatim} +If you want to use \gls*{bib2gls}, you need to use the +\pkgopt{record} option with \sty{glossaries-extra} and supply the +definitions in \texttt{.bib} files. (See the \gls{bib2gls} user +manual for further details.) \begin{important} Note that although a~\gls{nonlatinchar}, such as \'e, looks like a plain -character in your tex file, with standard \LaTeX\ it's actually a~macro and can therefore +character in your \filetype{.tex} file, with standard \LaTeX\ it's actually a~macro and can therefore cause expansion problems. You may need to switch off the field expansions with \cs{glsnoexpandfields}. This issue doesn't occur -with \XeLaTeX. +with \XeLaTeX\ or Lua\LaTeX. +\end{important} -If you use a~\gls{nonlatinchar} (or other expandable) character at the start of -an entry name, you must place it in a group, or it will cause -a problem for commands that convert the first letter to upper case -(e.g.\ \ics{Gls}). For example: +With \sty{inputenc}, if you use a~\gls{nonlatinchar} (or other expandable) +character at the start of an entry name, you must place it in a group, +or it will cause a problem for commands that convert the first letter +to upper case (e.g.\ \ics{Gls}). For example: \begin{alltt} \verb|\newglossaryentry}{elite}{name={{|\'e\verb|}lite},| description=\verb|{select group or class}}| \end{alltt} -\end{important} -(For further details, see the section -\qt{UTF-8} section in the \sty{mfirstuc} user manual.) - -If you use the \sty{inputenc} package, \gls{makeglossaries} -will pick up the encoding from the auxiliary file. If you use +(With newer versions of \sty{mfirstuc} and \sty{datatool-base} you +may be able to omit this grouping.) +For further details, see the \qt{UTF-8} section in the +\sty{mfirstuc} user manual. + +If you are using \gls{xindy} or \gls{bib2gls}, the application needs +to know the encoding of the \filetype{.tex} file. This information +is added to the \filetype{.aux} file and can be picked up by +\gls{makeglossaries} and \gls{bib2gls}. If you use \gls{xindy} explicitly instead of via \gls*{makeglossaries}, you may need to specify the encoding using the \xdyopt{C} -option. Read the \gls*{xindy} manual for further details. +option. Read the \gls*{xindy} manual for further details of this +option. As from v4.24, if you are writing in German (for example, using the \sty{ngerman} -package or \sty{babel} with the \pkgopt{ngerman} package option), +package\footnote{deprecated, use \styfmt{babel} instead} or \sty{babel} with the \pkgopt{ngerman} package option), and you want to use \gls{makeindex}['s] \mkidxopt{g} option, you'll need to change \gls{makeindex}['s] quote character using: \begin{definition}[\DescribeMacro\GlsSetQuote] @@ -1681,13 +2180,6 @@ Examples of use: \usepackage{glossaries} \end{verbatim} -\item Using \sty{ngerman}: -\begin{verbatim} -\documentclass{article} -\usepackage{ngerman} -\usepackage{glossaries} -\end{verbatim} - \end{itemize} Due to the varied nature of glossaries, it's likely that the @@ -1697,7 +2189,10 @@ predefined translations may not be appropriate. If you are using the the words babel uses}. If you are using the \sty{translator} package, then you can provide your own dictionary with the necessary modifications (using \cs{deftranslation}) and load it using -\cs{usedictionary}. +\cs{usedictionary}. If you simply want to change the title of a +glossary, you can use the \gloskey[printglossary]{title} key in +commands like \cs{printglossary} (but not the iterative commands +like \cs{printglossaries}). \begin{important} Note that the \sty{translator} dictionaries are loaded at the beginning of the @@ -1746,11 +2241,12 @@ option \pkgopt[babel]{translate}. For example: } \end{verbatim} -Note that \gls{xindy} provides much better multi-lingual support -than \gls{makeindex}, so I~recommend that you use \gls*{xindy} +Note that \gls{xindy} and \gls{bib2gls} provide much better multi-lingual support +than \gls{makeindex}, so I~recommend that you use \optsor34 if you have glossary entries that contain \glspl{nonlatinchar}. See \sectionref{sec:xindy} for further -details. +details on \gls{xindy}, and see the \gls{bib2gls} user manual for +further details of that application. \subsubsection{Creating a New Language Module} \label{sec:newlang} @@ -1982,13 +2478,13 @@ the appropriate UTF-8 characters. \begin{important} This section is only applicable if you have chosen \optsor23. You can -ignore this section if you have chosen \opt1. If you want to +ignore this section if you have chosen any of the other options. If you want to alphabetically sort your entries always remember to use the \gloskey{sort} key if the \gloskey{name} contains any \LaTeX\ commands. \end{important} If this section seriously confuses you, and you can't work out how -to run \gls{makeglossaries} or \gls{makeindex}, you can try using +to run external tools like \gls{makeglossaries} or \gls{makeindex}, you can try using the \pkgopt{automake} package option, described in \sectionref{sec:pkgopts-sort}, but you will need \TeX's shell escape enabled. @@ -1996,25 +2492,34 @@ enabled. In order to generate a sorted glossary with compact \glspl{numberlist}, it is necessary to use an external \gls{indexingapp} as an intermediate step (unless you have chosen -\opt1, which uses \TeX\ to do the sorting). It is this application -that creates the file containing the code that typesets the +\opt1, which uses \TeX\ to do the sorting or \opt5, which doesn't +perform any sorting). It is this application +that creates the file containing the code required to typeset the glossary. \textbf{If this step is omitted, the glossaries will not appear in your document.} The two \glspl*{indexingapp} that are most commonly used with \LaTeX\ are \gls{makeindex} and \gls{xindy}. As from version 1.17, the \styfmt{glossaries} package can be used with either of these applications. Previous versions were designed to be -used with \gls*{makeindex} only. Note that \gls*{xindy} has much +used with \gls*{makeindex} only. With the \sty{glossaries-extra} package, you +can also use \gls{bib2gls} as the indexing application. (See +the \sty{glossaries-extra} and \gls{bib2gls} user manuals for +further details.) Note that \gls*{xindy} and \gls*{bib2gls} have much better multi-lingual support than \gls*{makeindex}, so \gls*{xindy} -is recommended if you're not writing in English. Commands that only -have an effect when \gls*{xindy} is used are described in -\sectionref{sec:xindy}. +or \gls*{bib2gls} are recommended if you're not writing in English. +Commands that only have an effect when \gls*{xindy} is used are +described in \sectionref{sec:xindy}. \begin{important} This is a multi-stage process, but there are methods of automating document compilation using applications such as \app{latexmk} and -\app{arara}. See -\url{http://www.dickimaw-books.com/latex/thesis/html/build.html} for -more information. +\app{arara}. With \app{arara} you can just add special comments to +your document source: +\begin{alltt} +\% arara: pdflatex +\% arara: makeglossaries +\% arara: pdflatex +\end{alltt} +With \app{latexmk} you need to set up the required dependencies. \end{important} The \styfmt{glossaries} package comes with the Perl script @@ -2023,11 +2528,12 @@ on all the glossary files using a customized style file (which is created by \ics{makeglossaries}). See \sectionref{sec:makeglossariesapp} for further details. Perl is stable, cross-platform, open source software that -is used by a number of \TeX-related applications. Most Unix-like +is used by a number of \TeX-related applications (including +\gls*{xindy} and \app{latexmk}). Most Unix-like operating systems come with a~Perl interpreter. \TeX~Live also comes with a~Perl interpreter. MiK\TeX\ doesn't come with a~Perl interpreter so if you are a~Windows MiK\TeX\ user you will need to -install Perl if you want to use \gls{makeglossaries}. +install Perl if you want to use \gls{makeglossaries} or \gls{xindy}. Further information is available at \url{http://www.perl.org/about.html} and \href{http://tex.stackexchange.com/questions/158796/miktex-and-perl-scripts-and-one-python-script}{MiKTeX and Perl scripts (and one Python script)}. @@ -2050,12 +2556,11 @@ file and see if you can work it out from the \gls*{makeindex} or \item If \gls{makeindex} warns about multiple encap values, \gls{makeglossaries} will detect this and attempt to correct the -problem.\footnote{Added to version \gls{makeglossaries} 2.18.} Since -\gls{xindy} doesn't warn about this, this correction is only -provided by \gls{makeglossaries} when \gls{makeindex} is used. -(\gls{xindy} uses the order of the attributes list to determine -which format should take precedence. See \cs{GlsAddXdyAttribute} in -\sectionref{sec:xindyloc}.) +problem.\footnote{Added to version \gls{makeglossaries} 2.18.} This +correction is only provided by \gls{makeglossaries} when +\gls{makeindex} is used since \gls{xindy} uses the order of the +attributes list to determine which format should take precedence. +(See \cs{GlsAddXdyAttribute} in \sectionref{sec:xindyloc}.) \end{itemize} @@ -2205,20 +2710,11 @@ wrapper for the \gls{makeglossaries} Perl script. MiKTeX also provides a~wrapper \texttt{makeglossaries.exe} but doesn't provide a~Perl interpreter, which is still required even if you run MiKTeX's \texttt{makeglossaries.exe}, so with MiKTeX you'll need to install -Perl. There's more information about this at +Perl.\footnote{The batch file \texttt{makeglossaries.bat} has been +removed since the \TeX\ distributions for Windows provide +\texttt{makeglossaries.exe}.} There's more information about this at \url{http://tex.stackexchange.com/q/158796/19862} on the TeX.SX -site. Alternatively, there is a batch file called -\texttt{makeglossaries.bat} that should be located in the same -folder as the \gls{makeglossaries} Perl script. This just explicitly -loads the script into Perl. If you've installed Perl but for some -reason your operating system can't find \texttt{perl.exe}, you can -edit the \texttt{makeglossaries.bat} file to include the full path -to \texttt{perl.exe} (but take care as this file will be overwritten -next time you update the \styfmt{glossaries} package). If you move -the \texttt{.bat} file to a new location, you will also need to -supply the full path to the \gls{makeglossaries} Perl script. (Don't -also move the Perl script as well or you may miss out on updates to -\gls{makeglossaries}.) +site. The \gls{makeglossaries} script attempts to fork the \gls{makeindex}\slash\gls{xindy} process using \texttt{open()} on the @@ -2280,10 +2776,10 @@ 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 -2.21. +4.33. \end{important} -\subsection{Using the makeglossaries-lite.lua Lua Script} +\subsection{Using the makeglossaries-lite Lua Script} \label{sec:makeglossarieslua} The Lua alternative to the \gls{makeglossaries} Perl script requires @@ -2341,7 +2837,7 @@ files, you must make sure you have used the \end{verbatim} This is required regardless of whether you use \gls{xindy} explicitly or whether it's called implicitly via applications such -as \gls{makeglossaries} or \gls{makeglossariesgui}. This causes the glossary +as \gls{makeglossaries}. This causes the glossary entries to be written in raw \gls*{xindy} format, so you need to use \xdyopt{I}\texttt{ xindy} \emph{not} \xdyopt{I}\texttt{ tex}. @@ -2502,7 +2998,11 @@ If \opt1 has been used, the \texttt{.aux} file will contain \begin{definition} \cs{@gls@reference}\marg{type}\marg{label}\marg{location} \end{definition} -for every time an entry has been referenced. +for every time an entry has been referenced. If \opt4 has been +used, the \texttt{.aux} file will contain one or more instances of +\begin{definition} +\cs{glsxtr@resource}\marg{options}\marg{basename} +\end{definition} \chapter{Package Options} \label{sec:pkgopts} @@ -2510,6 +3010,8 @@ for every time an entry has been referenced. This section describes the available \styfmt{glossaries} package options. You may omit the \texttt{=true} for boolean options. (For example, \pkgopt{acronym} is equivalent to \pkgopt[true]{acronym}). +The \gls{glossaries-extra} package has additional options described +in the \gls*{glossaries-extra} manual. \begin{important} Note that \meta{key}=\meta{value} package options can't be passed via the @@ -2530,6 +3032,9 @@ the \styfmt{glossaries} package. Don't use this option if you're new to using common mistakes (such as forgetting to use \ics{makeglossaries}). Note that the \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} will override this option. +\item[\pkgopt{nolangwarn}] This suppresses the warning generated by +a missing language module. + \item[\pkgopt{noredefwarn}] If you load \styfmt{glossaries} with a~class or another package that already defines glossary related commands, by default \styfmt{glossaries} will warn you that it's @@ -2540,8 +3045,10 @@ warnings. Other warnings will still be issued unless you use the \pkgopt{nowarn} option described above. \item[\pkgopt{debug}] Introduced in version 4.24. -This was a boolean option but as from v4.32 it's now a choice -option. If no value is given, \pkgopt[true]{debug} is assumed. +The default setting is \pkgopt[false]{debug}. +This was a boolean option but as from v4.32 it now accepts the +values: \pkgoptfmt{false}, \pkgoptfmt{true} and +\pkgoptfmt{showtargets}. If no value is given, \pkgopt[true]{debug} is assumed. Both \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} switch on the debug mode (and will automatically cancel the \pkgopt{nowarn} option). The \pkgopt[showtargets]{debug} @@ -2549,16 +3056,25 @@ option will additionally use \begin{definition}[\DescribeMacro\glsshowtarget] \cs{glsshowtarget}\marg{target name} \end{definition} -to show the hypertarget\slash hyperlink name in the margin when +to show the hypertarget or hyperlink name in the margin when \cs{glsdohypertarget} is used by commands like \cs{glstarget} and when \cs{glsdohyperlink} is used by commands like \cs{gls}. +This puts the information in the margin using \ics{marginpar}. +If this causes a problem, you'll need to redefine +\cs{glsshowtarget}. For example: +\begin{verbatim} +\renewcommand*{\glsshowtarget}[1]{\texttt{\small [#1]}} +\end{verbatim} -Consider the following example document: +The purpose of the debug mode can be demonstrated with +the following example document: \begin{verbatim} \documentclass{article} \usepackage{glossaries} -\newglossaryentry{sample1}{name={sample1},description={example}} -\newglossaryentry{sample2}{name={sample2},description={example}} +\newglossaryentry{sample1}{name={sample1}, + description={example}} +\newglossaryentry{sample2}{name={sample2}, + description={example}} \glsadd{sample2} \makeglossaries \begin{document} @@ -2566,31 +3082,39 @@ Consider the following example document: \printglossaries \end{document} \end{verbatim} -Here, only the \texttt{sample1} entry has been indexed, even +In this case, only the \texttt{sample1} entry has been indexed, even though \verb|\glsadd{sample2}| appears in the source code. -This is because the associated file is opened by -\ics{makeglossaries}, but \verb|\glsadd{sample2}| has been used -before this command. Since the file isn't open yet, the -information can't be written to it, which is why the -\texttt{sample2} entry doesn't appear in the glossary. +This is because \verb|\glsadd{sample2}| has been used before the +associated file is opened by \ics{makeglossaries}. Since the file +isn't open yet, the information can't be written to it, which is why +the \texttt{sample2} entry doesn't appear in the glossary. This situation doesn't cause any errors or warnings as it's perfectly legitimate for a user to want to use \styfmt{glossaries} to format the entries (e.g.\ abbreviation expansion) but not display any lists of terms, abbreviations, symbols etc. -Without \cs{makeglossaries} (or \cs{makenoidxglossaries}) -the indexing is suppressed but, other than that, commands -like \cs{gls} behave as usual. +Without \cs{makeglossaries} the indexing is suppressed but, other +than that, commands like \cs{gls} behave as usual. It's also +possible that the user may want to temporarily comment out +\cs{makeglossaries} in order to suppress the indexing while working +on a draft version to speed compilation. Therefore +\cs{makeglossaries} can't be used to enable \cs{newglossaryentry} +and \cs{glsadd}. They must be enabled by default. (It does, however, +enable the \gloskey{see} key as that's a more common problem. See +below.) The debug mode, enabled with the \pkgopt{debug} option, +\begin{verbatim} +\usepackage[debug]{glossaries} +\end{verbatim} 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 \begin{quote} -Package glossaries Info: wrglossary(\meta{type})(\meta{line}) on +Package glossaries Info: wrglossary(\meta{type})(\meta{text}) on input line \meta{line number}. \end{quote} -where \meta{type} is the glossary label and \meta{line} is the line +where \meta{type} is the glossary label and \meta{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 but you're sure you used commands like \cs{glsadd} @@ -2607,7 +3131,9 @@ Since this is easy to miss, the \styfmt{glossaries} package by default issues an error message if the \gloskey{see} key is used before \cs{makeglossaries}. This option allows you to change the error into just a warning (\pkgopt[warn]{seenoindex}) or -ignore it (\pkgopt[ignore]{seenoindex}). +ignore it (\pkgopt[ignore]{seenoindex}) if, for example, you want +to temporarily comment out \cs{makeglossaries} to speed up the +compilation of a draft document by omitting the indexing. \item[\pkgopt{nomain}] This suppresses the creation of the main glossary and associated \texttt{.glo} file, if unrequired. Note that @@ -2621,7 +3147,8 @@ put all your entries (either via the \pkgopt{acronym} (or \begin{important} If you don't use the main glossary and you don't use this option, -\gls{makeglossaries} will produce the following warning: +\gls{makeglossaries} will produce a warning. +\end{important} \begin{alltt} Warning: File '\emph{filename}.glo' is empty. Have you used any entries defined in glossary @@ -2632,7 +3159,6 @@ you don't want to use the main glossary. If you did actually want to use the main glossary and you see this warning, check that you have referenced the entries in that glossary via commands such as \ics{gls}. -\end{important} \item[\pkgopt{sanitizesort}] This is a boolean option that determines whether or not to \gls{sanitize} the sort value when @@ -2669,17 +3195,18 @@ glossaries or if you are using a class or other packages that create a lot of external files, you may exceed the maximum number of available registers. If \pkgopt{savewrites} 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. If you run -out of token registers, you can use \sty{etex}. +document when they will be written to the external files. \begin{important} -This option can significantly slow document compilation. As an -alternative, you can use the \sty{scrwfile} package (part of the -KOMA-Script bundle) and not use this option. +This option can significantly slow document compilation and may +cause the indexing to fail. Page numbers in the \gls{numberlist} +will be incorrect on page boundaries due to \TeX's asynchronous +output routine. As an alternative, you can use the \sty{scrwfile} +package (part of the KOMA-Script bundle) and not use this option. \end{important} You can also reduce the number of write registers by using -\opt1 or by ensuring you define all your glossary entries in the +\optsor14 or by ensuring you define all your glossary entries in the preamble. \begin{important} @@ -2696,6 +3223,7 @@ document to avoid rewriting the files. For example: \let\glswritefiles\relax \end{verbatim} \end{important} +In general, this package option is best avoided. \item[\pkgopt{translate}] This can take the following values: @@ -3178,9 +3706,32 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the \setglossarystyle{mcoltree} \end{verbatim} +\item[\pkgopt{esclocations}] This is a boolean option. (The default +is \pkgopt[true]{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 +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 \pkgopt[false]{esclocations} to avoid the complex escaping +of location values. + \item[\pkgopt{nonumberlist}] This option will suppress the associated \glspl{numberlist} in the glossaries (see also -\sectionref{sec:numberlists}). +\sectionref{sec:numberlists}). Note that if you use \optsor23 +(\gls{makeindex} or \gls{xindy}) then the locations must still be +valid. This package option merely prevents the \gls{numberlist} +from being displayed, but both \gls{makeindex} and \gls{xindy} +still require a location or cross-reference for each term that's +indexed. Remember that \gls{numberlist} includes any +cross-references, so suppressing the \gls{numberlist} will also hide +the cross-references (see below). \item[\pkgopt{seeautonumberlist}] If you suppress the \glspl{numberlist} with \pkgopt{nonumberlist}, described above, this @@ -3250,14 +3801,16 @@ redefined, if required, before the entries are defined (in the case of \pkgopt[def]{sort}) or before the entries are used (in the case of \pkgopt[use]{sort}). -\item \pkgoptval{none}{sort} : this option is new to version 4.30 -and is only for documents that don't use \cs{makeglossaries} -or \cs{makenoidxglossaries}. It omits the code used to sanitize -or escape the sort value, since it's not required. This option +\item \pkgoptval{none}{sort} : this setting is new to version 4.30 +and is only for documents that don't use \cs{makeglossaries} (\optsor23) +or \cs{makenoidxglossaries} (\opt1). 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 \cs{printglossary} or \cs{printnoidxglossary} (or the iterative versions \cs{printglossaries} or \cs{printnoidxglossaries}). It may be used with -\sty{glossaries-extra}'s \cs{printunsrtglossary}. +\sty{glossaries-extra}'s \cs{printunsrtglossary} (\opt5). \end{itemize} Note that the group styles (such as \glostyle{listgroup}) are incompatible with the \pkgopt[use]{sort} and \pkgopt[def]{sort} @@ -3842,7 +4395,9 @@ started to define entries, you may get unexpected results. In the preamble you need to indicate whether you want to use \opt1, \opt2 or \opt3. It's not possible to mix these options within -a~document. +a~document, although some combinations are possible with +\gls*{glossaries-extra}. (For \optsand45 see the \gls{bib2gls} and +\gls{glossaries-extra} manuals.) \section[Option 1]{\ifpdf\opt1\else Option 1\fi} \label{sec:setupopt1} @@ -3942,13 +4497,19 @@ better to define them in the preamble to ensure this. In fact, some commands such as \cs{longnewglossaryentry} may only be used in the preamble. See \sectionref{sec:docdefs} for a discussion of the problems with defining entries within the -document instead of in the preamble. +document instead of in the preamble. (The \gls{glossaries-extra} +package has an option that provides a restricted form of document +definitions that avoids some of the issues discussed in +\sectionref{sec:docdefs}.) \begin{important} \opt1 enforces the preamble-only restriction on -\ics{newglossaryentry}. +\ics{newglossaryentry}. \opt4 requires that definitions are provided +in \texttt{.bib} format. \opt5 requires either preamble-only +definitions or the use of the \sty{glossaries-extra} package option +\optfmt{docdef=restricted}. \end{important} -Only those entries that are referenced in the document +Only those entries that are indexed in the document (using any of the commands described in \sectionref{sec:glslink}, \sectionref{sec:glsadd} or \sectionref{sec:crossref}) will appear in the glossary. See @@ -3978,9 +4539,8 @@ hasn't already been defined: \begin{definition}[\DescribeMacro\provideglossaryentry] \cs{provideglossaryentry}\marg{label}\marg{key=value list} \end{definition} -and\par -\DescribeMacro\longprovideglossaryentry -\begin{definition} +and +\begin{definition}[\DescribeMacro\longprovideglossaryentry] \cs{longprovideglossaryentry}\marg{label}\marg{key=value list}\marg{long description} \end{definition} @@ -4012,8 +4572,13 @@ The description is set in the third argument of \cs{longnewglossaryentry} and \cs{longprovideglossaryentry}. With the other commands it's set via the \gloskey{description} key. As is typical with \meta{key}=\meta{value} lists, values that contain -a comma or equal sign must be enclosed in -braces. Available fields are listed below: +a comma or equal sign must be enclosed in braces. Available fields +are listed below. Additional fields are provided by the +supplementary packages \sty{glossaries-prefix} +(\sectionref{sec:prefix}) and \sty{glossaries-accsupp} +(\sectionref{sec:accsupp}) and also by \gls{glossaries-extra}. +You can also define your own custom keys (see +\sectionref{sec:addkey}). \begin{description} \item[{\gloskey{name}}] The name of the entry (as it will appear in @@ -4190,9 +4755,6 @@ Six keys provided for any additional information the user may want to specify. (For example, an associated dimension or an alternative plural or some other grammatical construct.) Alternatively, you can add new keys using \ics{glsaddkey} or \ics{glsaddstoragekey} (see \sectionref{sec:addkey}). -Other keys are also provided by the \sty{glossaries-prefix} -(\sectionref{sec:prefix}) and \sty{glossaries-accsupp} -(\sectionref{sec:accsupp}) packages. \item[{\gloskey{nonumberlist}}] A boolean key. If the value is missing or is \texttt{true}, this will suppress the \gls{numberlist} just for @@ -4202,8 +4764,8 @@ for this entry with \gloskey{nonumberlist=false}. (See \sectionref{sec:numberlists}.) \item[{\gloskey{see}}] Cross-reference another entry. Using the -\gloskey{see} key will automatically add this entry to the -glossary, but will not automatically add the cross-referenced entry. +\gloskey{see} key will \emph{automatically add this entry to the +glossary}, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. If you want to override the \qt{see} tag, you can supply the new tag in square brackets before the label. For example @@ -4224,21 +4786,24 @@ after the entry has been defined. \begin{important} For \optsand23, \ics{makeglossaries} must be used before any occurrence of \ics{newglossaryentry} that contains the \gloskey{see} key. This key -has no effect for entries defined in the \env{document} environment. +should not be used with entries defined in the \env{document} environment. \end{important} +Since it's useful to suppress the indexing while working on a draft +document, consider using the \pkgopt{seenoindex} package option to +warn or ignore the \gloskey{see} key while \cs{makeglossaries} is +commented out. If you use the \gloskey{see} key, you may want to consider using the -supplementary \gls{glossaries-extra} package. +\gls{glossaries-extra} package which additionally +provides a \texttt{seealso} and \texttt{alias} key. If you want to +avoid the automatic indexing triggered by the \gloskey{see} key, +consider using \opt4. \end{description} The following keys are reserved for \ics{newacronym} (see \sectionref{sec:acronyms}): \gloskey{long}, \gloskey{longplural}, -\gloskey{short} and \gloskey{shortplural}. Additional keys are -provided by the \sty{glossaries-prefix} (\sectionref{sec:prefix}) -and the \sty{glossaries-accsupp} (\sectionref{sec:accsupp}) packages. -You can also define your own custom keys (see -\sectionref{sec:addkey}). +\gloskey{short} and \gloskey{shortplural}. \begin{important} Avoid using any of the \glslike\ or \glstextlike\ commands within @@ -4510,8 +5075,8 @@ 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.\footnote{The \gls{glossaries-extra} package -provides a simpler way of achieving this.} +forms of abbreviations. (The \gls{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 rather than some other form of abbreviation. I'm @@ -4533,7 +5098,8 @@ determine how to display the full form: \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% } {% Put the long form in the description - \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\GenericAcronymFields}{% + description={\the\glslongtok}}% % For the full format, test the value of the "abbrtype" key. % If it's set to "word" put the short form first with % the long form in brackets. @@ -4585,7 +5151,8 @@ determine how to display the full form: }% }% % Just use the short form as the name part in the glossary: - \renewcommand*{\acronymentry}[1]{\acronymfont{\glsentryshort{##1}}}% + \renewcommand*{\acronymentry}[1]{% + \acronymfont{\glsentryshort{##1}}}% % Sort by the short form: \renewcommand*{\acronymsort}[2]{##1}% % Just use the surrounding font for the short form: @@ -4655,7 +5222,8 @@ to determine whether or not to reference the value of this new The new acronym style has a~minor modification that forces the user to specify a description. In the previous example, the line: \begin{verbatim} - \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}% + \renewcommand*{\GenericAcronymFields}{% + description={\the\glslongtok}}% \end{verbatim} needs to be changed to: \begin{verbatim} @@ -4754,8 +5322,7 @@ below the deck. \end{description} (for contractions). -For a complete document, see the sample file -\samplefile{-storage-abbr-desc}. +For a complete document, see \samplefile{-storage-abbr-desc}. \end{example} \section{Expansion} @@ -4957,7 +5524,10 @@ type has been specified by \ics{glsdefaulttype}, which is what \ics{newglossaryentry} uses by default). This is a~preamble-only command. You may also use \ics{input} to load -the file but don't use \ics{include}. +the file but don't use \ics{include}. If you find that your file is +becoming unmanageably large, you may want to consider switching to +\gls{bib2gls} and use an application such as JabRef to manage the +entry definitions. \begin{important} If you want to use \ics{AtBeginDocument} to \cs{input} all your entries @@ -5152,6 +5722,14 @@ occur; the \gloskey{see} key isn't stored, which means it can't be added to the \filetype{.glsdefs} file when it's created at the end of the document (and therefore won't be present on subsequent runs). +The \gls{glossaries-extra} package provides a setting (but only for +\optsand23) that allows \cs{newglossaryentry} to occur in the +document environment but doesn't create the \filetype{.glsdefs} +file. This circumvents some problems but it means that you can't +display any of the glossaries before all the entries have been +defined (so it's all right if all the glossaries are at the end of +the document but not if any occur in the front matter). + \subsection{Good Practice Issues} \label{sec:goodpractice} @@ -5182,66 +5760,218 @@ definition. Each entry in the glossary has an associated \gls{numberlist}. By default, these numbers refer to the pages on which that entry has -been used (using any of the commands described in +been indexed (using any of the commands described in \sectionref{sec:glslink} and \sectionref{sec:glsadd}). The number list can be suppressed using the \pkgopt{nonumberlist} package option, or an alternative counter can be set as the default using the \pkgopt{counter} package option. The number list is also referred to as the location list\index{location list|see{number list}}. +\Glspl{numberlist} are more common with indexes rather than +glossaries (although you can use the \styfmt{glossaries} package for +indexes as well). However, the \styfmt{glossaries} package makes use +of \gls{makeindex} or \gls{xindy} to hierarchically sort and collate the +entries since they are readily available with most modern \TeX\ +distributions. Since these are both designed as \glspl{indexingapp} +they both require that terms either have a valid location or a +cross-reference. Even if you use \pkgopt{nonumberlist}, the +locations must still be provided and acceptable to the +\gls{indexingapp} or they will cause an error during the indexing +stage, which will interrupt the document build. However, if you're +not interested in the locations, each entry only needs to be indexed +once, so consider using \pkgopt{indexonlyfirst}, which can improve the +document build time by only indexing the \gls{firstuse} of each term. + +The \ics{glsaddall} command (see \sectionref{sec:glsadd}), which is used to +automatically index all entries, iterates over all defined entries +and does \cs{glsadd}\marg{label} for each entry (where \meta{label} +is that entry's label). This means that \cs{glsaddall} automatically +adds the same location to every entry's \gls{numberlist}, which +looks weird if the \gls*{numberlist} hasn't been suppressed. + +With \opt4, the indexing is performed by \gls{bib2gls}, which was +specifically designed for the \gls{glossaries-extra} package. So it +will allow any location format, and its \texttt{selection=all} +option will select all entries without adding an unwanted location to the +\gls{numberlist}. If \gls{bib2gls} can deduce a numerical value for +a location, it will attempt to form a range over consecutive +locations, otherwise it won't try to form a range and the +location will just form an individual item in the list. +\opt1 also allows any location but it doesn't form ranges. + +\section{Encap Values} +\label{sec:encap} + Each location in the \gls{numberlist} is encapsulated with a -command. (The \termdef{encap} value.) By default this is the -\ics{glsnumberformat} command, but may be overridden using the -\gloskey[glslink]{format} key in the optional argument to commands -like \cs{gls}. (See \sectionref{sec:glslink}.) For example, you may -want the location to appear in bold to indicate the principle use of -a term or symbol. Complications can arise if you use different encap -values for the same location. For example, suppose on page~10 you -have both the default \cs{glsnumberformat} and \cs{textbf} encaps. -While it may seem apparent that \cs{textbf} should override -\cs{glsnumberformat} in this situation, neither \gls{makeindex} nor -\gls{xindy} know this. In the case of \gls{xindy}, it only accepts -one encap and discards the other for identical locations. The encap -it chooses to keep may not necessarily be the one you want. In the -case of \gls{makeindex}, it accepts different encaps for the same -location, but warns about it. This leads to a \gls{numberlist} with -the same location repeated in different fonts. - -This is something you need to be careful about, but if you use the -\gls{makeglossaries} Perl script it will detect \gls{makeindex}'s -warning and attempt to fix the problem.\footnote{This feature was -introduced in \gls{makeglossaries} version 2.18.} Since \gls{xindy} -doesn't generate a warning, \gls{makeglossaries} won't do anything -about it if you are using \gls{xindy}. With \gls{makeindex}, -\gls{makeglossaries} will let the encaps override each other, -similar to \gls{xindy}, except that the \cs{glsnumberformat} encap -will always have the least precedence. Other conflicting encaps will -have the last one override earlier ones for the same location. - -Due to the asynchronous nature of \TeX's output routine (see, -for example, +command formed from the \termdef{encap} value. By +default this is the \ics{glsnumberformat} command, which corresponds +to the encap \texttt{glsnumberformat}, but this may be +overridden using the \gloskey[glslink]{format} key in the optional +argument to commands like \cs{gls}. (See \sectionref{sec:glslink}.) +For example, you may want the location to appear in bold to indicate +the principle use of a term or symbol. If the encap starts with an +open parenthesis~\verb|(| this signifies the start of a range and if +the encap starts with close parenthesis~\verb|)| this signifies the +end of a range. These must always occur in matching pairs. + +The \styfmt{glossaries} package provides the command \ics{glsignore} +which ignores its argument. This is the format used by +\cs{glsaddallunused} to suppress the location, which works fine as +long as no other locations are added to the \gls{numberlist}. For +example, if you use \verb|\gls{sample}| on page~2 then reset the +\gls{firstuseflag} and then use \cs{glsaddallunused} on page~10, the +\gls{numberlist} for \texttt{sample} will be \verb|2, \glsignore{10}| +which will result in \qt{2,~} which has a spurious comma. + +This isn't a problem with \gls{bib2gls} because you'd use +\texttt{selection=all} instead of \cs{glsaddallunused}, but even if +you explicitly had, for example, +\cs{gls}\texttt{[format=glsignore]}\marg{label} +for some reason, \gls{bib2gls} will recognise \texttt{glsignore} as +a special encap indicating an ignored location, so it will select +the entry but not add that location to the \gls{numberlist}. It's a +problem for all the other options (except \opt5, which doesn't +perform any indexing). + +Complications can arise if you use different encap values for the +same location. For example, suppose on page~10 you have both the +default \texttt{glsnumberformat} and \texttt{textbf} encaps. While it may +seem apparent that \texttt{textbf} should override \texttt{glsnumberformat} +in this situation, the \gls{indexingapp} may not know it. +This is therefore something you need to be careful about if you use the +\gloskey[glslink]{format} key or if you use a command that +implicitly sets it. + +In the case of \gls{xindy}, it only accepts one encap (according to +the order of precedence given in the \gls{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 \gls{makeindex}, it accepts different encaps for the +same location, but warns about it. This leads to a \gls{numberlist} +with the same location repeated in different formats. If you use +the \gls{makeglossaries} Perl script with \opt2 it will detect +\gls{makeindex}'s warning and attempt to fix the problem, ensuring +that the \texttt{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 \opt1 so again you get the same location +repeated in different formats. With \opt4, \gls{bib2gls} will discard +according to order of precedence, giving priority to start and end +range encaps. (See the \gls{bib2gls} manual for further details.) + +\section{Locations} +\label{sec:locationsyntax} + +Neither \opt1 nor \opt4 care about the location syntax as long as +it's valid \LaTeX\ code (and doesn't contain fragile commands). In +both cases, the indexing is performed by writing a line to the +\texttt{.aux} file. The write operation is deferred to avoid the +problems associated with \TeX's asynchronous output routine. +(See, for example, \href{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage}{Finding -if you're on an odd or an even page}) the \texttt{page} counter -(represented internally as \cs{c@page}) can be unreliable. -This can cause problems when glossary entries are referenced in a -paragraph that spans a page break. The standard \cs{label} mechanism -deals with this by deferring the write until the end of the -paragraph, but the \styfmt{glossaries} indexing mechanism -needs to take into account the possibility that the location might -contain any of \gls{xindy}['s] special characters which will need to -be escaped before the write can be performed. (This isn't a problem -with \gls{makeindex} as that places restrictions on the location -format which prevent this from happening, but these very -restrictions can make \gls*{xindy} preferable.) - -To compensate, the -\styfmt{glossaries} package has to make some adjustments to ensure -the location number is correct for this situation. By default, -the adjustments only affect the counter styles: \texttt{roman}, -\texttt{Roman}, \texttt{alph}, \texttt{Alph} and \texttt{arabic}. -If you have a different numbering system where +if you're on an odd or an even page} for more details on this issue.) +Unfortunately \optsand23 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 \gls{indexingapp} then use the package +option \pkgopt[false]{esclocations} to bypass this operation. This setting +only affects \optsand23 as the problem doesn't arise with the other +indexing options. + +Both \gls{makeindex} and \gls{xindy} are fussy about the syntax of +the locations. In the case of \gls{makeindex}, only the numbering +system obtained with \cs{arabic}, \cs{roman}, \cs{Roman}, \cs{alph} +and \cs{Alph} or composites formed from them with the same separator +(set with \cs{glsSetCompositor}\marg{char}) are accepted. +(\gls{makeindex} won't accept an empty location.) In the case of +\gls{xindy}, you can define your own location classes, but if the +location contains a robust command then the leading backslash must +be escaped. The \sty{glossaries} package tries to do this, but it's +caught between two conflicting requirements: +\begin{enumerate} +\item The location must be fully expanded before \verb|\| can be +converted to \verb|\\| (there's no point converting \verb|\thepage| +to \verb|\\thepage|); +\item The page number can't be expanded until the deferred write +operation (so \verb|\c@page| mustn't expand in the previous step +but \verb|\the\c@page| mustn't be converted to \verb|\\the\\c@page| +and \verb|\number\c@page| mustn't be converted to +\verb|\\number\\c@page| etc). +\end{enumerate} +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 +\cs{value}. For example, suppose you have a robust command called +\cs{tallynum} that takes a number as the argument and an expandable +command called \cs{tally} that converts a counter name into the +associated register or number to pass to \cs{tallynum}. Let's +suppose that this command is used to represent the page number: +\begin{verbatim} +\renewcommand{\thepage}{\tally{page}} +\end{verbatim} +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 \gls{xindy}, +the location \verb|\tally{page}| needs to be written to the file +as \verb|\\tallynum{2}|. If it's written as \verb|\tallynum{2}| then +\gls{xindy} will interpret \verb|\t| as the character \qt{t} +(which means the location would appear as \qt{tallynum2}). So +\sty{glossaries} tries to expand \cs{thepage} without expanding +\cs{c@page} and then escapes all the backslashes, except for the +page counter's internal command. The following definitions of +\cs{tally} will work: +\begin{itemize} +\item In the following, \cs{arabic} works as its internal command \cs{c@arabic} is +temporarily redefined to check for \cs{c@page}: +\begin{verbatim} +\newcommand{\tally}[1]{\tallynum{\arabic{#1}}} +\end{verbatim} + +\item The form \verb|\expandafter\the\csname c@|\meta{counter}\verb|\endcsname| +also works (provided \cs{the} is allowed to be temporarily redefined, +see below): +\begin{verbatim} +\newcommand{\tally}[1]{% + \tallynum{\expandafter\the\csname c@#1\endcsname}} +\end{verbatim} + +\item \verb|\expandafter\the\value|\marg{counter} now also works +(with the same condition as above): +\begin{verbatim} +\newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}} +\end{verbatim} + +\item Another variation that will work: +\begin{verbatim} +\newcommand{\tally}[1]{% + \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}} +\end{verbatim} + +\item and also: +\begin{verbatim} +\newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}} +\end{verbatim} +\end{itemize} +The following \emph{don't work}: +\begin{itemize} +\item This definition leads to the premature expansion of \cs{c@page} +to \qt{1} when, in this case, it should be \qt{2}: +\begin{verbatim} +\newcommand{\tally}[1]{\tallynum{\the\value{#1}}} +\end{verbatim} +\item This definition leads to \verb|\\c@page| in the glossary file: +\begin{verbatim} +\newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}} +\end{verbatim} +\end{itemize} +If you have a numbering system where \verb|\|\meta{cs name}\verb|{page}| expands to -\verb|\|\meta{internal cs name}\cs{c@page} you need to use: +\verb|\|\meta{internal cs name}\cs{c@page} (for example, if +\verb|\tally{page}| expands to \verb|\tallynum\c@page|) then you +need to use: \begin{definition}[\DescribeMacro\glsaddprotectedpagefmt] \cs{glsaddprotectedpagefmt}\marg{internal cs name} \end{definition} @@ -5265,13 +5995,14 @@ page-spanning paragraphs, you need to do: \end{verbatim} (If you are using a different counter for the location, such as \texttt{section} or \texttt{equation}, you don't need to worry about -this.) +this provided the inner command is expandable.) If the inner macro (as given by \verb|\|\meta{internal cs name}) contains non-expandable commands then you may need to redefine \cs{gls}\meta{internal cs name}\texttt{page} after using \cs{glsaddprotectedpagefmt}\marg{internal cs name}. This command doesn't take any arguments -as the location is assumed to be given by \cs{c@page}. For example, +as \emph{the location is assumed to be given by \cs{c@page}} because +that's the only occasion this command should be used. For example, suppose now my page counter format uses small caps Roman numerals: \begin{verbatim} \newcommand*{\samplenum}[1]{% @@ -5292,7 +6023,7 @@ format that's acceptable to the \gls*{indexingapp}. For example: \begin{verbatim} \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page} \end{verbatim} -While this modification means that the location list in the glossary +While this modification means that the \gls{numberlist} in the glossary won't exactly match the format of the page numbers (displaying lower case Roman numbers instead of small cap Roman numerals) this method will at least work correctly for both \gls{makeindex} @@ -5307,18 +6038,22 @@ combined with \GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace" "roman-numbers-lowercase" :sep "\glsclosebrace"} \end{verbatim} -will now have lowercase Roman numerals in the location list. -(This option may cause problems if your locations should be -hyperlinks.) +will now have lowercase Roman numerals in the location list +(see \sectionref{sec:xindyloc} for further details on that command). +Take care of the backslashes. The location (which ends up in +the ":locref" attribute) needs \verb|\\| but the location class +(identified with \cs{GlsAddXdyLocation}) just has a single +backslash. Note that this example will cause problems if your +locations should be hyperlinks. -Another possibility that will work with both \gls{makeindex} and +Another possibility that may work with both \gls{makeindex} and \gls{xindy} is to redefine \cs{gls}\meta{internal cs name}\texttt{page} (\cs{gls@samplenumpage} in this example) -to just expand to the decimal page number and redefine +to just expand to the decimal page number (\verb|\number\c@page|) and redefine \ics{glsnumberformat} to change the displayed format: \begin{verbatim} - \renewcommand*{\gls@samplenumpage}{\number\c@page} - \renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}} +\renewcommand*{\gls@samplenumpage}{\number\c@page} +\renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}} \end{verbatim} \begin{important} @@ -5334,13 +6069,19 @@ causes a problem you can disallow it using \begin{definition}[\DescribeMacro\glswrallowprimitivemodsfalse] \cs{glswrallowprimitivemodsfalse} \end{definition} +but you will need to find some other way to ensure the location expands +correctly. + +\section{Range Formations} +\label{sec:ranges} Both \gls{makeindex} and \gls{xindy} (\optsand23) concatenate a sequence of~3 or more consecutive pages into~a range. With \gls*{xindy} (\opt3) you can vary the minimum sequence length using \ics{GlsSetXdyMinRangeLength}\marg{n} where \meta{n} is either an integer or the keyword \texttt{none} which indicates that there -should be no range formation. +should be no range formation (see \sectionref{sec:xindyloc} for +further details). \begin{important} Note that \cs{GlsSetXdyMinRangeLength} must be used before @@ -5382,6 +6123,12 @@ before \ics{makeglossaries} and have no effect if \ics{noist} is used. \end{important} +It's also possible to concatenate a sequence of consecutive +locations into a range or have suffixes with \opt4, but with +\gls{bib2gls} these implicit ranges can't be merged with explicit +ranges (created with the \verb|(| and \verb|)| encaps). See +the \gls{bib2gls} manual for further details. + \opt1 doesn't form ranges. However, with this option you can iterate over an entry's \gls{numberlist} using: \begin{definition}[\DescribeMacro\glsnumberlistloop] @@ -5439,6 +6186,9 @@ which is described in \sectionref{sec:customxr}. \cs{glsnumberlistloop} is not available for \optsand23. \end{important} +\section{Style Hook} +\label{sec:isthook} + As from version 4.24, there's a hook that's used near the end of \ics{writeist} before the file is closed. You can set the code to be performed then using: @@ -5468,21 +6218,22 @@ valid code. \label{sec:glslink} Once you have defined a glossary entry using \ics{newglossaryentry} -or \ics{newacronym} (see \sectionref{sec:acronyms}), -you can refer to that entry in the document using one of the -commands listed in \sectionref{sec:gls-like} or -\sectionref{sec:glstext-like}. The text which appears at that -point in the document when using one of these commands is referred -to as the \gls{linktext} (even if there are no hyperlinks). These -commands also add a line to an external file that is -used to generate the relevant entry in the glossary. This +(\sectionref{sec:newglosentry}) or \ics{newacronym} (see +\sectionref{sec:acronyms}), you can refer to that entry in the +document using one of the commands listed in +\sectionref{sec:gls-like} or \sectionref{sec:glstext-like}. The text +which appears at that point in the document when using one of these +commands is referred to as the \gls{linktext} (even if there are no +hyperlinks). These commands also add a line to an external file that +is used to generate the relevant entry in the glossary. This information includes an associated location that is added to the \gls{numberlist} for that entry. By default, the location refers to the page number. For further information on number lists, see \sectionref{sec:numberlists}. These external files need to be post-processed by \gls{makeindex} or \gls{xindy} unless you have -chosen \opt1. If you don't use \ics{makeglossaries} these external -files won't be created. +chosen \optsor14. If you don't use \ics{makeglossaries} these external +files won't be created. (\optsand14 write the information to the +\filetype{.aux} file.) Note that repeated use of these commands for the same entry can cause the \gls{numberlist} to become quite long, which may not be @@ -5609,7 +6360,9 @@ other key that you plan to access through these commands. \cs{glssymbol}.) \end{important} -The following keys are available for the optional argument: +The keys listed below are available for the optional argument. +The \gls{glossaries-extra} package provides additional keys. +(See the \gls*{glossaries-extra} manual for further details.) \begin{description} \item[{\gloskey[glslink]{hyper}}] This is a boolean key which can be used to enable\slash disable the hyperlink to the relevant entry @@ -5628,22 +6381,28 @@ value is equivalent to the \gls{makeindex} encap value, and (as with \ics{index}) the value needs to be the name of a command \emph{without} the initial backslash. As with \ics{index}, the characters \verb"(" and \verb")" can also be used to specify the -beginning and ending of a number range. Again as with \ics{index}, -the command should be the name of a command which takes an argument -(which will be the associated location). Be careful not to use a -declaration (such as \texttt{bfseries}) instead of a text block command -(such as \texttt{textbf}) as the effect is not guaranteed to be -localised. If you want to apply more than one style to a given entry -(e.g.\ \textbf{bold} and \emph{italic}) you will need to create a -command that applies both formats, e.g.\ +beginning and ending of a number range and they must be in matching +pairs. (For example, \verb|\gls[format={(}]{sample}| on one page +to start the range and later \verb|\gls[format={)}]{sample}| to close +the range.) Again as with \ics{index}, the command should be the +name of a command which takes an argument (which will be the +associated location). Be careful not to use a declaration (such as +\texttt{bfseries}) instead of a text block command (such as +\texttt{textbf}) as the effect is not guaranteed to be localised. If +you want to apply more than one style to a given entry (e.g.\ +\textbf{bold} and \emph{italic}) you will need to create a command +that applies both formats, e.g.\ \begin{verbatim} \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}} \end{verbatim} and use that command. -In this document, the standard formats refer to the standard text -block commands such as \ics{textbf} or \ics{emph} or any of the -commands listed in \tableref{tab:hyperxx}. +In this document, the standard formats refer to the standard text +block commands such as \ics{textbf} or \ics{emph} or any of the +commands listed in \tableref{tab:hyperxx}. You can combine a range +and format using \verb|(|\meta{format} to start the range and +\verb|)|\meta{format} to end the range. The \meta{format} part must +match. For example, \verb|format={(emph}| and \verb|format={)emph}|. \begin{important} If you use \gls{xindy} instead of \gls{makeindex}, you @@ -5695,9 +6454,9 @@ sans-serif font, you can define a command called, say, \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} \end{verbatim} and then use \texttt{hyperbsf} as the value for the \gloskey{format} -key. (See also \ifpdf section~\ref*{sec:code:printglos} \fi +key.\footnote{See also \ifpdf section~\ref*{sec:code:printglos} \fi \qt{Displaying the glossary} in the documented code, -\texttt{glossaries-code.pdf}.) Remember that if you use \gls{xindy}, you +\texttt{glossaries-code.pdf}.} Remember that if you use \gls{xindy}, you will need to add this to the list of location attributes: \begin{verbatim} \GlsAddXdyAttribute{hyperbsf} @@ -5714,9 +6473,6 @@ the \gls*{firstuseflag} will be localised to the current scope. The default is \texttt{local=false}. \end{description} -The \gls{glossaries-extra} package provides an additional key. -Please see the \gls{glossaries-extra} user manual for further -details. \begin{important} The \gls{linktext} isn't scoped by default. Any unscoped @@ -6772,7 +7528,8 @@ You must use \ics{makeglossaries} (\optsor23) or terms that cross-reference entries. If any of the terms that you have cross-referenced don't appear in the glossary, check that you have put \cs{makeglossaries}\slash\cs{makenoidxglossaries} before all -entry definitions. +entry definitions. The \gls{glossaries-extra} package provides +better cross-reference handling. \end{important} There are several ways of cross-referencing entries in the @@ -7289,7 +8046,9 @@ have directly used \gls{makeindex} or \gls{xindy} (as described in \sectionref{sec:makeglossaries}). (While the external files are missing, these commands will just do \cs{null} for each missing glossary to assist dictionary style documents that just use -\cs{glsaddall} without inserting any text.) +\cs{glsaddall} without inserting any text. If you use +\gls{glossaries-extra}, it will insert a heading and boilerplate text when the +external files are missing.) If the glossary still does not appear after you re-\LaTeX\ your document, check the \gls*{makeindex}\slash\gls*{xindy} log files to @@ -7511,9 +8270,11 @@ This ensures that the glossary information is written in \gls*{xindy} syntax. \sectionref{sec:makeglossaries} covers how to use the external -\gls{indexingapp}. This section covers the commands provided -by the \styfmt{glossaries} package that allow you to adjust the -\gls{xindy} style file (\filetype{.xdy}) and parameters. +\gls{indexingapp}, and \sectionref{sec:locationsyntax} covers the +issues involved in the location syntax. This section covers the +commands provided by the \styfmt{glossaries} package that allow you +to adjust the \gls{xindy} style file (\filetype{.xdy}) and +parameters. To assist writing information to the \gls{xindy} style file, the \styfmt{glossaries} package provides the following @@ -7701,8 +8462,8 @@ where \meta{name} is the name of the format and \meta{definition} is the \gls{xindy} definition. The optional argument \meta{prefix-location} is needed if \cs{theH}\meta{counter} either isn't defined or is different from \cs{the}\meta{counter}. -(See also \ics{glsaddprotectedpagefmt} described in -\sectionref{sec:numberlists}.) +Be sure to also read \sectionref{sec:locationsyntax} for some issues +that you may encounter. \begin{important} Note that \cs{GlsAddXdyLocation} has no effect if \ics{noist} is @@ -7752,24 +8513,48 @@ This example is illustrated in the sample file \samplefile{xdy2}. \end{example} -\begin{example}{Locations as Words not Digits}{ex:fmtcount} -Suppose I want the page numbers written as words -rather than digits and I~use the \sty{fmtcount} package to -do this. I~can redefine \ics{thepage} as follows: +\begin{example}{Locations as Dice}{ex:dice} +Suppose I want a rather eccentric page numbering system that's +represented by the number of dots on dice. The \sty{stix} package +provides \cs{dicei}, \ldots, \cs{dicevi} that represent the six +sides of a die. I can define a command that takes a number as its +argument. If the number is less than seven, the appropriate +\cs{dice}\meta{n} command is used otherwise it does \cs{dicevi} the +required number of times with the leftover in a final +\cs{dice}\meta{n}. For example, the number 16 is represented by +\verb|\dicevi\dicevi\diceiv| ($6+6+4=16$). I've called this command +\cs{tallynum} to match the example given earlier in +\sectionref{sec:locationsyntax}: +\begin{verbatim} +\newrobustcmd{\tallynum}[1]{% + \ifnum\number#1<7 + $\csname dice\romannumeral#1\endcsname$% + \else + $\dicevi$% + \expandafter\tallynum\expandafter{\numexpr#1-6}% + \fi +} +\end{verbatim} +Here's the counter command: \begin{verbatim} -\renewcommand*{\thepage}{\Numberstring{page}} +newcommand{\tally}[1]{\tallynum{\arabic{#1}}} \end{verbatim} -This gets expanded to \verb|\protect \Numberstringnum |\marg{n} -where \meta{n} is the Arabic page number. This means that I~need to -define a new location that has that form: +The \ctr{page} counter representation (\cs{thepage}) needs to be +changed to use this command: \begin{verbatim} -\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space - \string\Numberstringnum\space\glsopenbrace" - "arabic-numbers" :sep "\glsclosebrace"} +\renewcommand*{\thepage}{\tally{page}} \end{verbatim} -Note that it's necessary to use \cs{space} to indicate that -spaces also appear in the format, since, unlike \TeX, -\gls{xindy} doesn't ignore spaces after control sequences. +The \cs{tally} command expands to \cs{tallynum} \marg{number} so +this needs a location class that matches this format: +\begin{verbatim} +\GlsAddXdyLocation{tally}{% + :sep "\string\tallynum\space\glsopenbrace" + "arabic-numbers" + :sep "\glsclosebrace" +} +\end{verbatim} +The space between \cs{tallynum} and \marg{number} is +significant to \gls{xindy} so \cs{space} is required. Note that \cs{GlsAddXdyLocation}\marg{name}\marg{definition} will define commands in the form: @@ -7779,16 +8564,16 @@ commands in the form: for each counter that has been identified either by the \pkgopt{counter} package option, the \meta{counter} option for \ics{newglossary} or in the argument of \ics{GlsAddXdyCounters}. - The first argument \meta{Hprefix} is only relevant when used with -the \sty{hyperref} package and indicates that \cs{the}\meta{Hcounter} -is given by \cs{Hprefix}"."\cs{the}\meta{counter}. The sample -file \samplefile{xdy}, which comes with the \styfmt{glossaries} +the \sty{hyperref} package and indicates that \cs{theH}\meta{counter} +is given by \cs{Hprefix}"."\cs{the}\meta{counter}. + +The sample file \samplefile{xdy}, which comes with the \styfmt{glossaries} package, uses the default \ctr{page} counter for locations, and it uses the default \ics{glsnumberformat} and a custom \cs{hyperbfit} -format. A new \gls{xindy} location called \texttt{Numberstring}, as +format. A new \gls{xindy} location called \texttt{tallynum}, as illustrated above, is defined to make the page numbers appear as -\qt{One}, \qt{Two}, etc. In order for the location numbers to +dice. In order for the location numbers to hyperlink to the relevant pages, I~need to redefine the necessary \cs{glsX}\meta{counter}"X"\meta{format} commands: \begin{verbatim} @@ -7800,28 +8585,99 @@ hyperlink to the relevant pages, I~need to redefine the necessary \textbf{\em\linkpagenumber#2}% } +\newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} +\end{verbatim} +Note that the second argument of \cs{glsXpageXglsnumberformat} is +in the format \cs{tallynum}\marg{n} so the line +\begin{verbatim} + \linkpagenumber#2% +\end{verbatim} +does +\begin{alltt} + \cs{linkpagenumber}\cs{tallynum}\marg{number} +\end{alltt} +so \cs{tallynum} is the first argument of \cs{linkpagenumber} +and \meta{number} is the second argument. +\end{example} + +\begin{important} +This method is very sensitive to the internal definition of the +location command. +\end{important} + +\begin{example}{Locations as Words not Digits}{ex:fmtcount} +Suppose I want the page numbers written as words +rather than digits and I~use the \sty{fmtcount} package to +do this. I~can redefine \ics{thepage} as follows: +\begin{verbatim} +\renewcommand*{\thepage}{\Numberstring{page}} +\end{verbatim} +This \emph{used} to get expanded to \verb|\protect \Numberstringnum |\marg{n} +where \meta{n} is the Arabic page number. This means that I~needed to +define a new location with the form: +\begin{verbatim} +\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space + \string\Numberstringnum\space\glsopenbrace" + "arabic-numbers" :sep "\glsclosebrace"} +\end{verbatim} +and if I'd used the \cs{linkpagenumber} command from the previous +example, it would need \emph{three} arguments (the first being +\cs{protect}): +\begin{verbatim} \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} \end{verbatim} + +The internal definition of \cs{Numberstring} has since changed +so that it now expands to \verb|\Numberstringnum |\marg{n} +(no \cs{protect}). This means that the location class definition +must be changed to: +\begin{verbatim} +\GlsAddXdyLocation{Numberstring}{% no \protect now! + :sep "\string\Numberstringnum\space\glsopenbrace" + "arabic-numbers" :sep "\glsclosebrace"} +\end{verbatim} +and \cs{linkpagenumber} goes back to only two arguments: +\begin{verbatim} +\newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} +\end{verbatim} +The other change is that \cs{Numberstring} uses +\begin{alltt} +\cs{the}\cs{value}\marg{counter} +\end{alltt} +instead of +\begin{alltt} +\cs{expandafter}\cs{the}\cs{csname} c@\meta{counter}\cs{endcsname} +\end{alltt} +so it hides \cs{c@page} from the location escaping mechanism +(see \sectionref{sec:locationsyntax}). This means that the page +number may be incorrect if the indexing occurs during the output +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 +\samplefile{xdy3} illustrates this. \end{example} -In the \gls{numberlist}, the locations are sorted according to -type. The default ordering is: \texttt{roman-page-numbers} (e.g.\ -i), \texttt{arabic-page-numbers} (e.g.\ 1), -\texttt{arabic-section-numbers} (e.g.\ 1.1 if the compositor is a -full stop or 1-1 if the compositor is a hyphen\footnote{see -\ics{setCompositor} described in \sectionref{sec:setup}}), -\texttt{alpha-page-numbers} (e.g.\ a), \texttt{Roman-page-numbers} -(e.g.\ I), \texttt{Alpha-page-numbers} (e.g.\ A), -\texttt{Appendix-page-numbers} (e.g.\ A.1 if the Alpha compositor is -a full stop or A-1 if the Alpha compositor is a hyphen\footnote{see -\ics{setAlphaCompositor} described in -\sectionref{sec:setup}}), user defined location names (as -specified by \ics{GlsAddXdyLocation} in the order in which they were -defined), \texttt{see} (cross-referenced entries). This ordering can -be changed using: - -\DescribeMacro{\GlsSetXdyLocationClassOrder} -\begin{definition} +In the \gls{numberlist}, the locations are sorted according to the list +of provided location classes. The default ordering is: +\texttt{roman-page-numbers} (i, ii, \ldots), \texttt{arabic-page-numbers} +(1, 2, \ldots), \texttt{arabic-section-numbers} (for example, 1.1 if the +compositor is a full stop or 1-1 if the compositor is a +hyphen\footnote{see \ics{glsSetCompositor} described in +\sectionref{sec:setup}}), \texttt{alpha-page-numbers} (a, b, \ldots), +\texttt{Roman-page-numbers} (I, II, \ldots), \texttt{Alpha-page-numbers} +(A, B, \ldots), \texttt{Appendix-page-numbers} (for example, A.1 if the Alpha +compositor is a full stop or A-1 if the Alpha compositor is a +hyphen\footnote{see \ics{glsSetAlphaCompositor} described in +\sectionref{sec:setup}}), user defined location names (as specified +by \ics{GlsAddXdyLocation} in the order in which they were defined), +and finally \texttt{see} (cross-referenced entries).\footnote{With +\gls{glossaries-extra} \texttt{seealso} is appended to the end of +the list.} This ordering can be changed using: + +\begin{definition}[\DescribeMacro\GlsSetXdyLocationClassOrder] \cs{GlsSetXdyLocationClassOrder}\marg{location names} \end{definition} where each location name is delimited by double quote marks and @@ -7838,6 +8694,8 @@ separated by white space. For example: "see" } \end{verbatim} +(Remember to add \verb|"seealso"| if you're using +\gls{glossaries-extra}.) \begin{important} Note that \cs{GlsSetXdyLocationClassOrder} has no effect if @@ -7849,10 +8707,9 @@ Note that \cs{GlsSetXdyLocationClassOrder} has no effect if If a \gls{numberlist} 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:\newpage +defaults to 2, but can be changed using: -\DescribeMacro{\GlsSetXdyMinRangeLength} -\begin{definition} +\begin{definition}[\DescribeMacro\GlsSetXdyMinRangeLength] \cs{GlsSetXdyMinRangeLength}\marg{n} \end{definition} For example: @@ -7869,8 +8726,7 @@ is used or if \ics{makeglossaries} is omitted. \cs{GlsSetXdyMinRangeLength} must be used before \ics{makeglossaries}. \end{important} - -See \sectionref{sec:numberlists} for further details. +See also \sectionref{sec:ranges}. \section{Glossary Groups} \label{sec:groups} @@ -7883,24 +8739,55 @@ a number group by default, unless you suppress it in the \usepackage[xindy={glsnumbers=false}]{glossaries} \end{verbatim} Any entry that doesn't go in one of the letter groups or the -number group is placed in the default group. +number group is placed in the default group. If you want \gls{xindy} +to sort the number group numerically (rather than by a string sort) +then you need to use \gls{xindy}['s] \texttt{numeric-sort} module: +\begin{verbatim} +\GlsAddXdyStyle{numeric-sort} +\end{verbatim} -If you have a number group, the default behaviour is to locate -it before the \qt{A} letter group. If you are not using a -Roman alphabet, you can change this using: +If you don't use \texttt{glsnumbers=false}, the default behaviour is to locate +the number group before the \qt{A} letter group. If you are not using a +Roman alphabet, you need to change this using: -\DescribeMacro{\GlsSetXdyFirstLetterAfterDigits} -\begin{definition} + +\begin{definition}[\DescribeMacro\GlsSetXdyFirstLetterAfterDigits] \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} \end{definition} +where \meta{letter} is the first letter of your alphabet. Take care +if you're using \sty{inputenc} as non-ASCII characters are actually +active characters that expand. (This isn't a problem with the native +UTF-8 engines and \sty{fontspec}.) The starred form will sanitize +the argument to prevent expansion. +Alternatively you can use: + + +\begin{definition}[\DescribeMacro\GlsSetXdyNumberGroupOrder] +\cs{GlsSetXdyNumberGroupOrder}\marg{relative location} +\end{definition} +to change the default +\begin{alltt} +:before \cs{string}"\meta{letter}\cs{string}" +\end{alltt} +to \meta{relative location}. For example: +\begin{verbatim} +\GlsSetXdyNumberGroupOrder{:after \string"Z\string"} +\end{verbatim} +will put the number group after the \qt{Z} letter group. +Again take care of active characters. There's a starred version +that sanitizes the argument (so don't use \cs{string} in it). +\begin{alltt} +\cs{GlsSetXdyNumberGroupOrder}*\{:after "\"O"\} +\end{alltt} \begin{important} -Note that \cs{GlsSetXdyFirstLetterAfterDigits} has no effect if +Note that these commands have no effect if \ics{noist} is used or if \ics{makeglossaries} is omitted. \cs{GlsSetXdyFirstLetterAfterDigits} must be used before \ics{makeglossaries}.\par \end{important} + \chapter{Defining New Glossaries} \label{sec:newglossary} @@ -8700,9 +9587,7 @@ 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 \meta{display} you can use -\par -\DescribeMacro{\GlsUseAcrEntryDispStyle} -\begin{definition} +\begin{definition}[\DescribeMacro\GlsUseAcrEntryDispStyle] \cs{GlsUseAcrEntryDispStyle}\marg{style name} \end{definition} to use the \meta{display} definition from the style given by @@ -9919,6 +10804,10 @@ given entry by placing \ics{nopostdesc} in the entry's description. As from version 3.03 you can now use the package option \pkgopt{nopostdot} to suppress this full stop. This is the better option if you want to use the \sty{glossaries-extra} package. +The \sty{glossaries-extra-stylemods} package provides some +adjustments some of to the predefined styles listed here, allowing +for greater flexibility. See the \sty{glossaries-extra} +documentation for further details. \subsection{List Styles} \label{sec:liststyles} @@ -9932,7 +10821,9 @@ these styles will automatically be available unless you use the \begin{important} Note that, except for the \glostyle{listdotted} style, these -list styles are incompatible with \sty{classicthesis}. +list styles are incompatible with \sty{classicthesis}. They +may also be incompatible with other classes or packages that +modify the \env{description} environment. \end{important} \begin{description} @@ -11765,8 +12656,7 @@ non-empty value for the \gloskey{prefixplural} key. Does \meta{true part} if the entry identified by \meta{label} has a non-empty value for the \gloskey{prefixfirst} key. -\DescribeMacro\ifglshasprefixfirstplural -\begin{definition} +\begin{definition}[\DescribeMacro\ifglshasprefixfirstplural] \cs{ifglshasprefixfirstplural}\marg{label}\marg{true part}\marg{false part} \end{definition} Does \meta{true part} if the entry identified by \meta{label} has a @@ -11791,8 +12681,7 @@ Displays the value of the \gloskey{prefixplural} key for the entry given by \meta{label}. (No check is performed to determine if the entry exists.) -\DescribeMacro\glsentryprefixfirstplural -\begin{definition} +\begin{definition}[\DescribeMacro\glsentryprefixfirstplural] \cs{glsentryprefixfirstplural}\marg{label} \end{definition} Displays the value of the \gloskey{prefixfirstplural} key for the entry given @@ -11812,8 +12701,7 @@ apply.}: \cs{Glsentryprefixplural}\marg{label} \end{definition} -\DescribeMacro\Glsentryprefixfirstplural -\begin{definition} +\begin{definition}[\DescribeMacro\Glsentryprefixfirstplural] \cs{Glsentryprefixfirstplural}\marg{label} \end{definition} @@ -11907,7 +12795,8 @@ that you also read the \sty{accsupp} documentation. \chapter{Troubleshooting} \label{sec:trouble} -The \styfmt{glossaries} package comes with some minimal example +In addition to the sample files listed in \sectionref{sec:samples}, +the \styfmt{glossaries} package comes with some minimal example files, \texttt{minimalgls.tex}, \texttt{mwe-gls.tex}, \texttt{mwe-acr.tex} and \texttt{mwe-acr-desc.tex}, which can be used for testing. These should be located in the \texttt{samples} @@ -11916,6 +12805,8 @@ directory. The location varies according to your operating system and \TeX\ installation. For example, on my Linux partition it can be found in \texttt{/usr\slash local\slash texlive\slash 2014\slash texmf-dist\slash doc\slash latex\slash glossaries/}. +The \gls{makeglossariesgui} application can also be used to test for +various problems. Further information on debugging \LaTeX\ code is available at \url{http://www.dickimaw-books.com/latex/minexample/}. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index 66d476fd9d1..ea4a11c301a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -17,6 +17,7 @@ /* start css.sty */ .cmr-17{font-size:170%;} .cmr-12{font-size:120%;} +.cmr-8{font-size:80%;} .cmtt-12{font-size:120%;font-family: monospace;} .cmtt-12{font-family: monospace;} .cmtt-12{font-family: monospace;} @@ -26,12 +27,14 @@ .cmbx-9{ font-weight: bold;} .cmss-9{font-size:90%; font-family: sans-serif;} .cmss-9{ font-family: sans-serif;} +.cmss-9{ font-family: sans-serif;} .cmtt-10{font-family: monospace;} .cmtt-10{font-family: monospace;} .cmtt-10{font-family: monospace;} .cmtt-10{font-family: monospace;} .cmss-10{ font-family: sans-serif;} .cmss-10{ font-family: sans-serif;} +.cmss-10{ font-family: sans-serif;} .cmti-10{ font-style: italic;} .cmtt-9{font-size:90%;font-family: monospace;} .cmtt-9{font-family: monospace;} @@ -41,6 +44,10 @@ .cmbx-10{ font-weight: bold;} .cmbx-10{ font-weight: bold;} .cmsy-9{font-size:90%;} +.cmss-8{font-size:80%; font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.small-caps{font-variant: small-caps; } p.noindent { text-indent: 0em } td p.noindent { text-indent: 0em; margin-top:0em; } p.nopar { text-indent: 0em; } @@ -172,7 +179,7 @@ div.array {text-align:center;} .equation-star td{text-align:center; } table.equation-star { width:100%; } table.equation { width:100%; } -table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:100%; margin-left:5%; white-space: nowrap;} +table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:95%; margin-left:5%; white-space: nowrap;} table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;} td.align-label { width:5%; text-align:center; } td.align-odd { text-align:right; padding-right:0.3em;} @@ -186,6 +193,46 @@ div.longtable{text-align:center;} .supertabular {text-align:center} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} +span#textcolor1{color:#00FF00} +span#textcolor2{color:#00FF00} +span#textcolor3{color:#00FF00} +span#textcolor4{color:#FF0000} +span#textcolor5{color:#00FF00} +span#textcolor6{color:#FF0000} +span#textcolor7{color:#FF0000} +span#textcolor8{color:#FF0000} +span#textcolor9{color:#00FF00} +span#textcolor10{color:#00FF00} +span#textcolor11{color:#FF0000} +span#textcolor12{color:#00FF00} +span#textcolor13{color:#00FF00} +span#textcolor14{color:#00FF00} +span#textcolor15{color:#00FF00} +span#textcolor16{color:#FF0000} +span#textcolor17{color:#FF0000} +span#textcolor18{color:#FF0000} +span#textcolor19{color:#00FF00} +span#textcolor20{color:#00FF00} +span#textcolor21{color:#FF0000} +span#textcolor22{color:#00FF00} +span#textcolor23{color:#00FF00} +span#textcolor24{color:#00FF00} +span#textcolor25{color:#00FF00} +span#textcolor26{color:#FF0000} +span#textcolor27{color:#FF0000} +span#textcolor28{color:#00FF00} +span#textcolor29{color:#FF0000} +span#textcolor30{color:#FF0000} +span#textcolor31{color:#FF0000} +span#textcolor32{color:#00FF00} +span#textcolor33{color:#FF0000} +span#textcolor34{color:#00FF00} +span#textcolor35{color:#00FF00} +span#textcolor36{color:#00FF00} +span#textcolor37{color:#00FF00} +span#textcolor38{color:#FF0000} +span#textcolor39{color:#00FF00} +span#textcolor40{color:#00FF00} /* end css.sty */ @@ -193,22 +240,22 @@ div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; cle -

    -

    +

    -

    +

    -

    -

    The glossaries package v4.32: a guide for +

    +

    The glossaries package v4.33: a guide for beginners

    @@ -220,36 +267,36 @@ id="TBL-1-1" /> Nicola L.C. Talbot
    -

    2017-08-24

    +

    2017-09-20

    -

    -

    +

    Abstract

    -

    The glossaries package is very flexible, but this means that it has a lot options, and since a user guide is supposed to provide a complete list of all +class="cmr-9">of options, and since a user guide is supposed to provide a complete list the high-level user commands, the main user manual is quite big. This can +class="cmr-9">of all the high-level user commands, the main user manual is quite big. be rather daunting for beginners, so this document is a brief introduction +class="cmr-9">This can be rather daunting for beginners, so this document is a brief just to help get you started. If you find yourself saying, “Yeah, but how +class="cmr-9">introduction just to help get you started. If you find yourself saying, “Yeah, can I dobut how can I do…?” then it’s time to move on to the main user manual. -

    I’ve made some statements in this document that don’t actually tell you the full truth, but it would clutter the document and cause confusion @@ -287,12 +334,12 @@ href="#sec:xr" id="QQ2-1-10">Cross-References
    9 Further Information

    -

    +

    -

    Top

    1 Getting Started

    -

    As with all packages, you need to load

    As with all packages, you need to load glossaries with \usepackage, but there are certain packages that must be loaded before fontencglossaries.) -

    If you require multilingual support you must also install the relevant +

    If you require multilingual support you must also install the relevant language module. Each language module is called glossaries-language⟩, where @@ -324,8 +371,8 @@ class="cmtt-10">glossaries-german. If a language module is required, the class="cmss-10">glossaries package will automatically try to load it and will give a warning if the module isn’t found.
    -

    -

    Once you have loaded

    +

    Once you have loaded glossaries, you need to define your terms in the preamble and then you can use them throughout the document. Here’s a simple example: @@ -334,34 +381,34 @@ example:

    -\documentclass{article} - 
    \usepackage{glossaries} - 
    \newglossaryentry{ex}{name={sample},description={an example}} - 
    \begin{document} - 
    Here's my \gls{ex} term. - 
    \end{document} + \documentclass{article} + 
     \usepackage{glossaries} + 
     \newglossaryentry{ex}{name={sample},description={an example}} + 
     \begin{document} + 
     Here's my \gls{ex} term. + 
     \end{document}
    -

    This produces: -
    Here’s my sample term. -
    -Here’s another example: +

    This produces: +

    +

    Here’s my sample term.

    +

    Here’s another example:

    -\documentclass{article} - 
    \usepackage{glossaries} - 
    \setacronymstyle{long-short} - 
    \newacronym{svm}{SVM}{support vector machine} - 
    \begin{document} - 
    First use: \gls{svm}. Second use: \gls{svm}. - 
    \end{document} -
    -

    This produces: -
    First use: support vector machine (SVM). Second use: SVM. -
    -In this case, the text produced by  \usepackage{glossaries} + 
     \setacronymstyle{long-short} + 
     \newacronym{svm}{SVM}{support vector machine} + 
     \begin{document} + 
     First use: \gls{svm}. Second use: \gls{svm}. + 
     \end{document} +

    +

    This produces: +

    +

    First use: support vector machine (SVM). Second use: SVM.

    +

    In this case, the text produced by \gls{svm} changed after the first use. The first use produced the long form followed by the short form in parentheses because I set the acronym style to .log file and search for the line that starts with Package: glossaries followed by a date and version.) -

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

    Abbreviations are slightly different if you use the extension package glossaries-extra +(which needs to be installed separately): + + + +

    +
    + \documentclass{article} + 
     \usepackage{glossaries-extra} + 
     \setabbreviationstyle{long-short}% glossaries-extra.sty + 
     \newabbreviation{svm}{SVM}{support vector machine}% glossaries-extra.sty + 
     \begin{document} + 
     First use: \gls{svm}. Second use: \gls{svm}. + 
     \end{document} +
    +

    If you still want to use \newacronym (rather than \newabbreviation) then you need +the optional argument of \setabbreviationstyle: + + + +

    +
    + \documentclass{article} + 
     \usepackage{glossaries-extra} + 
     \setabbreviationstyle[acronym]{long-short}% glossaries-extra.sty only + 
     \newacronym{svm}{SVM}{support vector machine} + 
     \begin{document} + 
     First use: \gls{svm}. Second use: \gls{svm}. + 
     \end{document} +
    +

    +

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

    +

    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 @@ -384,177 +472,394 @@ filename as the argument. For example:

    -
    +
    \loadglsentries{defns}
    -

    -

    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 in the -above to \textsc{svm}, then I need to select a style that uses \textsc, like -this: +

    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 bib2gls (installed separately) which +requires a .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 +with the underlying mechanism. Instead, the formatting should be done by the +style. For example, suppose I want to replace SVM with \textsc{svm}, then +I need to select a style that uses \textsc, like this (for the base glossaries +style):

    -
    -\documentclass{article} - 
    \usepackage{glossaries} - 
    \setacronymstyle{long-sc-short} - 
    \newacronym{svm}{svm}{support vector machine} - 
    \begin{document} - 
    First use: \gls{svm}. Second use: \gls{svm}. - 
    \end{document} +
    + \documentclass{article} + 
     \usepackage{glossaries} + 
     \setacronymstyle{long-sc-short} + 
     \newacronym{svm}{svm}{support vector machine} + 
     \begin{document} + 
     First use: \gls{svm}. Second use: \gls{svm}. + 
     \end{document} +
    +

    The abbreviation styles have a different naming scheme with glossaries-extra: + + + +

    +
    + \documentclass{article} + 
     \usepackage{glossaries-extra} + 
     \setabbreviationstyle{long-short-sc}% glossaries-extra.sty + 
     \newabbreviation{svm}{svm}{support vector machine}% glossaries-extra.sty + 
     \begin{document} + 
     First use: \gls{svm}. Second use: \gls{svm}. + 
     \end{document}
    -

    -

    As you can hopefully see from the above examples, there are two main ways of -defining a term. In both cases, the term is given a label. In the first case the label -was ex and in the second case the label was svm. The label is just a way of -identifying the term (like the standard

    With glossaries-extra you can have multiple abbreviation styles for different +categories. Many of these styles have their own associated formatting commands that +can be redefined for minor adjustments. For example: + + + +

    +
    + \documentclass{article} + 
     \usepackage{glossaries-extra} + 
     \setabbreviationstyle[statistical]{long-short-sc} + 
     \setabbreviationstyle[bacteria]{long-only-short-only} + 
     % Formatting commands used by 'long-only-short-only' style: + 
     \renewcommand*{\glsabbrvonlyfont}[1]{\emph{#1}} + 
     \renewcommand*{\glslongonlyfont}[1]{\emph{#1}} + 
     % Formatting command used by 'long-short-sc' style: + 
     % (make sure abbreviation is converted to lower case) + 
     \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}} + 
     \newabbreviation + 
      [ + 
        category={statistical}% glossaries-extra.sty key + 
      ] + 
      {svm}{SVM}{support vector machine} + 
     \newabbreviation + 
      [ + 
        category={bacteria}% glossaries-extra.sty key + 
      ] + 
      {cbot}{C.~botulinum}{Clostridium botulinum} + 
     \begin{document} + 
     First use: \gls{svm}, \gls{cbot}. + 
     Next use: \gls{svm}, \gls{cbot}. + 
     \end{document} +
    +

    This produces: +

    +

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

    Next use: svm, C. botulinum.

    +

    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 + + + +the first example, the label was ex and in the other examples the label was svm (and +cbot in the last example). The label is used to uniquely identify the term (like the +standard \label/\ref mechanism). It’s best to just use -the following alphanumerics in the labels: \ref or \cite mechanism). It’s best to just use the following +alphanumerics in the labels: a, …, z, A, …, Z, 0, …, 9. Sometimes you can -also use punctuation characters but not if another package (such as 9. Sometimes you can also use +punctuation characters but not if another package (such as babel) -meddles with them. Don’t try using any characters outside of the basic Latin -set (for example, é or ß) or things will go horribly wrong. This warning + id="dx1-2012">) meddles with +them. Don’t try using any characters outside of the basic Latin set with +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 \gls in chapter or section headings as it can have some -unpleasant side-effects. Instead use \glsentrytext for regular entries and -one of \glsentryshort,

    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 \glsentryshort, +\glsentrylong or \glsentryfull for acronyms. -
    -

    -

    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 glossaries package provides three options: use TEX to perform the -sorting; use makeindex to perform the sorting; use xindy to perform the -sorting. -

    The first option (using TEX) is the simplest and easiest method, but -it’s inefficient and the sorting is done according to the English alphabet. -To use this method, add \glsentryfull for acronyms. Alternatively use glossaries-extra +which provides special commands for use in section headings, such as \glsfmtshort +{label}.

    +

    +

    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 +glossaries-extra package provides a really easy way of listing all the defined +entries: + + + +

    +
    + \documentclass{article} + 
     \usepackage[sort=none]{glossaries-extra} + 
     \newglossaryentry{potato}{name={potato},plural={potatoes}, + 
      description={starchy tuber}} + 
     \newglossaryentry{cabbage}{name={cabbage}, + 
      description={vegetable with thick green or purple leaves}} + 
     \newglossaryentry{turnip}{name={turnip}, + 
      description={round pale root vegetable}} + 
     \newglossaryentry{carrot}{name={carrot}, + 
      description={orange root}} + 
     \begin{document} + 
     Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. + 
     \printunsrtglossaries % list all entries + 
     \end{document} +
    +

    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 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 (\printunsrtglossaries) +that’s used with bib2gls (Option 4) but with bib2gls you instead need to use the +record 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 +that have been used in the document. The glossaries package provides three options: +use TEX to perform the sorting (Option 1); use makeindex to perform +the sorting (Option 2); use xindy to perform the sorting (Option 3). The +extension package glossaries-extra provides a fourth method: use bib2gls +(Option 4). +

    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 \makenoidxglossaries to the preamble and put \printnoidxglossaries at the place where you want your glossary. For + + + example:

    -
    -\documentclass{article} - 
    \usepackage{glossaries} - 
    \makenoidxglossaries - 
    \newglossaryentry{potato}{name={potato},plural={potatoes}, - 
     description={starchy tuber}} - 
    \newglossaryentry{cabbage}{name={cabbage}, - 
     description={vegetable with thick green or purple leaves}} - 
    \newglossaryentry{carrot}{name={carrot}, - 
     description={orange root}} - 
    \begin{document} - 
    Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. - 
    \printnoidxglossaries - 
    \end{document} -
    -

    Try this out and run LAT + \documentclass{article} + 
     \usepackage{glossaries} + 
     \makenoidxglossaries % use TeX to sort + 
     \newglossaryentry{potato}{name={potato},plural={potatoes}, + 
      description={starchy tuber}} + 
     \newglossaryentry{cabbage}{name={cabbage}, + 
      description={vegetable with thick green or purple leaves}} + 
     \newglossaryentry{turnip}{name={turnip}, + 
      description={round pale root vegetable}} + 
     \newglossaryentry{carrot}{name={carrot}, + 
      description={orange root}} + 
     \begin{document} + 
     Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. + 
     \printnoidxglossaries + 
     \end{document} +

    +

    +

    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 LATEX (or pdfLATEX) twice. The first run won’t -show the glossary. It will only appear on the second run. 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 to the package +class="cmti-10">twice. The first run won’t show the +glossary. It will only appear on the second run. This doesn’t include “turnip” in the +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. +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 to the package options:

    -
    +
    \usepackage[nogroupskip]{glossaries}
    -

    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, so you can lookup the term in the glossary +

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

    +
    +\usepackage[style=indexgroup]{glossaries} +
    +

    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 back-reference, in which case you can suppress it using the nonumberlist package +class="cmss-10">nonumberlist package option:

    -
    +
    \usepackage[nonumberlist]{glossaries}
    -

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

    If you don’t like the terminating full stop, you can suppress that with the nopostdot package option:

    -
    +
    \usepackage[nopostdot]{glossaries}
    -

    -

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

    +

    If you tried out the previous example with glossaries-extra and \printunsrtglossaries +the terminating full stop is missing and there are no number lists. You can add the +full stop back with + + + +

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

    or + + + +

    +
    +\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: \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 makeindex or xindy. If you are using extended Latin or non-Latin characters, then -xindy is the recommended method. These two methods are described in more detail -in makeindex (Option 2) or xindy (Option 3) or bib2gls (Option 4). If you are using +extended Latin or non-Latin characters, then xindy or bib2gls are the +recommended methods. These methods are described in more detail in §4 Displaying a List of Entries. -

    The rest of this document briefly describes the main commands provided by the +href="#sec:printglossaries">Displaying +a List of Entries. +

    The rest of this document briefly describes the main commands provided by the glossaries package. -

    +class="cmss-10">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, acronym or symbol. +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{ options⟩ class="cmtt-10">}

    -

    + + + +

    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 this command in your document.) The ⟨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: -
      +
      \newglossaryentry{set}  
      {  
        name={set},  
        description={a collection of objects}  
      }
      -

      +

    2. Define the symbol emptyset: -
      +
      \newglossaryentry{emptyset}  
      {  
        name={\ensuremath{\emptyset}},  
        description={the empty set}  
      }
      -

      +

      (This will also need a sort key if you use Options 1 or 3, see below.)

    3. Define the phrase “Fish Age” with the label fishage: -
      +
      \longnewglossaryentry{fishage}  
      {name={Fish Age}}  
      {% @@ -674,7 +982,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.)

    4. é). This first letter must be placed in a g -
      +
      \newglossaryentry{elite}  
      {  
        name={{\'e}lite},  
        description={select group or class}  
      }
      -

      or

      +

      or

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

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

    Acronyms (or other abbreviations) can be defined using -


    \newacronym{label}{short}{long}

    -

    -where ⟨label⟩ is the label (as with the \newglossaryentry and the \longnewglossaryentry -commands), ⟨short⟩ is the short form and ⟨long⟩ is the long form. For example, the -following defines an abbreviation: +

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

    If you use bib2gls with glossaries-extra then the terms must be defined in a .bib +file. For example:

    +
    +% Encoding: UTF-8 +
    +
    @entry{set, +
      name={set}, +
      description={a collection of objects} +
    } +
    +
    @entry{emptyset, +
      name={\ensuremath{\emptyset}}, +
      description={the empty set} +
    } +
    +
    @entry{fishage, +
      name={Fish Age}, +
      description={A common name for the Devonian geologic period +
      spanning from the end of the Silurian Period to +
      the beginning of the Carboniferous Period. + + + +
    +
      This age was known for its remarkable variety of +
      fish species.} +
    } +
    +
    @entry{elite, +
      name={{é}lite}, +
      description={select group or class} +
    } +
    +
    (The .bib format doesn’t allow spaces in labels so you can’t have fish age as the +label, but you can have fish-age.) This method requires the glossaries-extra’s record +package option: + + + +
    +\usepackage[record]{glossaries-extra} +
    +

    and the .bib file is specified in the resource command. For example, if the +.bib file is called entries.bib then put the following line in the document +preamble:

    -
    -\newacronym{svm}{svm}{support vector machine} +
    +\GlsXtrLoadResources[src={entries}]
    -

    This defines a glossary entry with the label svm. By default, the ⟨name⟩ is set -to ⟨short⟩ (“svm” in the above example) and the ⟨description⟩ is set to ⟨long⟩ -(“support vector machine” in the above example). If, instead, you want to -be able to specify your own description you can do this using the optional -argument: +

    You can have a comma-separated list. For example, if you also have entries defined +in the file entries2.bib:

    -
    -\newacronym - 
     [description={statistical pattern recognition technique}] - 
     {svm}{svm}{support vector machine} +
    +\GlsXtrLoadResources[src={entries,entries2.bib}]
    -

    -

    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: long-short (on first use display the long form with the short form in -parentheses); short-long (on first use display the short form with the long form in -parentheses); long-short-desc (like long-short but you need to specify the -description); or short-long-desc (like short-long but you need to specify the -description). There are some other styles as well that use \textsc to typeset the -acronym or that use a footnote on first use. See the main user guide for further -details. -

    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 used above indicates how the term should appear in the list of entries (glossary). -If the term should appear differently when you reference it in the document, you need -to use the \gls{label} in the +document, you need to use the text key as well. -

    For example: +

    For example:

    -
    +
    \newglossaryentry{latinalph}  
    {  
      name={Latin Alphabet}, @@ -811,9 +1236,26 @@ 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 as -“Latin Alphabet”. -

    Another commonly used key is

    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 .bib file +as: + + + +

    +
    +@entry{latinalph, + 
      name={Latin Alphabet}, + 
      text={Latin alphabet}, + 
      description={alphabet consisting of the letters + 
      a, \ldots, z, A, \ldots, Z} + 
    } +
    +

    +

    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, @@ -823,7 +1265,7 @@ class="cmtt-10">plural key to override it:

    -
    +
    \newglossaryentry{oesophagus}  
    {  
      name={{\oe}sophagus}, @@ -831,148 +1273,681 @@ 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.) -

    The plural forms for acronyms can be specified using the longplural and -shortplural keys. For example: +

    Abbreviations can be defined using +


    \newacronym[options]{label}{short}{long}

    +

    +where ⟨label⟩ is the label (as per \newglossaryentry), ⟨short⟩ is the short form and +⟨long⟩ is the long form. For example, the following defines an abbreviation:

    -
    -\newacronym - 
     [longplural={diagonal matrices}] - 
     {dm}{DM}{diagonal matrix} -
    -

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

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

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

    This internally uses \newglossaryentry to define an entry with the label svm. By +default, the name key is set to ⟨short⟩ (“SVM” in the above example) and the +description key is set to ⟨long⟩ (“support vector machine” in the above example). If, +instead, you want to be able to specify your own description you can do this using +the optional argument:

    -
    -\newglossaryentry{emptyset} - 
    { - 
      name={empty set}, - 
      symbol={\ensuremath{\emptyset}}, - 
      description={the set containing no elements} - 
    } +
    +\newacronym + 
     [description={statistical pattern recognition technique}] + 
     {svm}{SVM}{support vector machine}
    -

    -

    -

    -

    Top

    3 Using Entries

    -

    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

    +

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


    \setacronymstyle{style name}

    -

    +

    where ⟨label⟩ is the label you assigned to the entry when you defined it. For example, -\gls{fishage} will display “Fish Age” in the text (given the definition from the -previous section). -

    If you are using the hyperref package (remember to load it before glossaries) \gls -will create a hyperlink to the corresponding entry in the glossary. If you want to -suppress the hyperlink for a particular instance, use the starred form \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 \newacronym described above), -then \gls will display the full form the first time it’s used and just the -short form on subsequent use. For example, if the acronym style is set to +class="cmti-10">style name⟩ is the name of the style. There are a number of predefined styles, +such as: long-short (on first use display the long form with the short form in +parentheses); short-long (on first use display the short form with the long form in +parentheses); long-short-desc (like long-short but you need to specify the +description); or short-long-desc (like short-long but you need to specify the +description). There are some other styles as well that use \textsc to typeset the +acronym or that use a footnote on first use. See the main user guide for further +details. +

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


    \newabbreviation[options]{label}{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 \newacronym the category is +acronym, which is why you need to use the optional argument if you define +abbreviations with \newacronym when glossaries-extra has been loaded:

    +
    +\setabbreviationstyle[acronym]{style name} +
    +
    If you use bib2gls then abbreviations are defined in the .bib file in the format: +
    +
    +@abbreviation{label, +
      long={long form}, + + + +
      short={short form} +
    } +
    +
    +

    The plural forms for abbreviations can be specified using the longplural and long-short, then \gls{svm} will display “support vector machine (svm)” the -first time it’s used, but the next occurrence of \gls{svm} will just display -“svm”. -

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


    shortplural keys. For example: + + + +

    +
    +\newacronym + 
     [longplural={diagonal matrices}] + 
     {dm}{DM}{diagonal matrix} +
    +

    or (with glossaries-extra): + + + +

    +
    +\newabbreviation % glossaries-extra.sty + 
     [longplural={diagonal matrices}] + 
     {dm}{DM}{diagonal matrix} +
    +

    If omitted, the defaults are again obtained by appending an “s” to the singular +versions. With bib2gls, the definition in the .bib file is: + + + +

    +
    +@abbreviation{dm, + 
      short={DM}, + 
      long={diagonal matrix}, + 
      longplural={diagonal matrices} + 
    } +
    +

    +

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

    +
    +\newglossaryentry{emptyset} + 
    { + 
      name={empty set}, + 
      symbol={\ensuremath{\emptyset}}, + 
      description={the set containing no elements} + 
    } +
    +

    or with bib2gls the definition in the .bib file is: + + + +

    +
    +@entry{emptyset, + 
      name={empty set}, + 
      symbol={\ensuremath{\emptyset}}, + 
      description={the set containing no elements} + 
    } +
    +

    +

    If you want the symbol in the name field then you must supply a sort value with +Options 1 and 3 otherwise you’ll end up with errors from TEX or xindy. With +Option 2 (makeindex) it’s not quite so important but you may find the resulting +order is a little odd. For example: + + + +

    +
    +\newglossaryentry{emptyset} + 
    { + 
      name={\ensuremath{\emptyset}}, + 
      sort={empty set}, + 
      description={the set containing no elements} + 
    } +
    +

    This displays the symbol as but sorts according to “empty set”. You +may want to consider using glossaries-extra’s symbols package option which +provides +


    \glsxtrnewsymbol[options]{label}{symbol}

    +

    +This internally uses \newglossaryentry but automatically sets the sort key to the +⟨label⟩. For example: + + + +

    +
    +\documentclass{article} + 
    \usepackage[symbols]{glossaries-extra} + 
    \makeglossaries + 
    \glsxtrnewsymbol % requires glossaries-extra.sty 'symbols' option + 
     [description={the set containing no elements}] + 
     {emptyset}% label (and sort value) + 
     {\ensuremath{\emptyset}}% symbol + 
    \begin{document} + 
    \gls{emptyset} + 
    \printglossaries + 
    \end{document} +
    +

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

    With bib2gls you can define this in the .bib file as + + + +

    +
    +@entry{emptyset, + 
      name={\ensuremath{\emptyset}}, + 
      description={the set containing no elements} + 
    } +
    +

    in which case bib2gls will try to interpret the name field to determine the sort +value. Alternatively you can use: + + + +

    +
    +@symbol{emptyset, + 
      name={\ensuremath{\emptyset}}, + 
      description={the set containing no elements} + 
    } +
    +

    which will use the label (emptyset) as the sort value. (You don’t need the symbols +package option in this case, unless you want a separate symbols list.) The +corresponding document (where the definition is in the file entries.bib) is +now: + + + +

    +
    +\documentclass{article} + 
    \usepackage[record]{glossaries-extra} + 
    \GlsXtrLoadResources[src=entries] + 
    \begin{document} + 
    \gls{emptyset} + 
    \printunsrtglossaries + 
    \end{document} +
    +

    +

    +

    +

    Top

    3 Using Entries

    +

    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, +\gls{fishage} will display “Fish Age” in the text (given the definition from the +previous section). If you are using bib2gls then this will display ?? (like +\ref and \cite) until bib2gls has created the relevant files and LATEX is +rerun. +

    If you are using the hyperref package (remember to load it before glossaries) \gls +will create a hyperlink to the corresponding entry in the glossary. If you want to +suppress the hyperlink for a particular instance, use the starred form \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 \newacronym with glossaries +described above) or an abbreviation (using \newabbreviation with glossaries-extra), +then \gls will display the full form the first time it’s used and just the +short form on subsequent use. For example, if the style is set to long-short, +then \gls{svm} will display “support vector machine (SVM)” the first time +it’s used, but the next occurrence of \gls{svm} will just display “SVM”. +(If you use \newacronym with glossaries-extra the default doesn’t show the +long form on first use. You’ll need to change the style first, as described +earlier.) + + + +

    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:

    -
    +
    \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 choose from -to create your glossary. Here they are again in a little more detail: -

    -

    +href="#sec:start">Getting Started, I mentioned that there are three options you can choose from +to create an automatically sorted glossary with the base glossaries package. These are +also available with the extension package glossaries-extra along with a fourth option. +These four options are listed below in a little more detail. Table 1 summarises the +main advantages and disadvantages. (There’s a more detailed summary in the main +glossaries user manual.) +

    +
    + + + +


    + + + +
    Table 1: Comparison of Glossary Options
    +
    + + + + + + + + + + +

    Option 1 Option 2 Option 3 Option 4

    Requires + glossaries-extra?

    Requires + an + external + application?

    Requires + Perl?

    Requires + Java?

    Can + sort + extended + Latin + or + non-Latin + alphabets?

    Efficient + sort + algorithm?

    Can + use + different + sort + methods + for + each + glossary?

    Any + problematic + sort + values?

    Can + form + ranges + in + the + location + lists?

    Can + have + non-standard + locations?

    +

    Requires some setting up. + + + +

    +

    +
    +
    Option 1: -

    This is the simplest option but it’s slow and if you want a sorted list, it - doesn’t work for non-Latin alphabets. -

    +

    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 sort value must be supplied) unless you + have the package option sanitizesort or sort=def or sort=use.

    1. Add Add \makenoidxglossaries to your preamble (before you start defining your entries, as described in §2 Defining Terms).
    2. Put -


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

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

    3. Run LATRun LATEX twice on your document. (As you would do to make a table of contents appear.) For example, click twice on the “typeset” or “build” or “PDFLATEX” button in your editor.
    -
    +

    Here’s a complete document (myDoc.tex): + + + +

    +
    + \documentclass{article} +  
    \usepackage{glossaries} +  
    \makenoidxglossaries % use TeX to sort +  
    \newglossaryentry{sample}{name={sample}, +  
      description={an example}} +  
    \begin{document} +  
    A \gls{sample}. +  
    \printnoidxglossaries % iterate over all indexed entries +  
    \end{document} +
    +

    Document build: + + + +

    +
    + pdflatex myDoc +  
    pdflatex myDoc +
    +

    +

    Option 2: -

    This option uses an application called makeindex to sort the entries. - This application comes with all modern TEX distributions, but it’s - hard-coded for the non-extended Latin alphabet. This process involves - making LATEX write the glossary information to a temporary file which - makeindex reads. Then makeindex writes a new file containing the - code to typeset the glossary. LATEX then reads this file on the next - run. -

    +

    This option uses an application called makeindex to sort the entries. This + application comes with all modern TEX distributions, but it’s hard-coded for + the non-extended Latin alphabet. This process involves making LATEX write + the glossary information to a temporary file which makeindex reads. + Then makeindex writes a new file containing the code to typeset the + glossary. LATEX then reads this file on the next run. The makeindex + application is automatically invoked by the helper makeglossaries + script, which works out all the appropriate settings from the .aux + file.

    1. If you are using If you are using ngerman or some other package that makes the - double-quote character " a shorthand, then use \GlsSetQuote to change - this to some other character. For example: + id="dx1-5019">1 + or some other package that makes the double-quote character " a + shorthand, then use \GlsSetQuote to change this to some other character. + For example: -
      +
      \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.

    2. Add Add \makeglossaries to your preamble (before you start defining your entries).
    3. Put -


      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 + with one of the package options: sort=standard (default), sort=use or + sort=def.
      +

    4. Run LATRun LATEX on your document. This creates files with the extensions .glo and myDoc.ist). If you look at your document at this point, y glossary as it hasn’t been created yet.
    5. Run makeindex with the .glo file as the input file and the .ist file - as the style so that it creates an output file with the extension + class="enumerate" id="x1-5032x5">Run makeglossaries with the base name of your document (without the .gls. If you have access to a terminal or a command prompt (for - example, the MSDOS command prompt for Windows users or +class="cmtt-10">.tex) extension. If you have access to a terminal or a command prompt + (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command: -
      - makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +
      + makeglossaries myDoc
      -

      (Replace

      (Replace myDoc with the base name of your LATEX document file. Avoid - spaces in the file name.) If you don’t know how to use the command - prompt, then you can probably access makeindex via your text editor, - but each editor has a different method of doing this, so I can’t - give a general description. You will have to check your editor’s - manual. -

      The default sort is word order (“sea lion” comes before “seal”). If you +class="E">EX document file + without the .tex extension. Avoid spaces in the file name.) If you don’t + have Perl installed use makeglossaries-lite instead: + + + +

      +
      + makeglossaries-lite myDoc +
      +

      +

      Some beginners get confused by makeglossaries the application (run as + a system command) and \makeglossaries the LATEX 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 + probably configure your text editor to add makeglossaries (or + makeglossaries-lite) as a build tool, but each editor has a different + method of doing this, so I can’t give a general description. You will have + to check your editor’s manual. If you still have problems, try adding the + automake package option: + + + +

      +
      + \usepackage[automake]{glossaries} +
      +

      +

      The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the -l switch: +class="cmss-10">order=letter package + option

      -
      - makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo +
      + \usepackage[order=letter]{glossaries}
      -

      +

    6. Once you have successfully completed the previous step, you can now run + class="enumerate" id="x1-5041x6">Once you have successfully completed the previous step, you can now run LATEX on your document again.
    -
    +

    Here’s a complete document (myDoc.tex): + + + +

    +
    + \documentclass{article} +  
    \usepackage{glossaries} +  
    \makeglossaries % create makeindex files +  
    \newglossaryentry{sample}{name={sample}, +  
      description={an example}} +  
    \begin{document} +  
    A \gls{sample}. +  
    \printglossaries % input files created by makeindex +  
    \end{document} +
    +

    Document build: + + + +

    +
    + pdflatex myDoc +  
    makeglossaries myDoc +  
    pdflatex myDoc +
    +

    or + + + +

    +
    + pdflatex myDoc +  
    makeglossaries-lite myDoc +  
    pdflatex myDoc +
    +

    +

    Option 3: -

    This option uses an application called xindy to sort the entries. This +

    This option uses an application called xindy to sort the entries. This application is more flexible than makeindex and is able to sort extended Latin - or non-Latin alphabets. It comes with TEX Live but not with MiKTEX. Since - xindy is a Perl script, if you are using MiKTEX you will not only need to - install xindy, you will also need to install Perl. In a similar way to Option 2, - this option involves making LATEX write the glossary information to - a temporary file which xindy reads. Then xindy writes a new file containing - the code to typeset the glossary. LATEX then reads this file on the next - run. -

    +class="cmtt-10">makeindex and is able to sort extended Latin + or non-Latin alphabets. It comes with both TEX Live and MiKTEX. + Since xindy is a Perl script, you will also need to ensure that Perl is + installed. In a similar way to Option 2, this option involves making + LATEX write the glossary information to a temporary file which xindy + reads. Then xindy writes a new file containing the code to typeset + the glossary. LATEX then reads this file on the next run. The xindy + application is automatically invoked by the helper makeglossaries + script, which works out all the appropriate settings from the .aux + file.

    1. Add the xindy option to the Add the xindy option to the glossaries package option list: + id="dx1-5052"> package option list: -
      +
      \usepackage[xindy]{glossaries}
      -

      +

    2. Add Add \makeglossaries to your preamble (before you start defining your entries).
    3. Put -


      Put +


      \printglossary[options]

      -

      +

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



      \printglossaries

      -

      +

      +

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

    4. Run LATRun LATEX on your document. This creates files with the extensions .glo and myDoc.xdy). If you look at your document at this point, y glossary as it hasn’t been created yet.
    5. Run xindy with the .glo file as the input file and the .xdy file as - a module so that it creates an output file with the extension .gls. You - also need to set the language name and input encoding. If you have - access to a terminal or a command prompt (for example, the - MSDOS command prompt for Windows users or the bash console for - Unix-like users) then you need to run the command (all on one - line): + class="enumerate" id="x1-5063x5">Run makeglossaries with the base name of the document (omitting the + .tex extension). If you have access to a terminal or a command prompt + (for example, the MSDOS command prompt for Windows users or + the bash console for Unix-like users) then you need to run the + command: -
      - xindy  -L english -C utf8 -I xindy -M myDoc -  
      -t myDoc.glg -o myDoc.gls myDoc.glo +
      + makeglossaries myDoc
      -

      (Replace

      (Replace myDoc with the base name of your LATEX document file. Avoid - spaces in the file name. If necessary, also replace english with the name - of your language and utf8 with your input encoding.) If you don’t know - how to use the command prompt, then you can probably access xindy via - your text editor, but each editor has a different method of doing this, so - I can’t give a general description. You will have to check your editor’s - manual. -

      The default sort is word order (“sea lion” comes before “seal”). If you +class="E">EX document file + without the .tex extension. Avoid spaces in the file name. If you don’t + know how to use the command prompt, then as mentioned above, you may + be able to configure your text editor to add makeglossaries as a build + tool. +

      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: @@ -1245,114 +2365,304 @@ class="cmtt-10">order=letter package

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

      +

    6. Once you have successfully completed the previous step, you can now run + class="enumerate" id="x1-5067x6">Once you have successfully completed the previous step, you can now run LATEX on your document again.
    -
    -

    For Options 

    Here’s a complete document (myDoc.tex): + + + +

    +
    + \documentclass{article} +  
    \usepackage[xindy]{glossaries} +  
    \makeglossaries % create xindy files +  
    \newglossaryentry{sample}{name={sample}, +  
      description={an example}} +  
    \begin{document} +  
    A \gls{sample}. +  
    \printglossaries % input files created by xindy +  
    \end{document} +
    +

    Document build: + + + +

    +
    + pdflatex myDoc +  
    makeglossaries myDoc +  
    pdflatex myDoc +
    +

    +

    +
    Option 4: +

    This requires the extension package glossaries-extra and an application called + bib2gls. This application is able to sort extended Latin or non-Latin + alphabets. It comes with both TEX Live and MiKTEX but requires at least + Java 7. This method works differently to Options 2 and 3, it can be difficult to remember all the parameters required -for makeindex or xindy, so the glossaries package provides a script called -makeglossaries that reads the .aux file to determine what settings you have used -and will then run makeindex or xindy. Again, this is a command line application -and can be run in a terminal or command prompt. For example, if your -LATEX document is in the file myDoc.tex, then run: +href="#option3">3. Instead of + creating a file containing the code to typeset the glossary it creates a + .glstex file containing the entry definitions fetched from the .bib file (or + files), but only those entries that are required in the document are + defined and they are defined in the order obtained from the chosen sort + method. This means that you can just use \printunsrtglossary to + display each glossary (or \printunsrtglossaries to display them + all). +

      +
    1. Add the record option to the glossaries-extra package option list: + + + +
      + \usepackage[record]{glossaries-extra} +
      +

      +

    2. +
    3. Add one or more +


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

      +

      + to your preamble where ⟨bib list⟩ is the list of .bib files containing the + entries. You may use different sort methods for each resource set. For + example:

      -
      -makeglossaries myDoc +
      + \usepackage[record,% using bib2gls +  
       abbreviations, +  
       symbols, +  
       numbers +  
      ]{glossaries-extra} +  
      \GlsXtrLoadResources[ +  
        src={terms},% entries in terms.bib +  
        type=main,% put these entries in the 'main' (default) list +  
        sort={de-CH-1996}% sort according to this locale +  
      ] +  
      \GlsXtrLoadResources[ +  
        src={abbrvs},% entries in abbrvs.bib +  
        type=abbreviations,% put these entries in the 'abbreviations' list +  
        sort={letter-case}% case-sensitive letter (non-locale) sort +  
      ] +  
      \GlsXtrLoadResources[ +  
        src={syms},% entries in syms.bib +  
        type=symbols,% put these entries in the 'symbols' list +  
        sort={use}% sort according to first use in the document +  
      ] +  
      \GlsXtrLoadResources[ +  
        src={constants},% entries in constants.bib +  
        type=numbers,% put these entries in the 'numbers' list +  
        sort-field={user1},% sort according to this field +  
        sort={double}% double-precision sort +  
      ] +
      +

      The last resource set assumes that the entries defined in the file + constants.bib have a number stored in the user1 field. For + example: + + + +

      +
      + @number{pi, +  
        name={\ensuremath{\pi}}, +  
        description={pi}, +  
        user1={3.141592654} +  
      } +
      +

      +

    4. +
    5. 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

      +

      +

    6. +
    7. Run LATEX on your document. The record option adds information to + the .aux file that provides bib2gls with all required details for each + resource set. For example, if the file is called myDoc.tex: + + + +
      + pdflatex myDoc
      -

      (Replace myDoc with the base name of your LATEX document file. Avoid -spaces in the file name.) If you don’t know how to use the command prompt, -you can probably access makeglossaries via your text editor. Check your -editor’s manual for advice. If you are using arara then you can just use the -directives: +

      +

    8. +
    9. Run bib2gls +
      + bib2gls myDoc +
      +

      or (if you need letter groups) + + + +

      +
      + bib2gls --group myDoc +
      +

      +

    10. +
    11. Run LATEX again.
    +

    Here’s a complete document (myDoc.tex): + + + +

    +
    + \documentclass{article} +  
    \usepackage[record]{glossaries-extra} +  
    \GlsXtrLoadResources % input file created by bib2gls +  
     [% instructions to bib2gls: +  
       src={entries}, % terms defined in entries.bib +  
       sort={en-GB}% sort according to this locale +  
     ] +  
    \newglossaryentry{sample}{name={sample}, +  
      description={an example}} +  
    \begin{document} +  
    A \gls{sample}. +  
    \printunsrtglossaries % iterate over all defined entries +  
    \end{document} +
    +

    The accompanying entries.bib file: + + + +

    +
    + @entry{sample, +  
      name = {sample}, +  
      description = {an example} +  
    } +
    +

    Document build: + + + +

    +
    + pdflatex myDoc +  
    bib2gls myDoc +  
    pdflatex myDoc +
    +

    -
    - arara: pdflatex - 
     arara: makeglossaries - 
     arara: pdflatex -
    -

    -

    The makeglossaries script is written in Perl, so you need a Perl interpreter -installed. If you are using a Unix-like operating system then you most likely have one -installed. If you are using Windows with the TEX Live distribution, then you can -use the Perl interpreter that comes with TEX Live. If you are using Windows and -MiKTEX then you need to install a Perl distribution for Windows. If you are using -Option 3, then you need to do this anyway as xindy is also written in Perl. -If you are using Option 2 and can’t work out how to install Perl (or for -some reason don’t want to install it) then just use makeindex directly, as -described above, or you can use a Lua alternative to makeglossaries called -makeglossaries-lite.lua: +

    +

    If you are having difficulty integrating makeglossaries into your document build +process, you may want to consider using arara, which is a Java application that +searches the document for special comment lines that tell arara which applications +to run. For example, the file myDoc.tex might start with:

    -
    -makeglossaries-lite.lua myDoc +
    + % arara: pdflatex + 
     % arara: makeglossaries + 
     % arara: pdflatex + 
     \documentclass{article} + 
     \usepackage{glossaries} + 
     \makeglossaries
    -

    -

    As a last resort you can try the package option automake: +

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

    -
    -\usepackage[automake]{glossaries} -
    -

    This will attempt to use TEX’s \write18 mechanism to run makeindex or xindy. It -probably won’t work for xindy and won’t work at all if the shell escape has been -disabled in your TEX distribution. Most TEX distributions will allow a restricted -shell escape, which will only allow trusted applications to be run. If the automake -option is successful, you will still need to run LATEX twice for the glossaries to be -displayed. -

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

    + arara myDoc +
    +

    (The currently pending version 4.0 of arara has directives for makeglossaries-lite +and bib2gls. These aren’t available in earlier versions, but you could try copying +and adapting the makeglossaries.yaml file and replace makeglossaries as +appropriate.) +

    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 @@ -1361,14 +2671,14 @@ earlier definition:

    -
    -\newglossaryentry{elite} - 
    { - 
      name={{\'e}lite}, - 
      description={select group or class} - 
    } -
    -

    No + \newglossaryentry{elite} + 
     { + 
       name={{\'e}lite}, + 
       description={select group or class} + 
     } +

    +

    No sort key was used, so it’s set to the same as the name key: {\’e}lite. How this @@ -1384,12 +2694,15 @@ class="description">By default, the accent command will be stripped so the sort class="cmtt-10">elite. This will put the entry in the “E” letter group. However if you use the sanitizesort=true package option, the sort value will be + id="dx1-5094"> package option, the sort value will be interpreted as the sequence of characters: { \ ’ e l i t and e. This will place - this entry before the “A” letter group since it starts with a symbol. +class="cmtt-10">’ e } l i t and e. This will + place this entry in the “symbols” group since it starts with a symbol.

    }lit and e. The first character is an opening curly brace { so makeindex +class="cmtt-10">makeindex will put this entry in the “symbols” group.
    Option 3:
    xindy disregards LATxindy disregards LATEX commands so it sorts on elite, which - puts this entry in the “E” group.
    -

    If the elite, which puts + this entry in the “E” group. If stripping all commands leads to an empty string + (such as \ensuremath{\emptyset}) then xindy will fail, so in these + situations you need to provide an appropriate sort value that xindy will + accept. +

    xindy merges entries with duplicate sort values. xindy forbids empty sort + values. A sort value may degrade into an empty or duplicate value once xindy + has stripped all commands and braces.
    +

    +

    +Option 4:
    bib2gls has a primitive LATEX parser that recognises a limited set of + commands, which includes the standard accent commands and some maths + commands, so it can convert {\’e}lite to élite. It disregards unknown + commands. This may lead to an empty sort value, but bib2gls doesn’t mind + that. +

    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 É + depending on the locale used by the sort comparator. In this case you + + + + will need to ensure the document can support this character either + with inputenc or by switching to a LATEX engine with native UTF-8 + support. +

    +
    +

    If the inputenc package is used and the entry is defined as:

    + id="dx1-5105"> package is used: + + + +

    +
    + \usepackage[utf8]{inputenc} +
    +

    and the entry is defined as:

    - \newglossaryentry{elite} -
     {
       name={{é}lite},
       description={select group or class} -
     }
    then: @@ -1454,15 +2836,13 @@ class="description">By default the sort value will be interpreted as elite so the entry will be put in the “E” letter group. If you use the sanitizesort=true package + id="dx1-5106"> package option, the sort value will be interpreted as élite where é has been - sanitized (so it’s no longer an active character) which will put this entry - before the “A” letter group. - - - + sanitized (so it’s no longer an active character and is in fact seen as two + octets 0xC3 0xA9) which will put this entry before the “A” letter group. + (The group is determined by the first octet 0xC3.)
    Option 2:
    makeindex doesn’t recognise é as a letter so it will be put in the - symbols group. +class="cmtt-10">makeindex sees é as two octets (0xC3 0xA9) rather than a single + character so it tries to put élite in the 0xC3 (“Ô) letter group (which, + in this case, comes after “Z”).
    Option 3:
    xindy will correctly recognise the sort value xindy will correctly recognise the sort value élite and will place it in whatever letter group is appropriate for the given language setting. - (In English, this would just be the “E” letter group.)
    -

    Therefore if you have extended Latin or non-Latin characters, your best option is -to use xindy (Option 3) with the

    +Option 4:
    The inputenc package. If you use makeindex (Option 2) -you need to specify the sort key like this: + id="dx1-5109"> package doesn’t affect the encoding used with .bib entry + definitions, since these are dependent on the encoding used to save the .bib file + (although the labels must still be ASCII). You can help bib2gls (and + JabRef) by putting an encoding comment at the start of the .bib file: +
    +
    + % Encoding: UTF-8 +
    +
    +

    With the correct encoding set up, bib2gls will determine that the sort value is + élite and will place it in whatever letter group is appropriate for the given + sort rule. For example, sort=en-GB (or just sort=en) will put élite in the + “E” letter group, but another language might put it in the “É” letter + group.

    -
    +
    +

    Therefore if you have extended Latin or non-Latin characters, your best option is +to use either xindy (Option 3) or bib2gls (Option 4) with the inputenc or fontspec +package. If you use makeindex (Option 2) you need to specify the sort key like +this: + + + +

    +
    \newglossaryentry{elite}  
    {  
      name={{\'e}lite}, @@ -1507,160 +2944,75 @@ class="cmtt-10">sort key like this:  
      description={select group or class}  
    }
    -

    If you use

    or

    If you use Option 1, you may or may not need to use the sort key, but you will need to be careful about fragile commands in the name key if you don’t set the sort key. -

    If you use

    If you use Option 3 and the name only contains a command (such as \P) you -must add the sort key. This is also advisable for the other options, but is essential -for Option 3. For example: +class="cmtt-10">name only contains a command or commands (such +as \P or \ensuremath{\pi}) you must add the sort key. This is also advisable +for the other options (except Option 4), but is essential for Option 3. For +example:

    -
    -\newglossaryentry{P}{name={\P},sort={P}, - 
     description={paragraph symbol}} +
    + \newglossaryentry{P}{name={\P},sort={P}, + 
      description={paragraph symbol}}
    -

    -

    Table 1 summarises the main pros and cons of three options described -above. -

    -
    - - - -


    - - - -
    Table 1: Glossary Options: Pros and Cons
    -
    - - - - - - -

    Option 1 Option 2 Option 3

    Requires - an - external - application?

    Requires - Perl?

    Can - sort - extended - Latin - or - non-Latin - alphabets?

    Efficient - sort - algorithm?

    Can - form - ranges - in - the - location - lists?

    Can - have - non-standard - locations?

    -

    Strips standard LATEX accents so, for example, \AA is treated the same as -A. - - - +

    -

    -
    -

    Top

    5 Customising the Glossary

    -

    The default glossary style uses the

    The default glossary style uses the description environment to display the entry list. @@ -1673,159 +3025,245 @@ class="cmtt-10">\glsnamefont:

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

    -

    By default, a full stop is appended to the description. To prevent this from -happening use the nopostdot package option: +

    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 +glossaries-extra). To prevent this from happening use the nopostdot package +option:

    -
    +
    \usepackage[nopostdot]{glossaries}
    -

    -

    By default, a location list is displayed for each entry. This refers to the -document locations (for example, the page number) where the entry has been -referenced. If you use Options 

    or to add it with glossaries-extra: + + + +

    +
    +\usepackage[postdot]{glossaries-extra} +
    +

    +

    By default, a location list is displayed for each entry (unless you use +\printunsrtglossary without bib2gls). This refers to the document locations (for +example, the page number) where the entry has been referenced. If you use +Options 2 or 3 described in §4 Displaying a List of -Entries location ranges will be compressed. For example, if an entry was -used on pages 1, 2 and 3, with Options Displaying a List of Entries or Option 4 (with +bib2gls and glossaries-extra) then location ranges will be compressed. For example, if +an entry was used on pages 1, 2 and 3, with Options 2 or 3 the location list will appear -as 1–3, but with Option 1 it will appear as 1, 2, 3. If you don’t want the -locations displayed you can hide them using the nonumberlist package +href="#option3">3 or Option 4 the +location list will appear as 1–3, but with Option 1 it will appear as 1, 2, 3. If you +don’t want the locations displayed you can hide them using the nonumberlist package option:

    -
    +
    \usepackage[nonumberlist]{glossaries}
    -

    -

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

    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 sort key. By default a vertical gap is placed between letter groups. You can suppress this with the nogroupskip package option: +class="cmss-10">nogroupskip package option:

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

    +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 multiple paragraphs, so there’s no “one style fits all” solution. You need to choose -a style that suits your document. -

    Examples: +a style that suits your document. For example: + + + +

    +
    +\setglossarystyle{index} +
    +

    You can also use the style package option for the preloaded styles. For example: + + + +

    +
    +\usepackage[style=index]{glossaries} +
    +

    +

    Examples:

    1. You have entries where the name is a symbol and the description is a brief + class="enumerate" id="x1-6015x1">You have entries where the name is a symbol and the description is a brief phrase or short sentence. Try one of the “mcol” styles defined in the glossary-mcols package. For example: + id="dx1-6016"> package. For example: -
      - \usepackage[nogroupskip,nopostdot]{glossaries} +
      + \usepackage[nopostdot]{glossaries}  
      \usepackage{glossary-mcols}  
      \setglossarystyle{mcolindex}
      -

      +

      or + + + +

      +
      + \usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra} +
      +

    2. You have entries where the name is a word or phrase and the description spans + class="enumerate" id="x1-6018x2">You have entries where the name is a word or phrase and the description spans multiple paragraphs. Try one of the “altlist” styles. For example: -
      +
      \usepackage[nopostdot]{glossaries}  
      \setglossarystyle{altlist}
      -

      +

      or + + + +

      +
      + \usepackage[stylemods,style=altlist]{glossaries-extra} +
      +

    3. You have entries where the name is a single word, the description is + class="enumerate" id="x1-6020x3">You have entries where the name is a single word, the description is brief, and an associated symbol has been set. Use one of the styles that display the symbol (not all of them do). For example, one of the tabular styles: -
      +
      \usepackage[nopostdot,nonumberlist]{glossaries}  
      \setglossarystyle{long4col}
      -

      or one of the “tree” styles: +

      or one of the “tree” styles:

      -
      +
      \usepackage[nopostdot,nonumberlist]{glossaries}  
      \setglossarystyle{tree}
      -

    -

    If your glossary consists of a list of acronyms and you also want to specify -a description as well as the long form, then you need to use an acronym style that -will suit the glossary style. For example, use the

    +

    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 style:

    -
    +
    \setacronymstyle{long-short-desc}
    -

    Define the acronyms with a description: +

    Define the acronyms with a description:

    -
    +
    \newacronym  
     [description={statistical pattern recognition technique}] - 
     {svm}{svm}{support vector machine} + 
     {svm}{SVM}{support vector machine} +
    +

    Alternatively with glossaries-extra: + + + +

    +
    +\setabbreviationstyle{long-short-desc} + 
    \newabbreviation + 
     [description={statistical pattern recognition technique}] + 
     {svm}{SVM}{support vector machine}
    -

    Choose a glossary style that suits wide entry names: +

    +

    Choose a glossary style that suits wide entry names. For example:

    -
    +
    \setglossarystyle{altlist}
    -

    -

    +

    +

    -

    Top

    6 Multiple Glossaries

    -

    The

    The glossaries package predefines a default main glossary. When you define an entry @@ -1837,7 +3275,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 ⟨\printglossary or \printnoidxglossary. The other arguments indicate the file extensions used by makeindex/xindy (described in makeindex/xindy (described in §4 Displaying a List of Entries). If you use -Option 1 described above, the ⟨Displaying a List of Entries). If you use Option 1 +described above (or bib2gls and \printunsrtglossaries), then the ⟨glg⟩, ⟨gls⟩ and ⟨glo⟩ arguments are ignored, in which -case you may prefer to use the starred version where you don’t specify the -extensions: -


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

    Since it’s quite common for documents to have both a list of terms and a list of -acronyms, the \makeglossaries. (Entries definitions should come after \makeglossaries.) In the case +of 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 +abbreviations, the glossaries package provides the package option acronym (or acronyms), -which is a convenient shortcut for + id="dx1-7005"> package provides the package option acronym (or +acronyms), which is a convenient shortcut for

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

    For example, suppose you want a main glossary for terms, a list of acronyms and +automatically put in the list of acronyms instead of the main glossary. The +glossaries-extra package also provides this option for abbreviations defined using +\newacronym but additionally has the package option abbreviations to create a list of +abbreviations for \newabbreviation. +

    There are some other package options for creating commonly used lists: symbols +(lists of symbols), numbers (lists of numbers), index (index of terms without +descriptions defined with \newterm[options]{label}). +

    For example, suppose you want a main glossary for terms, a list of acronyms and a list of notation:

    -
    -\usepackage[acronyms]{glossaries} - 
    \newglossary[nlg]{notation}{not}{ntn}{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: @@ -1919,95 +3392,152 @@ the preamble. For example:

    -
    -\newglossaryentry{gls:set} - 
    {% This entry goes in the `main' glossary - 
      name=set, - 
      description={A collection of distinct objects} - 
    } - 
     This entry goes in the `acronym' glossary: - 
    \newacronym{svm}{svm}{support vector machine} - 
    \newglossaryentry{not:set} - 
    {% This entry goes in the `notation' glossary: - 
      type=notation, - 
      name={\ensuremath{\mathcal{S}}}, - 
      description={A set}, - 
      sort={S}} -
    -

    or if you don’t like using + \newglossaryentry{gls:set} + 
     {% This entry goes in the `main' glossary + 
       name=set, + 
       description={A collection of distinct objects} + 
     } + 
     % This entry goes in the `acronym' glossary: + 
     \newacronym{svm}{svm}{support vector machine} + 
     \newglossaryentry{not:set} + 
     {% This entry goes in the `notation' glossary: + 
       type=notation, + 
       name={\ensuremath{\mathcal{S}}}, + 
       description={A set}, + 
       sort={S}} +

    +

    or if you don’t like using \ensuremath:

    -
    -\newglossaryentry{not:set} - 
    {% This entry goes in the `notation' glossary: - 
      type=notation, - 
      name={$\mathcal{S}$}, - 
      text={\mathcal{S}}, - 
      description={A set}, - 
      sort={S}} -
    -

    -

    Each glossary is displayed using: -


    + \newglossaryentry{not:set} + 
     {% This entry goes in the `notation' glossary: + 
       type=notation, + 
       name={$\mathcal{S}$}, + 
       text={\mathcal{S}}, + 
       description={A set}, + 
       sort={S}} +
    +

    +

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

    There’s a convenient shortcut that will display all the defined glossaries: -


    If you’re using bib2gls then each glossary is displayed using: +


    \printunsrtglossary[type=type]

    +

    +With this method you don’t use \makeglossaries or \makenoidxglossaries. +Instead you can assign the entry type with the resource command. For example: + + + +

    +
    + \usepackage[record,abbreviations,symbols]{glossaries-extra} + 
     \GlsXtrLoadResources[ + 
      src={terms}, % entries defined in terms.bib + 
      type={main}% put in main glossary + 
     ] + 
     \GlsXtrLoadResources[ + 
      src={abbrvs}, % entries defined in abbrvs.bib + 
      type={abbreviations}% put in abbreviations glossary + 
     ] + 
     \GlsXtrLoadResources[ + 
      src={syms}, % entries defined in syms.bib + 
      type={symbols}% put in symbols glossary + 
     ] +
    +

    Later in the document: + + + +

    +
    + \printunsrtglossary % main + 
     \printunsrtglossary[type=abbreviations] + 
     \printunsrtglossary[type=symbols] +
    +

    +

    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). -

    If you use 3) or (glossaries-extra only) +


    \printunsrtglossaries

    +

    +

    If you use Option 1, you don’t need to do anything else. If you use Options 2 or 3 with the makeglossaries Perl script, you similarly don’t need to do anything -else. If you use Options makeglossaries Perl script or the makeglossaries-lite Lua script, +you similarly don’t need to do anything else. If you use Options 2 or 3 without the makeglossaries Perl script then you -need to make sure you run makeindex/xindy 3 without the +makeglossaries Perl script then you need to make sure you run makeindex/xindy +for each defined glossary. The ⟨gls⟩ and -⟨gls⟩ and ⟨glo⟩ arguments of \newglossary specify the file extensions to use instead of .gls and -\newglossary specify the file +extensions to use instead of .gls and .glo. The optional argument ⟨glg⟩ is the file extension for the transcript file. This -should be different for each glossary in case you need to check for makeindex/xindy -errors or warnings if things go wrong. -

    For example, suppose you have three glossaries in your document (glg⟩ is the file +extension for the transcript file. This should be different for each glossary in +case you need to check for makeindex/xindy errors or warnings if things go +wrong. +

    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): -

    +

    Option 2: -

    You need to run makeindex three times: +href="#option2">Option 2 Either use one makeglossaries or makeglossaries-lite call: + + + +

    + makeglossaries myDoc +
    +

    or

    -
    +
    + makeglossaries-lite myDoc +
    +

    Or you need to run makeindex three times: + + + +

    +
    makeindex -t myDoc.glg -s myDoc.ist -o myDoc.gls myDoc.glo  
    makeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn  
    makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn
    -

    +

    Option 3: -

    You need to run xindy three times (be careful not to insert line breaks where - the line has wrapped.) +href="#option3">Option 3 Either use one makeglossaries call: + + + +

    + makeglossaries myDoc +
    +

    Or you need to run xindy three times (be careful not to insert line breaks + where the line has wrapped.)

    -
    +
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.glg  
    -o myDoc.gls myDoc.glo  
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.alg @@ -2059,59 +3617,78 @@ class="cmtt-10">xindy three times (be careful not to insert line breaks w  
    xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg  
    -o myDoc.not myDoc.ntn
    -

    -

    +

    +

    +
    Option 4 With bib2gls only one call is required: + + + +
    + pdflatex myDoc +  
    bib2gls --group myDoc +  
    pdflatex myDoc +
    +

    (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 hyperref. Contrary to the usual -advice that . Contrary to the usual advice +that hyperref should be loaded last, glossaries must be loaded after + id="dx1-8004"> (and glossaries-extra) must be loaded after hyperref: + id="dx1-8006">:

    -
    +
    \usepackage[colorlinks]{hyperref}  
    \usepackage{glossaries}
    -

    If you use

    If you use hyperref make sure you use PDFLAT make sure you use PDFLATEX rather than the LATEX to DVI engine. The DVI format can’t break hyperlinks across a line so long glossary entries (such as the full form of acronyms) won’t line wrap with the DVI engine. Also, hyperlinks in sub- or superscripts aren’t correctly sized with the DVI format. -

    By default, if the

    By default, if the hyperref package has been loaded, commands like 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 package option. For example, if you don’t want hyperlinks for entries -in the nohypertypes package option. For example, if you don’t want hyperlinks for entries in +the acronym and notation glossaries but you do want them for entries in the main @@ -2120,29 +3697,30 @@ glossary, then do:

    -
    +
    \usepackage[colorlinks]{hyperref}  
    \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 +class="cmss-10">hyperfirst=false package 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. + id="dx1-8011"> package but is a limitation of PDF bookmarks. Non-expandable commands include commands like \gls, \glspl, \Gls and \Glspl. The hyperref package provides a way of specifying alternative text for the PDF + id="dx1-8012"> package provides a way of specifying alternative text for the PDF bookmarks via \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: @@ -2176,28 +3754,39 @@ For example, the following works:

    -
    +
    \section{The \glsentrytext{fishage}}
    -

    and it doesn’t put the table of contents in the location list. -

    +

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

    +
    +\section{The \glsfmttext{fishage}} +
    +

    +

    -

    Top

    8 Cross-References

    -

    You can add a reference to another entry in a location list using the see= -{label} key when you define an entry. The referenced entry must also be +

    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:

    -
    +
    \longnewglossaryentry{devonian}{name={Devonian}}%  
    {%  
      The geologic period spanning from the end of the @@ -2212,7 +3801,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:

    -
    +
    \newglossaryentry{latinalph}  
    {  
      name={Latin alphabet}, @@ -2238,7 +3827,7 @@ class="cmti-10">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: @@ -2246,37 +3835,104 @@ enclose the value in braces. For example:

    -
    +
    \newacronym{ksvm}{ksvm}{kernel support vector machine}  
    \newacronym  
     [see={[see also]{ksvm}}]  
     {svm}{svm}{support vector machine}
    -

    -

    Since the cross-reference appears in the location list, if you suppress the location -list using the nonumberlist package option, then the cross-reference will also be -suppressed. -

    +

    The glossaries-extra package provides a seealso key. This doesn’t allow a tag but +behaves much like see={[\seealsoname]{label}}. For example: + + + +

    +
    +\newabbreviation{ksvm}{ksvm}{kernel support vector machine} + 
    \newabbreviation + 
     [seealso={ksvm}] + 
     {svm}{svm}{support vector machine} +
    +

    +

    Since the cross-reference appears in the location list, if you suppress the +location list using the nonumberlist package option, then the cross-reference +will also be suppressed. With bib2gls, don’t use the nonumberlist package +option. Instead use the save-locations=false in the resource options. For +example: + + + +

    +
    +\usepackage[record,abbreviations,symbols]{glossaries-extra} + 
    \GlsXtrLoadResources[ + 
     src={terms}, % entries defined in terms.bib + 
     type={main}% put in main glossary + 
    ] + 
    \GlsXtrLoadResources[ + 
     src={abbrvs}, % entries defined in abbrvs.bib + 
     type={abbreviations},% put in abbreviations glossary + 
     save-locations=false% no number list for these entries + 
    ] + 
    \GlsXtrLoadResources[ + 
     src={syms}, % entries defined in syms.bib + 
     type={symbols}% put in symbols glossary + 
    ] +
    +

    +

    -

    Top

    9 Further Information

    -

    Further information can be found in the main

    Further information can be found in the main glossaries user manual or in the glossaries FAQ. There is also an article on the glossaries and glossaries-extra packages -on the glossaries FAQ. See also the glossaries-extra package and the bib2gls document, both +of which can be found on CTAN (http://ctan.org/pkg/glossaries-extra and +http://ctan.org/pkg/bib2gls). There is also an article on the glossaries and +glossaries-extra packages on the LATEX Community’s Know How section and a chapter on the EX Community’s Know How section and +a chapter on the glossaries -package in package in Using LATEX to Write a PhD Thesis.

    +class="E">EX to Write a PhD Thesis. +

    1deprecated, use babel instead

    + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf index 434793e7b74..cc51404258e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf and b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 71273695d4b..8c662fcba08 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex @@ -12,18 +12,29 @@ \usepackage{alltt} \usepackage{pifont} \usepackage{array} +\usepackage{color} -\usepackage[colorlinks,pdfauthor={Nicola L.C. Talbot}, +\usepackage[colorlinks,linkcolor=blue,pdfauthor={Nicola L.C. Talbot}, pdftitle={The glossaries package: a guide for beginners}]{hyperref} \usepackage[nomain]{glossaries} \newcommand*{\yes}{\ding{52}} \newcommand*{\no}{\ding{56}} -\title{The glossaries package v4.32: +\newcommand*{\proyes}{\textcolor{green}{\yes}} +\newcommand*{\prono}{\textcolor{red}{\no}} + +\newcommand*{\conyes}{\textcolor{red}{\yes}} +\newcommand*{\conno}{\textcolor{green}{\no}} + +\newcommand*{\code}[1]{% + \texorpdfstring{{\frenchspacing\obeyspaces\ttfamily#1}}{#1}} +\newcommand*{\file}[1]{\texorpdfstring{\texttt{#1}}{#1}} + +\title{The glossaries package v4.33: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2017-08-24} +\date{2017-09-20} \ifpdf \externaldocument{glossaries-user} @@ -45,7 +56,7 @@ and~\hyperlink{option#2}{#2}} \begin{abstract} The \styfmt{glossaries} package is very flexible, but this means -that it has a~lot options, and since a user guide is supposed to +that it has a~lot of options, and since a user guide is supposed to provide a complete list of all the high-level user commands, the main user manual is quite big. This can be rather daunting for beginners, so this document is a brief introduction @@ -76,9 +87,9 @@ must load them before \styfmt{glossaries}.) \begin{important} If you require multilingual support you must also install the relevant language module. Each language module is called -\texttt{glossaries-}\meta{language}, where \meta{language} is the -root language name. For example, \texttt{glossaries-french} -or \texttt{glossaries-german}. If a language module is required, +\file{glossaries-}\meta{language}, where \meta{language} is the +root language name. For example, \file{glossaries-french} +or \file{glossaries-german}. If a language module is required, the \styfmt{glossaries} package will automatically try to load it and will give a warning if the module isn't found. \end{important} @@ -87,178 +98,367 @@ Once you have loaded \styfmt{glossaries}, you need to define your terms in the preamble and then you can use them throughout the document. Here's a simple example: \begin{verbatim} -\documentclass{article} + \documentclass{article} -\usepackage{glossaries} + \usepackage{glossaries} -\newglossaryentry{ex}{name={sample},description={an example}} + \newglossaryentry{ex}{name={sample},description={an example}} -\begin{document} -Here's my \gls{ex} term. -\end{document} + \begin{document} + Here's my \gls{ex} term. + \end{document} \end{verbatim} This produces: -\begin{display} +\begin{quote} Here's my sample term. -\end{display} +\end{quote} Here's another example: \begin{verbatim} -\documentclass{article} + \documentclass{article} -\usepackage{glossaries} + \usepackage{glossaries} -\setacronymstyle{long-short} + \setacronymstyle{long-short} -\newacronym{svm}{SVM}{support vector machine} + \newacronym{svm}{SVM}{support vector machine} -\begin{document} -First use: \gls{svm}. Second use: \gls{svm}. -\end{document} + \begin{document} + First use: \gls{svm}. Second use: \gls{svm}. + \end{document} \end{verbatim} This produces: -\begin{display} +\begin{quote} First use: support vector machine (SVM). Second use: SVM. -\end{display} +\end{quote} In this case, the text produced by \verb|\gls{svm}| changed after the first use. The first use produced the long form followed by the short form in parentheses because I set the acronym style to -\texttt{long-short}. I suggest you try the above two examples to +\code{long-short}. I suggest you try the above two examples to make sure you have the package correctly installed. -If you get an \texttt{undefined control sequence} error, check that +If you get an \code{undefined control sequence} error, check that the version number at the top of this document matches the version -you have installed. (Open the \texttt{.log} file and search for the -line that starts with \texttt{Package: glossaries} followed by a +you have installed. (Open the \file{.log} file and search for the +line that starts with \code{Package: glossaries} followed by a date and version.) +Abbreviations are slightly different if you use the extension package +\sty{glossaries-extra} (which needs to be installed separately): +\begin{verbatim} + \documentclass{article} + + \usepackage{glossaries-extra} + + \setabbreviationstyle{long-short}% glossaries-extra.sty + + \newabbreviation{svm}{SVM}{support vector machine}% glossaries-extra.sty + + \begin{document} + First use: \gls{svm}. Second use: \gls{svm}. + \end{document} +\end{verbatim} +If you still want to use \cs{newacronym} (rather than +\cs{newabbreviation}) then you need the optional +argument of \cs{setabbreviationstyle}: +\begin{verbatim} + \documentclass{article} + + \usepackage{glossaries-extra} + + \setabbreviationstyle[acronym]{long-short}% glossaries-extra.sty only + + \newacronym{svm}{SVM}{support vector machine} + + \begin{document} + First use: \gls{svm}. Second use: \gls{svm}. + \end{document} +\end{verbatim} +\begin{important} +You can't use \cs{setacronymstyle} with \sty{glossaries-extra}. +\end{important} + If you like, you can put all your definitions in another file (for -example, \texttt{defns.tex}) and load that file in the preamble using +example, \file{defns.tex}) and load that file in the preamble using \cs{loadglsentries} with the filename as the argument. For example: \begin{verbatim} \loadglsentries{defns} \end{verbatim} +If you find you have a really large number of definitions that are +hard to manage in a \file{.tex} file, you might want to have a +look at \app{bib2gls} (installed separately) which requires +a \file{.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 with the underlying mechanism. Instead, the formatting should be done by the style. For example, suppose I~want -to replace \texttt{SVM} in the above to \verb|\textsc{svm}|, then -I~need to select a style that uses \cs{textsc}, like this: +to replace \code{SVM} with \verb|\textsc{svm}|, then +I~need to select a style that uses \cs{textsc}, like this (for the +base \styfmt{glossaries} style): \begin{verbatim} -\documentclass{article} + \documentclass{article} -\usepackage{glossaries} + \usepackage{glossaries} -\setacronymstyle{long-sc-short} + \setacronymstyle{long-sc-short} -\newacronym{svm}{svm}{support vector machine} + \newacronym{svm}{svm}{support vector machine} -\begin{document} -First use: \gls{svm}. Second use: \gls{svm}. -\end{document} + \begin{document} + First use: \gls{svm}. Second use: \gls{svm}. + \end{document} +\end{verbatim} +The abbreviation styles have a different naming scheme with +\sty{glossaries-extra}: +\begin{verbatim} + \documentclass{article} + + \usepackage{glossaries-extra} + + \setabbreviationstyle{long-short-sc}% glossaries-extra.sty + + \newabbreviation{svm}{svm}{support vector machine}% glossaries-extra.sty + + \begin{document} + First use: \gls{svm}. Second use: \gls{svm}. + \end{document} \end{verbatim} +With \sty{glossaries-extra} you can have multiple abbreviation +styles for different categories. Many of these styles have their +own associated formatting commands that can be redefined +for minor adjustments. For example: +\begin{verbatim} + \documentclass{article} + + \usepackage{glossaries-extra} + + \setabbreviationstyle[statistical]{long-short-sc} + \setabbreviationstyle[bacteria]{long-only-short-only} + + % Formatting commands used by 'long-only-short-only' style: + \renewcommand*{\glsabbrvonlyfont}[1]{\emph{#1}} + \renewcommand*{\glslongonlyfont}[1]{\emph{#1}} + + % Formatting command used by 'long-short-sc' style: + % (make sure abbreviation is converted to lower case) + \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}} + + \newabbreviation + [ + category={statistical}% glossaries-extra.sty key + ] + {svm}{SVM}{support vector machine} + + \newabbreviation + [ + category={bacteria}% glossaries-extra.sty key + ] + {cbot}{C.~botulinum}{Clostridium botulinum} + + \begin{document} + First use: \gls{svm}, \gls{cbot}. + + Next use: \gls{svm}, \gls{cbot}. + \end{document} +\end{verbatim} +This produces: +\begin{quote} +First use: support vector machine (\textsc{svm}), \emph{Clostridium +botulinum}. + +Next use: \textsc{svm}, \emph{C.~botulinum}. +\end{quote} As you can hopefully see from the above examples, there are two main ways of -defining a term. In both cases, the term is given -a label. In the first case the label was \texttt{ex} and in the -second case the label was \texttt{svm}. The label is just a way of -identifying the term (like the standard \cs{label}\slash\cs{ref} -mechanism). It's best to just use the following alphanumerics in the -labels: \texttt{a}, \ldots, \texttt{z}, \texttt{A}, \ldots, -\texttt{Z}, \texttt{0}, \ldots, \texttt{9}. Sometimes you can also -use punctuation characters but not if another package (such as -\sty{babel}) meddles with them. Don't try using any characters -outside of the basic Latin set (for example, \'e or \ss) 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. +defining a term: as a general entry (\cs{newglossaryentry}) or as an +abbreviation (\cs{newacronym} or, with \sty{glossaries-extra}, +\cs{newabbreviation}). + +Regardless of the method of defining a term, the term is always +given a label. In the first example, the label was +\code{ex} and in the other examples the label was \code{svm} +(and \code{cbot} in the last example). The +label is used to uniquely identify the term (like the standard +\cs{label}\slash\cs{ref} or \cs{cite} mechanism). It's best to just use the +following alphanumerics in the labels: \code{a}, \ldots, +\code{z}, \code{A}, \ldots, \code{Z}, \code{0}, \ldots, +\code{9}. Sometimes you can also use punctuation characters but +not if another package (such as \sty{babel}) meddles with them. +Don't try using any characters outside of the basic Latin set with +\sty{inputenc} (for example, \'e or \ss) 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. \begin{important} Don't use \cs{gls} in chapter or section headings as it can have some unpleasant side-effects. Instead use \cs{glsentrytext} for regular entries and one of \cs{glsentryshort}, \cs{glsentrylong} -or \cs{glsentryfull} for acronyms. +or \cs{glsentryfull} for acronyms. Alternatively use +\sty{glossaries-extra} which provides special commands for use in +section headings, such as \cs{glsfmtshort}\marg{label}. \end{important} 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 \styfmt{glossaries} package provides -three options: use \TeX\ to perform the sorting; use -\texttt{makeindex} to perform the sorting; use \texttt{xindy} to -perform the sorting. - -The first option (using \TeX) is the simplest and easiest method, -but it's inefficient and the sorting is done according to the English -alphabet. To use this method, add \cs{makenoidxglossaries} -to the preamble and put \cs{printnoidxglossaries} at the place where -you want your glossary. For example: +comes if you want to display a \emph{sorted} list of all the entries you +have used in the document. The \sty{glossaries-extra} package +provides a really easy way of listing all the defined entries: \begin{verbatim} -\documentclass{article} + \documentclass{article} -\usepackage{glossaries} + \usepackage[sort=none]{glossaries-extra} -\makenoidxglossaries + \newglossaryentry{potato}{name={potato},plural={potatoes}, + description={starchy tuber}} -\newglossaryentry{potato}{name={potato},plural={potatoes}, - description={starchy tuber}} + \newglossaryentry{cabbage}{name={cabbage}, + description={vegetable with thick green or purple leaves}} + + \newglossaryentry{turnip}{name={turnip}, + description={round pale root vegetable}} -\newglossaryentry{cabbage}{name={cabbage}, - description={vegetable with thick green or purple leaves}} + \newglossaryentry{carrot}{name={carrot}, + description={orange root}} -\newglossaryentry{carrot}{name={carrot}, - description={orange root}} + \begin{document} + Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. -\begin{document} -Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. + \printunsrtglossaries % list all entries + \end{document} +\end{verbatim} +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 \qt{turnip} appears in the glossary even though there's +no \verb|\gls{turnip}| (or similar) in the document. + +The \pkgopt[none]{sort} 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 +(\cs{printunsrtglossaries}) that's used with \app{bib2gls} (\opt4) +but with \app{bib2gls} you instead need to use the +\pkgopt{record} package option and one or more instances of +\cs{GlsXtrLoadResources} in the preamble (see below). + +Most users prefer to have an automatically sorted list that only +contains entries that have been used in the document. +The \styfmt{glossaries} package provides +three options: use \TeX\ to perform the sorting (\opt1); use +\app{makeindex} to perform the sorting (\opt2); use \app{xindy} to +perform the sorting (\opt3). The extension package \sty{glossaries-extra} +provides a fourth method: use \app{bib2gls} (\opt4). + +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 +\cs{makenoidxglossaries} to the preamble and put +\cs{printnoidxglossaries} at the place where you want your glossary. +For example: +\begin{verbatim} + \documentclass{article} -\printnoidxglossaries -\end{document} + \usepackage{glossaries} + + \makenoidxglossaries % use TeX to sort + + \newglossaryentry{potato}{name={potato},plural={potatoes}, + description={starchy tuber}} + + \newglossaryentry{cabbage}{name={cabbage}, + description={vegetable with thick green or purple leaves}} + + \newglossaryentry{turnip}{name={turnip}, + description={round pale root vegetable}} + + \newglossaryentry{carrot}{name={carrot}, + description={orange root}} + + \begin{document} + Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}. + + \printnoidxglossaries + \end{document} \end{verbatim} + +\begin{important} +The \cs{makenoidxglossaries} method is very slow, uses an ASCII +comparator and often breaks if there are commands in the +\code{name} key. +\end{important} + Try this out and run \LaTeX\ (or pdf\LaTeX) \emph{twice}. The first run won't show the glossary. It will only appear on the second run. +This doesn't include \qt{turnip} in the glossary because that term +hasn't been used (with commands like \verb|\gls{turnip}|) in the document. + The glossary has a vertical gap between the \qt{carrot} term and the \qt{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 \texttt{nogroupskip} to the package options: +just add \pkgopt{nogroupskip} to the package options: \begin{verbatim} \usepackage[nogroupskip]{glossaries} \end{verbatim} +or you may want to try out a style that shows the group headings: +\begin{verbatim} +\usepackage[style=indexgroup]{glossaries} +\end{verbatim} 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, 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 back-reference, in which case you -can suppress it using the \texttt{nonumberlist} package option: +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 +back-reference, in which case you can suppress it using the +\pkgopt{nonumberlist} package option: \begin{verbatim} \usepackage[nonumberlist]{glossaries} \end{verbatim} If you don't like the terminating full stop, you can suppress that -with the \texttt{nopostdot} package option: +with the \pkgopt{nopostdot} package option: \begin{verbatim} \usepackage[nopostdot]{glossaries} \end{verbatim} +If you tried out the previous example with \sty{glossaries-extra} +and \cs{printunsrtglossaries} the terminating full stop is missing +and there are no number lists. You can add the full stop back with +\begin{verbatim} +\usepackage[nopostdot=false]{glossaries-extra} +\end{verbatim} +or +\begin{verbatim} +\usepackage[postdot]{glossaries-extra} +\end{verbatim} +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: \cs{glspl}. This displays the plural form. By default, this is just the singular form with the letter \qt{s} appended, but in the case of \qt{potato} I had to specify the correct plural using the -\texttt{plural} key. +\code{plural} key. 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 \texttt{makeindex} -or \texttt{xindy}. If you are using extended Latin or non-Latin -characters, then \texttt{xindy} is the recommended method. These two -methods are described in more detail in +you will have a much faster build time if you use \app{makeindex} +(\opt2) or \app{xindy} (\opt3) or \app{bib2gls} (\opt4). If +you are using extended Latin or non-Latin characters, then +\app{xindy} or \app{bib2gls} are the recommended methods. +These methods are described in more detail in \sectionref{sec:printglossaries}. The rest of this document briefly describes the main commands -provided by the \styfmt{glossaries} package. +provided by the \styfmt{glossaries} package. (Most of these are also +available with \sty{glossaries-extra} but may behave slightly +differently.) \section{Defining Terms} \label{sec:defterm} When you use the \sty{glossaries} package, you need to define glossary entries in the document preamble. These entries could be -a~word, phrase, acronym or symbol. They're usually accompanied by +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: @@ -295,7 +495,7 @@ a~long description, you can instead use: Examples: \begin{enumerate} -\item Define the term \qt{set} with the label \texttt{set}: +\item Define the term \qt{set} with the label \code{set}: \begin{verbatim} \newglossaryentry{set} { @@ -305,7 +505,7 @@ Examples: \end{verbatim} \item Define the symbol $\emptyset$ with the label -\texttt{emptyset}: +\code{emptyset}: \begin{verbatim} \newglossaryentry{emptyset} { @@ -313,9 +513,11 @@ Examples: description={the empty set} } \end{verbatim} +(This will also need a \code{sort} key if you use \optsor13, see +below.) \item Define the phrase \qt{Fish Age} with the label -\texttt{fishage}: +\code{fishage}: \begin{verbatim} \longnewglossaryentry{fishage} {name={Fish Age}} @@ -335,7 +537,7 @@ description.) \item Take care if the first letter is an extended Latin or non-Latin character (either specified via a~command such as \verb|\'e| or explicitly via the \sty{inputenc} package such -as \texttt{\'e}). This first letter must be placed in a~group: +as \code{\'e}). This first letter must be placed in a~group: \begin{verbatim} \newglossaryentry{elite} @@ -353,54 +555,64 @@ or \verb|}| \end{alltt} \end{enumerate} -(For further details, see the section -\qtdocref{UTF-8}{mfirstuc-manual} in the -\sty{mfirstuc} user manual.) +(For further details, see the section \qt{UTF-8} of the +\href{https://ctan.org/pkg/mfirstuc}{\styfmt{mfirstuc}} user manual.) -Acronyms (or other abbreviations) can be defined using -\begin{definition} -\cs{newacronym}\marg{label}\marg{short}\marg{long} -\end{definition} -where \meta{label} is the label (as with the \cs{newglossaryentry} -and the \cs{longnewglossaryentry} commands), \meta{short} is the -short form and \meta{long} is the long form. For example, the -following defines an abbreviation: +If you use \app{bib2gls} with \sty{glossaries-extra} then the +terms must be defined in a \file{.bib} file. For example: +\begin{alltt} +\% Encoding: UTF-8 + +@entry\{set, + name=\{set\}, + description=\{a collection of objects\} +\} + +@entry\{emptyset, + name=\verb|{\ensuremath{\emptyset}}|, + description=\{the empty set\} +\} + +@entry\{fishage, + name=\{Fish Age\}, + description=\{A common name for the Devonian geologic period + spanning from the end of the Silurian Period to + the beginning of the Carboniferous Period. + + This age was known for its remarkable variety of + fish species.\} +\} + +@entry\{elite, + name=\verb|{{|\'e\verb|}lite}|, + description=\verb|{select group or class}| +\} +\end{alltt} +(The \file{.bib} format doesn't allow spaces in labels so you can't +have \code{fish age} as the label, but you can have +\code{fish-age}.) +This method requires the \sty{glossaries-extra}'s \pkgopt{record} +package option: \begin{verbatim} -\newacronym{svm}{svm}{support vector machine} +\usepackage[record]{glossaries-extra} \end{verbatim} -This defines a glossary entry with the label \texttt{svm}. By -default, the \meta{name} is set to \meta{short} (\qt{svm} in the -above example) and the \meta{description} is set to \meta{long} -(\qt{support vector machine} in the above example). If, instead, you -want to be able to specify your own description you can do this -using the optional argument: +and the \file{.bib} file is specified in the resource command. For +example, if the \file{.bib} file is called \file{entries.bib} +then put the following line in the document preamble: \begin{verbatim} -\newacronym - [description={statistical pattern recognition technique}] - {svm}{svm}{support vector machine} +\GlsXtrLoadResources[src={entries}] +\end{verbatim} +You can have a comma-separated list. For example, if you also +have entries defined in the file \file{entries2.bib}: +\begin{verbatim} +\GlsXtrLoadResources[src={entries,entries2.bib}] \end{verbatim} - -Before you define your acronyms (or other types of abbreviations), you -need to specify which style to use with -\begin{definition} -\cs{setacronymstyle}\marg{style name} -\end{definition} -where \meta{style name} is the name of the style. There are a number -of predefined styles, such as: \texttt{long-short} (on first use -display the long form with the short form in parentheses); -\texttt{short-long} (on first use display the short form with the -long form in parentheses); \texttt{long-short-desc} (like -\texttt{long-short} but you need to specify the description); or -\texttt{short-long-desc} (like \texttt{short-long} but you need to -specify the description). There are some other styles as well that -use \cs{textsc} to typeset the acronym or that use a footnote on -first use. See the main user guide for further details. There are other keys you can use when you define an entry. For -example, the \texttt{name} key used above indicates how the term -should appear in the list of entries (glossary). If the term should -appear differently when you reference it in the document, you need -to use the \texttt{text} key as well. +example, the \code{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 \cs{gls}\marg{label} in +the document, you need to use the \code{text} key as well. For example: \begin{verbatim} @@ -414,11 +626,21 @@ For example: \end{verbatim} This will appear in the text as \qt{Latin alphabet} but will be listed in the glossary as \qt{Latin Alphabet}. +With \app{bib2gls} this entry is defined in the \file{.bib} +file as: +\begin{verbatim} +@entry{latinalph, + name={Latin Alphabet}, + text={Latin alphabet}, + description={alphabet consisting of the letters + a, \ldots, z, A, \ldots, Z} +} +\end{verbatim} -Another commonly used key is \texttt{plural} for specifying the -plural of the term. This defaults to the value of the \texttt{text} +Another commonly used key is \code{plural} for specifying the +plural of the term. This defaults to the value of the \code{text} key with an \qt{s} appended, but if this is incorrect, just use the -\texttt{plural} key to override it: +\code{plural} key to override it: \begin{verbatim} \newglossaryentry{oesophagus} { @@ -430,18 +652,99 @@ key with an \qt{s} appended, but if this is incorrect, just use the (Remember from earlier that the initial ligature \cs{oe} needs to be grouped.) -The plural forms for acronyms can be specified using the -\texttt{longplural} and \texttt{shortplural} keys. For example: +Abbreviations can be defined using +\begin{definition} +\cs{newacronym}\oarg{options}\marg{label}\marg{short}\marg{long} +\end{definition} +where \meta{label} is the label (as per \cs{newglossaryentry}), +\meta{short} is the short form and \meta{long} is the long form. +For example, the +following defines an abbreviation: +\begin{verbatim} +\newacronym{svm}{SVM}{support vector machine} +\end{verbatim} +This internally uses \cs{newglossaryentry} to define an entry with +the label \code{svm}. By default, the \code{name} key is set to +\meta{short} (\qt{SVM} in the above example) and the +\code{description} key is set to \meta{long} (\qt{support vector +machine} in the above example). If, instead, you want to be able to +specify your own description you can do this using the optional +argument: \begin{verbatim} \newacronym + [description={statistical pattern recognition technique}] + {svm}{SVM}{support vector machine} +\end{verbatim} + +Before you define your acronyms (or other types of abbreviations), you +need to specify which style to use with +\begin{definition} +\cs{setacronymstyle}\marg{style name} +\end{definition} +where \meta{style name} is the name of the style. There are a number +of predefined styles, such as: \code{long-short} (on first use +display the long form with the short form in parentheses); +\code{short-long} (on first use display the short form with the +long form in parentheses); \code{long-short-desc} (like +\code{long-short} but you need to specify the description); or +\code{short-long-desc} (like \code{short-long} but you need to +specify the description). There are some other styles as well that +use \cs{textsc} to typeset the acronym or that use a footnote on +first use. See the main user guide for further details. + +The \sty{glossaries-extra} package provides improved abbreviation +handling with \href{http://www.dickimaw-books.com/gallery/sample-abbr-styles.shtml}{a lot more predefined styles}. +With this extension package, abbreviations are defined using: +\begin{definition} +\cs{newabbreviation}\oarg{options}\marg{label}\marg{short}\marg{long} +\end{definition} +You can still use \cs{newacronym} but it's redefined to +use the new abbreviation interface. The style must now be set using: +\begin{definition} +\cs{setabbreviationstyle}\oarg{category}\marg{style name} +\end{definition} +The default \meta{category} is \code{abbreviation}. If you use +\cs{newacronym} the category is \code{acronym}, which is why you +need to use the optional argument if you define abbreviations with +\cs{newacronym} when \sty{glossaries-extra} has been loaded: +\begin{alltt} +\cs{setabbreviationstyle}[acronym]\marg{style name} +\end{alltt} +If you use \app{bib2gls} then abbreviations are defined in the +\file{.bib} file in the format: +\begin{alltt} +@abbreviation\{\meta{label}, + long=\marg{long form}, + short=\marg{short form} +\} +\end{alltt} + +The plural forms for abbreviations can be specified using the +\code{longplural} and \code{shortplural} keys. For example: +\begin{verbatim} +\newacronym + [longplural={diagonal matrices}] + {dm}{DM}{diagonal matrix} +\end{verbatim} +or (with \sty{glossaries-extra}): +\begin{verbatim} +\newabbreviation % glossaries-extra.sty [longplural={diagonal matrices}] {dm}{DM}{diagonal matrix} \end{verbatim} If omitted, the defaults are again obtained by appending an \qt{s} to -the singular versions. +the singular versions. With \app{bib2gls}, the definition in the +\file{.bib} file is: +\begin{verbatim} +@abbreviation{dm, + short={DM}, + long={diagonal matrix}, + longplural={diagonal matrices} +} +\end{verbatim} It's also possible to have both a~name and a~corresponding symbol. -Just use the \texttt{name} key for the name and the \texttt{symbol} key +Just use the \code{name} key for the name and the \code{symbol} key for the symbol. For example: \begin{verbatim} \newglossaryentry{emptyset} @@ -451,6 +754,91 @@ for the symbol. For example: description={the set containing no elements} } \end{verbatim} +or with \app{bib2gls} the definition in the \file{.bib} file is: +\begin{verbatim} +@entry{emptyset, + name={empty set}, + symbol={\ensuremath{\emptyset}}, + description={the set containing no elements} +} +\end{verbatim} + +If you want the symbol in the \code{name} field then you must +supply a \code{sort} value with \optsand13 otherwise you'll end up +with errors from \TeX\ or \app{xindy}. With \opt2 +(\app{makeindex}) it's not quite so important but you may find +the resulting order is a little odd. For example: +\begin{verbatim} +\newglossaryentry{emptyset} +{ + name={\ensuremath{\emptyset}}, + sort={empty set}, + description={the set containing no elements} +} +\end{verbatim} +This displays the symbol as $\emptyset$ but sorts according to +\qt{empty set}. You may want to consider using +\sty{glossaries-extra}'s \pkgopt{symbols} package option which +provides +\begin{definition} +\cs{glsxtrnewsymbol}\oarg{options}\marg{label}\marg{symbol} +\end{definition} +This internally uses \cs{newglossaryentry} but automatically sets +the \code{sort} key to the \meta{label}. For example: +\begin{verbatim} +\documentclass{article} + +\usepackage[symbols]{glossaries-extra} + +\makeglossaries + +\glsxtrnewsymbol % requires glossaries-extra.sty 'symbols' option + [description={the set containing no elements}] + {emptyset}% label (and sort value) + {\ensuremath{\emptyset}}% symbol + +\begin{document} +\gls{emptyset} + +\printglossaries +\end{document} +\end{verbatim} +Now the sort value is \qt{emptyset} rather than the previous +\qt{empty set}. + +With \app{bib2gls} you can define this in the \file{.bib} file +as +\begin{verbatim} +@entry{emptyset, + name={\ensuremath{\emptyset}}, + description={the set containing no elements} +} +\end{verbatim} +in which case \app{bib2gls} will try to interpret the \code{name} +field to determine the sort value. Alternatively you can use: +\begin{verbatim} +@symbol{emptyset, + name={\ensuremath{\emptyset}}, + description={the set containing no elements} +} +\end{verbatim} +which will use the label (\code{emptyset}) as the sort value. +(You don't need the \pkgopt{symbols} package option in this case, +unless you want a separate symbols list.) The corresponding document +(where the definition is in the file \file{entries.bib}) is now: +\begin{verbatim} +\documentclass{article} + +\usepackage[record]{glossaries-extra} + +\GlsXtrLoadResources[src=entries] + +\begin{document} +\gls{emptyset} + +\printunsrtglossaries +\end{document} +\end{verbatim} \section{Using Entries} \label{sec:useterm} @@ -464,6 +852,9 @@ do this, but the most common one is: where \meta{label} is the label you assigned to the entry when you defined it. For example, \verb|\gls{fishage}| will display \qt{Fish Age} in the text (given the definition from the previous section). +If you are using \app{bib2gls} then this will display ?? (like +\cs{ref} and \cs{cite}) until \app{bib2gls} has created the +relevant files and \LaTeX\ is rerun. If you are using the \sty{hyperref} package (remember to load it before \styfmt{glossaries}) \cs{gls} will create a hyperlink to the @@ -472,13 +863,17 @@ hyperlink for a particular instance, use the starred form \cs{gls*} for example, \verb|\gls*{fishage}|. The other commands described in this section all have a similar starred form. -If the entry was defined as an acronym (using \cs{newacronym} -described above), then \cs{gls} will display the full form the first -time it's used and just the short form on -subsequent use. For example, if the acronym style is set to -\texttt{long-short}, then \verb|\gls{svm}| will display \qt{support vector -machine (svm)} the first time it's used, but the next occurrence of -\verb|\gls{svm}| will just display \qt{svm}. +If the entry was defined as an acronym (using \cs{newacronym} with +\styfmt{glossaries} described above) or an abbreviation (using +\cs{newabbreviation} with \sty{glossaries-extra}), then \cs{gls} +will display the full form the first time it's used and just the +short form on subsequent use. For example, if the style is +set to \code{long-short}, then \verb|\gls{svm}| will display +\qt{support vector machine (SVM)} the first time it's used, but the +next occurrence of \verb|\gls{svm}| will just display \qt{SVM}. +(If you use \cs{newacronym} with \sty{glossaries-extra} the default +doesn't show the long form on first use. You'll need to change the +style first, as described earlier.) If you want the plural form, you can use: \begin{definition} @@ -502,7 +897,7 @@ for the plural form. For example: \end{verbatim} produces \qt{Sets are collections}. -If you've specified a symbol using the \texttt{symbol} key, you can +If you've specified a symbol using the \code{symbol} key, you can display it using: \begin{definition} \cs{glssymbol}\marg{label} @@ -511,15 +906,58 @@ display it using: \section{Displaying a List of Entries} \label{sec:printglossaries} -In \sectionref{sec:start} I mentioned that there are three options -you can choose from to create your glossary. Here they are again in -a little more detail: +In \sectionref{sec:start}, I mentioned that there are three options +you can choose from to create an automatically sorted glossary with the base +\styfmt{glossaries} package. These are also available with the +extension package \styfmt{glossaries-extra} along with a fourth +option. These four options are listed below in a little more detail. +\Tableref{tab:optionsp+c} summarises the main advantages and +disadvantages. (There's a more detailed summary in the main +\styfmt{glossaries} user manual.) + +\begin{table}[htbp] + \caption{Comparison of Glossary Options} + \label{tab:optionsp+c} + {% + \centering + \begin{tabular}{>{\raggedright}p{0.3\textwidth}cccc} + & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3 & \bfseries +\opt4\\ + Requires \sty{glossaries-extra}? & + \conno & \conno & \conno & \conyes\\ + Requires an external application? & + \conno & \conyes & \conyes & \conyes\\ + Requires Perl? & + \conno & \conno & \conyes & \conno\\ + Requires Java? & + \conno & \conno & \conno & \conyes\\ + Can sort extended Latin + or non-Latin alphabets? & + \prono & \prono & \proyes & \proyes\\ + Efficient sort algorithm? & + \prono & \proyes & \proyes & \proyes\\ + Can use different sort methods for each glossary? & + \proyes & \prono & \prono & \proyes\\ + Any problematic sort values? & + \conyes & \conyes & \conyes & \conno\\ + Can form ranges in the location lists? & + \prono & \proyes & \proyes & \proyes\\ + Can have non-standard locations? & + \proyes & \prono & \proyes\textsuperscript{\textdagger} & \proyes + \end{tabular} + \par}\medskip\footnotesize\textsuperscript{\textdagger} Requires some setting up. +\end{table} + \begin{description} \item[]\optionlabel1: 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 \code{name} mustn't contain commands (or, if it does, the + \code{sort} value must be supplied) unless you + have the package option \pkgopt{sanitizesort} or \pkgopt[def]{sort} + or \pkgopt[use]{sort}. \begin{enumerate} \item Add \cs{makenoidxglossaries} to your preamble (before you @@ -531,33 +969,66 @@ a little more detail: \cs{printnoidxglossary}[sort=\meta{order},\meta{other options}] \end{definition} where you want your list of entries to appear. The sort - \meta{order} may be one of: \texttt{word} (word ordering), - \texttt{letter} (letter ordering), \texttt{case} (case-sensitive - letter ordering), \texttt{def} (in order of definition) or - \texttt{use} (in order of use). Alternatively, use + \meta{order} may be one of: \code{word} (word ordering), + \code{letter} (letter ordering), \code{case} (case-sensitive + letter ordering), \code{def} (in order of definition) or + \code{use} (in order of use). Alternatively, use \begin{definition} \cs{printnoidxglossaries} \end{definition} 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: +\begin{verbatim} +\printnoidxglossary[sort=word]% main glossary +\printnoidxglossary[type=symbols,sort=use]% symbols glossary +\end{verbatim} + \item Run \LaTeX\ twice on your document. (As you would do to make a~table of contents appear.) For example, click twice on the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor. \end{enumerate} +Here's a complete document (\file{myDoc.tex}): +\begin{verbatim} +\documentclass{article} + +\usepackage{glossaries} + +\makenoidxglossaries % use TeX to sort + +\newglossaryentry{sample}{name={sample}, + description={an example}} + +\begin{document} +A \gls{sample}. + +\printnoidxglossaries % iterate over all indexed entries +\end{document} +\end{verbatim} +Document build: +\begin{verbatim} +pdflatex myDoc +pdflatex myDoc +\end{verbatim} \item[]\optionlabel2: - This option uses an application called \texttt{makeindex} to sort + This option uses an application called \app{makeindex} to sort the entries. This application comes with all modern \TeX\ distributions, but it's hard-coded for the non-extended Latin alphabet. This process involves making \LaTeX\ write the glossary information to a temporary - file which \texttt{makeindex} reads. Then \texttt{makeindex} writes + file which \app{makeindex} reads. Then \app{makeindex} writes a~new file containing the code to typeset the glossary. \LaTeX\ then - reads this file on the next run. + reads this file on the next run. The \app{makeindex} + application is automatically invoked by the helper + \app{makeglossaries} script, which works out all the + appropriate settings from the \file{.aux} file. \begin{enumerate} - \item If you are using \sty{ngerman} or some other package that + \item If you are using \sty{ngerman}\footnote{deprecated, use +\sty{babel} instead} or some other package that makes the double-quote character \verb|"| a shorthand, then use \cs{GlsSetQuote} to change this to some other character. For example: @@ -575,7 +1046,7 @@ example: \cs{printglossary}\oarg{options} \end{definition} where you want your list of entries (glossary) to appear. (The - \texttt{sort} key isn't available in \meta{options}.) + \code{sort} key isn't available in \meta{options}.) Alternatively, use \begin{definition} \cs{printglossaries} @@ -583,57 +1054,115 @@ example: which will display all glossaries (if you have more than one). This command doesn't have any arguments. +\begin{important} +All glossaries are sorted using the same method +which may be identified with one of the package options: +\pkgopt[standard]{sort} (default), \pkgopt[use]{sort} +or \pkgopt[def]{sort}. +\end{important} + \item Run \LaTeX\ on your document. This creates files with the - extensions \texttt{.glo} and \texttt{.ist} (for example, if your - \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have - two extra files called \texttt{myDoc.glo} and \texttt{myDoc.ist}). + extensions \file{.glo} and \file{.ist} (for example, if your + \LaTeX\ document is called \file{myDoc.tex}, then you'll have + two extra files called \file{myDoc.glo} and \file{myDoc.ist}). If you look at your document at this point, you won't see the glossary as it hasn't been created yet. - \item Run \texttt{makeindex} with the \texttt{.glo} file as the - input file and the \texttt{.ist} file as the style so that - it creates an output file with the extension \texttt{.gls}. If + \item Run \app{makeglossaries} with the base name of your + document (without the \file{.tex}) extension. If you have access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command: \begin{verbatim} -makeindex -s myDoc.ist -o myDoc.gls myDoc.glo +makeglossaries myDoc \end{verbatim} - (Replace \texttt{myDoc} with the base name of your \LaTeX\ - document file. Avoid spaces in the file name.) If you don't know - how to use the command prompt, then you can probably access - \texttt{makeindex} via your text editor, but each editor has a + (Replace \file{myDoc} with the base name of your \LaTeX\ + document file without the \file{.tex} extension. + Avoid spaces in the file name.) If you don't have Perl installed + use \app{makeglossaries-lite} instead: +\begin{verbatim} +makeglossaries-lite myDoc +\end{verbatim} + +\begin{important} +Some beginners get confused by \app{makeglossaries} the +application (run as a system command) and \cs{makeglossaries} +the \LaTeX\ command which should be typed in the document +preamble. These are two different concepts that happen to have +similar looking names. +\end{important} + + If you don't know how to use the command prompt, then you can + probably configure your text editor to add + \app{makeglossaries} (or \app{makeglossaries-lite}) + as a build tool, but each editor has a different method of doing this, so I~can't give a~general description. You will have to check your editor's manual. + If you still have problems, try adding the \pkgopt{automake} + package option: +\begin{verbatim} +\usepackage[automake]{glossaries} +\end{verbatim} - The default sort is word order (\qt{sea lion} comes before -\qt{seal}). - If you want letter ordering you need to add the \texttt{-l} - switch: + The default sort is word order (\qt{sea lion} comes before \qt{seal}). + If you want letter ordering you need to add the + \pkgopt[letter]{order} package option \begin{verbatim} -makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo +\usepackage[order=letter]{glossaries} \end{verbatim} \item Once you have successfully completed the previous step, you can now run \LaTeX\ on your document again. \end{enumerate} +Here's a complete document (\file{myDoc.tex}): +\begin{verbatim} +\documentclass{article} + +\usepackage{glossaries} + +\makeglossaries % create makeindex files + +\newglossaryentry{sample}{name={sample}, + description={an example}} + +\begin{document} +A \gls{sample}. + +\printglossaries % input files created by makeindex +\end{document} +\end{verbatim} +Document build: +\begin{verbatim} +pdflatex myDoc +makeglossaries myDoc +pdflatex myDoc +\end{verbatim} +or +\begin{verbatim} +pdflatex myDoc +makeglossaries-lite myDoc +pdflatex myDoc +\end{verbatim} + \item[]\optionlabel3: This option uses an application called - \texttt{xindy} to sort the entries. This application is more - flexible than \texttt{makeindex} and is able to sort extended - Latin or non-Latin alphabets. It comes with \TeX~Live but not - with MiK\TeX. Since \texttt{xindy} is a Perl script, if you are - using MiK\TeX\ you will not only need to install \texttt{xindy}, you - will also need to install Perl. In a~similar way to \opt2, this + \app{xindy} to sort the entries. This application is more + flexible than \app{makeindex} and is able to sort extended + Latin or non-Latin alphabets. It comes with both \TeX~Live and + MiK\TeX. Since \app{xindy} is a Perl script, you will also + need to ensure that Perl is installed. In a~similar way to \opt2, this option involves making \LaTeX\ write the glossary information to - a~temporary file which \texttt{xindy} reads. Then \texttt{xindy} + a~temporary file which \app{xindy} reads. Then \app{xindy} writes a~new file containing the code to typeset the glossary. - \LaTeX\ then reads this file on the next run. + \LaTeX\ then reads this file on the next run. The \app{xindy} + application is automatically invoked by the helper + \app{makeglossaries} script, which works out all the + appropriate settings from the \file{.aux} file. \begin{enumerate} - \item Add the \texttt{xindy} option to the \sty{glossaries} + \item Add the \pkgopt{xindy} option to the \sty{glossaries} package option list: \begin{verbatim} \usepackage[xindy]{glossaries} @@ -647,44 +1176,45 @@ package option list: \cs{printglossary}\oarg{options} \end{definition} where you want your list of entries (glossary) to appear. (The - \texttt{sort} key isn't available in \meta{options}.) + \code{sort} key isn't available in \meta{options}.) Alternatively, use \begin{definition} \cs{printglossaries} \end{definition} +\begin{important} +All glossaries are sorted using the same method +which may be identified with one of the package options: +\pkgopt[standard]{sort} (default), \pkgopt[use]{sort} +or \pkgopt[def]{sort}. +\end{important} + \item Run \LaTeX\ on your document. This creates files with the - extensions \texttt{.glo} and \texttt{.xdy} (for example, if your - \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have - two extra files called \texttt{myDoc.glo} and \texttt{myDoc.xdy}). + extensions \file{.glo} and \file{.xdy} (for example, if your + \LaTeX\ document is called \file{myDoc.tex}, then you'll have + two extra files called \file{myDoc.glo} and \file{myDoc.xdy}). If you look at your document at this point, you won't see the glossary as it hasn't been created yet. - \item Run \texttt{xindy} with the \texttt{.glo} file as the - input file and the \texttt{.xdy} file as a~module so that - it creates an output file with the extension \texttt{.gls}. You - also need to set the language name and input encoding. If - you have access to a terminal or a command prompt (for example, the + \item Run \app{makeglossaries} with the base name of the + document (omitting the \file{.tex} extension). + If you have access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for - Unix-like users) then you need to run the command (all on one - line): -\begin{verbatim} -xindy -L english -C utf8 -I xindy -M myDoc --t myDoc.glg -o myDoc.gls myDoc.glo -\end{verbatim} - (Replace \texttt{myDoc} with the base name of your \LaTeX\ - document file. Avoid spaces in the file name. If necessary, also replace - \texttt{english} with the name of your language and \texttt{utf8} - with your input encoding.) If you don't know - how to use the command prompt, then you can probably access - \texttt{xindy} via your text editor, but each editor has a - different method of doing this, so I~can't give a~general - description. You will have to check your editor's manual. + Unix-like users) then you need to run the command: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} + (Replace \file{myDoc} with the base name of your \LaTeX\ + document file without the \file{.tex} extension. + Avoid spaces in the file name. If you don't know + how to use the command prompt, then as mentioned above, you may + be able to configure your text editor to add + \app{makeglossaries} as a build tool. The default sort is word order (\qt{sea lion} comes before \qt{seal}). If you want letter ordering you need to add the - \texttt{order=letter} package option: + \code{order=letter} package option: \begin{verbatim} \usepackage[xindy,order=letter]{glossaries} \end{verbatim} @@ -693,126 +1223,309 @@ xindy -L english -C utf8 -I xindy -M myDoc you can now run \LaTeX\ on your document again. \end{enumerate} +Here's a complete document (\file{myDoc.tex}): +\begin{verbatim} +\documentclass{article} -\end{description} +\usepackage[xindy]{glossaries} -For \optsand23, it can be difficult to remember all the -parameters required for \texttt{makeindex} or \texttt{xindy}, so the -\sty{glossaries} package provides a~script called -\texttt{makeglossaries} that reads the \texttt{.aux} file to -determine what settings you have used and will then run -\texttt{makeindex} or \texttt{xindy}. Again, this is a~command line -application and can be run in a~terminal or command prompt. For -example, if your \LaTeX\ document is in the file \texttt{myDoc.tex}, -then run: +\makeglossaries % create xindy files + +\newglossaryentry{sample}{name={sample}, + description={an example}} + +\begin{document} +A \gls{sample}. + +\printglossaries % input files created by xindy +\end{document} +\end{verbatim} +Document build: \begin{verbatim} +pdflatex myDoc makeglossaries myDoc +pdflatex myDoc \end{verbatim} -(Replace \texttt{myDoc} with the base name of your \LaTeX\ document -file. Avoid spaces in the file name.) If you don't know how to use -the command prompt, you can probably access \texttt{makeglossaries} -via your text editor. Check your editor's manual for advice. If you -are using \texttt{arara} then you can just use the directives: + +\item[]\optionlabel4: + + This requires the extension package \sty{glossaries-extra} and + an application called \app{bib2gls}. This application is able + to sort extended Latin or non-Latin alphabets. It comes with both + \TeX~Live and MiK\TeX\ but requires at least Java~7. This method + works differently to \optsand23. Instead of creating a file + containing the code to typeset the glossary it creates a + \file{.glstex} file containing the entry definitions fetched + from the \file{.bib} file (or files), but only those entries + that are required in the document are defined and they are + defined in the order obtained from the chosen sort method. + This means that you can just use + \cs{printunsrtglossary} to display each glossary (or + \cs{printunsrtglossaries} to display them all). + + \begin{enumerate} + \item Add the \pkgopt{record} option to the \sty{glossaries-extra} + package option list: \begin{verbatim} -% arara: pdflatex -% arara: makeglossaries -% arara: pdflatex +\usepackage[record]{glossaries-extra} \end{verbatim} -The \texttt{makeglossaries} script is written in Perl, so you need -a~Perl interpreter installed. If you are using a~Unix-like operating -system then you most likely have one installed. If you are using -Windows with the \TeX~Live distribution, then you can use the Perl -interpreter that comes with \TeX~Live. If you are using Windows and -MiK\TeX\ then you need to install a~Perl distribution for Windows. -If you are using \opt3, then you need to do this anyway as -\texttt{xindy} is also written in Perl. If you are using \opt2 -and can't work out how to install Perl (or for some reason don't -want to install it) then just use \texttt{makeindex} directly, as -described above, or you can use a~Lua alternative to -\texttt{makeglossaries} called \texttt{makeglossaries-lite.lua}: + \item Add one or more +\begin{definition} +\cs{GlsXtrLoadResources}[src=\marg{bib list},\meta{options}] +\end{definition} + to your preamble where \meta{bib list} is the + list of \file{.bib} files containing the entries. You may + use different sort methods for each resource set. For example: +\begin{verbatim} +\usepackage[record,% using bib2gls + abbreviations, + symbols, + numbers +]{glossaries-extra} + +\GlsXtrLoadResources[ + src={terms},% entries in terms.bib + type=main,% put these entries in the 'main' (default) list + sort={de-CH-1996}% sort according to this locale +] +\GlsXtrLoadResources[ + src={abbrvs},% entries in abbrvs.bib + type=abbreviations,% put these entries in the 'abbreviations' list + sort={letter-case}% case-sensitive letter (non-locale) sort +] +\GlsXtrLoadResources[ + src={syms},% entries in syms.bib + type=symbols,% put these entries in the 'symbols' list + sort={use}% sort according to first use in the document +] +\GlsXtrLoadResources[ + src={constants},% entries in constants.bib + type=numbers,% put these entries in the 'numbers' list + sort-field={user1},% sort according to this field + sort={double}% double-precision sort +] +\end{verbatim} +The last resource set assumes that the entries defined in the +file \file{constants.bib} have a number stored in the \code{user1} +field. For example: \begin{verbatim} -makeglossaries-lite.lua myDoc +@number{pi, + name={\ensuremath{\pi}}, + description={pi}, + user1={3.141592654} +} \end{verbatim} -As a last resort you can try the package option \texttt{automake}: + \item Put +\begin{definition} +\cs{printunsrtglossary}[type=\marg{type},\meta{options}] +\end{definition} + where you want your list of entries (glossary) to appear. (The + \code{sort} key isn't available in \meta{options}. It needs to be + used in \cs{GlsXtrLoadResources} instead.) + Alternatively, use +\begin{definition} +\cs{printunsrtglossaries} +\end{definition} + + \item Run \LaTeX\ on your document. The \pkgopt{record} option + adds information to the \file{.aux} file that provides + \app{bib2gls} with all required details for each resource set. + For example, if the file is called \file{myDoc.tex}: \begin{verbatim} -\usepackage[automake]{glossaries} +pdflatex myDoc \end{verbatim} -This will attempt to use \TeX's \cs{write18} mechanism to run -\texttt{makeindex} or \texttt{xindy}. It probably won't work for -\texttt{xindy} and won't work at all if the shell escape has been -disabled in your \TeX\ distribution. Most \TeX\ distributions will -allow a restricted shell escape, which will only allow trusted -applications to be run. If the \texttt{automake} option is -successful, you will still need to run \LaTeX\ twice for the -glossaries to be displayed. + + \item Run \app{bib2gls} +\begin{verbatim} +bib2gls myDoc +\end{verbatim} +or (if you need letter groups) +\begin{verbatim} +bib2gls --group myDoc +\end{verbatim} + + \item Run \LaTeX\ again. + \end{enumerate} +Here's a complete document (\file{myDoc.tex}): +\begin{verbatim} +\documentclass{article} + +\usepackage[record]{glossaries-extra} + +\GlsXtrLoadResources % input file created by bib2gls + [% instructions to bib2gls: + src={entries}, % terms defined in entries.bib + sort={en-GB}% sort according to this locale + ] + +\newglossaryentry{sample}{name={sample}, + description={an example}} + +\begin{document} +A \gls{sample}. + +\printunsrtglossaries % iterate over all defined entries +\end{document} +\end{verbatim} +The accompanying \file{entries.bib} file: +\begin{verbatim} +@entry{sample, + name = {sample}, + description = {an example} +} +\end{verbatim} +Document build: +\begin{verbatim} +pdflatex myDoc +bib2gls myDoc +pdflatex myDoc +\end{verbatim} + +\end{description} + +If you are having difficulty integrating \app{makeglossaries} +into your document build process, you may want to consider using +\app{arara}, which is a Java application that searches the +document for special comment lines that tell \app{arara} which +applications to run. For example, the file \file{myDoc.tex} might +start with: +\begin{verbatim} + % arara: pdflatex + % arara: makeglossaries + % arara: pdflatex + \documentclass{article} + \usepackage{glossaries} + \makeglossaries +\end{verbatim} +then to build the document you just need the single system call: +\begin{verbatim} + arara myDoc +\end{verbatim} +(The currently pending version 4.0 of \app{arara} has +directives for \app{makeglossaries-lite} and \app{bib2gls}. +These aren't available in earlier versions, but you could try +copying and adapting the \file{makeglossaries.yaml} file and +replace \app{makeglossaries} as appropriate.) When sorting the entries, the string comparisons are made according -to each entry's \texttt{sort} key. If this is omitted, the -\texttt{name} key is used. For example, recall the earlier +to each entry's \code{sort} key. If this is omitted, the +\code{name} key is used. For example, recall the earlier definition: \begin{verbatim} -\newglossaryentry{elite} -{ - name={{\'e}lite}, - description={select group or class} -} + \newglossaryentry{elite} + { + name={{\'e}lite}, + description={select group or class} + } \end{verbatim} -No \texttt{sort} key was used, so it's set to the same as the -\texttt{name} key: \verb|{\'e}lite|. How this is interpreted depends +No \code{sort} key was used, so it's set to the same as the +\code{name} key: \verb|{\'e}lite|. How this is interpreted depends on which option you have used: \begin{description} \item[\opt1:] By default, the accent command will be stripped so the -sort value will be \texttt{elite}. This will put the entry in the +sort value will be \code{elite}. This will put the entry in the \qt{E} letter group. However if you use the \pkgopt[true]{sanitizesort} package option, the sort value will be -interpreted as the sequence of characters: \verb|\| \texttt{'} \texttt{e} -\texttt{l} \texttt{i} \texttt{t} and \texttt{e}. This will place -this entry before the \qt{A} letter group since it starts with a symbol. +interpreted as the sequence of characters: \verb|{| \verb|\| \code{'} \code{e} +\verb|}| \code{l} \code{i} \code{t} and \code{e}. This will place +this entry in the \qt{symbols} group since it starts with a symbol. \item[\opt2:] The sort key will be interpreted the sequence of characters: -\verb|{| \verb|\| \verb|'| \texttt{e} \verb|}| \texttt{l} \texttt{i} \texttt{t} -and \texttt{e}. The first character is an opening curly brace -\verb|{| so \texttt{makeindex} will put this entry in the +\verb|{| \verb|\| \verb|'| \code{e} \verb|}| \code{l} \code{i} \code{t} +and \code{e}. The first character is an opening curly brace +\verb|{| so \app{makeindex} will put this entry in the \qt{symbols} group. \item[\opt3:] -\texttt{xindy} disregards \LaTeX\ commands so it sorts on -\texttt{elite}, which puts this entry in the \qt{E} group. +\app{xindy} disregards \LaTeX\ commands so it sorts on +\code{elite}, which puts this entry in the \qt{E} group. +If stripping all commands leads to an empty string (such as +\verb|\ensuremath{\emptyset}|) then \app{xindy} will fail, so in +these situations you need to provide an appropriate \code{sort} +value that \app{xindy} will accept. +\begin{important} +\app{xindy} merges entries with duplicate sort values. +\app{xindy} forbids empty sort values. +A sort value may degrade into an empty or duplicate value once +\app{xindy} has stripped all commands and braces. +\end{important} + +\item[\opt4:] +\app{bib2gls} has a primitive \LaTeX\ parser that recognises a +limited set of commands, which includes the standard accent commands +and some maths commands, so it can convert \verb|{\'e}lite| to +\code{\'elite}. It disregards unknown commands. This may lead to +an empty sort value, but \app{bib2gls} doesn't mind that. + +Note that even if the name is given as \verb|{\'e}lite|, the letter +group heading (if the \verb|--group| switch is used) may end up with +the character \'E depending on the locale used by the sort +comparator. In this case you will need to ensure the document can +support this character either with \sty{inputenc} or by switching to +a \LaTeX\ engine with native UTF-8 support. + \end{description} -If the \sty{inputenc} package is used and the entry is defined as: +If the \sty{inputenc} package is used: +\begin{verbatim} + \usepackage[utf8]{inputenc} +\end{verbatim} +and the entry is defined as: \begin{alltt} -\verb|\newglossaryentry{elite}| -\verb|{| - name=\verb|{{|\'e\verb|}lite},| - description=\verb|{select group or class}| -\verb|}| + \verb|\newglossaryentry{elite}| + \verb|{| + name=\verb|{{|\'e\verb|}lite},| + description=\verb|{select group or class}| + \verb|}| \end{alltt} then: \begin{description} \item[\opt1:] By default the sort value will be interpreted as -\texttt{elite} so the entry will be put in the \qt{E} letter group. +\code{elite} so the entry will be put in the \qt{E} letter group. If you use the \pkgopt[true]{sanitizesort} package option, the -sort value will be interpreted as \texttt{\'elite} where \'e has -been sanitized (so it's no longer an active character) which will -put this entry before the \qt{A} letter group. +sort value will be interpreted as \code{\'elite} where \'e has +been sanitized (so it's no longer an active character and is in fact +seen as two octets 0xC3 0xA9) which will +put this entry before the \qt{A} letter group. (The group is +determined by the first octet 0xC3.) + +\item[\opt2:] \app{makeindex} sees \code{\'e} as two octets +(0xC3 0xA9) rather than a single character so it tries to put +\code{\'elite} in the 0xC3 (\qt{\~A}) letter group (which, in this +case, comes after \qt{Z}). + +\item[\opt3:] \app{xindy} will correctly recognise the sort value +\code{\'elite} and will place it in whatever letter group is +appropriate for the given language setting. (In English, this would +just be the \qt{E} letter group, but another language +might put it in the \qt{\'E} letter group.) + +\item[\opt4:] The \sty{inputenc} package doesn't affect the +encoding used with \file{.bib} entry definitions, since these are dependent +on the encoding used to save the \file{.bib} file (although the +labels must still be ASCII). You can help \app{bib2gls} (and +JabRef) by putting an encoding comment at the start of the \file{.bib} file: +\begin{alltt} +\% Encoding: UTF-8 +\end{alltt} -\item[\opt2:] \texttt{makeindex} doesn't recognise \texttt{\'e} as -a~letter so it will be put in the symbols group. +With the correct encoding set up, \app{bib2gls} will determine +that the sort value is \code{\'elite} and will place it in +whatever letter group is appropriate for the given sort rule. +For example, \verb|sort=en-GB| (or just \verb|sort=en|) will put +\code{\'elite} in the \qt{E} letter group, but another language +might put it in the \qt{\'E} letter group. -\item[\opt3:] \texttt{xindy} will correctly recognise the sort value -\texttt{\'elite} and will place it in whatever letter group is -appropriate for the given language setting. (In English, this would -just be the \qt{E} letter group.) \end{description} Therefore if you have extended Latin or non-Latin characters, your -best option is to use \texttt{xindy} (\opt3) with the \sty{inputenc} -package. If you use \texttt{makeindex} (\opt2) you need to specify the -\texttt{sort} key like this: +best option is to use either \app{xindy} (\opt3) or +\app{bib2gls} (\opt4) with the \sty{inputenc} or \sty{fontspec} package. +If you use \app{makeindex} (\opt2) you need to specify the +\code{sort} key like this: \begin{verbatim} \newglossaryentry{elite} { @@ -821,48 +1534,28 @@ package. If you use \texttt{makeindex} (\opt2) you need to specify the description={select group or class} } \end{verbatim} -If you use \opt1, you may or may not need to use the \texttt{sort} +or +\begin{alltt} +\cs{newglossaryentry}\{elite\} +\{ + name=\{\{\'e\}lite\}, + sort=\{elite\}, + description=\{select group or class\} +\} +\end{alltt} +If you use \opt1, you may or may not need to use the \code{sort} key, but you will need to be careful about fragile commands in the -\texttt{name} key if you don't set the \texttt{sort} key. +\code{name} key if you don't set the \code{sort} key. -If you use \opt3 and the \texttt{name} only contains a command -(such as \cs{P}) you must add the \texttt{sort} key. This -is also advisable for the other options, but is essential for -\opt3. For example: +If you use \opt3 and the \code{name} only contains a command or +commands (such as \cs{P} or \verb|\ensuremath{\pi}|) you must add the +\code{sort} key. This is also advisable for the other options +(except \opt4), but is essential for \opt3. For example: \begin{verbatim} -\newglossaryentry{P}{name={\P},sort={P}, - description={paragraph symbol}} + \newglossaryentry{P}{name={\P},sort={P}, + description={paragraph symbol}} \end{verbatim} -\Tableref{tab:optionsp+c} summarises the main pros and cons of three -options described above. - -\begin{table}[htbp] - \caption{Glossary Options: Pros and Cons} - \label{tab:optionsp+c} - {% - \centering - \begin{tabular}{>{\raggedright}p{0.3\textwidth}ccc} - & \bfseries \opt1 & \bfseries \opt2 & \bfseries \opt3\\ - Requires an external application? & - \no & \yes & \yes\\ - Requires Perl? & - \no & \no & \yes\\ - Can sort extended Latin - or non-Latin alphabets? & - \no\textsuperscript{\textdagger} & \no & \yes\\ - Efficient sort algorithm? & - \no & \yes & \yes\\ - Can form ranges in the location lists? & - \no & \yes & \yes\\ - Can have non-standard locations? & - \yes & \no & \yes - \end{tabular} - \par - }\textsuperscript{\textdagger} Strips standard \LaTeX\ accents so, -for example, \verb|\AA| is treated the same as A. -\end{table} - \section{Customising the Glossary} \label{sec:glosstyle} @@ -874,29 +1567,44 @@ displayed in bold. You can switch to medium weight by redefining \begin{verbatim} \renewcommand*{\glsnamefont}[1]{\textmd{#1}} \end{verbatim} - -By default, a~full stop is appended to the description. To prevent -this from happening use the \texttt{nopostdot} package option: +Some classes and packages redefine the \env{description} environment +in such as way that's incompatible with the \styfmt{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 \sty{glossaries-extra}). To prevent +this from happening use the \pkgopt{nopostdot} package option: \begin{verbatim} \usepackage[nopostdot]{glossaries} \end{verbatim} +or to add it with \styfmt{glossaries-extra}: +\begin{verbatim} +\usepackage[postdot]{glossaries-extra} +\end{verbatim} -By default, a~location list is displayed for each entry. This refers +By default, a~location list is displayed for each entry (unless you +use \cs{printunsrtglossary} without \app{bib2gls}). This refers to the document locations (for example, the page number) where the -entry has been referenced. If you use \optsor23 described -in \sectionref{sec:printglossaries} location ranges will be compressed. For -example, if an entry was used on pages~1, 2 and~3, with -\optsor23 the location list will appear as 1--3, but with \opt1 it +entry has been referenced. If you use \optsor23 described in +\sectionref{sec:printglossaries} or \opt4 (with \app{bib2gls} and +\sty{glossaries-extra}) then location ranges will be compressed. +For example, if an entry was used on pages~1, 2 and~3, with +\optsor23 or \opt4 the location list will appear as 1--3, but with \opt1 it will appear as 1, 2, 3. If you don't want the locations displayed -you can hide them using the \texttt{nonumberlist} package option: +you can hide them using the \pkgopt{nonumberlist} package option: \begin{verbatim} \usepackage[nonumberlist]{glossaries} \end{verbatim} +or with \app{bib2gls} use \code{save-locations=false} in the +optional argument of the appropriate \cs{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 \texttt{sort} key. By default a~vertical gap is placed +each entry's \code{sort} key. By default a~vertical gap is placed between letter groups. You can suppress this with the -\texttt{nogroupskip} package option: +\pkgopt{nogroupskip} package option: \begin{verbatim} \usepackage[nogroupskip]{glossaries} \end{verbatim} @@ -906,11 +1614,19 @@ style using: \begin{definition} \cs{setglossarystyle}\marg{style name} \end{definition} -There are a~number of predefined styles. Glossaries can vary from +\href{http://www.dickimaw-books.com/gallery/glossaries-styles/}{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 multiple paragraphs, so there's no \qt{one style fits all} solution. You need to choose a~style that -suits your document. +suits your document. For example: +\begin{verbatim} +\setglossarystyle{index} +\end{verbatim} +You can also use the \pkgopt{style} package option for the preloaded +styles. For example: +\begin{verbatim} +\usepackage[style=index]{glossaries} +\end{verbatim} Examples: \begin{enumerate} @@ -918,9 +1634,13 @@ Examples: description is a~brief phrase or short sentence. Try one of the \qt{mcol} styles defined in the \sty{glossary-mcols} package. For example: \begin{verbatim} -\usepackage[nogroupskip,nopostdot]{glossaries} +\usepackage[nopostdot]{glossaries} \usepackage{glossary-mcols} \setglossarystyle{mcolindex} +\end{verbatim} +or +\begin{verbatim} +\usepackage[stylemods={mcols},style=mcolindex]{glossaries-extra} \end{verbatim} \item You have entries where the name is a~word or phrase and the @@ -929,6 +1649,10 @@ example: \begin{verbatim} \usepackage[nopostdot]{glossaries} \setglossarystyle{altlist} +\end{verbatim} +or +\begin{verbatim} +\usepackage[stylemods,style=altlist]{glossaries-extra} \end{verbatim} \item You have entries where the name is a~single word, the @@ -946,10 +1670,10 @@ or one of the \qt{tree} styles: \end{verbatim} \end{enumerate} -If your glossary consists of a~list of acronyms and you also want to +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 acronym style that will suit the glossary style. For example, -use the \texttt{long-short-desc} acronym style: +an abbreviation style that will suit the glossary style. For example, +use the \code{long-short-desc} acronym style: \begin{verbatim} \setacronymstyle{long-short-desc} \end{verbatim} @@ -957,9 +1681,18 @@ Define the acronyms with a~description: \begin{verbatim} \newacronym [description={statistical pattern recognition technique}] - {svm}{svm}{support vector machine} + {svm}{SVM}{support vector machine} \end{verbatim} -Choose a~glossary style that suits wide entry names: +Alternatively with \sty{glossaries-extra}: +\begin{verbatim} +\setabbreviationstyle{long-short-desc} + +\newabbreviation + [description={statistical pattern recognition technique}] + {svm}{SVM}{support vector machine} +\end{verbatim} + +Choose a~glossary style that suits wide entry names. For example: \begin{verbatim} \setglossarystyle{altlist} \end{verbatim} @@ -967,11 +1700,11 @@ Choose a~glossary style that suits wide entry names: \section{Multiple Glossaries} \label{sec:multigloss} -The \sty{glossaries} package predefines a~default \texttt{main} +The \sty{glossaries} package predefines a~default \code{main} glossary. When you define an entry (using one of the commands described in \sectionref{sec:defterm}), that entry is automatically assigned to the default glossary, unless you indicate otherwise -using the \texttt{type} key. However you first need to +using the \code{type} key. However you first need to make sure the desired glossary has been defined. This is done using: \begin{definition} \cs{newglossary}\oarg{glg}\marg{label}\marg{gls}\marg{glo}\marg{title} @@ -982,9 +1715,10 @@ to use active characters in \meta{label}. The final argument \meta{title} is the section or chapter heading used by \cs{printglossary} or \cs{printnoidxglossary}. The other arguments indicate the file extensions used by -\texttt{makeindex}\slash\texttt{xindy} (described in +\app{makeindex}\slash\app{xindy} (described in \sectionref{sec:printglossaries}). If you use \opt1 described -above, the \meta{glg}, \meta{gls} and \meta{glo} arguments are +above (or \app{bib2gls} and \cs{printunsrtglossaries}), +then the \meta{glg}, \meta{gls} and \meta{glo} arguments are ignored, in which case you may prefer to use the starred version where you don't specify the extensions: \begin{definition} @@ -992,53 +1726,63 @@ where you don't specify the extensions: \end{definition} In the case of \optsor23, all glossary definitions must come before -\cs{makeglossaries}. +\cs{makeglossaries}. (Entries definitions should come after +\cs{makeglossaries}.) In the case of \opt4, all glossary definitions +must come before any \cs{GlsXtrLoadResources} that requires them. Since it's quite common for documents to have both a~list of terms -and a~list of acronyms, the \sty{glossaries} package provides the -package option \texttt{acronym} (or \texttt{acronyms}), which +and a~list of abbreviations, the \sty{glossaries} package provides the +package option \pkgopt{acronym} (or \pkgopt{acronyms}), which is a~convenient shortcut for \begin{verbatim} \newglossary[alg]{acronym}{acr}{acn}{\acronymname} \end{verbatim} The option also changes the behaviour of \cs{newacronym} so that acronyms are automatically put in the list of acronyms instead of the main -glossary. +glossary. The \sty{glossaries-extra} package also provides this +option for abbreviations defined using \cs{newacronym} but +additionally has the package option \pkgopt{abbreviations} to create +a list of abbreviations for \cs{newabbreviation}. + +There are some other package options for creating commonly used +lists: \pkgopt{symbols} (lists of symbols), \pkgopt{numbers} (lists +of numbers), \pkgopt{index} (index of terms without descriptions defined with +\cs{newterm}\oarg{options}\marg{label}). For example, suppose you want a~main glossary for terms, a~list of acronyms and a~list of notation: \begin{verbatim} -\usepackage[acronyms]{glossaries} -\newglossary[nlg]{notation}{not}{ntn}{Notation} + \usepackage[acronyms]{glossaries} + \newglossary[nlg]{notation}{not}{ntn}{Notation} \end{verbatim} After \cs{makeglossaries} (or \cs{makenoidxglossaries}) you can define the entries in the preamble. For example: \begin{verbatim} -\newglossaryentry{gls:set} -{% This entry goes in the `main' glossary - name=set, - description={A collection of distinct objects} -} - -% This entry goes in the `acronym' glossary: -\newacronym{svm}{svm}{support vector machine} - -\newglossaryentry{not:set} -{% This entry goes in the `notation' glossary: - type=notation, - name={\ensuremath{\mathcal{S}}}, - description={A set}, - sort={S}} + \newglossaryentry{gls:set} + {% This entry goes in the `main' glossary + name=set, + description={A collection of distinct objects} + } + + % This entry goes in the `acronym' glossary: + \newacronym{svm}{svm}{support vector machine} + + \newglossaryentry{not:set} + {% This entry goes in the `notation' glossary: + type=notation, + name={\ensuremath{\mathcal{S}}}, + description={A set}, + sort={S}} \end{verbatim} or if you don't like using \cs{ensuremath}: \begin{verbatim} -\newglossaryentry{not:set} -{% This entry goes in the `notation' glossary: - type=notation, - name={$\mathcal{S}$}, - text={\mathcal{S}}, - description={A set}, - sort={S}} + \newglossaryentry{not:set} + {% This entry goes in the `notation' glossary: + type=notation, + name={$\mathcal{S}$}, + text={\mathcal{S}}, + description={A set}, + sort={S}} \end{verbatim} Each glossary is displayed using: @@ -1050,10 +1794,41 @@ Each glossary is displayed using: \cs{printglossary}[type=\meta{type}] \end{definition} (\optsand23). Where \meta{type} is the glossary label. If the -type is omitted the default \texttt{main} glossary is assumed. +type is omitted the default \code{main} glossary is assumed. + +If you're using \app{bib2gls} then each glossary is displayed +using: +\begin{definition} +\cs{printunsrtglossary}[type=\meta{type}] +\end{definition} +With this method you don't use \cs{makeglossaries} or +\cs{makenoidxglossaries}. Instead you can assign the entry type +with the resource command. For example: +\begin{verbatim} + \usepackage[record,abbreviations,symbols]{glossaries-extra} + + \GlsXtrLoadResources[ + src={terms}, % entries defined in terms.bib + type={main}% put in main glossary + ] + \GlsXtrLoadResources[ + src={abbrvs}, % entries defined in abbrvs.bib + type={abbreviations}% put in abbreviations glossary + ] + \GlsXtrLoadResources[ + src={syms}, % entries defined in syms.bib + type={symbols}% put in symbols glossary + ] +\end{verbatim} +Later in the document: +\begin{verbatim} + \printunsrtglossary % main + \printunsrtglossary[type=abbreviations] + \printunsrtglossary[type=symbols] +\end{verbatim} There's a~convenient shortcut that will display all the defined -glossaries: +glossaries depending on the indexing method: \begin{definition} \cs{printnoidxglossaries} \end{definition} @@ -1061,44 +1836,59 @@ glossaries: \begin{definition} \cs{printglossaries} \end{definition} -(\optsand23). +(\optsand23) or (\sty{glossaries-extra} only) +\begin{definition} +\cs{printunsrtglossaries} +\end{definition} If you use \opt1, you don't need to do anything else. If you use -\optsor23 with the \texttt{makeglossaries} Perl script, you +\optsor23 with the \app{makeglossaries} Perl script or the +\app{makeglossaries-lite} Lua script, you similarly don't need to do anything else. If you use \optsor23 -without the \texttt{makeglossaries} Perl script then you need to -make sure you run \texttt{makeindex}\slash\texttt{xindy} \emph{for +without the \app{makeglossaries} Perl script then you need to +make sure you run \app{makeindex}\slash\app{xindy} \emph{for each defined glossary}. The \meta{gls} and \meta{glo} arguments of \cs{newglossary} specify the file extensions to use instead of -\texttt{.gls} and \texttt{.glo}. The optional argument \meta{glg} is +\file{.gls} and \file{.glo}. The optional argument \meta{glg} is the file extension for the transcript file. This should be different for each glossary in case you need to check for -\texttt{makeindex}\slash\texttt{xindy} errors or warnings if things +\app{makeindex}\slash\app{xindy} errors or warnings if things go wrong. For example, suppose you have three glossaries in your document -(\texttt{main}, \texttt{acronym} and \texttt{notation}), +(\code{main}, \code{acronym} and \code{notation}), specified using: \begin{verbatim} \usepackage[acronyms]{glossaries} \newglossary[nlg]{notation}{not}{ntn}{Notation} \end{verbatim} Then (assuming your \LaTeX\ document is in a~file called -\texttt{myDoc.tex}): +\file{myDoc.tex}): \begin{description} -\item\opt2: - -You need to run \texttt{makeindex} three times: +\item\opt2 +Either use one \app{makeglossaries} or +\app{makeglossaries-lite} call: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} +or +\begin{verbatim} +makeglossaries-lite myDoc +\end{verbatim} +Or you need to run \app{makeindex} three times: \begin{verbatim} makeindex -t myDoc.glg -s myDoc.ist -o myDoc.gls myDoc.glo makeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn \end{verbatim} -\item\opt3:\nopagebreak - -You need to run \texttt{xindy} three times (be careful not to insert +\item\opt3 +Either use one \app{makeglossaries} call: +\begin{verbatim} +makeglossaries myDoc +\end{verbatim} +Or you need to run \app{xindy} three times (be careful not to insert line breaks where the line has wrapped.) \begin{verbatim} xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg @@ -1108,15 +1898,25 @@ xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg -o myDoc.not myDoc.ntn \end{verbatim} + +\item\opt4 +With \app{bib2gls} only one call is required: +\begin{verbatim} +pdflatex myDoc +bib2gls --group myDoc +pdflatex myDoc +\end{verbatim} +(Omit \verb|--group| if you don't need letter groups.) \end{description} + \section[glossaries and hyperref]{\styfmt{glossaries} and \styfmt{hyperref}} \label{sec:hyperref} Take care if you use the \sty{glossaries} package with \sty{hyperref}. Contrary to the usual advice that \sty{hyperref} -should be loaded last, \sty{glossaries} must be loaded \emph{after} -\sty{hyperref}: +should be loaded last, \sty{glossaries} (and \sty{glossaries-extra}) +must be loaded \emph{after} \sty{hyperref}: \begin{verbatim} \usepackage[colorlinks]{hyperref} \usepackage{glossaries} @@ -1135,10 +1935,10 @@ glossaries, then use \cs{glsdisablehyper} \end{definition} If you want hyperlinks suppressed for entries in specific -glossaries, then use the \texttt{nohypertypes} package option. For -example, if you don't want hyperlinks for entries in the \texttt{acronym} and -\texttt{notation} glossaries but you do want them for entries in the -\texttt{main} glossary, then do: +glossaries, then use the \pkgopt{nohypertypes} package option. For +example, if you don't want hyperlinks for entries in the \code{acronym} and +\code{notation} glossaries but you do want them for entries in the +\code{main} glossary, then do: \begin{verbatim} \usepackage[colorlinks]{hyperref} \usepackage[acronym,nohypertypes={acronym,notation}]{glossaries} @@ -1147,7 +1947,7 @@ example, if you don't want hyperlinks for entries in the \texttt{acronym} and If you want the hyperlinks suppressed the first time an entry is used, but you want hyperlinks for subsequence references then use -the \texttt{hyperfirst=false} package option: +the \pkgopt[false]{hyperfirst} package option: \begin{verbatim} \usepackage[colorlinks]{hyperref} \usepackage[hyperfirst=false]{glossaries} @@ -1168,19 +1968,25 @@ your location list. Instead you can use \begin{definition} \cs{glsentrytext}\marg{label} \end{definition} -This is expandable provided that the \texttt{text} key doesn't +This is expandable provided that the \code{text} key doesn't contain non-expandable code. For example, the following works: \begin{verbatim} \section{The \glsentrytext{fishage}} \end{verbatim} and it doesn't put the table of contents in the location list. +If you use \sty{glossaries-extra} then use the commands that are +provided specifically for use in section headers. For example: +\begin{verbatim} +\section{The \glsfmttext{fishage}} +\end{verbatim} + \section{Cross-References} \label{sec:xr} You can add a~reference to another entry in a~location list using -the \texttt{see=}\marg{label} key when you define an entry. -The referenced entry must also be defined. +the \code{see=}\marg{label list} key when you define an entry. +The referenced entry (or entries) must also be defined. For example: \begin{verbatim} @@ -1202,7 +2008,7 @@ For example: \end{verbatim} The cross-reference will appear as \qt{\emph{see} Devonian}. You can change the \qt{see} tag using the format -\texttt{see=}\oarg{tag}\meta{label}. For example: +\code{see=}\oarg{tag}\meta{label}. For example: \begin{verbatim} \newglossaryentry{latinalph} { @@ -1218,7 +2024,7 @@ change the \qt{see} tag using the format other letters such as ligatures or diacritics.} } \end{verbatim} -If you use the \texttt{see} key in the optional argument of +If you use the \code{see} key in the optional argument of \cs{newacronym}, make sure you enclose the value in braces. For example: \begin{verbatim} @@ -1227,10 +2033,39 @@ example: [see={[see also]{ksvm}}] {svm}{svm}{support vector machine} \end{verbatim} +The \sty{glossaries-extra} package provides a \code{seealso} +key. This doesn't allow a tag but behaves much like +\code{see=\{[\cs{seealsoname}]\marg{label}\}}. For example: +\begin{verbatim} +\newabbreviation{ksvm}{ksvm}{kernel support vector machine} +\newabbreviation + [seealso={ksvm}] + {svm}{svm}{support vector machine} +\end{verbatim} Since the cross-reference appears in the location list, if you -suppress the location list using the \texttt{nonumberlist} package -option, then the cross-reference will also be suppressed. +suppress the location list using the \pkgopt{nonumberlist} package +option, then the cross-reference will also be suppressed. With +\app{bib2gls}, don't use the \pkgopt{nonumberlist} package +option. Instead use the \code{save-locations=false} in the resource +options. For example: +\begin{verbatim} +\usepackage[record,abbreviations,symbols]{glossaries-extra} + +\GlsXtrLoadResources[ + src={terms}, % entries defined in terms.bib + type={main}% put in main glossary +] +\GlsXtrLoadResources[ + src={abbrvs}, % entries defined in abbrvs.bib + type={abbreviations},% put in abbreviations glossary + save-locations=false% no number list for these entries +] +\GlsXtrLoadResources[ + src={syms}, % entries defined in syms.bib + type={symbols}% put in symbols glossary +] +\end{verbatim} \section{Further Information} \label{sec:moreinfo} @@ -1238,6 +2073,10 @@ option, then the cross-reference will also be suppressed. Further information can be found in the main \sty{glossaries} \docref{user manual}{glossaries-user} or in the \href{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{glossaries FAQ}. +See also the \sty{glossaries-extra} package and the \app{bib2gls} +document, both of which can be found on CTAN +(\url{http://ctan.org/pkg/glossaries-extra} and +\url{http://ctan.org/pkg/bib2gls}). There is also an \href{http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114}{article on the glossaries and glossaries-extra packages} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 63a260a3b70..7bbda2c662c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -200,7 +200,7 @@ class="td11">Nicola L.C. Talbot

    2017-08-24

    +class="cmr-12">2017-09-20

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf index a16892c6a1e..0bf90039eca 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 9475b810406..42ae884275a 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{2017-08-24} +\date{2017-09-20} \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 82d9c2229e9..a3f5a2b2cdc 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/glossary-lipsum-examples.tex b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.tex index 31a3c2922eb..c8fa373feb8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.tex @@ -13,17 +13,17 @@ \usepackage{glossary-mcols} \usepackage{glossary-longragged} -\newglossary[glg2]{long}{gls2}{glo2}{Long Descriptions} -\newglossary[glg3]{multipar}{gls3}{glo3}{Multi-Paragraph Descriptions} -\newglossary[glg4]{acronymdesc}{gls4}{glo4}{Acronyms with Descriptions} -\newglossary[glg5]{images}{gls5}{glo5}{Descriptions with Images} -\newglossary[glg6]{acronymslang}{gls6}{glo6}{Acronyms with -Translations} - -\newglossary[glg7]{parent}{gls7}{glo7}{Hierarchical Entries} -\newglossary[glg8]{homographs}{gls8}{glo8}{Homographs} -\newglossary[glg9]{cites}{gls9}{glo9}{Entries with Citations} -\newglossary[glg10]{urls}{gls10}{glo10}{Entries with URLs} +\newglossary*{symbolname}{Entries with Symbols in the Name} +\newglossary*{long}{Long Descriptions} +\newglossary*{multipar}{Multi-Paragraph Descriptions} +\newglossary*{acronymdesc}{Acronyms with Descriptions} +\newglossary*{images}{Descriptions with Images} +\newglossary*{acronymslang}{Acronyms with Translations} + +\newglossary*{parent}{Hierarchical Entries} +\newglossary*{homographs}{Homographs} +\newglossary*{cites}{Entries with Citations} +\newglossary*{urls}{Entries with URLs} \DeclareAcronymList{acronymdesc,acronymslang} @@ -33,6 +33,7 @@ Translations} \loadglsentries[long]{example-glossaries-long} \loadglsentries[multipar]{example-glossaries-multipar} \loadglsentries[symbols]{example-glossaries-symbols} +\loadglsentries[symbolname]{example-glossaries-symbolnames} \loadglsentries[images]{example-glossaries-images} \loadglsentries[parent]{example-glossaries-parent} \loadglsentries[homographs]{example-glossaries-childnoname} @@ -196,6 +197,8 @@ Here are just the acronyms again: \printglossary[type=symbols,style=altlongragged4col,nogroupskip] +\printglossary[type=symbolname,style=list,nogroupskip] + \printglossary[type=acronym,style=long] \printglossary[type=acronymdesc,style=altlist] diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf index 8f2f1de59a4..2e90f9ef57b 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 8ca2d10353e..527bbb9021e 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 92543fde02b..1ffdf6f15e1 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 5b04e4e2bd7..4eef91e910f 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 02b0be51c48..a83207037b5 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 e4219bf328e..0cc295c158c 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 852a5a7874f..2dc2cdb5346 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 d7a54e47a8f..f6d1ed25c01 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 c5fe662fcd5..8798d72cbef 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 50db72b21ff..e350bbc1ef3 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 9b912df0923..3b4bb41c899 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 aaf626a497e..76d0548f4f5 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 3f8505319dc..f868473e93d 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 cab3d65cd20..efbf6439a04 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 ad3654b937a..66644d926a2 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 57643ebf263..6ecf2267d00 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 9a084a916f7..78effa2eda0 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 0fd78d20ad0..f9be2f65de5 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 7d3fccc5b82..a93c4cd0c72 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 392e8f5ce9a..6f95fec6fc5 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 9b5cd72b1ad..0f8855209d5 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 1acff1e5e65..a337fe38d40 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 9eade134249..7cb90727860 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 e308daa1312..08890e5d4ed 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 e668fa83019..4ce6e5bf758 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 ad4e6ce4240..1fc7f6e3611 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 2579fc2870d..5f8bc545b39 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 2e0e8fd4704..5b9fad2bf96 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 04a734028fa..ce25de50c22 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 bfe88153f62..524d2008f46 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 0b15e1c0f11..0d3e6fe0b97 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 12e7e4f245e..30886f3918d 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 eb5da10a215..e4d5fbed093 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 3b05ac958a1..165105bff79 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 d2185be60ca..20f94a6df75 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 ce133c1a60d..acbd471d380 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 7419e9b79cb..a550390e0fb 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 10522684ab2..6c48a88c4d2 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 f5e1471c5be..e3488affb89 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 bfdfe9df206..36f94a6df9f 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 b5d469fa9b2..80ae1570b8d 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 802d5ac4528..73853016087 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 475828a6458..7d8ea893c7e 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 a4da24c0298..f4d2569c01e 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 7e2797f21cd..faccbfc2a7a 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/samplexdy.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex index 2c7182eec36..808a1ac5ee3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex @@ -1,93 +1,129 @@ - % 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} +\usepackage[notext,notextcomp]{stix} \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: - - \renewcommand*{\thepage}{\texorpdfstring{\Numberstring{page}}{\arabic{page}}} +% Redefine the page numbers to a custom format (requires stix +% package for the dice commands): + +% \tallynum{n} displays a die or dice where the dots add up to n +\newrobustcmd{\tallynum}[1]{% + \ifnum\number#1<7 + $\csname dice\romannumeral#1\endcsname$% + \else + $\dicevi$% + \expandafter\tallynum\expandafter{\numexpr#1-6}% + \fi +} - % Need to add this to the list of location styles. - % \Numberstring{page} gets expanded to - % \protect \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) +% \tally{counter} expands to \tallynum{n} where n is the counter +% value. In order to work with glossaries and xindy this requires +% a very specific format. (See the glossaries user manual for more +% details.) + +\newcommand{\tally}[1]{\tallynum{\arabic{page}}} + +% Now redefine \thepage +% (\texorpdfstring is used in case the page number ends up in a PDF +% bookmark, although this is unlikely) +\renewcommand*{\thepage}{\texorpdfstring{\tally{page}}{\arabic{page}}} + +% Need to add this to the list of location styles. +% This requires knowing how \thepage expands when written to a file. +% You can check by inspecting the ':locref' attributes in the .glo +% file. In this case, \thepage expands to \tallynum {n} +% (the space is significant) where n is an arabic number. +% (This command will have no effect if \noist is used) + +\GlsAddXdyLocation{tally}{% tally location format + :sep "\string\tallynum\space\glsopenbrace" % -> \tallynum { + "arabic-numbers" % -> arabic number (0, 1, 2, etc) + :sep "\glsclosebrace" % -> } +} -\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space - \string\Numberstringnum\space\glsopenbrace" - "arabic-numbers" :sep "\glsclosebrace"} +% If the definition of \tally changes so that it expands to +% something slightly different then the above will have to be +% changed accordingly. - % (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{}{\protect \Numberstringnum "\marg{n}"}" - % or - % "\glsXpageXhyperbfit{}{\protect \Numberstringnum "\marg{n}"}" - % - % Redefine to allow hyperlinks: +% Each page location will be specified in the form: +% +% "\glsXpageXglsnumberformat{}{\tallynum {" number "}}" +% or +% "\glsXpageXhyperbfit{}{\tallynum {" number "}}" +% +% Knowing this, we can redefine \glsXpageXglsnumberformat +% and \glsXpageXhyperbfit to grab the number part to work out the +% location's numeric value. If the definition of \tally changes +% so that it expands to something slightly different then this +% code will no longer work. +% +% Redefine to allow hyperlinks: \renewcommand{\glsXpageXglsnumberformat}[2]{% + % remember that #2 is in the form \tallynum {n} + % so this does \linkpagenumber\tallynum{n} \linkpagenumber#2% } @@ -95,13 +131,15 @@ \textbf{\em\linkpagenumber#2}% } -\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} +% Syntax: \linkpagenumber\tallynum{page number} +% This creates hyperlink to the given page. +\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}, @@ -142,14 +180,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}}} @@ -223,7 +261,8 @@ several pages. This paragraph has been shoved to the bottom of the page using a rule. This paragraph spans a page break for testing purposes to ensure the glossary entry in this paragraph has the correct location. Here's -the glossary entry: \gls{gaussianfn}. +the glossary entry: \gls{gaussianfn}. Check that the location is +correct. This page talks about \glspl[format=hyperbfit]{gaussianint}. Since it's the principle definition, the user-defined hyperbfit format is diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf index 7c343d14744..f48b8df6d13 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 new file mode 100644 index 00000000000..0b2ec343239 Binary files /dev/null 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 new file mode 100644 index 00000000000..06ffd8b3343 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex @@ -0,0 +1,266 @@ + % 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[colorlinks,plainpages]{hyperref} +\usepackage[xindy,style=altlistgroup]{glossaries} + + % 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) + +\GlsAddXdyAttribute{hyperbfit} + + % Redefine the page numbers so that they appear as a word: + + \renewcommand*{\thepage}{\texorpdfstring{\Numberstring{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) + +\GlsAddXdyLocation{Numberstring}{:sep "\string\Numberstringnum\space\glsopenbrace" + "arabic-numbers" :sep "\glsclosebrace"} + + % (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: + + %\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. + + % 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: + +\renewcommand{\glsXpageXglsnumberformat}[2]{% + \linkpagenumber#2% +} + +\renewcommand{\glsXpageXhyperbfit}[2]{% + \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. +\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 + +\newglossaryentry{mcadam}{name={McAdam, John Loudon}, +first={John Loudon McAdam},text={McAdam}, +description={Scottish engineer}} + +\newglossaryentry{maclaurin}{name={Maclaurin, Colin}, +first={Colin Maclaurin},text={Maclaurin}, +description={Scottish mathematician best known for the +\gls{maclaurinseries}}} + +\newglossaryentry{maclaurinseries}{name={Maclaurin series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylorstheorem}{name={Taylor's theorem}, +description={Theorem expressing a function $f(x)$ as the sum of +a polynomial and a remainder: +\[f(x) = f(a)+f'(a)(x-a)+f''(a)(x-a^2)/2!+\cdots+R_n\] +If $n\to\infty$ the expansion is a \glshyperlink{taylorseries} +and if $a=0$, the series is called a +\gls{maclaurinseries}}} + +\newglossaryentry{taylorseries}{name={Taylor series}, +description={Series expansion},see={taylorstheorem}} + +\newglossaryentry{taylor}{name={Taylor, Brook}, +first={Brook Taylor},text={Taylor}, +description={English mathematician}} + +\newglossaryentry{mcnemar}{name={McNemar, Quinn}, +first={Quinn McNemar},text={McNemar}, +description={Mathematician who introduced +\gls{mcnemarstest}. This entry has the number list +suppressed},nonumberlist} + +\newglossaryentry{mcnemarstest}{name={McNemar's test}, +description={A nonparametric test introduced by +\gls{mcnemar} in 1947}} + +\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 +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 +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}}} + +\newglossaryentry{malthus}{name={Malthus, Thomas Robert}, +first={Thomas Robert Malthus},text={Malthus}, +description={English mathematician, sociologist and classicist}} + +\newglossaryentry{ampereandre}{name={Ampère, André-Marie}, +first={André-Marie Ampère},text={Ampère}, +description={French mathematician and physicist}} + +\newglossaryentry{ampere}{name={ampere}, +description={SI unit of electric current named after +\gls{ampereandre}}} + +\newglossaryentry{archimedes}{name={Archimedes of Syracuse}, +first={Archimedes of Syracuse},text={Archimedes}, +description={Greek mathematician}} + +\newglossaryentry{archimedesprinciple}{name={Archimedes' principle}, +description={Principle that if a body is submerged in a fluid +it experiences upthrust equal to the weight of the displaced +fluid. Named after \gls{archimedes}}} + +\newglossaryentry{galton}{name={Galton, Sir Francis}, +first={Sir Francis Galton},text={Galton}, +description={English anthropologist}} + +\newglossaryentry{gauss}{name={Gauss, Karl Friedrich}, +first={Karl Friedrich Gauss},text={Gauss}, +description={German mathematician}} + +\newglossaryentry{gaussianint}{name={Gaussian integer}, +description={Complex number where both real and imaginary +parts are integers}} + +\newglossaryentry{gaussianfn}{name={Gaussian function}, + description={A function of the form: + \[f(x) = a \exp\left(-\frac{(x-b)^2}{2c^2}\right)\] + for some constants $a$, $b$ and $c$}} + +\newglossaryentry{peano}{name={Peano, Giuseppe}, +first={Giuseppe Peano},text={Peano}, +description={Italian mathematician}} + +\newglossaryentry{peanoscurve}{name={Peano's curve}, +description={A space-filling curve discovered by +\gls{peano}}} + +\newglossaryentry{pearson}{name={Pearson, Karl}, +first={Karl Pearson},text={Pearson}, +description={English mathematician}} + +\newglossaryentry{pearspmcc}{name={Pearson's product moment +correlation coefficient},description={Product moment correlation +coefficient named after \gls{pearson}}} + +\begin{document} +\title{Sample Document Using the Glossaries Package With Xindy} +\author{Nicola Talbot} +\maketitle + +\section{\glsentryfirst{gauss}} + +This is a section on +\gls[format=(]{gauss}. This section spans +several pages. + +\rule{1pt}{0.6\textheight} + +This paragraph has been shoved to the bottom of the page using a rule. +This paragraph spans a page break for testing purposes to ensure the +glossary entry in this paragraph has the correct location. Here's +the glossary entry: \gls{gaussianfn}. + +This page talks about \glspl[format=hyperbfit]{gaussianint}. Since +it's the principle definition, the user-defined hyperbfit format is +used. + +\newpage + +The section on \gls[format=)]{gauss} ends here. + +\section{Series Expansions} + +This section is about series expansions. It mentions +\gls{maclaurin} and \gls{taylor}. It also discusses +\gls{taylorstheorem} which is related to the \gls{taylorseries}. +The \gls{maclaurinseries} is a special case of the +\gls{taylorseries}. + +\section{\glsentryname{archimedesprinciple}} + +This section discusses \gls{archimedesprinciple} which was +introduced by \gls{archimedes}. + +\section{Another section} + +This section covers \gls{mach} who introduced the \gls{machnumber}. +It also mentions \gls{ampereandre} after whom the +SI unit \gls{ampere} is named. It then discusses \gls{galton} +and \gls{malthus}. Finally it mentions \gls{mcadam}. + +\newpage +This page discusses \gls{mcnemar} who introduced +\gls{mcnemarstest} and \gls{peano} who discovered \gls{peanoscurve}. + +\printglossaries +\end{document} -- cgit v1.2.3