From 27aa5722eb36fa15f05d471c338e2ced0e22d02c Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 15 Oct 2016 22:56:50 +0000 Subject: glossaries (12oct16) git-svn-id: svn://tug.org/texlive/trunk@42274 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/glossaries/CHANGES | 24 + Master/texmf-dist/doc/latex/glossaries/README | 4 +- .../doc/latex/glossaries/glossaries-code.pdf | Bin 1159914 -> 1158471 bytes .../doc/latex/glossaries/glossaries-user.html | 9671 ++++++++++---------- .../doc/latex/glossaries/glossaries-user.pdf | Bin 757969 -> 763034 bytes .../doc/latex/glossaries/glossaries-user.tex | 157 +- .../doc/latex/glossaries/glossariesbegin.html | 13 +- .../doc/latex/glossaries/glossariesbegin.pdf | Bin 156546 -> 156557 bytes .../doc/latex/glossaries/glossariesbegin.tex | 4 +- .../doc/latex/glossaries/glossary2glossaries.html | 3 +- .../doc/latex/glossaries/glossary2glossaries.pdf | Bin 142444 -> 142454 bytes .../doc/latex/glossaries/glossary2glossaries.tex | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 252930 -> 252930 bytes .../doc/latex/glossaries/samples/minimalgls.pdf | Bin 49969 -> 49969 bytes .../doc/latex/glossaries/samples/mwe-acr-desc.pdf | Bin 37969 -> 37969 bytes .../doc/latex/glossaries/samples/mwe-acr.pdf | Bin 33661 -> 33661 bytes .../doc/latex/glossaries/samples/mwe-gls.pdf | Bin 29951 -> 29951 bytes .../doc/latex/glossaries/samples/sample-FnDesc.pdf | Bin 58829 -> 58829 bytes .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 54834 -> 54834 bytes .../latex/glossaries/samples/sample-crossref.pdf | Bin 53468 -> 53468 bytes .../glossaries/samples/sample-custom-acronym.pdf | Bin 82200 -> 82200 bytes .../latex/glossaries/samples/sample-dot-abbr.pdf | Bin 52723 -> 52723 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 147100 -> 146773 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 102765 -> 102438 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 155768 -> 155736 bytes .../doc/latex/glossaries/samples/sampleEqPg.pdf | Bin 169225 -> 169195 bytes .../latex/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91354 -> 91354 bytes .../doc/latex/glossaries/samples/sampleNtn.pdf | Bin 98727 -> 98396 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 95108 -> 94784 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 178814 -> 178479 bytes .../doc/latex/glossaries/samples/samplexdy2.pdf | Bin 68412 -> 68412 bytes 59 files changed, 5130 insertions(+), 4748 deletions(-) (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 9fd001d8ea1..8d00c6cf939 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,29 @@ glossaries change log: +v4.26: + + * glossaries.sty: + + - added check for classicthesis.sty (if it's been loaded + the default style is changed to "index" since the "list" + style doesn't work with classicthesis.) + + * glossary-tree.sty: + + - new commands \glstreeitem, \glstreesubitem and + \glstreesubsubitem provided for the "index" style + to make the style easier to adjust. + + - replaced hard-coded \space with \glstreepredesc + or \glstreechildpredesc for all glossary-tree styles + except for the alttree* styles. + + * glossary-mcol.sty: + + - The "mcolindex" and "mcolindexspannav" styles + use the new \glstreeitem, \glstreesubitem and + \glstreesubsubitem provided by glossary-tree.sty. + v4.25: * glossaries.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README index b90ca7f2629..88563233f9b 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.25 +LaTeX Package : glossaries v4.26 -Last Modified : 2016-06-09 +Last Modified : 2016-10-12 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 e72684ba528..02510b98c67 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 94b4699fca1..03732c9c488 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -10,7 +10,6 @@ - -

-

+

-

+

-

-

User Manual for glossaries.sty v4.25 +

+

User Manual for glossaries.sty v4.26

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

2016-06-09

+

2016-10-12

-

+

-

-

+

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 @@ -280,12 +279,12 @@ to glossaries-extra. Versions of the glossaries package after v4.21 will mostly be just bug fixes. -

+

-

If you require multilingual support you must also separately install the relevant language +

If you require multilingual support you must also separately install the relevant language module. Each language module is called glossaries-⟨language⟩, where ⟨§1.3 Multi-Lingual Support for further details. -

The

The glossaries package requires a number of other packages including, but not limited to, tracklangEX 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 @@ -341,15 +340,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:

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.25”. + Code for glossaries v4.26”.
INSTALL
Change log. class="cmbx-10">README
Package summary.
-

Related resources:

+

Related resources:

-

If you use

If you use hyperref and glossaries, you must load doc’s changes glossary.) -

If you are using

If you are using hyperref, it’s best to use pdflatexpdflatex deals with hyperlinks much better. If you use th problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is an issue with the DVI format not with glossaries.

-

+

Contents

+ id="x1-1000">Contents +
Glossary
1 Hierarchical Categories href="#sec:homographs" id="QQ2-1-42">Homographs
 4.8 Loading Entries From a File -
 4.9 Moving Entries to Another Glossary +
 4.9 Moving Entries to Another Glossary
 4.10 Drawbacks With Defining Entries in the Document Environment
  4.10.1 Fetching and Updating the Value of a FieldPrefixes or Determiners
18 Accessibility Support -
19 Troubleshooting +
19 Troubleshooting
@@ -637,7 +637,8 @@ href="#sec:trouble" id="QQ2-1-95">Troubleshooting

List of Tables

1.1 List of Tables +
1.1 Glossary Options: Pros and Cons
1.2 Customised Text
1.3 Commands @@ -664,8 +665,9 @@ href="#tab:mcols">Multicolumn Styles

Glossary

This glossary style was setup using: + id="x1-3000">Glossary +

This glossary style was setup using:

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,
The text produced by commands such as \gls. It may or may not be a hyperlink - to the glossary.
+ to the glossary.
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 glossaries used this technique to write information to the files - used by the indexing applications to prevent problems caused by fragile commands. +

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.
indexing application with multilingual support writt class="newline" /> -

1.

1. Introduction

-

The

The glossaries package is provided to assist generating lists of terms, symbols or abbreviations (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 @@ -1055,7 +1057,7 @@ 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 @@ -1076,8 +1078,8 @@ options, particularly if you use an extended Latin alphabet or a non-Latin alphabet.
-

-

The basic idea behind the

+

The basic idea behind the glossaries package is that you first define your entries (terms, symbols or abbreviations). Then you can reference these within your document (like \cite or @@ -1091,7 +1093,7 @@ class="description">Option 1: -

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

This is the simplest option but it’s slow and if you want a sorted list, it doesn’t work well for extended Latin alphabets or non-Latin alphabets. However, if you @@ -1110,7 +1112,7 @@ class="cmss-10">sanitizesort=false\’elite if sanitizesort=true is used. -

This option works best with the

This option works best with the sort=def setting. For any other setting, be prepared for a long document build time, especially if you have a lot of entries @@ -1127,9 +1129,9 @@ href="#sec:newglosentry">Defining Glossary Entries

-

This must be used before

This must be used before \makeglossaries. Note that if you are using babelDefining Glossary Entries

\printglossary
-

+

where you want your list of entries to appear (described in §10 .gls. If you have access to a

-

(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 @@ -1260,7 +1262,7 @@ class="cmtt-10">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 +

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

-

(See

(See §1.4.4 Using makeindexOnce 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

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

@@ -1294,7 +1296,7 @@ class="description">Option 3: -

This option uses a 

This option uses a CLI application called xindyxindyLATEX 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 +

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. glossaries package option list:
    \usepackage[xindy]{glossaries}
    -

    +

  2. Add .gls. You also need to set the 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 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 +

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: @@ -1416,7 +1418,7 @@ class="cmss-10">order=letter \usepackage[xindy,order=letter]{glossaries}

-

(and return to the previous step.) See

(and return to the previous step.) See §1.4.3 Using xindyEX on your document again. -

For Options 

For Options 2 and 3, it can be difficult to remember all the parameters required for makeglossaries myDoc

-

(Replace

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

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

makeglossaries-lite.lua myDoc
-

This script doesn’t have the full functionality of the Perl script, but since modern +

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

The

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

+

An overview of these three options is given in table 1.1.

-

@@ -1526,7 +1528,7 @@ id="TBL-2-2" />

OptionOption 3

Requires +class="td11">

Requires an external application?

✔

Requires +class="td11">

Requires Perl?

✘ ✔

Can +class="td11">

Can sort extended @@ -1582,7 +1584,7 @@ class="td11"> ✔

Efficient +class="td11">

Efficient sort algorithm?

✔

Can +class="td11">

Can use a different @@ -1610,7 +1612,7 @@ class="td11"> ✘

Can +class="td11">

Can form ranges in @@ -1625,7 +1627,7 @@ class="td11"> ✔

Can +class="td11">

Can have non-standard locations @@ -1641,7 +1643,7 @@ class="td11"> ✔

Maximum +class="td11">

Maximum hierarchical depth

Unlimited 3 Unlimited

\glsdisplaynumberlist reliable?

✘

\newglossaryentry restricted @@ -1675,7 +1677,7 @@ class="td11"> ✘

Requires +class="td11">

Requires additional write registers?

✔

Default +class="td11">

Default value of true

-

† Strips standard LATEX accents (that is, accents generated by core LATEX commands) so, @@ -1716,7 +1718,7 @@ class="cmtt-10">\AA

-

This document uses the

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

The remainder of this introductory section covers the following:

+

The remainder of this introductory section covers the following:

-

Top

1.1 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) @@ -1765,14 +1767,14 @@ 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 +

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 follows

The sample documents are as follows1.2:

@@ -1791,7 +1793,7 @@ class="E">EX either by typing latex minimalgls -

+

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

-

These warnings may be ignored on the first run. -

If you get a

These warnings may be ignored on the first run. +

If you get a Missing \begin{document} error, then it’s most likely that your version of Generating the Associated Glossary Files). This can be done on a terminal either by typing
makeglossaries minimalgls -

+

or by typing
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 makeindexmakeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo -

+

(See §1.4.4 makeindexmakeindex explicitly.) -

Note that if you need to specify the full path and the path contains +

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.

@@ -1862,10 +1864,10 @@ class="cmtt-10">makeindexRun 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, Option 1). To create the complete document, you need class="cmtt-10">latex sample-noidx
latex sample-noidx -

+

sample-noidx-utf8.tex
inputenclatex sample-noidx-utf8
latex sample-noidx-utf8 -

+

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

+

As before, if you don’t have Perl installed, you will need to use makeindexmakeglossaries sampleAcr class="cmtt-10">latex sampleAcr
latex sampleAcr -

+

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

+

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

+

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

+

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

+

@@ -2038,7 +2040,7 @@ class="cmtt-10">latex sample-FnDesc class="cmtt-10">makeglossaries sample-FnDesc
latex sample-FnDesc -

+

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

+

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

+

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

+

The glossary definitions are stored in the accompanying files database1.tex and makeglossariesmakeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -

+

  • Create the secondary glossary (all on one line): @@ -2113,7 +2115,7 @@ class="cmtt-10">sampleDB.glo class="cmtt-10">makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn -

    +

    • latex sampleEq class="cmtt-10">makeglossaries sampleEq
    latex sampleEq -

    +

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

    +

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

    +

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

    +

    Note that if you don’t have Perl installed, you will need to use makeindexmakeglossariesmakeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -

    +

  • Create the secondary glossary (all on one line): @@ -2215,7 +2217,7 @@ class="cmtt-10">sampleNtn.glo class="cmtt-10">makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn -

    +

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

    +

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

    +

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

    +

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

    +

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

    it will set the style file to

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

    To create the document do: +

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

    +

    If you don’t have Perl installed, you will have to call xindysamplexdy.xdy, then do (no line class="cmtt-10">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 samplexdy.glo     -

    +

    samplexdy2.tex
    pdflatex samplexdy2 class="cmtt-10">makeglossaries samplexdy2
    pdflatex samplexdy2 -

    +

    If you can’t use makeglossariesxindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.gl class="cmtt-10">samplexdy2.gls samplexdy2.glo -

    +

    See §11.2 latex sampleutf8 class="cmtt-10">makeglossaries sampleutf8
    latex sampleutf8 -

    +

    If you don’t have Perl installed, you will have to call xindymakeglossariesxindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo -

    -

    If you remove the

    +

    If you remove the xindy option from sampleutf8.tex and do: @@ -2467,7 +2469,7 @@ 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 @@ -2484,7 +2486,7 @@ class="cmtt-10">makeindexmakeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo -

    +

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

    +

    @@ -2563,7 +2565,7 @@ class="cmtt-10">makeglossaries sample-numberlist class="cmtt-10">latex sample-numberlist
    latex sample-numberlist -

    +

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

    +

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

    +

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

    +

    sampleaccsupp.tex
    Counting the Number of Times an Entry has been Used acronyms.
    -

    +

    -

    Top

    1.2 Dummy Entries for Testing

    -

    In addition to the sample files described above,

    In addition to the sample files described above, glossaries also provides some files containing lorum ipsum dummy entries. These are provided for testing purposes and are on TThese entries use the user1 key to store an URL associated with the entry. -

    The sample file

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

    +

    -

    Top

    1.3 Multi-Lingual Support

    -

    As from version 1.17, the

    As from version 1.17, the glossaries package can now be used with xindy\usepackage{babel}  
    \usepackage[xindy]{glossaries} -

    -

    Note that although a 

    +

    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 problems. You may need to switch off the field expansions with \glsnoexpandfields. This issue doesn’t occur with XeLaTeX. -

    If you use a 

    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 @@ -2842,11 +2844,11 @@ class="cmtt-10"> or class}}

    -

    +

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

    If you use the

    If you use the inputenc package, -Cxindy manual for further details. -

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

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

    \GlsSetQuote  \GlsSetQuote{⟨character⟩}
    -

    +

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

    -

    This must be done before

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

    Be careful of

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

    -

    In general, it’s best not to use

    +

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

    -

    -

    The

    +

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

    -

    +

    +

    -

    Top

    1.3.1 Changing the Fixed Names

    -

    The fixed names are produced using the commands listed in

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

    and then use

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

    @@ -3077,22 +3079,22 @@ id="TBL-3-3" />Command Name

    Translator Key Word

    Purpose

    \glossaryname

    Glossary

    Title +class="td10">

    Title of the main @@ -3102,9 +3104,9 @@ class="td10">

    Title class="td01">\acronymname

    Acronyms

    Title +class="td10">

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

    Notation (glossaries)

    Header +class="td10">

    Header for first column @@ -3149,11 +3151,11 @@ class="td10">

    Header class="td01">\descriptionname

    Description (glossaries)

    Header +class="td10">

    Header for second column @@ -3175,11 +3177,11 @@ class="td10">

    Header class="td01">\symbolname

    Symbol (glossaries)

    Header +class="td10">

    Header for symbol column @@ -3198,13 +3200,13 @@ class="td10">

    Header class="td01">\pagelistname

    Page List (glossaries)

    Header +class="td10">

    Header for page list @@ -3223,11 +3225,11 @@ class="td10">

    Header class="td01">\glssymbolsgroupname

    Symbols (glossaries)

    Header +class="td10">

    Header for symbols section @@ -3246,11 +3248,11 @@ class="td10">

    Header class="td01">\glsnumbersgroupname

    Numbers (glossaries)

    Header +class="td10">

    Header for numbers section @@ -3271,7 +3273,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 @@ -3285,7 +3287,7 @@ class="cmss-10">glossaries are now provided by the appropriate language module. For further details about information specific to a given language, please see the documentation for that language module. -

    Examples of use:

    +

    Examples of use:

    -

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

    Due to the varied nature of glossaries, it’s likely that the predefined translations may not be appropriate. If you are using the babel package and the \deftranslation) and load it using \usedictionary. -

    Note that the

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

    -

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

    +

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

    myinstitute-glossaries-dictionary-English.dict
    -

    that contains the following: +

    that contains the following:

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

    You can now load it using: +

    You can now load it using:

    \usedictionary{myinstitute-glossaries-dictionary}
    -

    (Make sure that

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

    If you are using

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

    -

    Note that

    +

    Note that xindy provides much better multi-lingual support than Xindy (Option 3) for further

    Creating a New Language Module
    -

    The

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

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

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

    Here’s an example of

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

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

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

    Here’s an example of

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

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

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

    Note: the suffixes used to generate the plural forms when the plural hasn’t been specified are given by \glspluralsuffix (for general entries) and \glsacrpluralsuffix for other acronym styles. 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⟩-⟨   }%  
     } -

    -

    If the translations includes

    +

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

    The

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

    (Again you can use this as a template. Replace

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

    There are now two extra files:

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

    These both define

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

    whereas the

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

    +

    -

    Top

    1.4 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 name 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 makeglossaries or @@ -3749,7 +3751,7 @@ class="cmsy-10">§2.4 Sorting Options, but you will need TEX’s shell escape enabled. -

    In order to generate a sorted glossary with compact

    In order to generate a sorted glossary with compact number lists, it is necessary to use an @@ -3790,7 +3792,7 @@ href="#sec:xindy">§11 Xindy (Option 3). -

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

    This is a multi-stage process, but there are methods of automating document compilation using applications such as latexmk and ararahttp://www.dickimaw-books.com/latex/thesis/html/build.html for more information.
    -

    -

    The

    +

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

    The advantages of using

    The advantages of using makeglossaries:

    -

    As from version 4.16, the

    As from version 4.16, the glossaries package also comes with a Lua script called Option 2 (makeindex). -

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

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

    Whilst I strongly recommended that you use the

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

    If you are choosing not to use

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

    -

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

    +

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

    -

    and suppose you have

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

    +

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

    Likewise, an additional

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

    The examples in this document assume that you are accessing

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

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

    Alternatively, your text editor may have the facility to create a function that will call the required application. 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 .alg -

    @@ -4200,10 +4202,10 @@ class="cmti-10">code⟩
    -

    Top

    1.4.1 Using the makeglossaries Perl Script

    -

    The

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

    +

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

    -

    Windows users: TeX Live on Windows has its own internal Perl interpreter and provides +

    +

    Windows users: TeX Live on Windows has its own internal Perl interpreter and provides makeglossaries.exe as a convenient wrapper for the makeglossaries.) -

    The

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

    You can specify in which directory the

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

    +

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

    As from

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

    -

    If you explicitly use

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

    The

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

    When upgrading the

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

    -

    +

    +

    -

    Top

    1.4.2 Using the makeglossaries-lite.lua Lua Script

    -

    The Lua alternative to the

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

    The

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

    -

    +

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

    -

    +

    +

    -

    Top

    1.4.3 Using xindy explicitly (Option 3)

    -

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

    If you want to use

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

    -

    This is required regardless of whether you use

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

    To run

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

    +

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

    For example, if your document is called

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

    -

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

    +

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

    +

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

    Note that if you use

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

    +

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

    +

    -

    Top

    1.4.4 Using makeindex explicitly (Option 2)

    -

    If you want to use

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

    +

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

    For example, if your document is called

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

    +

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

    +

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

    Note that if you use

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

    +

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

    +

    -

    Top

    1.4.5 Note to Front-End and Script Developers

    -

    The information needed to determine whether to use

    The information needed to determine whether to use xindy or

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

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

    \@newglossary  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.xdy

    Word or letter ordering is specified by: -

    Word or letter ordering is specified by: +

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

    +

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

    If

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

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

    +

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

    If

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

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

    +

    for every time an entry has been referenced.

    -

    -

    +

    Top

    2. Package Options

    -

    This section describes the available

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

    Note that ⟨

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

    +

    -

    Top

    2.1 General Options

    @@ -4942,7 +4944,7 @@ class="cmss-10">nowarn\printglossaries  
    \end{document}
    -

    Here, only the

    Here, 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 @@ -4953,7 +4955,7 @@ class="cmtt-10">\glsadd{sample2} has been used before this 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 +

    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">\makenoidxglossaries) the indexing is suppressed but, other than that, commands like \gls behave as usual. -

    The debug mode, enabled with the

    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

    -

    Package glossaries Info: wrglossary(⟨

    Package glossaries Info: wrglossary(⟨type⟩)(⟨line⟩) 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 the associated file if it had been open. So if any entries haven’t appeared in the glossary @@ -5045,7 +5047,7 @@ href="#sec:newglossary">§12 Defining New Glossaries). -

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

    If you don’t use the main glossary and you don’t use this option, makeglossaries will @@ -5093,7 +5095,7 @@ class="cmtt-10"> glossary. class="cmtt-10">\gls.
    -

    +

    sanitizesortsanitize 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 @@ -5125,13 +5127,13 @@ class="E">EX will try to interpret it as a parameter  
      sort={\mysortvalue},  
      description={an example}}

    -

    and you actually want

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

    The default for Options 

    The default for Options 2 and 3 is sanitizesort=truesavewritesetex. -

    This option can significantly slow document compilation. As an alternative, you can +

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

    -

    You can also reduce the number of write registers by using

    +

    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

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

    -

    +

    +

    translatetranslator package. Instead load glossaries-babel. -

    I recommend you use

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

    +

    -

    If

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

    See

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

    -

    The values must be fully expanded, so

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

    \GlsDeclareNoHyperList{⟨list⟩}
    -

    +

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

    The

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

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

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

    -

    -

    Alternatively you can redefine the hook -

    +

    Alternatively you can redefine the hook +

    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook
    -

    +

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

    -

    -

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

    +

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

    You can customise this by redefining -

    You can customise this by redefining +

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

    +

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

    -

    This checks the

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

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

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

    -

    Here I’ve used

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

    +

    -

    Top

    2.2 Sectioning, Headings and TOC Options

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

    \glstoctrue  \glstoctrue
    -

    +

    and -

    \glstocfalse  \glstocfalse
    -

    +

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

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

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

    \usepackage[section]{glossaries}
    -

    is equivalent to +

    is equivalent to

    \usepackage[section=section]{glossaries}
    -

    You can change this value later in the document using -

    You can change this value later in the document using +

    \setglossarysection  \setglossarysection{⟨name⟩}
    -

    +

    where ⟨name⟩ is the sectional unit. -

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

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

    \glsglossarymark  \glsglossarymark{⟨glossary title⟩}
    -

    +

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

    -

    or to prevent it from changing the headers: +

    or to prevent it from changing the headers:

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

    If you want

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

    Occasionally you may find that another package defines

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

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

    +

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

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

    +

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

     
        \markright{#1}%  
      \fi}
    -

    If

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

    \glsautoprefix  \glsautoprefix ⟨type⟩
    -

    +

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

    -

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

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

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

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

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

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

    will add

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

    Or, if you are undecided on a prefix: +

    Or, if you are undecided on a prefix:

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

    +

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

    Now

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

    • -

    +

    -

    Top

    2.3 Glossary Appearance Options

    @@ -5902,19 +5904,19 @@ class="cmtt-9"> glossaryentry. -

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

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

    \glsrefentry  \glsrefentry{⟨label⟩}
    -

    +

    where ⟨label⟩ is the label associated with that glossary entry. -

    If you use

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

    +

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

    The

    The glossaryentry counter isn’t automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by counterwithin 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 -

    \glsresetentrycounter  \glsresetentrycounter
    -

    +

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

    -

    or if you are using

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

    -

    +

    subentrycounterThis is a ⟨key⟩=⟨value⟩ option. (Default is style=list.) Its value should be the name of the + id="dx1-19025">, unless classicthesis has been loaded, in + which case the default is style=index.) 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-19028">, glossary-long, , glossary-super or or glossary-tree. Alternatively, you can set the style + id="dx1-19031">. Alternatively, you can set the style using -

    \setglossarystyle{⟨style name⟩}
    -

    +

    (See §15 Glossary Styles for further

    nolong
    This prevents the glossaries package from automatically loading glossary-long (which + id="dx1-19033"> (which means that the longtable package also won’t be loaded). This reduces overhead by not + id="dx1-19034"> 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-19035">).
    nosuper
    This prevents the glossaries package from automatically loading glossary-super (which + id="dx1-19037"> (which means that the supertabular package also won’t be loaded). This reduces overhead by + id="dx1-19038"> 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-19039">).
    nolist
    This prevents the glossaries package from automatically loading glossary-list. This + id="dx1-19041">. 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 package (unless + you explicitly load glossary-list). Note that since the default style is - ). Note that since the default style is list, you will also need to use the (unless + classicthesis has been loaded), you will also need to use the style option to set the style to something - else. + id="dx1-19045"> option to set the style + to something else.
    notree
    This prevents the glossaries package from automatically loading glossary-tree. 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 . 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 + classicthesis has been loaded, the default style is index, which is provided by + glossary-tree). + id="dx1-19051">.
    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-19053">). Also if you use this option, you can’t use the style package option. Instead you must either + id="dx1-19054"> package option. Instead you must either use \setglossarystyle{⟨style⟩} or the style key in the optional argument to + id="dx1-19056"> key in the optional argument to \printglossary. Example: + id="dx1-19057">. Example:
    @@ -6147,14 +6164,14 @@ class="cmtt-10">\printglossary\usepackage{glossary-mcols}  
    \setglossarystyle{mcoltree}
    -

    +

    nonumberlist
    This option will suppress the associated number lists in the glossaries (see also + id="dx1-19059">s in the glossaries (see also §5 Number lists).
    seeautonumberlist
    If you suppress the number lists with s with nonumberlist, described + id="dx1-19062">, 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-19066">, the see key will automatically implement key will automatically implement nonumberlist=false for that entry. + id="dx1-19068"> for that entry. (Note this doesn’t affect \glssee.) For further details see Cross-Referencing
    counter
    This is a ⟨key⟩=⟨value⟩ option. (Default is counter=page.) The value should be + id="dx1-19070">.) The value should be the name of the default counter to use in the number lists (see s (see §5 Number @@ -6208,29 +6225,29 @@ href="#sec:numberlists">Number
    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-19073">.
    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-19075">.
    -

    +

    -

    Top

    2.4 Sorting Options

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

    This is a ⟨

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

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

    Both

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

    \glssortnumberfmt  \glssortnumberfmt{⟨number⟩}
    -

    +

    (padded with leading zeros, where necessary). This can be redefined, if required, before the entries are defined (in the case of sort=defsort=defsort=use).

    -

    Note that the group styles (such as

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

    The default is

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

    \glsprestandardsort  type⟩}{⟨label⟩}
    -

    +

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

    \glsdosanitizesort  \glsdosanitizesort
    -

    +

    which sanitizes ⟨sanitizesortsanitizesort=false is used). -

    The other arguments, ⟨

    The other arguments, ⟨type⟩ and ⟨label⟩, are the glossary type and the entry label for the current entry. Note that ⟨\newglossaryentry. -

    Redefining

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

    +

    -

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

    Suppose I have three glossaries:

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

    For

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

    -

    -

    For Options 

    +

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

    The first option can be achieved as follows: +

    The first option can be achieved as follows:

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

    The second option can be achieved as follows: +

    The second option can be achieved as follows:

    @@ -6467,7 +6484,7 @@ class="cmtt-10">notation    .  
      }%  
    }
    -

    (

    (\ifdefstring is defined by the etoolbox package.) For a complete document, see the @@ -6476,17 +6493,17 @@ href="#x1-5101r34">sampleSort.tex.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

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

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

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

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

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

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

    and

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

    \let\name\textname
    -

    Now redefine

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

    (The somewhat complicate use of

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

    Now the entries can be defined: +

    Now the entries can be defined:

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

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    orderword or letter. The default is word ordering. -

    Note that the

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

    -

    If you use

    +

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

    -

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

    Alternatively, you can specify the order for individual glossaries:

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

    +

    makeindexxindy.ist extension. -

    You may omit this package option if you are using

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

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

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

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

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

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

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

    If no value is supplied to this package option (either simply writing xindy or writing xindy={}) then the language, codepage and number group settings are unchanged. See @@ -6741,7 +6758,7 @@ class="E">EX distributions disable it completely, in which case this option won’t have an effect. (If this option doesn’t appear to work, search the log file for “runsystem” and see if it is followed by “enabled” or “disabled”.) -

    Some distributions allow

    Some distributions allow \write18 in a restricted mode. This mode has a limited number of trusted applications, which usually includes makeindexxindy. -

    However even in unrestricted mode this option may not work with

    However even in unrestricted mode this option may not work with xindy as xindymakeglossariesLATEX runs to ensure the document is up-to-date with this setting. -

    Since this package option attempts to run the

    Since this package option attempts to run the indexing application on every LATEX run, its use should be considered a last resort for those who can’t work out @@ -6786,9 +6803,9 @@ class="cmss-10">automake=false -

    +

    -

    Top

    2.5 Acronym Options

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

    It will also define -

    It will also define +

    \printacronyms  \printacronyms[⟨options⟩]
    -

    +

    that’s equivalent to

    ] package option compatible-3.07 is used). -

    If you are using

    If you are using Option 1, you need to use

    options⟩]
    to display the list of acronyms. -

    If the

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

    Remember to use the

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

    +

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

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

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

    You can use -

    You can use +

    \DeclareAcronymList  \DeclareAcronymList{⟨list⟩}
    -

    +

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

    \SetAcronymLists  \SetAcronymLists{⟨list⟩}
    -

    -

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

    +

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

    \glsIfListOfAcronyms  }{⟨false part⟩}
    -

    +

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

    \DefineAcronymSynonyms  \DefineAcronymSynonyms
    -

    +

    -

    +

    -

    Top

    2.5.1 Deprecated Acronym Style Options

    -

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

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

    or (with

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

    or (with

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

    or (with

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

    or (with

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

    or (with

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

    or (with

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

    +

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

    or (with

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

    or (with

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

    +

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

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

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

    +

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

    -

    or (with

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

    or (with

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

    +

    footnote\newacronym \setacronymstyle{footnote} -

    or (with

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

    or (with

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

    or (with

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

    or (with

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

    or (with

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

    +

    dua\newacronym \setacronymstyle{dua} -

    or (with

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

    +

    -

    +

    -

    Top

    2.6 Other Options

    -

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

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

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

    It also defines -

    It also defines +

    \printsymbols  \printsymbols[⟨options⟩]
    -

    +

    which is a synonym for

    options⟩]
    -

    If you use

    If you use Option 1, you need to use:

    options⟩]
    to display the list of symbols. -

    Remember to use the

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

    +

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

    It also defines -

    It also defines +

    \printnumbers  \printnumbers[⟨options⟩]
    -

    +

    which is a synonym for

    options⟩]
    -

    If you use

    If you use Option 1, you need to use:

    options⟩]
    to display the list of numbers. -

    Remember to use the

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

    +

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

    It also defines -

    It also defines +

    \newterm  options⟩]{⟨term⟩}
    -

    +

    which is a synonym for

    options⟩]
    and -

    \printindex  \printindex[⟨options⟩]
    -

    +

    which is a synonym for

    options⟩]
    -

    If you use

    If you use Option 1, you need to use:

    options⟩]
    to display this glossary. -

    Remember to use the

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

    +

    -

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

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

    The example file

    The example file sample-index.tex illustrates the use of the indexcompatible-3.07Compatibility mode for old documents created using version 3.07 or below.

    -

    +

    -

    Top

    2.7 Setting Options After the Package is Loaded

    -

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

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

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

    +

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

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

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

    +

    -

    -

    +

    Top

    3. Setting Up

    -

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

    In the preamble you need to indicate whether you want to use Option 1, Option 2 or Option 3. It’s not possible to mix these options within a document.

    -

    Top

    3.1 Option 1

    -

    The command -

    The command +

    \makenoidxglossaries  \makenoidxglossaries
    -

    +

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

    +

    -

    Top

    3.2 Options 2 and 3

    -

    The command -

    The command +

    \makeglossaries  \makeglossaries
    -

    +

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

    Note that some of the commands provided by the

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

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

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

    -

    -

    You can suppress the creation of the customised

    +

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

    \noist  \noist
    -

    +

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

    Note that if you have a custom

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

    -

    The default name for the customised style file is given by

    +

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

    \setStyleFile  \setStyleFile{⟨name⟩}
    -

    +

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

    Each glossary entry is assigned a

    Each glossary entry is assigned a number list that lists all the locations in the document where that entry was used. By default, the location refers to the page number but this may @@ -7631,14 +7648,14 @@ class="cmss-10">counter package option. The default form of the location number assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this using -

    \glsSetCompositor  \glsSetCompositor{⟨symbol⟩}
    -

    +

    For example: @@ -7646,19 +7663,19 @@ For example:

    \glsSetCompositor{-}
    -

    This command must not be used after

    This command must not be used after \makeglossaries. -

    If you use

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

    \glsSetAlphaCompositor  \glsSetAlphaCompositor{⟨symbol⟩}
    -

    +

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

    -

    See

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

    -

    +

    Top

    4. Defining Glossary Entries

    -

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

    All glossary entries must be defined before they are used, so it is better to define them in the preamble to ensure this. In fact, some commands such as \longnewglossaryentry may only be used in the preamble. See §4.10 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 +

    +

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

    New glossary entries are defined using the command: -

    New glossary entries are defined using the command: +

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

    +

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

    \longnewglossaryentry  long description⟩}
    -

    +

    instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \longnewglossaryentry will remove trailing spaces in the description (via \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  }{⟨key=value list⟩}
    -

    +

    and -

    \longprovideglossaryentry  -

    \longprovideglossaryentry{⟨label⟩}{⟨}{⟨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 @@ -7787,7 +7804,7 @@ construct internal commands that store the associated information (similarly to commands like \label) and therefore must be able to expand to a valid control sequence name. -

    Note that although an

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

    -

    The second argument, ⟨

    +

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

    If the

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

    +

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

    \nopostdesc  \nopostdesc
    -

    +

    to suppress the description terminator for this entry. For example, if this entry is a parent entry that doesn’t require a description, you can do description={\nopostdesc}. If you want a paragraph break in the description use -

    \glspar  \glspar
    -

    +

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

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

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

    -

    This is equivalent to: +

    This is equivalent to:

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

    Unless you use the package option

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

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

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

    Similarly if you use the

    Similarly if you use the inputenc package:

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

    With Options 

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

    Take care with

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

    Take care if you use

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

    -

    +

    type§8 Cross-Referencing Entries. -

    This key essentially provides a convenient shortcut that performs

    +

    This key essentially provides a convenient shortcut that performs

    @@ -8350,7 +8367,7 @@ class="cmitt-10"> list⟩}
    after the entry has been defined. -

    For Options 

    For Options 2 and 3, \makeglossariesseedocument environment.
    -

    -

    If you use the

    +

    If you use the see key, you may want to consider using the supplementary glossaries-extra package.

    -

    The following keys are reserved for

    The following keys are reserved for \newacronym (see §4.3 Additional Keys). -

    Avoid using any of the

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

    -

    Note that if the name starts with

    +

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

    -

    Note that the same applies if you are using the

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

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

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

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

    -

    Top

    4.1 Plurals

    -

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

    You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending -

    \glspluralsuffix  \glspluralsuffix
    -

    +

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

    -

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

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

    -

    -

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

    +

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

    -

    You can then use

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

    \let\glsaltpl\glsuseri
    -

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

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

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

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

    +

    -

    Top

    4.2 Other Grammatical Constructs

    -

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

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

    @@ -8586,7 +8603,7 @@ href="#top">Top

      }%  
    }

    -

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

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

    @@ -8595,7 +8612,7 @@ href="#top">Top

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

    -

    and use them in the text: +

    and use them in the text:

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

    -

    Alternatively, you can define your own keys using

    +

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

    +

    -

    Top

    4.3 Additional Keys

    -

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

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

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

    For example, if you want to add a key that indicates the associated unit for a term, you might want to reference this unit in your document. In this case use \glsaddkey described in §4.5 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 @@ -8643,13 +8660,13 @@ The new keys must be added using \glsaddkey or \glsaddstoragekey before glossary entries are defined. -

    +

    -

    Top

    4.4 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  default value⟩}{⟨no link cs⟩}{⟨no link ucfirst +class="cmitt-10">no link ucfirst cs⟩} cs⟩}{⟨{⟨link cs⟩}{⟨link ucfirst cs⟩}{⟨link allcaps cs⟩}
    -

    +

    where:

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

    The starred version of

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

    Example 3 (Defining Custom Keys) -

    Suppose I want to define two new keys,

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

    -

    Now I can define some entries: +

    Now I can define some entries:

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

    -

    These entries can later be used in the document: +

    +

    These entries can later be used in the document:

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

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.5 Storage Keys

    -

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

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

    \glsaddstoragekey  }{⟨no link cs⟩}
    -

    +

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

    This is essentially the same as

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

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

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

    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 +

    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 @@ -8854,8 +8871,8 @@ already exists):  
     {word}% default value if not explicitly set  
     {\abbrtype}% custom command to access the value if required

    -

    -

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

    +

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

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

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

    \setacronymstyle{mystyle}
    -

    -

    Since it’s a bit confusing to use

    +

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

    Now the entries can all be defined: +

    Now the entries can all be defined:

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

    On

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

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    -

    In the above example, if

    +

    ____________________________

    +

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

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

    The previous example can be modified if the

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

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

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

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

    The new acronym style has a minor modification that forces the user to specify a description. In the previous example, the line: @@ -9026,14 +9043,14 @@ description. In the previous example, the line:

       \renewcommand*{\GenericAcronymFields}{description={\the\glslongtok}}%
    -

    needs to be changed to: +

    needs to be changed to:

       \renewcommand*{\GenericAcronymFields}{}%
    -

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

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

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

    need to be changed to: +

    need to be changed to:

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

    -

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

    +

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

    -

    No change is required for the definition of

    +

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

    -

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

    +

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

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

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

    The contractions can similarly been defined using this new command:

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

    -

    Since the custom acronym style just checks if

    +

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

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

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

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

    -

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

    +

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

    This uses

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

    With this style set, the

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

    apple
    a fruit.
    -

    but the abbreviations are displayed in the form +

    but the abbreviations are displayed in the form

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

    (for acronyms) or +

    (for acronyms) or

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

    (for initalisms) or +

    (for initalisms) or

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

    (for contractions). -

    For a complete document, see the sample file

    (for contractions). +

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    +

    -

    Top

    4.6 Expansion

    -

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

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

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

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

    \glssetexpandfield  \glssetexpandfield{⟨field⟩}
    -

    +

    or -

    \glssetnoexpandfield  \glssetnoexpandfield{⟨field⟩}
    -

    +

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

    -

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

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

    Note that the parent entry will automatically be added to the glossary if any of its child entries are used in the document. If the parent entry is not referenced in the document, it will not have a number listmakeindex has a restriction on the maximum sub-entry depth. -

    +

    -

    Top

    4.7.1 Hierarchical Categories

    -

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

    To arrange a glossary with hierarchical categories, you need to first define the category and then define the sub-entries using the relevant category entry as the value of the parent key. -

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

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

    Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. Then I can define the categories as follows: @@ -9399,13 +9416,13 @@ and Roman letters. Then I can define the categories as follows:  
    \newglossaryentry{romanletter}{name={Roman letters},  
    description={\nopostdesc}}

    -

    -

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

    +

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

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

    I can now define my sub-entries as follows:

    @@ -9418,19 +9435,19 @@ terminator.  
    description={Euler’s constant},  
    parent=romanletter}
    -

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    4.7.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 @@ -9444,11 +9461,11 @@ entry:  
    description={\nopostdesc},  
    plural={glossaries}}

    -

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

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

    Now define the two different meanings of the word: +

    Now define the two different meanings of the word:

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

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

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

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

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

    -

    +

    +

    -

    Top

    4.8 Loading Entries From a File

    -

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

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

    \loadglsentries  type⟩]{⟨filename⟩}
    -

    +

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

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

    This is a preamble-only command. You may also use \input to load the file but don’t use \include. -

    If you want to use

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

    +

    -

    Example 7 (Loading Entries from Another File) -

    Suppose I have a file called

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

    -

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

    and suppose in my document preamble I use the command:

    \loadglsentries[languages]{myentries}
    -

    then this will add the entries

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

    -

    -

    ____________________________

    -

    +

    ____________________________

    +

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

    -

    then (supposing I have defined a new glossary type called

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

    \loadglsentries[altacronym]{myacronyms}
    -

    will add

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

    If you have used the

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

    and do: +

    and do:

    \loadglsentries[altacronym]{myacronyms}
    -

    +

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

    • -

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

    +

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

    Remember that you can use

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

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

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

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

    Now the

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

    +

    -

    Top

    4.9 Moving Entries to Another Glossary

    -

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

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

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

    +

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

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

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

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

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

    -

    +

    +

    -

    Top

    4.10 Drawbacks With Defining Entries in the Document Environment

    -

    Originally,

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

    +

    -

    Top

    4.10.1 Technical Issues

    -

    +

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

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

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

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

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

    +

    -

    Top

    4.10.2 Good Practice Issues

    -

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

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

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

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

    -

    -

    +

    Top

    5. Number lists

    -

    Each entry in the glossary has an associated

    Each entry in the glossary has an associated number list. By default, these numbers refer to the pages on which that entry has been used (using any of the commands described in counter package option. The number list is also referred to as the location list. -

    Each location in the

    Each location in the number list is encapsulated with a command. (The encapnumber list with the same location repeated in different fonts. -

    This is something you need to be careful about, but if you use the +

    This is something you need to be careful about, but if you use the makeglossariesxindy\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 T

    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 xindy preferable.) -

    To compensate, the

    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: \⟨internal cs name⟩\c@page you need to use: -

    \glsaddprotectedpagefmt  }
    -

    +

    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: @@ -10051,7 +10068,7 @@ class="cmtt-10">samplenum that is implemented as follows:  
       \expandafter\@samplenum\csname c@#1\endcsname}  
     \newcommand*{\@samplenum}[1]{\two@digits{#1}}

    -

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

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

    \glsaddprotectedpagefmt{@samplenum}
    -

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

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

    If the inner macro (as given by

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

    -

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

    Again, the inner macro needs to be identified using:

    \glsaddprotectedpagefmt{@samplenum}
    -

    However, since

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

    While this modification means that the location list in the glossary won’t exactly match the +

    While this modification means that the location 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 xindy   \glsbackslash\string\textsc{\romannumeral\c@page}} -

    combined with +

    combined with

    @@ -10145,9 +10162,9 @@ class="cmtt-10">xindy "roman-numbers-lowercase" :sep "\glsclosebrace"} -

    will now have lowercase Roman numerals in the location list. (This option may cause +

    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

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

    -

    If you redefine

    +

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

    -

    The mechanism that allows this to work temporarily redefines

    +

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

    \glswrallowprimitivemodsfalse  \glswrallowprimitivemodsfalse
    -

    -

    Both

    +

    Both makeindex and } where ⟨n⟩ is either an integer or the keyword none which indicates that there should be no range formation. -

    Note that

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

    -

    With both

    +

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

    \glsSetSuffixF  \glsSetSuffixF{⟨suffix⟩}
    -

    -

    +

    \glsSetSuffixFF  \glsSetSuffixFF{⟨suffix⟩}
    -

    +

    where the former command specifies the suffix to use for a 2 page list and the latter specifies the suffix to use for longer lists. For example: @@ -10257,7 +10274,7 @@ the suffix to use for longer lists. For example: \glsSetSuffixF{f.}  
    \glsSetSuffixFF{ff.}

    -

    Note that if you use

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

    -

    Note that if you use the

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

    -

    -

    Note that

    +

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

    -

    +

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

    \glsnumberlistloop  }{⟨xr handler cs⟩}
    -

    +

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

    ⟨

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

    +

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

    ⟨

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

    +

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

    For example, if on page 12 I have used +

    For example, if on page 12 I have used

    \gls[format=textbf]{apple}
    -

    and on page 18 I have used +

    and on page 18 I have used

    \gls[format=emph]{apple}
    -

    then +

    then

    \glsnumberlistloop{apple}{\myhandler}
    -

    will be equivalent to: +

    will be equivalent to:

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

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

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

    \glsnoidxdisplayloc  }{⟨location⟩}
    -

    +

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

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

    +

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

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

    -

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

    +

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

    \GlsSetWriteIstHook  \GlsSetWriteIstHook{⟨code⟩}
    -

    +

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

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

    +

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

    -

    This changes the page type precedence

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

    Remember that if you switch to

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

    -

    -

    +

    Top

    6. Links to Glossary Entries

    -

    Once you have defined a glossary entry using

    Once you have defined a glossary entry using \newglossaryentry or \newacronymOption 1. 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

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

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

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

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

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

    -

    The above warning is particularly important if you are using the

    +

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

    -

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

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

    If you want the

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

    If you use the

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

    These are limitations of the DVI format not of the

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

    -

    -

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

    +

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

    The way the

    The way the link text is displayed depends on -

    \glstextformat  \glstextformat{⟨text⟩}
    -

    +

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

    -

    Further customisation can be done via

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

    Each entry has an associated conditional referred to as the

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

    The

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

    Avoid nesting these commands. For example don’t do

    Avoid nesting these commands. For example don’t do \glslink{⟨label⟩}{\gls{⟨\gls +{⟨label2⟩}} -as this is likely to cause problems. By implication, these means that you should avoid using -any of these commands within the } as this is likely to cause problems. By implication, this means that +you should avoid using any of these commands within the text, firstfirstshort or long keys (or their plural equivalent) or -any other key that you plan to access through these commands. (For example, the +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 \glssymbol.)
    -

    -

    The following keys are available for the optional argument: + id="dx1-44034"> key if you intend to use \glssymbol.) +

    +

    +

    The following keys are available for the optional argument:

    hyperhyperrefglossaries package to ensure the hyperlinks work. -
    +
    format
    italic) you will need to create a command that applies bo
    \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
    -

    and use that command. -

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

    and use that command. +

    In this document, the standard formats refer to the standard text block commands such as \textbf or \emph or any of the commands listed in table 6.1. -

    If you use

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

    \GlsAddXdyAttribute{textbfem}
    -

    See

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

    -

    -

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

    +

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

    -

    emphasized hyperlink
    -

    Note that if the

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

    -

    and then use

    and then use hyperbsf as the value for the format key. (See also “Displaying the @@ -10955,7 +10975,7 @@ class="cmtt-10">xindy \GlsAddXdyAttribute{hyperbsf}

    -

    +

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

    The

    The 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 link text may affect subsequent text.
    -

    +

    -

    Top

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

    -

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

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

    These commands use

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

    Apart from

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

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

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

    -

    Don’t use any of the

    +

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

    -

    -

    +

    \gls  label⟩}[⟨insert⟩]
    -

    +

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

    There are two upper case variants: -

    There are two upper case variants: +

    \Gls  label⟩}[⟨insert⟩]
    -

    +

    and -

    \GLS  label⟩}[⟨insert⟩]
    -

    +

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

    The first letter uppercasing command

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

    +

    The upper casing is performed as follows:

    -

    Then

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

    -

    which will appear as

    which will appear as Sample phrase.

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

    Then

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

    -

    which will appear as Œ-ligature. +

    which will appear as Œ-ligature.

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

    (Note the use of the

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

    There are hundreds of LAT

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

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

    For example, starting with a math-shift symbol:

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

    This falls into case 2 above, so the

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

    -

    This attempts to uppercase the math-shift

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

    Now the

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

    and the

    and the \uppercase becomes harmless. -

    Another issue occurs when the

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

    Now the

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

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

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

    -

    If the

    +

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

    Now the

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

    This won’t work because

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

    In fact, since the whole design ethos of LAT

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

    For further details see the

    For further details see the mfirstuc user manual. -

    There are plural forms that are analogous to

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

    \glspl  label⟩}[⟨insert⟩]
    -

    -

    +

    \Glspl  label⟩}[⟨insert⟩]
    -

    -

    +

    \GLSpl  label⟩}[⟨insert⟩]
    -

    +

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

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

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

    and later you use it in math mode: +

    and later you use it in math mode:

    $\gls{Falpha}^2$
    -

    This will result in

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

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

    -

    -

    +

    +

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

    +

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

    Don’t use any of the

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

    -

    +

    +

    -

    Top

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

    -

    This section describes the commands that don’t change or reference the first use -flag. As described above, these commands all have a star-variant (hyper=false) -and a plus-variant (hyper=true) and have an optional first argument that is a -⟨

    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 +plus-variant (hyper=true) and have an optional first argument that is a ⟨key⟩=⟨value⟩ list. These commands also don’t use value⟩ +list. These commands also don’t use \glsentryfmt or the equivalent -definition provided by or the equivalent definition +provided by \defglsentryfmt (see §6.3 Changing the format of the link -text). -

    Apart from Changing the format of the link text). +Additional commands for abbreviations are described in §13 Acronyms and Other +Abbreviations. +

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

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

    +

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

    Don’t use any of the

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

    -

    +

    \glstext  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous commands: -

    There are also analogous commands: +

    \Glstext  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLStext  text⟩}[⟨insert⟩]
    -

    +

    These convert the first character or all the characters to uppercase, respectively. See the note on \Gls above for details on the limitations of converting the first letter to upper case. -

    There’s no equivalent command for title-casing, but you can use the more generic +

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

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

    (See

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

    \glsfirst  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsfirst  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSfirst  text⟩}[⟨insert⟩]
    -

    -

    The value of the

    +

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

    -

    +

    \glsplural  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsfirstplural  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsfirstplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSfirstplural  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsname  insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsname  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSname  text⟩}[⟨insert⟩]
    -

    -

    In general it’s best to avoid

    +

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

    -

    +

    \glssymbol  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glssymbol  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSsymbol  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsdesc  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsdesc  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSdesc  text⟩}[⟨insert⟩]
    -

    -

    If you want the title case version you can use +

    +

    If you want the title case version you can use

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

    -

    +

    \glsuseri  label⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseri  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseri  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuserii  text⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuserii  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuserii  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuseriii  text⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseriii  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseriii  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuseriv  text⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuseriv  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuseriv  insert⟩]
    -

    -

    +

    \glsuserv  text⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuserv  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuserv  text⟩}[⟨insert⟩]
    -

    -

    +

    \glsuservi  text⟩}[⟨insert⟩]
    -

    +

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

    There are also analogous uppercasing commands: -

    There are also analogous uppercasing commands: +

    \Glsuservi  text⟩}[⟨insert⟩]
    -

    -

    +

    \GLSuservi  text⟩}[⟨insert⟩]
    -

    -

    +

    +

    -

    Top

    6.3 Changing the format of the link text

    -

    The default format of the

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

    \glsentryfmt  \glsentryfmt
    -

    +

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

    \defglsentryfmt  type⟩]{⟨definition⟩}
    -

    +

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

    Note that

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

    -

    Within the ⟨

    +

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

    \glslabel  \glslabel
    -

    +

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

    \glstype  \glstype
    -

    +

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

    \glscustomtext  \glscustomtext
    -

    +

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

    \glsinsert  \glsinsert
    -

    +

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

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

    +

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

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

    +

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

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

    +

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

    Note that

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

    \glslinkvar  star⟩}{⟨plus⟩}
    -

    +

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

    Note that you can also use commands such as

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

    The commands

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

    This means that using commands like

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

    -

    If you only want to make minor modifications to

    +

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

    \glsgenentryfmt  \glsgenentryfmt
    -

    +

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

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

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

    \glsgenacfmt  \glsgenacfmt
    -

    +

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

    \genacrfullformat  label⟩}{⟨insert⟩}
    -

    +

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

    \genplacrfullformat  label⟩}{⟨insert⟩}
    -

    +

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

    \Genacrfullformat  label⟩}{⟨insert⟩}
    -

    +

    and -

    \Genplacrfullformat  label⟩}{⟨insert⟩}
    -

    +

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

    Note that

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

    -

    As from version 4.16, both the

    +

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

    \glslinkpostsetkeys  \glslinkpostsetkeys
    -

    +

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

    \glspostlinkhook  \glspostlinkhook
    -

    +

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

    Example 8 (Custom Entry Display in Text) -

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

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

    -

    and now suppose you want

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

    -

    -

    (Note that I’ve used

    +

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

    Note also that all of the

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

    -

    then

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

    For a complete document, see the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 9 (Custom Format for Particular Glossary) -

    Suppose you have created a new glossary called

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

    -

    Now suppose you have defined an entry as follows: +

    Now suppose you have defined an entry as follows:

    @@ -12687,13 +12711,13 @@ do:  
      symbol={$S$}  
    }
    -

    The

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

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

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

    -

    and define entries like this: +

    and define entries like this:

    @@ -12714,21 +12738,21 @@ do:  
      symbol={S}  
    }
    -

    +

    -

    -

    ____________________________

    -

    Remember that if you use the

    +

    ____________________________

    +

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

    +

    -

    Top

    6.4 Enabling and disabling hyperlinks to glossary entries

    -

    If you load the

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

    You can disable or enable links using: -

    You can disable or enable links using: +

    \glsdisablehyper  \glsdisablehyper
    -

    +

    and -

    \glsenablehyper  \glsenablehyper
    -

    +

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

    You can disable just the

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

    Example 10 (First Use With Hyperlinked Footnote Description) -

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

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

    -

    Now I need to redefine

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

    -

    -

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

    +

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

    -

    -

    ____________________________

    -

    Note that the

    +

    ____________________________

    +

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

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

    Suppose I want to suppress the hyperlink on

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

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

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

    Once all glossary entries have been defined I then do:

    \glsunsetall[main]
    -

    +

    -

    -

    ____________________________

    -

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

    +

    ____________________________

    +

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

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

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

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

    -

    Note that this doesn’t affect the

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

    See the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

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

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

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

    -

    This creates a new user command called

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

    Next I redefine the hook

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

    -

    Note that this will be confused if you use

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

    See the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    7. Adding an Entry to the Glossary Without Generating Text

    -

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

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

    \glsadd  options⟩]{⟨label⟩}
    -

    +

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

    -

    -

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

    +

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

    \glsaddall  \glsaddall[⟨options⟩]
    -

    +

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

    -

    -

    Note that

    +

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

    -

    There is now a variation of

    +

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

    \glsaddallunused  \glsaddallunused[⟨list⟩]
    -

    +

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

    If you want to use

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

    Example 14 (Dual Entries) -

    The example file

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

    -

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

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

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

    This has the following syntax:

    +

    This has the following syntax:

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

    Now you can reference the acronym with

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    8. Cross-Referencing Entries

    -

    You must use

    You must use \makeglossaries (Options 2 or \makeglossaries/\makenoidxglossaries before all entry definitions.
    -

    -

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

    +

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

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

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

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

    -

    +

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

    Note that in this case, the entry with the

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

    The “see” tag is produce using

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

    -

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

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

    -

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

    Similarly if the value contains a list. For example:

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

    +

  • After you have defined the entry, use -

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

    +

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

    -

    Note that this automatically adds the entry given by ⟨

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

    • -

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

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

    -

    Top

    8.1 Customising Cross-reference Text

    -

    When you use either the

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

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

    +

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

    -

    -

    The list of labels is dealt with by

    +

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

    \glsseesep  \glsseesep
    -

    +

    or (for the last pair) -

    \glsseelastsep  \glsseelastsep
    -

    +

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

    \glsseeitemformat  \glsseeitemformat{⟨label⟩}
    -

    +

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

    -

    -

    You can use

    +

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

    -

    +

    +

    -

    -

    +

    Top

    9. Using Glossary Terms Without Links

    -

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

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

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

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

    -

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

    +

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

    \glsentrytitlecase  label⟩}{⟨field⟩}
    -

    +

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

    -

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

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

    Note that this command has the same limitations as

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

    \glsentryname  \glsentryname{⟨label⟩}
    -

    -

    +

    \Glsentryname  \Glsentryname{⟨label⟩}
    -

    +

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

    In general it’s best to avoid

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

    -

    +

    \glossentryname  \glossentryname{⟨label⟩}
    -

    +

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

    -

    -

    +

    \Glossentryname  \Glossentryname{⟨label⟩}
    -

    +

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

    \glsentrytext  \glsentrytext{⟨label⟩}
    -

    -

    +

    \Glsentrytext  \Glsentrytext{⟨label⟩}
    -

    +

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

    \glsentryplural  \glsentryplural{⟨label⟩}
    -

    -

    +

    \Glsentryplural  \Glsentryplural{⟨label⟩}
    -

    +

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

    \glsentryfirst  \glsentryfirst{⟨label⟩}
    -

    -

    +

    \Glsentryfirst  \Glsentryfirst{⟨label⟩}
    -

    +

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

    \glsentryfirstplural  \glsentryfirstplural{⟨label⟩}
    -

    -

    +

    \Glsentryfirstplural  \Glsentryfirstplural{⟨label⟩}
    -

    +

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

    \glsentrydesc  \glsentrydesc{⟨label⟩}
    -

    -

    +

    \Glsentrydesc  \Glsentrydesc{⟨label⟩}
    -

    +

    These commands display the description for the glossary entry given by ⟨label⟩. \Glsentrydesc @@ -13744,14 +13768,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 @@ -13816,7 +13840,7 @@ makes the first letter upper case. The first form is expandable (unless the valu contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -

    \glsletentryfield  label⟩}{⟨field⟩}
    -

    +

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

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

    -

    +

    \glossentrysymbol  \glossentrysymbol{⟨label⟩}
    -

    +

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

    \Glossentrysymbol  \Glossentrysymbol{⟨label⟩}
    -

    +

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

    \glsentrysymbolplural  \glsentrysymbolplural{⟨label⟩}
    -

    -

    +

    \Glsentrysymbolplural  \Glsentrysymbolplural{⟨label⟩}
    -

    +

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

    \glsentryuseri  \glsentryuseri{⟨label⟩}
    -

    -

    +

    \Glsentryuseri  \Glsentryuseri{⟨label⟩}
    -

    -

    +

    \glsentryuserii  \glsentryuserii{⟨label⟩}
    -

    -

    +

    \Glsentryuserii  \Glsentryuserii{⟨label⟩}
    -

    -

    +

    \glsentryuseriii  \glsentryuseriii{⟨label⟩}
    -

    -

    +

    \Glsentryuseriii  \Glsentryuseriii{⟨label⟩}
    -

    -

    +

    \glsentryuseriv  \glsentryuseriv{⟨label⟩}
    -

    -

    +

    \Glsentryuseriv  label⟩}
    -

    -

    +

    \glsentryuserv  \glsentryuserv{⟨label⟩}
    -

    -

    +

    \Glsentryuserv  \Glsentryuserv{⟨label⟩}
    -

    -

    +

    \glsentryuservi  \glsentryuservi{⟨label⟩}
    -

    -

    +

    \Glsentryuservi  \Glsentryuservi{⟨label⟩}
    -

    +

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

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

    +

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

    If you use

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

    -

    The next two commands are only available with

    +

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

    \glsentrynumberlist  \glsentrynumberlist{⟨label⟩}
    -

    -

    +

    \glsdisplaynumberlist  \glsdisplaynumberlist{⟨label⟩}
    -

    +

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

    The first command,

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

    \glsnumlistsep  \glsnumlistsep
    -

    +

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

    \glsnumlistlastsep  \glsnumlistlastsep
    -

    +

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

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

    -

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

    +

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

    -

    -

    +

    Top

    10. Displaying a glossary

    @@ -14139,12 +14163,12 @@ class="cmbx-10">Option 1:
    -

    \printnoidxglossaries  \printnoidxglossaries
    -

    +

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

    -

    \printglossaries  \printglossaries
    -

    +

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

    -

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

    These commands will display all the glossaries in the order in which they were defined. Note that, in the case of Options 2 and 3, no glossaries will appear until you have either used @@ -14195,7 +14219,7 @@ class="cmtt-10">\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

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

    An individual glossary can be displayed using: +

    An individual glossary can be displayed using:

    Option 1:
    -

    \printnoidxglossary  \printnoidxglossary[⟨options⟩]
    -

    +

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

    -

    \printglossary  \printglossary[⟨options⟩]
    -

    +

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

    -

    where ⟨

    where ⟨options⟩ is a ⟨key⟩=⟨value⟩ list of options. (Again, when the associated external file is missing, \null is inserted into the document.) -

    The following keys are available: +

    The following keys are available:

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

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

    Note that you can’t display an ignored glossary, so don’t try setting type to the name of a glossary that was defined using 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 +

    +

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

    If you don’t get an error with

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

    -

    By default, the glossary is started either by

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

    \glsglossarymark  \glsglossarymark{⟨title⟩}
    -

    +

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

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

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

    \glossarypreamble  \glossarypreamble
    -

    +

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

    -

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

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

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

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

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

    +

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

    For example: +

    For example:

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

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

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

    There is an analogous command to

    There is an analogous command to \glossarypreamble called -

    \glossarypostamble  \glossarypostamble
    -

    +

    which is placed at the end of each glossary. -

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

    Suppose you are using the

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

    -

    +

    -

    -

    ____________________________

    -

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

    +

    ____________________________

    +

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

    \glsnamefont  \glsnamefont{⟨name⟩}
    -

    +

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

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

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

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

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

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

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

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    11. Xindy (Option 3)

    -

    If you want to use

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

    -

    This ensures that the glossary information is written in

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

    §1.4 Generating the Associated Glossary Files covers how to use the external xindy style file (.xdy) and parameters. -

    To assist writing information to the

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

    \glsopenbrace  \glsopenbrace
    -

    -

    +

    \glsclosebrace  \glsclosebrace
    -

    +

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

    \glspercentchar  \glspercentchar
    -

    +

    and a tilde character using: -

    \glstildechar  \glstildechar
    -

    +

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

    \glsbackslash  \glsbackslash
    -

    -

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

    +

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

    \glsquote  \glsquote{⟨text⟩}
    -

    +

    which will produce "⟨text⟩\string" to write the double-quote character. This document assumes that the double quote character has not been made active, so the examples just use " for clarity. -

    If you want greater control over the

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

    -

    Top

    11.1 Language and Encodings

    -

    When you use

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

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

    +

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

    If the

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

    \GlsSetXdyCodePage  \GlsSetXdyCodePage{⟨code⟩}
    -

    +

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

    \GlsSetXdyCodePage{utf8}
    -

    -

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

    +

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

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

    -

    If you write your own custom

    +

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

    \GlsSetXdyLanguage{}
    -

    (and remember to use

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

    The commands

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

    -

    +

    +

    -

    Top

    11.2 Locations and Number lists

    -

    If you use

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

    \GlsAddXdyCounters  \GlsAddXdyCounters{⟨counter list⟩}
    -

    +

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

    The most likely attributes used in the

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

    \GlsAddXdyAttribute  \GlsAddXdyAttribute{⟨name⟩}
    -

    +

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

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

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

    -

    Then in the document: +

    Then in the document:

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

    This will give the

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

    Example 17 (Custom Font for Displaying a Location) -

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

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

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

    but with

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

    -

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

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

    -

    (where

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

    -

    -

    ____________________________

    -

    Note that

    +

    ____________________________

    +

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

    -

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

    +

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

    \GlsAddXdyLocation  }{⟨definition⟩}
    -

    +

    where ⟨name⟩ is the name of the format and ⟨definition⟩ is the §5 Number lists.) -

    Note that

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

    +

    -

    Example 18 (Custom Numbering System for Locations) -

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

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

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

    If I haven’t done

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

    \GlsAddXdyCounters{section}
    -

    Next I need to add the location style (

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

    -

    Note that if I have further decided to use the

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

    -

    then I need to modify the

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

    -

    Since

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

    -

    This example is illustrated in the sample file

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

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 19 (Locations as Words not Digits) -

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

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

    -

    This gets expanded to

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

    -

    Note that it’s necessary to use

    Note that it’s necessary to use \space to indicate that spaces also appear in the format, since, unlike TEX, xindy doesn’t ignore spaces after control sequences. -

    Note that

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

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

    +

    for each counter that has been identified either by the counter package option, the ⟨\newglossary or in the argument of \GlsAddXdyCounters. -

    The first argument ⟨

    The first argument ⟨Hprefix⟩ is only relevant when used with the hyperref package and @@ -15253,12 +15277,12 @@ commands:  
    }  
    \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}

    -

    +

    -

    -

    ____________________________

    -

    In the

    +

    ____________________________

    +

    In the number list, the locations are sorted according to type. The default ordering is: \GlsAddXdyLocationsee (cross-referenced entries). This ordering can be changed using: -

    \GlsSetXdyLocationClassOrder  -

    \GlsSetXdyLocationClassOrder{⟨location names⟩}
    -

    +

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

    -

    -

    Note that

    +

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

    -

    If a

    +

    If a number list consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: -

    \GlsSetXdyMinRangeLength  -

    \GlsSetXdyMinRangeLength{⟨n⟩}
    -

    +

    For example: @@ -15346,13 +15370,13 @@ For example:

    \GlsSetXdyMinRangeLength{3}
    -

    The argument may also be the keyword

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

    Note that

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

    -

    See

    +

    See §5 Number lists for further details.

    -

    Top

    11.3 Glossary Groups

    -

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

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

    -

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

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

    If you have a number group, the default behaviour is to locate it before the “A” letter +

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

    \GlsSetXdyFirstLetterAfterDigits  -

    \GlsSetXdyFirstLetterAfterDigits{⟨letter⟩}
    -

    -

    Note that

    +

    Note that \GlsSetXdyFirstLetterAfterDigits has no effect if \noist is used or if @@ -15409,16 +15433,16 @@ class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits must be used before class="cmtt-10">\makeglossaries.
    -

    +

    -

    -

    +

    Top

    12. Defining New Glossaries

    -

    A new glossary can be defined using: -

    A new glossary can be defined using: +

    \newglossary  title⟩}[⟨counter⟩]
    -

    +

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

    The glossary label ⟨

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

    -

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

    +

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

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

    +

    which is equivalent to

    counter⟩]
    or you can also use: -

    \altnewglossary  title⟩}[⟨counter⟩]
    -

    +

    which is equivalent to

    counter⟩]
    -

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

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

    \newignoredglossary  \newignoredglossary{⟨name⟩}
    -

    +

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

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

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

    \ifignoredglossary  true⟩}{⟨false⟩}
    -

    +

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

    Note that the main (default) glossary is automatically created as: +

    Note that the main (default) glossary is automatically created as:

    \newglossary{main}{gls}{glo}{\glossaryname}
    -

    so it can be identified by the label

    so it can be identified by the label main (unless the nomain package option is used). Using @@ -15613,7 +15637,7 @@ class="cmss-10">acronym \newglossary[alg]{acronym}{acr}{acn}{\acronymname}

    -

    so it can be identified by the label

    so it can be identified by the label acronym. If you are not sure whether the acronym @@ -15632,7 +15656,7 @@ acronyms, you need to declare it as a list of acronyms using the package option acronymlists. -

    The

    The symbols package option creates a new glossary with the label symbols using: @@ -15642,7 +15666,7 @@ class="cmtt-10">symbols using:

    \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
    -

    The

    The numbers package option creates a new glossary with the label numbers using: @@ -15652,7 +15676,7 @@ class="cmtt-10">numbers using:

    \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
    -

    The

    The index package option creates a new glossary with the label index using: @@ -15662,14 +15686,14 @@ class="cmtt-10">index using:

    \newglossary[ilg]{index}{ind}{idx}{\indexname}
    -

    -

    Options 

    +

    Options 2 and 3: all glossaries must be defined before \makeglossaries to ensure that the relevant output files are opened. -

    See

    See §1.3.1 Changing the Fixed Names if you want to redefine \indexname, just follow the advice in How to change LaTeX’s “fixed names”.

    -

    +

    -

    -

    +

    Top

    13. Acronyms and Other Abbreviations

    -

    Note that although this chapter uses the term “acronym”, you can also use the +

    The glossaries-extra package provides superior abbreviation handling. You may want to +consider using that package instead of the commands described here. +

    Note that although this chapter uses the term “acronym”, you can also use the 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 Multi-Lingual Support) or by using the -Multi-Lingual Support) or by +using the title in the optional argument of in the optional argument of \printglossary (or (or \printacronym). You may -prefer to use the glossaries-extra package which defines \newabbreviation and treats -acronyms (e.g. “laser”) differently from other forms of abbreviations (e.g. “html”). + id="dx1-59005">). +Alternatively consider using the glossaries-extra package’s abbreviations option instead.
    -

    -

    You may have noticed in

    +

    You may have noticed in §4 Defining Glossary Entries that when you specify a new entry, @@ -15727,10 +15754,10 @@ href="#glo:firstuse">first used in the document. This provides a useful means to define abbreviations. For convenience, the glossaries package defines the command: -

    \newacronym  \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-59008"> 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-59010"> key within the optional argument. The \newacronym command also uses the long, , longplural, , short and and shortplural + id="dx1-59014"> 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-59015"> also apply to \newacronym (see §4 Defining Glossary Entries). -

    If you haven’t identified the specified glossary type as a list of acronyms (via +

    If you haven’t identified the specified glossary type as a list of acronyms (via the package option acronymlists or the command or the command \DeclareAcronymList, see , see §2.5 \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-59018">. 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-59020">) before defining your entries.
    -

    -

    The optional argument

    +

    The optional argument {⟨key-val list⟩} allows you to specify keys such as } allows you to specify additional information. Any +key that can be used in the second argument of \newglossaryentry can also be used +here in ⟨key-val list⟩. For example, description (when -used with one of the styles that require a description, described in (when used with one of the styles that +require a description, described in §13.1 Changing the -Abbreviation Style) or you can override plural forms of ⟨Changing the Abbreviation Style) or you can +override plural forms of ⟨abbrv⟩ or ⟨long⟩ using the shortplural or - or longplural keys. For example: + id="dx1-59024"> keys. For +example:

    @@ -15820,34 +15852,34 @@ class="cmss-10">longplural  {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-59026"> keys, I recommend you use \setacronymstyle to set the display style rather than using one of the pre-version 4.02 + id="dx1-59027"> 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-59030"> 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.8 Loading Entries From a File.
    -

    +

    -

    +

    Example 20 (Defining an Abbreviation) -

    The following defines the abbreviation IDN: + id="x1-59035"> +

    The following defines the abbreviation IDN:

    \newacronym{idn}{IDN}{identification number}
    -

    \gls{idn} will produce “identification number (IDN)” on first use and “IDN” on subsequent uses. If you want to use one of the smallcaps acronym styles, described in \newacronym{idn}{idn}{identification number}

    -

    Now

    Now \gls{idn} will produce “identification number (in” on subsequent uses.

    -

    -

    ____________________________

    -

    Recall from the warning in

    +

    ____________________________

    +

    Avoid nested definitions.
    +

    +

    Recall from the warning in §4 Defining Glossary Entries that you should avoid using the @@ -15918,13 +15952,13 @@ class="cmtt-10">\gls-like and \glstext-like commands within the value of keys like text and and first due to + id="dx1-59037"> 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:

    @@ -15932,23 +15966,23 @@ class="cmtt-10">\newacronym. \newacronym{ssi}{SSI}{server side includes}  
    \newacronym{html}{HTML}{hypertext markup language}
    -

    you may be tempted to do: +

    you may be tempted to do:

    \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}
    -

    Don’t! This will break the case-changing commands, such as \Gls, it will cause + id="dx1-59038">, 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-59039">). +

    Instead, consider doing:

    @@ -15957,7 +15991,7 @@ class="cmtt-10">\glslabel [description={\gls{ssi} enabled \gls{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}
    -

    or +

    or

    @@ -15967,25 +16001,30 @@ class="cmtt-10">\glslabel     {shtml}{SHTML}  
     {server side includes enabled hypertext markup language}
    -

    Similarly for the

    Similarly for the \glstext-like commands. -

    The commands described below are similar to the

    Other approaches are available with glossaries-extra. See the section “Nested Links” in the +glossaries-extra user manual. +

    The commands described below are similar to the \glstext-like commands in that they don’t modify the first use flag. However, their display is governed by \defentryfmt with + id="dx1-59041"> 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. @@ -15993,14 +16032,14 @@ As with the \glstext-like commands, the link text is placed in the argument of + id="dx1-59043"> 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-59047">) for the entry given by ⟨label⟩. The short form is as supplied by the short key, which key, which \newacronym implicitly + id="dx1-59049"> 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-59056"> implicitly sets. -

    \acrlong  \acrlong[⟨options⟩]{⟨label⟩}[⟨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-59067"> 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-59068"> 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⟩). (For further details of these format commands see the +class="cmti-10">short⟩). This command is now deprecated for new acronym styles but is +used by the default for backward compatibility if \setacronymstyle (§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⟩]{⟨label⟩}[⟨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-59077"> package option to activate the shorter command names listed in table 13.1.

    -

    @@ -16335,7 +16380,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-59080"> + id="dx1-59082"> + id="dx1-59084"> + id="dx1-59086"> + id="dx1-59088"> + id="dx1-59090"> + id="dx1-59092"> + id="dx1-59094"> + id="dx1-59096"> + id="dx1-59098"> + id="dx1-59100"> + id="dx1-59102"> + id="dx1-59104"> + id="dx1-59106"> + id="dx1-59108">
    \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-59110">
    -

    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 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-59112"> (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 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 format may be redefined by the -acronym style. + id="dx1-59125"> 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 @@ -16631,8 +16676,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 @@ -16640,7 +16685,7 @@ styles, then try using the glossaries-extra package, which has better abbreviation management. -

    Note that unlike the default behaviour of

    Note that unlike the default behaviour of \newacronym, the styles used via \setacronymstyle don’t use the \glsgenacfmt\genacrfullformat. -

    Note that when you use

    Note that when you use \setacronymstyle the name key is set to -

    \acronymentry  \acronymentry{⟨label⟩}
    -

    +

    and the sort key is set to -

    \acronymsort  short⟩}{⟨long⟩}
    -

    +

    These commands are redefined by the acronym styles. However, you can redefine them again after the style has been set but before you use \newacronym. Protected expansion is performed on \acronymsort when the entry is defined. -

    +

    -

    Top

    13.1.1 Predefined Acronym Styles

    -

    The

    The glossaries package provides a number of predefined styles. These styles apply -

    \firstacronymfont  \firstacronymfont{⟨text⟩}
    -

    +

    to the short form on first use and -

    \acronymfont  \acronymfont{⟨text⟩}
    -

    +

    on subsequent use. The styles modify the definition of \acronymfont as required, but \firstacronymfont independently of the acronym style. -

    The predefined styles that contain

    The predefined styles that contain sc in their name (for example long-sc-short) redefine @@ -16747,9 +16792,9 @@ class="cmtt-10">\acronymfont to use \textsc, which means that the short form needs to be specified in lower case. -

    -

    Some fonts don’t support bold smallcaps, so you may need to redefine

    Some fonts don’t support bold smallcaps, so you may need to redefine \glsnamefont (see \textsc.
    -

    -

    The predefined styles that contain

    +

    The predefined styles that contain sm in their name (for example long-sm-short) redefine @@ -16769,9 +16814,9 @@ class="cmss-10">long-sm-short\acronymfont to use \textsmaller. -

    -

    Note that the

    Note that the glossaries package doesn’t define or load any package that defines \textsmallerrelsize package or otherwise define \textsmaller.
    -

    -

    The remaining predefined styles redefine

    +

    The remaining predefined styles redefine \acronymfont{⟨text⟩} to simply do its argument ⟨text⟩. -

    In most cases, the predefined styles adjust

    In most cases, the predefined styles adjust \acrfull and \glsentryfullduafootnote styles (and their variants).
    -

    -

    The following styles are supplied by the

    +

    The following styles are supplied by the glossaries package:

    • long-sm-short, long-sp-short: -

      With these three styles, acronyms are displayed in the form -

      ⟨

      With these three styles, acronyms are displayed in the form +

      ⟨long⟩ (\firstacronymfont{⟨short⟩})
      -

      +

      on first use and -

      \acronymfont{⟨short⟩}
      -

      +

      on subsequent use. They also set \acronymsort{⟨short⟩}{⟨long⟩} to just ⟨short⟩. This - means that the acronyms are sorted according to their short form. In addition, +class="cmti-10">short⟩. This means + that the acronyms are sorted according to their short form. In addition, \acronymentry \acronymentry{⟨{⟨label⟩} is set to just the short form (enclosed in \acronymfont) and the - \acronymfont) and the description key is set to the long form. -

      The key + is set to the long form. +

      The long-sp-short 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-longsc-short-long, sm-short-long: -

      These three styles are analogous to the above three styles, except the display order is +

      These three styles are analogous to the above three styles, except the display order is swapped to -

      \firstacronymfont{⟨short⟩} (⟨long⟩)
      -

      +

      on first use. -

      Note, however, that

      Note, however, that \acronymsort and \acronymentrylong-sm-short-desc, long-sp-short-desc: -

      These are like the

      These are like the long-short, long-sc-shortlong-sc-shortlong-sm-short and long-sp-short - styles described above, except that the styles + described above, except that the description key must be supplied in the - optional argument of key must be supplied in the optional + argument of \newacronym. They also redefine \acronymentry to {⟨long⟩} - (\acronymfont{⟨} (\acronymfont + {⟨short⟩}) and redefine \acronymsortshort⟩}{⟨long⟩} to just ⟨long⟩. This - means that the acronyms are sorted according to the long form, and in the list of - acronyms the name field has the long form followed by the short form in parentheses. - I recommend you use a glossary style such as long⟩. This means that the + acronyms are sorted according to the long form, and in the list of acronyms the name + 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 field. + id="dx1-61047"> with these acronym styles to allow for the long name + field.

    • short-long-descsc-short-long-desc, sm-short-long-desc: -

      These styles are analogous to the above three styles, but the first use display style +

      These styles are analogous to the above three styles, but the first use display style is: -

      \firstacronymfont{⟨short⟩} (⟨long⟩)
      -

      +

      The definitions of \acronymsort and \acronymentry are the same as those for @@ -16983,7 +17030,7 @@ class="cmss-10">dua-desc: -

      With these styles, the

      With these styles, the \gls-like commands always display the long form regardless of whether the entry has been used or not. However, footnote-sc, footnote-sm: -

      With these three styles, on first use the

      With these three styles, on first use the \gls-like commands display: -

      \firstacronymfont{⟨short⟩}\footnote}\footnote{⟨long⟩}
      -

      +

      However, \acrfull and short⟩} (⟨long⟩). On subsequent use the display is: -

      \acronymfont{⟨short⟩}
      -

      +

      The sort and namedescription is set to the long form. -

      In order to avoid nested hyperlinks on

      In order to avoid nested hyperlinks on first use the footnote styles automatically implement hyperfirst=false for the acronym lists.
      -

      +

    • footnote-descfootnote-sc-desc, footnote-sm-desc: -

      These three styles are similar to the previous three styles, but the description +

      These three styles are similar to the previous three styles, but the description has to be supplied in the optional argument of \newacronym. The altlist

    -

    Example 21 (Adapting a Predefined Acronym Style) -

    Suppose I want to use the

    Suppose I want to use the footnote-sc-desc style, but I want the namefootnote-sc-desc \setacronymstyle{footnote-sc-desc}

    -

    and then redefine

    and then redefine \acronymsort and \acronymentry\acronymentry\renewcommand*{\acronymentry}[1]{%  
      \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}%

    -

    (I’ve used

    (I’ve used \space for extra clarity, but you can just use an actual space instead.) -

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to +

    Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to redefine \acronymfont so that it always switches to medium weight to ensure the smallcaps @@ -17138,24 +17185,24 @@ setting is used:

    \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}}
    -

    This isn’t necessary if you use a font that supports bold smallcaps. -

    The sample file

    This isn’t necessary if you use a font that supports bold smallcaps. +

    The sample file sampleFnAcrDesc.tex illustrates this example.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.1.2 Defining A Custom Acronym Style

    -

    You may find that the predefined acronyms styles that come with the

    You may find that the predefined acronyms styles that come with the glossaries package don’t suit your requirements. In this case you can define your own style using: -

    \newacronymstyle  }{⟨definitions⟩}
    -

    +

    where ⟨style name⟩ is the name of the new style (avoid active characters). The second argument, ⟨ \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%

    -

    (You can use

    (You can use \ifglshasshort instead of \ifglshaslong to test if the entry is an acronym if you prefer.) -

    The third argument, ⟨

    The third argument, ⟨definitions⟩, can be used to redefine the commands that affect the display style, such as \acronymfont\glsgenacfmt, \genacrfullformat and its variants. -

    Note that

    Note that \setacronymstyle redefines \glsentryfulldua\newacronymstyle should redefine these commands within ⟨definitions⟩. -

    Within

    Within \newacronymstyle’s ⟨definitions⟩ argument you can also redefine -

    \GenericAcronymFields  \GenericAcronymFields
    -

    +

    This is a list of additional fields to be set in \newacronym. You can use the following token @@ -17283,7 +17330,7 @@ does: \renewcommand*{\GenericAcronymFields}{%  
       description={\the\glslongtok}}%

    -

    which sets the

    which sets the description field to the long form of the acronym whereas the long-short-desc \renewcommand*{\GenericAcronymFields}{}%

    -

    since the description needs to be specified by the user. -

    It may be that you want to define a new acronym style that’s based on an existing style. +

    since the description needs to be specified by the user. +

    It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨display⟩ you can use -

    \GlsUseAcrEntryDispStyle  -

    \GlsUseAcrEntryDispStyle{⟨style name⟩}
    -

    +

    to use the ⟨display⟩ definition from the style given by ⟨style name⟩. Within ⟨definitions⟩ you can use -

    \GlsUseAcrStyleDefs  \GlsUseAcrStyleDefs{⟨style name⟩}
    -

    +

    to use the ⟨definitions⟩ from the style given by ⟨style name⟩. For example, the definitions⟩):  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
    }

    -

    (

    (\glstextup ms.) -

    Example 22 (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 @@ -17415,7 +17462,7 @@ class="cmti-10">long⟩ (⟨short⟩) ⟨description⟩
    -

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second +

    Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of \newacronymstyle using: @@ -17425,7 +17472,7 @@ class="cmtt-10">\newacronymstyle \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%

    -

    This will use

    This will use \glsgenentryfmt if the entry isn’t an acronym, otherwise it will use #):  
       \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%  
      }%

    -

    If you think it inappropriate for the short form to be capitalised at the start of a sentence +

    If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the above to: @@ -17486,7 +17533,7 @@ you can change the above to:  
     \let\Genacrfullformat\genacrfullformat  
     \let\Genplacrfullformat\genplacrfullformat

    -

    Another variation is to use

    Another variation is to use \Glsentrylong and \Glsentrylongpl\glsentrylong and \glsentrylongpl. -

    Now let’s suppose that commands such as

    Now let’s suppose that commands such as \glsentryfull and \acrfull\glsentryfull, \acrfullfmt and their plural and upper case variants. -

    First, the non-linking commands: +

    First, the non-linking commands:

    @@ -17531,7 +17578,7 @@ variants.  
          (\acronymfont{\glsentryshortpl{##1}})%  
      }%
    -

    Now for the linking commands: +

    Now for the linking commands:

    @@ -17577,11 +17624,11 @@ variants.  
        }%  
      }%
    -

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, +

    (This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only the short form is inside the argument of \glslink.) -

    The style also needs to redefine

    The style also needs to redefine \acronymsort so that the acronyms are sorted according to the long form: @@ -17591,7 +17638,7 @@ to the long form:

      \renewcommand*{\acronymsort}[2]{##2}%
    -

    If you prefer them to be sorted according to the short form you can change the above +

    If you prefer them to be sorted according to the short form you can change the above to: @@ -17599,7 +17646,7 @@ to:

      \renewcommand*{\acronymsort}[2]{##1}%
    -

    The acronym font needs to be set to

    The acronym font needs to be set to \textsc and the plural suffix adjusted so that the “s” suffix in the plural short form doesn’t get converted to smallcaps: @@ -17610,7 +17657,7 @@ suffix in the plural short form doesn’t get converted to smallcaps:   \renewcommand*{\acronymfont}[1]{\textsc{##1}}%  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%

    -

    There are a number of ways of dealing with the format in the list of acronyms. The simplest +

    There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine \acronymentry to the long form followed by the upper case short form in @@ -17623,13 +17670,13 @@ parentheses:  
       \Glsentrylong{##1}\space  
         (\MakeTextUppercase{\glsentryshort{##1}})}%

    -

    (I’ve used

    (I’ve used \Glsentrylong instead of \glsentrylong to capitalise the name in the glossary.) -

    An alternative approach is to set

    An alternative approach is to set \acronymentry to just the long form and redefine  \renewcommand*{\GenericAcronymFields}{%  
        symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}%

    -

    I’m going to use the first approach and set

    I’m going to use the first approach and set \GenericAcronymFields to do nothing: @@ -17660,8 +17707,8 @@ class="cmtt-10">\GenericAcronymFields  \renewcommand*{\GenericAcronymFields}{}%

    -

    -

    Finally, this style needs to switch off hyperlinks on first use to avoid nested +

    +

    Finally, this style needs to switch off hyperlinks on first use to avoid nested links: @@ -17669,7 +17716,7 @@ links:

     \glshyperfirstfalse
    -

    Putting this all together: +

    Putting this all together:

    @@ -17763,15 +17810,15 @@ links:  
         (\MakeTextUppercase{\glsentryshort{##1}})}%  
    }
    -

    -

    Now I need to specify that I want to use this new style: +

    +

    Now I need to specify that I want to use this new style:

    \setacronymstyle{custom-fn}
    -

    I also need to use a glossary style that suits this acronym style, for example

    I also need to use a glossary style that suits this acronym style, for example altlist: @@ -17780,8 +17827,8 @@ class="cmss-10">altlist \setglossarystyle{altlist}

    -

    -

    Once the acronym style has been set, I can define my acronyms: +

    +

    Once the acronym style has been set, I can define my acronyms:

    @@ -17793,26 +17840,26 @@ class="cmss-10">altlist    layout of a document written in a markup language}]{css}  
    {css}{Cascading Style Sheet}
    -

    -

    The sample file

    +

    The sample file sample-custom-acronym.tex illustrates this example.

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 23 (Italic and Upright Abbreviations) -

    Suppose I want to have some abbreviations in italic and some that just use the +

    Suppose I want to have some abbreviations in italic and some that just use the surrounding font. Hard-coding this into the ⟨short⟩ argument of \newacronym can cause complications. -

    This example uses

    This example uses \glsaddstoragekey to add an extra field that can be used to store the formatting declaration (such as \em).

    \glsaddstoragekey{font}{}{\entryfont}
    -

    This defines a new field/key called

    This defines a new field/key called font, which defaults to nothing if it’s not explicitly set. This also defines a command called \entryfont that’s analogous to \glsentrytext. A new style is then created to format abbreviations that access this field. -

    There are two ways to do this. The first is to create a style that doesn’t use

    There are two ways to do this. The first is to create a style that doesn’t use \glsgenacfmt but instead provides a modified version that doesn’t use \genacrfullformat need to be similarly adjusted. For exam  
       ({\entryfont{##1}\glsentryshort{##1}})%  
      }%

    -

    This will deal with commands like

    This will deal with commands like \gls but not commands like \acrshort \renewcommand*{\acronymfont}[1]{{\entryfont{\glslabel}#1}}%

    -

    So the new style can be defined as: +

    So the new style can be defined as:

    @@ -17910,23 +17957,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: @@ -17964,7 +18011,7 @@ The spacing is more noticeable with the typewriter font: \ttfamily  
    I was awarded a B.Sc. and a Ph.D. (From the same place.)

    -

    is typeset as +

    is typeset as
    I was awarded a B.Sc. and a Ph.D. (From the same place.)
    @@ -17980,8 +18027,8 @@ These can be corrected:

    I was awarded a B.Sc.\ and a Ph.D\@. (From the same place.)
    -

    -

    This situation is a bit problematic for

    +

    This situation is a bit problematic for glossaries. The full stops can form part of the ⟨short⟩ argument of \@ before the full stop. -

    The next example shows one way of achieving this. (Note that the supplemental +

    The next example shows one way of achieving this. (Note that the supplemental glossaries-extra package provides a much simpler way of doing this, which you may prefer to use.) -

    Example 24 (Abbreviations with Full Stops (Periods)) -

    As from version 4.16, there’s now a hook (

    As from version 4.16, there’s now a hook (\glspostlinkhook) that’s called at the very end of the amsgen documentation.) -

    It’s possible that I may also want acronyms or contractions in my document, so I need +

    It’s possible that I may also want acronyms or contractions in my document, so I need some way to differentiate between them. Here I’m going to use the same method as in example 4 where a new field is defined to indicate the type of abbreviation: @@ -18035,7 +18082,7 @@ href="#x1-33002r4">4 where a new \glsaddstoragekey{abbrtype}{word}{\abbrtype}  
    \newcommand*{\newabbr}[1][]{\newacronym[abbrtype=initials,#1]}

    -

    Now I just use

    Now I just use \newacronym for the acronyms, for example, @@ -18045,7 +18092,7 @@ class="cmtt-10">\newacronymemission of radiation}

    -

    and my new command

    and my new command \newabbr for initials, for example, @@ -18057,7 +18104,7 @@ class="cmtt-10">\newabbr for initials, for example,  
    \newabbr{ba}{B.A.}{Bachelor of Arts}  
    \newabbr{agm}{A.G.M.}{annual general meeting}

    -

    Within

    Within \glspostlinkhook the entry’s label can be accessed using \glslabel and @@ -18068,7 +18115,7 @@ class="cmtt-10">abbrtype field set to “initials”. If it doesn’t, then nothing needs to happen, but if it does, a check is performed to see if the next character is a full stop. If it is, this signals the end of a sentence otherwise it’s mid-sentence. -

    Remember that internal commands within the document file (rather than in a class or +

    Remember that internal commands within the document file (rather than in a class or package) need to be placed between \makeatletter and \makeatother}  
    \makeatother

    -

    In the event that a full stop is found

    In the event that a full stop is found \doendsentence is performed but it will be followed by the full stop, which needs to be discarded. Otherwise \doendword will be done but it won’t be @@ -18099,7 +18146,7 @@ are: \newcommand{\doendsentence}[1]{\spacefactor=10000{}}  
    \newcommand{\doendword}{\spacefactor=1000{}}

    -

    Now, I can just do

    Now, I can just do \gls{bsc} mid-sentence and \gls{phd}. at the end of the sentence. The terminating full stop will be discarded in the latter case, but it won’t be @@ -18107,7 +18154,7 @@ discarded in, say, \gls{laser}. as that doesn’t have the abbrtype field set to “initials”. -

    This also works on first use when the style is set to one of the ⟨

    This also works on first use when the style is set to one of the ⟨long⟩ (⟨short⟩) styles but it will fail with the ⟨first use flag and define a macro that can then be used in \glspostlinkhook. -

    The other thing to consider is what to do with plurals. One possibility is to check for +

    The other thing to consider is what to do with plurals. One possibility is to check for plural use within \doendsentence (using \glsifplural) and put the full stop back if the plural has been used. -

    The complete document is contained in the sample file

    The complete document is contained in the sample file ??.

    -

    -

    ____________________________

    -

    +

    +

    ____________________________

    +

    -

    Top

    13.2 Displaying the List of Acronyms

    -

    The list of acronyms is just like any other type of glossary and can be displayed on its own +

    The list of acronyms is just like any other type of glossary and can be displayed on its own using:

    [type=\acronymtype]
    -

    (If you use the

    (If you use the acronym package option you can also use

    @@ -18214,7 +18261,7 @@ href="#sec:pkgopts-acronym">§2.5 Acronym Options.) -

    Alternatively the list of acronyms can be displayed with all the other glossaries using: +

    Alternatively the list of acronyms can be displayed with all the other glossaries using:

    :
    \printglossaries
    -

    However, care must be taken to choose a glossary style that’s appropriate to your acronym +

    However, care must be taken to choose a glossary style that’s appropriate to your acronym style. Alternatively, you can define your own custom style (see §15.2 Defining your own glossary style for further details). -

    +

    -

    Top

    13.3 Upgrading From the glossary Package

    -

    Users of the obsolete

    Users of the obsolete glossary package may recall that the syntax used to define new acronyms has changed with the replacement acr-name⟩ when defining the acronym class="cmti-10">acr-name⟩. -

    In order to facilitate migrating from the old package to the new one, the

    In order to facilitate migrating from the old package to the new one, the glossaries package13.1 provides the command: -

    \oldacronym  long⟩}{⟨key-val list⟩}
    -

    +

    This uses the same syntax as the glossary package’s method of defining acronyms. It is @@ -18304,10 +18351,10 @@ In addition, \oldacronym also defines the commands \⟨label⟩, which is equivalent to -label⟩, which is equivalent to \gls +{⟨label⟩}, and \gls\Gls to change the settings. -

    Recall that, in general, LAT

    Recall that, in general, LATEX ignores spaces following command names consisting of alphabetical characters. This is also true for \⟨xspace.13.2
    -

    +

    -

    The

    The glossaries package doesn’t load the xspace package since there are both advantages @@ -18375,14 +18422,14 @@ you can’t use the optional argument to insert text (you will have to expli \gls). -

    To illustrate this, suppose I define the acronym “abc” as follows: +

    To illustrate this, suppose I define the acronym “abc” as follows:

    \oldacronym{abc}{example acronym}{}
    -

    This will create the command

    This will create the command \abc and its starred version \abc*. Table 13.2 illustrates the @@ -18398,7 +18445,7 @@ optional argument from being recognised.

    -

    @@ -18464,11 +18511,11 @@ class="td11"> abc’s xyz
    -

    -

    +

    Top

    14. Unsetting and Resetting Entry Flags

    -

    When using the

    When using the \gls-like commands it is possible that you may want to use the value given by the text key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands: -

    \glsreset  \glsreset{⟨label⟩}
    -

    -

    +

    \glslocalreset  \glslocalreset{⟨label⟩}
    -

    +

    while the latter can be achieved by one of the following commands: -

    \glsunset  \glsunset{⟨label⟩}
    -

    -

    +

    \glslocalunset  \glslocalunset{⟨label⟩}
    -

    +

    You can also reset or unset all entries for a given glossary or list of glossaries using: -

    \glsresetall  \glsresetall[⟨glossary list⟩]
    -

    -

    +

    \glslocalresetall  \glslocalresetall[⟨glossary list⟩]
    -

    -

    +

    \glsunsetall  \glsunsetall[⟨glossary list⟩]
    -

    -

    +

    \glslocalunsetall  \glslocalunsetall[⟨glossary list⟩]
    -

    +

    where ⟨glossary list⟩ is a comma-separated list of glossary labels. If omitted, all defined glossaries are assumed (except for the ignored ones). For example, to reset all entries in the @@ -18556,10 +18603,10 @@ main glossary and the list of acronyms:

    \glsresetall[main,acronym]
    -

    -

    You can determine whether an entry’s

    +

    You can determine whether an entry’s first use flag is set using: -

    \ifglsused  true part⟩}{⟨false part⟩}
    -

    +

    where ⟨label⟩ is the label of the required entry. If the entry has been used, ⟨true part⟩ will be done, otherwise ⟨false part⟩ will be done. -

    Be careful when using

    Be careful when using \gls-like commands within an environment or command argument that gets processed multiple times as it can cause unwanted side-effects when the first use displayed text is different from subsequent use.
    -

    -

    For example, the

    +

    For example, the frame environment in beamerfirst use flag will be unset on the first overlay and subsequent overlays will use the non-first use form. -

    Consider the following example: +

    Consider the following example:

    @@ -18609,15 +18656,15 @@ will use the non-first use form.  
    \end{frame}  
    \end{document}
    -

    -

    On the first overlay,

    +

    On the first overlay, \gls{svm} produces “support vector machine (SVM)” and then unsets the first use flag. When the second overlay is processed, \gls{svm} now produces “SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and I can only offer two suggestions. -

    Firstly, unset all acronyms at the start of the document and explicitly use

    Firstly, unset all acronyms at the start of the document and explicitly use \acrfull when you want the full version to be displayed: @@ -18639,8 +18686,8 @@ you want the full version to be displayed:  
    \end{frame}  
    \end{document}

    -

    -

    Secondly, explicitly reset each acronym on first use: +

    +

    Secondly, explicitly reset each acronym on first use:

    @@ -18653,7 +18700,7 @@ you want the full version to be displayed:  
     \end{itemize}  
    \end{frame}
    -

    These are non-optimal, but the

    These are non-optimal, but the beamer class is too complex for me to provide a programmatic solution. Other potentially problematic environments are some @@ -18666,7 +18713,7 @@ class="cmss-10">tabular itself) that process the contents in order to work out the column widths and then reprocess the contents to do the actual typesetting. -

    The

    The amsmath environments, such as alignalignglossaries package now checks for this.

    -

    Top

    14.1 Counting the Number of Times an Entry has been Used (First Use Flag Unset)

    -

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. +

    As from version 4.14, it’s now possible to keep track of how many times an entry is used. That is, how many times the first use flag is unset. Note that the supplemental glossaries-extra package improves this function and also provides per-unit counting, which isn’t available with the glossaries package. -

    This function is disabled by default as it adds extra overhead to the document build time +

    This function is disabled by default as it adds extra overhead to the document build time and also switches \newglossaryentry (and therefore \newacronym) into a preamble-only command.
    -

    -

    To enable this function, use -

    +

    To enable this function, use +

    \glsenableentrycount  \glsenableentrycount
    -

    +

    before defining your entries. This adds two extra (internal) fields to entries: currcount and prevcount. -

    The

    The currcount field keeps track of how many times \glsunset is used within the document. A local unset (using \glsreset and \glslocalreset reset this field back to zero (where \glslocalreset performs a local change). -

    The

    The prevcount field stores the final value of the currcount field from the previous run. @@ -18730,8 +18777,8 @@ class="cmtt-10">.aux file at the beginning of the document environment. -

    You can access these fields using -

    You can access these fields using +

    \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:

    @@ -18774,7 +18821,7 @@ class="cmbx-10">.      
    Number of times apple has been used: \glsentrycurrcount{apple}.  
    \end{document}
    -

    On the first LAT

    On the first LATEX run, \glsentryprevcount{apple} produces 0. At the end of the document, \glsentryprevcount{apple} now produces� class="cmtt-10">currcount field for the apple entry at the end of the document on the previous run. -

    When you enable the entry count using

    When you enable the entry count using \glsenableentrycount, you also enable the following commands: -

    \cgls  label⟩}[⟨insert⟩]
    -

    +

    (no case-change, singular) -

    \cglspl  label⟩}[⟨insert⟩]
    -

    +

    (no case-change, plural) -

    \cGls  label⟩}[⟨insert⟩]
    -

    +

    (first letter uppercase, singular), and -

    \cGlspl  label⟩}[⟨insert⟩]
    -

    +

    (first letter uppercase, plural). These all have plus and starred variants like the analogous \gls, \glspl, \Gls and \Glspl commands. -

    If you don’t use

    If you don’t use \glsenableentrycount, these commands behave like \gls, \glspl, \cgls, \cglspl, \cGls or \cGlspl. -

    \cglsformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cgls and defaults to

    @@ -18924,7 +18971,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cglsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cglspl and defaults to

    @@ -18953,7 +19000,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGls and defaults to

    @@ -18984,7 +19031,7 @@ class="cmtt-10">}⟨insert⟩
    otherwise. -

    \cGlsplformat  label⟩}{⟨insert⟩}
    -

    +

    This command is used by \cGlspl and defaults to

    @@ -19013,7 +19060,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 @@ -19022,7 +19069,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): @@ -19033,11 +19080,11 @@ class="cmtt-10">makeglossaries, (pdf)latex. -

    Example 25 (Don’t index entries that are only used once) -

    In this example, the abbreviations that have only been used once (on the previous run) +

    In this example, the abbreviations that have only been used once (on the previous run) only have their long form shown with \cgls. @@ -19064,7 +19111,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 @@ -19085,15 +19132,15 @@ example

    \let\ac\cgls
    -

    +

    -

    -

    +

    Top

    15. Glossary Styles

    -

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of +

    Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical entries. There is therefore no single style that fits every type of glossary. The Defining your own glossary style

    The glossary style can be set using the

    The glossary style can be set using the style key in the optional argument to \printglossary2 and 3) or using the command: -

    \setglossarystyle  \setglossarystyle{⟨style-name⟩}
    -

    +

    (before the glossary is displayed). -

    Some of the predefined glossary styles may also be set using the

    Some of the predefined glossary styles may also be set using the style package option, it depends if the package in which they are defined is automatically loaded by the glossaries package. -

    You can use the lorum ipsum dummy entries provided in the accompanying +

    You can use the lorum ipsum dummy entries provided in the accompanying example-glossaries-*.tex files (described in §1.2 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, 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 the nogroupskip package option to prevent odd vertical gaps appearing.
    -

    -

    The group title is obtained using

    +

    The group title is obtained using \glsgetgrouptitle{⟨label⟩}, which is described in Defining your own glossary style

    @@ -19375,7 +19422,7 @@ class="td11">
    -

    The tabular-like styles that allow multi-line descriptions and page lists use the length +

    The tabular-like styles that allow multi-line descriptions and page lists use the length \glsdescwidth \newline instead of \\. -

    Note that if you use the

    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 +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 key in the optional argument to key in the optional argument to \printnoidxglossary + id="dx1-68028"> (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 @@ -19426,14 +19482,14 @@ 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-68030"> will not have an affect for this glossary, as \glsgroupskip is redefined by style=long. Likewise, \setglossarystyle will also override + id="dx1-68031"> will also override any previous style definitions, so, again @@ -19442,16 +19498,16 @@ 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-68033"> (described in the next section) or make the modifications after \setglossarystyle, + id="dx1-68034">, e.g.: @@ -19460,39 +19516,39 @@ 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-68035"> 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-68036"> 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-68039"> to suppress this full stop. This is the better option if you want to use the glossaries-extra package. + id="dx1-68040"> package.

    -

    Top

    15.1.1 List Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-list. Since they all use the nolistnostyles package options. +

    Note that, except for the listdotted style, these list styles are incompatible with +classicthesis.
    +

    list
    The list style uses the style uses the description environment. The entry name is placed in the + id="dx1-69009"> environment. The entry name is placed in the optional argument of the \item command (so it will usually appear in bold by + id="dx1-69011"> command (so it will usually appear in bold by default). The description follows, and then the associated number list for that + id="dx1-69012"> 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. -
    + id="dx1-69013">. +

    The closest matching non-list style is the index style. +

    listgroup
    The listgroup style is like style is like list but the glossary groups have headings obtained + id="dx1-69016"> but the glossary groups have headings obtained using \glsgetgrouptitle{⟨label⟩§15.2 Defining your own glossary style. + +
    listhypergroup
    The listhypergroup style is like style is like listgroup but has a navigation line + id="dx1-69018"> 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: @@ -19571,21 +19637,21 @@ class="cmtt-10">\glshypernavsep

    \renewcommand*{\glshypernavsep}{\space}
    -

    -

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional +

    +

    Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to \item instead of after it to prevent a spurious space at the start. This can + id="dx1-69020"> 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-69022"> instead.

    altlist
    The altlist style is like style is like list but the description starts on the line following the name. + id="dx1-69024"> 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-69025"> 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-69026"> style, the name associated with each child entry is ignored. -
    +

    The closest matching non-list style is the index 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-69029"> 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-69031"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-69032">, described above.
    listdotted
    This style uses the description + id="dx1-69033"> environment.15.2 + id="x1-69035f2"> 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-69036"> 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 index style with + + +

    +
    + \renewcommand{\glstreepredesc}{\dotfill} +  
    \renewcommand{\glstreechildpredesc}{\dotfill} +
    +

    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 nonumberlist + option.)

    sublistdotted
    This is a variation on the listdotted style designed for hierarchical glossaries. + id="dx1-69041"> style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in the same manner as listdotted.
    -

    + id="dx1-69042">. Unlike the listdotted style, this style is incompatible with + classicthesis. +

    -

    Top

    15.1.2 Longtable Styles

    - - -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-long. Since they all use the longborderlong but has horizontal and vertical lines around it. + +

    longheader
    long3colheaderborderlong3colheader but has horizontal and vertical lines around it. - -
    long4col
    \glsdescwidth\glspagelistwidth. The widths of the name and symbol columns are governed by the widest entry in the given column. + +
    altlong4colborder
    altlong4colheaderborderlong4colheaderborder but allows multi-line descriptions and page lists.
    -

    +

    -

    Top

    15.1.3 Longtable Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longragged. These styles are analogous to those defined in glossary-longragged -

    +
    \usepackage{glossaries}  
    \usepackage{glossary-longragged}
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the altlongragged4colheaderborderaltlongragged4colheader but has horizontal and vertical lines around it. -

    +

    -

    Top

    15.1.4 Longtable Styles (booktabs)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-longbooktabs. -

    Since these styles all use the

    Since these styles all use the longtable environment, they are governed by the same @@ -20093,16 +20193,16 @@ class="cmss-10">glossary-longbooktabs -

    +
    \usepackage{glossaries}  
    \usepackage{glossary-longbooktabs}
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the glossaries package has been loaded. -

    These styles are similar to the “header” styles in the

    These styles are similar to the “header” styles in the glossary-long and glossary-ragged\printglossary. (The nogroupskip package option is checked by these styles.) -

    Alternatively, you can restore the original

    Alternatively, you can restore the original longtable behaviour with: -

    \glsrestoreLToutput  \glsrestoreLToutput
    -

    +

    For more information about the patch, see the documented code (glossaries-code.pdf).

    @@ -20209,12 +20309,12 @@ class="cmss-10">altlongragged4colheader style but adds rules as above.
    -

    +

    -

    Top

    15.1.5 Supertabular Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-super. Since they all use the super4colheaderborder but allows multi-line descriptions and page lists. -

    +

    -

    Top

    15.1.6 Supertabular Styles (Ragged Right)

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-superragged. These styles are analogous to those defined in glossary-superragged -

    +
    \usepackage{glossaries}  
    \usepackage{glossary-superragged}
    -

    Note that you can’t set these styles using the

    Note that you can’t set these styles using the style package option since the styles aren’t defined until after the altsuperragged4colheaderborderaltsuperragged4colheader but has horizontal and vertical lines around it. -

    +

    -

    Top

    15.1.7 Tree-Like Styles

    -

    The styles described in this section are all defined in the package

    The styles described in this section are all defined in the package glossary-tree. These styles are designed for hierarchical glossaries but can also be used with glossaries that don’t have -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 nostyles package options. These styles -all format the entry name using: -

    package +options. +

    These styles all format the entry name using: +

    \glstreenamefmt  \glstreenamefmt{⟨name⟩}
    -

    +

    This defaults to \textbf{⟨name⟩\glstreenamefont may be counteracted by another font chan class="cmtt-10">\glsnamefont (or in \acronymfont). The tree-like styles that also display the header use -

    \glstreegroupheaderfmt  \glstreegroupheaderfmt{⟨text⟩}
    -

    +

    to format the heading. This defaults to \glstreenamefmt{⟨text⟩indexhypergroup), format the navigation line using -

    \glstreenavigationfmt  text⟩}
    -

    +

    which defaults to \glstreenamefmt{⟨text⟩listhypergroup, as that also includes \item. +

    With the exception of the alttree style (and those derived from it), the space before the +description for top-level entries is produced with +

    \glstreepredesc  \glstreepredesc
    +

    +This defaults to \space. +

    With the exception of the treenoname and alttree styles (and those derived from them), +the space before the description for child entries is produced with +

    \glstreechildpredesc  \glstreechildpredesc
    +

    +This defaults to \space. +

    Most of these styles are not designed for multi-paragraph descriptions. (The tree style +isn’t too bad for multi-paragraph top-level entry descriptions, or you can use the index style +with the adjustment shown below.)
    +

    index
    The index style is similar to the way indices are usually formatted in that it has + id="dx1-75017"> 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. -
    + id="dx1-75018">. +

    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 +

    \glstreesubsubitem  \glstreesubsubitem
    +

    +

    Note that the index style automatically sets + + +

    +
    + \let\item\glstreeitem +  
    \let\subitem\glstreesubitem +  
    \let\subsubitem\glstreesubsubitem +
    +

    at the start of the glossary for backward compatibility. +

    The index style isn’t suitable for multi-paragraph descriptions, but this limitation can be + overcome by redefining the above commands. For example: + + +

    +
    + \renewcommand{\glstreeitem}{% +  
     \parindent0pt\par\hangindent40pt +  
     \everypar{\parindent50pt\hangindent40pt}} +
    +

    +

    indexgroup
    The indexgroup style is similar to the style is similar to the index style except that each group - has a heading obtained using style except that each group has a + heading obtained using \glsgetgrouptitle{⟨label⟩}, which is described in - }, which is described in §15.2 Defining your own glossary style. +href="#sec:newglossarystyle">Defining + your own glossary style.
    indexhypergroup
    The indexhypergroup style is like style is like indexgroup but has a set of links - to the glossary groups. The navigation line is the same as that for 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.
    tree
    The The tree style is similar to the style is similar to the index style except that it can have arbitrary - levels. (Note that 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 more than three levels.) Each sub-level is indented by - 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 \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 style instead. (See below.) + id="dx1-75034"> + 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-75036"> 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 glossary groups. The navigation line is the same as that for 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.
    treenoname
    The treenoname style is like the style is like the tree style except that the name for each + id="dx1-75041"> 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 each group has a heading. - - + id="dx1-75043"> style except that + each group has a heading.
    treenonamehypergroup
    The treenonamehypergroup style is like style is like treenonamegroup but - has a set of links to the glossary groups. The navigation line is the same as that for + id="dx1-75045"> 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. + +
    alttree
    The alttree style is similar to the style is similar to the tree style except that the indentation for each level + id="dx1-75048"> 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-75052"> 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-75053"> 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 @@ -20883,40 +21064,40 @@ 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-75056"> 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-75058"> but has a set of links to the glossary groups. The navigation line is the same as that for listhypergroup, described + id="dx1-75059">, described above.
    -

    +

    -

    Top

    15.1.8 Multicols Style

    -

    The

    The glossary-mcols package provides tree-like styles that are in the multicols\glstreenavigationfmt are all used by the corresponding glossary-mcols styles. -

    Note that

    Note that glossary-mcols is not loaded by glossaries. If you want to use any of the multicol @@ -20963,29 +21144,29 @@ class="cmtt-10">\usepackage and set the required glossary style using \setglossarystyle.
    -

    -

    The default number of columns is 2, but can be changed by redefining -

    +

    The default number of columns is 2, but can be changed by redefining +

    \glsmcols  \glsmcols
    -

    +

    to the required number. For example, for a three column glossary:

    -
    +
    \usepackage{glossary-mcols}  
    \renewcommand*{\glsmcols}{3}  
    \setglossarystyle{mcolindex}
    -

    +

    -

    @@ -21111,7 +21292,7 @@ class="cmss-10">alttreehypergroup
    -

    The styles with a navigation line, such as

    The styles with a navigation line, such as mcoltreehypergroup, now have a variant (as from v4.22) with “hypergroup” replaced with “spannav” in the style name. The original @@ -21122,10 +21303,10 @@ class="cmss-10">multicols environment so that it spans across all the columns.

    -

    Top

    15.1.9 In-Line Style

    -

    This section covers the

    This section covers the glossary-inline package that supplies the inlinenumber list. -

    You will most likely need to redefine

    You will most likely need to redefine \glossarysection with this style. For example, suppose you are required to have your glossaries and list of acronyms in a footnote, you can @@ -21142,13 +21323,13 @@ do:

    -
    +
     \usepackage{glossary-inline}  
     \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }  
     \setglossarystyle{inline}
    -

    -

    Note that you need to include

    +

    Note that you need to include glossary-inline with \usepackage as it’s not automatically @@ -21157,55 +21338,55 @@ class="cmss-10">glossaries package and then set the style using \setglossarystyle.
    -

    -

    Where you need to include your glossaries as a footnote you can do: +

    +

    Where you need to include your glossaries as a footnote you can do:

    -
    +
    \footnote{\printglossaries}
    -

    -

    The

    +

    The inline style is governed by the following: -

    \glsinlineseparator  \glsinlineseparator
    -

    +

    This defaults to “; ” and is used between main (i.e. level 0) entries. -

    \glsinlinesubseparator  \glsinlinesubseparator
    -

    +

    This defaults to “, ” and is used between sub-entries. -

    \glsinlineparentchildseparator  \glsinlineparentchildseparator
    -

    +

    This defaults to “: ” and is used between a parent main entry and its first sub-entry. -

    \glspostinline  \glspostinline
    -

    +

    This defaults to “; ” and is used at the end of the glossary. -

    \glsinlinenameformat  label⟩}{⟨name⟩}
    -

    +

    This is used to format the entry name and defaults to \glstarget{⟨label⟩ -

    +
    \renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}}
    -

    Sub-entry names are formatted according to -

    Sub-entry names are formatted according to +

    \glsinlinesubnameformat  label⟩}{⟨name⟩}
    -

    +

    This defaults to \glstarget{⟨label⟩}{} so the sub-entry name is ignored. -

    If the description has been suppressed (according to

    If the description has been suppressed (according to \ifglsdescsuppressed) then -

    \glsinlineemptydescformat  }{⟨number list⟩}
    -

    +

    (which defaults to nothing) is used, otherwise the description is formatted according to -

    \glsinlinedescformat  }{⟨number list⟩}
    -

    +

    This defaults to just \space⟨description⟩ so the symbol and location list are ignored. If the @@ -21286,16 +21467,16 @@ description is missing (according to \ifglshasdesc), then \glsinlineemptydescformat is used instead. -

    For example, if you want a colon between the name and the description: +

    For example, if you want a colon between the name and the description:

    -
    +
    \renewcommand*{\glsinlinedescformat}[3]{: #1}
    -

    -

    The sub-entry description is formatted according to: -

    +

    The sub-entry description is formatted according to: +

    \glsinlinesubdescformat  number list⟩}
    -

    +

    This defaults to just ⟨description⟩. -

    +

    -

    Top

    15.2 Defining your own glossary style

    -

    If the predefined styles don’t fit your requirements, you can define your own style +

    If the predefined styles don’t fit your requirements, you can define your own style using: -

    \newglossarystyle  name⟩}{⟨definitions⟩}
    -

    +

    where ⟨name⟩ is the name of the new glossary style (to be used in \setglossarystyle). The second argument ⟨definitions⟩ needs to redefine all of the following: -

    theglossary  theglossary
    -

    +

    This environment defines how the main body of the glossary should be typeset. Note that this does not include the section heading, the glossary preamble (defined by \glossarypreambledescription environment. -

    \glossaryheader  \glossaryheader
    -

    +

    This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as \glossarypreamblelongheader glossary style redefines \glossaryheader to do a header row. -

    \glsgroupheading  \glsgroupheading{⟨label⟩}
    -

    +

    This macro indicates what to do at the start of each logical block within the main body of the glossary. If you use xindy

    Note that the argument to

    Note that the argument to \glsgroupheading is a label not the group title. The group title can be obtained via -

    \glsgetgrouptitle  \glsgetgrouptitle{⟨label⟩}
    -

    +

    This obtains the title as follows: if ⟨label⟩ consists of a single non-active character or ⟨label⟩ is @@ -21450,8 +21631,8 @@ to just ⟨label⟩. You can redefine \glsgetgrouptitle if this is unsuitable for your document. -

    A navigation hypertarget can be created using -

    A navigation hypertarget can be created using +

    \glsnavhypertarget  label⟩}{⟨text⟩}
    -

    +

    This typically requires \glossaryheader to be redefined to use -

    \glsnavigation  \glsnavigation
    -

    +

    which displays the navigation line. -

    For further details about

    For further details about \glsnavhypertarget, see the documented code (glossaries-code.pdf). -

    Most of the predefined glossary styles redefine

    Most of the predefined glossary styles redefine \glsgroupheading to simply ignore its argument. The listhypergroup\glsgroupheading as follows:

    -
    +
    \renewcommand*{\glsgroupheading}[1]{%  
    \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
    -

    See also

    See also \glsgroupskip below. (Note that command definitions within \newglossarystyle must use ##1 instead of #1 etc.) -

    \glsgroupskip  \glsgroupskip
    -

    +

    This macro determines what to do after one logical group but before the header for the next logical group. The list\indexspace, whereas the tabular-like styles redefine \glsgroupskip to produce a blank row. -

    As from version 3.03, the package option

    As from version 3.03, the package option nogroupskip can be used to suppress this default gap for the predefined styles. -

    \glossentry  label⟩}{⟨number list⟩}
    -

    +

    This macro indicates what to do for each top-level (level 0) glossary entry. The entry label is given by ⟨label⟩ and the associated §9 Using Glossary Terms Without Links for further details.) You can also use the following commands: -

    \glsentryitem  \glsentryitem{⟨label⟩}
    -

    +

    This macro will increment and display the associated counter for the main (level 0) entries if the entrycounter\glossentry before \glstarget. The format of the counter is controlled by the macro -

    \glsentrycounterlabel  \glsentrycounterlabel
    -

    -

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the +

    +

    Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to set the appropriate target. This is done using -

    \glstarget  label⟩}{⟨text⟩}
    -

    +

    where ⟨label⟩ is the entry’s label. Note that you don’t need to worry about whether the hyperref\glstarget won’t create a target if \hypertarget hasn’t been defined. -

    For example, the

    For example, the list style defines \glossentry as follows:

    -
    +
      \renewcommand*{\glossentry}[2]{%  
        \item[\glsentryitem{##1}%  
              \glstarget{##1}{\glossentryname{##1}}]  
           \glossentrydesc{##1}\glspostdescription\space ##2}
    -

    -

    Note also that ⟨

    +

    Note also that ⟨number list⟩ will always be of the form -

    \glossaryentrynumbers{{⟨number(s)⟩}}
    -

    +

    where ⟨number(s)⟩ may contain \delimN (to delimit individual numbers) and/or - (to delimit individual numbers) and/or \delimR (to indicate a range of numbers). There may be multiple occurrences of - (to +indicate a range of numbers). There may be multiple occurrences of \setentrycounter +[⟨Hprefix⟩]{⟨}⟨format cmd⟩{⟨number(s)⟩}, but note that the -entire number list is enclosed within the argument of }, but note that the entire number list is +enclosed within the argument of \glossaryentrynumbers. 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 . 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 suppressing the number list altogether. (In fact, the nonumberlist package option. -

    \subglossentry  label⟩}{⟨number list⟩}
    -

    +

    This is used to display sub-entries. The first argument, ⟨level⟩, indicates the sub-entry level. This must be an integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for \glossentry described above. -

    \glssubentryitem  \glssubentryitem{⟨label⟩}
    -

    +

    This macro will increment and display the associated counter for the level 1 entries if the subentrycounter\subglossentry before \glstarget. The format of the counter is controlled by the macro -

    \glssubentrycounterlabel  \glssubentrycounterlabel
    -

    -

    Note that

    +

    Note that \printglossary (which \printglossaries calls) sets -

    \currentglossary  \currentglossary
    -

    +

    to the current glossary label, so it’s possible to create a glossary style that varies according to the glossary type. -

    For further details of these commands, see “Displaying the glossary” in the documented +

    For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf). -

    Example 26 (Creating a completely new style) -

    If you want a completely new style, you will need to redefine all of the commands and the +

    If you want a completely new style, you will need to redefine all of the commands and the environment listed above. -

    For example, suppose you want each entry to start with a bullet point. This +

    For example, suppose you want each entry to start with a bullet point. This means that the glossary should be placed in the itemize -

    +
     \newglossarystyle{mylist}{%  
     % put the glossary in the itemize environment:  
     \renewenvironment{theglossary}% @@ -21796,7 +21977,7 @@ follows:  
       \glossentry{##2}{##3}}%  
     }
    -

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the +

    Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top level entries. It also hasn’t used \glsentryitem or counterwithinsubentrycounter package options. -

    Variations:

    +

    Variations:

    • You might want the entry name to be capitalised, in which case use §16 href="#sec:utilities">Utilities): -
      +
       \renewcommand*{\glossentry}[2]{%  
       \item % bullet point  
       \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -21842,20 +22023,20 @@ href="#sec:utilities">Utilities):  
       \space [##2]% the number list in square brackets  
       }%
      -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 27 (Creating a new glossary style based on an existing style) -

    If you want to define a new style that is a slightly modified version of an existing style, +

    If you want to define a new style that is a slightly modified version of an existing style, you can use \setglossarystyle within the second argument of -

    +
    \newglossarystyle{mylist}{%  
    \setglossarystyle{list}% base this style on the list style  
    \renewcommand{\glsgroupskip}{}% make nothing happen  
                                  % between groups  
    }
    -

    (In this case, you can actually achieve the same effect using the

    (In this case, you can actually achieve the same effect using the list style in combination with the package option nogroupskip.)

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    Example 28 (Example: creating a glossary style that uses the user1user6 keys) -

    Suppose each entry not only has an associated symbol, but also units (stored in

    Suppose each entry not only has an associated symbol, but also units (stored in user1) and dimension (stored in longtable -

    -

    -

    +

    Top

    16. Utilities

    -

    This section describes some utility commands. Additional commands can be found in the +

    This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf).

    -

    Top

    16.1 Loops

    -

    Some of the commands described here take a comma-separated list as an argument. As with +

    Some of the commands described here take a comma-separated list as an argument. As with LATEX’s \@for command, make sure your list doesn’t have any unwanted spaces in it as @@ -21982,8 +22163,8 @@ href="http://www.dickimaw-books.com/latex/admin/html/docsvlist.shtml#spacesinlis class="cmsy-10">§2.7.2 of “LATEX for Administrative Work”.)
    -

    -

    +

    \forallglossaries  cs⟩}{⟨body⟩}
    -

    +

    This iterates through ⟨glossary list⟩, a comma-separated list of glossary labels (as supplied when the glossary was defined). At each iteration ⟨body⟩ is performed. If ⟨glossary list⟩ is omitted, the default is to iterate over all glossaries (except the ignored ones). -

    \forallacronyms  cs⟩}{⟨body⟩}
    -

    +

    This is like \forallglossaries but only iterates over the lists of acronyms (that have previously been declared using acronymlists\forallglossaries. -

    \forglsentries  cs⟩}{⟨body⟩}
    -

    +

    This iterates through all entries in the glossary given by ⟨glossary label⟩. At each iteration ⟨cs⟩ @@ -22046,7 +22227,7 @@ class="cmti-10">glossary label⟩ is omitted, \glsdefaulttype (usually the main glossary) is used. -

    \forallglsentries  cs⟩}{⟨body⟩}
    -

    +

    This is like \forglsentries but for each glossary in ⟨glossary list⟩ (a comma-separated list of @@ -22072,12 +22253,12 @@ class="cmti-10">cs⟩} within ⟨body⟩.) -

    +

    -

    Top

    16.2 Conditionals

    -

    \ifglossaryexists  true part⟩⟨false part⟩
    -

    +

    This checks if the glossary given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglsentryexists  \ifglsentryexists⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ exists. If it does ⟨true part⟩ is performed, @@ -22119,7 +22300,7 @@ href="#sec:techissues">§4.10.1 Technical Issues for further details.) -

    \glsdoifexists  label⟩}{⟨code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists. If it doesn’t exist, an error is generated. (This command uses \ifglsentryexists.) -

    \glsdoifnoexists  label⟩}{⟨code⟩}
    -

    +

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -

    \glsdoifexistsorwarn  label⟩}{⟨code⟩}
    -

    +

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -

    \glsdoifexistsordo  code⟩}{⟨else code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ exists otherwise generate an error and do ⟨else code⟩. -

    \glsdoifnoexistsordo  code⟩}{⟨else code⟩}
    -

    +

    Does ⟨code⟩ if the entry given by ⟨label⟩ doesn’t exist otherwise generate an error and do ⟨else code⟩. -

    \ifglsused  \ifglsused⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    See §14 Unsetting and Resetting Entry Flags. -

    \ifglshaschildren  \ifglshaschildren⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has any sub-entries. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshasparent  \ifglshasparent⟨label⟩⟨true part⟩⟨false part⟩
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has a parent entry. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshassymbol  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the symbolsymboltrue part⟩ is performed, otherwise ⟨false part⟩. -

    \ifglshaslong  false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the longfalse part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -

    \ifglshasshort  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the glossary entry given by ⟨label⟩ has had the shortfalse part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -

    \ifglshasdesc  true part⟩}{⟨false part⟩}
    -

    +

    This checks if the description field is non-empty for the entry given by ⟨label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. Compare with: -

    \ifglsdescsuppressed  }{⟨false part⟩}
    -

    +

    This checks if the description field has been set to just true part⟩ is performed, otherwise ⟨false part⟩. There is no check for the existence of ⟨label⟩. -

    For all other fields you can use: -

    For all other fields you can use: +

    \ifglshasfield  }{⟨false part⟩}
    -

    +

    This tests the value of the field given by ⟨field⟩ for the entry identified by ⟨label⟩. If the value is @@ -22375,14 +22556,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 @@ -22390,16 +22571,16 @@ example:

    -
    +
    \ifglshasfield{useri}{sample}{, \glscurrentfieldvalue}{}
    -

    will insert a comma, space and the field value if the

    will insert a comma, space and the field value if the user1 key has been set for the entry whose label is sample. -

    You can test if the value of the field is equal to a given string using: -

    You can test if the value of the field is equal to a given string using: +

    \ifglsfieldeq  }{⟨false⟩}
    -

    +

    In this case the ⟨field⟩ must be the field name not the key (see table 4.1). If the @@ -22427,12 +22608,12 @@ class="cmtt-10">\ifcsstring to perform the comparison. The string is not expanded during the test. -

    The result may vary depending on whether or not expansion is on for the given field +

    The result may vary depending on whether or not expansion is on for the given field (when the entry was defined). For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -22445,25 +22626,25 @@ class="cmti-10">test.  
    \ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  
    \end{document}
    -

    This will produce “TRUE” in both cases since expansion is on, so

    This will produce “TRUE” in both cases since expansion is on, so \foo was expanded to “FOO” when sample2 was defined. If the tests are changed to:

    -
    +
    \ifglsfieldeq{sample1}{useri}{\foo}{TRUE}{FALSE}.  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.
    -

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the +

    then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the user1 key:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -22477,14 +22658,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} @@ -22498,14 +22679,14 @@ class="cmtt-10">\foo” with “FOO”).  
    \ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    This now produces “FALSE” for the first case (comparing “FOO” with “

    This now produces “FALSE” for the first case (comparing “FOO” with “\foo”) and “TRUE” for the second case (comparing “\foo” with “\foo”). -

    You can test if the value of a field is equal to the replacement text of a command +

    You can test if the value of a field is equal to the replacement text of a command using: -

    \ifglsfielddefeq  }{⟨false⟩}
    -

    +

    This internally uses etoolbox’s \ifdefstrequal command to perform the comparison. The argument ⟨command⟩ must be a macro. -

    For example: +

    For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \newcommand*{\foo}{FOO} @@ -22546,14 +22727,14 @@ class="cmti-10">command⟩ must be a macro.  
    \ifglsfielddefeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  
    \end{document}
    -

    Here, the first case produces “TRUE” since the value of the

    Here, the first case produces “TRUE” since the value of the useri field (“FOO”) is the same as the replacement text (definition) of \foo (“FOO”). We have the result “FOO” is equal to “FOO”. -

    The second case produces “FALSE” since the value of the

    The second case produces “FALSE” since the value of the useri field (“\foo”) is not the same as the replacement text (definition) of useri field. We have the result “\foo” is not equal to “FOO”. -

    If we add: +

    If we add:

    -
    +
    \newcommand{\FOO}{\foo}  
    \ifglsfielddefeq{sample2}{useri}{\FOO}{TRUE}{FALSE}.
    -

    we now get “TRUE” since the value of the

    we now get “TRUE” since the value of the useri field (“\foo”) is the same as the replacement text (definition) of \foo”). We have the result “\foo” is equal to “\foo”. -

    There is a similar command that requires the control sequence name (without the leading +

    There is a similar command that requires the control sequence name (without the leading backslash) instead of the actual control sequence: -

    \ifglsfieldcseq  }{⟨false⟩}
    -

    +

    This internally uses etoolbox’s \ifcsstrequal command instead of \ifdefstrequal. -

    +

    -

    Top

    16.3 Fetching and Updating the Value of a Field

    -

    You can fetch the value of a given field and store it in a control sequence using: -

    You can fetch the value of a given field and store it in a control sequence using: +

    \glsfieldfetch  field⟩}{⟨cs⟩}
    -

    +

    where ⟨label⟩ is the label identifying the glossary entry, ⟨field⟩ is the field label (see @@ -22634,7 +22815,7 @@ that field in the argument of \newglossaryentry (or the optional argument of \newacronym). -

    You can change the value of a given field using one of the following commands. Note that +

    You can change the value of a given field using one of the following commands. Note that these commands only change the value of the given field. They have no affect on any related field. For example, if you change the value of the textplural, first or any other related key. -

    In all the four related commands below, ⟨

    In all the four related commands below, ⟨label⟩ and ⟨field⟩ are as above and ⟨definition⟩ is the new value of the field. -

    \glsfielddef  field⟩}{⟨definition⟩}
    -

    +

    This uses \def to change the value of the field (so it will be localised by any grouping). -

    \glsfieldedef  field⟩}{⟨definition⟩}
    -

    +

    This uses \edef to change the value of the field (so it will be localised by any grouping). Any fragile commands contained in the ⟨definition⟩ must be protected. -

    \glsfieldgdef  field⟩}{⟨definition⟩}
    -

    +

    This uses \gdef to change the value of the field. -

    \glsfieldxdef  field⟩}{⟨definition⟩}
    -

    +

    This uses \xdef to change the value of the field. Any fragile commands contained in the ⟨definition⟩ must be protected.

    -

    -

    +

    Top

    17. Prefixes or Determiners

    -

    The

    The glossaries-prefix package that comes with the glossaries package provides additional @@ -22729,7 +22910,7 @@ keys that can be used as prefixes. For example, if you want to specify determine class="cmss-10">glossaries-prefix package automatically loads the glossaries package and has the same package options. -

    The extra keys for

    The extra keys for \newglossaryentry are as follows:

    @@ -22768,20 +22949,20 @@ class="cmss-10">prefixplural key.
    -

    Example 29 (Defining Determiners) -

    Here’s the start of my example document: +

    Here’s the start of my example document:

    -
    +
    documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage[toc,acronym]{glossaries-prefix}
    -

    Note that I’ve simply replaced

    Note that I’ve simply replaced glossaries from previous sample documents with glossaries-prefix. Now for a sample definition17.1

    -
    +
    \newglossaryentry{sample}{name={sample},%  
      description={an example},%  
      prefix={a~},%  
      prefixplural={the\space}%  
    }
    -

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility +

    Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility of prefixes that shouldn’t have a space, such as:

    -
    +
    \newglossaryentry{oeil}{name={oeil},  
      plural={yeux},  
      description={eye},  
      prefix={l’},  
      prefixplural={les\space}}
    -

    Where a space is required at the end of the prefix, you must use a spacing command, such as +

    Where a space is required at the end of the prefix, you must use a spacing command, such as \space, \␣ (backslash space) or ~ due to the automatic spacing trimming per ⟨key⟩=⟨value⟩ options. -

    The prefixes can also be used with acronyms. For example: +

    The prefixes can also be used with acronyms. For example:

    -
    +
    \newacronym  
     [%  
       prefix={an\space},prefixfirst={a~}%  
     ]{svm}{SVM}{support vector machine}
    -

    +

    -

    -

    ____________________________

    -

    The

    +

    ____________________________

    +

    The glossaries-prefix package provides convenient commands to use these prefixes with commands such as §6 Links to Glossary Entries for further details.) -

    \pgls  label⟩}[⟨insert⟩]
    -

    +

    This is inserts the value of the prefix key (or prefixfirst key, on first use) in front of +href="#glo:firstuse">first use) in front of \gls \gls[⟨[⟨options⟩]{⟨label⟩}[⟨insert⟩]. -

    \Pgls  label⟩}[⟨insert⟩]
    -

    +

    If the prefix key (or prefixfirst, on first use) has been set, this displays the value of that key -with the first letter converted to upper case followed by , 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⟩]{⟨label⟩}[⟨} +[⟨insert⟩]. If that -key hasn’t been set, this is equivalent to ]. If that key hasn’t been set, this is equivalent to \Gls[⟨options⟩]{⟨label⟩}[⟨} +[⟨insert⟩]. -

    \PGLS  label⟩}[⟨insert⟩]
    -

    +

    As \pgls but converts the prefix to upper case and uses \GLS instead of \gls. -

    \pglspl  label⟩}[⟨insert⟩]
    -

    +

    This is inserts the value of the prefixplural key (or label⟩}[⟨insert⟩]. -

    \Pglspl  label⟩}[⟨insert⟩]
    -

    +

    If the prefixplural key (or prefixfirstplural, on first use) has been set, this displays -the value of that key with the first letter converted to upper case followed by -, 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⟩]{⟨label⟩}[⟨insert⟩]. If that key hasn’t been set, this is equivalent to +class="cmtt-10">} [⟨insert⟩]. If that key hasn’t been set, this is equivalent to \Glspl[⟨options⟩]{⟨label⟩}[⟨} +[⟨insert⟩]. -

    \PGLSpl  label⟩}[⟨insert⟩]
    -

    +

    As \pglspl but converts the prefix to upper case and uses \GLSpl\glspl. -

    Example 30 (Using Prefixes) -

    Continuing from Example 

    Continuing from Example 29, now that I’ve defined my entries, I can use them in the text via the above commands:

    -
    +
    First use: \pgls{svm}. Next use: \pgls{svm}.  
    Singular: \pgls{sample}, \pgls{oeil}.  
    Plural: \pglspl{sample}, \pglspl{oeil}.
    -

    which produces: +

    which produces:

    -

    First use: a support vector machine (SVM). Next use: an SVM. Singular: +

    First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. Plural: the samples, les yeux.

    -

    For a complete document, see

    For a complete document, see sample-prefix.tex.

    -

    -

    ____________________________

    -

    This package also provides the commands described below, none of which perform any +

    +

    ____________________________

    +

    This package also provides the commands described below, none of which perform any check to determine the entry’s existence. -

    \ifglshasprefix  true part⟩}{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefix key. -

    This package also provides the following commands: -

    This package also provides the following commands: +

    \ifglshasprefixplural  }{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixplural key. -

    \ifglshasprefixfirst  }{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirst key. -

    \ifglshasprefixfirstplural  -

    \ifglshasprefixfirstplural{⟨label⟩}{⟨true part⟩}{⟨false part⟩}
    -

    +

    Does ⟨true part⟩ if the entry identified by ⟨label⟩ has a non-empty value for the prefixfirstplural key. -

    \glsentryprefix  \glsentryprefix{⟨label⟩}
    -

    +

    Displays the value of the prefix key for the entry given by ⟨label⟩. -

    \glsentryprefixfirst  \glsentryprefixfirst{⟨label⟩}
    -

    +

    Displays the value of the prefixfirst key for the entry given by ⟨label⟩. -

    \glsentryprefixplural  \glsentryprefixplural{⟨label⟩}
    -

    +

    Displays the value of the prefixplural key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    \glsentryprefixfirstplural  -

    \glsentryprefixfirstplural{⟨label⟩}
    -

    +

    Displays the value of the prefixfirstplural key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -

    There are also variants that convert the first letter to upper +

    There are also variants that convert the first letter to upper case17.2: -

    \Glsentryprefix  \Glsentryprefix{⟨label⟩}
    -

    -

    +

    \Glsentryprefixfirst  \Glsentryprefixfirst{⟨label⟩}
    -

    -

    +

    \Glsentryprefixplural  \Glsentryprefixplural{⟨label⟩}
    -

    -

    +

    \Glsentryprefixfirstplural  -

    \Glsentryprefixfirstplural{⟨label⟩}
    -

    -

    As with analogous commands such as

    +

    As with analogous commands such as \Glsentrytext, these commands aren’t expandable so can’t be used in PDF bookmarks.
    -

    +

    -

    Example 31 (Adding Determiner to Glossary Style) -

    You can use the above commands to define a new glossary style that uses the determiner. +

    You can use the above commands to define a new glossary style that uses the determiner. For example, the following style is a slight modification of the list style that inserts the prefix @@ -23222,7 +23409,7 @@ before the name:

    -
    +
    \newglossarystyle{plist}{%  
      \setglossarystyle{list}%  
      \renewcommand*{\glossentry}[2]{% @@ -23232,18 +23419,18 @@ before the name:  
           \glossentrydesc{##1}\glspostdescription\space ##2}%  
    }
    -

    +

    -

    -

    ____________________________

    +

    +

    ____________________________

    -

    -

    +

    Top

    18. Accessibility Support

    -

    Limited accessibility support is provided by the accompanying

    Limited accessibility support is provided by the accompanying glossaries-accsupp package, but note that this package is experimental and it requires the shortplural\newacronym). -

    For example: +

    For example:

    -
    +
    \newglossaryentry{tex}{name={\TeX},description={Document  
    preparation language},access={TeX}}
    -

    Now

    Now \gls{tex} will be equivalent to

    -
    +
    \BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{}
    -

    The sample file

    The sample file sampleaccsupp.tex illustrates the glossaries-accsupp package. -

    See the documented code (

    See the documented code (glossaries-code.pdf) for further details. I recommend that you also read the accsuppaccsupp -

    -

    +

    Top

    19. Troubleshooting

    -

    The

    The glossaries package comes with some minimal example files, minimalgls.tex, 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

    Index + Symbols
    \@gls@codepage  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:
         39, 40, 41, 42
    + +     long-sc-short-desc  43
    - -     long-short  44, 70
    \ACRshort  71
    \Acrshort  72
    \acrshort  73
    \ACRshortpl  74
    \Acrshortpl  75
    \acrshortpl  76
    \altnewglossary  124
    class="cmtt-10">\cglsplformat  125
    + + +classicthesis package  126, 127, 128, 129, 130
    \currentglossary  126
    - - +class="cmti-10">131

    D datatool package  127, 128, 129, 130, 131
    +href="glossaries-user.html#dx1-9" >132, 133, 134, 135, 136
    datatool-base package  132
    +href="glossaries-user.html#dx1-8" >137
    \DeclareAcronymList  133
    +class="cmti-10">138
    \defglsentryfmt  134
    +class="cmti-10">139
    \DefineAcronymSynonyms  135
    +class="cmti-10">140
    doc package  136, 137, 138
    +href="glossaries-user.html#dx1-14" >141, 142, 143

    E encap  139
    +href="glossaries-user.html#dx1-43006" >144
    entry location  140
    +class="cmbx-10">145
    environments:
         theglossary  141
    +class="cmti-10">146
    etex package  142
    +href="glossaries-user.html#dx1-17033" >147
    etoolbox package  143, 144, 145, 146, 147, 148
    +href="glossaries-user.html#dx1-4" >148, 149, 150, 151, 152, 153
    Extended Latin Alphabet  149
    +class="cmbx-10">154
    extended Latin character  150, 155, 151, 152, 153, 154, 155, 156
    +class="cmbx-10">156, 157, 158, 159, 160, 161

    F file types
         .alg  157
    +href="glossaries-user.html#dx1-10069" >162
        .aux  158, 159, 160
    +href="glossaries-user.html#dx1-11002" >163, 164, 165
        .glg  161, 162, 163
    +href="glossaries-user.html#dx1-10068" >166, 167, 168
        .glg2  164
    +href="glossaries-user.html#dx1-18" >169
        .glo  165, 166, 167
    +href="glossaries-user.html#dx1-11021" >170, 171, 172
        .gls  168, 169
    +href="glossaries-user.html#dx1-13018" >173, 174
        .glsdefs  170, 171
    +href="glossaries-user.html#dx1-41013" >175, 176
        .ist  172, 173, 174, 175, 176, 177
    +href="glossaries-user.html#dx1-14005" >177, 178, 179, 180, 181, 182
        .tex  178, 179
    +href="glossaries-user.html#dx1-13011" >183, 184
        .xdy  180, 181, 182, 183, 184, 185, 186, 187
    +href="glossaries-user.html#dx1-13013" >185, 186, 187, 188, 189, 190, 191, 192
        glo2  188
    +href="glossaries-user.html#dx1-17" >193
        gls2  189
    +href="glossaries-user.html#dx1-16" >194
    first use  190
    +href="glossaries-user.html#dx1-3009" >195
        flag  191
    +href="glossaries-user.html#dx1-3017" >196
        text  192
    +href="glossaries-user.html#dx1-3018" >197
    \firstacronymfont  193
    +class="cmti-10">198
    flowfram package  194
    +href="glossaries-user.html#dx1-73011" >199
    fmtcount package  195
    +href="glossaries-user.html#dx1-56036" >200
    fontspec package  196
    +href="glossaries-user.html#dx1-28139" >201
    \forallacronyms  197
    +class="cmti-10">202
    + + \forallglossaries  198
    +class="cmti-10">203
    \forallglsentries  199
    - - +class="cmti-10">204
    \forglsentries  200
    +class="cmti-10">205

    G \Genacrfullformat  201
    +class="cmti-10">206
    \genacrfullformat  202
    +class="cmti-10">207
    \GenericAcronymFields  203
    +class="cmti-10">208
    \Genplacrfullformat  204
    +class="cmti-10">209
    \genplacrfullformat  205
    +class="cmti-10">210
    glossaries package  206, 207, 208, 209, 210
    +href="glossaries-user.html#dx1-6001" >211, 212, 213, 214, 215
    glossaries-accsupp package  211, 212, 213, 214, 215
    +href="glossaries-user.html#dx1-5108" >216, 217, 218, 219, 220
    glossaries-babel package  216, 217
    +href="glossaries-user.html#dx1-17049" >221, 222
    glossaries-extra package  218, 219, 220
    +href="glossaries-user.html#dx1-52006" >223, 224, 225, 226, 227, 228
    glossaries-polyglossia package  221
    +href="glossaries-user.html#dx1-17051" >229
    glossaries-prefix package  222, 223, 224, 225, 226
    +href="glossaries-user.html#dx1-5106" >230, 231, 232, 233, 234
    glossary counters:
         glossaryentry  227
    +class="cmti-10">235
        glossarysubentry  228
    +class="cmti-10">236
    glossary package  229, 230, 231, 232, 233
    +href="glossaries-user.html#dx1-11" >237, 238, 239, 240, 241
    glossary styles:
         altlist  234, 235, 236, 237, 238
    +href="glossaries-user.html#dx1-61047" >242, 243, 244, 245, 246
        altlistgroup  239, 240
    +href="glossaries-user.html#dx1-69028" >247, 248
        altlisthypergroup  241
    +href="glossaries-user.html#dx1-69030" >249
        altlong4col  242, 243, 244
    +href="glossaries-user.html#dx1-68022" >250, 251, 252
        altlong4col-booktabs  245
    +href="glossaries-user.html#dx1-72031" >253
        altlong4colborder  246
    +href="glossaries-user.html#dx1-70043" >254
        altlong4colheader  247, 248
    +href="glossaries-user.html#dx1-70045" >255, 256
        altlong4colheaderborder  249
    +href="glossaries-user.html#dx1-70047" >257
        altlongragged4col  250, 251, 252
    +href="glossaries-user.html#dx1-71030" >258, 259, 260
        altlongragged4col-booktabs  253
    +href="glossaries-user.html#dx1-72037" >261
        altlongragged4colborder  254
    +href="glossaries-user.html#dx1-71034" >262
        altlongragged4colheader  255, 256, 257
    +href="glossaries-user.html#dx1-71036" >263, 264, 265
        altlongragged4colheaderborder  258
    +href="glossaries-user.html#dx1-71038" >266
        altsuper4col  259, 260, 261
    +href="glossaries-user.html#dx1-68023" >267, 268, 269
        altsuper4colborder  262
    +href="glossaries-user.html#dx1-73048" >270
        altsuper4colheader  263
    +href="glossaries-user.html#dx1-73050" >271
        altsuper4colheaderborder  264
    +href="glossaries-user.html#dx1-73052" >272
        altsuperragged4col  265, 266, 267
    +href="glossaries-user.html#dx1-74032" >273, 274, 275
        altsuperragged4colborder  268
    +href="glossaries-user.html#dx1-74034" >276
        altsuperragged4colheader  269, 270
    +href="glossaries-user.html#dx1-74036" >277, 278
        altsuperragged4colheaderborder  271
    +href="glossaries-user.html#dx1-74038" >279
        alttree  272, 273, 274, 275, 276
    +href="glossaries-user.html#dx1-68026" >280, 281, 282, 283, 284, 285, 286, 287
        alttreegroup  277, 278, 279
    +href="glossaries-user.html#dx1-75055" >288, 289, 290
        alttreehypergroup  280, 281
    +href="glossaries-user.html#dx1-75057" >291, 292
    + +     index  282, 283, 284, 285, 286
    +href="glossaries-user.html#dx1-19050" >293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304
        indexgroup  287, 288, 289
    - - +href="glossaries-user.html#dx1-75024" >305, 306, 307
        indexhypergroup  290, 291, 292
    +href="glossaries-user.html#dx1-75007" >308, 309, 310
        inline  293, 294, 295
    +href="glossaries-user.html#dx1-5062" >311, 312, 313
        list  296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308
    +href="glossaries-user.html#dx1-19043" >314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326
        listdotted  309, 310, 311
    +href="glossaries-user.html#dx1-68036" >327, 328, 329, 330, 331
        listgroup  312, 313, 314, 315
    +href="glossaries-user.html#dx1-20020" >332, 333, 334, 335
        listhypergroup  316, 317, 318, 319, 320, 321, 322, 323
    +href="glossaries-user.html#dx1-69017" >336, 337, 338, 339, 340, 341, 342, 343
        long  324, 325, 326, 327, 328
    +href="glossaries-user.html#dx1-68025" >344, 345, 346, 347, 348, 349
        long-booktabs  329, 330
    +href="glossaries-user.html#dx1-72024" >350, 351
        long3col  331, 332, 333, 334, 335
    +href="glossaries-user.html#dx1-68009" >352, 353, 354, 355, 356
        long3col-booktabs  336
    +href="glossaries-user.html#dx1-72026" >357
        long3colborder  337, 338
    +href="glossaries-user.html#dx1-68011" >358, 359
        long3colheader  339, 340, 341, 342
    +href="glossaries-user.html#dx1-68010" >360, 361, 362, 363
        long3colheaderborder  343, 344
    +href="glossaries-user.html#dx1-68012" >364, 365
        long4col  345, 346, 347, 348, 349
    +href="glossaries-user.html#dx1-68020" >366, 367, 368, 369, 370
        long4col-booktabs  350
    +href="glossaries-user.html#dx1-72029" >371
        long4colborder  351, 352
    +href="glossaries-user.html#dx1-70033" >372, 373
        long4colheader  353, 354, 355, 356
    +href="glossaries-user.html#dx1-70035" >374, 375, 376, 377
        long4colheaderborder  357, 358
    +href="glossaries-user.html#dx1-70037" >378, 379
        longborder  359
    +href="glossaries-user.html#dx1-70013" >380
        longheader  360, 361, 362, 363
    +href="glossaries-user.html#dx1-70015" >381, 382, 383, 384
        longheaderborder  364, 365
    +href="glossaries-user.html#dx1-70017" >385, 386
        longragged  366, 367, 368, 369
    +href="glossaries-user.html#dx1-71010" >387, 388, 389, 390
        longragged-booktabs  370
    +href="glossaries-user.html#dx1-72033" >391
        longragged3col  371, 372, 373, 374
    +href="glossaries-user.html#dx1-71019" >392, 393, 394, 395
        longragged3col-booktabs  375
    +href="glossaries-user.html#dx1-72035" >396
        longragged3colborder  376
    +href="glossaries-user.html#dx1-71024" >397
        longragged3colheader  377, 378, 379
    +href="glossaries-user.html#dx1-71026" >398, 399, 400
        longragged3colheaderborder  380
    +href="glossaries-user.html#dx1-71028" >401
        longraggedborder  381
    +href="glossaries-user.html#dx1-71013" >402
        longraggedheader  382, 383, 384
    +href="glossaries-user.html#dx1-71015" >403, 404, 405
        longraggedheaderborder  385
    +href="glossaries-user.html#dx1-71017" >406
        mcolalttree  386
    +href="glossaries-user.html#dx1-76039" >407
        mcolalttreegroup  387
    +href="glossaries-user.html#dx1-76041" >408
        mcolalttreehypergroup  388
    +href="glossaries-user.html#dx1-76043" >409
        mcolalttreespannav  389
    +href="glossaries-user.html#dx1-76044" >410
        mcolindex  390, 391
    +href="glossaries-user.html#dx1-76005" >411, 412
        mcolindexgroup  392
    +href="glossaries-user.html#dx1-76020" >413
        mcolindexhypergroup  393
    +href="glossaries-user.html#dx1-76022" >414
        mcolindexspannav  394
    +href="glossaries-user.html#dx1-76023" >415
        mcoltree  395
    +href="glossaries-user.html#dx1-76025" >416
        mcoltreegroup  396
    +href="glossaries-user.html#dx1-76027" >417
        mcoltreehypergroup  397, 398
    +href="glossaries-user.html#dx1-76029" >418, 419
        mcoltreenoname  399
    +href="glossaries-user.html#dx1-76032" >420
        mcoltreenonamegroup  400
    +href="glossaries-user.html#dx1-76034" >421
    + +     mcoltreenonamehypergroup  401
    +href="glossaries-user.html#dx1-76036" >422
        mcoltreenonamespannav  402
    - - +href="glossaries-user.html#dx1-76037" >423
        mcoltreespannav  403
    +href="glossaries-user.html#dx1-76030" >424
        super  404, 405, 406, 407
    +href="glossaries-user.html#dx1-73012" >425, 426, 427, 428
        super3col  408, 409, 410, 411
    +href="glossaries-user.html#dx1-73024" >429, 430, 431, 432
        super3colborder  412
    +href="glossaries-user.html#dx1-73029" >433
        super3colheader  413, 414
    +href="glossaries-user.html#dx1-73031" >434, 435
        super3colheaderborder  415
    +href="glossaries-user.html#dx1-73033" >436
        super4col  416, 417, 418, 419, 420
    +href="glossaries-user.html#dx1-68021" >437, 438, 439, 440, 441
        super4colborder  421, 422
    +href="glossaries-user.html#dx1-73038" >442, 443
        super4colheader  423, 424, 425
    +href="glossaries-user.html#dx1-73040" >444, 445, 446
        super4colheaderborder  426, 427
    +href="glossaries-user.html#dx1-73042" >447, 448
        superborder  428
    +href="glossaries-user.html#dx1-73018" >449
        superheader  429, 430
    +href="glossaries-user.html#dx1-73020" >450, 451
        superheaderborder  431, 432
    +href="glossaries-user.html#dx1-53066" >452, 453
        superragged  433, 434, 435, 436
    +href="glossaries-user.html#dx1-74009" >454, 455, 456, 457
        superragged3col  437, 438, 439, 440
    +href="glossaries-user.html#dx1-74021" >458, 459, 460, 461
        superragged3colborder  441
    +href="glossaries-user.html#dx1-74026" >462
        superragged3colheader  442, 443
    +href="glossaries-user.html#dx1-74028" >463, 464
        superragged3colheaderborder  444
    +href="glossaries-user.html#dx1-74030" >465
        superraggedborder  445
    +href="glossaries-user.html#dx1-74015" >466
        superraggedheader  446, 447
    +href="glossaries-user.html#dx1-74017" >467, 468
        superraggedheaderborder  448
    +href="glossaries-user.html#dx1-74019" >469
        tree  449, 450, 451, 452, 453, 454
    +href="glossaries-user.html#dx1-62066" >470, 471, 472, 473, 474, 475, 476
        treegroup  455, 456, 457
    +href="glossaries-user.html#dx1-75035" >477, 478, 479
        treehypergroup  458, 459, 460
    +href="glossaries-user.html#dx1-69022" >480, 481, 482
        treenoname  461, 462, 463
    +href="glossaries-user.html#dx1-75012" >483, 484, 485, 486
        treenonamegroup  464, 465, 466
    +href="glossaries-user.html#dx1-75042" >487, 488, 489
        treenonamehypergroup  467, 468
    +href="glossaries-user.html#dx1-75044" >490, 491
    glossary-inline package  469, 470
    +href="glossaries-user.html#dx1-77001" >492, 493
    glossary-list package  471, 472, 473, 474, 475
    +href="glossaries-user.html#dx1-19028" >494, 495, 496, 497, 498
    glossary-long package  476, 477, 478, 479, 480, 481, 482, 483
    +href="glossaries-user.html#dx1-19029" >499, 500, 501, 502, 503, 504, 505, 506
    glossary-longbooktabs package  484, 485, 486
    +href="glossaries-user.html#dx1-72001" >507, 508, 509
    glossary-longragged package  487, 488, 489, 490
    +href="glossaries-user.html#dx1-71001" >510, 511, 512, 513
    glossary-mcols package  491, 492, 493, 494, 495, 496, 497
    +href="glossaries-user.html#dx1-19053" >514, 515, 516, 517, 518, 519, 520
    glossary-ragged package  498
    +href="glossaries-user.html#dx1-72010" >521
    glossary-super package  499, 500, 501, 502, 503, 504
    +href="glossaries-user.html#dx1-19030" >522, 523, 524, 525, 526, 527
    glossary-superragged package  505, 506, 507
    +href="glossaries-user.html#dx1-74001" >528, 529, 530
    glossary-tree package  508, 509, 510, 511, 512, 513, 514
    +href="glossaries-user.html#dx1-19031" >531, 532, 533, 534, 535, 536, 537, 538
    glossaryentry (counter)  515, 516, 517, 518
    +class="cmti-10">539, 540, 541, 542
    \glossaryheader  519
    +class="cmti-10">543
    \glossarypostamble  520
    +class="cmti-10">544
    \glossarypreamble  521
    +class="cmti-10">545
    glossarysubentry (counter)  522
    +class="cmti-10">546
    \glossentry  523
    +class="cmti-10">547
    \Glossentrydesc  524
    +class="cmti-10">548
    + + \glossentrydesc  525
    +class="cmti-10">549
    \Glossentryname  526
    - - +class="cmti-10">550
    \glossentryname  527
    +class="cmti-10">551
    \Glossentrysymbol  528
    +class="cmti-10">552
    \glossentrysymbol  529
    +class="cmti-10">553
    \GLS  530
    +class="cmti-10">554
    \Gls  531
    +class="cmti-10">555
    \gls  532
    +class="cmti-10">556
    \glsacspace  533
    +class="cmti-10">557
    \glsadd  534
    +class="cmti-10">558
    \glsaddall  535
    +class="cmti-10">559
    \glsaddall options
         types  536
    +href="glossaries-user.html#dx1-49004" >560
    \glsaddallunused  537
    +class="cmti-10">561
    \glsaddkey  538
    +class="cmti-10">562
    \glsaddprotectedpagefmt  539
    +class="cmti-10">563
    \glsaddstoragekey  540
    +class="cmti-10">564
    \GlsAddXdyAttribute  541
    +class="cmti-10">565
    \GlsAddXdyCounters  542
    +class="cmti-10">566
    \GlsAddXdyLocation  543
    +class="cmti-10">567
    \glsautoprefix  544
    +class="cmti-10">568
    \glsbackslash  545
    +class="cmti-10">569
    \glscapscase  546
    +class="cmti-10">570
    \glsclearpage  547
    +class="cmti-10">571
    \glsclosebrace  548
    +class="cmti-10">572
    \glscurrentfieldvalue  549
    +class="cmti-10">573
    \glscustomtext  550
    +class="cmti-10">574
    \GLSdesc  551
    +class="cmti-10">575
    \Glsdesc  552
    +class="cmti-10">576
    \glsdesc  553
    +class="cmti-10">577
    \glsdescwidth  554
    +class="cmti-10">578
    \glsdisablehyper  555
    +class="cmti-10">579
    \glsdisp  556
    +class="cmti-10">580
    \glsdisplaynumberlist  557
    +class="cmti-10">581
    \glsdoifexists  558
    +class="cmti-10">582
    \glsdoifexistsordo  559
    +class="cmti-10">583
    \glsdoifexistsorwarn  560
    +class="cmti-10">584
    \glsdoifnoexists  561
    +class="cmti-10">585
    \glsdoifnoexistsordo  562
    +class="cmti-10">586
    \glsdosanitizesort  563
    +class="cmti-10">587
    \glsenableentrycount  564
    +class="cmti-10">588
    \glsenablehyper  565
    +class="cmti-10">589
    \glsentrycounterlabel  566
    +class="cmti-10">590
    \glsentrycurrcount  567
    +class="cmti-10">591
    \Glsentrydesc  568
    +class="cmti-10">592
    \glsentrydesc  569
    +class="cmti-10">593
    + + \Glsentrydescplural  570
    +class="cmti-10">594
    \glsentrydescplural  571
    - - +class="cmti-10">595
    \Glsentryfirst  572
    +class="cmti-10">596
    \glsentryfirst  573
    +class="cmti-10">597
    \Glsentryfirstplural  574
    +class="cmti-10">598
    \glsentryfirstplural  575
    +class="cmti-10">599
    \glsentryfmt  576
    +class="cmti-10">600
    \Glsentryfull  577
    +href="glossaries-user.html#dx1-59122" >601
    \glsentryfull  578
    +href="glossaries-user.html#dx1-59121" >602
    \Glsentryfullpl  579
    +href="glossaries-user.html#dx1-59124" >603
    \glsentryfullpl  580
    +href="glossaries-user.html#dx1-59123" >604
    \glsentryitem  581
    +class="cmti-10">605
    \Glsentrylong  582
    +href="glossaries-user.html#dx1-59114" >606
    \glsentrylong  583
    +href="glossaries-user.html#dx1-59113" >607
    \Glsentrylongpl  584
    +href="glossaries-user.html#dx1-59116" >608
    \glsentrylongpl  585
    +href="glossaries-user.html#dx1-59115" >609
    \Glsentryname  586
    +class="cmti-10">610
    \glsentryname  587
    +class="cmti-10">611
    \glsentrynumberlist  588
    +class="cmti-10">612
    \Glsentryplural  589
    +class="cmti-10">613
    \glsentryplural  590
    +class="cmti-10">614
    \Glsentryprefix  591
    +class="cmti-10">615
    \glsentryprefix  592
    +class="cmti-10">616
    \Glsentryprefixfirst  593
    +class="cmti-10">617
    \glsentryprefixfirst  594
    +class="cmti-10">618
    \Glsentryprefixfirstplural  595
    +class="cmti-10">619
    \glsentryprefixfirstplural  596
    +class="cmti-10">620
    \Glsentryprefixplural  597
    +class="cmti-10">621
    \glsentryprefixplural  598
    +class="cmti-10">622
    \glsentryprevcount  599
    +class="cmti-10">623
    \Glsentryshort  600
    +href="glossaries-user.html#dx1-59118" >624
    \glsentryshort  601
    +href="glossaries-user.html#dx1-59117" >625
    \Glsentryshortpl  602
    +href="glossaries-user.html#dx1-59120" >626
    \glsentryshortpl  603
    +href="glossaries-user.html#dx1-59119" >627
    \Glsentrysymbol  604
    +class="cmti-10">628
    \glsentrysymbol  605
    +class="cmti-10">629
    \Glsentrysymbolplural  606
    +class="cmti-10">630
    \glsentrysymbolplural  607
    +class="cmti-10">631
    \Glsentrytext  608
    +class="cmti-10">632
    \glsentrytext  609
    +class="cmti-10">633
    \glsentrytitlecase  610
    +class="cmti-10">634
    \Glsentryuseri  611
    +class="cmti-10">635
    \glsentryuseri  612
    +class="cmti-10">636
    \Glsentryuserii  613
    +class="cmti-10">637
    \glsentryuserii  614
    +class="cmti-10">638
    \Glsentryuseriii  615
    +class="cmti-10">639
    + + \glsentryuseriii  616
    +class="cmti-10">640
    \Glsentryuseriv  617
    - - +class="cmti-10">641
    \glsentryuseriv  618
    +class="cmti-10">642
    \Glsentryuserv  619
    +class="cmti-10">643
    \glsentryuserv  620
    +class="cmti-10">644
    \Glsentryuservi  621
    +class="cmti-10">645
    \glsentryuservi  622
    +class="cmti-10">646
    \glsexpandfields  623
    +class="cmti-10">647
    \glsfielddef  624
    +class="cmti-10">648
    \glsfieldedef  625
    +class="cmti-10">649
    \glsfieldfetch  626
    +class="cmti-10">650
    \glsfieldgdef  627
    +class="cmti-10">651
    \glsfieldxdef  628
    +class="cmti-10">652
    \glsfindwidesttoplevelname  629
    +href="glossaries-user.html#dx1-75051" >653
    \GLSfirst  630
    +class="cmti-10">654
    \Glsfirst  631
    +class="cmti-10">655
    \glsfirst  632
    +class="cmti-10">656
    \GLSfirstplural  633
    +class="cmti-10">657
    \Glsfirstplural  634
    +class="cmti-10">658
    \glsfirstplural  635
    +class="cmti-10">659
    \glsgenacfmt  636
    +class="cmti-10">660
    \glsgenentryfmt  637
    +class="cmti-10">661
    \glsgetgrouptitle  638
    +class="cmti-10">662
    \glsglossarymark  639, 663, 640
    +class="cmti-10">664
    \glsgroupheading  641
    +class="cmti-10">665
    \glsgroupskip  642
    +class="cmti-10">666
    \glshyperlink  643
    +class="cmti-10">667
    \glshypernavsep  644
    +href="glossaries-user.html#dx1-69019" >668
    \glsifhyperon  645
    +class="cmti-10">669
    \glsIfListOfAcronyms  646
    +class="cmti-10">670
    \glsifplural  647
    +class="cmti-10">671
    \glsinlinedescformat  648
    +class="cmti-10">672
    \glsinlineemptydescformat  649
    +class="cmti-10">673
    \glsinlinenameformat  650
    +class="cmti-10">674
    \glsinlineparentchildseparator  651
    +class="cmti-10">675
    \glsinlineseparator  652
    +class="cmti-10">676
    \glsinlinesubdescformat  653
    +class="cmti-10">677
    \glsinlinesubnameformat  654
    +class="cmti-10">678
    \glsinlinesubseparator  655
    +class="cmti-10">679
    \glsinsert  656
    +class="cmti-10">680
    \glslabel  657
    +class="cmti-10">681
    \glslabeltok  658
    +class="cmti-10">682
    \glsletentryfield  659
    +class="cmti-10">683
    \glslink  660
    +class="cmti-10">684
    \glslink options
         counter  661, 662
    +href="glossaries-user.html#dx1-44069" >685, 686
    + +     format  663, 664, 665, 666, 667, 668, 669
    +href="glossaries-user.html#dx1-43008" >687, 688, 689, 690, 691, 692, 693
        hyper  670, 671, 672, 673, 674, 675, 676
    - - +href="glossaries-user.html#dx1-17091" >694, 695, 696, 697, 698, 699, 700
        local  677
    +href="glossaries-user.html#dx1-44070" >701
    \glslinkcheckfirsthyperhook  678
    +class="cmti-10">702
    \glslinkpostsetkeys  679
    +class="cmti-10">703
    \glslinkvar  680
    +class="cmti-10">704
    \glslistdottedwidth  681
    +href="glossaries-user.html#dx1-69037" >705
    \glslistnavigationitem  682
    +href="glossaries-user.html#dx1-69021" >706
    \glslocalreset  683
    +class="cmti-10">707
    \glslocalresetall  684
    +class="cmti-10">708
    \glslocalunset  685
    +class="cmti-10">709
    \glslocalunsetall  686
    +class="cmti-10">710
    \glslongtok  687
    +class="cmti-10">711
    \glsmcols  688
    +class="cmti-10">712
    \glsmoveentry  689
    +class="cmti-10">713
    \GLSname  690
    +class="cmti-10">714
    \Glsname  691
    +class="cmti-10">715
    \glsname  692
    +class="cmti-10">716
    \glsnamefont  693
    +class="cmti-10">717
    \glsnavhypertarget  694
    +class="cmti-10">718
    \glsnavigation  695
    +class="cmti-10">719
    \glsnoexpandfields  696
    +class="cmti-10">720
    \glsnoidxdisplayloc  697
    +class="cmti-10">721
    \glsnumberlistloop  698
    +class="cmti-10">722
    \glsnumlistlastsep  699
    +class="cmti-10">723
    \glsnumlistsep  700
    +class="cmti-10">724
    \glsopenbrace  701
    +class="cmti-10">725
    \glspagelistwidth  702
    +class="cmti-10">726
    \glspar  703
    +class="cmti-10">727
    \glspercentchar  704
    +class="cmti-10">728
    \GLSpl  705
    +class="cmti-10">729
    \Glspl  706
    +class="cmti-10">730
    \glspl  707
    +class="cmti-10">731
    \GLSplural  708
    +class="cmti-10">732
    \Glsplural  709
    +class="cmti-10">733
    \glsplural  710
    +class="cmti-10">734
    \glspluralsuffix  711
    +class="cmti-10">735
    \glspostdescription  712
    +href="glossaries-user.html#dx1-68037" >736
    \glspostinline  713
    +class="cmti-10">737
    \glspostlinkhook  714
    +class="cmti-10">738
    \glsprestandardsort  715
    +class="cmti-10">739
    \glsquote  716
    +class="cmti-10">740
    \glsrefentry  717
    +class="cmti-10">741
    \glsreset  718
    +class="cmti-10">742
    \glsresetall  719
    +class="cmti-10">743
    \glsresetentrycounter  720
    +class="cmti-10">744
    + + \glsrestoreLToutput  721
    +class="cmti-10">745
    \glssee  722
    - - +class="cmti-10">746
    \glsseeformat  723
    +class="cmti-10">747
    \glsseeitemformat  724
    +class="cmti-10">748
    \glsseelastsep  725
    +class="cmti-10">749
    \glsseesep  726
    +class="cmti-10">750
    \glsSetAlphaCompositor  727
    +class="cmti-10">751
    \glsSetCompositor  728
    +class="cmti-10">752
    \glssetexpandfield  729
    +class="cmti-10">753
    \glssetnoexpandfield  730
    +class="cmti-10">754
    \GlsSetQuote  731
    +class="cmti-10">755
    \glsSetSuffixF  732
    +class="cmti-10">756
    \glsSetSuffixFF  733
    +class="cmti-10">757
    \glssetwidest  734
    +href="glossaries-user.html#dx1-75049" >758
    \GlsSetWriteIstHook  735
    +class="cmti-10">759
    \GlsSetXdyCodePage  736
    +class="cmti-10">760
    \GlsSetXdyFirstLetterAfterDigits  737
    +class="cmti-10">761
    \GlsSetXdyLanguage  738
    +class="cmti-10">762
    \GlsSetXdyLocationClassOrder  739
    +class="cmti-10">763
    \GlsSetXdyMinRangeLength  740
    +class="cmti-10">764
    \glsshorttok  741
    +class="cmti-10">765
    \glssortnumberfmt  742
    +class="cmti-10">766
    \glssubentrycounterlabel  743
    +class="cmti-10">767
    \glssubentryitem  744
    +class="cmti-10">768
    \GLSsymbol  745
    +class="cmti-10">769
    \Glssymbol  746
    +class="cmti-10">770
    \glssymbol  747
    +class="cmti-10">771
    \glstarget  748
    +class="cmti-10">772
    \GLStext  749
    +class="cmti-10">773
    \Glstext  750
    +class="cmti-10">774
    \glstext  751
    +class="cmti-10">775
    \glstextformat  752
    +class="cmti-10">776
    \glstextup  753
    +class="cmti-10">777
    \glstildechar  754
    +class="cmti-10">778
    \glstocfalse  755
    +class="cmti-10">779
    \glstoctrue  756
    +class="cmti-10">780
    +\glstreechildpredesc  781
    \glstreegroupheaderfmt  757
    +class="cmti-10">782
    \glstreeindent  758
    +href="glossaries-user.html#dx1-75033" >783
    +\glstreeitem  784
    \glstreenamebox  759
    +href="glossaries-user.html#dx1-75054" >785
    \glstreenamefmt  760
    +class="cmti-10">786
    \glstreenavigationfmt  761
    +class="cmti-10">787
    +\glstreepredesc  788
    +\glstreesubitem  789
    +\glstreesubsubitem  790
    + + \glstype  762
    +class="cmti-10">791
    \glsunset  763
    +class="cmti-10">792
    \glsunsetall  764
    +class="cmti-10">793
    \GlsUseAcrEntryDispStyle  765
    +class="cmti-10">794
    \GlsUseAcrStyleDefs  766
    +class="cmti-10">795
    \GLSuseri  767
    +class="cmti-10">796
    \Glsuseri  768
    - - +class="cmti-10">797
    \glsuseri  769
    +class="cmti-10">798
    \GLSuserii  770
    +class="cmti-10">799
    \Glsuserii  771
    +class="cmti-10">800
    \glsuserii  772
    +class="cmti-10">801
    \GLSuseriii  773
    +class="cmti-10">802
    \Glsuseriii  774
    +class="cmti-10">803
    \glsuseriii  775
    +class="cmti-10">804
    \GLSuseriv  776
    +class="cmti-10">805
    \Glsuseriv  777
    +class="cmti-10">806
    \glsuseriv  778
    +class="cmti-10">807
    \GLSuserv  779
    +class="cmti-10">808
    \Glsuserv  780
    +class="cmti-10">809
    \glsuserv  781
    +class="cmti-10">810
    \GLSuservi  782
    +class="cmti-10">811
    \Glsuservi  783
    +class="cmti-10">812
    \glsuservi  784
    +class="cmti-10">813
    \glswrallowprimitivemodsfalse  785
    +class="cmti-10">814
    \glswrite  786
    +class="cmti-10">815
    \glswriteentry  787
    +class="cmti-10">816

    H html package  788
    +href="glossaries-user.html#dx1-48002" >817
    hyperref package  789, 790, 791, 792, 793, 794, 795, 796, 797, 798, 799, 800, 801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811
    +href="glossaries-user.html#dx1-12" >818, 819, 820, 821, 822, 823, 824, 825, 826, 827, 828, 829, 830, 831, 832, 833, 834, 835, 836, 837, 838, 839, 840

    I \ifglossaryexists  812
    +class="cmti-10">841
    \ifglsdescsuppressed  813
    +class="cmti-10">842
    \ifglsentryexists  814
    +class="cmti-10">843
    \ifglsfieldcseq  815
    +class="cmti-10">844
    \ifglsfielddefeq  816
    +class="cmti-10">845
    \ifglsfieldeq  817
    +class="cmti-10">846
    \ifglshaschildren  818
    +class="cmti-10">847
    \ifglshasdesc  819
    +class="cmti-10">848
    \ifglshasfield  820
    +class="cmti-10">849
    \ifglshaslong  821
    +class="cmti-10">850
    \ifglshasparent  822
    +class="cmti-10">851
    \ifglshasprefix  823
    +class="cmti-10">852
    + + \ifglshasprefixfirst  824
    +class="cmti-10">853
    \ifglshasprefixfirstplural  825
    +class="cmti-10">854
    \ifglshasprefixplural  826
    +class="cmti-10">855
    \ifglshasshort  827
    +class="cmti-10">856
    \ifglshassymbol  828
    +class="cmti-10">857
    \ifglsucmark  829
    +class="cmti-10">858
    \ifglsused  830, 859, 831
    - - +class="cmti-10">860
    \ifignoredglossary  832
    +class="cmti-10">861
    imakeidx package  833
    +href="glossaries-user.html#dx1-23022" >862
    index package  834
    +href="glossaries-user.html#dx1-23021" >863
    inputenc package  835, 836, 837, 838, 839, 840
    +href="glossaries-user.html#dx1-5016" >864, 865, 866, 867, 868, 869

    L latex  841, 842
    +href="glossaries-user.html#dx1-22" >870, 871
    latexmk  843
    +href="glossaries-user.html#dx1-10014" >872
    Latin alphabet  844, 845, 846
    +class="cmbx-10">873, 874, 875
    Latin character  847, 848, 849, 850, 876, 877, 878, 879, 851, 852, 853
    +class="cmbx-10">880, 881, 882
    link text  854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865, 866, 867, 868, 869, 870, 871, 872, 873, 874, 875, 876, 877, 878, 879, 880, 881, 882, 883, 884, 885, 886, 887, 888, 889, 890, 891, 892, 893, 894, 895, 896, 897, 898, 899, 900, 901, 902
    +class="cmbx-10">883, 884, 885, 886, 887, 888, 889, 890, 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
    \loadglsentries  903
    +class="cmti-10">932
    location list  see number list
    \longnewglossaryentry  905
    +class="cmti-10">934
    \longprovideglossaryentry  906
    +class="cmti-10">935
    longtable package  907, 908
    +href="glossaries-user.html#dx1-19034" >936, 937

    M makeglossaries  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, 940, 941, 942, 943, 944, 945, 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
    +class="cmbx-10">938, 939, 940, 941, 942, 943, 944, 945, 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
        -d  994
    +href="glossaries-user.html#dx1-12004" >1023
        -k  995
    +href="glossaries-user.html#dx1-11017" >1024
        -m  996
    +href="glossaries-user.html#dx1-11025" >1025
        -Q  997
    +href="glossaries-user.html#dx1-11016" >1026
        -q  998
    +href="glossaries-user.html#dx1-11019" >1027
        -x  999
    +href="glossaries-user.html#dx1-11027" >1028
    \makeglossaries  1000
    +class="cmti-10">1029
    makeglossaries-lite.lua  1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009
    +class="cmbx-10">1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038
    makeglossariesgui  1010, 1011, 1012
    +class="cmbx-10">1039, 1040, 1041
    makeidx package  1013
    +href="glossaries-user.html#dx1-23020" >1042
    makeindex  1014, 1015, 1016, 1043, 1044, 1045, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120
    +class="cmbx-10">1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096, 1097, 1098, 1099, 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
        -g  1121, 1122, 1123
    +href="glossaries-user.html#dx1-4023" >1150, 1151, 1152
        -l  1124, 1125, 1126, 1127
    +href="glossaries-user.html#dx1-4036" >1153, 1154, 1155, 1156
    \makenoidxglossaries  1128
    +class="cmti-10">1157
    memoir class  1129, 1130, 1131, 1132
    +href="glossaries-user.html#dx1-18021" >1158, 1159, 1160, 1161
    mfirstuc package  1133, 1134, 1135, 1136, 1137, 1138, 1139
    +href="glossaries-user.html#dx1-3" >1162, 1163, 1164, 1165, 1166, 1167, 1168
    + + multicol package  1140
    +href="glossaries-user.html#dx1-76004" >1169
    mwe package  1141
    +href="glossaries-user.html#dx1-6006" >1170

    N nameref package  1142
    +href="glossaries-user.html#dx1-18049" >1171
    \newacronym  1143
    - - +href="glossaries-user.html#dx1-59007" >1172
    \newacronymstyle  1144
    +class="cmti-10">1173
    \newglossary  1145
    +class="cmti-10">1174
    \newglossary*  1146
    +class="cmti-10">1175
    \newglossaryentry  1147
    +class="cmti-10">1176
    \newglossaryentry options
         access  1148
    +href="glossaries-user.html#dx1-84003" >1177
        description  1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166
    +href="glossaries-user.html#dx1-6007" >1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195
        descriptionaccess  1167
    +href="glossaries-user.html#dx1-84017" >1196
        descriptionplural  1168, 1169, 1170, 1171
    +href="glossaries-user.html#dx1-28022" >1197, 1198, 1199, 1200
        descriptionpluralaccess  1172
    +href="glossaries-user.html#dx1-84019" >1201
        entrycounter  1173, 1174
    +href="glossaries-user.html#dx1-53035" >1202, 1203
        first  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
    +href="glossaries-user.html#dx1-3019" >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
        firstaccess  1200
    +href="glossaries-user.html#dx1-84007" >1229
        firstplural  1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217
    +href="glossaries-user.html#dx1-3020" >1230, 1231, 1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246
        firstpluralaccess  1218
    +href="glossaries-user.html#dx1-84011" >1247
        format  1219
    +href="glossaries-user.html#dx1-44067" >1248
        long  1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232
    +href="glossaries-user.html#dx1-17098" >1249, 1250, 1251, 1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261
        longaccess  1233
    +href="glossaries-user.html#dx1-84021" >1262
        longplural  1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242
    +href="glossaries-user.html#dx1-28124" >1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271
        longpluralaccess  1243
    +href="glossaries-user.html#dx1-84027" >1272
        name  1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275, 1276, 1277, 1278
    +href="glossaries-user.html#dx1-6009" >1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 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
        nonumberlist  1279
    +href="glossaries-user.html#dx1-28105" >1308
        parent  1280, 1281, 1282, 1283
    +href="glossaries-user.html#dx1-28011" >1309, 1310, 1311, 1312
        plural  1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298
    +href="glossaries-user.html#dx1-28037" >1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327
        pluralaccess  1299
    +href="glossaries-user.html#dx1-84009" >1328
        prefix  1300, 1301, 1302, 1303, 1304, 1305, 1306
    +href="glossaries-user.html#dx1-83003" >1329, 1330, 1331, 1332, 1333, 1334, 1335
        prefixfirst  1307, 1308, 1309, 1310, 1311
    +href="glossaries-user.html#dx1-83007" >1336, 1337, 1338, 1339, 1340
        prefixfirstplural  1312, 1313, 1314, 1315, 1316
    +href="glossaries-user.html#dx1-83010" >1341, 1342, 1343, 1344, 1345
        prefixplural  1317, 1318, 1319, 1320, 1321, 1322
    +href="glossaries-user.html#dx1-83005" >1346, 1347, 1348, 1349, 1350, 1351
        see  1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338
    +href="glossaries-user.html#dx1-17012" >1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367
        short  1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349
    +href="glossaries-user.html#dx1-28125" >1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378
        shortaccess  1350
    +href="glossaries-user.html#dx1-84024" >1379
        shortplural  1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359
    +href="glossaries-user.html#dx1-28126" >1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388
        shortpluralaccess  1360
    +href="glossaries-user.html#dx1-84030" >1389
        sort  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, 1391, 1392
    +href="glossaries-user.html#dx1-3049" >1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421
        subentrycounter  1393
    +href="glossaries-user.html#dx1-53036" >1422
    + +     symbol  1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405
    +href="glossaries-user.html#dx1-6004" >1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434
        symbolaccess  1406
    +href="glossaries-user.html#dx1-84013" >1435
        symbolplural  1407, 1408, 1409
    +href="glossaries-user.html#dx1-28061" >1436, 1437, 1438
        symbolpluralaccess  1410
    +href="glossaries-user.html#dx1-84015" >1439
        text  1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431
    +href="glossaries-user.html#dx1-28024" >1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460
        textaccess  1432
    - - +href="glossaries-user.html#dx1-84005" >1461
        type  1433, 1434, 1435
    +href="glossaries-user.html#dx1-28093" >1462, 1463, 1464
        user1  1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446
    +href="glossaries-user.html#dx1-6005" >1465, 1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475
        user2  1447, 1448, 1449, 1450
    +href="glossaries-user.html#dx1-28097" >1476, 1477, 1478, 1479
        user3  1451, 1452, 1453
    +href="glossaries-user.html#dx1-28098" >1480, 1481, 1482
        user4  1454, 1455, 1456
    +href="glossaries-user.html#dx1-28099" >1483, 1484, 1485
        user5  1457, 1458, 1459
    +href="glossaries-user.html#dx1-28100" >1486, 1487, 1488
        user6  1460, 1461, 1462, 1463
    +href="glossaries-user.html#dx1-28096" >1489, 1490, 1491, 1492
    \newglossarystyle  1464
    +class="cmti-10">1493
    \newignoredglossary  1465
    +class="cmti-10">1494
    \newterm  1466
    +class="cmti-10">1495
    ngerman package  1467, 1468, 1469, 1470, 1471
    +href="glossaries-user.html#dx1-7018" >1496, 1497, 1498, 1499, 1500
    \noist  1472
    +class="cmti-10">1501
    Non-Latin Alphabet  1473
    +class="cmbx-10">1502
    non-Latin character  1474, 1475, 1503, 1504, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484
    +class="cmbx-10">1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513
    \nopostdesc  1485
    +class="cmti-10">1514
    number list  1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535
    +class="cmbx-10">1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 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

    O \oldacronym  1536
    +class="cmti-10">1566

    P package options:
         acronym  1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560
    +href="glossaries-user.html#dx1-8026" >1567, 1568, 1569, 1570, 1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590
            true  1561, 1562
    +href="glossaries-user.html#dx1-16002" >1591, 1592
        acronymlists  1563, 1564, 1565, 1566, 1567, 1568, 1569
    +href="glossaries-user.html#dx1-21019" >1593, 1594, 1595, 1596, 1597, 1598, 1599
        acronyms  1570, 1571
    +href="glossaries-user.html#dx1-17018" >1600, 1601
        automake  1572, 1573, 1574
    +href="glossaries-user.html#dx1-10005" >1602, 1603, 1604
            false  1575
    +href="glossaries-user.html#dx1-20088" >1605
        compatible-2.07  1576, 1577, 1578
    +href="glossaries-user.html#dx1-23027" >1606, 1607, 1608
        compatible-3.07  1579, 1580, 1581
    +href="glossaries-user.html#dx1-21004" >1609, 1610, 1611
        counter  1582, 1583, 1584, 1585, 1586
    +href="glossaries-user.html#dx1-19069" >1612, 1613, 1614, 1615, 1616
            page  1587
    +href="glossaries-user.html#dx1-19070" >1617
        counterwithin  1588, 1589, 1590, 1591, 1592
    +href="glossaries-user.html#dx1-19009" >1618, 1619, 1620, 1621, 1622
        debug  1593, 1594, 1595
    +href="glossaries-user.html#dx1-17006" >1623, 1624, 1625
            true  1596
    +href="glossaries-user.html#dx1-17003" >1626
    + +     description  1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605
    +href="glossaries-user.html#dx1-22002" >1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635
        dua  1606, 1607
    +href="glossaries-user.html#dx1-22011" >1636, 1637
        entrycounter  1608, 1609, 1610, 1611, 1612
    +href="glossaries-user.html#dx1-19001" >1638, 1639, 1640, 1641, 1642
            false  1613
    +href="glossaries-user.html#dx1-19002" >1643
            true  1614
    +href="glossaries-user.html#dx1-19010" >1644
        footnote  1615, 1616, 1617, 1618, 1619, 1620
    +href="glossaries-user.html#dx1-22006" >1645, 1646, 1647, 1648, 1649, 1650
        hyperfirst  1621, 1622, 1623, 1624
    - - +href="glossaries-user.html#dx1-17078" >1651, 1652, 1653, 1654
            false  1625, 1626, 1627, 1628, 1629
    +href="glossaries-user.html#dx1-17092" >1655, 1656, 1657, 1658, 1659
            true  1630, 1631
    +href="glossaries-user.html#dx1-17079" >1660, 1661
        index  1632, 1633, 1634, 1635, 1636
    +href="glossaries-user.html#dx1-17021" >1662, 1663, 1664, 1665, 1666
        indexonlyfirst  1637, 1638
    +href="glossaries-user.html#dx1-17102" >1667, 1668
            false  1639
    +href="glossaries-user.html#dx1-17103" >1669
        makeindex  1640, 1641, 1642
    +href="glossaries-user.html#dx1-16004" >1670, 1671, 1672
        ngerman  1643
    +href="glossaries-user.html#dx1-7020" >1673
        nogroupskip  1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651
    +href="glossaries-user.html#dx1-5020" >1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681
            false  1652
    +href="glossaries-user.html#dx1-19075" >1682
        nohypertypes  1653, 1654, 1655, 1656, 1657, 1658, 1659, 1660, 1661
    +href="glossaries-user.html#dx1-17074" >1683, 1684, 1685, 1686, 1687, 1688, 1689, 1690, 1691
            index  1662
    +href="glossaries-user.html#dx1-23024" >1692
        nolist  1663, 1664, 1665
    +href="glossaries-user.html#dx1-19040" >1693, 1694, 1695
        nolong  1666, 1667, 1668, 1669
    +href="glossaries-user.html#dx1-19032" >1696, 1697, 1698, 1699
        nomain  1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677
    +href="glossaries-user.html#dx1-17016" >1700, 1701, 1702, 1703, 1704, 1705, 1706, 1707
        nonumberlist  1678, 1679, 1680, 1681, 1682, 1683, 1684, 1685
    +href="glossaries-user.html#dx1-3047" >1708, 1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716
        nopostdot  1686, 1687
    +href="glossaries-user.html#dx1-19072" >1717, 1718
            false  1688
    +href="glossaries-user.html#dx1-19073" >1719
        noredefwarn  1689
    +href="glossaries-user.html#dx1-17004" >1720
        nostyles  1690, 1691, 1692, 1693, 1694, 1695, 1696
    +href="glossaries-user.html#dx1-19052" >1721, 1722, 1723, 1724, 1725, 1726, 1727
        nosuper  1697, 1698, 1699, 1700
    +href="glossaries-user.html#dx1-19036" >1728, 1729, 1730, 1731
        notranslate  1701, 1702, 1703
    +href="glossaries-user.html#dx1-8010" >1732, 1733, 1734
        notree  1704, 1705, 1706, 1707
    +href="glossaries-user.html#dx1-19046" >1735, 1736, 1737, 1738
        nowarn  1708, 1709, 1710
    +href="glossaries-user.html#dx1-17001" >1739, 1740, 1741
        numberedsection  1711, 1712, 1713, 1714, 1715
    +href="glossaries-user.html#dx1-18035" >1742, 1743, 1744, 1745, 1746
            autolabel  1716, 1717
    +href="glossaries-user.html#dx1-18039" >1747, 1748
            false  1718
    +href="glossaries-user.html#dx1-18037" >1749
            nameref  1719
    +href="glossaries-user.html#dx1-18045" >1750
            nolabel  1720
    +href="glossaries-user.html#dx1-18038" >1751
        numberline  1721, 1722
    +href="glossaries-user.html#dx1-18004" >1752, 1753
        numbers  1723, 1724, 1725
    +href="glossaries-user.html#dx1-17020" >1754, 1755, 1756
        order  1726, 1727, 1728
    +href="glossaries-user.html#dx1-20045" >1757, 1758, 1759
            letter  1729, 1730, 1731, 1732
    +href="glossaries-user.html#dx1-4060" >1760, 1761, 1762, 1763
            word  1733, 1734, 1735
    +href="glossaries-user.html#dx1-5056" >1764, 1765, 1766
        sanitizesort  1736, 1737, 1738
    +href="glossaries-user.html#dx1-4076" >1767, 1768, 1769
            false  1739, 1740, 1741, 1742, 1743, 1744
    +href="glossaries-user.html#dx1-4006" >1770, 1771, 1772, 1773, 1774, 1775
            true  1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752
    +href="glossaries-user.html#dx1-4008" >1776, 1777, 1778, 1779, 1780, 1781, 1782, 1783
        savenumberlist  1753, 1754
    +href="glossaries-user.html#dx1-17108" >1784, 1785
            false  1755
    +href="glossaries-user.html#dx1-17110" >1786
        savewrites  1756, 1757, 1758
    +href="glossaries-user.html#dx1-17030" >1787, 1788, 1789
    + +         false  1759
    +href="glossaries-user.html#dx1-17031" >1790
        section  1760, 1761
    +href="glossaries-user.html#dx1-18011" >1791, 1792
        seeautonumberlist  1762, 1763, 1764, 1765
    +href="glossaries-user.html#dx1-19060" >1793, 1794, 1795, 1796
        seenoindex  1766
    +href="glossaries-user.html#dx1-17011" >1797
            ignore  1767
    +href="glossaries-user.html#dx1-17015" >1798
            warn  1768
    +href="glossaries-user.html#dx1-17014" >1799
        shortcuts  1769, 1770
    - - +href="glossaries-user.html#dx1-21026" >1800, 1801
        smallcaps  1771, 1772, 1773, 1774, 1775, 1776
    +href="glossaries-user.html#dx1-22004" >1802, 1803, 1804, 1805, 1806, 1807
        smaller  1777, 1778, 1779, 1780, 1781
    +href="glossaries-user.html#dx1-22005" >1808, 1809, 1810, 1811, 1812
        sort  1782
    +href="glossaries-user.html#dx1-20001" >1813
            def  1783, 1784, 1785, 1786, 1787, 1788, 1789, 1790, 1791, 1792
    +href="glossaries-user.html#dx1-4009" >1814, 1815, 1816, 1817, 1818, 1819, 1820, 1821, 1822, 1823
            standard  1793, 1794, 1795
    +href="glossaries-user.html#dx1-20006" >1824, 1825, 1826
            use  1796, 1797, 1798, 1799, 1800, 1801, 1802, 1803, 1804
    +href="glossaries-user.html#dx1-20005" >1827, 1828, 1829, 1830, 1831, 1832, 1833, 1834, 1835
        style  1805, 1806, 1807, 1808, 1809, 1810, 1811, 1812
    +href="glossaries-user.html#dx1-19024" >1836, 1837, 1838, 1839, 1840, 1841, 1842, 1843
    +        index  1844
            list  1813
    +href="glossaries-user.html#dx1-19025" >1845
        subentrycounter  1814, 1815, 1816, 1817, 1818, 1819
    +href="glossaries-user.html#dx1-19018" >1846, 1847, 1848, 1849, 1850, 1851
            false  1820
    +href="glossaries-user.html#dx1-19019" >1852
        symbols  1821, 1822, 1823
    +href="glossaries-user.html#dx1-17019" >1853, 1854, 1855
        toc  1824, 1825, 1826, 1827, 1828
    +href="glossaries-user.html#dx1-18001" >1856, 1857, 1858, 1859, 1860
        translate  1829, 1830, 1831, 1832
    +href="glossaries-user.html#dx1-17041" >1861, 1862, 1863, 1864
            babel  1833, 1834, 1835, 1836, 1837, 1838
    +href="glossaries-user.html#dx1-8012" >1865, 1866, 1867, 1868, 1869, 1870
            false  1839, 1840, 1841, 1842
    +href="glossaries-user.html#dx1-8011" >1871, 1872, 1873, 1874
            true  1843, 1844, 1845, 1846
    +href="glossaries-user.html#dx1-17042" >1875, 1876, 1877, 1878
        ucfirst  1847
    +href="glossaries-user.html#dx1-18032" >1879
        ucmark  1848, 1849
    +href="glossaries-user.html#dx1-18017" >1880, 1881
            false  1850
    +href="glossaries-user.html#dx1-18020" >1882
            true  1851
    +href="glossaries-user.html#dx1-18022" >1883
        xindy  1852, 1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862, 1863, 1864, 1865
    +href="glossaries-user.html#dx1-4049" >1884, 1885, 1886, 1887, 1888, 1889, 1890, 1891, 1892, 1893, 1894, 1895, 1896, 1897
        xindygloss  1866, 1867
    +href="glossaries-user.html#dx1-20070" >1898, 1899
        xindynoglsnumbers  1868, 1869
    +href="glossaries-user.html#dx1-20074" >1900, 1901
    page (counter)  1870
    +href="glossaries-user.html#dx1-56043" >1902
    page type precedence  1871
    +href="glossaries-user.html#dx1-43062" >1903
    pdflatex  1872, 1873
    +href="glossaries-user.html#dx1-21" >1904, 1905
    \PGLS  1874
    +class="cmti-10">1906
    \Pgls  1875
    +class="cmti-10">1907
    \pgls  1876
    +class="cmti-10">1908
    \PGLSpl  1877
    +class="cmti-10">1909
    \Pglspl  1878
    +class="cmti-10">1910
    \pglspl  1879
    +class="cmti-10">1911
    pod2man  1880
    +href="glossaries-user.html#dx1-11038" >1912
    polyglossia package  1881, 1882, 1883, 1884, 1885, 1886, 1887
    +href="glossaries-user.html#dx1-8002" >1913, 1914, 1915, 1916, 1917, 1918, 1919
    \printacronyms  1888
    +class="cmti-10">1920
    \printglossaries  1889
    +class="cmti-10">1921
    \printglossary  1890
    +class="cmti-10">1922
    \printglossary options
     + +     entrycounter  1891
    +href="glossaries-user.html#dx1-53032" >1923
        nogroupskip  1892
    +href="glossaries-user.html#dx1-53030" >1924
        nonumberlist  1893
    +href="glossaries-user.html#dx1-53029" >1925
        nopostdot  1894
    +href="glossaries-user.html#dx1-53031" >1926
        numberedsection  1895
    +href="glossaries-user.html#dx1-53026" >1927
        style  1896, 1897, 1898, 1899, 1900
    +href="glossaries-user.html#dx1-19056" >1928, 1929, 1930, 1931, 1932
        subentrycounter  1901
    +href="glossaries-user.html#dx1-53034" >1933
        title  1902, 1903, 1904
    - - +href="glossaries-user.html#dx1-53019" >1934, 1935, 1936
        toctitle  1905
    +href="glossaries-user.html#dx1-53020" >1937
        type  1906, 1907
    +href="glossaries-user.html#dx1-53016" >1938, 1939
    \printindex  1908
    +class="cmti-10">1940
    \printnoidxglossaries  1909
    +class="cmti-10">1941
    \printnoidxglossary  1910
    +class="cmti-10">1942
    \printnoidxglossary options
         sort  1911, 1912, 1913, 1914
    +href="glossaries-user.html#dx1-20002" >1943, 1944, 1945, 1946
    \printnumbers  1915
    +class="cmti-10">1947
    \printsymbols  1916
    +class="cmti-10">1948
    \provideglossaryentry  1917
    +class="cmti-10">1949

    R relsize package  1918, 1919
    +href="glossaries-user.html#dx1-22019" >1950, 1951

    S sanitize  1920, 1921, 1922, 1923, 1924
    +class="cmbx-10">1952, 1953, 1954, 1955, 1956
    scrwfile package  1925
    +href="glossaries-user.html#dx1-17034" >1957
    \SetAcronymLists  1926
    +class="cmti-10">1958
    \setacronymstyle  1927
    +class="cmti-10">1959
    \setglossarypreamble  1928
    +class="cmti-10">1960
    \setglossarysection  1929
    +class="cmti-10">1961
    \setglossarystyle  1930
    +class="cmti-10">1962
    \setStyleFile  1931
    +class="cmti-10">1963
    \setupglossaries  1932
    +class="cmti-10">1964
    \subglossentry  1933
    +class="cmti-10">1965
    supertabular package  1934, 1935, 1936
    +href="glossaries-user.html#dx1-19038" >1966, 1967, 1968

    T textcase package  1937, 1938, 1939
    +href="glossaries-user.html#dx1-6" >1969, 1970, 1971
    theglossary (environment)  1940
    +class="cmti-10">1972
    tracklang package  1941, 1942, 1943
    +href="glossaries-user.html#dx1-2" >1973, 1974, 1975
    translator package  1944, 1945, 1946, 1947, 1948, 1949, 1950, 1951, 1952, 1953, 1954, 1955, 1956, 1957, 1958, 1959, 1960, 1961, 1962, 1963, 1964, 1965, 1966, 1967, 1968
    +href="glossaries-user.html#dx1-8009" >1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000

    X + + xfor package  1969
    +href="glossaries-user.html#dx1-7" >2001
    xindy  1970, 1971, 1972, 2002, 2003, 2004, 1973, 1974, 1975, 1976, 1977, 1978, 1979, 1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 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, 2019, 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
    +class="cmbx-10">2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 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
        -C  2110, 2111, 2112, 2113, 2114
    +href="glossaries-user.html#dx1-4058" >2142, 2143, 2144, 2145, 2146
        -I  2115, 2116
    +href="glossaries-user.html#dx1-13008" >2147, 2148
        -L  2117, 2118, 2119, 2120
    +href="glossaries-user.html#dx1-4057" >2149, 2150, 2151, 2152
        -M  2121
    - - +href="glossaries-user.html#dx1-10077" >2153
    xkeyval package  2122, 2123, 2124
    +href="glossaries-user.html#dx1-5" >2154, 2155, 2156
    xspace package  2125, 2126, 2127, 2128, 2129, 2130, 2131
    +href="glossaries-user.html#dx1-64014" >2157, 2158, 2159, 2160, 2161, 2162, 2163

    -

    1.1That is, if the term has been referenced using any of the commands described in commands such as \acrshort.

    -

    1.2Note that although I’ve written latex the reasons given earlier.

    -

    1.3Added to version makeglossaries 2.18.

    -

    1.4As from v3.01 \gls is no longer fragile and doesn’t need protecting.

    -

    2.1bug fix in v4.16 has corrected the code to ensure this.

    -

    2.2unless memoirmemoiris loaded, which case it uses \markboth

    -

    2.3Actually it uses \mfirstucMakeUppercasepackage is automatically loaded by glossaries.)

    -

    2.4Actually it sets \acronymtypeunless the nomain option has been used.

    -

    4.1The glossaries-extra package provides a simpler way of achieving this.

    -

    4.2This is because \acronymtypeacronym package option is not used.

    used.

    5.1This feature was introduced in makeglossaries version 2.18.

    -

    6.1I’ve used \MakeUppercase in all the examples for clarity, but it will actually use \mfirstucMakeUppercase.

    -

    6.2\glsdisplayfirst but you may need to use the compatible-3.07 option

    -

    8.1makeindex will always assign a location number, even if it’s not needed, so it needs to be discarded.

    discarded.

    8.2If you redefine \glsseeformat[\seename] in the output file if no optional argument is given.

    -

    8.3In versions before 3.0, \glsentryname key was href="#glo:sanitize">sanitized.

    .

    9.1versions before 3.0 used \glsentrynamebeen sanitized.

    .

    10.1you can’t use the longheaderborderlongtable environment in two column mode.

    two column mode.

    11.1see \setCompositor§3 Setting Up

    -

    11.2see \setAlphaCompositor§3 Setting Up

    -

    13.1as from version 1.18

    as from version 1.18

    13.2See David Carlisle’sexplanation in http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace

    -

    15.1These lengths will not be available if you use both the nolonguse the nostyles package option unless you explicitly load the relevant package.

    -

    15.2This style was supplied by Axel Menzel.

    -

    15.3e.g. with the flowfram package.

    -

    17.1Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after “a” in the prefix field.

    -

    17.2The earlier caveats about initial non-Latin characters apply.

    diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf index e40c4d642ec..f5fa611c60f 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 8ef6883f0ad..3b416ba21d9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -76,6 +76,7 @@ \newcommand{\glstextlike}{\hyperref[sec:glstext-like]{\cs{glstext}-like}} \IndexPrologue{\chapter*{\indexname} + \addcontentsline{toc}{chapter}{\indexname}% \markboth{\indexname}{\indexname}} \longnewglossaryentry{indexingapp}% @@ -395,11 +396,11 @@ and~\hyperlink{option#2}{#2}} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.25} + \title{User Manual for glossaries.sty v4.26} \author{Nicola L.C. Talbot\\% \url{http://www.dickimaw-books.com/}} - \date{2016-06-09} + \date{2016-10-12} \maketitle \begin{abstract} @@ -477,7 +478,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.25}. +\qt{Documented Code for glossaries v4.26}. \item[INSTALL] Installation instructions. @@ -3075,7 +3076,8 @@ reference the number within the document using associated with the sub-entry. \item[\pkgopt{style}] This is a \meta{key}=\meta{value} option. -(Default is \pkgopt[list]{style}.) Its value should be the name of +(Default is \pkgopt[list]{style}, unless \sty{classicthesis} +has been loaded, in which case the default is \pkgopt[index]{style}.) Its value should be the name of the glossary style to use. This key may only be used for styles defined in \sty{glossary-list}, \sty{glossary-long}, \sty{glossary-super} or \sty{glossary-tree}. Alternatively, you can @@ -3107,7 +3109,8 @@ 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 \styfmt{glossary-list} package (unless you explicitly load \sty{glossary-list}). -Note that since the default style is \glostyle{list}, you will +Note that since the default style is \glostyle{list} (unless +\sty{classicthesis} has been loaded), you will also need to use the \pkgopt{style} option to set the style to something else. @@ -3116,7 +3119,9 @@ from automatically loading \sty{glossary-tree}. 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 \styfmt{glossary-tree} package -(unless you explicitly load \sty{glossary-tree}). +(unless you explicitly load \sty{glossary-tree}). Note that if +\sty{classicthesis} has been loaded, the default style is +\glostyle{index}, which is provided by \sty{glossary-tree}. \item[\pkgopt{nostyles}] This prevents all the predefined styles from being loaded. If you use this option, you need to load a @@ -5544,7 +5549,7 @@ provides the option to add a third custom variant. \begin{important} Avoid nesting these commands. For example don't do \cs{glslink}\marg{label}\texttt{\{\cs{gls}\marg{label2}\}} -as this is likely to cause problems. By implication, these +as this is likely to cause problems. By implication, this means that you should avoid using any of these commands within the \gloskey{text}, \gloskey{first}, \gloskey{short} or \gloskey{long} keys (or their plural equivalent) or any @@ -5942,6 +5947,8 @@ star-variant (\texttt{hyper=false}) and a plus-variant that is a \meta{key}=\meta{value} list. These commands also don't use \ics{glsentryfmt} or the equivalent definition provided by \ics{defglsentryfmt} (see \sectionref{sec:glsdisplay}). +Additional commands for abbreviations are described in +\sectionref{sec:acronyms}. Apart from \ics{glslink}, the commands described in this section also have a \emph{final} optional argument \meta{insert} which may @@ -7946,6 +7953,10 @@ change LaTeX’s \qt{fixed names}}. \chapter{Acronyms and Other Abbreviations} \label{sec:acronyms} +The \sty{glossaries-extra} package provides superior +abbreviation handling. You may want to consider using that +package instead of the commands described here. + \begin{important} Note that although this chapter uses the term \qt{acronym}, you can also use the commands described here for initialisms or contractions @@ -7955,10 +7966,9 @@ should be \qt{Abbreviations} rather than \qt{Acronyms}) then you can change the title either by redefining \ics{acronymname} (see \sectionref{sec:languages}) or by using the \gloskey[printglossary]{title} in the optional argument of \ics{printglossary} (or -\ics{printacronym}). You may prefer to use the -\gls{glossaries-extra} package which defines \cs{newabbreviation} -and treats acronyms (e.g.\ \qt{laser}) differently from other forms -of abbreviations (e.g.\ \qt{html}). +\ics{printacronym}). Alternatively consider using the +\sty{glossaries-extra} package's \pkgoptfmt{abbreviations} +option instead. \end{important} You may have noticed in \sectionref{sec:newglosentry} that when you @@ -7995,8 +8005,11 @@ list of acronyms and then use \ics{defglsentryfmt} (not redefine \ics{glsentryfmt}) before defining your entries. \end{important} -The optional argument \marg{key-val list} allows you to specify keys -such as \gloskey{description} (when used with one of the styles that +The optional argument \marg{key-val list} allows you to specify +additional information. Any key that can be used in the second +argument of \ics{newglossaryentry} can also be used here in \meta{key-val +list}. +For example, \gloskey{description} (when used with one of the styles that require a description, described in \sectionref{sec:setacronymstyle}) or you can override plural forms of \meta{abbrv} or \meta{long} using the @@ -8043,6 +8056,10 @@ Now \verb|\gls{idn}| will produce \qt{identification number uses. \end{example} +\begin{important} +Avoid nested definitions. +\end{important} + Recall from the warning in \sectionref{sec:newglosentry} that you should avoid using the \glslike\ and \glstextlike\ commands within the value of @@ -8080,6 +8097,10 @@ or \end{verbatim} Similarly for the \glstextlike\ commands. +Other approaches are available with \sty{glossaries-extra}. +See the section \qt{Nested Links} in the \styfmt{glossaries-extra} +user manual. + \begin{important} The commands described below are similar to the \glstextlike\ commands in that they don't modify the \firstuseflag. @@ -8173,9 +8194,12 @@ where \begin{definition}[\DescribeMacro\acrfullformat] \cs{acrfullformat}\marg{long}\marg{short} \end{definition} -by default does \meta{long} (\meta{short}). -(For further details of these format commands see -\ifpdf section~\ref*{sec:code:acronym} in \fi the documented code, +by default does \meta{long} (\meta{short}). This command is now +deprecated for new acronym styles but is used by the default for +backward compatibility if \cs{setacronymstyle} +(\sectionref{sec:setacronymstyle}) hasn't been used. (For further +details of these format commands see \ifpdf +section~\ref*{sec:code:acronym} in \fi the documented code, \texttt{glossaries-code.pdf}.) There are also analogous upper case variants: @@ -8284,7 +8308,8 @@ And the full form can be obtained using: \cs{Glsentryfullpl}\marg{label} \end{definition} These again use \ics{acrfullformat} by default, but -the format may be redefined by the acronym style. +the new styles described in the section below use different +formatting commands. \section{Changing the Abbreviation Style} \label{sec:setacronymstyle} @@ -9772,6 +9797,14 @@ explicitly create a line-break within a multi-line description in a tabular-like style it's better to use \ics{newline} instead of \verb|\\|. +\begin{important} +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 +\glostyle{long}, allows multilined descriptions, you'll probably encounter +page-breaking problems if you have entries with long descriptions. +You may want to consider using the \glostyle{alttree} style instead. +\end{important} + Note that if you use the \gloskey[printglossary]{style} key in the optional argument to \ics{printnoidxglossary} (\opt1) or \ics{printglossary} (\optsand23), it will override any @@ -9827,6 +9860,11 @@ environment. These styles all ignore the entry's symbol. Note that these styles will automatically be available unless you use the \pkgopt{nolist} or \pkgopt{nostyles} package options. +\begin{important} +Note that, except for the \glostyle{listdotted} style, these +list styles are incompatible with \sty{classicthesis}. +\end{important} + \begin{description} \item[list] The \glostyle{list} style uses the \env{description} environment. The entry name is placed in the optional argument of @@ -9836,6 +9874,8 @@ 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 \ics{indexspace}. +The closest matching non-list style is the \glostyle{index} style. + \item[listgroup] The \glostyle{listgroup} style is like \glostyle{list} but the glossary groups have headings obtained using \cs{glsgetgrouptitle}\marg{label}, @@ -9879,6 +9919,14 @@ with the \glostyle{list} style, the symbol is ignored.) Each child entry starts a new line, but as with the \glostyle{list} style, the name associated with each child entry is ignored. +The closest matching non-list style is the \glostyle{index} +style with the following adjustment: +\begin{verbatim} +\renewcommand{\glstreepredesc}{% + \glstreeitem\parindent\hangindent} +\end{verbatim} + + \item[altlistgroup] The \glostyle{altlistgroup} style is like \glostyle{altlist} but the glossary groups have headings. @@ -9898,10 +9946,24 @@ ignores both the \gls{numberlist} and the symbol. The length 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 \glostyle{index} style +with +\begin{verbatim} +\renewcommand{\glstreepredesc}{\dotfill} +\renewcommand{\glstreechildpredesc}{\dotfill} +\end{verbatim} +Note that this doesn't use \cs{glslistdottedwidth} and causes +the description to be flush-right and will display the +symbol, if provided. (It also doesn't suppress +the \gls*{numberlist}, but that can be achieved with the +\pkgopt{nonumberlist} option.) + \item[sublistdotted] This is a variation on the \glostyle{listdotted} style designed for hierarchical glossaries. The main entries have just the name displayed. The sub entries are displayed in -the same manner as \glostyle{listdotted}. +the same manner as \glostyle{listdotted}. Unlike the +\glostyle{listdotted} style, this style is incompatible with +\sty{classicthesis}. \end{description} @@ -10356,7 +10418,9 @@ 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 \pkgopt{notree} or \pkgopt{nostyles} package -options. These styles all format the entry name using: +options. + +These styles all format the entry name using: \begin{definition}[\DescribeMacro\glstreenamefmt] \cs{glstreenamefmt}\marg{name} \end{definition} @@ -10379,6 +10443,30 @@ which defaults to \cs{glstreenamefmt}\marg{text}. Note that this is different from \cs{glslistnavigationitem}, provided with the styles such as \glostyle{listhypergroup}, as that also includes \cs{item}. +With the exception of the \glostyle{alttree} style (and those +derived from it), the space before the description for top-level +entries is produced with +\begin{definition}[\DescribeMacro\glstreepredesc] +\cs{glstreepredesc} +\end{definition} +This defaults to \cs{space}. + +With the exception of the \glostyle{treenoname} and +\glostyle{alttree} styles (and those derived from them), the +space before the description for child +entries is produced with +\begin{definition}[\DescribeMacro\glstreechildpredesc] +\cs{glstreechildpredesc} +\end{definition} +This defaults to \cs{space}. + +\begin{important} +Most of these styles are not designed for multi-paragraph +descriptions. (The \glostyle{tree} style isn't too bad for +multi-paragraph top-level entry descriptions, or you can use the +\glostyle{index} style with the adjustment shown below.) +\end{important} + \begin{description} \item[index] The \glostyle{index} style is similar to the way indices are usually formatted in that it has a hierarchical @@ -10389,6 +10477,37 @@ Sub-entries are indented and also include the name, the symbol in brackets (if present) and the description. Groups are separated using \ics{indexspace}. +Each main level item is started with +\begin{definition}[\DescribeMacro\glstreeitem] +\cs{glstreeitem} +\end{definition} +The level~1 entries are started with +\begin{definition}[\DescribeMacro\glstreesubitem] +\cs{glstreesubitem} +\end{definition} + +The level~2 entries are started with +\begin{definition}[\DescribeMacro\glstreesubsubitem] +\cs{glstreesubsubitem} +\end{definition} + +Note that the \glostyle{index} style automatically sets +\begin{verbatim} +\let\item\glstreeitem +\let\subitem\glstreesubitem +\let\subsubitem\glstreesubsubitem +\end{verbatim} +at the start of the glossary for backward compatibility. + +The \glostyle{index} style isn't suitable for multi-paragraph +descriptions, but this limitation can be overcome by redefining +the above commands. For example: +\begin{verbatim} +\renewcommand{\glstreeitem}{% + \parindent0pt\par\hangindent40pt + \everypar{\parindent50pt\hangindent40pt}} +\end{verbatim} + \item[indexgroup] The \glostyle{indexgroup} style is similar to the \glostyle{index} style except that each group has a heading obtained using \cs{glsgetgrouptitle}\marg{label}, diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index eda478fcee2..b2e3e872828 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -10,7 +10,6 @@ -