From 9e987d284eb0915a995e129c61df7c94146b5007 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 15 Jun 2017 21:47:33 +0000 Subject: glossaries-extra (15jun17) git-svn-id: svn://tug.org/texlive/trunk@44608 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 23 + .../texmf-dist/doc/latex/glossaries-extra/README | 10 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 783250 -> 798427 bytes .../glossaries-extra/glossaries-extra-manual.html | 9891 ++++++++++---------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 677832 -> 690735 bytes .../glossaries-extra/glossaries-extra-manual.tex | 234 +- .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44761 -> 44761 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80757 -> 80757 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50368 -> 50368 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36745 -> 36745 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43611 -> 43611 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35308 -> 35308 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91061 -> 91061 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69532 -> 69532 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54866 -> 54866 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 141591 -> 141998 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 146634 -> 161489 bytes .../latex/glossaries-extra/sample-autoindex.tex | 14 +- .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 41294 -> 41294 bytes .../doc/latex/glossaries-extra/sample-crossref.tex | 2 +- .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41319 -> 41613 bytes .../latex/glossaries-extra/sample-crossref2.tex | 5 +- .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45257 -> 45257 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54623 -> 54623 bytes .../doc/latex/glossaries-extra/sample-external.pdf | Bin 55786 -> 55786 bytes .../doc/latex/glossaries-extra/sample-fmt.pdf | Bin 75272 -> 75272 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63232 -> 63232 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125199 -> 125199 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42722 -> 42722 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81591 -> 81591 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57823 -> 57823 bytes .../latex/glossaries-extra/sample-mixedsort.pdf | Bin 45154 -> 45154 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 159443 -> 159939 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202102 -> 202102 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67736 -> 67736 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47582 -> 47582 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44527 -> 44527 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106071 -> 106071 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19860 -> 19856 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43481 -> 43481 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38801 -> 38801 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37063 -> 37063 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67889 -> 67889 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33119 -> 33119 bytes .../doc/latex/glossaries-extra/sample-record.pdf | Bin 49665 -> 49665 bytes .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47895 -> 47895 bytes .../latex/glossaries-extra/sample-suppl-hyp.pdf | Bin 34944 -> 34944 bytes .../glossaries-extra/sample-suppl-main-hyp.pdf | Bin 32971 -> 32971 bytes .../latex/glossaries-extra/sample-suppl-main.pdf | Bin 31607 -> 31607 bytes .../doc/latex/glossaries-extra/sample-suppl.pdf | Bin 13423 -> 13423 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49455 -> 49455 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33231 -> 33231 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61051 -> 61051 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45747 -> 45747 bytes 54 files changed, 5439 insertions(+), 4740 deletions(-) (limited to 'Master/texmf-dist/doc/latex/glossaries-extra') diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 8e803f76d47..91e3ac4cd3e 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,26 @@ +1.16 (2017-06-15): + + * New key: seealso + + * New commands: \glsxtrseealsolabels, \glsxtrseelist, + \glsxtrindexseealso, \glsxtruseseealso, + \glsxtrautoindexentry, \glsxtrautoindexassignsort, + \glsxtrautoindex + + * New package option: autoseeindex + (autoseeindex=false requires at least glossaries v4.30) + + * Added xindy "seealso" cross-reference class to work with + \glsxtrindexseealso (requires at least glossaries v4.30, + otherwise behaves like \glssee). + + * Added example-glossaries-xr.tex which contains dummy entries + with cross-references for use in test documents. + + * Fixed bug in \@gls@noidx@getgrouptitle + + * Fixed bug in \@print@unsrt@glossary + 1.15 (2017-05-10): * Fixed typo in command name (\glsabbvfont -> \glsabbrvfont) diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index 3ef56ff3cda..a5a766cd75d 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.15 +LaTeX Package : glossaries-extra v1.16 -Last Modified : 2017-05-10 +Last Modified : 2017-06-15 Author : Nicola Talbot @@ -12,6 +12,12 @@ glossaries-extra-manual.pdf for further details. Requires the glossaries package (and, naturally, all packages required by glossaries.sty). +The file example-glossaries-xr.tex contains dummy +entries with cross-references that may be used for creating +minimal working examples for testing the glossaries-extra +package. (The base glossaries package provides additional files, +but this one needs glossaries-extra.sty.) + LICENCE This material is subject to the LaTeX Project Public License. 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 51b025afa54..c83974ff9e4 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 9aa301401df..0328541b6af 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 @@ -217,7 +217,7 @@ a span.HoLogo-TeX span.HoLogo-e{text-decoration:none;} >

glossaries-extra.sty v1.15: an extension to the +class="cmr-17">glossaries-extra.sty v1.16: an extension to the glossaries package

@@ -241,7 +241,7 @@ href="http://www.dickimaw-books.com/" class="url" >http://www.dickimaw-books.com/

2017-05-10

+class="cmr-12">2017-06-15

@@ -263,12 +263,20 @@ with glossaries version 4.19 (or above). This document assumes familiarity with the glossaries package. +

The file example-glossaries-xr.tex contains dummy entries with cross-references +that may be used for creating minimal working examples for testing the +glossaries-extra package. (The base glossaries package provides additional files, but this +one needs glossaries-extra.)

-

Since

Since glossaries-extra internally loads the glossaries package, you also need to have EX distribution? or Updating TEX on Linux.)
-

-

Additional resources:

+

+

Additional resources:

-

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 @@ -433,10 +443,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 @@ -446,7 +456,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: @@ -528,7 +538,7 @@ Commands and Styles).  
\usepackage[toc,nopostdot]{glossaries}  
\usepackage{glossaries-extra}

-

+

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

    This is like: +

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

    +

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

    This is like: +

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

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

    This is like: +

    This is like: @@ -593,19 +603,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: @@ -656,7 +666,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 @@ -712,13 +722,13 @@ class="cmss-10">nomain\printglossaries  
    \end{document} -

    -

    +

    +

    -

    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:

    @@ -754,7 +764,7 @@ class="cmss-10">glossaries-accsupp

    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 through glossaries-extra-stylemodsvalue⟩ if it contains any commas.) The value may be omitted if no options need to be passed. See §2.7 §2.8 Glossary Style Modifications for further details.

    @@ -826,18 +836,129 @@ class="cmss-10">glossaries). You can switch this to a warning message (and ?? appearing in the text) with 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.
    -

    +

    recordindexcrossrefs
    This is a boolean option. If true, this will automatically index any + cross-referenced entries that haven’t been marked as used at the end of the + document. Note that this necessarily adds to the overall document build time, + especially if you have defined a large number of entries, so this defaults to false, + but it will be automatically switched on if you use the see or seealso keys + in any entries (unless autoseeindex=false). To force it off, even if you + use the see or seealso key, you need to explicitly set indexcrossrefs to + false. +

    Note that bib2gls can automatically find dependent entries when it + parses the .bib source file. The record option automatically implements + indexcrossrefs=false. +

    +autoseeindex
    (New to v1.16.) This is a boolean option. If true (default), this makes + + + + the see and seealso keys automatically index the cross-reference when an entry + is defined. If false, the value of those keys will still be stored in their + corresponding fields (and can be accessed using commands like \glsxtrusesee + and \glsxtruseseealso) but cross-reference won’t be automatically + indexed. +

    Note that the record=only option automatically implements autoseeindex=false. +

    For example, if an entry is defined as + + + +

    +
    + \newglossaryentry{foo}{name={foo},description={},see={bar,baz}} +
    +

    then with autoseeindex=true, this is equivalent to + + + +

    +
    + \newglossaryentry{foo}{name={foo},description={}} +  
    \glssee{foo}{bar,baz} +  
    \glossariesextrasetup{indexcrossrefs=true} +  
    \GlsXtrSetField{foo}{see}{bar,baz} +
    +

    but with autoseeindex=false, this is equivalent to + + + +

    +
    + \newglossaryentry{foo}{name={foo},description={}} +  
    \GlsXtrSetField{foo}{see}{bar,baz} +
    +

    Note that indexcrossrefs isn’t automatically implemented by the presence of the + see key when autoseeindex is false. +

    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 + 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. + This will need the package option seenoindex=ignore (provided by glossaries) to + prevent an error occurring. +

    +record
    (New to v1.08.) This is a ⟨key⟩=⟨value⟩ option, which has three allowed values: @@ -847,57 +968,63 @@ class="cmss-10">only and alsoindex. If the value is omitted only is assumed. The option is provided for the benefit of bib2gls (see (see §9 bib2gls: Managing Reference Databases). -

    The option may only be set in the preamble. -

    The

    The option may only be set in the preamble. +

    The record=off option switches off the recording, as per the default behaviour. + id="dx1-4040"> option switches off the recording, as per the default behaviour. It implements undefaction=error. -

    The other values switch on the recording and also . +

    The other values switch on the recording and also undefaction=warn, + id="dx1-4042">, but record=only will also switch off the indexing mechanism (even if + id="dx1-4043"> will also switch off the indexing mechanism (even if \makeglossaries or \makenoidxglossaries has been used) whereas record=alsoindex will both record and index. Note that will both record and index. Note that record=only will prevent + id="dx1-4045"> will prevent the see from automatically implementing from automatically implementing \glssee. (bib2gls deals with the deals with the see + id="dx1-4049"> field.) You may explicitly use \glssee in the document, but bib2gls - - - + id="dx1-4051"> will ignore the cross-reference if the see field was already set for that + id="dx1-4052"> field was already set for that entry. -

    With the recording on, any of the commands that would typically index the +

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

    With the recording on, 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 read these lines to find out which entries + id="dx1-4056"> 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 commands won’t add a corresponding §9 bib2gls: Managing Reference Databases for further details. + + +

    docdef
    This option governs the use of \newglossaryentry. It was originally a boolean option, but as from version 1.06, it can now take one of three values (if @@ -931,10 +1060,10 @@ class="cmss-10">true is assumed):
    • \newglossaryentry is not permitted in the is not permitted in the document environment + id="dx1-4060"> environment (default).
    • \newglossaryentry behaves as it does in the base glossaries package. That is, where its use is permitted in the document environment, it + id="dx1-4063"> environment, it uses the .glsdefs temporary file to store the entry definitions so that on the next LATEX run the entries are defined at the beginning of the document environment. This allows the entry information + id="dx1-4065"> environment. This allows the entry information to be referenced in the glossary, even if the glossary occurs before \newglossaryentry. (For example, when the glossary is displayed in @@ -963,11 +1092,11 @@ class="cmss-10">glossaries user
    • (new to version 1.06) \newglossaryentry is permitted in the + id="dx1-4068"> 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 @@ -976,15 +1105,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-4073"> 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 @@ -992,44 +1121,42 @@ 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-4074"> 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-4075"> environment (when used with makeindex or xindy) but the user manual warns + id="dx1-4077">makeindex or xindy) but the user manual warns against this usage. By default the glossaries-extra package prohibits this, only allowing definitions within the preamble. If you are really determined to define entries in the document environment, despite all the + id="dx1-4079"> environment, despite all the associated drawbacks, you can restore this with docdef=true. Note that this + id="dx1-4081">. 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 further details. A better option if document definitions are required is docdef=restricted. Only use . Only use docdef=true if document definitions + id="dx1-4083"> 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

    Note that bib2gls can automatically find dependent entries when it - parses the .bib source file. The record option automatically implements - indexcrossrefs=false. -

    -abbreviations
    This option has no value and can’t be cancelled. If used, it will automatically create a new glossary with the label abbreviations and redefines \glsxtrabbrvtype to this label. In addition, it defines a shortcut command -



    \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-4090"> 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-4093"> option provided by the glossaries package hasn’t been used, then \acronymtype will be set to + id="dx1-4094"> will be set to \glsxtrabbrvtype so that acronyms defined with so that acronyms defined with \newacronym can be added + id="dx1-4096"> 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-4097"> option (or associated commands) as the abbreviation mechanism is handled differently with 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.
    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: @@ -1273,18 +1368,18 @@ class="cmss-10">glossaries package option of the same name, this option i
    • shortcuts=acronyms (or (or shortcuts=acro): set the shortcuts provided + id="dx1-4105">): set the shortcuts provided by the glossaries package for acronyms (such as \ac).
    • shortcuts=abbreviations (or (or shortcuts=abbr): + id="dx1-4107">): set the abbreviation shortcuts provided by glossaries-extra. (See glossaries package.
    • shortcuts=other: set the “other” shortcut commands, but not the shortcut + id="dx1-4108">: 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-4110">
      • \newsym equivalent to equivalent to \glsxtrnewsymbol (see the (see the symbols + id="dx1-4113"> option).
      • \newnum equivalent to equivalent to \glsxtrnewnumber (see the (see the numbers + id="dx1-4116"> option).
    • shortcuts=all (or (or shortcuts=true): define all the shortcut commands. + id="dx1-4118">): define all the shortcut commands.
    • shortcuts=none (or (or shortcuts=false): don’t define any of the shortcut + id="dx1-4120">): 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-4124"> options may only be used in the preamble. Additionally, docdef can’t be used after can’t be used after \makenoidxglossaries. + id="dx1-4126">.

    -

    -

    +

    Top

    2. Modifications to Existing Commands and Styles

    -

    The commands used by

    The commands used by glossaries to automatically produce an error if an entry is undefined (such as \glsdoifexists\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, \glsdisablehyper this doesn’t switch off hyperlinks any cross-references within the glossary won’t be affected. This is a way of avoiding duplicate target warnings if a glossary needs to be displayed multiple times. -

    The \newglossaryentry command has two new keys:

    +

    The \newglossaryentry command has three new keys:

    -

    The for further details. + +

  • seealso, which performs much like see, but allows for separate “see” and + “see also” treatment. See §2.2 Cross-References (“see” and “see also”) for + further details.
  • +

    The test file example-glossaries-xr.tex contains dummy entries with a mixture of +see, alias and seealso keys for use with minimal working examples. +

    The \longnewglossaryentry command now has a starred version (as from v1.12) that doesn’t automatically insert

    -
    +
    \leavevmode\unskip\nopostdesc
    -

    at the end of the description field. -


    at the end of the description field. +


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

    -

    +

    The descriptionplural key is left unset unless explicitly set in ⟨ 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: @@ -1486,59 +1601,59 @@ 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 + id="dx1-5019"> package’s treatment of the descriptionplural key. Since a plural description doesn’t make much sense for + id="dx1-5020"> key. Since a plural description doesn’t make much sense for multi-paragraph descriptions, the default behaviour with glossaries-extra’s + id="dx1-5021">’s \longnewglossaryentry is to simply leave the plural description unset unless explicitly set using the descriptionplural key. The key. The glossaries.sty version of this command sets the description’s plural form to the same as the singular.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 command (defined through the index package option) is modified + id="dx1-5030"> package option) is modified so that the category defaults to index. The . The \newacronym command is modified + id="dx1-5032"> command is modified to use the new abbreviation interface provided by glossaries-extra. (See §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 @@ -1546,28 +1661,28 @@ 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. -

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

    +

    +

    You will need at least version 2.20 of makeglossaries or at least version 1.3 of the Lua alternative makeglossaries-lite.lua (both distributed with (both distributed with glossaries v4.27) to allow for this use of \makeglossaries[list]. Alternatively, use the automake option. + id="dx1-5038"> 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:

    -
    +
    \newcommand*{\glsxtrinitwrgloss}{%  
     \glsifattribute{\glslabel}{wrgloss}{after}%  
     {% @@ -1663,15 +1778,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 after to automatically use this @@ -1685,22 +1800,22 @@ class="cmtt-10">\GlsXtrSetDefaultGlsOpts\glsxtrinitwrgloss.)

    -

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

    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 @@ -1726,13 +1841,13 @@ class="cmtt-10">\gls or \glslink. Remember that the value will still need to be a valid location according to the rules of whichever indexing application you use. -

    For example, suppose the file

    For example, suppose the file suppl.tex contains:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \newglossaryentry{sample}{name={sample},description={an example}} @@ -1743,7 +1858,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 -

    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \makeglossaries @@ -1764,11 +1879,11 @@ example:  
    \glsadd[thevalue={S.2}]{sample}  
    \end{document}
    -

    (By placing

    (By placing \glsadd at the end of the document, it adds the supplementary location to the end of the location list, although the ordering may be changed by the indexing application depending on its location collation settings.) -

    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 externallocation to the location of the PDF file. For example: @@ -1776,21 +1891,21 @@ class="cmss-10">externallocation -

    +
    \glssetcategoryattribute{supplemental}{externallocation}{suppl.pdf}  
    \newglossaryentry{sample}{category=supplemental,  
     name={sample},description={an example}}
    -

    Next you need to add

    Next you need to add 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.
    -

    -

    The value of the

    +

    +

    +

    Top

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

    +

    The value of the see key is now saved as a field. This isn’t the case with key is now saved as a field. This isn’t the case with glossaries, where the see attribute is simply used to directly write a line to the corresponding + id="dx1-7002"> value is simply used to directly write a line to the corresponding glossary file and is then discarded. This is why the see key can’t be used + id="dx1-7003"> key can’t be used before \makeglossaries (since the file hasn’t been opened yet). It’s also the + id="dx1-7004"> (since the file hasn’t been opened yet). It’s also the reason why the see key doesn’t have any effect when used in entries that + id="dx1-7005"> key doesn’t have any effect when used in entries that are defined in the document environment. Since the value isn’t saved, it’s + id="dx1-7006"> environment. Since the value isn’t saved, it’s not available when the .glsdefs file is created at the end of the document and so isn’t available at the start of the document environment on the next + id="dx1-7008"> 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 was set to false. +

    As a by-product of this enhancement, the see key will now work for entries + id="dx1-7012"> key will now work for entries defined in the document environment, but it’s still best to define entries in the + id="dx1-7013"> environment, but it’s still best to define entries in the preamble, and the see key still can’t perform any indexing before the file has been + id="dx1-7015"> key still can’t perform any indexing before the file has been opened by \makeglossaries. Note that glossaries v4.24 introduced the seenoindex + id="dx1-7016"> package option, which can be used to suppress the error when the see key + id="dx1-7017"> key is used before \makeglossaries, so seenoindex=ignore will allow the will allow the see + id="dx1-7019"> 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  \glsxtruseseeformat{tag}{xr list}

    - - - -

    +

    where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field (if + id="dx1-7022"> field (if non-empty). By default, this just does \glsseeformat[tagxr list}{}, which is how the cross-reference is displayed in the number list. Note that \glsxtrusesee does nothing if the see field hasn’t been set for the entry given by + id="dx1-7024"> field hasn’t been set for the entry given by ⟨label⟩. -

    Suppose you want to suppress the number list using

    Suppose you want to suppress the number list using nonumberlist. This + id="dx1-7026">. This will automatically prevent the cross-references from being displayed. The seeautonumberlist package option will automatically enable the number list for entries + id="dx1-7027"> package option will automatically enable the number list for entries that have the see key set, but this will also show the rest of the number + id="dx1-7029"> 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: @@ -1947,51 +2067,193 @@ example:

    -
    +
    \renewcommand*{\glsxtrpostdescgeneral}{%  
     \ifglshasfield{see}{\glscurrententrylabel}  
     {, \glsxtrusesee{\glscurrententrylabel}}%  
     {}%  
    }
    -

    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 seealso key. Unlike see, this doesn’t have an +optional part for the textual tag. The syntax seealso={xr-labels} works in +much the same way as using see=[\seealsoname]{xr-labels} but the +information is stored in a separate field. If you need a different tag, use the see key +instead (or redefine \seealsoname or \glsxtruseseealsoformat, described +below). +

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

    -

    Top

    2.2 +\renewcommand*{\glsxtrpostdescgeneral}{% + 
     \ifglshasfield{see}{\glscurrententrylabel} + 
     {, \glsxtrusesee{\glscurrententrylabel}}% + 
     {}% + 
     \ifglshasfield{seealso}{\glscurrententrylabel} + 
     { (\glsxtruseseealso{\glscurrententrylabel})}% + 
     {}% + 
    } +

    +

    +

    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 key. There’s +no corresponding command to access the see field. If you really need to access it, you +can use commands like \glsxtrfielduse, but remember that it may start with +[tag], so it can’t be automatically treated as a simple comma-separated +list. +

    The base glossaries package provides \glsseelist, which requires a +comma-separated list of labels as the argument. The argument isn’t fully expanded, +so it’s not suitable to use, for example, \glsxtrseealsolabels{label} as the +argument. For convenience, glossaries-extra provides +


    \glsxtrseelist  \glsxtrseelist{xr list}

    +

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

    The seealso key implements the automatic indexing using +


    \glsxtrindexseealso  \glsxtrindexseealso{label}{xr list}

    +

    +which just does

    +
    +\glssee[\seealsoname]{label}{xr list} +
    +
    unless the xindy option is used with 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 line in the glossary). This text is referred to as the “link-text” regardless of 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 link-text by commands like + id="dx1-8002">) used in the link-text by commands like \gls, , \glsxtrfull, , \glsxtrshort and and \glsxtrlong (but not commands like + id="dx1-8007"> (but not commands like \glslink, , \glsfirst and and \glstext) is changed by glossaries-extra to test for regular entries, which are determined as follows: @@ -1999,56 +2261,53 @@ entries, which are determined as follows:

    • If an entry is assigned to a category that has the regular attribute set (see attribute set (see §5 Categories), the entry is considered a regular entry, even if it has a value for the short key. In this case key. In this case \glsentryfmt uses \glsgenentryfmt + id="dx1-8012"> (provided by glossaries), which uses the first (or (or firstplural) value on ) value on first use and the text (or (or plural) value on subsequent use. + id="dx1-8017">) value on subsequent use.
    • An entry that doesn’t have a value for the short key is assumed to + id="dx1-8018"> key is assumed to be a regular entry, even if the regular attribute isn’t set to “true” + id="dx1-8019"> attribute isn’t set to “true” (since it can’t be an abbreviation without the short form). In this case \glsentryfmt uses \glsgenentryfmt. + id="dx1-8020">.
    • If an entry does has a value for the short key and hasn’t been marked as + id="dx1-8021"> key and hasn’t been marked as a regular entry through the regular attribute, it’s not considered a regular - - - + id="dx1-8022"> attribute, it’s not considered a regular entry. In this case \glsentryfmt uses \glsxtrgenabbrvfmt (defined by + id="dx1-8023"> (defined by glossaries-extra) which is governed by the abbreviation style (see §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 now puts \glsgenentry in the argument of + id="dx1-8025"> 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 @@ -2079,42 +2338,42 @@ you can redefine \glsxtrregularfont. This is more precise than changing \glstextformat which will be applied to all linking commands for all entries. -

    For example: + id="dx1-8027"> which will be applied to all linking commands for all entries. +

    For example:

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

    -
    +
    \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifcategory{\glslabel}{general}{\textsf{#1}}{#1}}
    -

    or query the category attribute: +

    or query the category attribute:

    -
    +
    \glssetcategoryattribute{general}{font}{sf}  
    \renewcommand*{\glsxtrregularfont}[1]{%  
     \glsifattribute{\glslabel}{font}{sf}{\textsf{#1}}{#1}}
    -

    or use the attribute to store the control sequence name: +

    or use the attribute to store the control sequence name:

    -
    +
    \glssetcategoryattribute{general}{font}{textsf}  
    \glssetcategoryattribute{acronym}{font}{emph}  
    \renewcommand*{\glsxtrregularfont}[1]{% @@ -2123,49 +2382,49 @@ category:  
      {#1}%  
    }
    -

    (Remember the category and attribute settings will only queried here for

    (Remember the category and attribute settings will only queried here for regular + id="dx1-8028"> entries, so if the abbreviation style for the acronym category in the above example + id="dx1-8029"> category in the above example changes the regular attribute to “false”, \glsxtrregularfont will no longer apply.) -

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

    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 @@ -2174,32 +2433,32 @@ class="cmtt-10">\glsentrytext, \glsaccesstext or \glsxtrp (§2.5 §2.6 Nested Links) instead.
    -

    -

    By default

    +

    By default \glsxtrpostlink just does \glsxtrpostlinkcategory if + id="dx1-8035"> if it exists, where ⟨category⟩ is the category label for the current entry. (For example, for the general category, 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 is defined the hook will do that and then insert a + id="dx1-8037"> is defined the hook will do that and then insert a full stop with the space factor adjusted to match the end of sentence. If \glsxtrpostlinkcategory hasn’t been defined, the space factor is adjusted to match + id="dx1-8038"> hasn’t been defined, the space factor is adjusted to match the end of sentence. This means that if you have, for example, an entry that ends with a full stop, a redundant following full stop will be discarded and the space factor @@ -2208,163 +2467,163 @@ with a full stop, a redundant following full stop will be discarded and the spac adjusted (in case the entry is in uppercase) unless the entry is followed by additional material, in which case the following full stop is no longer redundant and needs to be reinserted. -

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

    For example, suppose you want to append the description in parentheses on first use for entries in the symbol category: + id="dx1-8043"> category:

    -
    +
    \newcommand*{\glsxtrpostlinksymbol}{%  
      \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- within the post-link-text hook as by this point the first use flag will have been unset. Instead you can use -



    \glsxtrifwasfirstuse  \glsxtrifwasfirstuse{true}{false}

    -

    +

    This will do ⟨true⟩ if the last used entry was the first use for that entry, otherwise it + id="dx1-8050">first use for that entry, otherwise it will do ⟨false⟩. (Requires at least glossaries v4.19 to work properly.) This command is locally set by commands like \gls, so don’t rely on it outside of the post-link-text + id="dx1-8051">link-text hook. -

    Note that commands like

    Note that commands like \glsfirst and and \glsxtrfull fake first use for the + id="dx1-8053"> fake first use for the benefit of the post-link-text hooks by setting link-text hooks by setting \glsxtrifwasfirstuse to \@firstoftwo. (Although, depending on the styles in use, they may not exactly match the text produced by \gls-like commands on first use.) However, the + id="dx1-8056">-like commands on first use.) However, the short-postfootnote style alters style alters \glsxtrfull so that it fakes non-first use otherwise + id="dx1-8059">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 link-text +

    +

    For example, if you want to place the description in a footnote after the link-text on first use for the first use for the general category: + id="dx1-8062"> category:

    -
    +
    \newcommand*{\glsxtrpostlinkgeneral}{%  
      \glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}%  
    }
    -

    -

    The

    +

    The short-postfootnote abbreviation style uses the post- 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: -


    etc with: +


    \GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts{options}

    -

    +

    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 number list. These defaults may be overridden by other settings (such as category attributes) in addition to any settings passed in the option argument of commands like \glslink and \gls. -

    Note that if you don’t want

    Note that if you don’t want any indexing, just omit \makeglossaries and \printglossaries (or analogous commands). If you want to adjust the default for wrgloss, it’s better to do this by redefining , it’s better to do this by redefining \glsxtrinitwrgloss + id="dx1-8070"> instead. -

    Commands like

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



    \GlsXtrSetAltModifier  \GlsXtrSetAltModifier{char}{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:

    -
    +
    \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 @@ -2409,23 +2668,23 @@ 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  \glsnoidxdisplayloc{prefix}{} class="cmtt-10">{location}

    -

    +

    This command is provided by glossaries, but is modified by glossaries-extra to check @@ -2446,53 +2705,53 @@ 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  \glsxtrdisplaysingleloc{format}{location}

    -

    +

    otherwise it uses -



    \glsxtrdisplaystartloc  \glsxtrdisplaystartloc{format}{location}

    -

    +

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



    \glsxtrdisplayendloc  \glsxtrdisplayendloc{format}{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  \glsxtrdisplayendlochook{format}{location}

    -

    +

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

    This means that the list +

    This means that the list

    -
    +
    \glsnoidxdisplayloc{}{page}{(textbf}{1},  
    \glsnoidxdisplayloc{}{page}{textbf}{1},  
    \glsnoidxdisplayloc{}{page}{)textbf}{1}.
    -

    doesn’t display any differently from +

    doesn’t display any differently from

    -
    +
    \glsnoidxdisplayloc{}{page}{textbf}{1},  
    \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.3

    Top

    2.4 Entry Counting Modifications

    -

    The

    The \glsenableentrycount command is modified to allow for the command is modified to allow for the entrycount + id="dx1-9002"> attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but you also need to set the appropriate attribute (see §5 Categories). -

    For example, instead of just doing: +

    For example, instead of just doing:

    -
    +
    \glsenableentrycount
    -

    you now need to do: +

    you now need to do:

    -
    +
    \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 + id="dx1-9003"> 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 Entry Counting. -

    +

    -

    Top

    2.4

    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 glossaries package allows the package allows the plural key to be optional when + id="dx1-10002"> key to be optional when defining entries. In some cases a plural may not make any sense (for example, the term is a symbol) and in some cases the plural may be identical to the singular. -

    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 sets lets the package sets lets the plural + id="dx1-10004"> field default to the value of the text field with field with \glspluralsuffix appended. This + id="dx1-10006"> appended. This command is defined to be just the letter “s”. This means that the majority of terms don’t need to have the plural supplied as well, and you only need to use it for the + id="dx1-10007"> 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 + id="dx1-10008"> field will always need to be supplied, where needed. -

    There are other plural fields, such as

    There are other plural fields, such as firstplural, , longplural and and shortplural. Again, if + id="dx1-10011">. Again, if you are using a language that doesn’t have a simple suffix rule, you’ll have to supply the plural forms if you need them (and if a plural makes sense in the context). -

    If these fields are omitted, the

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

    + id="dx1-10012"> package follows these rules:

    • If firstplural is missing, then is missing, then \glspluralsuffix is appended to the first + id="dx1-10014"> field, if that field has been supplied. If the first field hasn’t been supplied + id="dx1-10015"> field hasn’t been supplied but the plural field has been supplied, then the field has been supplied, then the firstplural field defaults to + id="dx1-10017"> field defaults to the plural field. If the field. If the plural field hasn’t been supplied, then both the field hasn’t been supplied, then both the plural + id="dx1-10020"> and firstplural fields default to the fields default to the text field (or field (or name, if no , if no text field) with + id="dx1-10024"> field) with \glspluralsuffix appended. @@ -2682,49 +2941,49 @@ class="cmtt-10">\glspluralsuffix appended.
    • If the longplural field is missing, then field is missing, then \glspluralsuffix is appended to the long field, if the field, if the long field has been supplied. + id="dx1-10027"> field has been supplied.
    • If the shortplural field is missing then, field is missing then, with the base glossaries acronym mechanism, \acrpluralsuffix is appended to the is appended to the short field. + id="dx1-10031"> field.
    -

    This

    This last case is changed with glossaries-extra. With this extension package, the shortplural field defaults to the field defaults to the short field with field with \abbrvpluralsuffix appended + id="dx1-10034"> appended unless overridden by category attributes. This suffix command is set by the abbreviation styles. This means that every time an abbreviation style is implemented, \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 -

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

    So if you want to completely strip all the plural suffixes used for abbreviations then +

    So if you want to completely strip all the plural suffixes used for abbreviations then you need to redefine \glsxtrabbrvpluralsuffix not \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 which + id="dx1-10036"> which uses the suffix

    -
    +
    '\abbrvpluralsuffix
    -

    That is, an apostrophe followed by

    That is, an apostrophe followed by \abbrvpluralsuffix is appended. The second attribute is noshortplural which suppresses the suffix and simply sets which suppresses the suffix and simply sets shortplural to the + id="dx1-10038"> to the same as short. -

    + id="dx1-10039">. +

    -

    Top

    2.5

    Top

    2.6 Nested Links

    -

    Complications arise when you use

    Complications arise when you use \gls in the value of the in the value of the name field (or field (or text or or first + id="dx1-11004"> fields, if set). This tends to occur with abbreviations that extend other abbreviations. For example, SHTML is an abbreviation for SSI enabled HTML, where SSI is an abbreviation for Server Side Includes and HTML is an abbreviation for Hypertext Markup Language. -

    Things can go wrong if we try the following with the

    Things can go wrong if we try the following with the glossaries package:

    -
    +
    \newacronym{ssi}{SSI}{Server Side Includes}  
    \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. The first letter upper casing commands, such as \Gls, won’t work for the + id="dx1-11007">, won’t work for the shtml entry on first use if the long form is displayed before the short form (which is the default abbreviation style). This will attempt to do -
      +
      \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

      -
      +
      \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 \GLS. + id="dx1-11009">.

    2. The long and abbreviated forms accessed through \glsentrylong and + id="dx1-11012"> and \glsentryshort are no longer expandable and so can’t be used be used in + id="dx1-11013"> are no longer expandable and so can’t be used be used in contexts that require this, such as PDF bookmarks.
    3. The nested commands may end up in the sort key, which will confuse the + id="dx1-11016"> key, which will confuse the indexing.
    4. The shtml entry produces inconsistent results depending on whether the ssi @@ -2864,18 +3123,18 @@ class="cmtt-10">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 @@ -2885,41 +3144,41 @@ 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:

      -
      +
      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: @@ -2927,22 +3186,22 @@ 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 instead of displaying “(SHTML)” at the end of the first use, it now displays “(HTML)”, since \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: @@ -2950,27 +3209,27 @@ 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 \textsmaller), + id="dx1-11023">), this will produce an odd result.

    5. Each time the shtml entry is used, the html entry will also be indexed and marked as used, and on first use this will happen to both the ssi and html @@ -2978,86 +3237,86 @@ class="cmtt-10">html helpful to the reader.
    6. If hyperref is in use, you’ll get nested hyperlinks and there’s no consistent way + id="dx1-11029"> is in use, you’ll get nested hyperlinks and there’s no consistent way of dealing with this across the available PDF viewers. If on the first + id="dx1-11030">first use case, the user clicks on the “HTML” part of the “SSI enabled HTML (SHTML)” link, they may be directed to the HTML entry in the glossary or they may be directed to the SHTML entry in the glossary.
    -

    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 or \glsentryshort in the definition of other entries + id="dx1-11032"> in the definition of other entries (although that doesn’t fix the first problem). Alternatively use something like:

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

    with

    with glossaries or:

    -
    +
    \newabbreviation  
     [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 \glsdesc). Note that replacing ). Note that replacing \gls with \acrshort in the original example may fix the first 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:

    -
    +
    \setabbreviationstyle{long-short-sc}  
    \newabbreviation{ssi}{ssi}{server-side includes}  
    \newabbreviation{html}{html}{hypertext markup language}  
    \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 + id="dx1-11035"> in a field that may be included within some link-text, glossaries-extra patches internals used by the linking commands so that if \gls (or plural or case changing variants) occurs in the link-text it will + id="dx1-11037">link-text it will behave as though you used \glstext[hyper=false,noindex] instead. Grouping is also added so that, for example, when \gls{shtml} is used for the first time the long @@ -3066,19 +3325,19 @@ form

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

    is treated as +

    is treated as

    -
    +
    {\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 2. Problem 3 usually won’t be an issue as most abbreviation styles set the sort + id="dx1-11039"> key to the short form, so using these commands in the long form but not the short form will only affect entries with a style that sorts according to the long form (such as 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 + id="dx1-11041"> or \acrlong will be temporarily redefined to just use

    + id="dx1-11042"> will be temporarily redefined to just use

    {\glsentrylong{label}}
    (or case-changing versions). Similarly the short form commands, such as \glsxtrshort or or \acrshort will use will use \glsentryshort in the argument of either + id="dx1-11046"> in the argument of either \glsabbrvfont (for \glsxtrshort) 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 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:

    -
    +
    \newabbreviation{shtml}{SHTML}{\glsxtrshort{ssi} enabled  
    \glsxtrshort{html}}
    -

    then the

    then the 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 abbreviation style that governs \glsabbrvfont will be set for will be set for \glsxtrshort. Note + id="dx1-11051">. Note that \acrshort doesn’t set the abbreviation style. -

    Alternatively you can use: -


    Alternatively you can use: +


    \glsxtrp  \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 @@ -3233,167 +3492,167 @@ href="#sec:headtitle">Entries in Sectioning Titles, Headers, Captions and Conten hook is also suppressed and extra grouping is added. It automatically sets hyper to to false and noindex to to true. If you want to change this, you can use -



    \glsxtrsetpopts  \glsxtrsetpopts{options}

    -

    +

    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

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

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

    -

    For example, +

    +

    For example,

    -
    +
    \glsxtrp{short}{ssi}
    -

    is equivalent to +

    is equivalent to

    -
    +
    {\let\glspostlinkhook\relax  
     \glsxtrshort[hyper=false,noindex]{ssi}[]%  
    }
    -

    in the main body of the document or +

    in the main body of the document or

    -
    +
    {\let\glspostlinkhook\relax  
     \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

    -
    +
    {\glsxtrheadshort{ssi}}
    -

    (which recognises the

    (which recognises the headuc attribute.) -

    If attribute.) +

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

    There are similar commands -


    There are similar commands +


    \Glsxtrp  \Glsxtrp{field}{label}

    -

    +

    for first letter upper case and -



    \Glsxtrp  \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 or \Glstext, (either + id="dx1-11064">, (either all caps or first letter upper casing) don’t use any of the linking commands, such as \gls or or \glstext, in the definition of entries for any of the fields that may be used + id="dx1-11066">, 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

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

    -
    +
    \documentclass{report}  
    \usepackage[utf8]{inputenc}  
    \usepackage[T1]{fontenc} @@ -3418,20 +3677,20 @@ class="cmti-10">really need nested commands, the safest method is  
    \printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    2.6

    Top

    2.7 Acronym Style Modifications

    -

    The

    The glossaries-extra package provides a new way of dealing with abbreviations and redefines \newacronym to use to use \newabbreviation (see §3 glossaries-extra is do just add

    -
    +
    \setabbreviationstyle[acronym]{long-short}
    -

    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

    -
    +
    \documentclass{article}  
    \usepackage[acronym,nopostdot,toc]{glossaries}  
    \makeglossaries @@ -3466,13 +3725,13 @@ class="cmss-10">glossaries  
    \printglossaries  
    \end{document}
    -

    can be easily adapted to use

    can be easily adapted to use glossaries-extra:

    -
    +
    \documentclass{article}  
    \usepackage[acronym]{glossaries-extra}  
    \makeglossaries @@ -3483,7 +3742,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


    @@ -3515,41 +3774,41 @@ class="cmtt-10">\setabbreviationstyle[⟨category]{new-style-name}
    +class="cmtt-10">}
    + id="dx1-12004">

    + id="dx1-12006">

    + id="dx1-12010">

    + id="dx1-12012">

    + id="dx1-12014">

    + id="dx1-12016">

    + id="dx1-12018">

    + id="dx1-12020">

    + id="dx1-12024">

    + id="dx1-12026">

    + id="dx1-12028">

    + id="dx1-12030">

    + id="dx1-12032">

    + id="dx1-12034">

    + id="dx1-12036">

    + id="dx1-12038">

    + id="dx1-12040">

    + id="dx1-12042">

    Old Style Name

    New Style Name

    long-sc-short

    long-short-sc

    long-sm-short

    long-short-sm

    long-sp-short

    long-short

    with \renewcommand{#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

    with \renewcommand{#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

    + id="dx1-12044">


    -

    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 @@ -3730,226 +3989,226 @@ 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 type. The original . The original glossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands. -

    If you use

    If you use \RestoreAcronyms, don’t use any of the commands provided by glossaries-extra intended for abbreviations (such as \glsxtrshort or or \glsfmtshort) + id="dx1-12048">) with entries defined via \newacronym as it will cause unexpected results. + id="dx1-12049"> as it will cause unexpected results.
    -

    -

    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, then it’s best to either stick with just + id="dx1-12050">, then it’s best to either stick with just glossaries for that document or define an equivalent abbreviation style with \newabbreviationstyle. (See . (See §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 + id="dx1-12053"> 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 (such as long-short) + id="dx1-12056">) can easily be changed to use \glsacspace with

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

    -

    The

    +

    The first use acronym font command -



    \firstacronymfont{text}

    -

    +

    is redefined to use the first use abbreviation font command first use abbreviation font command \glsfirstabbrvfont. + id="dx1-12059">. 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. + id="dx1-12060">. This will be reset if you use \RestoreAcronyms.

    -

    Top

    2.7

    Top

    2.8 Glossary Style Modifications

    -

    The default value of

    The default value of \glslistdottedwidth is changed so that it’s set at the start + id="dx1-13001"> 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 glossaries package tries to determine the group title from its label by first + id="dx1-13002"> package tries to determine the group title from its label by first checking if \labelgroupname exists. If it doesn’t exist, then the title is assumed to be the same as the label. For example, when typesetting the “A” letter group, glossaries + id="dx1-13003"> first checks if \Agroupname exists. This could potentially cause conflict with another package that may have some other meaning for \Agroupname, so glossaries-extra first + id="dx1-13004"> first checks for the existence of the internal command \glsxtr@grouptitle@label⟩ which shouldn’t clash with another package. You can set the group title using -



    \glsxtrsetgrouptitle  \glsxtrsetgrouptitle{label}{title}

    -

    +

    For example:

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

    -

    +

    +

    -

    Top

    2.7.1

    Top

    2.8.1 Style Hooks

    -

    The commands

    The commands \glossentryname and and \glossentrydesc are modified to take into + id="dx1-14002"> are modified to take into account the glossname, , glossdesc and and glossdescfont attributes (see attributes (see §5 Categories). This means you can make simple case-changing modifications to the name and description without defining a new glossary style. -

    There is a hook after

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


    : +


    \glsxtrpostnamehook  \glsxtrpostnamehook{label}

    -

    +

    By default this checks the indexname attribute. If the attribute exists for the + id="dx1-14009"> attribute. If the attribute exists for the category to which the label belongs, then the name is automatically indexed using -



    \glsxtrdoautoindexname{label}{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 \glsxtrpostnamecategory⟩ if it exists. You can use \glscurrententrylabel to + id="dx1-14011"> to obtain the entry label with the definition of this command. For example, suppose you are using a glossary style the doesn’t display the symbol, you can insert the symbol after the name for a particular category, say, the “symbol” @@ -3958,25 +4217,25 @@ category:

    -
    +
    \newcommand*{\glsxtrpostnamesymbol}{\space  
     (\glsentrysymbol{\glscurrententrylabel})}
    -

    -

    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 + id="dx1-14013"> 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 ⟨category⟩ is the category label associated with th \glsxtrpostdescgeneral for entries with the category set to general or + id="dx1-14014"> or \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 + id="dx1-14017"> category, then you could 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 \glsxtrpostdescription. class="cmtt-10">\glspostdescription to do nothing instead of using the nopostdot option to suppress the terminating full stop.) See §2.7.3 The + id="dx1-14018"> option to suppress the terminating full stop.) See §2.8.3 The glossaries-extra-stylemods Package to patch the predefined styles provided by glossaries that are missing \glspostdescription.
    -

    -

    +

    +

    -

    Top

    2.7.2

    Top

    2.8.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 nonumberlist option + id="dx1-15003"> option redefines \glossaryentrynumbers so that it doesn’t display the number list, but it + id="dx1-15004">number list, but it still saves the number list in case it’s required. -

    If you want to suppress the number list always use the number list in case it’s required. +

    If you want to suppress the number list always use the nonumberlist option + id="dx1-15007"> option instead of redefining \glossaryentrynumbers to do nothing.
    -

    -

    If you want to, for example, change the font for the entire number list +

    +

    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 number list. This +

    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  \GlsXtrEnablePreLocationTag{page}{pages}

    -

    +

    where ⟨page⟩ is the text to display if the number list only contains a single location and + id="dx1-15011">number list only contains a single location and ⟨pages⟩ is the text to display otherwise. For example:

    -
    +
    \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 + id="dx1-15013"> 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.7.3 The

    Top

    2.8.3 The glossaries-extra-stylemods Package

    -

    As from v1.02,

    As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that + id="dx1-16001"> that will redefine the predefined styles to include the post-description hook (for those that are missing it). You will need to make sure the styles have already been defined before loading glossaries-extra. For example:

    -
    +
    \usepackage{glossaries-extra}  
    \usepackage{glossary-longragged}  
    \usepackage{glossaries-extra-stylemods}
    -

    Alternatively you can load

    Alternatively you can load glossary-name.sty at the same time by passing ⟨name⟩ as a package option to glossaries-extra-stylemods. For example: + id="dx1-16002">. For example:

    -
    +
    \usepackage{glossaries-extra}  
    \usepackage[longragged]{glossaries-extra-stylemods}
    -

    Another option is to use the

    Another option is to use the stylemods key when you load key when you load glossaries-extra. You can omit a value if you only want to use the predefined styles that are automatically loaded by glossaries (for example, the long3col style): + id="dx1-16004"> style):

    -
    +
    \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 + id="dx1-16005"> may be a comma-separated list of the style package 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:

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

    -

    Note that the

    +

    Note that the inline style is dealt with slightly differently. The original definition + id="dx1-16006"> style is dealt with slightly differently. The original definition provided by the glossary-inline package uses package uses \glspostdescription at the end of the glossary (not after each entry description) within the definition of \glspostinline. @@ -4214,152 +4473,152 @@ class="cmtt-10">\glsxtrpostdescription (not \glspostdescription). This means that the modified inline style isn’t affected by the style isn’t affected by the nopostdot option, but the post-description + id="dx1-16009"> option, but the post-description category hook can still be used. -

    As from version 1.05, the

    As from version 1.05, the glossaries-extra-stylemods package provides some additional commands for use with the alttree style to make it easier to modify. These + id="dx1-16010"> style to make it easier to modify. These commands are only defined if the glossary-tree package has already been loaded, + id="dx1-16011"> package has already been loaded, which is typically the case unless the notree option has been used when loading + id="dx1-16012"> option has been used when loading glossaries. -



    \eglssetwidest  \eglssetwidest[level]{name}

    -

    +

    This is like \glssetwidest (provided by glossary-tree) but performs a protected + id="dx1-16014">) but performs a protected expansion on ⟨name⟩. This has a localised effect. For a global setting, use -



    \xglssetwidest  \xglssetwidest[level]{name}

    -

    +

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

    The command

    The command \glsfindwidesttoplevelname provided by glossary-tree has a + id="dx1-16018"> has a CamelCase synonym: -



    \glsFindWidestTopLevelName  \glsFindWidestTopLevelName[glossary list]

    -

    +

    Similar commands are also provided: -



    \glsFindWidestUsedTopLevelName  \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 alttree style occur at the end of the document. + id="dx1-16021"> style occur at the end of the document. This command should be placed just before the start of the glossary. (Alternatively, place it at the end of the document and save the value in the auxiliary file for the next run.) -



    \glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list]

    -

    +

    This is like the previous command but if doesn’t check the parent key. This is useful if + id="dx1-16023"> key. This is useful if all levels should have the same width for the name. -



    \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  \glsFindWidestUsedAnyNameSymbol [glossary list]{register}

    -

    +

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



    \glsFindWidestAnyNameSymbol  \glsFindWidestAnyNameSymbol[glossary list]{register}

    -

    +

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



    \glsFindWidestUsedAnyNameSymbolLocation  \glsFindWidestUsedAnyNameSymbolLocation [symbol register}{location register}

    -

    +

    This is like \glsFindWidestUsedAnyNameSymbol but also measures the number list. This requires \glsentrynumberlist (see the (see the glossaries user manual). The length of the widest symbol is stored in ⟨symbol register⟩ and the length of the widest number + id="dx1-16032">number list is stored in ⟨location register⟩. -



    \glsFindWidestAnyNameSymbolLocation  \glsFindWidestAnyNameSymbolLocation [symbol register}{location register}

    -

    +

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



    \glsFindWidestUsedAnyNameLocation  \glsFindWidestUsedAnyNameLocation [}

    -

    +

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



    \glsFindWidestAnyNameLocation  \glsFindWidestAnyNameLocation[glossary 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  \glsxtralttreeSymbolDescLocation {label}{number list}

    -

    +

    for top-level entries and -



    \glsxtralttreeSubSymbolDescLocation  \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 + id="dx1-16040"> 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 + id="dx1-16043"> style, see the documented code (glossaries-extra-code.pdf). For examples, see the accompanying sample files 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 @@ -4536,19 +4795,19 @@ replaced by an apostrophe, such as “don’t”). The “acrony class="cmss-10">glossaries package is misnamed as it’s more often than not used for initialisms instead. Acronyms tend not to be expanded on first use (although they may need 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  \newabbreviation[options]{}{long}

    -

    -

    This sets the

    +

    This sets the category key to key to abbreviation by default, but that value may be overridden in ⟨options⟩. The category may have attributes that modify the way abbreviations are defined. For example, the insertdots attribute will automatically + id="dx1-17004"> attribute will automatically insert full stops (periods) into ⟨short⟩ or the noshortplural attribute will set the default + id="dx1-17005"> attribute will set the default value of the shortplural key to just ⟨ key to just ⟨short⟩ (without appending the plural suffix). See §5 Categories for further details. -

    See

    See §2.5 §2.6 Nested Links regarding the pitfalls of using commands like \gls or + id="dx1-17007"> or \glsxtrshort within ⟨ 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 command provided by the glossaries package is redefined by glossaries-extra to use \newabbreviation with the category set to set to acronym (see also §2.6 §2.7 Acronym Style Modifications) so -



    \newacronym  \newacronym[options]{short}{long}

    -

    +

    is now equivalent @@ -4648,122 +4907,122 @@ class="cmtt-10">}
    -

    The

    The \newabbreviation command is superficially similar to the glossaries package’s \newacronym but you can apply different styles to different categories. The default style is short-nolong for entries in the for entries in the acronym category and category and short-long for + id="dx1-17014"> for entries in the abbreviation category. (These aren’t the same as the acronym + id="dx1-17015"> category. (These aren’t the same as the acronym styles provided by the glossaries package, although they may produce similar results.) -

    The short form is displayed within commands like

    The short form is displayed within commands like \gls using -



    \glsfirstabbrvfont  \glsfirstabbrvfont{short-form}

    -

    +

    on first use and -



    \glsabbrvfont  \glsabbrvfont{short-form}

    -

    +

    for subsequent use. -

    These commands (

    These commands (\glsfirstabbrvfont and \glsabbrvfont) are reset by the abbreviation styles and whenever an abbreviation is used by commands like \gls (but not by commands like \glsentryshort) so don’t try redefining them outside of + id="dx1-17019">) so don’t try redefining them outside of an abbreviation style.
    -

    -

    If you use the

    +

    If you use the long-short style, style, \glsabbrvfont is redefine to use -



    \glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

    -

    +

    whereas the long-short-sc style redefines style redefines \glsabbrvfont to use \glsxtrscfont. If you want to use a different font-changing command you can either redefine \glsabbrvdefaultfont and use one of the base styles, such as long-short, or define a + id="dx1-17023">, or define a new style in a similar manner to the “sc”, “sm” or “em” styles. -

    Similarly the basic styles redefine

    Similarly the basic styles redefine \glsfirstabbrvfont to use -



    \glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{short-form}

    -

    +

    whereas the font modifier styles, such as long-short-sc, use their own custom + id="dx1-17025">, use their own custom command, such as \glsfirstscfont. -

    The commands that display the full form for abbreviations use

    The commands that display the full form for abbreviations use \glsfirstabbrvfont to display the short form and -



    \glsfirstlongfont  \glsfirstlongfont{long-form}

    -

    +

    to display the long form on first use or for the inline full format. Commands like + id="dx1-17027">first use or for the inline full format. Commands like \glsxtrlong use -



    \glslongfont  \glslongfont{long-form}

    -

    +

    instead. -

    As with

    As with \glsabbrvfont, this command is changed by all styles. Currently + id="dx1-17029">, this command is changed by all styles. Currently all predefined abbreviation styles, except the “long-em” (emphasize long form) versions, provided by glossaries-extra redefine \glsfirstlongfont to use -



    \glsfirstlongdefaultfont  \glsfirstlongdefaultfont{long-form}

    -

    +

    and \glslongfont to use -



    \glslongdefaultfont  \glslongdefaultfont{long-form}

    -

    -

    You can redefine these command if you want to change the font used by the long +

    +

    You can redefine these command if you want to change the font used by the long form for all your abbreviations (except for the emphasize-long styles), or you can define your own abbreviation style that provides a different format for only those abbreviations defined with that style. -

    The “long-em” (emphasize long) styles use -


    The “long-em” (emphasize long) styles use +


    \glsfirstlongemfont  \glsfirstlongemfont{long-form}

    -

    +

    instead of \glsfirstlongdefaultfont{long-form} and -



    \glslongemfont  \glslongemfont{long-form}

    -

    +

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

    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:

    -
    +
    \setabbreviationstyle{long-short}  
    \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 + id="dx1-17035">, the inserted text would be placed inside the font command for the short form (rather than the long form in the above example). -

    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 \gls and the inline full form, which is used by + id="dx1-17037"> and the inline full form, which is used by commands like \glsxtrfull. For some of the abbreviation styles, such as + id="dx1-17038">. For some of the abbreviation styles, such as long-short, the display and inline forms are the same. In the case of styles + id="dx1-17039">, the display and inline forms are the same. In the case of styles such as short-nolong or or short-footnote, the display and inline full forms are + id="dx1-17041">, 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, , long or + id="dx1-17044"> or longplural fields, which means they won’t be used within commands like + id="dx1-17045"> fields, which means they won’t be used within commands like \glsentryshort (but they are used within commands like \glsxtrshort and \glsfmtshort). Note that \glsxtrlong and the case-changing variants don’t use + id="dx1-17046"> and the case-changing variants don’t use \glsfirstlongfont.

    -

    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  \GlsXtrEnableInitialTagging{categories} @@ -4907,31 +5166,31 @@ class="cmtt-10">} 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 the glossary it’s activated for those categories that have the tagging attribute set to + id="dx1-18002"> 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 @@ -4943,38 +5202,38 @@ 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 tagging attribute will automatically be set for those + id="dx1-18005"> attribute will automatically be set for those categories. You can later set this attribute for other categories (see §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 acronym and and abbreviation categories: + id="dx1-18007"> categories:

    -
    +
    \GlsXtrEnableInitialTagging{acronym,abbreviation}{\itag}
    -

    This defines the command

    This defines the command \itag which can be used in the definitions. For example:

    -
    +
    \newacronym  
     [description={a system for detecting the location and  
     speed of ships, aircraft, etc, through the use of radio @@ -4986,27 +5245,27 @@ 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. -

    + id="dx1-18008"> 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  \setabbreviationstyle[category]{style-name}

    -

    +

    where ⟨style-name⟩ is the name of the style and ⟨category⟩ is the category label @@ -5018,20 +5277,20 @@ class="cmtt-10">abbreviation category. Some styles may automatically modify one or more of the attributes associated with the given category. For example, the long-noshort and and short-nolong styles set the styles set the regular attribute to + id="dx1-19004"> 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 is disabled by glossaries-extra. Use

    }
    instead. The original acronym interface can be restored with \RestoreAcronyms (see + id="dx1-19006"> (see §2.6 §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, + id="dx1-19007">, but don’t use the acronym commands like \acrshort (which use (which use \acronymfont). + id="dx1-19009">). The short form can be produced with: -



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

    -

    +

    (Use this instead of \acrshort.) -

    The long form can be produced with -


    .) +

    The long form can be produced with +


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

    -

    +

    (Use this instead of \acrlong.) -

    The .) +

    The inline full form can be produced with -



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

    -

    +

    (This this instead of \acrfull.) -

    As mentioned earlier, the inline full form may not necessarily match the format + id="dx1-19015">.) +

    As mentioned earlier, the inline full form may not necessarily match the format used on first use with \gls. For example, the short-nolong style only displays the + id="dx1-19017"> style only displays the short form on first use, but the full form will display the long form followed by the + id="dx1-19018">first 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  \Glsxtrshort[options]{label}[insert]

    -

    -

    First letter upper case long form: -


    +

    First letter upper case long form: +


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

    -

    -

    First letter upper case inline full form: -


    +

    First letter upper case inline full form: +


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

    -

    -

    All upper case short form: -


    +

    All upper case short form: +


    \Glsxtrshort  \GLSxtrshort[options]{label}[insert]

    -

    -

    All upper case long form: -


    +

    All upper case long form: +


    \Glsxtrlong  \GLSxtrlong[options]{]

    -

    -

    All upper case inline full form: -


    +

    All upper case inline full form: +


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

    -

    -

    Plural forms are also available. -

    Short form plurals: -


    +

    Plural forms are also available. +

    Short form plurals: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    -

    Long form plurals: -


    +

    Long form plurals: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    -

    Full form plurals: -


    +

    Full form plurals: +


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

    -

    -


    +


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

    -

    -


    +


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

    -

    -

    Be careful about using

    +

    Be careful about using \glsentryfull, \Glsentryfull, \glsentryfullpl and @@ -5333,24 +5592,24 @@ class="cmtt-10">\Glsentryfullpl. These commands will use the currently ap than the style in use when the entry was defined. If you have mixed styles, you’ll need to use \glsxtrfull instead. Similarly for instead. Similarly for \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 shortcuts=abbreviation (or (or shortcuts=abbr). This defines the commands listed in + id="dx1-20002">). This defines the commands listed in table 3.1.

    @@ -5358,7 +5617,7 @@ href="#tab:abbrshortcuts">table 3.1. -


    @@ -5366,7 +5625,7 @@ href="#tab:abbrshortcuts">table 3.1.
    Table 3.1: Abbreviation Shortcut Commands
    +class="content">Abbreviation Shortcut Commands
    Equivalent Command style="vertical-align:baseline;" id="TBL-3-2-"> + id="dx1-20005"> + id="dx1-20007"> + id="dx1-20009"> + id="dx1-20011"> + id="dx1-20013"> + id="dx1-20015"> + id="dx1-20017"> + id="dx1-20019"> + id="dx1-20021"> + id="dx1-20023"> + id="dx1-20025"> + id="dx1-20027"> + id="dx1-20029"> + id="dx1-20031"> + id="dx1-20033"> + id="dx1-20035"> + id="dx1-20037"> + id="dx1-20039"> + id="dx1-20041"> + id="dx1-20043">
    \ab \cgls
    \abp \cglspl
    \as \glsxtrshort
    \asp \glsxtrshortpl
    \al \glsxtrlong
    \alp \glsxtrlongpl
    \af \glsxtrfull
    \afp \glsxtrfullpl
    \As \Glsxtrshort
    \Asp \Glsxtrshortpl
    \Al \Glsxtrlong
    \Alp \Glsxtrlongpl
    \Af \Glsxtrfull
    \Afp \Glsxtrfullpl
    \AS \GLSxtrshort
    \ASP \GLSxtrshortpl
    \AL \GLSxtrlong
    \ALP \GLSxtrlongpl
    \AF \GLSxtrfull
    \AFP \GLSxtrfullpl
    \newabbr \newabbreviation
    + id="dx1-20045">

    -

    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 uses \glsgenentryfmt) and those that don’t treat the + id="dx1-21002">) and those that don’t treat the abbreviation as a regular entry (so that \gls uses uses \glsxtrgenabbrvfmt). -

    The regular entry abbreviation styles set the ). +

    The regular entry abbreviation styles set the regular attribute to “true” for the + id="dx1-21005"> attribute to “true” for the category assigned to each abbreviation with that style. This means that on first use, \gls uses the value of the uses the value of the first field and on subsequent use field and on subsequent use \gls uses the value of the + id="dx1-21009"> uses the value of the text field (and analogously for the plural and case-changing versions). The field (and analogously for the plural and case-changing versions). The short and + id="dx1-21011"> and long fields are set as appropriate and may be accessed through commands like + id="dx1-21012"> fields are set as appropriate and may be accessed through commands like \glsxtrshort. -

    The other abbreviation styles don’t modify the . +

    The other abbreviation styles don’t modify the regular attribute. The attribute. The first + id="dx1-21015"> and text fields (and their plural forms) are set and can be accessed through + id="dx1-21016"> fields (and their plural forms) are set and can be accessed through commands like \glsfirst, but they aren’t used by commands like \gls, which + id="dx1-21017">, which instead use the short form (stored in the short key) and the display full + id="dx1-21018"> key) and the display full format (through commands like \glsxtrfullformat that are defined by the + id="dx1-21019"> that are defined by the style). -

    In both cases, the first use of

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

    For the “sc” styles that use (and likewise for the plural and case-changing versions). +

    For the “sc” styles that use \textsc, be careful about your choice of fonts as + id="dx1-21023">, be careful about your choice of fonts as some only have limited support. For example, you may not be able to combine bold and small-caps. I recommend that you at least use the fontenc package with the package with the T1 option or something similar.
    -

    -

    The “sc” styles all use -


    +

    The “sc” styles all use +


    \glsxtrscfont  \glsxtrscfont{text}

    -

    +

    which is defined as

    -
    +
    \newcommand*{\glsxtrscfont}[1]{\textsc{#1}}
    -

    and -


    and +


    \glsxtrfirstscfont  \glsxtrfirstscfont{text}

    -

    +

    which is defined as

    -
    +
    \newcommand*{\glsxtrfirstscfont}[1]{\glsxtrscfont{#1}}
    -

    The default plural suffix for the short form is set to -


    The default plural suffix for the short form is set to +


    \glsxtrscsuffix  \glsxtrscsuffix

    -

    +

    This just defined as

    -
    +
    \newcommand*{\glsxtrscsuffix}{\glstextup{\glspluralsuffix}}
    -

    The

    The \glstextup command is provided by command is provided by glossaries and is used to switch off the small caps font for the suffix. If you override the default short plural using the shortplural key when you define the abbreviation you will need to make the + id="dx1-21029"> key when you define the abbreviation you will need to make the appropriate adjustment if necessary. (Remember that the default plural suffix behaviour can be modified through the use of the aposplural and and noshortplural + id="dx1-21031"> attributes. See §5 Categories for further details.) -

    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 @@ -5702,132 +5961,132 @@ its argument to lowercase. For example:

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

    -

    The “sm” styles all use -


    +

    The “sm” styles all use +


    \glsxtrsmfont  \glsxtrsmfont{text}

    -

    +

    This is defined as:

    -
    +
    \newcommand*{\glsxtrsmfont}[1]{\textsmaller{#1}}
    -

    and -


    and +


    \glsxtrfirstsmfont  \glsxtrfirstsmfont{text}

    -

    +

    which is defined as

    -
    +
    \newcommand*{\glsxtrfirstsmfont}[1]{\glsxtrsmfont{#1}}
    -

    If you want to use this style, you must explicitly load the

    If you want to use this style, you must explicitly load the relsize package which + id="dx1-21034"> package which defines the \textsmaller command. If you want to easily switch between the “sc” + id="dx1-21035"> command. If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert to upper case:

    -
    +
    \renewcommand*{\glsxtrsmfont}[1]{\textsmaller{\MakeTextUppercase{#1}}}
    -

    The default plural suffix for the short form is set to -


    The default plural suffix for the short form is set to +


    \glsxtrsmsuffix  \glsxtrsmsuffix

    -

    +

    This just does \glspluralsuffix. -

    The “em” styles all use -


    . +

    The “em” styles all use +


    \glsabbrvemfont  \glsabbrvemfont{text}

    -

    +

    which is defined as:

    -
    +
    \newcommand*{\glsabbrvemfont}[1]{\emph{#1}}
    -

    and -


    and +


    \glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

    -

    +

    which is defined as:

    -
    +
    \newcommand*{\glsfirstabbrvemfont}[1]{\glsabbrvemfont{#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:

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

    or +

    or

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

    • field1⟩[field2⟩[-modifier2⟩][-user] -

      This is for the parenthetical styles. The

      This is for the parenthetical styles. The -modifier⟩ parts may be omitted. These styles display ⟨field2⟩ in parentheses. If ⟨field2⟩ starts with “no” then the parenthetical element is omitted from the display style but is included in the inline style. -

      If the

      If the -modifier⟩ part is present, then the field has a font changing command applied to it. -

      If the

      If the -user part is present, then the user1 value, if provided, is inserted + id="dx1-21041"> value, if provided, is inserted into the parenthetical material . (The field used for the inserted material may be changed.) -

      Examples:

      +

      Examples:

      • long-noshort-sc: ⟨: ⟨field1⟩ is the long form, the short form is set in smallcaps but omitted in the display style.
      • long-em-short-em: both the long form and the short form are + id="dx1-21043">: both the long form and the short form are emphasized. The short form is in parentheses.
      • long-short-em: the short form is emphasized but not the long form. + id="dx1-21044">: the short form is emphasized but not the long form. The short form is in parentheses.
      • long-short-user: if the : if the user1 key has been set, this produces the style + id="dx1-21046"> key has been set, this produces the style ⟨long⟩ (⟨short⟩, ⟨modifier1⟩]-[post]footnote -

        The display style uses ⟨

        The display style uses ⟨field1⟩ followed by a footnote with the other field in it. If post is present then the footnote is placed after the link-text using the post-link hook. The inline style does ⟨field1⟩ followed by the other field in parentheses. -

        If

        If -modifier1⟩ is present, ⟨field1⟩ has a font-changing command applied to it. -

        Examples:

        +

        Examples:

        • short-footnote: short form in the text with the long form in the + id="dx1-21048">: short form in the text with the long form in the footnote.
        • short-sc-postfootnote: short form in smallcaps with the long form in + id="dx1-21049">: short form in smallcaps with the long form in the footnote outside of the link-text.
        -

        Take care with the footnote styles. Remember that there are some situations +

        Take care with the footnote styles. Remember that there are some situations where \footnote doesn’t work.
        -

        + id="dx1-21051"> doesn’t work.

        +

      • style-desc -

        Like ⟨

        Like ⟨style⟩ but the description key must be provided when defining abbreviations + id="dx1-21052"> key must be provided when defining abbreviations with this style. -

        Examples:

        +

        Examples:

        • short-long-desc: like : like short-long but requires a description. + id="dx1-21054"> but requires a description.
        • short-em-footnote-desc: like : like short-em-footnote but requires a + id="dx1-21056"> but requires a description.
      -

      Not all combinations that fit the above syntax are provided. Pre-version 1.04 +

      Not all combinations that fit the above syntax are provided. Pre-version 1.04 styles that didn’t fit this naming scheme are either provided with a synonym (where the former name wasn’t ambiguous) or provided with a deprecated synonym (where the former name was confusing). The deprecated style names generate a warning using: -



      \GlsXtrWarnDeprecatedAbbrStyle  \GlsXtrWarnDeprecatedAbbrStyle {old-name}{new-name}

      -

      +

      where ⟨old-name⟩ is the deprecated name and ⟨new-name⟩ is the preferred name. You can suppress these warnings by redefining this command to do nothing. -

      +

      -

      Top

      3.4.1 Predefined Abbreviation Styles that Set the Regular Attribute

      -

      The following abbreviation styles set the

      The following abbreviation styles set the regular attribute to “true” for all categories + id="dx1-22001"> attribute to “true” for all categories that have abbreviations defined with any of these styles. @@ -5989,187 +6248,187 @@ that have abbreviations defined with any of these styles.

      short-nolong
      This only displays the short form on first use. The name is set to + id="dx1-22004"> is set to the short form. The description is set to the long form. The inline full form + id="dx1-22005"> is set to the long form. The inline full form displays ⟨short⟩ (⟨long⟩). The long form on its own can be displayed through commands like \glsxtrlong. + id="dx1-22006">.
      short
      A synonym for short-nolong. + id="dx1-22008">.
      short-sc-nolong
      Like short-nolong but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-22011">.
      short-sc
      A synonym for short-sc-nolong + id="dx1-22013">
      short-sm-nolong
      Like short-nolong but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-22016">.
      short-sm
      A synonym for short-sm-nolong. + id="dx1-22018">.
      short-em-nolong
      Like short-nolong but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-22021">.
      short-em
      A synonym for short-em-nolong + id="dx1-22023">
      short-nolong-desc
      Like the short-nolong style, but the style, but the name is set to the full + id="dx1-22026"> is set to the full form and the description must be supplied by the user. You may prefer + id="dx1-22027"> must be supplied by the user. You may prefer to use the short-nolong style with the post-description hook set to display + id="dx1-22028"> style with the post-description hook set to display the long form and override the description key. (See the sample file + id="dx1-22029"> key. (See the sample file sample-acronym-desc.tex.)
      short-desc
      A synonym for short-nolong-desc. + id="dx1-22031">.
      short-sc-nolong-desc
      Like short-nolong but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-22034">.
      short-sc-desc
      A synonym for short-sc-nolong-desc. + id="dx1-22036">.
      short-sm-nolong-desc
      Like short-nolong-desc but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-22039">.
      short-sm-desc
      A synonym for short-sm-nolong-desc. + id="dx1-22041">.
      short-em-nolong-desc
      Like short-nolong-desc but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-22044">.
      short-em-desc
      A synonym for short-em-nolong-desc. + id="dx1-22046">.
      long-noshort-desc
      This style only displays the long form, regardless of first or subsequent use of commands \gls. The short form may be accessed + id="dx1-22048">. The short form may be accessed through commands like \glsxtrshort. The inline full form displays ⟨. The inline full form displays ⟨long⟩ (⟨short⟩). -

      The

      The name and and sort keys are set to the long form and the keys are set to the long form and the description must + id="dx1-22052"> must be provided by the user. The predefined glossary styles won’t display the short form. You can use the post-description hook to automatically append the short form to the description. The inline full form will display ⟨short⟩).

      long-desc
      A synonym for long-noshort-desc. + id="dx1-22054">.
      long-noshort-sc-desc
      Like the long-noshort-desc style but the short form + id="dx1-22056"> style but the short form (accessed through commands like \glsxtrshort) use ) use \glsxtrscfont. + id="dx1-22058">. (This style was originally called long-desc-sc. Renamed in version + id="dx1-22059">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-noshort-sm-desc
      Like long-noshort-desc but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. (This style was originally called . (This style was originally called long-desc-sm. + id="dx1-22063">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-noshort-em-desc
      Like long-noshort-desc but redefines but redefines \glsabbrvfont to use \glsxtremfont. The long form isn’t emphasized. (This style was + id="dx1-22066">. The long form isn’t emphasized. (This style was originally called long-desc-em. Renamed in version 1.04, but original name + id="dx1-22067">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-em-noshort-em-desc
      New to version 1.04, like long-noshort-desc but + id="dx1-22069"> but redefines \glsabbrvfont to use \glsxtremfont. The long form uses + id="dx1-22070">. The long form uses \glsfirstlongemfont and and \glslongemfont. + id="dx1-22072">.
      long-noshort
      This style doesn’t really make sense if you don’t use the short form anywhere in the document, but is provided for completeness. This is like the long-noshort-desc style, but the style, but the name and and sort keys are set to the + id="dx1-22076"> keys are set to the short form and the description is set to the long form. + id="dx1-22077"> is set to the long form.
      long
      A synonym for long-noshort + id="dx1-22079">
      long-noshort-sc
      Like the long-noshort style but the short form (accessed + id="dx1-22081"> style but the short form (accessed through commands like \glsxtrshort) use ) use \glsxtrscfont. (This style + id="dx1-22083">. (This style was originally called long-sc. Renamed in version 1.04, but original name + id="dx1-22084">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-noshort-sm
      Like long-noshort but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. (This style was originally called . (This style was originally called long-sm. Renamed in + id="dx1-22088">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-noshort-em
      This style is like long-noshort but redefines but redefines \glsabbrvfont to use \glsxtremfont. The long form isn’t emphasized. (This style was + id="dx1-22091">. The long form isn’t emphasized. (This style was originally called long-em. Renamed in version 1.04, but original name + id="dx1-22092">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      long-em-noshort-em
      New to version 1.04, this style is like long-noshort but + id="dx1-22094"> but redefines \glsabbrvfont to use \glsxtremfont, , \glsfirstlongfont to use \glsfirstlongemfont and \glslongfont to use \glslongemfont. The short form isn’t used by commands like \gls, but can be obtained + id="dx1-22096">, but can be obtained using \glsxtrshort. + id="dx1-22097">.
      -

      +

      -

      Top

      3.4.2 Predefined Abbreviation Styles that Don’t Set the Regular Attribute

      -

      The following abbreviation styles will set the

      The following abbreviation styles will set the regular attribute to “false” if it has + id="dx1-23001"> attribute to “false” if it has previously been set. If it hasn’t already been set, it’s left unset. Other attributes may also be set, depending on the style.

      long-short
      On first use, this style uses the format ⟨long⟩ (⟨short⟩). The inline and display full forms are the same. The name and and sort keys are + id="dx1-23005"> keys are set to the short form. (The name key additionally includes the font + id="dx1-23006"> key additionally includes the font command \glsabbrvfont.) The description is set to the long form. The + id="dx1-23007"> is set to the long form. The long and short forms are separated by \glsxtrfullsep. If you want to insert material within the parentheses (such as a translation), try the long-short-user style. + id="dx1-23008"> style.
      long-short-sc
      Like long-short but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-23011">.
      long-short-sm
      Like long-short but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-23014">.
      long-short-em
      Like long-short but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-23017">.
      long-em-short-em
      New to version 1.04, this style is like long-short-em but + id="dx1-23019"> but redefines \glsfirstlongfont to use \glsfirstlongemfont. + id="dx1-23020">.
      long-short-user
      This style was introduced in version 1.04. It’s like the long-short style + id="dx1-23022"> style but additional information can be inserted into the parenthetical material. This checks the value of the field given by -



      \glsxtruserfield  \glsxtruserfield

      -

      +

      (which defaults to useri) using \ifglshasfield (provided by (provided by glossaries). If the field hasn’t been set, the style behaves like the long-short style and produces + id="dx1-23025"> style and produces ⟨long⟩ (⟨short⟩) but if the field has been set, the contents of that field are inserted @@ -6456,23 +6715,23 @@ class="cmti-10">long⟩ (⟨short⟩, ⟨field-value⟩). The format is governed by -



      \glsxtruserparen  \glsxtruserparen{text}{label}

      -

      +

      where ⟨text⟩ is the short form (for the long-short-user style) or the long form (for + id="dx1-23027"> style) or the long form (for the short-long-user style). This command first inserts a space using + id="dx1-23028"> style). This command first inserts a space using \glsxtrfullsep and then the parenthetical content. The ⟨text⟩ argument @@ -6482,339 +6741,339 @@ class="cmti-10">short⟩} in the case of the long-short-user style and style and \glsfirstlongfont{long} in the case of the short-long-user style. -

      For example: + id="dx1-23030"> style. +

      For example:

      -
      +
      \setabbreviationstyle[acronym]{long-short-user}  
      \newacronym{tug}{TUG}{\TeX\ User Group}  
      \newacronym  
       [user1={German Speaking \TeX\ User Group}]  
       {dante}{DANTE}{Deutschsprachige Anwendervereinigung \TeX\ e.V}
      -

      On first use,

      On first use, \gls{tug} will appear as:

      -

      T

      TEX User Group (TUG)

      -

      whereas

      whereas \gls{dante} will appear as:

      -

      Deutschsprachige Anwendervereinigung T

      Deutschsprachige Anwendervereinigung TEX e.V (DANTE, German Speaking TEX User Group)

      -

      The short form is formatted according to -


      The short form is formatted according to +


      \glsabbrvuserfont  \glsabbrvuserfont{text}

      -

      +

      and the plural suffix is given by -



      \glsxtrusersuffix  \glsxtrusersuffix

      -

      -

      These may be redefined as appropriate. For example, if you want a smallcaps +

      +

      These may be redefined as appropriate. For example, if you want a smallcaps style, you can just set these commands to those used by the long-short-sc + id="dx1-23033"> style:

      -
      +
      \renewcommand{\glsabbruserfont}[1]{\glsxtrscfont{#1}}  
      \renewcommand{\glsxtrusersuffix}{\glsxtrscsuffix}
      -

      +

      long-short-desc
      On first use, this style uses the format ⟨long⟩ (⟨short⟩). The inline and display full forms are the same. The name is set to the full + id="dx1-23036"> is set to the full form. The sort key is set to ⟨ key is set to ⟨long⟩ (⟨short⟩). Before version 1.04, this was incorrectly set to the short form. If you want to revert back to this you can redefine -



      \glsxtrlongshortdescsort  \glsxtrlongshortdescsort

      -

      +

      For example:

      -
      +
      \renewcommand*{\glsxtrlongshortdescsort}{\the\glsshorttok}
      -

      The

      The description must be supplied by the user. The long and short forms are + id="dx1-23039"> must be supplied by the user. The long and short forms are separated by \glsxtrfullsep.

      long-short-sc-desc
      Like long-short-desc but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-23042">.
      long-short-sm-desc
      Like long-short-desc but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-23045">.
      long-short-em-desc
      Like long-short-desc but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-23048">.
      long-em-short-em-desc
      New to version 1.04, this style is like long-short-em-desc but + id="dx1-23050"> but redefines \glsfirstlongfont to use \glsfirstlongemfont. + id="dx1-23051">.
      long-short-user-desc
      New to version 1.04, this style is like a cross between the long-short-desc style and the style and the long-short-user style. The display and inline forms + id="dx1-23054"> style. The display and inline forms are as for long-short-user and the and the name key is as key is as long-short-desc. The . The description + id="dx1-23058"> key must be supplied in the optional argument of \newabbreviation (or \newacronym). The sort key is set to ⟨ key is set to ⟨long⟩ (⟨short⟩) as per the long-short-desc + id="dx1-23060"> style.
      short-long
      On first use, this style uses the format ⟨short⟩ (⟨long⟩). The inline and display full forms are the same. The name and and sort keys are set to the + id="dx1-23064"> keys are set to the short form. The description is set to the long form. The short and long + id="dx1-23065"> is set to the long form. The short and long forms are separated by \glsxtrfullsep. If you want to insert material within the parentheses (such as a translation), try the short-long-user + id="dx1-23066"> style.
      short-sc-long
      Like short-long but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-23069">.
      short-sm-long
      Like short-long but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-23072">.
      short-em-long
      Like short-long but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-23075">.
      short-em-long-em
      New to version 1.04, this style is like short-em-long but redefines + id="dx1-23077"> but redefines \glsfirstlongfont to use \glsfirstlongemfont. + id="dx1-23078">.
      short-long-user
      New to version 1.04. This style is like the long-short-user + id="dx1-23080"> style but with the long and short forms switched. The parenthetical material is governed by the same command \glsxtruserparen, but + id="dx1-23081">, but the first argument supplied to it is the long form instead of the short form.
      short-long-desc
      On first use, this style uses the format ⟨short⟩ (⟨long⟩). The inline and display full forms are the same. The name is set to the full form. The is set to the full form. The description + id="dx1-23085"> must be supplied by the user. The short and long forms are separated by \glsxtrfullsep.
      short-sc-long-desc
      Like short-long-desc but redefines but redefines \glsabbrvfont to use \glsxtrscfont. + id="dx1-23088">.
      short-sm-long-desc
      Like short-long-desc but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. + id="dx1-23091">.
      short-em-long-desc
      Like short-long-desc but redefines but redefines \glsabbrvfont to use \glsxtremfont. + id="dx1-23094">.
      short-em-long-em-desc
      New to version 1.04, this style is like short-em-long-desc but + id="dx1-23096"> but redefines \glsfirstlongfont to use \glsfirstlongemfont. + id="dx1-23097">.
      short-long-user-desc
      New to version 1.04, this style is like a cross between the short-long-desc style and the style and the short-long-user style. The display and inline forms + id="dx1-23100"> style. The display and inline forms are as for short-long-user and the and the name key is as key is as short-long-desc. The . The description + id="dx1-23104"> key must be supplied in the optional argument of \newabbreviation (or \newacronym).
      short-footnote
      On first use, this style displays the short form with the long form as + id="dx1-23106">first use, this style displays the short form with the long form as a footnote. This style automatically sets the nohyperfirst attribute to “true” for + id="dx1-23107"> attribute to “true” for the supplied category, so the first use won’t be hyperlinked (but the footnote + id="dx1-23108">first use won’t be hyperlinked (but the footnote marker may be, if the hyperref package is used). + id="dx1-23109"> package is used). -

      The inline full form uses the ⟨

      The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short + id="dx1-23110"> is set to the short form. The description is set to the long form. -

      As from version 1.05, all the footnote styles use: -


      is set to the long form. +

      As from version 1.05, all the footnote styles use: +


      \glsfirstlongfootnotefont  \glsfirstlongfootnotefont{text}

      -

      +

      to format the long form on first use or for the full form and -



      \glslongfootnotefont  \glslongfootnotefont{text}

      -

      +

      to format the long form elsewhere (for example, when used with \glsxtrlong). -

      As from version 1.07, all the footnote styles use: -


      As from version 1.07, all the footnote styles use: +


      \glsxtrabbrvfootnote  \glsxtrabbrvfootnote{label}{long}

      -

      +

      By default, this just does \footnote{long} (the first argument is ignored). For @@ -6890,177 +7149,177 @@ class="cmtt-10">} (the first argument is ignored). For

      -
      +
      \renewcommand{\glsxtrabbrvfootnote}[2]{%  
        \footnote{\glshyperlink[#2]{#1}}%  
      }
      -

      or to include the short form with a hyperlink: +

      or to include the short form with a hyperlink:

      -
      +
      \renewcommand{\glsxtrabbrvfootnote}[2]{%  
        \footnote{\glshyperlink[\glsfmtshort{#1}]{#1}: #2}%  
      }
      -

      Note that I haven’t used commands like

      Note that I haven’t used commands like \glsxtrshort to avoid interference (see §2.2 §2.3 Entry Display Style Modifications and §2.5 §2.6 Nested Links).

      footnote
      A synonym for short-footnote. + id="dx1-23118">.
      short-sc-footnote
      Like short-footnote but redefines but redefines \glsabbrvfont to use \glsxtrscfont. (This style was originally called . (This style was originally called footnote-sc. Renamed in + id="dx1-23122">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-sc-footnote
      Like short-footnote but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. (This style was originally called . (This style was originally called footnote-sm. Renamed in + id="dx1-23126">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-em-footnote
      Like short-footnote but redefines but redefines \glsabbrvfont to use \glsxtremfont. (This style was originally called . (This style was originally called footnote-em. Renamed in + id="dx1-23130">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-postfootnote
      This is similar to the short-footnote style but doesn’t modify the + id="dx1-23132"> style but doesn’t modify the category attribute. Instead it changes \glsxtrpostlinkcategory to insert the + id="dx1-23133"> to insert the footnote after the link-text on first use. This will also defer the footnote until after any following punctuation character that’s recognised by \glsxtrifnextpunc. -

      The inline full form uses the ⟨. +

      The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short + id="dx1-23137"> is set to the short form. The description is set to the long form. Note that this style will change + id="dx1-23138"> is set to the long form. Note that this style will change \glsxtrfull (and it’s variants) so that it fakes non-first use. (Otherwise the + id="dx1-23139">first use. (Otherwise the footnote would appear after the inline form.)

      postfootnote
      A synonym for short-postfootnote. + id="dx1-23141">.
      short-sc-postfootnote
      Like short-postfootnote but redefines but redefines \glsabbrvfont to use \glsxtrscfont. (This style was originally called . (This style was originally called postfootnote-sc. Renamed in + id="dx1-23145">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-sm-postfootnote
      Like short-postfootnote but redefines but redefines \glsabbrvfont to use \glsxtrsmfont. (This style was originally called . (This style was originally called postfootnote-sm. Renamed in + id="dx1-23149">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-em-postfootnote
      Like short-postfootnote but redefines but redefines \glsabbrvfont to use \glsxtremfont. (This style was originally called . (This style was originally called postfootnote-em. Renamed in + id="dx1-23153">. Renamed in version 1.04, but original name retained as a deprecated synonym for backward-compatibility.)
      short-postlong-user
      This style was introduced in version 1.12. It’s like the short-long-user style but defers the parenthetical material to after the + id="dx1-23155"> style but defers the parenthetical material to after the link-text. This means that you don’t have such a long hyperlink (which can cause problems for the DVI LATEX format) and it also means @@ -7069,51 +7328,51 @@ class="E">EX format) and it also means
      short-postlong-user-desc
      This style was introduced in version 1.12. It’s like the above short-postlong-user style but the style but the description must be + id="dx1-23158"> must be specified.
      long-postshort-user
      This style was introduced in version 1.12. It’s like the above short-postlong-user style but the long form is shown first and + id="dx1-23160"> style but the long form is shown first and the short form is in the parenthetical material (as for long-short-user) + id="dx1-23161">) style.
      long-postshort-user-desc
      This style was introduced in version 1.12. It’s like the above long-postshort-user style but the style but the description must be + id="dx1-23164"> must be specified.
      -

      +

      -

      Top

      3.5 Defining New Abbreviation Styles

      -

      New abbreviation styles may be defined using: -


      New abbreviation styles may be defined using: +


      \newabbreviationstyle  \newabbreviationstyle{name}{}{fmts}

      -

      -

      where ⟨

      +

      where ⟨name⟩ is the name of the new style (as used in the mandatory argument of \setabbreviationstyle). This is similar but not identical to the ). This is similar but not identical to the glossaries package’s \newacronymstyle command. -

      You can’t use styles defined by command. +

      You can’t use styles defined by \newacronymstyle with glossaries-extra unless you have reverted \newacronym back to its generic definition from + id="dx1-24004"> back to its generic definition from glossaries (using \RestoreAcronyms). The acronym styles from the ). The acronym styles from the glossaries package can’t be used with abbreviations defined with \newabbreviation.
      -

      -

      The ⟨

      +

      The ⟨setup⟩ argument deals with the way the entry is defined and may set attributes for the given abbreviation category. This argument should redefine -



      \CustomAbbreviationFields  \CustomAbbreviationFields

      -

      +

      to set the entry fields including the name (defaults to the short form if omitted), + id="dx1-24007"> (defaults to the short form if omitted), sort, , first, , firstplural. Other fields may also be set, such as . Other fields may also be set, such as text, , plural and + id="dx1-24012"> and description. -

      . +

      \CustomAbbreviationFields is expanded by \newabbreviation so take care to protect commands that shouldn’t be expanded.
      -

      -

      For example, the

      +

      For example, the long-short style has the following in ⟨ style has the following in ⟨setup⟩:

      -
      +
        \renewcommand*{\CustomAbbreviationFields}{%  
          name={\protect\glsabbrvfont{\the\glsshorttok}},  
          sort={\the\glsshorttok}, @@ -7200,32 +7459,32 @@ class="cmti-10">setup⟩:  
          plural={\protect\glsabbvfont{\the\glsshortpltok}},%  
          description={\the\glslongtok}}%
      -

      Note that the

      Note that the first and and firstplural are set even though they’re not used by + id="dx1-24016"> are set even though they’re not used by \gls. -

      The ⟨

      The ⟨setup⟩ argument may also redefine -



      \GlsXtrPostNewAbbreviation  \GlsXtrPostNewAbbreviation

      -

      +

      which can be used to assign attributes. (This will automatically be initialised to do nothing.) -

      For example, the

      For example, the short-footnote includes the following in ⟨ includes the following in ⟨setup⟩:

      -
      +
        \renewcommand*{\GlsXtrPostNewAbbreviation}{%  
          \glssetattribute{\the\glslabeltok}{nohyperfirst}{true}%  
          \glshasattribute{\the\glslabeltok}{regular}% @@ -7235,222 +7494,222 @@ class="cmti-10">setup⟩:  
          {}%  
        }%
      -

      This sets the

      This sets the nohyperfirst attribute to “true”. It also unsets the attribute to “true”. It also unsets the regular attribute if it + id="dx1-24020"> attribute if it has previously been set. Note that the nohyperfirst attribute doesn’t get unset by + id="dx1-24021"> attribute doesn’t get unset by other styles, so take care not to switch styles for the same category. -

      You can access the short, long, short plural and long plural values through the +

      You can access the short, long, short plural and long plural values through the following token registers. -

      Short value (defined by

      Short value (defined by glossaries): -



      \glsshorttok  \glsshorttok

      -

      -

      Short plural value (defined by

      +

      Short plural value (defined by glossaries-extra): -



      \glsshortpltok  \glsshortpltok

      -

      +

      (This may be the default value or, if provided, the value provided by the user through the shortplural key in the optional argument of key in the optional argument of \newabbreviation.) -

      Long value (defined by .) +

      Long value (defined by glossaries): -



      \glslongtok  \glslongtok

      -

      -

      Long plural value (defined by

      +

      Long plural value (defined by glossaries-extra): -



      \glslongpltok  \glslongpltok

      -

      +

      (This may be the default value or, if provided, the value provided by the user through the longplural key in the optional argument of key in the optional argument of \newabbreviation.) -

      There are two other registers available that are defined by .) +

      There are two other registers available that are defined by glossaries: -



      \glslabeltok  \glslabeltok

      -

      +

      which contains the entry’s label and -



      \glskeylisttok  \glskeylisttok

      -

      +

      which contains the values provided in the optional argument of \newabbreviation. -

      Remember put . +

      Remember put \the in front of the register command as in the examples above. The category label can be access through the command (not a register): -



      \glscategorylabel  \glscategorylabel

      -

      +

      This may be used inside the definition of \GlsXtrPostNewAbbreviation. -

      If you want to base a style on an existing style, you can use -


      If you want to base a style on an existing style, you can use +


      \GlsXtrUseAbbrStyleSetup  \GlsXtrUseAbbrStyleSetup{name}

      -

      +

      where ⟨name⟩ is the name of the existing style. For example, the short-sc-footnote and + id="dx1-24035"> and short-sm-footnote styles both simply use + id="dx1-24036"> styles both simply use

      -
      +
      \GlsXtrUseAbbrStyleSetup{short-footnote}
      -

      within ⟨

      within ⟨setup⟩. -

      The ⟨

      The ⟨fmts⟩ argument deals with the way the entry is displayed in the document. This argument should redefine the following commands: -

      The default suffix for the plural short form (if not overridden by the

      The default suffix for the plural short form (if not overridden by the shortplural + id="dx1-24037"> key): -



      \abbrvpluralsuffix  \abbrvpluralsuffix

      -

      +

      (Note that this isn’t used for the plural long form, which just uses the regular \glspluralsuffix.) -

      The font used for the short form on

      The font used for the short form on first use or in the full forms: -



      \glsfirstabbrvfont  \glsfirstabbrvfont{text}

      -

      -

      The font used for the short form on subsequent use or through commands like +

      +

      The font used for the short form on subsequent use or through commands like \glsxtrshort: -


      : +


      \glsabbrvfont  \glsabbrvfont{text}

      -

      -

      The font used for the long form on first use or in the full forms: -


      +

      The font used for the long form on first use or in the full forms: +


      \glsfirstlongfont  \glsfirstlongfont{text}

      -

      -

      The font used for the long form in commands like

      +

      The font used for the long form in commands like \glsxtrlong use: -



      \glslongfont  \glslongfont{text}

      -

      -

      Display full form singular no case-change (used by

      +

      Display full form singular no case-change (used by \gls on first use for + id="dx1-24046"> on first use for abbreviations without the regular attribute set): -


      attribute set): +


      \glsxtrfullformat  \glsxtrfullformat{label}{insert}

      -

      -

      Display full form singular first letter converted to upper case (used by

      +

      Display full form singular first letter converted to upper case (used by \Gls on + id="dx1-24050"> on first use for abbreviations without the first use for abbreviations without the regular attribute set): -


      attribute set): +


      \Glsxtrfullformat  \Glsxtrfullformat{label}{insert}

      -

      -

      Display full form plural no case-change (used by

      +

      Display full form plural no case-change (used by \glspl on first use for + id="dx1-24054"> on first use for abbreviations without the regular attribute set): -


      attribute set): +


      \glsxtrfullplformat  \glsxtrfullplformat{label}{}

      -

      -

      Display full form plural first letter converted to upper case (used by

      +

      Display full form plural first letter converted to upper case (used by \Glspl on + id="dx1-24058"> on first use for abbreviations without the regular attribute set): -


      attribute set): +


      \Glsxtrfullplformat  \Glsxtrfullplformat{label}{insert}

      -

      -

      In addition ⟨

      +

      In addition ⟨fmts⟩ may also redefine the following commands that govern the inline full formats. If the style doesn’t redefine them, they will default to the same as the display full forms. -

      Inline singular no case-change (used by

      Inline singular no case-change (used by \glsentryfull, , \glsxtrfull and + id="dx1-24063"> and \GLSxtrfull): -


      ): +


      \glsxtrinlinefullformat  \glsxtrinlinefullformat{label}{insert}

      -

      -

      Inline singular first letter converted to upper case (used by

      +

      Inline singular first letter converted to upper case (used by \Glsentryfull and + id="dx1-24066"> and \Glsxtrfull): -


      ): +


      \Glsxtrinlinefullformat  \Glsxtrinlinefullformat{label}{insert}

      -

      -

      Inline plural no case-change (used by

      +

      Inline plural no case-change (used by \glsentryfullpl, , \glsxtrfullpl and + id="dx1-24070"> and \GLSxtrfullpl): -


      ): +


      \glsxtrinlinefullplformat  \glsxtrinlinefullplformat{label}{insert}

      -

      -

      Inline plural first letter converted to upper case (used by

      +

      Inline plural first letter converted to upper case (used by \Glsentryfullpl and + id="dx1-24073"> and \Glsxtrfullpl): -


      ): +


      \Glsxtrinlinefullplformat  \Glsxtrinlinefullplformat{label}{insert}

      -

      -

      If you want to provide support for

      +

      If you want to provide support for glossaries-accsupp use the following + id="dx1-24076"> use the following \glsaccessxxx⟩ commands (\glsentry⟨xxx⟩ commands. (If you don’t use glossaries-accsupp, they will just do the corresponding , they will just do the corresponding \glsentryxxx⟩ command.) -

      For example, the

      For example, the short-long style has the following in ⟨ style has the following in ⟨fmts⟩:

      -
      +
        \renewcommand*{\abbrvpluralsuffix}{\glspluralsuffix}%  
        \renewcommand*{\glsabbrvfont}[1]{\glsabbrvdefaultfont{##1}}%  
        \renewcommand*{\glsfirstabbrvfont}[1]{\glsfirstabbrvdefaultfont{##1}}% @@ -7604,55 +7863,55 @@ class="cmti-10">fmts⟩:  
          (\glsfirstlongfont{\glsaccesslongpl{##1}})%  
        }%
      -

      Since the inline full commands aren’t redefined, they default to the same as the +

      Since the inline full commands aren’t redefined, they default to the same as the display versions. -

      If you want to base a style on an existing style, you can use -


      If you want to base a style on an existing style, you can use +


      \GlsXtrUseAbbrStyleFmts  \GlsXtrUseAbbrStyleFmts{name}

      -

      +

      within ⟨fmts⟩, where ⟨name⟩ is the name of the existing style. For example, the short-sc-long style has the following in ⟨ style has the following in ⟨fmts⟩:

      -
      +
        \GlsXtrUseAbbrStyleFmts{short-long}%  
        \renewcommand*{\abbrvpluralsuffix}{\protect\glsxtrscsuffix}%  
        \renewcommand*{\glsabbrvfont}[1]{\glsxtrscfont{##1}}%
      -

      and the

      and the short-sm-long style has: + id="dx1-24081"> style has:

      -
      +
        \GlsXtrUseAbbrStyleFmts{short-long-desc}%  
        \renewcommand*{\glsabbrvfont}[1]{\glsxtrsmfont{##1}}%  
        \renewcommand*{\abbrvpluralsuffix}{\protect\glsxtrsmsuffix}%
      -

      -

      The simplest examples of creating a new style based on an existing style are the +

      +

      The simplest examples of creating a new style based on an existing style are the “em” styles, such as the short-em-long style, which is defined as: + id="dx1-24082"> style, which is defined as:

      -
      +
      \newabbreviationstyle  
      {short-em-long}% label  
      {% setup @@ -7663,22 +7922,22 @@ class="cmss-10">short-em-long  \renewcommand*{\glsabbrvfont}[1]{\glsxtremfont{##1}}%  
      }
      -

      +

      -

      -

      +

      Top

      4. Entries in Sectioning Titles, Headers, Captions and Contents

      -

      The

      The glossaries user manual cautions against using commands like \gls in chapter or section titles. The principle problems are:

      • if you have a table of contents, the first use flag will be unset in the contents rather than later in the document;
      • @@ -7695,27 +7954,27 @@ class="cmtt-10">\gls etc) will be converted to upper case and the
      • if you use hyperref, commands like , commands like \gls can’t be expanded to a simple string and only the label will appear in the PDF bookmark (with a warning from hyperref); + id="dx1-25003">);
      • if you use hyperref, you will end up with nested hyperlinks in the table of + id="dx1-25004">, you will end up with nested hyperlinks in the table of contents.
      -

      Similar problems can also occur with captions (except for the page header and bookmark +

      Similar problems can also occur with captions (except for the page header and bookmark issues). -

      To get around all these problems, the

      To get around all these problems, the glossaries user manual recommends using the expandable non-hyperlink commands, such as \glsentrytext + id="dx1-25005"> (for regular entries) or \glsentryshort (for abbreviations). This is the + id="dx1-25006"> (for abbreviations). This is the simplest solution, but doesn’t allow for special formatting that’s applied to the entry through commands like \glstext or \glsxtrshort. This means that if, for example, you are using one of the abbreviation styles that uses \textsc then the short form displayed with then the short form displayed with \glsentryshort won’t use small caps. If you only have one abbreviation style in use, you can explicitly enclose -

      +
      \chapter{A Chapter about \glsabbrvfont{\glsentryshort{html}}}
      -

      Or, if you are using

      Or, if you are using hyperref: + id="dx1-25008">:

      -
      +
      \chapter{A Chapter about  
      \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 + id="dx1-25010"> and \markboth. If you don’t like this change, you can restore their former definitions + id="dx1-25011">. 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}}
      -

      -

      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 if hyperref has been + id="dx1-25014"> has been loaded so that the expandable non-formatted version is added to the PDF bookmarks. Note that since the commands that convert the first letter to upper case aren’t expandable, the non-case-changing version is used for the bookmarks. -

      These commands essentially behave as though you have used

      These commands essentially behave as though you have used \glsxtrshort (or equivalent) with the options noindex and and hyper=false. The text produced won’t be + id="dx1-25016">. The text produced won’t be converted to upper case in the page headings by default. If you want the text converted to upper case you need to set the headuc attribute to “true” for the + id="dx1-25017"> 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 + id="dx1-25018"> styles, be aware that the default fonts don’t provide bold small-caps or italic small-caps. This means that if the chapter or section title style uses bold, this may override the small-caps setting, in which case the abbreviation will just appear as lower case bold. If the @@ -7829,298 +8088,298 @@ heading style uses italic, the abbreviation may appear in upright small-caps, even if you have set the headuc attribute since the all-capitals form still uses \glsabbrvfont. You may want to consider using the slantsc package in this case. + id="dx1-25020"> 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: -


      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}

      -

      -

      Similarly for the value of the

      +

      Similarly for the value of the first field: -


      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 + id="dx1-26001"> (or commands that internally use it such as \newabbreviation) is assigned a category through the ) is assigned a category through the category key. You may + id="dx1-26003"> key. You may add any category that you like, but since the category is a label used in the creation of some control sequences, avoid problematic characters within the category label. (So take care if you have babel shorthands on that make some characters + id="dx1-26004"> 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 with type. -

      The default category assumed by . +

      The default category assumed by \newglossaryentry is labelled general. + id="dx1-26007">. Abbreviations defined with \newabbreviation have the category set to abbreviation + id="dx1-26008"> by default. Abbreviations defined with \newacronym have the category set to acronym by default. -

      Additionally, if you have enabled by default. +

      Additionally, if you have enabled \newterm with the with the index package option + id="dx1-26011"> package option that command will set the category to index by default. If you have enabled + id="dx1-26012"> by default. If you have enabled \glsxtrnewsymbol with the with the symbols package option, that command will set the + id="dx1-26014"> package option, that command will set the category to symbol. If you have enabled . If you have enabled \glsxtrnewnumber with the with the numbers package + id="dx1-26017"> package option, that command will set the category to number. -

      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  \glsifcategory{entry-label}{part}{false part}

      -

      +

      This is equivalent to

      \ifglsfieldeq{entry-label}}
      so any restrictions that apply to \ifglsfieldeq also apply to \glsifcategory. -

      Each category may have a set of attributes. For example, the

      Each category may have a set of attributes. For example, the general and and acronym + id="dx1-26023"> categories have the attribute regular set to “true” to indicate that all entries with + id="dx1-26024"> set to “true” to indicate that all entries with either of those categories are regular entries (as opposed to abbreviations). This attribute is accessed by \glsentryfmt to determine whether to use \glsgenentryfmt or \glsxtrgenabbrvfmt. -

      Other attributes recognised by

      Other attributes recognised by glossaries-extra are:

      nohyperfirst
      When using commands like \gls this will automatically suppress the + id="dx1-26026"> this will automatically suppress the hyperlink on first use for entries with a category that has this attribute set to “true”. (This settings can be overridden by explicitly setting the hyper key on + id="dx1-26028"> key on or off in the optional argument of commands like \gls.) As from version 1.07, \glsfirst, \Glsfirst, \GLSfirst and their plural versions (which should ideally behave in a similar way to the first use of first use of \gls or \glspl) now honour this attribute (but not the package-wide hyperfirst=false option, which + id="dx1-26030"> option, which matches the behaviour of glossaries). If you want commands these + id="dx1-26031">). If you want commands these \glsfirst etc commands to ignore the nohyperfirst attribute then just + id="dx1-26032"> attribute then just redefine -



      \glsxtrchecknohyperfirst  \glsxtrchecknohyperfirst{label}

      -

      +

      to do nothing.

      nohyper
      When using commands like \gls this will automatically suppress the + id="dx1-26035"> this will automatically suppress the hyperlink for entries with a category that has this attribute set to “true”. (This settings can be overridden by explicitly setting the hyper key on or off in the + id="dx1-26036"> key on or off in the optional argument of commands like \gls.)
      indexonlyfirst
      This is similar to the indexonlyfirst package option but only for entries + id="dx1-26038"> package option but only for entries that have a category with this attribute set to “true”.
      wrgloss
      When using commands like \gls, if this attribute is set to “after”, it will + id="dx1-26040">, if this attribute is set to “after”, it will automatically implement wrgloss=after. (New to v1.14.)
      discardperiod
      If set to “true”, the post-link-text hook will discard a full stop (period) that follows non-plural commands like \gls or \glstext. (Provided for entries such as abbreviations that end with a full stop.) -

      Note that this can cause a problem if you access a field that doesn’t end with a +

      Note that this can cause a problem if you access a field that doesn’t end with a full stop. For example:

      -
      +
      \newabbreviation  
       [user1={German Speaking \TeX\ User Group}]  
       {dante}{DANTE e.V.}{Deutschsprachige Anwendervereinigung \TeX\  
      e.V.}
      -

      Here the

      Here the short and and long fields end with a full stop, but the fields end with a full stop, but the user1 field doesn’t. + id="dx1-26046"> field doesn’t. The simplest solution in this situation is to put the sentence terminator in the final optional argument. For example:

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

      pluraldiscardperiod
      If this attribute is set to “true” and the discardperiod attribute is + id="dx1-26049"> attribute is set to “true”, this will behave as above for the plural commands like \glspl or \glsplural.
      retainfirstuseperiod
      If this attribute is set to “true” then the full stop won’t be discarded for first use instances, even if discardperiod or or pluraldiscardperiod are + id="dx1-26053"> are set. This is useful for ⟨short⟩ (⟨long⟩) abbreviation styles where only the short form @@ -8327,10 +8586,10 @@ class="cmti-10">long⟩) abbreviation styles where only the short fo
      insertdots
      If this attribute is set to “true” any entry defined using \newabbreviation + id="dx1-26055"> will automatically have full stops (periods) inserted after each letter. The entry will be defined with those dots present as though they had been present in the ⟨\newabbreviation (rather than inserting them new dotted version of the original ⟨short⟩ form with the plural suffix appended. -

      If you explicitly override the short plural using the

      If you explicitly override the short plural using the shortplural key, you must + id="dx1-26056"> 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”. + id="dx1-26057"> attribute set to “true”.

      aposplural
      If this attribute is set to “true”, \newabbreviation will insert an + id="dx1-26059"> will insert an apostrophe (’) before the plural suffix for the short plural form (unless explicitly overridden with the shortplural key). The long plural form is + id="dx1-26060"> key). The long plural form is unaffected by this setting.
      noshortplural
      If this attribute is set to “true”, \newabbreviation won’t append the + id="dx1-26062"> won’t append the plural suffix for the short plural form. This means the short and and shortplural + id="dx1-26064"> values will be the same unless explicitly overridden. The aposplural attribute trumps the noshortplural attribute. @@ -8391,21 +8650,21 @@ class="cmti-10">attribute.
      headuc
      If this attribute is set to “true”, commands like \glsfmtshort will use the + id="dx1-26068"> will use the upper case version in the page headers.
      tagging
      If this attribute is set to “true”, the tagging command defined by \GlsXtrEnableInitialTagging will be activated to use will be activated to use \glsxtrtagfont in + id="dx1-26071"> in the glossary (see §3.1 Tagging Initials).
      entrycount
      Unlike the above attributes, this attribute isn’t boolean but instead must be an integer value and is used in combination with \glsenableentrycount + id="dx1-26073"> (see §2.3 §2.4 Entry Counting Modifications). Leave blank or undefined for categories that shouldn’t have this facility enabled. The value of this attribute is used by \glsxtrifcounttrigger to determine how commands such as to determine how commands such as \cgls + id="dx1-26075"> should behave. -

      With

      With glossaries, commands like \cgls use \cglsformat only if the previous @@ -8437,16 +8696,16 @@ class="cmtt-10">\cglsformat only if the previous class="cmss-10">glossaries-extra the test is now for entries that have the entrycount attribute set and where the previous + id="dx1-26076"> attribute set and where the previous usage count for that entry is less than or equal to the value of that attribute.

      glossdesc
      The \glossentrydesc command (used in the predefined glossary styles) is + id="dx1-26078"> command (used in the predefined glossary styles) is modified by glossaries-extra to check for this attribute. The attribute may have one of the following values: @@ -8455,34 +8714,34 @@ class="cmss-10">glossaries-extra to check for this attribute. The attribu class="cmtt-10">firstuc: the first letter of the description will be converted to upper case (using \Glsentrydesc). + id="dx1-26079">).
    • title: the description will be used in the argument of the title casing command \capitalisewords (provided by (provided by mfirstuc). If you want to use a + id="dx1-26081">). If you want to use a different command you can redefine: -



      \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs}

      -

      +

      For example:

      -
      +
      \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 user manual for further details. + id="dx1-26083"> user manual for further details.

    glossdescfont
    (New to version 1.04) In addition to the above, the modified \glossentrydesc command also checks this attribute. If set, it should be the + id="dx1-26085"> command also checks this attribute. If set, it should be the name of a control sequence (without the leading backslash) that takes one argument. This control sequence will be applied to the description text. For example: -
    +
    \glssetcategoryattribute{general}{glossdescfont}{emph}
    -

    +

    glossname
    As glossdesc but applies to but applies to \glossentryname. Additionally, if this + id="dx1-26088">. Additionally, if this attribute is set to “uc” the name is converted to all capitals.
    indexname
    If set, the \glsxtrpostnamehook hook used at the end of \glossentyname + id="dx1-26090"> will index the entry using \index. See . See §7 Auto-Indexing for further @@ -8541,40 +8800,40 @@ href="#sec:autoindex">Auto-Indexing for fur
    glossnamefont
    (New to version 1.04) In addition to the above, the modified \glossentryname command also checks this attribute. If set, it should be the + id="dx1-26093"> command also checks this attribute. If set, it should be the name of a control sequence (without the leading backslash) that takes one argument. This control sequence will be applied to the name text. For example: -
    +
    \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.

    dualindex
    If set, whenever a glossary entry has information written to the external glossary file through commands like \gls and and \glsadd, a corresponding line + id="dx1-26096">, a corresponding line will be written to the indexing file using \index. See . See §7 Auto-Indexing for @@ -8582,17 +8841,17 @@ href="#sec:autoindex">Auto-Indexing for
    targeturl
    If set, the hyperlink generated by commands like \gls will be set to the URL provided by this attributes value. For example: -
    +
    \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 ~) remember that the base glossaries package provides commands like \glspercentchar and 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 targetname to the anchor ⟨ to the anchor ⟨name⟩. You may use \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 entries to link to glossaries in the URL given by targeturl, you can just + id="dx1-26101">, you can just do:

    -
    +
    \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 targetname for the ⟨ for the ⟨name2⟩ part and targetcategory for the ⟨ for the ⟨name1⟩ part. -

    For example: +

    For example:

    -
    +
    \glssetcategoryattribute{general}{targeturl}{master-doc.pdf}  
    \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 for the external list. For + id="dx1-26104"> for the external list. For example:

    -
    +
    \newignoredglossary*{external}  
    \glssetcategoryattribute{external}{targeturl}{master-doc.pdf}  
    \glssetcategoryattribute{general}{targetname}{\glolinkprefix\glslabel} @@ -8678,14 +8937,14 @@ class="cmtt-10">\newignoredglossary  category=external,  
      description={external example}}
    -

    +

    -

    An attribute can be set using: -


    An attribute can be set using: +


    \glssetcategoryattribute  \glssetcategoryattribute{category-label} @@ -8695,30 +8954,30 @@ class="cmitt-10">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”: -


    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  \glssetattribute{entry-label}{} 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  \glsgetcategoryattribute{category-label} @@ -8745,13 +9004,13 @@ class="cmtt-10">} class="cmtt-10">{⟨attribute-label}

    -

    +

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



    \glsgetattribute  \glsgetattribute{entry-label}{} -

    -

    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  \glshascategoryattribute{category-label} @@ -8778,19 +9037,19 @@ class="cmitt-10">true code}{false code}

    -

    +

    This uses etoolbox’s ’s \ifcsvoid and does ⟨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  \glshasattribute{entry-label}{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  \glsifcategoryattribute{category-label} @@ -8821,7 +9080,7 @@ class="cmitt-10">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:

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

    This does “NO HYPER” if the

    This does “NO HYPER” if the general category has the category has the nohyper attribute set to + id="dx1-26116"> 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 , 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  \glsifattribute{entry-label}{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 + id="dx1-26119"> attribute set to “true”: -



    \glsifregularcategory  \glsifregularcategory{category-label} @@ -8889,12 +9148,12 @@ class="cmitt-10">true-part}{false-part}

    -

    +

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



    \glsifregular  \glsifregular{entry-label}{}{false-part}

    -

    +

    Note that if the regular attribute hasn’t be set, the above do ⟨ attribute hasn’t be set, the above do ⟨false-part⟩. There are also reverse commands that test if the regular attribute has been set to + id="dx1-26123"> attribute has been set to “false”: -



    \glsifnotregularcategory  \glsifnotregularcategory{category-label} @@ -8925,12 +9184,12 @@ class="cmitt-10">true-part}{false-part}

    -

    +

    or for a particular entry: -



    \glsifnotregular  \glsifnotregular{entry-label}{}{false-part}

    -

    +

    Again, if the regular attribute hasn’t been set, the above do ⟨ 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  \glsforeachwithattribute[glossary-labels] @@ -8998,42 +9257,42 @@ class="cmtt-10">}{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 + id="dx1-26128">. Alternatively, you can use -



    \glsxtrsetcategory  \glsxtrsetcategory{entry-labels}{category-label}

    -

    +

    This will change the category to ⟨category-label⟩ for each entry listed in the comma-separated list ⟨entry-labels⟩. This command uses \glsfieldxdef so it will + id="dx1-26130"> 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  \glsxtrsetcategoryforall{glossary-labels} @@ -9041,75 +9300,75 @@ class="cmtt-10">} class="cmtt-10">{⟨category-label}

    -

    +

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

    -

    -

    +

    Top

    6. Entry Counting

    -

    As mentioned in

    As mentioned in §2.3 §2.4 Entry Counting Modifications, glossaries-extra modifies the \glsenableentrycount command to allow for the command to allow for the entrycount attribute. This means + id="dx1-27002"> attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but + id="dx1-27003">, but you also need to set the appropriate attribute (see §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 instead of \gls even if you haven’t enabled + id="dx1-27006"> even if you haven’t enabled entry counting. You will only get a warning if you use \glsenableentrycount without setting the entrycount attribute. (With attribute. (With glossaries, commands like \cgls will + id="dx1-27008"> will generate a warning if \glsenableentrycount hasn’t been used.) The abbreviation shortcut \ab uses uses \cgls (see §3.3 Shortcut Commands) unlike the acronym shortcut \ac which uses which uses \gls. -

    All upper case versions (not provided by

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



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

    -

    +

    and -



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

    -

    +

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



    \cGLSformat  \cGLSformat{label}{insert}

    -

    +

    and -



    \cGLSplformat  \cGLSplformat{label}{insert}

    -

    +

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

    Just using

    Just using glossaries:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \makeglossaries @@ -9178,16 +9437,16 @@ class="cmss-10">glossaries:  
    \printglossaries  
    \end{document}
    -

    -

    If you switch to

    +

    If you switch to glossaries-extra you must set the entrycount attribute: + id="dx1-27015"> attribute:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \makeglossaries @@ -9201,16 +9460,16 @@ class="cmss-10">entrycount\printglossaries  
    \end{document}
    -

    -

    When activated with

    +

    When activated with \glsenableentrycount, commands such as \cgls now + id="dx1-27016"> now use -



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

    -

    +

    to determine if the entry trips the entry count trigger. The ⟨trigger code⟩ uses commands like \cglsformat and unsets the first use flag. The ⟨normal code⟩ is the code that would ordinarily be performed by whatever the equivalent command is (for @@ -9236,12 +9495,12 @@ class="cmti-10">trigger code⟩ but the usual \gls behaviour in ⟨normal code⟩). -

    The default definition is: +

    The default definition is:

    -
    +
    \newcommand*{\glsxtrifcounttrigger}[3]{%  
     \glshasattribute{#1}{entrycount}%  
     {% @@ -9254,35 +9513,35 @@ 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 + id="dx1-27019"> 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:

    -
    +
    \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 attribute and redefine attribute and redefine \gls, etc to use , etc to use \cgls etc: -


    etc: +


    \GlsXtrEnableEntryCounting  \GlsXtrEnableEntryCounting{categories} @@ -9290,18 +9549,18 @@ class="cmtt-10">} class="cmtt-10">{⟨value}

    -

    +

    The first argument ⟨categories⟩ is a comma-separated list of categories. For each category, the entrycount attribute is set to ⟨ attribute is set to ⟨value⟩. In addition, this does:

    -
    +
    \renewcommand*{\gls}{\cgls}%  
    \renewcommand*{\Gls}{\cGls}%  
    \renewcommand*{\glspl}{\cglspl}% @@ -9309,18 +9568,18 @@ class="cmti-10">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: + id="dx1-27025"> attribute for each listed category. +

    The above example document can then become:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \makeglossaries @@ -9333,15 +9592,15 @@ 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  \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 + id="dx1-27027"> counter.

    +

    +

    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 hyperref also has a similar requirement and provides + id="dx1-27028"> also has a similar requirement and provides \theHcounter-name⟩ as an expandable alternative, \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 + id="dx1-27029"> (as before) and unitcount (the name of the counter). + id="dx1-27030"> (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:

    -
    +
    \documentclass{report}  
    \usepackage{glossaries-extra}  
    \GlsXtrEnableEntryUnitCounting{abbreviation}{2}{chapter} @@ -9460,11 +9719,11 @@ 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 first use with the short form used on subsequent use, and the css entries in that @@ -9474,19 +9733,19 @@ only used once, which trips the suppression trigger, so in that chapter, the long form is used and \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 category, which hasn’t been listed in + id="dx1-27036"> category, which hasn’t been listed in \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 @@ -9494,20 +9753,20 @@ example document the trigger value is set to zero, which means the index suppres won’t be triggered, but the unit entry count is used to automatically suppress the hyperlink for commands like \gls by modifying the hook -


    by modifying the hook +


    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +

    which is used at the end of the macro the determines whether or not to suppress the hyperlink.

    -
    +
    \documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage{glossaries-extra} @@ -9528,12 +9787,12 @@ 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 + id="dx1-27039"> 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 @@ -9542,203 +9801,306 @@ page.

    -

    -

    +

    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: indexname and + id="dx1-28001"> and dualindex. -

    The . +

    The \glsxtrpostnamehook macro, used at the end of macro, used at the end of \glossentryname and + id="dx1-28004"> and \Glossentryname, checks the , checks the indexname attribute for the category associated with + id="dx1-28006"> attribute for the category associated with that entry. Since \glossentryname is used in the default glossary styles, this makes a convenient way of automatically indexing each entry name at its location in the glossary without fiddling around with the value of the name + id="dx1-28007"> 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 -


    attribute. +

    In both cases, the indexing is done through +


    \glsxtrdoautoindexname  \glsxtrdoautoindexname{label}{attribute-label}

    -

    +

    This uses the standard \index command with the sort value taken from the entry’s + id="dx1-28010"> command with the sort value taken from the entry’s sort key and the actual value set to key and the actual value set to \glsentryname{label}. 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: +class="cmtt-10">}. 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 +


    \glsxtrautoindexentry  \glsxtrautoindexentry{label}

    +

    +where ⟨label⟩ is the entry’s label. The default definition is:

    -
    -\glssetcategoryattribute{general}{indexname}{textbf} +
    +\newcommand*{\glsxtrautoindexentry}[1]{\string\glsentryname{#1}}
    -

    will set the encap to textbf which will display the relevant page number in bold -whereas +

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


    \glsxtrautoindexassignsort  \glsxtrautoindexassignsort{cs}{label} +

    +

    +where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the +sort value. The default definition is:

    -
    -\glssetcategoryattribute{general}{dualindex}{true} +
    +\newcommand*{\glsxtrautoindexassignsort}[2]{% + 
      \glsletentryfield{#1}{#2}{sort}% + 
    }
    -

    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 format key won’t be used with the dualindex attribute. You can -allow the format key to override the attribute value by using the preamble-only -command: -


    \GlsXtrEnableIndexFormatOverride

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


    \glsxtrautoindex  \glsxtrautoindex{text}

    +

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

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

    +

    For example, to index the value of the first key, instead of the name key: + + + +

    +
    +\renewcommand*{\glsxtrautoindexentry}[1]{\string\glsentryfirst{#1}} +
    +

    and if the sort value also needs to be set to the long field, if present, otherwise the +sort field: + + + +

    +
    +\renewcommand*{\glsxtrautoindexassignsort}[2]{% + 
      \ifglshaslong{#2}% + 
      {\glsletentryfield{#1}{#2}{long}}% + 
      {\glsletentryfield{#1}{#2}{sort}}% + 
    } +
    +

    +

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

    +
    +\glssetcategoryattribute{general}{indexname}{textbf} +
    +

    will set the encap to textbf which will display the relevant page number in bold +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 +used in the glossary. (Unless some other loaded package has modified the definition of +\index to use some thing else.)
    +

    +

    By default the format key won’t be used with the dualindex attribute. You can +allow 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 has been loaded, then the theindex + id="dx1-28026"> environment will be modified to redefine \glshypernumber to allow formats that use + id="dx1-28028"> to allow formats that use that command. -

    The

    The dualindex attribute will still be used on subsequent use even if the + id="dx1-28029"> attribute will still be used on subsequent use even if the indexonlyfirst attribute (or attribute (or indexonlyfirst package option) is set. However, the package option) is set. However, the dualindex + id="dx1-28032"> attribute will honour the noindex key.
    -

    -

    The key.

    +

    +

    The \glsxtrdoautoindexname command will attempt to escape any of \makeindex’s special characters, but there may be special cases where it fails, so take + id="dx1-28034">’s special characters, but there may be special cases where it fails, so take care. This assumes the default makeindex actual, level, quote and encap values (unless any of the commands \actualchar, , \levelchar, , \quotechar or or \encapchar + id="dx1-28039"> 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  \GlsXtrSetEncapChar{char}

    -

    +

    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 document + id="dx1-29001"> environment. As mentioned in §1.2 glossaries-extra but can be enabled using the docdefs package options. -

    Although this can be problematic, the package options. +

    Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the document environment without the tricks used + id="dx1-29004"> environment without the tricks used with the docdefs option. option. There 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 \Glsxtrpl can’t be used after the glossaries have been displayed (through \printglossary etc). It’s best not to + id="dx1-29008"> etc). It’s best not to mix these commands with the standard glossary commands, such as \gls or there may be unexpected results.
    -

    -


    +


    \glsxtr  \glsxtr[gls-options][dfn-options]{label}

    -

    +

    If an entry with the label ⟨label⟩ has already been defined, this just does \gls @@ -9839,68 +10201,68 @@ 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 ⟨label⟩ and placed in the name key must be provided in the optional + id="dx1-29010"> 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  \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:

    -
    +
    \glsxtr[][plural=geese]{goose}  
     ... later  
    \glsxtr[][plural=geese]{goose}
    -

    -

    If you are considering doing something like: +

    +

    If you are considering doing something like:

    -
    +
    \newcommand*{\goose}{\glsxtr[][plural=geese]{goose}}  
    \renewcommand*{\GlsXtrWarning}[2]{}  
     ... 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 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  \glsxtrpl[gls-options][dfn-options]{label}

    -

    +

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



    \Glsxtr  \Glsxtr[gls-options][dfn-options]{label}

    -

    +

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



    \Glsxtrpl  \Glsxtrpl[gls-options][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 @@ -9954,24 +10316,24 @@ 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 under development called

    There is a new command line application under development called bib2gls, + id="dx1-30002">, which works in much the same way as bibtex. Instead of storing all your entry definitions in a \input or \loadglsentries, the entries can instead be stored in a .bib file and bib2gls can selectively write the appropriate + id="dx1-30004"> can selectively write the appropriate commands to a .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 .tex file that contains hundreds of definitions, but you only use a dozen or so in your document, then the build time is needlessly slowed by the unrequired definitions that occur when the file is input. -

    Although

    Although bib2gls isn’t ready yet, there have been some new commands and + id="dx1-30006"> isn’t ready yet, there have been some new commands and options added to glossaries-extra to help assist the integration of bib2gls into the + id="dx1-30008"> into the document build process. -

    An example of the contents of

    An example of the contents of .bib file that stores glossary entries that can be extracted with bib2gls: + id="dx1-30010">:

    -
    +
    @entry{bird,  
      name={bird},  
      description = {feathered animal}, @@ -10032,13 +10394,13 @@ class="cmtt-10">bib2gls  description={a waterbird with a long neck}  
    }
    -

    -

    The follow provides some abbreviations: +

    +

    The follow provides some abbreviations:

    -
    + -

    -

    Here are some symbols: +

    +

    Here are some symbols:

    -
    +
    preamble{"\providecommand{\mtx}[1]{\boldsymbol{#1}}"}  
    @symbol{M,  
      name={$\mtx{M}$}, @@ -10081,70 +10443,70 @@ preamble{"\providecommand{\mtx}[1]{\boldsymbol{#1}}"}  
      description={a set}  
    }
    -

    -

    To ensure that

    +

    To ensure that bib2gls can find out which entries have been used in the + id="dx1-30012"> can find out which entries have been used in the document, you need the record package. Option: + id="dx1-30013"> package. Option:

    -
    +
    \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 + id="dx1-30015"> can also sort the entries and collate the locations. +

    If you still want to use an indexing application (for example, you need a custom xindy rule), then just use record=alsoindex and continue to use and continue to use \makeglossaries and \printglossary (or \printglossaries), but instruct bib2gls to omit sorting + id="dx1-30019"> to omit sorting to save time. -

    The

    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 that sets ⟨filename\jobname: -



    \GlsXtrLoadResources  \GlsXtrLoadResources[options]

    -

    +

    On the first use, this command is a shortcut for

    }
    On subsequent use,9.1 this + id="x1-30022f1"> 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-30023f2"> -

    The options are ignored by

    The options are ignored by glossaries-extra but are picked up by bib2gls and are + id="dx1-30025"> and are used to supply various information, such as the name of the .bib files and any changes to the default behaviour. -

    Since the

    Since the .glstex won’t exist on the first LATEX run, the record package option + id="dx1-30026"> 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 bib2gls has created the has created the .glstex file the references should be resolved. -

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

    Since the

    Since the .glstex file only defines those references used within the document and the definitions have been written in the order corresponding to bib2gls sorted + id="dx1-30031"> sorted list, the glossaries can simply be displayed using \printunsrtglossary (or §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:

    -
    +
    \documentclass{article}  
    \usepackage[record]{glossaries-extra}  
    \setabbreviationstyle{long-short-desc} @@ -10268,18 +10630,18 @@ class="E">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:

    -
    +
    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, bird, shtml and M entries were added because bib2gls detected (from the detected (from the .aux file) that they had been used in the document. The other entries were added because bib2gls detected (from the detected (from the .bib files) that they are referenced by the used entries. In the case of duck and goose, they are in the see field for field for bird. In the case of ssi and html, they are referenced in the description field of field of 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:

    -
    +
    \documentclass{article}  
    \usepackage[record,abbreviations,symbols]{glossaries-extra}  
    \setabbreviationstyle{long-short-desc} @@ -10342,151 +10704,151 @@ methods:  
    \printunsrtglossaries  
    \end{document}
    -

    (By default, entries are sorted according to the operating system’s locale. +

    (By default, entries are sorted according to the operating system’s locale. If this doesn’t match the document language, you need to set this in the option list, for example sort=de-CH-1996 for Swiss German using the new orthography.) -

    Note that

    Note that \glsaddall doesn’t work in this case as it has to iterate over the glossary lists, which will be empty on the first run and on subsequent runs will only contain those entries that have been selected by bib2gls. Instead, if you want to + id="dx1-30039">. Instead, if you want to add all entries to the glossary, you need to tell bib2gls this in the options + id="dx1-30041"> this in the options list:

    -
    +
    \GlsXtrLoadResources[src={terms},selection={all}]
    -

    -

    The

    +

    The bib2gls user manual will contain more detail. + id="dx1-30043"> user manual will contain more detail.

    -

    -

    +

    Top

    10. Miscellaneous New Commands

    -

    The

    The glossaries package provides \glsrefentry entry to cross-reference entries + id="dx1-31001"> 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-31008"> 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-31009"> 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}{% @@ -10511,13 +10873,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

    \glsxtrfmt will simply do ⟨text⟩. The default ⟨options⟩ are given by -



    \GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

    -

    +

    @@ -10562,12 +10924,12 @@ replacement text of \GlsXtrFmtDefaultOptions is prepended to the optional argument of \glslink. -

    For example: +

    For example:

    -
    +
    \[  
      \glsxtrfmt{matrix}{A}  
      \glsxtrfmt{matrixinv}{A} @@ -10575,34 +10937,34 @@ class="cmtt-10">\glslink.  
      \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-32004"> 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 @@ -10613,17 +10975,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 @@ -10662,22 +11024,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-32009"> 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-32010"> 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}{} (ignoring the class="cmti-10">field⟩ argument), so by default it causes an error if the entry doesn’t exist. This can be changed to a warning with undefaction=warn. You can redefine + id="dx1-32014">. 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 @@ -10882,60 +11244,60 @@ class="cmti-10">code⟩} is still used, as for \GlsXtrSetField. -

    The

    The glossaries package provides \glsfieldfetch which can be used to fetch the + id="dx1-32024"> 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-32026"> 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-32028"> 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-32038">’s user manual for further details of these commands, in particular the limitations of \ifinlist. -

    When using the

    When using the record option, in addition to recording the usual location, you can + id="dx1-32039"> 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). -

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

    For example: +

    If you have any entries with the see key set, you will need the glossaries package +option seenoindex=ignore or seenoindex=warn to prevent an error occurring from the +automated \glssee normally triggered by this key. The record=only package option +will automatically deal with this. +

    For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \newglossaryentry{zebra}{name={zebra},description={stripy animal}} @@ -11221,98 +11598,98 @@ href="#sec:bib2gls">bib2gls: Managing Reference Databases

    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-33011"> 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-33012"> 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⟩]. -

    The

    The \printunsrtglossary command internally uses -



    \printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

    -

    +

    for each item in the list, where ⟨label⟩ is the current label. -

    By default this just does -


    By default this 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. -

    If you redefine the handler to exclude entries, you may end up with an empty +

    You can redefine the handler if required. +

    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} @@ -11321,10 +11698,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-33019"> 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: @@ -11332,7 +11709,7 @@ duplicate hypertarget names. For example:

    -
    +
    \printunsrtglossary*{%  
      \renewcommand{\printunsrtglossaryhandler}[1]{%  
        \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -11348,13 +11725,13 @@ duplicate hypertarget names. For example:  
      }%  
    }
    -

    If it’s a short summary at the start of a section, you might also want to suppress the +

    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} @@ -11372,12 +11749,12 @@ glossary header and add some vertical space afterwards:  
      \appto\glossarypostamble{\glspar\medskip\glspar}%  
    }
    -

    -

    There’s a shortcut command that does this: -


    +

    There’s a shortcut command that 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-33022"> (or record=alsoindex) package option. -

    This temporary change in the hypertarget prefix means you need to explicitly use + id="dx1-33023">) 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 @@ -11438,32 +11815,32 @@ 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 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-34001"> 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-34005"> key will automatically trigger
      }
    • If the hyperref package has been loaded then package has been loaded then \gls{entry-1} will link to ⟨entry-2⟩’s target. (Unless the targeturl attribute has been set for ⟨ attribute has been set for ⟨entry-1⟩’s category.) @@ -11493,18 +11870,18 @@ class="cmti-10">entry-1⟩’s
    • With record=off or or record=alsoindex, the , the noindex setting will automatically + id="dx1-34010"> 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 @@ -11512,95 +11889,95 @@ class="cmtt-10">\glssee) unless it’s been explicitly class="cmtt-10">\glsadd or if the indexing has been explicitly set using noindex=false. -

      Note that with

      Note that with record=only, the , 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-34017"> 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-35001"> (for prefixing) and glossaries-accsupp (for accessibility support). These packages aren’t + id="dx1-35002"> (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} @@ -11615,31 +11992,31 @@ example:  
    \printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    11.2 Accessibility Support

    -

    The

    The glossaries-accsupp needs to be loaded before needs to be loaded before glossaries-extra or through the accsupp package option: + id="dx1-37002"> 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-37007"> 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  
      {% @@ -11691,38 +12068,38 @@ class="cmss-10">glossaries-accsupp  {#1}%  
    }
    -

    (

    (\glsnameaccessdisplay is defined by the is defined by the glossaries-accsupp package.) The first + id="dx1-37009"> package.) The first letter upper case version is: -



    \Glsaccessname  \Glsaccessname{label}

    -

    +

    Without the glossaries-accsupp package this is just defined as: + id="dx1-37011"> package this is just defined as:

    -
    +
    \newcommand*{\Glsaccessname}[1]{\Glsentryname{#1}}
    -

    With the

    With the glossaries-accsupp package this is defined as: + id="dx1-37012"> package this is defined as:

    -
    +
    \newcommand*{\Glsaccessname}[1]{%  
      \glsnameaccessdisplay  
      {% @@ -11731,299 +12108,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-37016"> 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-37020"> 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-37024"> 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-37028"> 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-37032"> 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-37036"> 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-37040"> 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-37044"> 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-37048"> 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-37052"> 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-37056"> 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-37060"> 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.
    @@ -12097,7 +12474,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). @@ -12110,27 +12487,27 @@ class="description">Using entries in section/chapter headings. class="cmbx-10">sample-autoindex.tex
    Using the dualindex and and indexname attributes to + id="dx1-38004"> 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-38006">.
    sample-nested.tex
    Using \gls within the value of the within the value of the name key. + id="dx1-38008"> key.
    sample-entrycount.tex
    \printnoidxglossary. class="cmbx-10">sample-external.tex
    Uses the targeturl attribute to allow for entries that + id="dx1-38009"> 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.3 Entry Aliases.) @@ -12194,29 +12571,29 @@ 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-38012"> style (see §2.7.3 The §2.8.3 The glossaries-extra-stylemods Package).
    sample-alttree-sym.tex
    Another alttree example that measures the symbol + id="dx1-38013"> example that measures the symbol widths.
    sample-alttree-marginpar.tex
    Another alttree example that puts the + id="dx1-38014"> example that puts the number list in the margin.
    sample-onthefly.tex
    Using on-the-fly commands. Terms with accents must have the name key explicitly set. + id="dx1-38016"> key explicitly set.
    sample-onthefly-xetex.tex
    Using on-the-fly commands with XƎLATEX. Terms with UTF-8 characters don’t need to have the name key explicitly + id="dx1-38017"> key explicitly set. Terms that contain commands must have the name key explicitly set + id="dx1-38018"> key explicitly set with the commands removed from the label.
    Tries to emulate the previous sample file for use with LATEX through the starred version of \GlsXtrEnableOnTheFly. + id="dx1-38019">. This is a bit iffy and may not always work. Terms that contain commands must have the name key explicitly set with the commands removed from + id="dx1-38020"> key explicitly set with the commands removed from the label.
    sample-accsupp.tex
    Integrate glossaries-accsupp. + id="dx1-38021">.
    sample-prefix.tex
    Integrate glossaries-prefix. + id="dx1-38022">.
    sample-suppl-main.tex
    Uses thevalue to reference a location in the + id="dx1-38023"> to reference a location in the supplementary file sample-suppl.tex.
    @@ -12275,101 +12652,101 @@ class="cmbx-10">sample-suppl-main-hyp.tex
    A more complicated version to the above that uses the hyperref package to reference a location in the supplementary file + id="dx1-38024"> package to reference a location in the supplementary file sample-suppl-hyp.tex.
    -

    -

    +

    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-39002"> 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-39003"> 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-39005"> 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-39006"> 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

    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 +

    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 tracklang + id="dx1-39007"> 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}% @@ -12395,8 +12772,8 @@ class="cmtt-10">glossariesxtr-french.ldf.  
      \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 EX’s path so that it can be found by class="cmss-10">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 +

    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 +

    This document is incomplete. The external file associated with the glossary ‘⟨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 +

    You need to either replace \makenoidxglossaries with \makeglossaries or @@ -12514,17 +12891,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-39018"> 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. @@ -12578,13 +12955,13 @@ documented code for further details.

    Top

    Glossary

    + id="x1-4000013">Glossary

    bib2gls
    A command line Java application that selects entries from a .bib file and converts them to glossary definitions. At the time of writing, this application is still under development. Further details at: @@ -12595,7 +12972,7 @@ class="cmtt-10">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. @@ -12603,81 +12980,81 @@ 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-40007">, \glspl, , \Glspl, , \GLSpl or or \glsdisp. + id="dx1-40011">.
    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-40015">first use, which is governed by the first and and firstplural keys of keys of \newglossaryentry. (May be overridden by + id="dx1-40018">. (May be overridden by \glsdisp.) + id="dx1-40019">.)
    link-text
    The text produced by commands such as \gls. It may or may not + id="dx1-40021">. 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. @@ -12688,13 +13065,13 @@ class="cmtt-10">makeindex according to the document makeglossaries-lite.lua
    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.lua script. 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-40035"> package option.
    xindy
    An flexible indexing application with multilingual support written in Perl.

    Index

    + id="x1-4100013">Index

    A

    abbreviation styles (deprecated):
        footnote-em  1
    +href="glossaries-extra-manual.html#dx1-23130" >1
        footnote-sc  2
    +href="glossaries-extra-manual.html#dx1-23122" >2
        footnote-sm  3
    +href="glossaries-extra-manual.html#dx1-23126" >3
        long-desc-em  4
    +href="glossaries-extra-manual.html#dx1-22067" >4
        long-desc-sc  5
    +href="glossaries-extra-manual.html#dx1-22059" >5
        long-desc-sm  6
    +href="glossaries-extra-manual.html#dx1-22063" >6
        long-em  7
    +href="glossaries-extra-manual.html#dx1-22092" >7
        long-sc  8
    +href="glossaries-extra-manual.html#dx1-22084" >8
        long-sm  9
    +href="glossaries-extra-manual.html#dx1-22088" >9
        postfootnote-em  10
    +href="glossaries-extra-manual.html#dx1-23153" >10
        postfootnote-sc  11
    +href="glossaries-extra-manual.html#dx1-23145" >11
        postfootnote-sm  12
    +href="glossaries-extra-manual.html#dx1-23149" >12
    abbreviation styles:
        footnote  13
    +href="glossaries-extra-manual.html#dx1-23117" >13
        long  14
    +href="glossaries-extra-manual.html#dx1-22078" >14
        long-desc  15
    +href="glossaries-extra-manual.html#dx1-22053" >15
        long-em-noshort-em  16
    +href="glossaries-extra-manual.html#dx1-22093" >16
        long-em-noshort-em-desc  17
    +href="glossaries-extra-manual.html#dx1-22068" >17
        long-em-short-em  18, 19
    +href="glossaries-extra-manual.html#dx1-21043" >18, 19
        long-em-short-em-desc  20
    +href="glossaries-extra-manual.html#dx1-23049" >20
        long-noshort  21, 22, 23, 24, 25, 26, 27, 28
    +href="glossaries-extra-manual.html#dx1-12030" >21, 22, 23, 24, 25, 26, 27, 28
        long-noshort-desc  29, 30, 31, 32, 33, 34, 35, 36, 37
    +href="glossaries-extra-manual.html#dx1-11040" >29, 30, 31, 32, 33, 34, 35, 36, 37
        long-noshort-em  38
    +href="glossaries-extra-manual.html#dx1-22089" >38
        long-noshort-em-desc  39
    +href="glossaries-extra-manual.html#dx1-22064" >39
        long-noshort-sc  40, 41
    +href="glossaries-extra-manual.html#dx1-21042" >40, 41
        long-noshort-sc-desc  42
    +href="glossaries-extra-manual.html#dx1-22055" >42
        long-noshort-sm  43
    +href="glossaries-extra-manual.html#dx1-22085" >43
        long-noshort-sm-desc  44
    +href="glossaries-extra-manual.html#dx1-22060" >44
        long-postshort-user  45, 46
    +href="glossaries-extra-manual.html#dx1-23159" >45, 46
        long-postshort-user-desc  47
    +href="glossaries-extra-manual.html#dx1-23162" >47
        long-short  48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60
    +href="glossaries-extra-manual.html#dx1-11047" >48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60
        long-short-desc  61, 62, 63, 64, 65, 66, 67, 68, 69
    +href="glossaries-extra-manual.html#dx1-12016" >61, 62, 63, 64, 65, 66, 67, 68, 69
        long-short-em  70, 71, 72
    +href="glossaries-extra-manual.html#dx1-21044" >70, 71, 72
        long-short-em-desc  73, 74
    +href="glossaries-extra-manual.html#dx1-23046" >73, 74
        long-short-sc  75, 76, 77, 78, 79
    +href="glossaries-extra-manual.html#dx1-12004" >75, 76, 77, 78, 79
        long-short-sc-desc  80, 81
    +href="glossaries-extra-manual.html#dx1-12018" >80, 81
        long-short-sm  82, 83
    +href="glossaries-extra-manual.html#dx1-12006" >82, 83
        long-short-sm-desc  84, 85
    +href="glossaries-extra-manual.html#dx1-12020" >84, 85
        long-short-user  86, 87, 88, 89, 90, 91, 92, 93, 94
    +href="glossaries-extra-manual.html#dx1-21045" >86, 87, 88, 89, 90, 91, 92, 93, 94
        long-short-user-desc  95
    +href="glossaries-extra-manual.html#dx1-23052" >95
        postfootnote  96
    +href="glossaries-extra-manual.html#dx1-23140" >96
        short  97
    +href="glossaries-extra-manual.html#dx1-22007" >97
        short-desc  98
    +href="glossaries-extra-manual.html#dx1-22030" >98
        short-em  99
    +href="glossaries-extra-manual.html#dx1-22022" >99
        short-em-desc  100
    +href="glossaries-extra-manual.html#dx1-22045" >100
        short-em-footnote  101, 102
    +href="glossaries-extra-manual.html#dx1-21056" >101, 102
        short-em-footnote-desc  103
    +href="glossaries-extra-manual.html#dx1-21055" >103
        short-em-long  104, 105, 106
    +href="glossaries-extra-manual.html#dx1-23073" >104, 105, 106
        short-em-long-desc  107, 108
    +href="glossaries-extra-manual.html#dx1-23092" >107, 108
        short-em-long-em  109
    +href="glossaries-extra-manual.html#dx1-23076" >109
        short-em-long-em-desc  110
    +href="glossaries-extra-manual.html#dx1-23095" >110
        short-em-nolong  111, 112
    +href="glossaries-extra-manual.html#dx1-22019" >111, 112
        short-em-nolong-desc  113, 114
    +href="glossaries-extra-manual.html#dx1-22042" >113, 114
        short-em-postfootnote  115
    +href="glossaries-extra-manual.html#dx1-23150" >115
        short-footnote  116, 117, 118, 119, 120, 121, 122, 123, 124, 125
    +href="glossaries-extra-manual.html#dx1-12034" >116, 117, 118, 119, 120, 121, 122, 123, 124, 125
        short-footnote-desc  126
    +href="glossaries-extra-manual.html#dx1-12040" >126
        short-long  127, 128, 129, 130, 131, 132, 133, 134, 135
    +href="glossaries-extra-manual.html#dx1-12010" >127, 128, 129, 130, 131, 132, 133, 134, 135
        short-long-desc  136, 137, 138, 139, 140, 141, 142, 143
    +href="glossaries-extra-manual.html#dx1-12024" >136, 137, 138, 139, 140, 141, 142, 143
        short-long-user  144, 145, 146, 147, 148, 149, 150
    +href="glossaries-extra-manual.html#dx1-23028" >144, 145, 146, 147, 148, 149, 150
        short-long-user-desc  151
    +href="glossaries-extra-manual.html#dx1-23098" >151
        short-nolong  152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163
    +href="glossaries-extra-manual.html#dx1-17012" >152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163
        short-nolong-desc  164, 165, 166, 167
    +href="glossaries-extra-manual.html#dx1-22024" >164, 165, 166, 167
        short-postfootnote  168, 169, 170, 171, 172, 173, 174
    +href="glossaries-extra-manual.html#dx1-8058" >168, 169, 170, 171, 172, 173, 174
        short-postlong-user  175, 176, 177
    +href="glossaries-extra-manual.html#dx1-23154" >175, 176, 177
        short-postlong-user-desc  178
    +href="glossaries-extra-manual.html#dx1-23156" >178
        short-sc  179
    +href="glossaries-extra-manual.html#dx1-22012" >179
        short-sc-desc  180
    +href="glossaries-extra-manual.html#dx1-22035" >180
        short-sc-footnote  181, 182, 183, 184
    +href="glossaries-extra-manual.html#dx1-12036" >181, 182, 183, 184
        short-sc-footnote-desc  185
    +href="glossaries-extra-manual.html#dx1-12042" >185
        short-sc-long  186, 187, 188
    +href="glossaries-extra-manual.html#dx1-12012" >186, 187, 188
        short-sc-long-desc  189, 190
    +href="glossaries-extra-manual.html#dx1-12026" >189, 190
        short-sc-nolong  191, 192
    +href="glossaries-extra-manual.html#dx1-22009" >191, 192
        short-sc-nolong-desc  193, 194
    +href="glossaries-extra-manual.html#dx1-22032" >193, 194
        short-sc-postfootnote  195, 196
    +href="glossaries-extra-manual.html#dx1-21049" >195, 196
        short-sm  197
    +href="glossaries-extra-manual.html#dx1-22017" >197
        short-sm-desc  198
    +href="glossaries-extra-manual.html#dx1-22040" >198
        short-sm-footnote  199, 200
    +href="glossaries-extra-manual.html#dx1-12038" >199, 200
        short-sm-footnote-desc  201
    +href="glossaries-extra-manual.html#dx1-12044" >201
        short-sm-long  202, 203, 204
    +href="glossaries-extra-manual.html#dx1-12014" >202, 203, 204
        short-sm-long-desc  205, 206
    +href="glossaries-extra-manual.html#dx1-12028" >205, 206
        short-sm-nolong  207, 208
    +href="glossaries-extra-manual.html#dx1-22014" >207, 208
        short-sm-nolong-desc  209, 210
    +href="glossaries-extra-manual.html#dx1-22037" >209, 210
        short-sm-postfootnote  211
    +href="glossaries-extra-manual.html#dx1-23146" >211
    \abbreviationsname  212
    \abbrvpluralsuffix  213
    acronym styles (glossaries):
        dua  214
    +href="glossaries-extra-manual.html#dx1-12029" >214
        dua-desc  215
    +href="glossaries-extra-manual.html#dx1-12031" >215
        footnote  216
    +href="glossaries-extra-manual.html#dx1-12033" >216
        footnote-desc  217
    +href="glossaries-extra-manual.html#dx1-12039" >217
        footnote-sc  218
    +href="glossaries-extra-manual.html#dx1-12035" >218
        footnote-sc-desc  219
    +href="glossaries-extra-manual.html#dx1-12041" >219
        footnote-sm  220
    +href="glossaries-extra-manual.html#dx1-12037" >220
        footnote-sm-desc  221
    +href="glossaries-extra-manual.html#dx1-12043" >221
        long-sc-short  222
    +href="glossaries-extra-manual.html#dx1-12003" >222
        long-sc-short-desc  223
    +href="glossaries-extra-manual.html#dx1-12017" >223
        long-short-desc  224
    +href="glossaries-extra-manual.html#dx1-12015" >224
        long-sm-short  225
    +href="glossaries-extra-manual.html#dx1-12005" >225
        long-sm-short-desc  226
    +href="glossaries-extra-manual.html#dx1-12019" >226
        long-sp-short  227, 228
    +href="glossaries-extra-manual.html#dx1-12007" >227, 228
        long-sp-short-desc  229
    +href="glossaries-extra-manual.html#dx1-12021" >229
        sc-short-long  230
    +href="glossaries-extra-manual.html#dx1-12011" >230
        sc-short-long-desc  231
    +href="glossaries-extra-manual.html#dx1-12025" >231
        short-long  232
    +href="glossaries-extra-manual.html#dx1-12009" >232
        short-long-desc  233
    +href="glossaries-extra-manual.html#dx1-12023" >233
        sm-short-long  234
    +href="glossaries-extra-manual.html#dx1-12013" >234
        sm-short-long-desc  235
    +href="glossaries-extra-manual.html#dx1-12027" >235
    amsgen package  236
    \apptoglossarypreamble  237

    B @@ -13206,288 +13583,288 @@ class="cmbx-10">B class="cmss-10">babel package  238, 239, 240, 241, 242, 243, 244, 245
    +href="glossaries-extra-manual.html#dx1-4088" >240, 241, 242, 243, 244, 245
    bib2gls  246, 247, 248, 249, 250, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272
    bib2gls  273, 274, 275, 276, 277, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299

    C categories:
        abbreviation  300, 301, 302, 303
    +href="glossaries-extra-manual.html#dx1-9003" >300, 301, 302, 303
        acronym  304, 305, 306, 307, 308, 309
    +href="glossaries-extra-manual.html#dx1-8029" >304, 305, 306, 307, 308, 309
        general  310, 311, 312, 313, 314, 315, 316, 317
    +href="glossaries-extra-manual.html#dx1-8036" >310, 311, 312, 313, 314, 315, 316, 317
        index  318, 319
    +href="glossaries-extra-manual.html#dx1-5031" >318, 319
        number  320
    +href="glossaries-extra-manual.html#dx1-26018" >320
        symbol  321, 322
    +href="glossaries-extra-manual.html#dx1-8043" >321, 322
    category attributes:
        aposplural  323, 324, 325, 326
    +href="glossaries-extra-manual.html#dx1-10036" >323, 324, 325, 326
        discardperiod  327, 328, 329, 330, 331
    +href="glossaries-extra-manual.html#dx1-8032" >327, 328, 329, 330, 331
        dualindex  332, 333, 334, 335, 336, 337, 338
    +href="glossaries-extra-manual.html#dx1-26094" >332, 333, 334, 335, 336, 337, 338
        entrycount  339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349
    +href="glossaries-extra-manual.html#dx1-9002" >339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349
        externallocation  350
        glossdesc  351, 352, 353
    +href="glossaries-extra-manual.html#dx1-14004" >351, 352, 353
        glossdescfont  354, 355
    +href="glossaries-extra-manual.html#dx1-14005" >354, 355
        glossname  356, 357
    +href="glossaries-extra-manual.html#dx1-14003" >356, 357
        glossnamefont  358
    +href="glossaries-extra-manual.html#dx1-26092" >358
        headuc  359, 360, 361, 362
    +href="glossaries-extra-manual.html#dx1-11059" >359, 360, 361, 362
        indexname  363, 364, 365, 366, 367
    +href="glossaries-extra-manual.html#dx1-14009" >363, 364, 365, 366, 367
        indexonlyfirst  368, 369, 370
    +href="glossaries-extra-manual.html#dx1-26037" >369, 370
        insertdots  371, 372
    +href="glossaries-extra-manual.html#dx1-17004" >371, 372
        nohyper  373, 374, 375
    +href="glossaries-extra-manual.html#dx1-26034" >373, 374, 375
        nohyperfirst  376, 377, 378, 379, 380
    +href="glossaries-extra-manual.html#dx1-23107" >376, 377, 378, 379, 380
        noshortplural  381, 382, 383, 384, 385
    +href="glossaries-extra-manual.html#dx1-10037" >381, 382, 383, 384, 385
        pluraldiscardperiod  386, 387
    +href="glossaries-extra-manual.html#dx1-26048" >386, 387
        regular  388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407
    +href="glossaries-extra-manual.html#dx1-8010" >388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407
        retainfirstuseperiod  408
    +href="glossaries-extra-manual.html#dx1-26050" >408
        tagging  409, 410, 411, 412
    +href="glossaries-extra-manual.html#dx1-18002" >409, 410, 411, 412
        targetcategory  413
    +href="glossaries-extra-manual.html#dx1-26103" >413
        targetname  414, 415
    +href="glossaries-extra-manual.html#dx1-26100" >414, 415
        targeturl  416, 417, 418, 419, 420
    +href="glossaries-extra-manual.html#dx1-26098" >417, 418, 419, 420
        unitcount  421
    +href="glossaries-extra-manual.html#dx1-27030" >421
        wrgloss  422, 423
    +href="glossaries-extra-manual.html#dx1-26039" >423
    \cGLS  424
    \cGLSformat  425
    \cGLSpl  426
    \cGLSplformat  427
    \csGlsXtrLetField  428
    \CustomAbbreviationFields  429

    D @@ -13498,25 +13875,25 @@ href="glossaries-extra-manual.html#dx1-8" >430
    class="cmbx-10">E \eglssetwidest  431
    \eGlsXtrSetField  432
    entry location  433, 434, 435
    +href="glossaries-extra-manual.html#dx1-40023" >434, 435
    etoolbox package  436, 437, 438, 439, 440, 441
    +href="glossaries-extra-manual.html#dx1-26112" >437, 438, 439, 440, 441
    @@ -13524,1985 +13901,2073 @@ href="glossaries-extra-manual.html#dx1-31038" >441
    class="cmbx-10">F first use  442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495
    +href="glossaries-extra-manual.html#dx1-40013" >494, 495
    first use flag  496, 497, 498, 499, 496, 497, 498, 499, 500
    first use text  501, 502
    +href="glossaries-extra-manual.html#dx1-40037" >502
    fontenc package  503
    +href="glossaries-extra-manual.html#dx1-21024" >503

    G \gGlsXtrSetField  504
    glossaries package  505, 506, 507, 508, 509, 510, 511, 512, 513
    +href="glossaries-extra-manual.html#dx1-5019" >505, 506, 507, 508, 509, 510, 511, 512, 513, 514, 515
    glossaries-accsupp package  514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 527, 528
    +href="glossaries-extra-manual.html#dx1-4003" >516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 527, 528, 529, 530
    glossaries-extra package  529, 530
    +href="glossaries-extra-manual.html#dx1-5021" >531, 532
    glossaries-extra-stylemods package  531, 532, 533, 534
    +href="glossaries-extra-manual.html#dx1-4012" >533, 534, 535, 536
    glossaries-prefix package  535, 536, 537
    +href="glossaries-extra-manual.html#dx1-35001" >537, 538, 539
    \glossariesextrasetup  538
    +href="glossaries-extra-manual.html#dx1-4122" >540
    glossary styles:
        alttree  539, 540, 541, 542, 543, 544, 545
    +href="glossaries-extra-manual.html#dx1-16010" >541, 542, 543, 544, 545, 546, 547
        inline  546, 547
    +href="glossaries-extra-manual.html#dx1-16006" >548, 549
        long3col  548
    +href="glossaries-extra-manual.html#dx1-16004" >550
    glossary-inline package  549
    +href="glossaries-extra-manual.html#dx1-16007" >551
    glossary-tree package  550, 551, 552
    +href="glossaries-extra-manual.html#dx1-16011" >552, 553, 554
    \glossxtrsetpopts  553
    +href="glossaries-extra-manual.html#dx1-11058" >555
    \glsabbrvdefaultfont  554
    +href="glossaries-extra-manual.html#dx1-17021" >556
    \glsabbrvemfont  555
    +href="glossaries-extra-manual.html#dx1-21038" >557
    \glsabbrvfont  556, 557
    +href="glossaries-extra-manual.html#dx1-17018" >558, 559
    \glsabbrvuserfont  558
    +href="glossaries-extra-manual.html#dx1-23031" >560
    \Glsaccessdesc  559
    +href="glossaries-extra-manual.html#dx1-37039" >561
    \glsaccessdesc  560
    +href="glossaries-extra-manual.html#dx1-37037" >562
    \Glsaccessdescplural  561
    +href="glossaries-extra-manual.html#dx1-37043" >563
    \glsaccessdescplural  562
    +href="glossaries-extra-manual.html#dx1-37041" >564
    \Glsaccessfirst  563
    +href="glossaries-extra-manual.html#dx1-37023" >565
    \glsaccessfirst  564
    +href="glossaries-extra-manual.html#dx1-37021" >566
    \Glsaccessfirstplural  565
    +href="glossaries-extra-manual.html#dx1-37027" >567
    \glsaccessfirstplural  566
    +href="glossaries-extra-manual.html#dx1-37025" >568
    \Glsaccesslong  567
    +href="glossaries-extra-manual.html#dx1-37055" >569
    \glsaccesslong  568
    +href="glossaries-extra-manual.html#dx1-37053" >570
    \Glsaccesslongpl  569
    +href="glossaries-extra-manual.html#dx1-37059" >571
    \glsaccesslongpl  570
    +href="glossaries-extra-manual.html#dx1-37057" >572
    \Glsaccessname  571
    +href="glossaries-extra-manual.html#dx1-37010" >573
    \glsaccessname  572
    +href="glossaries-extra-manual.html#dx1-37005" >574
    \Glsaccessplural  573
    +href="glossaries-extra-manual.html#dx1-37019" >575
    \glsaccessplural  574
    +href="glossaries-extra-manual.html#dx1-37017" >576
    \Glsaccessshort  575
    +href="glossaries-extra-manual.html#dx1-37047" >577
    \glsaccessshort  576
    +href="glossaries-extra-manual.html#dx1-37045" >578
    \Glsaccessshortpl  577
    +href="glossaries-extra-manual.html#dx1-37051" >579
    \glsaccessshortpl  578
    +href="glossaries-extra-manual.html#dx1-37049" >580
    \Glsaccesssymbol  579
    +href="glossaries-extra-manual.html#dx1-37031" >581
    \glsaccesssymbol  580
    +href="glossaries-extra-manual.html#dx1-37029" >582
    \Glsaccesssymbolplural  581
    +href="glossaries-extra-manual.html#dx1-37035" >583
    \glsaccesssymbolplural  582
    +href="glossaries-extra-manual.html#dx1-37033" >584
    \Glsaccesstext  583
    +href="glossaries-extra-manual.html#dx1-37015" >585
    \glsaccesstext  584
    +href="glossaries-extra-manual.html#dx1-37013" >586
    \glsacspace  585
    +href="glossaries-extra-manual.html#dx1-12052" >587
    \glsacspacemax  586
    +href="glossaries-extra-manual.html#dx1-12054" >588
    \glsadd options
        theHvalue  587, 588
    +href="glossaries-extra-manual.html#dx1-6018" >589, 590
        thevalue  589, 590, 591
    +href="glossaries-extra-manual.html#dx1-6017" >591, 592, 593
    \glscategory  592
    +href="glossaries-extra-manual.html#dx1-26019" >594
    \glscategorylabel  593
    +href="glossaries-extra-manual.html#dx1-24033" >595
    \glscurrententrylabel  594
    +href="glossaries-extra-manual.html#dx1-14016" >596
    \glsentrycurrcount  595
    +href="glossaries-extra-manual.html#dx1-27031" >597
    \glsentryprevcount  596
    +href="glossaries-extra-manual.html#dx1-27032" >598
    \glsentryprevmaxcount  597
    +href="glossaries-extra-manual.html#dx1-27034" >599
    \glsentryprevtotalcount  598
    +href="glossaries-extra-manual.html#dx1-27033" >600
    \glsFindWidestAnyName  599
    +href="glossaries-extra-manual.html#dx1-16024" >601
    \glsFindWidestAnyNameLocation  600
    +href="glossaries-extra-manual.html#dx1-16036" >602
    \glsFindWidestAnyNameSymbol  601
    +href="glossaries-extra-manual.html#dx1-16028" >603
    \glsFindWidestAnyNameSymbolLocation  602
    +href="glossaries-extra-manual.html#dx1-16033" >604
    \glsFindWidestLevelTwo  603
    +href="glossaries-extra-manual.html#dx1-16026" >605
    \glsFindWidestTopLevelName  604
    +href="glossaries-extra-manual.html#dx1-16019" >606
    \glsFindWidestUsedAnyName  605
    +href="glossaries-extra-manual.html#dx1-16022" >607
    \glsFindWidestUsedAnyNameLocation  606
    +href="glossaries-extra-manual.html#dx1-16034" >608
    \glsFindWidestUsedAnyNameSymbol  607
    +href="glossaries-extra-manual.html#dx1-16027" >609
    \glsFindWidestUsedAnyNameSymbolLocation  608
    +href="glossaries-extra-manual.html#dx1-16029" >610
    \glsFindWidestUsedLevelTwo  609
    +href="glossaries-extra-manual.html#dx1-16025" >611
    \glsFindWidestUsedTopLevelName  610
    +href="glossaries-extra-manual.html#dx1-16020" >612
    \glsfirstabbrvdefaultfont  611
    +href="glossaries-extra-manual.html#dx1-17024" >613
    \glsfirstabbrvemfont  612
    +href="glossaries-extra-manual.html#dx1-21039" >614
    \glsfirstabbrvfont  613, 614
    +href="glossaries-extra-manual.html#dx1-17016" >615, 616
    \glsfirstlongdefaultfont  615
    +href="glossaries-extra-manual.html#dx1-17030" >617
    \glsfirstlongemfont  616
    +href="glossaries-extra-manual.html#dx1-17032" >618
    \glsfirstlongfont  617, 618
    +href="glossaries-extra-manual.html#dx1-17026" >619, 620
    \glsfirstlongfootnotefont  619
    +href="glossaries-extra-manual.html#dx1-23112" >621
    \Glsfmtfirst  620
    +href="glossaries-extra-manual.html#dx1-25040" >622
    \glsfmtfirst  621
    +href="glossaries-extra-manual.html#dx1-25039" >623
    \Glsfmtfirstpl  622
    +href="glossaries-extra-manual.html#dx1-25042" >624
    \glsfmtfirstpl  623
    +href="glossaries-extra-manual.html#dx1-25041" >625
    \Glsfmtfull  624
    +href="glossaries-extra-manual.html#dx1-25031" >626
    \glsfmtfull  625
    +href="glossaries-extra-manual.html#dx1-25029" >627
    \Glsfmtfullpl  626
    +href="glossaries-extra-manual.html#dx1-25032" >628
    \glsfmtfullpl  627
    +href="glossaries-extra-manual.html#dx1-25030" >629
    \Glsfmtlong  628
    +href="glossaries-extra-manual.html#dx1-25027" >630
    \glsfmtlong  629
    +href="glossaries-extra-manual.html#dx1-25025" >631
    \Glsfmtlongpl  630
    +href="glossaries-extra-manual.html#dx1-25028" >632
    \glsfmtlongpl  631
    +href="glossaries-extra-manual.html#dx1-25026" >633
    \Glsfmtplural  632
    +href="glossaries-extra-manual.html#dx1-25037" >634
    \glsfmtplural  633
    +href="glossaries-extra-manual.html#dx1-25036" >635
    \Glsfmtshort  634
    +href="glossaries-extra-manual.html#dx1-25023" >636
    \glsfmtshort  635
    +href="glossaries-extra-manual.html#dx1-25021" >637
    \Glsfmtshortpl  636
    +href="glossaries-extra-manual.html#dx1-25024" >638
    \glsfmtshortpl  637
    +href="glossaries-extra-manual.html#dx1-25022" >639
    \Glsfmttext  638
    +href="glossaries-extra-manual.html#dx1-25035" >640
    \glsfmttext  639
    +href="glossaries-extra-manual.html#dx1-25034" >641
    \glsforeachwithattribute  640
    +href="glossaries-extra-manual.html#dx1-26127" >642
    \glsgetattribute  641
    +href="glossaries-extra-manual.html#dx1-26110" >643
    \glsgetcategoryattribute  642
    +href="glossaries-extra-manual.html#dx1-26109" >644
    \glsgetwidestname  643
    +href="glossaries-extra-manual.html#dx1-16016" >645
    \glsgetwidestsubname  644
    +href="glossaries-extra-manual.html#dx1-16017" >646
    \glshasattribute  645
    +href="glossaries-extra-manual.html#dx1-26113" >647
    \glshascategoryattribute  646
    +href="glossaries-extra-manual.html#dx1-26111" >648
    \glsifattribute  647
    +href="glossaries-extra-manual.html#dx1-26118" >649
    \glsifcategory  648
    +href="glossaries-extra-manual.html#dx1-26020" >650
    \glsifcategoryattribute  649
    +href="glossaries-extra-manual.html#dx1-26114" >651
    \glsifnotregular  650
    +href="glossaries-extra-manual.html#dx1-26125" >652
    \glsifnotregularcategory  651
    +href="glossaries-extra-manual.html#dx1-26124" >653
    \glsifregular  652
    +href="glossaries-extra-manual.html#dx1-26121" >654
    \glsifregularcategory  653
    +href="glossaries-extra-manual.html#dx1-26120" >655
    \glskeylisttok  654
    +href="glossaries-extra-manual.html#dx1-24031" >656
    \glslabeltok  655
    +href="glossaries-extra-manual.html#dx1-24030" >657
    \glslink options
        format  656, 657
    +href="glossaries-extra-manual.html#dx1-28021" >658, 659
        hyper  658, 659, 660
    +href="glossaries-extra-manual.html#dx1-11055" >660, 661, 662
        hyper=false  661
    +href="glossaries-extra-manual.html#dx1-25016" >663
        noindex  662, 663, 664, 665, 666, 667, 668
    +href="glossaries-extra-manual.html#dx1-6001" >664, 665, 666, 667, 668, 669, 670
        wrgloss  669, 670, 671, 672
    +href="glossaries-extra-manual.html#dx1-6009" >671, 672, 673, 674
    \glslinkcheckfirsthyperhook  673
    +href="glossaries-extra-manual.html#dx1-27038" >675
    \glslongdefaultfont  674
    +href="glossaries-extra-manual.html#dx1-17031" >676
    \glslongemfont  675
    +href="glossaries-extra-manual.html#dx1-17033" >677
    \glslongfont  676, 677
    +href="glossaries-extra-manual.html#dx1-17028" >678, 679
    \glslongfootnotefont  678
    +href="glossaries-extra-manual.html#dx1-23114" >680
    \glslongpltok  679
    +href="glossaries-extra-manual.html#dx1-24027" >681
    \glslongtok  680
    +href="glossaries-extra-manual.html#dx1-24026" >682
    \glsnoidxdisplayloc  681
    +href="glossaries-extra-manual.html#dx1-8074" >683
    \glsps  682
    +href="glossaries-extra-manual.html#dx1-11053" >684
    \glspt  683
    +href="glossaries-extra-manual.html#dx1-11054" >685
    \glssetattribute  684
    +href="glossaries-extra-manual.html#dx1-26108" >686
    \glssetcategoryattribute  685
    +href="glossaries-extra-manual.html#dx1-26105" >687
    \glssetregularcategory  686
    +href="glossaries-extra-manual.html#dx1-26107" >688
    \glsshortpltok  687
    +href="glossaries-extra-manual.html#dx1-24023" >689
    \glsshorttok  688
    +href="glossaries-extra-manual.html#dx1-24022" >690
    \Glsxtr  689
    +href="glossaries-extra-manual.html#dx1-29014" >691
    \glsxtr  690
    +href="glossaries-extra-manual.html#dx1-29009" >692
    \glsxtrabbrvfootnote  691
    +href="glossaries-extra-manual.html#dx1-23115" >693
    \glsxtrabbrvpluralsuffix  692
    +href="glossaries-extra-manual.html#dx1-10035" >694
    \glsxtraddallcrossrefs  693
    +href="glossaries-extra-manual.html#dx1-7010" >695
    \glsxtralias  694
    +href="glossaries-extra-manual.html#dx1-34021" >696
    \glsxtrAltTreeIndent  695
    +href="glossaries-extra-manual.html#dx1-16042" >697
    \glsxtralttreeInit  696
    +href="glossaries-extra-manual.html#dx1-16041" >698
    \glsxtralttreeSubSymbolDescLocation  697
    +href="glossaries-extra-manual.html#dx1-16039" >699
    \glsxtralttreeSymbolDescLocation  698
    +href="glossaries-extra-manual.html#dx1-16038" >700
    +\glsxtrautoindex  701
    +\glsxtrautoindexassignsort  702
    +\glsxtrautoindexentry  703
    \glsxtrchecknohyperfirst  699
    +href="glossaries-extra-manual.html#dx1-26033" >704
    \glsxtrcopytoglossary  700
    +href="glossaries-extra-manual.html#dx1-31007" >705
    \glsxtrdeffield  701
    +href="glossaries-extra-manual.html#dx1-32015" >706
    \glsxtrdisplayendloc  702
    +href="glossaries-extra-manual.html#dx1-8077" >707
    \glsxtrdisplayendlochook  703
    +href="glossaries-extra-manual.html#dx1-8079" >708
    \glsxtrdisplaysingleloc  704
    +href="glossaries-extra-manual.html#dx1-8075" >709
    \glsxtrdisplaystartloc  705
    +href="glossaries-extra-manual.html#dx1-8076" >710
    \glsxtrdoautoindexname  706
    +href="glossaries-extra-manual.html#dx1-28009" >711
    \glsxtrdowrglossaryhook  707
    +class="cmti-10">712
    \glsxtredeffield  708
    +href="glossaries-extra-manual.html#dx1-32017" >713
    \GlsXtrEnableEntryCounting  709
    +href="glossaries-extra-manual.html#dx1-27023" >714
    \GlsXtrEnableEntryUnitCounting  710
    +href="glossaries-extra-manual.html#dx1-27026" >715
    \GlsXtrEnableIndexFormatOverride  711
    +href="glossaries-extra-manual.html#dx1-28024" >716
    \GlsXtrEnableInitialTagging  712
    +href="glossaries-extra-manual.html#dx1-18001" >717
    \GlsXtrEnableOnTheFly  713
    +href="glossaries-extra-manual.html#dx1-29007" >718
    \GlsXtrEnablePreLocationTag  714
    +href="glossaries-extra-manual.html#dx1-15010" >719
    \glsxtrentryfmt  715
    +href="glossaries-extra-manual.html#dx1-32005" >720
    \glsxtrfielddolistloop  716
    +href="glossaries-extra-manual.html#dx1-32034" >721
    \glsxtrfieldforlistloop  717
    +href="glossaries-extra-manual.html#dx1-32035" >722
    \glsxtrfieldifinlist  718
    +href="glossaries-extra-manual.html#dx1-32036" >723
    \glsxtrfieldlistadd  719
    +href="glossaries-extra-manual.html#dx1-32030" >724
    \glsxtrfieldlisteadd  720
    +href="glossaries-extra-manual.html#dx1-32032" >725
    \glsxtrfieldlistgadd  721
    +href="glossaries-extra-manual.html#dx1-32031" >726
    \glsxtrfieldlistxadd  722
    +href="glossaries-extra-manual.html#dx1-32033" >727
    \glsxtrfieldtitlecasecs  723
    +href="glossaries-extra-manual.html#dx1-26082" >728
    \glsxtrfieldxifinlist  724
    +href="glossaries-extra-manual.html#dx1-32037" >729
    \glsxtrfirstscfont  725
    +href="glossaries-extra-manual.html#dx1-21026" >730
    \glsxtrfirstsmfont  726
    +href="glossaries-extra-manual.html#dx1-21033" >731
    \glsxtrfmt  727
    +href="glossaries-extra-manual.html#dx1-32002" >732
    + + + \GlsXtrFmtDefaultOptions  728
    +href="glossaries-extra-manual.html#dx1-32003" >733
    \GlsXtrFmtField  729
    +href="glossaries-extra-manual.html#dx1-32001" >734
    \GlsXtrFormatLocationList  730
    - - - +href="glossaries-extra-manual.html#dx1-15002" >735
    \GLSxtrfull  731
    +href="glossaries-extra-manual.html#dx1-19024" >736
    \Glsxtrfull  732
    +href="glossaries-extra-manual.html#dx1-19021" >737
    \glsxtrfull  733
    +href="glossaries-extra-manual.html#dx1-19014" >738
    \Glsxtrfullformat  734
    +href="glossaries-extra-manual.html#dx1-24053" >739
    \glsxtrfullformat  735
    +href="glossaries-extra-manual.html#dx1-24049" >740
    \GLSxtrfullpl  736
    +href="glossaries-extra-manual.html#dx1-19033" >741
    \Glsxtrfullpl  737
    +href="glossaries-extra-manual.html#dx1-19032" >742
    \glsxtrfullpl  738
    +href="glossaries-extra-manual.html#dx1-19031" >743
    \Glsxtrfullplformat  739
    +href="glossaries-extra-manual.html#dx1-24061" >744
    \glsxtrfullplformat  740
    +href="glossaries-extra-manual.html#dx1-24057" >745
    \glsxtrfullsep  741
    +href="glossaries-extra-manual.html#dx1-21040" >746
    \glsxtrifcounttrigger  742
    +href="glossaries-extra-manual.html#dx1-27017" >747
    \glsxtrifkeydefined  743
    +href="glossaries-extra-manual.html#dx1-32007" >748
    \glsxtrifwasfirstuse  744
    +href="glossaries-extra-manual.html#dx1-8049" >749
    \glsxtrindexaliased  745
    +href="glossaries-extra-manual.html#dx1-34019" >750
    +\glsxtrindexseealso  751
    \glsxtrinitwrgloss  746
    +class="cmti-10">752
    \Glsxtrinlinefullformat  747
    +href="glossaries-extra-manual.html#dx1-24068" >753
    \glsxtrinlinefullformat  748
    +href="glossaries-extra-manual.html#dx1-24065" >754
    \Glsxtrinlinefullplformat  749
    +href="glossaries-extra-manual.html#dx1-24075" >755
    \glsxtrinlinefullplformat  750
    +href="glossaries-extra-manual.html#dx1-24072" >756
    \glsxtrinsertinsidetrue  751
    +href="glossaries-extra-manual.html#dx1-17034" >757
    \GlsXtrLetField  752
    +href="glossaries-extra-manual.html#dx1-32021" >758
    \GlsXtrLetFieldToField  753
    +href="glossaries-extra-manual.html#dx1-32023" >759
    \GlsXtrLoadResources  754
    +href="glossaries-extra-manual.html#dx1-30021" >760
    \glsxtrlocrangefmt  755
    +href="glossaries-extra-manual.html#dx1-8078" >761
    \Glsxtrlong  756, 757
    +href="glossaries-extra-manual.html#dx1-19020" >762, 763
    \glsxtrlong  758
    +href="glossaries-extra-manual.html#dx1-19012" >764
    \GLSxtrlongpl  759
    +href="glossaries-extra-manual.html#dx1-19030" >765
    \Glsxtrlongpl  760
    +href="glossaries-extra-manual.html#dx1-19029" >766
    \glsxtrlongpl  761
    +href="glossaries-extra-manual.html#dx1-19028" >767
    \glsxtrlongshortdescsort  762
    +href="glossaries-extra-manual.html#dx1-23038" >768
    \glsxtrnewnumber  763
    +href="glossaries-extra-manual.html#dx1-4102" >769
    \glsxtrnewsymbol  764
    +href="glossaries-extra-manual.html#dx1-4099" >770
    \GlsXtrNoGlsWarningAutoMake  765
    +href="glossaries-extra-manual.html#dx1-39017" >771
    \GlsXtrNoGlsWarningBuildInfo  766
    +href="glossaries-extra-manual.html#dx1-39016" >772
    \GlsXtrNoGlsWarningCheckFile  767
    +href="glossaries-extra-manual.html#dx1-39012" >773
    \GlsXtrNoGlsWarningEmptyMain  768
    +href="glossaries-extra-manual.html#dx1-39010" >774
    \GlsXtrNoGlsWarningEmptyNotMain  769
    +href="glossaries-extra-manual.html#dx1-39011" >775
    \GlsXtrNoGlsWarningEmptyStart  770
    +href="glossaries-extra-manual.html#dx1-39009" >776
    \GlsXtrNoGlsWarningHead  771
    +href="glossaries-extra-manual.html#dx1-39008" >777
    \GlsXtrNoGlsWarningMisMatch  772
    +href="glossaries-extra-manual.html#dx1-39013" >778
    \GlsXtrNoGlsWarningNoOut  773
    +href="glossaries-extra-manual.html#dx1-39014" >779
    + + + \GlsXtrNoGlsWarningTail  774
    +href="glossaries-extra-manual.html#dx1-39015" >780
    \Glsxtrp  775, 776
    +href="glossaries-extra-manual.html#dx1-11061" >781, 782
    \glsxtrp  777
    +href="glossaries-extra-manual.html#dx1-11052" >783
    \glsxtrpageref  778
    - - - +href="glossaries-extra-manual.html#dx1-31004" >784
    \Glsxtrpl  779
    +href="glossaries-extra-manual.html#dx1-29015" >785
    \glsxtrpl  780
    +href="glossaries-extra-manual.html#dx1-29013" >786
    \glsxtrpostdescription  781
    +href="glossaries-extra-manual.html#dx1-14012" >787
    \glsxtrpostlink  782
    +href="glossaries-extra-manual.html#dx1-8033" >788
    \glsxtrpostlinkAddDescOnFirstUse  783
    +href="glossaries-extra-manual.html#dx1-8040" >789
    \glsxtrpostlinkAddSymbolOnFirstUse  784
    +href="glossaries-extra-manual.html#dx1-8044" >790
    \glsxtrpostlinkendsentence  785
    +href="glossaries-extra-manual.html#dx1-8034" >791
    \glsxtrpostlinkhook  786
    +href="glossaries-extra-manual.html#dx1-8031" >792
    \glsxtrpostlongdescription  787
    +href="glossaries-extra-manual.html#dx1-5018" >793
    \glsxtrpostnamehook  788
    +href="glossaries-extra-manual.html#dx1-14008" >794
    \GlsXtrPostNewAbbreviation  789
    +href="glossaries-extra-manual.html#dx1-24017" >795
    \glsxtrprovidestoragekey  790
    +href="glossaries-extra-manual.html#dx1-32006" >796
    \GlsXtrRecordCounter  791
    +href="glossaries-extra-manual.html#dx1-32040" >797
    \glsxtrregularfont  792
    +href="glossaries-extra-manual.html#dx1-8026" >798
    \glsxtrresourcefile  793
    +href="glossaries-extra-manual.html#dx1-30020" >799
    \glsxtrRevertMarks  794
    +href="glossaries-extra-manual.html#dx1-25012" >800
    \glsxtrscfont  795
    +href="glossaries-extra-manual.html#dx1-21025" >801
    \glsxtrscsuffix  796
    +href="glossaries-extra-manual.html#dx1-21027" >802
    +\glsxtrseealsolabels  803
    +\glsxtrseelist  804
    \GlsXtrSetActualChar  797
    +href="glossaries-extra-manual.html#dx1-28040" >805
    \glsxtrsetaliasnoindex  798
    +href="glossaries-extra-manual.html#dx1-34016" >806
    \GlsXtrSetAltModifier  799
    +href="glossaries-extra-manual.html#dx1-8072" >807
    \glsxtrsetcategory  800
    +href="glossaries-extra-manual.html#dx1-26129" >808
    \glsxtrsetcategoryforall  801
    +href="glossaries-extra-manual.html#dx1-26131" >809
    \GlsXtrSetDefaultGlsOpts  802
    +href="glossaries-extra-manual.html#dx1-8067" >810
    \GlsXtrSetEncapChar  803
    +href="glossaries-extra-manual.html#dx1-28043" >811
    \GlsXtrSetEscChar  804
    +href="glossaries-extra-manual.html#dx1-28042" >812
    \GlsXtrSetField  805
    +href="glossaries-extra-manual.html#dx1-32011" >813
    \glsxtrsetfieldifexists  806
    +href="glossaries-extra-manual.html#dx1-32012" >814
    \glsxtrsetgrouptitle  807
    +href="glossaries-extra-manual.html#dx1-13005" >815
    \GlsXtrSetLevelChar  808
    +href="glossaries-extra-manual.html#dx1-28041" >816
    \glsxtrsetpopts  809
    +href="glossaries-extra-manual.html#dx1-11057" >817
    \Glsxtrshort  810, 811
    +href="glossaries-extra-manual.html#dx1-19019" >818, 819
    \glsxtrshort  812
    +href="glossaries-extra-manual.html#dx1-19010" >820
    \GLSxtrshortpl  813
    +href="glossaries-extra-manual.html#dx1-19027" >821
    \Glsxtrshortpl  814
    +href="glossaries-extra-manual.html#dx1-19026" >822
    \glsxtrshortpl  815
    +href="glossaries-extra-manual.html#dx1-19025" >823
    \glsxtrsmfont  816
    +href="glossaries-extra-manual.html#dx1-21032" >824
    \glsxtrsmsuffix  817
    +href="glossaries-extra-manual.html#dx1-21036" >825
    \glsxtrtagfont  818
    +href="glossaries-extra-manual.html#dx1-18003" >826
    \glsxtrunsrtdo  819
    +href="glossaries-extra-manual.html#dx1-33015" >827
    + + + \GlsXtrUseAbbrStyleFmts  820
    +href="glossaries-extra-manual.html#dx1-24079" >828
    \GlsXtrUseAbbrStyleSetup  821
    +href="glossaries-extra-manual.html#dx1-24034" >829
    \Glsxtrusefield  822
    +href="glossaries-extra-manual.html#dx1-32027" >830
    \glsxtrusefield  823
    +href="glossaries-extra-manual.html#dx1-32025" >831
    \glsxtruserfield  824
    +href="glossaries-extra-manual.html#dx1-23023" >832
    \glsxtruserparen  825
    - - - +href="glossaries-extra-manual.html#dx1-23026" >833
    \glsxtrusersuffix  826
    +href="glossaries-extra-manual.html#dx1-23032" >834
    \glsxtrusesee  827
    +href="glossaries-extra-manual.html#dx1-7020" >835
    +\glsxtruseseealso  836
    \glsxtruseseeformat  828
    +href="glossaries-extra-manual.html#dx1-7021" >837, 838
    \GlsXtrWarnDeprecatedAbbrStyle  829
    +href="glossaries-extra-manual.html#dx1-21057" >839
    \GlsXtrWarning  830
    +href="glossaries-extra-manual.html#dx1-29011" >840

    H hyperref package  831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848
    +href="glossaries-extra-manual.html#dx1-6025" >841, 842, 843, 844, 845, 846, 847, 848, 849, 850, 851, 852, 853, 854, 855, 856, 857, 858

    I \ifglsxtrinitwrglossbefore  849
    +class="cmti-10">859

    L link-text  850, 851, 852, 853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865, 866, 867
    +href="glossaries-extra-manual.html#dx1-8001" >860, 861, 862, 863, 864, 865, 866, 867, 868, 869, 870, 871, 872, 873, 874, 875, 876, 877
    location list  868, 869, 870, 871, 872
    +href="glossaries-extra-manual.html#dx1-8073" >878, 879, 880, 881, 882
    \longnewglossaryentry  873
    +href="glossaries-extra-manual.html#dx1-5016" >883

    M makeglossaries  874, 875, 876, 877, 878
    +href="glossaries-extra-manual.html#dx1-3026" >884, 885, 886, 887, 888
    \makeglossaries  879
    +href="glossaries-extra-manual.html#dx1-5033" >889
    makeglossaries-lite.lua  880, 881
    +href="glossaries-extra-manual.html#dx1-5036" >890, 891
    makeglossaries-lite.lua  882, 883
    +href="glossaries-extra-manual.html#dx1-5037" >892, 893
    makeindex  884, 885, 886, 887, 888, 889, 890, 891, 892, 893
    +href="glossaries-extra-manual.html#dx1-3021" >894, 895, 896, 897, 898, 899, 900, 901, 902, 903
    +makeindex  904
    memoir class  894
    +href="glossaries-extra-manual.html#dx1-3020" >905
    mfirstuc package  895, 896, 897
    +href="glossaries-extra-manual.html#dx1-3" >906, 907, 908

    N \newabbreviation  898
    +href="glossaries-extra-manual.html#dx1-17002" >909
    \newabbreviationstyle  899
    +href="glossaries-extra-manual.html#dx1-24001" >910
    \newacronym  900
    +href="glossaries-extra-manual.html#dx1-17011" >911
    \newglossaryentry options
        alias  901, 902, 903, 904, 905
    +href="glossaries-extra-manual.html#dx1-5010" >912, 913, 914, 915, 916, 917
        category  906, 907, 908, 909, 910
    +href="glossaries-extra-manual.html#dx1-5009" >918, 919, 920, 921, 922
    + + +     desc  911, 912
    +href="glossaries-extra-manual.html#dx1-37038" >923, 924
        descplural  913, 914
    +href="glossaries-extra-manual.html#dx1-37042" >925, 926
        description  915, 916, 917, 918, 919, 920, 921, 922, 923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933
    +href="glossaries-extra-manual.html#dx1-21052" >927, 928, 929, 930, 931, 932, 933, 934, 935, 936, 937, 938, 939, 940, 941, 942, 943, 944, 945
        descriptionplural  934, 935, 936, 937
    +href="glossaries-extra-manual.html#dx1-5017" >946, 947, 948, 949
        first  938, 939, 940, 941, 942, 943, 944, 945, 946, 947, 948, 949
    +href="glossaries-extra-manual.html#dx1-8013" >950, 951, 952, 953, 954, 955, 956, 957, 958, 959, 960, 961, 962
        firstplural  950, 951, 952, 953, 954, 955, 956, 957, 958, 959
    +href="glossaries-extra-manual.html#dx1-8014" >963, 964, 965, 966, 967, 968, 969, 970, 971, 972
        location  960
    +href="glossaries-extra-manual.html#dx1-33016" >973
        loclist  961
    - - - +href="glossaries-extra-manual.html#dx1-33017" >974
        long  962, 963, 964, 965, 966, 967, 968, 969
    +href="glossaries-extra-manual.html#dx1-10026" >975, 976, 977, 978, 979, 980, 981, 982, 983
        longplural  970, 971, 972, 973, 974, 975
    +href="glossaries-extra-manual.html#dx1-10010" >984, 985, 986, 987, 988, 989
        name  976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999
    +href="glossaries-extra-manual.html#dx1-10023" >990, 991, 992, 993, 994, 995, 996, 997, 998, 999, 1000, 1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
        parent  1000, 1001
    +href="glossaries-extra-manual.html#dx1-16023" >1015, 1016, 1017
        plural  1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
    +href="glossaries-extra-manual.html#dx1-8017" >1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030
        see  1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032
    +href="glossaries-extra-manual.html#dx1-4019" >1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056
    +    seealso  1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066
        short  1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046
    +href="glossaries-extra-manual.html#dx1-8011" >1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080
        shortplural  1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060
    +href="glossaries-extra-manual.html#dx1-10011" >1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094
        sort  1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072
    +href="glossaries-extra-manual.html#dx1-4073" >1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107
        symbol  1073, 1074, 1075
    +href="glossaries-extra-manual.html#dx1-37030" >1108, 1109, 1110
        symbolplural  1076, 1077
    +href="glossaries-extra-manual.html#dx1-37034" >1111, 1112
        text  1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089
    +href="glossaries-extra-manual.html#dx1-8016" >1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124
        type  1090, 1091
    +href="glossaries-extra-manual.html#dx1-12046" >1125, 1126
        user1  1092, 1093, 1094
    +href="glossaries-extra-manual.html#dx1-21041" >1127, 1128, 1129
    number list  1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116
    +href="glossaries-extra-manual.html#dx1-7023" >1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151

    P package options:
        abbreviations  1117, 1118, 1119, 1120, 1121
    +href="glossaries-extra-manual.html#dx1-4085" >1152, 1153, 1154, 1155, 1156
        accsupp  1122, 1123, 1124
    +href="glossaries-extra-manual.html#dx1-4002" >1157, 1158, 1159
        acronym  1125
    +href="glossaries-extra-manual.html#dx1-4093" >1160
        acronymlists  1126
    +href="glossaries-extra-manual.html#dx1-4097" >1161
        automake  1127, 1128
    +href="glossaries-extra-manual.html#dx1-5038" >1162, 1163
    +    autoseeindex  1164, 1165
    +        false  1166, 1167
        docdef  1129, 1130, 1131, 1132
    +href="glossaries-extra-manual.html#dx1-4057" >1168, 1169, 1170, 1171
            restricted  1133
    +href="glossaries-extra-manual.html#dx1-4082" >1172
            true  1134, 1135
    +href="glossaries-extra-manual.html#dx1-4081" >1173, 1174
        docdefs  1136, 1137, 1138
    +href="glossaries-extra-manual.html#dx1-29003" >1175, 1176, 1177
        entrycounter  1139
    +href="glossaries-extra-manual.html#dx1-31002" >1178
        hyperfirst
            false  1140
    +href="glossaries-extra-manual.html#dx1-26030" >1179
        index  1141, 1142
    +href="glossaries-extra-manual.html#dx1-5030" >1180, 1181
    + + +     indexcrossrefs  1143, 1144, 1145
    +href="glossaries-extra-manual.html#dx1-4018" >1182, 1183, 1184, 1185
            false  1146
    +href="glossaries-extra-manual.html#dx1-4028" >1186
        indexonlyfirst  1147, 1148, 1149, 1150
    +href="glossaries-extra-manual.html#dx1-6002" >1187, 1188, 1189, 1190
        nomain  1151
    +href="glossaries-extra-manual.html#dx1-3031" >1191
        nomissingglstext  1152
    +href="glossaries-extra-manual.html#dx1-4084" >1192
        nonumberlist  1153, 1154, 1155, 1156
    +href="glossaries-extra-manual.html#dx1-7026" >1193, 1194, 1195, 1196
        nopostdot  1157, 1158
    +href="glossaries-extra-manual.html#dx1-14018" >1197, 1198
            false  1159, 1160
    +href="glossaries-extra-manual.html#dx1-3004" >1199, 1200
            true  1161
    +href="glossaries-extra-manual.html#dx1-3003" >1201
        noredefwarn
            false  1162
    +href="glossaries-extra-manual.html#dx1-3008" >1202
            true  1163
    - - - +href="glossaries-extra-manual.html#dx1-3005" >1203
        notree  1164
    +href="glossaries-extra-manual.html#dx1-16012" >1204
        numbers  1165, 1166, 1167
    +href="glossaries-extra-manual.html#dx1-4101" >1205, 1206, 1207
        record  1168, 1169, 1170, 1171, 1172, 1173
    +href="glossaries-extra-manual.html#dx1-4027" >1208, 1209, 1210, 1211, 1212, 1213
            alsoindex  1174, 1175, 1176, 1177
    +href="glossaries-extra-manual.html#dx1-4044" >1214, 1215, 1216, 1217
            off  1178, 1179
    +href="glossaries-extra-manual.html#dx1-4040" >1218, 1219
            only  1180, 1181, 1182, 1183
    +href="glossaries-extra-manual.html#dx1-4032" >1220, 1221, 1222, 1223, 1224, 1225, 1226
        seeautonumberlist  1184
    +href="glossaries-extra-manual.html#dx1-7027" >1227
        seenoindex  1185
    +href="glossaries-extra-manual.html#dx1-7016" >1228
            ignore  1186
    +href="glossaries-extra-manual.html#dx1-7018" >1229, 1230
    +        warn  1231
        shortcuts  1187, 1188
    +href="glossaries-extra-manual.html#dx1-4103" >1232, 1233
            abbr  1189, 1190
    +href="glossaries-extra-manual.html#dx1-4107" >1234, 1235
            abbreviation  1191
    +href="glossaries-extra-manual.html#dx1-20001" >1236
            abbreviations  1192
    +href="glossaries-extra-manual.html#dx1-4106" >1237
            acro  1193
    +href="glossaries-extra-manual.html#dx1-4105" >1238
            acronyms  1194
    +href="glossaries-extra-manual.html#dx1-4104" >1239
            all  1195
    +href="glossaries-extra-manual.html#dx1-4117" >1240
            false  1196
    +href="glossaries-extra-manual.html#dx1-4120" >1241
            none  1197
    +href="glossaries-extra-manual.html#dx1-4119" >1242
            other  1198
    +href="glossaries-extra-manual.html#dx1-4108" >1243
            true  1199
    +href="glossaries-extra-manual.html#dx1-4118" >1244
    +    sort
    +        none  1245
        stylemods  1200, 1201, 1202
    +href="glossaries-extra-manual.html#dx1-4011" >1246, 1247, 1248
        subentrycounter  1203
    +href="glossaries-extra-manual.html#dx1-31003" >1249
        symbols  1204, 1205, 1206
    +href="glossaries-extra-manual.html#dx1-4098" >1250, 1251, 1252
        toc
            false  1207
    +href="glossaries-extra-manual.html#dx1-3002" >1253
            true  1208
    +href="glossaries-extra-manual.html#dx1-3001" >1254
        translate
            babel  1209
    +href="glossaries-extra-manual.html#dx1-3010" >1255
            true  1210
    +href="glossaries-extra-manual.html#dx1-3012" >1256
        undefaction  1211, 1212
    +href="glossaries-extra-manual.html#dx1-4013" >1257, 1258
            error  1213, 1214
    +href="glossaries-extra-manual.html#dx1-4014" >1259, 1260
    + + +         warn  1215, 1216, 1217, 1218, 1219
    +href="glossaries-extra-manual.html#dx1-4015" >1261, 1262, 1263, 1264, 1265
    +    xindy  1266
    page (counter)  1220, 1221
    +href="glossaries-extra-manual.html#dx1-27027" >1267, 1268
    polyglossia package  1222
    +href="glossaries-extra-manual.html#dx1-39005" >1269
    \pretoglossarypreamble  1223
    +href="glossaries-extra-manual.html#dx1-31011" >1270
    \printabbreviations  1224
    +href="glossaries-extra-manual.html#dx1-4086" >1271
    \printglossary options
        target  1225, 1226
    +href="glossaries-extra-manual.html#dx1-5008" >1272, 1273
        title  1227
    +href="glossaries-extra-manual.html#dx1-39006" >1274
    \printnoidxglossary options
        sort  1228
    +href="glossaries-extra-manual.html#dx1-33012" >1275
    \printunsrtglossaries  1229
    +href="glossaries-extra-manual.html#dx1-33013" >1276
    \printunsrtglossary  1230, 1231
    +href="glossaries-extra-manual.html#dx1-33001" >1277, 1278
    \printunsrtglossaryhandler  1232
    +href="glossaries-extra-manual.html#dx1-33014" >1279
    \printunsrtglossaryunit  1233
    +href="glossaries-extra-manual.html#dx1-33020" >1280
    \printunsrtglossaryunitsetup  1234
    - - - +href="glossaries-extra-manual.html#dx1-33021" >1281
    \provideignoredglossary  1235
    +class="cmti-10">1282

    R relsize package  1236
    +href="glossaries-extra-manual.html#dx1-21034" >1283
    \RestoreAcronyms  1237
    +href="glossaries-extra-manual.html#dx1-12045" >1284

    S \setabbreviationstyle  1238
    +href="glossaries-extra-manual.html#dx1-19001" >1285
    slantsc package  1239
    +href="glossaries-extra-manual.html#dx1-25020" >1286

    T textcase package  1240
    +href="glossaries-extra-manual.html#dx1-6" >1287
    tracklang package  1241, 1242
    +href="glossaries-extra-manual.html#dx1-2" >1288, 1289
    translator package  1243
    +href="glossaries-extra-manual.html#dx1-3011" >1290

    X xfor package  1244
    +href="glossaries-extra-manual.html#dx1-7" >1291
    \xglssetwidest  1245
    +href="glossaries-extra-manual.html#dx1-16015" >1292
    \xGlsXtrSetField  1246
    +href="glossaries-extra-manual.html#dx1-32020" >1293
    xindy  1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
    +href="glossaries-extra-manual.html#dx1-3022" >1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301
    xkeyval package  1255
    +href="glossaries-extra-manual.html#dx1-5" >1302

    + + +

    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 descriptionplural key is a throwback to the base package’s original acronym mechanism before the introduction of the long and short keys, where the long form was stored in the description + id="dx1-5027"> field and the short form was stored in the symbol field.

    -

    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.15: + \title{glossaries-extra.sty v1.16: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2017-05-10} + \date{2017-06-15} \maketitle \begin{abstract} @@ -183,6 +183,12 @@ Some of the features provided by this package are only available with \styfmt{glossaries} version 4.19 (or above). This document assumes familiarity with the \styfmt{glossaries} package. +The file \texttt{example-glossaries-xr.tex} contains dummy +entries with cross-references that may be used for creating +minimal working examples for testing the \styfmt{glossaries-extra} +package. (The base \styfmt{glossaries} package provides additional files, +but this one needs \styfmt{glossaries-extra}.) + \end{abstract} \begin{important} @@ -489,6 +495,65 @@ over a glossary list. This includes \ics{forglsentries} and \ics{glsaddall}. \end{important} +\item[{\pkgopt{indexcrossrefs}}] This is a boolean option. +If \pkgoptfmt{true}, this will automatically index any +cross-referenced entries that haven't been marked as used at +the end of the document. Note that this necessarily adds to +the overall document build time, especially if you have defined +a large number of entries, so this defaults to \pkgoptfmt{false}, +but it will be automatically switched on if you use the \gloskey{see} +or \gloskey{seealso} keys in any entries (unless +\pkgopt[false]{autoseeindex}). To force it off, even if you use the +\gloskey{see} or \gloskey{seealso} key, you +need to explicitly set \pkgopt{indexcrossrefs} to \pkgoptfmt{false}. + +Note that \gls{bib2gls} can automatically find dependent +entries when it parses the \texttt{.bib} source file. +The \pkgopt{record} option automatically implements +\pkgopt[false]{indexcrossrefs}. + +\item[{\pkgopt{autoseeindex}}]\label{opt:autoseeindex} (New to +v1.16.) This is a boolean option. If true (default), this makes +the \gloskey{see} and \gloskey{seealso} keys automatically index the +cross-reference when an entry is defined. If false, the value +of those keys will still be stored in their corresponding fields +(and can be accessed using commands like \cs{glsxtrusesee} and +\cs{glsxtruseseealso}) but cross-reference won't be automatically +indexed. + +Note that the \pkgopt[only]{record} option automatically implements +\pkgopt[false]{autoseeindex}. + +For example, if an entry is defined as +\begin{verbatim} +\newglossaryentry{foo}{name={foo},description={},see={bar,baz}} +\end{verbatim} +then with \texttt{autoseeindex=true}, this is equivalent to +\begin{verbatim} +\newglossaryentry{foo}{name={foo},description={}} +\glssee{foo}{bar,baz} +\glossariesextrasetup{indexcrossrefs=true} +\GlsXtrSetField{foo}{see}{bar,baz} +\end{verbatim} +but with \texttt{autoseeindex=false}, this is equivalent to +\begin{verbatim} +\newglossaryentry{foo}{name={foo},description={}} +\GlsXtrSetField{foo}{see}{bar,baz} +\end{verbatim} +Note that \pkgopt{indexcrossrefs} isn't automatically implemented +by the presence of the \gloskey{see} key when \pkgopt{autoseeindex} +is false. + +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 before the external indexing files have been +opened with \cs{makeglossaries}. Since the appropriate file isn't +open, the information can't be written to it. This will need +the package option \pkgoptfmt{seenoindex=ignore} (provided by +\styfmt{glossaries}) to prevent an error occurring. + \item[{\pkgopt{record}}]\label{opt:record}(New to v1.08.) This is a \meta{key}=\meta{value} option, which has three allowed values: \pkgoptfmt{off} (default), \pkgoptfmt{only} and \pkgoptfmt{alsoindex}. If the value is omitted @@ -511,6 +576,11 @@ automatically implementing \cs{glssee}. (\gls{bib2gls} deals with the document, but \gls{bib2gls} will ignore the cross-reference if the \gloskey{see} field was already set for that entry. +The \pkgopt[only]{record} option will automatically set +the \styfmt{glossaries} package's \pkgopt[none]{sort} option +if available. (That option value was only introduced to +\styfmt{glossaries} v4.30.) + With the recording on, any of the commands that would typically index the entry (such as \cs{gls}, \cs{glstext} or \cs{glsadd}) will add a \cs{glsxtr@record} entry to the \texttt{.aux} file. @@ -593,21 +663,6 @@ to an incomplete document build. However, it's probably simpler just to fix whatever has caused the failure to build the external file or files. -\item[{\pkgopt{indexcrossrefs}}] This is a boolean option. -If \pkgoptfmt{true}, this will automatically index any -cross-referenced entries that haven't been marked as used at -the end of the document. Note that this necessarily adds to -the overall document build time, especially if you have defined -a large number of entries, so this defaults to \pkgoptfmt{false}, -but it will be automatically switched on if you use the \gloskey{see} key in any -entries. To force it off, even if you use the \gloskey{see} key, you -need to explicitly set \pkgopt{indexcrossrefs} to \pkgoptfmt{false}. - -Note that \gls{bib2gls} can automatically find dependent -entries when it parses the \texttt{.bib} source file. -The \pkgopt{record} option automatically implements -\pkgopt[false]{indexcrossrefs}. - \item[{\pkgopt{abbreviations}}] This option has no value and can't be cancelled. If used, it will automatically create a new glossary with the label @@ -755,7 +810,7 @@ any cross-references within the glossary won't be affected. This is a way of avoiding duplicate target warnings if a glossary needs to be displayed multiple times. -The \cs{newglossaryentry} command has two new keys: +The \cs{newglossaryentry} command has three new keys: \begin{itemize} \item \gloskey{category}, which sets the category label for the given entry. By default this is \texttt{general}. See @@ -763,7 +818,13 @@ entry. By default this is \texttt{general}. See categories. \item \gloskey{alias}, which allows an entry to be alias to another entry. See \sectionref{sec:alias} for further details. +\item \gloskey{seealso}, which performs much like \gloskey{see}, but +allows for separate \qt{see} and \qt{see also} treatment. +See \sectionref{sec:see} for further details. \end{itemize} +The test file \texttt{example-glossaries-xr.tex} contains +dummy entries with a mixture of \gloskey{see}, \gloskey{alias} +and \gloskey{seealso} keys for use with minimal working examples. The \cs{longnewglossaryentry} command now has a starred version (as from v1.12) that doesn't automatically insert @@ -997,9 +1058,12 @@ take you to the relevant place in the external PDF file links, and some may take you to the first page or last visited page. \end{important} +\section{Cross-References (\qt{see} and \qt{see also})} +\label{sec:see} + The value of the \gloskey{see} key is now saved as a field. This isn't the case with \styfmt{glossaries}, where -the \gloskey{see} attribute is simply used to directly +the \gloskey{see} value is simply used to directly write a line to the corresponding glossary file and is then discarded. This is why the \gloskey{see} key can't be used before \ics{makeglossaries} (since the file hasn't been opened @@ -1066,6 +1130,70 @@ the description. For example: Now the cross-references can appear even though the \gls{numberlist} has been suppressed. +As from v1.16, there's a separate \gloskey{seealso} key. Unlike +\gloskey{see}, this doesn't have an optional part for the textual +tag. The syntax \texttt{seealso=\marg{xr-labels}} works in much the same way as using +\texttt{see=[\cs{seealsoname}]\marg{xr-labels}} but the information +is stored in a separate field. If you need a different tag, use the +\gloskey{see} key instead (or redefine \cs{seealsoname} or +\cs{glsxtruseseealsoformat}, described below). + +You can display the formatted list of +cross-references stored in the \gloskey{seealso} key using: +\begin{definition}[\DescribeMacro\glsxtruseseealso] +\cs{glsxtruseseealso}\marg{label} +\end{definition} +This works in much the same way as \cs{glsxtrusesee} +but it internally uses +\begin{definition}[\DescribeMacro\glsxtruseseeformat] +\cs{glsxtruseseealsoformat}\marg{xr list} +\end{definition} +For example: +\begin{verbatim} +\renewcommand*{\glsxtrpostdescgeneral}{% + \ifglshasfield{see}{\glscurrententrylabel} + {, \glsxtrusesee{\glscurrententrylabel}}% + {}% + \ifglshasfield{seealso}{\glscurrententrylabel} + { (\glsxtruseseealso{\glscurrententrylabel})}% + {}% +} +\end{verbatim} + +The actual unformatted comma-separated list \meta{xr-list} +stored in the \gloskey{seealso} field can be accessed with: +\begin{definition}[\DescribeMacro\glsxtrseealsolabels] +\cs{glsxtrseealsolabels}\marg{label} +\end{definition} +This will just expand to the \meta{xr-labels} provided in the value +of the \gloskey{seealso} key. There's no corresponding command to +access the \gloskey{see} field. If you really need to access it, you +can use commands like \cs{glsxtrfielduse}, but remember that it +may start with \oarg{tag}, so it can't be automatically treated +as a simple comma-separated list. + +The base \styfmt{glossaries} package provides \ics{glsseelist}, +which requires a comma-separated list of labels as the argument. +The argument isn't fully expanded, so it's not suitable to use, for +example, \cs{glsxtrseealsolabels}\marg{label} as the argument. +For convenience, \styfmt{glossaries-extra} provides +\begin{definition}[\DescribeMacro\glsxtrseelist] +\cs{glsxtrseelist}\marg{xr list} +\end{definition} +which fully expands its argument and passes it to \cs{glsseelist}. + +The \gloskey{seealso} key implements the automatic indexing using +\begin{definition}[\DescribeMacro\glsxtrindexseealso] +\cs{glsxtrindexseealso}\marg{label}\marg{xr list} +\end{definition} +which just does +\begin{alltt} +\cs{glssee}\oarg{\cs{seealsoname}}\marg{label}\marg{xr list} +\end{alltt} +unless the \pkgopt{xindy} option is used with \sty{glossaries} +v4.30+, in which case a distinct \texttt{seealso} cross-reference +class is used instead. + \section{Entry Display Style Modifications} \label{sec:entryfmtmods} @@ -4895,8 +5023,65 @@ In both cases, the indexing is done through \end{definition} This uses the standard \ics{index} command with the sort value taken from the entry's \gloskey{sort} key and the actual value -set to \cs{glsentryname}\marg{label}. If the value of the -attribute given by \meta{attribute-label} is \qt{true}, no encap +set to \cs{glsentryname}\marg{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 +\begin{definition}[\DescribeMacro\glsxtrautoindexentry] +\cs{glsxtrautoindexentry}\marg{label} +\end{definition} +where \meta{label} is the entry's label. The default definition +is: +\begin{verbatim} +\newcommand*{\glsxtrautoindexentry}[1]{\string\glsentryname{#1}} +\end{verbatim} +Note the use of \cs{string} to prevent \cs{glsentryname} from +being expanded as it's written to the index file. + +The sort value is assigned using: +\begin{definition}[\DescribeMacro\glsxtrautoindexassignsort] +\cs{glsxtrautoindexassignsort}\marg{cs}\marg{label} +\end{definition} +where \meta{label} is the entry label and \meta{cs} is the command +which needs to be set to the sort value. The default definition is: +\begin{verbatim} +\newcommand*{\glsxtrautoindexassignsort}[2]{% + \glsletentryfield{#1}{#2}{sort}% +} +\end{verbatim} +After this macro is called, \meta{cs} is then processed to escape +any of \app{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: +\begin{definition}[\DescribeMacro\glsxtrautoindex] +\cs{glsxtrautoindex}\marg{text} +\end{definition} +This just does \cs{index}\marg{text} by default. + +\begin{important} +The entry's \gloskey{parent} field isn't referenced in this +automated indexing. +\end{important} + +For example, to index the value of the \gloskey{first} key, +instead of the \gloskey{name} key: +\begin{verbatim} +\renewcommand*{\glsxtrautoindexentry}[1]{\string\glsentryfirst{#1}} +\end{verbatim} +and if the sort value also needs to be set to the \gloskey{long} +field, if present, otherwise the \gloskey{sort} field: +\begin{verbatim} +\renewcommand*{\glsxtrautoindexassignsort}[2]{% + \ifglshaslong{#2}% + {\glsletentryfield{#1}{#2}{long}}% + {\glsletentryfield{#1}{#2}{sort}}% +} +\end{verbatim} + +If the value of the attribute given by \meta{attribute-label} +is \qt{true}, no encap will be added, otherwise the encap will be the attribute value. For example: \begin{verbatim} @@ -5703,6 +5888,13 @@ there will be no \gls{numberlist} in this case, as that has to be set by a post-processor such as \gls{bib2gls} (see \sectionref{sec:bib2gls}). +If you have any entries with the \gloskey{see} key set, you will +need the \sty{glossaries} package option \pkgopt[ignore]{seenoindex} +or \pkgopt[warn]{seenoindex} to prevent an error occurring from the +automated \cs{glssee} normally triggered by this key. The +\pkgopt[only]{record} package option will automatically deal with +this. + For example: \begin{verbatim} \documentclass{article} diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf index 7321e83ea46..07a12467f7c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbrv.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf index f72a05591c7..8faeed5a65e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-accsupp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf index d71ed9bb4db..b64f4b44d81 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym-desc.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf index b9a9386e6cc..1071fb37230 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-acronym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf index d47b53dffd1..13bf53dbf0f 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alias.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf index 9579992ca18..d0d864f2b7a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-altmodifier.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf index 2522d6095d0..ee28217f909 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-marginpar.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf index 33c4050b266..f76d9fd7da6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree-sym.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf index a48a5da6945..1aa9e8fb0ce 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-alttree.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf index d65f54d1e42..a80cebf7ffd 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf index 26a0c34c444..1b03fbba473 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.tex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.tex index 479004828b7..da2b32d6d9c 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.tex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-autoindex.tex @@ -11,8 +11,8 @@ \usepackage[abbreviations,counter=chapter,nopostdot=false]{glossaries-extra} \renewcommand*{\abbreviationsname}{List of Abbreviations} -\renewcommand*{\glossarypreamble}{\emph{Numbers refer to the chapter -where the entry was referenced.}} +\renewcommand*{\glossarypreamble}{\emph{Numbers refer to the +\textbf{chapter} where the entry was referenced.}} \makeindex \makeglossaries @@ -45,6 +45,16 @@ where the entry was referenced.}} % Allow "format" key to override "dualindex" attribute. \GlsXtrEnableIndexFormatOverride +% use first field instead of name field +\renewcommand*{\glsxtrautoindexentry}[1]{\string\glsentryfirst{#1}} + +% use long form for the sort value, if provided: +\renewcommand*{\glsxtrautoindexassignsort}[2]{% + \ifglshaslong{#2}% + {\glsletentryfield{#1}{#2}{long}}% + {\glsletentryfield{#1}{#2}{sort}}% +} + % Define general entries: \newglossaryentry{duck}{name=duck,% diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf index b1712cf74e7..6f406982eb3 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.tex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.tex index 896ce4bdee2..4216b7f6110 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.tex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.tex @@ -12,7 +12,7 @@ \newglossaryentry{sample2}{name={sample 2},description={an example},see={sample1}} \newglossaryentry{sample3}{name={sample 3},description={an -example},see=[see also]{sample2}} +example},seealso={sample2}} \begin{document} \gls{sample3}. diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf index 68b6a849092..868aedc2c5e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.tex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.tex index 9a400c897be..abadf2b8509 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.tex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.tex @@ -11,6 +11,9 @@ \ifglshasfield{see}{\glscurrententrylabel} {, \glsxtrusesee{\glscurrententrylabel}}% {}% + \ifglshasfield{seealso}{\glscurrententrylabel} + { (\glsxtruseseealso{\glscurrententrylabel})}% + {}% } \newglossaryentry{sample1}{name={sample 1},description={an example}} @@ -19,7 +22,7 @@ example},see={sample1}} \newglossaryentry{sample3}{name={sample 3},description={an example},see={sample2}} \newglossaryentry{sample4}{name={sample 4},description={an -example},see=[see also]{sample2,sample3}} +example},seealso={sample2,sample3}} \begin{document} \gls{sample4}. diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf index 17ac4891838..02ce8a4f383 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf index f7ebb3a939b..67ac21243b4 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-entrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf index 66a49ed8725..8c36388ebbe 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-external.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf index 44361707b79..633be418894 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-fmt.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf index aeb2b1614be..4cbbbd2466a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-footnote.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf index 8df2b1bc4ee..0c5e1996734 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-header.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf index e9ab96577f2..d378caa5497 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-indexhook.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf index 80a9e94992f..f1cc4ad5d00 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-initialisms.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf index 14009848d23..b88a22bdbc3 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf index dc0aa546cd1..7b918de1735 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixedsort.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf index 468aae4ac44..7dce6a4c727 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixture.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf index ea2b2c74c48..ba4f88c7a3b 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-name-font.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf index b5246a6caff..81054dc1f7e 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-nested.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf index 1141a99fdaa..01bb9135c6a 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-noidx-restricteddocdefs.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf index 44c3053dc17..f780bed07a6 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onelink.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf index 6bd73b10c74..cf281d9b556 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-utf8.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf index 31365552498..374aa603145 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly-xetex.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf index 66d0d15a694..47ddf992d2d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-onthefly.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf index fada0ab0bed..b819fd7a202 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-pages.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf index 18114cf5264..e5c936e7351 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postdot.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf index 2c79df3df5a..386b78f3e28 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-postlink.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf index 035a8b80e6c..54032c41937 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf index af5605a6c6b..2c74cb25b1c 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf index 3002dfafd75..d7628e18e3d 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-restricteddocdefs.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf index 76ed0b56ebc..d74b2d1bcbf 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf index fb0b73766f7..b4bfdcab4ea 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main-hyp.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf index 7e2a1a98167..630a42cb294 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl-main.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf index b9e23407ca7..2cef4c690b7 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-suppl.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf index 50411956331..88700231d13 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-trans.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf index 81a06310628..bb04e1afcd5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-undef.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf index d5e4bb51e5e..0f86f395e37 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-unitentrycount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf index d6606ac1a1c..dc364f438f5 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample.pdf differ -- cgit v1.2.3