From 5add5510b8b8121f5575f0c8cc8397a36abb3eab Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 5 Jan 2018 21:49:40 +0000 Subject: glossaries-extra (5jan18) git-svn-id: svn://tug.org/texlive/trunk@46225 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 8 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 1069684 -> 1077653 bytes .../glossaries-extra/glossaries-extra-manual.html | 8870 +++++++++++--------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 844831 -> 856813 bytes .../glossaries-extra/glossaries-extra-manual.tex | 305 +- .../latex/glossaries-extra/sample-abbr-styles.pdf | Bin 512950 -> 512950 bytes .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44749 -> 44749 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 80745 -> 80745 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50358 -> 50358 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36734 -> 36734 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43863 -> 43863 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35296 -> 35296 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91049 -> 91049 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69519 -> 69519 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54855 -> 54855 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 141941 -> 142288 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 161378 -> 161738 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 .../latex/glossaries-extra/sample-linkcount.pdf | Bin 0 -> 38222 bytes .../latex/glossaries-extra/sample-linkcount.tex | 44 + .../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 159823 -> 160174 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 19863 -> 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 .../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 .../latex/glossaries-extra/glossaries-extra.dtx | 207 +- .../latex/glossaries-extra/glossaries-extra.ins | 4 +- .../glossaries-extra/example-glossaries-xr.tex | 2 +- .../glossaries-extra-stylemods.sty | 4 +- .../latex/glossaries-extra/glossaries-extra.sty | 54 +- .../latex/glossaries-extra/glossary-bookindex.sty | 4 +- 60 files changed, 5275 insertions(+), 4231 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.pdf create mode 100644 Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.tex (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 4a7a6dd3b77..e9cab792509 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,11 @@ +1.26 (2018-01-05): + + * glossaries-extra.sty: + + - added \GlsXtrEnableLinkCounting and associated commands. + + - added \glslinkpresetkeys + 1.25 (2017-11-24) * glossaries-extra.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index a4348edcb70..da9487871e2 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.25 +LaTeX Package : glossaries-extra v1.26 -Last Modified : 2017-11-24 +Last Modified : 2018-01-05 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 c9ec4c00187..7b901e61e36 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 be887f8b5f3..19a71c39a80 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.25: an extension to the +class="cmr-17">glossaries-extra.sty v1.26: 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-24

+class="cmr-12">2018-01-05

@@ -394,44 +394,48 @@ href="#sec:headtitle" id="QQ2-1-28">Entries in Sectioning Titles, Headers, Capti
5 Categories
6 Entry Counting +href="#sec:countref" id="QQ2-1-30">Counting References +
 6.1 Entry Counting (First Use Flag) +
 6.2 Link Counting
7 Auto-Indexing +href="#sec:autoindex" id="QQ2-1-33">Auto-Indexing
8 On-the-Fly Document Definitions +href="#sec:onthefly" id="QQ2-1-34">On-the-Fly Document Definitions
9 bib2gls: Managing Reference Databases +href="#sec:bib2gls" id="QQ2-1-35">bib2gls: Managing Reference Databases
 9.1 Selection +href="#selection" id="QQ2-1-36">Selection
 9.2 Sorting and Displaying the Glossary +href="#sortinganddisplayingtheglossary" id="QQ2-1-37">Sorting and Displaying the Glossary
 9.3 Supplementary Commands -
 9.4 Record Counting -
10 Miscellaneous New Commands +href="#supplementarycommands" id="QQ2-1-38">Supplementary Commands +
 9.4 Record Counting +
10 Miscellaneous New Commands
 10.1 Entry Fields +href="#sec:fields" id="QQ2-1-41">Entry Fields
 10.2 Display All Entries Without Sorting or Indexing +href="#sec:printunsrt" id="QQ2-1-42">Display All Entries Without Sorting or Indexing
 10.3 Standalone Entry Items +href="#sec:glossentry" id="QQ2-1-43">Standalone Entry Items
 10.4 Entry Aliases +href="#sec:alias" id="QQ2-1-44">Entry Aliases
11 Supplemental Packages +href="#sec:supplemental" id="QQ2-1-45">Supplemental Packages
 11.1 Prefixes or Determiners +href="#sec:prefix" id="QQ2-1-46">Prefixes or Determiners
 11.2 Accessibility Support +href="#sec:accsupp" id="QQ2-1-47">Accessibility Support
12 Sample Files +href="#sec:samples" id="QQ2-1-48">Sample Files
13 Multi-Lingual Support +href="#sec:lang" id="QQ2-1-49">Multi-Lingual Support
Glossary
@@ -2550,42 +2554,59 @@ class="cmti-10">label⟩ is the entry’s label. This does nothi (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

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


\glslinkpresetkeys  \glslinkpresetkeys

+

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

As from version 1.14, there are two new keys for \glsadd: thevalue and and theHvalue. + id="dx1-6024">. These keys are designed for manually adding explicit locations rather than obtaining the value from the associated counter. As from version 1.19, these two keys are also available for commands like \gls and \glslink. The thevalue keys is intended + id="dx1-6025"> 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 is for the location value. The other key theHvalue can + id="dx1-6027"> can be used to extract a prefix value for the first argument of commands like \glsnoidxdisplayloc. It’s value must be in the format ⟨. It’s value must be in the format ⟨prefix⟩⟨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 + id="dx1-6029">, 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 [⟨ will only accept locations in the form [⟨num⟩⟨sep⟩]*⟨num⟩ @@ -2598,7 +2619,7 @@ instances of a number followed by the recognised separator character (set with \glsSetCompositor). This means that makeindex won’t accept, for + id="dx1-6031"> won’t accept, for example, @@ -2607,23 +2628,23 @@ example,

\glsadd[thevalue={Supplementary Material}]{sample}
-

This location value will be accepted by

This location value will be accepted by bib2gls, since it will allow any location and + id="dx1-6033">, since it will allow any location and will only try forming ranges if the location matches any of its numerical patterns. In the case of xindy, you’ll need to add a rule that can match the value. + id="dx1-6034">, you’ll need to add a rule that can match the value. If you’re using hyperref, you may need to use the , you may need to use the format key to prevent a + id="dx1-6036"> 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: @@ -2640,10 +2661,10 @@ 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 to S.2. For example: @@ -2661,17 +2682,17 @@ example:  
\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 ⟨ 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 externallocation to the location of the PDF file. For example: + id="dx1-6039"> to the location of the PDF file. For example: @@ -2681,7 +2702,7 @@ class="cmss-10">externallocation\newglossaryentry{sample}{category=supplemental,  
 name={sample},description={an example}} -

Next you need to add

Next you need to add glsxtrsupphypernumber as the format: @@ -2690,30 +2711,30 @@ 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 + id="dx1-6040"> package. Remember that the counter used for the location also needs to match. If \theHcounter⟩ is defined in the other document and doesn’t match in the referencing document, then you need to use theHvalue to set the appropriate value. See the accompanying sample files + id="dx1-6041"> to set the appropriate value. See the accompanying sample files sample-suppl-hyp.tex and 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, @@ -2753,20 +2774,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: @@ -2871,11 +2892,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: @@ -2932,20 +2953,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 @@ -2971,20 +2992,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 @@ -3031,7 +3052,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 @@ -3142,7 +3163,7 @@ overridden by the textformat attribute. -

For example: +

For example: @@ -3150,7 +3171,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: @@ -3161,7 +3182,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: @@ -3173,7 +3194,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: @@ -3181,9 +3202,9 @@ class="cmtt-10">font:

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

without redefining

without redefining \glsxtrregularfont. -

The

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



\glsxtrpostlinkhook  \glsxtrpostlinkhook

-

+

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



\glsxtrpostlink  \glsxtrpostlink

-

+

if a full stop hasn’t be discarded and -



\glsxtrpostlinkendsentence  \glsxtrpostlinkendsentence

-

+

if a full stop has been discarded. -

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

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



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

-

+

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

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

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

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

Avoid the use of

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

-

By default

+

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

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

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

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

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



\glsxtrpostlinkAddDescOnFirstUse  \glsxtrpostlinkAddDescOnFirstUse

-

+

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

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

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

-

-


+


\glsxtrpostlinkAddSymbolOnFirstUse  \glsxtrpostlinkAddSymbolOnFirstUse

-

+

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

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

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



\glsxtrifwasfirstuse  true}{false}

-

+

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

Note that commands like

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

-

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

+

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

-

-

The

+

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

You can set the default options used by

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



\GlsXtrSetDefaultGlsOpts  \GlsXtrSetDefaultGlsOpts{options}

-

+

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

\GlsXtrSetDefaultGlsOpts{noindex}
-

and then use, for example,

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

Note that if you don’t want

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

\GlsXtrSetDefaultGlsOpts doesn’t affect \glsadd.
-

-

If you want to change the default value of

+

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



\GlsXtrSetDefaultNumberFormat{format}

-

+

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

-

-

Commands like

+

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



\GlsXtrSetAltModifier  }{options}

-

+

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

When choosing the character ⟨

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

-

Example: +

+

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

\GlsXtrSetAltModifier{!}{noindex}
-

This means that

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

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

you can use

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

Location lists displayed with \printnoidxglossary internally use -



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

-

+

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

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


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


\glsxtrdisplaysingleloc  }{location}

-

+

otherwise it uses -



\glsxtrdisplaystartloc  }{location}

-

+

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



\glsxtrdisplayendloc  }{location}

-

+

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

By default the start range command saves the format in -


By default the start range command saves the format in +


\glsxtrlocrangefmt  \glsxtrlocrangefmt

-

+

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

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

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



\glsxtrdisplayendlochook  }{location}

-

+

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

This means that the list +

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

-

doesn’t display any differently from +

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

-

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

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

+

-

Top

2.4 Entry Counting Modifications

-

If you are using

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

The

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

For example, instead of just doing: +

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

\glsenableentrycount
-

you now need to do: +

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

-

This will enable the entry counting for entries in the

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

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

Further information about entry counting, including the new per-unit feature, is described in §6 Entry Counting. -

+class="cmsy-10">§6.1 Entry Counting (First Use Flag). +

-

Top

2.5 Plurals

-

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

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

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

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

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

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

There are other plural fields, such as

There are other plural fields, such as firstplural, longpluralshortplural

If these fields are omitted, the

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

    @@ -3821,7 +3842,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: @@ -3907,8 +3928,8 @@ class="cmss-10">glossaries package:  
\newacronym{html}{HTML}{Hypertext Markup Language}  
\newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}}

-

-

The main problems are: +

+

The main problems are:

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

    which just doesn’t work. Grouping the

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

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

    This will upper case the label

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

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

    This produces: +

    This produces:

    -

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

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

    -

    So the

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

    Now let’s suppose the

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

-

This produces: +

This produces:

-

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

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

-

So the

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

Now let’s suppose the

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

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

This produces: +

This produces:

-

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

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

-

So the

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

This is all aggravated by setting the style using the

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

\setacronymstyle{long-short}
-

as this references the label through the use of

as this references the label through the use of \glslabel when displaying the long and short forms, but this value changes with each use of \gls, so @@ -4053,7 +4074,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: @@ -4064,10 +4085,10 @@ class="cmtt-10">shtml

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

The next use of

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

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

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

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

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

-

with

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

-

with

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

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

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

-

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

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

However if you’re really determined to use

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

-

is treated as +

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

-

This overcomes problems 

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

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

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

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

then (using the

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

-

whereas if the entry is defined as: +

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

-

then the

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

-

Note that the first optional argument of

Note that the first optional argument of \acrshort or \glsxtrshort is ignored in this context. (The final optional argument will be inserted, if present.) The @@ -4288,8 +4309,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 @@ -4352,14 +4373,14 @@ class="cmss-10">noindex to true. If you want to change this, you can use -



\glsxtrsetpopts  \glsxtrsetpopts{options}

-

+

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

\glsxtrsetpopts{hyper=false}
-

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

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

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

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



\glossxtrsetpopts  \glossxtrsetpopts

-

+

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

\glsxtrsetpopts{noindex}
-

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

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

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

-

For example, +

+

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

\glsxtrp{short}{ssi}
-

is equivalent to +

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

-

in the main body of the document or +

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

-

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

If

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

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

{\glsxtrheadshort{ssi}}
-

(which recognises the

(which recognises the headuc attribute.) -

If

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

There are similar commands -


There are similar commands +


\Glsxtrp  field}{label}

-

+

for first letter upper case and -



\Glsxtrp  field}{label}

-

+

for all upper case. -

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

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

-

You can, with care, protect against issue 

+

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

If you

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

-

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

Example document: +

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

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

-

-

+

+

-

Top

2.7 Acronym Style Modifications

-

The

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

-

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

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

-

can be easily adapted to use

can be easily adapted to use glossaries-extra: @@ -4597,7 +4618,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


@@ -4636,34 +4657,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

@@ -4856,7 +4877,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 @@ -4865,15 +4886,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 @@ -4883,7 +4904,7 @@ class="cmss-10">typeglossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands. -

If you use

-

-

In general, there’s rarely any need for

+

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



\glsacspace  \glsacspace{label}

-

+

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



\glsacspacemax  \glsacspacemax

-

+

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

Any of the new abbreviation styles that use

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

-

-

The

+

The first use acronym font command -



\firstacronymfont{text}

-

+

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

The subsequent use acronym font command -


The subsequent use acronym font command +


\acronymfont{text}

-

+

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

-

Top

2.8 glossary-bookindex package

-

As from v1.21,

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

-

or use both the

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

-

The

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

The number of columns is given by -


The number of columns is given by +


\glsxtrbookindexcols  \glsxtrbookindexcols

-

+

which defaults to 2. -

This style uses the

This style uses the multicols environment. If the command -



\glsxtrbookindexcolspread  \glsxtrbookindexcolspread

-

+

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



\glsxtrbookindexmulticolsenv  \glsxtrbookindexmulticolsenv

-

+

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

\renewcommand{\glsxtrbookindexmulticolsenv}{multicols*}
-

-

Each top-level entry is displayed using -


+

Each top-level entry is displayed using +


\glsxtrbookindexname  \glsxtrbookindexname{label}

-

+

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

-

Alternatively you can use the

Alternatively you can use the \glsxtrpostnamecategory⟩ hook. -

Sub-entries are displayed using -


Sub-entries are displayed using +


\glsxtrbookindexsubname  \glsxtrbookindexsubname{label}

-

+

which just defaults to \glsxtrbookindexname{label}. -

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

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



\glsxtrbookindexprelocation  \glsxtrbookindexprelocation{label}

-

+

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

,\glsxtrprelocation
-

otherwise it just does

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

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


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


\glsxtrbookindexsubprelocation  \glsxtrbookindexsubprelocation{label}

-

+

which defaults to \glsxtrbookindexprelocation{label}. -

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

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



\glsxtrbookindexparentchildsep  \glsxtrbookindexparentchildsep

-

+

This defaults to \nopagebreak. -

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

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



\glsxtrbookindexparentsubchildsep  \glsxtrbookindexparentsubchildsep

-

+

This defaults to \glsxtrbookindexparentchildsep. -

The separator between top-level entries is given by -


The separator between top-level entries is given by +


\glsxtrbookindexbetween  }{label2}

-

+

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

The separator between two level 1 entries is given by -


The separator between two level 1 entries is given by +


\glsxtrbookindexsubbetween  }{label2}

-

-

The separator between two level 2 entries is given by -


+

The separator between two level 2 entries is given by +


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

-

+

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



\glsxtrbookindexsubsubatendgroup  }

-

-


+


\glsxtrbookindexsubatendgroup  \glsxtrbookindexsubatendgroup{sub-label}

-

-


+


\glsxtrbookindexatendgroup  \glsxtrbookindexatendgroup{label}

-

+

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

For example, the resource option

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

-

This uses

This uses \glstreesubitem and \glstreesubsubitem to indent the cross-reference according to the next level down, so the cross-reference for a top-level entry is aligned @@ -5299,7 +5320,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 @@ -5354,14 +5375,14 @@ which is defined as  
  \par{\centering\glstreegroupheaderfmt{#1}\par}%  
}

-

where

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

The

The glossary-bookindex package provides some supplementary commands that aren’t used by default, but may be used when adjusting the style. These commands @@ -5369,35 +5390,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: @@ -5431,7 +5452,7 @@ current entry:  
  \glossentryname{#1}%  
}

-

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

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

-

-

Then if you’re using

+

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

-

-

+

+

-

Top

2.9 Glossary Style Modifications

-

The

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

The

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



\glsxtrsetgrouptitle  label}{title}

-

+

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

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

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

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



\glsxtrlocalsetgrouptitle  }{title}

-

-

+

+

-

Top

2.9.1 Style Hooks

-

The commands

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

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

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



\glossentrynameother  label}{field}

-

+

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

There is a hook after

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



\glsxtrpostnamehook  \glsxtrpostnamehook{label}

-

+

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



\glsxtrdoautoindexname{}{indexname}

-

+

See §7 Auto-Indexing for further details. -

As from version 1.04, the post-name hook

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

-

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


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


\glsextrapostnamehook  \glsextrapostnamehook{label}

-

+

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

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

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



\glsxtrpostdescription  \glsxtrpostdescription

-

+

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

This new command will do

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

Since both

Since both \glossentry and \subglossentry set -



\glscurrententrylabel  \glscurrententrylabel

-

+

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

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

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

-

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

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

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

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

-

+

+

-

Top

2.9.2 Number List

-

The

The number list is now placed inside the argument of -



\GlsXtrFormatLocationList  \GlsXtrFormatLocationList{number list}

-

+

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

If you want to suppress the

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

-

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

+

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

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

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



\GlsXtrEnablePreLocationTag  }{pages}

-

+

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

\GlsXtrEnablePreLocationTag{Page: }{Pages: }
-

An extra run is required when using this command. -

Use

An extra run is required when using this command. +

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

-

See the accompanying sample file

+

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

Note that

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

+

-

Top

2.9.3 The glossaries-extra-stylemods Package

-

As from v1.02,

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

-

Alternatively you can load

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

-

Another option is to use the

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

-

Or the value of

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

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

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

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

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

-

Note that the

+

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

The

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

As from version 1.21, the hard-coded

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



\glsxtrprelocation  \glsxtrprelocation

-

+

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

\renewcommand{\glsxtrprelocation}{\dotfill}
-

-

The

+

The list styles use -


\glsxtrprelocation


\glslistprelocation  \glslistprelocation

-

+

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



\glslistchildprelocation  \glslistchildprelocation

-

+

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

For just the

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



\glslistchildpostlocation  \glslistchildpostlocation

-

+

which defaults to a full stop. -

The default value of

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

The

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



\glstreeprelocation  \glstreeprelocation

-

+

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



\glstreechildprelocation  \glstreechildprelocation

-

+

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

As from version 1.05, the

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



\gglssetwidest  level]{name}

-

+

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



\eglssetwidest  level]{name}

-

+

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



\xglssetwidest  }

-

+

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



\glsupdatewidest  level]{name}

-

+

Global update: -



\gglsupdatewidest  level]{name}

-

+

Locale update (expands ⟨name⟩): -



\eglsupdatewidest  level]{name}

-

+

Global update (expands ⟨name⟩): -



\xglsupdatewidest  level]{name}

-

-

The widest entry value can later be retrieved using -


+

The widest entry value can later be retrieved using +


\glsgetwidestname  \glsgetwidestname

-

+

for the top-level entries and -



\glsgetwidestsubname  \glsgetwidestsubname{level}

-

+

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

Note that if you are using

Note that if you are using bib2glsTEX. -

The command

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



\glsFindWidestTopLevelName  \glsFindWidestTopLevelName[glossary list]

-

+

Similar commands are also provided: -



\glsFindWidestUsedTopLevelName  glossary list]

-

+

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



\glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list]

-

+

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



\glsFindWidestAnyName  \glsFindWidestAnyName[glossary list]

-

+

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



\glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo[glossary list]

-

+

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



\glsFindWidestLevelTwo  \glsFindWidestLevelTwo[glossary list]

-

+

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



\glsFindWidestUsedAnyNameSymbol  glossary list]{register}

-

+

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



\glsFindWidestAnyNameSymbol  list]{register}

-

+

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



\glsFindWidestUsedAnyNameSymbolLocation  symbol register}{location register}

-

+

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



\glsFindWidestAnyNameSymbolLocation  symbol register}{location register}

-

+

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



\glsFindWidestUsedAnyNameLocation  glossary list]{register}

-

+

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



\glsFindWidestAnyNameLocation  list]{register}

-

+

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

The layout of the symbol, description and

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



\glsxtralttreeSymbolDescLocation  label}{number list}

-

+

for top-level entries and -



\glsxtralttreeSubSymbolDescLocation  label}{number list}

-

+

for sub-entries. -

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

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



\glsxtralttreeInit  \glsxtralttreeInit

-

-

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

+

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



\glsxtrAltTreeIndent  \glsxtrAltTreeIndent

-

-

For additional commands that are available with the

+

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

-

-

+

Top

3. Abbreviations

-

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

Abbreviations include acronyms (words formed from initial letters, such as “laser”), initialisms (initial letters of a phrase, such as “html”, that aren’t pronounced as words) and contractions (where parts of words are omitted, often replaced by an apostrophe, such as “don’t”). The “acronym” code provided by the @@ -6437,10 +6458,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 @@ -6478,7 +6499,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 @@ -6506,7 +6527,7 @@ class="cmtt-10">acronym (see also href="#sec:acronymmods">§2.7 Acronym Style Modifications) so -



\newacronym  short}{long}

-

+

is now equivalent @@ -6545,7 +6566,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 @@ -6668,21 +6689,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 @@ -6691,7 +6712,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: @@ -6735,18 +6756,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 @@ -6778,11 +6799,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

@@ -6803,7 +6824,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, @@ -6813,7 +6834,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 @@ -7102,13 +7123,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. -


@@ -7448,10 +7469,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 @@ -7487,7 +7508,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 @@ -7526,52 +7547,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 @@ -7657,7 +7678,7 @@ This is defined as

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

The

The \glstextup command is provided by glossaries and is used to switch off the @@ -7677,51 +7698,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: @@ -7954,17 +7975,17 @@ This applies to all the predefined styles. For example:  
\renewcommand*{\glsfirstlongdefaultfont}[1]{\emph{#1}}  
\glsxtrinsertinsidetrue

-

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

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

Note that for some styles, such as the

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

Remember that

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

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

-

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

+

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

-

-

Some of the styles use -


+

Some of the styles use +


\glsxtrfullsep  \glsxtrfullsep{label}

-

+

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

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

or +

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

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

-

The new naming scheme for abbreviation styles is as follows:

+

+

The new naming scheme for abbreviation styles is as follows:

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

    • \glsfirstabbrvhyphenfont on first
    • style-noreg -

      Some styles set the

      Some styles set the regular attribute. In some cases, there’s a version of the @@ -8128,7 +8149,7 @@ href="#abbrstyle.long-em-noshort-em-noreg">long-em-noshort-em-noreg style is a minor variation that style that doesn’t set the attribute. -

      There are a few “noshort” styles, such as

      There are a few “noshort” styles, such as long-hyphen-noshort-noreg, that have @@ -8146,7 +8167,7 @@ class="cmti-10">modifier1⟩]-[post]footnote -

      The display style uses ⟨

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

      If

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

      Examples:

      +

      Examples:

      • short-sc-postfootnote: short form in smallcaps with the long form in the footnote outside of the link-text.
      -

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

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

      +

    • style-desc -

      Like ⟨

      Like ⟨style⟩ but the description key must be provided when defining abbreviations with this style. -

      Examples:

      +

      Examples:

      -

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

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



      \GlsXtrWarnDeprecatedAbbrStyle  old-name}{new-name}

      -

      +

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

      +

      -

      Top

      3.4.1 Predefined Abbreviation Styles that Set the Regular Attribute

      -

      The following abbreviation styles set the

      The following abbreviation styles set the regular attribute to “true” for all categories @@ -8252,12 +8273,12 @@ href="#glo:firstuse">first use. The name is set to the short form through the command -



      \glsxtrshortnolongname  \glsxtrshortnolongname

      -

      +

      (Similarly for the other shortmodifier\newacronym) for it to take effect. Make sure to \protect any formatting commands (or anything else that shouldn’t be expanded). -

      The

      The description is set to the long form. The inline full form displays ⟨short⟩ @@ -8425,12 +8446,12 @@ class="cmss-10">short-nolongname is set to the full form obtained by expanding -



      \glsxtrshortdescname  \glsxtrshortdescname

      -

      +

      (Similarly for the other shortmodifier\protect fragile and formatting commands and only redefin before \newabbreviation (or \newacronym). -

      The

      The description must be supplied by the user. You may prefer to use the \glsxtrshortlong⟩ (⟨short⟩). -

      The

      The sort key are set to the long form. The name key is also set to the long form, but this is done by expanding -



      \glsxtrlongnoshortdescname  \glsxtrlongnoshortdescname

      -

      +

      (Similarly for the other longmodifier-desc styles, unless indicated otherwise.) This command should only be redefined before abbreviations are defined, and any fragile or formatting commands within it need protecting. -

      The

      The description must be provided by the user. The predefined glossary styles won’t display the short form. You can use the post-description hook to @@ -8678,12 +8699,12 @@ class="cmss-10">sortname key is also set to the short form, but this is done by expanding -



      \glsxtrlongnoshortname  \glsxtrlongnoshortname

      -

      +

      (Similarly for other longmodifier-noshortmodifier⟩ styles, unless indicated otherwise.) This command should only be redefined before abbreviations are defined, and fragile or formatting commands should be protected. -

      The

      The description is set to the long form.

      @@ -8790,12 +8811,12 @@ href="#catattr.regular">regular attribute. -

      +

      -

      Top

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

      -

      The following abbreviation styles will set the

      The following abbreviation styles will set the regular attribute to “false” if it has @@ -8817,12 +8838,12 @@ class="cmss-10">sortname is also set to the short form through -



      \glsxtrlongshortname  \glsxtrlongshortname

      -

      +

      (Similarly for other longmodifiermodifier⟩ styles, unless indicated class="cmtt-10">\the\glslongtok and the short form can be referenced with \the\glsshorttok. -

      The

      The description is set to the long form. The long and short forms are separated by \glsxtrfull shows the long form followed by the short for The name field is obtained from -



      \glsxtronlyname  \glsxtronlyname

      -

      +

      Any redefinition of this command must come before the abbreviations are defined as it expands on definition. Make sure you protect any commands that shouldn’t be expanded. The long form can be referenced @@ -8934,12 +8955,12 @@ class="cmss-10">long-only-short-onlyname field is obtained from -



      \glsxtronlydescname  \glsxtronlydescname

      -

      +

      Any redefinition of this command must come before the abbreviations are defined as it expands on definition. Make sure you protect any commands that shouldn’t be expanded. The long form can be referenced @@ -8971,12 +8992,12 @@ class="cmss-10">long-short style but additional information can be inserted into the parenthetical material. This checks the value of the field given by -



      \glsxtruserfield  \glsxtruserfield

      -

      +

      (which defaults to useri) using \ifglshasfieldlong⟩ (⟨short⟩, ⟨field-value⟩). The format is governed by -



      \glsxtruserparen  text}{label}

      -

      +

      where ⟨text⟩ is the short form (for the \glsxtrparen

      The

      The name is obtained by expanding \glsxtrlongshortname (see above). The @@ -9041,7 +9062,7 @@ class="cmtt-10">} href="#abbrstyle.short-long-user">short-long-user style. -

      For example: +

      For example: @@ -9053,35 +9074,35 @@ class="cmss-10">short-long-user [user1={German Speaking \TeX\ User Group}]  
       {dante}{DANTE}{Deutschsprachige Anwendervereinigung \TeX\ e.V}

      -

      On first use,

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

      -

      T

      TEX User Group (TUG)

      -

      whereas

      whereas \gls{dante} will appear as:

      -

      Deutschsprachige Anwendervereinigung T

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

      -

      The short form is formatted according to -


      The short form is formatted according to +


      \glsabbrvuserfont  \glsabbrvuserfont{text}

      -

      +

      and the plural suffix is given by -



      \glsxtrusersuffix  \glsxtrusersuffix

      -

      -

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

      +

      These may be redefined as appropriate. For example, if you want a smallcaps style, you can just set these commands to those used by the long-short-sclong-short-sc\renewcommand{\glsxtrusersuffix}{\glsxtrscsuffix}

      -

      +

      long⟩ (⟨short⟩). Before version 1.04, this was incorrectly set to the short form. If you want to revert back to this you can redefine -



      \glsxtrlongshortdescsort  \glsxtrlongshortdescsort

      -

      +

      For example: @@ -9156,7 +9177,7 @@ class="cmtt-10">\glsxtrlongshortdescsort


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

      The

      The description must be supplied by the user. The long and short forms are separated by \glsxtrfullsep. The name field is obtained from -



      \glsxtrlongshortdescname  \glsxtrlongshortdescname

      -

      +

      (Similarly for other longmodifierlong-short-username key is obtained from -



      \glsxtrlongshortuserdescname  \glsxtrlongshortuserdescname

      -

      +

      Again, this should only be redefined before \newabbreviation (or \newacronym), and fragile and formatting commands need protecting. -

      The

      The description key must be supplied in the optional argument of short-long-user style. -

      The

      The name field is obtained from -



      \glsxtrshortlongname  \glsxtrshortlongname

      -

      +

      (Similarly for other shortmodifier\glsxtruserparenname field is obtained by expanding -



      \glsxtrshortlongname  \glsxtrshortlongname

      -

      +

      Again, this should only be redefined before \newabbreviation (or \glsxtrfullsep. The name field is obtained from -



      \glsxtrshortlongdescname  \glsxtrshortlongdescname

      -

      +

      (Similarly for other shortmodifiername



      \glsxtrshortlonguserdescname  \glsxtrshortlonguserdescname

      -

      +

      Again, this should only be redefined before \newabbreviation (or \newacronym), and fragile and formatting commands need protecting. -

      The

      The description key must be supplied in the optional argument of nohyperfirsthyperref package is used). -

      The inline full form uses the ⟨

      The inline full form uses the ⟨short⟩ (⟨long⟩) style. The namedescriptionname key is obtained by expanding -



      \glsxtrfootnotename  \glsxtrfootnotename

      -

      +

      (Similarly for other shortmodifierfootnote styles, unless class="cmtt-10">\newabbreviation (or \newacronym), and fragile or formatting commands should be protected from expansion. -

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


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


      \glsfirstlongfootnotefont  \glsfirstlongfootnotefont{text}

      -

      +

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



      \glslongfootnotefont  \glslongfootnotefont{text}

      -

      +

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

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


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


      \glsxtrabbrvfootnote  label}{long}

      -

      +

      By default, this just does \footnote} (the first argument is ignored). For  
        \footnote{\glshyperlink[#2]{#1}}%  
      }

      -

      or to include the short form with a hyperlink: +

      or to include the short form with a hyperlink: @@ -9694,7 +9715,7 @@ class="cmtt-10">} (the first argument is ignored). For  
        \footnote{\glshyperlink[\glsfmtshort{#1}]{#1}: #2}%  
      }

      -

      Note that I haven’t used commands like

      Note that I haven’t used commands like \glsxtrshort to avoid interference (see first use. This will also defer the footnote \glsxtrifnextpunc. -

      The inline full form uses the ⟨

      The inline full form uses the ⟨short⟩ (⟨long⟩) style. The namemarkwords category attribute. The full form is formatted using -



      \glsxtrlonghyphenshort  }

      -

      +

      where ⟨insert⟩ is the inserted material provided in the final optional argument of commands like name key is obtained from \glsxtrlongshortname. -

      Unlike the other ⟨

      Unlike the other ⟨long⟩ (⟨short⟩) type of styles, such as long-short

      -

      The space before the parenthetical material is actually given by +

      The space before the parenthetical material is actually given by \glsxtrfullsep{labelinsert⟩ may be moved into the formatting commands according to the conditional \ifglsxtrinsertinside. -

      For example, if

      For example, if ip is defined using: @@ -10011,7 +10032,7 @@ class="cmtt-10">ip is defined using:  
      \setabbreviationstyle[english]{long-hyphen-short-hyphen}  
      \newabbreviation[category=english]{ip}{IP}{Internet Protocol}

      -

      then +

      then @@ -10019,10 +10040,10 @@ class="cmtt-10">ip is defined using:

      \gls{ip}[-Adressen]
      -

      will do +

      will do

      -

      Internet-Protocol-Adressen (IP-Adressen)

      -

      on first use, whereas +

      Internet-Protocol-Adressen (IP-Adressen)

      +

      on first use, whereas @@ -10030,11 +10051,11 @@ class="cmtt-10">ip is defined using:

      \gls{ip}[ Address]
      -

      will do +

      will do

      -

      Internet Protocol Address (IP Address)

      -

      on first use. -

      Note that the hyphenation isn’t applied when using commands like +

      Internet Protocol Address (IP Address)

      +

      on first use. +

      Note that the hyphenation isn’t applied when using commands like \glsxtrlong. This means that @@ -10044,12 +10065,12 @@ class="cmtt-10">\glsxtrlong. This means that
      \glsxtrlong{ip}[-Adressen]
      -

      will do +

      will do

      -

      Internet Protocol-Adressen

      +

      Internet Protocol-Adressen

      -

      -

      If the

      +

      If the markwords attribute hadn’t been set, then the first use of @@ -10060,11 +10081,11 @@ class="cmss-10">markwords \gls{ip}[-Adressen]

      -

      would do +

      would do

      -

      Internet Protocol-Adressen (IP-Adressen)

      -

      instead. -

      If the inserted material ⟨

      Internet Protocol-Adressen (IP-Adressen)

      +

      instead. +

      -

      -

      If you want the short version in small-caps, you can just redefine +

      +

      If you want the short version in small-caps, you can just redefine \glsabbrvhyphenfont and \glsxtrhyphensuffix to use the small-caps @@ -10086,7 +10107,7 @@ class="cmtt-10">\glsxtrhyphensuffix to use the small-caps \renewcommand{\glsabbrvhyphenfont}{\glsabbrvscfont}  
      \renewcommand{\glsxtrhyphensuffix}{\glsxtrscsuffix}

      -

      Similarly for other font-changing variations. +

      Similarly for other font-changing variations.

      long-hyphen-noshort-desc-noreglong-hyphen-short-hyphen-desc
      -

      New to version 1.17. This is similar to

      New to version 1.17. This is similar to long-hyphen-short-hyphen but the user @@ -10137,7 +10158,7 @@ class="cmtt-10">\glsxtrlongshortdescname. class="cmssbx-10">long-hyphen-postshort-hyphen

      -

      New to version 1.17. This is similar to

      New to version 1.17. This is similar to long-hyphen-short-hyphen but the @@ -10163,7 +10184,7 @@ class="cmtt-10">}⟨insert
      where -



      \glsxtrposthyphenshort  label}insert

      -

      +

      is in the post-link hook. This uses the format:
      insert⟩ (isnert⟩) -

      The singular short form is always used here, even with

      The singular short form is always used here, even with \glspl. (Unlike long-hyphen-long-hyphen.)
      -

      -

      The part in the link-text on first use: -


      +

      The part in the link-text on first use: +


      \glsxtrlonghyphen  }{insert}

      -

      +

      checks if ⟨insert⟩ starts with a hyphen. If it does, then \glsxtrwordsep is locally @@ -10217,15 +10238,15 @@ class="cmti-10">insert⟩ for this style without causing nested hyperlinks, but only for commands like \gls. -

      Don’t use

      Don’t use \gls in the ⟨insert⟩ part for commands like \glsxtrfull, \glsxtrshort or \glsxtrlong.
      -

      -

      The inline full display format used by commands like

      +

      The inline full display format used by commands like \glsxtrfull behaves differently to the first use of \gls with this style. It’s better @@ -10242,7 +10263,7 @@ class="cmtt-10">} if you want to ensure the full class="cmssbx-10">long-hyphen-postshort-hyphen-desc

      -

      New to version 1.17. This is similar to

      New to version 1.17. This is similar to long-hyphen-postshort-hyphen @@ -10262,7 +10283,7 @@ class="cmss-10">long-hyphen-short-hyphen, except that the short form is displayed first followed by the long form in parentheses. The full form is formatted using -



      \glsxtrshorthyphenlong  } class="cmtt-10">{⟨insert}

      -

      +

      which behaves in an analogous way to \glsxtrlonghyphenshort. The name\glsxtrshortlongname. class="cmssbx-10">short-hyphen-long-hyphen-desc

      -

      New to version 1.17. This is similar to

      New to version 1.17. This is similar to short-hyphen-long-hyphen but the user @@ -10333,7 +10354,7 @@ class="cmtt-10">}⟨insert
      where -



      \glsxtrposthyphenlong  label}insert

      -

      +

      is in the post-link hook. These commands behave in an analogous manner to those used with name is obtained from \glsxtrshortlongname. -

      Don’t use

      Don’t use \gls in the ⟨insert⟩ part for commands like \glsxtrfull, \glsxtrshort or \glsxtrlong.
      -

      -

      The inline full display format used by commands like

      +

      The inline full display format used by commands like \glsxtrfull behaves differently to the first use of \gls with this style. It’s better @@ -10377,7 +10398,7 @@ class="cmtt-10">} if you want to ensure the full class="cmssbx-10">short-hyphen-postlong-hyphen-desc

      -

      New to version 1.17. This is similar to

      New to version 1.17. This is similar to short-hyphen-postlong-hyphen @@ -10388,13 +10409,13 @@ class="cmss-10">name\glsxtrshortlongdescname.

      -

      +

      -

      Top

      3.5 Defining New Abbreviation Styles

      -

      New abbreviation styles may be defined using: -


      New abbreviation styles may be defined using: +


      \newabbreviationstyle  }{fmts}

      -

      +

      -

      where ⟨

      where ⟨name⟩ is the name of the new style (as used in the mandatory argument of \setabbreviationstyleglossaries package’s \newacronymstyle command. -

      You can’t use styles defined by

      You can’t use styles defined by \newacronymstyle with glossaries-extra unless you have reverted glossaries package can’t be used with abbreviations defined with \newabbreviation.
      -

      -

      The ⟨

      +

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



      \CustomAbbreviationFields  \CustomAbbreviationFields

      -

      +

      to set the entry fields including the name (defaults to the short form if omitted), @@ -10461,12 +10482,12 @@ class="cmss-10">pluraldescription. -

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

      -

      For example, the

      +

      For example, the long-short style has the following in ⟨setup⟩:  
          plural={\protect\glsabbrvfont{\the\glsshortpltok}},%  
          description={\the\glslongtok}}%

      -

      Note that the

      Note that the first and firstplural are set even though they’re not used by \gls. -

      The basic styles, such as

      The basic styles, such as long-short, use commands like fmts⟩ argument even if they’re not used within \CustomAbbreviationFields. -

      The ⟨

      The ⟨setup⟩ argument may also redefine -



      \GlsXtrPostNewAbbreviation  \GlsXtrPostNewAbbreviation

      -

      +

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

      For example, the

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

      -

      This sets the

      This sets the nohyperfirst attribute to “true”. It also unsets the nohyperfirst attribute doesn’t get unset by other styles, so take care not to switch styles for the same category. -

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

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

      Short value (defined by

      Short value (defined by glossaries): -



      \glsshorttok  \glsshorttok

      -

      -

      Short plural value (defined by

      +

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



      \glsshortpltok  \glsshortpltok

      -

      +

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

      Long value (defined by

      Long value (defined by glossaries): -



      \glslongtok  \glslongtok

      -

      -

      Long plural value (defined by

      +

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



      \glslongpltok  \glslongpltok

      -

      +

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

      The short or long values may be modified by attributes (such as

      The short or long values may be modified by attributes (such as markwords). The @@ -10608,19 +10629,19 @@ above registers reflect the modification. If you want to access the original (unmodified) short or long form (as provided in the final two arguments of \newabbreviation), then use the commands: -



      \glsxtrorgshort  \glsxtrorgshort

      -

      +

      for the short form and -



      \glsxtrorglong  \glsxtrorglong

      -

      +

      for the long form. (These may be useful for the sort key to avoid any formatting that @@ -10628,44 +10649,44 @@ class="cmss-10">sort

      There are two other registers available that are defined by

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



      \glslabeltok  \glslabeltok

      -

      +

      which contains the entry’s label and -



      \glskeylisttok  \glskeylisttok

      -

      +

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

      Remember put

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



      \glscategorylabel  \glscategorylabel

      -

      +

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

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


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


      \GlsXtrUseAbbrStyleSetup  \GlsXtrUseAbbrStyleSetup{name}

      -

      +

      where ⟨name⟩ is the name of the existing style. For example, the \GlsXtrUseAbbrStyleSetup{long-noshort-desc}

      -

      within ⟨

      within ⟨setup⟩. -

      The ⟨

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

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

      The default suffix for the plural short form (if not overridden by the shortplural key): -



      \abbrvpluralsuffix  \abbrvpluralsuffix

      -

      +

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

      The font used for the short form on

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



      \glsfirstabbrvfont  \glsfirstabbrvfont{text}

      -

      -

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

      +

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



      \glsabbrvfont  \glsabbrvfont{text}

      -

      -

      The font used for the long form on

      +

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



      \glsfirstlongfont  \glsfirstlongfont{text}

      -

      -

      The font used for the long form in commands like

      +

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



      \glslongfont  \glslongfont{text}

      -

      -

      Display full form singular no case-change (used by

      +

      Display full form singular no case-change (used by \gls on first use for @@ -10748,7 +10769,7 @@ abbreviations without the regular attribute set): -



      \glsxtrfullformat  label}{insert}

      -

      -

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

      +

      Display full form singular first letter converted to upper case (used by \Gls on \Glsregular attribute set): -



      \Glsxtrfullformat  label}{insert}

      -

      -

      Display full form plural no case-change (used by

      +

      Display full form plural no case-change (used by \glspl on first use for @@ -10784,7 +10805,7 @@ abbreviations without the regular attribute set): -



      \glsxtrfullplformat  }

      -

      -

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

      +

      Display full form plural first letter converted to upper case (used by \Glspl on first use for abbreviations without the regular attribute set): -



      \Glsxtrfullplformat  label}{insert}

      -

      -

      In addition ⟨

      +

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

      Inline singular no case-change (used by

      Inline singular no case-change (used by \glsentryfull, \glsxtrfull\glsxtrfull\GLSxtrfull): -



      \glsxtrinlinefullformat  }{insert}

      -

      -

      Inline singular first letter converted to upper case (used by

      +

      Inline singular first letter converted to upper case (used by \Glsentryfull and \Glsxtrfull): -



      \Glsxtrinlinefullformat  }{insert}

      -

      -

      Inline plural no case-change (used by

      +

      Inline plural no case-change (used by \glsentryfullpl, \glsxtrfullpl\glsxtrfullpl\GLSxtrfullpl): -



      \glsxtrinlinefullplformat  }{insert}

      -

      -

      Inline plural first letter converted to upper case (used by

      +

      Inline plural first letter converted to upper case (used by \Glsentryfullpl and \Glsxtrfullpl): -



      \Glsxtrinlinefullplformat  }{insert}

      -

      -

      (New to version 1.17.) You can also modify the way the subsequent use is +

      +

      (New to version 1.17.) You can also modify the way the subsequent use is formatted by redefining the following four commands, but these won’t be used for abbreviations with the regular attribute set. If the style doesn’t redefine these commands, the default values are used. -

      Singular with no case-change: -


      Singular with no case-change: +


      \glsxtrsubsequentfmt  label}{insert}

      -

      -

      Singular with first letter upper case: -


      +

      Singular with first letter upper case: +


      \Glsxtrsubsequentfmt  label}{insert}

      -

      +

      -

      Plural with no case-change: -


      Plural with no case-change: +


      \glsxtrsubsequentplfmt  }{insert}

      -

      -

      Plural with first letter upper case: -


      +

      Plural with first letter upper case: +


      \Glsxtrsubsequentplfmt  }{insert}

      -

      -

      If you want to provide support for

      +

      If you want to provide support for glossaries-accsupp use the following glossaries-accsupp\glsentry⟨xxx⟩ command.) -

      For example, the

      For example, the short-long style has the following in ⟨fmts⟩:  
          \glsxtrparen{\glsfirstlongfont{\glsaccesslongpl{##1}}}%  
        }%

      -

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

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

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


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


      \GlsXtrUseAbbrStyleFmts  \GlsXtrUseAbbrStyleFmts{name}

      -

      +

      within ⟨fmts⟩, where ⟨name⟩ is the name of the existing style. For example, the @@ -11031,8 +11052,8 @@ class="cmti-10">fmts⟩:

        \GlsXtrUseAbbrStyleFmts{long-short}%
      -

      -

      Here’s an example of an abbreviation style that’s based on

      +

      Here’s an example of an abbreviation style that’s based on long-short that displays @@ -11053,7 +11074,7 @@ class="cmtt-10">\textsf:  
        \renewcommand*{\glsabbrvfont}[1]{\textsf{##1}}%  
      }

      -

      Note that this wouldn’t work if it was instead based on one of the modified versions +

      Note that this wouldn’t work if it was instead based on one of the modified versions such as short-sc-longshort-long\glsabbrvfont etc which makes them easier to adapt than the modified styles. -

      For further details, see the “Abbreviations” section in the documented code +

      For further details, see the “Abbreviations” section in the documented code (glossaries-extra-code.pdf).

      -

      -

      +

      Top

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

      -

      The

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

      @@ -11111,9 +11132,9 @@ class="cmss-10">hyperrefhyperref, you will end up with nested hyperlinks in the table of contents.
    -

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

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

    To get around all these problems, the

    To get around all these problems, the glossaries user manual recommends using the expandable non-hyperlink commands, such as \glsentrytext \chapter{A Chapter about \glsabbrvfont{\glsentryshort{html}}}

-

Or, if you are using

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

-

-

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

+

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

The

The glossaries-extra package tries to resolve this by modifying \markright and @@ -11179,12 +11200,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 @@ -11250,239 +11271,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. @@ -11516,7 +11537,7 @@ class="cmtt-10">\newacronym have the category set to acronym by default. -

Additionally, if you have enabled

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

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


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


\glscategory  \glscategory{label}

-

+

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

You can test the category for a given entry using -


You can test the category for a given entry using +


\glsifcategory  part}{false part}

-

+

This is equivalent to

-

Here the

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

-

This will bring the punctuation character inside the

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



\glsxtrwordsep  \glsxtrwordsep

-

+

and each word is encapsulated with -



\glsxtrword  \glsxtrword{word}

-

+

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


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

is essentially the same as +

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


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

The “hyphen” styles, such as

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

-

-

This setting will also adjust the long plural. -

This setting may result in the

+

This setting will also adjust the long plural. +

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

+

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

This setting will only adjust the short plural if the

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

This setting may result in the

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

+

markshortwords. -

If you explicitly override the short plural using the

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

-

This attribute is best used with the

+

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

With

With glossaries, commands like \cgls use \cglsformat only if the previous @@ -12006,13 +12027,39 @@ class="cmss-10">entrycount

+linkcount
This attribute is set to true by \GlsXtrEnableLinkCounting (see §6.2 + Link Counting). +
+linkcountmaster
This attribute is set to the name of the master counter by + \GlsXtrEnableLinkCounting if the optional argument is provided (see §6.2 + Link Counting). +
glossdesc
The \glossentrydesc command (used in the predefined glossary styles) is + id="dx1-27095"> command (used in the predefined glossary styles) is modified by glossaries-extra to check for this attribute. The attribute may have one of the following values: @@ -12021,25 +12068,28 @@ class="cmss-10">glossaries-extra to check for this attribute. The attribu class="cmtt-10">firstuc: the first letter of the description will be converted to upper case (using \Glsentrydesc). + id="dx1-27096">). + + +
  • title: the description will be used in the argument of the title casing command \capitalisewords (provided by (provided by mfirstuc). If you want to use a + id="dx1-27098">). If you want to use a different command you can redefine: -



    \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs}

    -

    +

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

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

    (Note that the argument to

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

  • -

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

    Any other values of this attribute are ignored. Remember that there are design limitations for both the first letter uppercasing and the title casing commands. See the mfirstuc user manual for further details. + id="dx1-27100"> user manual for further details.

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

    +

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

    (New to version 1.21.) Commands like \gls and \glstext have the link @@ -12152,14 +12202,14 @@ class="cmtt-10">\glstextformat by default. If this hyperoutside
    (New to v1.21.) The attribute value may be false, true or unset. If unset, true is assumed. This indicates the default setting of the hyperoutside + id="dx1-27113"> key, described in §2.1 Entry Indexing. dualindex
    If set, whenever a glossary entry has information written to the external glossary file through commands like \gls and and \glsadd, a corresponding line + id="dx1-27116">, a corresponding line will be written to the indexing file using \index. See . See §7 Auto-Indexing for @@ -12186,7 +12236,7 @@ href="#sec:autoindex">Auto-Indexing for targeturl
    If set, the hyperlink generated by commands like \gls will be set to the URL provided by this attributes value. For example: @@ -12196,7 +12246,7 @@ class="cmtt-10">\gls will be set to the
    \glssetcategoryattribute{general}{targeturl}{master-doc.pdf}
    -

    (See also the accompanying sample file

    (See also the accompanying sample file sample-external.tex.) If the URL contains awkward characters (such as % or ~) remember that the base glossaries package provides commands like \glspercentchar and and \glstildechar that expand to literal characters. -

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

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

    All the predefined glossary styles start each entry listing with

    All the predefined glossary styles start each entry listing with \glstarget which sets the anchor to \glolinkprefix\glslabel, so if you want entries to link to glossaries in the URL given by targeturl, you can just + id="dx1-27121">, you can just do: @@ -12236,23 +12286,23 @@ 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 targetname for the ⟨ for the ⟨name2⟩ part and targetcategory for the ⟨ for the ⟨name1⟩ part. -

    For example: +

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

    -

    will cause all link text for

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

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

    If you want a mixture in your document of entries that link to an internal glossary and entries that link to an external URL then you can use the starred form of \newignoredglossary for the external list. For + id="dx1-27124"> for the external list. For example: @@ -12286,14 +12336,14 @@ class="cmtt-10">\newignoredglossary  category=external,  
      description={external example}}

    -

    +

    -

    An attribute can be set using: -


    An attribute can be set using: +


    \glssetcategoryattribute  \glssetcategoryattribute{category-label} @@ -12303,31 +12353,31 @@ class="cmitt-10">attribute-label}{value}

    -

    +

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

    There is a shortcut version to set the

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


    attribute to “true”: +


    \glssetregularcategory  \glssetregularcategory{category-label}

    -

    -

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

    +

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



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

    -

    +

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

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


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


    \glsgetcategoryattribute  \glsgetcategoryattribute{category-label} @@ -12354,13 +12404,13 @@ class="cmtt-10">} class="cmtt-10">{⟨attribute-label}

    -

    +

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



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

    -

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


    +

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


    \glshascategoryattribute  \glshascategoryattribute{category-label} @@ -12387,19 +12437,19 @@ class="cmitt-10">true code}{false code}

    -

    +

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



    \glshasattribute  \glshasattribute{entry-label}{code}{false code}

    -

    -

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


    +

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


    \glsifcategoryattribute  \glsifcategoryattribute{category-label} @@ -12430,7 +12480,7 @@ class="cmitt-10">true-part}{false-part}

    -

    +

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

    For example: +

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

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

    This does “NO HYPER” if the

    This does “NO HYPER” if the general category has the category has the nohyper attribute set to + id="dx1-27136"> attribute set to true otherwise if does “HYPER”. -

    With boolean-style attributes like

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

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

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



    \glsifattribute  \glsifattribute{entry-label}{true-part} {false-part}

    -

    -

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

    +

    There’s also a shortcut to determine if a particular category has the regular + id="dx1-27139"> attribute set to “true”: -



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

    -

    +

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



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

    -

    +

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



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

    -

    +

    or for a particular entry: -



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

    -

    +

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

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


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


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

    -

    +

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

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

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



    \glsforeachwithattribute  \glsforeachwithattribute[glossary-labels] @@ -12613,42 +12663,42 @@ class="cmtt-10">}{body}

    -

    +

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

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

    You can change the category for a particular entry using the standard glossary field changing commands, such as \glsfielddef. Alternatively, you can + id="dx1-27148">. Alternatively, you can use -



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

    -

    +

    This will change the category to ⟨category-label⟩ for each entry listed in the comma-separated list ⟨entry-labels⟩. This command uses \glsfieldxdef so it will + id="dx1-27150"> so it will expand ⟨category-label⟩ and make the change global. -

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

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



    \glsxtrsetcategoryforall  \glsxtrsetcategoryforall{glossary-labels} @@ -12656,82 +12706,154 @@ class="cmtt-10">} class="cmtt-10">{⟨category-label}

    -

    +

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

    -

    -

    +

    Top

    6. Entry Counting

    -

    As mentioned in Counting References +

    There are three basic ways of counting entry references: +

      +
    1. Counting the total number of times \glsunset is used (\glsreset resets + the count and is best avoided). This is provided by the base glossaries + package and is intended for documents where the term should be displayed + differently if it’s only been used a certain number of times. The information + has to be written to the .aux file so that it’s available on the next + LATEX run. +

      This method is extended by glossaries-extra and is described in §6.1 Entry + Counting (First Use Flag). +

    2. +
    3. Counting the total number of records. This method is only available with + bib2gls and is intended for documents where the term should be displayed + differently if it’s only been recorded (indexed) a certain number of times. + See §9.4 Record Counting for further details. +
    4. +
    5. Counting the number of times the \gls-like or \glstext-like + commands are used. (That is, those commands that internally use + \@gls@link.) Unlike the other two methods, this just provides a + running total rather than the total from the previous LATEX run. + This method is intended to make it more convenient to work with + hooks like \glslinkcheckfirsthyperhook, \glslinkpostsetkeys or + \glslinkpresetkeys. See §6.2 Link Counting for further details.
    +

    Top

    6.1 Entry Counting (First Use Flag)

    +

    As mentioned in §2.4 Entry Counting Modifications, glossaries-extra modifies the \glsenableentrycount command to allow for the command to allow for the entrycount attribute. This means + id="dx1-29002"> attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but + id="dx1-29003">, but you also need to set the appropriate attribute (see §5 Categories). -

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

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

    -

    With

    +

    With glossaries-extra, you may use \cgls instead of instead of \gls even if you haven’t enabled + id="dx1-29006"> even if you haven’t enabled entry counting. You will only get a warning if you use \glsenableentrycount without setting the entrycount attribute. (With attribute. (With glossaries, commands like \cgls + id="dx1-29008"> will generate a warning if \glsenableentrycount hasn’t been used.) The + + + abbreviation shortcut \ab uses uses \cgls (see §3.3 Shortcut Commands) unlike the +href="#sec:abbrshortcuts">Shortcut Commands). The acronym shortcut \ac which uses \gls (except when it’s defined through - uses \cgls if it’s been defined with shortcuts=ac). -

    All upper case versions (not provided by (or +shortcuts=all) but uses \gls if it’s been defined with shortcuts=acronyms (or +shortcuts=acro). +

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



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

    -

    +

    and -



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

    -

    +

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



    \cGLSformat  \cGLSformat{label}{insert}

    -

    +

    and -



    \cGLSplformat  \cGLSplformat{label}{insert}

    -

    +

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

    Just using

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

    -

    -

    If you switch to

    +

    If you switch to glossaries-extra you must set the entrycount attribute: + id="dx1-29019"> attribute: @@ -12824,16 +12946,16 @@ class="cmss-10">entrycount\printglossaries  
    \end{document}

    -

    -

    When activated with

    +

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



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

    -

    +

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

    The default definition is: +

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

    -

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

    This means that if an entry is assigned to a category that has the entrycount + id="dx1-29023"> 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: @@ -12894,20 +13016,20 @@ four:

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

    -

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

    +

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


    etc: +


    \GlsXtrEnableEntryCounting  \GlsXtrEnableEntryCounting{categories} @@ -12915,13 +13037,13 @@ class="cmtt-10">} class="cmtt-10">{⟨value}

    -

    +

    The first argument ⟨categories⟩ is a comma-separated list of categories. For each category, the entrycount attribute is set to ⟨ attribute is set to ⟨value⟩. In addition, this does: @@ -12935,14 +13057,14 @@ class="cmti-10">value⟩. In addition, this does:  
    \renewcommand*{\GLS}{\cGLS}%  
    \renewcommand*{\GLSpl}{\cGLSpl}%

    -

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

    If you use

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

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

    The above example document can then become: + id="dx1-29029"> attribute for each listed category. +

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

    -

    -

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

    +

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



    \GlsXtrEnableEntryUnitCounting  \GlsXtrEnableEntryUnitCounting {value}{counter-name}

    -

    +

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

    Due to the asynchronous nature of T

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

    -

    Note that you can’t use both the document-wide counting and the per-unit + id="dx1-29031"> counter.

    +

    +

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

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

    The counter value is used as part of a label, which means that \thecounter-name⟩ needs to be expandable. Since hyperref also has a similar requirement and provides + id="dx1-29032"> also has a similar requirement and provides \theHcounter-name⟩ as an expandable alternative, \theHcounter-name⟩ if it exists otherwise it will use \thecounter-name⟩. -

    The per-unit counting function uses two attributes:

    The per-unit counting function uses two attributes: entrycount (as before) and -unitcount (the name of the counter). + id="dx1-29033"> (as before) and -

    Both the original document-wide counting mechanism and the per-unit counting +unitcount (the name of the counter). +

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

    -

    In this document, the

    In this document, the css entry is used three times in the first chapter. This is more than the trigger value of 2, so \gls{css} is expanded on first use with the short form used on subsequent use, and the css entries in that @@ -13103,33 +13225,33 @@ only used once, which trips the suppression trigger, so in that chapter, the long form is used and \gls{css} doesn’t get a line added to the glossary file. -

    The

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

    The

    The sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the general category, which hasn’t been listed in + id="dx1-29040"> 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 example document the trigger value is set to zero, which means the index suppression won’t be triggered, but the unit entry count is used to automatically suppress the hyperlink for commands like \gls by modifying the hook -


    by modifying the hook +


    \glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

    -

    +

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

    -

    This only produces a hyperlink for the first instance of

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

    The earlier warning about using the

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

    +

    +

    Top

    6.2 Link Counting

    +

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

    -

    -

    Top

    7. Auto-Indexing

    -

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

    The \glsxtrpostnamehook macro, used at the end of \glossentryname and +of times the \gls-like or \glstext-like commands are used. (The “link” in this +method’s name refers to the use of the internal command \@gls@link not to \Glossentryname, checks the indexname attribute for the category associated with -that entry. Since \glossentryname is used in the default glossary styles, this -makes a convenient way of automatically indexing each entry name at its -location in the glossary without fiddling around with the value of the name -key. -

    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 -


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

    -

    -This uses the standard \index command with the sort value taken from the entry’s +class="cmtt-10">\hyperlink although \@gls@link may use \hyperlink when displaying the +link-text.) +

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


    \GlsXtrEnableLinkCounting  \GlsXtrEnableLinkCounting[master counter] sort key and the actual value set to \glsentryname{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 -


    \glsxtrautoindexentry  \glsxtrautoindexentry{label{categories}

    -

    +

    where ⟨label⟩ is the entry’s label. The default definition is: +class="cmti-10">categories⟩ is a list of category labels. The optional argument ⟨master +counter⟩ may be used to identify a master counter (which must be defined). If +present, the associated link counter will be reset when the master counter is +incremented. This command automatically sets the linkcount attribute for the given +categories. If the optional argument is present, it also sets the linkcountmaster +attribute. +

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


    \glsxtrinclinkcounter  \glsxtrinclinkcounter{counter name}

    +

    +This just does \stepcounter{counter name} by default but if you need +\refstepcounter instead, just redefine this command:

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

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

    The sort value is assigned using: -


    \glsxtrautoindexassignsort

    +

    You can access the internal count register using +


    \GlsXtrLinkCounterValue  \GlsXtrLinkCounterValue{label}

    +

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

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


    \GlsXtrTheLinkCounter  \GlsXtrTheLinkCounter{counter}

    +

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

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

    +

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


    \GlsXtrIfLinkCounterDef  \GlsXtrIfLinkCounterDef{label}{true}{false} +

    +

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

    The counter name can be obtained using +


    \GlsXtrLinkCounterName  \GlsXtrLinkCounterName{label}

    +

    +This simply expands to the counter name associated with the entry given by ⟨label⟩ +without any check for existence. For example, to change the display command +(\thecounter⟩) using etoolbox: + + + +

    +
    +\csdef{the\GlsXtrLinkCounterName{duck}}{\Roman{\GlsXtrLinkCounterName{duck}}} +
    +

    This is useful if you just want to change the display for specific entries but isn’t +convenient if you want to change the display for all entries. Instead, it’s simpler to +redefine \GlsXtrTheLinkCounter. For example: + + + +

    +
    +\renewcommand*{\GlsXtrTheLinkCounter}[1]{% + 
     \GlsXtrIfLinkCounterDef{#1}% + 
     {\Roman{\GlsXtrLinkCounterName{#1}}}% + 
     {0}% + 
    } +
    +

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

    Here’s an example document that uses link counting to disable the hyperlink after +the first reference. This redefines \glslinkpresetkeys (which is used by both \gls +and \glstext) instead of \glslinkcheckfirsthyperhook (which is used by \gls +but not by \glstext). + + + +

    +
    +\documentclass{article} + 
    \usepackage[colorlinks]{hyperref} + 
    \usepackage{glossaries-extra} + 
    \makeglossaries + 
    \renewcommand*{\glslinkpresetkeys}{% + 
     \ifnum\GlsXtrLinkCounterValue{\glslabel}>1 + 
      \setkeys{glslink}{hyper=false}% + 
     \fi + 
    } + 
    \GlsXtrEnableLinkCounting{general} + 
    \newglossaryentry{sample1}{name={sample1},description={an example}} + 
    \newglossaryentry{sample2}{name={sample2},description={another example}} + 
    \newabbreviation{ex}{ex}{example} + 
    \begin{document} + 
    \section{Sample Section} + 
    \Gls{sample1}, \gls{sample2} and \gls{ex}. + 
    \Glstext{sample1} and \gls{ex} again. + 
    \section{Another Sample Section} + 
    \Gls{sample1}, \gls{sample2} and \gls{ex}. + 
    \printglossaries + 
    \end{document} +
    +

    The use of \glslinkpresetkeys means that the options can override this. For +example + + + +

    +
    +\gls[hyper=true]{sample1} +
    +

    will override the hyper=false setting in \glslinkpresetkeys. If \glslinkpostsetkeys +is used instead, the hyper=false setting will override the setting provided in the +optional argument. +

    The abbreviation category doesn’t have the linkcount attribute set (since it’s not +listed in the argument of \GlsXtrEnableLinkCounting). This means that +\GlsXtrLinkCounterValue always expands to 0 for the abbreviation (ex), so the +inequality test + + + +

    +
    +\ifnum\GlsXtrLinkCounterValue{\glslabel}>1 +
    +

    will always be false. This means that the abbreviation won’t have hyper=false +applied. If the test is changed to + + + +

    +
    +\ifnum\GlsXtrLinkCounterValue{\glslabel}=1 + 
    \else + 
     \setkeys{glslink}{hyper=false}% + 
    \fi +
    +

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

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

    +
    +\GlsXtrEnableLinkCounting[section]{general} +
    +

    + + + +

    +

    +

    Top

    7. Auto-Indexing

    +

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

    The \glsxtrpostnamehook macro, used at the end of \glossentryname and +\Glossentryname, checks the indexname attribute for the category associated with +that entry. Since \glossentryname is used in the default glossary styles, this +makes a convenient way of automatically indexing each entry name at its +location in the glossary without fiddling around with the value of the name +key. +

    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 +


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

    +

    +This uses the standard \index command with the sort value taken from the entry’s +sort key and the actual value set to \glsentryname{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 +


    \glsxtrautoindexentry  \glsxtrautoindexentry{label}

    +

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

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

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

    The sort value is assigned using: +


    \glsxtrautoindexassignsort  \glsxtrautoindexassignsort{cs}{label}

    -

    +

    where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the @@ -13274,212 +13659,212 @@ 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 + id="dx1-31014">’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. + id="dx1-31016"> 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 key, instead of the name key: + id="dx1-31018"> key:

    -
    +
    \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 + id="dx1-31019"> field, if present, otherwise the sort field: + id="dx1-31020"> field:

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



    \GlsXtrEnableIndexFormatOverride  \GlsXtrEnableIndexFormatOverride

    -

    +

    If you use this command and hyperref has been loaded, then the has been loaded, then the theindex + id="dx1-31026"> environment will be modified to redefine \glshypernumber to allow formats that use + id="dx1-31028"> to allow formats that use that command. -

    The

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

    -

    The key.

    +

    +

    The \glsxtrdoautoindexname command will attempt to escape any of \makeindex’s special characters, but there may be special cases where it fails, so take + id="dx1-31034">’s special characters, but there may be special cases where it fails, so take care. This assumes the default makeindex actual, level, quote and encap values (unless any of the commands \actualchar, , \levelchar, , \quotechar or or \encapchar + id="dx1-31039"> have been defined before glossaries-extra is loaded). -

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

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

    Be very careful of possible shifting category codes!
    -

    -


    Be very careful of possible shifting category codes!
    +

    +


    \GlsXtrSetActualChar  \GlsXtrSetActualChar{char}

    -

    +

    Set the actual character to ⟨char⟩. -



    \GlsXtrSetLevelChar  \GlsXtrSetLevelChar{char}

    -

    +

    Set the level character to ⟨char⟩. -



    \GlsXtrSetEscChar  \GlsXtrSetEscChar{char}

    -

    +

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



    \GlsXtrSetEncapChar  \GlsXtrSetEncapChar{char}

    -

    +

    Set the encap character to ⟨char⟩.

    -

    -

    +

    Top

    8. On-the-Fly Document Definitions

    -

    The commands described here may superficially look like ⟨

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

    -

    The

    +

    The glossaries package advises against defining entries in the document + id="dx1-32001"> environment. As mentioned in §1.2 glossaries-extra but can be enabled using the docdefs package options. -

    Although this can be problematic, the package options. +

    Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the document environment without the tricks used + id="dx1-32004"> environment without the tricks used with the docdefs option. option. There are limitations with this approach, so take care with it. This function is disabled by default, but can be enabled using the preamble-only command: -



    \GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly

    -

    +

    When used, this defines the commands described below. -

    The commands

    The commands \glsxtr, \glsxtrpl, \Glsxtr and \Glsxtrpl can’t be used after the glossaries have been displayed (through \printglossary etc). It’s best not to + id="dx1-32008"> etc). It’s best not to mix these commands with the standard glossary commands, such as \gls or there may be unexpected results.
    -

    -


    +


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

    -

    +

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

    -

    The ⟨

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

    +

    -

    The second optional argument ⟨

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



    \GlsXtrWarning  \GlsXtrWarning{dfn-options}{label}

    -

    -

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

    +

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

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

    -

    If you are considering doing something like: +

    +

    If you are considering doing something like:

    -
    +
    \newcommand*{\goose}{\glsxtr[][plural=geese]{goose}}  
    \renewcommand*{\GlsXtrWarning}[2]{}  
     ... later  
    \goose\ some more text here
    -

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

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

    There are plural and case-changing alternatives to

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



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

    -

    +

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



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

    -

    +

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



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

    -

    +

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

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

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

    If you use the starred version of

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

    +

    -

    -

    +

    Top

    9. bib2gls: Managing Reference Databases

    -

    There is a new command line application called

    There is a new command line application called bib2gls, which works in much + id="dx1-33002">, which works in much the same way as a combination of bibtex and makeindex/\input or \loadglsentries, the entries can instead be stored in a .bib file and bib2gls can + id="dx1-33004"> can selectively write the appropriate commands to a .glstex file which is loaded using \glsxtrresourcefile (or \GlsXtrLoadResources). -

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

    This means that you can use a reference managing system, such as JabRef, to maintain the database and it reduces the TEX overhead by only defining the entries that are actually required in the document. If you currently have a .tex file containing glossary definitions to a .bib file using convertgls2bib, supplied with + id="dx1-33005">, supplied with bib2gls.) -

    There are some new commands and options added to .) +

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

    This chapter just provides a general overview of bib2gls. The full details and +some sample documents are provided in the bib2gls into the document build process. -

    An example of the contents of manual. +

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

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

    -

    The follow provides some abbreviations: +

    +

    The follow provides some abbreviations:

    -
    + -

    -

    Here are some symbols: +

    +

    Here are some symbols:

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

    -

    To ensure that

    +

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

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

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

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

    If you still want to use an indexing application (for example, you need a custom + id="dx1-33020"> can also sort the entries and collate the locations. +

    If you still want to use an indexing application (for example, you need a custom xindy rule), then just use record=alsoindex and continue to use and continue to use \makeglossaries and \printglossary (or \printglossaries), but it’s a good idea to also instruct bib2gls to omit sorting to save time. -

    The to omit sorting to save time. +

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



    \glsxtrresourcefile  \glsxtrresourcefile[options]{filename}

    -

    +

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



    \GlsXtrLoadResources  \GlsXtrLoadResources[options]

    -

    +

    On the first use, this command is a shortcut for

    }
    On subsequent use,9.1 this + id="x1-33027f1"> this command is a shortcut for
    }
    where ⟨n⟩ is the current value of -



    \glsxtrresourcecount

    -

    +

    which is incremented at the end of \GlsXtrLoadResources. Any advisory notes regarding \glsxtrresourcefile also apply to \GlsXtrLoadResources. -

    The

    The \glsxtrresourcefile command writes the line

    filename.glstex if it exists.9.2 + id="x1-33028f2"> -

    Since the

    Since the .glstex won’t exist on the first LATEX run, the record package option + id="dx1-33029"> package option additionally switches on undefaction=warn. Any use of commands like . Any use of commands like \gls or \glstext will produce ?? in the document, since they are undefined at this point. Once bib2gls has created the has created the .glstex file the references should be resolved. 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 to select all entries that have a record in the + id="dx1-34002"> to select all entries that have a record in the .aux file, and any dependent entries (including parent and cross-references). The glsignore format (for example, \gls[format=glsignore]{duck}) is recognised by bib2gls as a special ignored record. This means that it will match the + id="dx1-34004"> as a special ignored record. This means that it will match the selection criteria but the record won’t be added to the location list. This means that you won’t get spurious commas in the location list, so you can do, for example, @@ -14004,72 +14398,72 @@ example,

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

    Note that commands like \glsaddall and \glsaddallunused don’t work with bib2gls as the command has to iterate over the internal lists of + id="dx1-34006"> as the command has to iterate over the internal lists of defined entry labels, which will be empty on the first run and on subsequent runs will only contain those entries that have been selected by bib2gls. + id="dx1-34008">.
    -

    -

    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 + id="dx1-34010"> this in the 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 bib2gls user manual for more details of this option. -

    + id="dx1-34012"> 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 + id="dx1-35002">. The default is to sort according to the system locale. If the document has a language setting, you can use sort=doc to instruct bib2gls to sort according to that. (The language tag obtained + id="dx1-35004"> to sort according to that. (The language tag obtained from tracklang’s interface is written to the ’s interface is written to the .aux file.) For a multilingual document you need to explicitly set the locale using a well-formed language tag. For example: @@ -14077,28 +14471,28 @@ 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 + id="dx1-35007"> 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 the order corresponding to bib2gls sorted list, the glossaries can simply be displayed + id="dx1-35009"> sorted list, the glossaries can simply be displayed using \printunsrtglossary (or \printunsrtglossaries), described in §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} @@ -14130,18 +14524,18 @@ class="E">EX’s path. Then the document might look like:  
    \printunsrtglossaries  
    \end{document}
    -

    The document build process (assuming the document is called

    The document build process (assuming the document is called mydoc) is:

    -
    +
    pdflatex mydoc  
    bib2gls mydoc  
    pdflatex mydoc
    -

    This creates a single glossary containing the entries:

    This creates a single glossary containing the entries: bird, duck, goose, bird, shtml and M entries were added because bib2gls detected (from the detected (from the .aux file) that they had been used in the document. The other entries were added because bib2gls detected (from the detected (from the .bib files) that they are referenced by the used entries. In the case of duck and goose, they are in the see field for field for bird. In the case of ssi and html, they are referenced in the description field of field of shtml. These cross-referenced entries won’t have a location list when the glossary is first displayed, but depending on how they are referenced, they may pick up a location list on the next document build. -

    The entries can be separated into different glossaries with different sort +

    The entries can be separated into different glossaries with different sort methods:

    -
    +
    \documentclass{article}  
    \usepackage[record,abbreviations,symbols]{glossaries-extra}  
    \setabbreviationstyle{long-short-desc} @@ -14202,8 +14596,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: @@ -14211,7 +14605,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} @@ -14229,13 +14623,13 @@ class="cmtt-10">type, which will produce a glossary with ordered sub-bloc  
    \printunsrtglossaries  
    \end{document}
    -

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

    This will result in a glossary where the first group has the title “Abbreviations”, the second group has the title “Symbols” and then follow the usual letter groups. Note that for this example to work, you must run bib2gls with the with the --group (or -g) switch. For example, if the document is called 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:

     sort rule
      sort-rule=% sort-rule={% required with sort=custom @@ -14378,33 +14774,42 @@ class="cmtt-10">,Z;Ż
       +class="cmtt-10"> }
    ]
    Remember that if you are using inputenc then extended characters, such as é or ø, + id="dx1-35018"> then extended characters, such as é or ø, are active and will expand when written to the .aux file. So with PDFLATEX the above would have to be changed to protect against expansion. Some of the options, including sort-rule, may have Unicode characters indicated in the format -sort-rule, may have Unicode characters indicated in the format \uhexin the .aux file. hex⟩ (or +\u ⟨hex⟩) in the .aux file. bib2gls will recognise this format as indicating the + id="dx1-35020"> will recognise this format as indicating the character given by the hexadecimal value ⟨hex⟩. The \u also needs protection from -expansion, so with a non-Unicode aware engine the above needs to be written as: +expansion, so with a non-Unicode aware engine, the character æ needs to be +written as \string\uE6 and so on. This is quite cumbersome, but you can +use the shortcut \glshex E6 instead, so the above needs to be written as:
     sort rule
      sort-rule=% sort-rule={% required with sort=custom
      < \string\uE6;\string\uC6 < a;\string\uE1;\string\uE5,\string\uE4,A;\string\uC1;\string\uC5;\string\uC4 \glshex E6;\glshex C6 + + + +
      < b,B +class="cmtt-10"> a;\glshex E1;\glshex E5,\glshex E4,A;\glshex C1;\glshex C5;\glshex C4
      < c;\string\u0107,C;\string\u0106 b,B < d,D c;\glshex 0107,C;\glshex 0106 < d,D +
      < e;\string\uE9,E;\string\uC9 e;\glshex E9,E;\glshex C9 < f,F <  < h,H < i;\string\uED,I;\string\uCD i;\glshex ED,I;\glshex CD < j,J j,J +
      < l;\string\u0142,L;\string\u0141 l;\glshex 0142,L;\glshex 0141 < m,M < n,N - - -
      < o;\string\uF6;\string\uF8,O;\string\uD6;\string\uD8 o;\glshex F6;\glshex F8,O;\glshex D6;\glshex D8 +
      < p,P < q,Q < r,R < s;\string\u013F,S;\string\u015A +class="cmtt-10"> s;\glshex 013F,S;\glshex 015A
      < t,T < u;\string\uFA,U;\string\uDA u;\glshex FA,U;\glshex DA < v,V < w,W < x,X < y,Y < +class="cmtt-10"> y,Y
      z;\string\u017C,Z;\string\u017B +class="cmtt-10"> < z;\glshex 017C,Z;\glshex 017B
       -
     }]
    -

    +

    -

    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 +class="cmti-10">hex⟩ in some of the resource options (as illustrated above). -

    The information provided with

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

    @@ -14542,16 +14983,16 @@ class="cmtt-10">}
    where ⟨information⟩ is the information to pass to bib2gls. The command in the + id="dx1-36005">. 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: @@ -14559,22 +15000,23 @@ commands for convenience. For example, with:

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

    you can just use, for example, \uE6 instead of \string\uE6 in the custom rule. This -redefinition of

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

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

    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} @@ -14595,24 +15037,24 @@ example:  
    \printunsrtglossaries  
    \end{document}
    -

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

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

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

    The problem with this is that the custom command \sym does allow for modifiers +

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



    \glsxtrnewgls  \glsxtrnewgls[default options]{prefix}{cs}

    -

    +

    which defines the command ⟨cs⟩ that behaves like

    @@ -14630,7 +15072,9 @@ class="cmitt-10">modifier⟩[default options,options],options]{prefix⟩⟨label] -
    +
    \glsxtrnewgls{sym.}{\sym}
    -

    or (to default to no hyperlinks) +

    or (to default to no hyperlinks)

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

    now you can use

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

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

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



    \glsxtrnewglslike  \glsxtrnewglslike[default options]{}{\Glspl-like cs}

    -

    +

    For example:

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

    For the all caps versions: -


    For the all caps versions: +


    \glsxtrnewGLSlike  \glsxtrnewGLSlike[default options]{\GLS-like cs}{\GLSpl-like cs}

    -

    +

    For example:

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

    -

    There’s an analogous command for

    +

    There’s an analogous command for \rgls: -



    \glsxtrnewrgls  \glsxtrnewrgls[default options]{}{cs}

    -

    +

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



    \glsxtrnewrglslike  \glsxtrnewrglslike[default options]{}{\rGlspl-like cs}

    -

    +

    and for the all caps: -



    \glsxtrnewrGLSlike  \glsxtrnewrGLSlike[default options]{\rGLS-like cs}{\rGLSpl-like cs}

    -

    -

    +

    +

    -

    Top

    9.4 Record Counting

    -

    As from version 1.1 of Record Counting +

    As from version 1.1 of bib2gls, you can save the total record count for each entry by + id="dx1-37002">, you can save the total record count for each entry by invoking bib2gls with the with the --record-count or --record-count-unit switches. These options will ensure that when each entry is written to the .glstex file bib2gls will additionally set the following internal fields for that entry: + id="dx1-37006"> will additionally set the following internal fields for that entry:

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

    If

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

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

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

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



      \glsxtrdetoklocation  \glsxtrdetoklocation{location}

      -

      +

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

      Note that the record count includes locations that

      Note that the record count includes locations that bib2gls discards, such as + id="dx1-37009"> discards, such as ignored records, duplicates and partial duplicates. It doesn’t include cross-reference records. For example, if \gls{bird} is used twice on page 1, once on page 2 and @@ -14851,43 +15295,43 @@ field) is 2 + 1 + 4 = 7, and the total for the section counter (stored in the recordcount.section field) is 1. -

      With the unit counting on as well, the field

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

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

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



      \GlsXtrTotalRecordCount  \GlsXtrTotalRecordCount{label}

      -

      +

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

      -
      +
      \GlsXtrTotalRecordCount{bird}
      -

      expands to 8. -


      expands to 8. +


      \GlsXtrRecordCount  \GlsXtrRecordCount{label}{counter}

      -

      +

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

      -
      +
      \GlsXtrRecordCount{bird}{page}
      -

      expands to 7 and +

      expands to 7 and

      -
      +
      \GlsXtrRecordCount{bird}{section}
      -

      expands to 1. -


      expands to 1. +


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

      -

      +

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

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

      expands to 4. Be careful about using

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

      There are commands analogous to the entry counting commands like

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



      \rgls  \rglsmodifier[label}[insert]

      -

      -


      +


      \rglspl  \rglsplmodifier[label}[insert]

      -

      -


      +


      \rGls  \rGlsmodifier[label}[insert]

      -

      -


      +


      \rGlspl  \rGlsplmodifier[label}[insert]

      -

      -


      +


      \rGLS  \rGLSmodifier[label}[insert]

      -

      -


      +


      \rGLSpl  \rGLSplmodifier[label}[insert]

      -

      +

      These commands check the recordcount attribute which, if set, should be a number. + id="dx1-37019"> attribute which, if set, should be a number. For example:

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

      For convenience, you can use -


      For convenience, you can use +


      \GlsXtrSetRecordCountAttribute  \GlsXtrSetRecordCountAttribute{category list}{n}

      -

      +

      to set the recordcount attribute to ⟨ attribute to ⟨n⟩ for all the categories listed in ⟨category list⟩. -

      The

      The \rgls-like commands use -



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

      -

      +

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

      This command checks if the

      This command checks if the recordcount attribute is set. If not is just does + id="dx1-37023"> attribute is set. If not is just does ⟨normal⟩, otherwise it tests if -



      \glsxtrrecordtriggervalue  \glsxtrrecordtriggervalue{label}

      -

      +

      is greater than the value given in the recordcount attribute for that entry’s category. + id="dx1-37025"> attribute for that entry’s category. If true, this does ⟨normal⟩ otherwise it does ⟨trigger code⟩. The default definition of the @@ -15106,105 +15550,105 @@ trigger value command is:

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

      The ⟨

      The ⟨trigger code⟩ part writes a record with the format set to set to glstriggerrecordformat (which bib2gls v1.1+ recognises as a special type of ignored location format) and + id="dx1-37028"> v1.1+ recognises as a special type of ignored location format) and does ⟨trigger format⟩. Then it unsets the first use flag. Note that it doesn’t implement the post-link hook. This ensures that the record count is correct on the next run. -

      The ⟨

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



      \rglsformat  \rglsformat{label}{insert}

      -

      -


      +


      \rglsplformat  \rglsplformat{label}{insert}

      -

      -


      +


      \rGlsformat  \rGlsformat{label}{insert}

      -

      -


      +


      \rGlsplformat  \rGlsplformat{label}{insert}

      -

      -


      +


      \rGLSformat  \rGLSformat{label}{insert}

      -

      -


      +


      \rGLSplformat  \rGLSplformat{label}{insert}

      -

      +

      These all behave much like their \cglsformat counterparts. If the entry’s regular + id="dx1-37036"> 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. @@ -15228,7 +15672,7 @@ For example:

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

      In the above,

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

      -

      -

      +

      Top

      10. Miscellaneous New Commands

      -

      The

      The glossaries package provides \glsrefentry entry to cross-reference entries + id="dx1-38001"> entry to cross-reference entries when used with the entrycounter or or subentrycounter options. The options. The glossaries-extra package provides a supplementary command -



      \glsxtrpageref  \glsxtrpageref{label}

      -

      +

      that works in the same way except that it uses \pageref instead of instead of \ref. -

      You can copy an entry to another glossary using -


      . +

      You can copy an entry to another glossary using +


      \glsxtrcopytoglossary  \glsxtrcopytoglossary{entry-label}{glossary-type}

      -

      +

      This appends ⟨entry-label⟩ to the end of the internal list for the glossary given by ⟨glossary-type⟩. Be careful if you use the hyperref package as this may cause duplicate + id="dx1-38008"> package as this may cause duplicate hypertargets. You will need to change \glolinkprefix to another value or disable hyperlinks when you display the duplicate. Alternatively, use the new target key to + id="dx1-38009"> key to switch off the targets:

      -
      +
      \printunsrtglossary[target=false]
      -

      -

      The

      +

      The glossaries package allows you to set preamble code for a given glossary type using \setglossarypreamble. This overrides any previous setting. With glossaries-extra (as from v1.12) you can instead append to the preamble using -



      \apptoglossarypreamble  \apptoglossarypreamble[type]{code}

      -

      +

      or prepend using -



      \pretoglossarypreamble  \pretoglossarypreamble[type]{code}

      -

      +

      -

      Top

      10.1 Entry Fields

      -

      A field may now be used to store the name of a text-block command that takes a +

      A field may now be used to store the name of a text-block command that takes a single argument. The field is given by -



      \GlsXtrFmtField  \GlsXtrFmtField

      -

      +

      The default value is useri. Note that the value must be the control sequence name without the initial backslash. -

      For example: +

      For example:

      -
      +
      \newcommand*{\mtx}[1]{\boldsymbol{#1}}  
      \newcommand*{\mtxinv}[1]{\mtx{#1}\sp{-1}}  
      \newglossaryentry{matrix}{% @@ -15391,13 +15835,13 @@ class="cmti-10">without the initial backslash.  
         $\mtx{M}\mtxinv{M}=\glssymbol{identitymatrix}$}  
      }
      -

      -

      There are two commands provided that allow you to apply the command to an +

      +

      There are two commands provided that allow you to apply the command to an argument: -



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

      -

      +

      This effectively does

      {\glsxtrfmtdisplay {cs name}{text}{}}
      where ⟨cs⟩ is the command obtained from the control sequence name supplied in the -provided field, which must be defined to take a single required argument. Although it -effectively acts like cs name⟩ is the control sequence name supplied in the provided field, which +must be defined to take a single required argument. Although it effectively acts like +\glslink it misses out the post-link hook. -

      The default ⟨

      The default ⟨default-options⟩ are given by -



      \GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

      -

      +

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

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

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



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

      -

      +

      Both the starred and unstarred versions use: -



      \glsxtrfmtdisplay  \glsxtrfmtdisplay{cs name}{}{insert}

      -

      +

      within the link text. In the case of the unstarred version ⟨insert⟩ will be empty. It will also be empty if the final option argument is missing from the starred form. If the @@ -15487,7 +15934,7 @@ warning if undefaction=warn). There won’t be a warning or error if the entry is + id="dx1-39006">). There won’t be a warning or error if the entry is defined by the given field is missing. In either case, (the entry is undefined or the field is missing) ⟨cs name⟩ will be -

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

      which puts ⟨

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

      Remember that nested links cause a problem so avoid using commands like

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

      -

      For example: +

      +

      For example:

      -
      +
      \[  
        \glsxtrfmt{matrix}{A}  
        \glsxtrfmt{matrixinv}{A} @@ -15523,34 +15970,34 @@ class="cmti-10">text⟩.
       
        \glssymbol{identitymatrix}  
      \]
      -

      If the default options are set to

      If the default options are set to noindex then \glsxtrfmt won’t index, but will create a hyperlink (if hyperref has been loaded). This can be changed so that it also + id="dx1-39007"> 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 @@ -15561,17 +16008,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 @@ -15610,22 +16057,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-39012"> 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-39013"> 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-39017">. 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 @@ -15832,19 +16279,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-39027"> to determine if a field has been set. The glossaries-extra package provides a simpler version: -



      \glsxtrifhasfield  \glsxtrifhasfield{field}{}{false}

      -

      -(New to v1.19.) Unlike \ifglshasfield, this version doesn’t complain if the entry -(given by ⟨label⟩) or the field don’t exist and will simply do ⟨false⟩. If the field does exist -for the given entry and it’s not empty, the ⟨

      +(New to v1.19.) Note that in this case the ⟨field⟩ must be the internal field label (for +example, useri rather than user1). Unlike \ifglshasfield, this version +doesn’t complain if the entry (given by ⟨label⟩) or the field don’t exist and +will simply do ⟨false⟩. If the field does exist for the given entry and it’s not +empty, the ⟨true⟩ part is done otherwise it does ⟨false⟩. -Within ⟨true⟩ you may use -


      false⟩. Within ⟨true⟩ you may +use +


      \glscurrentfieldvalue  \glscurrentfieldvalue

      -

      +

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



      \glsxtrifhasfield*  \glsxtrifhasfield*{field}{}{false}

      -

      +

      omits the implicit grouping. -

      There is also a version that simply uses

      Be careful of keys that use \relax as the default value (such as the symbol). Use +\ifglshassymbol instead.
      +

      +

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



      \GlsXtrIfFieldUndef  \GlsXtrIfFieldUndef{field}{}{false}

      -

      -

      There’s a difference between an undefined field and an unset field. An undefined +

      +

      There’s a difference between an undefined field and an unset field. An undefined field hasn’t been assigned any value (no associated internal control sequence has been defined). If a defined field has been defined to empty, then it’s considered unset. \GlsXtrIfFieldUndef for fields that can only be defined through commands like \GlsXtrSetField.
      -

      -

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


      +

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


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

      -

      +

      If the entry exists and has the given field set to the given text then this does ⟨true⟩ otherwise it does ⟨false⟩. This is just a shortcut that uses \glsxtrifhasfield to test if + + + the field exists and then compares the replacement text of \glscurrentfieldvalue with ⟨text⟩ using etoolbox’s ’s \ifdefstring. -

      The

      The glossaries package provides \glsfieldfetch which can be used to fetch the + id="dx1-39035"> 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-39037"> 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-39039"> internal list, you can use the following command that adds an item to the field using etoolbox’s ’s \listcsadd: -



      \glsxtrfieldlistadd  \glsxtrfieldlistadd{label}{}{item}

      -

      +

      where ⟨label⟩ is the entry’s label, ⟨field⟩ is the entry’s field and ⟨\listgadd, \listeadd and \listxadd: -



      \glsxtrfieldlistgadd  \glsxtrfieldlistgadd{label}{}{item}

      -

      -


      +


      \glsxtrfieldlisteadd  \glsxtrfieldlisteadd{label}{}{item}

      -

      -


      +


      \glsxtrfieldlistxadd  \glsxtrfieldlistxadd{label}{}{item}

      -

      +

      You can then iterate over the list using: -



      \glsxtrfielddolistloop  \glsxtrfielddolistloop{label}{field}

      -

      +

      or -



      \glsxtrfieldforlistloop  \glsxtrfieldforlistloop{label}{} class="cmtt-10">{handler}

      -

      +

      that internally use \dolistcsloop and \forlistloop, respectively. -

      There are also commands that use

      There are also commands that use \ifinlistcs: -



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

      -

      +

      and \xifinlistcs - - - -



      \glsxtrfieldxifinlist  \glsxtrfieldxifinlist{label}{true}{false}

      -

      -

      See the

      +

      See the etoolbox’s user manual for further details of these commands, in particular + id="dx1-39049">’s user manual for further details of these commands, in particular the limitations of \ifinlist. -

      If the field has a comma-separated list value instead, you can iterate over it +

      If the field has a comma-separated list value instead, you can iterate over it using: -



      \glsxtrforcsvfield  \glsxtrforcsvfield{label}{}{handler}

      -

      +

      where again ⟨handler⟩ is a control sequence that takes a single argument. Unlike the etoolbox loops, this doesn’t ignore empty elements nor does it discard leading / + id="dx1-39051"> loops, this doesn’t ignore empty elements nor does it discard leading / trailing spaces. Internally it uses \@for (modified by xfor which is automatically + id="dx1-39052"> which is automatically loaded by glossaries). The ). The xfor package modifies the behaviour of package modifies the behaviour of \@for to allow the loop to be broken prematurely using \@endfortrue. The \glsxtrforcsvfield command locally defines a user level command: -



      \glsxtrendfor  \glsxtrendfor

      -

      +

      which is just a synonym for \@endfortrue. -

      The loop is performed within the true part of

      The loop is performed within the true part of \glsxtrifhasfield so scoping is automatically applied. -

      When using the

      When using the record option, in addition to recording the usual location, you can + id="dx1-39056"> option, in addition to recording the usual location, you can also record the current value of another counter at the same time using the preamble-only command: -



      \GlsXtrRecordCounter  \GlsXtrRecordCounter{counter name}

      -

      +

      For example:

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

      Each time an entry is referenced with commands like

      Each time an entry is referenced with commands like \gls or \glstext, the \gls{bird} is used in section 1.2 th -

      +
      \glsxtrfieldlistgadd{bird}{record.section}{1.2}
      -

      Note that there’s no key corresponding to this new

      Note that there’s no key corresponding to this new record.section field, but its value can be accessed with \glsxtrfielduse or the list can be iterated over with \glsxtrfielddolistloop etc. -

      +

      -

      Top

      10.2 Display All Entries Without Sorting or Indexing

      -



      \printunsrtglossary  \printunsrtglossary[options]

      -

      +

      This behaves like \printnoidxglossary but never sorts the entries and always lists all the defined entries for the given glossary (and doesn’t require \makenoidxglossaries). If you want to use one of the tabular-like styles with + id="dx1-40002">-like styles with \printunsrtglossary, make sure you load glossaries-extra-stylemods which modifies + id="dx1-40004"> which modifies the definition of \glsgroupskip to avoid the “Incomplete \iftrue” error that may otherwise occur. -

      There’s also a starred form -


      There’s also a starred form +


      \printunsrtglossary*  \printunsrtglossary*[options]{code}

      -

      +

      which is equivalent to

      \endgroup class="cmtt-10">\glossarypreamble, the supplied ⟨code⟩ is done before the glossary header. -

      This means you now have the option to simply list all entries on the first +

      This means you now have the option to simply list all entries on the first LATEX run without the need for a post-processor, however there will be no number list in this case, as that has to be set by a post-processor such as bib2gls (see (see §9 bib2gls: Managing Reference Databases). -

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

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

      +

      -

      If you have any entries with the

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

      For example: +

      For example:

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

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

      If you allow document definitions with the

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

      If you allow document definitions with the docdefs option, the document will + id="dx1-40014"> option, the document will require a second LATEX run if the entries are defined after \printunsrtglossary. -

      The optional argument is as for

      The optional argument is as for \printnoidxglossary (except for the sort key, + id="dx1-40015"> key, which isn’t available). -

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


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


      \printunsrtglossaries  \printunsrtglossaries

      -

      +

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

      To avoid complications caused by

      To avoid complications caused by tabular-like glossary styles, -like glossary styles, \printunsrtglossary iterates over all entries in the selected glossary and appends the appropriate code to an internal command. Once the construction of this command is complete, then it’s performed to display the glossary. This puts the loop outside the style code. For convenience, there’s a hook used within the loop: -



      \printunsrtglossaryentryprocesshook  \printunsrtglossaryentryprocesshook {label}

      -

      +

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



      \printunsrtglossaryskipentry  \printunsrtglossaryskipentry

      -

      +

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

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

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



      \printunsrtglossarypredoglossary  \printunsrtglossarypredoglossary

      -

      +

      -

      The internal command uses -


      The internal command uses +


      \printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

      -

      +

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

      By default the handler just does -


      By default the handler just does +


      \glsxtrunsrtdo  \glsxtrunsrtdo{label}

      -

      +

      which determines whether to use \glossentry or \subglossentry and checks the location and and loclist fields for the fields for the number list. -

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

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



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

      -

      +

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

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

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

      -

      For example, if the preamble includes: +

      +

      For example, if the preamble includes:

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

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

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

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

      -

      Alternatively you can use the starred form of

      +

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

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

      -

      If you are using the

      +

      If you are using the hyperref package and want to display the same glossary more + id="dx1-40028"> package and want to display the same glossary more than once, you can also add a temporary redefinition of \glolinkprefix to avoid duplicate hypertarget names. For example: @@ -16559,7 +17019,7 @@ duplicate hypertarget names. For example:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -16575,7 +17035,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: @@ -16583,7 +17043,7 @@ better approach to use:

      -
      +
      \printunsrtglossary*{%  
        \renewcommand{\printunsrtglossaryhandler}[1]{%  
          \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -16599,14 +17059,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} @@ -16624,12 +17084,12 @@ the glossary header and add some vertical space afterwards:  
        \appto\glossarypostamble{\glspar\medskip\glspar}%  
      }
      -

      -

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


      +

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


      \printunsrtglossaryunit  \printunsrtglossaryunit[options]{counter name}

      -

      +

      The above example can simply be replaced with:

      -
      +
      \printunsrtglossaryunit{section}
      -

      -

      This shortcut command is actually defined to use

      +

      This shortcut command is actually defined to use \printunsrtglossary* with -



      \printunsrtglossaryunitsetup  \printunsrtglossaryunitsetup{counter name}

      -

      +

      so if you want to just make some minor modifications you can do

      -
      +
      \printunsrtglossary*{\printunsrtglossaryunitsetup{section}%  
        \renewcommand*{\glossarysection}[2][]{\subsection*{Summary}}%  
      }
      -

      which will start the list with a subsection header with the title “Summary” +

      which will start the list with a subsection header with the title “Summary” (overriding the glossary’s title). -

      Note that this shortcut command is only available with the

      Note that this shortcut command is only available with the record (or + id="dx1-40031"> (or record=alsoindex) package option. -

      This temporary change in the hypertarget prefix means you need to explicitly use + id="dx1-40032">) package option. +

      This temporary change in the hypertarget prefix means you need to explicitly use \hyperlink to create a link to it as commands like \gls will try to link to the target @@ -16693,12 +17153,12 @@ the front or back matter) which can be the target for all glossary references an just use \printunsrtglossaryunit for a quick summary at the start of a section etc. -

      +

      -

      Top

      10.3 Standalone Entry Items

      -

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

      It may be that you don’t want a list but would rather display entry details throughout the document. You can simply do \glsentryname followed by \glsentrydesc. (Remember that if you don’t want a s href="#styopt.sort">sort=none to + id="dx1-41001"> to skip the construction of the sort field.) For example, in the preamble provide a + id="dx1-41002"> field.) For example, in the preamble provide a custom command:

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

      define your entries +

      define your entries

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

      and then later in the text: +

      and then later in the text:

      -
      +
      \displayterm{function}
      -

      -

      However, if may be that you want to use

      +

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



      \glsxtrglossentry  \glsxtrglossentry{label}

      -

      +

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

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

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

      • Defines \glssubentryitem.
      • Increments and display the entry counters if the entrycounter or or subentrycounter + id="dx1-41006"> package options are set. If the entry has a parent, then this does
        • \glssubentryitem{label}
        -

        otherwise it does

        +

        otherwise it does

        • \glsentryitem{\glsnamefont or picks up the style from category attribut such as glossnamefont.
        + id="dx1-41007">.
      -

      If you have used

      If you have used \nopostdesc or or \glsxtrnopostpunc in any of your description fields, + id="dx1-41009"> 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

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

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

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


      ): +


      \glsxtrglossentryother  \glsxtrglossentryother{header}{}{field}

      -

      +

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

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

    The

    The \glsxtrglossentryother command internally uses \glossentrynameother{label\glossentryname{label}. If you are using the glossaries-accsupp + id="dx1-41013"> package (through the accsupp option) then accessibility support will be provided if + id="dx1-41014"> option) then accessibility support will be provided if there’s a corresponding command

    }
    (for example, \glssymbolaccessdisplay). -

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

    This means that my custom command can be changed to:

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

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

    If I want numbered definitions, then I can use the package options entrycounter or + id="dx1-41015"> or subentrycounter and remove the colon: + id="dx1-41016"> and remove the colon:

    -
    +
    \newcommand{\displayterm}[1]{%  
     \par\medskip\par\noindent  
     Definition \glsxtrglossentry{#1}.\par @@ -16942,28 +17402,28 @@ class="cmss-10">subentrycounter \par\medskip  
    }
    -

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

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

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

    It’s now possible to not only use

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

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

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

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

    (Note the grouping to localise

    (Note the grouping to localise \glsxtractivatenopost.) -

    You can also use

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

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

    This will use

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

    +

    -

    Top

    10.4 Entry Aliases

    -

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

    An entry can be made an alias of another entry using the alias key. The + id="dx1-42001"> key. The value should be the label of the other term. There’s no check for the other’s existence when the aliased entry is defined. This is to allow the possibility of defining the other entry after the aliased entry. (For example, when used with bib2gls.) -

    If an entry ⟨.) +

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

    • If the see field wasn’t provided when ⟨ field wasn’t provided when ⟨entry-1⟩ was defined, the alias key will + id="dx1-42005"> key will automatically trigger
      }
    • If the hyperref package has been loaded then package has been loaded then \gls{entry-1} will link to @@ -17048,7 +17508,7 @@ class="cmtt-10">} will link to class="cmti-10">entry-2⟩’s target. (Unless the targeturl attribute has been set for ⟨ attribute has been set for ⟨entry-1⟩’s category.)
    • @@ -17056,20 +17516,20 @@ class="cmti-10">entry-1⟩’s href="#styopt.record">record=off or or record=alsoindex, the , the noindex setting will automatically + id="dx1-42010"> setting will automatically be triggered when referencing ⟨entry-1⟩ with commands like \gls or \glstext. This prevents ⟨entry-1⟩ from have a location list (aside from the cross-reference added with \glssee) unless it’s been explicitly @@ -17080,97 +17540,97 @@ class="cmtt-10">noindex=false. -

      Note that with

      Note that with record=only, the location list for aliased entries is controlled + id="dx1-42012">, the location list for aliased entries is controlled with bib2gls’s settings.

    -

    The index suppression trigger is performed by -


    ’s settings.

    +

    The index suppression trigger is performed by +


    \glsxtrsetaliasnoindex  \glsxtrsetaliasnoindex

    -

    +

    This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts + id="dx1-42017"> have been set. With record=only, , \glsxtrsetaliasnoindex will default to do nothing. -

    Within the definition of

    Within the definition of \glsxtrsetaliasnoindex you can use -



    \glsxtrindexaliased  \glsxtrindexaliased

    -

    +

    to index ⟨entry-2⟩. -

    The index suppression command can be redefined to index the main term instead. +

    The index suppression command can be redefined to index the main term instead. For example:

    -
    +
    \renewcommand{\glsxtrsetaliasnoindex}{%  
     \glsxtrindexaliased  
     \setkeys{glslink}{noindex}%  
    }
    -

    -

    The value of the

    +

    The value of the alias field can be accessed using -


    field can be accessed using +


    \glsxtralias  \glsxtralias{label}

    -

    +

    -

    -

    +

    Top

    11. Supplemental Packages

    -

    The

    The glossaries bundle provides additional support packages glossaries-prefix (for + id="dx1-43001"> (for prefixing) and glossaries-accsupp (for accessibility support). These packages aren’t + id="dx1-43002"> (for accessibility support). These packages aren’t automatically loaded.

    -

    Top

    11.1 Prefixes or Determiners

    -

    If prefixing is required, you can simply load

    If prefixing is required, you can simply load glossaries-prefix after after glossaries-extra. For example:

    -
    +
    \documentclass{article}  
    \usepackage{glossaries-extra}  
    \usepackage{glossaries-prefix} @@ -17185,32 +17645,32 @@ example:  
    \printglossaries  
    \end{document}
    -

    -

    +

    +

    -

    Top

    11.2 Accessibility Support

    -

    The

    The glossaries-accsupp package needs to be loaded before package needs to be loaded before glossaries-extra or through the accsupp package option: + id="dx1-45002"> package option:

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

    If you don’t load

    If you don’t load glossaries-accsupp or you load or you load glossaries-accsupp after after glossaries-extra the new \glsaccessxxx⟩ commands described below will simply be equiv corresponding \glsentryxxx⟩ commands. -

    The following

    The following \glsaccessxxx⟩ commands add accessibility information wrapped around the corresponding \glsentryxxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information. -



    \glsaccessname  \glsaccessname{label}

    -

    +

    This displays the value of the name field for the entry identified by ⟨ field for the entry identified by ⟨label⟩. -

    If the

    If the glossaries-accsupp package isn’t loaded, this is simply defined as: + id="dx1-45007"> 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  
      {% @@ -17262,38 +17722,38 @@ class="cmss-10">glossaries-accsupp  {#1}%  
    }
    -

    (

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



    \Glsaccessname  \Glsaccessname{label}

    -

    +

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

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

    With the

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

    -
    +
    \newcommand*{\Glsaccessname}[1]{%  
      \glsnameaccessdisplay  
      {% @@ -17302,299 +17762,299 @@ class="cmss-10">glossaries-accsupp  {#1}%  
    }
    -

    -

    The following commands are all defined in an analogous manner. -


    +

    The following commands are all defined in an analogous manner. +


    \glsaccesstext  \glsaccesstext{label}

    -

    +

    This displays the value of the text field. -


    field. +


    \Glsaccesstext  \Glsaccesstext{label}

    -

    +

    This displays the value of the text field with the first letter converted to upper + id="dx1-45016"> field with the first letter converted to upper case. -



    \glsaccessplural  \glsaccessplural{label}

    -

    +

    This displays the value of the plural field. -


    field. +


    \Glsaccessplural  \Glsaccessplural{label}

    -

    +

    This displays the value of the plural field with the first letter converted to upper + id="dx1-45020"> field with the first letter converted to upper case. -



    \glsaccessfirst  \glsaccessfirst{label}

    -

    +

    This displays the value of the first field. -


    field. +


    \Glsaccessfirst  \Glsaccessfirst{label}

    -

    +

    This displays the value of the first field with the first letter converted to upper + id="dx1-45024"> field with the first letter converted to upper case. -



    \glsaccessfirstplural  \glsaccessfirstplural{label}

    -

    +

    This displays the value of the firstplural field. -


    field. +


    \Glsaccessfirstplural  \Glsaccessfirstplural{label}

    -

    +

    This displays the value of the firstplural field with the first letter converted to upper + id="dx1-45028"> field with the first letter converted to upper case. -



    \glsaccesssymbol  \glsaccesssymbol{label}

    -

    +

    This displays the value of the symbol field. -


    field. +


    \Glsaccesssymbol  \Glsaccesssymbol{label}

    -

    +

    This displays the value of the symbol field with the first letter converted to upper + id="dx1-45032"> field with the first letter converted to upper case. -



    \glsaccesssymbolplural  \glsaccesssymbolplural{label}

    -

    +

    This displays the value of the symbolplural field. -


    field. +


    \Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

    -

    +

    This displays the value of the symbolplural field with the first letter converted to + id="dx1-45036"> field with the first letter converted to upper case. -



    \glsaccessdesc  \glsaccessdesc{label}

    -

    +

    This displays the value of the desc field. -


    field. +


    \Glsaccessdesc  \Glsaccessdesc{label}

    -

    +

    This displays the value of the desc field with the first letter converted to upper + id="dx1-45040"> field with the first letter converted to upper case. -



    \glsaccessdescplural  \glsaccessdescplural{label}

    -

    +

    This displays the value of the descplural field. -


    field. +


    \Glsaccessdescplural  \Glsaccessdescplural{label}

    -

    +

    This displays the value of the descplural field with the first letter converted to upper + id="dx1-45044"> field with the first letter converted to upper case. -



    \glsaccessshort  \glsaccessshort{label}

    -

    +

    This displays the value of the short field. -


    field. +


    \Glsaccessshort  \Glsaccessshort{label}

    -

    +

    This displays the value of the short field with the first letter converted to upper + id="dx1-45048"> field with the first letter converted to upper case. -



    \glsaccessshortpl  \glsaccessshortpl{label}

    -

    +

    This displays the value of the shortplural field. -


    field. +


    \Glsaccessshortpl  \Glsaccessshortpl{label}

    -

    +

    This displays the value of the shortplural field with the first letter converted to upper + id="dx1-45052"> field with the first letter converted to upper case. -



    \glsaccesslong  \glsaccesslong{label}

    -

    +

    This displays the value of the long field. -


    field. +


    \Glsaccesslong  \Glsaccesslong{label}

    -

    +

    This displays the value of the long field with the first letter converted to upper + id="dx1-45056"> field with the first letter converted to upper case. -



    \glsaccesslongpl  \glsaccesslongpl{label}

    -

    +

    This displays the value of the longplural field. -


    field. +


    \Glsaccesslongpl  \Glsaccesslongpl{label}

    -

    +

    This displays the value of the longplural field with the first letter converted to upper + id="dx1-45060"> field with the first letter converted to upper case.

    -

    -

    +

    Top

    12. Sample Files

    -

    The following sample files are provided with this package: +

    The following sample files are provided with this package:

    sample.tex
    General abbreviations. sample-acronym.tex
    Acronyms aren’t initialisms and don’t expand on first use.
    @@ -17672,7 +18132,7 @@ class="description">Another initialisms example. sample-postlink.tex
    Automatically inserting text after the link-text produced by commands like \gls (outside of hyperlink, if present). @@ -17686,47 +18146,65 @@ class="cmbx-10">sample-autoindex.tex
    Using the dualindex and and indexname attributes to + id="dx1-46004"> attributes to automatically add glossary entries to the index (in addition to the glossary location list).
    sample-autoindex-hyp.tex
    As previous but uses hyperref. + id="dx1-46006">.
    sample-nested.tex
    Using \gls within the value of the within the value of the name key. + id="dx1-46008"> key.
    sample-entrycount.tex
    Enable entry-use counting (only index if used more than n times). +class="cmmi-10">n times, see §6.1 Entry Counting (First Use Flag)).
    sample-unitentrycount.tex
    Enable use of per-unit entry-use counting. +class="description">Enable use of per-unit entry-use counting (§6.1 + Entry Counting (First Use Flag)).
    sample-pages.tex
    Insert “page” or “pages” before the location list. +class="cmbx-10">sample-onelink.tex
    Using the per-unit entry counting (§6.1 Entry Counting + (First Use Flag)) to only have one hyperlink per entry per page.
    sample-onelink.tex
    Using the per-unit entry counting to only have one - hyperlink per entry per page. +class="cmbx-10">sample-linkcount.tex
    Using link counting (§6.2 Link Counting) to only have + one hyperlink per entry. +
    +sample-pages.tex
    Insert “page” or “pages” before the location list.
    sample-altmodifier.tex
    \makeglossaries to allow a mixture of \printglossary and \printnoidxglossary. + + +
    sample-external.tex
    Uses the targeturl attribute to allow for entries that + id="dx1-46009"> attribute to allow for entries that should link to an external URL rather than to an internal glossary. - - -
    sample-fmt.tex
    \glsxtrfmt. class="cmbx-10">sample-alias.tex
    Uses the alias key. (See key. (See §10.4 Entry Aliases.) @@ -17772,9 +18250,9 @@ href="#sec:alias">Entry Aliases.) class="cmbx-10">sample-alttree.tex
    Uses the glossaries-extra-stylemods package with the package with the alttree + id="dx1-46012"> style (see §2.9.3 glossaries-extra-stylemods Package

    -

    +

    Top

    13. Multi-Lingual Support

    -

    There’s only one command provided by

    There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname ( (§1.2 New or Modified Package Options) if you use the abbreviations package option to + id="dx1-47002"> package option to automatically create the glossary labelled abbreviations. If this command doesn’t already exist, it will be defined to “Abbreviations” if babel hasn’t + id="dx1-47003"> hasn’t been loaded, otherwise it will be defined as \acronymname (provided by glossaries). -

    You can redefine it in the usual way. For example: +

    You can redefine it in the usual way. For example:

    -
    +
    \renewcommand*{\abbreviationsname}{List of Abbreviations}
    -

    Or using

    Or using babel or or polyglossia captions hook: + id="dx1-47005"> captions hook:

    -
    +
    \appto\captionsenglish{%  
     \renewcommand*{\abbreviationsname}{List of Abbreviations}%  
    }
    -

    -

    Alternatively you can use the

    +

    Alternatively you can use the title key when you print the list of abbreviations. + id="dx1-47006"> key when you print the list of abbreviations. For example:

    -
    +
    \printabbreviations[title={List of Abbreviations}]
    -

    or +

    or

    -
    +
    \printglossary[type=abbreviations,title={List of Abbreviations}]
    -

    -

    The other fixed text commands are the diagnostic messages, which shouldn’t +

    +

    The other fixed text commands are the diagnostic messages, which shouldn’t appear in the final draft of your document. -

    The

    The glossaries-extra package has the facility to load language modules if they exist, but won’t warn if they don’t. -

    If you want to write your own language module, you just need to create a file +

    If you want to write your own language module, you just need to create a file called glossariesxtr-lang.ldf, where ⟨lang⟩ is the language name (see the tracklang + id="dx1-47007"> 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}% @@ -17977,8 +18455,8 @@ class="cmtt-10">glossariesxtr-french.ldf.  
      \glossariesxtrcaptionsfrench  
    }
    -

    -

    You can adapt this for other languages by replacing all instances of the language +

    +

    You can adapt this for other languages by replacing all instances of the language identifier french and the translated text Abr\’eviations as appropriate. This EX’s path so that it can be found by class="cmss-10">glossaries-extra. You might also want to consider uploading it to CTAN so that it can be useful to others. (Please don’t send it to me. I already have more packages than I am able to maintain.) -

    If you additionally want to provide translations for the diagnostic messages used +

    If you additionally want to provide translations for the diagnostic messages used when a glossary is missing, you need to redefine the following commands: -



    \GlsXtrNoGlsWarningHead  \GlsXtrNoGlsWarningHead{label}{file}

    -

    +

    This produces the following text in English:

    -

    This document is incomplete. The external file associated with the +

    This document is incomplete. The external file associated with the glossary ‘⟨label⟩’ (which should be called ⟨file⟩) hasn’t been created.

    -



    \GlsXtrNoGlsWarningEmptyStart  \GlsXtrNoGlsWarningEmptyStart

    -

    +

    This produces the following text in English:

    -

    This has probably happened because there are no entries defined in +

    This has probably happened because there are no entries defined in this glossary.

    -



    \GlsXtrNoGlsWarningEmptyMain  \GlsXtrNoGlsWarningEmptyMain

    -

    +

    This produces the following text in English:

    -

    If you don’t want this glossary, add

    If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:

    -



    \GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain{label}

    -

    +

    This produces the following text in English:

    -

    Did you forget to use

    Did you forget to use type=label⟩ when you defined your entries? If you tried to load entries into this glossary with ] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.

    -



    \GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile{file}

    -

    +

    This produces the following text in English:

    -

    Check the contents of the file ⟨

    Check the contents of the file ⟨file⟩. If it’s empty, that means you haven’t indexed any of your entries in this glossary (using commands like \gls or \glsadd) so this list can’t be generated. If the file isn’t empty, the document build process hasn’t been completed.

    -



    \GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch

    -

    +

    This produces the following text in English:

    -

    You need +

    You need to either replace \makenoidxglossaries with \makeglossaries or @@ -18096,17 +18574,17 @@ class="cmtt-10">\printglossaries) class="cmtt-10">\printnoidxglossary (or \printnoidxglossaries) and then rebuild this document.

    -



    \GlsXtrNoGlsWarningNoOut  \GlsXtrNoGlsWarningNoOut{file}

    -

    +

    This produces the following text in English:

    -

    The file ⟨

    The file ⟨file⟩ doesn’t exist. This most likely means you haven’t used \makeglossaries or you have used \nofiles. If this is just a draft version of the document, you can suppress this message using the nomissingglstext package option.

    -



    \GlsXtrNoGlsWarningTail  \GlsXtrNoGlsWarningTail

    -

    +

    This produces the following text in English:

    -

    This message will be removed once the problem has been fixed.

    -


    This message will be removed once the problem has been fixed.

    +


    \GlsXtrNoGlsWarningBuildInfo  \GlsXtrNoGlsWarningBuildInfo

    -

    +

    This is advice on how to generate the glossary files. See the documented code (glossaries-extra-code.pdf) for further details. -



    \GlsXtrNoGlsWarningAutoMake  \GlsXtrNoGlsWarningAutoMake{label}

    -

    +

    This is the message produced when the automake option is used, but the document + id="dx1-47018"> option is used, but the document needs a rerun or the shell escape setting doesn’t permit the execution of the external application. This command also generates a warning in the transcript file. See the documented code for further details. @@ -18161,22 +18639,22 @@ documented code for further details.

    Top

    Glossary

    + id="x1-4800013">Glossary
    bib2gls
    A command line Java application that selects entries from a .bib file and converts them to glossary definitions (like bibtex but also performs hierarchical sorting and collation, thus omitting the need for xindy or makeindex). Further details at: http://www.dickimaw-books.com/software/bib2gls/. entry location
    The location of the entry in the document. This defaults to the page number on which the entry appears. An entry may have multiple locations. @@ -18194,80 +18672,80 @@ class="description">The location of the entry in the document. This defaults to first use
    The first time a glossary entry is used (from the start of the document or after a reset) with one of the following commands: \gls, , \Gls, , \GLS, + id="dx1-48009">, \glspl, , \Glspl, , \GLSpl or or \glsdisp. + id="dx1-48013">.
    first use flag
    A conditional that determines whether or not the entry has been used according to the rules of first use.
    first use text
    The text that is displayed on first use, which is governed by the + id="dx1-48017">first use, which is governed by the first and and firstplural keys of keys of \newglossaryentry. (May be overridden by + id="dx1-48020">. (May be overridden by \glsdisp.) + id="dx1-48021">.)
    link-text
    The text produced by commands such as \gls. It may or may not + id="dx1-48023">. It may or may not have a hyperlink to the glossary.
    location list
    A list of entry locations. See number list.
    makeglossaries
    A custom designed Perl script interface provided with the glossaries package to run xindy or makeindex according to the document settings. @@ -18277,13 +18755,13 @@ class="cmtt-10">makeindex according to the document makeglossaries-lite
    A custom designed Lua script interface to xindy and makeindex provided with the glossaries package. This is a cut-down alternative to the Perl makeglossaries-lite.exe. makeindex
    An indexing application.
    number list
    A list of entry locations (also called a location list). The number list can be suppressed using the nonumberlist package option. + id="dx1-48037"> package option.
    xindy
    An flexible indexing application with multilingual support written in Perl.

    Index

    + id="x1-4900013">Index

    A

    @@ -18907,7 +19385,7 @@ class="cmss-10">amsgen
    package  298
    \apptoglossarypreamble  299

    B @@ -18919,8 +19397,8 @@ href="glossaries-extra-manual.html#dx1-4139" >302, 303, 304, 305, 306, 307
    +href="glossaries-extra-manual.html#dx1-47003" >306, 307
    bib2gls  308, 317, 318, 319, 320, 321, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362
    +href="glossaries-extra-manual.html#dx1-28005" >329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365
    bib2gls  363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417
    +href="glossaries-extra-manual.html#dx1-3" >366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423

    C categories:
        abbreviation  418, 419, 420, 421
    +href="glossaries-extra-manual.html#dx1-9005" >424, 425, 426, 427, 428
        acronym  422, 423, 424, 425, 426
    +href="glossaries-extra-manual.html#dx1-15021" >429, 430, 431, 432, 433
        general  427, 428, 429, 430, 431, 432, 433, 434
    +href="glossaries-extra-manual.html#dx1-8036" >434, 435, 436, 437, 438, 439, 440, 441
        index  435, 436
    +href="glossaries-extra-manual.html#dx1-5044" >442, 443
        number  437
    +href="glossaries-extra-manual.html#dx1-27018" >444
        symbol  438, 439
    +href="glossaries-extra-manual.html#dx1-8043" >445, 446
    category attributes:
        aposplural  440, 441, 442, 443
    +href="glossaries-extra-manual.html#dx1-10036" >447, 448, 449, 450
        discardperiod  444, 445, 446, 447, 448
    +href="glossaries-extra-manual.html#dx1-8031" >451, 452, 453, 454, 455
        dualindex  449, 450, 451, 452, 453, 454, 455
    +href="glossaries-extra-manual.html#dx1-27114" >456, 457, 458, 459, 460, 461, 462
        entrycount  456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466
    +href="glossaries-extra-manual.html#dx1-9004" >463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473
        externallocation  467
    +href="glossaries-extra-manual.html#dx1-6039" >474
        glossdesc  468, 469, 470
    +href="glossaries-extra-manual.html#dx1-15004" >475, 476, 477
        glossdescfont  471, 472
    +href="glossaries-extra-manual.html#dx1-15005" >478, 479
        glossname  473, 474, 475
    +href="glossaries-extra-manual.html#dx1-15003" >480, 481, 482
        glossnamefont  476, 477, 478
    +href="glossaries-extra-manual.html#dx1-15009" >483, 484, 485
        headuc  479, 480, 481, 482
    +href="glossaries-extra-manual.html#dx1-11059" >486, 487, 488, 489
        hyperoutside  483, 484
    +href="glossaries-extra-manual.html#dx1-6017" >490, 491
        indexname  485, 486, 487, 488, 489
    +href="glossaries-extra-manual.html#dx1-15014" >492, 493, 494, 495, 496
        indexonlyfirst  490, 491, 492
    +href="glossaries-extra-manual.html#dx1-6005" >497, 498, 499
        insertdots  493, 494, 495
    +href="glossaries-extra-manual.html#dx1-18004" >500, 501, 502
    +    linkcount  503, 504, 505
    +    linkcountmaster  506, 507
        markshortwords  496, 497
    +href="glossaries-extra-manual.html#dx1-27061" >508, 509
        markwords  498, 499, 500, 501, 502, 503
    +href="glossaries-extra-manual.html#dx1-24209" >510, 511, 512, 513, 514, 515
    + + +     nohyper  504, 505, 506
    +href="glossaries-extra-manual.html#dx1-27034" >516, 517, 518
        nohyperfirst  507, 508, 509, 510, 511
    - - - +href="glossaries-extra-manual.html#dx1-24145" >519, 520, 521, 522, 523
        noshortplural  512, 513, 514, 515, 516
    +href="glossaries-extra-manual.html#dx1-10037" >524, 525, 526, 527, 528
        pluraldiscardperiod  517, 518
    +href="glossaries-extra-manual.html#dx1-27048" >529, 530
        recordcount  519, 520, 521, 522
    +href="glossaries-extra-manual.html#dx1-37019" >531, 532, 533, 534
        regular  523, 524, 525, 526, 527, 528, 529, 530, 531, 532, 533, 534, 535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554
    +href="glossaries-extra-manual.html#dx1-8010" >535, 536, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546, 547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 565, 566
        retainfirstuseperiod  555
    +href="glossaries-extra-manual.html#dx1-27050" >567
        tagging  556, 557, 558, 559
    +href="glossaries-extra-manual.html#dx1-19002" >568, 569, 570, 571
        targetcategory  560
    +href="glossaries-extra-manual.html#dx1-27123" >572
        targetname  561, 562
    +href="glossaries-extra-manual.html#dx1-27120" >573, 574
        targeturl  563, 564, 565, 566, 567
    +href="glossaries-extra-manual.html#dx1-5014" >575, 576, 577, 578, 579
        textformat  568, 569, 570
    +href="glossaries-extra-manual.html#dx1-6018" >580, 581, 582
        unitcount  571
    +href="glossaries-extra-manual.html#dx1-29034" >583
        wrgloss  572, 573
    +href="glossaries-extra-manual.html#dx1-6013" >584, 585
    \cGLS  574
    +href="glossaries-extra-manual.html#dx1-29015" >586
    \cGLSformat  575
    +href="glossaries-extra-manual.html#dx1-29017" >587
    \cGLSpl  576
    +href="glossaries-extra-manual.html#dx1-29016" >588
    \cGLSplformat  577
    +href="glossaries-extra-manual.html#dx1-29018" >589
    convertgls2bib  578
    +href="glossaries-extra-manual.html#dx1-33005" >590
    \csGlsXtrLetField  579
    +href="glossaries-extra-manual.html#dx1-39025" >591
    \CustomAbbreviationFields  580
    +class="cmti-10">592

    D datatool-base package  581
    +href="glossaries-extra-manual.html#dx1-10" >593

    E \eglssetwidest  582
    +class="cmti-10">594
    \eglsupdatewidest  583
    +class="cmti-10">595
    \eGlsXtrSetField  584
    +href="glossaries-extra-manual.html#dx1-39022" >596
    entry location  585, 586, 587
    +href="glossaries-extra-manual.html#dx1-48005" >597, 598, 599
    entrycounter package  588
    +href="glossaries-extra-manual.html#dx1-41015" >600
    etoolbox package  589, 590, 591, 592, 593, 594, 595, 596
    +href="glossaries-extra-manual.html#dx1-6" >601, 602, 603, 604, 605, 606, 607, 608, 609

    F fancyhdr package  597
    +href="glossaries-extra-manual.html#dx1-13047" >610
    first use  598, 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, 647, 648, 649
    +href="glossaries-extra-manual.html#dx1-6003" >611, 612, 613, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 628, 629, 630, 631, 632, 633, 634, 635, 636, 637, 638, 639, 640, 641, 642, 643, 644, 645, 646, 647, 648, 649, 650, 651, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662
    first use flag  650, 651, 652, 653, 654, 655
    +href="glossaries-extra-manual.html#dx1-8048" >663, 664, 665, 666, 667, 668
    first use text  656, 657
    +href="glossaries-extra-manual.html#dx1-48016" >669, 670
    fontenc package  658
    +href="glossaries-extra-manual.html#dx1-22024" >671

    G -\gglssetwidest  659
    +\gglssetwidest  672
    \gglsupdatewidest  660
    +class="cmti-10">673
    \gGlsXtrSetField  661
    +href="glossaries-extra-manual.html#dx1-39021" >674
    glossaries package  662, 663, 664, 665, 666, 667, 668, 669, 670, 671, 672, 673
    +href="glossaries-extra-manual.html#dx1-5032" >675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686
    glossaries-accsupp package  674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689
    +href="glossaries-extra-manual.html#dx1-4036" >687, 688, 689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702
    glossaries-extra package  690, 691
    +href="glossaries-extra-manual.html#dx1-5034" >703, 704
    glossaries-extra-stylemods package  692, 693, 694, 695, 696, 697, 698
    +href="glossaries-extra-manual.html#dx1-4027" >705, 706, 707, 708, 709, 710, 711
    glossaries-prefix package  699, 700, 701
    +href="glossaries-extra-manual.html#dx1-43001" >712, 713, 714
    \glossariesextrasetup  702
    +class="cmti-10">715
    glossary styles:
        altlist  703
    +href="glossaries-extra-manual.html#dx1-17022" >716
        alttree  704, 705, 706, 707, 708, 709, 710
    +href="glossaries-extra-manual.html#dx1-17032" >717, 718, 719, 720, 721, 722, 723
        bookindex  711, 712, 713, 714
    +href="glossaries-extra-manual.html#dx1-13002" >724, 725, 726, 727
        index  715
    +href="glossaries-extra-manual.html#dx1-17027" >728
        inline  716, 717
    +href="glossaries-extra-manual.html#dx1-17006" >729, 730
        list  718, 719
    +href="glossaries-extra-manual.html#dx1-17018" >731, 732
        listdotted  720
    +href="glossaries-extra-manual.html#dx1-17023" >733
        long  721
    +href="glossaries-extra-manual.html#dx1-17012" >734
        long3col  722
    +href="glossaries-extra-manual.html#dx1-17004" >735
        mcolindexgroup  723
    +href="glossaries-extra-manual.html#dx1-13003" >736
        tree  724
    +href="glossaries-extra-manual.html#dx1-17028" >737
    glossary-bookindex package  725, 726
    +href="glossaries-extra-manual.html#dx1-13001" >738, 739
    glossary-inline package  727
    +href="glossaries-extra-manual.html#dx1-17007" >740
    glossary-tree package  728, 729, 730, 731
    +href="glossaries-extra-manual.html#dx1-13040" >741, 742, 743, 744
    \glossentrynameother  732
    +class="cmti-10">745
    \glossxtrsetpopts  733
    +class="cmti-10">746
    \glsabbrvdefaultfont  734, 747, 735
    +class="cmti-10">748
    \glsabbrvemfont  736
    +class="cmti-10">749
    \glsabbrvfont  737
    +class="cmti-10">750
    \glsabbrvhyphenfont  738
    +class="cmti-10">751
    \glsabbrvonlyfont  739
    +class="cmti-10">752
    \glsabbrvscfont  740
    +class="cmti-10">753
    \glsabbrvsmfont  741
    +class="cmti-10">754
    \glsabbrvuserfont  742, 755, 743
    +class="cmti-10">756
    \Glsaccessdesc  744
    +href="glossaries-extra-manual.html#dx1-45039" >757
    \glsaccessdesc  745
    +href="glossaries-extra-manual.html#dx1-45037" >758
    \Glsaccessdescplural  746
    +href="glossaries-extra-manual.html#dx1-45043" >759
    \glsaccessdescplural  747
    +href="glossaries-extra-manual.html#dx1-45041" >760
    \Glsaccessfirst  748
    +href="glossaries-extra-manual.html#dx1-45023" >761
    \glsaccessfirst  749
    +href="glossaries-extra-manual.html#dx1-45021" >762
    \Glsaccessfirstplural  750
    +href="glossaries-extra-manual.html#dx1-45027" >763
    \glsaccessfirstplural  751
    +href="glossaries-extra-manual.html#dx1-45025" >764
    \Glsaccesslong  752
    +href="glossaries-extra-manual.html#dx1-45055" >765
    \glsaccesslong  753
    +href="glossaries-extra-manual.html#dx1-45053" >766
    + + + \Glsaccesslongpl  754
    +href="glossaries-extra-manual.html#dx1-45059" >767
    \glsaccesslongpl  755
    +href="glossaries-extra-manual.html#dx1-45057" >768
    \Glsaccessname  756
    - - - +href="glossaries-extra-manual.html#dx1-45010" >769
    \glsaccessname  757
    +href="glossaries-extra-manual.html#dx1-45005" >770
    \Glsaccessplural  758
    +href="glossaries-extra-manual.html#dx1-45019" >771
    \glsaccessplural  759
    +href="glossaries-extra-manual.html#dx1-45017" >772
    \Glsaccessshort  760
    +href="glossaries-extra-manual.html#dx1-45047" >773
    \glsaccessshort  761
    +href="glossaries-extra-manual.html#dx1-45045" >774
    \Glsaccessshortpl  762
    +href="glossaries-extra-manual.html#dx1-45051" >775
    \glsaccessshortpl  763
    +href="glossaries-extra-manual.html#dx1-45049" >776
    \Glsaccesssymbol  764
    +href="glossaries-extra-manual.html#dx1-45031" >777
    \glsaccesssymbol  765
    +href="glossaries-extra-manual.html#dx1-45029" >778
    \Glsaccesssymbolplural  766
    +href="glossaries-extra-manual.html#dx1-45035" >779
    \glsaccesssymbolplural  767
    +href="glossaries-extra-manual.html#dx1-45033" >780
    \Glsaccesstext  768
    +href="glossaries-extra-manual.html#dx1-45015" >781
    \glsaccesstext  769
    +href="glossaries-extra-manual.html#dx1-45013" >782
    \glsacspace  770
    +class="cmti-10">783
    \glsacspacemax  771
    +class="cmti-10">784
    \glsadd options
        format  772
    +href="glossaries-extra-manual.html#dx1-8071" >785
        theHvalue  773, 774
    +href="glossaries-extra-manual.html#dx1-6024" >786, 787
        thevalue  775, 776, 777, 778, 779
    +href="glossaries-extra-manual.html#dx1-6023" >788, 789, 790, 791, 792
    \glscategory  780
    +class="cmti-10">793
    \glscategorylabel  781
    +class="cmti-10">794
    \glscurrententrylabel  782
    +class="cmti-10">795
    \glscurrentfieldvalue  783
    +href="glossaries-extra-manual.html#dx1-39029" >796
    \glsentrycurrcount  784
    +href="glossaries-extra-manual.html#dx1-29035" >797
    \glsentryprevcount  785
    +href="glossaries-extra-manual.html#dx1-29036" >798
    \glsentryprevmaxcount  786
    +href="glossaries-extra-manual.html#dx1-29038" >799
    \glsentryprevtotalcount  787
    +href="glossaries-extra-manual.html#dx1-29037" >800
    \glsextrapostnamehook  788
    +class="cmti-10">801
    \glsFindWidestAnyName  789
    +class="cmti-10">802
    \glsFindWidestAnyNameLocation  790
    +class="cmti-10">803
    \glsFindWidestAnyNameSymbol  791
    +class="cmti-10">804
    \glsFindWidestAnyNameSymbolLocation  792
    +class="cmti-10">805
    \glsFindWidestLevelTwo  793
    +class="cmti-10">806
    \glsFindWidestTopLevelName  794
    +class="cmti-10">807
    \glsFindWidestUsedAnyName  795
    +class="cmti-10">808
    \glsFindWidestUsedAnyNameLocation  796
    +class="cmti-10">809
    \glsFindWidestUsedAnyNameSymbol  797
    +class="cmti-10">810
    \glsFindWidestUsedAnyNameSymbolLocation  798
    +class="cmti-10">811
    \glsFindWidestUsedLevelTwo  799
    +class="cmti-10">812
    \glsFindWidestUsedTopLevelName  800
    +class="cmti-10">813
    \glsfirstabbrvdefaultfont  801
    +class="cmti-10">814
    \glsfirstabbrvemfont  802
    +class="cmti-10">815
    \glsfirstabbrvfont  803
    +class="cmti-10">816
    + + + \glsfirstabbrvhyphenfont  804
    +class="cmti-10">817
    \glsfirstabbrvonlyfont  805
    +class="cmti-10">818
    \glsfirstabbrvsmfont  806
    - - - +class="cmti-10">819
    \glsfirstabbrvuserfont  807
    +class="cmti-10">820
    \glsfirstlongdefaultfont  808
    +class="cmti-10">821
    \glsfirstlongemfont  809
    +class="cmti-10">822
    \glsfirstlongfont  810
    +class="cmti-10">823
    \glsfirstlongfootnotefont  811
    +class="cmti-10">824
    \glsfirstlonghyphenfont  812
    +class="cmti-10">825
    \glsfirstlongonlyfont  813
    +class="cmti-10">826
    \glsfirstlonguserfont  814
    +class="cmti-10">827
    \Glsfmtfirst  815
    +class="cmti-10">828
    \glsfmtfirst  816
    +class="cmti-10">829
    \Glsfmtfirstpl  817
    +class="cmti-10">830
    \glsfmtfirstpl  818
    +class="cmti-10">831
    \Glsfmtfull  819
    +class="cmti-10">832
    \glsfmtfull  820
    +class="cmti-10">833
    \Glsfmtfullpl  821
    +class="cmti-10">834
    \glsfmtfullpl  822
    +class="cmti-10">835
    \Glsfmtlong  823
    +class="cmti-10">836
    \glsfmtlong  824
    +class="cmti-10">837
    \Glsfmtlongpl  825
    +class="cmti-10">838
    \glsfmtlongpl  826
    +class="cmti-10">839
    \Glsfmtname  827
    +class="cmti-10">840
    \glsfmtname  828
    +class="cmti-10">841
    \Glsfmtplural  829
    +class="cmti-10">842
    \glsfmtplural  830
    +class="cmti-10">843
    \Glsfmtshort  831
    +class="cmti-10">844
    \glsfmtshort  832
    +class="cmti-10">845
    \Glsfmtshortpl  833
    +class="cmti-10">846
    \glsfmtshortpl  834
    +class="cmti-10">847
    \Glsfmttext  835
    +class="cmti-10">848
    \glsfmttext  836
    +class="cmti-10">849
    \glsforeachwithattribute  837
    +href="glossaries-extra-manual.html#dx1-27147" >850
    \glsgetattribute  838
    +href="glossaries-extra-manual.html#dx1-27130" >851
    \glsgetcategoryattribute  839
    +href="glossaries-extra-manual.html#dx1-27129" >852
    \glsgetwidestname  840
    +class="cmti-10">853
    \glsgetwidestsubname  841
    +class="cmti-10">854
    \glshasattribute  842
    +href="glossaries-extra-manual.html#dx1-27133" >855
    \glshascategoryattribute  843
    +href="glossaries-extra-manual.html#dx1-27131" >856
    \glshex  844
    +href="glossaries-extra-manual.html#dx1-36003" >857
    \glsifattribute  845
    +href="glossaries-extra-manual.html#dx1-27138" >858
    \glsifcategory  846
    +class="cmti-10">859
    \glsifcategoryattribute  847
    +href="glossaries-extra-manual.html#dx1-27134" >860
    \glsifnotregular  848
    +href="glossaries-extra-manual.html#dx1-27145" >861
    \glsifnotregularcategory  849
    +href="glossaries-extra-manual.html#dx1-27144" >862
    + + + \glsifregular  850
    +href="glossaries-extra-manual.html#dx1-27141" >863
    \glsifregularcategory  851
    +href="glossaries-extra-manual.html#dx1-27140" >864
    \glskeylisttok  852
    - - - +class="cmti-10">865
    \glslabeltok  853
    +class="cmti-10">866
    \glslink options
        format  854, 855, 856, 857
    +href="glossaries-extra-manual.html#dx1-6036" >867, 868, 869, 870
        hyper  858, 859, 860
    +href="glossaries-extra-manual.html#dx1-11055" >871, 872, 873
        hyper=false  861
    +href="glossaries-extra-manual.html#dx1-26016" >874
        hyperoutside  862, 863
    +href="glossaries-extra-manual.html#dx1-6016" >875, 876
        noindex  864, 865, 866, 867, 868, 869, 870
    +href="glossaries-extra-manual.html#dx1-6001" >877, 878, 879, 880, 881, 882, 883
        theHvalue  871
    +href="glossaries-extra-manual.html#dx1-6027" >884
        thevalue  872
    +href="glossaries-extra-manual.html#dx1-6026" >885
        wrgloss  873, 874, 875, 876
    +href="glossaries-extra-manual.html#dx1-6009" >886, 887, 888, 889
    \glslinkcheckfirsthyperhook  877
    +href="glossaries-extra-manual.html#dx1-29042" >890
    +\glslinkpresetkeys  891
    \glslistchildpostlocation  878
    +class="cmti-10">892
    \glslistchildprelocation  879
    +class="cmti-10">893
    +\glslistprelocation  894
    \glslongdefaultfont  880
    +class="cmti-10">895
    \glslongemfont  881
    +class="cmti-10">896
    \glslongfont  882
    +class="cmti-10">897
    \glslongfootnotefont  883
    +class="cmti-10">898
    \glslonghyphenfont  884
    +class="cmti-10">899
    \glslongonlyfont  885
    +class="cmti-10">900
    \glslongpltok  886
    +class="cmti-10">901
    \glslongtok  887
    +class="cmti-10">902
    \glslonguserfont  888
    +class="cmti-10">903
    \glsnoidxdisplayloc  889
    +class="cmti-10">904
    \glsps  890
    +class="cmti-10">905
    \glspt  891
    +class="cmti-10">906
    \glsseeitemformat  892
    +class="cmti-10">907
    \glssetattribute  893
    +href="glossaries-extra-manual.html#dx1-27128" >908
    \glssetcategoryattribute  894
    +href="glossaries-extra-manual.html#dx1-27125" >909
    \glssetregularcategory  895
    +href="glossaries-extra-manual.html#dx1-27127" >910
    \glsshortpltok  896
    +class="cmti-10">911
    \glsshorttok  897
    +class="cmti-10">912
    \glstreechildprelocation  898
    +class="cmti-10">913
    \glstreeprelocation  899
    +class="cmti-10">914
    \glsupdatewidest  900
    +class="cmti-10">915
    \glsuseabbrvfont  901
    +class="cmti-10">916
    \glsuselongfont  902
    +class="cmti-10">917
    \Glsxtr  903
    +href="glossaries-extra-manual.html#dx1-32014" >918
    \glsxtr  904
    +href="glossaries-extra-manual.html#dx1-32009" >919
    \glsxtrabbrvfootnote  905
    +class="cmti-10">920
    \glsxtrabbrvpluralsuffix  906, 921, 907
    +class="cmti-10">922
    \glsxtractivatenopost  908
    +href="glossaries-extra-manual.html#dx1-41010" >923
    + + + \glsxtraddallcrossrefs  909
    +class="cmti-10">924
    \glsxtralias  910
    +href="glossaries-extra-manual.html#dx1-42021" >925
    \glsxtrAltTreeIndent  911
    +class="cmti-10">926
    \glsxtralttreeInit  912
    +class="cmti-10">927
    \glsxtralttreeSubSymbolDescLocation  913
    - - - +class="cmti-10">928
    \glsxtralttreeSymbolDescLocation  914
    +class="cmti-10">929
    \glsxtrautoindex  915
    +href="glossaries-extra-manual.html#dx1-31015" >930
    \glsxtrautoindexassignsort  916
    +href="glossaries-extra-manual.html#dx1-31013" >931
    \glsxtrautoindexentry  917
    +href="glossaries-extra-manual.html#dx1-31012" >932
    \glsxtrbookindexatendgroup  918
    +class="cmti-10">933
    \glsxtrbookindexbetween  919
    +class="cmti-10">934
    \glsxtrbookindexbookmark  920
    +class="cmti-10">935
    \glsxtrbookindexcols  921
    +class="cmti-10">936
    \glsxtrbookindexcolspread  922
    +class="cmti-10">937
    \glsxtrbookindexfirstmark  923
    +class="cmti-10">938
    \glsxtrbookindexfirstmarkfmt  924
    +class="cmti-10">939
    \glsxtrbookindexformatheader  925
    +class="cmti-10">940
    \glsxtrbookindexlastmark  926
    +class="cmti-10">941
    \glsxtrbookindexlastmarkfmt  927
    +class="cmti-10">942
    \glsxtrbookindexmarkentry  928
    +class="cmti-10">943
    \glsxtrbookindexmulticolsenv  929
    +class="cmti-10">944
    \glsxtrbookindexname  930
    +class="cmti-10">945
    \glsxtrbookindexparentchildsep  931
    +class="cmti-10">946
    \glsxtrbookindexparentsubchildsep  932
    +class="cmti-10">947
    \glsxtrbookindexprelocation  933
    +class="cmti-10">948
    \glsxtrbookindexsubatendgroup  934
    +class="cmti-10">949
    \glsxtrbookindexsubbetween  935
    +class="cmti-10">950
    \glsxtrbookindexsubname  936
    +class="cmti-10">951
    \glsxtrbookindexsubprelocation  937
    +class="cmti-10">952
    \glsxtrbookindexsubsubatendgroup  938
    +class="cmti-10">953
    \glsxtrbookindexsubsubbetween  939
    +class="cmti-10">954
    \glsxtrchecknohyperfirst  940
    +class="cmti-10">955
    \glsxtrcopytoglossary  941
    +href="glossaries-extra-manual.html#dx1-38007" >956
    \glsxtrdeffield  942
    +href="glossaries-extra-manual.html#dx1-39018" >957
    \glsxtrdetoklocation  943
    +href="glossaries-extra-manual.html#dx1-37007" >958
    \glsxtrdisplayendloc  944
    +class="cmti-10">959
    \glsxtrdisplayendlochook  945
    +class="cmti-10">960
    \glsxtrdisplaysingleloc  946
    +class="cmti-10">961
    \glsxtrdisplaystartloc  947
    +class="cmti-10">962
    \glsxtrdoautoindexname  948
    +href="glossaries-extra-manual.html#dx1-31009" >963
    \glsxtrdowrglossaryhook  949
    +class="cmti-10">964
    \glsxtredeffield  950
    +href="glossaries-extra-manual.html#dx1-39020" >965
    \glsxtremsuffix  951
    +class="cmti-10">966
    \GlsXtrEnableEntryCounting  952
    +href="glossaries-extra-manual.html#dx1-29027" >967
    \GlsXtrEnableEntryUnitCounting  953
    +href="glossaries-extra-manual.html#dx1-29030" >968
    \GlsXtrEnableIndexFormatOverride  954
    +href="glossaries-extra-manual.html#dx1-31024" >969
    + + + \GlsXtrEnableInitialTagging  955
    +class="cmti-10">970
    +\GlsXtrEnableLinkCounting  971
    \GlsXtrEnableOnTheFly  956
    +href="glossaries-extra-manual.html#dx1-32007" >972
    \GlsXtrEnablePreLocationTag  957
    +class="cmti-10">973
    \glsxtrenablerecordcount  958
    +href="glossaries-extra-manual.html#dx1-37037" >974
    \glsxtrendfor  959
    - - - +href="glossaries-extra-manual.html#dx1-39055" >975
    \glsxtrentryfmt  960
    +href="glossaries-extra-manual.html#dx1-39008" >976
    \glsxtrfielddolistloop  961
    +href="glossaries-extra-manual.html#dx1-39045" >977
    \glsxtrfieldforlistloop  962
    +href="glossaries-extra-manual.html#dx1-39046" >978
    \glsxtrfieldifinlist  963
    +href="glossaries-extra-manual.html#dx1-39047" >979
    \glsxtrfieldlistadd  964
    +href="glossaries-extra-manual.html#dx1-39041" >980
    \glsxtrfieldlisteadd  965
    +href="glossaries-extra-manual.html#dx1-39043" >981
    \glsxtrfieldlistgadd  966
    +href="glossaries-extra-manual.html#dx1-39042" >982
    \glsxtrfieldlistxadd  967
    +href="glossaries-extra-manual.html#dx1-39044" >983
    \glsxtrfieldtitlecasecs  968
    +href="glossaries-extra-manual.html#dx1-27099" >984
    \glsxtrfieldxifinlist  969
    +href="glossaries-extra-manual.html#dx1-39048" >985
    \glsxtrfmt  970
    +href="glossaries-extra-manual.html#dx1-39002" >986
    \glsxtrfmt*  971
    +href="glossaries-extra-manual.html#dx1-39004" >987
    \GlsXtrFmtDefaultOptions  972
    +href="glossaries-extra-manual.html#dx1-39003" >988
    \glsxtrfmtdisplay  973
    +href="glossaries-extra-manual.html#dx1-39005" >989
    \GlsXtrFmtField  974
    +href="glossaries-extra-manual.html#dx1-39001" >990
    \glsxtrfootnotename  975
    +class="cmti-10">991
    \glsxtrforcsvfield  976
    +href="glossaries-extra-manual.html#dx1-39050" >992
    \GlsXtrFormatLocationList  977
    +class="cmti-10">993
    \GLSxtrfull  978
    +class="cmti-10">994
    \Glsxtrfull  979
    +class="cmti-10">995
    \glsxtrfull  980
    +class="cmti-10">996
    \Glsxtrfullformat  981
    +class="cmti-10">997
    \glsxtrfullformat  982
    +class="cmti-10">998
    \GLSxtrfullpl  983
    +class="cmti-10">999
    \Glsxtrfullpl  984
    +class="cmti-10">1000
    \glsxtrfullpl  985
    +class="cmti-10">1001
    \Glsxtrfullplformat  986
    +class="cmti-10">1002
    \glsxtrfullplformat  987
    +class="cmti-10">1003
    \glsxtrfullsep  988
    +class="cmti-10">1004
    \glsxtrglossentry  989
    +href="glossaries-extra-manual.html#dx1-41004" >1005
    \glsxtrglossentryother  990
    +href="glossaries-extra-manual.html#dx1-41012" >1006
    \glsxtrhyphensuffix  991
    +class="cmti-10">1007
    \glsxtrifcounttrigger  992
    +href="glossaries-extra-manual.html#dx1-29021" >1008
    \glsxtrifcustomdiscardperiod  993
    +class="cmti-10">1009
    \GlsXtrIfFieldEqStr  994
    +href="glossaries-extra-manual.html#dx1-39033" >1010
    \GlsXtrIfFieldUndef  995
    +href="glossaries-extra-manual.html#dx1-39032" >1011
    \glsxtrifhasfield  996
    +href="glossaries-extra-manual.html#dx1-39028" >1012
    \glsxtrifhasfield*  997
    +href="glossaries-extra-manual.html#dx1-39030" >1013
    \glsxtrifkeydefined  998
    +href="glossaries-extra-manual.html#dx1-39010" >1014
    \glsxtriflabelinlist  999
    +href="glossaries-extra-manual.html#dx1-40027" >1015
    + + + +\GlsXtrIfLinkCounterDef  1016
    \glsxtrifrecordtrigger  1000
    +href="glossaries-extra-manual.html#dx1-37022" >1017
    \glsxtrifwasfirstuse  1001
    +class="cmti-10">1018
    +\glsxtrinclinkcounter  1019
    \glsxtrindexaliased  1002
    +href="glossaries-extra-manual.html#dx1-42019" >1020
    \glsxtrindexseealso  1003
    +class="cmti-10">1021
    \glsxtrinitwrgloss  1004
    +class="cmti-10">1022
    \Glsxtrinlinefullformat  1005
    - - - +class="cmti-10">1023
    \glsxtrinlinefullformat  1006
    +class="cmti-10">1024
    \Glsxtrinlinefullplformat  1007
    +class="cmti-10">1025
    \glsxtrinlinefullplformat  1008
    +class="cmti-10">1026
    \glsxtrinsertinsidetrue  1009
    +class="cmti-10">1027
    \GlsXtrLetField  1010
    +href="glossaries-extra-manual.html#dx1-39024" >1028
    \GlsXtrLetFieldToField  1011
    +href="glossaries-extra-manual.html#dx1-39026" >1029
    +\GlsXtrLinkCounterName  1030
    +\GlsXtrLinkCounterValue  1031
    \GlsXtrLoadResources  1012
    +href="glossaries-extra-manual.html#dx1-33026" >1032
    \glsxtrlocalsetgrouptitle  1013
    +class="cmti-10">1033
    \GlsXtrLocationRecordCount  1014
    +href="glossaries-extra-manual.html#dx1-37012" >1034
    \glsxtrlocrangefmt  1015
    +class="cmti-10">1035
    \Glsxtrlong  1016, 1036, 1017
    +class="cmti-10">1037
    \glsxtrlong  1018
    +class="cmti-10">1038
    \glsxtrlonghyphen  1019
    +class="cmti-10">1039
    \glsxtrlonghyphenshort  1020
    +class="cmti-10">1040
    \glsxtrlongnoshortdescname  1021
    +class="cmti-10">1041
    \glsxtrlongnoshortname  1022
    +class="cmti-10">1042
    \GLSxtrlongpl  1023
    +class="cmti-10">1043
    \Glsxtrlongpl  1024
    +class="cmti-10">1044
    \glsxtrlongpl  1025
    +class="cmti-10">1045
    \glsxtrlongshortdescname  1026
    +class="cmti-10">1046
    \glsxtrlongshortdescsort  1027
    +class="cmti-10">1047
    \glsxtrlongshortname  1028
    +class="cmti-10">1048
    \glsxtrlongshortuserdescname  1029
    +class="cmti-10">1049
    \glsxtrnewgls  1030
    +href="glossaries-extra-manual.html#dx1-36007" >1050
    \glsxtrnewGLSlike  1031
    +href="glossaries-extra-manual.html#dx1-36009" >1051
    \glsxtrnewglslike  1032
    +href="glossaries-extra-manual.html#dx1-36008" >1052
    \glsxtrnewnumber  1033
    +class="cmti-10">1053
    \glsxtrnewrgls  1034
    +href="glossaries-extra-manual.html#dx1-36010" >1054
    \glsxtrnewrGLSlike  1035
    +href="glossaries-extra-manual.html#dx1-36012" >1055
    \glsxtrnewrglslike  1036
    +href="glossaries-extra-manual.html#dx1-36011" >1056
    \glsxtrnewsymbol  1037
    +class="cmti-10">1057
    \GlsXtrNoGlsWarningAutoMake  1038
    +href="glossaries-extra-manual.html#dx1-47017" >1058
    \GlsXtrNoGlsWarningBuildInfo  1039
    +href="glossaries-extra-manual.html#dx1-47016" >1059
    \GlsXtrNoGlsWarningCheckFile  1040
    +href="glossaries-extra-manual.html#dx1-47012" >1060
    \GlsXtrNoGlsWarningEmptyMain  1041
    +href="glossaries-extra-manual.html#dx1-47010" >1061
    \GlsXtrNoGlsWarningEmptyNotMain  1042
    +href="glossaries-extra-manual.html#dx1-47011" >1062
    + + + \GlsXtrNoGlsWarningEmptyStart  1043
    +href="glossaries-extra-manual.html#dx1-47009" >1063
    \GlsXtrNoGlsWarningHead  1044
    +href="glossaries-extra-manual.html#dx1-47008" >1064
    \GlsXtrNoGlsWarningMisMatch  1045
    +href="glossaries-extra-manual.html#dx1-47013" >1065
    \GlsXtrNoGlsWarningNoOut  1046
    +href="glossaries-extra-manual.html#dx1-47014" >1066
    \GlsXtrNoGlsWarningTail  1047
    +href="glossaries-extra-manual.html#dx1-47015" >1067
    \glsxtrnopostpunc  1048
    +class="cmti-10">1068
    \glsxtronlydescname  1049
    +class="cmti-10">1069
    \glsxtronlyname  1050
    +class="cmti-10">1070
    \glsxtronlysuffix  1051
    +class="cmti-10">1071
    \glsxtrorglong  1052
    - - - +class="cmti-10">1072
    \glsxtrorgshort  1053
    +class="cmti-10">1073
    \Glsxtrp  1054, 1074, 1055
    +class="cmti-10">1075
    \glsxtrp  1056
    +class="cmti-10">1076
    \glsxtrpageref  1057
    +href="glossaries-extra-manual.html#dx1-38004" >1077
    \glsxtrparen  1058
    +class="cmti-10">1078
    \Glsxtrpl  1059
    +href="glossaries-extra-manual.html#dx1-32015" >1079
    \glsxtrpl  1060
    +href="glossaries-extra-manual.html#dx1-32013" >1080
    \glsxtrpostdescription  1061
    +class="cmti-10">1081
    \glsxtrposthyphenlong  1062
    +class="cmti-10">1082
    \glsxtrposthyphenshort  1063
    +class="cmti-10">1083
    \glsxtrpostlink  1064
    +class="cmti-10">1084
    \glsxtrpostlinkAddDescOnFirstUse  1065
    +class="cmti-10">1085
    \glsxtrpostlinkAddSymbolOnFirstUse  1066
    +class="cmti-10">1086
    \glsxtrpostlinkendsentence  1067
    +class="cmti-10">1087
    \glsxtrpostlinkhook  1068
    +class="cmti-10">1088
    \glsxtrpostlongdescription  1069
    +class="cmti-10">1089
    \glsxtrpostnamehook  1070
    +class="cmti-10">1090
    \GlsXtrPostNewAbbreviation  1071
    +class="cmti-10">1091
    \glsxtrprelocation  1072, 1073
    +class="cmti-10">1092
    \glsxtrprovidestoragekey  1074
    +href="glossaries-extra-manual.html#dx1-39009" >1093
    \GlsXtrRecordCount  1075
    +href="glossaries-extra-manual.html#dx1-37011" >1094
    \GlsXtrRecordCounter  1076
    +href="glossaries-extra-manual.html#dx1-39057" >1095
    \glsxtrrecordtriggervalue  1077
    +href="glossaries-extra-manual.html#dx1-37024" >1096
    \glsxtrregularfont  1078
    +class="cmti-10">1097
    \glsxtrresourcefile  1079
    +href="glossaries-extra-manual.html#dx1-33025" >1098
    \glsxtrresourceinit  1080
    +href="glossaries-extra-manual.html#dx1-36006" >1099
    \glsxtrrestorepostpunc  1081
    +class="cmti-10">1100
    \glsxtrRevertMarks  1082
    +class="cmti-10">1101
    \glsxtrscsuffix  1083
    +class="cmti-10">1102
    \glsxtrseealsolabels  1084
    +class="cmti-10">1103
    \glsxtrseelist  1085
    +class="cmti-10">1104
    \GlsXtrSetActualChar  1086
    +href="glossaries-extra-manual.html#dx1-31040" >1105
    \glsxtrsetaliasnoindex  1087
    +href="glossaries-extra-manual.html#dx1-42016" >1106
    \GlsXtrSetAltModifier  1088
    +class="cmti-10">1107
    \glsxtrsetcategory  1089
    +href="glossaries-extra-manual.html#dx1-27149" >1108
    \glsxtrsetcategoryforall  1090
    +href="glossaries-extra-manual.html#dx1-27151" >1109
    + + + \GlsXtrSetDefaultGlsOpts  1091
    +class="cmti-10">1110
    \GlsXtrSetEncapChar  1092
    +href="glossaries-extra-manual.html#dx1-31043" >1111
    \GlsXtrSetEscChar  1093
    +href="glossaries-extra-manual.html#dx1-31042" >1112
    \GlsXtrSetField  1094
    +href="glossaries-extra-manual.html#dx1-39014" >1113
    \glsxtrsetfieldifexists  1095
    +href="glossaries-extra-manual.html#dx1-39015" >1114
    \glsxtrsetgrouptitle  1096
    +class="cmti-10">1115
    \GlsXtrSetLevelChar  1097
    +href="glossaries-extra-manual.html#dx1-31041" >1116
    \glsxtrsetpopts  1098
    +class="cmti-10">1117
    \GlsXtrSetRecordCountAttribute  1099
    +href="glossaries-extra-manual.html#dx1-37020" >1118
    \Glsxtrshort  1100, 1119, 1101
    - - - +class="cmti-10">1120
    \glsxtrshort  1102
    +class="cmti-10">1121
    \glsxtrshortdescname  1103
    +class="cmti-10">1122
    \glsxtrshorthyphenlong  1104
    +class="cmti-10">1123
    \glsxtrshortlongdescname  1105
    +class="cmti-10">1124
    \glsxtrshortlongname  1106, 1125, 1107
    +class="cmti-10">1126
    \glsxtrshortlonguserdescname  1108
    +class="cmti-10">1127
    \glsxtrshortnolongname  1109
    +class="cmti-10">1128
    \GLSxtrshortpl  1110
    +class="cmti-10">1129
    \Glsxtrshortpl  1111
    +class="cmti-10">1130
    \glsxtrshortpl  1112
    +class="cmti-10">1131
    \glsxtrsmsuffix  1113
    +class="cmti-10">1132
    \Glsxtrsubsequentfmt  1114
    +class="cmti-10">1133
    \glsxtrsubsequentfmt  1115
    +class="cmti-10">1134
    \Glsxtrsubsequentplfmt  1116
    +class="cmti-10">1135
    \glsxtrsubsequentplfmt  1117
    +class="cmti-10">1136
    \glsxtrtagfont  1118
    +class="cmti-10">1137
    +\GlsXtrTheLinkCounter  1138
    \GlsXtrTotalRecordCount  1119
    +href="glossaries-extra-manual.html#dx1-37010" >1139
    \glsxtrunsrtdo  1120
    +href="glossaries-extra-manual.html#dx1-40023" >1140
    \GlsXtrUseAbbrStyleFmts  1121
    +class="cmti-10">1141
    \GlsXtrUseAbbrStyleSetup  1122
    +class="cmti-10">1142
    \Glsxtrusefield  1123
    +href="glossaries-extra-manual.html#dx1-39038" >1143
    \glsxtrusefield  1124
    +href="glossaries-extra-manual.html#dx1-39036" >1144
    \glsxtruserfield  1125
    +class="cmti-10">1145
    \glsxtruserparen  1126
    +class="cmti-10">1146
    \glsxtrusersuffix  1127, 1147, 1128
    +class="cmti-10">1148
    \glsxtrusesee  1129
    +class="cmti-10">1149
    \glsxtruseseealso  1130
    +class="cmti-10">1150
    \glsxtruseseeformat  1131, 1151, 1132
    +class="cmti-10">1152
    \GlsXtrWarnDeprecatedAbbrStyle  1133
    +class="cmti-10">1153
    \GlsXtrWarning  1134
    +href="glossaries-extra-manual.html#dx1-32011" >1154
    \glsxtrword  1135
    +class="cmti-10">1155
    \glsxtrwordsep  1136
    +class="cmti-10">1156
    \glsxtrwrglossmark  1137
    +class="cmti-10">1157

    H + + + hyperref package  1138, 1139, 1140, 1141, 1142, 1143, 1144, 1145, 1146, 1147, 1148, 1149, 1150, 1151, 1152, 1153, 1154, 1155, 1156, 1157
    +href="glossaries-extra-manual.html#dx1-6035" >1158, 1159, 1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177

    I \ifglsxtrinitwrglossbefore  1158
    +class="cmti-10">1178
    inputenc package  1159
    +href="glossaries-extra-manual.html#dx1-35018" >1179

    L link-text  1160, 1161, 1162, 1163, 1164, 1165, 1166, 1167, 1168, 1169, 1170, 1171, 1172, 1173, 1174, 1175, 1176, 1177, 1178
    - - - +href="glossaries-extra-manual.html#dx1-8001" >1180, 1181, 1182, 1183, 1184, 1185, 1186, 1187, 1188, 1189, 1190, 1191, 1192, 1193, 1194, 1195, 1196, 1197, 1198, 1199
    location list  1179, 1180, 1181, 1182, 1183
    +href="glossaries-extra-manual.html#dx1-8074" >1200, 1201, 1202, 1203, 1204
    \longnewglossaryentry  1184
    +class="cmti-10">1205

    M makeglossaries  1185, 1186, 1187, 1188, 1189
    +href="glossaries-extra-manual.html#dx1-3027" >1206, 1207, 1208, 1209, 1210
    \makeglossaries  1190
    +class="cmti-10">1211
    makeglossaries-lite  1191, 1192
    +href="glossaries-extra-manual.html#dx1-5052" >1212, 1213
    makeglossaries-lite  1193, 1194
    +href="glossaries-extra-manual.html#dx1-5053" >1214, 1215
    makeindex  1195, 1196, 1197, 1198, 1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207
    +href="glossaries-extra-manual.html#dx1-3022" >1216, 1217, 1218, 1219, 1220, 1221, 1222, 1223, 1224, 1225, 1226, 1227, 1228
    makeindex  1208, 1209, 1210, 1211
    +href="glossaries-extra-manual.html#dx1-6030" >1229, 1230, 1231, 1232
    memoir class  1212
    +href="glossaries-extra-manual.html#dx1-3021" >1233
    mfirstuc package  1213, 1214, 1215
    +href="glossaries-extra-manual.html#dx1-5" >1234, 1235, 1236

    N \newabbreviation  1216
    +class="cmti-10">1237
    \newabbreviationstyle  1217
    +class="cmti-10">1238
    \newacronym  1218
    +class="cmti-10">1239
    \newglossaryentry options
        alias  1219, 1220, 1221, 1222, 1223, 1224
    +href="glossaries-extra-manual.html#dx1-5021" >1240, 1241, 1242, 1243, 1244, 1245
        category  1225, 1226, 1227, 1228, 1229, 1230
    +href="glossaries-extra-manual.html#dx1-5020" >1246, 1247, 1248, 1249, 1250, 1251
        desc  1231, 1232
    +href="glossaries-extra-manual.html#dx1-45038" >1252, 1253
        descplural  1233, 1234
    +href="glossaries-extra-manual.html#dx1-45042" >1254, 1255
        description  1235, 1236, 1237, 1238, 1239, 1240, 1241, 1242, 1243, 1244, 1245, 1246, 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
    +href="glossaries-extra-manual.html#dx1-5002" >1256, 1257, 1258, 1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271, 1272, 1273, 1274, 1275
        descriptionplural  1255, 1256, 1257, 1258
    +href="glossaries-extra-manual.html#dx1-5030" >1276, 1277, 1278, 1279
        first  1259, 1260, 1261, 1262, 1263, 1264, 1265, 1266, 1267, 1268, 1269, 1270, 1271
    +href="glossaries-extra-manual.html#dx1-8013" >1280, 1281, 1282, 1283, 1284, 1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292
        firstplural  1272, 1273, 1274, 1275, 1276, 1277, 1278, 1279, 1280, 1281
    +href="glossaries-extra-manual.html#dx1-8014" >1293, 1294, 1295, 1296, 1297, 1298, 1299, 1300, 1301, 1302
        location  1282, 1283
    +href="glossaries-extra-manual.html#dx1-13021" >1303, 1304
        loclist  1284
    +href="glossaries-extra-manual.html#dx1-40025" >1305
        long  1285, 1286, 1287, 1288, 1289, 1290, 1291, 1292, 1293
    +href="glossaries-extra-manual.html#dx1-10026" >1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314
        longplural  1294, 1295, 1296, 1297, 1298, 1299
    +href="glossaries-extra-manual.html#dx1-10010" >1315, 1316, 1317, 1318, 1319, 1320
        name  1300, 1301, 1302, 1303, 1304, 1305, 1306, 1307, 1308, 1309, 1310, 1311, 1312, 1313, 1314, 1315, 1316, 1317, 1318, 1319, 1320, 1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349
    +href="glossaries-extra-manual.html#dx1-5007" >1321, 1322, 1323, 1324, 1325, 1326, 1327, 1328, 1329, 1330, 1331, 1332, 1333, 1334, 1335, 1336, 1337, 1338, 1339, 1340, 1341, 1342, 1343, 1344, 1345, 1346, 1347, 1348, 1349, 1350, 1351, 1352, 1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370
    + + +     parent  1350, 1351, 1352
    +href="glossaries-extra-manual.html#dx1-17054" >1371, 1372, 1373
        plural  1353, 1354, 1355, 1356, 1357, 1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365
    +href="glossaries-extra-manual.html#dx1-8017" >1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386
        see  1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392
    +href="glossaries-extra-manual.html#dx1-4054" >1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413
        seealso  1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1402
    +href="glossaries-extra-manual.html#dx1-4055" >1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1422, 1423
        short  1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416
    +href="glossaries-extra-manual.html#dx1-8011" >1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1435, 1436, 1437
        shortplural  1417, 1418, 1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431
    +href="glossaries-extra-manual.html#dx1-10011" >1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452
        sort  1432, 1433, 1434, 1435, 1436, 1437, 1438, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448
    +href="glossaries-extra-manual.html#dx1-4124" >1453, 1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466, 1467, 1468, 1469
        symbol  1449, 1450, 1451
    +href="glossaries-extra-manual.html#dx1-39031" >1470, 1471, 1472, 1473
        symbolplural  1452, 1453
    +href="glossaries-extra-manual.html#dx1-45034" >1474, 1475
        text  1454, 1455, 1456, 1457, 1458, 1459, 1460, 1461, 1462, 1463, 1464, 1465, 1466
    - - - +href="glossaries-extra-manual.html#dx1-5009" >1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488
        type  1467, 1468
    +href="glossaries-extra-manual.html#dx1-12046" >1489, 1490
        user1  1469, 1470, 1471
    +href="glossaries-extra-manual.html#dx1-22080" >1491, 1492, 1493
    number list  1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487, 1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500
    +href="glossaries-extra-manual.html#dx1-4028" >1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522

    P package options:
        abbreviations  1501, 1502, 1503, 1504, 1505
    +href="glossaries-extra-manual.html#dx1-4136" >1523, 1524, 1525, 1526, 1527
        accsupp  1506, 1507, 1508, 1509
    +href="glossaries-extra-manual.html#dx1-4035" >1528, 1529, 1530, 1531
        acronym  1510
    +href="glossaries-extra-manual.html#dx1-4144" >1532
        acronymlists  1511
    +href="glossaries-extra-manual.html#dx1-4148" >1533
        automake  1512, 1513
    +href="glossaries-extra-manual.html#dx1-5054" >1534, 1535
        autoseeindex  1514, 1515
    +href="glossaries-extra-manual.html#dx1-4064" >1536, 1537
            false  1516, 1517
    +href="glossaries-extra-manual.html#dx1-4056" >1538, 1539
        debug  1518
    +href="glossaries-extra-manual.html#dx1-4002" >1540
            all  1519, 1520
    +href="glossaries-extra-manual.html#dx1-4005" >1541, 1542
            showtargets  1521, 1522
    +href="glossaries-extra-manual.html#dx1-4003" >1543, 1544
            showwrgloss  1523, 1524, 1525
    +href="glossaries-extra-manual.html#dx1-4004" >1545, 1546, 1547
            true  1526
    +href="glossaries-extra-manual.html#dx1-4007" >1548
        docdef  1527, 1528, 1529, 1530
    +href="glossaries-extra-manual.html#dx1-4104" >1549, 1550, 1551, 1552
            restricted  1531, 1532
    +href="glossaries-extra-manual.html#dx1-4117" >1553, 1554
            true  1533, 1534
    +href="glossaries-extra-manual.html#dx1-4132" >1555, 1556
        docdefs  1535, 1536, 1537
    +href="glossaries-extra-manual.html#dx1-32003" >1557, 1558, 1559
            true  1538
    +href="glossaries-extra-manual.html#dx1-4116" >1560
        entrycounter  1539, 1540
    +href="glossaries-extra-manual.html#dx1-38002" >1561, 1562
        hyperfirst
            false  1541
    +href="glossaries-extra-manual.html#dx1-27030" >1563
        index  1542, 1543
    +href="glossaries-extra-manual.html#dx1-5043" >1564, 1565
        indexcrossrefs  1544, 1545, 1546, 1547
    +href="glossaries-extra-manual.html#dx1-4053" >1566, 1567, 1568, 1569
            false  1548
    +href="glossaries-extra-manual.html#dx1-4063" >1570
        indexonlyfirst  1549, 1550, 1551, 1552
    +href="glossaries-extra-manual.html#dx1-6002" >1571, 1572, 1573, 1574
        nogroupskip  1553
    +href="glossaries-extra-manual.html#dx1-17014" >1575
        nomain  1554
    +href="glossaries-extra-manual.html#dx1-3032" >1576
    + + +     nomissingglstext  1555
    +href="glossaries-extra-manual.html#dx1-4135" >1577
        nonumberlist  1556, 1557, 1558, 1559
    +href="glossaries-extra-manual.html#dx1-7026" >1578, 1579, 1580, 1581
        nopostdot  1560, 1561, 1562, 1563
    +href="glossaries-extra-manual.html#dx1-4023" >1582, 1583, 1584, 1585
            false  1564, 1565, 1566
    +href="glossaries-extra-manual.html#dx1-3004" >1586, 1587, 1588
            true  1567
    +href="glossaries-extra-manual.html#dx1-3003" >1589
        noredefwarn
            false  1568
    +href="glossaries-extra-manual.html#dx1-3009" >1590
            true  1569
    +href="glossaries-extra-manual.html#dx1-3006" >1591
        notree  1570
    +href="glossaries-extra-manual.html#dx1-17034" >1592
        numbers  1571, 1572, 1573
    +href="glossaries-extra-manual.html#dx1-4152" >1593, 1594, 1595
        postdot  1574, 1575, 1576
    +href="glossaries-extra-manual.html#dx1-3005" >1596, 1597, 1598
        postpunc  1577, 1578, 1579
    - - - +href="glossaries-extra-manual.html#dx1-4019" >1599, 1600, 1601
            comma  1580
    +href="glossaries-extra-manual.html#dx1-4020" >1602
            dot  1581
    +href="glossaries-extra-manual.html#dx1-4021" >1603
            none  1582
    +href="glossaries-extra-manual.html#dx1-4022" >1604
        record  1583, 1584, 1585, 1586, 1587, 1588
    +href="glossaries-extra-manual.html#dx1-4062" >1605, 1606, 1607, 1608, 1609, 1610
            alsoindex  1589, 1590, 1591, 1592, 1593, 1594
    +href="glossaries-extra-manual.html#dx1-4009" >1611, 1612, 1613, 1614, 1615, 1616
            off  1595, 1596
    +href="glossaries-extra-manual.html#dx1-5049" >1617, 1618
            only  1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605
    +href="glossaries-extra-manual.html#dx1-4067" >1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627
        section
            chapter  1606
    +href="glossaries-extra-manual.html#dx1-13038" >1628
        seeautonumberlist  1607
    +href="glossaries-extra-manual.html#dx1-7027" >1629
        seenoindex  1608
    +href="glossaries-extra-manual.html#dx1-7016" >1630
            ignore  1609, 1610
    +href="glossaries-extra-manual.html#dx1-7018" >1631, 1632
            warn  1611
    +href="glossaries-extra-manual.html#dx1-40012" >1633
        shortcuts  1612, 1613
    +href="glossaries-extra-manual.html#dx1-4154" >1634, 1635
            abbr  1614, 1615
    +href="glossaries-extra-manual.html#dx1-4160" >1636, 1637
            abbreviation  1616, 1617
    +href="glossaries-extra-manual.html#dx1-21001" >1638, 1639
            abbreviations  1618, 1619
    +href="glossaries-extra-manual.html#dx1-4159" >1640, 1641
            ac  1620, 1621, 1622, 1623, 1624, 1625
    +href="glossaries-extra-manual.html#dx1-4157" >1642, 1643, 1644, 1645, 1646, 1647
            acro  1626
    +href="glossaries-extra-manual.html#dx1-4156" >1648, 1649
            acronyms  1627
    +href="glossaries-extra-manual.html#dx1-4155" >1650, 1651
            all  1628
    +href="glossaries-extra-manual.html#dx1-4170" >1652, 1653
            false  1629
    +href="glossaries-extra-manual.html#dx1-4176" >1654
            none  1630
    +href="glossaries-extra-manual.html#dx1-4175" >1655
            other  1631, 1632
    +href="glossaries-extra-manual.html#dx1-4161" >1656, 1657
            true  1633
    +href="glossaries-extra-manual.html#dx1-4171" >1658
        sort
            none  1634, 1635
    +href="glossaries-extra-manual.html#dx1-4089" >1659, 1660
        stylemods  1636, 1637, 1638, 1639, 1640
    +href="glossaries-extra-manual.html#dx1-4044" >1661, 1662, 1663, 1664, 1665
            all  1641
    +href="glossaries-extra-manual.html#dx1-4047" >1666
            default  1642
    +href="glossaries-extra-manual.html#dx1-4046" >1667
        subentrycounter  1643, 1644
    +href="glossaries-extra-manual.html#dx1-38003" >1668, 1669
        symbols  1645, 1646, 1647
    +href="glossaries-extra-manual.html#dx1-4149" >1670, 1671, 1672
        toc
            false  1648
    +href="glossaries-extra-manual.html#dx1-3002" >1673
    + + +         true  1649
    +href="glossaries-extra-manual.html#dx1-3001" >1674
        translate
            babel  1650
    +href="glossaries-extra-manual.html#dx1-3011" >1675
            true  1651
    +href="glossaries-extra-manual.html#dx1-3013" >1676
        undefaction  1652, 1653
    +href="glossaries-extra-manual.html#dx1-4048" >1677, 1678
            error  1654, 1655
    +href="glossaries-extra-manual.html#dx1-4049" >1679, 1680
            warn  1656, 1657, 1658, 1659, 1660, 1661
    +href="glossaries-extra-manual.html#dx1-4050" >1681, 1682, 1683, 1684, 1685, 1686
        xindy  1662
    +href="glossaries-extra-manual.html#dx1-7046" >1687
    page (counter)  1663, 1664
    +href="glossaries-extra-manual.html#dx1-29031" >1688, 1689
    polyglossia package  1665
    +href="glossaries-extra-manual.html#dx1-47005" >1690
    \pretoglossarypreamble  1666
    +href="glossaries-extra-manual.html#dx1-38011" >1691
    \printabbreviations  1667
    - - - +class="cmti-10">1692
    \printglossary options
        nogroupskip  1668
    +href="glossaries-extra-manual.html#dx1-17015" >1693
        target  1669, 1670
    +href="glossaries-extra-manual.html#dx1-5018" >1694, 1695
        targetnameprefix  1671
    +href="glossaries-extra-manual.html#dx1-5019" >1696
        title  1672
    +href="glossaries-extra-manual.html#dx1-47006" >1697
    \printnoidxglossary options
        sort  1673
    +href="glossaries-extra-manual.html#dx1-40015" >1698
    \printunsrtglossaries  1674
    +href="glossaries-extra-manual.html#dx1-40016" >1699
    \printunsrtglossary  1675
    +href="glossaries-extra-manual.html#dx1-40001" >1700
    \printunsrtglossary*  1676
    +href="glossaries-extra-manual.html#dx1-40005" >1701
    \printunsrtglossaryentryprocesshook  1677
    +href="glossaries-extra-manual.html#dx1-40019" >1702
    \printunsrtglossaryhandler  1678
    +href="glossaries-extra-manual.html#dx1-40022" >1703
    \printunsrtglossarypredoglossary  1679
    +href="glossaries-extra-manual.html#dx1-40021" >1704
    \printunsrtglossaryskipentry  1680
    +href="glossaries-extra-manual.html#dx1-40020" >1705
    \printunsrtglossaryunit  1681
    +href="glossaries-extra-manual.html#dx1-40029" >1706
    \printunsrtglossaryunitsetup  1682
    +href="glossaries-extra-manual.html#dx1-40030" >1707
    \provideignoredglossary  1683
    +class="cmti-10">1708

    R relsizes package  1684
    +href="glossaries-extra-manual.html#dx1-22048" >1709
    \RestoreAcronyms  1685
    +class="cmti-10">1710
    \rGLS  1686
    +href="glossaries-extra-manual.html#dx1-37017" >1711
    \rGls  1687
    +href="glossaries-extra-manual.html#dx1-37015" >1712
    \rgls  1688
    +href="glossaries-extra-manual.html#dx1-37013" >1713
    \rGLSformat  1689
    +href="glossaries-extra-manual.html#dx1-37034" >1714
    \rGlsformat  1690
    +href="glossaries-extra-manual.html#dx1-37032" >1715
    \rglsformat  1691
    +href="glossaries-extra-manual.html#dx1-37030" >1716
    \rGLSpl  1692
    +href="glossaries-extra-manual.html#dx1-37018" >1717
    \rGlspl  1693
    +href="glossaries-extra-manual.html#dx1-37016" >1718
    \rglspl  1694
    +href="glossaries-extra-manual.html#dx1-37014" >1719
    \rGLSplformat  1695
    +href="glossaries-extra-manual.html#dx1-37035" >1720
    \rGlsplformat  1696
    +href="glossaries-extra-manual.html#dx1-37033" >1721
    \rglsplformat  1697
    +href="glossaries-extra-manual.html#dx1-37031" >1722
    + + +

    S \setabbreviationstyle  1698
    +class="cmti-10">1723
    slantsc package  1699
    +href="glossaries-extra-manual.html#dx1-26020" >1724
    style package  1700
    +href="glossaries-extra-manual.html#dx1-13005" >1725
    subentrycounter package  1701
    +href="glossaries-extra-manual.html#dx1-41016" >1726

    T textcase package  1702
    +href="glossaries-extra-manual.html#dx1-8" >1727
    tracklang package  1703, 1704, 1705
    - - - +href="glossaries-extra-manual.html#dx1-4" >1728, 1729, 1730
    translator package  1706
    +href="glossaries-extra-manual.html#dx1-3012" >1731

    X xfor package  1707, 1708, 1709
    +href="glossaries-extra-manual.html#dx1-9" >1732, 1733, 1734
    \xglssetwidest  1710
    +class="cmti-10">1735
    \xglsupdatewidest  1711
    +class="cmti-10">1736
    \xGlsXtrSetField  1712
    +href="glossaries-extra-manual.html#dx1-39023" >1737
    xindy  1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723
    +href="glossaries-extra-manual.html#dx1-3023" >1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748
    xindy  1724
    +href="glossaries-extra-manual.html#dx1-6034" >1749
    xkeyval package  1725
    +href="glossaries-extra-manual.html#dx1-7" >1750

    1.14.21 was originally intended as the last release of glossaries 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.25: + \title{glossaries-extra.sty v1.26: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2017-11-24} + \date{2018-01-05} \maketitle \begin{abstract} @@ -1273,6 +1273,15 @@ accompanying sample file \texttt{sample-indexhook.tex}, which uses this hook to determine which entries haven't been indexed.) +There's also a new hook (from v1.26) that's used immediately +before the options are set by the \cs{gls}-like and +\cs{glstext}-like commands: +\begin{definition}[\DescribeMacro\glslinkpresetkeys] +\cs{glslinkpresetkeys} +\end{definition} +(The base package provides \ics{glslinkpostsetkeys} that's +used immediately after the options are set.) + As from version 1.14, there are two new keys for \cs{glsadd}: \gloskey[glsadd]{thevalue} and \gloskey[glsadd]{theHvalue}. These keys are designed for manually adding explicit locations @@ -3032,7 +3041,7 @@ For example: \end{verbatim} The \glostyle{list} styles use -\begin{definition}[\DescribeMacro\glsxtrprelocation] +\begin{definition}[\DescribeMacro\glslistprelocation] \cs{glslistprelocation} \end{definition} (which defaults to \cs{glsxtrprelocation}) for top-level items and @@ -5761,6 +5770,15 @@ have the \catattr{entrycount} attribute set and where the previous usage count for that entry is less than or equal to the value of that attribute. +\item[\catattrdef{linkcount}] This attribute is set to +\texttt{true} by \ics{GlsXtrEnableLinkCounting} (see +\sectionref{sec:linkcount}). + +\item[\catattrdef{linkcountmaster}] This attribute is set to +the name of the master counter by \ics{GlsXtrEnableLinkCounting} +if the optional argument is provided (see +\sectionref{sec:linkcount}). + \item[\catattrdef{glossdesc}] The \ics{glossentrydesc} command (used in the predefined glossary styles) is modified by \styfmt{glossaries-extra} to check for this attribute. @@ -6054,7 +6072,39 @@ glossaries using: where \meta{glossary-labels} is a comma-separated list of glossary labels. -\chapter{Entry Counting} +\chapter{Counting References} +\label{sec:countref} + +There are three basic ways of counting entry references: +\begin{enumerate} +\item Counting the total number of times \cs{glsunset} is used +(\cs{glsreset} resets the count and is best avoided). +This is provided by the base \styfmt{glossaries} package and is +intended for documents where the term should be displayed +differently if it's only been used a certain number of times. +The information has to be written to the \texttt{.aux} file +so that it's available on the next \LaTeX\ run. + +This method is extended by \styfmt{glossaries-extra} and is +described in \sectionref{sec:entrycount}. + +\item Counting the total number of records. This method is +only available with \gls{bib2gls} and is intended +for documents where the term should be displayed differently +if it's only been recorded (indexed) a certain number of times. +See \sectionref{sec:recordcount} for further details. + +\item Counting the number of times the \cs{gls}-like or +\cs{glstext}-like commands are used. (That is, those commands +that internally use \cs{@gls@link}.) Unlike the other two methods, +this just provides a running total rather than the total from the +previous \LaTeX\ run. This method is intended to make it more +convenient to work with hooks like \cs{glslinkcheckfirsthyperhook}, +\cs{glslinkpostsetkeys} or \cs{glslinkpresetkeys}. +See \sectionref{sec:linkcount} for further details. +\end{enumerate} + +\section{Entry Counting (First Use Flag)} \label{sec:entrycount} As mentioned in \sectionref{sec:entrycountmods}, @@ -6079,9 +6129,11 @@ the \catattr{entrycount} attribute. (With \styfmt{glossaries}, commands like \ics{cgls} will generate a warning if \cs{glsenableentrycount} hasn't been used.) The abbreviation shortcut \ics{ab} uses \cs{cgls} (see -\sectionref{sec:abbrshortcuts}) unlike the acronym shortcut \ics{ac} -which uses \cs{gls} (except when it's defined through -\pkgopt[ac]{shortcuts}). +\sectionref{sec:abbrshortcuts}). The acronym shortcut +\ics{ac} uses \cs{cgls} if it's been defined with +\pkgopt[ac]{shortcuts} (or \pkgopt[all]{shortcuts}) +but uses \cs{gls} if it's been defined with +\pkgopt[acronyms]{shortcuts} (or \pkgopt[acro]{shortcuts}). All upper case versions (not provided by \styfmt{glossaries}) are also available: @@ -6407,6 +6459,171 @@ applies. If the first instance of \cs{gls} occurs at the top of the page within a paragraph that started on the previous page, then the count will continue from the previous page. +\section{Link Counting} +\label{sec:linkcount} + +As from version 1.26, an alternative method of entry counting +is to count the number of times the \cs{gls}-like or +\cs{glstext}-like commands are used. (The \qt{link} in this method's +name refers to the use of the internal command \cs{@gls@link} +not to \cs{hyperlink} although \cs{@gls@link} may use +\cs{hyperlink} when displaying the \gls{linktext}.) + +To enable link counting use the preamble-only command: +\begin{definition}[\DescribeMacro\GlsXtrEnableLinkCounting] +\cs{GlsXtrEnableLinkCounting}\oarg{master counter}\marg{categories} +\end{definition} +where \meta{categories} is a list of category labels. The optional +argument \meta{master counter} may be used to identify a master +counter (which must be defined). If present, the associated +link counter will be reset when the master counter is incremented. +This command automatically sets the \catattr{linkcount} attribute +for the given categories. If the optional argument is +present, it also sets the \catattr{linkcountmaster} attribute. + +When enabled, commands like \cs{gls} and \cs{glstext} +increment the associated counter using +\begin{definition}[\DescribeMacro\glsxtrinclinkcounter] +\cs{glsxtrinclinkcounter}\marg{counter name} +\end{definition} +This just does +\texttt{\cs{stepcounter}\marg{counter name}} by default but if you +need \cs{refstepcounter} instead, just redefine this command: +\begin{verbatim} +\renewcommand*{\glsxtrinclinkcounter}[1]{\refstepcounter{#1}} +\end{verbatim} + +You can access the internal count register using +\begin{definition}[\DescribeMacro\GlsXtrLinkCounterValue] +\cs{GlsXtrLinkCounterValue}\marg{label} +\end{definition} +where \meta{label} is the entry's label. This will expand +to 0 if the counter hasn't been defined. + +It's also possible to access the display value +(\cs{the}\meta{counter}) using +\begin{definition}[\DescribeMacro\GlsXtrTheLinkCounter] +\cs{GlsXtrTheLinkCounter}\marg{counter} +\end{definition} +(This will expand to 0 if the counter hasn't been defined.) + +\begin{important} +In order to conserve resources, the counter is only defined +when it first needs to be incremented so terms that have +been defined but haven't been used in the document +won't have the associated count register allocated. +\end{important} + +You can test if the counter has been defined using: +\begin{definition}[\DescribeMacro\GlsXtrIfLinkCounterDef] +\cs{GlsXtrIfLinkCounterDef}\marg{label}\marg{true}\marg{false} +\end{definition} +where \meta{label} is the entry's label. + +The counter name can be obtained using +\begin{definition}[\DescribeMacro\GlsXtrLinkCounterName] +\cs{GlsXtrLinkCounterName}\marg{label} +\end{definition} +This simply expands to the counter name associated with the +entry given by \meta{label} without any check for +existence. For example, to change the display command +(\cs{the}\meta{counter}) using \sty{etoolbox}: +\begin{verbatim} +\csdef{the\GlsXtrLinkCounterName{duck}}{\Roman{\GlsXtrLinkCounterName{duck}}} +\end{verbatim} +This is useful if you just want to change the display for +specific entries but isn't convenient if you want to change the +display for all entries. Instead, it's simpler to redefine +\cs{GlsXtrTheLinkCounter}. For example: +\begin{verbatim} +\renewcommand*{\GlsXtrTheLinkCounter}[1]{% + \GlsXtrIfLinkCounterDef{#1}% + {\Roman{\GlsXtrLinkCounterName{#1}}}% + {0}% +} +\end{verbatim} +In both cases, the redefinition should be implemented +after \cs{GlsXtrEnableLinkCounting}. + +Here's an example document that uses link counting to disable +the hyperlink after the first reference. This redefines +\ics{glslinkpresetkeys} (which is used by both \cs{gls} +and \cs{glstext}) instead of +\cs{glslinkcheckfirsthyperhook} (which is used by \cs{gls} +but not by \cs{glstext}). + +\begin{verbatim} +\documentclass{article} + +\usepackage[colorlinks]{hyperref} +\usepackage{glossaries-extra} + +\makeglossaries + +\renewcommand*{\glslinkpresetkeys}{% + \ifnum\GlsXtrLinkCounterValue{\glslabel}>1 + \setkeys{glslink}{hyper=false}% + \fi +} + +\GlsXtrEnableLinkCounting{general} + +\newglossaryentry{sample1}{name={sample1},description={an example}} +\newglossaryentry{sample2}{name={sample2},description={another example}} + +\newabbreviation{ex}{ex}{example} + +\begin{document} + +\section{Sample Section} + +\Gls{sample1}, \gls{sample2} and \gls{ex}. +\Glstext{sample1} and \gls{ex} again. + +\section{Another Sample Section} + +\Gls{sample1}, \gls{sample2} and \gls{ex}. + +\printglossaries + +\end{document} +\end{verbatim} +The use of \ics{glslinkpresetkeys} +means that the options can override this. For example +\begin{verbatim} +\gls[hyper=true]{sample1} +\end{verbatim} +will override the \texttt{hyper=false} setting in +\ics{glslinkpresetkeys}. If \ics{glslinkpostsetkeys} is used +instead, the \texttt{hyper=false} setting will override +the setting provided in the optional argument. + +The \category{abbreviation} category doesn't have the +\catattr{linkcount} attribute set (since it's not +listed in the argument of \cs{GlsXtrEnableLinkCounting}). This means that +\cs{GlsXtrLinkCounterValue} +always expands to 0 for the abbreviation (\texttt{ex}), so the +inequality test +\begin{verbatim} +\ifnum\GlsXtrLinkCounterValue{\glslabel}>1 +\end{verbatim} +will always be false. This means that the abbreviation won't +have \texttt{hyper=false} applied. If the test is changed to +\begin{verbatim} +\ifnum\GlsXtrLinkCounterValue{\glslabel}=1 +\else + \setkeys{glslink}{hyper=false}% +\fi +\end{verbatim} +Then the abbreviation will always have \texttt{hyper=false} +applied. + +To reset the counter every section use the optional argument to set +the master counter: +\begin{verbatim} +\GlsXtrEnableLinkCounting[section]{general} +\end{verbatim} + \chapter{Auto-Indexing} \label{sec:autoindex} @@ -6711,6 +6928,10 @@ There are some new commands and options added to \styfmt{glossaries-extra} to help assist the integration of \gls{bib2gls} into the document build process. +This chapter just provides a general overview of \gls{bib2gls}. +The full details and some sample documents are provided +in the \gls{bib2gls} \href{http://mirrors.ctan.org/support/bib2gls/bib2gls.pdf}{manual}. + An example of the contents of \texttt{.bib} file that stores glossary entries that can be extracted with \gls{bib2gls}: \begin{verbatim} @@ -7037,14 +7258,14 @@ if you are using \XeLaTeX\ or \LuaLaTeX: \cs{GlsXtrLoadResources}[ src=terms, % entries in terms.bib sort=custom, % custom sort rule - sort-rule={% required with sort=custom + sort-rule=\{% required with sort=custom < \ae;\AE\ < a;\'a;\aa;\"a,\"A;\'A;\AA;\"A < b,B < c;\'c,C;\'C < d,D < e;\'e,E;\'E < f,F < g,G < h,H < i;\'i,I;\'I < j,J < l;\l,L;\L < m,M < n,N < o;\"o;\o,O;\"O;\O\ < p,P < q,Q < r,R < s;\'s,S;\'S < t,T < u;\'u,U;\'U < v,V < w,W < x,X < y,Y < z;\.z,Z;\.Z - } + \} ] \end{alltt} Remember that if you are using \sty{inputenc} then extended @@ -7053,24 +7274,30 @@ written to the \texttt{.aux} file. So with PDF\LaTeX\ the above would have to be changed to protect against expansion. Some of the options, including \texttt{sort-rule}, may have Unicode characters indicated in the format -\cs{u}\meta{hex} \emph{in the \texttt{.aux} file}. \gls{bib2gls} +\cs{u}\meta{hex} (or \cs{u}~\meta{hex}) \textbf{in the \texttt{.aux} file}. \gls{bib2gls} will recognise this format as indicating the character given by the hexadecimal value \meta{hex}. The \cs{u} also needs protection from expansion, so with a non-Unicode aware -engine the above needs to be written as: +engine, the character \ae\ needs to be written as +\texttt{\cs{string}\cs{u}E6} and so on. This is quite cumbersome, +but you can use the shortcut \texttt{\ics{glshex} E6} instead, so +the above needs to be written as: \begin{alltt} \cs{GlsXtrLoadResources}[ src=terms, % entries in terms.bib sort=custom, % custom sort rule - sort-rule={% required with sort=custom - < \cs{string}\cs{u}E6;\cs{string}\cs{u}C6 < a;\cs{string}\cs{u}E1;\cs{string}\cs{u}E5,\cs{string}\cs{u}E4,A;\cs{string}\cs{u}C1;\cs{string}\cs{u}C5;\cs{string}\cs{u}C4 < b,B - < c;\cs{string}\cs{u}0107,C;\cs{string}\cs{u}0106 < d,D < e;\cs{string}\cs{u}E9,E;\cs{string}\cs{u}C9 < f,F < g,G - < h,H < i;\cs{string}\cs{u}ED,I;\cs{string}\cs{u}CD < j,J < l;\cs{string}\cs{u}0142,L;\cs{string}\cs{u}0141 < m,M < n,N - < o;\cs{string}\cs{u}F6;\cs{string}\cs{u}F8,O;\cs{string}\cs{u}D6;\cs{string}\cs{u}D8 < p,P < q,Q < r,R < s;\cs{string}\cs{u}013F,S;\cs{string}\cs{u}015A - < t,T < u;\cs{string}\cs{u}FA,U;\cs{string}\cs{u}DA < v,V < w,W < x,X < y,Y < - z;\cs{string}\cs{u}017C,Z;\cs{string}\cs{u}017B - } -] + sort-rule=\{% required with sort=custom + < \cs{glshex} E6;\cs{glshex} C6 + < a;\cs{glshex} E1;\cs{glshex} E5,\cs{glshex} E4,A;\cs{glshex} C1;\cs{glshex} C5;\cs{glshex} C4 + < b,B < c;\cs{glshex} 0107,C;\cs{glshex} 0106 < d,D + < e;\cs{glshex} E9,E;\cs{glshex} C9 < f,F < g,G + < h,H < i;\cs{glshex} ED,I;\cs{glshex} CD < j,J + < l;\cs{glshex} 0142,L;\cs{glshex} 0141 < m,M < n,N + < o;\cs{glshex} F6;\cs{glshex} F8,O;\cs{glshex} D6;\cs{glshex} D8 + < p,P < q,Q < r,R < s;\cs{glshex} 013F,S;\cs{glshex} 015A + < t,T < u;\cs{glshex} FA,U;\cs{glshex} DA < v,V < w,W < x,X < y,Y + < z;\cs{glshex} 017C,Z;\cs{glshex} 017B + \}] \end{alltt} \section{Supplementary Commands} @@ -7084,7 +7311,7 @@ for use with \gls{bib2gls}. This is just defined as \verb|\string\u|, which is required when you need to indicate a Unicode character in the form \cs{u}\meta{hex} in some of -the resource options (as described above). +the resource options (as illustrated above). The information provided with \cs{GlsXtrLoadResources} is written to the \texttt{.aux} file using @@ -7103,7 +7330,7 @@ short commands for convenience. For example, with: \begin{verbatim} \renewcommand{\glsxtrresourceinit}{\let\u\glshex} \end{verbatim} -you can just use, for example, \verb|\uE6| instead of +you can just use, for example, \verb|\u E6| instead of \verb|\string\uE6| in the custom rule. This redefinition of \cs{u} is scoped so its original definition is restored after the write operation. @@ -7145,14 +7372,14 @@ to define custom commands that set the prefix. For example: \newcommand*{\sym}[2][]{\gls[#1]{sym.#2}} \end{verbatim} The problem with this is that the custom command \cs{sym} -does allow for modifiers (such as \cs{gls*} or \cs{gls+}). +doesn't allow for modifiers (such as \cs{gls*} or \cs{gls+}). Instead you can use: \begin{definition}[\DescribeMacro\glsxtrnewgls] \cs{glsxtrnewgls}\oarg{default options}\marg{prefix}\marg{cs} \end{definition} which defines the command \meta{cs} that behaves like \begin{alltt} -\cs{gls}\meta{modifier}[\meta{default options},options]\{\meta{prefix}\meta{label}\}\oarg{insert} +\cs{gls}\meta{modifier}[\meta{default options},\meta{options}]\{\meta{prefix}\meta{label}\}\oarg{insert} \end{alltt} For example: \begin{verbatim} @@ -7202,6 +7429,7 @@ options}\marg{prefix}\marg{\cs{rGLS}-like cs}\marg{\cs{rGLSpl}-like cs} \end{definition} \section{Record Counting} +\label{sec:recordcount} As from version 1.1 of \gls{bib2gls}, you can save the total record count for each entry by invoking \gls{bib2gls} @@ -7507,9 +7735,9 @@ command to an argument: \end{definition} This effectively does \begin{alltt} -\cs{glslink}[\meta{default-options},\meta{options}]\marg{label}\{\cs{glsxtrfmtdisplay}\marg{text}\{\}\} +\cs{glslink}[\meta{default-options},\meta{options}]\marg{label}\{\cs{glsxtrfmtdisplay}\marg{cs name}\marg{text}\{\}\} \end{alltt} -where \meta{cs} is the command obtained from the control +where \meta{cs name} is the control 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. @@ -7692,7 +7920,9 @@ package provides a simpler version: \begin{definition}[\DescribeMacro\glsxtrifhasfield] \cs{glsxtrifhasfield}\marg{field}\marg{label}\marg{true}\marg{false} \end{definition} -(New to v1.19.) +(New to v1.19.) Note that in this case the \meta{field} must be the +\emph{internal} field label (for example, \texttt{useri} rather than +\texttt{user1}). Unlike \cs{ifglshasfield}, this version doesn't complain if the entry (given by \meta{label}) or the field don't exist and will simply do \meta{false}. If the field does exist for the given @@ -7709,6 +7939,11 @@ The starred version \end{definition} omits the implicit grouping. +\begin{important} +Be careful of keys that use \cs{relax} as the default value +(such as the \gloskey{symbol}). Use \cs{ifglshassymbol} instead. +\end{important} + 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: @@ -8657,16 +8892,22 @@ entries to the index (in addition to the glossary \gls{locationlist}). value of the \gloskey{name} key. \item[sample-entrycount.tex] Enable entry-use counting (only index -if used more than $n$ times). +if used more than $n$ times, see \sectionref{sec:entrycount}). -\item[sample-unitentrycount.tex] Enable use of per-unit entry-use counting. - -\item[sample-pages.tex] Insert \qt{page} or \qt{pages} before the -location list. +\item[sample-unitentrycount.tex] Enable use of per-unit entry-use counting +(\sectionref{sec:entrycount}). \item[sample-onelink.tex] Using the per-unit entry counting +(\sectionref{sec:entrycount}) to only have one hyperlink per entry per page. +\item[sample-linkcount.tex] Using link counting +(\sectionref{sec:linkcount}) +to only have one hyperlink per entry. + +\item[sample-pages.tex] Insert \qt{page} or \qt{pages} before the +location list. + \item[sample-altmodifier.tex] Set the default options for commands like \cs{gls} and add an alternative modifier. 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 e29a9f88693..204fced5f26 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 c43c2d47872..1bf5cc78e7a 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 5f0a3c0af1a..e8fbb61b6a5 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 3f1a6c8c0c9..20eed21aad5 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 0d6dafdee90..f8b21607781 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 6537dfe437d..493a8ce6879 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 6a52db087af..d5caa5126d0 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 c93648ff82e..a9f42790986 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 ea177209bfe..9614985c3c1 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 304aade2501..f8921a82261 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 261c81c3ae0..73d08591d28 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 44c74a86092..c70e21e39bd 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 7cd161860e6..c025b836aa0 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 75b825c84ec..535c3983867 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 85c0bc56745..289c7ce8be1 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 a3b6f329784..160b9f8fa5d 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 8fdf5d555da..4a7084bf74a 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 8b3760e2b3b..0a474d88557 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 1d6d70c1d48..270b398b285 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 a653d472580..449bcc30b09 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 2ba403dd32a..bd073b3e5c9 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 8228d1bea3b..93006e7b987 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-linkcount.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.pdf new file mode 100644 index 00000000000..e21b1156cc4 Binary files /dev/null and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.tex b/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.tex new file mode 100644 index 00000000000..d8375eaabf6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.tex @@ -0,0 +1,44 @@ +% arara: pdflatex +% arara: makeglossaries +% arara: pdflatex +\documentclass{article} + +\usepackage[colorlinks]{hyperref} +\usepackage{glossaries-extra} + +\makeglossaries + +\renewcommand*{\glslinkpostsetkeys}{% + \ifnum\GlsXtrLinkCounterValue{\glslabel}>1 + \setkeys{glslink}{hyper=false}% + \fi +} + +%\GlsXtrEnableLinkCounting[section]{general} +\GlsXtrEnableLinkCounting{general} + +\newglossaryentry{sample1}{name={sample1},description={an example}} +\newglossaryentry{sample2}{name={sample2},description={another example}} + +\newabbreviation{ex}{ex}{example} + +\begin{document} + +\section{Sample Section} + +\Gls{sample1}, \gls{sample2} and \gls{ex}. +\Glstext{sample1} and \gls{ex} again. +Link count: \GlsXtrTheLinkCounter{sample1} (sample1), +\GlsXtrTheLinkCounter{sample2} (sample2) and +\GlsXtrTheLinkCounter{ex} (ex). + +\section{Another Sample Section} + +\Gls{sample1}, \gls{sample2} and \gls{ex}. +Link count: \GlsXtrTheLinkCounter{sample1} (sample1), +\GlsXtrTheLinkCounter{sample2} (sample2) and +\GlsXtrTheLinkCounter{ex} (ex). + +\printglossaries + +\end{document} 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 c4f44642a9c..c5f8be34ae3 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 fba1ab52ba9..a8f75ca098f 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 dafb1cd4c35..a4016cf23f4 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 6c7ae1a9d8b..a71c332f4ce 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 59eeaa0aa97..2da53702fc3 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 ccfb29f4bce..a6cb5109994 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 c96d7876741..2b335a3842c 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 fa4b3f4760c..1510acf3b52 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 5db475032f4..09aba9d6a60 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 8452d955d0a..1a67f297148 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 ee6fa6c7c34..e481a54e1a3 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 34b8fed224d..f13ba752f69 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 7961a7094a5..0dfaa805f59 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 8c45fb90d93..9831d6f1fd8 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-prefix.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-record.pdf index 97a097e0fe2..a41afc8a7dc 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 ff430174da1..bbfb508eaa6 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 3fc7c0740a2..dae1d60a830 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 1602a11a809..100edebe1f8 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 a036e872445..9d47c0858b6 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 fa78812c171..b80c378d669 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 d13a02daabf..3965a66d979 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 4764efe7e94..9734fe450f5 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 c2b9614ebf2..ac83e80eead 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 163d0f070b2..7d8b69b3029 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 diff --git a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx index e9151f3574c..369ed3645e6 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx @@ -1,22 +1,22 @@ %\iffalse % glossaries-extra.dtx generated using makedtx version 1.2 (c) Nicola Talbot % Command line args: +% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" +% -setambles ".*\.bib=>\nopreamble\nopostamble" +% -doc "glossaries-extra-codedoc.tex" +% -author "Nicola Talbot" % -src "glossaries-extra.sty\Z=>glossaries-extra.sty" % -src "glossaries-extra-stylemods.sty\Z=>glossaries-extra-stylemods.sty" % -src "glossary-bookindex.sty\Z=>glossary-bookindex.sty" % -src "(example-glossaries-.+\.tex)\Z=>\1" % -src "(example-glossaries-.+\.bib)\Z=>\1" -% -author "Nicola Talbot" -% -section "chapter" -% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" -% -macrocode ".*\.tex" -% -macrocode ".*\.bib" -% -doc "glossaries-extra-codedoc.tex" % -comment ".*\.tex" % -comment ".*\.bib" -% -setambles ".*\.bib=>\nopreamble\nopostamble" +% -macrocode ".*\.tex" +% -macrocode ".*\.bib" +% -section "chapter" % glossaries-extra -% Created on 2017/11/24 16:50 +% Created on 2018/1/5 12:41 %\fi %\iffalse %<*package> @@ -39,7 +39,7 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2017 Nicola Talbot, all rights reserved. +% Copyright (C) 2018 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> @@ -126,7 +126,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{20152} +\CheckSum{20216} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -166,13 +166,13 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \raggedright } -\title{glossaries-extra.sty v1.25: +\title{glossaries-extra.sty v1.26: documented code} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} -\date{2017-11-24} +\date{2018-01-05} \begin{document} \DocInput{glossaries-extra.dtx} @@ -217,7 +217,7 @@ Dickimaw Books\\ %\section{Package Initialisation and Options} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossaries-extra}[2018/01/05 v1.26 (NLCT)] % \end{macrocode} % Requires \sty{xkeyval} to define package options. % \begin{macrocode} @@ -3943,6 +3943,23 @@ Dickimaw Books\\ % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsxtr@inc@linkcount} +%\changes{1.26}{2018-01-05}{new} +%Does nothing by default. +% \begin{macrocode} +\newcommand*{\glsxtr@inc@linkcount}{} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glslinkpresetkeys} +%\changes{1.26}{2018-01-05}{new} +%User hook performed immediately before options are set. +%Does nothing by default. +% \begin{macrocode} +\newcommand*{\glslinkpresetkeys}{} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@gls@link} %\changes{1.14}{2017-04-18}{added redefinition} %Redefine to allow the indexing to be placed after the link text. By @@ -3975,13 +3992,30 @@ Dickimaw Books\\ % \begin{macrocode} \glsxtrinithyperoutside % \end{macrocode} -% As the original definition. Note that the default link options may +% Note that the default link options may % override \cs{glsxtrinitwrgloss}. % \begin{macrocode} \@gls@setdefault@glslink@opts +% \end{macrocode} +%Increment link counter if enabled (new to v1.26). +% \begin{macrocode} + \glsxtr@inc@linkcount +% \end{macrocode} +% As the original definition. +% \begin{macrocode} \do@glsdisablehyperinlist \do@gls@link@checkfirsthyper +% \end{macrocode} +%User hook before options are set (new to v1.26): +% \begin{macrocode} + \glslinkpresetkeys +% \end{macrocode} +%Set options. +% \begin{macrocode} \setkeys{glslink}{#1}% +% \end{macrocode} +%User hook after options are set: +% \begin{macrocode} \glslinkpostsetkeys % \end{macrocode} % Check \gloskey[glslink]{thevalue} and \gloskey[glslink]{theHvalue} @@ -6239,11 +6273,15 @@ Dickimaw Books\\ % %\subsection{Entry Counting} % -% The entry counting mechanism from \styfmt{glossaries} is adjusted +% The (use) entry counting mechanism from \styfmt{glossaries} is adjusted % here to work with category attributes. Provide a convenient % command to enable entry counting, set the \catattr{entrycount} % attribute for given categories and redefine \ics{gls} etc to -% use \cs{cgls} instead. +% use \cs{cgls} instead. This form of entry counting is provided to +% adjust the formatting if the number of times an entry has been +% used (through commands that unset the first use flag) doesn't +% exceeding the specified threshold. For link counting, see +% \sectionref{sec:linkcount}. % % First adjust definitions of the unset and reset commands to % provide a hook. @@ -9423,6 +9461,7 @@ defined}{}% \def\@glsxtr@thevalue{}% \def\@glsxtr@theHvalue{\@glsxtr@thevalue}% \glsxtrinitwrgloss + \glslinkpresetkeys \setkeys{glslink}{#1}% \glslinkpostsetkeys \ifdefempty{\@glsxtr@thevalue}% @@ -9699,6 +9738,138 @@ defined}{}% % \end{macrocode} %\end{macro} % +%\section{Link Counting} +%\label{sec:linkcount} +%This is different to the entry counting provided by the base +%package (which counts the number of times the first use flag is +%unset). Instead, this method hooks into \cs{@gls@link} (through +%\cs{glsxtr@inc@linkcount}) to increment an associated counter. +%To preserve resources, the counter is only defined if it needs to +%be incremented. This method is independent of the presence of +%hyperlinks. (The \qt{link} part of the name refers to \cs{@gls@link} +%not \cs{hyperlink}.) +% +%\begin{macro}{\@glsxtr@do@inc@linkcount} +%\changes{1.26}{2018-01-05}{new} +%This performs the actual incrementing and counter definition. +%The counter is given by \cs{c@glsxtr@linkcount@\meta{label}} where +%\meta{label} is the entry's label. Since this is performed within +%\cs{@gls@link} the label can be accessed with \cs{glslabel}. +% \begin{macrocode} +\newcommand{\@glsxtr@do@inc@linkcount}{% +% \end{macrocode} +%Does this entry have the \catattr{linkcount} attribute set? +% \begin{macrocode} + \glsifattribute{\glslabel}{linkcount}{true}% + {% +% \end{macrocode} +%Does the counter exist? +% \begin{macrocode} + \ifcsdef{c@glsxtr@linkcount@\glslabel}{}% + {% +% \end{macrocode} +%Counter doesn't exist, so define it. +% \begin{macrocode} + \newcounter{glsxtr@linkcount@\glslabel}% +% \end{macrocode} +%If \catattr{linkcountmaster} is set, add to counter reset. +% \begin{macrocode} + \glshasattribute{\glslabel}{linkcountmaster}% + {% +% \end{macrocode} +%Need to ensure values are fully expanded. +% \begin{macrocode} + \begingroup + \edef\x{\endgroup\noexpand\@addtoreset{glsxtr@linkcount@\glslabel}% + {\glsgetattribute{\glslabel}{linkcountmaster}}}% + \x + }% + {}% + }% +% \end{macrocode} +% Increment counter: +% \begin{macrocode} + \glsxtrinclinkcounter{glsxtr@linkcount@\glslabel}% + }% + {}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsxtrinclinkcounter} +%\changes{1.26}{2018-01-05}{new} +%May be redefined to use \cs{refstepcounter} if required. +% \begin{macrocode} +\newcommand*{\glsxtrinclinkcounter}[1]{\stepcounter{#1}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\GlsXtrLinkCounterValue} +%\changes{1.26}{2018-01-05}{new} +%Expands to the associated link counter register or 0 if not +%defined. +% \begin{macrocode} +\newcommand*{\GlsXtrLinkCounterValue}[1]{% + \ifcsundef{c@glsxtr@linkcount@#1}{0}{\csname c@glsxtr@linkcount@#1\endcsname}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\GlsXtrTheLinkCounter} +%\changes{1.26}{2018-01-05}{new} +%Expands to the display value of the associated link counter or 0 if not +%defined. +% \begin{macrocode} +\newcommand*{\GlsXtrTheLinkCounter}[1]{% + \ifcsundef{theglsxtr@linkcount@#1}{0}% + {\csname theglsxtr@linkcount@#1\endcsname}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\GlsXtrIfLinkCounterDef} +%\changes{1.26}{2018-01-05}{new} +%Tests if the counter has been defined +% \begin{macrocode} +\newcommand*{\GlsXtrIfLinkCounterDef}[3]{% + \ifcsundef{theglsxtr@linkcount@#1}{#3}{#2}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\GlsXtrLinkCounterName} +%\changes{1.26}{2018-01-05}{new} +%Expands to the associated link counter name. (No check for +%existence.) +% \begin{macrocode} +\newcommand*{\GlsXtrLinkCounterName}[1]{glsxtr@linkcount@#1} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\GlsXtrEnableLinkCounting} +%\changes{1.26}{2018-01-05}{new} +%\begin{definition} +%\cs{GlsXtrEnableLinkCounting}\oarg{master counter}\marg{categories} +%\end{definition} +%Enable link counting for the given categories. +% \begin{macrocode} +\newcommand*{\GlsXtrEnableLinkCounting}[2][]{% + \let\glsxtr@inc@linkcount\@glsxtr@do@inc@linkcount + \@for\@glsxtr@label:=#2\do + {% + \glssetcategoryattribute{\@glsxtr@label}{linkcount}{true}% + \ifstrempty{#1}{}% + {% + \ifcsundef{c@#1}% + {\@nocounterr{#1}}% + {\glssetcategoryattribute{\@glsxtr@label}{linkcountmaster}{#1}}% + }% + }% +} +\@onlypreamble\GlsXtrEnableLinkCounting +% \end{macrocode} +%\end{macro} +% %\section{Integration with glossaries-accsupp} % Provide better integration with the \sty{glossaries-accsupp} % package. (Must be loaded before the main code of @@ -20926,7 +21097,7 @@ defined}{}% % First identify package: % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-stylemods}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossaries-extra-stylemods}[2018/01/05 v1.26 (NLCT)] % \end{macrocode} % Provide package options to automatically load required predefined % styles. The simplest method is to just test for the existence of @@ -22983,7 +23154,7 @@ defined}{}% %\section{Package Initialisation and Options} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary-bookindex}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossary-bookindex}[2018/01/05 v1.26 (NLCT)] % \end{macrocode} %Load required packages. % \begin{macrocode} diff --git a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins index b675e9517f1..089a1aa7ab8 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins @@ -1,10 +1,10 @@ -% glossaries-extra.ins generated using makedtx version 1.2 2017/11/24 16:50 +% glossaries-extra.ins generated using makedtx version 1.2 2018/1/5 12:41 \input docstrip \preamble glossaries-extra.dtx - Copyright 2017 Nicola Talbot + Copyright 2018 Nicola Talbot This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/example-glossaries-xr.tex b/Master/texmf-dist/tex/latex/glossaries-extra/example-glossaries-xr.tex index 0e041579df0..8ca4d216b5b 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/example-glossaries-xr.tex +++ b/Master/texmf-dist/tex/latex/glossaries-extra/example-glossaries-xr.tex @@ -7,7 +7,7 @@ %% glossaries-extra.dtx (with options: `example-glossaries-xr.tex,package') %% %% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot +%% Copyright 2018 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty index 21be266918d..5eaff9953a6 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-stylemods.sty @@ -7,7 +7,7 @@ %% glossaries-extra.dtx (with options: `glossaries-extra-stylemods.sty,package') %% %% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot +%% Copyright 2018 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-stylemods}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossaries-extra-stylemods}[2018/01/05 v1.26 (NLCT)] \newcommand*{\@glsxtr@loadstyles}{} \DeclareOption{all}{% \appto\@glsxtr@loadstyles{% diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty index b316e74887e..2cd704b5a24 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty @@ -7,7 +7,7 @@ %% glossaries-extra.dtx (with options: `glossaries-extra.sty,package') %% %% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot +%% Copyright 2018 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossaries-extra}[2018/01/05 v1.26 (NLCT)] \RequirePackage{xkeyval} \RequirePackage{etoolbox} \@ifpackageloaded{glossaries} @@ -1825,6 +1825,8 @@ \glsxtr@hyperoutsidetrue }% } +\newcommand*{\glsxtr@inc@linkcount}{} +\newcommand*{\glslinkpresetkeys}{} \def\@gls@link[#1]#2#3{% \leavevmode \edef\glslabel{\glsdetoklabel{#2}}% @@ -1839,8 +1841,10 @@ \glsxtrinitwrgloss \glsxtrinithyperoutside \@gls@setdefault@glslink@opts + \glsxtr@inc@linkcount \do@glsdisablehyperinlist \do@gls@link@checkfirsthyper + \glslinkpresetkeys \setkeys{glslink}{#1}% \glslinkpostsetkeys \ifdefempty{\@glsxtr@thevalue}% @@ -4716,6 +4720,7 @@ defined}{}% \def\@glsxtr@thevalue{}% \def\@glsxtr@theHvalue{\@glsxtr@thevalue}% \glsxtrinitwrgloss + \glslinkpresetkeys \setkeys{glslink}{#1}% \glslinkpostsetkeys \ifdefempty{\@glsxtr@thevalue}% @@ -4845,6 +4850,51 @@ defined}{}% \newcommand*{\rGLSplformat}[2]{% \expandafter\mfirstucMakeUppercase\expandafter{\rglsplformat{#1}{#2}}% } +\newcommand{\@glsxtr@do@inc@linkcount}{% + \glsifattribute{\glslabel}{linkcount}{true}% + {% + \ifcsdef{c@glsxtr@linkcount@\glslabel}{}% + {% + \newcounter{glsxtr@linkcount@\glslabel}% + \glshasattribute{\glslabel}{linkcountmaster}% + {% + \begingroup + \edef\x{\endgroup\noexpand\@addtoreset{glsxtr@linkcount@\glslabel}% + {\glsgetattribute{\glslabel}{linkcountmaster}}}% + \x + }% + {}% + }% + \glsxtrinclinkcounter{glsxtr@linkcount@\glslabel}% + }% + {}% +} +\newcommand*{\glsxtrinclinkcounter}[1]{\stepcounter{#1}} +\newcommand*{\GlsXtrLinkCounterValue}[1]{% + \ifcsundef{c@glsxtr@linkcount@#1}{0}{\csname c@glsxtr@linkcount@#1\endcsname}% +} +\newcommand*{\GlsXtrTheLinkCounter}[1]{% + \ifcsundef{theglsxtr@linkcount@#1}{0}% + {\csname theglsxtr@linkcount@#1\endcsname}% +} +\newcommand*{\GlsXtrIfLinkCounterDef}[3]{% + \ifcsundef{theglsxtr@linkcount@#1}{#3}{#2}% +} +\newcommand*{\GlsXtrLinkCounterName}[1]{glsxtr@linkcount@#1} +\newcommand*{\GlsXtrEnableLinkCounting}[2][]{% + \let\glsxtr@inc@linkcount\@glsxtr@do@inc@linkcount + \@for\@glsxtr@label:=#2\do + {% + \glssetcategoryattribute{\@glsxtr@label}{linkcount}{true}% + \ifstrempty{#1}{}% + {% + \ifcsundef{c@#1}% + {\@nocounterr{#1}}% + {\glssetcategoryattribute{\@glsxtr@label}{linkcountmaster}{#1}}% + }% + }% +} +\@onlypreamble\GlsXtrEnableLinkCounting \@ifpackageloaded{glossaries-accsupp} { \newcommand*{\glsaccessname}[1]{% diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty index 883a46c8dc4..0fa722e7893 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty @@ -7,7 +7,7 @@ %% glossaries-extra.dtx (with options: `glossary-bookindex.sty,package') %% %% glossaries-extra.dtx -%% Copyright 2017 Nicola Talbot +%% Copyright 2018 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary-bookindex}[2017/11/24 v1.25 (NLCT)] +\ProvidesPackage{glossary-bookindex}[2018/01/05 v1.26 (NLCT)] \RequirePackage{multicol} \RequirePackage{glossary-tree} \newcommand{\glsxtrbookindexcols}{2} -- cgit v1.2.3