From 1bbee619d358bad552a4d4aec4f8dc7637e1d846 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 13 Nov 2017 23:52:25 +0000 Subject: glossaries-extra (13nov17) git-svn-id: svn://tug.org/texlive/trunk@45786 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 22 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 1060549 -> 1063790 bytes .../glossaries-extra/glossaries-extra-manual.html | 6940 ++++++++++---------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 826025 -> 830727 bytes .../glossaries-extra/glossaries-extra-manual.tex | 103 +- .../latex/glossaries-extra/sample-abbr-styles.pdf | Bin 512874 -> 512874 bytes .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44749 -> 44749 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80745 -> 80745 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50358 -> 50358 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36734 -> 36734 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43863 -> 43863 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35296 -> 35296 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91049 -> 91049 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69519 -> 69519 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54855 -> 54855 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 142039 -> 141800 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 161532 -> 161248 bytes .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 41281 -> 41281 bytes .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41603 -> 41603 bytes .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45245 -> 45245 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54610 -> 54610 bytes .../doc/latex/glossaries-extra/sample-external.pdf | Bin 55773 -> 55773 bytes .../doc/latex/glossaries-extra/sample-fmt.pdf | Bin 75114 -> 75114 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63220 -> 63220 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125899 -> 125899 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42711 -> 42711 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81603 -> 81603 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57809 -> 57809 bytes .../latex/glossaries-extra/sample-mixedsort.pdf | Bin 45141 -> 45141 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 159972 -> 159680 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202082 -> 202082 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67724 -> 67724 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47572 -> 47572 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44514 -> 44514 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106058 -> 106058 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19862 -> 19860 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43469 -> 43469 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38788 -> 38788 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37047 -> 37047 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67878 -> 67878 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33107 -> 33107 bytes .../latex/glossaries-extra/sample-record.glstex | 6 +- .../doc/latex/glossaries-extra/sample-record.pdf | Bin 48035 -> 48035 bytes .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47883 -> 47883 bytes .../latex/glossaries-extra/sample-suppl-hyp.pdf | Bin 34931 -> 34931 bytes .../glossaries-extra/sample-suppl-main-hyp.pdf | Bin 46388 -> 46388 bytes .../latex/glossaries-extra/sample-suppl-main.pdf | Bin 31596 -> 31596 bytes .../doc/latex/glossaries-extra/sample-suppl.pdf | Bin 13411 -> 13411 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49443 -> 49443 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33219 -> 33219 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61040 -> 61040 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45734 -> 45734 bytes 53 files changed, 3707 insertions(+), 3368 deletions(-) (limited to 'Master/texmf-dist/doc') diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 89204f72b7d..801ea4c1694 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,25 @@ +1.23 (2017-11-12): + + * glossaries-extra.sty: + + - added \glsxtrrestorepostpunc + + - added \GlsXtrIfFieldUndef + + - added \glsxtrifcustomdiscardperiod + + - added starred form of \glsxtrfmt + + - bug fix: added missing label in \@glsxtrentryfmt + + - fixed shortcuts=all / true option + (\newabbr now defined with \providecommand) + + * glossaries-extra-stylemods.sty: + + - added \glsupdatewidest, \gglsupdatewidest, \eglsupdatewidest + and \xglsupdatewidest + 1.22 (2017-11-08): * glossaries-extra.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index 9bcf3a481e4..8358aa1a1cc 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.22 +LaTeX Package : glossaries-extra v1.23 -Last Modified : 2017-11-08 +Last Modified : 2017-11-12 Author : Nicola Talbot diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-code.pdf index 57b0bd90b29..f96b816f41e 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 2438062ac53..ceb98b44bd7 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.22: an extension to the +class="cmr-17">glossaries-extra.sty v1.23: an extension to the glossaries package

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

2017-11-08

+class="cmr-12">2017-11-12

@@ -1810,23 +1810,29 @@ class="cmss-10">=acronymsshortcuts=acro): set the shortcuts provided by - the ): set the shortcuts provided + by the glossaries package for acronyms (such as \ac). Note that the short - and long forms don’t use \ac). Note that the + short and long forms don’t use \glsxtrshort and \glsxtrlong but use - the original \acrshort and \acrlong, which don’t recognise multiple - abbreviation styles. +class="cmtt-10">\glsxtrlong but + use the original \acrshort and \acrlong, which don’t recognise + multiple abbreviation styles. The better option with glossaries-extra + is shortcuts=ac.
  • shortcuts=ac: set the shortcuts provided by the : set the shortcuts provided by the glossaries package for acronyms (such as \ac) but uses the \gls. href="#styopt.shortcuts">shortcuts=abbreviations (or (or shortcuts=abbr): + id="dx1-4160">): set the abbreviation shortcuts provided by glossaries-extra. (See glossaries package. href="#styopt.shortcuts">shortcuts=other: set the “other” shortcut commands, but not the shortcut + id="dx1-4161">: 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-4163">
    • \newsym equivalent to equivalent to \glsxtrnewsymbol (see the (see the symbols + id="dx1-4166"> option).
    • \newnum equivalent to equivalent to \glsxtrnewnumber (see the (see the numbers + id="dx1-4169"> option).
  • shortcuts=all (or (or shortcuts=true): implements both ): implements shortcuts=ac and + id="dx1-4172">, shortcuts=abbreviations and shortcuts=other + id="dx1-4174">.
  • shortcuts=none (or (or shortcuts=false): don’t define any of the shortcut + id="dx1-4176">): 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-4180"> options may only be used in the preamble. Additionally, docdef can’t be used after can’t be used after \makenoidxglossaries. + id="dx1-4182">.

    -

    -

    +

    Top

    2. Modifications to Existing Commands and Styles

    -

    The

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



    \glsxtrnopostpunc  \glsxtrnopostpunc

    -

    +

    which has a similar function but only suppresses the post-description punctuation. It doesn’t suppress the use of \glsxtrpostdescription which allows the use of -category-dependent post-description hooks. (Note that the punctuation, which is in -the original base hook \glspostdescription, comes after the extended -post-description hook \glsxtrpostdescription not before.) -

    The \glspostdescription, comes after the +extended post-description hook \glsxtrpostdescription not before.) The +post-description hook can counter-act the effect of \glsxtrnopostpunc +using +


    \glsxtrrestorepostpunc  \glsxtrrestorepostpunc

    +

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

    The glossaries package provides -



    \glsseeitemformat  \glsseeitemformat{label}

    -

    +

    to format items in a cross-reference list (identified with the see key or key or \glssee). This was originally defined to use \glsentryname{} since it makes more sense for the cross-reference to match the way the term appears in the glossary. Unfortunately this caused a problem when the name field was sanitized, which used to be the default + id="dx1-5007"> field was sanitized, which used to be the default setting, so glossaries v3.0 changed the default definition of this command to use \glsentrytext instead. Since the name and and text field are quite often + id="dx1-5009"> field are quite often the same, this change usually doesn’t have a noticeable effect. However, now that the name field is no longer sanitized (following the redesign of + id="dx1-5010"> field is no longer sanitized (following the redesign of glossaries v4.0) it makes more sense to restore this command to its original behaviour, but to take account of abbreviations  \ifglshasshort{\glslabel}{\glsaccesstext{#1}}{\glsaccessname{#1}}%  
    }

    -

    If you want to restore the

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

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

    -

    The commands used by

    +

    The commands used by glossaries to automatically produce an error if an entry is undefined (such as \glsdoifexists) are changed to take the ) are changed to take the undefaction option into + id="dx1-5012"> option into account. -

    The

    The \newignoredglossary{type} command now (as from v1.11) has a starred @@ -2060,7 +2087,7 @@ version that doesn’t automatically switch off the hyperlinks. This starred be used with the targeturl attribute to create a link to an external URL. (See attribute to create a link to an external URL. (See §5 Categories for furt check that the glossary doesn’t already exist. (The glossaries package omits this check.) -

    You can now provide an ignored glossary with: -


    You can now provide an ignored glossary with: +


    \provideignoredglossary  \provideignoredglossary{type}

    -

    +

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

    The individual glossary displaying commands

    The individual glossary displaying commands \printglossary, , \printnoidxglossary + id="dx1-5017"> and \printunsrtglossary have two extra keys:

    • target. This is a boolean key which can be used to switch off the automatic + id="dx1-5018">. This is a boolean key which can be used to switch off the automatic hypertarget for each entry. Unlike \glsdisablehyper this doesn’t switch off hyperlinks, so any cross-references within the glossary won’t be affected. @@ -2099,7 +2126,7 @@ class="cmtt-10">\glsdisablehyper this doesn’t switch
    • targetnameprefix={prefix}. Another way of avoiding duplicate target names @@ -2107,12 +2134,12 @@ class="cmtt-10">}. Another way of avoiding duplicate target names class="cmtt-10">\glolinkprefix this doesn’t affect any hyperlinks (such as those created with \gls).
    -

    The

    The \newglossaryentry command has three new keys:

    • category, which sets the category label for the given entry. By default this + id="dx1-5020">, which sets the category label for the given entry. By default this is general. See Categories for furt
    • alias, which allows an entry to be alias to another entry. See , which allows an entry to be alias to another entry. See §10.4 Entry @@ -2129,9 +2156,9 @@ href="#sec:alias">Entry
    • seealso, which performs much like , which performs much like see, but allows for separate “see” and + id="dx1-5023">, but allows for separate “see” and @@ -2140,24 +2167,24 @@ href="#sec:see">§2.2 Cross-References (“see” and “see also”) for further details.
    -

    The test file

    The test file example-glossaries-xr.tex contains dummy entries with a mixture of see, , alias and and seealso keys for use with minimal working examples. There are also + id="dx1-5026"> keys for use with minimal working examples. There are also example-glossaries-*.bib files that correspond to each example-glossaries-*.tex file for testing bib2gls. -

    The . +

    The \longnewglossaryentry command now has a starred version (as from v1.12) that doesn’t automatically insert @@ -2167,11 +2194,11 @@ 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: @@ -2204,57 +2231,57 @@ 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-5032"> package’s treatment of the descriptionplural key. Since a plural description doesn’t make much sense for + id="dx1-5033"> key. Since a plural description doesn’t make much sense for multi-paragraph descriptions, the default behaviour with glossaries-extra’s + id="dx1-5034">’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-5043"> package option) is modified so that the category defaults to index. The . The \newacronym command is modified + id="dx1-5045"> 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 @@ -2262,44 +2289,44 @@ class="cmtt-10">\makeglossaries behaves as per its original definition in class="cmss-10">glossaries package, otherwise ⟨list⟩ can be a comma-separated list of glossaries that need processing with an external indexing application. -

    This command is not permitted with the

    This command is not permitted with the record=only package option. Without + id="dx1-5047"> package option. Without the optional argument, it’s permitted with record=alsoindex. With the optional + id="dx1-5048">. With the optional argument, it’s only permitted with the default record=off. -

    It should then be possible to use . +

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

    If you use the optional argument ⟨

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

    -

    You will need at least version 2.20 of option).

    +

    +

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


     
     }%  
    }
    -

    This sets the conditional -


    This sets the conditional +


    \ifglsxtrinitwrglossbefore  \ifglsxtrinitwrgloss

    -

    +

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

    This means you can set the

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

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

    will set

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

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

    will use

    will use \mathrel instead of \glstextformat resulting in:

    @@ -2508,22 +2535,22 @@ class="cmsy-10">} class="cmss-10">category key set to mathrelation. -

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

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



    \glsxtrdowrglossaryhook  \glsxtrdowrglossaryhook{label}

    -

    +

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

    As from version 1.14, there are two new keys for

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

    The principle key

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

    If you use

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

    -

    For example,

    +

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

    -

    This location value will be accepted by

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

    For example, suppose the file

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

    -

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

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

    -

    This location value will be accepted by

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

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

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

    -

    Next you need to add

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

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

    Both documents will need to use the

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

    The hyperlink for the supplementary location may or

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

    -

    For example, if both

    +

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

    +

    -

    Top

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

    -

    The value of the

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

    This modification allows

    This modification allows glossaries-extra to provide -



    \glsxtraddallcrossrefs  \glsxtraddallcrossrefs

    -

    +

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

    As a by-product of this enhancement, the

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

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

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



    \glsxtrusesee  \glsxtrusesee{label}

    -

    +

    This internally uses -



    \glsxtruseseeformat  tag}{xr list}

    -

    +

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

    Suppose you want to suppress the

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

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

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

    -

    Now the cross-references can appear even though the

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

    As from v1.16, there’s a separate

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

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

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



    \glsxtruseseealso  \glsxtruseseealso{label}

    -

    +

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



    \glsxtruseseeformat  \glsxtruseseealsoformat{xr list}

    -

    +

    For example: @@ -2905,20 +2932,20 @@ For example:  
     {}%  
    }

    -

    -

    The actual unformatted comma-separated list ⟨

    +

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



    \glsxtrseealsolabels  \glsxtrseealsolabels{label}

    -

    +

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

    The base

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



    \glsxtrseelist  \glsxtrseelist{xr list}

    -

    +

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

    The

    The seealso key implements the automatic indexing using -



    \glsxtrindexseealso  label}{xr list}

    -

    +

    which just does

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

    +

    -

    Top

    2.3 Entry Display Style Modifications

    -

    Recall from the

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

    The default entry format (

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

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

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

    As from version 1.04,

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



    \glsxtrregularfont  \glsxtrregularfont{text}

    -

    +

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

    For example: +

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

    -

    You can access the label through

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

    -

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

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

    -

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

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

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

    without redefining

    without redefining \glsxtrregularfont. -

    The

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



    \glsxtrpostlinkhook  \glsxtrpostlinkhook

    -

    +

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



    \glsxtrpostlink  \glsxtrpostlink

    -

    +

    if a full stop hasn’t be discarded and -



    \glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence

    -

    +

    if a full stop has been discarded. -

    Avoid the use of

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


    \glsxtrifcustomdiscardperiod  \glsxtrifcustomdiscardperiod{true} +{false}

    +

    +You can access the field’s label using \glslabel. This command should do ⟨true⟩ if the +post-link hook should check if a period follows and ⟨false⟩ otherwise. The default +definition is simply: + + + +

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

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

    Avoid the use of \gls-like and \glstext-like commands within the post-link hook as they will cause interference. Consider using commands like @@ -3202,204 +3259,202 @@ href="#sec:nested">§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 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: -


    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-link-text hook as by this point the 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. -

    \GlsXtrSetDefaultGlsOpts doesn’t affect \glsadd.
    -

    -

    If you want to change the default value of

    +

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


    , you can instead use: +


    \GlsXtrSetDefaultNumberFormat{format}

    -

    +

    This has the advantage of also working for \glsadd. For example, if you want all locations in the back matter to appear in italic (unless explicitly @@ -3408,14 +3463,14 @@ overridden):

    -
    +
    \backmatter  
    \GlsXtrSetDefaultNumberFormat{hyperit}
    -

    -

    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 @@ -3460,23 +3515,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 @@ -3497,53 +3552,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.4 Entry Counting Modifications

    -

    If you are using

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

    The

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

    For example, instead of just doing: +

    For example, instead of just doing:

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

    -

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

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

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

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

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

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

    There are other plural fields, such as

    There are other plural fields, such as firstplural, longpluralshortplural

    If these fields are omitted, the

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

      @@ -3766,7 +3821,7 @@ class="cmtt-10">\acrpluralsuffixshort field.
    -

    This

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



    \glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

    -

    +

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

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

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

    +
    '\abbrvpluralsuffix
    -

    That is, an apostrophe followed by

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

    +

    -

    Top

    2.6 Nested Links

    -

    Complications arise when you use

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

    Things can go wrong if we try the following with the

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

    -
    +
    \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. first use if the long form is displayed before the shor -
      +
      \gls{\uppercase ssi} enabled \gls{html}
      -

      which just doesn’t work. Grouping the

      which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this will effectively try to do

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

      This will upper case the label

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

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

      This produces: +

      This produces:

      -

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

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

      -

      So the

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

      Now let’s suppose the

      Now let’s suppose the html entry is used before the shtml but the ssi entry is @@ -3941,41 +3996,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: @@ -3983,10 +4038,10 @@ 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 @@ -3998,7 +4053,7 @@ class="cmtt-10">\glslabel has been changed to html by \gls{html}. -

      Another oddity occurs if you reset the

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

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

      The next use of

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

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

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

    -

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

    For these reasons it’s better to use the simple expandable commands like \glsentrytext or -

    +
    \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 \glsdescfirst use issue, but it doesn’t fix any of the other problems listed above. -

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

    If it’s simply that you want to use the abbreviation font, you can use \glsabbrvfont:

    -
    +
    \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 within some -

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

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

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

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

    then (using the

    then (using the long-short style) the first use will be like

    -
    +
    {\acronymfont{\glsentryshort{ssi}}} enabled  
    {\acronymfont{\glsentryshort{html}}} (SHTML)
    -

    whereas if the entry is defined as: +

    whereas if the entry is defined as:

    -
    +
    \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 @@ -4233,8 +4288,8 @@ class="cmtt-10">\glsxtrshort. Note that \acrshort doesn’t set the abbreviation style. -

    Alternatively you can use: -


    Alternatively you can use: +


    \glsxtrp  field}{label}

    -

    +

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

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


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


    \glsps  \glsps{label}

    -

    +

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



    \glspt  \glspt{label}

    -

    +

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

    The

    The \glsxtrp command behaves much like the \glsfmtfield⟩ commands described @@ -4297,104 +4352,104 @@ class="cmss-10">noindex 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

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

    There are similar commands -


    There are similar commands +


    \Glsxtrp  field}{label}

    -

    +

    for first letter upper case and -



    \Glsxtrp  field}{label}

    -

    +

    for all upper case. -

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

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

    -

    You can, with care, protect against issue 

    +

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

    If you

    If you really need nested commands, the safest method is

    -
    +
    \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} @@ -4477,16 +4532,16 @@ class="cmti-10">really need nested commands, the safest method is  
    \printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    2.7 Acronym Style Modifications

    -

    The

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

    -
    +
    \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 @@ -4525,13 +4580,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 @@ -4542,7 +4597,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


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

    Old Style Name

    New Style Name

    long-sc-short

    long-short-sc

    long-sm-short

    long-short-sm

    long-sp-short

    long-short
    #1}}

    short-long

    short-long

    sc-short-long

    short-sc-long

    sm-short-long

    short-sm-long

    long-short-desc

    long-short-desc

    long-sc-short-desc

    long-short-sc-desc

    long-sm-short-desc

    long-short-sm-desc

    long-sp-short-desc

    long-short-desc
    #1}}

    short-long-desc

    short-long-desc

    sc-short-long-desc

    short-sc-long-desc

    sm-short-long-desc

    short-sm-long-desc

    dua

    long-noshort

    dua-desc

    long-noshort-desc

    footnote

    short-footnote

    footnote-sc

    short-sc-footnote

    footnote-sm

    short-sm-footnote

    footnote-desc

    short-footnote-desc

    footnote-sc-desc

    short-sc-footnote-desc

    footnote-sm-desc

    short-sm-footnote-desc

    @@ -4801,7 +4856,7 @@ class="cmss-10">short-sm-footnote-desc
    -

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

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



    \RestoreAcronyms  \RestoreAcronyms

    -

    +

    (before any use of \newacronym). -

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

    If you use

    -

    -

    In general, there’s rarely any need for

    +

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



    \glsacspace  \glsacspace{label}

    -

    +

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



    \glsacspacemax  \glsacspacemax

    -

    +

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

    Any of the new abbreviation styles that use

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

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

    -

    The

    +

    The first use acronym font command -



    \firstacronymfont{text}

    -

    +

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

    The subsequent use acronym font command -


    The subsequent use acronym font command +


    \acronymfont{text}

    -

    +

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

    -

    Top

    2.8 glossary-bookindex package

    -

    As from v1.21,

    As from v1.21, glossaries-extra has a new supplementary package glossary-bookindex @@ -4940,12 +4995,12 @@ style:

    -
    +
    \usepackage{glossaries-extra}  
    \usepackage{glossary-bookindex}  
    \setglossarystyle{bookindex}
    -

    or use both the

    or use both the stylemods and style -

    +
    \usepackage[stylemods=bookindex,style=bookindex]{glossaries-extra}
    -

    The

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

    The number of columns is given by -


    The number of columns is given by +


    \glsxtrbookindexcols  \glsxtrbookindexcols

    -

    +

    which defaults to 2. -

    This style uses the

    This style uses the multicols environment. If the command -



    \glsxtrbookindexcolspread  \glsxtrbookindexcolspread

    -

    +

    isn’t empty then it’s supplied as the optional argument following \begin{multicols} {n}. -

    Each top-level entry is displayed using -


    Each top-level entry is displayed using +


    \glsxtrbookindexname  \glsxtrbookindexname{label}

    -

    +

    where the entry is identified by ⟨label⟩. This just does \glossentryname{ -

    +
    \renewcommand*{\glsxtrbookindexname}[1]{%  
     \glossentryname{#1}%  
     \ifglshassymbol{#1}{\space (\glossentrysymbol{#1})}{}%  
    }
    -

    Alternatively you can use the

    Alternatively you can use the \glsxtrpostnamecategory⟩ hook. -

    Sub-entries are displayed using -


    Sub-entries are displayed using +


    \glsxtrbookindexsubname  \glsxtrbookindexsubname{label}

    -

    +

    which just defaults to \glsxtrbookindexname{label}. -

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

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



    \glsxtrbookindexprelocation  \glsxtrbookindexprelocation{label}

    -

    +

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

    -
    +
    ,\glsxtrprelocation
    -

    otherwise it just does

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

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


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


    \glsxtrbookindexsubprelocation  \glsxtrbookindexsubprelocation{label}

    -

    +

    which defaults to \glsxtrbookindexprelocation{label}. -

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

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



    \glsxtrbookindexparentchildsep  \glsxtrbookindexparentchildsep

    -

    +

    This defaults to \nopagebreak. -

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

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



    \glsxtrbookindexparentsubchildsep  \glsxtrbookindexparentsubchildsep

    -

    +

    This defaults to \glsxtrbookindexparentchildsep. -

    The separator between top-level entries is given by -


    The separator between top-level entries is given by +


    \glsxtrbookindexbetween  }{label2}

    -

    +

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

    The separator between two level 1 entries is given by -


    The separator between two level 1 entries is given by +


    \glsxtrbookindexsubbetween  }{label2}

    -

    -

    The separator between two level 2 entries is given by -


    +

    The separator between two level 2 entries is given by +


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

    -

    +

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



    \glsxtrbookindexsubsubatendgroup  }

    -

    -


    +


    \glsxtrbookindexsubatendgroup  \glsxtrbookindexsubatendgroup{sub-label}

    -

    -


    +


    \glsxtrbookindexatendgroup  \glsxtrbookindexatendgroup{label}

    -

    +

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

    For example, the resource option

    For example, the resource option seealso=omit instructs -

    +
    \renewcommand{\glsxtrbookindexatendgroup}[1]{%  
      \glsxtrifhasfield{seealso}{#1}{\glstreesubitem\glsxtruseseealso{#1}}{}%  
    } @@ -5213,7 +5268,7 @@ appended after the child entries using:  
      \glsxtrbookindexsubsubatendgroup{#1}%  
    }
    -

    This uses

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

    The

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




    -

    +

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

    The group heading is formatted according to -


    The group heading is formatted according to +


    \glsxtrbookindexformatheader  } -

    +

    which is defined as

    -
    +
    \newcommand*{\glsxtrbookindexformatheader}[1]{%  
      \par{\centering\glstreegroupheaderfmt{#1}\par}%  
    }
    -

    where

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

    The

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



    \glsxtrbookindexmarkentry  \glsxtrbookindexmarkentry{label}

    -

    +

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

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


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


    \glsxtrbookindexfirstmark  \glsxtrbookindexfirstmark

    -

    +

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



    \glsxtrbookindexlastmark  \glsxtrbookindexlastmark

    -

    +

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

    The entry is formatted using: -


    The entry is formatted using: +


    \glsxtrbookindexfirstmarkfmt  \glsxtrbookindexfirstmarkfmt{label}

    -

    +

    for the first instance and -



    \glsxtrbookindexlastmarkfmt  \glsxtrbookindexlastmarkfmt{label}

    -

    +

    for the last. -

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

    These commands are designed for use in page headers or footers where the page number is stable. For example, \glsxtrbookindexname can be redefined to mark the current entry: @@ -5349,13 +5404,13 @@ current entry:

    -
    +
    \renewcommand{\glsxtrbookindexname}[1]{%  
      \glsxtrbookindexmarkentry{#1}%  
      \glossentryname{#1}%  
    }
    -

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

    If you only want to mark the top-level entries, remember to redefine \glsxtrbookindexsubname as it defaults to \glsxtrbookindexname: @@ -5363,13 +5418,13 @@ class="cmtt-10">\glsxtrbookindexname:

    -
    +
    \renewcommand{\glsxtrbookindexsubname}[1]{%  
      \glossentryname{#1}%  
    }
    -

    -

    Then if you’re using

    +

    Then if you’re using fancyhdr you can set the page style to show the first and last entry for the current page with: @@ -5377,20 +5432,20 @@ entry for the current page with:

    -
    +
      \pagestyle{fancy}%  
      \lhead{\thepage}%  
      \lfoot{\glsxtrbookindexfirstmark}%  
      \cfoot{}%  
      \rfoot{\glsxtrbookindexlastmark}%
    -

    -

    +

    +

    -

    Top

    2.9 Glossary Style Modifications

    -

    The

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

    The

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



    \glsxtrsetgrouptitle  label}{title}

    -

    +

    For example:

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

    -

    +

    +

    -

    Top

    2.9.1 Style Hooks

    -

    The commands

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

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

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



    \glossentrynameother  label}{field}

    -

    +

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

    There is a hook after

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



    \glsxtrpostnamehook  \glsxtrpostnamehook{label}

    -

    +

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



    \glsxtrdoautoindexname{}{indexname}

    -

    +

    See §7 Auto-Indexing for further details. -

    As from version 1.04, the post-name hook

    As from version 1.04, the post-name hook \glsxtrpostnamehook will also use \glsxtrpostname -

    +
    \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 option is used, it will be inserted before the terminating full stop. -

    This new command will do

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

    Since both

    Since both \glossentry and \subglossentry set -



    \glscurrententrylabel  \glscurrententrylabel

    -

    +

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

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

    For example, suppose you want to insert the plural form in brackets after the description in the glossary, but only for entries in the general category, then you could @@ -5605,14 +5660,14 @@ do:

    -
    +
    \renewcommand{\glsxtrpostdescgeneral}{\space  
     (plural: \glsentryplural{\glscurrententrylabel})}
    -

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

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

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

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

    -

    +

    +

    -

    Top

    2.9.2 Number List

    -

    The

    The number list is now placed inside the argument of -



    \GlsXtrFormatLocationList  \GlsXtrFormatLocationList{number list}

    -

    +

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

    If you want to suppress the

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

    -

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

    +

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

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

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



    \GlsXtrEnablePreLocationTag  }{pages}

    -

    +

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

    -
    +
    \GlsXtrEnablePreLocationTag{Page: }{Pages: }
    -

    An extra run is required when using this command. -

    Use

    An extra run is required when using this command. +

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

    -

    See the accompanying sample file

    +

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

    Note that

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

    +

    -

    Top

    2.9.3 The glossaries-extra-stylemods Package

    -

    As from v1.02,

    As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that @@ -5736,12 +5791,12 @@ class="cmss-10">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 ⟨glossaries-extra-stylemods -

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

    +
    \usepackage[style=long3col,stylemods]{glossaries-extra}
    -

    Or the value of

    Or the value of stylemods may be a comma-separated list of the style package @@ -5783,19 +5838,19 @@ 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 provided by the nopostdot option, but the post-description category hook can still be used. -

    The

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

    As from version 1.21, the hard-coded

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



    \glsxtrprelocation  \glsxtrprelocation

    -

    +

    This just defaults to \space but may be redefined as required. For example:

    -
    +
    \renewcommand{\glsxtrprelocation}{\dotfill}
    -

    -

    The

    +

    The list styles use -



    \glsxtrprelocation  \glslistprelocation

    -

    +

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



    \glslistchildprelocation  \glslistchildprelocation

    -

    +

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

    For just the

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



    \glslistchildpostlocation  \glslistchildpostlocation

    -

    +

    which defaults to a full stop. -

    The default value of

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

    The

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



    \glstreeprelocation  \glstreeprelocation

    -

    +

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



    \glstreechildprelocation  \glstreechildprelocation

    -

    +

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

    As from version 1.05, the

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



    \gglssetwidest  level]{name}

    -

    +

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



    \eglssetwidest  level]{name}

    -

    +

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



    \xglssetwidest  level]{name}

    -

    -The widest entry value can later be retrieved using -


    \glsgetwidestname

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


    \glsupdatewidest  \glsupdatewidest[level]{name}

    +

    +Global update: +


    \gglsupdatewidest  \gglsupdatewidest[level]{name}

    +

    +Locale update (expands ⟨name⟩): +


    \eglsupdatewidest  \eglsupdatewidest[level]{name}

    +

    +Global update (expands ⟨name⟩): +


    \xglsupdatewidest  \xglsupdatewidest[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. -

    Note that if you are using

    Note that if you are using bib2gls, you can use the resource option , you can use the resource option set-widest which will try to determine the widest name of all the selected entries. This isn’t guaranteed to work as it may depend on fonts or commands that bib2gls + id="dx1-17048"> can’t replicate, but it should be suitable for names that just consist of text, and can be more efficient than iterating over all the defined entries using TEX. -

    The command

    The command \glsfindwidesttoplevelname provided by glossary-tree has a + id="dx1-17049"> 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-17052"> 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-17054"> 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-17063">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 [glossary list]{register}

    -

    +

    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 number list is governed by -


    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-17071"> 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-17074"> 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 @@ -6288,10 +6392,10 @@ to be described for readers unfamiliar with the term). They are therefore more like a regular term, which may or may not require a description in the glossary. -

    The

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



    \newabbreviation  }{long}

    -

    -

    This sets the

    +

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

    See

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

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

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

    -

    The

    +

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



    \newacronym  short}{long}

    -

    +

    is now equivalent @@ -6396,7 +6500,7 @@ class="cmtt-10">}
    -

    The

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

    The way the abbreviations are displayed by commands like

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

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

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

    These formatting commands aren’t stored in the

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

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

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



    \glsuseabbrvfont  text}{category}

    -

    +

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



    \glsuselongfont  text}{category}

    -

    +

    -

    Top

    3.1 Tagging Initials

    -

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

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



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

    -

    +

    before you define your abbreviations. -

    This command (robustly) defines ⟨

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



    \glsxtrtagfont  \glsxtrtagfont{text}

    -

    +

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

    The control sequence ⟨

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

    The first argument of

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

    The accompanying sample file

    The accompanying sample file sample-mixtures.tex uses initial tagging for both the acronymabbreviation -

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

    This defines the command

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

    -
    +
    \newacronym  
     [description={a system for detecting the location and  
     speed of ships, aircraft, etc, through the use of radio @@ -6586,18 +6690,18 @@ example:  
    \newabbreviation{xml}{XML}  
     {e\itag{x}tensible \itag{m}arkup \itag{l}anguage}
    -

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

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

    +

    -

    Top

    3.2 Abbreviation Styles

    -

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


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


    \setabbreviationstyle  ]{style-name}

    -

    +

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

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

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

    -

    Note that

    +

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

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

    Abbreviations can be used with the standard

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



    \glsxtrshort  label}[insert]

    -

    +

    (Use this instead of \acrshort.) -

    The long form can be produced with -


    The long form can be produced with +


    \glsxtrlong  label}[insert]

    -

    +

    (Use this instead of \acrlong.) -

    The

    The inline full form can be produced with -



    \glsxtrfull  label}[insert]

    -

    +

    (This this instead of \acrfull.) -

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

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

    -

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

    +

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

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

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

    -

    The arguments ⟨

    +

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

    First letter upper case short form: -


    First letter upper case short form: +


    \Glsxtrshort  label}[insert]

    -

    -

    First letter upper case long form: -


    +

    First letter upper case long form: +


    \Glsxtrlong  label}[insert]

    -

    -

    First letter upper case inline full form: -


    +

    First letter upper case inline full form: +


    \Glsxtrfull  label}[insert]

    -

    -

    All upper case short form: +

    +

    All upper case short form: -



    \Glsxtrshort  label}[insert]

    -

    -

    All upper case long form: -


    +

    All upper case long form: +


    \Glsxtrlong  label}[insert]

    -

    -

    All upper case inline full form: -


    +

    All upper case inline full form: +


    \GLSxtrfull  label}[insert]

    -

    -

    Plural forms are also available. -

    Short form plurals: -


    +

    Plural forms are also available. +

    Short form plurals: +


    \glsxtrshortpl  label}[insert]

    -

    -


    +


    \Glsxtrshortpl  label}[insert]

    -

    -


    +


    \GLSxtrshortpl  label}[insert]

    -

    -

    Long form plurals: -


    +

    Long form plurals: +


    \glsxtrlongpl  label}[insert]

    -

    -


    +


    \Glsxtrlongpl  label}[insert]

    -

    -


    +


    \GLSxtrlongpl  label}[insert]

    -

    -

    Full form plurals: -


    +

    Full form plurals: +


    \glsxtrfullpl  label}[insert]

    -

    -


    +


    \Glsxtrfullpl  label}[insert]

    -

    -


    +


    \GLSxtrfullpl  label}[insert]

    -

    -

    Be careful about using

    +

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

    -

    +

    +

    -

    Top

    3.3 Shortcut Commands

    -

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

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


    @@ -7299,10 +7403,10 @@ class="cmtt-10">\newabbreviation
    -

    Top

    3.4 Predefined Abbreviation Styles

    -

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

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

    The regular entry abbreviation styles set the

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

    The other abbreviation styles don’t modify the

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

    In both cases, the

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

    The sample file

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

    For the “sc” styles that use

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

    -

    The parenthetical styles, such as

    +

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



    \glsxtrparen  \glsxtrparen{text}

    -

    +

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

    The basic abbreviation styles, such as

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



    \glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

    -

    +

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



    \glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{text}

    -

    +

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



    \glslongdefaultfont  }

    -

    +

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



    \glsfirstlongdefaultfont  \glsfirstlongdefaultfont{text}

    -

    +

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



    \glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

    -

    +

    which defaults to \glspluralsuffix. -

    The small-cap styles, such as

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



    \glsabbrvscfont  \glsabbrvscfont{text}

    -

    +

    which uses \textsc.3.1 On first use -



    \glsabbrvdefaultfont  \glsfirstabbrvscfont{text}

    -

    +

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

    The long form for the small-cap styles uses

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



    \glsxtrscsuffix  \glsxtrscsuffix

    -

    +

    This is defined as

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

    The

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

    The small styles, such as

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



    \glsabbrvsmfont  \glsabbrvsmfont{text}

    -

    +

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



    \glsfirstabbrvsmfont  \glsfirstabbrvsmfont{text}

    -

    +

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

    The long form for the smaller styles uses

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



    \glsxtrsmsuffix  \glsxtrsmsuffix

    -

    +

    which defaults to just \glsxtrabbrvpluralsuffix. -

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

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



    \glsabbrvemfont  \glsabbrvemfont{text}

    -

    +

    On first use -



    \glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

    -

    +

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



    \glsxtremsuffix  \glsxtremsuffix

    -

    +

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

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

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



    \glsfirstlongemfont  \glsfirstlongemfont{long-form}

    -

    +

    instead of \glsfirstlongdefaultfont{long-form} and -



    \glslongemfont  }

    -

    +

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

    The user styles have similar commands: -


    The user styles have similar commands: +


    \glsabbrvuserfont  \glsabbrvuserfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvuserfont  \glsfirstabbrvuserfont{text}

    -

    +

    for the first use short form, -



    \glslonguserfont  \glslonguserfont{text}

    -

    +

    for the long form, -



    \glsfirstlonguserfont  \glsfirstlonguserfont{text}

    -

    +

    for the first use long form, and -



    \glsxtrusersuffix  \glsxtrusersuffix

    -

    +

    for the short plural suffix. -

    Similarly for the hyphen styles: -


    Similarly for the hyphen styles: +


    \glsabbrvhyphenfont  \glsabbrvhyphenfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvhyphenfont  \glsfirstabbrvhyphenfont{text}

    -

    +

    for the first use short form, -



    \glslonghyphenfont  \glslonghyphenfont{text}

    -

    +

    for the long form, -



    \glsfirstlonghyphenfont  \glsfirstlonghyphenfont{text}

    -

    +

    for the first use long form, and -



    \glsxtrhyphensuffix  \glsxtrhyphensuffix

    -

    +

    for the short plural suffix. -

    Similarly for the “only” styles, such as

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



    \glsabbrvonlyfont  \glsabbrvonlyfont{text}

    -

    +

    for the short form, -



    \glsfirstabbrvonlyfont  \glsfirstabbrvonlyfont{text}

    -

    +

    for the first use short form, -



    \glslongonlyfont  \glslongonlyfont{text}

    -

    +

    for the long form, -



    \glsfirstlongonlyfont  }

    -

    +

    for the first use long form, and -



    \glsxtronlysuffix  \glsxtronlysuffix

    -

    +

    for the short plural suffix. -

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

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



    \glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue

    -

    +

    This applies to all the predefined styles. For example:

    -
    +
    \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 placed inside the font command for the short form (rather than the long form in the above example). -

    Remember that

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

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

    -

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

    +

    If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert case:

    -
    +
    \renewcommand*{\glsabbrvscfont}[1]{\textsc{\MakeTextLowercase{#1}}}  
    \renewcommand*{\glsabbrvsmfont}[1]{\textsmaller{\MakeTextUppercase{#1}}}
    -

    -

    Some of the styles use -


    +

    Some of the styles use +


    \glsxtrfullsep  \glsxtrfullsep{label}

    -

    +

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

    -
    +
    \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 ⟨field1⟩ or ⟨field2⟩ starts with “no” then that element is omitted from the display style (no parenthetical part) 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. The special modifier -only indicates that field is only present according to whether or not the entry has been used. -

      If

      If post is present then ⟨field2⟩ is placed after the link-text using the post-link hook. -

      If the

      If the -user part is present, then the user1 value, if provided, is inserted into the parenthetical material . (The field used for the inserted material may be changed.) -

      Examples:

      +

      Examples:

      -

      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 -

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

      Or, if you are using

      Or, if you are using hyperref:

      -
      +
      \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 @@ -10751,12 +10855,12 @@ class="cmtt-10">\markboth and \@starttoc. If you don’t like this change, you can restore their former definitions using -



      \glsxtrRevertMarks  \glsxtrRevertMarks

      -

      +

      In this case, you’ll have to use the glossaries manual’s recommendations of either simply using -

      +
      \chapter[A Chapter about \glsentryshort{html}]{A Chapter about \gls{html}}
      -

      Alternatively, you need to find a way to insert

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

      If you don’t revert the mark commands back with

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

      The commands listed below all use

      The commands listed below all use \texorpdfstring if hyperref

      These commands essentially behave as though you have used

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

      If you use one of the

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

      -

      Display the short form: -


      +

      Display the short form: +


      \glsfmtshort  \glsfmtshort{label}

      -

      -

      Display the plural short form: -


      +

      Display the plural short form: +


      \glsfmtshortpl  \glsfmtshortpl{label}

      -

      -

      First letter upper case singular short form: -


      +

      First letter upper case singular short form: +


      \Glsfmtshort  \Glsfmtshort{label}

      -

      +

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

      First letter upper case plural short form: +

      First letter upper case plural short form: -



      \Glsfmtshortpl  \Glsfmtshortpl{label}

      -

      +

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

      Display the long form: -


      Display the long form: +


      \glsfmtlong  \glsfmtlong{label}

      -

      -

      Display the plural long form: -


      +

      Display the plural long form: +


      \glsfmtlongpl  \glsfmtlongpl{label}

      -

      -

      First letter upper case singular long form: -


      +

      First letter upper case singular long form: +


      \Glsfmtlong  \Glsfmtlong{label}

      -

      +

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

      First letter upper case plural long form: -


      First letter upper case plural long form: +


      \Glsfmtlongpl  \Glsfmtlongpl{label}

      -

      +

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

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

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

      Display the full form: -


      Display the full form: +


      \glsfmtfull  \glsfmtfull{label}

      -

      -

      Display the plural full form: -


      +

      Display the plural full form: +


      \glsfmtfullpl  \glsfmtfullpl{label}

      -

      -

      First letter upper case singular full form: -


      +

      First letter upper case singular full form: +


      \Glsfmtfull  \Glsfmtfull{label}

      -

      +

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

      First letter upper case plural full form: -


      First letter upper case plural full form: +


      \Glsfmtfullpl  \Glsfmtfullpl{label}

      -

      +

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

      There are also equivalent commands for the value of the

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



      \glsfmttext  \glsfmttext{label}

      -

      -

      First letter converted to upper case: -


      +

      First letter converted to upper case: +


      \Glsfmttext  \Glsfmttext{label}

      -

      +

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

      The plural equivalents: +

      The plural equivalents: -



      \glsfmtplural  \glsfmtplural{label}

      -

      +

      and -



      \Glsfmtplural  \Glsfmtplural{label}

      -

      -

      Likewise for the value of the

      +

      Likewise for the value of the name field: -



      \glsfmtname  \glsfmtname{label}

      -

      -

      First letter converted to upper case: -


      +

      First letter converted to upper case: +


      \Glsfmtname  \Glsfmtname{label}

      -

      +

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

      Similarly for the value of the

      Similarly for the value of the first field: -



      \glsfmtfirst  \glsfmtfirst{label}

      -

      -

      First letter converted to upper case: -


      +

      First letter converted to upper case: +


      \Glsfmtfirst  \Glsfmtfirst{label}

      -

      +

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

      The plural equivalents: -


      The plural equivalents: +


      \glsfmtfirstpl  \glsfmtfirstpl{label}

      -

      +

      and -



      \Glsfmtfirstpl  \Glsfmtfirstpl{label}

      -

      +

      -

      -

      +

      Top

      5. Categories

      -

      Each entry defined by

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

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

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

      The default category assumed by

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

      Additionally, if you have enabled

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

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


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


      \glscategory  \glscategory{label}

      -

      +

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

      You can test the category for a given entry using -


      You can test the category for a given entry using +


      \glsifcategory  part}{false part}

      -

      +

      This is equivalent to

      }
      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 acronym\glsentryfmt to determine whether to use \glsgenentryfmt or \glsxtrgenabbrvfmt. -

      Other attributes recognised by

      Other attributes recognised by glossaries-extra are:

      nohyperfirst attribute then just redefine -



      \glsxtrchecknohyperfirst  \glsxtrchecknohyperfirst{label}

      -

      +

      to do nothing.

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

      +
      \glsuseri{dante}[.]
      -

      This will bring the punctuation character inside the

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



      \glsxtrwordsep  \glsxtrwordsep

      -

      +

      and each word is encapsulated with -



      \glsxtrword  \glsxtrword{word}

      -

      +

      For example:

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

      is essentially the same as +

      is essentially the same as

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

      The “hyphen” styles, such as

      The “hyphen” styles, such as long-hyphen-short-hyphen, take advantage of this @@ -11409,19 +11513,19 @@ class="cmtt-10">\glsxtrlong. You can provide your own

      -
      +
      \newcommand{\hyplong}[2][]{%  
       {\def\glsxtrwordsep{-}\glsxtrlong[#1]{#2}}}
      -

      -

      This setting will also adjust the long plural. -

      This setting may result in the

      +

      This setting will also adjust the long plural. +

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

      +

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

      This setting will only adjust the short plural if the

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

      This setting may result in the

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

      +

      markshortwords. -

      If you explicitly override the short plural using the

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

      -

      This attribute is best used with the

      +

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

      With

      With glossaries, commands like \cgls use \cglsformat only if the previous @@ -11603,7 +11707,7 @@ class="cmtt-10">\capitalisewordsmfirstuc). 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\glossentrydesc +

    -

    +

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

    Note that this overrides

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

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

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

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

    (See also the accompanying sample file

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

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

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

    All the predefined glossary styles start each entry listing with

    All the predefined glossary styles start each entry listing with \glstarget which sets the anchor to \glolinkprefix\glslabel, so if you want @@ -11805,13 +11909,13 @@ class="cmss-10">targeturl -

    +
    \glssetcategoryattribute{general}{targetname}{\glolinkprefix\glslabel}
    -

    (If the target document changed

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

    If the anchor is in the form ⟨

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

    For example: +

    For example:

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

    + -

    +

    -

    An attribute can be set using: -


    An attribute can be set using: +


    \glssetcategoryattribute  attribute-label}{value}

    -

    +

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

    There is a shortcut version to set the

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



    \glssetregularcategory  \glssetregularcategory{category-label}

    -

    -

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

    +

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



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

    -

    +

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

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


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


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

    -

    +

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



    \glsgetattribute  } -

    -

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


    +

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


    \glshascategoryattribute  true code}{false code}

    -

    +

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



    \glshasattribute  code}{false code}

    -

    -

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


    +

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


    \glsifcategoryattribute  true-part}{false-part}

    -

    +

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

    For example: +

    For example:

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

    This does “NO HYPER” if the

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

    With boolean-style attributes like

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

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

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



    \glsifattribute  true-part} {false-part}

    -

    -

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

    +

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



    \glsifregularcategory  true-part}{false-part}

    -

    +

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



    \glsifregular  }{false-part}

    -

    +

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



    \glsifnotregularcategory  true-part}{false-part}

    -

    +

    or for a particular entry: -



    \glsifnotregular  }{false-part}

    -

    +

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

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


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


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

    -

    +

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

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

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



    \glsforeachwithattribute  }{body}

    -

    +

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

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

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



    \glsxtrsetcategory  }{category-label}

    -

    +

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

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

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



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

    -

    +

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

    -

    -

    +

    Top

    6. Entry Counting

    -

    As mentioned in

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

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

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

    -

    With

    +

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

    All upper case versions (not provided by

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



    \cGLS  label}[insert]

    -

    +

    and -



    \cGLSpl  label}[insert]

    -

    +

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



    \cGLSformat  label}{insert}

    -

    +

    and -



    \cGLSplformat  label}{insert}

    -

    +

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

    Just using

    Just using glossaries:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries}  
    \makeglossaries @@ -12372,8 +12476,8 @@ class="cmss-10">glossaries:  
    \printglossaries  
    \end{document}
    -

    -

    If you switch to

    +

    If you switch to glossaries-extra you must set the entrycountentrycount -

    + -

    -

    When activated with

    +

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



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

    -

    +

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

    The default definition is: +

    The default definition is:

    -
    +
    \newcommand*{\glsxtrifcounttrigger}[3]{%  
     \glshasattribute{#1}{entrycount}%  
     {% @@ -12449,7 +12553,7 @@ class="cmti-10">normal code⟩).  
     {#3}%  
    }
    -

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

    This means that if an entry is assigned to a category that has the entrycount @@ -12457,17 +12561,17 @@ 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\gls, etc to use \cgls etc: -



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

    -

    +

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

    -
    +
    \renewcommand*{\gls}{\cgls}%  
    \renewcommand*{\Gls}{\cGls}%  
    \renewcommand*{\glspl}{\cglspl}% @@ -12507,19 +12611,19 @@ 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: +

    The above example document can then become:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \makeglossaries @@ -12532,12 +12636,12 @@ class="cmss-10">entrycount\printglossaries  
    \end{document}
    -

    -

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

    +

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



    \GlsXtrEnableEntryUnitCounting  value}{counter-name}

    -

    +

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

    Due to the asynchronous nature of T

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

    -

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

    +

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

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

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

    The per-unit counting function uses two attributes:

    The per-unit counting function uses two attributes: entrycount (as before) and @@ -12591,58 +12695,58 @@ class="cmss-10">unitcount

    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} @@ -12661,7 +12765,7 @@ which gives the maximum per-unit total from the previous run.  
    \printglossaries  
    \end{document}
    -

    In this document, the

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

    The

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

    The

    The sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the general 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 @@ -12696,19 +12800,19 @@ won’t be triggered, but the unit entry count is used to automatically supp hyperlink for commands like \gls by modifying the hook -



    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +

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

    -
    +
    \documentclass{article}  
    \usepackage[colorlinks]{hyperref}  
    \usepackage{glossaries-extra} @@ -12729,10 +12833,10 @@ hyperlink.  
    \printglossaries  
    \end{document}
    -

    This only produces a hyperlink for the first instance of

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

    The earlier warning about using the

    The earlier warning about using the page counter still applies. If the first instance of -

    -

    +

    Top

    7. Auto-Indexing

    -

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

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

    The

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

    The internal macro used by the

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

    In both cases, the indexing is done through -


    In both cases, the indexing is done through +


    \glsxtrdoautoindexname  }{attribute-label}

    -

    +

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

    The actual value is given by -


    The actual value is given by +


    \glsxtrautoindexentry  \glsxtrautoindexentry{label}

    -

    +

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

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

    Note the use of

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

    The sort value is assigned using: -


    The sort value is assigned using: +


    \glsxtrautoindexassignsort  }{label}

    -

    +

    where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the @@ -12846,36 +12950,36 @@ sort value. The default definition is:

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

    After this macro is called, ⟨

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

    The command used to perform the actual indexing is: -


    The command used to perform the actual indexing is: +


    \glsxtrautoindex  \glsxtrautoindex{text}

    -

    +

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

    The entry’s

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

    -

    For example, to index the value of the

    +

    For example, to index the value of the first key, instead of the namename -

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

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

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

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

    -

    If the value of the attribute given by ⟨

    +

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

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

    will set the encap to

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

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

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

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

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

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

    -

    By default the

    +

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



    \GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride

    -

    +

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

    The

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

    -

    The

    +

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

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

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

    Be very careful of possible shifting category codes!
    -

    -


    Be very careful of possible shifting category codes!
    +

    +


    \GlsXtrSetActualChar  \GlsXtrSetActualChar{char}

    -

    +

    Set the actual character to ⟨char⟩. -



    \GlsXtrSetLevelChar  \GlsXtrSetLevelChar{char}

    -

    +

    Set the level character to ⟨char⟩. -



    \GlsXtrSetEscChar  \GlsXtrSetEscChar{char}

    -

    +

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



    \GlsXtrSetEncapChar  }

    -

    +

    Set the encap character to ⟨char⟩.

    -

    -

    +

    Top

    8. On-the-Fly Document Definitions

    -

    The commands described here may superficially look like ⟨

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

    -

    The

    +

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

    Although this can be problematic, the

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



    \GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly

    -

    +

    When used, this defines the commands described below. -

    The commands

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

    -


    +


    \glsxtr  dfn-options]{label}

    -

    +

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

    -

    The ⟨

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

    +

    -

    The second optional argument ⟨

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



    \GlsXtrWarning  dfn-options}{label}

    -

    -

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

    +

    For example, this warning will be generated on the second instance of \glsxtr below:

    -
    +
    \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 \gls in the document. -

    There are plural and case-changing alternatives to

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



    \glsxtrpl  dfn-options]{label}

    -

    +

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



    \Glsxtr  dfn-options]{label}

    -

    +

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



    \Glsxtrpl  dfn-options]{label}

    -

    +

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

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

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

    If you use the starred version of

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

    +

    -

    -

    +

    Top

    9. bib2gls: Managing Reference Databases

    -

    There is a new command line application called

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

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

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

    There are some new commands and options added to

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

    An example of the contents of

    An example of the contents of .bib file that stores glossary entries that can be extracted with bib2gls -

    + -

    -

    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}$}, @@ -13403,8 +13507,8 @@ preamble{"\providecommand{\mtx}[1]{\boldsymbol{#1}}"}  
      description={a set}  
    }
    -

    -

    To ensure that

    +

    To ensure that bib2glsrecord -

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

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

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

    If you still want to use an indexing application (for example, you need a custom +

    If you still want to use an indexing application (for example, you need a custom \printglossaries), but it’s a good idea to also ins id="dx1-31019">bib2gls to omit sorting to save time. -

    The

    The .glstex file created by \bib2gls is loaded using: -



    \glsxtrresourcefile  ]{filename}

    -

    +

    (Don’t include the file extension in ⟨filename⟩.) There’s a shortcut version (recommended over the above) that sets ⟨filename⟩ to use \jobname: -



    \GlsXtrLoadResources  \GlsXtrLoadResources[options]

    -

    +

    On the first use, this command is a shortcut for

    }
    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

    9.2

    Since the

    Since the .glstex won’t exist on the first LATEX run, the .glstex file the references should be resolved. This may cause a shift in the locations if the actual text produced once the entry is defined is larger than the placeholder ?? (as can occur with long citations). -

    Note that as from v1.12,

    Note that as from v1.12, \glsxtrresourcefile temporarily switches the category code of @ to 11 (letter) while it reads the file to allow for any internal commands stored in the location field.

    -

    Top

    9.1 Selection

    -

    The default behaviour is for

    The default behaviour is for bib2gls -

    +
    \GlsXtrSetDefaultNumberFormat{glsignore}
    -

    at the start of the front matter and +

    at the start of the front matter and

    -
    +
    \GlsXtrSetDefaultNumberFormat{glsnumberformat}
    -

    at the start of the main matter to prevent any records in the front matter from +

    at the start of the main matter to prevent any records in the front matter from occurring in the location lists. -

    Note that commands like

    -

    -

    If you want to add all entries to the glossary, you need to tell

    +

    If you want to add all entries to the glossary, you need to tell bib2gls this in the @@ -13613,10 +13717,10 @@ options list. For example:

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

    This will add all entries, regardless of whether or not they have any records in the +

    This will add all entries, regardless of whether or not they have any records in the .aux file. Those that don’t have any records will have an empty location list. See the .aux file. Those that don’t have any records will h href="#glo:bib2gls">bib2gls user manual for more details of this option. -

    +

    -

    Top

    9.2 Sorting and Displaying the Glossary

    -

    There are many sorting options provided by

    There are many sorting options provided by bib2gls. The default is to sort @@ -13649,13 +13753,13 @@ example:

    -
    +
    \GlsXtrLoadResources[  
      src=terms, % data in terms.bib  
      sort=de-DE-1996 % sort according to this locale  
    ]
    -

    The locale-sensitive sort methods usually ignore most punctuation so for lists of +

    The locale-sensitive sort methods usually ignore most punctuation so for lists of symbols you may find it more appropriate to use one of the letter-base sort methods that sort according to the Unicode value of each character. See the bib2gls manual for full details of all the available sort methods. -

    Since the

    Since the .glstex file only defines those references required within the document (selected according to the selection option) and the definitions have been written in @@ -13678,7 +13782,7 @@ href="#sec:printunsrt">§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} @@ -13702,18 +13806,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, 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} @@ -13774,8 +13878,8 @@ methods:  
    \printunsrtglossaries  
    \end{document}
    -

    -

    Or you can have multiple instance of

    +

    Or you can have multiple instance of \GlsXtrLoadResources with the same type, which will produce a glossary with ordered sub-blocks. For example: @@ -13783,7 +13887,7 @@ class="cmtt-10">type, which will produce a glossary with ordered sub-bloc

    -
    +
    \documentclass{article}  
    \usepackage[record,style=indexgroup]{glossaries-extra}  
    \setabbreviationstyle{long-short-desc} @@ -13801,7 +13905,7 @@ class="cmtt-10">type, which will produce a glossary with ordered sub-bloc  
    \printunsrtglossaries  
    \end{document}
    -

    This will result in a glossary where the first group has the title “Abbreviations”, the +

    This will result in a glossary where the first group has the title “Abbreviations”, the second group has the title “Symbols” and then follow the usual letter groups. Note that for this example to work, you must run myDoc.tex:

    -
    +
    pdflatex myDoc  
    bib2gls -g myDoc  
    pdflatex myDoc
    -

    -

    You can provide your own custom sort rule. For example, if you are using +

    +

    You can provide your own custom sort rule. For example, if you are using XƎLATEX or LuaLATEX:

      class="cmtt-10">]
    -

    +

    -

    Top

    9.3 Supplementary Commands

    -

    These commands are provided by

    These commands are provided by glossaries-extra for use with bib2gls. -



    \glshex  \glshex

    -

    +

    This is just defined as \string\u, which is required when you need to indicate a Unicode character in the form \uhex⟩ in some of the resource options (as described above). -

    The information provided with

    The information provided with \GlsXtrLoadResources is written to the .aux file using

    @@ -14118,12 +14222,12 @@ class="cmti-10">information⟩ is the information to pass to bib2gls. The command in the second argument -



    \glsxtrresourceinit  \glsxtrresourceinit

    -

    +

    may be used to temporarily redefine commands before the information is written to the file. This does nothing by default, but may be redefined to allow the use of short commands for convenience. For example, with: @@ -14131,22 +14235,22 @@ commands for convenience. For example, with:

    -
    +
    \renewcommand{\glsxtrresourceinit}{\let\u\glshex}
    -

    you can just use, for example,

    you can just use, for example, \uE6 instead of \string\uE6 in the custom rule. This redefinition of \u is scoped so its original definition is restored after the write operation. -

    It’s possible to specify label prefixes. For example, modifying the earlier +

    It’s possible to specify label prefixes. For example, modifying the earlier example:

    -
    +
    \documentclass{article}  
    \usepackage[record,style=indexgroup]{glossaries-extra}  
    \setabbreviationstyle{long-short-desc} @@ -14167,21 +14271,21 @@ example:  
    \printunsrtglossaries  
    \end{document}
    -

    If you do something like this, you may find it more convenient to define custom +

    If you do something like this, you may find it more convenient to define custom commands that set the prefix. For example:

    -
    +
    \newcommand*{\sym}[2][]{\gls[#1]{sym.#2}}
    -

    The problem with this is that the custom command

    The problem with this is that the custom command \sym does allow for modifiers (such as \gls* or \gls+). Instead you can use: -



    \glsxtrnewgls  prefix}{cs}

    -

    +

    which defines the command ⟨cs⟩ that behaves like

    @@ -14215,23 +14319,23 @@ class="cmtt-10">] -
    +
    \glsxtrnewgls{sym.}{\sym}
    -

    or (to default to no hyperlinks) +

    or (to default to no hyperlinks)

    -
    +
    \glsxtrnewgls[hyper=false]{sym.}{\sym}
    -

    now you can use

    now you can use \sym+{M} to behave like \gls+{sym.M}. -

    If you also want the plural and first letter upper case versions you can +

    If you also want the plural and first letter upper case versions you can use -



    \glsxtrnewglslike  }{\Glspl-like cs}

    -

    +

    For example:

    -
    +
    \glsxtrnewglslike[hyper=false]{idx.}{\idx}{\idxpl}{\Idx}{\Idxpl}
    -

    For the all caps versions: -


    For the all caps versions: +


    \glsxtrnewGLSlike  \GLS-like cs}{\GLSpl-like cs}

    -

    +

    For example:

    -
    +
    \glsxtrnewGLSlike[hyper=false]{idx.}{\IDX}{\IDXpl}
    -

    -

    There’s an analogous command for

    +

    There’s an analogous command for \rgls: -



    \glsxtrnewrgls  }{cs}

    -

    +

    and for \rgls, \rglspl, \rGls and \rGlspl: -



    \glsxtrnewrglslike  }{\rGlspl-like cs}

    -

    +

    and for the all caps: -



    \glsxtrnewrGLSlike  \rGLS-like cs}{\rGLSpl-like cs}

    -

    -

    +

    +

    -

    Top

    9.4 Record Counting

    -

    As from version 1.1 of

    As from version 1.1 of bib2glsrecordcount: set to the total number of records found for class="cmtt-10">recordcount.⟨counter⟩: set to the total number of records found for the entry for the given counter. -

    If

    If --record-count-unit is used then additionally:

    • location⟩: set to the total number of reco -

      Only use the unit counting option if the locations don’t contain any special characters. If +

      Only use the unit counting option if the locations don’t contain any special characters. If you really need it with locations that may contain formatting commands, then you can try redefining: -



      \glsxtrdetoklocation  \glsxtrdetoklocation{location}

      -

      +

      so that it detokenizes ⟨location⟩ but take care when using \GlsXtrLocationRecordCount with commands like \thepage as they can end up becoming detokenized too early. -

      Note that the record count includes locations that

      Note that the record count includes locations that bib2glssection counter (stored in the recordcount.section field) is 1. -

      With the unit counting on as well, the field

      With the unit counting on as well, the field recordcount.page.1 is set to 2, recordcount.page.2 is set to 1, recordcount.page.3 is set to 4 and recordcount.section.3 is set to 1. -

      You can access these fields using the following commands which will expand to +

      You can access these fields using the following commands which will expand to the field value if set or to 0 if unset: -



      \GlsXtrTotalRecordCount  \GlsXtrTotalRecordCount{label}

      -

      +

      This expands to the total record count for the entry given by ⟨label⟩.

      -
      +
      \GlsXtrTotalRecordCount{bird}
      -

      expands to 8. -


      expands to 8. +


      \GlsXtrRecordCount  label}{counter}

      -

      +

      This expands to the counter total for the entry given by ⟨label⟩ where ⟨counter⟩ is the @@ -14468,19 +14572,19 @@ counter name. For example:

      -
      +
      \GlsXtrRecordCount{bird}{page}
      -

      expands to 7 and +

      expands to 7 and

      -
      +
      \GlsXtrRecordCount{bird}{section}
      -

      expands to 1. -


      expands to 1. +


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

      -

      +

      This expands to the total for the given location. For example

      -
      +
      \GlsXtrLocationRecordCount{bird}{page}{3}
      -

      expands to 4. Be careful about using

      expands to 4. Be careful about using \thepage in the ⟨location⟩ part. Remember that due to TEX’s asynchronous output routine, \thepage may not be correct. -

      There are commands analogous to the entry counting commands like

      There are commands analogous to the entry counting commands like \cgls and \cglsformat that are triggered by the record count. These are listed below. -



      \rgls  label}[insert]

      -

      -


      +


      \rglspl  label}[insert]

      -

      -


      +


      \rGls  label}[insert]

      -

      -


      +


      \rGlspl  label}[insert]

      -

      -


      +


      \rGLS  label}[insert]

      -

      -


      +


      \rGLSpl  label}[insert]

      -

      +

      These commands check the recordcount -

      +
      \glssetcategoryattribute{abbreviation}{recordcount}{1}
      -

      For convenience, you can use -


      For convenience, you can use +



      -

      +

      to set the recordcountn⟩ for all the categories listed in ⟨category list⟩. -

      The

      The \rgls-like commands use -



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

      -

      +

      to determine whether the \rgls-like command should behave like its \gls counterpart (⟨normal⟩) or whether it should instead use ⟨trigger code⟩. -

      This command checks if the

      This command checks if the recordcount attribute is set. If not is just does ⟨normal⟩, otherwise it tests if -



      \glsxtrrecordtriggervalue  \glsxtrrecordtriggervalue{label}

      -

      +

      is greater than the value given in the recordcount -

      +
      \newcommand*{\glsxtrrecordtriggervalue}[1]{%  
       \GlsXtrTotalRecordCount{#1}%  
      }
      -

      The ⟨

      The ⟨trigger code⟩ part writes a record with the format set to trigger format⟩. Then it unsets the first use flag. Note that it doesn’t implement the post-link hook. This ensures that the record count is correct on the next run. -

      The ⟨

      The ⟨trigger format⟩ depends on the \rgls-like command used and will be one of the following: -



      \rglsformat  label}{insert}

      -

      -


      +


      \rglsplformat  label}{insert}

      -

      -


      +


      \rGlsformat  label}{insert}

      -

      -


      +


      \rGlsplformat  label}{insert}

      -

      -


      +


      \rGLSformat  label}{insert}

      -

      -


      +


      \rGLSplformat  label}{insert}

      -

      +

      These all behave much like their \cglsformat counterparts. If the entry’s regular attribute is set or if the entry doesn’t have a long form, the first or first plural is used, otherwise the long or long plural form is used. -

      You can use -


      You can use +


      \glsxtrenablerecordcount  \glsxtrenablerecordcount

      -

      +

      to redefine \gls, \glspl, \rGls, class="cmtt-10">\rGlspl, \rGLS, \rGLSpl, respectively, for convenience. -

      If you don’t want the entries that use ⟨

      If you don’t want the entries that use ⟨trigger code⟩ to appear in the glossary, you need to use the resource option trigger-type to assign them to another glossary. @@ -14800,7 +14904,7 @@ For example:

      -
      +
      \documentclass{article}  
      \usepackage[record]{glossaries-extra}  
      \newignoredglossary{ignored} @@ -14817,7 +14921,7 @@ For example:  
      \printunsrtglossaries  
      \end{document}
      -

      In the above,

      In the above, stc and upa both only have one record, so they are assigned to the main one.

      -

      -

      +

      Top

      10. Miscellaneous New Commands

      -

      The

      The glossaries package provides \glsrefentry entry to cross-reference entries @@ -14844,21 +14948,21 @@ class="cmss-10">subentrycounter 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 \ref. -

      You can copy an entry to another glossary using -


      You can copy an entry to another glossary using +


      \glsxtrcopytoglossary  }{glossary-type}

      -

      +

      This appends ⟨entry-label⟩ to the end of the internal list for the glossary given by ⟨ -

      +
      \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  type]{code}

      -

      +

      or prepend using -



      \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}{% @@ -14963,10 +15067,10 @@ 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  label}{text}

      -

      +

      This effectively does

      \glslink[default-options,options]{label}{cs{\glsxtrfmtdisplay +{text}} +class="cmsy-10">{}}
      where ⟨cs⟩ is the command obtained from the control sequence name supplied in the -provided field. If the field hasn’t been set, \glsxtrfmt will simply do ⟨text⟩. The -default ⟨options⟩ are given by -


      \glslink it misses out the post-link hook. +

      The default ⟨default-options⟩ are given by + + + +


      \GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

      -

      - - - +

      This is defined as noindex but may be redefined as appropriate. Note that the replacement text of \GlsXtrFmtDefaultOptions is prepended to the optional argument of \glslink. -

      For example: - - - -

      -
      +

      As from version 1.23, there’s also a starred version of this command that has a +final optional argument: +


      \glsxtrfmt*  \glsxtrfmt*[options]{label}{text}[insert]

      +

      +Both the starred and unstarred versions use: +


      \glsxtrfmtdisplay  \glsxtrfmtdisplay{cs name}{text}{insert} +

      +

      +within the link text. In the case of the unstarred version ⟨insert⟩ will be empty. It will +also be empty if the final option argument is missing from the starred form. If the +entry given by ⟨label⟩ is undefined \glsxtrfmt and \glsxtrfmt* will issue an error (or +warning if undefaction=warn). There won’t be a warning or error if the entry is +defined by the given field is missing. In either case, (the entry is undefined or the field +is missing) ⟨cs name⟩ will be @firstofone otherwise it will be the field value. The +default definition is: + + + +

      +
      +\newcommand{\glsxtrfmtdisplay}[3]{\csuse{#1}{#2}#3} +
      +

      which puts ⟨text⟩ inside the argument of the control sequence and ⟨insert⟩ outside it +(but it will still be inside the link text). +

      Remember that nested links cause a problem so avoid using commands like \gls +or \glsxtrfmt within ⟨text⟩.
      +

      +

      For example: + + + +

      +
      \[  
        \glsxtrfmt{matrix}{A}  
        \glsxtrfmt{matrixinv}{A} @@ -15028,34 +15199,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-37007"> 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 @@ -15066,17 +15237,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 @@ -15115,22 +15286,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-37012"> 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-37013"> field). Unexpected results may occur if they are subsequently changed. -



      \GlsXtrSetField  \GlsXtrSetField{label}{field}{value}

      -

      +

      Sets the field given by ⟨field⟩ to ⟨value⟩ for the entry given by ⟨

      \GlsXtrSetField uses -



      \glsxtrsetfieldifexists  \glsxtrsetfieldifexists{label}{}{code}

      -

      +

      where ⟨label⟩ is the entry label and ⟨code⟩ is the assignment code. -

      This command just uses

      This command just uses \glsdoifexists{label}{undefaction=warn. You can redefine + id="dx1-37017">. 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 @@ -15337,19 +15508,19 @@ class="cmti-10">code⟩} is still used, as for \GlsXtrSetField. -

      The

      The glossaries package provides \ifglshasfield to determine if a field has been + id="dx1-37027"> to determine if a field has been set. The glossaries-extra package provides a simpler version: -



      \glsxtrifhasfield  \glsxtrifhasfield{label}{}{false}

      -

      +

      (New to v1.19.) Unlike \ifglshasfield, this version doesn’t complain if the entry (given by ⟨true⟩ part is done otherwise it does ⟨false⟩. Within ⟨true⟩ you may use -



      \glscurrentfieldvalue  \glscurrentfieldvalue

      -

      +

      to access the field value. This command includes grouping which scopes the ⟨true⟩ and ⟨false⟩ parts. The starred version -



      \glsxtrifhasfield*  \glsxtrifhasfield*{label}{}{false}

      -

      +

      omits the implicit grouping. -

      You can test if a field value equals a string using -


      There is also a version that simply uses \ifcsundef. It doesn’t save the field +value, but can be used if you only need to check if the field is defined without +accessing it: +


      \GlsXtrIfFieldUndef  \GlsXtrIfFieldUndef{field}{label}{true}{false} +

      +

      +

      You can test if a field value equals a string using +


      \GlsXtrIfFieldEqStr  \GlsXtrIfFieldEqStr{label}{} class="cmtt-10">{false}

      -

      +

      If the entry exists and has the given field set to the given text then this does ⟨true⟩ otherwise it does ⟨\glscurrentfieldvalue with ⟨text⟩ using etoolbox’s ’s \ifdefstring. -

      The

      The glossaries package provides \glsfieldfetch which can be used to fetch the + id="dx1-37034"> 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-37036"> 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-37038"> 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 ⟨item⟩ is the item to add. There are analogous commands that use \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-37048">’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-37049"> 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 @@ -15719,8 +15909,8 @@ the definition of \glsgroupskip to avoid the “Incomplete \iftrue” error that may otherwise occur. -

      There’s also a starred form -


      There’s also a starred form +


      \printunsrtglossary*  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 §9 bib2gls: Managing Reference Databases). -

      No attempt is made to gather hierarchical elements. If child entries aren’t defined +

      No attempt is made to gather hierarchical elements. If child entries aren’t defined immediately after their parent entry, they won’t be together in the glossary when using \printunsrtglossary.
      -

      +

      -

      If you have any entries with the

      If you have any entries with the see key set, you will need the glossariesrecord=only package option will automatically deal with this. -

      For example: +

      For example:

      -
      +
      \documentclass{article}  
      \usepackage{glossaries-extra}  
      \newglossaryentry{zebra}{name={zebra},description={stripy animal}} @@ -15805,32 +15995,32 @@ will automatically deal with this.  
      \printunsrtglossaries  
      \end{document}
      -

      In the above, zebra will be listed before ant as it was defined first. -

      If you allow document definitions with the

      In the above, zebra will be listed before ant as it was defined first. +

      If you allow document definitions with the docdefs option, the document will 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, which isn’t available). -

      All glossaries may be displayed in the order of their definition using: -


      All glossaries may be displayed in the order of their definition using: +


      \printunsrtglossaries  \printunsrtglossaries

      -

      +

      which is analogous to \printnoidxglossaries. This just iterates over all defined glossaries (that aren’t on the ignored list) and does \printunsrtglossary[type=⟨type⟩]. -

      To avoid complications caused by

      To avoid complications caused by tabular-like glossary styles,



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

      -

      +

      This hook should not display any content, but may be used to perform calculations. For example, to calculate widths. Within this hook you can use: -



      \printunsrtglossaryskipentry  \printunsrtglossaryskipentry

      -

      +

      to skip the current entry. This will prevent the entry from being added to the internal command. -

      There’s another hook immediately before the internal command containing the +

      There’s another hook immediately before the internal command containing the glossary code is performed: -



      \printunsrtglossarypredoglossary  \printunsrtglossarypredoglossary

      -

      +

      -

      The internal command uses -


      The internal command uses +


      \printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

      -

      +

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

      By default the handler just does -


      By default the handler just does +


      \glsxtrunsrtdo  \glsxtrunsrtdo{label}

      -

      +

      which determines whether to use \glossentry or \subglossentry and checks the @@ -15902,10 +16092,10 @@ class="cmss-10">loclist fields for the number list. -

      You can redefine the handler if required. For example, you may want to filter +

      You can redefine the handler if required. For example, you may want to filter entries according to the category label. You can test if a label is contained in a comma-separated list of labels using: -



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

      -

      +

      The ⟨label⟩ and ⟨label list⟩ will be fully expanded. -

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

      If you redefine the handler to exclude entries, you may end up with an empty glossary. This could cause a problem for the list-based styles.
      -

      -

      For example, if the preamble includes: +

      +

      For example, if the preamble includes:

      -
      +
      \usepackage[record,style=index]{glossaries-extra}  
      \GlsXtrRecordCounter{section}
      -

      then you can print the glossary but first redefine the handler to only select entries +

      then you can print the glossary but first redefine the handler to only select entries that include the current section number in the record.section field:

      -
      +
      \renewcommand{\printunsrtglossaryhandler}[1]{%  
        \glsxtrfieldxifinlist{#1}{record.section}{\thesection}  
        {\glsxtrunsrtdo{#1}}%  
        {}%  
      }
      -

      -

      Alternatively you can use the starred form of

      +

      Alternatively you can use the starred form of \printunsrtglossary which will localise the change:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -15967,8 +16157,8 @@ localise the change:  
        }%  
      }
      -

      -

      If you are using the

      +

      If you are using the hyperref package and want to display the same glossary more than once, you can also add a temporary redefinition of -

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

      Note that this will cause a problem if your descriptions contain commands like

      Note that this will cause a problem if your descriptions contain commands like \gls that need to link an entry that doesn’t appear in the summary. In this case, it’s a better approach to use: @@ -16002,7 +16192,7 @@ better approach to use:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -16018,14 +16208,14 @@ better approach to use:  
        }%  
      }
      -

      -

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

      +

      If it’s a short summary at the start of a section, you might also want to suppress the glossary header and add some vertical space afterwards:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -16043,9 +16233,9 @@ the glossary header and add some vertical space afterwards:  
        \appto\glossarypostamble{\glspar\medskip\glspar}%  
      }
      -

      -

      There’s a shortcut command that essentially does this: -


      +

      There’s a shortcut command that essentially does this: +


      \printunsrtglossaryunit  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  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 @@ -16100,7 +16290,7 @@ href="#styopt.record">record=alsoindex) package option. -

      This temporary change in the hypertarget prefix means you need to explicitly use +

      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 @@ -16112,12 +16302,12 @@ the front or back matter) which can be the target for all glossary references an just use \printunsrtglossaryunit for a quick summary at the start of a section etc. -

      +

      -

      Top

      10.3 Standalone Entry Items

      -

      It may be that you don’t want a list but would rather display entry details +

      It may be that you don’t want a list but would rather display entry details throughout the document. You can simply do \glsentryname followed by -

      +
      \newcommand{\displayterm}[1]{%  
       \par\medskip\par\noindent  
       Definition: \glsentryname{#1}.\par @@ -16142,43 +16332,43 @@ custom command:  
       \par\medskip  
      }
      -

      define your entries +

      define your entries

      -
      +
      \newglossaryentry{function}{name={function},  
        description={a relation or expression involving variables}  
      }
      -

      and then later in the text: +

      and then later in the text:

      -
      +
      \displayterm{function}
      -

      -

      However, if may be that you want to use

      +

      However, if may be that you want to use hyperref and have commands like \gls link back to the place where the term is described. Instead of using \glsentryname use -



      \glsxtrglossentry  \glsxtrglossentry{label}

      -

      +

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

      This is designed to behave much like the way the name is displayed in the +

      This is designed to behave much like the way the name is displayed in the glossary. It performs the following:

      -

      otherwise it does

      +

      otherwise it does

      • \glsentryitem{glossnamefont

        If you have used

        If you have used \nopostdesc or \glsxtrnopostpunc in any of your description fields, you can use -



        \glsxtractivatenopost  \glsxtractivatenopost

        -

        +

        to make these commands behave as they normally do within a glossary. This needs to be placed before

        @@ -16260,10 +16450,10 @@ class="cmtt-10">}\glspostdescription class="cmtt-10">\glsnonextpages and \glsnextpages have no effect outside of the glossary and are not intended for use in a standalone context. -

        It’s also possible to select a different field (rather than using

        It’s also possible to select a different field (rather than using name): -



        \glsxtrglossentryother  }{field}

        -

        +

        The ⟨field⟩ must be given using its internal field label which may not be the same as the key used to set the field. See the key to field mappings table in the }.

      • Otherwise ⟨header⟩ is simply the field value.
      -

      The

      The \glsxtrglossentryother command internally uses \glossentrynameother{label}

      (for example, \glssymbolaccessdisplay). -

      This means that my custom command can be changed to: +

      This means that my custom command can be changed to:

      -
      +
      \newcommand{\displayterm}[1]{%  
       \par\medskip\par\noindent  
       Definition: \glsxtrglossentry{#1}.\par @@ -16343,7 +16533,7 @@ class="cmtt-10">\glssymbolaccessdisplay).  
       \par\medskip  
      }
      -

      If I want numbered definitions, then I can use the package options

      If I want numbered definitions, then I can use the package options entrycounter or subentrycounter -

      + -

      The counter label uses a dot after the number by default but this can be changed to +

      The counter label uses a dot after the number by default but this can be changed to a colon:

      -
      +
      \renewcommand*{\glsentrycounterlabel}{\theglossaryentry:\space}
      -

      It’s now possible to not only use

      It’s now possible to not only use \gls to link back to the definition but also use \glsrefentry to reference the counter and \glsxtrpageref to reference the page number. -

      If I want the description to behave more like it does in a glossary in need to make +

      If I want the description to behave more like it does in a glossary in need to make the following modification:

      -
      +
      \newcommand{\displayterm}[1]{%  
       \par\medskip\par\noindent  
       Definition \glsxtrglossentry{#1}.\par @@ -16393,18 +16583,18 @@ the following modification:  
       \par\medskip  
      }
      -

      (Note the grouping to localise

      (Note the grouping to localise \glsxtractivatenopost.) -

      You can also use

      You can also use \glsxtrglossentry within section headings. For example:

      -
      +
      \section{\glsxtrglossentry{function}}
      -

      This will use

      This will use \glsentryname in PDF bookmarks (if \texorpdfstring is defined) and will use \@glsxtrnotinmark and \glsxtrrestoremarkhook.) -

      +

      -

      Top

      10.4 Entry Aliases

      -

      An entry can be made an alias of another entry using the

      An entry can be made an alias of another entry using the alias key. The value should be the label of the other term. There’s no check for the other’s @@ -16436,7 +16626,7 @@ defining the other entry after the aliased entry. (For example, when used with href="#glo:bib2gls">bib2gls.) -

      If an entry ⟨

      If an entry ⟨entry-1⟩ is made an alias of ⟨entry-2⟩ then:

      -

      The index suppression trigger is performed by -


      The index suppression trigger is performed by +


      \glsxtrsetaliasnoindex  \glsxtrsetaliasnoindex

      -

      +

      This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts @@ -16526,49 +16716,49 @@ class="cmss-10">=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 -



      \glsxtralias  \glsxtralias{label}

      -

      +

      -

      -

      +

      Top

      11. Supplemental Packages

      -

      The

      The glossaries bundle provides additional support packages glossaries-prefix (for @@ -16577,10 +16767,10 @@ class="cmss-10">glossaries-accsupp (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 glossaries-extra. For @@ -16589,7 +16779,7 @@ example:

      -
      +
      \documentclass{article}  
      \usepackage{glossaries-extra}  
      \usepackage{glossaries-prefix} @@ -16604,13 +16794,13 @@ example:  
      \printglossaries  
      \end{document}
      -

      -

      +

      +

      -

      Top

      11.2 Accessibility Support

      -

      The

      The glossaries-accsupp package needs to be loaded before glossaries-extra or through @@ -16622,10 +16812,10 @@ class="cmss-10">accsupp -

      +
      \usepackage[accsupp]{glossaries-extra}
      -

      If you don’t load

      If you don’t load glossaries-accsupp or you load glossaries-accsuppxxx⟩ 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 ⟨label⟩. -

      If the

      If the glossaries-accsupp 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  
        {% @@ -16681,20 +16871,20 @@ class="cmss-10">glossaries-accsupp  {#1}%  
      }
      -

      (

      (\glsnameaccessdisplay is defined by the glossaries-accsupp package.) The first letter upper case version is: -



      \Glsaccessname  \Glsaccessname{label}

      -

      +

      Without the glossaries-accsupp package this is just defined as: @@ -16702,17 +16892,17 @@ class="cmss-10">glossaries-accsupp -

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

      With the

      With the glossaries-accsupp package this is defined as:

      -
      +
      \newcommand*{\Glsaccessname}[1]{%  
        \glsnameaccessdisplay  
        {% @@ -16721,112 +16911,112 @@ 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. -



      \Glsaccesstext  \Glsaccesstext{label}

      -

      +

      This displays the value of the text field with the first letter converted to upper case. -



      \glsaccessplural  \glsaccessplural{label}

      -

      +

      This displays the value of the plural field. -



      \Glsaccessplural  \Glsaccessplural{label}

      -

      +

      This displays the value of the plural field with the first letter converted to upper case. -



      \glsaccessfirst  \glsaccessfirst{label}

      -

      +

      This displays the value of the first field. -



      \Glsaccessfirst  \Glsaccessfirst{label}

      -

      +

      This displays the value of the first field with the first letter converted to upper case. -



      \glsaccessfirstplural  \glsaccessfirstplural{label}

      -

      +

      This displays the value of the firstplural field. -



      \Glsaccessfirstplural  \Glsaccessfirstplural{label}

      -

      +

      This displays the value of the firstplural field with the first letter converted to upper case. -



      \glsaccesssymbol  \glsaccesssymbol{label}

      -

      +

      This displays the value of the symbol field. -



      \Glsaccesssymbol  }

      -

      +

      This displays the value of the symbol field with the first letter converted to upper case. -



      \glsaccesssymbolplural  \glsaccesssymbolplural{label}

      -

      +

      This displays the value of the symbolplural field. -



      \Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

      -

      +

      This displays the value of the symbolplural field with the first letter converted to upper case. -



      \glsaccessdesc  \glsaccessdesc{label}

      -

      +

      This displays the value of the desc field. -



      \Glsaccessdesc  \Glsaccessdesc{label}

      -

      +

      This displays the value of the desc field with the first letter converted to upper case. -



      \glsaccessdescplural  \glsaccessdescplural{label}

      -

      +

      This displays the value of the descplural field. -



      \Glsaccessdescplural  \Glsaccessdescplural{label}

      -

      +

      This displays the value of the descplural field with the first letter converted to upper case. -



      \glsaccessshort  \glsaccessshort{label}

      -

      +

      This displays the value of the short field. -



      \Glsaccessshort  \Glsaccessshort{label}

      -

      +

      This displays the value of the short field with the first letter converted to upper case. -



      \glsaccessshortpl  \glsaccessshortpl{label}

      -

      +

      This displays the value of the shortplural field. -



      \Glsaccessshortpl  \Glsaccessshortpl{label}

      -

      +

      This displays the value of the shortplural field with the first letter converted to upper case. -



      \glsaccesslong  \glsaccesslong{label}

      -

      +

      This displays the value of the long field. -



      \Glsaccesslong  \Glsaccesslong{label}

      -

      +

      This displays the value of the long field with the first letter converted to upper case. -



      \glsaccesslongpl  }

      -

      +

      This displays the value of the longplural field. -



      \Glsaccesslongpl  \Glsaccesslongpl{label}

      -

      +

      This displays the value of the longplural field with the first letter converted to upper @@ -17009,11 +17199,11 @@ 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
      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\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 polyglossiapolyglossia -

      +
      \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. For example: @@ -17338,24 +17528,24 @@ 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-langtracklang 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}% @@ -17396,8 +17586,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  }{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 @@ -17515,17 +17705,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 automakeshort-nolong-noreg  230
          short-postfootnote  231, 232, 231, 232, 233, 234, 235, 318, 319, 320, 321, 322, 322, 323, 324, 325, 326, 327, 328, 329, 330, 329, 330, 331, 332, 333, 373, 374, 375, 376, 377, 377, 378, 379, 380, 381, 382, 383, 384, 385, 384, 385, 386, 387, 388, 427, 428
          general  429, 430, 429, 430, 431, 432, 433, 435, 436
          index  437, 437, 438
          number  439
          symbol  440, 440, 441
      category attributes:
          563, 564
          targeturl  565, 565, 566, 567, 568, convertgls2bib  580
      \csGlsXtrLetField  581
      \CustomAbbreviationFields  \eglssetwidest  584
      \eGlsXtrSetField  \eglsupdatewidest  585
      +\eGlsXtrSetField  586
      entry location  586, 587, 588
      +class="cmbx-10">587, 588, 589
      entrycounter package  589
      +href="glossaries-extra-manual.html#dx1-39015" >590
      etoolbox package  590, 591, 592, 593, 594, 595, 596
      +href="glossaries-extra-manual.html#dx1-6" >591, 592, 593, 594, 595, 596, 597

      F fancyhdr package  597
      +href="glossaries-extra-manual.html#dx1-13042" >598
      first use  598, 599, 600, 599, 600, 601, 602, 603, 604, 605, 606, 607, 608, 609, 610, 611, 612, 613, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 602, 603, 604, 605, 606, 607, 608, 609, 610, 611, 612, 613, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 647, 648, 649
      +class="cmbx-10">648, 649, 650
      first use flag  650, 651, 652, 653, 654, 651, 652, 653, 654, 655, 655
      +class="cmbx-10">656
      first use text  656, 657
      +class="cmbx-10">657, 658
      fontenc package  658
      +href="glossaries-extra-manual.html#dx1-22024" >659

      G \gglssetwidest  659
      -\gGlsXtrSetField  660
      +\gglsupdatewidest  661
      +\gGlsXtrSetField  662
      glossaries package  661, 662, 663, 664, 665, 666, 667, 668, 669, 670, 671
      +href="glossaries-extra-manual.html#dx1-5032" >663, 664, 665, 666, 667, 668, 669, 670, 671, 672, 673
      glossaries-accsupp package  672, 673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687
      +href="glossaries-extra-manual.html#dx1-4036" >674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689
      glossaries-extra package  688, 689
      +href="glossaries-extra-manual.html#dx1-5034" >690, 691
      glossaries-extra-stylemods package  690, 691, 692, 693, 694, 695, 696
      +href="glossaries-extra-manual.html#dx1-4027" >692, 693, 694, 695, 696, 697, 698
      glossaries-prefix package  697, 698, 699
      +href="glossaries-extra-manual.html#dx1-41001" >699, 700, 701
      \glossariesextrasetup  700
      +href="glossaries-extra-manual.html#dx1-4178" >702
      glossary styles:
          altlist  701
      +href="glossaries-extra-manual.html#dx1-17022" >703
          alttree  702, 703, 704, 705, 706, 707, 708
      +href="glossaries-extra-manual.html#dx1-17032" >704, 705, 706, 707, 708, 709, 710
          bookindex  709, 710, 711, 712
      +href="glossaries-extra-manual.html#dx1-13002" >711, 712, 713, 714
          index  713
      +href="glossaries-extra-manual.html#dx1-17027" >715
          inline  714, 715
      +href="glossaries-extra-manual.html#dx1-17006" >716, 717
          list  716, 717
      +href="glossaries-extra-manual.html#dx1-17018" >718, 719
          listdotted  718
      +href="glossaries-extra-manual.html#dx1-17023" >720
          long  719
      +href="glossaries-extra-manual.html#dx1-17012" >721
          long3col  720
      +href="glossaries-extra-manual.html#dx1-17004" >722
          mcolindexgroup  721
      +href="glossaries-extra-manual.html#dx1-13003" >723
          tree  722
      +href="glossaries-extra-manual.html#dx1-17028" >724
      glossary-bookindex package  723, 724
      +href="glossaries-extra-manual.html#dx1-13001" >725, 726
      glossary-inline package  725
      +href="glossaries-extra-manual.html#dx1-17007" >727
      glossary-tree package  726, 727, 728, 729
      +href="glossaries-extra-manual.html#dx1-13035" >728, 729, 730, 731
      \glossentrynameother  730
      +class="cmti-10">732
      \glossxtrsetpopts  731
      +class="cmti-10">733
      \glsabbrvdefaultfont  732, 734, 733
      +class="cmti-10">735
      \glsabbrvemfont  734
      +class="cmti-10">736
      \glsabbrvfont  735
      +class="cmti-10">737
      \glsabbrvhyphenfont  736
      +class="cmti-10">738
      \glsabbrvonlyfont  737
      +class="cmti-10">739
      \glsabbrvscfont  738
      +class="cmti-10">740
      \glsabbrvsmfont  739
      +class="cmti-10">741
      \glsabbrvuserfont  740, 742, 741
      +class="cmti-10">743
      \Glsaccessdesc  742
      +class="cmti-10">744
      \glsaccessdesc  743
      +class="cmti-10">745
      \Glsaccessdescplural  744
      +class="cmti-10">746
      \glsaccessdescplural  745
      +class="cmti-10">747
      \Glsaccessfirst  746
      +class="cmti-10">748
      \glsaccessfirst  747
      +class="cmti-10">749
      \Glsaccessfirstplural  748
      +class="cmti-10">750
      \glsaccessfirstplural  749
      +class="cmti-10">751
      \Glsaccesslong  750
      +class="cmti-10">752
      \glsaccesslong  751
      +class="cmti-10">753
      \Glsaccesslongpl  752
      +class="cmti-10">754
      \glsaccesslongpl  753
      +class="cmti-10">755
      \Glsaccessname  754
      +class="cmti-10">756
      + + + \glsaccessname  755
      +class="cmti-10">757
      \Glsaccessplural  756
      - - - +class="cmti-10">758
      \glsaccessplural  757
      +class="cmti-10">759
      \Glsaccessshort  758
      +class="cmti-10">760
      \glsaccessshort  759
      +class="cmti-10">761
      \Glsaccessshortpl  760
      +class="cmti-10">762
      \glsaccessshortpl  761
      +class="cmti-10">763
      \Glsaccesssymbol  762
      +class="cmti-10">764
      \glsaccesssymbol  763
      +class="cmti-10">765
      \Glsaccesssymbolplural  764
      +class="cmti-10">766
      \glsaccesssymbolplural  765
      +class="cmti-10">767
      \Glsaccesstext  766
      +class="cmti-10">768
      \glsaccesstext  767
      +class="cmti-10">769
      \glsacspace  768
      +class="cmti-10">770
      \glsacspacemax  769
      +class="cmti-10">771
      \glsadd options
          format  770
      +href="glossaries-extra-manual.html#dx1-8071" >772
          theHvalue  771, 772
      +href="glossaries-extra-manual.html#dx1-6022" >773, 774
          thevalue  773, 774, 775, 776, 777
      +href="glossaries-extra-manual.html#dx1-6021" >775, 776, 777, 778, 779
      \glscategory  778
      +class="cmti-10">780
      \glscategorylabel  779
      +class="cmti-10">781
      \glscurrententrylabel  780
      +class="cmti-10">782
      \glscurrentfieldvalue  781
      +href="glossaries-extra-manual.html#dx1-37029" >783
      \glsentrycurrcount  782
      +class="cmti-10">784
      \glsentryprevcount  783
      +class="cmti-10">785
      \glsentryprevmaxcount  784
      +class="cmti-10">786
      \glsentryprevtotalcount  785
      +class="cmti-10">787
      \glsFindWidestAnyName  786
      +href="glossaries-extra-manual.html#dx1-17055" >788
      \glsFindWidestAnyNameLocation  787
      +href="glossaries-extra-manual.html#dx1-17067" >789
      \glsFindWidestAnyNameSymbol  788
      +href="glossaries-extra-manual.html#dx1-17059" >790
      \glsFindWidestAnyNameSymbolLocation  789
      +href="glossaries-extra-manual.html#dx1-17064" >791
      \glsFindWidestLevelTwo  790
      +href="glossaries-extra-manual.html#dx1-17057" >792
      \glsFindWidestTopLevelName  791
      +href="glossaries-extra-manual.html#dx1-17050" >793
      \glsFindWidestUsedAnyName  792
      +href="glossaries-extra-manual.html#dx1-17053" >794
      \glsFindWidestUsedAnyNameLocation  793
      +href="glossaries-extra-manual.html#dx1-17065" >795
      \glsFindWidestUsedAnyNameSymbol  794
      +href="glossaries-extra-manual.html#dx1-17058" >796
      \glsFindWidestUsedAnyNameSymbolLocation  795
      +href="glossaries-extra-manual.html#dx1-17060" >797
      \glsFindWidestUsedLevelTwo  796
      +href="glossaries-extra-manual.html#dx1-17056" >798
      \glsFindWidestUsedTopLevelName  797
      +href="glossaries-extra-manual.html#dx1-17051" >799
      \glsfirstabbrvdefaultfont  798
      +class="cmti-10">800
      \glsfirstabbrvemfont  799
      +class="cmti-10">801
      \glsfirstabbrvfont  800
      +class="cmti-10">802
      \glsfirstabbrvhyphenfont  801
      +class="cmti-10">803
      \glsfirstabbrvonlyfont  802
      +class="cmti-10">804
      \glsfirstabbrvsmfont  803
      +class="cmti-10">805
      \glsfirstabbrvuserfont  804
      +class="cmti-10">806
      + + + \glsfirstlongdefaultfont  805
      +class="cmti-10">807
      \glsfirstlongemfont  806
      - - - +class="cmti-10">808
      \glsfirstlongfont  807
      +class="cmti-10">809
      \glsfirstlongfootnotefont  808
      +class="cmti-10">810
      \glsfirstlonghyphenfont  809
      +class="cmti-10">811
      \glsfirstlongonlyfont  810
      +class="cmti-10">812
      \glsfirstlonguserfont  811
      +class="cmti-10">813
      \Glsfmtfirst  812
      +class="cmti-10">814
      \glsfmtfirst  813
      +class="cmti-10">815
      \Glsfmtfirstpl  814
      +class="cmti-10">816
      \glsfmtfirstpl  815
      +class="cmti-10">817
      \Glsfmtfull  816
      +class="cmti-10">818
      \glsfmtfull  817
      +class="cmti-10">819
      \Glsfmtfullpl  818
      +class="cmti-10">820
      \glsfmtfullpl  819
      +class="cmti-10">821
      \Glsfmtlong  820
      +class="cmti-10">822
      \glsfmtlong  821
      +class="cmti-10">823
      \Glsfmtlongpl  822
      +class="cmti-10">824
      \glsfmtlongpl  823
      +class="cmti-10">825
      \Glsfmtname  824
      +class="cmti-10">826
      \glsfmtname  825
      +class="cmti-10">827
      \Glsfmtplural  826
      +class="cmti-10">828
      \glsfmtplural  827
      +class="cmti-10">829
      \Glsfmtshort  828
      +class="cmti-10">830
      \glsfmtshort  829
      +class="cmti-10">831
      \Glsfmtshortpl  830
      +class="cmti-10">832
      \glsfmtshortpl  831
      +class="cmti-10">833
      \Glsfmttext  832
      +class="cmti-10">834
      \glsfmttext  833
      +class="cmti-10">835
      \glsforeachwithattribute  834
      +class="cmti-10">836
      \glsgetattribute  835
      +class="cmti-10">837
      \glsgetcategoryattribute  836
      +class="cmti-10">838
      \glsgetwidestname  837
      +href="glossaries-extra-manual.html#dx1-17043" >839
      \glsgetwidestsubname  838
      +href="glossaries-extra-manual.html#dx1-17044" >840
      \glshasattribute  839
      +class="cmti-10">841
      \glshascategoryattribute  840
      +class="cmti-10">842
      \glshex  841
      +class="cmti-10">843
      \glsifattribute  842
      +class="cmti-10">844
      \glsifcategory  843
      +class="cmti-10">845
      \glsifcategoryattribute  844
      +class="cmti-10">846
      \glsifnotregular  845
      +class="cmti-10">847
      \glsifnotregularcategory  846
      +class="cmti-10">848
      \glsifregular  847
      +class="cmti-10">849
      \glsifregularcategory  848
      +class="cmti-10">850
      \glskeylisttok  849
      +class="cmti-10">851
      \glslabeltok  850
      +class="cmti-10">852
      + + + \glslink options
          format  851, 852, 853, 854
      - - - +href="glossaries-extra-manual.html#dx1-6034" >853, 854, 855, 856
          hyper  855, 856, 857
      +href="glossaries-extra-manual.html#dx1-11055" >857, 858, 859
          hyper=false  858
      +href="glossaries-extra-manual.html#dx1-26016" >860
          hyperoutside  859, 860
      +href="glossaries-extra-manual.html#dx1-6016" >861, 862
          noindex  861, 862, 863, 864, 865, 866, 867
      +href="glossaries-extra-manual.html#dx1-6001" >863, 864, 865, 866, 867, 868, 869
          theHvalue  868
      +href="glossaries-extra-manual.html#dx1-6025" >870
          thevalue  869
      +href="glossaries-extra-manual.html#dx1-6024" >871
          wrgloss  870, 871, 872, 873
      +href="glossaries-extra-manual.html#dx1-6009" >872, 873, 874, 875
      \glslinkcheckfirsthyperhook  874
      +class="cmti-10">876
      \glslistchildpostlocation  875
      +class="cmti-10">877
      \glslistchildprelocation  876
      +class="cmti-10">878
      \glslongdefaultfont  877
      +class="cmti-10">879
      \glslongemfont  878
      +class="cmti-10">880
      \glslongfont  879
      +class="cmti-10">881
      \glslongfootnotefont  880
      +class="cmti-10">882
      \glslonghyphenfont  881
      +class="cmti-10">883
      \glslongonlyfont  882
      +class="cmti-10">884
      \glslongpltok  883
      +class="cmti-10">885
      \glslongtok  884
      +class="cmti-10">886
      \glslonguserfont  885
      +class="cmti-10">887
      \glsnoidxdisplayloc  886
      +href="glossaries-extra-manual.html#dx1-8075" >888
      \glsps  887
      +class="cmti-10">889
      \glspt  888
      +class="cmti-10">890
      \glsseeitemformat  889
      +href="glossaries-extra-manual.html#dx1-5005" >891
      \glssetattribute  890
      +class="cmti-10">892
      \glssetcategoryattribute  891
      +class="cmti-10">893
      \glssetregularcategory  892
      +class="cmti-10">894
      \glsshortpltok  893
      +class="cmti-10">895
      \glsshorttok  894
      +class="cmti-10">896
      \glstreechildprelocation  895
      +class="cmti-10">897
      \glstreeprelocation  896
      +class="cmti-10">898
      +\glsupdatewidest  899
      \glsuseabbrvfont  897
      +class="cmti-10">900
      \glsuselongfont  898
      +class="cmti-10">901
      \Glsxtr  899
      +class="cmti-10">902
      \glsxtr  900
      +class="cmti-10">903
      \glsxtrabbrvfootnote  901
      +class="cmti-10">904
      \glsxtrabbrvpluralsuffix  902, 905, 903
      +class="cmti-10">906
      \glsxtractivatenopost  904
      +class="cmti-10">907
      \glsxtraddallcrossrefs  905
      +class="cmti-10">908
      \glsxtralias  906
      +class="cmti-10">909
      \glsxtrAltTreeIndent  907
      +href="glossaries-extra-manual.html#dx1-17073" >910
      \glsxtralttreeInit  908
      +href="glossaries-extra-manual.html#dx1-17072" >911
      \glsxtralttreeSubSymbolDescLocation  909
      +href="glossaries-extra-manual.html#dx1-17070" >912
      \glsxtralttreeSymbolDescLocation  910
      +href="glossaries-extra-manual.html#dx1-17069" >913
      + + + \glsxtrautoindex  911
      +class="cmti-10">914
      \glsxtrautoindexassignsort  912
      +class="cmti-10">915
      \glsxtrautoindexentry  913
      - - - +class="cmti-10">916
      \glsxtrbookindexatendgroup  914
      +class="cmti-10">917
      \glsxtrbookindexbetween  915
      +class="cmti-10">918
      \glsxtrbookindexbookmark  916
      +class="cmti-10">919
      \glsxtrbookindexcols  917
      +class="cmti-10">920
      \glsxtrbookindexcolspread  918
      +class="cmti-10">921
      \glsxtrbookindexfirstmark  919
      +class="cmti-10">922
      \glsxtrbookindexfirstmarkfmt  920
      +class="cmti-10">923
      \glsxtrbookindexformatheader  921
      +class="cmti-10">924
      \glsxtrbookindexlastmark  922
      +class="cmti-10">925
      \glsxtrbookindexlastmarkfmt  923
      +class="cmti-10">926
      \glsxtrbookindexmarkentry  924
      +class="cmti-10">927
      \glsxtrbookindexname  925
      +class="cmti-10">928
      \glsxtrbookindexparentchildsep  926
      +class="cmti-10">929
      \glsxtrbookindexparentsubchildsep  927
      +class="cmti-10">930
      \glsxtrbookindexprelocation  928
      +class="cmti-10">931
      \glsxtrbookindexsubatendgroup  929
      +class="cmti-10">932
      \glsxtrbookindexsubbetween  930
      +class="cmti-10">933
      \glsxtrbookindexsubname  931
      +class="cmti-10">934
      \glsxtrbookindexsubprelocation  932
      +class="cmti-10">935
      \glsxtrbookindexsubsubatendgroup  933
      +class="cmti-10">936
      \glsxtrbookindexsubsubbetween  934
      +class="cmti-10">937
      \glsxtrchecknohyperfirst  935
      +class="cmti-10">938
      \glsxtrcopytoglossary  936
      +class="cmti-10">939
      \glsxtrdeffield  937
      +href="glossaries-extra-manual.html#dx1-37018" >940
      \glsxtrdetoklocation  938
      +class="cmti-10">941
      \glsxtrdisplayendloc  939
      +href="glossaries-extra-manual.html#dx1-8078" >942
      \glsxtrdisplayendlochook  940
      +href="glossaries-extra-manual.html#dx1-8080" >943
      \glsxtrdisplaysingleloc  941
      +href="glossaries-extra-manual.html#dx1-8076" >944
      \glsxtrdisplaystartloc  942
      +href="glossaries-extra-manual.html#dx1-8077" >945
      \glsxtrdoautoindexname  943
      +class="cmti-10">946
      \glsxtrdowrglossaryhook  944
      +class="cmti-10">947
      \glsxtredeffield  945
      +href="glossaries-extra-manual.html#dx1-37020" >948
      \glsxtremsuffix  946
      +class="cmti-10">949
      \GlsXtrEnableEntryCounting  947
      +class="cmti-10">950
      \GlsXtrEnableEntryUnitCounting  948
      +class="cmti-10">951
      \GlsXtrEnableIndexFormatOverride  949
      +class="cmti-10">952
      \GlsXtrEnableInitialTagging  950
      +class="cmti-10">953
      \GlsXtrEnableOnTheFly  951
      +class="cmti-10">954
      \GlsXtrEnablePreLocationTag  952
      +class="cmti-10">955
      \glsxtrenablerecordcount  953
      +class="cmti-10">956
      \glsxtrentryfmt  954
      +href="glossaries-extra-manual.html#dx1-37008" >957
      \glsxtrfielddolistloop  955
      +href="glossaries-extra-manual.html#dx1-37044" >958
      \glsxtrfieldforlistloop  956
      +href="glossaries-extra-manual.html#dx1-37045" >959
      + + + \glsxtrfieldifinlist  957
      +href="glossaries-extra-manual.html#dx1-37046" >960
      \glsxtrfieldlistadd  958
      +href="glossaries-extra-manual.html#dx1-37040" >961
      \glsxtrfieldlisteadd  959
      - - - +href="glossaries-extra-manual.html#dx1-37042" >962
      \glsxtrfieldlistgadd  960
      +href="glossaries-extra-manual.html#dx1-37041" >963
      \glsxtrfieldlistxadd  961
      +href="glossaries-extra-manual.html#dx1-37043" >964
      \glsxtrfieldtitlecasecs  962
      +class="cmti-10">965
      \glsxtrfieldxifinlist  963
      +href="glossaries-extra-manual.html#dx1-37047" >966
      \glsxtrfmt  964
      +class="cmti-10">967
      +\glsxtrfmt*  968
      \GlsXtrFmtDefaultOptions  965
      +class="cmti-10">969
      +\glsxtrfmtdisplay  970
      \GlsXtrFmtField  966
      +class="cmti-10">971
      \GlsXtrFormatLocationList  967
      +class="cmti-10">972
      \GLSxtrfull  968
      +class="cmti-10">973
      \Glsxtrfull  969
      +class="cmti-10">974
      \glsxtrfull  970
      +class="cmti-10">975
      \Glsxtrfullformat  971
      +class="cmti-10">976
      \glsxtrfullformat  972
      +class="cmti-10">977
      \GLSxtrfullpl  973
      +class="cmti-10">978
      \Glsxtrfullpl  974
      +class="cmti-10">979
      \glsxtrfullpl  975
      +class="cmti-10">980
      \Glsxtrfullplformat  976
      +class="cmti-10">981
      \glsxtrfullplformat  977
      +class="cmti-10">982
      \glsxtrfullsep  978
      +class="cmti-10">983
      \glsxtrglossentry  979
      +class="cmti-10">984
      \glsxtrglossentryother  980
      +class="cmti-10">985
      \glsxtrhyphensuffix  981
      +class="cmti-10">986
      \glsxtrifcounttrigger  982
      +class="cmti-10">987
      +\glsxtrifcustomdiscardperiod  988
      \GlsXtrIfFieldEqStr  983
      +href="glossaries-extra-manual.html#dx1-37032" >989
      +\GlsXtrIfFieldUndef  990
      \glsxtrifhasfield  984
      +href="glossaries-extra-manual.html#dx1-37028" >991
      \glsxtrifhasfield*  985
      +href="glossaries-extra-manual.html#dx1-37030" >992
      \glsxtrifkeydefined  986
      +href="glossaries-extra-manual.html#dx1-37010" >993
      \glsxtriflabelinlist  987
      +class="cmti-10">994
      \glsxtrifrecordtrigger  988
      +class="cmti-10">995
      \glsxtrifwasfirstuse  989
      +href="glossaries-extra-manual.html#dx1-8049" >996
      \glsxtrindexaliased  990
      +class="cmti-10">997
      \glsxtrindexseealso  991
      +class="cmti-10">998
      \glsxtrinitwrgloss  992
      +class="cmti-10">999
      \Glsxtrinlinefullformat  993
      +class="cmti-10">1000
      \glsxtrinlinefullformat  994
      +class="cmti-10">1001
      \Glsxtrinlinefullplformat  995
      +class="cmti-10">1002
      \glsxtrinlinefullplformat  996
      +class="cmti-10">1003
      \glsxtrinsertinsidetrue  997
      +class="cmti-10">1004
      \GlsXtrLetField  998
      +href="glossaries-extra-manual.html#dx1-37024" >1005
      + + + \GlsXtrLetFieldToField  999
      +href="glossaries-extra-manual.html#dx1-37026" >1006
      \GlsXtrLoadResources  1000
      +class="cmti-10">1007
      \GlsXtrLocationRecordCount  1001
      +class="cmti-10">1008
      \glsxtrlocrangefmt  1002
      +href="glossaries-extra-manual.html#dx1-8079" >1009
      \Glsxtrlong  1003, 1010, 1004
      +class="cmti-10">1011
      \glsxtrlong  1005
      +class="cmti-10">1012
      \glsxtrlonghyphen  1006
      - - - +class="cmti-10">1013
      \glsxtrlonghyphenshort  1007
      +class="cmti-10">1014
      \GLSxtrlongpl  1008
      +class="cmti-10">1015
      \Glsxtrlongpl  1009
      +class="cmti-10">1016
      \glsxtrlongpl  1010
      +class="cmti-10">1017
      \glsxtrlongshortdescsort  1011
      +class="cmti-10">1018
      \glsxtrnewgls  1012
      +class="cmti-10">1019
      \glsxtrnewGLSlike  1013
      +class="cmti-10">1020
      \glsxtrnewglslike  1014
      +class="cmti-10">1021
      \glsxtrnewnumber  1015
      +class="cmti-10">1022
      \glsxtrnewrgls  1016
      +class="cmti-10">1023
      \glsxtrnewrGLSlike  1017
      +class="cmti-10">1024
      \glsxtrnewrglslike  1018
      +class="cmti-10">1025
      \glsxtrnewsymbol  1019
      +class="cmti-10">1026
      \GlsXtrNoGlsWarningAutoMake  1020
      +class="cmti-10">1027
      \GlsXtrNoGlsWarningBuildInfo  1021
      +class="cmti-10">1028
      \GlsXtrNoGlsWarningCheckFile  1022
      +class="cmti-10">1029
      \GlsXtrNoGlsWarningEmptyMain  1023
      +class="cmti-10">1030
      \GlsXtrNoGlsWarningEmptyNotMain  1024
      +class="cmti-10">1031
      \GlsXtrNoGlsWarningEmptyStart  1025
      +class="cmti-10">1032
      \GlsXtrNoGlsWarningHead  1026
      +class="cmti-10">1033
      \GlsXtrNoGlsWarningMisMatch  1027
      +class="cmti-10">1034
      \GlsXtrNoGlsWarningNoOut  1028
      +class="cmti-10">1035
      \GlsXtrNoGlsWarningTail  1029
      +class="cmti-10">1036
      \glsxtrnopostpunc  1030
      +class="cmti-10">1037
      \glsxtronlysuffix  1031
      +class="cmti-10">1038
      \glsxtrorglong  1032
      +class="cmti-10">1039
      \glsxtrorgshort  1033
      +class="cmti-10">1040
      \Glsxtrp  1034, 1041, 1035
      +class="cmti-10">1042
      \glsxtrp  1036
      +class="cmti-10">1043
      \glsxtrpageref  1037
      +class="cmti-10">1044
      \glsxtrparen  1038
      +class="cmti-10">1045
      \Glsxtrpl  1039
      +class="cmti-10">1046
      \glsxtrpl  1040
      +class="cmti-10">1047
      \glsxtrpostdescription  1041
      +class="cmti-10">1048
      \glsxtrposthyphenlong  1042
      +class="cmti-10">1049
      \glsxtrposthyphenshort  1043
      +class="cmti-10">1050
      \glsxtrpostlink  1044
      +class="cmti-10">1051
      \glsxtrpostlinkAddDescOnFirstUse  1045
      +href="glossaries-extra-manual.html#dx1-8040" >1052
      \glsxtrpostlinkAddSymbolOnFirstUse  1046
      +href="glossaries-extra-manual.html#dx1-8044" >1053
      + + + \glsxtrpostlinkendsentence  1047
      +class="cmti-10">1054
      \glsxtrpostlinkhook  1048
      +class="cmti-10">1055
      \glsxtrpostlongdescription  1049
      +href="glossaries-extra-manual.html#dx1-5031" >1056
      \glsxtrpostnamehook  1050
      +class="cmti-10">1057
      \GlsXtrPostNewAbbreviation  1051
      +class="cmti-10">1058
      \glsxtrprelocation  1052, 1059, 1053
      +class="cmti-10">1060
      \glsxtrprovidestoragekey  1054
      - - - +href="glossaries-extra-manual.html#dx1-37009" >1061
      \GlsXtrRecordCount  1055
      +class="cmti-10">1062
      \GlsXtrRecordCounter  1056
      +href="glossaries-extra-manual.html#dx1-37050" >1063
      \glsxtrrecordtriggervalue  1057
      +class="cmti-10">1064
      \glsxtrregularfont  1058
      +class="cmti-10">1065
      \glsxtrresourcefile  1059
      +class="cmti-10">1066
      \glsxtrresourceinit  1060
      +class="cmti-10">1067
      +\glsxtrrestorepostpunc  1068
      \glsxtrRevertMarks  1061
      +class="cmti-10">1069
      \glsxtrscsuffix  1062
      +class="cmti-10">1070
      \glsxtrseealsolabels  1063
      +class="cmti-10">1071
      \glsxtrseelist  1064
      +class="cmti-10">1072
      \GlsXtrSetActualChar  1065
      +class="cmti-10">1073
      \glsxtrsetaliasnoindex  1066
      +class="cmti-10">1074
      \GlsXtrSetAltModifier  1067
      +href="glossaries-extra-manual.html#dx1-8073" >1075
      \glsxtrsetcategory  1068
      +class="cmti-10">1076
      \glsxtrsetcategoryforall  1069
      +class="cmti-10">1077
      \GlsXtrSetDefaultGlsOpts  1070
      +href="glossaries-extra-manual.html#dx1-8067" >1078
      \GlsXtrSetEncapChar  1071
      +class="cmti-10">1079
      \GlsXtrSetEscChar  1072
      +class="cmti-10">1080
      \GlsXtrSetField  1073
      +href="glossaries-extra-manual.html#dx1-37014" >1081
      \glsxtrsetfieldifexists  1074
      +href="glossaries-extra-manual.html#dx1-37015" >1082
      \glsxtrsetgrouptitle  1075
      +class="cmti-10">1083
      \GlsXtrSetLevelChar  1076
      +class="cmti-10">1084
      \glsxtrsetpopts  1077
      +class="cmti-10">1085
      \GlsXtrSetRecordCountAttribute  1078
      +class="cmti-10">1086
      \Glsxtrshort  1079, 1087, 1080
      +class="cmti-10">1088
      \glsxtrshort  1081
      +class="cmti-10">1089
      \glsxtrshorthyphenlong  1082
      +class="cmti-10">1090
      \GLSxtrshortpl  1083
      +class="cmti-10">1091
      \Glsxtrshortpl  1084
      +class="cmti-10">1092
      \glsxtrshortpl  1085
      +class="cmti-10">1093
      \glsxtrsmsuffix  1086
      +class="cmti-10">1094
      \Glsxtrsubsequentfmt  1087
      +class="cmti-10">1095
      \glsxtrsubsequentfmt  1088
      +class="cmti-10">1096
      \Glsxtrsubsequentplfmt  1089
      +class="cmti-10">1097
      \glsxtrsubsequentplfmt  1090
      +class="cmti-10">1098
      \glsxtrtagfont  1091
      +class="cmti-10">1099
      \GlsXtrTotalRecordCount  1092
      +class="cmti-10">1100
      \glsxtrunsrtdo  1093
      +class="cmti-10">1101
      + + + \GlsXtrUseAbbrStyleFmts  1094
      +class="cmti-10">1102
      \GlsXtrUseAbbrStyleSetup  1095
      +class="cmti-10">1103
      \Glsxtrusefield  1096
      +href="glossaries-extra-manual.html#dx1-37037" >1104
      \glsxtrusefield  1097
      +href="glossaries-extra-manual.html#dx1-37035" >1105
      \glsxtruserfield  1098
      +class="cmti-10">1106
      \glsxtruserparen  1099
      +class="cmti-10">1107
      \glsxtrusersuffix  1100, 1108, 1101
      +class="cmti-10">1109
      \glsxtrusesee  1102
      - - - +class="cmti-10">1110
      \glsxtruseseealso  1103
      +class="cmti-10">1111
      \glsxtruseseeformat  1104, 1112, 1105
      +class="cmti-10">1113
      \GlsXtrWarnDeprecatedAbbrStyle  1106
      +class="cmti-10">1114
      \GlsXtrWarning  1107
      +class="cmti-10">1115
      \glsxtrword  1108
      +class="cmti-10">1116
      \glsxtrwordsep  1109
      +class="cmti-10">1117
      \glsxtrwrglossmark  1110
      +class="cmti-10">1118

      H hyperref package  1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118, 1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129, 1130
      +href="glossaries-extra-manual.html#dx1-6033" >1119, 1120, 1121, 1122, 1123, 1124, 1125, 1126, 1127, 1128, 1129, 1130, 1131, 1132, 1133, 1134, 1135, 1136, 1137, 1138

      I \ifglsxtrinitwrglossbefore  1131
      +class="cmti-10">1139
      inputenc package  1132
      +href="glossaries-extra-manual.html#dx1-33018" >1140

      L link-text  1133, 1134, 1135, 1136, 1137, 1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157, 1158, 1151
      +class="cmbx-10">1159
      location list  1152, 1153, 1154, 1155, 1160, 1161, 1162, 1163, 1156
      +class="cmbx-10">1164
      \longnewglossaryentry  1157
      +href="glossaries-extra-manual.html#dx1-5029" >1165

      M makeglossaries  1158, 1159, 1160, 1161, 1166, 1167, 1168, 1169, 1162
      +class="cmbx-10">1170
      \makeglossaries  1163
      +href="glossaries-extra-manual.html#dx1-5046" >1171
      makeglossaries-lite  1164, 1172, 1165
      +class="cmbx-10">1173
      makeglossaries-lite  1166, 1174, 1167
      +class="cmbx-10">1175
      makeindex  1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178, 1179, 1176, 1177, 1178, 1179, 1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1180
      +class="cmbx-10">1188
      makeindex  1181, 1182, 1183, 1184
      +href="glossaries-extra-manual.html#dx1-6028" >1189, 1190, 1191, 1192
      memoir class  1185
      +href="glossaries-extra-manual.html#dx1-3021" >1193
      mfirstuc package  1186, 1187, 1188
      +href="glossaries-extra-manual.html#dx1-5" >1194, 1195, 1196

      N \newabbreviation  1189
      +class="cmti-10">1197
      \newabbreviationstyle  1190
      +class="cmti-10">1198
      + + + \newacronym  1191
      +class="cmti-10">1199
      \newglossaryentry options
          alias  1192, 1193, 1194, 1195, 1196, 1197
      +href="glossaries-extra-manual.html#dx1-5021" >1200, 1201, 1202, 1203, 1204, 1205
          category  1198, 1199, 1200, 1201, 1202, 1203
      +href="glossaries-extra-manual.html#dx1-5020" >1206, 1207, 1208, 1209, 1210, 1211
          desc  1204, 1205
      +href="glossaries-extra-manual.html#dx1-43038" >1212, 1213
          descplural  1206, 1207
      +href="glossaries-extra-manual.html#dx1-43042" >1214, 1215
          description  1208, 1209, 1210, 1211, 1212, 1213, 1214, 1215, 1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227
      - - - +href="glossaries-extra-manual.html#dx1-5002" >1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228, 1229, 1230, 1231, 1232, 1233, 1234, 1235
          descriptionplural  1228, 1229, 1230, 1231
      +href="glossaries-extra-manual.html#dx1-5030" >1236, 1237, 1238, 1239
          first  1232, 1233, 1234, 1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244
      +href="glossaries-extra-manual.html#dx1-8013" >1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252
          firstplural  1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
      +href="glossaries-extra-manual.html#dx1-8014" >1253, 1254, 1255, 1256, 1257, 1258, 1259, 1260, 1261, 1262
          location  1255, 1256
      +href="glossaries-extra-manual.html#dx1-13016" >1263, 1264
          loclist  1257
      +href="glossaries-extra-manual.html#dx1-38025" >1265
          long  1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266
      +href="glossaries-extra-manual.html#dx1-10026" >1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274
          longplural  1267, 1268, 1269, 1270, 1271, 1272
      +href="glossaries-extra-manual.html#dx1-10010" >1275, 1276, 1277, 1278, 1279, 1280
          name  1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304
      +href="glossaries-extra-manual.html#dx1-5007" >1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312
          parent  1305, 1306, 1307
      +href="glossaries-extra-manual.html#dx1-17054" >1313, 1314, 1315
          plural  1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320
      +href="glossaries-extra-manual.html#dx1-8017" >1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328
          see  1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347
      +href="glossaries-extra-manual.html#dx1-4054" >1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355
          seealso  1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357
      +href="glossaries-extra-manual.html#dx1-4055" >1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365
          short  1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371
      +href="glossaries-extra-manual.html#dx1-8011" >1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379
          shortplural  1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386
      +href="glossaries-extra-manual.html#dx1-10011" >1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394
          sort  1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403
      +href="glossaries-extra-manual.html#dx1-4124" >1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411
          symbol  1404, 1405, 1406
      +href="glossaries-extra-manual.html#dx1-43030" >1412, 1413, 1414
          symbolplural  1407, 1408
      +href="glossaries-extra-manual.html#dx1-43034" >1415, 1416
          text  1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421
      +href="glossaries-extra-manual.html#dx1-5009" >1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429
          type  1422, 1423
      +href="glossaries-extra-manual.html#dx1-12046" >1430, 1431
          user1  1424, 1425, 1426
      +href="glossaries-extra-manual.html#dx1-22080" >1432, 1433, 1434
      number list  1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1455
      +class="cmbx-10">1463

      P package options:
          abbreviations  1456, 1457, 1458, 1459, 1460
      +href="glossaries-extra-manual.html#dx1-4136" >1464, 1465, 1466, 1467, 1468
          accsupp  1461, 1462, 1463, 1464
      +href="glossaries-extra-manual.html#dx1-4035" >1469, 1470, 1471, 1472
          acronym  1465
      +href="glossaries-extra-manual.html#dx1-4144" >1473
          acronymlists  1466
      +href="glossaries-extra-manual.html#dx1-4148" >1474
          automake  1467, 1468
      +href="glossaries-extra-manual.html#dx1-5054" >1475, 1476
          autoseeindex  1469, 1470
      +href="glossaries-extra-manual.html#dx1-4064" >1477, 1478
              false  1471, 1472
      +href="glossaries-extra-manual.html#dx1-4056" >1479, 1480
          debug  1473
      +href="glossaries-extra-manual.html#dx1-4002" >1481
              all  1474, 1475
      +href="glossaries-extra-manual.html#dx1-4005" >1482, 1483
              showtargets  1476, 1477
      +href="glossaries-extra-manual.html#dx1-4003" >1484, 1485
      + + +         showwrgloss  1478, 1479, 1480
      +href="glossaries-extra-manual.html#dx1-4004" >1486, 1487, 1488
              true  1481
      +href="glossaries-extra-manual.html#dx1-4007" >1489
          docdef  1482, 1483, 1484, 1485
      +href="glossaries-extra-manual.html#dx1-4104" >1490, 1491, 1492, 1493
              restricted  1486, 1487
      +href="glossaries-extra-manual.html#dx1-4117" >1494, 1495
              true  1488, 1489
      +href="glossaries-extra-manual.html#dx1-4132" >1496, 1497
          docdefs  1490, 1491, 1492
      +href="glossaries-extra-manual.html#dx1-30003" >1498, 1499, 1500
              true  1493
      +href="glossaries-extra-manual.html#dx1-4116" >1501
          entrycounter  1494, 1495
      - - - +href="glossaries-extra-manual.html#dx1-36002" >1502, 1503
          hyperfirst
              false  1496
      +href="glossaries-extra-manual.html#dx1-27030" >1504
          index  1497, 1498
      +href="glossaries-extra-manual.html#dx1-5043" >1505, 1506
          indexcrossrefs  1499, 1500, 1501, 1502
      +href="glossaries-extra-manual.html#dx1-4053" >1507, 1508, 1509, 1510
              false  1503
      +href="glossaries-extra-manual.html#dx1-4063" >1511
          indexonlyfirst  1504, 1505, 1506, 1507
      +href="glossaries-extra-manual.html#dx1-6002" >1512, 1513, 1514, 1515
          nogroupskip  1508
      +href="glossaries-extra-manual.html#dx1-17014" >1516
          nomain  1509
      +href="glossaries-extra-manual.html#dx1-3032" >1517
          nomissingglstext  1510
      +href="glossaries-extra-manual.html#dx1-4135" >1518
          nonumberlist  1511, 1512, 1513, 1514
      +href="glossaries-extra-manual.html#dx1-7026" >1519, 1520, 1521, 1522
          nopostdot  1515, 1516, 1517, 1518
      +href="glossaries-extra-manual.html#dx1-4023" >1523, 1524, 1525, 1526
              false  1519, 1520, 1521
      +href="glossaries-extra-manual.html#dx1-3004" >1527, 1528, 1529
              true  1522
      +href="glossaries-extra-manual.html#dx1-3003" >1530
          noredefwarn
              false  1523
      +href="glossaries-extra-manual.html#dx1-3009" >1531
              true  1524
      +href="glossaries-extra-manual.html#dx1-3006" >1532
          notree  1525
      +href="glossaries-extra-manual.html#dx1-17034" >1533
          numbers  1526, 1527, 1528
      +href="glossaries-extra-manual.html#dx1-4152" >1534, 1535, 1536
          postdot  1529, 1530, 1531
      +href="glossaries-extra-manual.html#dx1-3005" >1537, 1538, 1539
          postpunc  1532, 1533, 1534
      +href="glossaries-extra-manual.html#dx1-4019" >1540, 1541, 1542
              comma  1535
      +href="glossaries-extra-manual.html#dx1-4020" >1543
              dot  1536
      +href="glossaries-extra-manual.html#dx1-4021" >1544
              none  1537
      +href="glossaries-extra-manual.html#dx1-4022" >1545
          record  1538, 1539, 1540, 1541, 1542, 1543
      +href="glossaries-extra-manual.html#dx1-4062" >1546, 1547, 1548, 1549, 1550, 1551
              alsoindex  1544, 1545, 1546, 1547, 1548, 1549
      +href="glossaries-extra-manual.html#dx1-4009" >1552, 1553, 1554, 1555, 1556, 1557
              off  1550, 1551
      +href="glossaries-extra-manual.html#dx1-5049" >1558, 1559
              only  1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560
      +href="glossaries-extra-manual.html#dx1-4067" >1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568
          section
              chapter  1561
      +href="glossaries-extra-manual.html#dx1-13033" >1569
          seeautonumberlist  1562
      +href="glossaries-extra-manual.html#dx1-7027" >1570
          seenoindex  1563
      +href="glossaries-extra-manual.html#dx1-7016" >1571
              ignore  1564, 1565
      +href="glossaries-extra-manual.html#dx1-7018" >1572, 1573
              warn  1566
      +href="glossaries-extra-manual.html#dx1-38012" >1574
          shortcuts  1567, 1568
      +href="glossaries-extra-manual.html#dx1-4154" >1575, 1576
              abbr  1569, 1570
      +href="glossaries-extra-manual.html#dx1-4160" >1577, 1578
              abbreviation  1571, 1572
      +href="glossaries-extra-manual.html#dx1-21001" >1579, 1580
              abbreviations  1573
      +href="glossaries-extra-manual.html#dx1-4159" >1581, 1582
              ac  1574, 1575, 1576, 1577, 1578
      +href="glossaries-extra-manual.html#dx1-4157" >1583, 1584, 1585, 1586, 1587, 1588
      + + +         acro  1579
      +href="glossaries-extra-manual.html#dx1-4156" >1589
              acronyms  1580
      +href="glossaries-extra-manual.html#dx1-4155" >1590
              all  1581
      +href="glossaries-extra-manual.html#dx1-4170" >1591
              false  1582
      +href="glossaries-extra-manual.html#dx1-4176" >1592
              none  1583
      +href="glossaries-extra-manual.html#dx1-4175" >1593
              other  1584, 1585
      +href="glossaries-extra-manual.html#dx1-4161" >1594, 1595
              true  1586
      +href="glossaries-extra-manual.html#dx1-4171" >1596
          sort
      - - -         none  1587, 1588
      +href="glossaries-extra-manual.html#dx1-4089" >1597, 1598
          stylemods  1589, 1590, 1591, 1592, 1593
      +href="glossaries-extra-manual.html#dx1-4044" >1599, 1600, 1601, 1602, 1603
              all  1594
      +href="glossaries-extra-manual.html#dx1-4047" >1604
              default  1595
      +href="glossaries-extra-manual.html#dx1-4046" >1605
          subentrycounter  1596, 1597
      +href="glossaries-extra-manual.html#dx1-36003" >1606, 1607
          symbols  1598, 1599, 1600
      +href="glossaries-extra-manual.html#dx1-4149" >1608, 1609, 1610
          toc
              false  1601
      +href="glossaries-extra-manual.html#dx1-3002" >1611
              true  1602
      +href="glossaries-extra-manual.html#dx1-3001" >1612
          translate
              babel  1603
      +href="glossaries-extra-manual.html#dx1-3011" >1613
              true  1604
      +href="glossaries-extra-manual.html#dx1-3013" >1614
          undefaction  1605, 1606
      +href="glossaries-extra-manual.html#dx1-4048" >1615, 1616
              error  1607, 1608
      +href="glossaries-extra-manual.html#dx1-4049" >1617, 1618
              warn  1609, 1610, 1611, 1612, 1613
      +href="glossaries-extra-manual.html#dx1-4050" >1619, 1620, 1621, 1622, 1623, 1624
          xindy  1614
      +href="glossaries-extra-manual.html#dx1-7046" >1625
      page (counter)  1615, 1616
      +href="glossaries-extra-manual.html#dx1-28028" >1626, 1627
      polyglossia package  1617
      +href="glossaries-extra-manual.html#dx1-45005" >1628
      \pretoglossarypreamble  1618
      +class="cmti-10">1629
      \printabbreviations  1619
      +class="cmti-10">1630
      \printglossary options
          nogroupskip  1620
      +href="glossaries-extra-manual.html#dx1-17015" >1631
          target  1621, 1622
      +href="glossaries-extra-manual.html#dx1-5018" >1632, 1633
          targetnameprefix  1623
      +href="glossaries-extra-manual.html#dx1-5019" >1634
          title  1624
      +href="glossaries-extra-manual.html#dx1-45006" >1635
      \printnoidxglossary options
          sort  1625
      +href="glossaries-extra-manual.html#dx1-38015" >1636
      \printunsrtglossaries  1626
      +class="cmti-10">1637
      \printunsrtglossary  1627
      +class="cmti-10">1638
      \printunsrtglossary*  1628
      +class="cmti-10">1639
      \printunsrtglossaryentryprocesshook  1629
      +class="cmti-10">1640
      \printunsrtglossaryhandler  1630
      +class="cmti-10">1641
      \printunsrtglossarypredoglossary  1631
      +class="cmti-10">1642
      \printunsrtglossaryskipentry  1632
      +class="cmti-10">1643
      \printunsrtglossaryunit  1633
      +class="cmti-10">1644
      \printunsrtglossaryunitsetup  1634
      +class="cmti-10">1645
      \provideignoredglossary  1635
      +href="glossaries-extra-manual.html#dx1-5015" >1646

      R + + + relsizes package  1636
      +href="glossaries-extra-manual.html#dx1-22048" >1647
      \RestoreAcronyms  1637
      +class="cmti-10">1648
      \rGLS  1638
      +class="cmti-10">1649
      \rGls  1639
      +class="cmti-10">1650
      \rgls  1640
      +class="cmti-10">1651
      \rGLSformat  1641
      - - - +class="cmti-10">1652
      \rGlsformat  1642
      +class="cmti-10">1653
      \rglsformat  1643
      +class="cmti-10">1654
      \rGLSpl  1644
      +class="cmti-10">1655
      \rGlspl  1645
      +class="cmti-10">1656
      \rglspl  1646
      +class="cmti-10">1657
      \rGLSplformat  1647
      +class="cmti-10">1658
      \rGlsplformat  1648
      +class="cmti-10">1659
      \rglsplformat  1649
      +class="cmti-10">1660

      S \setabbreviationstyle  1650
      +class="cmti-10">1661
      slantsc package  1651
      +href="glossaries-extra-manual.html#dx1-26020" >1662
      style package  1652
      +href="glossaries-extra-manual.html#dx1-13005" >1663
      subentrycounter package  1653
      +href="glossaries-extra-manual.html#dx1-39016" >1664

      T textcase package  1654
      +href="glossaries-extra-manual.html#dx1-8" >1665
      tracklang package  1655, 1656, 1657
      +href="glossaries-extra-manual.html#dx1-4" >1666, 1667, 1668
      translator package  1658
      +href="glossaries-extra-manual.html#dx1-3012" >1669

      X xfor package  1659
      +href="glossaries-extra-manual.html#dx1-9" >1670
      \xglssetwidest  1660
      +class="cmti-10">1671
      +\xglsupdatewidest  1672
      \xGlsXtrSetField  1661
      +href="glossaries-extra-manual.html#dx1-37023" >1673
      xindy  1662, 1663, 1664, 1665, 1666, 1667, 1668, 1669, 1670, 1671, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683, 1672
      +class="cmbx-10">1684
      xindy  1673
      +href="glossaries-extra-manual.html#dx1-6032" >1685
      xkeyval package  1674
      +href="glossaries-extra-manual.html#dx1-7" >1686

      + + +

      1.1glossaries 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-5040"> field and the short form was stored in the symbol field.

      -

      3.1For compatibility with earlier versions, \glsabbrvscfont \glsxtrscfont is now deprecated. Likewise for similar commands.

      -

      9.1Version 1.11 only allowed one use of \GlsXtrLoadResources per document.

      -

      9.2v1.08 assumed filename#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.22: + \title{glossaries-extra.sty v1.23: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2017-11-08} + \date{2017-11-12} \maketitle \begin{abstract} @@ -925,7 +925,8 @@ set the shortcuts provided by the \styfmt{glossaries} package for acronyms (such as \cs{ac}). Note that the short and long forms don't use \cs{glsxtrshort} and \cs{glsxtrlong} but use the original \cs{acrshort} and \cs{acrlong}, which don't recognise multiple -abbreviation styles. +abbreviation styles. The better option with \styfmt{glossaries-extra} +is \pkgopt[ac]{shortcuts}. \item \pkgopt[ac]{shortcuts}: set the shortcuts provided by the \styfmt{glossaries} package for @@ -953,7 +954,8 @@ The \qt{other} shortcuts are: \end{itemize} \item \pkgopt[all]{shortcuts} (or \pkgopt[true]{shortcuts}): -implements both \pkgopt[ac]{shortcuts} and \pkgopt[other]{shortcuts} +implements \pkgopt[ac]{shortcuts}, \pkgopt[abbreviations]{shortcuts} +and \pkgopt[other]{shortcuts}. \item \pkgopt[none]{shortcuts} (or \pkgopt[false]{shortcuts}): don't define any of the shortcut commands (default). @@ -988,7 +990,14 @@ post-description punctuation. It doesn't suppress the use of category-dependent post-description hooks. (Note that the punctuation, which is in the original base hook \cs{glspostdescription}, comes after the extended post-description hook -\cs{glsxtrpostdescription} not before.) +\cs{glsxtrpostdescription} not before.) The post-description hook +can counter-act the effect of \cs{glsxtrnopostpunc} using +\begin{definition}[\DescribeMacro\glsxtrrestorepostpunc] +\cs{glsxtrrestorepostpunc} +\end{definition} +These commands have no effect outside of the glossary (except with +standalone entries that use \cs{glsxtractivatenopost} and +\cs{glspostdescription}, see \sectionref{sec:glossentry}). The \styfmt{glossaries} package provides \begin{definition}[\DescribeMacro\glsseeitemformat] @@ -1615,6 +1624,22 @@ if a full stop hasn't be discarded and \end{definition} if a full stop has been discarded. +It may be that you want to check some other setting (rather +than a category attribute) to determine whether or not to discard +a following full stop. In which case you can redefine: +\begin{definition}[\DescribeMacro\glsxtrifcustomdiscardperiod] +\cs{glsxtrifcustomdiscardperiod}\marg{true}\marg{false} +\end{definition} +You can access the field's label using \cs{glslabel}. +This command should do \meta{true} if the post-link hook +should check if a period follows and \meta{false} otherwise. +The default definition is simply: +\begin{verbatim} +\newcommand*{\glsxtrifcustomdiscardperiod}[2]{#2} +\end{verbatim} +which means that no additional checks are performed. +(Only the recognised category attributes will be checked.) + \begin{important} Avoid the use of \cs{gls}-like and \cs{glstext}-like commands within the post-link hook as they will cause interference. @@ -3045,6 +3070,25 @@ a localised effect. For a global setting, use \begin{definition}[\DescribeMacro\xglssetwidest] \cs{xglssetwidest}\oarg{level}\marg{name} \end{definition} +The following only set the value if \meta{name} is wider than the +current value (new to version 1.23). Local update: +\begin{definition}[\DescribeMacro\glsupdatewidest] +\cs{glsupdatewidest}\oarg{level}\marg{name} +\end{definition} +Global update: +\begin{definition}[\DescribeMacro\gglsupdatewidest] +\cs{gglsupdatewidest}\oarg{level}\marg{name} +\end{definition} +Locale update (expands \meta{name}): +\begin{definition}[\DescribeMacro\eglsupdatewidest] +\cs{eglsupdatewidest}\oarg{level}\marg{name} +\end{definition} +Global update (expands \meta{name}): +\begin{definition}[\DescribeMacro\xglsupdatewidest] +\cs{xglsupdatewidest}\oarg{level}\marg{name} +\end{definition} + + The widest entry value can later be retrieved using \begin{definition}[\DescribeMacro\glsgetwidestname] \cs{glsgetwidestname} @@ -7289,12 +7333,14 @@ command to an argument: \end{definition} This effectively does \begin{alltt} -\cs{glslink}\oarg{options}\marg{label}\{\meta{cs}\marg{text}\} +\cs{glslink}[\meta{default-options},\meta{options}]\marg{label}\{\cs{glsxtrfmtdisplay}\marg{text}\{\}\} \end{alltt} where \meta{cs} is the command obtained from the control -sequence name supplied in the provided field. If the field -hasn't been set, \cs{glsxtrfmt} will simply do \meta{text}. -The default \meta{options} are given by +sequence name supplied in the provided field, which must be defined +to take a single required argument. Although it effectively +acts like \cs{glslink} it misses out the post-link hook. + +The default \meta{default-options} are given by \begin{definition}[\DescribeMacro\GlsXtrFmtDefaultOptions] \cs{GlsXtrFmtDefaultOptions} \end{definition} @@ -7303,6 +7349,38 @@ be redefined as appropriate. Note that the replacement text of \cs{GlsXtrFmtDefaultOptions} is prepended to the optional argument of \cs{glslink}. +As from version 1.23, there's also a starred version of +this command that has a final optional argument: +\begin{definition}[\DescribeMacro{\glsxtrfmt*}] +\cs{glsxtrfmt*}\oarg{options}\marg{label}\marg{text}\oarg{insert} +\end{definition} +Both the starred and unstarred versions use: +\begin{definition}[\DescribeMacro\glsxtrfmtdisplay] +\cs{glsxtrfmtdisplay}\marg{cs name}\marg{text}\marg{insert} +\end{definition} +within the link text. +In the case of the unstarred version \meta{insert} will be empty. +It will also be empty if the final option argument is +missing from the starred form. If the entry given by \meta{label} +is undefined \cs{glsxtrfmt} and \cs{glsxtrfmt*} will issue +an error (or warning if \pkgopt[warn]{undefaction}). +There won't be a warning or error if the entry is defined by +the given field is missing. In either case, +(the entry is undefined or the field is missing) \meta{cs name} +will be \texttt{@firstofone} otherwise it will be the +field value. The default definition is: +\begin{verbatim} +\newcommand{\glsxtrfmtdisplay}[3]{\csuse{#1}{#2}#3} +\end{verbatim} +which puts \meta{text} inside the argument of the control sequence +and \meta{insert} outside it (but it will still be inside the +link text). + +\begin{important} +Remember that nested links cause a problem so avoid using +commands like \cs{gls} or \cs{glsxtrfmt} within \meta{text}. +\end{important} + For example: \begin{verbatim} \[ @@ -7457,6 +7535,13 @@ The starred version \end{definition} omits the implicit grouping. +There is also a version that simply uses \cs{ifcsundef}. It +doesn't save the field value, but can be used if you only +need to check if the field is defined without accessing it: +\begin{definition}[\DescribeMacro\GlsXtrIfFieldUndef] +\cs{GlsXtrIfFieldUndef}\marg{field}\marg{label}\marg{true}\marg{false} +\end{definition} + You can test if a field value equals a string using \begin{definition}[\DescribeMacro{\GlsXtrIfFieldEqStr}] \cs{GlsXtrIfFieldEqStr}\marg{label}\marg{field}\marg{text}\marg{true}\marg{false} diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf index 33acc0fdf10..2343a3af263 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-abbr-styles.pdf differ 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 d16b7faf93f..f292970bed7 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 23707a2e7dc..31417492597 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 119f3fe0edd..c59dac9e4d8 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 f7eb97863c6..7b59e7cb4a0 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 02b5ad2f48e..dd8b00973a0 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 b38b45a7734..46af42a4f57 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 1919f077535..3d29feeb3a3 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 faf7e1a0f20..380cd0c7405 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 cd25a454021..bd9432f893e 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 be8b504e871..bd9e45b0f8d 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 1ded01f5729..94daab172d4 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-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref.pdf index c9b4d0999ce..b0d9d8446c4 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-crossref2.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-crossref2.pdf index 076ff8dd478..6623b5f2523 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-docdef.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-docdef.pdf index 8d9bdbb25f6..93a3a946e1c 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 88d378f940e..86d9f6db2c5 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 b3ca0b88419..1d3d9a36d67 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 952cb7914ba..7e31132e0f8 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 2ad3eccf8a0..c4e0dc6151a 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 5eb06d8d5a5..bff18dd6168 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 4879b5d5256..335efed130e 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 b547d215eb7..050ac280d68 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 ed4750bffaa..fe40f9e25eb 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 55ce8226542..78a1c6b2a5f 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 d88d070acc4..f862868753c 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 0b0c98c9280..f31a4d93f74 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 b6cfdcead35..c56ef83e63c 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 112a1c3364e..04c7de34279 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 870618bf67f..7f2db50342a 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 81e09f53fd3..0d33b3825bc 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 62d24b3008a..ae7053c0638 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 bb68df3ce26..0ef81682c25 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 de028dbbf2e..acab3064308 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 c2e6524b9fd..62c4e3d2ba0 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 e9ec6ba6b83..71d8561e5a1 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 abbb7d2ea93..72a58b6b9bf 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.glstex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex index 22a7b8bc1df..5e1e271b732 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.glstex @@ -32,7 +32,7 @@ \bibglsnewentry{amet}% {location={\bibglslocprefix{1}\setentrycounter[]{page}\glsnumberformat{1}\bibglslocsuffix{1}}, -sort={amet}}% +sort={amet|}}% {amet}% {consectetuer} \glsxtrfieldlistadd{amet}{loclist}{\glsnoidxdisplayloc{}{page}{glsnumberformat}{1}} @@ -40,7 +40,7 @@ sort={amet}}% \bibglsnewentry{dolor}% {location={\bibglslocprefix{1}\setentrycounter[]{page}\glsnumberformat{1}\bibglslocsuffix{1}}, -sort={dolor}}% +sort={dolor|}}% {dolor}% {sit} \glsxtrfieldlistadd{dolor}{loclist}{\glsnoidxdisplayloc{}{page}{glsnumberformat}{1}} @@ -48,7 +48,7 @@ sort={dolor}}% \bibglsnewentry{lorem}% {location={\bibglslocprefix{1}\setentrycounter[]{page}\glsnumberformat{1}\bibglslocsuffix{1}}, -sort={lorem}}% +sort={lorem|}}% {lorem}% {ipsum} \glsxtrfieldlistadd{lorem}{loclist}{\glsnoidxdisplayloc{}{page}{glsnumberformat}{1}} 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 be946905702..ba96f4815d1 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 610a4dac0e7..5c8c3a09087 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 2cd7a679f4b..f8b11759504 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 cd994f6bcea..69bc5966136 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 c5efdcb0d04..7939be3ce79 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 ed8fb947fbc..4f078818202 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 c182dd11d87..8e087db1ed5 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 eefb0d323a3..48abcd0fc77 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 77f5002b4fc..57bc7dc4498 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 75ad17eee92..f56bfc57882 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