From f6f97a69d3847af9a8c49c35bd957fe0b35201e8 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 27 Feb 2018 20:36:27 +0000 Subject: glossaries-extra (27feb18) git-svn-id: svn://tug.org/texlive/trunk@46755 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 5 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 1077653 -> 1109549 bytes .../glossaries-extra/glossaries-extra-manual.html | 9801 +++++++++++--------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 856813 -> 651390 bytes .../glossaries-extra/glossaries-extra-manual.tex | 792 +- .../latex/glossaries-extra/sample-abbr-styles.pdf | Bin 512950 -> 512950 bytes .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44749 -> 44749 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80745 -> 80745 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50358 -> 50358 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36734 -> 36734 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43863 -> 43863 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35296 -> 35296 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91049 -> 91049 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69519 -> 69519 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54855 -> 54855 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 142288 -> 142288 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 161738 -> 161729 bytes .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 41281 -> 41281 bytes .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41603 -> 41603 bytes .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45245 -> 45245 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54610 -> 54610 bytes .../doc/latex/glossaries-extra/sample-external.pdf | Bin 55773 -> 55773 bytes .../doc/latex/glossaries-extra/sample-fmt.pdf | Bin 75114 -> 97551 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63220 -> 63220 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125899 -> 125899 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42711 -> 42711 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81603 -> 81603 bytes .../latex/glossaries-extra/sample-linkcount.pdf | Bin 38222 -> 38222 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57809 -> 57809 bytes .../latex/glossaries-extra/sample-mixedsort.pdf | Bin 45141 -> 45141 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 160174 -> 160173 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202082 -> 202082 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67724 -> 67724 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47572 -> 47572 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44514 -> 44514 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106058 -> 106058 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19860 -> 19861 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43469 -> 43469 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38788 -> 38788 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37047 -> 37047 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67878 -> 67878 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33107 -> 33107 bytes .../doc/latex/glossaries-extra/sample-record.pdf | Bin 48035 -> 48035 bytes .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47883 -> 47883 bytes .../latex/glossaries-extra/sample-suppl-hyp.pdf | Bin 34931 -> 34931 bytes .../glossaries-extra/sample-suppl-main-hyp.pdf | Bin 46388 -> 46388 bytes .../latex/glossaries-extra/sample-suppl-main.pdf | Bin 31596 -> 31596 bytes .../doc/latex/glossaries-extra/sample-suppl.pdf | Bin 13411 -> 13411 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49443 -> 49443 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33219 -> 33219 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61040 -> 61040 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45734 -> 45734 bytes 53 files changed, 6389 insertions(+), 4213 deletions(-) (limited to 'Master/texmf-dist/doc/latex') diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index e9cab792509..9cb421f8b7a 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,8 @@ +1.27 (2018-02-26): + + * added supplementary package glossaries-extra-bib2gls.sty + (automatically loaded by the record=only package option) + 1.26 (2018-01-05): * glossaries-extra.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index da9487871e2..6577a2b8b65 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/README +++ b/Master/texmf-dist/doc/latex/glossaries-extra/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries-extra v1.26 +LaTeX Package : glossaries-extra v1.27 -Last Modified : 2018-01-05 +Last Modified : 2018-02-26 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf index 7b901e61e36..81a79231f4b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html index 19a71c39a80..febcbae4b1c 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html +++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.html @@ -202,22 +202,22 @@ a span.HoLogo-TeX span.HoLogo-e{text-decoration:none;} -

-

+

-

+

-

-

glossaries-extra.sty v1.26: an extension to the +

+

glossaries-extra.sty v1.27: an extension to the glossaries package

@@ -240,22 +240,22 @@ class="td11">http://www.dickimaw-books.com/
-

2018-01-05

+

2018-02-26

-

+

-

-

+

Abstract

-

The

The glossaries-extra package is an extension to the glossaries package, providing additional features. Some of the features provided by this package are only available @@ -263,7 +263,7 @@ with glossaries version 4.19 (or above). This document assumes familiarity with the glossaries package. -

The file

The file example-glossaries-xr.tex contains dummy entries with cross-references that may be used for creating minimal working examples for testing the bib2gls

-

Since

-

-

Additional resources:

+

+

Additional resources:

+href="http://www.latex-community.org/know-how/latex/55-latex-general/263-glossaries-nomenclature-lists-of-symbols-and-acronyms" >Glossaries, Nomenclature, Lists of Symbols and Acronyms. + +
  • The base glossaries package.
  • @@ -410,47 +415,50 @@ href="#selection" id="QQ2-1-36">Selection
     9.2 Sorting and Displaying the Glossary
     9.3 Supplementary Commands +href="#x1-360009.3" id="QQ2-1-38">The glossaries-extra-bib2gls package
     9.4 Record Counting +href="#supplementarycommands" id="QQ2-1-39">Supplementary Commands +
     9.5 Record Counting
    10 Miscellaneous New Commands +href="#sec:miscnew" id="QQ2-1-41">Miscellaneous New Commands
     10.1 Entry Fields +href="#sec:fields" id="QQ2-1-42">Entry Fields
     10.2 Display All Entries Without Sorting or Indexing +href="#sec:printunsrt" id="QQ2-1-43">Display All Entries Without Sorting or Indexing
     10.3 Standalone Entry Items +href="#sec:glossentry" id="QQ2-1-44">Standalone Entry Items
     10.4 Entry Aliases +href="#sec:alias" id="QQ2-1-45">Entry Aliases
    11 Supplemental Packages +href="#sec:supplemental" id="QQ2-1-46">Supplemental Packages
     11.1 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-47">Prefixes or Determiners
     11.2 Accessibility Support +href="#sec:accsupp" id="QQ2-1-48">Accessibility Support
    12 Sample Files +href="#sec:samples" id="QQ2-1-49">Sample Files
    13 Multi-Lingual Support +href="#sec:lang" id="QQ2-1-50">Multi-Lingual Support
    Glossary
    -

    1.

    1. Introduction

    -

    The

    The glossaries package is a flexible package, but it’s also a heavy-weight package that uses a lot of resources. As package developer, I’m caught between those users who complain about the drawbacks of a heavy-weight package with a large user manual and those users who want more features (which necessarily adds to the package weight and manual size). -

    The

    The glossaries-extra package is an attempt to provide a compromise for this conflict. Version 4.22 of the glossaries package is the last version to incorporate new @@ -466,10 +474,10 @@ of package loading time and allocation of resources, but those users who do want extra features available will have more of a chance of getting their feature requests accepted.

    -

    Top

    1.1 Package Defaults

    -

    I’m not happy with some of the default settings assumed by the

    I’m not happy with some of the default settings assumed by the glossaries package, and, judging from code I’ve seen, other users also seem unhappy with them, as certain package options are often used in questions posted on various sites. I can’t @@ -479,7 +487,7 @@ but since glossaries-extra is a separate package, I have decided to implement some of these commonly-used options by default. You can switch them back if they’re not appropriate. -

    The new defaults are:

    +

    The new defaults are:

    -

    This is like: +

    This is like: @@ -580,7 +588,7 @@ Commands and Styles).  
    \usepackage[toc,nopostdot]{glossaries}  
    \usepackage{glossaries-extra}

    -

    +

  • @@ -592,7 +600,7 @@ Commands and Styles).  
    \usepackage{babel}  
    \usepackage{glossaries-extra} -

    This is like: +

    This is like: @@ -603,7 +611,7 @@ Commands and Styles).  
    \usepackage[toc,nopostdot,translate=babel]{glossaries}  
    \usepackage{glossaries-extra} -

    +

  • @@ -614,7 +622,7 @@ Commands and Styles). \documentclass{memoir}  
    \usepackage{glossaries-extra} -

    This is like: +

    This is like: @@ -624,7 +632,7 @@ Commands and Styles).  
    \usepackage[toc,nopostdot,noredefwarn]{glossaries}  
    \usepackage{glossaries-extra} -

    However @@ -635,7 +643,7 @@ class="cmti-10">However  
    \usepackage{glossaries}  
    \usepackage{glossaries-extra} -

    This is like: +

    This is like: @@ -645,19 +653,19 @@ class="cmti-10">However  
    \usepackage[toc,nopostdot]{glossaries}  
    \usepackage{glossaries-extra} -

    Since by the time

    Since by the time glossaries-extra has been loaded, glossaries has already redefined memoir’s glossary-related commands.

  • -

    Another noticeable change is that by default

    Another noticeable change is that by default \printglossary will now display information text in the document if the external glossary file doesn’t exist. This is explanatory text to help new users who can’t work out what to do next to complete the document build. Once the document is set up correctly and the external files have been generated, this text will disappear. -

    This change is mostly likely to be noticed by users with one or more +

    This change is mostly likely to be noticed by users with one or more redundant empty glossaries who ignore transcript messages, explicitly use \printglossaries  
    \end{document} -

    The above document will only display the list of acronyms at the place where +

    The above document will only display the list of acronyms at the place where \printglossaries occurs. However it will also attempt to input the .gls file associated with the main glossary. -

    If you use

    If you use makeglossaries, you’ll get the warning message: @@ -708,7 +716,7 @@ Warning: File 'test.glo' is empty.  
    Remember to use package option 'nomain' if you  
    don't want to use the main glossary. -

    (where the original file is called

    (where the original file is called test.tex) but if you simply call No file test.gls. -

    This doesn’t occur with

    This doesn’t occur with makeglossaries as it will create the .gls file containing the single command \null. -

    If you simply change from

    If you simply change from glossaries to glossaries-extra in this document, you’ll find a change in the resulting PDF if you don’t use .acr file with makeindex. -

    The transcript file will still contain the message about the missing

    The transcript file will still contain the message about the missing .gls, but now you’ll also see information in the actual PDF document. The simplest remedy is to follow the advice inserted into the document at that point, which is to add the @@ -766,19 +774,19 @@ class="cmss-10">nomain\printglossaries  
    \end{document} -

    (Note the need to set the acronym style using

    (Note the need to set the acronym style using \setabbreviationstyle before \newacronym. See §3 Abbreviations for further details.) -

    +

    -

    Top

    1.2 New or Modified Package Options

    -

    If you haven’t already loaded

    If you haven’t already loaded glossaries, you can use any of the package options provided by glossaries when you load \setupglossariesglossaries package options may be used in that command. -

    This section only lists options that are either unrecognised by the

    This section only lists options that are either unrecognised by the glossaries package or are a modified version of options of the same name provided by glossaries. See the glossaries user manual for details about the unmodified options.
    -

    -

    The new and modified options provided by

    +

    The new and modified options provided by glossaries-extra are described below: @@ -828,7 +836,7 @@ class="cmss-10">glossaries v4.32, so if you want to use this option with class="cmss-10">glossaries-extra you must make sure that your version of glossaries supports it. -

    The

    The glossaries-extra package extends this option to provide the additional values debug=all. -

    The

    The debug=showwrglossdebug=true and uses -



    \glsxtrwrglossmark  \glsxtrwrglossmark

    -

    +

    to show a mark just before the write operation performed by the indexing commands. If you use makeindex or id="dx1-4013">xindy. -

    The

    The debug=allpostpunc=; does

    -

    The value may also be one of the following keywords: +

    The value may also be one of the following keywords:

    comma=comma \renewcommand{\glspostdescription}{,}
    -

    +

    dot=dot \renewcommand{\glspostdescription}{.\spacefactor\sfcode`\. }
    -

    +

    none=none \renewcommand{\glspostdescription}{} -

    -

    The default definition is +

    +

    The default definition is @@ -972,7 +980,7 @@ class="cmss-10">=none  \ifglsnopostdot\else.\spacefactor\sfcode`\. \fi  
    } -

    where the conditional is determined by the

    where the conditional is determined by the nopostdot package option. @@ -990,7 +998,7 @@ class="cmss-10">postdot will restore the original definition of \glspostdescription. -

    The

    The glossaries-extra-stylemods package adjusts the predefined styles that had a hard-coded \hfil: \usepackage[postpunc=comma,stylemods]{glossaries-extra}  
    \renewcommand{\glsxtrprelocation}{\hfil} -

    Be careful with doing this as it will look odd if the

    Be careful with doing this as it will look odd if the number list is missing. (With accsuppLoad the glossaries-accsupp package (if not already loaded). -

    If you want to define styles that can interface with the accessibility support +

    If you want to define styles that can interface with the accessibility support provided by glossaries-accsupp use the §11.2 Accessibility Support for further details.) -

    Note that the

    Note that the accsupp option can only be used as a package option (not @@ -1126,7 +1134,7 @@ href="#styopt.undefaction">undefaction=warn. -

    Undefined entries can’t be picked up by any commands that iterate +

    Undefined entries can’t be picked up by any commands that iterate over a glossary list. This includes \forglsentries and \glsaddall

    +

    indexcrossrefs to false. -

    Note that

    Note that bib2gls\glsxtrusesee and \glsxtruseseealso) but cross-reference won’t be automatically indexed. -

    Note that the

    Note that the record=onlyautoseeindex=false. -

    For example, if an entry is defined as +

    For example, if an entry is defined as @@ -1217,7 +1225,7 @@ class="cmss-10">=false \newglossaryentry{foo}{name={foo},description={},see={bar,baz}} -

    then with

    then with autoseeindex=true, this is equivalent to @@ -1229,7 +1237,7 @@ class="cmtt-10">autoseeindex=true, this is equivalent to  
    \glossariesextrasetup{indexcrossrefs=true}  
    \GlsXtrSetField{foo}{see}{bar,baz} -

    but with

    but with autoseeindex=false, this is equivalent to @@ -1239,7 +1247,7 @@ class="cmtt-10">autoseeindex=false, this is equivalent to \newglossaryentry{foo}{name={foo},description={}}  
    \GlsXtrSetField{foo}{see}{bar,baz} -

    Note that

    Note that indexcrossrefs isn’t automatically implemented by the presence of the @@ -1249,9 +1257,9 @@ class="cmss-10">seeautoseeindex is false. -

    It’s therefore possible to remove the cross-references from the location lists and +

    It’s therefore possible to remove the cross-references from the location lists and set their position within the glossary style. -

    Another method of preventing the automatic indexing is to define the entries +

    Another method of preventing the automatic indexing is to define the entries before the external indexing files have been opened with \makeglossaries. Since the appropriate file isn’t open, the information can’t be written to it. @@ -1275,7 +1283,7 @@ class="cmtt-10">bib2gls§9 bib2gls: Managing Reference Databases). -

    The option may only be set in the preamble and can’t be used after +

    The option may only be set in the preamble and can’t be used after \GlsXtrLoadResources. If the value is missing \makenoidxglossaries is permitted. This setting imp href="#styopt.undefaction">undefaction=warn. -

    The glossaries should be displayed using and automatically loads the supplementary + glossaries-extra-bib2gls package. (There should be no need to explicitly + load glossaries-extra-bib2gls.) +

    The glossaries should be displayed using \printunsrtglossary (or \printunsrtglossaries). -

    The document build process is (assuming the file is called

    The document build process is (assuming the file is called myDoc.tex): @@ -1329,57 +1343,57 @@ class="cmtt-10">myDoc.tex):  
    bib2gls myDoc  
    pdflatex myDoc -

    -

    Note that

    +

    Note that record=only will prevent the will prevent the see from automatically + id="dx1-4083"> from automatically implementing \glssee. (bib2gls deals with the deals with the see field.) You + id="dx1-4086"> field.) You may explicitly use \glssee in the document, but bib2gls will + id="dx1-4088"> will ignore the cross-reference if the see field was already set for that + id="dx1-4089"> field was already set for that entry. -

    The

    The record=only option will automatically set the option will automatically set the glossaries package’s sort=none option if available. (That option value was only introduced to + id="dx1-4091"> option if available. (That option value was only introduced to glossaries v4.30.)

    alsoindex
    This is a hybrid setting that uses bib2gls to fetch entry information + id="dx1-4093"> to fetch entry information from .bib files, but uses makeindex or xindy to create the glossary files. This option should be used with \makeglossaries but not \makenoidxglossaries. You may need to change the transcript file used by bib2gls to avoid a clash with the transcript file used by bib2gls to avoid a clash with the transcript file used by makeindex or xindy. (This can be done with bib2gls’s ’s --log-file or -t option.) -

    The glossaries should be displayed using

    The glossaries should be displayed using \printglossary (or \printglossaries). -

    The document build process is (assuming the file is called \printglossaries). This option is expected to be used with bib2gls’s + sort=none setting and so glossaries-extra-bib2gls is not automatically + loaded. +

    The document build process is (assuming the file is called myDoc.tex): @@ -1419,16 +1441,16 @@ class="cmtt-10">myDoc.tex):  
    makeglossaries myDoc  
    pdflatex myDoc -

    -

    With the recording on (

    +

    With the recording on (record=only or or record=alsoindex), any of the commands + id="dx1-4106">), any of the commands that would typically index the entry (such as \gls, \glstext or \glsadd) will add a \glsxtr@record entry to the .aux file. bib2gls can then + id="dx1-4108"> can then read these lines to find out which entries have been used. (Remember that commands like \glsentryname don’t index, so any use of these @@ -1455,7 +1477,7 @@ href="#sec:bib2gls">bib2gls: Managing Reference Databases

    Remember that if

    Remember that if \newglossaryentry wouldn’t be allowed in the document environment with the base environment with the base glossaries package, then it still won’t be allowed with docdefs=true. If your glossaries occur at the + id="dx1-4121">. If your glossaries occur at the end of the document, consider using docdef=restricted instead. + id="dx1-4122"> instead.

  • (new to version 1.06) \newglossaryentry is permitted in the + id="dx1-4124"> is permitted in the document environment without using the environment without using the .glsdefs file. This means that all entries must be defined before the glossary is displayed, but it avoids the complications associated with saving the entry details @@ -1529,15 +1551,15 @@ class="cmtt-10">.glsdefs file. This means class="cmti-10">key⟩=⟨value⟩ mechanism (that is, the comma and equal sign) and any makeindex or xindy character that occurs in the sort key or label. If any of those characters + id="dx1-4129"> key or label. If any of those characters are made active in the document, then it can cause problems with the entry definition. This option will allow \newglossaryentry to @@ -1545,12 +1567,12 @@ class="cmtt-10">\newglossaryentry to class="cmtt-10">\makenoidxglossaries, but note that \longnewglossaryentry remains a preamble-only command. -

    With this option, if an entry appears in the glossary before it has been +

    With this option, if an entry appears in the glossary before it has been defined, an error will occur (or a warning if the undefaction=warn + id="dx1-4130"> option is used.) If you edit your document and either remove an entry or change its label, you may need to delete the document’s temporary files (such as the .aux and .gls files).

  • -

    The

    The glossaries package allows \newglossaryentry within the document + id="dx1-4131"> environment (when used with makeindex or xindy) but the user manual warns against this usage. By default the prohibits this, only allowing definitions within the preamble. If you are really determined to define entries in the document environment, despite all the associated drawbacks, you + id="dx1-4135"> environment, despite all the associated drawbacks, you can restore this with docdef=true. Note that this doesn’t change the + id="dx1-4137">. Note that this doesn’t change the prohibitions that the glossaries package has in certain circumstances (for example, when using “option 1”). See the glossaries user manual for href="#styopt.docdef">docdef=restricted. Only use . Only use docdef=true if document definitions + id="dx1-4139"> if document definitions are necessary and one or more of the glossaries occurs in the front matter. -

    This option affects commands that internally use

    This option affects commands that internally use \newglossaryentry, such as \newabbreviation, but not the “on-the-fly” commands described in On-the-Fly Document Definitions



    \printabbreviations  \printabbreviations[options]

    -

    +

    which is equivalent to

    options]
    The title of the new glossary is given by -



    \abbreviationsname  \abbreviationsname

    -

    +

    If this command is already defined, it’s left unchanged. Otherwise it’s defined to “Abbreviations” if babel hasn’t been loaded or hasn’t been loaded or \acronymname if babel has been loaded. However, if you’re using has been loaded. However, if you’re using babel it’s likely you + id="dx1-4146"> it’s likely you will need to change this. (See §13 Multi-Lingual Support for further details.) -

    If you don’t use the

    If you don’t use the abbreviations package option, the package option, the \abbreviationsname command won’t be defined (unless it’s defined by an included language file).
    -

    -

    If the

    +

    If the abbreviations option is used and the option is used and the acronym option provided by the + id="dx1-4149"> option provided by the glossaries package hasn’t been used, then \acronymtype will be set to + id="dx1-4150"> will be set to \glsxtrabbrvtype so that acronyms defined with so that acronyms defined with \newacronym can be added + id="dx1-4152"> can be added to the list of abbreviations. If you want acronyms in the main glossary and other abbreviations in the main:

    \renewcommand*{\acronymtype}{main}
    -

    -

    Note that there are no analogous options to the

    +

    Note that there are no analogous options to the glossaries package’s acronymlists + id="dx1-4153"> option (or associated commands) as the abbreviation mechanism is handled differently with glossaries-extra. @@ -1720,13 +1742,13 @@ class="cmss-10">glossaries-extra. symbols

    This is passed to glossaries but will additionally define -



    \glsxtrnewsymbol  \glsxtrnewsymbol[options]{}{symbol}

    -

    +

    which is equivalent to

    }
    Note that the sort key is set to the ⟨ key is set to the ⟨label⟩ not the ⟨symbol⟩ as the symbol will likely contain commands. @@ -1763,19 +1785,19 @@ class="cmti-10">symbol⟩ as the symbol will numbers
    This is passed to glossaries but will additionally define -



    \glsxtrnewnumber  \glsxtrnewnumber[options]{number}

    -

    +

    which is equivalent to

    } shortcuts
    Unlike the glossaries package option of the same name, this option isn’t boolean but has multiple values: @@ -1810,11 +1832,11 @@ class="cmss-10">glossaries package option of the same name, this option i href="#styopt.shortcuts">shortcuts=acronyms (or (or shortcuts=acro): set the shortcuts provided + id="dx1-4161">): set the shortcuts provided by the glossaries package for acronyms (such as \ac). Note that the @@ -1830,13 +1852,13 @@ class="cmss-10">glossaries-extra href="#styopt.shortcuts">shortcuts=ac. + id="dx1-4162">.
  • shortcuts=ac: set the shortcuts provided by the : set the shortcuts provided by the glossaries package for acronyms (such as \ac) but uses the \gls. href="#styopt.shortcuts">shortcuts=abbreviations (or (or shortcuts=abbr): + id="dx1-4165">): set the abbreviation shortcuts provided by glossaries-extra. (See glossaries package. href="#styopt.shortcuts">shortcuts=other: set the “other” shortcut commands, but not the shortcut + id="dx1-4166">: set the “other” shortcut commands, but not the shortcut commands for abbreviations or the acronym shortcuts provided by glossaries. The “other” shortcuts are:
    • \newentry equivalent to equivalent to \newglossaryentry + id="dx1-4168">
    • \newsym equivalent to equivalent to \glsxtrnewsymbol (see the (see the symbols + id="dx1-4171"> option).
    • \newnum equivalent to equivalent to \glsxtrnewnumber (see the (see the numbers + id="dx1-4174"> option).
  • shortcuts=all (or (or shortcuts=true): implements ): implements shortcuts=ac, + id="dx1-4177">, shortcuts=abbreviations and and shortcuts=other. + id="dx1-4179">.
  • shortcuts=none (or (or shortcuts=false): don’t define any of the shortcut + id="dx1-4181">): don’t define any of the shortcut commands (default).
  • -

    Note that multiple invocations of the

    Note that multiple invocations of the shortcuts option option within the same option list will override each other.

    -

    After the

    After the glossaries-extra package has been loaded, you can set available options using -



    \glossariesextrasetup  \glossariesextrasetup{options}

    -

    +

    The abbreviations and and docdef options may only be used in the preamble. Additionally, + id="dx1-4185"> options may only be used in the preamble. Additionally, docdef can’t be used after can’t be used after \makenoidxglossaries. + id="dx1-4187">.

    -

    -

    +

    Top

    2. Modifications to Existing Commands and Styles

    -

    The

    The glossaries package provides \nopostdesc which may be used in the descriptionglossaries-extra package provides another command -



    \glsxtrnopostpunc  \glsxtrnopostpunc

    -

    +

    which has a similar function but only suppresses the post-description punctuation. It doesn’t suppress the use of \glsxtrpostdescription which allows the use of @@ -2000,12 +2022,12 @@ class="cmtt-10">\glsxtrpostdescription not before.) The post-description hook can counter-act the effect of \glsxtrnopostpunc using -



    \glsxtrrestorepostpunc  \glsxtrrestorepostpunc

    -

    +

    These commands have no effect outside of the glossary (except with standalone entries that use \glsxtractivatenopost and §10.3 Standalone Entry Items). -

    The

    The glossaries package provides -



    \glsseeitemformat  \glsseeitemformat{label}

    -

    +

    to format items in a cross-reference list (identified with the see key or  \ifglshasshort{\glslabel}{\glsaccesstext{#1}}{\glsaccessname{#1}}%  
    }

    -

    If you want to restore the

    If you want to restore the glossaries v3.0+ definition just do: @@ -2071,8 +2093,8 @@ class="cmss-10">glossaries v3.0+ definition just do:

    \renewcommand*{\glsseeitemformat}[1]{\glsentrytext{#1}}
    -

    -

    The commands used by

    +

    The commands used by glossaries to automatically produce an error if an entry is undefined (such as \glsdoifexistsundefaction option into account. -

    The

    The \newignoredglossary{Categories for furt check that the glossary doesn’t already exist. (The glossaries package omits this check.) -

    You can now provide an ignored glossary with: -


    You can now provide an ignored glossary with: +


    \provideignoredglossary  \provideignoredglossary{type}

    -

    +

    which will only define the glossary if it doesn’t already exist. This also has a starred version that doesn’t automatically switch off hyperlinks. -

    The individual glossary displaying commands

    The individual glossary displaying commands \printglossary, \printnoidxglossary}. Another way of avoiding duplicate target names class="cmtt-10">\glolinkprefix this doesn’t affect any hyperlinks (such as those created with \gls). -

    The

    The \newglossaryentry command has three new keys:

    -

    The test file

    The test file example-glossaries-xr.tex contains dummy entries with a mixture of seebib2gls. -

    The

    The \longnewglossaryentry command now has a starred version (as from v1.12) that doesn’t automatically insert @@ -2198,8 +2220,8 @@ that doesn’t automatically insert

    \leavevmode\unskip\nopostdesc
    -

    at the end of the description field. -


    at the end of the description field. +


    \longnewglossaryentry  } class="cmtt-10">{⟨description}

    -

    +

    The descriptionplural key is left unset unless explicitly set in ⟨options⟩. -

    The unstarred version no longer hard-codes the above code (which removes +

    The unstarred version no longer hard-codes the above code (which removes trailing space and suppresses the post-description hook) but instead uses: -



    \glsxtrpostlongdescription  \glsxtrpostlongdescription

    -

    +

    This can be redefined to allow the post-description hook to work but retain the \unskip part if required. For example: @@ -2235,9 +2257,9 @@ class="cmtt-10">\unskip part if required. For example:

    \renewcommand*{\glsxtrpostlongdescription}{\leavevmode\unskip}
    -

    This will discarded unwanted trailing space at the end of the description but won’t +

    This will discarded unwanted trailing space at the end of the description but won’t suppress the post-description hook. -

    The unstarred version also alters the base

    The unstarred version also alters the base glossaries package’s treatment of the 2.1 -

    Note that this modified unstarred version doesn’t append

    Note that this modified unstarred version doesn’t append \glsxtrpostlongdescription to the description’s plural form. -

    The

    The \newterm command (defined through the §3 Abbreviations.) -

    The

    The \makeglossaries command now has an optional argument. -



    \makeglossaries  \makeglossaries[list]

    -

    +

    If ⟨list⟩ is empty, \makeglossaries behaves as per its original definition in the @@ -2293,7 +2315,7 @@ class="cmtt-10">\makeglossaries behaves as per its original definition in class="cmss-10">glossaries package, otherwise ⟨list⟩ can be a comma-separated list of glossaries that need processing with an external indexing application. -

    This command is not permitted with the

    This command is not permitted with the record=onlyrecord=off. -

    It should then be possible to use

    It should then be possible to use \printglossary for those glossaries listed in ⟨list⟩ and \printnoidxglossary for the other glossaries. (See the accompanying file sample-mixedsort.tex for an example.) -

    If you use the optional argument ⟨

    If you use the optional argument ⟨list⟩, you can’t define entries in the document (even with the docdef option).
    -

    -

    You will need at least version 2.20 of

    +

    You will need at least version 2.20 of makeglossaries or at least version 1.3 of @@ -2341,10 +2363,10 @@ class="cmss-10">automake option.

    -

    Top

    2.1 Entry Indexing

    -

    The

    The glossaries-extra package provides extra keys for commands like \gls and wrgloss=after for specific instances. Note that this opti settings (such as noindex). -

    The default value is set up using -


    The default value is set up using +


    \glsxtrinitwrgloss  \glsxtrinitwrgloss

    -

    +

    which is defined as: @@ -2430,15 +2452,15 @@ class="cmtt-10">\glsxtrinitwrgloss


     
     }%  
    }
    -

    This sets the conditional -


    This sets the conditional +


    \ifglsxtrinitwrglossbefore  \ifglsxtrinitwrgloss

    -

    +

    which is used to determine where to perform the indexing. -

    This means you can set the

    This means you can set the wrgloss attribute to \hyperlink. For

    \glssetcategoryattribute{mathrelation}{hyperoutside}{false}
    -

    will set

    will set hyperoutside=false for all entries that are assigned to the category mathrelation and @@ -2520,7 +2542,7 @@ class="cmtt-10">mathrelation and

    \glssetcategoryattribute{mathrelation}{textformat}{mathrel}
    -

    will use

    will use \mathrel instead of \glstextformat resulting in:

    @@ -2539,36 +2561,36 @@ class="cmsy-10">} class="cmss-10">category key set to mathrelation. -

    There is a new hook that’s used each time indexing information is written to the +

    There is a new hook that’s used each time indexing information is written to the external glossary files: -



    \glsxtrdowrglossaryhook  \glsxtrdowrglossaryhook{label}

    -

    +

    where ⟨label⟩ is the entry’s label. This does nothing by default but may be redefined. (See, for example, the accompanying sample file sample-indexhook.tex, which uses this hook to determine which entries haven’t been indexed.) -

    There’s also a new hook (from v1.26) that’s used immediately before the options +

    There’s also a new hook (from v1.26) that’s used immediately before the options are set by the \gls-like and \glstext-like commands: -



    \glslinkpresetkeys  \glslinkpresetkeys

    -

    +

    (The base package provides \glslinkpostsetkeys that’s used immediately after the options are set.) -

    As from version 1.14, there are two new keys for

    As from version 1.14, there are two new keys for \glsadd: thevalue and thevalue keys is intended primarily for adding locations in supplementary material that can’t be obtained from a counter. -

    The principle key

    The principle key thevalue is for the location value. The other key theHvalueprefix⟩⟨location⟩. In general, there’s little need for this key as the prefix is typically associated with a counter that can be used to form hypertargets. -

    If you use

    If you use thevalue, you must make sure that you use an indexing application that will accept the given value.
    -

    +

    -

    For example,

    For example, makeindex will only accept locations in the form [⟨num⟩⟨ \glsadd[thevalue={Supplementary Material}]{sample}

    -

    This location value will be accepted by

    This location value will be accepted by bib2glsformat key to prevent a hyperlink if one can’t naturally be formed from the prefix, counter and location value. -

    For example, suppose the file

    For example, suppose the file suppl.tex contains: @@ -2661,7 +2683,7 @@ class="cmtt-10">suppl.tex contains:  
    \gls{sample}.  
    \end{document}

    -

    This has an entry on page S.2. Suppose another document wants to include this +

    This has an entry on page S.2. Suppose another document wants to include this location in the glossary. Then this can be done by setting thevalue to \glsadd[thevalue={S.2}]{sample}  
    \end{document}

    -

    This location value will be accepted by

    This location value will be accepted by makeindex as it’s in the form ⟨num⟩⟨sep⟩⟨num⟩. -

    If you want hyperlinks, things are more complicated. First you need to set the +

    If you want hyperlinks, things are more complicated. First you need to set the externallocationexternallocation\newglossaryentry{sample}{category=supplemental,  
     name={sample},description={an example}}

    -

    Next you need to add

    Next you need to add glsxtrsupphypernumber as the format: @@ -2711,7 +2733,7 @@ class="cmtt-10">glsxtrsupphypernumber as the format:

    \glsadd[thevalue={S.2},format=glsxtrsupphypernumber]{sample}
    -

    Both documents will need to use the

    Both documents will need to use the hyperref package. Remember that the counter used for the location also needs to match. If sample-suppl-main-hyp.tex for an example that uses hyperref. -

    The hyperlink for the supplementary location may or

    The hyperlink for the supplementary location may or may not take you to the relevant place in the external PDF file depending on your PDF viewer. Some may not support external links, and some may take you to the first page or last visited page.
    -

    -

    For example, if both

    +

    For example, if both sample-suppl-hyp.pdf and sample-suppl-main-hyp.pdf are in the same directory, then viewing sample-suppl-main-hyp.pdf in Evince will take you to the correct location in the linked document (when you click on the S.2 external link), but Okular will take you to the top of the first page of the linked document. -

    +

    -

    Top

    2.2 Cross-References (“see” and “see also”)

    -

    The value of the

    The value of the see key is now saved as a field. This isn’t the case with glossaries, @@ -2774,20 +2796,20 @@ class="cmss-10">document environment on the next run. -

    This modification allows

    This modification allows glossaries-extra to provide -



    \glsxtraddallcrossrefs  \glsxtraddallcrossrefs

    -

    +

    which is used at the end of the document to automatically add any unused cross-references unless the package option indexcrossrefs was set to false. -

    As a by-product of this enhancement, the

    As a by-product of this enhancement, the see key will now work for entries defined in the see value to be stored even though it may not be possible to index it at that point. -

    As from version 1.06, you can display the cross-referenced information for a given +

    As from version 1.06, you can display the cross-referenced information for a given entry using -



    \glsxtrusesee  \glsxtrusesee{label}

    -

    +

    This internally uses -



    \glsxtruseseeformat  tag}{xr list}

    -

    +

    where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field hasn’t been set for the entry given by ⟨label⟩. -

    Suppose you want to suppress the

    Suppose you want to suppress the number list using nonumberlistsee key set, but this will also show the rest of the number list. -

    Another approach in this situation is to use the post description hook +

    Another approach in this situation is to use the post description hook with \glsxtrusesee to append the cross-reference after the description. For example: @@ -2892,11 +2914,11 @@ example:  
     {}%  
    }

    -

    Now the cross-references can appear even though the

    Now the cross-references can appear even though the number list has been suppressed. -

    As from v1.16, there’s a separate

    As from v1.16, there’s a separate seealso key. Unlike see\seealsoname or \glsxtruseseealsoformat, described below). -

    You can display the formatted list of cross-references stored in the

    You can display the formatted list of cross-references stored in the seealso key using: -



    \glsxtruseseealso  \glsxtruseseealso{label}

    -

    +

    This works in much the same way as \glsxtrusesee but it internally uses -



    \glsxtruseseeformat  \glsxtruseseealsoformat{xr list}

    -

    +

    For example: @@ -2953,20 +2975,20 @@ For example:  
     {}%  
    }

    -

    -

    The actual unformatted comma-separated list ⟨

    +

    The actual unformatted comma-separated list ⟨xr-list⟩ stored in the seealso field can be accessed with: -



    \glsxtrseealsolabels  \glsxtrseealsolabels{label}

    -

    +

    This will just expand to the ⟨xr-labels⟩ provided in the value of the seealso[⟨tag], so it can’t be automatically treated as a simple comma-separated list. -

    The base

    The base glossaries package provides \glsseelist, which requires a @@ -2992,20 +3014,20 @@ class="cmti-10">label⟩} as the argument. For convenience, glossaries-extra provides -



    \glsxtrseelist  \glsxtrseelist{xr list}

    -

    +

    which fully expands its argument and passes it to \glsseelist. -

    The

    The seealso key implements the automatic indexing using -



    \glsxtrindexseealso  label}{xr list}

    -

    +

    which just does

    glossaries v4.30+, in which case a distinct seealso cross-reference class is used instead. -

    +

    -

    Top

    2.3 Entry Display Style Modifications

    -

    Recall from the

    Recall from the glossaries package that commands such as \gls display text at that point in the document (optionally with a hyperlink to the relevant @@ -3052,7 +3074,7 @@ whether or not it actually has a hyperlink. The actual text and the way it’s displayed depends on the command used (such as \gls) and the entry format. -

    The default entry format (

    The default entry format (\glsentryfmt) used in the §3.2 Abbreviation Styles). -

    This means that entries with a short form can be treated as regular entries rather +

    This means that entries with a short form can be treated as regular entries rather than abbreviations if it’s more appropriate for the desired style. -

    As from version 1.04,

    As from version 1.04, \glsentryfmt now puts \glsgenentry in the argument of the new command -



    \glsxtrregularfont  \glsxtrregularfont{text}

    -

    +

    This just does its argument ⟨text⟩ by default. This means that if you want regular entries in a different font but don’t want that font to apply to abbreviations, then @@ -3163,7 +3185,7 @@ overridden by the textformat attribute. -

    For example: +

    For example: @@ -3171,7 +3193,7 @@ class="cmss-10">textformat \renewcommand*{\glsxtrregularfont}[1]{\textsf{#1}}

    -

    You can access the label through

    You can access the label through \glslabel. For example, you can query the category: @@ -3182,7 +3204,7 @@ category: \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifcategory{\glslabel}{general}{\textsf{#1}}{#1}}

    -

    or query the category attribute, for example, provide a custom attribute called +

    or query the category attribute, for example, provide a custom attribute called font: @@ -3194,7 +3216,7 @@ class="cmtt-10">font:  
    \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifattribute{\glslabel}{font}{sf}{\textsf{#1}}{#1}}

    -

    As from version 1.21, it’s simpler to just do, for example: +

    As from version 1.21, it’s simpler to just do, for example: @@ -3202,9 +3224,9 @@ class="cmtt-10">font:

    \glssetcategoryattribute{general}{textformat}{textsf}
    -

    without redefining

    without redefining \glsxtrregularfont. -

    The

    The \glspostlinkhook provided by the glossaries package to insert information after the link-text produced by commands like \gls and \glstext is redefined to -



    \glsxtrpostlinkhook  \glsxtrpostlinkhook

    -

    +

    This command will discard a following full stop (period) if the discardperiod attribute is set to “true” for the current entry’s category. It will also do -



    \glsxtrpostlink  \glsxtrpostlink

    -

    +

    if a full stop hasn’t be discarded and -



    \glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence

    -

    +

    if a full stop has been discarded. -

    It may be that you want to check some other setting (rather than a category +

    It may be that you want to check some other setting (rather than a category attribute) to determine whether or not to discard a following full stop. In which case you can redefine: -



    \glsxtrifcustomdiscardperiod  } class="cmtt-10">{⟨false}

    -

    +

    You can access the field’s label using \glslabel. This command should do ⟨true⟩ if the @@ -3266,9 +3288,9 @@ definition is simply:

    \newcommand*{\glsxtrifcustomdiscardperiod}[2]{#2}
    -

    which means that no additional checks are performed. (Only the recognised category +

    which means that no additional checks are performed. (Only the recognised category attributes will be checked.) -

    Avoid the use of

    Avoid the use of \gls-like and \glstext-like commands within the post-link hook as they will cause interference. Consider using commands like @@ -3280,8 +3302,8 @@ href="#sec:nested">§2.6 Nested Links) instead.
    -

    -

    By default

    +

    By default \glsxtrpostlink just does \glsxtrpostlinkcategorygeneral category, \glsxtrpostlinkgeneral if it has been defined.) -

    The sentence-ending hook is slightly more complicated. If the command +

    The sentence-ending hook is slightly more complicated. If the command \glsxtrpostlinkcategory

    There are some convenient commands you might want to use when customizing +

    There are some convenient commands you might want to use when customizing the post-link-text category hooks: -



    \glsxtrpostlinkAddDescOnFirstUse  \glsxtrpostlinkAddDescOnFirstUse

    -

    +

    This will add the description in parentheses on first use. -

    For example, suppose you want to append the description in parentheses on

    For example, suppose you want to append the description in parentheses on first use for entries in the symbolsymbol  \glsxtrpostlinkAddDescOnFirstUse  
    }

    -

    -


    +


    \glsxtrpostlinkAddSymbolOnFirstUse  \glsxtrpostlinkAddSymbolOnFirstUse

    -

    +

    This will append the symbol (if defined) in parentheses on first use. -

    If you want to provide your own custom format be aware that you can’t use +

    If you want to provide your own custom format be aware that you can’t use \ifglsused within the post-link-text hook as by this point the first use flag will have been unset. Instead you can use -



    \glsxtrifwasfirstuse  true}{false}

    -

    +

    This will do ⟨true⟩ if the last used entry was the first use for that entry, otherwise it @@ -3376,7 +3398,7 @@ locally set by commands like \gls, so don’t rely on it outside of the post-link-text hook. -

    Note that commands like

    Note that commands like \glsfirst and \glsxtrfull\glsxtrfull so that it fakes non-first use otherwise the inline full format would include the footnote, which is inappropriate.
    -

    -

    For example, if you want to place the description in a footnote after the

    +

    For example, if you want to place the description in a footnote after the link-text on first use for the general  \glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}%  
    }

    -

    -

    The

    +

    The short-postfootnote abbreviation style uses the post-link-text hook to place the footnote after trailing punctuation characters. -

    You can set the default options used by

    You can set the default options used by \glslink, \gls etc with: -



    \GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts{options}

    -

    +

    For example, if you mostly don’t want to index entries then you can do: @@ -3444,7 +3466,7 @@ For example, if you mostly don’t want to index entries then you can do:

    \GlsXtrSetDefaultGlsOpts{noindex}
    -

    and then use, for example,

    and then use, for example, \gls[noindex=false]{sample} when you actually want the location added to the \glslink and \gls. -

    Note that if you don’t want

    Note that if you don’t want any indexing, just omit \makeglossaries and wrgloss\glsxtrinitwrgloss instead. -

    \GlsXtrSetDefaultGlsOpts doesn’t affect \glsadd.
    -

    -

    If you want to change the default value of

    +

    If you want to change the default value of format, you can instead use: -



    \GlsXtrSetDefaultNumberFormat{format}

    -

    +

    This has the advantage of also working for \glsadd. For example, if you want all locations in the back matter to appear in italic (unless explicitly @@ -3488,8 +3510,8 @@ overridden): \backmatter  
    \GlsXtrSetDefaultNumberFormat{hyperit}

    -

    -

    Commands like

    +

    Commands like \gls have star (*) and plus (hyper=false and hyper=true. The glossaries-extra package provides a way to add a third modifier, if required, using -



    \GlsXtrSetAltModifier  }{options}

    -

    +

    where ⟨char⟩ is the character used as the modifier and ⟨options⟩ is the default set of options (which may be overridden). Note that ⟨char⟩ must be a single character (not a UTF-8 character, unless you are using XƎLATEX or LuaLATEX). -

    When choosing the character ⟨

    When choosing the character ⟨char⟩ take care of any changes in category code.
    -

    -

    Example: +

    +

    Example: @@ -3528,7 +3550,7 @@ class="cmti-10">char⟩ take care of any changes in category code.

    \GlsXtrSetAltModifier{!}{noindex}
    -

    This means that

    This means that \gls!{sample} will be equivalent to \gls[noindex]{sample}. It’s not possible to mix modifiers. For example, if you want to do @@ -3539,17 +3561,17 @@ not possible to mix modifiers. For example, if you want to do

    \gls[noindex,hyper=false]{sample}
    -

    you can use

    you can use \gls*[noindex]{sample} or \gls![hyper=false]{sample} but you can’t combine the * and ! modifiers. -

    Location lists displayed with \printnoidxglossary internally use -



    \glsnoidxdisplayloc  } class="cmtt-10">{⟨location}

    -

    +

    This command is provided by glossaries, but is modified by glossaries-extra to check @@ -3573,8 +3595,8 @@ class="cmtt-10">( and ) which are discarded to obtain the actual control sequence name that forms the location formatting command. -

    If the range identifiers aren’t present, this just uses -


    If the range identifiers aren’t present, this just uses +


    \glsxtrdisplaysingleloc  }{location}

    -

    +

    otherwise it uses -



    \glsxtrdisplaystartloc  }{location}

    -

    +

    for the start of a range (where the identifier has been stripped from ⟨format⟩) or -



    \glsxtrdisplayendloc  }{location}

    -

    +

    for the end of a range (where the identifier has been stripped from ⟨format⟩). -

    By default the start range command saves the format in -


    By default the start range command saves the format in +


    \glsxtrlocrangefmt  \glsxtrlocrangefmt

    -

    +

    and does
    \glsxtrdisplaysingleloc{}
    (If the format is empty, it will be replaced with glsnumberformat.) -

    The end command checks that the format matches the start of the range, +

    The end command checks that the format matches the start of the range, does -



    \glsxtrdisplayendlochook  }{location}

    -

    +

    (which does nothing by default), followed by
    \glsxtrdisplaysingleloc{\glsxtrlocrangefmt to empty. -

    This means that the list +

    This means that the list @@ -3666,7 +3688,7 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.  
    \glsnoidxdisplayloc{}{page}{textbf}{1},  
    \glsnoidxdisplayloc{}{page}{)textbf}{1}.

    -

    doesn’t display any differently from +

    doesn’t display any differently from @@ -3676,14 +3698,14 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.  
    \glsnoidxdisplayloc{}{page}{textbf}{1},  
    \glsnoidxdisplayloc{}{page}{textbf}{1}.

    -

    but it does make it easier to define your own custom list handler that can +

    but it does make it easier to define your own custom list handler that can accommodate the ranges. -

    +

    -

    Top

    2.4 Entry Counting Modifications

    -

    If you are using

    If you are using bib2gls§9 bib2gls: Managing Reference Databases instead. -

    The

    The \glsenableentrycount command is modified to allow for the §5 Categories). -

    For example, instead of just doing: +

    For example, instead of just doing: @@ -3714,7 +3736,7 @@ href="#sec:categories">Categories).

    \glsenableentrycount
    -

    you now need to do: +

    you now need to do: @@ -3723,21 +3745,21 @@ href="#sec:categories">Categories). \glsenableentrycount  
    \glssetcategoryattribute{abbreviation}{entrycount}{1}

    -

    This will enable the entry counting for entries in the

    This will enable the entry counting for entries in the abbreviation category, but any entries assigned to other categories will be unchanged. -

    Further information about entry counting, including the new per-unit feature, is +

    Further information about entry counting, including the new per-unit feature, is described in §6.1 Entry Counting (First Use Flag). -

    +

    -

    Top

    2.5 Plurals

    -

    Some languages, such as English, have a general rule that plurals are formed from +

    Some languages, such as English, have a general rule that plurals are formed from the singular with a suffix appended. This isn’t an absolute rule. There are plenty of exceptions (for example, geese, children, churches, elves, fairies, sheep). The plural

    To make life easier for languages where the majority of plurals can simply be +

    To make life easier for languages where the majority of plurals can simply be formed by appending a suffix to the singular, the glossaries package lets the plural supplied as well, and you only need to use it for the exceptions. -

    For languages that don’t have this general rule, the

    For languages that don’t have this general rule, the plural field will always need to be supplied, where needed. -

    There are other plural fields, such as

    There are other plural fields, such as firstplural, longpluralshortplural

    If these fields are omitted, the

    If these fields are omitted, the glossaries package follows these rules:

      @@ -3842,7 +3864,7 @@ class="cmtt-10">\acrpluralsuffixshort field.
    -

    This

    This last case is changed with glossaries-extra. With this extension package, the \abbrvpluralsuffix is redefined. In most cases its redefined to use -



    \glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

    -

    +

    which defaults to just \glspluralsuffix. Some of the abbreviation styles have their own command for the plural suffix, such as \abbrvpluralsuffix, which changes with the style. Redefining \acrpluralsuffix will have no affect, since it’s not used by the new abbreviation mechanism. -

    If you require a mixture (for example, in a multilingual document), there are two +

    If you require a mixture (for example, in a multilingual document), there are two attributes that affect the short plural suffix formation. The first is aposplural '\abbrvpluralsuffix

    -

    That is, an apostrophe followed by

    That is, an apostrophe followed by \abbrvpluralsuffix is appended. The second attribute is shortpluralshort. -

    +

    -

    Top

    2.6 Nested Links

    -

    Complications arise when you use

    Complications arise when you use \gls in the value of the name

    Things can go wrong if we try the following with the

    Things can go wrong if we try the following with the glossaries package: @@ -3928,8 +3950,8 @@ class="cmss-10">glossaries package:  
    \newacronym{html}{HTML}{Hypertext Markup Language}  
    \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}

    -

    -

    The main problems are: +

    +

    The main problems are:

    1. first use if the long form is displayed before the shor
      \gls{\uppercase ssi} enabled \gls{html}
      -

      which just doesn’t work. Grouping the

      which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this will effectively try to do @@ -3958,7 +3980,7 @@ class="cmtt-10">\gls{ssi} doesn’t work either as this

      \uppercase{\gls{ssi}} enabled \gls{html}
      -

      This will upper case the label

      This will upper case the label ssi so the entry won’t be recognised. This problem will also occur if you use the all capitals version, such as shtml. For example:

      This section discusses \gls{ssi}, \gls{html} and \gls{shtml}.
      -

      This produces: +

      This produces:

      -

      This section discusses server side includes (SSI), hypertext +

      This section discusses server side includes (SSI), hypertext markup language (HTML) and SSI enabled HTML (SHTML).

      -

      So the

      So the first use of the shtml entry produces “SSI enabled HTML (SHTML)”. -

      Now let’s suppose the

      Now let’s suppose the html entry is used before the shtml but the ssi entry is @@ -4021,17 +4043,17 @@ class="cmtt-10">shtml entry, for example: The sample files are either \gls{html} or \gls{shtml}, but let's  
      first discuss \gls{ssi}.

    -

    This produces: +

    This produces:

    -

    The sample files are either hypertext markup language (HTML) +

    The sample files are either hypertext markup language (HTML) or server side includes (SSI) enabled HTML (SHTML), but let’s first discuss SSI.

    -

    So the

    So the first use of the shtml entry now produces “server side includes (SSI) enabled HTML (SHTML)”, which looks a bit strange. -

    Now let’s suppose the

    Now let’s suppose the shtml entry is used before (or without) the other two entries: @@ -4041,17 +4063,17 @@ class="cmtt-10">shtml entry is used before (or without) the other two

    This article is an introduction to \gls{shtml}.
    -

    This produces: +

    This produces:

    -

    This article is an introduction to server side includes (SSI) +

    This article is an introduction to server side includes (SSI) enabled hypertext markup language (HTML) (SHTML).

    -

    So the

    So the first use of the shtml entry now produces “server side includes (SSI) enabled hypertext markup language (HTML) (SHTML)”, which is even more strange. -

    This is all aggravated by setting the style using the

    This is all aggravated by setting the style using the glossaries package’s \setacronymstyle. For example: @@ -4062,7 +4084,7 @@ class="cmtt-10">\setacronymstyle. For example:

    \setacronymstyle{long-short}
    -

    as this references the label through the use of

    as this references the label through the use of \glslabel when displaying the long and short forms, but this value changes with each use of \gls, so @@ -4074,7 +4096,7 @@ class="cmtt-10">\glslabel has been changed to html by \gls{html}. -

    Another oddity occurs if you reset the

    Another oddity occurs if you reset the html entry between uses of the shtml entry. For example: @@ -4085,10 +4107,10 @@ class="cmtt-10">shtml

    \gls{shtml} ... \glsreset{html}\gls{shtml}
    -

    The next use of

    The next use of shtml produces “Shypertext markup language (HTML)”, which is downright weird. -

    Even without this, the short form has nested formatting commands, which +

    Even without this, the short form has nested formatting commands, which amount to \acronymfont{S\acronymfont{HTML}}. This may not be a problem for some styles, but if you use one of the “sm” styles (that use hyperref -

    For these reasons it’s better to use the simple expandable commands +

    For these reasons it’s better to use the simple expandable commands like \glsentrytext or  [description={\acrshort{ssi} enabled \acrshort{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}

    -

    with

    with glossaries or: @@ -4149,7 +4171,7 @@ class="cmss-10">glossaries or:  
     [description={\glsxtrshort{ssi} enabled \glsxtrshort{html}}]  
     {shtml}{SHTML}{SSI enabled HTML}

    -

    with

    with glossaries-extra. This fixes all the above listed problems (as long as you don’t use \glsdescfirst use issue, but it doesn’t fix any of the other problems listed above. -

    If it’s simply that you want to use the abbreviation font, you can use +

    If it’s simply that you want to use the abbreviation font, you can use \glsabbrvfont: @@ -4174,10 +4196,10 @@ class="cmtt-10">\glsabbrvfont:  
    \newabbreviation{shtml}{shtml}{\glsabbrvfont{ssi} enabled  
    \glsabbrvfont{html}}

    -

    This will pick up the font style setting of the outer entry (shtml, in the above case). +

    This will pick up the font style setting of the outer entry (shtml, in the above case). This isn’t a problem in the above example as all the abbreviations use the same style. -

    However if you’re really determined to use

    However if you’re really determined to use \gls in a field that may be included within some \gls{ssi} enabled \gls{html}

    -

    is treated as +

    is treated as @@ -4210,7 +4232,7 @@ form {\glstext[hyper=false,noindex]{ssi}} enabled  
    {\glstext[hyper=false,noindex]{html}}

    -

    This overcomes problems 

    This overcomes problems 4, 5 and 6 listed above, but still doesn’t fix problems long-noshort-desc). -

    Additionally, any instance of the long form commands, such as

    Additionally, any instance of the long form commands, such as \glsxtrlong or shtml entry had instead been defined as:

    \newacronym{shtml}{SHTML}{\acrshort{ssi} enabled \acrshort{html}}
    -

    then (using the

    then (using the long-short style) the first use will be like {\acronymfont{\glsentryshort{ssi}}} enabled  
    {\acronymfont{\glsentryshort{html}}} (SHTML)

    -

    whereas if the entry is defined as: +

    whereas if the entry is defined as: @@ -4287,7 +4309,7 @@ href="#glo:firstuse">first use will be like \newabbreviation{shtml}{SHTML}{\glsxtrshort{ssi} enabled  
    \glsxtrshort{html}}

    -

    then the

    then the first use will be like: @@ -4298,7 +4320,7 @@ href="#glo:firstuse">first use will be like: {\glsabbrvfont{\glsentryshort{ssi}}} enabled  
    {\glsabbrvfont{\glsentryshort{html}}} (SHTML)

    -

    Note that the first optional argument of

    Note that the first optional argument of \acrshort or \glsxtrshort is ignored in this context. (The final optional argument will be inserted, if present.) The @@ -4309,8 +4331,8 @@ class="cmtt-10">\glsxtrshort. Note that \acrshort doesn’t set the abbreviation style. -

    Alternatively you can use: -


    Alternatively you can use: +


    \glsxtrp  field}{label}

    -

    +

    where ⟨field⟩ is the field label and corresponds to a command in the form \gls\glstext) or in the form \glsxtrfield⟩ (e.g. \glsxtrshort). -

    There’s a shortcut command for the most common fields: -


    There’s a shortcut command for the most common fields: +


    \glsps  \glsps{label}

    -

    +

    which is equivalent to \glsxtrp{short}{label}, and -



    \glspt  \glspt{label}

    -

    +

    which is equivalent to \glsxtrp{text}{label}. -

    The

    The \glsxtrp command behaves much like the \glsfmtfield⟩ commands described @@ -4373,14 +4395,14 @@ class="cmss-10">noindex to true. If you want to change this, you can use -



    \glsxtrsetpopts  \glsxtrsetpopts{options}

    -

    +

    For example: @@ -4389,17 +4411,17 @@ For example:

    \glsxtrsetpopts{hyper=false}
    -

    will just switch off the hyperlinks but not the indexing. Be careful using +

    will just switch off the hyperlinks but not the indexing. Be careful using this command or you can end up back to the original problem of nested links. -

    The hyper link is re-enabled within glossaries. This is done through the +

    The hyper link is re-enabled within glossaries. This is done through the command: -



    \glossxtrsetpopts  \glossxtrsetpopts

    -

    +

    which by default just does @@ -4408,7 +4430,7 @@ which by default just does

    \glsxtrsetpopts{noindex}
    -

    You can redefine this if you want to adjust the setting when

    You can redefine this if you want to adjust the setting when \glsxtrp is used in the glossary. For example: @@ -4418,8 +4440,8 @@ glossary. For example:

    \renewcommand{\glossxtrsetpopts}{\glsxtrsetpopts{noindex=false}}
    -

    -

    For example, +

    +

    For example, @@ -4427,7 +4449,7 @@ glossary. For example:

    \glsxtrp{short}{ssi}
    -

    is equivalent to +

    is equivalent to @@ -4437,7 +4459,7 @@ glossary. For example:  
     \glsxtrshort[hyper=false,noindex]{ssi}[]%  
    }

    -

    in the main body of the document or +

    in the main body of the document or @@ -4447,8 +4469,8 @@ glossary. For example:  
     \glsxtrshort[noindex]{ssi}[]%  
    }

    -

    inside the glossary. (Note the post-link hook is locally disabled.) -

    If

    inside the glossary. (Note the post-link hook is locally disabled.) +

    If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent to @@ -4458,19 +4480,19 @@ to

    {\glsxtrheadshort{ssi}}
    -

    (which recognises the

    (which recognises the headuc attribute.) -

    If

    If hyperref has been loaded, then the bookmark will use \glsentryfield⟩ (\glsentryshort{ssi} in the above example). -

    There are similar commands -


    There are similar commands +


    \Glsxtrp  field}{label}

    -

    +

    for first letter upper case and -



    \Glsxtrp  field}{label}

    -

    +

    for all upper case. -

    If you use any of the case-changing commands, such as

    If you use any of the case-changing commands, such as \Gls or \Glstext\gls\glstext, in the definition of entries for any of the fields that may be used by those case-changing commands.
    -

    -

    You can, with care, protect against issue 

    +

    You can, with care, protect against issue 1 by inserting an empty group at the start if the long form starts with a command that breaks the first letter uppercasing commands like \Gls, but you still won’t be able to use the all caps commands, such as \GLS. -

    If you

    If you really need nested commands, the safest method is @@ -4522,8 +4544,8 @@ class="cmti-10">really need nested commands, the safest method is \newabbreviation{shtml}{shtml}{{}\glsxtrp{short}{ssi} enabled  
    \glsxtrp{short}{html}}

    -

    but be aware that it may have some unexpected results occasionally. -

    Example document: +

    but be aware that it may have some unexpected results occasionally. +

    Example document: @@ -4553,16 +4575,16 @@ class="cmti-10">really need nested commands, the safest method is  
    \printglossaries  
    \end{document}

    -

    -

    +

    +

    -

    Top

    2.7 Acronym Style Modifications

    -

    The

    The glossaries-extra package provides a new way of dealing with abbreviations and redefines \newacronymglossaries-extra is do just add

    -

    before you define any entries. For example, the following document using just +

    before you define any entries. For example, the following document using just glossaries @@ -4601,7 +4623,7 @@ class="cmss-10">glossaries  
    \printglossaries  
    \end{document}

    -

    can be easily adapted to use

    can be easily adapted to use glossaries-extra: @@ -4618,7 +4640,7 @@ class="cmss-10">glossaries-extra:  
    \printglossaries  
    \end{document}

    -

    Table 

    Table 2.1 lists the nearest equivalent glossaries-extra abbreviation styles for the predefined acronym styles provided by


    @@ -4657,34 +4679,34 @@ cellspacing="0" cellpadding="0" id="TBL-2-1" />

    Old Style Name

    New Style Name

    long-sc-short

    long-short-sc

    long-sm-short

    long-short-sm

    long-sp-short

    long-short
    #1}}

    short-long

    short-long

    sc-short-long

    short-sc-long

    sm-short-long

    short-sm-long

    long-short-desc

    long-short-desc

    long-sc-short-desc

    long-short-sc-desc

    long-sm-short-desc

    long-short-sm-desc

    long-sp-short-desc

    long-short-desc
    #1}}

    short-long-desc

    short-long-desc

    sc-short-long-desc

    short-sc-long-desc

    sm-short-long-desc

    short-sm-long-desc

    dua

    long-noshort

    dua-desc

    long-noshort-desc

    footnote

    short-footnote

    footnote-sc

    short-sc-footnote

    footnote-sm

    short-sm-footnote

    footnote-desc

    short-footnote-desc

    footnote-sc-desc

    short-sc-footnote-desc

    footnote-sm-desc

    short-sm-footnote-desc

    @@ -4877,7 +4899,7 @@ class="cmss-10">short-sm-footnote-desc

    -

    The reason for introducing the new style of abbreviation commands provided by +

    The reason for introducing the new style of abbreviation commands provided by glossaries-extra is because the original acronym commands provided by glossaries are @@ -4886,15 +4908,15 @@ class="cmss-10">glossaries-extra. However, if you really want to restore the generic acronym function provided by glossaries you can use -



    \RestoreAcronyms  \RestoreAcronyms

    -

    +

    (before any use of \newacronym). -

    \RestoreAcronyms should not be used in combination with the newer glossaries-extra abbreviations. Don’t combine old and new style entries with the same @@ -4904,7 +4926,7 @@ class="cmss-10">typeglossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands. -

    If you use

    -

    -

    In general, there’s rarely any need for

    +

    In general, there’s rarely any need for \RestoreAcronyms. If you have a document that uses \newacronymstyle§3.5 Defining New Abbreviation Styles for further details.) -



    \glsacspace  \glsacspace{label}

    -

    +

    The space command \glsacspace used by the long-sp-short acronym style provided by glossaries is modified so that it uses -



    \glsacspacemax  \glsacspacemax

    -

    +

    instead of the hard-coded 3em. This is a command not a length and so can be changed using \renewcommand. -

    Any of the new abbreviation styles that use

    Any of the new abbreviation styles that use \glsxtrfullsep (such as \glsacspace with

    -

    -

    The

    +

    The first use acronym font command -



    \firstacronymfont{text}

    -

    +

    is redefined to use the first use abbreviation font command \glsfirstabbrvfont. This will be reset if you use \RestoreAcronyms. -

    The subsequent use acronym font command -


    The subsequent use acronym font command +


    \acronymfont{text}

    -

    +

    is redefined to use the subsequent use abbreviation font command \glsabbrvfont. This will be reset if you use \RestoreAcronyms.

    -

    Top

    2.8 glossary-bookindex package

    -

    As from v1.21,

    As from v1.21, glossaries-extra has a new supplementary package glossary-bookindex @@ -5021,7 +5043,7 @@ style:  
    \usepackage{glossary-bookindex}  
    \setglossarystyle{bookindex}

    -

    or use both the

    or use both the stylemods and style \usepackage[stylemods=bookindex,style=bookindex]{glossaries-extra}

    -

    The

    The bookindex style only supports a maximum hierarchical level of 2 (top-level, level 1 and level 2). -

    The number of columns is given by -


    The number of columns is given by +


    \glsxtrbookindexcols  \glsxtrbookindexcols

    -

    +

    which defaults to 2. -

    This style uses the

    This style uses the multicols environment. If the command -



    \glsxtrbookindexcolspread  \glsxtrbookindexcolspread

    -

    +

    isn’t empty then it’s supplied as the optional argument following \begin{multicols} multicolsmulticols* by redefining -



    \glsxtrbookindexmulticolsenv  \glsxtrbookindexmulticolsenv

    -

    +

    For example @@ -5082,16 +5104,16 @@ For example

    \renewcommand{\glsxtrbookindexmulticolsenv}{multicols*}
    -

    -

    Each top-level entry is displayed using -


    +

    Each top-level entry is displayed using +


    \glsxtrbookindexname  \glsxtrbookindexname{label}

    -

    +

    where the entry is identified by ⟨label⟩. This just does \glossentryname{ \ifglshassymbol{#1}{\space (\glossentrysymbol{#1})}{}%  
    }

    -

    Alternatively you can use the

    Alternatively you can use the \glsxtrpostnamecategory⟩ hook. -

    Sub-entries are displayed using -


    Sub-entries are displayed using +


    \glsxtrbookindexsubname  \glsxtrbookindexsubname{label}

    -

    +

    which just defaults to \glsxtrbookindexname{label}. -

    The separator used before the location list for top-level entries is given +

    The separator used before the location list for top-level entries is given by -



    \glsxtrbookindexprelocation  \glsxtrbookindexprelocation{label}

    -

    +

    where ⟨label⟩ is the entry’s label. This checks if the location field has been set. If it @@ -5146,7 +5168,7 @@ has, it does

    ,\glsxtrprelocation
    -

    otherwise it just does

    otherwise it just does \glsxtrprelocation (which defaults to \space). If you’re not using bib2gls, the location field won’t be set. -

    The separator used before the location list for sub-entries is given by -


    The separator used before the location list for sub-entries is given by +


    \glsxtrbookindexsubprelocation  \glsxtrbookindexsubprelocation{label}

    -

    +

    which defaults to \glsxtrbookindexprelocation{label}. -

    The separator used between a top-level parent and child entry is given +

    The separator used between a top-level parent and child entry is given by -



    \glsxtrbookindexparentchildsep  \glsxtrbookindexparentchildsep

    -

    +

    This defaults to \nopagebreak. -

    The separator used between a sub-level parent and child entry is given +

    The separator used between a sub-level parent and child entry is given by -



    \glsxtrbookindexparentsubchildsep  \glsxtrbookindexparentsubchildsep

    -

    +

    This defaults to \glsxtrbookindexparentchildsep. -

    The separator between top-level entries is given by -


    The separator between top-level entries is given by +


    \glsxtrbookindexbetween  }{label2}

    -

    +

    This comes after the entry given by ⟨label1⟩, if the entry has no children, or after the last descendent otherwise, so it always comes immediately before the entry given by ⟨label2⟩ unless the entry occurs at the start of a group. This does nothing by default. -

    The separator between two level 1 entries is given by -


    The separator between two level 1 entries is given by +


    \glsxtrbookindexsubbetween  }{label2}

    -

    -

    The separator between two level 2 entries is given by -


    +

    The separator between two level 2 entries is given by +


    \glsxtrbookindexsubsubbetween  } class="cmtt-10">{⟨label2}

    -

    +

    At the end of each letter group, the following hooks are done in order: -



    \glsxtrbookindexsubsubatendgroup  }

    -

    -


    +


    \glsxtrbookindexsubatendgroup  \glsxtrbookindexsubatendgroup{sub-label}

    -

    -


    +


    \glsxtrbookindexatendgroup  \glsxtrbookindexatendgroup{label}

    -

    +

    where ⟨sub-sub-label⟩ is the label of the last level 2 entry, ⟨sub-label⟩ is the label of the last level 1 entry and ⟨label⟩ is the label of the last level 0 entry. -

    For example, the resource option

    For example, the resource option seealso=omit instructs   \glsxtrbookindexsubsubatendgroup{#1}%  
    }

    -

    This uses

    This uses \glstreesubitem and \glstreesubsubitem to indent the cross-reference according to the next level down, so the cross-reference for a top-level entry is aligned @@ -5320,7 +5342,7 @@ indented a bit further (but it won’t be aligned with any deeper level as t class="cmss-10">bookindex style only supports a maximum of two sub-levels). -

    The

    The bookindex style uses group headings. (If you use bib2gls--group or -g switch.) The heading will use -




    -

    +

    If \pdfbookmark has been defined, this will use that command to bookmark the group title. If \pdfbookmark hasn’t been defined, this command does nothin. -

    The group heading is formatted according to -


    The group heading is formatted according to +


    \glsxtrbookindexformatheader  } -

    +

    which is defined as @@ -5375,14 +5397,14 @@ which is defined as  
      \par{\centering\glstreegroupheaderfmt{#1}\par}%  
    }

    -

    where

    where \glstreegroupheaderfmt is provided by the glossary-tree package, which is automatically loaded. Note that the entry names aren’t encapsulated with \glstreenamefmt. -

    The

    The glossary-bookindex package provides some supplementary commands that aren’t used by default, but may be used when adjusting the style. These commands @@ -5390,35 +5412,35 @@ should only be used within one of the \print…glossary commands. (That is, they should only be used in glossary styles.) -



    \glsxtrbookindexmarkentry  \glsxtrbookindexmarkentry{label}

    -

    +

    This writes information to the .aux file that can be read on the next run to obtain the first and last entry on each page of the glossary. -

    You can display the first entry associated with the current page using: -


    You can display the first entry associated with the current page using: +


    \glsxtrbookindexfirstmark  \glsxtrbookindexfirstmark

    -

    +

    and the last entry associated with the current page using: -



    \glsxtrbookindexlastmark  \glsxtrbookindexlastmark

    -

    +

    These do nothing if there are no entries marked on the current page (or if the document build isn’t up to date). -

    The entry is formatted using: -


    The entry is formatted using: +


    \glsxtrbookindexfirstmarkfmt  \glsxtrbookindexfirstmarkfmt{label}

    -

    +

    for the first instance and -



    \glsxtrbookindexlastmarkfmt  \glsxtrbookindexlastmarkfmt{label}

    -

    +

    for the last. -

    These commands are designed for use in page headers or footers where the page +

    These commands are designed for use in page headers or footers where the page number is stable. For example, \glsxtrbookindexname can be redefined to mark the current entry: @@ -5452,7 +5474,7 @@ current entry:  
      \glossentryname{#1}%  
    }

    -

    If you only want to mark the top-level entries, remember to redefine +

    If you only want to mark the top-level entries, remember to redefine \glsxtrbookindexsubname as it defaults to \glsxtrbookindexname: @@ -5465,8 +5487,8 @@ class="cmtt-10">\glsxtrbookindexname:  
      \glossentryname{#1}%  
    }

    -

    -

    Then if you’re using

    +

    Then if you’re using fancyhdr you can set the page style to show the first and last entry for the current page with: @@ -5481,13 +5503,13 @@ entry for the current page with:  
      \cfoot{}%  
      \rfoot{\glsxtrbookindexlastmark}%

    -

    -

    +

    +

    -

    Top

    2.9 Glossary Style Modifications

    -

    The

    The glossaries-extra-stylemods package (more conveniently loaded through the §2.9.3 The glossaries-extra-stylemods Package. -

    The

    The glossaries package tries to determine the group title from its label by first checking if \glsxtr@grouptitle@label⟩ which shouldn’t clash with another package. You can set the group title using -



    \glsxtrsetgrouptitle  label}{title}

    -

    +

    For example: @@ -5541,9 +5563,9 @@ For example:

    \glsxtrsetgrouptitle{A}{A (a)}
    -

    This uses a global assignment. If you need to scope the change you can +

    This uses a global assignment. If you need to scope the change you can use -



    \glsxtrlocalsetgrouptitle  }{title}

    -

    -

    +

    +

    -

    Top

    2.9.1 Style Hooks

    -

    The commands

    The commands \glossentryname and \glossentrydesc§5 Categories). This means you can make simple case-changing modifications to the name and description without defining a new glossary style. -

    If you want to adapt a style to use another field instead of

    If you want to adapt a style to use another field instead of name, you can use -



    \glossentrynameother  label}{field}

    -

    +

    This behaves just like \glossentryname (that is, it obeys description). See the key to field mappings table in the glossaries user manual. -

    There is a hook after

    There is a hook after \glossentryname and \Glossentryname: -



    \glsxtrpostnamehook  \glsxtrpostnamehook{label}

    -

    +

    By default this checks the indexname attribute. If the attribute exists for the category to which the label belongs, then the name is automatically indexed using -



    \glsxtrdoautoindexname{}{indexname}

    -

    +

    See §7 Auto-Indexing for further details. -

    As from version 1.04, the post-name hook

    As from version 1.04, the post-name hook \glsxtrpostnamehook will also use \glsxtrpostname (\glsentrysymbol{\glscurrententrylabel})}

    -

    As from version 1.25, the post-name hook also does -


    As from version 1.25, the post-name hook also does +


    \glsextrapostnamehook  \glsextrapostnamehook{label}

    -

    +

    (before \glsxtrpostnamecategory⟩) to allow for additional non-category related code. This does nothing by default. -

    The post-description code used within the glossary is modified so that it also +

    The post-description code used within the glossary is modified so that it also does -



    \glsxtrpostdescription  \glsxtrpostdescription

    -

    +

    This occurs before the original \glspostdescription, so if the nopostdot=false option is used, it will be inserted before the terminating full stop. -

    This new command will do

    This new command will do \glsxtrpostdesccategory⟩ if it exists, where ⟨general\glsxtrpostdescacronym for entries with the category set to acronym. -

    Since both

    Since both \glossentry and \subglossentry set -



    \glscurrententrylabel  \glscurrententrylabel

    -

    +

    to the label for the current entry, you can use this within the definition of these post-description hooks if you need to reference the label. -

    For example, suppose you want to insert the plural form in brackets after the +

    For example, suppose you want to insert the plural form in brackets after the description in the glossary, but only for entries in the general category, then you could @@ -5730,10 +5752,10 @@ do: \renewcommand{\glsxtrpostdescgeneral}{\space  
     (plural: \glsentryplural{\glscurrententrylabel})}

    -

    This means you don’t have to define a custom glossary style, which you may find +

    This means you don’t have to define a custom glossary style, which you may find more complicated. (It also allows more flexibility if you decide to change the underlying glossary style.) -

    This feature can’t be used for glossary styles that ignore

    This feature can’t be used for glossary styles that ignore \glspostdescription or if you redefine \glspostdescription without including glossaries-extra-stylemods Package

    -

    +

    +

    -

    Top

    2.9.2 Number List

    -

    The

    The number list is now placed inside the argument of -



    \GlsXtrFormatLocationList  \GlsXtrFormatLocationList{number list}

    -

    +

    This is internally used by \glossaryentrynumbers. The \glossaryentrynumbers so that it doesn’t display th id="dx1-16004">number list, but it still saves the number list in case it’s required. -

    If you want to suppress the

    If you want to suppress the number list always use the nonumberlist option instead of redefining \glossaryentrynumbers to do nothing.
    -

    -

    If you want to, for example, change the font for the entire

    +

    If you want to, for example, change the font for the entire number list then redefine \GlsXtrFormatLocationList as appropriate. Don’t modify \glossaryentrynumbers. -

    Sometimes users like to insert “page” or “pages” in front of the

    Sometimes users like to insert “page” or “pages” in front of the number list. This is quite fiddly to do with the base glossaries package, but glossaries-extra provides a way of doing this. First you need to enable this option and specify the text to display using: -



    \GlsXtrEnablePreLocationTag  }{pages}

    -

    +

    where ⟨page⟩ is the text to display if the number list only contains a single location and @@ -5824,28 +5846,28 @@ class="cmti-10">pages⟩ is the text to display otherwise. For examp

    \GlsXtrEnablePreLocationTag{Page: }{Pages: }
    -

    An extra run is required when using this command. -

    Use

    An extra run is required when using this command. +

    Use glsignore not @gobble as the format if you want to suppress the page number (and only index the entry once).
    -

    -

    See the accompanying sample file

    +

    See the accompanying sample file sample-pages.tex. -

    Note that

    Note that bib2gls can be instructed to insert a prefix at the start of non-empty location lists, which can be used as an alternative to \GlsXtrEnablePreLocationTag. -

    +

    -

    Top

    2.9.3 The glossaries-extra-stylemods Package

    -

    As from v1.02,

    As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that @@ -5862,7 +5884,7 @@ class="cmss-10">glossaries-extra. For example:  
    \usepackage{glossary-longragged}  
    \usepackage{glossaries-extra-stylemods}

    -

    Alternatively you can load

    Alternatively you can load glossary-name.sty at the same time by passing ⟨glossaries-extra-stylemods\usepackage[longragged]{glossaries-extra-stylemods}

    -

    Another option is to use the

    Another option is to use the stylemods key when you load long3col \usepackage[style=long3col,stylemods]{glossaries-extra}

    -

    Or the value of

    Or the value of stylemods may be a comma-separated list of the style package @@ -5907,7 +5929,7 @@ identifiers. For example:

    \usepackage[style=mcoltree,stylemods=mcols]{glossaries-extra}
    -

    Remember to group the value if it contains any commas: +

    Remember to group the value if it contains any commas: @@ -5915,8 +5937,8 @@ identifiers. For example:

    \usepackage[stylemods={mcols,longbooktabs}]{glossaries-extra}
    -

    -

    Note that the

    +

    Note that the inline style is dealt with slightly differently. The original definition provided by the nopostdot option, but the post-description category hook can still be used. -

    The

    The tabular-like styles, such as \printglossary, \printnoidxglossary or \printunsrtglossary, you must also reset the glossary style. -

    As from version 1.21, the hard-coded

    As from version 1.21, the hard-coded \space before the number list in many of the predefined styles is replaced with -



    \glsxtrprelocation  \glsxtrprelocation

    -

    +

    This just defaults to \space but may be redefined as required. For example: @@ -5988,27 +6010,27 @@ class="cmtt-10">\space but may be redefined as required. For example:

    \renewcommand{\glsxtrprelocation}{\dotfill}
    -

    -

    The

    +

    The list styles use -



    \glslistprelocation  \glslistprelocation

    -

    +

    (which defaults to \glsxtrprelocation) for top-level items and -



    \glslistchildprelocation  \glslistchildprelocation

    -

    +

    (which defaults to \glslistprelocation) for child items. -

    For just the

    For just the list style and its letter group variations (not the altlistlistdottednumber list for child entries is followed by -



    \glslistchildpostlocation  \glslistchildpostlocation

    -

    +

    which defaults to a full stop. -

    The default value of

    The default value of \glslistdottedwidth is changed so that it’s set at the start of the document (if it hasn’t been changed in the preamble). This should take into account situations where \hsize isn’t set until the start of the document. -

    The

    The index-like and tree-like styles insert the pre-number list space with -



    \glstreeprelocation  \glstreeprelocation

    -

    +

    (which defaults to \glsxtrprelocation) for top-level items and -



    \glstreechildprelocation  \glstreechildprelocation

    -

    +

    (which defaults to \glstreeprelocation) for child items. -

    As from version 1.05, the

    As from version 1.05, the glossaries-extra-stylemods package provides some additional commands for use with the alttreenotree option has been used when loading glossaries. -



    \gglssetwidest  level]{name}

    -

    +

    (New to version 1.21.) This is like \glssetwidest (provided by glossary-tree) but performs a global assignment. -



    \eglssetwidest  level]{name}

    -

    +

    This is like \glssetwidest but performs a protected expansion on ⟨name⟩. This has a localised effect. For a global setting, use -



    \xglssetwidest  }

    -

    +

    The following only set the value if ⟨name⟩ is wider than the current value (new to version 1.23). Local update: -



    \glsupdatewidest  level]{name}

    -

    +

    Global update: -



    \gglsupdatewidest  level]{name}

    -

    +

    Locale update (expands ⟨name⟩): -



    \eglsupdatewidest  level]{name}

    -

    +

    Global update (expands ⟨name⟩): -



    \xglsupdatewidest  level]{name}

    -

    -

    The widest entry value can later be retrieved using -


    +

    The widest entry value can later be retrieved using +


    \glsgetwidestname  \glsgetwidestname

    -

    +

    for the top-level entries and -



    \glsgetwidestsubname  \glsgetwidestsubname{level}

    -

    +

    for sub-entries, where ⟨level⟩ is the level number. -

    Note that if you are using

    Note that if you are using bib2glsTEX. -

    The command

    The command \glsfindwidesttoplevelname provided by glossary-tree has a CamelCase synonym: -



    \glsFindWidestTopLevelName  \glsFindWidestTopLevelName[glossary list]

    -

    +

    Similar commands are also provided: -



    \glsFindWidestUsedTopLevelName  glossary list]

    -

    +

    This has an additional check that the entry has been used. Naturally this is only useful if the glossaries that use the alttreealttree



    \glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list]

    -

    +

    This is like the previous command but if doesn’t check the parent key. This is useful if @@ -6239,17 +6261,17 @@ class="cmss-10">parent



    \glsFindWidestAnyName  \glsFindWidestAnyName[glossary list]

    -

    +

    This is like the previous command but doesn’t check if the entry has been used. -



    \glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo[glossary list]

    -

    +

    This is like \glsFindWidestUsedTopLevelName but also sets the first two sub-levels as well. Any entry that has a great-grandparent is ignored. -



    \glsFindWidestLevelTwo  \glsFindWidestLevelTwo[glossary list]

    -

    +

    This is like the previous command but doesn’t check if the entry has been used. -



    \glsFindWidestUsedAnyNameSymbol  glossary list]{register}

    -

    +

    This is like \glsFindWidestUsedAnyName but also measures the symbol. The length of the widest symbol is stored in ⟨register⟩. -



    \glsFindWidestAnyNameSymbol  list]{register}

    -

    +

    This is like the previous command but it doesn’t check if the entry has been used. -



    \glsFindWidestUsedAnyNameSymbolLocation  symbol register}{location register}

    -

    +

    This is like \glsFindWidestUsedAnyNameSymbol but also measures the symbol register⟩ and the length of the widest number list is stored in ⟨location register⟩. -



    \glsFindWidestAnyNameSymbolLocation  symbol register}{location register}

    -

    +

    This is like the previous command but it doesn’t check if the entry has been used. -



    \glsFindWidestUsedAnyNameLocation  glossary list]{register}

    -

    +

    This is like \glsFindWidestUsedAnyNameSymbolLocation but doesn’t measure the symbol. The length of the widest number list is stored in ⟨register⟩. -



    \glsFindWidestAnyNameLocation  list]{register}

    -

    +

    This is like the previous command but doesn’t check if the entry has been used. -

    The layout of the symbol, description and

    The layout of the symbol, description and number list is governed by -



    \glsxtralttreeSymbolDescLocation  label}{number list}

    -

    +

    for top-level entries and -



    \glsxtralttreeSubSymbolDescLocation  label}{number list}

    -

    +

    for sub-entries. -

    There is now a user level command that performs the initialisation for the

    There is now a user level command that performs the initialisation for the alttree style: -



    \glsxtralttreeInit  \glsxtralttreeInit

    -

    -

    The paragraph indent for subsequent paragraphs in multi-paragraph descriptions +

    +

    The paragraph indent for subsequent paragraphs in multi-paragraph descriptions is provided by the length -



    \glsxtrAltTreeIndent  \glsxtrAltTreeIndent

    -

    -

    For additional commands that are available with the

    +

    For additional commands that are available with the alttree style, see the documented code (sample-alttree-marginpar.tex.

    -

    -

    +

    Top

    3. Abbreviations

    -

    Abbreviations include acronyms (words formed from initial letters, such as +

    Abbreviations include acronyms (words formed from initial letters, such as “laser”), initialisms (initial letters of a phrase, such as “html”, that aren’t pronounced as words) and contractions (where parts of words are omitted, often replaced by an apostrophe, such as “don’t”). The “acronym” code provided by the @@ -6458,10 +6480,10 @@ to be described for readers unfamiliar with the term). They are therefore more like a regular term, which may or may not require a description in the glossary. -

    The

    The glossaries-extra package corrects this misnomer, and provides better abbreviation handling, with -



    \newabbreviation  }{long}

    -

    -

    This sets the

    +

    This sets the category key to abbreviation by default, but that value may be @@ -6499,7 +6521,7 @@ href="#sec:categories">§5 Categories for further details. -

    See

    See §2.6 Nested Links regarding the pitfalls of using commands like \glsxtrshort within ⟨short⟩ or ⟨long⟩. -

    Make sure that you set the category attributes before defining new abbreviations +

    Make sure that you set the category attributes before defining new abbreviations or they may not be correctly applied.
    -

    -

    The

    +

    The \newacronym command provided by the glossaries package is redefined by @@ -6527,7 +6549,7 @@ class="cmtt-10">acronym (see also href="#sec:acronymmods">§2.7 Acronym Style Modifications) so -



    \newacronym  short}{long}

    -

    +

    is now equivalent @@ -6566,7 +6588,7 @@ class="cmtt-10">}
    -

    The

    The \newabbreviation command is superficially similar to the glossaries package’s abbreviationglossaries package, although they may produce similar results.) -

    The way the abbreviations are displayed by commands like

    The way the abbreviations are displayed by commands like \gls varies according to the abbreviation style. The styles are set according to the entry’s category so, unlike the base glossaries package, you can have different abbreviation styles within the same glossary. -

    There are two types of full forms. The display full form, which is used on +

    There are two types of full forms. The display full form, which is used on first use by commands like short-footnote, the display and inline full forms are different. -

    These formatting commands aren’t stored in the

    These formatting commands aren’t stored in the short, shortplural\glsxtrlong and the case-changing variants don’t use \glsfirstlongfont. -

    You can apply the formatting command used for the short form to some arbitrary +

    You can apply the formatting command used for the short form to some arbitrary text using -



    \glsuseabbrvfont  text}{category}

    -

    +

    where ⟨category⟩ is the category label that identifies the abbreviation style. Similarly for the formatting command use by the long form: -



    \glsuselongfont  text}{category}

    -

    +

    -

    Top

    3.1 Tagging Initials

    -

    If you would like to tag the initial letters in the long form such that those letters are +

    If you would like to tag the initial letters in the long form such that those letters are underlined in the glossary but not in the main part of the document, you can use -



    \GlsXtrEnableInitialTagging  } class="cmtt-10">{⟨cs}

    -

    +

    before you define your abbreviations. -

    This command (robustly) defines ⟨

    This command (robustly) defines ⟨cs⟩ (a control sequence) to accept a single argument, which is the letter (or letters) that needs to be tagged. The normal behaviour of this command within the document is to simply do its argument, but in @@ -6689,21 +6711,21 @@ href="#catattr.tagging">tagging attribute set to “true”. For those cases it will use -



    \glsxtrtagfont  \glsxtrtagfont{text}

    -

    +

    This command defaults to \underline{text} but may be redefined as required. -

    The control sequence ⟨

    The control sequence ⟨cs⟩ can’t already be defined when used with the unstarred version of \GlsXtrEnableInitialTagging for safety reasons. The starred @@ -6712,7 +6734,7 @@ class="cmti-10">cs⟩. As with redefining any commands, ensure that you don’t redefine something important. In fact, just forget the existence of the starred version and let’s pretend I didn’t mention it. -

    The first argument of

    The first argument of \GlsXtrEnableInitialTagging is a comma-separated list of category names. The §5 Categories) but this must be done before the glossary is displayed. -

    The accompanying sample file

    The accompanying sample file sample-mixtures.tex uses initial tagging for both the acronymabbreviation \GlsXtrEnableInitialTagging{acronym,abbreviation}{\itag}

    -

    This defines the command

    This defines the command \itag which can be used in the definitions. For example: @@ -6756,18 +6778,18 @@ example:  
    \newabbreviation{xml}{XML}  
     {e\itag{x}tensible \itag{m}arkup \itag{l}anguage}

    -

    The underlining of the tagged letters only occurs in the glossary and then only for +

    The underlining of the tagged letters only occurs in the glossary and then only for entries with the tagging attribute set. -

    +

    -

    Top

    3.2 Abbreviation Styles

    -

    The abbreviation style must be set before abbreviations are defined using: -


    The abbreviation style must be set before abbreviations are defined using: +


    \setabbreviationstyle  ]{style-name}

    -

    +

    where ⟨style-name⟩ is the name of the style and ⟨category⟩ is the category label @@ -6799,11 +6821,11 @@ class="cmss-10">regular attribute to true. -

    If you want to apply different styles to groups of abbreviations, assign a +

    If you want to apply different styles to groups of abbreviations, assign a different category to each group and set the style for the given category.
    -

    -

    Note that

    +

    Note that \setacronymstyle is disabled by glossaries-extra. Use

    @@ -6824,7 +6846,7 @@ href="#sec:acronymmods">§2.7 Acronym Style Modifications). However the original acronym interface is incompatible with all the commands described here. -

    Abbreviations can be used with the standard

    Abbreviations can be used with the standard glossaries commands, such as \gls, @@ -6834,7 +6856,7 @@ class="cmtt-10">\acrshort\acronymfont). The short form can be produced with: -



    \glsxtrshort  label}[insert]

    -

    +

    (Use this instead of \acrshort.) -

    The long form can be produced with -


    The long form can be produced with +


    \glsxtrlong  label}[insert]

    -

    +

    (Use this instead of \acrlong.) -

    The

    The inline full form can be produced with -



    \glsxtrfull  label}[insert]

    -

    +

    (This this instead of \acrfull.) -

    In general, it’s best not to use commands like

    In general, it’s best not to use commands like \glsfirst for abbreviations, especially if you use the ⟨insert⟩ optional argument. Use either \gls (possibly with a reset) or \glsxtrfull.
    -

    -

    As mentioned earlier, the inline full form may not necessarily match the format +

    +

    As mentioned earlier, the inline full form may not necessarily match the format used on first use with short-nolongfirst use, but the full form will display the long form followed by the short form in parentheses. -

    If you want to use an abbreviation in a chapter or section title, use the +

    If you want to use an abbreviation in a chapter or section title, use the commands described in §4 Entries in Sectioning Titles, Headers, Captions and Contents instead.
    -

    -

    The arguments ⟨

    +

    The arguments ⟨options⟩, ⟨label⟩ and ⟨insert⟩ are the same as for commands such as \glstext. There are also analogous case-changing commands: -

    First letter upper case short form: -


    First letter upper case short form: +


    \Glsxtrshort  label}[insert]

    -

    -

    First letter upper case long form: -


    +

    First letter upper case long form: +


    \Glsxtrlong  label}[insert]

    -

    -

    First letter upper case inline full form: -


    +

    First letter upper case inline full form: +


    \Glsxtrfull  label}[insert]

    -

    -

    All upper case short form: +

    +

    All upper case short form: -



    \Glsxtrshort  label}[insert]

    -

    -

    All upper case long form: -


    +

    All upper case long form: +


    \Glsxtrlong  label}[insert]

    -

    -

    All upper case inline full form: -


    +

    All upper case inline full form: +


    \GLSxtrfull  label}[insert]

    -

    -

    Plural forms are also available. -

    Short form plurals: -


    +

    Plural forms are also available. +

    Short form plurals: +


    \glsxtrshortpl  label}[insert]

    -

    -


    +


    \Glsxtrshortpl  label}[insert]

    -

    -


    +


    \GLSxtrshortpl  label}[insert]

    -

    -

    Long form plurals: -


    +

    Long form plurals: +


    \glsxtrlongpl  label}[insert]

    -

    -


    +


    \Glsxtrlongpl  label}[insert]

    -

    -


    +


    \GLSxtrlongpl  label}[insert]

    -

    -

    Full form plurals: -


    +

    Full form plurals: +


    \glsxtrfullpl  label}[insert]

    -

    -


    +


    \Glsxtrfullpl  label}[insert]

    -

    -


    +


    \GLSxtrfullpl  label}[insert]

    -

    -

    Be careful about using

    +

    Be careful about using \glsentryfull, \Glsentryfull, \glsentryfullpl and @@ -7123,13 +7145,13 @@ class="cmtt-10">\glsentryshort etc.
    -

    -

    +

    +

    -

    Top

    3.3 Shortcut Commands

    -

    The abbreviation shortcut commands can be enabled using the package option +

    The abbreviation shortcut commands can be enabled using the package option shortcutstable 3.1. -


    @@ -7469,10 +7491,10 @@ class="cmtt-10">\newabbreviation
    -

    Top

    3.4 Predefined Abbreviation Styles

    -

    There are two types of abbreviation styles: those that treat the abbreviation as a +

    There are two types of abbreviation styles: those that treat the abbreviation as a regular entry (so that \gls uses \gls uses \glsxtrgenabbrvfmt). -

    The regular entry abbreviation styles set the

    The regular entry abbreviation styles set the regular attribute to “true” for the @@ -7508,7 +7530,7 @@ class="cmss-10">long\glsxtrshort. -

    The other abbreviation styles don’t modify the

    The other abbreviation styles don’t modify the regular attribute. The \glsxtrfullformat that are defined by the style). -

    In both cases, the

    In both cases, the first use of \gls may not match the text produced by \glsfirst (and likewise for the plural and case-changing versions). -

    The sample file

    The sample file sample-abbr-styles.tex demonstrates all predefined styles described here. -

    For the “sc” styles that use

    For the “sc” styles that use \textsc, be careful about your choice of fonts as some only have limited support. For example, you may not be able to combine bold @@ -7547,52 +7569,52 @@ class="cmss-10">fontenc package with the T1 option or something similar.
    -

    -

    The parenthetical styles, such as

    +

    The parenthetical styles, such as long-short, use -



    \glsxtrparen  \glsxtrparen{text}

    -

    +

    to set the parenthetical material. This just puts parentheses around the text: (⟨text⟩). -

    The basic abbreviation styles, such as

    The basic abbreviation styles, such as long-short and short-long use -



    \glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

    -

    +

    for the short form. This just does ⟨text⟩ by default. (That is, no font change is applied.) On first use, -



    \glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{text}

    -

    +

    is used instead. By default, this just does \glsabbrvdefaultfont. The long form is formatted according to -



    \glslongdefaultfont  }

    -

    +

    which again just does ⟨text⟩ (no font change). On first use, -



    \glsfirstlongdefaultfont  \glsfirstlongdefaultfont{text}

    -

    +

    is used instead. This just does \glslongdefaultfont. The plural suffix used for the short form is given by -



    \glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

    -

    +

    which defaults to \glspluralsuffix. -

    The small-cap styles, such as

    The small-cap styles, such as long-short-sc and short-sc-long, use -



    \glsabbrvscfont  \glsabbrvscfont{text}

    -

    +

    which uses \textsc.3.1 On first use -



    \glsabbrvdefaultfont  \glsfirstabbrvscfont{text}

    -

    +

    is used instead. This uses \glsabbrvscfont by default. So redefine, \glsabbrvscfont to change first and subsequent uses or \glsfirstabbrvscfont to change just the first use. -

    The long form for the small-cap styles uses

    The long form for the small-cap styles uses \glslongdefaultfont or \glsfirstlongdefaultfont, as with the basic style. The suffix is given by -



    \glsxtrscsuffix  \glsxtrscsuffix

    -

    +

    This is defined as @@ -7678,7 +7700,7 @@ This is defined as

    \newcommand*{\glsxtrscsuffix}{\glstextup{\glsxtrabbrvpluralsuffix}}
    -

    The

    The \glstextup command is provided by glossaries and is used to switch off the @@ -7698,51 +7720,51 @@ attributes. See §5 Categories for further details.) -

    The small styles, such as

    The small styles, such as long-short-sm and short-sm-long, use -



    \glsabbrvsmfont  \glsabbrvsmfont{text}

    -

    +

    which uses \textsmaller. (This requires the relsizes package, which isn’t loaded by glossaries-extra, so must be loaded explicitly.) On first use -



    \glsfirstabbrvsmfont  \glsfirstabbrvsmfont{text}

    -

    +

    is used instead. This uses \glsabbrvsmfont by default. -

    The long form for the smaller styles uses

    The long form for the smaller styles uses \glslongdefaultfont or \glsfirstlongdefaultfont, as with the basic style. The suffix is given by -



    \glsxtrsmsuffix  \glsxtrsmsuffix

    -

    +

    which defaults to just \glsxtrabbrvpluralsuffix. -

    The “short-em” (emphasize short) styles, such as

    The “short-em” (emphasize short) styles, such as long-short-em or short-em-long, use -



    \glsabbrvemfont  \glsabbrvemfont{text}

    -

    +

    On first use -



    \glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

    -

    +

    is used instead. This uses \glsabbrvemfont by default. The suffix is given by -



    \glsxtremsuffix  \glsxtremsuffix

    -

    +

    which defaults to just \glsxtrabbrvpluralsuffix. The long form is as for the basic style unless the style is a “long-em” style. -

    The “long-em” (emphasize long) styles, such as

    The “long-em” (emphasize long) styles, such as long-em-short-em or short-em-long-em, use -



    \glsfirstlongemfont  \glsfirstlongemfont{long-form}

    -

    +

    instead of \glsfirstlongdefaultfont{long-form} and -



    \glslongemfont  }

    -

    +

    instead of \glslongdefaultfont{long-form}. The first form \glsfirstlongemfont is initialised to use \glslongemfont. -

    The user styles have similar commands: -


    The user styles have similar commands: +


    \glsabbrvuserfont  \glsabbrvuserfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvuserfont  \glsfirstabbrvuserfont{text}

    -

    +

    for the first use short form, -



    \glslonguserfont  \glslonguserfont{text}

    -

    +

    for the long form, -



    \glsfirstlonguserfont  \glsfirstlonguserfont{text}

    -

    +

    for the first use long form, and -



    \glsxtrusersuffix  \glsxtrusersuffix

    -

    +

    for the short plural suffix. -

    Similarly for the hyphen styles: -


    Similarly for the hyphen styles: +


    \glsabbrvhyphenfont  \glsabbrvhyphenfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvhyphenfont  \glsfirstabbrvhyphenfont{text}

    -

    +

    for the first use short form, -



    \glslonghyphenfont  \glslonghyphenfont{text}

    -

    +

    for the long form, -



    \glsfirstlonghyphenfont  \glsfirstlonghyphenfont{text}

    -

    +

    for the first use long form, and -



    \glsxtrhyphensuffix  \glsxtrhyphensuffix

    -

    +

    for the short plural suffix. -

    Similarly for the “only” styles, such as

    Similarly for the “only” styles, such as long-only-short-only: -



    \glsabbrvonlyfont  \glsabbrvonlyfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvonlyfont  \glsfirstabbrvonlyfont{text}

    -

    +

    for the first use short form, -



    \glslongonlyfont  \glslongonlyfont{text}

    -

    +

    for the long form, -



    \glsfirstlongonlyfont  }

    -

    +

    for the first use long form, and -



    \glsxtronlysuffix  \glsxtronlysuffix

    -

    +

    for the short plural suffix. -

    Note that by default inserted material (provided in the final optional argument of +

    Note that by default inserted material (provided in the final optional argument of commands like \gls), is placed outside the font command in the predefined styles. To move it inside, use: -



    \glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue

    -

    +

    This applies to all the predefined styles. For example: @@ -7975,17 +7997,17 @@ This applies to all the predefined styles. For example:  
    \renewcommand*{\glsfirstlongdefaultfont}[1]{\emph{#1}}  
    \glsxtrinsertinsidetrue

    -

    This will make the long form and the inserted text emphasized, whereas the default +

    This will make the long form and the inserted text emphasized, whereas the default (without \glsxtrinsertinsidetrue) would place the inserted text outside of the emphasized font. -

    Note that for some styles, such as the

    Note that for some styles, such as the short-long, the inserted text would be placed inside the font command for the short form (rather than the long form in the above example). -

    Remember that

    Remember that \textsc renders lowercase letters as small capitals. Uppercase letters are rendered as normal uppercase letters, so if you specify the short form in @@ -7999,8 +8021,8 @@ convert its argument to lowercase. For example:

    \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeLowercase{#1}}}
    -

    -

    If you want to easily switch between the “sc” and “sm” styles, you may find it +

    +

    If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert case: @@ -8010,16 +8032,16 @@ easier to redefine this command to convert case: \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeTextLowercase{#1}}}  
    \renewcommand*{\glsabbrvsmfont}[1]{\textsmaller{\MakeTextUppercase{#1}}}

    -

    -

    Some of the styles use -


    +

    Some of the styles use +


    \glsxtrfullsep  \glsxtrfullsep{label}

    -

    +

    as a separator between the long and short forms. This is defined as a space by default, but may be changed as required. For example: @@ -8029,7 +8051,7 @@ default, but may be changed as required. For example:

    \renewcommand*{\glsxtrfullsep}[1]{~}
    -

    or +

    or @@ -8037,8 +8059,8 @@ default, but may be changed as required. For example:

    \renewcommand*{\glsxtrfullsep}[1]{\glsacspace{#1}}
    -

    -

    The new naming scheme for abbreviation styles is as follows:

    +

    +

    The new naming scheme for abbreviation styles is as follows:

    -

    Or, if you are using

    Or, if you are using hyperref: @@ -11176,8 +11198,8 @@ class="cmss-10">hyperref\texorpdfstring{\glsabbrvfont{\glsentryshort{html}}}{\glsentryshort{html}}}

    -

    -

    Since this is a bit cumbersome, you might want to define a new command to do +

    +

    Since this is a bit cumbersome, you might want to define a new command to do this for you. However, if you have mixed styles this won’t work as commands like \gls and \MakeUppercase. -

    The

    The glossaries-extra package tries to resolve this by modifying \markright and @@ -11200,12 +11222,12 @@ class="cmtt-10">\markboth and \@starttoc. If you don’t like this change, you can restore their former definitions using -



    \glsxtrRevertMarks  \glsxtrRevertMarks

    -

    +

    In this case, you’ll have to use the glossaries manual’s recommendations of either simply using \chapter[A Chapter about \glsentryshort{html}]{A Chapter about \gls{html}}

    -

    Alternatively, you need to find a way to insert

    Alternatively, you need to find a way to insert \glsxtrmarkhook and \@glsxtrinmark at the start of the header or table of contents either scoped or afterwards cancelled with \@glsxtrnotinmark and \glsxtrrestoremarkhook. -

    If you don’t revert the mark commands back with

    If you don’t revert the mark commands back with \glsxtrRevertMarks, you can use the commands described below in the argument of sectioning commands. You can still use them even if the mark commands have been reverted, but only where they don’t conflict with the page style. -

    The commands listed below all use

    The commands listed below all use \texorpdfstring if hyperref

    These commands essentially behave as though you have used

    These commands essentially behave as though you have used \glsxtrshort (or equivalent) with the options noindexheaduc attribute to “true” for the appropriate category. -

    If you use one of the

    If you use one of the \textsc styles, be aware that the default fonts don’t provide bold small-caps or italic small-caps. This means that if the chapter @@ -11271,239 +11293,239 @@ class="cmtt-10">\glsabbrvfont. You may want to consider using the slantsc package in this case.
    -

    -

    Display the short form: -


    +

    Display the short form: +


    \glsfmtshort  \glsfmtshort{label}

    -

    -

    Display the plural short form: -


    +

    Display the plural short form: +


    \glsfmtshortpl  \glsfmtshortpl{label}

    -

    -

    First letter upper case singular short form: -


    +

    First letter upper case singular short form: +


    \Glsfmtshort  \Glsfmtshort{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural short form: +

    First letter upper case plural short form: -



    \Glsfmtshortpl  \Glsfmtshortpl{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    Display the long form: -


    Display the long form: +


    \glsfmtlong  \glsfmtlong{label}

    -

    -

    Display the plural long form: -


    +

    Display the plural long form: +


    \glsfmtlongpl  \glsfmtlongpl{label}

    -

    -

    First letter upper case singular long form: -


    +

    First letter upper case singular long form: +


    \Glsfmtlong  \Glsfmtlong{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural long form: -


    First letter upper case plural long form: +


    \Glsfmtlongpl  \Glsfmtlongpl{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    There are similar commands for the full form, but note that these use the

    There are similar commands for the full form, but note that these use the inline full form, which may be different from the full form used by \gls. -

    Display the full form: -


    Display the full form: +


    \glsfmtfull  \glsfmtfull{label}

    -

    -

    Display the plural full form: -


    +

    Display the plural full form: +


    \glsfmtfullpl  \glsfmtfullpl{label}

    -

    -

    First letter upper case singular full form: -


    +

    First letter upper case singular full form: +


    \Glsfmtfull  \Glsfmtfull{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    First letter upper case plural full form: -


    First letter upper case plural full form: +


    \Glsfmtfullpl  \Glsfmtfullpl{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    There are also equivalent commands for the value of the

    There are also equivalent commands for the value of the text field: -



    \glsfmttext  \glsfmttext{label}

    -

    -

    First letter converted to upper case: -


    +

    First letter converted to upper case: +


    \Glsfmttext  \Glsfmttext{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    The plural equivalents: +

    The plural equivalents: -



    \glsfmtplural  \glsfmtplural{label}

    -

    +

    and -



    \Glsfmtplural  \Glsfmtplural{label}

    -

    -

    Likewise for the value of the

    +

    Likewise for the value of the name field: -



    \glsfmtname  \glsfmtname{label}

    -

    -

    First letter converted to upper case: -


    +

    First letter converted to upper case: +


    \Glsfmtname  \Glsfmtname{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    Similarly for the value of the

    Similarly for the value of the first field: -



    \glsfmtfirst  \glsfmtfirst{label}

    -

    -

    First letter converted to upper case: -


    +

    First letter converted to upper case: +


    \Glsfmtfirst  \Glsfmtfirst{label}

    -

    +

    (No case-change applied to PDF bookmarks.) -

    The plural equivalents: -


    The plural equivalents: +


    \glsfmtfirstpl  \glsfmtfirstpl{label}

    -

    +

    and -



    \Glsfmtfirstpl  \Glsfmtfirstpl{label}

    -

    +

    -

    -

    +

    Top

    5. Categories

    -

    Each entry defined by

    Each entry defined by \newglossaryentry (or commands that internally use it such as babel shorthands on that make some characters active.) -

    The use of categories can give you more control over the way entries are displayed +

    The use of categories can give you more control over the way entries are displayed in the text or glossary. Note that an entry’s category is independent of the glossary type. Be careful not to confuse category with type. -

    The default category assumed by

    The default category assumed by \newglossaryentry is labelled general. @@ -11537,7 +11559,7 @@ class="cmtt-10">\newacronym have the category set to acronym by default. -

    Additionally, if you have enabled

    Additionally, if you have enabled \newterm with the numbersnumber. -

    You can obtain the category label for a given entry using -


    You can obtain the category label for a given entry using +


    \glscategory  \glscategory{label}

    -

    +

    This is equivalent to commands like \glsentryname and so may be used in an expandable context. No error is generated if the entry doesn’t exist. -

    You can test the category for a given entry using -


    You can test the category for a given entry using +


    \glsifcategory  part}{false part}

    -

    +

    This is equivalent to

    -

    Here the

    Here the short and longuser1 \glsuseri{dante}[.]

    -

    This will bring the punctuation character inside the

    This will bring the punctuation character inside the link-text and it won’t be discarded. @@ -11807,21 +11829,21 @@ class="description">If this attribute is set to “true” any entry def class="cmtt-10">\newabbreviation will automatically have spaces in the long form replaced with -



    \glsxtrwordsep  \glsxtrwordsep

    -

    +

    and each word is encapsulated with -



    \glsxtrword  \glsxtrword{word}

    -

    +

    For example: @@ -11831,7 +11853,7 @@ class="cmtt-10">}


    \glssetcategoryattribute{abbreviation}{markwords}{true}  
    \newabbreviation{ip}{IP}{Internet Protocol}
    -

    is essentially the same as +

    is essentially the same as @@ -11840,7 +11862,7 @@ class="cmtt-10">}


    \newabbreviation{ip}{IP}  
    {\glsxtrword{Internet}\glsxtrwordsep\glsxtrword{Protocol}}
    -

    The “hyphen” styles, such as

    The “hyphen” styles, such as long-hyphen-short-hyphen, take advantage of this @@ -11862,15 +11884,15 @@ class="cmtt-10">\glsxtrlong. You can provide your own \newcommand{\hyplong}[2][]{%  
     {\def\glsxtrwordsep{-}\glsxtrlong[#1]{#2}}}

    -

    -

    This setting will also adjust the long plural. -

    This setting may result in the

    +

    This setting will also adjust the long plural. +

    This setting may result in the \glsxtrword and \glsxtrwordsep markup ending up in the sort field, depending on the style in use.
    -

    +

    markwords but applies to the short form. (Only useful for abbreviations that contain spaces.) -

    This setting will only adjust the short plural if the

    This setting will only adjust the short plural if the shortplural key isn’t used. This setting will take precedence over insertdots. -

    This setting may result in the

    This setting may result in the \glsxtrword and \glsxtrwordsep markup ending up in the sort field, depending on the style in use.
    -

    +

    markshortwords. -

    If you explicitly override the short plural using the

    If you explicitly override the short plural using the shortplural key, you must explicitly insert the dots yourself (since there’s no way for the code to determine if the plural has a suffix that shouldn’t be followed by a dot).
    -

    -

    This attribute is best used with the

    +

    This attribute is best used with the discardperiod attribute set to “true”. @@ -12014,7 +12036,7 @@ class="cmtt-10">\glsxtrifcounttrigger\cgls should behave. -

    With

    With glossaries, commands like \cgls use \cglsformat only if the previous @@ -12081,7 +12103,7 @@ class="cmtt-10">\capitalisewordsmfirstuc). If you want to use a different command you can redefine: -



    \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs}

    -

    +

    For example: @@ -12098,7 +12120,7 @@ class="cmtt-10">}

    \newcommand*{\glsxtrfieldtitlecasecs}[1]{\xcapitalisefmtwords*{#1}}
    -

    (Note that the argument to

    (Note that the argument to \glsxtrfieldtitlecasecs will be a control sequence whose replacement text is the entry’s description, which is why \xcapitalisefmtwords is needed instead of \capitalisefmtwords.)

    -

    Any other values of this attribute are ignored. Remember that there are design +

    Any other values of this attribute are ignored. Remember that there are design limitations for both the first letter uppercasing and the title casing commands. See the mfirstuc\glossentrydesc \glssetcategoryattribute{general}{glossdescfont}{emph}

    -

    +

    \glossentryname \glssetcategoryattribute{general}{glossnamefont}{emph}
    -

    Note that this overrides

    Note that this overrides \glsnamefont which will only be used if this attribute hasn’t been set. -

    Remember that glossary styles may additionally apply a font change, +

    Remember that glossary styles may additionally apply a font change, such as the list styles which put the name in the optional argument of \item. @@ -12246,7 +12268,7 @@ class="cmtt-10">\gls will be set to the

    \glssetcategoryattribute{general}{targeturl}{master-doc.pdf}
    -

    (See also the accompanying sample file

    (See also the accompanying sample file sample-external.tex.) If the URL contains awkward characters (such as % or \glspercentchar and \glstildechar that expand to literal characters. -

    If you want to a named anchor within the target URL (notionally adding +

    If you want to a named anchor within the target URL (notionally adding #name⟩ to the URL), then you also need to set \glslabel within ⟨name⟩ which is set by commands like \gls to the entry’s label. -

    All the predefined glossary styles start each entry listing with

    All the predefined glossary styles start each entry listing with \glstarget which sets the anchor to \glolinkprefix\glslabel, so if you want @@ -12286,10 +12308,10 @@ class="cmss-10">targeturl \glssetcategoryattribute{general}{targetname}{\glolinkprefix\glslabel}

    -

    (If the target document changed

    (If the target document changed \glolinkprefix then you will need to adjust the above as appropriate.) -

    If the anchor is in the form ⟨

    If the anchor is in the form ⟨name1.name2⟩ then use targetcategory for the ⟨name1⟩ part. -

    For example: +

    For example: @@ -12312,11 +12334,11 @@ class="cmti-10">name1⟩ part.  
    \glssetcategoryattribute{general}{targetcategory}{page}  
    \glssetcategoryattribute{general}{targetname}{7}

    -

    will cause all link text for

    will cause all link text for general entries to link to master-doc.pdf#page.7 (page 7 of that PDF). -

    If you want a mixture in your document of entries that link to an internal +

    If you want a mixture in your document of entries that link to an internal glossary and entries that link to an external URL then you can use the starred form of \newignoredglossary\newignoredglossary  category=external,  
      description={external example}}

    -

    +

    -

    An attribute can be set using: -


    An attribute can be set using: +


    \glssetcategoryattribute  attribute-label}{value}

    -

    +

    where ⟨category-label⟩ is the category label, ⟨attribute-label⟩ is the attribute label and ⟨value⟩ is the new value for the attribute. -

    There is a shortcut version to set the

    There is a shortcut version to set the regular attribute to “true”: -



    \glssetregularcategory  \glssetregularcategory{category-label}

    -

    -

    If you need to lookup the category label for a particular entry, you can use the +

    +

    If you need to lookup the category label for a particular entry, you can use the shortcut command: -



    \glssetattribute  } class="cmtt-10">{⟨value}

    -

    +

    This uses \glssetcategoryattribute with \glscategory to set the attribute. Note that this will affect all other entries that share this entry’s category. -

    You can fetch the value of an attribute for a particular category using: -


    You can fetch the value of an attribute for a particular category using: +


    \glsgetcategoryattribute  } class="cmtt-10">{⟨attribute-label}

    -

    +

    Again there is a shortcut if you need to lookup the category label for a given entry: -



    \glsgetattribute  } -

    -

    You can test if an attribute has been assigned to a given category using: -


    +

    You can test if an attribute has been assigned to a given category using: +


    \glshascategoryattribute  true code}{false code}

    -

    +

    This uses etoolbox’s true code⟩ if the attribute has been set and isn’t blank and isn’t \relax. The shortcut if you need to lookup the category label from an entry is: -



    \glshasattribute  code}{false code}

    -

    -

    You can test the value of an attribute for a particular category using: -


    +

    You can test the value of an attribute for a particular category using: +


    \glsifcategoryattribute  true-part}{false-part}

    -

    +

    This tests if the attribute (given by ⟨attribute-label⟩) for the category (given by ⟨true-part⟩ is done. If the attribute isn’t set or is set but isn’t equal to ⟨value⟩, ⟨false part⟩ is done. -

    For example: +

    For example: @@ -12498,7 +12520,7 @@ class="cmti-10">false part⟩ is done.

    \glsifcategoryattribute{general}{nohyper}{true}{NO HYPER}{HYPER}
    -

    This does “NO HYPER” if the

    This does “NO HYPER” if the general category has the nohyper attribute set to true otherwise if does “HYPER”. -

    With boolean-style attributes like

    With boolean-style attributes like nohyper, make sure you always test for true not false in case the attribute hasn’t been set. -

    Again there’s a shortcut if you need to lookup the category label from a particular +

    Again there’s a shortcut if you need to lookup the category label from a particular entry: -



    \glsifattribute  true-part} {false-part}

    -

    -

    There’s also a shortcut to determine if a particular category has the

    +

    There’s also a shortcut to determine if a particular category has the regular attribute set to “true”: -



    \glsifregularcategory  true-part}{false-part}

    -

    +

    Alternatively, if you need to lookup the category for a particular entry: -



    \glsifregular  }{false-part}

    -

    +

    Note that if the regularregular attribute has been set to “false”: -



    \glsifnotregularcategory  true-part}{false-part}

    -

    +

    or for a particular entry: -



    \glsifnotregular  }{false-part}

    -

    +

    Again, if the regular attribute hasn’t been set, the above do ⟨false-part⟩, so these reverse commands aren’t logically opposite in the strict sense. -

    You can iterate through all entries with a given category using: -


    You can iterate through all entries with a given category using: +


    \glsforeachincategory[glossary-labels]{label-cs}{body}

    -

    +

    This iterates through all entries in the glossaries identified by the comma-separated list ⟨glossary-labels⟩ that have the category given by ⟨

    Similarly, you can iterate through all entries that have a category with a given +

    Similarly, you can iterate through all entries that have a category with a given attribute using: -



    \glsforeachwithattribute  }{body}

    -

    +

    This will do ⟨body⟩ for each entry that has a category with the attribute ⟨attribute-label⟩ set to ⟨attribute-value⟩. The remaining arguments are as the previous command. -

    You can change the category for a particular entry using the standard glossary +

    You can change the category for a particular entry using the standard glossary field changing commands, such as \glsfielddef. Alternatively, you can use -



    \glsxtrsetcategory  }{category-label}

    -

    +

    This will change the category to ⟨category-label⟩ for each entry listed in the comma-separated list ⟨\glsfieldxdef so it will expand ⟨category-label⟩ and make the change global. -

    You can also change the category for all entries with a glossary or glossaries +

    You can also change the category for all entries with a glossary or glossaries using: -



    \glsxtrsetcategoryforall  } class="cmtt-10">{⟨category-label}

    -

    +

    where ⟨glossary-labels⟩ is a comma-separated list of glossary labels.

    -

    -

    +

    Top

    6. Counting References

    -

    There are three basic ways of counting entry references: +

    There are three basic ways of counting entry references:

    1. Counting the total number of times glossaries class="cmtt-10">.aux file so that it’s available on the next LATEX run. -

      This method is extended by

      This method is extended by glossaries-extra and is described in §6.1 bib2gls§9.4 §9.5 Record Counting for further details.

    2. \glslinkpresetkeys. See §6.2 Link Counting for further details.
    -

    Top

    6.1 Entry Counting (First Use Flag)

    -

    As mentioned in

    As mentioned in §2.4 Entry Counting Modifications, §5 Categories). -

    Remember that entry counting only counts the number of times an entry is used +

    Remember that entry counting only counts the number of times an entry is used by commands that change the first use flag. (That is, all those commands that mark the entry as having been used.) There are many commands that don’t modify this flag and they won’t contribute to the entry use count.
    -

    -

    With

    +

    With glossaries-extra, you may use \cgls instead of shortcuts=acro). -

    All upper case versions (not provided by

    All upper case versions (not provided by glossaries) are also available: -



    \cGLS  label}[insert]

    -

    +

    and -



    \cGLSpl  label}[insert]

    -

    +

    These are analogous to \cgls and \cglspl but they use -



    \cGLSformat  label}{insert}

    -

    +

    and -



    \cGLSplformat  label}{insert}

    -

    +

    which convert the analogous \cglsformat and \cglsplformat to upper case. -

    Just using

    Just using glossaries: @@ -12922,8 +12944,8 @@ class="cmss-10">glossaries:  
    \printglossaries  
    \end{document}

    -

    -

    If you switch to

    +

    If you switch to glossaries-extra you must set the entrycountentrycount\printglossaries  
    \end{document}

    -

    -

    When activated with

    +

    When activated with \glsenableentrycount, commands such as \cgls now use -



    \glsxtrifcounttrigger  } class="cmtt-10">{⟨normal code}

    -

    +

    to determine if the entry trips the entry count trigger. The ⟨trigger code⟩ uses commands like trigger code⟩ but the usual \gls behaviour in ⟨normal code⟩). -

    The default definition is: +

    The default definition is: @@ -12999,7 +13021,7 @@ class="cmti-10">normal code⟩).  
     {#3}%  
    }

    -

    This means that if an entry is assigned to a category that has the

    This means that if an entry is assigned to a category that has the entrycount @@ -13007,7 +13029,7 @@ attribute then the ⟨trigger code⟩ will be used if the previous count value (the number of times the entry was used on the last run) is greater than the value of the attribute. -

    For example, to trigger normal use if the previous count value is greater than +

    For example, to trigger normal use if the previous count value is greater than four: @@ -13016,8 +13038,8 @@ four:

    \glssetcategoryattribute{abbreviation}{entrycount}{4}
    -

    -

    There is a convenient command provided to enable entry counting, set the +

    +

    There is a convenient command provided to enable entry counting, set the entrycount\gls, etc to use \cgls etc: -



    \GlsXtrEnableEntryCounting  } class="cmtt-10">{⟨value}

    -

    +

    The first argument ⟨categories⟩ is a comma-separated list of categories. For each category, the value⟩. In addition, this does:  
    \renewcommand*{\GLS}{\cGLS}%  
    \renewcommand*{\GLSpl}{\cGLSpl}%

    -

    This makes it easier to enable entry-counting on existing documents. -

    If you use

    This makes it easier to enable entry-counting on existing documents. +

    If you use \GlsXtrEnableEntryCounting more than once, subsequent uses will just set the entrycount attribute for each listed category. -

    The above example document can then become: +

    The above example document can then become: @@ -13082,12 +13104,12 @@ class="cmss-10">entrycount\printglossaries  
    \end{document}

    -

    -

    The standard entry-counting function describe above counts the number of times +

    +

    The standard entry-counting function describe above counts the number of times an entry has been marked as used throughout the document. (The reset commands will reset the total back to zero.) If you prefer to count per sectional-unit, you can use -



    \GlsXtrEnableEntryUnitCounting  value}{counter-name}

    -

    +

    where ⟨categories⟩ is a comma-separated list of categories to which this feature should be applied, ⟨value⟩ is the trigger value and ⟨counter-name⟩ is the name of the counter used by the sectional unit. -

    Due to the asynchronous nature of T

    Due to the asynchronous nature of TEX’s output routine, discrepancies will occur in page spanning paragraphs if you use the page counter.
    -

    -

    Note that you can’t use both the document-wide counting and the per-unit +

    +

    Note that you can’t use both the document-wide counting and the per-unit counting in the same document. -

    The counter value is used as part of a label, which means that

    The counter value is used as part of a label, which means that \thecounter-name⟩ needs to be expandable. Since \theHcounter-name⟩ if it exists otherwise it will use \thecounter-name⟩. -

    The per-unit counting function uses two attributes:

    The per-unit counting function uses two attributes: entrycount (as before) and @@ -13141,53 +13163,53 @@ class="cmss-10">entrycountunitcount (the name of the counter). -

    Both the original document-wide counting mechanism and the per-unit counting +

    Both the original document-wide counting mechanism and the per-unit counting mechanism provide a command that can be used to access the current count value for this run: -



    \glsentrycurrcount  \glsentrycurrcount{label}

    -

    +

    and the final value from the previous run: -



    \glsentryprevcount  \glsentryprevcount{label}

    -

    +

    In the case of the per-unit counting, this is the final value for the current unit. In both commands ⟨label⟩ is the entry’s label. -

    The per-unit counting mechanism additionally provides: -


    The per-unit counting mechanism additionally provides: +


    \glsentryprevtotalcount  \glsentryprevtotalcount{label}

    -

    +

    which gives the sum of all the per-unit totals from the previous run for the entry given by ⟨label⟩, and -



    \glsentryprevmaxcount  \glsentryprevmaxcount{label}

    -

    +

    which gives the maximum per-unit total from the previous run. -

    The above two commands are unavailable for the document-wide counting. -

    Example of per-unit counting, where the unit is the chapter: +

    The above two commands are unavailable for the document-wide counting. +

    Example of per-unit counting, where the unit is the chapter: @@ -13211,7 +13233,7 @@ which gives the maximum per-unit total from the previous run.  
    \printglossaries  
    \end{document}

    -

    In this document, the

    In this document, the css entry is used three times in the first chapter. This is more than the trigger value of 2, so \gls{css} is expanded on \gls{css} doesn’t get a line added to the glossary file. -

    The

    The html is used a total of three times, but the expansion and indexing suppression trigger is tripped in both chapters because the per-unit total (1 for the first chapter and 2 for the second chapter) is less than or equal to the trigger value. -

    The

    The sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the general\GlsXtrEnableEntryUnitCounting. -

    The per-unit entry counting can be used for other purposes. In the following +

    The per-unit entry counting can be used for other purposes. In the following example document the trigger value is set to zero, which means the index suppression won’t be triggered, but the unit entry count is used to automatically suppress the hyperlink for commands like \gls by modifying the hook -



    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +

    which is used at the end of the macro the determines whether or not to suppress the hyperlink. @@ -13279,22 +13301,22 @@ hyperlink.  
    \printglossaries  
    \end{document}

    -

    This only produces a hyperlink for the first instance of

    This only produces a hyperlink for the first instance of \gls{sample} on each page. -

    The earlier warning about using the

    The earlier warning about using the page counter still applies. If the first instance of \gls occurs at the top of the page within a paragraph that started on the previous page, then the count will continue from the previous page. -

    +

    -

    Top

    6.2 Link Counting

    -

    As from version 1.26, an alternative method of entry counting is to count the number +

    As from version 1.26, an alternative method of entry counting is to count the number @@ -13310,8 +13332,8 @@ class="cmtt-10">\hyperlink when displaying the link-text.) -

    To enable link counting use the preamble-only command: -


    To enable link counting use the preamble-only command: +


    \GlsXtrEnableLinkCounting  ] class="cmtt-10">{⟨categories}

    -

    +

    where ⟨categories⟩ is a list of category labels. The optional argument ⟨master @@ -13338,18 +13360,18 @@ href="#catattr.linkcountmaster">linkcountmaster attribute. -

    When enabled, commands like

    When enabled, commands like \gls and \glstext increment the associated counter using -



    \glsxtrinclinkcounter  \glsxtrinclinkcounter{counter name}

    -

    +

    This just does \stepcounter{counter name\refstepcounter instead, just redefine this command:

    \renewcommand*{\glsxtrinclinkcounter}[1]{\refstepcounter{#1}}
    -

    -

    You can access the internal count register using -


    +

    You can access the internal count register using +


    \GlsXtrLinkCounterValue  \GlsXtrLinkCounterValue{label}

    -

    +

    where ⟨label⟩ is the entry’s label. This will expand to 0 if the counter hasn’t been defined. -

    It’s also possible to access the display value (

    It’s also possible to access the display value (\thecounter⟩) using -



    \GlsXtrTheLinkCounter  \GlsXtrTheLinkCounter{counter}

    -

    +

    (This will expand to 0 if the counter hasn’t been defined.) -

    In order to conserve resources, the counter is only defined when it first +

    In order to conserve resources, the counter is only defined when it first needs to be incremented so terms that have been defined but haven’t been used in the document won’t have the associated count register allocated.
    -

    -

    You can test if the counter has been defined using: -


    +

    You can test if the counter has been defined using: +


    \GlsXtrIfLinkCounterDef  }{false}

    -

    +

    where ⟨label⟩ is the entry’s label. -

    The counter name can be obtained using -


    The counter name can be obtained using +


    \GlsXtrLinkCounterName  \GlsXtrLinkCounterName{label}

    -

    +

    This simply expands to the counter name associated with the entry given by ⟨label⟩ without any check for existence. For example, to change the display command @@ -13433,7 +13455,7 @@ class="cmss-10">etoolbox \csdef{the\GlsXtrLinkCounterName{duck}}{\Roman{\GlsXtrLinkCounterName{duck}}}

    -

    This is useful if you just want to change the display for specific entries but isn’t +

    This is useful if you just want to change the display for specific entries but isn’t convenient if you want to change the display for all entries. Instead, it’s simpler to redefine \GlsXtrTheLinkCounter. For example: @@ -13448,9 +13470,9 @@ class="cmtt-10">\GlsXtrTheLinkCounter. For example:  
     {0}%  
    }

    -

    In both cases, the redefinition should be implemented after

    In both cases, the redefinition should be implemented after \GlsXtrEnableLinkCounting. -

    Here’s an example document that uses link counting to disable the hyperlink after +

    Here’s an example document that uses link counting to disable the hyperlink after the first reference. This redefines \glslinkpresetkeys (which is used by both \glstext).  
    \printglossaries  
    \end{document}

    -

    The use of

    The use of \glslinkpresetkeys means that the options can override this. For example @@ -13499,7 +13521,7 @@ example

    \gls[hyper=true]{sample1}
    -

    will override the

    will override the hyper=false setting in \glslinkpresetkeys. If \glslinkpostsetkeyshyper=false setting will override the setting provided in the optional argument. -

    The

    The abbreviation category doesn’t have the \ifnum\GlsXtrLinkCounterValue{\glslabel}>1

    -

    will always be false. This means that the abbreviation won’t have

    will always be false. This means that the abbreviation won’t have hyper=false applied. If the test is changed to @@ -13540,9 +13562,9 @@ applied. If the test is changed to  
     \setkeys{glslink}{hyper=false}%  
    \fi

    -

    Then the abbreviation will always have

    Then the abbreviation will always have hyper=false applied. -

    To reset the counter every section use the optional argument to set the master +

    To reset the counter every section use the optional argument to set the master counter: @@ -13551,16 +13573,16 @@ counter:

    \GlsXtrEnableLinkCounting[section]{general}
    -

    +

    -

    -

    +

    Top

    7. Auto-Indexing

    -

    It’s possible that you may also want a normal index as well as the glossary, +

    It’s possible that you may also want a normal index as well as the glossary, and you may want entries to automatically be added to the index (as in this document). There are two attributes that govern this: indexnamedualindex. -

    The

    The \glsxtrpostnamehook macro, used at the end of \glossentrynamename key. -

    The internal macro used by the

    The internal macro used by the glossaries package to write the information to the external glossary file is modified to check for the dualindex attribute. -

    In both cases, the indexing is done through -


    In both cases, the indexing is done through +


    \glsxtrdoautoindexname  }{attribute-label}

    -

    +

    This uses the standard \index command with the sort value taken from the entry’s @@ -13617,15 +13639,15 @@ class="cmti-10">label⟩}. As from v1.16, there are user-level commands available to change the sort and actual value used by the automated index. -

    The actual value is given by -


    The actual value is given by +


    \glsxtrautoindexentry  \glsxtrautoindexentry{label}

    -

    +

    where ⟨label⟩ is the entry’s label. The default definition is: @@ -13635,12 +13657,12 @@ class="cmti-10">label⟩ is the entry’s label. The default def

    \newcommand*{\glsxtrautoindexentry}[1]{\string\glsentryname{#1}}
    -

    Note the use of

    Note the use of \string to prevent \glsentryname from being expanded as it’s written to the index file. -

    The sort value is assigned using: -


    The sort value is assigned using: +


    \glsxtrautoindexassignsort  }{label}

    -

    +

    where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the @@ -13664,31 +13686,31 @@ sort value. The default definition is:  
      \glsletentryfield{#1}{#2}{sort}%  
    }

    -

    After this macro is called, ⟨

    After this macro is called, ⟨cs⟩ is then processed to escape any of makeindex’s special characters. Note that this escaping is only performed on the sort not on the actual value. -

    The command used to perform the actual indexing is: -


    The command used to perform the actual indexing is: +


    \glsxtrautoindex  \glsxtrautoindex{text}

    -

    +

    This just does \index{text} by default. -

    The entry’s

    The entry’s parent field isn’t referenced in this automated indexing.
    -

    -

    For example, to index the value of the

    +

    For example, to index the value of the first key, instead of the namename \renewcommand*{\glsxtrautoindexentry}[1]{\string\glsentryfirst{#1}}

    -

    and if the sort value also needs to be set to the

    and if the sort value also needs to be set to the long field, if present, otherwise the sort  {\glsletentryfield{#1}{#2}{sort}}%  
    }

    -

    -

    If the value of the attribute given by ⟨

    +

    If the value of the attribute given by ⟨attribute-label⟩ is “true”, no encap will be added, otherwise the encap will be the attribute value. For example: @@ -13728,7 +13750,7 @@ added, otherwise the encap will be the attribute value. For example:

    \glssetcategoryattribute{general}{indexname}{textbf}
    -

    will set the encap to

    will set the encap to textbf which will display the relevant page number in bold whereas @@ -13738,13 +13760,13 @@ whereas

    \glssetcategoryattribute{general}{dualindex}{true}
    -

    won’t apply any formatting to the page number in the index. -

    The location used in the index will always be the page number not the counter +

    won’t apply any formatting to the page number in the index. +

    The location used in the index will always be the page number not the counter used in the glossary. (Unless some other loaded package has modified the definition of \index to use some thing else.)
    -

    -

    By default the

    +

    By default the format key won’t be used with the format key to override the attribute value by using the preamble-only command: -



    \GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride

    -

    +

    If you use this command and hyperref has been loaded, then the \glshypernumber to allow formats that use that command. -

    The

    The dualindex attribute will still be used on subsequent use even if the @@ -13788,8 +13810,8 @@ class="cmss-10">dualindexnoindex key.
    -

    -

    The

    +

    The \glsxtrdoautoindexname command will attempt to escape any of \makeindex\encapchar have been defined before glossaries-extra is loaded). -

    If this isn’t the case, you can use the following preamble-only commands to set +

    If this isn’t the case, you can use the following preamble-only commands to set the correct characters. -

    Be very careful of possible shifting category codes!
    -

    -


    Be very careful of possible shifting category codes!
    +

    +


    \GlsXtrSetActualChar  \GlsXtrSetActualChar{char}

    -

    +

    Set the actual character to ⟨char⟩. -



    \GlsXtrSetLevelChar  \GlsXtrSetLevelChar{char}

    -

    +

    Set the level character to ⟨char⟩. -



    \GlsXtrSetEscChar  \GlsXtrSetEscChar{char}

    -

    +

    Set the escape (quote) character to ⟨char⟩. -



    \GlsXtrSetEncapChar  }

    -

    +

    Set the encap character to ⟨char⟩.

    -

    -

    +

    Top

    8. On-the-Fly Document Definitions

    -

    The commands described here may superficially look like ⟨

    The commands described here may superficially look like ⟨word\index{word\index then just use \index.
    -

    -

    The

    +

    The glossaries package advises against defining entries in the documentglossaries-extra but can be enabled using the href="#styopt.docdefs">docdefs package options. -

    Although this can be problematic, the

    Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the documentdocdefsThere are limitations with this approach, so take care with it. This function is disabled by default, but can be enabled using the preamble-only command: -



    \GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly

    -

    +

    When used, this defines the commands described below. -

    The commands

    The commands \glsxtr, \glsxtrpl, \Glsxtr and \printglossary\gls or there may be unexpected results.
    -

    -


    +


    \glsxtr  dfn-options]{label}

    -

    +

    If an entry with the label ⟨label⟩ has already been defined, this just does \gls @@ -13967,7 +13989,7 @@ class="cmitt-10">dfn-options⟩}

    -

    The ⟨

    The ⟨label⟩ must contain any non-expandable commands, such as formatting commands or problematic characters. If the term requires any of these, they must be omitted from the ⟨name key must be provided in the optional argument ⟨dfn-options⟩.
    -

    +

    -

    The second optional argument ⟨

    The second optional argument ⟨dfn-options⟩ should be empty if the entry has already been defined, since it’s too late for them. If it’s not empty, a warning will be generated with -



    \GlsXtrWarning  dfn-options}{label}

    -

    -

    For example, this warning will be generated on the second instance of

    +

    For example, this warning will be generated on the second instance of \glsxtr below: @@ -14006,8 +14028,8 @@ below:  
     ... later  
    \glsxtr[][plural=geese]{goose}

    -

    -

    If you are considering doing something like: +

    +

    If you are considering doing something like: @@ -14018,14 +14040,14 @@ below:  
     ... later  
    \goose\ some more text here

    -

    then don’t bother. It’s simpler and less problematic to just define the entries in the +

    then don’t bother. It’s simpler and less problematic to just define the entries in the preamble with \newglossaryentry and then use \gls in the document. -

    There are plural and case-changing alternatives to

    There are plural and case-changing alternatives to \glsxtr: -



    \glsxtrpl  dfn-options]{label}

    -

    +

    This is like \glsxtr but uses \glspl instead of \gls. -



    \Glsxtr  dfn-options]{label}

    -

    +

    This is like \glsxtr but uses \Gls instead of \gls. -



    \Glsxtrpl  dfn-options]{label}

    -

    +

    This is like \glsxtr but uses \Glspl instead of \gls. -

    If you use UTF-8 and don’t want the inconvenient of needing to use an +

    If you use UTF-8 and don’t want the inconvenient of needing to use an ASCII-only label, then it’s better to use XƎLATEX or LuaLATEX instead of LATEX (or pdfLATEX). If you really desperately want to use UTF-8 entry labels @@ -14082,20 +14104,20 @@ without switching to X\GlsXtrEnableOnTheFly that allows you to use UTF-8 characters in ⟨label⟩, but it’s experimental and may not work in some cases. -

    If you use the starred version of

    If you use the starred version of \GlsXtrEnableOnTheFly don’t use any commands in the ⟨label⟩, even if they expand to just text.
    -

    +

    -

    -

    +

    Top

    9. bib2gls: Managing Reference Databases

    -

    There is a new command line application called

    There is a new command line application called bib2gls.glstex file which is loaded using \glsxtrresourcefile (or \GlsXtrLoadResources). -

    This means that you can use a reference managing system, such as JabRef, to +

    This means that you can use a reference managing system, such as JabRef, to maintain the database and it reduces the TEX overhead by only defining the entries that are actually required in the document. If you currently have a convertgls2bibbib2gls.) -

    There are some new commands and options added to

    There are some new commands and options added to glossaries-extra to help assist the integration of bib2gls into the document build process. -

    This chapter just provides a general overview of

    This chapter just provides a general overview of bib2gls. The full details and @@ -14150,7 +14172,7 @@ some sample documents are provided in the bib2gls manual. -

    An example of the contents of

    An example of the contents of .bib file that stores glossary entries that can be extracted with bib2gls  description={a waterbird with a long neck}  
    }

    -

    -

    The follow provides some abbreviations: +

    +

    The follow provides some abbreviations: @@ -14201,8 +14223,8 @@ class="cmtt-10">bib2gls  description={a simple interpreted server-side scripting language}  
    }

    -

    -

    Here are some symbols: +

    +

    Here are some symbols: @@ -14225,8 +14247,8 @@ preamble{"\providecommand{\mtx}[1]{\boldsymbol{#1}}"}  
      description={a set}  
    }

    -

    -

    To ensure that

    +

    To ensure that bib2glsrecord \usepackage[record]{glossaries-extra}

    -

    If this option’s value is omitted (as above), the normal indexing will be switched off, +

    If this option’s value is omitted (as above), the normal indexing will be switched off, since bib2gls can also sort the entries and collate the locations. -

    If you still want to use an indexing application (for example, you need a custom +

    If you still want to use an indexing application (for example, you need a custom =alsoindex\makeglossaries and \printglossary (or \printglossaries), but it’s a good idea to also instruct +class="cmtt-10">\printglossaries), but you also need to instruct bib2gls to omit sorting to save time. -

    The .glstex file created by \bib2gls is loaded using: -


    to omit sorting to save time and to prevent the sort key from being +set. +

    The .glstex file created by bib2gls is loaded using: +


    \glsxtrresourcefile  \glsxtrresourcefile[options]{filename}

    -

    +

    (Don’t include the file extension in ⟨filename⟩.) There’s a shortcut version (recommended over the above) that sets ⟨filename⟩ to use \jobname: -



    \GlsXtrLoadResources  \GlsXtrLoadResources[options]

    -

    +

    On the first use, this command is a shortcut for

    }
    On subsequent use,9.1 this + id="x1-33030f1"> this command is a shortcut for
    }
    where ⟨n⟩ is the current value of -



    \glsxtrresourcecount

    -

    +

    which is incremented at the end of \GlsXtrLoadResources. Any advisory notes regarding \glsxtrresourcefile also apply to \GlsXtrLoadResources. -

    The

    The \glsxtrresourcefile command writes the line

    filename.glstex if it exists.9.2 + id="x1-33031f2"> -

    Since the .glstex won’t exist on the first LAT

    Since the .glstex file won’t exist on the first LATEX run, the record package option -additionally switches on package +option additionally switches on undefaction=warn. Any use of commands like . Any use of commands like \gls or \glstext will produce ?? in the document, since they are undefined at this point. -Once \glstext will produce ?? in the document, since the entries are undefined at this +point. Once bib2gls has created the has created the .glstex file the references should be resolved. -This may cause a shift in the locations if the actual text produced once the -entry is defined is larger than the placeholder ?? (as can occur with long -citations). -

    Note that as from v1.12,

    Note that as from v1.12, \glsxtrresourcefile temporarily switches the category code of @ to 11 (letter) while it reads the file to allow for any internal commands stored in the location field.

    -

    Top

    9.1 Selection

    -

    The default behaviour is for

    The default behaviour is for bib2glsbib2gls.aux file, and any dependent entries (including parent and cross-references). The glsignore format (for example, \gls[format=glsignore]{duck}) is recognised -by \gls[format=glsignore]{duck}) is recognised by +bib2gls as a special ignored record. This means that it will match the -selection criteria but the record won’t be added to the location list. This means -that you won’t get spurious commas in the location list, so you can do, for -example, + id="dx1-34004"> as a special ignored record. This means that it will match the selection +criteria but the record won’t be added to the location list. This means that you won’t +get spurious commas in the location list (as can happen with the other indexing +methods), so you can do, for example, @@ -14401,7 +14428,7 @@ example,

    \GlsXtrSetDefaultNumberFormat{glsignore}
    -

    at the start of the front matter and +

    at the start of the front matter and @@ -14409,9 +14436,9 @@ example,

    \GlsXtrSetDefaultNumberFormat{glsnumberformat}
    -

    at the start of the main matter to prevent any records in the front matter from +

    at the start of the main matter to prevent any records in the front matter from occurring in the location lists. -

    Note that commands like

    Note that commands like \glsaddall and \glsaddallunused don’t work with bib2gls.
    -

    -

    If you want to add all entries to the glossary, you need to tell

    +

    If you want to add all entries to the glossary, you need to tell bib2gls this in the @@ -14438,7 +14465,7 @@ options list. For example:

    \GlsXtrLoadResources[src={terms},selection={all}]
    -

    This will add all entries, regardless of whether or not they have any records in the +

    This will add all entries, regardless of whether or not they have any records in the .aux file. Those that don’t have any records will have an empty location list. See the .aux file. Those that don’t have any records will h href="#glo:bib2gls">bib2gls user manual for more details of this option. -

    +

    -

    Top

    9.2 Sorting and Displaying the Glossary

    -

    There are many sorting options provided by

    There are many sorting options provided by bib2gls. The default is to sort @@ -14477,30 +14504,31 @@ example:  
      sort=de-DE-1996 % sort according to this locale  
    ]

    -

    The locale-sensitive sort methods usually ignore most punctuation so for lists of +

    The locale-sensitive sort methods usually ignore most punctuation so for lists of symbols you may find it more appropriate to use one of the letter-base sort methods -that sort according to the Unicode value of each character. See the bib2gls manual -for full details of all the available sort methods. -

    Since the manual for full details of all the available sort +methods. +

    Since the .glstex file only defines those references required within the document (selected according to the selection option) and the definitions have been written in the order corresponding to bib2gls sorted list, the glossaries can simply be displayed -using ’s sorted list, the glossaries can simply be +displayed using \printunsrtglossary (or \printunsrtglossaries), described in \printunsrtglossaries), described in +§10.2 -§10.2 Display All Entries Without Sorting or Indexing. -

    Suppose the

    Suppose the .bib examples shown above have been stored in the files terms.bib, EX’s path. Then the document might look like:  
    \printunsrtglossaries  
    \end{document}

    -

    The document build process (assuming the document is called

    The document build process (assuming the document is called mydoc) is: @@ -14535,7 +14563,7 @@ pdflatex mydoc  
    bib2gls mydoc  
    pdflatex mydoc

    -

    This creates a single glossary containing the entries:

    This creates a single glossary containing the entries: bird, duck, goose, shtml. These cross-referenced entries won’t have a location list when the glossary is first displayed, but depending on how they are referenced, they may pick up a location list on the next document build. -

    The entries can be separated into different glossaries with different sort +

    The entries can be separated into different glossaries with different sort methods: @@ -14596,8 +14624,8 @@ methods:  
    \printunsrtglossaries  
    \end{document}

    -

    -

    Or you can have multiple instance of

    +

    Or you can have multiple instance of \GlsXtrLoadResources with the same type, which will produce a glossary with ordered sub-blocks. For example: @@ -14623,7 +14651,7 @@ class="cmtt-10">type, which will produce a glossary with ordered sub-bloc  
    \printunsrtglossaries  
    \end{document}

    -

    This will result in a glossary where the first group has the title “Abbreviations”, the +

    This will result in a glossary where the first group has the title “Abbreviations”, the second group has the title “Symbols” and then follow the usual letter groups. Note that for this example to work, you must run bib2gls -g myDoc  
    pdflatex myDoc

    -

    -

    You can provide your own custom sort rule. For example, if you are using +

    The value of the group field must always be a label. You can set the corresponding +title with \glsxtrsetgrouptitle (see §2.9 Glossary Style Modifications). If no title +is set then the label is used as the group title. +

    You can provide your own custom sort rule. For example, if you are using XƎLATEX or LuaLATEX:

    ]
    Remember that if you are using inputenc then extended characters, such as é or ø, + id="dx1-35019"> then extended characters, such as é or ø, are active and will expand when written to the .aux file. So with PDFLATEX the -above would have to be changed to protect against expansion. Some of the options, -including sort-rule, may have Unicode characters indicated in the format sort-rule, allow Unicode characters to be indicated in the +format \uhex⟩ (or -hex⟩ (or \u ⟨hex⟩) in the .aux file. bib2gls will recognise this format as indicating the + id="dx1-35021"> will recognise this as the character given by the hexadecimal value ⟨hex⟩. The \u also needs protection from @@ -14808,7 +14844,7 @@ written as \string\uE6 and so on. This is quite cumbersome, but you can use the shortcut \glshex E6 instead, so the above needs to be written as:
    @@ -14828,6 +14864,9 @@ class="cmtt-10"> % custom sort rule + + +
      sort-rule= < \glshex E6;\glshex C6 - - -
      <}]
    -

    +

    -

    Top

    9.3 Supplementary Commands

    -

    These commands are provided by glossaries-extra for use with The glossaries-extra-bib2gls package +

    The package option record=only (or simply record) automatically loads the +supplementary package glossaries-extra-bib2gls, which provides some commands that +are specific to sorting with bib2gls. -


    . The package isn’t loaded by record=alsoindex as +that option is intended for sorting with makeindex or xindy and it is expected that +the sorting will be switched off (with the resource option sort=none). +

    If glossaries-extra-bib2gls is loaded via the record package option then the +check for associated language resource files (see §13 Multi-Lingual Support) +will also search for the existence of glossariesxtr-script.ldf for each +document dialect (where ⟨script⟩ is the four letter script identifier, such as +Latn). +


    \glshex  \glshex

    -

    +

    This is just defined as \string\u, which is required when you need to indicate a Unicode character in the form \uhex⟩ in some of the resource options (as illustrated above). -

    The information provided with \GlsXtrLoadResources is written to the .aux file -using

    -
    +


    \glsxtrprovidecommand  \glsxtrprovidecommand

    +

    +This command is intended for use in @preamble. It’s simply defined to +\providecommand in glossaries-extra-bib2gls but bib2gls’s interpreter treats it as \protected@write\@auxout{\glsxtrresourceinit}{information} -

    -
    where ⟨information⟩ is the information to pass to \renewcommand. This means that you can override bib2gls. The command in the -second argument -


    \glsxtrresourceinit  \glsxtrresourceinit

    -

    -may be used to temporarily redefine commands before the information is written to -the file. This does nothing by default, but may be redefined to allow the use of short -commands for convenience. For example, with: + id="dx1-36017">’s internal definition of a +command without overriding the command definition in the document (if it’s already +defined before the resource file is input). For example

    -\renewcommand{\glsxtrresourceinit}{\let\u\glshex} +@preamble{"\glsxtrprovidecommand{\int}{integral}"}
    -

    you can just use, for example, \u E6 instead of \string\uE6 in the custom rule. -This redefinition of \u is scoped so its original definition is restored after the write -operation. -

    It’s possible to specify label prefixes. For example, modifying the earlier -example: - - - -

    -
    -\documentclass{article} - 
    \usepackage[record,style=indexgroup]{glossaries-extra} - 
    \setabbreviationstyle{long-short-desc} - 
    \GlsXtrLoadResources - 
     [src={abbrvs},sort={letter-nocase},type=main, - 
      label-prefix={abr.}, +

    This will force bib2gls to treat \int as the word “integral” to assist sorting but if +this preamble code is written to the .glstex file (as it is by default) then it won’t +override the current definition (provided by the kernel or redefined by a +package). +

    The glossaries-extra-bib2gls package also provides definitions of the missing +mathematical Greek commands: \Alpha, \Beta, \Epsilon, \Zeta, \Eta, \Iota, +\Kappa, \Mu, \Nu, \Omicron, \Rho, \Tau, \Chi, \Digamma, \omicron. These are all +defined with \providecommand, so they won’t override any definitions provided by +any package loaded before glossaries-extra. Since bib2gls’s interpreter recognises +these commands, using them instead of explicitly using the Latin characters with the +same shape helps to keep the Greek symbols together when sorting. Similarly, +if upgreek has been loaded, the missing upright Greek commands are also +provided. +

    The remaining commands provide common rule blocks for use in the +sort-rule resource option. If you want a rule for a specific locale, you can +provide similar commands in a file called glossariesxtr-tag.ldf, where ⟨tag⟩ +identifies the dialect, locale, region or root language. See the description of +\IfTrackedLanguageFileExists in the tracklang documentation for further details. +If this file is on TEX’s path and the tracklang package (automatically loaded by +glossaries) detects that the document has requested that language or locale, then the +file will automatically be loaded. For example, if you want to provide a rule +block for Welsh, then create a file called glossariesxtr-welsh.ldf that +contains: + + + +

    +
    +\ProvidesGlossariesExtraLang{welsh}[2018/02/23 v1.0] + 
    \@ifpackageloaded{glossaries-extra-bib2gls} + 
    { + 
      \newcommand{\glsxtrWelshRules}{% + 
       \glsxtrLatinA + 
       \string<b,B + 
       \string<c,C + 
       \string<ch,CH + 
       \string<d,D + 
       \string<dd,DD + 
       \string<\glsxtrLatinE + 
       \string<f,F + 
       \string<ff,FF + 
       \string<g,G + 
       \string<ng,NG + 
       \string<\glsxtrLatinH + 
       \string<\glsxtrLatinI + 
       \string<j,J + 
       \string<\glsxtrLatinL + 
       \string<ll,LL + 
       \string<\glsxtrLatinM + 
       \string<\glsxtrLatinN + 
       \string<\glsxtrLatinO + 
       \string<\glsxtrLatinP + 
       \string<ph,PH + 
       \string<r,R + 
       \string<rh,RH + 
       \string<\glsxtrLatinS + 
       \string<\glsxtrLatinT + 
       \string<th,TH + 
       \string<u,U + 
       \string<w,W + 
       \string<y,Y + 
      } + 
    } + 
    {}% glossaries-extra-bib2gls.sty not loaded +
    +

    (The use of \string is in case the < character has been made active.) You can +provide more than one rule-block per local, to allow for loanwords or foreign words. +For example, you could provide \glsxtrWelshIRules, \glsxtrWelshIIRules +etc. +

    If the rules are for a particular script (independent of language or region) then +they can be provided in a file given by glossariesxtr-script.ldf instead. For +example, the file glossariesxtr-Cyrl.ldf could contain: + + + +

    +
    +\ProvidesGlossariesExtraLang{Cyrl}[2018/02/23 v1.0] + 
    \newcommand*{\glsxtrGeneralCyrillicIRules}{% + 
      % Cyrillic rules + 
    } + 
    \newcommand*{\glsxtrGeneralCyrillicIIRules}{% + 
      % an alternative set of Cyrillic rules + 
    } +
    +

    (Remember that the required document language scripts need to be tracked through +the tracklang package, in order for these files to be automatically loaded. This +essentially means ensuring you load the appropriate language package before +tracklang is loaded by the base glossaries package or any other package that uses it. +See the tracklang documentation for further details.) +

    Alternatively, if the rules are specific to a subject rather than a region or +language, then you can provide a supplementary package. For example, if you have a +package called, say, mapsymbols that provides map symbols, then the file +mapsymbols.sty might contain: + + + +

    +
    +\NeedsTeXFormat{LaTeX2e} + 
    \ProvidesPackage{mapsymbols} + 
     some package or font loading stuff here to provide + 
     the appropriate symbols + 
    \newcommand{\Stadium}{...} + 
    \newcommand{\Battlefield}{...} + 
    \newcommand{\Harbour}{...} + 
     etc + 
     Provide a rule block: + 
    \newcommand{\MapSymbolOrder}{% + 
     \glshex 2694 % crossed-swords 0x2694 + 
     \string< \glshex 2693 % anchor 0x2693 + 
     \string< \glshex 26BD % football 0x26BD + 
    } +
    +

    and the supplementary file mapsymbols.bib can provide the appropriate definitions +for bib2gls: + + + +

    +
    +@preamble{"\glsxtrprovidecommand{\Harbour}{\char"2693} + 
    \glsxtrprovidecommand{\Battlefield}{\char"2694} + 
    \glsxtrprovidecommand{\Stadium}{\char"26BD}"} +
    +

    Now both the preamble and rule block can be used in the resource set: + + + +

    +
    +\usepackage{mapsymbols}% my custom package + 
    \usepackage[record]{glossaries-extra} + 
    \GlsXtrLoadResources[ + 
      src={mapsymbols,% <--- my custom mapsymbols.bib + 
       entries% data in entries.bib + 
      }, + 
      sort={custom}, + 
      sort-rule={\glsxtrcontrolrules % control codes + 
     ;\glsxtrspacerules % space characters + 
     ;\glsxtrnonprintablerules % non-printable characters + 
     ;\glsxtrcombiningdiacriticrules % combining diacritics + 
     ,\glsxtrhyphenrules % hyphens + 
     <\glsxtrgeneralpuncrules % general punctuation + 
     <\glsxtrdigitrules % 0, ..., 9 + 
     <\glsxtrfractionrules % fraction symbols + 
     <\MapSymbolOrder % <--- custom map symbols + 
     <\glsxtrMathItalicGreekIrules % math-greek symbols + 
     <\glsxtrGeneralLatinIrules % Latin letters + 
     } + 
    ] +
    +

    +

    The following commands are provided by glossaries-extra-bib2gls. They should be +separated by the rule separator characters ; (semi-colon) or , (comma) or +& (ampersand) or < (less than). See Java’s RuleBasedCollator documentation for +details of the rule syntax. +

    For example, the following will place the mathematical Greek symbols (\alpha, +\Alpha, \beta, \Beta etc) in a block before Latin characters: + + + +

    +
    +sort-rule={\glsxtrcontrolrules + 
     ;\glsxtrspacerules + 
     ;\glsxtrnonprintablerules + 
     ;\glsxtrcombiningdiacriticrules + 
     ,\glsxtrhyphenrules + 
     <\glsxtrgeneralpuncrules + 
     <\glsxtrdigitrules + 
     <\glsxtrfractionrules + 
     <\glsxtrMathItalicGreekIrules + 
     <\glsxtrGeneralLatinIVrules + 
     <\glsxtrLatinAA + 
     <\glsxtrLatinOslash + 
    } +
    +

    +


    \glsxtrcontrolrules  \glsxtrcontrolrules

    +

    +These are control characters that are usually placed at the start of a rule in the +ignored section. They typically won’t occur in any sort values, but if they do they +should normally be ignored. +


    \glsxtrspacerules  \glsxtrspacerules

    +

    +These are space characters. They typically come after the control characters with the +two blocks separated by a ; (semi-colon). +


    \glsxtrnonprintablerules  \glsxtrnonprintablerules

    +

    +These are non-printable characters (BOM, tabs, line feed and carriage return). They +typically come after the spaces separated by a ; (semi-colon). These characters +aren’t checked for by bib2gls when it determines whether or not to use the +interpreter, so a TAB or newline character may end up in the sort value if it wasn’t +interpreted. +


    \glsxtrcombiningdiacriticrules  \glsxtrcombiningdiacriticrules +

    +

    +These are combining diacritic marks which typically follow the space and +non-printable blocks (separated by a semi-colon). This command is defined in terms +of sub-block commands: + + + +

    +
    +\newcommand*{\glsxtrcombiningdiacriticrules}{% + 
     \glsxtrcombiningdiacriticIrules\string; + 
     \glsxtrcombiningdiacriticIIrules\string; + 
     \glsxtrcombiningdiacriticIIIrules\string; + 
     \glsxtrcombiningdiacriticIVrules + 
    } +
    +

    If you prefer, you can use the sub-blocks directly in your required ordered. +


    \glsxtrcombiningdiacriticIrules  \glsxtrcombiningdiacriticIrules +

    +

    +This contains the combining diacritics: acute, grave, breve, circumflex, caron, ring, +vertical line above, diaeresis (umlaut), double acute, tilde, dot above, combining +macron. +


    \glsxtrcombiningdiacriticIIrules  \glsxtrcombiningdiacriticIIrules +

    +

    +This contains the combining diacritics: short solidus overlay, cedilla, ogonek, dot +below, low line, overline, hook above, double vertical line above, double grave +accent, candrabindu, inverted breve, turned comma above, comma above, +reversed comma above, comma above right, grave accent below, acute accent +below. +


    \glsxtrcombiningdiacriticIIIrules  \glsxtrcombiningdiacriticIIIrules +

    +

    +This contains the combining diacritics: left tack below, right tack below, left angle +above, horn, left half ring below, up tack below, down tack below, plus sign below, +minus sign below, palatalized hook below, retroflex hook below, diaresis below, ring +below, comma below, vertical line below, bridge below, inverted double arch below, +caron below, circumflex accent below, breve below, inverted breve below, tilde below, +macron below, double low line, tilde overlay, short stroke overlay, long stroke overlay, +long solidus overlay, right half ring below, inverted bridge below, square below, +seagull below, x above, vertical tilde, double overline, Greek perispomeni, Greek +dialytika tonos, Greek ypogegrammeni, double tilde, double inverted breve, +Cyrillic titlo, Cyrillic palatalization, Cyrillic dasia pneumata, Cyrillic psili +pneumata. +


    \glsxtrcombiningdiacriticIVrules  \glsxtrcombiningdiacriticIVrules +

    +

    +This contains the combining diacritics: left harpoon above, right harpoon above, long +vertical line overlay, short vertical line overlay, anticlockwise arrow above, clockwise +arrow above, left arrow above, right arrow above, ring overlay, clockwise ring overlay, + + + +anticlockwise ring overlay, three dots above, four dots above, enclosing circle, +enclosing square, enclosing diamond, enclosing circle backslash, left right arrow +above. +


    \glsxtrhyphenrules  \glsxtrhyphenrules

    +

    +This contains hyphens (including the minus sign 0x2212). This rule block typically +comes after the diacritic rules separated by a comma. +


    \glsxtrgeneralpuncrules  \glsxtrgeneralpuncrules

    +

    +This contains punctuation characters. This rule block typically comes after the +hyphen rules separated by a less than (<). As with the combining diacritics, this +command is defined in terms of sub-blocks which may be used directly instead if a +different order is required: + + + +

    +
    +\newcommand*{\glsxtrgeneralpuncrules}{% + 
      \glsxtrgeneralpuncIrules + 
      \string<\glsxtrcurrencyrules + 
      \string<\glsxtrgeneralpuncIIrules + 
    } +
    +

    +


    \glsxtrgeneralpuncIrules  \glsxtrgeneralpuncIrules

    +

    +This is the first punctuation sub-block containing: underscore, macron, comma, +semi-colon, colon, exclamation mark, inverted exclamation mark, question +mark, inverted question mark, solidus, full stop, acute accent, grave accent, +circumflex accent, diaersis, tilde, middle dot, cedilla, straight apostrophe, +straight double quote, left guillemet, right guillemet, left parenthesis, right +parenthesis, left square bracket, right square bracket, left curly bracket, right +curly bracket, section sign, pilcrow sign, copyright sign, registered sign, at +sign. +


    \glsxtrcurrencyrules  \glsxtrcurrencyrules

    +

    +This sub-block contains some currency symbols: currency sign, Thai currency symbol +baht, cent sign, colon sign, cruzeiro sign, dollar sign, dong sign, euro sign, French +franc sign, lira sign, mill sign, naira sign, peseta sign, pound sign, rupee sign, new +sheqel sign, won sign, yen sign. +


    \glsxtrgeneralpuncIIrules  \glsxtrgeneralpuncIIrules

    +

    +This sub-block contains some other punctuation symbols: asterisk, backslash, +ampersand, hash sign, percent sign, plus sign, plus-minus sign, division sign, +multiplication sign, less-than sign, equals sign, greater-than sign, not sign, vertical +bar (pipe), broken bar, degree sign, micron sign. +


    \glsxtrdigitrules  \glsxtrdigitrules

    +

    +This rule block contains the Basic Latin digits (0, …, 9) and the subscript and +superscript digits (0 0 etc) made equivalent to the corresponding Basic Latin digit. +The digit block typically comes after the punctuation rules separated by a less than +(<). +


    \glsxtrBasicDigitrules  \glsxtrBasicDigitrules

    +

    +This rule block contains just the Basic Latin digits (0, …, 9). +


    \glsxtrSubScriptDigitrules  \glsxtrSubScriptDigitrules

    +

    +This rule block contains just the subscript digits (0 … 9). +


    \glsxtrSuperScriptDigitrules  \glsxtrSuperScriptDigitrules

    + + + +

    +This rule block contains just the superscript digits (0 … 9). +


    \glsxtrfractionrules  \glsxtrfractionrules

    +

    +This rule block contains vulgar fraction characters. The digit block typically comes +after the digit rules separated by a less than (<). +

    There are a number of Latin rule blocks. Some of these included extended +characters or ligatures (such as ß or œ) but they don’t include accented +characters. If you require a Latin rule block that includes accented characters, +digraphs, trigraphs or other extended characters, then it’s best to provide similar +commands in a glossariesxtr-tag.ldf file for the particular language or +region. +


    \glsxtrGeneralLatinIrules  \glsxtrGeneralLatinIrules

    +

    +This is just the basic (non-extended) Latin alphabet with the superscript and +subscript Latin letters (a a etc) treated as the equivalent basic Latin letter. (If you +don’t want the subscripts and superscripts included you can redefine \glsxtrLatinA +etc to omit them.) +


    \glsxtrGeneralLatinIIrules  \glsxtrGeneralLatinIIrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’ +and eszett (ß) treated as ‘ss’. +


    \glsxtrGeneralLatinIIIrules  \glsxtrGeneralLatinIIIrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’ +and eszett (ß) treated as ‘sz’. +


    \glsxtrGeneralLatinIVrules  \glsxtrGeneralLatinIVrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, +ae-ligature (æ) is treated as ‘ae’, oe-ligature (œ) is treated as ‘oe’, eszett (ß) treated +as ‘ss’ and thorn (þ) is treated as ‘th’. +


    \glsxtrGeneralLatinVrules  \glsxtrGeneralLatinVrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, +eszett (ß) treated as ‘ss’ and thorn (þ) treated as ‘th’. +


    \glsxtrGeneralLatinVIrules  \glsxtrGeneralLatinVIrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, +eszett (ß) treated as ‘sz’ and thorn (þ) treated as ‘th’. +


    \glsxtrGeneralLatinVIIrules  \glsxtrGeneralLatinVIIrules

    +

    +This is like \glsxtrGeneralLatinIrules but it includes ae-ligature (æ) between ‘A’ +and ‘B’, eth (Ð) between ‘D’ and ‘E’, insular G (Ᵹ) instead of ‘G’, oe-ligature between +‘O’ and ‘P’, long s (ſ) equivalent to ‘s’, thorn (þ) between ‘T’ and ‘U’ and wynn (Ƿ) +instead of W. +


    \glsxtrGeneralLatinVIIIrules  \glsxtrGeneralLatinVIIIrules

    + + + +

    +This is like \glsxtrGeneralLatinIrules but ae-ligature (æ) is treated as ‘ae’, +oe-ligature (œ) is treated as ‘oe’, eszett (ß) treated as ‘ss’, thorn (þ) is treated as ‘th’, +Ø is treated as ‘O’ and ‘Ł’ is treated as ‘L’. +


    \glsxtrLatinA  \glsxtrLatinA

    +

    +A mini-rule that just covers ‘A’ but includes the sub- and superscript A. +


    \glsxtrLatinE  \glsxtrLatinE

    +

    +A mini-rule that just covers ‘E’ but includes the subscript E. +


    \glsxtrLatinH  \glsxtrLatinH

    +

    +A mini-rule that just covers ‘H’ but includes the subscript H. +


    \glsxtrLatinK  \glsxtrLatinK

    +

    +A mini-rule that just covers ‘K’ but includes the subscript K. +


    \glsxtrLatinI  \glsxtrLatinI

    +

    +A mini-rule that just covers ‘I’ but includes the superscript I. +


    \glsxtrLatinL  \glsxtrLatinL

    +

    +A mini-rule that just covers ‘L’ but includes the subscript L. +


    \glsxtrLatinM  \glsxtrLatinM

    +

    +A mini-rule that just covers ‘M’ but includes the subscript M. +


    \glsxtrLatinN  \glsxtrLatinN

    +

    +A mini-rule that just covers ‘N’ but includes the sub- and superscript N. +


    \glsxtrLatinO  \glsxtrLatinO

    +

    +A mini-rule that just covers ‘O’ but includes the sub- and superscript O. +


    \glsxtrLatinP  \glsxtrLatinP

    +

    +A mini-rule that just covers ‘P’ but includes the subscript P. +


    \glsxtrLatinS  \glsxtrLatinS

    +

    +A mini-rule that just covers ‘S’ but includes the subscript S. +


    \glsxtrLatinT  \glsxtrLatinT

    +

    +A mini-rule that just covers ‘T’ but includes the subscript T. +


    \glsxtrLatinX  \glsxtrLatinX

    +

    +A mini-rule that just covers ‘X’ but includes the subscript X. +


    \glsxtrLatinEszettSs  \glsxtrLatinEszettSs

    +

    +A mini-rule that just covers eszett (ß) and makes long s (ſ) followed by short ‘s’ + + + +equivalent to ‘ß’. (This is used in the above blocks that treat ‘ß’ as ‘ss’.) +


    \glsxtrLatinEszettSz  \glsxtrLatinEszettSz

    +

    +A mini-rule that just covers eszett (ß) and makes long s (ſ) followed by ‘z’ equivalent +to ‘ß’. (This is used in the above blocks that treat ‘ß’ as ‘sz’.) +


    \glsxtrLatinEth  \glsxtrLatinEth

    +

    +A mini-rule for eth (Ð) so you don’t need to remember the Unicode values. +


    \glsxtrLatinThorn  \glsxtrLatinThorn

    +

    +A mini-rule for thorn (þ) so you don’t need to remember the Unicode values. +


    \glsxtrLatinAELigature  \glsxtrLatinAELigature

    +

    +A mini-rule for ae-ligature (æ) so you don’t need to remember the Unicode +values. +


    \glsxtrLatinOELigature  \glsxtrLatinOELigature

    +

    +A mini-rule for oe-ligature (œ) so you don’t need to remember the Unicode +values. +


    \glsxtrLatinOslash  \glsxtrLatinOslash

    +

    +A mini-rule for ‘Ø’ so you don’t need to remember the Unicode values. +


    \glsxtrLatinLslash  \glsxtrLatinLslash

    +

    +A mini-rule for ‘Ł’ so you don’t need to remember the Unicode values. +


    \glsxtrLatinWynn  \glsxtrLatinWynn

    +

    +A mini-rule for wynn (Ƿ) so you don’t need to remember the Unicode values. +


    \glsxtrLatinInsularG  \glsxtrLatinInsularG

    +

    +A mini-rule for insular G (Ᵹ) so you don’t need to remember the Unicode +values. +


    \glsxtrLatinSchwa  \glsxtrLatinSchwa

    +

    +A mini-rule that just covers schwa (Ə) but includes the subscript schwa. (Not used in +any of the provided Latin rule blocks described above.) +


    \glsxtrLatinAA  \glsxtrLatinAA

    +

    +A mini-rule for ‘Å’ so you don’t need to remember the Unicode values. (Not used in +any of the provided Latin rule blocks described above.) +


    \glsxtrMathGreekIrules  \glsxtrMathGreekIrules

    +

    +A rule block for mathematical Greek (\alpha, \beta etc) and upright Greek +(\upalpha, etc, from the upgreek package) characters that includes digamma +(\digamma and \Digamma) between epsilon and zeta. The upright and italic versions +are gathered together into the same letter group. + + + +


    \glsxtrMathGreekIIrules  \glsxtrMathGreekIIrules

    +

    +As \glsxtrMathGreekIrules but doesn’t include digamma. +


    \glsxtrMathUpGreekIrules  \glsxtrMathUpGreekIrules

    +

    +A rule block for upright Greek (\upalpha, etc, from the upgreek package) +characters that includes digamma (\digamma and \Digamma) between epsilon and +zeta. +


    \glsxtrMathUpGreekIIrules  \glsxtrMathUpGreekIIrules

    +

    +A rule block for upright Greek (\upalpha, etc, from the upgreek package) that +doesn’t include digamma. +


    \glsxtrMathItalicGreekIrules  \glsxtrMathItalicGreekIrules

    +

    +A rule block for mathematical Greek (\alpha, \Alpha, etc) characters that includes +digamma (\diagamma and \Digamma) between epsilon and zeta. Note that even +though the upper case \Delta etc are actually rendered upright by LATEX, +bib2gls’s interpreter treats them as italic to help keep them close to the lower case +versions. +


    \glsxtrMathItalicGreekIIrules  \glsxtrMathItalicGreekIIrules

    +

    +A rule block for mathematical Greek (\alpha, \Alpha, etc) characters that doesn’t +include digamma. +


    \glsxtrMathItalicUpperGreekIrules  \glsxtrMathItalicUpperGreekIrules +

    +

    +A rule block for upper case mathematical Greek (\Alpha, \Beta, etc) characters that +includes digamma (\Digamma) between epsilon and zeta. +


    \glsxtrMathItalicUpperGreekIIrules  \glsxtrMathItalicUpperGreekIIrules +

    +

    +A rule block for upper case mathematical Greek (\Alpha, \Beta, etc) characters that +doesn’t include digamma. +


    \glsxtrMathItalicLowerGreekIrules  \glsxtrMathItalicLowerGreekIrules +

    +

    +A rule block for lower case mathematical Greek (\alpha, \beta, etc) characters that +includes digamma (\digamma) between epsilon and zeta. +


    \glsxtrMathItalicLowerGreekIIrules  \glsxtrMathItalicLowerGreekIIrules +

    +

    +A rule block for lower case mathematical Greek (\alpha, \beta, etc) characters that +doesn’t include digamma. +

    Additionally, there are commands in the form \glsxtrUpAlpha, \glsxtrUpBeta +etc and \glsxtrMathItalicAlpha, \glsxtrMathItalicBeta etc that just cover the +upper and lower case forms of a special Greek character (\Upalpha, \upalpha etc + + + +and \Alpha, \alpha etc) as well as the following: +


    \glsxtrMathItalicPartial  \glsxtrMathItalicPartial

    +

    +The partial derivative symbol (). +


    \glsxtrMathItalicNabla  \glsxtrMathItalicNabla

    +

    +The nabla symbol (). +

    +

    +

    Top

    9.4 Supplementary Commands

    +

    These commands are provided by glossaries-extra for use with bib2gls. +

    The information provided with \GlsXtrLoadResources is written to the .aux file +using

    +
    +\protected@write\@auxout{\glsxtrresourceinit}{information} +
    +
    where ⟨information⟩ is the information to pass to bib2gls. The command in the +second argument +


    \glsxtrresourceinit  \glsxtrresourceinit

    +

    +may be used to temporarily redefine commands before the information is written to +the file. This does nothing by default, but may be redefined to allow the use of short +commands for convenience. For example, with: + + + +

    +
    +\renewcommand{\glsxtrresourceinit}{\let\u\glshex} +
    +

    you can just use, for example, \u E6 instead of \string\uE6 in the custom rule. +This redefinition of \u is scoped so its original definition is restored after the write +operation. +

    It’s possible to specify label prefixes. For example, modifying the earlier +example: + + + +

    +
    +\documentclass{article} + 
    \usepackage[record,style=indexgroup]{glossaries-extra} + 
    \setabbreviationstyle{long-short-desc} + 
    \GlsXtrLoadResources + 
     [src={abbrvs},sort={letter-nocase},type=main, + 
      label-prefix={abr.},  
      group={Abbreviations}]  
    \GlsXtrLoadResources  
     [src={symbols},sort={use},type=main, @@ -15037,24 +16122,24 @@ example:  
    \printunsrtglossaries  
    \end{document}
    -

    If you do something like this, you may find it more convenient to define custom +

    If you do something like this, you may find it more convenient to define custom commands that set the prefix. For example:

    -
    +
    \newcommand*{\sym}[2][]{\gls[#1]{sym.#2}}
    -

    The problem with this is that the custom command

    The problem with this is that the custom command \sym doesn’t allow for modifiers (such as \gls* or \gls+). Instead you can use: -



    \glsxtrnewgls  \glsxtrnewgls[default options]{prefix}{cs}

    -

    +

    which defines the command ⟨cs⟩ that behaves like

    @@ -15087,26 +16172,26 @@ class="cmtt-10">] -
    +
    \glsxtrnewgls{sym.}{\sym}
    -

    or (to default to no hyperlinks) +

    or (to default to no hyperlinks)

    -
    +
    \glsxtrnewgls[hyper=false]{sym.}{\sym}
    -

    now you can use

    now you can use \sym+{M} to behave like \gls+{sym.M}. -

    If you also want the plural and first letter upper case versions you can +

    If you also want the plural and first letter upper case versions you can use -



    \glsxtrnewglslike  \glsxtrnewglslike[default options]{}{\Glspl-like cs}

    -

    +

    For example:

    -
    +
    \glsxtrnewglslike[hyper=false]{idx.}{\idx}{\idxpl}{\Idx}{\Idxpl}
    -

    For the all caps versions: -


    For the all caps versions: +


    \glsxtrnewGLSlike  \glsxtrnewGLSlike[default options]{\GLS-like cs}{\GLSpl-like cs}

    -

    +

    For example:

    -
    +
    \glsxtrnewGLSlike[hyper=false]{idx.}{\IDX}{\IDXpl}
    -

    -

    There’s an analogous command for

    +

    There’s an analogous command for \rgls: -



    \glsxtrnewrgls  \glsxtrnewrgls[default options]{}{cs}

    -

    +

    and for \rgls, \rglspl, \rGls and \rGlspl: -



    \glsxtrnewrglslike  \glsxtrnewrglslike[default options]{}{\rGlspl-like cs}

    -

    +

    and for the all caps: -



    \glsxtrnewrGLSlike  \glsxtrnewrGLSlike[default options]{\rGLS-like cs}{\rGLSpl-like cs}

    -

    -

    +

    +

    -

    Top

    9.4

    Top

    9.5 Record Counting

    -

    As from version 1.1 of

    As from version 1.1 of bib2gls, you can save the total record count for each entry by + id="dx1-38002">, you can save the total record count for each entry by invoking bib2gls with the with the --record-count or --record-count-unit switches. These options will ensure that when each entry is written to the .glstex file bib2gls will additionally set the following internal fields for that entry: + id="dx1-38006"> will additionally set the following internal fields for that entry:

    • recordcount: set to the total number of records found for class="cmtt-10">recordcount.⟨counter⟩: set to the total number of records found for the entry for the given counter.
    -

    If

    If --record-count-unit is used then additionally:

    • location⟩: set to the total number of reco -

      Only use the unit counting option if the locations don’t contain any special characters. If +

      Only use the unit counting option if the locations don’t contain any special characters. If you really need it with locations that may contain formatting commands, then you can try redefining: -



      \glsxtrdetoklocation  \glsxtrdetoklocation{location}

      -

      +

      so that it detokenizes ⟨location⟩ but take care when using \GlsXtrLocationRecordCount with commands like \thepage as they can end up becoming detokenized too early. -

      Note that the record count includes locations that

      Note that the record count includes locations that bib2gls discards, such as + id="dx1-38009"> discards, such as ignored records, duplicates and partial duplicates. It doesn’t include cross-reference records. For example, if \gls{bird} is used twice on page 1, once on page 2 and @@ -15295,43 +16380,43 @@ field) is 2 + 1 + 4 = 7, and the total for the section counter (stored in the recordcount.section field) is 1. -

      With the unit counting on as well, the field

      With the unit counting on as well, the field recordcount.page.1 is set to 2, recordcount.page.2 is set to 1, recordcount.page.3 is set to 4 and recordcount.section.3 is set to 1. -

      You can access these fields using the following commands which will expand to +

      You can access these fields using the following commands which will expand to the field value if set or to 0 if unset: -



      \GlsXtrTotalRecordCount  \GlsXtrTotalRecordCount{label}

      -

      +

      This expands to the total record count for the entry given by ⟨label⟩.

      -
      +
      \GlsXtrTotalRecordCount{bird}
      -

      expands to 8. -


      expands to 8. +


      \GlsXtrRecordCount  \GlsXtrRecordCount{label}{counter}

      -

      +

      This expands to the counter total for the entry given by ⟨label⟩ where ⟨counter⟩ is the @@ -15340,22 +16425,22 @@ counter name. For example:

      -
      +
      \GlsXtrRecordCount{bird}{page}
      -

      expands to 7 and +

      expands to 7 and

      -
      +
      \GlsXtrRecordCount{bird}{section}
      -

      expands to 1. -


      expands to 1. +


      \GlsXtrLocationRecordCount  \GlsXtrLocationRecordCount{label}{} class="cmtt-10">{location}

      -

      +

      This expands to the total for the given location. For example

      -
      +
      \GlsXtrLocationRecordCount{bird}{page}{3}
      -

      expands to 4. Be careful about using

      expands to 4. Be careful about using \thepage in the ⟨location⟩ part. Remember that due to TEX’s asynchronous output routine, \thepage may not be correct. -

      There are commands analogous to the entry counting commands like

      There are commands analogous to the entry counting commands like \cgls and \cglsformat that are triggered by the record count. These are listed below. -



      \rgls  \rglsmodifier[label}[insert]

      -

      -


      +


      \rglspl  \rglsplmodifier[label}[insert]

      -

      -


      +


      \rGls  \rGlsmodifier[label}[insert]

      -

      -


      +


      \rGlspl  \rGlsplmodifier[label}[insert]

      -

      -


      +


      \rGLS  \rGLSmodifier[label}[insert]

      -

      -


      +


      \rGLSpl  \rGLSplmodifier[label}[insert]

      -

      +

      These commands check the recordcount attribute which, if set, should be a number. + id="dx1-38019"> attribute which, if set, should be a number. For example:

      -
      +
      \glssetcategoryattribute{abbreviation}{recordcount}{1}
      -

      For convenience, you can use -


      For convenience, you can use +


      \GlsXtrSetRecordCountAttribute  \GlsXtrSetRecordCountAttribute{category list}{n}

      -

      +

      to set the recordcount attribute to ⟨ attribute to ⟨n⟩ for all the categories listed in ⟨category list⟩. -

      The

      The \rgls-like commands use -



      \glsxtrifrecordtrigger  \glsxtrifrecordtrigger{label}{} class="cmtt-10">{normal}

      -

      +

      to determine whether the \rgls-like command should behave like its \gls counterpart (⟨normal⟩) or whether it should instead use ⟨trigger code⟩. -

      This command checks if the

      This command checks if the recordcount attribute is set. If not is just does + id="dx1-38023"> attribute is set. If not is just does ⟨normal⟩, otherwise it tests if -



      \glsxtrrecordtriggervalue  \glsxtrrecordtriggervalue{label}

      -

      +

      is greater than the value given in the recordcount attribute for that entry’s category. + id="dx1-38025"> attribute for that entry’s category. If true, this does ⟨normal⟩ otherwise it does ⟨trigger code⟩. The default definition of the @@ -15550,105 +16635,105 @@ trigger value command is:

      -
      +
      \newcommand*{\glsxtrrecordtriggervalue}[1]{%  
       \GlsXtrTotalRecordCount{#1}%  
      }
      -

      The ⟨

      The ⟨trigger code⟩ part writes a record with the format set to set to glstriggerrecordformat (which bib2gls v1.1+ recognises as a special type of ignored location format) and + id="dx1-38028"> v1.1+ recognises as a special type of ignored location format) and does ⟨trigger format⟩. Then it unsets the first use flag. Note that it doesn’t implement the post-link hook. This ensures that the record count is correct on the next run. -

      The ⟨

      The ⟨trigger format⟩ depends on the \rgls-like command used and will be one of the following: -



      \rglsformat  \rglsformat{label}{insert}

      -

      -


      +


      \rglsplformat  \rglsplformat{label}{insert}

      -

      -


      +


      \rGlsformat  \rGlsformat{label}{insert}

      -

      -


      +


      \rGlsplformat  \rGlsplformat{label}{insert}

      -

      -


      +


      \rGLSformat  \rGLSformat{label}{insert}

      -

      -


      +


      \rGLSplformat  \rGLSplformat{label}{insert}

      -

      +

      These all behave much like their \cglsformat counterparts. If the entry’s regular + id="dx1-38036"> attribute is set or if the entry doesn’t have a long form, the first or first plural is used, otherwise the long or long plural form is used. -

      You can use -


      You can use +


      \glsxtrenablerecordcount  \glsxtrenablerecordcount

      -

      +

      to redefine \gls, \glspl, \rGls, class="cmtt-10">\rGlspl, \rGLS, \rGLSpl, respectively, for convenience. -

      If you don’t want the entries that use ⟨

      If you don’t want the entries that use ⟨trigger code⟩ to appear in the glossary, you need to use the resource option trigger-type to assign them to another glossary. @@ -15672,7 +16757,7 @@ For example:

      -
      +
      \documentclass{article}  
      \usepackage[record]{glossaries-extra}  
      \newignoredglossary{ignored} @@ -15689,7 +16774,7 @@ For example:  
      \printunsrtglossaries  
      \end{document}
      -

      In the above,

      In the above, stc and upa both only have one record, so they are assigned to the main one.

      -

      -

      +

      Top

      10. Miscellaneous New Commands

      -

      The

      The glossaries package provides \glsrefentry entry to cross-reference entries + id="dx1-39001"> entry to cross-reference entries when used with the entrycounter or or subentrycounter options. The options. The glossaries-extra package provides a supplementary command -



      \glsxtrpageref  \glsxtrpageref{label}

      -

      +

      that works in the same way except that it uses \pageref instead of instead of \ref. -

      You can copy an entry to another glossary using -


      . +

      You can copy an entry to another glossary using +


      \glsxtrcopytoglossary  \glsxtrcopytoglossary{entry-label}{glossary-type}

      -

      +

      This appends ⟨entry-label⟩ to the end of the internal list for the glossary given by ⟨glossary-type⟩. Be careful if you use the hyperref package as this may cause duplicate + id="dx1-39008"> package as this may cause duplicate hypertargets. You will need to change \glolinkprefix to another value or disable hyperlinks when you display the duplicate. Alternatively, use the new target key to + id="dx1-39009"> key to switch off the targets:

      -
      +
      \printunsrtglossary[target=false]
      -

      -

      The

      +

      The glossaries package allows you to set preamble code for a given glossary type using \setglossarypreamble. This overrides any previous setting. With glossaries-extra (as from v1.12) you can instead append to the preamble using -



      \apptoglossarypreamble  \apptoglossarypreamble[type]{code}

      -

      +

      or prepend using -



      \pretoglossarypreamble  \pretoglossarypreamble[type]{code}

      -

      +

      -

      Top

      10.1 Entry Fields

      -

      A field may now be used to store the name of a text-block command that takes a +

      A field may now be used to store the name of a text-block command that takes a single argument. The field is given by -



      \GlsXtrFmtField  \GlsXtrFmtField

      -

      +

      The default value is useri. Note that the value must be the control sequence name without the initial backslash. -

      For example: +

      For example:

      -
      +
      \newcommand*{\mtx}[1]{\boldsymbol{#1}}  
      \newcommand*{\mtxinv}[1]{\mtx{#1}\sp{-1}}  
      \newglossaryentry{matrix}{% @@ -15835,13 +16920,13 @@ class="cmti-10">without the initial backslash.  
         $\mtx{M}\mtxinv{M}=\glssymbol{identitymatrix}$}  
      }
      -

      -

      There are two commands provided that allow you to apply the command to an +

      +

      There are two commands provided that allow you to apply the command to an argument: -



      \glsxtrfmt  \glsxtrfmt[options]{label}{text}

      -

      +

      This effectively does

      cs name⟩ is the control sequence name supplied in must be defined to take a single required argument. Although it effectively acts like \glslink it misses out the post-link hook. -

      The default ⟨

      The default ⟨default-options⟩ are given by -



      \GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

      -

      +

      This is defined as noindex but may be redefined as appropriate. Note that the replacement text of \GlsXtrFmtDefaultOptions is prepended to the optional argument of \glslink. -

      As from version 1.23, there’s also a starred version of this command that has a +

      As from version 1.23, there’s also a starred version of this command that has a final optional argument: -



      \glsxtrfmt*  \glsxtrfmt*[options]{text}[insert]

      -

      +

      Both the starred and unstarred versions use: -



      \glsxtrfmtdisplay  \glsxtrfmtdisplay{cs name}{}{insert}

      -

      +

      within the link text. In the case of the unstarred version ⟨insert⟩ will be empty. It will also be empty if the final option argument is missing from the starred form. If the @@ -15934,7 +17019,7 @@ warning if undefaction=warn). There won’t be a warning or error if the entry is + id="dx1-40006">). There won’t be a warning or error if the entry is defined by the given field is missing. In either case, (the entry is undefined or the field is missing) ⟨cs name⟩ will be -

      +
      \newcommand{\glsxtrfmtdisplay}[3]{\csuse{#1}{#2}#3}
      -

      which puts ⟨

      which puts ⟨text⟩ inside the argument of the control sequence and ⟨insert⟩ outside it (but it will still be inside the link text). -

      Remember that nested links cause a problem so avoid using commands like

      Remember that nested links cause a problem so avoid using commands like \gls or \glsxtrfmt within ⟨text⟩.
      -

      -

      For example: +

      +

      For example:

      -
      +
      \[  
        \glsxtrfmt{matrix}{A}  
        \glsxtrfmt{matrixinv}{A} @@ -15970,34 +17055,34 @@ class="cmti-10">text⟩.
       
        \glssymbol{identitymatrix}  
      \]
      -

      If the default options are set to

      If the default options are set to noindex then \glsxtrfmt won’t index, but will create a hyperlink (if hyperref has been loaded). This can be changed so that it also + id="dx1-40007"> has been loaded). This can be changed so that it also suppresses the hyperlink:

      -
      +
      \renewcommand{\GlsXtrFmtDefaultOptions}{hyper=false,noindex}
      -

      -

      Note that

      +

      Note that \glsxtrfmt won’t work with PDF bookmarks. Instead you can use -



      \glsxtrentryfmt  \glsxtrentryfmt{label}{text}

      -

      +

      This uses \texorpdfstring and will simply expand to ⟨text⟩ within the PDF @@ -16008,17 +17093,17 @@ class="cmti-10">text⟩} if a control sequence name has been provided or just ⟨text⟩ otherwise. -

      The

      The glossaries package provides \glsaddstoragekey to add new keys. This command will cause an error if the key has already been defined. The glossaries-extra package provides a supplementary command that will only define the key if it doesn’t already exist: -



      \glsxtrprovidestoragekey  \glsxtrprovidestoragekey{key}{}{cs}

      -

      +

      If the key has already been defined, it will still provide the command given in the third argument ⟨cs⟩ (if it hasn’t already been defined). Unlike cs⟩ may be left empty if you’re happy to just use \glsfieldfetch to fetch the value of this new key. -

      You can test if a key has been provided with: -


      You can test if a key has been provided with: +


      \glsxtrifkeydefined  \glsxtrifkeydefined{key}{true}{false}

      -

      +

      This tests if ⟨key⟩ is available for use in the ⟨key⟩= list in the second argument of @@ -16057,22 +17142,22 @@ class="cmtt-10">\newglossaryentry (or the optional argument of commands l class="cmtt-10">\newabbreviation). The corresponding field may not have been set for any of the entries if no default was provided. -

      There are now commands provided to set individual fields. Note that +

      There are now commands provided to set individual fields. Note that these only change the specified field, not any related values. For example, changing the value of the text field won’t update the field won’t update the plural field. There are also + id="dx1-40012"> field. There are also some fields that should really only be set when entries are defined (such as the parent field). Unexpected results may occur if they are subsequently + id="dx1-40013"> field). Unexpected results may occur if they are subsequently changed. -



      \GlsXtrSetField  \GlsXtrSetField{label}{field}{value}

      -

      +

      Sets the field given by ⟨field⟩ to ⟨value⟩ for the entry given by ⟨

      \GlsXtrSetField uses -



      \glsxtrsetfieldifexists  \glsxtrsetfieldifexists{label}{}{code}

      -

      +

      where ⟨label⟩ is the entry label and ⟨code⟩ is the assignment code. -

      This command just uses

      This command just uses \glsdoifexists{label}{undefaction=warn. You can redefine + id="dx1-40017">. You can redefine \glsxtrsetfieldifexists to simply do ⟨code⟩ if you want to skip the existence check. Alternatively you can instead use -



      \glsxtrdeffield  \glsxtrdeffield{label}{replacement text}

      -

      +

      This simply uses etoolbox’s ’s \csdef without any checks. This command isn’t robust. There is also a version that uses \csedef instead: -



      \glsxtredeffield  \glsxtredeffield{label}{replacement text}

      -

      -


      +


      \gGlsXtrSetField  \gGlsXtrSetField{label}{field}{value}

      -

      +

      As \GlsXtrSetField but globally. -



      \eGlsXtrSetField  \eGlsXtrSetField{label}{field}{value}

      -

      +

      As \GlsXtrSetField but uses protected expansion. -



      \xGlsXtrSetField  \xGlsXtrSetField{label}{field}{value}

      -

      +

      As \gGlsXtrSetField but uses protected expansion. -



      \GlsXtrLetField  \GlsXtrLetField{label}{field}{cs}

      -

      +

      Sets the field given by ⟨field⟩ to the replacement text of ⟨cs⟩ for the entry given by ⟨label⟩ (using \let). -



      \csGlsXtrLetField  \csGlsXtrLetField{label}{}{cs name}

      -

      +

      As \GlsXtrLetField but the control sequence name is supplied instead. -



      \GlsXtrLetFieldToField  \GlsXtrLetFieldToField{label-1}{label-2}{field-2}

      -

      +

      Sets the field given by ⟨field-1⟩ for the entry given by ⟨label-1⟩ to the field given by @@ -16279,19 +17364,19 @@ class="cmti-10">code⟩} is still used, as for \GlsXtrSetField. -

      The

      The glossaries package provides \ifglshasfield to determine if a field has been + id="dx1-40027"> to determine if a field has been set. The glossaries-extra package provides a simpler version: -



      \glsxtrifhasfield  \glsxtrifhasfield{field}{}{false}

      -

      +

      (New to v1.19.) Note that in this case the ⟨field⟩ must be the internal field label (for @@ -16319,20 +17404,20 @@ class="cmti-10">true⟩ part is done otherwise it does ⟨false⟩. Within ⟨true⟩ you may use -



      \glscurrentfieldvalue  \glscurrentfieldvalue

      -

      +

      to access the field value. This command includes grouping which scopes the ⟨true⟩ and ⟨false⟩ parts. The starred version -



      \glsxtrifhasfield*  \glsxtrifhasfield*{field}{}{false}

      -

      +

      omits the implicit grouping. -

      Be careful of keys that use

      Be careful of keys that use \relax as the default value (such as the symbol). Use + id="dx1-40031">). Use \ifglshassymbol instead.
      -

      -

      There is also a version that simply uses

      +

      There is also a version that simply uses \ifcsundef. It doesn’t save the field value, but can be used if you only need to check if the field is defined without accessing it: -



      \GlsXtrIfFieldUndef  \GlsXtrIfFieldUndef{field}{}{false}

      -

      -

      There’s a difference between an undefined field and an unset field. An undefined +

      +

      There’s a difference between an undefined field and an unset field. An undefined field hasn’t been assigned any value (no associated internal control sequence has been defined). If a defined field has been defined to empty, then it’s considered unset. \GlsXtrIfFieldUndef for fields that can only be defined through commands like \GlsXtrSetField.
      -

      -

      You can test if a field value equals a string using -


      +

      You can test if a field value equals a string using +


      \GlsXtrIfFieldEqStr  \GlsXtrIfFieldEqStr{field}{} class="cmtt-10">{false}

      -

      +

      If the entry exists and has the given field set to the given text then this does ⟨true⟩ otherwise it does ⟨\glscurrentfieldvalue with ⟨text⟩ using etoolbox’s ’s \ifdefstring. -

      The

      The glossaries package provides \glsfieldfetch which can be used to fetch the + id="dx1-40035"> which can be used to fetch the value of the given field and store it in a control sequence. The glossaries-extra package provides another way of accessing the field value: -



      \glsxtrusefield  \glsxtrusefield{entry-label}{field-label}

      -

      +

      This works in the same way as commands like \glsentrytext but the field label is specified in the first argument. Note that the ⟨field-label⟩ corresponds to the internal field tag, which isn’t always the same as the key name. See Table 4.1 of the glossaries + id="dx1-40037"> manual. No error occurs if the entry or field haven’t been defined. This command is not robust. -

      There is also a version that converts the first letter to uppercase (analogous to +

      There is also a version that converts the first letter to uppercase (analogous to \Glsentrytext): -



      \Glsxtrusefield  \Glsxtrusefield{entry-label}{field-label}

      -

      -

      If you want to use a field to store a list that can be used as an

      +

      If you want to use a field to store a list that can be used as an etoolbox internal + id="dx1-40039"> internal list, you can use the following command that adds an item to the field using etoolbox’s ’s \listcsadd: -



      \glsxtrfieldlistadd  \glsxtrfieldlistadd{label}{}{item}

      -

      +

      where ⟨label⟩ is the entry’s label, ⟨field⟩ is the entry’s field and ⟨\listgadd, \listeadd and \listxadd: -



      \glsxtrfieldlistgadd  \glsxtrfieldlistgadd{label}{}{item}

      -

      -


      +


      \glsxtrfieldlisteadd  \glsxtrfieldlisteadd{label}{}{item}

      -

      -


      +


      \glsxtrfieldlistxadd  \glsxtrfieldlistxadd{label}{}{item}

      -

      +

      You can then iterate over the list using: -



      \glsxtrfielddolistloop  \glsxtrfielddolistloop{label}{field}

      -

      +

      or -



      \glsxtrfieldforlistloop  \glsxtrfieldforlistloop{label}{} class="cmtt-10">{handler}

      -

      +

      that internally use \dolistcsloop and \forlistloop, respectively. -

      There are also commands that use

      There are also commands that use \ifinlistcs: -



      \glsxtrfieldifinlist  \glsxtrfieldifinlist{label}{} class="cmtt-10">{false}

      -

      +

      and \xifinlistcs -



      \glsxtrfieldxifinlist  \glsxtrfieldxifinlist{label}{true}{false}

      -

      -

      See the

      +

      See the etoolbox’s user manual for further details of these commands, in particular + id="dx1-40049">’s user manual for further details of these commands, in particular the limitations of \ifinlist. -

      If the field has a comma-separated list value instead, you can iterate over it +

      If the field has a comma-separated list value instead, you can iterate over it using: -



      \glsxtrforcsvfield  \glsxtrforcsvfield{label}{}{handler}

      -

      +

      where again ⟨handler⟩ is a control sequence that takes a single argument. Unlike the etoolbox loops, this doesn’t ignore empty elements nor does it discard leading / + id="dx1-40051"> loops, this doesn’t ignore empty elements nor does it discard leading / trailing spaces. Internally it uses \@for (modified by xfor which is automatically + id="dx1-40052"> which is automatically loaded by glossaries). The ). The xfor package modifies the behaviour of package modifies the behaviour of \@for to allow the loop to be broken prematurely using \@endfortrue. The \glsxtrforcsvfield command locally defines a user level command: -



      \glsxtrendfor  \glsxtrendfor

      -

      +

      which is just a synonym for \@endfortrue. -

      The loop is performed within the true part of

      The loop is performed within the true part of \glsxtrifhasfield so scoping is automatically applied. -

      When using the

      When using the record option, in addition to recording the usual location, you can + id="dx1-40056"> option, in addition to recording the usual location, you can also record the current value of another counter at the same time using the preamble-only command: -



      \GlsXtrRecordCounter  \GlsXtrRecordCounter{counter name}

      -

      +

      For example:

      -
      +
      \usepackage[record]{glossaries-extra}  
      \GlsXtrRecordCounter{section}
      -

      Each time an entry is referenced with commands like

      Each time an entry is referenced with commands like \gls or \glstext, the \gls{bird} is used in section 1.2 th -

      +
      \glsxtrfieldlistgadd{bird}{record.section}{1.2}
      -

      Note that there’s no key corresponding to this new

      Note that there’s no key corresponding to this new record.section field, but its value can be accessed with \glsxtrfielduse or the list can be iterated over with \glsxtrfielddolistloop etc. -

      +

      -

      Top

      10.2 Display All Entries Without Sorting or Indexing

      -



      \printunsrtglossary  \printunsrtglossary[options]

      -

      +

      This behaves like \printnoidxglossary but never sorts the entries and always lists all the defined entries for the given glossary (and doesn’t require \makenoidxglossaries). If you want to use one of the tabular-like styles with + id="dx1-41002">-like styles with \printunsrtglossary, make sure you load glossaries-extra-stylemods which modifies + id="dx1-41004"> which modifies the definition of \glsgroupskip to avoid the “Incomplete \iftrue” error that may otherwise occur. -

      There’s also a starred form -


      There’s also a starred form +


      \printunsrtglossary*  \printunsrtglossary*[options]{code}

      -

      +

      which is equivalent to

      \endgroup class="cmtt-10">\glossarypreamble, the supplied ⟨code⟩ is done before the glossary header. -

      This means you now have the option to simply list all entries on the first +

      This means you now have the option to simply list all entries on the first LATEX run without the need for a post-processor, however there will be no number list in this case, as that has to be set by a post-processor such as bib2gls (see (see §9 bib2gls: Managing Reference Databases). -

      No attempt is made to gather hierarchical elements. If child entries aren’t defined +

      No attempt is made to gather hierarchical elements. If child entries aren’t defined immediately after their parent entry, they won’t be together in the glossary when using \printunsrtglossary.
      -

      +

      -

      If you have any entries with the

      If you have any entries with the see key set, you will need the key set, you will need the glossaries package + id="dx1-41010"> package option seenoindex=ignore or or seenoindex=warn to prevent an error occurring from the + id="dx1-41012"> to prevent an error occurring from the automated \glssee normally triggered by this key. The record=only package option + id="dx1-41013"> package option will automatically deal with this. -

      For example: +

      For example:

      -
      +
      \documentclass{article}  
      \usepackage{glossaries-extra}  
      \newglossaryentry{zebra}{name={zebra},description={stripy animal}} @@ -16846,110 +17931,110 @@ will automatically deal with this.  
      \printunsrtglossaries  
      \end{document}
      -

      In the above, zebra will be listed before ant as it was defined first. -

      If you allow document definitions with the

      In the above, zebra will be listed before ant as it was defined first. +

      If you allow document definitions with the docdefs option, the document will + id="dx1-41014"> option, the document will require a second LATEX run if the entries are defined after \printunsrtglossary. -

      The optional argument is as for

      The optional argument is as for \printnoidxglossary (except for the sort key, + id="dx1-41015"> key, which isn’t available). -

      All glossaries may be displayed in the order of their definition using: -


      All glossaries may be displayed in the order of their definition using: +


      \printunsrtglossaries  \printunsrtglossaries

      -

      +

      which is analogous to \printnoidxglossaries. This just iterates over all defined glossaries (that aren’t on the ignored list) and does \printunsrtglossary[type=⟨type⟩]. -

      To avoid complications caused by

      To avoid complications caused by tabular-like glossary styles, -like glossary styles, \printunsrtglossary iterates over all entries in the selected glossary and appends the appropriate code to an internal command. Once the construction of this command is complete, then it’s performed to display the glossary. This puts the loop outside the style code. For convenience, there’s a hook used within the loop: -



      \printunsrtglossaryentryprocesshook  \printunsrtglossaryentryprocesshook {label}

      -

      +

      This hook should not display any content, but may be used to perform calculations. For example, to calculate widths. Within this hook you can use: -



      \printunsrtglossaryskipentry  \printunsrtglossaryskipentry

      -

      +

      to skip the current entry. This will prevent the entry from being added to the internal command. -

      There’s another hook immediately before the internal command containing the +

      There’s another hook immediately before the internal command containing the glossary code is performed: -



      \printunsrtglossarypredoglossary  \printunsrtglossarypredoglossary

      -

      +

      -

      The internal command uses -


      The internal command uses +


      \printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

      -

      +

      to display each item in the list, where ⟨label⟩ is the current label. -

      By default the handler just does -


      By default the handler just does +


      \glsxtrunsrtdo  \glsxtrunsrtdo{label}

      -

      +

      which determines whether to use \glossentry or \subglossentry and checks the location and and loclist fields for the fields for the number list. -

      You can redefine the handler if required. For example, you may want to filter +

      You can redefine the handler if required. For example, you may want to filter entries according to the category label. You can test if a label is contained in a comma-separated list of labels using: -



      \glsxtriflabelinlist  \glsxtriflabelinlist{label}{} class="cmtt-10">{false}

      -

      +

      The ⟨label⟩ and ⟨label list⟩ will be fully expanded. -

      If you redefine the handler to exclude entries, you may end up with an empty +

      If you redefine the handler to exclude entries, you may end up with an empty glossary. This could cause a problem for the list-based styles.
      -

      -

      For example, if the preamble includes: +

      +

      For example, if the preamble includes:

      -
      +
      \usepackage[record,style=index]{glossaries-extra}  
      \GlsXtrRecordCounter{section}
      -

      then you can print the glossary but first redefine the handler to only select entries +

      then you can print the glossary but first redefine the handler to only select entries that include the current section number in the record.section field:

      -
      +
      \renewcommand{\printunsrtglossaryhandler}[1]{%  
        \glsxtrfieldxifinlist{#1}{record.section}{\thesection}  
        {\glsxtrunsrtdo{#1}}%  
        {}%  
      }
      -

      -

      Alternatively you can use the starred form of

      +

      Alternatively you can use the starred form of \printunsrtglossary which will localise the change:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -17008,10 +18093,10 @@ localise the change:  
        }%  
      }
      -

      -

      If you are using the

      +

      If you are using the hyperref package and want to display the same glossary more + id="dx1-41028"> package and want to display the same glossary more than once, you can also add a temporary redefinition of \glolinkprefix to avoid duplicate hypertarget names. For example: @@ -17019,7 +18104,7 @@ duplicate hypertarget names. For example:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -17035,7 +18120,7 @@ duplicate hypertarget names. For example:  
        }%  
      }
      -

      Note that this will cause a problem if your descriptions contain commands like

      Note that this will cause a problem if your descriptions contain commands like \gls that need to link an entry that doesn’t appear in the summary. In this case, it’s a better approach to use: @@ -17043,7 +18128,7 @@ better approach to use:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -17059,14 +18144,14 @@ better approach to use:  
        }%  
      }
      -

      -

      If it’s a short summary at the start of a section, you might also want to suppress +

      +

      If it’s a short summary at the start of a section, you might also want to suppress the glossary header and add some vertical space afterwards:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -17084,12 +18169,12 @@ the glossary header and add some vertical space afterwards:  
        \appto\glossarypostamble{\glspar\medskip\glspar}%  
      }
      -

      -

      There’s a shortcut command that essentially does this: -


      +

      There’s a shortcut command that essentially does this: +


      \printunsrtglossaryunit  \printunsrtglossaryunit[options]{counter name}

      -

      +

      The above example can simply be replaced with:

      -
      +
      \printunsrtglossaryunit{section}
      -

      -

      This shortcut command is actually defined to use

      +

      This shortcut command is actually defined to use \printunsrtglossary* with -



      \printunsrtglossaryunitsetup  \printunsrtglossaryunitsetup{counter name}

      -

      +

      so if you want to just make some minor modifications you can do

      -
      +
      \printunsrtglossary*{\printunsrtglossaryunitsetup{section}%  
        \renewcommand*{\glossarysection}[2][]{\subsection*{Summary}}%  
      }
      -

      which will start the list with a subsection header with the title “Summary” +

      which will start the list with a subsection header with the title “Summary” (overriding the glossary’s title). -

      Note that this shortcut command is only available with the

      Note that this shortcut command is only available with the record (or + id="dx1-41031"> (or record=alsoindex) package option. -

      This temporary change in the hypertarget prefix means you need to explicitly use + id="dx1-41032">) package option. +

      This temporary change in the hypertarget prefix means you need to explicitly use \hyperlink to create a link to it as commands like \gls will try to link to the target @@ -17153,12 +18238,12 @@ the front or back matter) which can be the target for all glossary references an just use \printunsrtglossaryunit for a quick summary at the start of a section etc. -

      +

      -

      Top

      10.3 Standalone Entry Items

      -

      It may be that you don’t want a list but would rather display entry details +

      It may be that you don’t want a list but would rather display entry details throughout the document. You can simply do \glsentryname followed by \glsentrydesc. (Remember that if you don’t want a s href="#styopt.sort">sort=none to + id="dx1-42001"> to skip the construction of the sort field.) For example, in the preamble provide a + id="dx1-42002"> field.) For example, in the preamble provide a custom command:

      -
      +
      \newcommand{\displayterm}[1]{%  
       \par\medskip\par\noindent  
       Definition: \glsentryname{#1}.\par @@ -17183,43 +18268,43 @@ custom command:  
       \par\medskip  
      }
      -

      define your entries +

      define your entries

      -
      +
      \newglossaryentry{function}{name={function},  
        description={a relation or expression involving variables}  
      }
      -

      and then later in the text: +

      and then later in the text:

      -
      +
      \displayterm{function}
      -

      -

      However, if may be that you want to use

      +

      However, if may be that you want to use hyperref and have commands like and have commands like \gls link back to the place where the term is described. Instead of using \glsentryname use -



      \glsxtrglossentry  \glsxtrglossentry{label}

      -

      +

      where ⟨label⟩ is the entry’s label. -

      This is designed to behave much like the way the name is displayed in the +

      This is designed to behave much like the way the name is displayed in the glossary. It performs the following:

      • Defines \glssubentryitem.
      • Increments and display the entry counters if the entrycounter or or subentrycounter + id="dx1-42006"> package options are set. If the entry has a parent, then this does
        • \glssubentryitem{label}
        -

        otherwise it does

        +

        otherwise it does

        • \glsentryitem{\glsnamefont or picks up the style from category attribut such as glossnamefont.
        + id="dx1-42007">.
      -

      If you have used

      If you have used \nopostdesc or or \glsxtrnopostpunc in any of your description fields, + id="dx1-42009"> in any of your description fields, you can use -



      \glsxtractivatenopost  \glsxtractivatenopost

      -

      +

      to make these commands behave as they normally do within a glossary. This needs to be placed before

      @@ -17301,13 +18386,13 @@ class="cmtt-10">}\glspostdescription class="cmtt-10">\glsnonextpages and \glsnextpages have no effect outside of the glossary and are not intended for use in a standalone context. -

      It’s also possible to select a different field (rather than using

      It’s also possible to select a different field (rather than using name): -


      ): +


      \glsxtrglossentryother  \glsxtrglossentryother{header}{}{field}

      -

      +

      The ⟨field⟩ must be given using its internal field label which may not be the same as the key used to set the field. See the key to field mappings table in the }.

    • Otherwise ⟨header⟩ is simply the field value.
    -

    The

    The \glsxtrglossentryother command internally uses \glossentrynameother{label\glossentryname{label}. If you are using the glossaries-accsupp + id="dx1-42013"> package (through the accsupp option) then accessibility support will be provided if + id="dx1-42014"> option) then accessibility support will be provided if there’s a corresponding command

    }
    (for example, \glssymbolaccessdisplay). -

    This means that my custom command can be changed to: +

    This means that my custom command can be changed to:

    -
    +
    \newcommand{\displayterm}[1]{%  
     \par\medskip\par\noindent  
     Definition: \glsxtrglossentry{#1}.\par @@ -17384,17 +18469,17 @@ class="cmtt-10">\glssymbolaccessdisplay).  
     \par\medskip  
    }
    -

    If I want numbered definitions, then I can use the package options

    If I want numbered definitions, then I can use the package options entrycounter or + id="dx1-42015"> or subentrycounter and remove the colon: + id="dx1-42016"> and remove the colon:

    -
    +
    \newcommand{\displayterm}[1]{%  
     \par\medskip\par\noindent  
     Definition \glsxtrglossentry{#1}.\par @@ -17402,28 +18487,28 @@ class="cmss-10">subentrycounter \par\medskip  
    }
    -

    The counter label uses a dot after the number by default but this can be changed to +

    The counter label uses a dot after the number by default but this can be changed to a colon:

    -
    +
    \renewcommand*{\glsentrycounterlabel}{\theglossaryentry:\space}
    -

    It’s now possible to not only use

    It’s now possible to not only use \gls to link back to the definition but also use \glsrefentry to reference the counter and \glsxtrpageref to reference the page number. -

    If I want the description to behave more like it does in a glossary in need to make +

    If I want the description to behave more like it does in a glossary in need to make the following modification:

    -
    +
    \newcommand{\displayterm}[1]{%  
     \par\medskip\par\noindent  
     Definition \glsxtrglossentry{#1}.\par @@ -17434,18 +18519,18 @@ the following modification:  
     \par\medskip  
    }
    -

    (Note the grouping to localise

    (Note the grouping to localise \glsxtractivatenopost.) -

    You can also use

    You can also use \glsxtrglossentry within section headings. For example:

    -
    +
    \section{\glsxtrglossentry{function}}
    -

    This will use

    This will use \glsentryname in PDF bookmarks (if \texorpdfstring is defined) and will use \@glsxtrnotinmark and \glsxtrrestoremarkhook.) -

    +

    -

    Top

    10.4 Entry Aliases

    -

    An entry can be made an alias of another entry using the

    An entry can be made an alias of another entry using the alias key. The + id="dx1-43001"> key. The value should be the label of the other term. There’s no check for the other’s existence when the aliased entry is defined. This is to allow the possibility of defining the other entry after the aliased entry. (For example, when used with bib2gls.) -

    If an entry ⟨.) +

    If an entry ⟨entry-1⟩ is made an alias of ⟨entry-2⟩ then:

    • If the see field wasn’t provided when ⟨ field wasn’t provided when ⟨entry-1⟩ was defined, the alias key will + id="dx1-43005"> key will automatically trigger
      }
    • If the hyperref package has been loaded then package has been loaded then \gls{entry-1} will link to @@ -17508,7 +18593,7 @@ class="cmtt-10">} will link to class="cmti-10">entry-2⟩’s target. (Unless the targeturl attribute has been set for ⟨ attribute has been set for ⟨entry-1⟩’s category.)
    • @@ -17516,20 +18601,20 @@ class="cmti-10">entry-1⟩’s href="#styopt.record">record=off or or record=alsoindex, the , the noindex setting will automatically + id="dx1-43010"> setting will automatically be triggered when referencing ⟨entry-1⟩ with commands like \gls or \glstext. This prevents ⟨entry-1⟩ from have a location list (aside from the cross-reference added with \glssee) unless it’s been explicitly @@ -17540,97 +18625,97 @@ class="cmtt-10">noindex=false. -

      Note that with

      Note that with record=only, the location list for aliased entries is controlled + id="dx1-43012">, the location list for aliased entries is controlled with bib2gls’s settings.

    -

    The index suppression trigger is performed by -


    ’s settings.

    +

    The index suppression trigger is performed by +


    \glsxtrsetaliasnoindex  \glsxtrsetaliasnoindex

    -

    +

    This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts + id="dx1-43017"> have been set. With record=only, , \glsxtrsetaliasnoindex will default to do nothing. -

    Within the definition of

    Within the definition of \glsxtrsetaliasnoindex you can use -



    \glsxtrindexaliased  \glsxtrindexaliased

    -

    +

    to index ⟨entry-2⟩. -

    The index suppression command can be redefined to index the main term instead. +

    The index suppression command can be redefined to index the main term instead. For example:

    -
    +
    \renewcommand{\glsxtrsetaliasnoindex}{%  
     \glsxtrindexaliased  
     \setkeys{glslink}{noindex}%  
    }
    -

    -

    The value of the

    +

    The value of the alias field can be accessed using -


    field can be accessed using +


    \glsxtralias  \glsxtralias{label}

    -

    +

    -

    -

    +

    Top

    11. Supplemental Packages

    -

    The

    The glossaries bundle provides additional support packages glossaries-prefix (for + id="dx1-44001"> (for prefixing) and glossaries-accsupp (for accessibility support). These packages aren’t + id="dx1-44002"> (for accessibility support). These packages aren’t automatically loaded.

    -

    Top

    11.1 Prefixes or Determiners

    -

    If prefixing is required, you can simply load

    If prefixing is required, you can simply load glossaries-prefix after after glossaries-extra. For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \usepackage{glossaries-prefix} @@ -17645,32 +18730,32 @@ example:  
    \printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    11.2 Accessibility Support

    -

    The

    The glossaries-accsupp package needs to be loaded before package needs to be loaded before glossaries-extra or through the accsupp package option: + id="dx1-46002"> package option:

    -
    +
    \usepackage[accsupp]{glossaries-extra}
    -

    If you don’t load

    If you don’t load glossaries-accsupp or you load or you load glossaries-accsupp after after glossaries-extra the new \glsaccessxxx⟩ commands described below will simply be equiv corresponding \glsentryxxx⟩ commands. -

    The following

    The following \glsaccessxxx⟩ commands add accessibility information wrapped around the corresponding \glsentryxxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information. -



    \glsaccessname  \glsaccessname{label}

    -

    +

    This displays the value of the name field for the entry identified by ⟨ field for the entry identified by ⟨label⟩. -

    If the

    If the glossaries-accsupp package isn’t loaded, this is simply defined as: + id="dx1-46007"> package isn’t loaded, this is simply defined as:

    -
    +
    \newcommand*{\glsaccessname}[1]{\glsentryname{#1}}
    -

    otherwise it’s defined as: +

    otherwise it’s defined as:

    -
    +
    \newcommand*{\glsaccessname}[1]{%  
      \glsnameaccessdisplay  
      {% @@ -17722,38 +18807,38 @@ class="cmss-10">glossaries-accsupp  {#1}%  
    }
    -

    (

    (\glsnameaccessdisplay is defined by the is defined by the glossaries-accsupp package.) The first + id="dx1-46009"> package.) The first letter upper case version is: -



    \Glsaccessname  \Glsaccessname{label}

    -

    +

    Without the glossaries-accsupp package this is just defined as: + id="dx1-46011"> package this is just defined as:

    -
    +
    \newcommand*{\Glsaccessname}[1]{\Glsentryname{#1}}
    -

    With the

    With the glossaries-accsupp package this is defined as: + id="dx1-46012"> package this is defined as:

    -
    +
    \newcommand*{\Glsaccessname}[1]{%  
      \glsnameaccessdisplay  
      {% @@ -17762,299 +18847,299 @@ class="cmss-10">glossaries-accsupp  {#1}%  
    }
    -

    -

    The following commands are all defined in an analogous manner. -


    +

    The following commands are all defined in an analogous manner. +


    \glsaccesstext  \glsaccesstext{label}

    -

    +

    This displays the value of the text field. -


    field. +


    \Glsaccesstext  \Glsaccesstext{label}

    -

    +

    This displays the value of the text field with the first letter converted to upper + id="dx1-46016"> field with the first letter converted to upper case. -



    \glsaccessplural  \glsaccessplural{label}

    -

    +

    This displays the value of the plural field. -


    field. +


    \Glsaccessplural  \Glsaccessplural{label}

    -

    +

    This displays the value of the plural field with the first letter converted to upper + id="dx1-46020"> field with the first letter converted to upper case. -



    \glsaccessfirst  \glsaccessfirst{label}

    -

    +

    This displays the value of the first field. -


    field. +


    \Glsaccessfirst  \Glsaccessfirst{label}

    -

    +

    This displays the value of the first field with the first letter converted to upper + id="dx1-46024"> field with the first letter converted to upper case. -



    \glsaccessfirstplural  \glsaccessfirstplural{label}

    -

    +

    This displays the value of the firstplural field. -


    field. +


    \Glsaccessfirstplural  \Glsaccessfirstplural{label}

    -

    +

    This displays the value of the firstplural field with the first letter converted to upper + id="dx1-46028"> field with the first letter converted to upper case. -



    \glsaccesssymbol  \glsaccesssymbol{label}

    -

    +

    This displays the value of the symbol field. -


    field. +


    \Glsaccesssymbol  \Glsaccesssymbol{label}

    -

    +

    This displays the value of the symbol field with the first letter converted to upper + id="dx1-46032"> field with the first letter converted to upper case. -



    \glsaccesssymbolplural  \glsaccesssymbolplural{label}

    -

    +

    This displays the value of the symbolplural field. -


    field. +


    \Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

    -

    +

    This displays the value of the symbolplural field with the first letter converted to + id="dx1-46036"> field with the first letter converted to upper case. -



    \glsaccessdesc  \glsaccessdesc{label}

    -

    +

    This displays the value of the desc field. -


    field. +


    \Glsaccessdesc  \Glsaccessdesc{label}

    -

    +

    This displays the value of the desc field with the first letter converted to upper + id="dx1-46040"> field with the first letter converted to upper case. -



    \glsaccessdescplural  \glsaccessdescplural{label}

    -

    +

    This displays the value of the descplural field. -


    field. +


    \Glsaccessdescplural  \Glsaccessdescplural{label}

    -

    +

    This displays the value of the descplural field with the first letter converted to upper + id="dx1-46044"> field with the first letter converted to upper case. -



    \glsaccessshort  \glsaccessshort{label}

    -

    +

    This displays the value of the short field. -


    field. +


    \Glsaccessshort  \Glsaccessshort{label}

    -

    +

    This displays the value of the short field with the first letter converted to upper + id="dx1-46048"> field with the first letter converted to upper case. -



    \glsaccessshortpl  \glsaccessshortpl{label}

    -

    +

    This displays the value of the shortplural field. -


    field. +


    \Glsaccessshortpl  \Glsaccessshortpl{label}

    -

    +

    This displays the value of the shortplural field with the first letter converted to upper + id="dx1-46052"> field with the first letter converted to upper case. -



    \glsaccesslong  \glsaccesslong{label}

    -

    +

    This displays the value of the long field. -


    field. +


    \Glsaccesslong  \Glsaccesslong{label}

    -

    +

    This displays the value of the long field with the first letter converted to upper + id="dx1-46056"> field with the first letter converted to upper case. -



    \glsaccesslongpl  \glsaccesslongpl{label}

    -

    +

    This displays the value of the longplural field. -


    field. +


    \Glsaccesslongpl  \Glsaccesslongpl{label}

    -

    +

    This displays the value of the longplural field with the first letter converted to upper + id="dx1-46060"> field with the first letter converted to upper case.

    -

    -

    +

    Top

    12. Sample Files

    -

    The following sample files are provided with this package: +

    The following sample files are provided with this package:

    sample.tex
    General abbreviations. sample-acronym.tex
    Acronyms aren’t initialisms and don’t expand on first use.
    @@ -18132,7 +19217,7 @@ class="description">Another initialisms example. sample-postlink.tex
    Automatically inserting text after the link-text produced by commands like \gls (outside of hyperlink, if present). @@ -18146,28 +19231,28 @@ class="cmbx-10">sample-autoindex.tex
    Using the dualindex and and indexname attributes to + id="dx1-47004"> attributes to automatically add glossary entries to the index (in addition to the glossary location list).
    sample-autoindex-hyp.tex
    As previous but uses hyperref. + id="dx1-47006">.
    sample-nested.tex
    Using \gls within the value of the within the value of the name key. + id="dx1-47008"> key.
    sample-entrycount.tex
    sample-external.tex
    Uses the targeturl attribute to allow for entries that + id="dx1-47009"> attribute to allow for entries that should link to an external URL rather than to an internal glossary.
    \glsxtrfmt. class="cmbx-10">sample-alias.tex
    Uses the alias key. (See key. (See §10.4 Entry Aliases.) @@ -18250,9 +19335,9 @@ href="#sec:alias">Entry Aliases.) class="cmbx-10">sample-alttree.tex
    Uses the glossaries-extra-stylemods package with the package with the alttree + id="dx1-47012"> style (see §2.9.3 glossaries-extra-stylemods Package

    -

    +

    Top

    13. Multi-Lingual Support

    -

    There’s only one command provided by

    There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname ( (§1.2 New or Modified Package Options) if you use the abbreviations package option to + id="dx1-48002"> package option to automatically create the glossary labelled abbreviations. If this command doesn’t already exist, it will be defined to “Abbreviations” if babel hasn’t + id="dx1-48003"> hasn’t been loaded, otherwise it will be defined as \acronymname (provided by glossaries). -

    You can redefine it in the usual way. For example: +

    You can redefine it in the usual way. For example:

    -
    +
    \renewcommand*{\abbreviationsname}{List of Abbreviations}
    -

    Or using

    Or using babel or or polyglossia captions hook: + id="dx1-48005"> captions hook:

    -
    +
    \appto\captionsenglish{%  
     \renewcommand*{\abbreviationsname}{List of Abbreviations}%  
    }
    -

    -

    Alternatively you can use the

    +

    Alternatively you can use the title key when you print the list of abbreviations. + id="dx1-48006"> key when you print the list of abbreviations. For example:

    -
    +
    \printabbreviations[title={List of Abbreviations}]
    -

    or +

    or

    -
    +
    \printglossary[type=abbreviations,title={List of Abbreviations}]
    -

    -

    The other fixed text commands are the diagnostic messages, which shouldn’t +

    +

    The other fixed text commands are the diagnostic messages, which shouldn’t appear in the final draft of your document. -

    The glossaries-extra package has the facility to load language modules if they exist, -but won’t warn if they don’t. -

    If you want to write your own language module, you just need to create a file +

    The glossaries-extra package has the facility to load language modules (whose +filename is in the form glossariesxtr-language.ldf) if they exist, but won’t warn if +they don’t. If glossaries-extra-bib2gls is loaded via the record package option then the +check for language resource files will additionally search for an associated language +script file given by glossariesxtr-script.ldf where ⟨script⟩ is the four letter script +identifier, such as Latn, associated with the given dialect. There’s no warning +if the associated file isn’t found. The script file is loaded after the dialect +file. +

    If you want to write your own language module, you just need to create a file called glossariesxtr-lang.ldf, where ⟨lang⟩ is the language name (see the lang⟩ identifies the language or dialect (see +the tracklang -package). For example, package). For example, glossariesxtr-french.ldf. -

    The simplest code for this file is: +

    The simplest code for this file is:

    -
    +
    \ProvidesGlossariesExtraLang{french}[2015/12/09 v1.0]  
    \newcommand*{\glossariesxtrcaptionsfrench}{%  
     \def\abbreviationsname{Abr\'eviations}% @@ -18450,79 +19554,89 @@ class="cmtt-10">glossariesxtr-french.ldf.  
          \glossariesxtrcaptionsfrench  
        }%  
      }% - 
      {% - 
      }% - 
      \glossariesxtrcaptionsfrench + 
      {}%  
    }
    -

    -

    You can adapt this for other languages by replacing all instances of the language +

    +

    You can adapt this for other languages by replacing all instances of the language identifier french and the translated text Abr\’eviations as appropriate. This .ldf -file then needs to be put somewhere on TEX’s path so that it can be found by -glossaries-extra. You might also want to consider uploading it to CTAN so that it can -be useful to others. (Please don’t send it to me. I already have more packages than I -am able to maintain.) -

    If you additionally want to provide translations for the diagnostic messages used +class="cmtt-10">Abr\’eviations as appropriate. You can +also use the .ldf file to provide rule blocks for a particular language for use with +bib2gls’s custom sort rule. See §9.3 The glossaries-extra-bib2gls package for further +details. +

    This .ldf file then needs to be put somewhere on TEX’s path so that it can be +found by glossaries-extra. You might also want to consider uploading it to CTAN so +that it can be useful to others. (Please don’t send it to me. I already have more +packages than I am able to maintain.) +

    If you additionally want to provide translations for the diagnostic messages used when a glossary is missing, you need to redefine the following commands: -



    \GlsXtrNoGlsWarningHead  \GlsXtrNoGlsWarningHead{label}{file}

    -

    +

    This produces the following text in English:

    -

    This document is incomplete. The external file associated with the - glossary ‘⟨label⟩’ (which should be called ⟨file⟩) hasn’t been created.

    +

    This document is incomplete. The external file associated with the -


    label⟩’ (which should be called ⟨file⟩) hasn’t been created.

    +


    \GlsXtrNoGlsWarningEmptyStart  \GlsXtrNoGlsWarningEmptyStart

    -

    +

    This produces the following text in English:

    -

    This has probably happened because there are no entries defined in +

    This has probably happened because there are no entries defined in this glossary.

    -



    \GlsXtrNoGlsWarningEmptyMain  \GlsXtrNoGlsWarningEmptyMain

    -

    +

    This produces the following text in English:

    -

    If you don’t want this glossary, add

    If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:

    -



    \GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain{label}

    -

    +

    This produces the following text in English:

    -

    Did you forget to use

    Did you forget to use type=label⟩ when you defined your entries? If you tried to load entries into this glossary with ] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.

    -



    \GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile{file}

    -

    +

    This produces the following text in English:

    -

    Check the contents of the file ⟨

    Check the contents of the file ⟨file⟩. If it’s empty, that means you haven’t indexed any of your entries in this glossary (using commands like \gls or \glsadd) so this list can’t be generated. If the file isn’t empty, the document build process hasn’t been completed.

    -



    \GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch

    -

    +

    This produces the following text in English:

    -

    You need - to either replace \makenoidxglossaries with \makeglossaries or +

    You need + to either replace \makenoidxglossaries with \makeglossaries or replace \printglossary (or \printglossaries) @@ -18574,17 +19688,17 @@ class="cmtt-10">\printglossaries) class="cmtt-10">\printnoidxglossary (or \printnoidxglossaries) and then rebuild this document.

    -



    \GlsXtrNoGlsWarningNoOut  \GlsXtrNoGlsWarningNoOut{file}

    -

    +

    This produces the following text in English:

    -

    The file ⟨

    The file ⟨file⟩ doesn’t exist. This most likely means you haven’t used \makeglossaries or you have used \nofiles. If this is just a draft version of the document, you can suppress this message using the nomissingglstext package option.

    -



    \GlsXtrNoGlsWarningTail  \GlsXtrNoGlsWarningTail

    -

    +

    This produces the following text in English:

    -

    This message will be removed once the problem has been fixed.

    -


    This message will be removed once the problem has been fixed.

    +


    \GlsXtrNoGlsWarningBuildInfo  \GlsXtrNoGlsWarningBuildInfo

    -

    +

    This is advice on how to generate the glossary files. See the documented code (glossaries-extra-code.pdf) for further details. -



    \GlsXtrNoGlsWarningAutoMake  \GlsXtrNoGlsWarningAutoMake{label}

    -

    +

    This is the message produced when the automake option is used, but the document + id="dx1-48022"> option is used, but the document needs a rerun or the shell escape setting doesn’t permit the execution of the external application. This command also generates a warning in the transcript file. See the documented code for further details. @@ -18639,22 +19753,22 @@ documented code for further details.

    Top

    Glossary

    + id="x1-4900013">Glossary
    bib2gls
    A command line Java application that selects entries from a .bib file and converts them to glossary definitions (like bibtex but also performs hierarchical sorting and collation, thus omitting the need for xindy or makeindex). Further details at: http://www.dickimaw-books.com/software/bib2gls/. entry location
    The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple locations. @@ -18672,80 +19786,80 @@ class="description">The location of the entry in the document. This defaults to first use
    The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \gls, , \Gls, , \GLS, + id="dx1-49009">, \glspl, , \Glspl, , \GLSpl or or \glsdisp. + id="dx1-49013">.
    first use flag
    A conditional that determines whether or not the entry has been used according to the rules of first use.
    first use text
    The text that is displayed on first use, which is governed by the + id="dx1-49017">first use, which is governed by the first and and firstplural keys of keys of \newglossaryentry. (May be overridden by + id="dx1-49020">. (May be overridden by \glsdisp.) + id="dx1-49021">.)
    link-text
    The text produced by commands such as \gls. It may or may not + id="dx1-49023">. It may or may not have a hyperlink to the glossary.
    location list
    A list of entry locations. See number list.
    makeglossaries
    A custom designed Perl script interface provided with the glossaries package to run xindy or makeindex according to the document settings. @@ -18755,13 +19869,13 @@ class="cmtt-10">makeindex according to the document makeglossaries-lite
    A custom designed Lua script interface to xindy and makeindex provided with the glossaries package. This is a cut-down alternative to the Perl makeglossaries-lite.exe. makeindex
    An indexing application.
    number list
    A list of entry locations (also called a location list). The number list can be suppressed using the nonumberlist package option. + id="dx1-49037"> package option.
    xindy
    An flexible indexing application with multilingual support written in Perl.

    Index

    + id="x1-5000013">Index

    A

    @@ -19306,7 +20420,7 @@ class="cmss-10">short-sm-postfootnote
      273
    \abbreviationsname  274
    \abbrvpluralsuffix  amsgen package  298
    \apptoglossarypreamble  299

    B @@ -19393,12 +20507,12 @@ class="cmbx-10">B class="cmss-10">babel package  300, 301, 302, 303, 304, 302, 303, 304, 305, 306, 307
    +href="glossaries-extra-manual.html#dx1-48003" >306, 307
    bib2gls  308, 310, 311, 312, 313, 314, 315, 316, 317, 318, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365
    +href="glossaries-extra-manual.html#dx1-4107" >320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376
    bib2gls  366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423
    +href="glossaries-extra-manual.html#dx1-3" >377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445

    C categories:
        abbreviation  424, 425, 426, 427, 428
    +href="glossaries-extra-manual.html#dx1-9005" >446, 447, 448, 449, 450
        acronym  429, 430, 431, 432, 433
    +href="glossaries-extra-manual.html#dx1-15021" >451, 452, 453, 454, 455
        general  434, 435, 436, 437, 438, 439, 440, 441
    +href="glossaries-extra-manual.html#dx1-8036" >456, 457, 458, 459, 460, 461, 462, 463
        index  442, 443
    +href="glossaries-extra-manual.html#dx1-5044" >464, 465
        number  444
    +href="glossaries-extra-manual.html#dx1-27018" >466
        symbol  445, 446
    +href="glossaries-extra-manual.html#dx1-8043" >467, 468
    category attributes:
        aposplural  447, 448, 449, 450
    +href="glossaries-extra-manual.html#dx1-10036" >469, 470, 471, 472
        discardperiod  451, 452, 453, 454, 455
    +href="glossaries-extra-manual.html#dx1-8031" >473, 474, 475, 476, 477
        dualindex  456, 457, 458, 459, 460, 461, 462
    +href="glossaries-extra-manual.html#dx1-27114" >478, 479, 480, 481, 482, 483, 484
        entrycount  463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473
    +href="glossaries-extra-manual.html#dx1-9004" >485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495
        externallocation  474
    +href="glossaries-extra-manual.html#dx1-6039" >496
        glossdesc  475, 476, 477
    +href="glossaries-extra-manual.html#dx1-15004" >497, 498, 499
        glossdescfont  478, 479
    +href="glossaries-extra-manual.html#dx1-15005" >500, 501
        glossname  480, 481, 482
    +href="glossaries-extra-manual.html#dx1-15003" >502, 503, 504
        glossnamefont  483, 484, 485
    +href="glossaries-extra-manual.html#dx1-15009" >505, 506, 507
        headuc  486, 487, 488, 489
    +href="glossaries-extra-manual.html#dx1-11059" >508, 509, 510, 511
        hyperoutside  490, 491
    +href="glossaries-extra-manual.html#dx1-6017" >512, 513
        indexname  492, 493, 494, 495, 496
    +href="glossaries-extra-manual.html#dx1-15014" >514, 515, 516, 517, 518
        indexonlyfirst  497, 498, 499
    +href="glossaries-extra-manual.html#dx1-6005" >519, 520, 521
        insertdots  500, 501, 502
    +href="glossaries-extra-manual.html#dx1-18004" >522, 523, 524
        linkcount  503, 504, 505
    +href="glossaries-extra-manual.html#dx1-27090" >525, 526, 527
        linkcountmaster  506, 507
    +href="glossaries-extra-manual.html#dx1-27092" >528, 529
        markshortwords  508, 509
    +href="glossaries-extra-manual.html#dx1-27061" >530, 531
        markwords  510, 511, 512, 513, 514, 515
    +href="glossaries-extra-manual.html#dx1-24209" >532, 533, 534, 535, 536, 537
        nohyper  516, 517, 518
    +href="glossaries-extra-manual.html#dx1-27034" >538, 539, 540
        nohyperfirst  519, 520, 521, 522, 523
    +href="glossaries-extra-manual.html#dx1-24145" >541, 542, 543, 544, 545
        noshortplural  524, 525, 526, 527, 528
    +href="glossaries-extra-manual.html#dx1-10037" >546, 547, 548, 549, 550
        pluraldiscardperiod  529, 530
    +href="glossaries-extra-manual.html#dx1-27048" >551, 552
        recordcount  531, 532, 533, 534
    +href="glossaries-extra-manual.html#dx1-38019" >553, 554, 555, 556
        regular  535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 565, 566
    +href="glossaries-extra-manual.html#dx1-8010" >557, 558, 559, 560, 561, 562, 563, 564, 565, 566, 567, 568, 569, 570, 571, 572, 573, 574, 575, 576, 577, 578, 579, 580, 581, 582, 583, 584, 585, 586, 587, 588
        retainfirstuseperiod  567
    +href="glossaries-extra-manual.html#dx1-27050" >589
        tagging  568, 569, 570, 571
    +href="glossaries-extra-manual.html#dx1-19002" >590, 591, 592, 593
        targetcategory  572
    +href="glossaries-extra-manual.html#dx1-27123" >594
        targetname  573, 574
    +href="glossaries-extra-manual.html#dx1-27120" >595, 596
        targeturl  575, 576, 577, 578, 579
    +href="glossaries-extra-manual.html#dx1-5014" >597, 598, 599, 600, 601
        textformat  580, 581, 582
    +href="glossaries-extra-manual.html#dx1-6018" >602, 603, 604
        unitcount  583
    +href="glossaries-extra-manual.html#dx1-29034" >605
        wrgloss  584, 585
    +href="glossaries-extra-manual.html#dx1-6013" >606, 607
    \cGLS  586
    +class="cmti-10">608
    \cGLSformat  587
    +class="cmti-10">609
    \cGLSpl  588
    +class="cmti-10">610
    \cGLSplformat  589
    +class="cmti-10">611
    convertgls2bib  590
    +href="glossaries-extra-manual.html#dx1-33005" >612
    \csGlsXtrLetField  591
    +href="glossaries-extra-manual.html#dx1-40025" >613
    \CustomAbbreviationFields  592
    +class="cmti-10">614

    D datatool-base package  593
    +href="glossaries-extra-manual.html#dx1-10" >615

    E \eglssetwidest  594
    +class="cmti-10">616
    \eglsupdatewidest  595
    +class="cmti-10">617
    \eGlsXtrSetField  596
    +href="glossaries-extra-manual.html#dx1-40022" >618
    entry location  597, 598, 599
    +href="glossaries-extra-manual.html#dx1-49005" >619, 620, 621
    entrycounter package  600
    +href="glossaries-extra-manual.html#dx1-42015" >622
    etoolbox package  601, 602, 603, 604, 605, 606, 607, 608, 609
    +href="glossaries-extra-manual.html#dx1-6" >623, 624, 625, 626, 627, 628, 629, 630, 631

    F fancyhdr package  610
    +href="glossaries-extra-manual.html#dx1-13047" >632
    first use  611, 612, 613, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662
    +href="glossaries-extra-manual.html#dx1-6003" >633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662, 663, 664, 665, 666, 667, 668, 669, 670, 671, 672, 673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684
    first use flag  663, 664, 665, 666, 667, 668
    +href="glossaries-extra-manual.html#dx1-8048" >685, 686, 687, 688, 689, 690
    first use text  669, 670
    +href="glossaries-extra-manual.html#dx1-49016" >691, 692
    fontenc package  671
    +href="glossaries-extra-manual.html#dx1-22024" >693

    G @@ -19913,2743 +21049,3042 @@ class="cmbx-10">G \gglssetwidest  672
    +class="cmti-10">694
    \gglsupdatewidest  673
    +class="cmti-10">695
    \gGlsXtrSetField  674
    +href="glossaries-extra-manual.html#dx1-40021" >696
    glossaries package  675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686
    +href="glossaries-extra-manual.html#dx1-5032" >697, 698, 699, 700, 701, 702, 703, 704, 705, 706, 707, 708, 709
    glossaries-accsupp package  687, 688, 689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702
    +href="glossaries-extra-manual.html#dx1-4036" >710, 711, 712, 713, 714, 715, 716, 717, 718, 719, 720, 721, 722, 723, 724, 725
    glossaries-extra package  703, 704
    +href="glossaries-extra-manual.html#dx1-5034" >726, 727, 728
    +glossaries-extra-bib2gls package  729, 730, 731, 732, 733, 734, 735, 736, 737
    glossaries-extra-stylemods package  705, 706, 707, 708, 709, 710, 711
    +href="glossaries-extra-manual.html#dx1-4027" >738, 739, 740, 741, 742, 743, 744
    glossaries-prefix package  712, 713, 714
    +href="glossaries-extra-manual.html#dx1-44001" >745, 746, 747
    \glossariesextrasetup  715
    +href="glossaries-extra-manual.html#dx1-4183" >748
    glossary styles:
        altlist  716
    +href="glossaries-extra-manual.html#dx1-17022" >749
        alttree  717, 718, 719, 720, 721, 722, 723
    +href="glossaries-extra-manual.html#dx1-17032" >750, 751, 752, 753, 754, 755, 756
        bookindex  724, 725, 726, 727
    +href="glossaries-extra-manual.html#dx1-13002" >757, 758, 759, 760
        index  728
    +href="glossaries-extra-manual.html#dx1-17027" >761
        inline  729, 730
    +href="glossaries-extra-manual.html#dx1-17006" >762, 763
        list  731, 732
    +href="glossaries-extra-manual.html#dx1-17018" >764, 765
        listdotted  733
    +href="glossaries-extra-manual.html#dx1-17023" >766
        long  734
    +href="glossaries-extra-manual.html#dx1-17012" >767
        long3col  735
    +href="glossaries-extra-manual.html#dx1-17004" >768
        mcolindexgroup  736
    +href="glossaries-extra-manual.html#dx1-13003" >769
        tree  737
    +href="glossaries-extra-manual.html#dx1-17028" >770
    glossary-bookindex package  738, 739
    +href="glossaries-extra-manual.html#dx1-13001" >771, 772
    glossary-inline package  740
    +href="glossaries-extra-manual.html#dx1-17007" >773
    glossary-tree package  741, 742, 743, 744
    +href="glossaries-extra-manual.html#dx1-13040" >774, 775, 776, 777
    \glossentrynameother  745
    +class="cmti-10">778
    \glossxtrsetpopts  746
    +class="cmti-10">779
    \glsabbrvdefaultfont  747, 780, 748
    +class="cmti-10">781
    \glsabbrvemfont  749
    +class="cmti-10">782
    \glsabbrvfont  750
    +class="cmti-10">783
    \glsabbrvhyphenfont  751
    +class="cmti-10">784
    \glsabbrvonlyfont  752
    +class="cmti-10">785
    \glsabbrvscfont  753
    +class="cmti-10">786
    \glsabbrvsmfont  754
    +class="cmti-10">787
    \glsabbrvuserfont  755, 788, 756
    +class="cmti-10">789
    \Glsaccessdesc  757
    +href="glossaries-extra-manual.html#dx1-46039" >790
    \glsaccessdesc  758
    +href="glossaries-extra-manual.html#dx1-46037" >791
    \Glsaccessdescplural  759
    +href="glossaries-extra-manual.html#dx1-46043" >792
    \glsaccessdescplural  760
    +href="glossaries-extra-manual.html#dx1-46041" >793
    \Glsaccessfirst  761
    +href="glossaries-extra-manual.html#dx1-46023" >794
    \glsaccessfirst  762
    +href="glossaries-extra-manual.html#dx1-46021" >795
    \Glsaccessfirstplural  763
    +href="glossaries-extra-manual.html#dx1-46027" >796
    \glsaccessfirstplural  764
    +href="glossaries-extra-manual.html#dx1-46025" >797
    \Glsaccesslong  765
    -\glsaccesslong  766
    +href="glossaries-extra-manual.html#dx1-46055" >798
    +\glsaccesslong  799
    \Glsaccesslongpl  767
    +href="glossaries-extra-manual.html#dx1-46059" >800
    \glsaccesslongpl  768
    +href="glossaries-extra-manual.html#dx1-46057" >801
    \Glsaccessname  769
    +href="glossaries-extra-manual.html#dx1-46010" >802
    \glsaccessname  770
    +href="glossaries-extra-manual.html#dx1-46005" >803
    \Glsaccessplural  771
    +href="glossaries-extra-manual.html#dx1-46019" >804
    \glsaccessplural  772
    +href="glossaries-extra-manual.html#dx1-46017" >805
    \Glsaccessshort  773
    +href="glossaries-extra-manual.html#dx1-46047" >806
    \glsaccessshort  774
    +href="glossaries-extra-manual.html#dx1-46045" >807
    \Glsaccessshortpl  775
    +href="glossaries-extra-manual.html#dx1-46051" >808
    \glsaccessshortpl  776
    +href="glossaries-extra-manual.html#dx1-46049" >809
    \Glsaccesssymbol  777
    +href="glossaries-extra-manual.html#dx1-46031" >810
    \glsaccesssymbol  778
    +href="glossaries-extra-manual.html#dx1-46029" >811
    \Glsaccesssymbolplural  779
    +href="glossaries-extra-manual.html#dx1-46035" >812
    \glsaccesssymbolplural  780
    +href="glossaries-extra-manual.html#dx1-46033" >813
    \Glsaccesstext  781
    +href="glossaries-extra-manual.html#dx1-46015" >814
    \glsaccesstext  782
    +href="glossaries-extra-manual.html#dx1-46013" >815
    \glsacspace  783
    +class="cmti-10">816
    \glsacspacemax  784
    +class="cmti-10">817
    \glsadd options
        format  785
    +href="glossaries-extra-manual.html#dx1-8071" >818
        theHvalue  786, 787
    +href="glossaries-extra-manual.html#dx1-6024" >819, 820
        thevalue  788, 789, 790, 791, 792
    +href="glossaries-extra-manual.html#dx1-6023" >821, 822, 823, 824, 825
    \glscategory  793
    +class="cmti-10">826
    \glscategorylabel  794
    +class="cmti-10">827
    \glscurrententrylabel  795
    +class="cmti-10">828
    \glscurrentfieldvalue  796
    +href="glossaries-extra-manual.html#dx1-40029" >829
    \glsentrycurrcount  797
    +class="cmti-10">830
    \glsentryprevcount  798
    +class="cmti-10">831
    \glsentryprevmaxcount  799
    +class="cmti-10">832
    \glsentryprevtotalcount  800
    +class="cmti-10">833
    \glsextrapostnamehook  801
    +class="cmti-10">834
    \glsFindWidestAnyName  802
    +class="cmti-10">835
    \glsFindWidestAnyNameLocation  803
    +class="cmti-10">836
    \glsFindWidestAnyNameSymbol  804
    +class="cmti-10">837
    \glsFindWidestAnyNameSymbolLocation  805
    +class="cmti-10">838
    \glsFindWidestLevelTwo  806
    +class="cmti-10">839
    \glsFindWidestTopLevelName  807
    +class="cmti-10">840
    \glsFindWidestUsedAnyName  808
    +class="cmti-10">841
    \glsFindWidestUsedAnyNameLocation  809
    +class="cmti-10">842
    \glsFindWidestUsedAnyNameSymbol  810
    +class="cmti-10">843
    \glsFindWidestUsedAnyNameSymbolLocation  811
    +class="cmti-10">844
    \glsFindWidestUsedLevelTwo  812
    +class="cmti-10">845
    \glsFindWidestUsedTopLevelName  813
    +class="cmti-10">846
    \glsfirstabbrvdefaultfont  814
    +class="cmti-10">847
    \glsfirstabbrvemfont  815
    -\glsfirstabbrvfont  816
    +class="cmti-10">848
    +\glsfirstabbrvfont  849
    \glsfirstabbrvhyphenfont  817
    +class="cmti-10">850
    \glsfirstabbrvonlyfont  818
    +class="cmti-10">851
    \glsfirstabbrvsmfont  819
    +class="cmti-10">852
    \glsfirstabbrvuserfont  820
    +class="cmti-10">853
    \glsfirstlongdefaultfont  821
    +class="cmti-10">854
    \glsfirstlongemfont  822
    +class="cmti-10">855
    \glsfirstlongfont  823
    +class="cmti-10">856
    \glsfirstlongfootnotefont  824
    +class="cmti-10">857
    \glsfirstlonghyphenfont  825
    +class="cmti-10">858
    \glsfirstlongonlyfont  826
    +class="cmti-10">859
    \glsfirstlonguserfont  827
    +class="cmti-10">860
    \Glsfmtfirst  828
    +class="cmti-10">861
    \glsfmtfirst  829
    +class="cmti-10">862
    \Glsfmtfirstpl  830
    +class="cmti-10">863
    \glsfmtfirstpl  831
    +class="cmti-10">864
    \Glsfmtfull  832
    +class="cmti-10">865
    \glsfmtfull  833
    +class="cmti-10">866
    \Glsfmtfullpl  834
    +class="cmti-10">867
    \glsfmtfullpl  835
    +class="cmti-10">868
    \Glsfmtlong  836
    +class="cmti-10">869
    \glsfmtlong  837
    +class="cmti-10">870
    \Glsfmtlongpl  838
    +class="cmti-10">871
    \glsfmtlongpl  839
    +class="cmti-10">872
    \Glsfmtname  840
    +class="cmti-10">873
    \glsfmtname  841
    +class="cmti-10">874
    \Glsfmtplural  842
    +class="cmti-10">875
    \glsfmtplural  843
    +class="cmti-10">876
    \Glsfmtshort  844
    +class="cmti-10">877
    \glsfmtshort  845
    +class="cmti-10">878
    \Glsfmtshortpl  846
    +class="cmti-10">879
    \glsfmtshortpl  847
    +class="cmti-10">880
    \Glsfmttext  848
    +class="cmti-10">881
    \glsfmttext  849
    +class="cmti-10">882
    \glsforeachwithattribute  850
    +class="cmti-10">883
    \glsgetattribute  851
    +class="cmti-10">884
    \glsgetcategoryattribute  852
    +class="cmti-10">885
    \glsgetwidestname  853
    +class="cmti-10">886
    \glsgetwidestsubname  854
    +class="cmti-10">887
    \glshasattribute  855
    +class="cmti-10">888
    \glshascategoryattribute  856
    +class="cmti-10">889
    \glshex  857
    +href="glossaries-extra-manual.html#dx1-36011" >890
    \glsifattribute  858
    +class="cmti-10">891
    \glsifcategory  859
    +class="cmti-10">892
    \glsifcategoryattribute  860
    +class="cmti-10">893
    \glsifnotregular  861
    -\glsifnotregularcategory  862
    +class="cmti-10">894
    +\glsifnotregularcategory  895
    \glsifregular  863
    +class="cmti-10">896
    \glsifregularcategory  864
    +class="cmti-10">897
    \glskeylisttok  865
    +class="cmti-10">898
    \glslabeltok  866
    +class="cmti-10">899
    \glslink options
        format  867, 868, 869, 870
    +href="glossaries-extra-manual.html#dx1-6036" >900, 901, 902, 903
        hyper  871, 872, 873
    +href="glossaries-extra-manual.html#dx1-11055" >904, 905, 906
        hyper=false  874
    +href="glossaries-extra-manual.html#dx1-26016" >907
        hyperoutside  875, 876
    +href="glossaries-extra-manual.html#dx1-6016" >908, 909
        noindex  877, 878, 879, 880, 881, 882, 883
    +href="glossaries-extra-manual.html#dx1-6001" >910, 911, 912, 913, 914, 915, 916
        theHvalue  884
    +href="glossaries-extra-manual.html#dx1-6027" >917
        thevalue  885
    +href="glossaries-extra-manual.html#dx1-6026" >918
        wrgloss  886, 887, 888, 889
    +href="glossaries-extra-manual.html#dx1-6009" >919, 920, 921, 922
    \glslinkcheckfirsthyperhook  890
    +class="cmti-10">923
    \glslinkpresetkeys  891
    +class="cmti-10">924
    \glslistchildpostlocation  892
    +class="cmti-10">925
    \glslistchildprelocation  893
    +class="cmti-10">926
    \glslistprelocation  894
    +class="cmti-10">927
    \glslongdefaultfont  895
    +class="cmti-10">928
    \glslongemfont  896
    +class="cmti-10">929
    \glslongfont  897
    +class="cmti-10">930
    \glslongfootnotefont  898
    +class="cmti-10">931
    \glslonghyphenfont  899
    +class="cmti-10">932
    \glslongonlyfont  900
    +class="cmti-10">933
    \glslongpltok  901
    +class="cmti-10">934
    \glslongtok  902
    +class="cmti-10">935
    \glslonguserfont  903
    +class="cmti-10">936
    \glsnoidxdisplayloc  904
    +class="cmti-10">937
    \glsps  905
    +class="cmti-10">938
    \glspt  906
    +class="cmti-10">939
    \glsseeitemformat  907
    +class="cmti-10">940
    \glssetattribute  908
    +class="cmti-10">941
    \glssetcategoryattribute  909
    +class="cmti-10">942
    \glssetregularcategory  910
    +class="cmti-10">943
    \glsshortpltok  911
    +class="cmti-10">944
    \glsshorttok  912
    +class="cmti-10">945
    \glstreechildprelocation  913
    +class="cmti-10">946
    \glstreeprelocation  914
    +class="cmti-10">947
    \glsupdatewidest  915
    +class="cmti-10">948
    \glsuseabbrvfont  916
    +class="cmti-10">949
    \glsuselongfont  917
    +class="cmti-10">950
    \Glsxtr  918
    +class="cmti-10">951
    \glsxtr  919
    +class="cmti-10">952
    \glsxtrabbrvfootnote  920
    +class="cmti-10">953
    \glsxtrabbrvpluralsuffix  921, 954, 922
    -\glsxtractivatenopost  923
    +class="cmti-10">955
    +\glsxtractivatenopost  956
    \glsxtraddallcrossrefs  924
    +class="cmti-10">957
    \glsxtralias  925
    +href="glossaries-extra-manual.html#dx1-43021" >958
    \glsxtrAltTreeIndent  926
    +class="cmti-10">959
    \glsxtralttreeInit  927
    +class="cmti-10">960
    \glsxtralttreeSubSymbolDescLocation  928
    +class="cmti-10">961
    \glsxtralttreeSymbolDescLocation  929
    +class="cmti-10">962
    \glsxtrautoindex  930
    +class="cmti-10">963
    \glsxtrautoindexassignsort  931
    +class="cmti-10">964
    \glsxtrautoindexentry  932
    +class="cmti-10">965
    +\glsxtrBasicDigitrules  966
    \glsxtrbookindexatendgroup  933
    +class="cmti-10">967
    \glsxtrbookindexbetween  934
    +class="cmti-10">968
    \glsxtrbookindexbookmark  935
    +class="cmti-10">969
    \glsxtrbookindexcols  936
    +class="cmti-10">970
    \glsxtrbookindexcolspread  937
    +class="cmti-10">971
    \glsxtrbookindexfirstmark  938
    +class="cmti-10">972
    \glsxtrbookindexfirstmarkfmt  939
    +class="cmti-10">973
    \glsxtrbookindexformatheader  940
    +class="cmti-10">974
    \glsxtrbookindexlastmark  941
    +class="cmti-10">975
    \glsxtrbookindexlastmarkfmt  942
    +class="cmti-10">976
    \glsxtrbookindexmarkentry  943
    +class="cmti-10">977
    \glsxtrbookindexmulticolsenv  944
    +class="cmti-10">978
    \glsxtrbookindexname  945
    +class="cmti-10">979
    \glsxtrbookindexparentchildsep  946
    +class="cmti-10">980
    \glsxtrbookindexparentsubchildsep  947
    +class="cmti-10">981
    \glsxtrbookindexprelocation  948
    +class="cmti-10">982
    \glsxtrbookindexsubatendgroup  949
    +class="cmti-10">983
    \glsxtrbookindexsubbetween  950
    +class="cmti-10">984
    \glsxtrbookindexsubname  951
    +class="cmti-10">985
    \glsxtrbookindexsubprelocation  952
    +class="cmti-10">986
    \glsxtrbookindexsubsubatendgroup  953
    +class="cmti-10">987
    \glsxtrbookindexsubsubbetween  954
    +class="cmti-10">988
    \glsxtrchecknohyperfirst  955
    +class="cmti-10">989
    +\glsxtrcombiningdiacriticIIIrules  990
    +\glsxtrcombiningdiacriticIIrules  991
    +\glsxtrcombiningdiacriticIrules  992
    +\glsxtrcombiningdiacriticIVrules  993
    +\glsxtrcombiningdiacriticrules  994
    +\glsxtrcontrolrules  995
    \glsxtrcopytoglossary  956
    +href="glossaries-extra-manual.html#dx1-39007" >996
    +\glsxtrcurrencyrules  997
    \glsxtrdeffield  957
    +href="glossaries-extra-manual.html#dx1-40018" >998
    \glsxtrdetoklocation  958
    +href="glossaries-extra-manual.html#dx1-38007" >999
    +\glsxtrdigitrules  1000
    \glsxtrdisplayendloc  959
    +class="cmti-10">1001
    + + + \glsxtrdisplayendlochook  960
    +class="cmti-10">1002
    \glsxtrdisplaysingleloc  961
    +class="cmti-10">1003
    \glsxtrdisplaystartloc  962
    +class="cmti-10">1004
    \glsxtrdoautoindexname  963
    +class="cmti-10">1005
    \glsxtrdowrglossaryhook  964
    +class="cmti-10">1006
    \glsxtredeffield  965
    +href="glossaries-extra-manual.html#dx1-40020" >1007
    \glsxtremsuffix  966
    +class="cmti-10">1008
    \GlsXtrEnableEntryCounting  967
    +class="cmti-10">1009
    \GlsXtrEnableEntryUnitCounting  968
    +class="cmti-10">1010
    \GlsXtrEnableIndexFormatOverride  969
    - - - +class="cmti-10">1011
    \GlsXtrEnableInitialTagging  970
    +class="cmti-10">1012
    \GlsXtrEnableLinkCounting  971
    +class="cmti-10">1013
    \GlsXtrEnableOnTheFly  972
    +class="cmti-10">1014
    \GlsXtrEnablePreLocationTag  973
    +class="cmti-10">1015
    \glsxtrenablerecordcount  974
    +href="glossaries-extra-manual.html#dx1-38037" >1016
    \glsxtrendfor  975
    +href="glossaries-extra-manual.html#dx1-40055" >1017
    \glsxtrentryfmt  976
    +href="glossaries-extra-manual.html#dx1-40008" >1018
    \glsxtrfielddolistloop  977
    +href="glossaries-extra-manual.html#dx1-40045" >1019
    \glsxtrfieldforlistloop  978
    +href="glossaries-extra-manual.html#dx1-40046" >1020
    \glsxtrfieldifinlist  979
    +href="glossaries-extra-manual.html#dx1-40047" >1021
    \glsxtrfieldlistadd  980
    +href="glossaries-extra-manual.html#dx1-40041" >1022
    \glsxtrfieldlisteadd  981
    +href="glossaries-extra-manual.html#dx1-40043" >1023
    \glsxtrfieldlistgadd  982
    +href="glossaries-extra-manual.html#dx1-40042" >1024
    \glsxtrfieldlistxadd  983
    +href="glossaries-extra-manual.html#dx1-40044" >1025
    \glsxtrfieldtitlecasecs  984
    +class="cmti-10">1026
    \glsxtrfieldxifinlist  985
    +href="glossaries-extra-manual.html#dx1-40048" >1027
    \glsxtrfmt  986
    +href="glossaries-extra-manual.html#dx1-40002" >1028
    \glsxtrfmt*  987
    +href="glossaries-extra-manual.html#dx1-40004" >1029
    \GlsXtrFmtDefaultOptions  988
    +href="glossaries-extra-manual.html#dx1-40003" >1030
    \glsxtrfmtdisplay  989
    +href="glossaries-extra-manual.html#dx1-40005" >1031
    \GlsXtrFmtField  990
    +href="glossaries-extra-manual.html#dx1-40001" >1032
    \glsxtrfootnotename  991
    +class="cmti-10">1033
    \glsxtrforcsvfield  992
    +href="glossaries-extra-manual.html#dx1-40050" >1034
    \GlsXtrFormatLocationList  993
    +class="cmti-10">1035
    +\glsxtrfractionrules  1036
    \GLSxtrfull  994
    +class="cmti-10">1037
    \Glsxtrfull  995
    +class="cmti-10">1038
    \glsxtrfull  996
    +class="cmti-10">1039
    \Glsxtrfullformat  997
    +class="cmti-10">1040
    \glsxtrfullformat  998
    +class="cmti-10">1041
    \GLSxtrfullpl  999
    +class="cmti-10">1042
    \Glsxtrfullpl  1000
    +class="cmti-10">1043
    \glsxtrfullpl  1001
    +class="cmti-10">1044
    \Glsxtrfullplformat  1002
    +class="cmti-10">1045
    \glsxtrfullplformat  1003
    +class="cmti-10">1046
    \glsxtrfullsep  1004
    +class="cmti-10">1047
    + + + +\glsxtrGeneralLatinIIIrules  1048
    +\glsxtrGeneralLatinIIrules  1049
    +\glsxtrGeneralLatinIrules  1050
    +\glsxtrGeneralLatinIVrules  1051
    +\glsxtrGeneralLatinVIIIrules  1052
    +\glsxtrGeneralLatinVIIrules  1053
    +\glsxtrGeneralLatinVIrules  1054
    +\glsxtrGeneralLatinVrules  1055
    +\glsxtrgeneralpuncIIrules  1056
    +\glsxtrgeneralpuncIrules  1057
    +\glsxtrgeneralpuncrules  1058
    \glsxtrglossentry  1005
    +href="glossaries-extra-manual.html#dx1-42004" >1059
    \glsxtrglossentryother  1006
    +href="glossaries-extra-manual.html#dx1-42012" >1060
    +\glsxtrhyphenrules  1061
    \glsxtrhyphensuffix  1007
    +class="cmti-10">1062
    \glsxtrifcounttrigger  1008
    +class="cmti-10">1063
    \glsxtrifcustomdiscardperiod  1009
    +class="cmti-10">1064
    \GlsXtrIfFieldEqStr  1010
    +href="glossaries-extra-manual.html#dx1-40033" >1065
    \GlsXtrIfFieldUndef  1011
    +href="glossaries-extra-manual.html#dx1-40032" >1066
    \glsxtrifhasfield  1012
    +href="glossaries-extra-manual.html#dx1-40028" >1067
    \glsxtrifhasfield*  1013
    +href="glossaries-extra-manual.html#dx1-40030" >1068
    \glsxtrifkeydefined  1014
    +href="glossaries-extra-manual.html#dx1-40010" >1069
    \glsxtriflabelinlist  1015
    - - - +href="glossaries-extra-manual.html#dx1-41027" >1070
    \GlsXtrIfLinkCounterDef  1016
    +class="cmti-10">1071
    \glsxtrifrecordtrigger  1017
    +href="glossaries-extra-manual.html#dx1-38022" >1072
    \glsxtrifwasfirstuse  1018
    +class="cmti-10">1073
    \glsxtrinclinkcounter  1019
    +class="cmti-10">1074
    \glsxtrindexaliased  1020
    +href="glossaries-extra-manual.html#dx1-43019" >1075
    \glsxtrindexseealso  1021
    +class="cmti-10">1076
    \glsxtrinitwrgloss  1022
    +class="cmti-10">1077
    \Glsxtrinlinefullformat  1023
    +class="cmti-10">1078
    \glsxtrinlinefullformat  1024
    +class="cmti-10">1079
    \Glsxtrinlinefullplformat  1025
    +class="cmti-10">1080
    \glsxtrinlinefullplformat  1026
    +class="cmti-10">1081
    \glsxtrinsertinsidetrue  1027
    +class="cmti-10">1082
    +\glsxtrLatinA  1083
    +\glsxtrLatinAA  1084
    +\glsxtrLatinAELigature  1085
    +\glsxtrLatinE  1086
    +\glsxtrLatinEszettSs  1087
    +\glsxtrLatinEszettSz  1088
    +\glsxtrLatinEth  1089
    +\glsxtrLatinH  1090
    +\glsxtrLatinI  1091
    +\glsxtrLatinInsularG  1092
    +\glsxtrLatinK  1093
    + + + +\glsxtrLatinL  1094
    +\glsxtrLatinLslash  1095
    +\glsxtrLatinM  1096
    +\glsxtrLatinN  1097
    +\glsxtrLatinO  1098
    +\glsxtrLatinOELigature  1099
    +\glsxtrLatinOslash  1100
    +\glsxtrLatinP  1101
    +\glsxtrLatinS  1102
    +\glsxtrLatinSchwa  1103
    +\glsxtrLatinT  1104
    +\glsxtrLatinThorn  1105
    +\glsxtrLatinWynn  1106
    +\glsxtrLatinX  1107
    \GlsXtrLetField  1028
    +href="glossaries-extra-manual.html#dx1-40024" >1108
    \GlsXtrLetFieldToField  1029
    +href="glossaries-extra-manual.html#dx1-40026" >1109
    \GlsXtrLinkCounterName  1030
    +class="cmti-10">1110
    \GlsXtrLinkCounterValue  1031
    +class="cmti-10">1111
    \GlsXtrLoadResources  1032
    +href="glossaries-extra-manual.html#dx1-33029" >1112
    \glsxtrlocalsetgrouptitle  1033
    +class="cmti-10">1113
    \GlsXtrLocationRecordCount  1034
    +href="glossaries-extra-manual.html#dx1-38012" >1114
    \glsxtrlocrangefmt  1035
    +class="cmti-10">1115
    \Glsxtrlong  1036, 1116, 1037
    +class="cmti-10">1117
    \glsxtrlong  1038
    +class="cmti-10">1118
    \glsxtrlonghyphen  1039
    +class="cmti-10">1119
    \glsxtrlonghyphenshort  1040
    +class="cmti-10">1120
    \glsxtrlongnoshortdescname  1041
    +class="cmti-10">1121
    \glsxtrlongnoshortname  1042
    +class="cmti-10">1122
    \GLSxtrlongpl  1043
    +class="cmti-10">1123
    \Glsxtrlongpl  1044
    +class="cmti-10">1124
    \glsxtrlongpl  1045
    +class="cmti-10">1125
    \glsxtrlongshortdescname  1046
    +class="cmti-10">1126
    \glsxtrlongshortdescsort  1047
    +class="cmti-10">1127
    \glsxtrlongshortname  1048
    +class="cmti-10">1128
    \glsxtrlongshortuserdescname  1049
    +class="cmti-10">1129
    +\glsxtrMathGreekIIrules  1130
    +\glsxtrMathGreekIrules  1131
    +\glsxtrMathItalicGreekIIrules  1132
    +\glsxtrMathItalicGreekIrules  1133
    +\glsxtrMathItalicLowerGreekIIrules  1134
    +\glsxtrMathItalicLowerGreekIrules  1135
    +\glsxtrMathItalicNabla  1136
    +\glsxtrMathItalicPartial  1137
    +\glsxtrMathItalicUpperGreekIIrules  1138
    +\glsxtrMathItalicUpperGreekIrules  1139
    +\glsxtrMathUpGreekIIrules  1140
    + + + +\glsxtrMathUpGreekIrules  1141
    \glsxtrnewgls  1050
    +href="glossaries-extra-manual.html#dx1-37006" >1142
    \glsxtrnewGLSlike  1051
    +href="glossaries-extra-manual.html#dx1-37008" >1143
    \glsxtrnewglslike  1052
    +href="glossaries-extra-manual.html#dx1-37007" >1144
    \glsxtrnewnumber  1053
    +href="glossaries-extra-manual.html#dx1-4158" >1145
    \glsxtrnewrgls  1054
    +href="glossaries-extra-manual.html#dx1-37009" >1146
    \glsxtrnewrGLSlike  1055
    +href="glossaries-extra-manual.html#dx1-37011" >1147
    \glsxtrnewrglslike  1056
    +href="glossaries-extra-manual.html#dx1-37010" >1148
    \glsxtrnewsymbol  1057
    +href="glossaries-extra-manual.html#dx1-4155" >1149
    \GlsXtrNoGlsWarningAutoMake  1058
    +href="glossaries-extra-manual.html#dx1-48021" >1150
    \GlsXtrNoGlsWarningBuildInfo  1059
    +href="glossaries-extra-manual.html#dx1-48020" >1151
    \GlsXtrNoGlsWarningCheckFile  1060
    +href="glossaries-extra-manual.html#dx1-48016" >1152
    \GlsXtrNoGlsWarningEmptyMain  1061
    +href="glossaries-extra-manual.html#dx1-48014" >1153
    \GlsXtrNoGlsWarningEmptyNotMain  1062
    - - - +href="glossaries-extra-manual.html#dx1-48015" >1154
    \GlsXtrNoGlsWarningEmptyStart  1063
    +href="glossaries-extra-manual.html#dx1-48013" >1155
    \GlsXtrNoGlsWarningHead  1064
    +href="glossaries-extra-manual.html#dx1-48012" >1156
    \GlsXtrNoGlsWarningMisMatch  1065
    +href="glossaries-extra-manual.html#dx1-48017" >1157
    \GlsXtrNoGlsWarningNoOut  1066
    +href="glossaries-extra-manual.html#dx1-48018" >1158
    \GlsXtrNoGlsWarningTail  1067
    +href="glossaries-extra-manual.html#dx1-48019" >1159
    +\glsxtrnonprintablerules  1160
    \glsxtrnopostpunc  1068
    +class="cmti-10">1161
    \glsxtronlydescname  1069
    +class="cmti-10">1162
    \glsxtronlyname  1070
    +class="cmti-10">1163
    \glsxtronlysuffix  1071
    +class="cmti-10">1164
    \glsxtrorglong  1072
    +class="cmti-10">1165
    \glsxtrorgshort  1073
    +class="cmti-10">1166
    \Glsxtrp  1074, 1167, 1075
    +class="cmti-10">1168
    \glsxtrp  1076
    +class="cmti-10">1169
    \glsxtrpageref  1077
    +href="glossaries-extra-manual.html#dx1-39004" >1170
    \glsxtrparen  1078
    +class="cmti-10">1171
    \Glsxtrpl  1079
    +class="cmti-10">1172
    \glsxtrpl  1080
    +class="cmti-10">1173
    \glsxtrpostdescription  1081
    +class="cmti-10">1174
    \glsxtrposthyphenlong  1082
    +class="cmti-10">1175
    \glsxtrposthyphenshort  1083
    +class="cmti-10">1176
    \glsxtrpostlink  1084
    +class="cmti-10">1177
    \glsxtrpostlinkAddDescOnFirstUse  1085
    +class="cmti-10">1178
    \glsxtrpostlinkAddSymbolOnFirstUse  1086
    +class="cmti-10">1179
    \glsxtrpostlinkendsentence  1087
    +class="cmti-10">1180
    \glsxtrpostlinkhook  1088
    +class="cmti-10">1181
    \glsxtrpostlongdescription  1089
    +class="cmti-10">1182
    \glsxtrpostnamehook  1090
    +class="cmti-10">1183
    \GlsXtrPostNewAbbreviation  1091
    +class="cmti-10">1184
    \glsxtrprelocation  1092
    +class="cmti-10">1185
    +\glsxtrprovidecommand  1186
    \glsxtrprovidestoragekey  1093
    +href="glossaries-extra-manual.html#dx1-40009" >1187
    + + + \GlsXtrRecordCount  1094
    +href="glossaries-extra-manual.html#dx1-38011" >1188
    \GlsXtrRecordCounter  1095
    +href="glossaries-extra-manual.html#dx1-40057" >1189
    \glsxtrrecordtriggervalue  1096
    +href="glossaries-extra-manual.html#dx1-38024" >1190
    \glsxtrregularfont  1097
    +class="cmti-10">1191
    \glsxtrresourcefile  1098
    +href="glossaries-extra-manual.html#dx1-33028" >1192
    \glsxtrresourceinit  1099
    +href="glossaries-extra-manual.html#dx1-37005" >1193
    \glsxtrrestorepostpunc  1100
    +class="cmti-10">1194
    \glsxtrRevertMarks  1101
    +class="cmti-10">1195
    \glsxtrscsuffix  1102
    +class="cmti-10">1196
    \glsxtrseealsolabels  1103
    +class="cmti-10">1197
    \glsxtrseelist  1104
    +class="cmti-10">1198
    \GlsXtrSetActualChar  1105
    +class="cmti-10">1199
    \glsxtrsetaliasnoindex  1106
    +href="glossaries-extra-manual.html#dx1-43016" >1200
    \GlsXtrSetAltModifier  1107
    +class="cmti-10">1201
    \glsxtrsetcategory  1108
    +class="cmti-10">1202
    \glsxtrsetcategoryforall  1109
    - - - +class="cmti-10">1203
    \GlsXtrSetDefaultGlsOpts  1110
    +class="cmti-10">1204
    \GlsXtrSetEncapChar  1111
    +class="cmti-10">1205
    \GlsXtrSetEscChar  1112
    +class="cmti-10">1206
    \GlsXtrSetField  1113
    +href="glossaries-extra-manual.html#dx1-40014" >1207
    \glsxtrsetfieldifexists  1114
    +href="glossaries-extra-manual.html#dx1-40015" >1208
    \glsxtrsetgrouptitle  1115
    +class="cmti-10">1209
    \GlsXtrSetLevelChar  1116
    +class="cmti-10">1210
    \glsxtrsetpopts  1117
    +class="cmti-10">1211
    \GlsXtrSetRecordCountAttribute  1118
    +href="glossaries-extra-manual.html#dx1-38020" >1212
    \Glsxtrshort  1119, 1213, 1120
    +class="cmti-10">1214
    \glsxtrshort  1121
    +class="cmti-10">1215
    \glsxtrshortdescname  1122
    +class="cmti-10">1216
    \glsxtrshorthyphenlong  1123
    +class="cmti-10">1217
    \glsxtrshortlongdescname  1124
    +class="cmti-10">1218
    \glsxtrshortlongname  1125, 1219, 1126
    +class="cmti-10">1220
    \glsxtrshortlonguserdescname  1127
    +class="cmti-10">1221
    \glsxtrshortnolongname  1128
    +class="cmti-10">1222
    \GLSxtrshortpl  1129
    +class="cmti-10">1223
    \Glsxtrshortpl  1130
    +class="cmti-10">1224
    \glsxtrshortpl  1131
    +class="cmti-10">1225
    \glsxtrsmsuffix  1132
    +class="cmti-10">1226
    +\glsxtrspacerules  1227
    +\glsxtrSubScriptDigitrules  1228
    \Glsxtrsubsequentfmt  1133
    +class="cmti-10">1229
    \glsxtrsubsequentfmt  1134
    +class="cmti-10">1230
    \Glsxtrsubsequentplfmt  1135
    +class="cmti-10">1231
    \glsxtrsubsequentplfmt  1136
    +class="cmti-10">1232
    +\glsxtrSuperScriptDigitrules  1233
    \glsxtrtagfont  1137
    +class="cmti-10">1234
    \GlsXtrTheLinkCounter  1138
    +class="cmti-10">1235
    + + + \GlsXtrTotalRecordCount  1139
    +href="glossaries-extra-manual.html#dx1-38010" >1236
    \glsxtrunsrtdo  1140
    +href="glossaries-extra-manual.html#dx1-41023" >1237
    \GlsXtrUseAbbrStyleFmts  1141
    +class="cmti-10">1238
    \GlsXtrUseAbbrStyleSetup  1142
    +class="cmti-10">1239
    \Glsxtrusefield  1143
    +href="glossaries-extra-manual.html#dx1-40038" >1240
    \glsxtrusefield  1144
    +href="glossaries-extra-manual.html#dx1-40036" >1241
    \glsxtruserfield  1145
    +class="cmti-10">1242
    \glsxtruserparen  1146
    +class="cmti-10">1243
    \glsxtrusersuffix  1147, 1244, 1148
    +class="cmti-10">1245
    \glsxtrusesee  1149
    +class="cmti-10">1246
    \glsxtruseseealso  1150
    +class="cmti-10">1247
    \glsxtruseseeformat  1151, 1248, 1152
    +class="cmti-10">1249
    \GlsXtrWarnDeprecatedAbbrStyle  1153
    +class="cmti-10">1250
    \GlsXtrWarning  1154
    +class="cmti-10">1251
    \glsxtrword  1155
    +class="cmti-10">1252
    \glsxtrwordsep  1156
    +class="cmti-10">1253
    \glsxtrwrglossmark  1157
    +class="cmti-10">1254

    H - - - hyperref package  1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177
    +href="glossaries-extra-manual.html#dx1-6035" >1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274

    I \ifglsxtrinitwrglossbefore  1178
    +class="cmti-10">1275
    inputenc package  1179
    +href="glossaries-extra-manual.html#dx1-35019" >1276

    L link-text  1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199
    +href="glossaries-extra-manual.html#dx1-8001" >1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296
    location list  1200, 1201, 1202, 1203, 1204
    +href="glossaries-extra-manual.html#dx1-8074" >1297, 1298, 1299, 1300, 1301
    \longnewglossaryentry  1205
    +class="cmti-10">1302

    M makeglossaries  1206, 1207, 1208, 1209, 1210
    +href="glossaries-extra-manual.html#dx1-3027" >1303, 1304, 1305, 1306, 1307
    \makeglossaries  1211
    +class="cmti-10">1308
    makeglossaries-lite  1212, 1213
    +href="glossaries-extra-manual.html#dx1-5052" >1309, 1310
    makeglossaries-lite  1214, 1215
    +href="glossaries-extra-manual.html#dx1-5053" >1311, 1312
    makeindex  1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228
    +href="glossaries-extra-manual.html#dx1-3022" >1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326
    makeindex  1229, 1230, 1231, 1232
    +href="glossaries-extra-manual.html#dx1-6030" >1327, 1328, 1329, 1330
    memoir class  1233
    +href="glossaries-extra-manual.html#dx1-3021" >1331
    mfirstuc package  1234, 1235, 1236
    +href="glossaries-extra-manual.html#dx1-5" >1332, 1333, 1334

    N \newabbreviation  1237
    +class="cmti-10">1335
    + + + \newabbreviationstyle  1238
    +class="cmti-10">1336
    \newacronym  1239
    +class="cmti-10">1337
    \newglossaryentry options
        alias  1240, 1241, 1242, 1243, 1244, 1245
    +href="glossaries-extra-manual.html#dx1-5021" >1338, 1339, 1340, 1341, 1342, 1343
        category  1246, 1247, 1248, 1249, 1250, 1251
    +href="glossaries-extra-manual.html#dx1-5020" >1344, 1345, 1346, 1347, 1348, 1349
        desc  1252, 1253
    +href="glossaries-extra-manual.html#dx1-46038" >1350, 1351
        descplural  1254, 1255
    +href="glossaries-extra-manual.html#dx1-46042" >1352, 1353
        description  1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275
    +href="glossaries-extra-manual.html#dx1-5002" >1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373
        descriptionplural  1276, 1277, 1278, 1279
    +href="glossaries-extra-manual.html#dx1-5030" >1374, 1375, 1376, 1377
        first  1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292
    +href="glossaries-extra-manual.html#dx1-8013" >1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390
        firstplural  1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302
    +href="glossaries-extra-manual.html#dx1-8014" >1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400
    +    group  1401
        location  1303, 1304
    +href="glossaries-extra-manual.html#dx1-13021" >1402, 1403
        loclist  1305
    +href="glossaries-extra-manual.html#dx1-41025" >1404
        long  1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314
    +href="glossaries-extra-manual.html#dx1-10026" >1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413
        longplural  1315, 1316, 1317, 1318, 1319, 1320
    +href="glossaries-extra-manual.html#dx1-10010" >1414, 1415, 1416, 1417, 1418, 1419
        name  1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370
    - - - +href="glossaries-extra-manual.html#dx1-5007" >1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469
        parent  1371, 1372, 1373
    +href="glossaries-extra-manual.html#dx1-17054" >1470, 1471, 1472
        plural  1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386
    +href="glossaries-extra-manual.html#dx1-8017" >1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485
        see  1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413
    +href="glossaries-extra-manual.html#dx1-4054" >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
        seealso  1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423
    +href="glossaries-extra-manual.html#dx1-4055" >1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522
        short  1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437
    +href="glossaries-extra-manual.html#dx1-8011" >1523, 1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536
        shortplural  1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452
    +href="glossaries-extra-manual.html#dx1-10011" >1537, 1538, 1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551
        sort  1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469
    +href="glossaries-extra-manual.html#dx1-4129" >1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569
        symbol  1470, 1471, 1472, 1473
    +href="glossaries-extra-manual.html#dx1-40031" >1570, 1571, 1572, 1573
        symbolplural  1474, 1475
    +href="glossaries-extra-manual.html#dx1-46034" >1574, 1575
        text  1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488
    +href="glossaries-extra-manual.html#dx1-5009" >1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588
        type  1489, 1490
    +href="glossaries-extra-manual.html#dx1-12046" >1589, 1590
        user1  1491, 1492, 1493
    +href="glossaries-extra-manual.html#dx1-22080" >1591, 1592, 1593
    number list  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
    +href="glossaries-extra-manual.html#dx1-4028" >1594, 1595, 1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619, 1620, 1621, 1622

    P package options:
        abbreviations  1523, 1524, 1525, 1526, 1527
    +href="glossaries-extra-manual.html#dx1-4141" >1623, 1624, 1625, 1626, 1627
        accsupp  1528, 1529, 1530, 1531
    +href="glossaries-extra-manual.html#dx1-4035" >1628, 1629, 1630, 1631
        acronym  1532
    +href="glossaries-extra-manual.html#dx1-4149" >1632
        acronymlists  1533
    +href="glossaries-extra-manual.html#dx1-4153" >1633
        automake  1534, 1535
    +href="glossaries-extra-manual.html#dx1-5054" >1634, 1635
        autoseeindex  1536, 1537
    +href="glossaries-extra-manual.html#dx1-4064" >1636, 1637
            false  1538, 1539
    +href="glossaries-extra-manual.html#dx1-4056" >1638, 1639
    + + +     debug  1540
    +href="glossaries-extra-manual.html#dx1-4002" >1640
            all  1541, 1542
    +href="glossaries-extra-manual.html#dx1-4005" >1641, 1642
            showtargets  1543, 1544
    +href="glossaries-extra-manual.html#dx1-4003" >1643, 1644
            showwrgloss  1545, 1546, 1547
    +href="glossaries-extra-manual.html#dx1-4004" >1645, 1646, 1647
            true  1548
    +href="glossaries-extra-manual.html#dx1-4007" >1648
        docdef  1549, 1550, 1551, 1552
    +href="glossaries-extra-manual.html#dx1-4109" >1649, 1650, 1651, 1652
            restricted  1553, 1554
    +href="glossaries-extra-manual.html#dx1-4122" >1653, 1654
            true  1555, 1556
    +href="glossaries-extra-manual.html#dx1-4137" >1655, 1656
        docdefs  1557, 1558, 1559
    +href="glossaries-extra-manual.html#dx1-32003" >1657, 1658, 1659
            true  1560
    +href="glossaries-extra-manual.html#dx1-4121" >1660
        entrycounter  1561, 1562
    +href="glossaries-extra-manual.html#dx1-39002" >1661, 1662
        hyperfirst
            false  1563
    +href="glossaries-extra-manual.html#dx1-27030" >1663
        index  1564, 1565
    +href="glossaries-extra-manual.html#dx1-5043" >1664, 1665
        indexcrossrefs  1566, 1567, 1568, 1569
    +href="glossaries-extra-manual.html#dx1-4053" >1666, 1667, 1668, 1669
            false  1570
    +href="glossaries-extra-manual.html#dx1-4063" >1670
        indexonlyfirst  1571, 1572, 1573, 1574
    +href="glossaries-extra-manual.html#dx1-6002" >1671, 1672, 1673, 1674
        nogroupskip  1575
    +href="glossaries-extra-manual.html#dx1-17014" >1675
        nomain  1576
    - - - +href="glossaries-extra-manual.html#dx1-3032" >1676
        nomissingglstext  1577
    +href="glossaries-extra-manual.html#dx1-4140" >1677
        nonumberlist  1578, 1579, 1580, 1581
    +href="glossaries-extra-manual.html#dx1-7026" >1678, 1679, 1680, 1681
        nopostdot  1582, 1583, 1584, 1585
    +href="glossaries-extra-manual.html#dx1-4023" >1682, 1683, 1684, 1685
            false  1586, 1587, 1588
    +href="glossaries-extra-manual.html#dx1-3004" >1686, 1687, 1688
            true  1589
    +href="glossaries-extra-manual.html#dx1-3003" >1689
        noredefwarn
            false  1590
    +href="glossaries-extra-manual.html#dx1-3009" >1690
            true  1591
    +href="glossaries-extra-manual.html#dx1-3006" >1691
        notree  1592
    +href="glossaries-extra-manual.html#dx1-17034" >1692
        numbers  1593, 1594, 1595
    +href="glossaries-extra-manual.html#dx1-4157" >1693, 1694, 1695
        postdot  1596, 1597, 1598
    +href="glossaries-extra-manual.html#dx1-3005" >1696, 1697, 1698
        postpunc  1599, 1600, 1601
    +href="glossaries-extra-manual.html#dx1-4019" >1699, 1700, 1701
            comma  1602
    +href="glossaries-extra-manual.html#dx1-4020" >1702
            dot  1603
    +href="glossaries-extra-manual.html#dx1-4021" >1703
            none  1604
    +href="glossaries-extra-manual.html#dx1-4022" >1704
        record  1605, 1606, 1607, 1608, 1609, 1610
    +href="glossaries-extra-manual.html#dx1-4062" >1705, 1706, 1707, 1708, 1709, 1710, 1711, 1712, 1713
            alsoindex  1611, 1612, 1613, 1614, 1615, 1616
    +href="glossaries-extra-manual.html#dx1-4009" >1714, 1715, 1716, 1717, 1718, 1719, 1720
            off  1617, 1618
    +href="glossaries-extra-manual.html#dx1-5049" >1721, 1722
            only  1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627
    +href="glossaries-extra-manual.html#dx1-4067" >1723, 1724, 1725, 1726, 1727, 1728, 1729, 1730, 1731, 1732
        section
            chapter  1628
    +href="glossaries-extra-manual.html#dx1-13038" >1733
        seeautonumberlist  1629
    +href="glossaries-extra-manual.html#dx1-7027" >1734
        seenoindex  1630
    +href="glossaries-extra-manual.html#dx1-7016" >1735
            ignore  1631, 1632
    +href="glossaries-extra-manual.html#dx1-7018" >1736, 1737
            warn  1633
    +href="glossaries-extra-manual.html#dx1-41012" >1738
        shortcuts  1634, 1635
    +href="glossaries-extra-manual.html#dx1-4159" >1739, 1740
            abbr  1636, 1637
    +href="glossaries-extra-manual.html#dx1-4165" >1741, 1742
    + + +         abbreviation  1638, 1639
    +href="glossaries-extra-manual.html#dx1-21001" >1743, 1744
            abbreviations  1640, 1641
    +href="glossaries-extra-manual.html#dx1-4164" >1745, 1746
            ac  1642, 1643, 1644, 1645, 1646, 1647
    +href="glossaries-extra-manual.html#dx1-4162" >1747, 1748, 1749, 1750, 1751, 1752
            acro  1648, 1649
    +href="glossaries-extra-manual.html#dx1-4161" >1753, 1754
            acronyms  1650, 1651
    +href="glossaries-extra-manual.html#dx1-4160" >1755, 1756
            all  1652, 1653
    +href="glossaries-extra-manual.html#dx1-4175" >1757, 1758
            false  1654
    +href="glossaries-extra-manual.html#dx1-4181" >1759
            none  1655
    +href="glossaries-extra-manual.html#dx1-4180" >1760
            other  1656, 1657
    +href="glossaries-extra-manual.html#dx1-4166" >1761, 1762
            true  1658
    +href="glossaries-extra-manual.html#dx1-4176" >1763
        sort
            none  1659, 1660
    +href="glossaries-extra-manual.html#dx1-4091" >1764, 1765
        stylemods  1661, 1662, 1663, 1664, 1665
    +href="glossaries-extra-manual.html#dx1-4044" >1766, 1767, 1768, 1769, 1770
            all  1666
    +href="glossaries-extra-manual.html#dx1-4047" >1771
            default  1667
    +href="glossaries-extra-manual.html#dx1-4046" >1772
        subentrycounter  1668, 1669
    +href="glossaries-extra-manual.html#dx1-39003" >1773, 1774
        symbols  1670, 1671, 1672
    +href="glossaries-extra-manual.html#dx1-4154" >1775, 1776, 1777
        toc
            false  1673
    - - - +href="glossaries-extra-manual.html#dx1-3002" >1778
            true  1674
    +href="glossaries-extra-manual.html#dx1-3001" >1779
        translate
            babel  1675
    +href="glossaries-extra-manual.html#dx1-3011" >1780
            true  1676
    +href="glossaries-extra-manual.html#dx1-3013" >1781
        undefaction  1677, 1678
    +href="glossaries-extra-manual.html#dx1-4048" >1782, 1783
            error  1679, 1680
    +href="glossaries-extra-manual.html#dx1-4049" >1784, 1785
            warn  1681, 1682, 1683, 1684, 1685, 1686
    +href="glossaries-extra-manual.html#dx1-4050" >1786, 1787, 1788, 1789, 1790, 1791
        xindy  1687
    +href="glossaries-extra-manual.html#dx1-7046" >1792
    page (counter)  1688, 1689
    +href="glossaries-extra-manual.html#dx1-29031" >1793, 1794
    polyglossia package  1690
    +href="glossaries-extra-manual.html#dx1-48005" >1795
    \pretoglossarypreamble  1691
    +href="glossaries-extra-manual.html#dx1-39011" >1796
    \printabbreviations  1692
    +href="glossaries-extra-manual.html#dx1-4142" >1797
    \printglossary options
        nogroupskip  1693
    +href="glossaries-extra-manual.html#dx1-17015" >1798
        target  1694, 1695
    +href="glossaries-extra-manual.html#dx1-5018" >1799, 1800
        targetnameprefix  1696
    +href="glossaries-extra-manual.html#dx1-5019" >1801
        title  1697
    +href="glossaries-extra-manual.html#dx1-48006" >1802
    \printnoidxglossary options
        sort  1698
    +href="glossaries-extra-manual.html#dx1-41015" >1803
    \printunsrtglossaries  1699
    +href="glossaries-extra-manual.html#dx1-41016" >1804
    \printunsrtglossary  1700
    +href="glossaries-extra-manual.html#dx1-41001" >1805
    \printunsrtglossary*  1701
    +href="glossaries-extra-manual.html#dx1-41005" >1806
    \printunsrtglossaryentryprocesshook  1702
    +href="glossaries-extra-manual.html#dx1-41019" >1807
    \printunsrtglossaryhandler  1703
    +href="glossaries-extra-manual.html#dx1-41022" >1808
    \printunsrtglossarypredoglossary  1704
    +href="glossaries-extra-manual.html#dx1-41021" >1809
    \printunsrtglossaryskipentry  1705
    +href="glossaries-extra-manual.html#dx1-41020" >1810
    \printunsrtglossaryunit  1706
    +href="glossaries-extra-manual.html#dx1-41029" >1811
    + + + \printunsrtglossaryunitsetup  1707
    +href="glossaries-extra-manual.html#dx1-41030" >1812
    \provideignoredglossary  1708
    +class="cmti-10">1813

    R relsizes package  1709
    +href="glossaries-extra-manual.html#dx1-22048" >1814
    \RestoreAcronyms  1710
    +class="cmti-10">1815
    \rGLS  1711
    +href="glossaries-extra-manual.html#dx1-38017" >1816
    \rGls  1712
    +href="glossaries-extra-manual.html#dx1-38015" >1817
    \rgls  1713
    +href="glossaries-extra-manual.html#dx1-38013" >1818
    \rGLSformat  1714
    +href="glossaries-extra-manual.html#dx1-38034" >1819
    \rGlsformat  1715
    +href="glossaries-extra-manual.html#dx1-38032" >1820
    \rglsformat  1716
    +href="glossaries-extra-manual.html#dx1-38030" >1821
    \rGLSpl  1717
    +href="glossaries-extra-manual.html#dx1-38018" >1822
    \rGlspl  1718
    +href="glossaries-extra-manual.html#dx1-38016" >1823
    \rglspl  1719
    +href="glossaries-extra-manual.html#dx1-38014" >1824
    \rGLSplformat  1720
    +href="glossaries-extra-manual.html#dx1-38035" >1825
    \rGlsplformat  1721
    +href="glossaries-extra-manual.html#dx1-38033" >1826
    \rglsplformat  1722
    - - - +href="glossaries-extra-manual.html#dx1-38031" >1827

    S \setabbreviationstyle  1723
    +class="cmti-10">1828
    slantsc package  1724
    +href="glossaries-extra-manual.html#dx1-26020" >1829
    style package  1725
    +href="glossaries-extra-manual.html#dx1-13005" >1830
    subentrycounter package  1726
    +href="glossaries-extra-manual.html#dx1-42016" >1831

    T textcase package  1727
    +href="glossaries-extra-manual.html#dx1-8" >1832
    tracklang package  1728, 1729, 1730
    +href="glossaries-extra-manual.html#dx1-4" >1833, 1834, 1835, 1836, 1837, 1838, 1839, 1840
    translator package  1731
    +href="glossaries-extra-manual.html#dx1-3012" >1841
    +

    U +upgreek package  1842, 1843, 1844, 1845

    X xfor package  1732, 1733, 1734
    +href="glossaries-extra-manual.html#dx1-9" >1846, 1847, 1848
    \xglssetwidest  1735
    +class="cmti-10">1849
    \xglsupdatewidest  1736
    +class="cmti-10">1850
    \xGlsXtrSetField  1737
    +href="glossaries-extra-manual.html#dx1-40023" >1851
    xindy  1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748
    +href="glossaries-extra-manual.html#dx1-3023" >1852, 1853, 1854, 1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862, 1863
    xindy  1749
    +href="glossaries-extra-manual.html#dx1-6034" >1864
    xkeyval package  1750
    +href="glossaries-extra-manual.html#dx1-7" >1865
    + + +

    1.14.21 was originally intended as the last release of glossaries to incorporate new features, but a few new minor features slipped in with some bug fixes in v4.21.

    -

    2.1The descriptionpluralfield and the short form was stored in the symbol field.

    -

    3.1For compatibility with earlier versions, \glsabbrvscfont \glsxtrscfont is now deprecated. Likewise for similar commands.

    -

    9.1Version 1.11 only allowed one use of \GlsXtrLoadResources per document.

    -

    9.2v1.08 assumed filename#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.26: + \title{glossaries-extra.sty v1.27: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2018-01-05} + \date{2018-02-26} \maketitle \begin{abstract} @@ -260,11 +276,13 @@ Additional resources: \item The \href{http://www.dickimaw-books.com/gallery/#glossaries-extra}{\styfmt{glossaries-extra} gallery}. +\item \href{http://www.dickimaw-books.com/software/bib2gls}{\appfmt{bib2gls}} + \item \href{http://www.latex-community.org/know-how/latex/55-latex-general/263-glossaries-nomenclature-lists-of-symbols-and-acronyms}{Glossaries, Nomenclature, Lists of Symbols and Acronyms}. -\item \href{http://www.dickimaw-books.com/software/bib2gls}{bib2gls} +\item The base \href{https://ctan.org/pkg/glossaries}{\styfmt{glossaries}} package. \end{itemize} \tableofcontents @@ -706,7 +724,9 @@ or \cs{makenoidxglossaries}. This setting implements \pkgopt[error]{undefaction} \item[\pkgoptfmt{only}] The indexing is performed by \gls{bib2gls} (see \sectionref{sec:bib2gls}). Neither \cs{makeglossaries} nor \cs{makenoidxglossaries} is permitted. -This setting implements \pkgopt[warn]{undefaction}. +This setting implements \pkgopt[warn]{undefaction} and automatically +loads the supplementary \sty{glossaries-extra-bib2gls} package. +(There should be no need to explicitly load \sty{glossaries-extra-bib2gls}.) The glossaries should be displayed using \cs{printunsrtglossary} (or \cs{printunsrtglossaries}). @@ -742,7 +762,9 @@ to avoid a clash with the transcript file used by \gls{bib2gls}['s] \verb|--log-file| or \verb|-t| option.) The glossaries should be displayed using \cs{printglossary} -(or \cs{printglossaries}). +(or \cs{printglossaries}). This option is expected to be used with +\gls{bib2gls}'s \texttt{sort=none} setting and so +\sty{glossaries-extra-bib2gls} is not automatically loaded. The document build process is (assuming the file is called \texttt{myDoc.tex}): @@ -4054,8 +4076,8 @@ use \ics{glsabbrvscfont} (which defaults to \cs{textsc}). \item[\abbrstyledef{nolong-short-sc}] Like \abbrstyle{short-sc-nolong} but the inline full form displays \meta{long} (\meta{short}). The name is still obtained from -\cs{glsxtrshortnolongname} (similarly for the other -\texttt{nolong}\meta{modifier}\texttt{-short}\meta{modifier} styles, +\cs{glsxtrshortnolongname} (similarly for the other styles in the +form \texttt{nolong}\meta{modifier}\texttt{-short}\meta{modifier} unless indicated otherwise). \item[\abbrstyledef{short-sm-nolong}] @@ -7012,10 +7034,11 @@ collate the locations. If you still want to use an indexing application (for example, you need a custom \gls{xindy} rule), then just use \pkgopt[alsoindex]{record} and continue to use \cs{makeglossaries} -and \cs{printglossary} (or \cs{printglossaries}), but it's a good -idea to also instruct \gls{bib2gls} to omit sorting to save time. +and \cs{printglossary} (or \cs{printglossaries}), but you also need +to instruct \gls{bib2gls} to omit sorting to save time and +to prevent the \gloskey{sort} key from being set. -The \texttt{.glstex} file created by \cs{bib2gls} is loaded using: +The \texttt{.glstex} file created by \gls{bib2gls} is loaded using: \begin{definition}[\DescribeMacro\glsxtrresourcefile] \cs{glsxtrresourcefile}\oarg{options}\marg{filename} \end{definition} @@ -7051,15 +7074,15 @@ to the \texttt{.aux} file and will input for example, \meta{filename} happens to be the same as \cs{jobname}. The \texttt{.glstex} extension was enforced by version 1.11.} -Since the \texttt{.glstex} won't exist on the first \LaTeX\ run, the +Since the \texttt{.glstex} file won't exist on the first \LaTeX\ run, the \pkgopt{record} package option additionally switches on \pkgopt[warn]{undefaction}. Any use of commands like \cs{gls} or -\cs{glstext} will produce ?? in the document, since they are +\cs{glstext} will produce ?? in the document, since the entries are undefined at this point. Once \gls{bib2gls} has created the \texttt{.glstex} file the references should be resolved. This may cause a shift in the locations if the actual text produced -once the entry is defined is larger than the placeholder ?? (as can -occur with long citations). +once the entry is defined is significantly larger than the +placeholder ?? (as this can alter the page breaking). Note that as from v1.12, \cs{glsxtrresourcefile} temporarily switches the category code of \texttt{@} to 11 (letter) while it @@ -7076,7 +7099,8 @@ entries (including parent and cross-references). The as a special ignored record. This means that it will match the selection criteria but the record won't be added to the location list. This means that you won't get spurious -commas in the location list, so you can do, for example, +commas in the location list (as can happen with the other indexing +methods), so you can do, for example, \begin{verbatim} \GlsXtrSetDefaultNumberFormat{glsignore} \end{verbatim} @@ -7125,6 +7149,7 @@ The locale-sensitive sort methods usually ignore most punctuation so for lists of symbols you may find it more appropriate to use one of the letter-base sort methods that sort according to the Unicode value of each character. +Alternatively you can provide a custom rule. See the \gls{bib2gls} manual for full details of all the available sort methods. @@ -7132,7 +7157,7 @@ Since the \texttt{.glstex} file only defines those references required within the document (selected according to the \texttt{selection} option) and the definitions have been written in the -order corresponding to \gls{bib2gls} sorted list, the glossaries can +order corresponding to \gls{bib2gls}['s] sorted list, the glossaries can simply be displayed using \cs{printunsrtglossary} (or \cs{printunsrtglossaries}), described in \sectionref{sec:printunsrt}. @@ -7251,6 +7276,10 @@ pdflatex myDoc bib2gls -g myDoc pdflatex myDoc \end{verbatim} +The value of the \gloskey{group} field must always be a label. You +can set the corresponding title with \cs{glsxtrsetgrouptitle} +(see \sectionref{sec:glosstylemods}). If no title is set then the +label is used as the group title. You can provide your own custom sort rule. For example, if you are using \XeLaTeX\ or \LuaLaTeX: @@ -7273,9 +7302,9 @@ characters, such as \'e or \o, are active and will expand when written to the \texttt{.aux} file. So with PDF\LaTeX\ the above would have to be changed to protect against expansion. Some of the options, including \texttt{sort-rule}, -may have Unicode characters indicated in the format +allow Unicode characters to be indicated in the format \cs{u}\meta{hex} (or \cs{u}~\meta{hex}) \textbf{in the \texttt{.aux} file}. \gls{bib2gls} -will recognise this format as indicating the character +will recognise this as the character given by the hexadecimal value \meta{hex}. The \cs{u} also needs protection from expansion, so with a non-Unicode aware engine, the character \ae\ needs to be written as @@ -7300,10 +7329,25 @@ the above needs to be written as: \}] \end{alltt} -\section{Supplementary Commands} - -These commands are provided by \styfmt{glossaries-extra} -for use with \gls{bib2gls}. +\section{The \styfmt{glossaries-extra-bib2gls} package} +\label{sec:bib2glssty} + +The package option \pkgopt[only]{record} (or simply \pkgopt{record}) +automatically loads the supplementary package +\sty{glossaries-extra-bib2gls}, which provides some commands +that are specific to sorting with \gls{bib2gls}. The package isn't +loaded by \pkgopt[alsoindex]{record} as that option is intended +for sorting with \gls{makeindex} or \gls{xindy} and it is expected +that the sorting will be switched off (with the resource option +\texttt{sort=none}). + +If \sty{glossaries-extra-bib2gls} is loaded via the +\pkgopt{record} package option then the check for associated +language resource files (see \sectionref{sec:lang}) will also +search for the existence of +\texttt{glossariesxtr-}\meta{script}\texttt{.ldf} for each +document dialect (where \meta{script} is the four letter +script identifier, such as \texttt{Latn}). \begin{definition}[\DescribeMacro\glshex] \cs{glshex} @@ -7313,6 +7357,686 @@ when you need to indicate a Unicode character in the form \cs{u}\meta{hex} in some of the resource options (as illustrated above). +\begin{definition}[\DescribeMacro\glsxtrprovidecommand] +\cs{glsxtrprovidecommand} +\end{definition} +This command is intended for use in \texttt{@preamble}. +It's simply defined to \cs{providecommand} in +\sty{glossaries-extra-bib2gls} but \gls{bib2gls}['s] interpreter +treats it as \cs{renewcommand}. This means that you can +override \gls{bib2gls}['s] internal definition of a command +without overriding the command definition in the document +(if it's already defined before the resource file is input). +For example +\begin{verbatim} +@preamble{"\glsxtrprovidecommand{\int}{integral}"} +\end{verbatim} +This will force \gls{bib2gls} to treat \cs{int} as the word +\qt{integral} to assist sorting but if this preamble code is written +to the \texttt{.glstex} file (as it is by default) then it won't +override the current definition (provided by the kernel or redefined +by a package). + +The \sty{glossaries-extra-bib2gls} package also provides definitions +of the missing mathematical Greek commands: \ics{Alpha}, +\ics{Beta}, \ics{Epsilon}, \ics{Zeta}, \ics{Eta}, \ics{Iota}, +\ics{Kappa}, \ics{Mu}, \ics{Nu}, \ics{Omicron}, \ics{Rho}, +\ics{Tau}, \ics{Chi}, \ics{Digamma}, \ics{omicron}. +These are all defined with \cs{providecommand}, so they won't override +any definitions provided by any package loaded before +\sty{glossaries-extra}. Since \gls{bib2gls}['s] interpreter +recognises these commands, using them instead of explicitly using +the Latin characters with the same shape helps to keep the Greek +symbols together when sorting. +Similarly, if \sty{upgreek} has been loaded, the missing upright +Greek commands are also provided. + +The remaining commands provide common rule blocks for use in +the \texttt{sort-rule} resource option. If you want a rule for +a specific locale, you can provide similar commands in a file called +\texttt{glossariesxtr-}\meta{tag}\texttt{.ldf}, where \meta{tag} +identifies the dialect, locale, region or root language. See the +description of \cs{IfTrackedLanguageFileExists} in the +\sty{tracklang} documentation for further details. If this file is +on \TeX's path and the \sty{tracklang} package (automatically loaded +by \styfmt{glossaries}) detects that the document has requested that +language or locale, then the file will automatically be loaded. +For example, if you want to provide a rule block for Welsh, then +create a file called \texttt{glossariesxtr-welsh.ldf} that contains: +\begin{verbatim} +\ProvidesGlossariesExtraLang{welsh}[2018/02/23 v1.0] + +\@ifpackageloaded{glossaries-extra-bib2gls} +{ + \newcommand{\glsxtrWelshRules}{% + \glsxtrLatinA + \string