From e2d776e4380890862007f3a0b2b6982a081ce452 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 19 Aug 2018 21:25:32 +0000 Subject: glossaries-extra (19aug18) git-svn-id: svn://tug.org/texlive/trunk@48437 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/glossaries-extra/CHANGES | 11 + .../texmf-dist/doc/latex/glossaries-extra/README | 4 +- .../glossaries-extra/glossaries-extra-code.pdf | Bin 1167436 -> 1167701 bytes .../glossaries-extra/glossaries-extra-manual.html | 8951 ++++++++++---------- .../glossaries-extra/glossaries-extra-manual.pdf | Bin 698619 -> 705248 bytes .../glossaries-extra/glossaries-extra-manual.tex | 101 +- .../latex/glossaries-extra/sample-abbr-styles.pdf | Bin 512962 -> 512962 bytes .../doc/latex/glossaries-extra/sample-abbrv.pdf | Bin 44761 -> 44761 bytes .../doc/latex/glossaries-extra/sample-accsupp.pdf | Bin 82623 -> 82623 bytes .../latex/glossaries-extra/sample-acronym-desc.pdf | Bin 50368 -> 50368 bytes .../doc/latex/glossaries-extra/sample-acronym.pdf | Bin 36745 -> 36745 bytes .../doc/latex/glossaries-extra/sample-alias.pdf | Bin 43875 -> 43875 bytes .../latex/glossaries-extra/sample-altmodifier.pdf | Bin 35308 -> 35308 bytes .../glossaries-extra/sample-alttree-marginpar.pdf | Bin 91061 -> 91061 bytes .../latex/glossaries-extra/sample-alttree-sym.pdf | Bin 69532 -> 69532 bytes .../doc/latex/glossaries-extra/sample-alttree.pdf | Bin 54866 -> 54866 bytes .../glossaries-extra/sample-autoindex-hyp.pdf | Bin 142415 -> 142167 bytes .../latex/glossaries-extra/sample-autoindex.pdf | Bin 161881 -> 161657 bytes .../doc/latex/glossaries-extra/sample-crossref.pdf | Bin 41294 -> 41294 bytes .../latex/glossaries-extra/sample-crossref2.pdf | Bin 41613 -> 41613 bytes .../doc/latex/glossaries-extra/sample-docdef.pdf | Bin 45257 -> 45257 bytes .../latex/glossaries-extra/sample-entrycount.pdf | Bin 54623 -> 54623 bytes .../doc/latex/glossaries-extra/sample-external.pdf | Bin 34187 -> 34187 bytes .../doc/latex/glossaries-extra/sample-fmt.pdf | Bin 75268 -> 75268 bytes .../doc/latex/glossaries-extra/sample-footnote.pdf | Bin 63232 -> 63232 bytes .../doc/latex/glossaries-extra/sample-header.pdf | Bin 125912 -> 125912 bytes .../latex/glossaries-extra/sample-indexhook.pdf | Bin 42722 -> 42722 bytes .../latex/glossaries-extra/sample-initialisms.pdf | Bin 81618 -> 81618 bytes .../latex/glossaries-extra/sample-linkcount.pdf | Bin 38234 -> 38234 bytes .../glossaries-extra/sample-mixed-abbrv-styles.pdf | Bin 57823 -> 57823 bytes .../latex/glossaries-extra/sample-mixedsort.pdf | Bin 45154 -> 45154 bytes .../doc/latex/glossaries-extra/sample-mixture.pdf | Bin 160329 -> 160093 bytes .../latex/glossaries-extra/sample-name-font.pdf | Bin 202094 -> 202094 bytes .../doc/latex/glossaries-extra/sample-nested.pdf | Bin 67736 -> 67736 bytes .../sample-noidx-restricteddocdefs.pdf | Bin 47582 -> 47582 bytes .../doc/latex/glossaries-extra/sample-onelink.pdf | Bin 44527 -> 44527 bytes .../glossaries-extra/sample-onthefly-utf8.pdf | Bin 106071 -> 106071 bytes .../glossaries-extra/sample-onthefly-xetex.pdf | Bin 19863 -> 19858 bytes .../doc/latex/glossaries-extra/sample-onthefly.pdf | Bin 43481 -> 43481 bytes .../doc/latex/glossaries-extra/sample-pages.pdf | Bin 38801 -> 38801 bytes .../doc/latex/glossaries-extra/sample-postdot.pdf | Bin 37059 -> 37059 bytes .../doc/latex/glossaries-extra/sample-postlink.pdf | Bin 67890 -> 67890 bytes .../doc/latex/glossaries-extra/sample-prefix.pdf | Bin 33119 -> 33119 bytes .../doc/latex/glossaries-extra/sample-record.pdf | Bin 50231 -> 50231 bytes .../glossaries-extra/sample-restricteddocdefs.pdf | Bin 47895 -> 47895 bytes .../latex/glossaries-extra/sample-suppl-hyp.pdf | Bin 34944 -> 34944 bytes .../glossaries-extra/sample-suppl-main-hyp.pdf | Bin 46402 -> 46402 bytes .../latex/glossaries-extra/sample-suppl-main.pdf | Bin 31607 -> 31607 bytes .../doc/latex/glossaries-extra/sample-suppl.pdf | Bin 13423 -> 13423 bytes .../doc/latex/glossaries-extra/sample-trans.pdf | Bin 49455 -> 49455 bytes .../doc/latex/glossaries-extra/sample-undef.pdf | Bin 33231 -> 33231 bytes .../glossaries-extra/sample-unitentrycount.pdf | Bin 61051 -> 61051 bytes .../doc/latex/glossaries-extra/sample.pdf | Bin 45747 -> 45747 bytes .../latex/glossaries-extra/glossaries-extra.dtx | 78 +- .../latex/glossaries-extra/glossaries-extra.ins | 2 +- .../glossaries-extra/glossaries-extra-bib2gls.sty | 12 +- .../latex/glossaries-extra/glossaries-extra.sty | 9 +- .../latex/glossaries-extra/glossary-bookindex.sty | 2 +- 58 files changed, 4753 insertions(+), 4417 deletions(-) diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES index 52211a30b10..31e52db4642 100644 --- a/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES @@ -1,3 +1,14 @@ +1.36 (2018-08-18) + + * glossaries-extra-bib2gls.sty + + - added \glsxtrdisplaysupploc and \glsxtrmultisupplocation for use + with bib2gls version 1.7+. + + * glossaries-extra.sty + + - added \glsxtrautoindexesc + 1.35 (2018-08-13) * fixed bug in \glslink diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/README b/Master/texmf-dist/doc/latex/glossaries-extra/README index 0d0ae541e75..cbe12413bae 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.35 +LaTeX Package : glossaries-extra v1.36 -Last Modified : 2018-08-13 +Last Modified : 2018-08-18 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 4e94a024028..ee037236147 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 508565e473d..e809808ef05 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.35: an extension to the +class="cmr-17">glossaries-extra.sty v1.36: an extension to the glossaries package

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

2018-08-13

+class="cmr-12">2018-08-18

@@ -2815,54 +2815,67 @@ class="description">Locally redefines \glolinkprefix to the given value. It should match the prefix for the desired glossary. +
+thevalue
Explicitly set the location to this value (see below). +
+theHvalue
Set the corresponding hyperlink location (see below).
-

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

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



\glsxtrdowrglossaryhook  \glsxtrdowrglossaryhook{label}

-

+

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

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

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



\glslinkpresetkeys  \glslinkpresetkeys

-

+

(The base package provides \glslinkpostsetkeys that’s used immediately after the + id="dx1-6030"> that’s used immediately after the options are set.) -

As from version 1.30 there are also similar hooks for

As from version 1.30 there are also similar hooks for \glsadd: -



\glsaddpresetkeys  \glsaddpresetkeys

-

+

and -



\glsaddpostsetkeys  \glsaddpostsetkeys

-

+

For example, to default to using the equation counter in maths mode: + id="dx1-6033"> counter in maths mode: @@ -2873,9 +2886,9 @@ class="cmss-10">equation\renewcommand{\glsaddpresetkeys}{%  
 \ifmmode \setkeys{glossadd}{counter=equation}\fi}

-

(This can be overridden with an explicit use of

(This can be overridden with an explicit use of counter in the optional argument + id="dx1-6034"> in the optional argument of \gls or \glsadd.) Alternatively, to enforce this (overriding the option @@ -2890,43 +2903,43 @@ argument):  
\renewcommand{\glsaddpostsetkeys}{%  
 \ifmmode \setkeys{glossadd}{counter=equation}\fi}

-

-

As from version 1.14, there are two new keys for

+

As from version 1.14, there are two new keys for \glsadd: thevalue and and theHvalue. + id="dx1-6036">. 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-6037"> 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-6039"> can be used to extract a prefix value for the first argument of commands like \glsnoidxdisplayloc. It’s value must be in the format ⟨. Its 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-6041">, 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⟩ @@ -2939,7 +2952,7 @@ instances of a number followed by the recognised separator character (set with \glsSetCompositor). This means that makeindex won’t accept, for + id="dx1-6043"> won’t accept, for example, @@ -2948,23 +2961,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-6045">, 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-6046">, 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-6048"> 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: @@ -2981,10 +2994,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: @@ -3002,17 +3015,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-6051"> attribute to the location of the PDF file. For example: @@ -3022,7 +3035,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: @@ -3031,30 +3044,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-6052"> 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-6053"> 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. -

+

This method can only be used where there is one external source for the +designated category (identified by the externallocation attribute). For multiple +sources, you need to use bib2gls version 1.7+, which is the better method in +general as it can automatically fetch the relevant locations from the .aux files +of the designated external documents without the need to explicitly use +\glsadd. +

-

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, @@ -3094,20 +3122,23 @@ 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 documentsee key still can’t perform any indexing before the file has been - - - opened by \makeglossaries. Note that glossaries v4.24 introduced 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: @@ -3212,11 +3240,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: @@ -3273,20 +3301,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 @@ -3312,20 +3340,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 @@ -3372,7 +3400,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 @@ -3483,7 +3511,7 @@ overridden by the textformat attribute. -

For example: +

For example: @@ -3491,7 +3519,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: @@ -3502,7 +3530,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: @@ -3514,7 +3542,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: @@ -3522,23 +3550,23 @@ class="cmtt-10">font:

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

without redefining

without redefining \glsxtrregularfont. -

As from version 1.30, there is also a command for abbreviations that encapsulates +

As from version 1.30, there is also a command for abbreviations that encapsulates \glsxtrgenabbrvfmt: -



\glsxtrabbreviationfont  \glsxtrabbreviationfont{text}

-

+

This also just does its argument by default. Font changes made by abbreviation styles are within ⟨text⟩. -

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 @@ -3600,9 +3628,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 @@ -3614,8 +3642,8 @@ href="#sec:nested">§2.7 Nested Links) instead.
-

-

By default

+

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

You can define the post-link hook command using

You can define the post-link hook command using \newcommand, for example: @@ -3639,8 +3667,8 @@ example:  
 \glsxtrpostlinkAddDescOnFirstUse  
}

-

or, as from v1.31, you can use -


or, as from v1.31, you can use +


\glsdefpostlink  category}{definition}

-

+

This is simply a shortcut for:

definition}
Note that it doesn’t check if the command has already 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. (Does nothing if the symbol hasn’t been set.) -



\glsxtrpostlinkAddSymbolDescOnFirstUse  \glsxtrpostlinkAddSymbolDescOnFirstUse

-

+

(New to v1.31.) On first use, this will append \space(⟨description⟩) if the symbol is defined otherwise it just appends \space(⟨description⟩). -

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 @@ -3762,7 +3790,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: @@ -3830,7 +3858,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 @@ -3874,8 +3902,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: @@ -3914,7 +3942,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 @@ -3925,17 +3953,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 @@ -3959,8 +3987,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 @@ -4052,7 +4080,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 @@ -4062,14 +4090,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: @@ -4100,7 +4128,7 @@ href="#sec:categories">Categories).

\glsenableentrycount
-

you now need to do: +

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

-

This will enable the entry counting for entries in the

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

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

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

+

-

Top

2.5 First Use Flag

-

The

The glossaries package provides -



\ifglsused{true}{false}

-

+

to determine whether or not an entry has been used. This requires the entry to have been defined. If the entry is undefined, then the underlying boolean variable doesn’t exist and so is neither true nor false. This command will produce an error with the @@ -4154,7 +4182,7 @@ class="cmti-10">true⟩ nor ⟨false⟩ will be performed if ⟨label⟩ doesn’t exist. -

The

The record option automatically implements bib2gls. In this case, you may prefer to use: -



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

-

+

(new to v1.34) which does ⟨true⟩ if the entry given by ⟨label⟩ is undefined or if @@ -4199,24 +4227,24 @@ href="#sec:entryfmtmods">§2.3 Entry Display Style Modifications.) -

There are two new commands provided with version 1.31+: -


There are two new commands provided with version 1.31+: +


\glslocalreseteach  \glslocalreseteach{list}

-

+

and -



\glslocalunseteach  \glslocalunseteach{list}

-

+

These behave like \glslocalreset and \glslocalunset but the argument is a @@ -4224,7 +4252,7 @@ class="cmtt-10">\glslocalunset but the argument is a comma-separated list of labels. -

The internal command used by

The internal command used by \glsunset is modified first to allow for the changing in entry counting, described above, but also to allow for buffering pending unsets when commands like \ul{Some text about \gls{html}.}

-

This causes the confusing error: +

This causes the confusing error: @@ -4248,7 +4276,7 @@ the commands provided with the Glossary entry `{html}' has not been defined.

-

The simplest workaround is to put

The simplest workaround is to put \gls{html} inside the argument of \mbox. For example: @@ -4259,7 +4287,7 @@ example:

\ul{Some text about \mbox{\gls{html}}.}
-

This can work provided it’s not the first use of this entry. It if is, then unsetting the +

This can work provided it’s not the first use of this entry. It if is, then unsetting the first use flag causes a problem and results in the error: @@ -4268,17 +4296,17 @@ first use flag causes a problem and results in the error:

! Package soul Error: Reconstruction failed.
-

The

The glossaries-extra package provides a way of temporarily switching off \glsunset so that it just makes a note of the entry’s label but doesn’t actually perform the change: -



\GlsXtrStartUnsetBuffering  \GlsXtrStartUnsetBuffering

-

+

The unstarred version doesn’t check for duplicates, so the internal list may end up with multiple occurrences of the same label. The starred version only adds a label to the internal list if it’s not already in it. Note that this @@ -4286,14 +4314,14 @@ buffering only applies to the global \glsunset and does not affect the local \glslocalunset. -

Later you can restore

Later you can restore \glsunset and unset all buffered labels using: -



\GlsXtrStopUnsetBuffering  \GlsXtrStopUnsetBuffering

-

+

The starred form \GlsXtrStopUnsetBuffering* uses \glslocalunset instead. For @@ -4315,9 +4343,9 @@ example:  
Next use: \gls{html}.  
\end{document}

-

Before you stop the unset buffering, you can iterate over the current buffer +

Before you stop the unset buffering, you can iterate over the current buffer using -



\GlsXtrForUnsetBufferedList  \GlsXtrForUnsetBufferedList{cs}

-

+

where ⟨cs⟩ is a control sequence that takes a single argument (which is the entry label). This is best used with the starred version \GlsXtrStartUnsetBuffering* to avoid duplicates. -

Note that since the change in the first use flag now doesn’t occur until +

Note that since the change in the first use flag now doesn’t occur until \GlsXtrStopUnsetBuffering, multiple references of the same term within the buffering zone will always be treated as first use (if the term wasn’t used before the buffering started).
-

-

There can still be a problem here as content within

+

There can still be a problem here as content within \mbox can’t break across a line so you may end up with an overfull line or excessive white space within the paragraph. -

An alternative is to use

An alternative is to use \protect: @@ -4352,7 +4380,7 @@ class="cmtt-10">\protect:  
\ul{Some text about \protect\gls{html}.}  
\GlsXtrStopUnsetBuffering

-

but the formatting (underlining in this example) won’t be applied. Another +

but the formatting (underlining in this example) won’t be applied. Another possibility is: @@ -4375,7 +4403,7 @@ possibility is:  
Next use: \gls{html}.  
\end{document}

-

This moves

This moves \gls outside of \ul and uses textformattextformat\gul, which locally changes the regular font and the default abbreviation font to use \ul. It then uses -



\GlsXtrExpandedFmt  cs}{text}

-

+

which (protected) fully expands ⟨text⟩ before applying ⟨cs⟩, which must be a control @@ -4411,12 +4439,12 @@ something that \ul can’t deal with. For example, if an abbreviation style is used that contains complex formatting or if the field value contains problematic content. -

+

-

Top

2.6 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

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:

    @@ -4521,7 +4549,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

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.7 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: @@ -4610,8 +4638,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 @@ -4640,7 +4668,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 @@ -4703,17 +4731,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: @@ -4723,17 +4751,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: @@ -4744,7 +4772,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 @@ -4756,7 +4784,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: @@ -4767,10 +4795,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: @@ -4831,7 +4859,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: @@ -4856,10 +4884,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 @@ -4892,7 +4920,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: @@ -4969,7 +4997,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: @@ -4980,7 +5008,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 @@ -4991,8 +5019,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 @@ -5055,14 +5083,14 @@ class="cmss-10">noindex to true. If you want to change this, you can use -



\glsxtrsetpopts  \glsxtrsetpopts{options}

-

+

For example: @@ -5071,17 +5099,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 @@ -5090,7 +5118,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: @@ -5100,8 +5128,8 @@ glossary. For example:

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

-

For example, +

+

For example, @@ -5109,7 +5137,7 @@ glossary. For example:

\glsxtrp{short}{ssi}
-

is equivalent to +

is equivalent to @@ -5119,7 +5147,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 @@ -5129,8 +5157,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 @@ -5140,19 +5168,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 @@ -5204,8 +5232,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: @@ -5235,16 +5263,16 @@ class="cmti-10">really need nested commands, the safest method is  
\printglossaries  
\end{document}

-

-

+

+

-

Top

2.8 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 @@ -5283,7 +5311,7 @@ class="cmss-10">glossaries  
\printglossaries  
\end{document}

-

can be easily adapted to use

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


@@ -5339,34 +5367,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

@@ -5559,7 +5587,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 @@ -5568,15 +5596,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 @@ -5586,7 +5614,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.9 glossary-bookindex package

-

As from v1.21,

As from v1.21, glossaries-extra has a new supplementary package glossary-bookindex @@ -5703,7 +5731,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 -


bib2gls. It may be used +with other indexing options, but some features may not be present and UTF-8 +characters may cause a problem with non-Unicode engines in letter group +headings or PDF bookmarks. (bib2gls uses numeric identifies by default to +avoid these problems. If numbers show up in the group headings instead of +the appropriate characters, check that you have used the record package +option.) +

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 -


environment. If the command +


\glsxtrbookindexcolspread  \glsxtrbookindexcolspread

-

+

isn’t empty then it’s supplied as the optional argument following \begin{multicols} {n}. You can switch from multicols to to multicols* by redefining -


by redefining +


\glsxtrbookindexmulticolsenv  \glsxtrbookindexmulticolsenv

-

+

For example @@ -5764,16 +5808,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

or if you want the description (if set): + + + +

+
+\renewcommand*{\glsxtrbookindexname}[1]{% + 
 \glossentryname{#1}% + 
 \ifglshasdesc{#1}{\space \glossentrydesc{#1}\glspostdescription}{}% + 
} +
+

(which picks up the post-description hook). +

Alternatively you can use the \glsxtrpostnamecategory⟩ hook. -

Sub-entries are displayed using -


category⟩ hook to append +information after the name according to the entry’s category. +

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 @@ -5825,90 +5882,90 @@ has, it does

-
+
,\glsxtrprelocation
-

otherwise it just does

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

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


field won’t be set. +

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  \glsxtrbookindexbetween{label1}{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  \glsxtrbookindexsubbetween{label1}{label2}

-

-

The separator between two level 2 entries is given by -


+

The separator between two level 2 entries is given by +


\glsxtrbookindexsubsubbetween  \glsxtrbookindexsubsubbetween{label1} @@ -5916,12 +5973,12 @@ class="cmtt-10">} class="cmtt-10">{⟨label2}

-

+

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



\glsxtrbookindexsubsubatendgroup  \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 bib2gls to omit the + id="dx1-14037"> to omit the seealso cross-reference from the location list. (The see cross-reference will still be @@ -5971,7 +6028,7 @@ appended after the child entries using:

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

This uses

This uses \glstreesubitem and \glstreesubsubitem to indent the cross-reference according to the next level down, so the cross-reference for a top-level entry is aligned @@ -6000,45 +6057,45 @@ with the sub-entries, and a level 1 entry has its cross-reference aligned sub-sub-entries. In the event that a level 2 entry has a cross-reference, this is indented a bit further (but it won’t be aligned with any deeper level as the bookindex + id="dx1-14038"> style only supports a maximum of two sub-levels). -

The

The bookindex style uses group headings. (If you use style uses group headings. (If you use bib2gls remember to invoke + id="dx1-14041"> remember to invoke it with the --group or -g switch.) The heading will use -



\glsxtrbookindexbookmark  \glsxtrbookindexbookmark{group title}{name}

-

+

If \pdfbookmark has been defined, this will use that command to bookmark the group title. If section=chapter is set (default if chapters are defined) then this + id="dx1-14043"> is set (default if chapters are defined) then this uses level 1 otherwise it uses level 2. You can redefine this command if this isn’t appropriate. 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  \glsxtrbookindexformatheader{group title} @@ -6046,81 +6103,81 @@ class="cmtt-10">} -

+

which is defined as

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

where

where \glstreegroupheaderfmt is provided by the glossary-tree package, which is + id="dx1-14045"> 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 + id="dx1-14046"> package provides some supplementary commands that aren’t used by default, but may be used when adjusting the style. These commands 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: @@ -6128,13 +6185,13 @@ current entry:

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

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

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

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

-

Then if you’re using

+

Then if you’re using fancyhdr you can set the page style to show the first and last + id="dx1-14052"> you can set the page style to show the first and last entry for the current page with:

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

-

+

+

-

Top

2.10 Glossary Style Modifications

-

The

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

The

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



\glsxtrsetgrouptitle  label}{title}

-

+

For example:

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

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.10.1 Style Hooks

-

The commands

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

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

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



\glossentrynameother  label}{field}

-

+

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

There is a hook after

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



\glsxtrpostnamehook  \glsxtrpostnamehook{label}

-

+

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



\glsxtrdoautoindexname{}{indexname}

-

+

See §7 Auto-Indexing for further details. -

As from version 1.04, the post-name hook

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

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

For convenience, as from v1.31, you can use -


For convenience, as from v1.31, you can use +


\glsdefpostname  category}{definition}

-

+

This is simply a shortcut for:

definition}
Note that it doesn’t check if the command has already been defined. -

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 ⟨\glsxtrpostdescacronym for entries with the category set class="cmss-10">acronym. For convenience, as from v1.31, you can use -



\glsdefpostdesc  category}{definition}

-

+

This is simply a shortcut for:

definition}
Note that it doesn’t check if the command has already been defined. -

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 @@ -6459,14 +6516,14 @@ do:

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

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

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

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

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

-

+

+

-

Top

2.10.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-17004">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 @@ -6554,31 +6611,31 @@ class="cmti-10">pages⟩ is the text to display otherwise. For examp

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

An extra run is required when using this command. -

Use

An extra run is required when using this command. +

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

-

See the accompanying sample file

+

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

Note that

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

+

-

Top

2.10.3 The glossaries-extra-stylemods Package

-

As from v1.02,

As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that @@ -6590,12 +6647,12 @@ class="cmss-10">glossaries-extra. For example:

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

Alternatively you can load

Alternatively you can load glossary-name.sty at the same time by passing ⟨glossaries-extra-stylemods -

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

Another option is to use the

Another option is to use the stylemods key when you load long3col -

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

Or the value of

Or the value of stylemods may be a comma-separated list of the style package @@ -6637,19 +6694,19 @@ identifiers. For example:

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

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

Remember to group the value if it contains any commas:

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

-

Note that the

+

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

The

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

As from version 1.21, the hard-coded

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



\glsxtrprelocation  \glsxtrprelocation

-

+

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

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

-

The

+

The list styles use -



\glslistprelocation  \glslistprelocation

-

+

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



\glslistchildprelocation  \glslistchildprelocation

-

+

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

As from v1.31, the description (including the post-description hook) is governed +

As from v1.31, the description (including the post-description hook) is governed by: -



\glslistdesc  \glslistdesc{label}

-

+

for the list and altlist styles (but not the listdotted variations). -

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 glossary-tree package introduced two new commands in glossaries\glstreenamefmt has been defined, as from v1.31 glossaries-extra-stylemods defines: -



\glstreedefaultnamefmt  \glstreedefaultnamefmt{text}

-

+

which simply does \textbf{text\glstreenamefmt without affecting the other two commands, you now can. -

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.31, the

As from version 1.31, the glossaries-extra-stylemods package also provides: -



\glstreenonamedesc  \glstreenonamedesc{label}

-

+

which is used by the treenoname styles to display the pre-description separator, the description and the post-description hook. Similarly for the symbol: -



\glstreenonamesymbol  \glstreenonamesymbol{label}

-

+

The above are just used for top-level entries. Child entries don’t have the name or symbol displayed for the treenoname styles, so there’s only a command for the child description: -



\glstreenonamechilddesc  \glstreenonamechilddesc{label}

-

-

For the

+

For the tree styles (but not the treenonametreenonamealttree styles), the description is displayed using: -



\glstreedesc  \glstreedesc{label}

-

+

and the symbol with: -



\glstreesymbol  \glstreesymbol{label}

-

+

Again the above two commands are just for top-level entries. The child entries use: -



\glstreechilddesc  \glstreechilddesc{label}

-

+

for the description and -



\glstreechildsymbol  \glstreechildsymbol{label}

-

+

for the symbol. -

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  }

-

+

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



\xglssetwidest  level]{name}

-

+

The 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 alttree



\glsFindWidestUsedAnyName  \glsFindWidestUsedAnyName[glossary list]

-

+

This is like the previous command but if doesn’t check the parent key. This is useful if all levels should have the same width for the name. -



\glsFindWidestAnyName  \glsFindWidestAnyName[glossary list]

-

+

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



\glsFindWidestUsedLevelTwo  \glsFindWidestUsedLevelTwo[glossary list]

-

+

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



\glsFindWidestLevelTwo  \glsFindWidestLevelTwo[glossary list]

-

+

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



\glsFindWidestUsedAnyNameSymbol  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 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 @@ -7340,10 +7397,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 @@ -7381,7 +7438,7 @@ href="#sec:categories">§5 Categories for further details. -

See

See §2.7 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 @@ -7409,7 +7466,7 @@ class="cmtt-10">acronym (see also href="#sec:acronymmods">§2.8 Acronym Style Modifications) so -



\newacronym  short}{long}

-

+

is now equivalent @@ -7448,7 +7505,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 @@ -7571,21 +7628,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 @@ -7594,7 +7651,7 @@ class="cmti-10">cs⟩. As with redefining any commands, ensure that you don’t redefine something important. In fact, just forget the existence of the starred version and let’s pretend I didn’t mention it. -

The first argument of

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

The accompanying sample file

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

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

This defines the command

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

-
+
\newacronym  
 [description={a system for detecting the location and  
 speed of ships, aircraft, etc, through the use of radio @@ -7638,18 +7695,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 @@ -7681,11 +7738,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

@@ -7706,7 +7763,7 @@ href="#sec:acronymmods">§2.8 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, @@ -7716,7 +7773,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 @@ -8005,13 +8062,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. -


@@ -8351,10 +8408,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 @@ -8390,7 +8447,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 @@ -8429,52 +8486,52 @@ class="cmss-10">fontenc package with the T1 option or something similar.
-

-

The parenthetical styles, such as

+

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



\glsxtrparen  \glsxtrparen{text}

-

+

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

The basic abbreviation styles, such as

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



\glsabbrvdefaultfont  \glsabbrvdefaultfont{text}

-

+

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



\glsfirstabbrvdefaultfont  \glsfirstabbrvdefaultfont{text}

-

+

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



\glslongdefaultfont  }

-

+

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



\glsfirstlongdefaultfont  \glsfirstlongdefaultfont{text}

-

+

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



\glsxtrabbrvpluralsuffix  \glsxtrabbrvpluralsuffix

-

+

which defaults to \glspluralsuffix. -

The small-cap styles, such as

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



\glsabbrvscfont  \glsabbrvscfont{text}

-

+

which uses \textsc.3.1 On first use -



\glsabbrvdefaultfont  \glsfirstabbrvscfont{text}

-

+

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

The long form for the small-cap styles uses

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



\glsxtrscsuffix  \glsxtrscsuffix

-

+

This is defined as

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

The

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

The small styles, such as

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



\glsabbrvsmfont  \glsabbrvsmfont{text}

-

+

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



\glsfirstabbrvsmfont  \glsfirstabbrvsmfont{text}

-

+

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

The long form for the smaller styles uses

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



\glsxtrsmsuffix  \glsxtrsmsuffix

-

+

which defaults to just \glsxtrabbrvpluralsuffix. -

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

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



\glsabbrvemfont  \glsabbrvemfont{text}

-

+

On first use -



\glsfirstabbrvemfont  \glsfirstabbrvemfont{text}

-

+

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



\glsxtremsuffix  \glsxtremsuffix

-

+

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

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

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



\glsfirstlongemfont  \glsfirstlongemfont{long-form}

-

+

instead of \glsfirstlongdefaultfont{long-form} and -



\glslongemfont  }

-

+

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

The user styles have similar commands: -


The user styles have similar commands: +


\glsabbrvuserfont  \glsabbrvuserfont{text}

-

+

for the short form, -



\glsfirstabbrvuserfont  \glsfirstabbrvuserfont{text}

-

+

for the first use short form, -



\glslonguserfont  \glslonguserfont{text}

-

+

for the long form, -



\glsfirstlonguserfont  \glsfirstlonguserfont{text}

-

+

for the first use long form, and -



\glsxtrusersuffix  \glsxtrusersuffix

-

+

for the short plural suffix. -

Similarly for the hyphen styles: -


Similarly for the hyphen styles: +


\glsabbrvhyphenfont  \glsabbrvhyphenfont{text}

-

+

for the short form, -



\glsfirstabbrvhyphenfont  \glsfirstabbrvhyphenfont{text}

-

+

for the first use short form, -



\glslonghyphenfont  \glslonghyphenfont{text}

-

+

for the long form, -



\glsfirstlonghyphenfont  \glsfirstlonghyphenfont{text}

-

+

for the first use long form, and -



\glsxtrhyphensuffix  \glsxtrhyphensuffix

-

+

for the short plural suffix. -

Similarly for the “only” styles, such as

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



\glsabbrvonlyfont  \glsabbrvonlyfont{text}

-

+

for the short form, -



\glsfirstabbrvonlyfont  \glsfirstabbrvonlyfont{text}

-

+

for the first use short form, -



\glslongonlyfont  \glslongonlyfont{text}

-

+

for the long form, -



\glsfirstlongonlyfont  }

-

+

for the first use long form, and -



\glsxtronlysuffix  \glsxtronlysuffix

-

+

for the short plural suffix. -

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

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



\glsxtrinsertinsidetrue  \glsxtrinsertinsidetrue

-

+

This applies to all the predefined styles. For example:

-
+
\setabbreviationstyle{long-short}  
\renewcommand*{\glsfirstlongdefaultfont}[1]{\emph{#1}}  
\glsxtrinsertinsidetrue
-

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

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

Note that for some styles, such as the

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

Remember that

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

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

-

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

+

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

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

-

Some of the styles use -


+

Some of the styles use +


\glsxtrfullsep  \glsxtrfullsep{label}

-

+

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

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

or +

or

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

-

The new naming scheme for abbreviation styles is as follows:

+

+

The new naming scheme for abbreviation styles is as follows:

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

    This is for the parenthetical styles. The

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

    If the

    If the -modifier⟩ part is present, then the field has a font changing command applied to it. The special modifier -only indicates that field is only present according to whether or not the entry has been used. -

    If

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

    If the

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

    Examples:

    +

    Examples:

    • \glsfirstabbrvhyphenfont on first
    • style-noreg -

      Some styles set the

      Some styles set the regular attribute. In some cases, there’s a version of the @@ -9031,7 +9088,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 @@ -9049,7 +9106,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 @@ -9155,12 +9212,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⟩ @@ -9328,12 +9385,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 @@ -9581,12 +9638,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.

      @@ -9693,12 +9750,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 @@ -9720,12 +9777,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 @@ -9837,12 +9894,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 @@ -9874,12 +9931,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 \glsxtrparendescription is set to -



      \glsuserdescription  long}{label}

      -

      +

      The default definition ignores the ⟨label⟩ and encapsulates ⟨long⟩ with \glslonguserfont. -

      The

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

      For example: +

      For example:

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

      On first use,

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

      -

      T

      TEX User Group (TUG)

      -

      whereas

      whereas \gls{dante} will appear as:

      -

      Deutschsprachige Anwendervereinigung T

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

      -

      The short form is formatted according to -


      The short form is formatted according to +


      \glsabbrvuserfont  \glsabbrvuserfont{text}

      -

      +

      and the plural suffix is given by -



      \glsxtrusersuffix  \glsxtrusersuffix

      -

      -

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

      +

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

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



      \glsxtrlongshortdescsort  \glsxtrlongshortdescsort

      -

      +

      For example:

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

      The

      The description must be supplied by the user. The long and short forms are 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

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

      or to include the short form with a hyperlink: +

      or to include the short form with a hyperlink:

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

      Note that I haven’t used commands like

      Note that I haven’t used commands like \glsxtrshort to avoid interference (see 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 namenamedescription is set to the long form. Note that this style will change \glsxtrfull (and it’s variants) so that it fakes non-\glsxtrfull (and its variants) so that it fakes non-first use. (Otherwise the footnote would appear after the inline form.)

      @@ -10864,7 +10921,7 @@ href="#catattr.markwords">markwords 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:

      -
      +
      \glssetcategoryattribute{english}{markwords}{true}  
      \setabbreviationstyle[english]{long-hyphen-short-hyphen}  
      \newabbreviation[category=english]{ip}{IP}{Internet Protocol}
      -

      then +

      then

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

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

      -
      +
      \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 @@ -10985,14 +11042,14 @@ 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 @@ -11010,11 +11067,11 @@ 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 @@ -11065,7 +11122,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 @@ -11091,7 +11148,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 @@ -11145,15 +11202,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 @@ -11170,7 +11227,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 @@ -11190,7 +11247,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 @@ -11261,7 +11318,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 @@ -11305,7 +11362,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 @@ -11316,13 +11373,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), @@ -11389,12 +11446,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⟩:

      -
      +
        \renewcommand*{\CustomAbbreviationFields}{%  
          name={\protect\glsabbrvfont{\the\glsshorttok}},  
          sort={\the\glsshorttok}, @@ -11416,14 +11473,14 @@ class="cmti-10">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⟩:

      -
      +
        \renewcommand*{\GlsXtrPostNewAbbreviation}{%  
          \glssetattribute{\the\glslabeltok}{nohyperfirst}{true}%  
          \glshasattribute{\the\glslabeltok}{regular}% @@ -11470,7 +11527,7 @@ class="cmti-10">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 @@ -11536,19 +11593,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 @@ -11556,44 +11613,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 @@ -11676,7 +11733,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 @@ -11712,7 +11769,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⟩:

      -
      +
        \renewcommand*{\abbrvpluralsuffix}{\glsxtrabbrvpluralsuffix}%  
        \renewcommand*{\glsabbrvfont}[1]{\glsabbrvdefaultfont{##1}}%  
        \renewcommand*{\glsfirstabbrvfont}[1]{\glsfirstabbrvdefaultfont{##1}}% @@ -11933,17 +11990,17 @@ class="cmti-10">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 @@ -11956,11 +12013,11 @@ 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 @@ -11970,7 +12027,7 @@ class="cmtt-10">\textsf:

      -
      +
      \newabbreviationstyle  
      {custom-sf}% label  
      {% setup @@ -11981,7 +12038,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:

      @@ -12039,9 +12096,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:

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

    -

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

    +

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

    The

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



    \glsxtrRevertMarks  \glsxtrRevertMarks

    -

    +

    If you only want to restore \@starttoc you can use: -



    \glsxtrRevertTocMarks  \glsxtrRevertTocMarks

    -

    +

    If you restore the header or table of contents commands, 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 @@ -12186,239 +12243,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. @@ -12452,7 +12509,7 @@ class="cmtt-10">\newacronym have the category set to acronym by default. -

    Additionally, if you have enabled

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

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


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


    \glscategory  \glscategory{label}

    -

    +

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

    You can test the category for a given entry using -


    You can test the category for a given entry using +


    \glsifcategory  part}{false part}

    -

    +

    This is equivalent to

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

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

    Each category may have a set of attributes. For example, the general and acronym\glsentryfmt to determine whether to use \glsgenentryfmt or \glsxtrgenabbrvfmt. -

    Other attributes recognised by

    Other attributes recognised by glossaries-extra are:

    nohyperfirst attribute then just redefine -



    \glsxtrchecknohyperfirst  \glsxtrchecknohyperfirst{label}

    -

    +

    to do nothing.

    \newacronym if it’s using \newabbreviation.) This attribute doesn’t apply to the accessibility fields. -

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

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

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

    Here the

    Here the short and longuser1 -

    +
    \glsuseri{dante}[.]
    -

    This will bring the punctuation character inside the

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



    \glsxtrwordsep  \glsxtrwordsep

    -

    +

    and each word is encapsulated with -



    \glsxtrword  \glsxtrword{word}

    -

    +

    For example:

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

    is essentially the same as +

    is essentially the same as

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

    The “hyphen” styles, such as

    The “hyphen” styles, such as long-hyphen-short-hyphen, take advantage of this @@ -12789,24 +12846,24 @@ 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 attribute is only applicable to +

    +

    This setting will also adjust the long plural. This attribute is only applicable to entries defined using \newabbreviation (or \newacronym if it’s using \newabbreviation.) -

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

    +

    \newabbreviation (or \newacronym if it’s using \newabbreviation.) -

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

    +

    \newabbreviation (or \newacronym if it’s using \newabbreviation.) -

    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”. @@ -12953,11 +13010,11 @@ class="cmss-10">short +

    -

    This setting will be overridden by an explicit use of the

    This setting will be overridden by an explicit use of the shortaccess key in the optional argument of \glsxtrifcounttrigger\cgls should behave. -

    With

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



    \glsxtrfieldtitlecasecs  \glsxtrfieldtitlecasecs{phrase cs}

    -

    +

    For example:

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

    (Note that the argument to

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

-

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

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

-

+

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

Note that this overrides

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

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

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

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

(See also the accompanying sample file

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

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

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

All the predefined glossary styles start each entry listing with

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

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

(If the target document changed

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

If the anchor is in the form ⟨

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

For example: +

For example:

-
+
\glssetcategoryattribute{general}{targeturl}{master-doc.pdf}  
\glssetcategoryattribute{general}{targetcategory}{page}  
\glssetcategoryattribute{general}{targetname}{7}
-

will cause all link text for

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

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

If you want a mixture in your document of entries that link to an internal glossary and entries that link to an external URL then you can use the starred form of \newignoredglossary\newignoredglossary -

+externallocation
The value should be the file name of the target document when + manually indexing an external location (see §2.1 Entry Indexing). In general, + it’s better to use bib2gls v1.7+ which can handle multiple external sources + and doesn’t require this attribute.
-

An attribute can be set using: -


An attribute can be set using: +


\glssetcategoryattribute  \glssetcategoryattribute{category-label} @@ -13459,31 +13531,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} @@ -13510,28 +13582,28 @@ 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}{attribute-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} @@ -13543,19 +13615,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} @@ -13586,7 +13658,7 @@ class="cmitt-10">true-part}{false-part}

-

+

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

For example: +

For example:

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

This does “NO HYPER” if the

This does “NO HYPER” if the general category has the category has the nohyper attribute set to + id="dx1-28173"> 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-28176"> attribute set to “true”: -



\glsifregularcategory  \glsifregularcategory{category-label} @@ -13657,12 +13729,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-28180"> attribute has been set to “false”: -



\glsifnotregularcategory  \glsifnotregularcategory{category-label} @@ -13695,12 +13767,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] @@ -13769,42 +13841,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-28185">. 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-28187"> 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} @@ -13812,18 +13884,18 @@ class="cmtt-10">} class="cmtt-10">{⟨category-label}

-

+

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

-

-

+

Top

6. Counting References

-

There are three basic ways of counting entry references: +

There are three basic ways of counting entry references:

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

    This method is extended by

    This method is extended by glossaries-extra and is described in §6.1 \glslinkpresetkeys. See §6.2 Link Counting for further details.

-

Top

6.1 Entry Counting (First Use Flag)

-

As mentioned in

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

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

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

-

With

+

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

All upper case versions (not provided by

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



\cGLS  label}[insert]

-

+

and -



\cGLSpl  label}[insert]

-

+

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



\cGLSformat  label}{insert}

-

+

and -



\cGLSplformat  label}{insert}

-

+

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

Just using

Just using glossaries:

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

-

If you switch to

+

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

+ -

-

When activated with

+

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



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

-

+

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

The default definition is: +

The default definition is:

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

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

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

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

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

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

-

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

+

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



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

-

+

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

-
+
\renewcommand*{\gls}{\cgls}%  
\renewcommand*{\Gls}{\cGls}%  
\renewcommand*{\glspl}{\cglspl}% @@ -14163,19 +14235,19 @@ class="cmti-10">value⟩. In addition, this does:  
\renewcommand*{\GLS}{\cGLS}%  
\renewcommand*{\GLSpl}{\cGLSpl}%
-

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

If you use

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

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

The above example document can then become: +

The above example document can then become:

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

-

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

+

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



\GlsXtrEnableEntryUnitCounting  value}{counter-name}

-

+

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

Due to the asynchronous nature of T

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

-

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

+

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

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

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

The per-unit counting function uses two attributes:

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

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

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



\glsentrycurrcount  \glsentrycurrcount{label}

-

+

and the final value from the previous run: -



\glsentryprevcount  \glsentryprevcount{label}

-

+

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

The per-unit counting mechanism additionally provides: -


The per-unit counting mechanism additionally provides: +


\glsentryprevtotalcount  \glsentryprevtotalcount{label}

-

+

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



\glsentryprevmaxcount  \glsentryprevmaxcount{label}

-

+

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

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

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

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

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

-
+
\documentclass{report}  
\usepackage{glossaries-extra}  
\GlsXtrEnableEntryUnitCounting{abbreviation}{2}{chapter} @@ -14317,7 +14389,7 @@ which gives the maximum per-unit total from the previous run.  
\printglossaries  
\end{document}
-

In this document, the

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

The

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

The

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

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

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



\glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

-

+

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

-
+
\documentclass{article}  
\usepackage[colorlinks]{hyperref}  
\usepackage{glossaries-extra} @@ -14385,22 +14457,22 @@ hyperlink.  
\printglossaries  
\end{document}
-

This only produces a hyperlink for the first instance of

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

The earlier warning about using the

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

+

-

Top

6.2 Link Counting

-

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

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

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


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


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

-

+

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

When enabled, commands like

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



\glsxtrinclinkcounter  \glsxtrinclinkcounter{counter name}

-

+

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

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

-

You can access the internal count register using -


+

You can access the internal count register using +


\GlsXtrLinkCounterValue  \GlsXtrLinkCounterValue{label}

-

+

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

It’s also possible to access the display value (

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



\GlsXtrTheLinkCounter  \GlsXtrTheLinkCounter{counter}

-

+

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

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

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

-

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


+

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


\GlsXtrIfLinkCounterDef  }{false}

-

+

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

The counter name can be obtained using -


The counter name can be obtained using +


\GlsXtrLinkCounterName  \GlsXtrLinkCounterName{label}

-

+

This simply expands to the counter name associated with the entry given by ⟨label⟩ without any check for existence. For example, to change the display command @@ -14536,10 +14608,10 @@ class="cmss-10">etoolbox -

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

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

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

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

In both cases, the redefinition should be implemented after

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

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

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

-
+
\documentclass{article}  
\usepackage[colorlinks]{hyperref}  
\usepackage{glossaries-extra} @@ -14594,7 +14666,7 @@ class="cmtt-10">\glstext).  
\printglossaries  
\end{document}
-

The use of

The use of \glslinkpresetkeys means that the options can override this. For example @@ -14602,10 +14674,10 @@ example

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

will override the

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

The

The abbreviation category doesn’t have the -

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

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

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

-
+

Top

7. Auto-Indexing

-

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

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

The

The auto-indexing is designed for makeindex syntax. If you’ve used the xindy +package option, the automatic escaping of xindy special characters in the sort field +may result in an incorrect sort value for the \index command used by the +auto-indexing. Note also that texindy has a fixed set of special characters +(corresponding to makeindex’s defaults) that can’t be customized. You may want +to consider using bib2gls and its dual entries as an alternative approach. +
+

+

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

The internal macro used by the

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

In both cases, the indexing is done through -


attribute. +

In both cases, the indexing is done through +


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

-

+

This uses the standard \index command with the sort value taken from the entry’s + id="dx1-32018"> command with the sort value taken from the entry’s sort key and the actual value set to key and the actual value set to \glsentryname{label}. As from v1.16, there are user-level commands available to change the sort and actual value used by the automated index. -

The actual value is given by -


The actual value is given by +


\glsxtrautoindexentry  \glsxtrautoindexentry{label}

-

+

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

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

Note the use of

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

The sort value is assigned using: -


The sort value is assigned using: +


\glsxtrautoindexassignsort  \glsxtrautoindexassignsort{cs}{label}

-

+

where ⟨label⟩ is the entry label and ⟨cs⟩ is the command which needs to be set to the @@ -14765,212 +14865,225 @@ 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-32022">’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: -



\glsxtrautoindexesc  \glsxtrautoindexesc

+

+You can redefine this to do nothing if you want to omit the escaping. You may want +to consider providing another field to obtain the appropriate sort value if the one +provided in the sort field isn’t suitable (because it may already have had special +characters escaped or it may be a numeric value in the case of sort by use or +definition). +

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-32026"> 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-32028"> 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-32029"> field, if present, otherwise the sort field: + id="dx1-32030"> 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-32032"> attribute. You can allow the format key to override the attribute value by using the preamble-only + id="dx1-32033"> 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-32036"> environment will be modified to redefine \glshypernumber to allow formats that use + id="dx1-32038"> to allow formats that use that command. -

The

The dualindex attribute will still be used on subsequent use even if the + id="dx1-32039"> 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-32042"> 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-32044">’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-32049"> 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 documentglossaries-extra but can be enabled using the href="#styopt.docdefs">docdefs package options. -

Although this can be problematic, the

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



\GlsXtrEnableOnTheFly  \GlsXtrEnableOnTheFly

-

+

When used, this defines the commands described below. -

The commands

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

-


+


\glsxtr  dfn-options]{label}

-

+

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

-

The ⟨

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

+

-

The second optional argument ⟨

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



\GlsXtrWarning  dfn-options}{label}

-

-

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

+

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

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

-

If you are considering doing something like: +

+

If you are considering doing something like:

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

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

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

There are plural and case-changing alternatives to

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



\glsxtrpl  dfn-options]{label}

-

+

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



\Glsxtr  dfn-options]{label}

-

+

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



\Glsxtrpl  dfn-options]{label}

-

+

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

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

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

If you use the starred version of

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

+

-

-

+

Top

9. bib2gls: Managing Reference Databases

-

There is a new command line application called

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

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

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

There are some new commands and options added to

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

This chapter just provides a general overview of

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

An example of the contents of

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

+ -

-

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

-

To ensure that

+

To ensure that bib2glsrecord -

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

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

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

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

If you still want to use an indexing application (for example, you need a custom bib2glssort key from being set. -

The

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



\glsxtrresourcefile  ]{filename}

-

+

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



\GlsXtrLoadResources  \GlsXtrLoadResources[options]

-

+

On the first use, this command is a shortcut for

}
where ⟨n⟩ is the current value of -



\glsxtrresourcecount

-

+

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

The

The \glsxtrresourcefile command writes the line

9.2

Since the

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

Note that as from v1.12,

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

-

Top

9.1 Selection

-

The default behaviour is for

The default behaviour is for bib2gls -

+
\GlsXtrSetDefaultNumberFormat{glsignore}
-

at the start of the front matter and +

at the start of the front matter and

-
+
\GlsXtrSetDefaultNumberFormat{glsnumberformat}
-

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

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

Note that commands like

-

-

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

+

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

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

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

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

+

-

Top

9.2 Sorting and Displaying the Glossary

-

There are many sorting options provided by

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

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

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

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

Since the

Since the .glstex file only defines those references required within the document (selected according to the selection option) and the definitions have been written in @@ -15612,7 +15725,7 @@ class="cmtt-10">\printunsrtglossaries), described in href="#sec:printunsrt">§10.2 Display All Entries Without Sorting or Indexing. -

Suppose the

Suppose the .bib examples shown above have been stored in the files terms.bib, EX’s path. Then the document might look like:

-
+
\documentclass{article}  
\usepackage[record]{glossaries-extra}  
\setabbreviationstyle{long-short-desc} @@ -15636,18 +15749,18 @@ class="E">EX’s path. Then the document might look like:  
\printunsrtglossaries  
\end{document}
-

The document build process (assuming the document is called

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

-
+
pdflatex mydoc  
bib2gls mydoc  
pdflatex mydoc
-

This creates a single glossary containing the entries:

This creates a single glossary containing the entries: bird, duck, goose, shtml. These cross-referenced entries won’t have a location list when the glossary is first displayed, but depending on how they are referenced, they may pick up a location list on the next document build. -

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

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

-
+
\documentclass{article}  
\usepackage[record,abbreviations,symbols]{glossaries-extra}  
\setabbreviationstyle{long-short-desc} @@ -15708,8 +15821,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: @@ -15717,7 +15830,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} @@ -15735,7 +15848,7 @@ class="cmtt-10">type, which will produce a glossary with ordered sub-bloc  
\printunsrtglossaries  
\end{document}
-

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

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

-
+
pdflatex myDoc  
bib2gls -g myDoc  
pdflatex myDoc
-

The value of the

The value of the group field must always be a label. You can set the corresponding title with §2.10 Glossary Style Modifications). If no title is set then the label is used as the group title. -

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

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

}]
-

+

-

Top

9.3 The glossaries-extra-bib2gls package

-

The package option

The package option record=onlyxindy and it is expected that the sorting will be switched off (with the resource option sort=none). -

If

If glossaries-extra-bib2gls is loaded via the script⟩ is the four letter script identifier, such as Latn). -



\glshex  \glshex

-

+

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



\glscapturedgroup  \glscapturedgroup

-

+

This is just defined as \string\$ and is used for the captured group reference in a replacement part of a regular expression substitution (requires at least -

+
sort-replace={{([a-zA-Z])\string\.}{\glscapturedgroup1}}
-

This only removes a full stop that follows any of the characters a,…,z or +

This only removes a full stop that follows any of the characters a,…,z or A,…,Z. -

If you use the

If you use the save-child-count resource option, you can test if the childcount field is non-zero using: -



\GlsXtrIfHasNonZeroChildCount  true}{false}

-

+

This internally uses \GlsXtrIfFieldNonZero and will do ⟨false⟩ if the field isn’t set. @@ -16178,12 +16291,12 @@ class="cmti-10">false⟩ you can use \glscurrentfieldvalue to access the value. (It will be 0 in ⟨false⟩ if the field isn’t set.) -



\glsxtrprovidecommand  \glsxtrprovidecommand

-

+

This command is intended for use in @preamble. It’s simply defined to -

+
@preamble{"\glsxtrprovidecommand{\int}{integral}"}
-

This will force

This will force bib2gls.glstex file (as it is by default) then it won’t override the current definition (provided by the kernel or redefined by a package). -




-

+

If the \hyperref command has been defined (that is, bib2gls manual for further details (at least version 1.4). -



\GlsXtrBibTeXEntryAliases  \GlsXtrBibTeXEntryAliases

-

+

A convenient shortcut for use in the entry-type-aliases setting. This provides aliases for BibT@bibtexentry entry type id="dx1-37035">bib2gls version 1.4). -



\GlsXtrProvideBibTeXFields  \GlsXtrProvideBibTeXFields

-

+

Defines storage keys for BibTEX’s standard fields. Note that BibTEX’s \glsxtrbibaddress. The class="cmtt-10">bibtextype field can be accessed with \glsxtrbibtype. Each of these commands takes the entry label as the sole argument. -

The


\glsxtrdisplaysupploc  \glsxtrdisplaysupploc{prefix}{counter}{format} +{src}{location}

+

+This is used by bib2gls version 1.7+ for supplemental locations, instead of using +\glsxtrsupphypernumber with the externallocation attribute. This command sets up +the location counter and prefix (used in the formation of hyperlinks) and then +uses +


\glsxtrmultisupplocation  \glsxtrmultisupplocation{location}{src} +{format}

+ + + +

+to format the actual location (with an external hyperlink, if supported). +

The glossaries-extra-bib2gls package also provides definitions of the missing + id="dx1-37045"> package also provides definitions of the missing mathematical Greek commands: \Alpha, , \Beta, , \Epsilon, , \Zeta, , \Eta, , \Iota, + id="dx1-37051">, \Kappa, , \Mu, , \Nu, , \Omicron, , \Rho, , \Tau, , \Chi, , \Digamma, , \omicron. These are all + id="dx1-37060">. These are all defined with \providecommand, so they won’t override any definitions provided by any package loaded before glossaries-extra. Since . Since bib2gls’s interpreter recognises + id="dx1-37063">’s interpreter recognises these commands, using them instead of explicitly using the Latin characters with the same shape helps to keep the Greek symbols together when sorting. Similarly, if upgreek has been loaded, the missing upright Greek commands are also + id="dx1-37064"> has been loaded, the missing upright Greek commands are also provided. - - - -

The remaining commands provide common rule blocks for use in the +

The remaining commands provide common rule blocks for use in the sort-rule resource option. If you want a rule for a specific locale, you can provide similar commands in a file called \IfTrackedLanguageFileExists in the tracklang documentation for further details. + id="dx1-37065"> documentation for further details. If this file is on TEX’s path and the tracklang package (automatically loaded by + id="dx1-37066"> package (automatically loaded by glossaries) detects that the document has requested that language or locale, then the file will automatically be loaded. For example, if you want to provide a rule @@ -16388,7 +16546,7 @@ contains:

-
+
\ProvidesGlossariesExtraLang{welsh}[2018/02/23 v1.0]  
\@ifpackageloaded{glossaries-extra-bib2gls}  
{ @@ -16426,7 +16584,7 @@ contains:  
}  
{}% glossaries-extra-bib2gls.sty not loaded
-

(The use of

(The use of \string is in case the < character has been made active.) You can provide more than one rule-block per local, to allow for loanwords or foreign words. @@ -16434,7 +16592,7 @@ For example, you could provide \glsxtrWelshIRules, \glsxtrWelshIIRules etc. -

If the rules are for a particular script (independent of language or region) then +

If the rules are for a particular script (independent of language or region) then they can be provided in a file given by glossariesxtr-scriptglossariesxtr-Cyrl.ldf could contain:

-
+
\ProvidesGlossariesExtraLang{Cyrl}[2018/02/23 v1.0]  
\newcommand*{\glsxtrGeneralCyrillicIRules}{%  
  % Cyrillic rules @@ -16454,20 +16612,20 @@ class="cmtt-10">glossariesxtr-Cyrl.ldf could contain:  
  % an alternative set of Cyrillic rules  
}
-

(Remember that the required document language scripts need to be tracked through +

(Remember that the required document language scripts need to be tracked through the tracklang package, in order for these files to be automatically loaded. This + id="dx1-37067"> package, in order for these files to be automatically loaded. This essentially means ensuring you load the appropriate language package before tracklang is loaded by the base is loaded by the base glossaries package or any other package that uses it. + id="dx1-37069"> package or any other package that uses it. See the tracklang documentation for further details.) -

Alternatively, if the rules are specific to a subject rather than a region or + id="dx1-37070"> documentation for further details.) +

Alternatively, if the rules are specific to a subject rather than a region or language, then you can provide a supplementary package. For example, if you have a package called, say, mapsymbols that provides map symbols, then the file @@ -16477,7 +16635,7 @@ class="cmtt-10">mapsymbols.sty might contain:

-
+
\NeedsTeXFormat{LaTeX2e}  
\ProvidesPackage{mapsymbols}  
 some package or font loading stuff here to provide @@ -16493,28 +16651,28 @@ class="cmtt-10">mapsymbols.sty might contain:  
 \string< \glshex 26BD % football 0x26BD  
}
-

and the supplementary file

and the supplementary file mapsymbols.bib can provide the appropriate definitions for bib2gls: + id="dx1-37072">:

-
+
@preamble{"\glsxtrprovidecommand{\Harbour}{\char"2693}  
\glsxtrprovidecommand{\Battlefield}{\char"2694}  
\glsxtrprovidecommand{\Stadium}{\char"26BD}"}
-

Now both the preamble and rule block can be used in the resource set: +

Now both the preamble and rule block can be used in the resource set:

-
+
\usepackage{mapsymbols}% my custom package  
\usepackage[record]{glossaries-extra}  
\GlsXtrLoadResources[ @@ -16536,10 +16694,10 @@ class="cmtt-10">bib2gls }  
]
-

-

The following commands are provided by

+

The following commands are provided by glossaries-extra-bib2gls. They should be + id="dx1-37073">. They should be separated by the rule separator characters ; (semi-colon) or , (comma) or @@ -16548,21 +16706,21 @@ class="cmtt-10">& (ampersand) or < (less than). See Java’s RuleBasedCollator documentation for details of the rule syntax. -

For example, the following will place the mathematical Greek symbols (

For example, the following will place the mathematical Greek symbols (\alpha, + id="dx1-37074">, \Alpha, , \beta, , \Beta etc) in a block before Latin characters: + id="dx1-37077"> etc) in a block before Latin characters:

-
+
sort-rule={\glsxtrcontrolrules  
 ;\glsxtrspacerules  
 ;\glsxtrnonprintablerules @@ -16577,48 +16735,48 @@ sort-rule={\glsxtrcontrolrules  
 <\glsxtrLatinOslash  
}
-

-


+


\glsxtrcontrolrules  \glsxtrcontrolrules

-

+

These are control characters that are usually placed at the start of a rule in the ignored section. They typically won’t occur in any sort values, but if they do they should normally be ignored. -



\glsxtrspacerules  \glsxtrspacerules

-

+

These are space characters. They typically come after the control characters with the two blocks separated by a ; (semi-colon). -



\glsxtrnonprintablerules  \glsxtrnonprintablerules

-

+

These are non-printable characters (BOM, tabs, line feed and carriage return). They typically come after the spaces separated by a ; (semi-colon). These characters aren’t checked for by bib2gls when it determines whether or not to use the + id="dx1-37082"> when it determines whether or not to use the interpreter, so a TAB or newline character may end up in the sort value if it wasn’t interpreted. -



\glsxtrcombiningdiacriticrules  \glsxtrcombiningdiacriticrules

-

+

These are combining diacritic marks which typically follow the space and non-printable blocks (separated by a semi-colon). This command is defined in terms of sub-block commands: @@ -16626,7 +16784,7 @@ of sub-block commands:

-
+
\newcommand*{\glsxtrcombiningdiacriticrules}{%  
 \glsxtrcombiningdiacriticIrules\string;  
 \glsxtrcombiningdiacriticIIrules\string; @@ -16634,36 +16792,36 @@ of sub-block commands:  
 \glsxtrcombiningdiacriticIVrules  
}
-

If you prefer, you can use the sub-blocks directly in your required ordered. -


If you prefer, you can use the sub-blocks directly in your required ordered. +


\glsxtrcombiningdiacriticIrules  \glsxtrcombiningdiacriticIrules

-

+

This contains the combining diacritics: acute, grave, breve, circumflex, caron, ring, vertical line above, diaeresis (umlaut), double acute, tilde, dot above, combining macron. -



\glsxtrcombiningdiacriticIIrules  \glsxtrcombiningdiacriticIIrules

-

+

This contains the combining diacritics: short solidus overlay, cedilla, ogonek, dot below, low line, overline, hook above, double vertical line above, double grave accent, candrabindu, inverted breve, turned comma above, comma above, reversed comma above, comma above right, grave accent below, acute accent below. -



\glsxtrcombiningdiacriticIIIrules  \glsxtrcombiningdiacriticIIIrules

-

+

This contains the combining diacritics: left tack below, right tack below, left angle above, horn, left half ring below, up tack below, down tack below, plus sign below, minus sign below, palatalized hook below, retroflex hook below, diaresis below, ring @@ -16675,13 +16833,13 @@ seagull below, x above, vertical tilde, double overline, Greek perispomeni, Gree dialytika tonos, Greek ypogegrammeni, double tilde, double inverted breve, Cyrillic titlo, Cyrillic palatalization, Cyrillic dasia pneumata, Cyrillic psili pneumata. -



\glsxtrcombiningdiacriticIVrules  \glsxtrcombiningdiacriticIVrules

-

+

This contains the combining diacritics: left harpoon above, right harpoon above, long vertical line overlay, short vertical line overlay, anticlockwise arrow above, clockwise arrow above, left arrow above, right arrow above, ring overlay, clockwise ring overlay, @@ -16691,20 +16849,20 @@ arrow above, left arrow above, right arrow above, ring overlay, clockwise ring o anticlockwise ring overlay, three dots above, four dots above, enclosing circle, enclosing square, enclosing diamond, enclosing circle backslash, left right arrow above. -



\glsxtrhyphenrules  \glsxtrhyphenrules

-

+

This contains hyphens (including the minus sign 0x2212). This rule block typically comes after the diacritic rules separated by a comma. -



\glsxtrgeneralpuncrules  \glsxtrgeneralpuncrules

-

+

This contains punctuation characters. This rule block typically comes after the hyphen rules separated by a less than (<). As with the combining diacritics, this @@ -16714,20 +16872,20 @@ different order is required:

-
+
\newcommand*{\glsxtrgeneralpuncrules}{%  
  \glsxtrgeneralpuncIrules  
  \string<\glsxtrcurrencyrules  
  \string<\glsxtrgeneralpuncIIrules  
}
-

-


+


\glsxtrgeneralpuncIrules  \glsxtrgeneralpuncIrules

-

+

This is the first punctuation sub-block containing: underscore, macron, comma, semi-colon, colon, exclamation mark, inverted exclamation mark, question mark, inverted question mark, solidus, full stop, acute accent, grave accent, @@ -16736,32 +16894,32 @@ straight double quote, left guillemet, right guillemet, left parenthesis, right parenthesis, left square bracket, right square bracket, left curly bracket, right curly bracket, section sign, pilcrow sign, copyright sign, registered sign, at sign. -



\glsxtrcurrencyrules  \glsxtrcurrencyrules

-

+

This sub-block contains some currency symbols: currency sign, Thai currency symbol baht, cent sign, colon sign, cruzeiro sign, dollar sign, dong sign, euro sign, French franc sign, lira sign, mill sign, naira sign, peseta sign, pound sign, rupee sign, new sheqel sign, won sign, yen sign. -



\glsxtrgeneralpuncIIrules  \glsxtrgeneralpuncIIrules

-

+

This sub-block contains some other punctuation symbols: asterisk, backslash, ampersand, hash sign, percent sign, plus sign, plus-minus sign, division sign, multiplication sign, less-than sign, equals sign, greater-than sign, not sign, vertical bar (pipe), broken bar, degree sign, micron sign. -



\glsxtrdigitrules  \glsxtrdigitrules

-

+

This rule block contains the Basic Latin digits (0, …, 9) and the subscript and superscript digits (0 0 etc) made equivalent to the corresponding Basic Lat The digit block typically comes after the punctuation rules separated by a less than (<). -



\glsxtrBasicDigitrules  \glsxtrBasicDigitrules

-

+

This rule block contains just the Basic Latin digits (0, …, 9). -



\glsxtrSubScriptDigitrules  \glsxtrSubScriptDigitrules

-

+

This rule block contains just the subscript digits (0 … 9). -



\glsxtrSuperScriptDigitrules  \glsxtrSuperScriptDigitrules

-

+

This rule block contains just the superscript digits (0 … 9). -



\glsxtrfractionrules  \glsxtrfractionrules

-

+

This rule block contains vulgar fraction characters. The digit block typically comes after the digit rules separated by a less than (<). -

There are a number of Latin rule blocks. Some of these included extended +

There are a number of Latin rule blocks. Some of these included extended characters or ligatures (such as ß or œ) but they don’t include accented characters. If you require a Latin rule block that includes accented characters, digraphs, trigraphs or other extended characters, then it’s best to provide similar @@ -16815,12 +16973,12 @@ class="cmtt-10">glossariesxtr-⟨tag.ldf file for the particular language or region. -



\glsxtrGeneralLatinIrules  \glsxtrGeneralLatinIrules

-

+

This is just the basic (non-extended) Latin alphabet with the superscript and subscript Latin letters (a a etc) treated as the equivalent basic Latin letter. don’t want the subscripts and superscripts included you can redefine \glsxtrLatinA etc to omit them.) -



\glsxtrGeneralLatinIIrules  \glsxtrGeneralLatinIIrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’ and eszett (ß) treated as ‘ss’. -



\glsxtrGeneralLatinIIIrules  \glsxtrGeneralLatinIIIrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’ and eszett (ß) treated as ‘sz’. -



\glsxtrGeneralLatinIVrules  \glsxtrGeneralLatinIVrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, ae-ligature (æ) is treated as ‘ae’, oe-ligature (œ) is treated as ‘oe’, eszett (ß) treated as ‘ss’ and thorn (þ) is treated as ‘th’. -



\glsxtrGeneralLatinVrules  \glsxtrGeneralLatinVrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, eszett (ß) treated as ‘ss’ and thorn (þ) treated as ‘th’. -



\glsxtrGeneralLatinVIrules  \glsxtrGeneralLatinVIrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes eth (Ð) between ‘D’ and ‘E’, eszett (ß) treated as ‘sz’ and thorn (þ) treated as ‘th’. -



\glsxtrGeneralLatinVIIrules  \glsxtrGeneralLatinVIIrules

-

+

This is like \glsxtrGeneralLatinIrules but it includes ae-ligature (æ) between ‘A’ and ‘B’, eth (Ð) between ‘D’ and ‘E’, insular G (Ᵹ) instead of ‘G’, oe-ligature between ‘O’ and ‘P’, long s (ſ) equivalent to ‘s’, thorn (þ) between ‘T’ and ‘U’ and wynn (Ƿ) instead of W. -



\glsxtrGeneralLatinVIIIrules  \glsxtrGeneralLatinVIIIrules

-

+

This is like \glsxtrGeneralLatinIrules but ae-ligature (æ) is treated as ‘ae’, oe-ligature (œ) is treated as ‘oe’, eszett (ß) treated as ‘ss’, thorn (þ) is treated as ‘th’, Ø is treated as ‘O’ and ‘Ł’ is treated as ‘L’. -



\glsxtrLatinA  \glsxtrLatinA

-

+

A mini-rule that just covers ‘A’ but includes the sub- and superscript A. -



\glsxtrLatinE  \glsxtrLatinE

-

+

A mini-rule that just covers ‘E’ but includes the subscript E. -



\glsxtrLatinH  \glsxtrLatinH

-

+

A mini-rule that just covers ‘H’ but includes the subscript H. -



\glsxtrLatinK  \glsxtrLatinK

-

+

A mini-rule that just covers ‘K’ but includes the subscript K. -



\glsxtrLatinI  \glsxtrLatinI

-

+

A mini-rule that just covers ‘I’ but includes the superscript I. -



\glsxtrLatinL  \glsxtrLatinL

-

+

A mini-rule that just covers ‘L’ but includes the subscript L. -



\glsxtrLatinM  \glsxtrLatinM

-

+

A mini-rule that just covers ‘M’ but includes the subscript M. -



\glsxtrLatinN  \glsxtrLatinN

-

+

A mini-rule that just covers ‘N’ but includes the sub- and superscript N. -



\glsxtrLatinO  \glsxtrLatinO

-

+

A mini-rule that just covers ‘O’ but includes the sub- and superscript O. -



\glsxtrLatinP  \glsxtrLatinP

-

+

A mini-rule that just covers ‘P’ but includes the subscript P. -



\glsxtrLatinS  \glsxtrLatinS

-

+

A mini-rule that just covers ‘S’ but includes the subscript S. -



\glsxtrLatinT  \glsxtrLatinT

-

+

A mini-rule that just covers ‘T’ but includes the subscript T. -



\glsxtrLatinX  \glsxtrLatinX

-

+

A mini-rule that just covers ‘X’ but includes the subscript X. -



\glsxtrLatinEszettSs  \glsxtrLatinEszettSs

-

+

A mini-rule that just covers eszett (ß) and makes long s (ſ) followed by short ‘s’ equivalent to ‘ß’. (This is used in the above blocks that treat ‘ß’ as ‘ss’.) -



\glsxtrLatinEszettSz  \glsxtrLatinEszettSz

-

+

A mini-rule that just covers eszett (ß) and makes long s (ſ) followed by ‘z’ equivalent to ‘ß’. (This is used in the above blocks that treat ‘ß’ as ‘sz’.) -



\glsxtrLatinEth  \glsxtrLatinEth

-

+

A mini-rule for eth (Ð) so you don’t need to remember the Unicode values. -



\glsxtrLatinThorn  \glsxtrLatinThorn

-

+

A mini-rule for thorn (þ) so you don’t need to remember the Unicode values. -



\glsxtrLatinAELigature  \glsxtrLatinAELigature

-

+

A mini-rule for ae-ligature (æ) so you don’t need to remember the Unicode values. -



\glsxtrLatinOELigature  \glsxtrLatinOELigature

-

+

A mini-rule for oe-ligature (œ) so you don’t need to remember the Unicode values. -



\glsxtrLatinOslash  \glsxtrLatinOslash

-

+

A mini-rule for ‘Ø’ so you don’t need to remember the Unicode values. -



\glsxtrLatinLslash  \glsxtrLatinLslash

-

+

A mini-rule for ‘Ł’ so you don’t need to remember the Unicode values. -



\glsxtrLatinWynn  \glsxtrLatinWynn

-

+

A mini-rule for wynn (Ƿ) so you don’t need to remember the Unicode values. -



\glsxtrLatinInsularG  \glsxtrLatinInsularG

-

+

A mini-rule for insular G (Ᵹ) so you don’t need to remember the Unicode values. -



\glsxtrLatinSchwa  \glsxtrLatinSchwa

-

+

A mini-rule that just covers schwa (Ə) but includes the subscript schwa. (Not used in any of the provided Latin rule blocks described above.) -



\glsxtrLatinAA  \glsxtrLatinAA

-

+

A mini-rule for ‘Å’ so you don’t need to remember the Unicode values. (Not used in any of the provided Latin rule blocks described above.) -



\glsxtrMathGreekIrules  \glsxtrMathGreekIrules

-

+

A rule block for mathematical Greek (\alpha, , \beta etc) and upright Greek + id="dx1-37133"> etc) and upright Greek (\upalpha, etc, from the , etc, from the upgreek package) characters that includes digamma + id="dx1-37135"> package) characters that includes digamma (\digamma and and \Digamma) between epsilon and zeta. The upright and italic versions + id="dx1-37137">) between epsilon and zeta. The upright and italic versions are gathered together into the same letter group. -



\glsxtrMathGreekIIrules  \glsxtrMathGreekIIrules

-

+

As \glsxtrMathGreekIrules but doesn’t include digamma. -



\glsxtrMathUpGreekIrules  \glsxtrMathUpGreekIrules

-

+

A rule block for upright Greek (\upalpha, etc, from the , etc, from the upgreek package) + id="dx1-37141"> package) characters that includes digamma (\digamma and and \Digamma) between epsilon and + id="dx1-37143">) between epsilon and zeta. -



\glsxtrMathUpGreekIIrules  \glsxtrMathUpGreekIIrules

-

+

A rule block for upright Greek (\upalpha, etc, from the , etc, from the upgreek package) that + id="dx1-37146"> package) that doesn’t include digamma. -



\glsxtrMathItalicGreekIrules  \glsxtrMathItalicGreekIrules

-

+

A rule block for mathematical Greek (\alpha, , \Alpha, etc) characters that includes + id="dx1-37149">, etc) characters that includes digamma (\diagamma and and \Digamma) between epsilon and zeta. Note that even + id="dx1-37151">) between epsilon and zeta. Note that even though the upper case \Delta etc are actually rendered upright by LATEX, bib2gls’s interpreter treats them as italic to help keep them close to the lower case + id="dx1-37153">’s interpreter treats them as italic to help keep them close to the lower case versions. -



\glsxtrMathItalicGreekIIrules  \glsxtrMathItalicGreekIIrules

-

+

A rule block for mathematical Greek (\alpha, , \Alpha, etc) characters that doesn’t + id="dx1-37156">, etc) characters that doesn’t include digamma. -



\glsxtrMathItalicUpperGreekIrules  \glsxtrMathItalicUpperGreekIrules

-

+

A rule block for upper case mathematical Greek (\Alpha, , \Beta, etc) characters that + id="dx1-37159">, etc) characters that includes digamma (\Digamma) between epsilon and zeta. -


) between epsilon and zeta. +


\glsxtrMathItalicUpperGreekIIrules  \glsxtrMathItalicUpperGreekIIrules

-

+

A rule block for upper case mathematical Greek (\Alpha, , \Beta, etc) characters that + id="dx1-37163">, etc) characters that doesn’t include digamma. -



\glsxtrMathItalicLowerGreekIrules  \glsxtrMathItalicLowerGreekIrules

-

+

A rule block for lower case mathematical Greek (\alpha, , \beta, etc) characters that + id="dx1-37166">, etc) characters that includes digamma (\digamma) between epsilon and zeta. -


) between epsilon and zeta. +


\glsxtrMathItalicLowerGreekIIrules  \glsxtrMathItalicLowerGreekIIrules

-

+

A rule block for lower case mathematical Greek (\alpha, , \beta, etc) characters that + id="dx1-37170">, etc) characters that doesn’t include digamma. -

Additionally, there are commands in the form

Additionally, there are commands in the form \glsxtrUpAlpha, \glsxtrUpBeta etc and \upalpha etc and \Alpha, \alpha etc) as well as the following: -



\glsxtrMathItalicPartial  \glsxtrMathItalicPartial

-

+

The partial derivative symbol (). -



\glsxtrMathItalicNabla  \glsxtrMathItalicNabla

-

+

The nabla symbol (). -

+

-

Top

9.4 Supplementary Commands

-

These commands are provided by

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

The information provided with

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

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



\glsxtrresourceinit  \glsxtrresourceinit

-

+

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

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

you can just use, for example,

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} @@ -17350,21 +17508,21 @@ example:  
\printunsrtglossaries  
\end{document}
-

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

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

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

The problem with this is that the custom command

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



\glsxtrnewgls  prefix}{cs}

-

+

which defines the command ⟨cs⟩ that behaves like

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

or (to default to no hyperlinks) +

or (to default to no hyperlinks)

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

now you can use

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

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

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



\glsxtrnewglslike  }{\Glspl-like cs}

-

+

For example:

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

For the all caps versions: -


For the all caps versions: +


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

-

+

For example:

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

-

There’s an analogous command for

+

There’s an analogous command for \rgls: -



\glsxtrnewrgls  }{cs}

-

+

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



\glsxtrnewrglslike  }{\rGlspl-like cs}

-

+

and for the all caps: -



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

-

-

+

+

-

Top

9.5 Record Counting

-

As from version 1.1 of

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

If

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

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

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

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



    \glsxtrdetoklocation  \glsxtrdetoklocation{location}

    -

    +

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

    Note that the record count includes locations that

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

    With the unit counting on as well, the field

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

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

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



    \GlsXtrTotalRecordCount  \GlsXtrTotalRecordCount{label}

    -

    +

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

    -
    +
    \GlsXtrTotalRecordCount{bird}
    -

    expands to 8. -


    expands to 8. +


    \GlsXtrRecordCount  label}{counter}

    -

    +

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

    -
    +
    \GlsXtrRecordCount{bird}{page}
    -

    expands to 7 and +

    expands to 7 and

    -
    +
    \GlsXtrRecordCount{bird}{section}
    -

    expands to 1. -


    expands to 1. +


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

    -

    +

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

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

    expands to 4. Be careful about using

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

    There are commands analogous to the entry counting commands like

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



    \rgls  label}[insert]

    -

    -


    +


    \rglspl  label}[insert]

    -

    -


    +


    \rGls  label}[insert]

    -

    -


    +


    \rGlspl  label}[insert]

    -

    -


    +


    \rGLS  label}[insert]

    -

    -


    +


    \rGLSpl  label}[insert]

    -

    +

    These commands check the recordcount -

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

    For convenience, you can use -


    For convenience, you can use +



    -

    +

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

    The

    The \rgls-like commands use -



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

    -

    +

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

    This command checks if the

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



    \glsxtrrecordtriggervalue  \glsxtrrecordtriggervalue{label}

    -

    +

    is greater than the value given in the recordcount -

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

    The ⟨

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

    The ⟨

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



    \rglsformat  label}{insert}

    -

    -


    +


    \rglsplformat  label}{insert}

    -

    -


    +


    \rGlsformat  label}{insert}

    -

    -


    +


    \rGlsplformat  label}{insert}

    -

    -


    +


    \rGLSformat  label}{insert}

    -

    -


    +


    \rGLSplformat  label}{insert}

    -

    +

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

    You can use -


    You can use +


    \glsxtrenablerecordcount  \glsxtrenablerecordcount

    -

    +

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

    If you don’t want the entries that use ⟨

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

    -
    +
    \documentclass{article}  
    \usepackage[record]{glossaries-extra}  
    \newignoredglossary{ignored} @@ -18002,7 +18160,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 @@ -18029,21 +18187,21 @@ class="cmss-10">subentrycounter options. The glossaries-extra package provides a supplementary command -



    \glsxtrpageref  \glsxtrpageref{label}

    -

    +

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

    You can copy an entry to another glossary using -


    You can copy an entry to another glossary using +


    \glsxtrcopytoglossary  }{glossary-type}

    -

    +

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

    +
    \printunsrtglossary[target=false]
    -

    -

    The

    +

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



    \apptoglossarypreamble  type]{code}

    -

    +

    or prepend using -



    \pretoglossarypreamble  type]{code}

    -

    +

    -

    Top

    10.1 Entry Fields

    -

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

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



    \GlsXtrFmtField  \GlsXtrFmtField

    -

    +

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

    For example: +

    For example:

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

    -

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

    +

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



    \glsxtrfmt  label}{text}

    -

    +

    This effectively does

    cs name⟩ is the control sequence name supplied in must be defined to take a single required argument. Although it effectively acts like \glslink it misses out the post-link hook. -

    The default ⟨

    The default ⟨default-options⟩ are given by -



    \GlsXtrFmtDefaultOptions  \GlsXtrFmtDefaultOptions

    -

    +

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

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

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



    \glsxtrfmt*  text}[insert]

    -

    +

    Both the starred and unstarred versions use: -



    \glsxtrfmtdisplay  }{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 @@ -18257,25 +18415,25 @@ default definition is:

    -
    +
    \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} @@ -18283,7 +18441,7 @@ 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 -

    +
    \renewcommand{\GlsXtrFmtDefaultOptions}{hyper=false,noindex}
    -

    -

    Note that

    +

    Note that \glsxtrfmt won’t work with PDF bookmarks. Instead you can use -



    \glsxtrentryfmt  label}{text}

    -

    +

    This uses \texorpdfstring and will simply expand to ⟨text⟩ within the PDF @@ -18321,14 +18479,14 @@ 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  }{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  true}{false}

    -

    +

    This tests if ⟨key⟩ is available for use in the ⟨key⟩= list in the second argument of @@ -18370,7 +18528,7 @@ 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 textparent field). Unexpected results may occur if they are subsequently changed. -



    \GlsXtrSetField  field}{value}

    -

    +

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

    \GlsXtrSetField uses -



    \glsxtrsetfieldifexists  }{code}

    -

    +

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

    This command just uses

    This command just uses \glsdoifexists{=warn\glsxtrsetfieldifexists to simply do ⟨code⟩ if you want to skip the existence check. Alternatively you can instead use -



    \glsxtrdeffield  replacement text}

    -

    +

    This simply uses etoolbox’s \protected@csedef instead:10.1 -



    \glsxtredeffield  replacement text}

    -

    -


    +


    \gGlsXtrSetField  field}{value}

    -

    +

    As \GlsXtrSetField but globally. -



    \eGlsXtrSetField  field}{value}

    -

    +

    As \GlsXtrSetField but uses protected expansion. -



    \xGlsXtrSetField  field}{value}

    -

    +

    As \gGlsXtrSetField but uses protected expansion. -



    \GlsXtrLetField  field}{cs}

    -

    +

    Sets the field given by ⟨field⟩ to the replacement text of ⟨cs⟩ for the entry given by ⟨label⟩ (using \let). -



    \csGlsXtrLetField  }{cs name}

    -

    +

    As \GlsXtrLetField but the control sequence name is supplied instead. -



    \GlsXtrLetFieldToField  label-2}{field-2}

    -

    +

    Sets the field given by ⟨field-1⟩ for the entry given by ⟨label-1⟩ to the field given by @@ -18595,7 +18753,7 @@ class="cmti-10">code⟩} is still used, as for \GlsXtrSetField. -

    The

    The glossaries package provides \ifglshasfield to determine if a field has been @@ -18604,7 +18762,7 @@ class="cmss-10">glossaries-extra package provides a simpler version: -



    \glsxtrifhasfield  }{false}

    -

    +

    (New to v1.19.) Note that in this case the ⟨field⟩ must be the internal field label (for @@ -18635,17 +18793,17 @@ class="cmti-10">true⟩ part is done otherwise it does ⟨false⟩. Within ⟨true⟩ you may use -



    \glscurrentfieldvalue  \glscurrentfieldvalue

    -

    +

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



    \glsxtrifhasfield*  }{false}

    -

    +

    omits the implicit grouping. -

    Be careful of keys that use

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

    -

    There is also a version that simply uses

    +

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



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



    \GlsXtrIfFieldCmpStr  true}{false}

    -

    +

    This in turn is just a shortcut that uses \glsxtrifhasfield to test if the field exists and then compares the replacement text of = (equality), < (less than) or > (greater than). -

    As from version 1.31, there’s a similar command: -


    As from version 1.31, there’s a similar command: +


    \GlsXtrIfFieldEqXpStr  true}{false}

    -

    +

    This is like \GlsXtrIfFieldEqStr but first (protected) fully expands ⟨text⟩ (but not the field value). If you want to compare the (protected) full expansion of both the field value and ⟨text⟩ use: -



    \GlsXtrIfXpFieldEqXpStr  true}{false}

    -

    -

    As from v1.31, if a field represents a numeric (integer) value, you can use the +

    +

    As from v1.31, if a field represents a numeric (integer) value, you can use the following two numeric tests. If the field is set, it must expand to an integer. You may use \glscurrentfieldvalue within ⟨false⟩ are scoped. If the field is undefined or empty, the value is assumed to be 0, and \glscurrentfieldvalue is set accordingly. -

    To test if the value is non-zero: -


    To test if the value is non-zero: +


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

    -

    +

    Alternatively, you can test if the field expands to a specific number using: -



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

    -

    +

    This does ⟨true⟩ if the field value equals ⟨n⟩ (using \ifnum for the comparison) otherwise it does ⟨false⟩. -

    The

    The glossaries package provides \glsfieldfetch 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  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 ⟨glossaries 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  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 list, you can use the following command that adds an item to the field using @@ -18913,7 +19071,7 @@ list, you can use the following command that adds an item to the field using class="cmss-10">etoolbox’s \listcsadd: -



    \glsxtrfieldlistadd  }{item}

    -

    +

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



    \glsxtrfieldlistgadd  }{item}

    -

    -


    +


    \glsxtrfieldlisteadd  }{item}

    -

    -


    +


    \glsxtrfieldlistxadd  }{item}

    -

    +

    You can then iterate over the list using: -



    \glsxtrfielddolistloop  }{field}

    -

    +

    or -



    \glsxtrfieldforlistloop  } 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  } class="cmtt-10">{⟨false}

    -

    +

    and \xifinlistcs -



    \glsxtrfieldxifinlist  true}{false}

    -

    -

    See the

    +

    See the etoolbox’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  }{handler}

    -

    +

    where again ⟨handler⟩ is a control sequence that takes a single argument. Unlike the \@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. -

    As from version 1.32, if the field given by -


    As from version 1.32, if the field given by +


    \GlsXtrForeignTextField  \GlsXtrForeignTextField

    -

    +

    (which defaults to userii) contains a locale tag, then -



    \GlsXtrForeignText  entry label}{text}

    -

    +

    can be used to encapsulate ⟨text⟩ in \foreignlanguage{text⟩. For example:

    -
    +
    \documentclass{article}  
    \usepackage[main=british,brazilian,ngerman]{babel}  
    \usepackage{glossaries-extra} @@ -19173,31 +19331,31 @@ class="cmti-10">text⟩. For example:  
    \gls{abnt}, \gls{din}.  
    \end{document}
    -

    -

    When using the

    +

    When using the record 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 @@ -19279,8 +19437,8 @@ the definition of \glsgroupskip to avoid the “Incomplete \iftrue” error that may otherwise occur. -

    There’s also a starred form -


    There’s also a starred form +


    \printunsrtglossary*  options]{code}

    -

    +

    which is equivalent to

    \endgroup class="cmtt-10">\glossarypreamble, the supplied ⟨code⟩ is done before the glossary header. -

    This means you now have the option to simply list all entries on the first +

    This means you now have the option to simply list all entries on the first LATEX run without the need for a post-processor, however there will be no §9 bib2gls: Managing Reference Databases). -

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

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

    +

    -

    There’s a difference in behaviour depending on whether or not the

    There’s a difference in behaviour depending on whether or not the group key is defined. If not defined (default), the group label will be formed from the first @@ -19342,7 +19500,7 @@ class="cmsy-10">§2.10 Glossary Style Modifications. This can lead to an odd effect if you are using a style that separates letter groups when the ordering isn’t alphabetical. -

    If the

    If the group key is defined (which it is with the group field is non-empty, then the corresponding title is obtained as described earlier. -

    If you want to use a different field, you can redefine -


    If you want to use a different field, you can redefine +


    \glsxtrgroupfield  \glsxtrgroupfield

    -

    +

    to the relevant internal field label, but the group bib2glssecondarygroup internal field.) -

    If you have any entries with the

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

    For example: +

    For example:

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

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

    If you allow document definitions with the

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

    If you allow document definitions with the docdefs option, the document will require a second LATEX run if the entries are defined after \printunsrtglossary. -

    The optional argument is as for

    The optional argument is as for \printnoidxglossary (except for the sort key, which isn’t available). -

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


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


    \printunsrtglossaries  \printunsrtglossaries

    -

    +

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

    To avoid complications caused by

    To avoid complications caused by tabular-like glossary styles,



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

    -

    +

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



    \printunsrtglossaryskipentry  \printunsrtglossaryskipentry

    -

    +

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

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

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



    \printunsrtglossarypredoglossary  \printunsrtglossarypredoglossary

    -

    +

    -

    The internal command uses -


    The internal command uses +


    \printunsrtglossaryhandler  \printunsrtglossaryhandler{label}

    -

    +

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

    By default the handler just does -


    By default the handler just does +


    \glsxtrunsrtdo  \glsxtrunsrtdo{label}

    -

    +

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

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

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



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

    -

    +

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

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

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

    -

    For example, if the preamble includes: +

    +

    For example, if the preamble includes:

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

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

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

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

    -

    Alternatively you can use the starred form of

    +

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

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

    -

    If you are using the

    +

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

    +
    \printunsrtglossary*{%  
      \renewcommand{\printunsrtglossaryhandler}[1]{%  
        \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -19600,14 +19758,14 @@ duplicate hypertarget names. For example:  
      }%  
      \ifcsundef{theHsection}%  
      {% - 
        \renewcommand*{\glolinkprefix}{record.#2.\csuse{thesection}.}% + 
        \renewcommand*{\glolinkprefix}{record.\csuse{thesection}.}%  
      }%  
      {% - 
        \renewcommand*{\glolinkprefix}{record.#2.\csuse{theHsection}.}% + 
        \renewcommand*{\glolinkprefix}{record.\csuse{theHsection}.}%  
      }%  
    }
    -

    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: @@ -19615,7 +19773,7 @@ better approach to use:

    -
    +
    \printunsrtglossary*{%  
      \renewcommand{\printunsrtglossaryhandler}[1]{%  
        \glsxtrfieldxifinlist{#1}{record.section}{\thesection} @@ -19624,21 +19782,21 @@ better approach to use:  
      }%  
      \ifcsundef{theHsection}%  
      {% - 
        \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{thesection}.}}% + 
        \setkeys{printgloss}{targetnameprefix={record.\csuse{thesection}.}}%  
      }%  
      {% - 
        \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{theHsection}.}}% + 
        \setkeys{printgloss}{targetnameprefix={record.\csuse{theHsection}.}}%  
      }%  
    }
    -

    -

    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} @@ -19647,18 +19805,18 @@ the glossary header and add some vertical space afterwards:  
      }%  
      \ifcsundef{theHsection}%  
      {% - 
        \renewcommand*{\glolinkprefix}{record.#2.\csuse{thesection}.}% + 
        \renewcommand*{\glolinkprefix}{record.\csuse{thesection}.}%  
      }%  
      {% - 
        \renewcommand*{\glolinkprefix}{record.#2.\csuse{theHsection}.}% + 
        \renewcommand*{\glolinkprefix}{record.\csuse{theHsection}.}%  
      }%  
      \renewcommand*{\glossarysection}[2][]{}%  
      \appto\glossarypostamble{\glspar\medskip\glspar}%  
    }
    -

    -

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


    +

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


    \printunsrtglossaryunit  counter name}

    -

    +

    The above example can simply be replaced with:

    -
    +
    \printunsrtglossaryunit{section}
    -

    -

    This shortcut command is actually defined to use

    +

    This shortcut command is actually defined to use \printunsrtglossary* with -



    \printunsrtglossaryunitsetup  counter name}

    -

    +

    so if you want to just make some minor modifications you can do

    -
    +
    \printunsrtglossary*{\printunsrtglossaryunitsetup{section}%  
      \renewcommand*{\glossarysection}[2][]{\subsection*{Summary}}%  
    }
    -

    which will start the list with a subsection header with the title “Summary” +

    which will start the list with a subsection header with the title “Summary” (overriding the glossary’s title). -

    Note that this shortcut command is only available with the

    Note that this shortcut command is only available with the record (or @@ -19713,7 +19871,7 @@ href="#styopt.record">record=alsoindex) package option. -

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

    This temporary change in the hypertarget prefix means you need to explicitly use \hyperlink to create a link to it as commands like \gls will try to link to the target @@ -19725,12 +19883,12 @@ the front or back matter) which can be the target for all glossary references an just use \printunsrtglossaryunit for a quick summary at the start of a section etc. -

    +

    -

    Top

    10.3 Standalone Entry Items

    -

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

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

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

    define your entries +

    define your entries

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

    and then later in the text: +

    and then later in the text:

    -
    +
    \displayterm{function}
    -

    -

    However, if may be that you want to use

    +

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



    \glsxtrglossentry  \glsxtrglossentry{label}

    -

    +

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

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

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

    • Defines \printglossary and may be used by style hooks. class="cmtt-10">\glsentryitem and \glssubentryitem. The value is obtained by fully expanding: -



      \GlsXtrStandaloneGlossaryType  \GlsXtrStandaloneGlossaryType

      -

      +

      which defaults to the value of the type field for the current entry. @@ -19838,7 +19996,7 @@ class="cmss-10">subentrycounter\glsentryitem{⟨label}

    -

    otherwise it does (as from v1.31)

    +

    otherwise it does (as from v1.31)

    -

    If you have used

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



    \glsxtractivatenopost  \glsxtractivatenopost

    -

    +

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

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

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

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



    \glsxtrglossentryother  }{field}

    -

    +

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

-

The

The \glsxtrglossentryother command internally uses \glossentrynameother{label}

(for example, \glssymbolaccessdisplay). -

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

This means that my custom command can be changed to:

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

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

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

+ -

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

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

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

It’s now possible to not only use

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

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

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

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

(Note the grouping to localise

(Note the grouping to localise \glsxtractivatenopost.) -

You can also use

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

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

This will use

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

+

-

Top

10.4 Entry Aliases

-

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

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

If an entry ⟨

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

-

The index suppression trigger is performed by -


The index suppression trigger is performed by +


\glsxtrsetaliasnoindex  \glsxtrsetaliasnoindex

-

+

This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts @@ -20174,49 +20332,49 @@ class="cmss-10">=only, \glsxtrsetaliasnoindex will default to do nothing. -

Within the definition of

Within the definition of \glsxtrsetaliasnoindex you can use -



\glsxtrindexaliased  \glsxtrindexaliased

-

+

to index ⟨entry-2⟩. -

The index suppression command can be redefined to index the main term instead. +

The index suppression command can be redefined to index the main term instead. For example:

-
+
\renewcommand{\glsxtrsetaliasnoindex}{%  
 \glsxtrindexaliased  
 \setkeys{glslink}{noindex}%  
}
-

-

The value of the

+

The value of the alias field can be accessed using -



\glsxtralias  \glsxtralias{label}

-

+

-

-

+

Top

11. Supplemental Packages

-

The

The glossaries bundle provides additional support packages glossaries-prefix (for @@ -20225,10 +20383,10 @@ class="cmss-10">glossaries-accsupp (for accessibility support). These packages aren’t automatically loaded.

-

Top

11.1 Prefixes or Determiners

-

If prefixing is required, you can simply load

If prefixing is required, you can simply load glossaries-prefix after glossaries-extra. For @@ -20237,7 +20395,7 @@ example:

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

-

+

+

-

Top

11.2 Accessibility Support

-

The

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

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

If you don’t load

If you don’t load glossaries-accsupp or you load glossaries-accsuppxxx⟩ commands described below will simply be equiv corresponding \glsentryxxx⟩ commands. -

The following

The following \glsaccessxxx⟩ commands add accessibility information wrapped around the corresponding \glsentryxxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information. -



\glsaccessname  \glsaccessname{label}

-

+

This displays the value of the name field for the entry identified by ⟨label⟩. -

If the

If the glossaries-accsupp package isn’t loaded, this is simply defined as:

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

otherwise it’s defined as: +

otherwise it’s defined as:

-
+
\newcommand*{\glsaccessname}[1]{%  
  \glsnameaccessdisplay  
  {% @@ -20329,20 +20487,20 @@ class="cmss-10">glossaries-accsupp  {#1}%  
}
-

(

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



\Glsaccessname  \Glsaccessname{label}

-

+

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

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

With the

With the glossaries-accsupp package this is defined as:

-
+
\newcommand*{\Glsaccessname}[1]{%  
  \glsnameaccessdisplay  
  {% @@ -20369,112 +20527,112 @@ class="cmss-10">glossaries-accsupp  {#1}%  
}
-

-

The following commands are all defined in an analogous manner. -


+

The following commands are all defined in an analogous manner. +


\glsaccesstext  \glsaccesstext{label}

-

+

This displays the value of the text field. -



\Glsaccesstext  \Glsaccesstext{label}

-

+

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



\glsaccessplural  \glsaccessplural{label}

-

+

This displays the value of the plural field. -



\Glsaccessplural  \Glsaccessplural{label}

-

+

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



\glsaccessfirst  \glsaccessfirst{label}

-

+

This displays the value of the first field. -



\Glsaccessfirst  \Glsaccessfirst{label}

-

+

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



\glsaccessfirstplural  \glsaccessfirstplural{label}

-

+

This displays the value of the firstplural field. -



\Glsaccessfirstplural  \Glsaccessfirstplural{label}

-

+

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



\glsaccesssymbol  \glsaccesssymbol{label}

-

+

This displays the value of the symbol field. -



\Glsaccesssymbol  }

-

+

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



\glsaccesssymbolplural  \glsaccesssymbolplural{label}

-

+

This displays the value of the symbolplural field. -



\Glsaccesssymbolplural  \Glsaccesssymbolplural{label}

-

+

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



\glsaccessdesc  \glsaccessdesc{label}

-

+

This displays the value of the desc field. -



\Glsaccessdesc  \Glsaccessdesc{label}

-

+

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



\glsaccessdescplural  \glsaccessdescplural{label}

-

+

This displays the value of the descplural field. -



\Glsaccessdescplural  \Glsaccessdescplural{label}

-

+

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



\glsaccessshort  \glsaccessshort{label}

-

+

This displays the value of the short field. -



\Glsaccessshort  \Glsaccessshort{label}

-

+

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



\glsaccessshortpl  \glsaccessshortpl{label}

-

+

This displays the value of the shortplural field. -



\Glsaccessshortpl  \Glsaccessshortpl{label}

-

+

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



\glsaccesslong  \glsaccesslong{label}

-

+

This displays the value of the long field. -



\Glsaccesslong  \Glsaccesslong{label}

-

+

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



\glsaccesslongpl  }

-

+

This displays the value of the longplural field. -



\Glsaccesslongpl  \Glsaccesslongpl{label}

-

+

This displays the value of the longplural field with the first letter converted to upper @@ -20657,11 +20815,11 @@ case.

-

-

+

Top

12. Sample Files

-

The following sample files are provided with this package: +

The following sample files are provided with this package:

sample.tex
sample-suppl-hyp.tex. -

-

+

Top

13. Multi-Lingual Support

-

There’s only one command provided by

There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname\acronymname (provided by glossaries). -

You can redefine it in the usual way. For example: +

You can redefine it in the usual way. For example:

-
+
\renewcommand*{\abbreviationsname}{List of Abbreviations}
-

Or using

Or using babel or polyglossiapolyglossia -

+
\appto\captionsenglish{%  
 \renewcommand*{\abbreviationsname}{List of Abbreviations}%  
}
-

-

Alternatively you can use the

+

Alternatively you can use the title key when you print the list of abbreviations. For example: @@ -21004,21 +21162,21 @@ 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 (whose filename is in the form glossariesxtr-Latn, associated with the given dialect. There’s no warning if the associated file isn’t found. The script file is loaded after the dialect file. -

If you want to write your own language module, you just need to create a file +

If you want to write your own language module, you just need to create a file called glossariesxtr-langtracklang package). For example, glossariesxtr-french.ldf. -

The simplest code for this file is: +

The simplest code for this file is:

-
+
\ProvidesGlossariesExtraLang{french}[2015/12/09 v1.0]  
\newcommand*{\glossariesxtrcaptionsfrench}{%  
 \def\abbreviationsname{Abr\'eviations}% @@ -21079,8 +21237,8 @@ class="cmtt-10">glossariesxtr-french.ldf.  
  {}%  
}
-

-

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. You can @@ -21096,16 +21254,16 @@ class="cmsy-10">§9.3 The glossaries-extra-bib2gls package for further details. -

This

This .ldf file then needs to be put somewhere on TEX’s path so that it can be found by glossaries-extra. You might also want to consider uploading it to CTAN so that it can be useful to others. (Please don’t send it to me. I already have more packages than I am able to maintain.) -

If you additionally want to provide translations for the diagnostic messages used +

If you additionally want to provide translations for the diagnostic messages used when a glossary is missing, you need to redefine the following commands: -



\GlsXtrNoGlsWarningHead  }{file}

-

+

This produces the following text in English:

-

This document is incomplete. The external file associated with the +

This document is incomplete. The external file associated with the glossary ‘⟨label⟩’ (which should be called ⟨file⟩) hasn’t been created.

-



\GlsXtrNoGlsWarningEmptyStart  \GlsXtrNoGlsWarningEmptyStart

-

+

This produces the following text in English:

-

This has probably happened because there are no entries defined in +

This has probably happened because there are no entries defined in this glossary.

-



\GlsXtrNoGlsWarningEmptyMain  \GlsXtrNoGlsWarningEmptyMain

-

+

This produces the following text in English:

-

If you don’t want this glossary, add

If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:

-



\GlsXtrNoGlsWarningEmptyNotMain  \GlsXtrNoGlsWarningEmptyNotMain{label}

-

+

This produces the following text in English:

-

Did you forget to use

Did you forget to use type=label⟩ when you defined your entries? If you tried to load entries into this glossary with ] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.

-



\GlsXtrNoGlsWarningCheckFile  \GlsXtrNoGlsWarningCheckFile{file}

-

+

This produces the following text in English:

-

Check the contents of the file ⟨

Check the contents of the file ⟨file⟩. If it’s empty, that means you haven’t indexed any of your entries in this glossary (using commands like \gls or \glsadd) so this list can’t be generated. If the file isn’t empty, the document build process hasn’t been completed.

-



\GlsXtrNoGlsWarningMisMatch  \GlsXtrNoGlsWarningMisMatch

-

+

This produces the following text in English:

-

You need +

You need to either replace \makenoidxglossaries with \makeglossaries or @@ -21210,17 +21368,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 automake325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 390
+class="cmbx-10">396
bib2gls  391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 471
+class="cmbx-10">483

C categories:
    abbreviation  472, 473, 474, 475, 476
+href="glossaries-extra-manual.html#dx1-9005" >484, 485, 486, 487, 488
    acronym  477, 478, 479, 480, 481
+href="glossaries-extra-manual.html#dx1-16022" >489, 490, 491, 492, 493
    general  482, 483, 484, 485, 486, 487, 488, 489
+href="glossaries-extra-manual.html#dx1-8037" >494, 495, 496, 497, 498, 499, 500, 501
    index  490, 491
+href="glossaries-extra-manual.html#dx1-5047" >502, 503
    number  492
+href="glossaries-extra-manual.html#dx1-28018" >504
    symbol  493, 494
+href="glossaries-extra-manual.html#dx1-8045" >505, 506
category attributes:
    accessaposplural  495, 496, 497
+href="glossaries-extra-manual.html#dx1-28099" >507, 508, 509
    accessinsertdots  498
+href="glossaries-extra-manual.html#dx1-28080" >510
    accessnoshortplural  499
+href="glossaries-extra-manual.html#dx1-28110" >511
    aposplural  500, 501, 502, 503, 504, 505, 506, 507
+href="glossaries-extra-manual.html#dx1-11036" >512, 513, 514, 515, 516, 517, 518, 519
    discardperiod  508, 509, 510, 511, 512
+href="glossaries-extra-manual.html#dx1-8032" >520, 521, 522, 523, 524
    dualindex  513, 514, 515, 516, 517, 518, 519
+href="glossaries-extra-manual.html#dx1-28148" >525, 526, 527, 528, 529, 530, 531
    entrycount  520, 521, 522, 523, 524, 525, 526, 527, 528, 529, 530
+href="glossaries-extra-manual.html#dx1-9004" >532, 533, 534, 535, 536, 537, 538, 539, 540, 541, 542
    externallocation  531
+href="glossaries-extra-manual.html#dx1-6051" >543, 544, 545, 546
    firstshortaccess  532
+href="glossaries-extra-manual.html#dx1-28096" >547
    glossdesc  533, 534, 535
+href="glossaries-extra-manual.html#dx1-16004" >548, 549, 550
    glossdescfont  536, 537
+href="glossaries-extra-manual.html#dx1-16005" >551, 552
    glossname  538, 539, 540
+href="glossaries-extra-manual.html#dx1-16003" >553, 554, 555
    glossnamefont  541, 542, 543
+href="glossaries-extra-manual.html#dx1-16009" >556, 557, 558
    headuc  544, 545, 546, 547
+href="glossaries-extra-manual.html#dx1-12059" >559, 560, 561, 562
    hyperoutside  548, 549
+href="glossaries-extra-manual.html#dx1-6018" >563, 564
    indexname  550, 551, 552, 553, 554
+href="glossaries-extra-manual.html#dx1-16014" >565, 566, 567, 568, 569
    indexonlyfirst  555, 556, 557
+href="glossaries-extra-manual.html#dx1-6006" >570, 571, 572
    insertdots  558, 559, 560, 561
+href="glossaries-extra-manual.html#dx1-19004" >573, 574, 575, 576
    linkcount  562, 563, 564
+href="glossaries-extra-manual.html#dx1-28124" >577, 578, 579
    linkcountmaster  565, 566
+href="glossaries-extra-manual.html#dx1-28126" >580, 581
    markshortwords  567, 568
+href="glossaries-extra-manual.html#dx1-28061" >582, 583
    markwords  569, 570, 571, 572, 573, 574
+href="glossaries-extra-manual.html#dx1-25212" >584, 585, 586, 587, 588, 589
    nameshortaccess  575
+href="glossaries-extra-manual.html#dx1-28087" >590
    nohyper  576, 577, 578
+href="glossaries-extra-manual.html#dx1-28034" >591, 592, 593
    nohyperfirst  579, 580, 581, 582, 583
+href="glossaries-extra-manual.html#dx1-25148" >594, 595, 596, 597, 598
    noshortplural  584, 585, 586, 587, 588, 589
+href="glossaries-extra-manual.html#dx1-11037" >599, 600, 601, 602, 603, 604
    pluraldiscardperiod  590, 591
+href="glossaries-extra-manual.html#dx1-28048" >605, 606
    recordcount  592, 593, 594, 595
+href="glossaries-extra-manual.html#dx1-39019" >607, 608, 609, 610
    regular  596, 597, 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
+href="glossaries-extra-manual.html#dx1-8010" >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
    retainfirstuseperiod  628
+href="glossaries-extra-manual.html#dx1-28050" >643
    tagging  629, 630, 631, 632
+href="glossaries-extra-manual.html#dx1-20002" >644, 645, 646, 647
    targetcategory  633
+href="glossaries-extra-manual.html#dx1-28157" >648
    targetname  634, 635
+href="glossaries-extra-manual.html#dx1-28154" >649, 650
    targeturl  636, 637, 638, 639, 640
+href="glossaries-extra-manual.html#dx1-5014" >651, 652, 653, 654, 655
    textformat  641, 642, 643, 644, 645
+href="glossaries-extra-manual.html#dx1-6019" >656, 657, 658, 659, 660
    textshortaccess  646
+href="glossaries-extra-manual.html#dx1-28093" >661
    unitcount  647
+href="glossaries-extra-manual.html#dx1-30034" >662
    wrgloss  648, 649
+href="glossaries-extra-manual.html#dx1-6014" >663, 664
\cGLS  650
+class="cmti-10">665
\cGLSformat  651
+class="cmti-10">666
\cGLSpl  652
+class="cmti-10">667
\cGLSplformat  653
+class="cmti-10">668
convertgls2bib  654
+href="glossaries-extra-manual.html#dx1-34005" >669
\csGlsXtrLetField  655
+class="cmti-10">670
\CustomAbbreviationFields  656
+class="cmti-10">671

D datatool-base package  657
+href="glossaries-extra-manual.html#dx1-10" >672

E \eglssetwidest  658
+class="cmti-10">673
\eglsupdatewidest  659
+class="cmti-10">674
\eGlsXtrSetField  660
+class="cmti-10">675
entry location  661, 662, 663
+class="cmbx-10">676, 677, 678
entrycounter package  664
+href="glossaries-extra-manual.html#dx1-43018" >679
equation (counter)  665, 666
+href="glossaries-extra-manual.html#dx1-4125" >680, 681
etoolbox package  667, 668, 669, 670, 671, 672, 673, 674, 675
+href="glossaries-extra-manual.html#dx1-6" >682, 683, 684, 685, 686, 687, 688, 689, 690

F fancyhdr package  676
+href="glossaries-extra-manual.html#dx1-14052" >691
first use  677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689, 690, 691, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711, 712, 713, 714, 715, 716, 717, 718, 719, 720, 721, 722, 723, 724, 725, 726, 692, 693, 694, 695, 696, 697, 698, 699, 700, 701, 702, 703, 704, 705, 706, 707, 708, 709, 710, 711, 712, 713, 714, 715, 716, 717, 718, 719, 720, 721, 722, 723, 724, 725, 726, 727, 728, 729, 730, 731, 732, 733, 734, 735, 736, 737, 738, 739, 740, 741, 727, 728, 729
+class="cmbx-10">742, 743, 744
first use flag  730, 731, 732, 733, 734, 735, 745, 746, 747, 748, 749, 750, 736
+class="cmbx-10">751
first use text  737, 738
+class="cmbx-10">752, 753
fontenc package  739
+href="glossaries-extra-manual.html#dx1-23024" >754

G \gglssetwidest  740
+class="cmti-10">755
\gglsupdatewidest  741
+class="cmti-10">756
\gGlsXtrSetField  742
+class="cmti-10">757
glossaries package  743, 744, 745, 746, 747, 748, 749, 750, 751, 752, 753, 754, 755, 756, 757
+href="glossaries-extra-manual.html#dx1-5035" >758, 759, 760, 761, 762, 763, 764, 765, 766, 767, 768, 769, 770, 771, 772
glossaries-accsupp package  758, 759, 760, 761, 762, 763, 764, 765, 766, 767, 768, 769, 770, 771, 772, 773, 774
+href="glossaries-extra-manual.html#dx1-4036" >773, 774, 775, 776, 777, 778, 779, 780, 781, 782, 783, 784, 785, 786, 787, 788, 789
glossaries-extra package  775, 776, 777
+href="glossaries-extra-manual.html#dx1-5037" >790, 791, 792
glossaries-extra-bib2gls package  778, 779, 780, 781, 782, 783, 784, 785, 786
+href="glossaries-extra-manual.html#dx1-4082" >793, 794, 795, 796, 797, 798, 799, 800, 801
glossaries-extra-stylemods package  787, 788, 789, 790, 791, 792, 793, 794
+href="glossaries-extra-manual.html#dx1-4027" >802, 803, 804, 805, 806, 807, 808, 809
glossaries-prefix package  795, 796, 797
+href="glossaries-extra-manual.html#dx1-45001" >810, 811, 812
\glossariesextrasetup  798
+class="cmti-10">813
glossary styles:
    altlist  799, 800
+href="glossaries-extra-manual.html#dx1-18023" >814, 815
    alttree  801, 802, 803, 804, 805, 806, 807, 808
+href="glossaries-extra-manual.html#dx1-18050" >816, 817, 818, 819, 820, 821, 822, 823
    bookindex  809, 810, 811, 812
+href="glossaries-extra-manual.html#dx1-14002" >824, 825, 826, 827
    index  813
+href="glossaries-extra-manual.html#dx1-18038" >828
    inline  814, 815
+href="glossaries-extra-manual.html#dx1-18006" >829, 830
    list  816, 817, 818
+href="glossaries-extra-manual.html#dx1-18018" >831, 832, 833
    listdotted  819, 820
+href="glossaries-extra-manual.html#dx1-18024" >834, 835
    long  821
+href="glossaries-extra-manual.html#dx1-18012" >836
    long3col  822
+href="glossaries-extra-manual.html#dx1-18004" >837
    mcolindexgroup  823
+href="glossaries-extra-manual.html#dx1-14003" >838
    tree  824, 825
+href="glossaries-extra-manual.html#dx1-18039" >839, 840
    treenoname  826, 827, 828
+href="glossaries-extra-manual.html#dx1-18044" >841, 842, 843
glossary-bookindex package  829, 830
+href="glossaries-extra-manual.html#dx1-14001" >844, 845
glossary-inline package  831
+href="glossaries-extra-manual.html#dx1-18007" >846
glossary-tree package  832, 833, 834, 835, 836
+href="glossaries-extra-manual.html#dx1-14045" >847, 848, 849, 850, 851
\glossentrynameother  837
+class="cmti-10">852
\glossxtrsetpopts  838
+class="cmti-10">853
\glsabbrvdefaultfont  839, 854, 840
+class="cmti-10">855
\glsabbrvemfont  841
+class="cmti-10">856
\glsabbrvfont  842
+class="cmti-10">857
\glsabbrvhyphenfont  843
+class="cmti-10">858
\glsabbrvonlyfont  844
+class="cmti-10">859
\glsabbrvscfont  845
+class="cmti-10">860
\glsabbrvsmfont  846
+class="cmti-10">861
\glsabbrvuserfont  847, 862, 848
+class="cmti-10">863
\Glsaccessdesc  849
+class="cmti-10">864
\glsaccessdesc  850
+class="cmti-10">865
\Glsaccessdescplural  851
+class="cmti-10">866
\glsaccessdescplural  852
+class="cmti-10">867
\Glsaccessfirst  853
+class="cmti-10">868
\glsaccessfirst  854
+class="cmti-10">869
\Glsaccessfirstplural  855
+class="cmti-10">870
\glsaccessfirstplural  856
+class="cmti-10">871
\Glsaccesslong  857
+class="cmti-10">872
\glsaccesslong  858
+class="cmti-10">873
\Glsaccesslongpl  859
+class="cmti-10">874
\glsaccesslongpl  860
+class="cmti-10">875
\Glsaccessname  861
+class="cmti-10">876
\glsaccessname  862
+class="cmti-10">877
\Glsaccessplural  863
+class="cmti-10">878
\glsaccessplural  864
+class="cmti-10">879
\Glsaccessshort  865
+class="cmti-10">880
\glsaccessshort  866
+class="cmti-10">881
\Glsaccessshortpl  867
+class="cmti-10">882
\glsaccessshortpl  868
+class="cmti-10">883
\Glsaccesssymbol  869
+class="cmti-10">884
\glsaccesssymbol  870
+class="cmti-10">885
\Glsaccesssymbolplural  871
+class="cmti-10">886
\glsaccesssymbolplural  872
+class="cmti-10">887
\Glsaccesstext  873
+class="cmti-10">888
\glsaccesstext  874
+class="cmti-10">889
\glsacspace  875
+class="cmti-10">890
\glsacspacemax  876
+class="cmti-10">891
\glsadd options
    format  877
+href="glossaries-extra-manual.html#dx1-8075" >892
    theHvalue  878, 879
+href="glossaries-extra-manual.html#dx1-6036" >893, 894
    thevalue  880, 881, 882, 883, 884
+href="glossaries-extra-manual.html#dx1-6035" >895, 896, 897, 898, 899
\glsaddeach  885
+class="cmti-10">900
\glsaddpostsetkeys  886
+href="glossaries-extra-manual.html#dx1-6032" >901
\glsaddpresetkeys  887
+href="glossaries-extra-manual.html#dx1-6031" >902
\glscapturedgroup  888
+class="cmti-10">903
\glscategory  889
+class="cmti-10">904
\glscategorylabel  890
+class="cmti-10">905
\glscurrententrylabel  891
+class="cmti-10">906
\glscurrentfieldvalue  892
+class="cmti-10">907
\glsdefpostdesc  893
+class="cmti-10">908
\glsdefpostlink  894
+class="cmti-10">909
\glsdefpostname  895
+class="cmti-10">910
\glsentrycurrcount  896
+class="cmti-10">911
\glsentryprevcount  897
+class="cmti-10">912
\glsentryprevmaxcount  898
+class="cmti-10">913
\glsentryprevtotalcount  899
+class="cmti-10">914
\glsextrapostnamehook  900
+class="cmti-10">915
\glsFindWidestAnyName  901
+class="cmti-10">916
\glsFindWidestAnyNameLocation  902
+class="cmti-10">917
\glsFindWidestAnyNameSymbol  903
+class="cmti-10">918
\glsFindWidestAnyNameSymbolLocation  904
+class="cmti-10">919
\glsFindWidestLevelTwo  905
+class="cmti-10">920
\glsFindWidestTopLevelName  906
+class="cmti-10">921
\glsFindWidestUsedAnyName  907
+class="cmti-10">922
\glsFindWidestUsedAnyNameLocation  908
+class="cmti-10">923
\glsFindWidestUsedAnyNameSymbol  909
+class="cmti-10">924
\glsFindWidestUsedAnyNameSymbolLocation  910
+class="cmti-10">925
\glsFindWidestUsedLevelTwo  911
+class="cmti-10">926
\glsFindWidestUsedTopLevelName  912
+class="cmti-10">927
\glsfirstabbrvdefaultfont  913
+class="cmti-10">928
\glsfirstabbrvemfont  914
+class="cmti-10">929
\glsfirstabbrvfont  915
+class="cmti-10">930
\glsfirstabbrvhyphenfont  916
+class="cmti-10">931
\glsfirstabbrvonlyfont  917
+class="cmti-10">932
\glsfirstabbrvsmfont  918
+class="cmti-10">933
\glsfirstabbrvuserfont  919
+class="cmti-10">934
\glsfirstlongdefaultfont  920
+class="cmti-10">935
\glsfirstlongemfont  921
+class="cmti-10">936
\glsfirstlongfont  922
+class="cmti-10">937
\glsfirstlongfootnotefont  923
+class="cmti-10">938
\glsfirstlonghyphenfont  924
+class="cmti-10">939
\glsfirstlongonlyfont  925
+class="cmti-10">940
\glsfirstlonguserfont  926
+class="cmti-10">941
\Glsfmtfirst  927
+class="cmti-10">942
\glsfmtfirst  928
+class="cmti-10">943
\Glsfmtfirstpl  929
+class="cmti-10">944
\glsfmtfirstpl  930
+class="cmti-10">945
\Glsfmtfull  931
+class="cmti-10">946
\glsfmtfull  932
+class="cmti-10">947
\Glsfmtfullpl  933
+class="cmti-10">948
\glsfmtfullpl  934
+class="cmti-10">949
\Glsfmtlong  935
+class="cmti-10">950
\glsfmtlong  936
+class="cmti-10">951
\Glsfmtlongpl  937
+class="cmti-10">952
\glsfmtlongpl  938
+class="cmti-10">953
\Glsfmtname  939
+class="cmti-10">954
\glsfmtname  940
+class="cmti-10">955
\Glsfmtplural  941
+class="cmti-10">956
\glsfmtplural  942
+class="cmti-10">957
\Glsfmtshort  943
+class="cmti-10">958
\glsfmtshort  944
+class="cmti-10">959
\Glsfmtshortpl  945
+class="cmti-10">960
\glsfmtshortpl  946
+class="cmti-10">961
\Glsfmttext  947
+class="cmti-10">962
\glsfmttext  948
+class="cmti-10">963
\glsforeachwithattribute  949
+href="glossaries-extra-manual.html#dx1-28184" >964
\glsgetattribute  950
+href="glossaries-extra-manual.html#dx1-28167" >965
\glsgetcategoryattribute  951
+href="glossaries-extra-manual.html#dx1-28166" >966
\glsgetwidestname  952
+class="cmti-10">967
\glsgetwidestsubname  953
+class="cmti-10">968
\glshasattribute  954
+href="glossaries-extra-manual.html#dx1-28170" >969
\glshascategoryattribute  955
+href="glossaries-extra-manual.html#dx1-28168" >970
\glshex  956
+class="cmti-10">971
\glsifattribute  957
+href="glossaries-extra-manual.html#dx1-28175" >972
\glsifcategory  958
+class="cmti-10">973
\glsifcategoryattribute  959
+href="glossaries-extra-manual.html#dx1-28171" >974
\glsifnotregular  960
+href="glossaries-extra-manual.html#dx1-28182" >975
\glsifnotregularcategory  961
+href="glossaries-extra-manual.html#dx1-28181" >976
\glsifregular  962
+href="glossaries-extra-manual.html#dx1-28178" >977
\glsifregularcategory  963
+href="glossaries-extra-manual.html#dx1-28177" >978
\glskeylisttok  964
+class="cmti-10">979
\glslabeltok  965
+class="cmti-10">980
\glslink options
    format  966, 967, 968, 969
+href="glossaries-extra-manual.html#dx1-6048" >981, 982, 983, 984
    hyper  970, 971, 972
+href="glossaries-extra-manual.html#dx1-12055" >985, 986, 987
    hyper=false  973
+href="glossaries-extra-manual.html#dx1-27017" >988
    hyperoutside  974, 975
+href="glossaries-extra-manual.html#dx1-6017" >989, 990
    noindex  976, 977, 978, 979, 980, 981, 982
+href="glossaries-extra-manual.html#dx1-6002" >991, 992, 993, 994, 995, 996, 997
    prefix  983, 984
+href="glossaries-extra-manual.html#dx1-5022" >998, 999
    textformat  985, 986
+href="glossaries-extra-manual.html#dx1-6021" >1000, 1001
    theHvalue  987
+href="glossaries-extra-manual.html#dx1-6027" >1002, 1003
    thevalue  988
+href="glossaries-extra-manual.html#dx1-6026" >1004, 1005
    wrgloss  989, 990, 991, 992
+href="glossaries-extra-manual.html#dx1-6010" >1006, 1007, 1008, 1009
\glslinkcheckfirsthyperhook  993
+class="cmti-10">1010
\glslinkpresetkeys  994
+href="glossaries-extra-manual.html#dx1-6029" >1011
\glslistchildpostlocation  995
+class="cmti-10">1012
\glslistchildprelocation  996
+class="cmti-10">1013
\glslistdesc  997
+class="cmti-10">1014
\glslistprelocation  998
+class="cmti-10">1015
\glslocalreseteach  999
+class="cmti-10">1016
\glslocalunseteach  1000
+class="cmti-10">1017
\glslongdefaultfont  1001
+class="cmti-10">1018
\glslongemfont  1002
+class="cmti-10">1019
\glslongfont  1003
+class="cmti-10">1020
\glslongfootnotefont  1004
+class="cmti-10">1021
\glslonghyphenfont  1005
+class="cmti-10">1022
\glslongonlyfont  1006
+class="cmti-10">1023
\glslongpltok  1007
+class="cmti-10">1024
\glslongtok  1008
+class="cmti-10">1025
\glslonguserfont  1009
+class="cmti-10">1026
\glsnoidxdisplayloc  1010
+class="cmti-10">1027
\glsps  1011
+class="cmti-10">1028
\glspt  1012
+class="cmti-10">1029
\glsseeitemformat  1013
+class="cmti-10">1030
\glssetattribute  1014
+href="glossaries-extra-manual.html#dx1-28165" >1031
\glssetcategoryattribute  1015
+href="glossaries-extra-manual.html#dx1-28162" >1032
\glssetregularcategory  1016
+href="glossaries-extra-manual.html#dx1-28164" >1033
\glsshortpltok  1017
+class="cmti-10">1034
\glsshorttok  1018
+class="cmti-10">1035
\glstreechilddesc  1019
+class="cmti-10">1036
\glstreechildprelocation  1020
+class="cmti-10">1037
\glstreechildsymbol  1021
+class="cmti-10">1038
\glstreedefaultnamefmt  1022
+class="cmti-10">1039
\glstreedesc  1023
+class="cmti-10">1040
\glstreenonamechilddesc  1024
+class="cmti-10">1041
\glstreenonamedesc  1025
+class="cmti-10">1042
\glstreenonamesymbol  1026
+class="cmti-10">1043
\glstreeprelocation  1027
+class="cmti-10">1044
\glstreesymbol  1028
+class="cmti-10">1045
\glsupdatewidest  1029
+class="cmti-10">1046
\glsuseabbrvfont  1030
+class="cmti-10">1047
\glsuselongfont  1031
+class="cmti-10">1048
\glsuserdescription  1032
+class="cmti-10">1049
\Glsxtr  1033
+class="cmti-10">1050
\glsxtr  1034
+class="cmti-10">1051
\glsxtrabbreviationfont  1035
+class="cmti-10">1052
\glsxtrabbrvfootnote  1036
+class="cmti-10">1053
\glsxtrabbrvpluralsuffix  1037, 1054, 1038
+class="cmti-10">1055
\glsxtractivatenopost  1039
+class="cmti-10">1056
\glsxtraddallcrossrefs  1040
+class="cmti-10">1057
\glsxtralias  1041
+class="cmti-10">1058
\glsxtrAltTreeIndent  1042
+class="cmti-10">1059
\glsxtralttreeInit  1043
+class="cmti-10">1060
\glsxtralttreeSubSymbolDescLocation  1044
+class="cmti-10">1061
\glsxtralttreeSymbolDescLocation  1045
+class="cmti-10">1062
\glsxtrautoindex  1046
+href="glossaries-extra-manual.html#dx1-32025" >1063
\glsxtrautoindexassignsort  1047
+href="glossaries-extra-manual.html#dx1-32021" >1064
\glsxtrautoindexentry  1048
+href="glossaries-extra-manual.html#dx1-32020" >1065
+\glsxtrautoindexesc  1066
\glsxtrBasicDigitrules  1049
+href="glossaries-extra-manual.html#dx1-37094" >1067
\GlsXtrBibTeXEntryAliases  1050
+class="cmti-10">1068
\glsxtrbookindexatendgroup  1051
+href="glossaries-extra-manual.html#dx1-14035" >1069
\glsxtrbookindexbetween  1052
+href="glossaries-extra-manual.html#dx1-14030" >1070
\glsxtrbookindexbookmark  1053
-\glsxtrbookindexcols  1054
+href="glossaries-extra-manual.html#dx1-14042" >1071
+\glsxtrbookindexcols  1072
\glsxtrbookindexcolspread  1055
+href="glossaries-extra-manual.html#dx1-14015" >1073
\glsxtrbookindexfirstmark  1056
+href="glossaries-extra-manual.html#dx1-14048" >1074
\glsxtrbookindexfirstmarkfmt  1057
+href="glossaries-extra-manual.html#dx1-14050" >1075
\glsxtrbookindexformatheader  1058
+href="glossaries-extra-manual.html#dx1-14044" >1076
\glsxtrbookindexlastmark  1059
+href="glossaries-extra-manual.html#dx1-14049" >1077
\glsxtrbookindexlastmarkfmt  1060
+href="glossaries-extra-manual.html#dx1-14051" >1078
\glsxtrbookindexmarkentry  1061
+href="glossaries-extra-manual.html#dx1-14047" >1079
\glsxtrbookindexmulticolsenv  1062
+href="glossaries-extra-manual.html#dx1-14020" >1080
\glsxtrbookindexname  1063
+href="glossaries-extra-manual.html#dx1-14021" >1081
\glsxtrbookindexparentchildsep  1064
+href="glossaries-extra-manual.html#dx1-14028" >1082
\glsxtrbookindexparentsubchildsep  1065
+href="glossaries-extra-manual.html#dx1-14029" >1083
\glsxtrbookindexprelocation  1066
+href="glossaries-extra-manual.html#dx1-14023" >1084
\glsxtrbookindexsubatendgroup  1067
+href="glossaries-extra-manual.html#dx1-14034" >1085
\glsxtrbookindexsubbetween  1068
+href="glossaries-extra-manual.html#dx1-14031" >1086
\glsxtrbookindexsubname  1069
+href="glossaries-extra-manual.html#dx1-14022" >1087
\glsxtrbookindexsubprelocation  1070
+href="glossaries-extra-manual.html#dx1-14027" >1088
\glsxtrbookindexsubsubatendgroup  1071
+href="glossaries-extra-manual.html#dx1-14033" >1089
\glsxtrbookindexsubsubbetween  1072
+href="glossaries-extra-manual.html#dx1-14032" >1090
\glsxtrchecknohyperfirst  1073
+class="cmti-10">1091
\glsxtrcombiningdiacriticIIIrules  1074
+href="glossaries-extra-manual.html#dx1-37086" >1092
\glsxtrcombiningdiacriticIIrules  1075
+href="glossaries-extra-manual.html#dx1-37085" >1093
\glsxtrcombiningdiacriticIrules  1076
+href="glossaries-extra-manual.html#dx1-37084" >1094
\glsxtrcombiningdiacriticIVrules  1077
+href="glossaries-extra-manual.html#dx1-37087" >1095
\glsxtrcombiningdiacriticrules  1078
+href="glossaries-extra-manual.html#dx1-37083" >1096
\glsxtrcontrolrules  1079
+href="glossaries-extra-manual.html#dx1-37078" >1097
\glsxtrcopytoglossary  1080
+class="cmti-10">1098
\glsxtrcurrencyrules  1081
+href="glossaries-extra-manual.html#dx1-37091" >1099
\glsxtrdeffield  1082
+class="cmti-10">1100
\glsxtrdetoklocation  1083
+class="cmti-10">1101
\glsxtrdigitrules  1084
+href="glossaries-extra-manual.html#dx1-37093" >1102
\glsxtrdisplayendloc  1085
+class="cmti-10">1103
\glsxtrdisplayendlochook  1086
+class="cmti-10">1104
\glsxtrdisplaysingleloc  1087
+class="cmti-10">1105
\glsxtrdisplaystartloc  1088
+class="cmti-10">1106
+\glsxtrdisplaysupploc  1107
\glsxtrdoautoindexname  1089
+href="glossaries-extra-manual.html#dx1-32017" >1108
\glsxtrdowrglossaryhook  1090
+href="glossaries-extra-manual.html#dx1-6028" >1109
\glsxtredeffield  1091
+class="cmti-10">1110
\glsxtremsuffix  1092
+class="cmti-10">1111
\GlsXtrEnableEntryCounting  1093
+class="cmti-10">1112
\GlsXtrEnableEntryUnitCounting  1094
+class="cmti-10">1113
\GlsXtrEnableIndexFormatOverride  1095
+href="glossaries-extra-manual.html#dx1-32034" >1114
\GlsXtrEnableInitialTagging  1096
+class="cmti-10">1115
\GlsXtrEnableLinkCounting  1097
+class="cmti-10">1116
\GlsXtrEnableOnTheFly  1098
+class="cmti-10">1117
+ + + \GlsXtrEnablePreLocationTag  1099
+class="cmti-10">1118
\glsxtrenablerecordcount  1100
- - - +class="cmti-10">1119
\glsxtrendfor  1101
+class="cmti-10">1120
\glsxtrentryfmt  1102
+class="cmti-10">1121
\GlsXtrExpandedFmt  1103
+class="cmti-10">1122
\glsxtrfielddolistloop  1104
+class="cmti-10">1123
\glsxtrfieldforlistloop  1105
+class="cmti-10">1124
\glsxtrfieldifinlist  1106
+class="cmti-10">1125
\glsxtrfieldlistadd  1107
+class="cmti-10">1126
\glsxtrfieldlisteadd  1108
+class="cmti-10">1127
\glsxtrfieldlistgadd  1109
+class="cmti-10">1128
\glsxtrfieldlistxadd  1110
+class="cmti-10">1129
\glsxtrfieldtitlecasecs  1111
+class="cmti-10">1130
\glsxtrfieldxifinlist  1112
+class="cmti-10">1131
\glsxtrfmt  1113
+class="cmti-10">1132
\glsxtrfmt*  1114
+class="cmti-10">1133
\GlsXtrFmtDefaultOptions  1115
+class="cmti-10">1134
\glsxtrfmtdisplay  1116
+class="cmti-10">1135
\GlsXtrFmtField  1117
+class="cmti-10">1136
\glsxtrfootnotename  1118
+class="cmti-10">1137
\glsxtrforcsvfield  1119
+class="cmti-10">1138
\GlsXtrForeignText  1120
+class="cmti-10">1139
\GlsXtrForeignTextField  1121
+class="cmti-10">1140
\GlsXtrFormatLocationList  1122
+class="cmti-10">1141
\GlsXtrForUnsetBufferedList  1123
+class="cmti-10">1142
\glsxtrfractionrules  1124
+href="glossaries-extra-manual.html#dx1-37097" >1143
\GLSxtrfull  1125
+class="cmti-10">1144
\Glsxtrfull  1126
+class="cmti-10">1145
\glsxtrfull  1127
+class="cmti-10">1146
\Glsxtrfullformat  1128
+class="cmti-10">1147
\glsxtrfullformat  1129
+class="cmti-10">1148
\GLSxtrfullpl  1130
+class="cmti-10">1149
\Glsxtrfullpl  1131
+class="cmti-10">1150
\glsxtrfullpl  1132
+class="cmti-10">1151
\Glsxtrfullplformat  1133
+class="cmti-10">1152
\glsxtrfullplformat  1134
+class="cmti-10">1153
\glsxtrfullsep  1135
+class="cmti-10">1154
\glsxtrGeneralLatinIIIrules  1136
+href="glossaries-extra-manual.html#dx1-37100" >1155
\glsxtrGeneralLatinIIrules  1137
+href="glossaries-extra-manual.html#dx1-37099" >1156
\glsxtrGeneralLatinIrules  1138
+href="glossaries-extra-manual.html#dx1-37098" >1157
\glsxtrGeneralLatinIVrules  1139
+href="glossaries-extra-manual.html#dx1-37101" >1158
\glsxtrGeneralLatinVIIIrules  1140
+href="glossaries-extra-manual.html#dx1-37105" >1159
\glsxtrGeneralLatinVIIrules  1141
+href="glossaries-extra-manual.html#dx1-37104" >1160
\glsxtrGeneralLatinVIrules  1142
+href="glossaries-extra-manual.html#dx1-37103" >1161
\glsxtrGeneralLatinVrules  1143
+href="glossaries-extra-manual.html#dx1-37102" >1162
\glsxtrgeneralpuncIIrules  1144
+href="glossaries-extra-manual.html#dx1-37092" >1163
+ + + \glsxtrgeneralpuncIrules  1145
+href="glossaries-extra-manual.html#dx1-37090" >1164
\glsxtrgeneralpuncrules  1146
- - - +href="glossaries-extra-manual.html#dx1-37089" >1165
\glsxtrglossentry  1147
+class="cmti-10">1166
\glsxtrglossentryother  1148
+class="cmti-10">1167
\glsxtrgroupfield  1149
+class="cmti-10">1168
\glsxtrhyphenrules  1150
+href="glossaries-extra-manual.html#dx1-37088" >1169
\glsxtrhyphensuffix  1151
+class="cmti-10">1170
\glsxtrifcounttrigger  1152
+class="cmti-10">1171
\glsxtrifcustomdiscardperiod  1153
+class="cmti-10">1172
\GlsXtrIfFieldCmpStr  1154
+class="cmti-10">1173
\GlsXtrIfFieldEqNum  1155
+class="cmti-10">1174
\GlsXtrIfFieldEqStr  1156
+class="cmti-10">1175
\GlsXtrIfFieldEqXpStr  1157
+class="cmti-10">1176
\GlsXtrIfFieldNonZero  1158
+class="cmti-10">1177
\GlsXtrIfFieldUndef  1159
+class="cmti-10">1178
\glsxtrifhasfield  1160
+class="cmti-10">1179
\glsxtrifhasfield*  1161
+class="cmti-10">1180
\GlsXtrIfHasNonZeroChildCount  1162
+class="cmti-10">1181
\glsxtrifkeydefined  1163
+class="cmti-10">1182
\glsxtriflabelinlist  1164
+class="cmti-10">1183
\GlsXtrIfLinkCounterDef  1165
+class="cmti-10">1184
\glsxtrifrecordtrigger  1166
+class="cmti-10">1185
\GlsXtrIfUnusedOrUndefined  1167
+class="cmti-10">1186
\glsxtrifwasfirstuse  1168
+class="cmti-10">1187
\GlsXtrIfXpFieldEqXpStr  1169
+class="cmti-10">1188
\glsxtrinclinkcounter  1170
+class="cmti-10">1189
\glsxtrindexaliased  1171
+class="cmti-10">1190
\GlsXtrIndexCounterLink  1172
+class="cmti-10">1191
\glsxtrindexseealso  1173
+class="cmti-10">1192
\glsxtrinitwrgloss  1174
+class="cmti-10">1193
\Glsxtrinlinefullformat  1175
+class="cmti-10">1194
\glsxtrinlinefullformat  1176
+class="cmti-10">1195
\Glsxtrinlinefullplformat  1177
+class="cmti-10">1196
\glsxtrinlinefullplformat  1178
+class="cmti-10">1197
\glsxtrinsertinsidetrue  1179
+class="cmti-10">1198
\glsxtrLatinA  1180
+href="glossaries-extra-manual.html#dx1-37106" >1199
\glsxtrLatinAA  1181
+href="glossaries-extra-manual.html#dx1-37130" >1200
\glsxtrLatinAELigature  1182
+href="glossaries-extra-manual.html#dx1-37123" >1201
\glsxtrLatinE  1183
+href="glossaries-extra-manual.html#dx1-37107" >1202
\glsxtrLatinEszettSs  1184
+href="glossaries-extra-manual.html#dx1-37119" >1203
\glsxtrLatinEszettSz  1185
+href="glossaries-extra-manual.html#dx1-37120" >1204
\glsxtrLatinEth  1186
+href="glossaries-extra-manual.html#dx1-37121" >1205
\glsxtrLatinH  1187
+href="glossaries-extra-manual.html#dx1-37108" >1206
\glsxtrLatinI  1188
+href="glossaries-extra-manual.html#dx1-37110" >1207
\glsxtrLatinInsularG  1189
+href="glossaries-extra-manual.html#dx1-37128" >1208
\glsxtrLatinK  1190
+href="glossaries-extra-manual.html#dx1-37109" >1209
+ + + \glsxtrLatinL  1191
+href="glossaries-extra-manual.html#dx1-37111" >1210
\glsxtrLatinLslash  1192
- - - +href="glossaries-extra-manual.html#dx1-37126" >1211
\glsxtrLatinM  1193
+href="glossaries-extra-manual.html#dx1-37112" >1212
\glsxtrLatinN  1194
+href="glossaries-extra-manual.html#dx1-37113" >1213
\glsxtrLatinO  1195
+href="glossaries-extra-manual.html#dx1-37114" >1214
\glsxtrLatinOELigature  1196
+href="glossaries-extra-manual.html#dx1-37124" >1215
\glsxtrLatinOslash  1197
+href="glossaries-extra-manual.html#dx1-37125" >1216
\glsxtrLatinP  1198
+href="glossaries-extra-manual.html#dx1-37115" >1217
\glsxtrLatinS  1199
+href="glossaries-extra-manual.html#dx1-37116" >1218
\glsxtrLatinSchwa  1200
+href="glossaries-extra-manual.html#dx1-37129" >1219
\glsxtrLatinT  1201
+href="glossaries-extra-manual.html#dx1-37117" >1220
\glsxtrLatinThorn  1202
+href="glossaries-extra-manual.html#dx1-37122" >1221
\glsxtrLatinWynn  1203
+href="glossaries-extra-manual.html#dx1-37127" >1222
\glsxtrLatinX  1204
+href="glossaries-extra-manual.html#dx1-37118" >1223
\GlsXtrLetField  1205
+class="cmti-10">1224
\GlsXtrLetFieldToField  1206
+class="cmti-10">1225
\GlsXtrLinkCounterName  1207
+class="cmti-10">1226
\GlsXtrLinkCounterValue  1208
+class="cmti-10">1227
\GlsXtrLoadResources  1209
+class="cmti-10">1228
\glsxtrlocalsetgrouptitle  1210
+class="cmti-10">1229
\GlsXtrLocationRecordCount  1211
+class="cmti-10">1230
\glsxtrlocrangefmt  1212
+class="cmti-10">1231
\Glsxtrlong  1213, 1232, 1214
+class="cmti-10">1233
\glsxtrlong  1215
+class="cmti-10">1234
\glsxtrlonghyphen  1216
+class="cmti-10">1235
\glsxtrlonghyphenshort  1217
+class="cmti-10">1236
\glsxtrlongnoshortdescname  1218
+class="cmti-10">1237
\glsxtrlongnoshortname  1219
+class="cmti-10">1238
\GLSxtrlongpl  1220
+class="cmti-10">1239
\Glsxtrlongpl  1221
+class="cmti-10">1240
\glsxtrlongpl  1222
+class="cmti-10">1241
\glsxtrlongshortdescname  1223
+class="cmti-10">1242
\glsxtrlongshortdescsort  1224
+class="cmti-10">1243
\glsxtrlongshortname  1225
+class="cmti-10">1244
\glsxtrlongshortuserdescname  1226
+class="cmti-10">1245
\glsxtrMathGreekIIrules  1227
+href="glossaries-extra-manual.html#dx1-37138" >1246
\glsxtrMathGreekIrules  1228
+href="glossaries-extra-manual.html#dx1-37131" >1247
\glsxtrMathItalicGreekIIrules  1229
+href="glossaries-extra-manual.html#dx1-37154" >1248
\glsxtrMathItalicGreekIrules  1230
+href="glossaries-extra-manual.html#dx1-37147" >1249
\glsxtrMathItalicLowerGreekIIrules  1231
+href="glossaries-extra-manual.html#dx1-37168" >1250
\glsxtrMathItalicLowerGreekIrules  1232
+href="glossaries-extra-manual.html#dx1-37164" >1251
\glsxtrMathItalicNabla  1233
+href="glossaries-extra-manual.html#dx1-37172" >1252
\glsxtrMathItalicPartial  1234
+href="glossaries-extra-manual.html#dx1-37171" >1253
\glsxtrMathItalicUpperGreekIIrules  1235
+href="glossaries-extra-manual.html#dx1-37161" >1254
\glsxtrMathItalicUpperGreekIrules  1236
+href="glossaries-extra-manual.html#dx1-37157" >1255
\glsxtrMathUpGreekIIrules  1237
-\glsxtrMathUpGreekIrules  1238
-\glsxtrnewgls  1239
+href="glossaries-extra-manual.html#dx1-37144" >1256
+\glsxtrMathUpGreekIrules  1257
+\glsxtrmultisupplocation  1258
+\glsxtrnewgls  1259
\glsxtrnewGLSlike  1240
+class="cmti-10">1260
\glsxtrnewglslike  1241
+class="cmti-10">1261
\glsxtrnewnumber  1242
+class="cmti-10">1262
\glsxtrnewrgls  1243
+class="cmti-10">1263
\glsxtrnewrGLSlike  1244
+class="cmti-10">1264
\glsxtrnewrglslike  1245
+class="cmti-10">1265
\glsxtrnewsymbol  1246
+class="cmti-10">1266
\GlsXtrNoGlsWarningAutoMake  1247
+class="cmti-10">1267
\GlsXtrNoGlsWarningBuildInfo  1248
+class="cmti-10">1268
\GlsXtrNoGlsWarningCheckFile  1249
+class="cmti-10">1269
\GlsXtrNoGlsWarningEmptyMain  1250
+class="cmti-10">1270
\GlsXtrNoGlsWarningEmptyNotMain  1251
+class="cmti-10">1271
\GlsXtrNoGlsWarningEmptyStart  1252
+class="cmti-10">1272
\GlsXtrNoGlsWarningHead  1253
+class="cmti-10">1273
\GlsXtrNoGlsWarningMisMatch  1254
+class="cmti-10">1274
\GlsXtrNoGlsWarningNoOut  1255
+class="cmti-10">1275
\GlsXtrNoGlsWarningTail  1256
+class="cmti-10">1276
\glsxtrnonprintablerules  1257
+href="glossaries-extra-manual.html#dx1-37080" >1277
\glsxtrnopostpunc  1258
+class="cmti-10">1278
\glsxtronlydescname  1259
+class="cmti-10">1279
\glsxtronlyname  1260
+class="cmti-10">1280
\glsxtronlysuffix  1261
+class="cmti-10">1281
\glsxtrorglong  1262
+class="cmti-10">1282
\glsxtrorgshort  1263
+class="cmti-10">1283
\Glsxtrp  1264, 1284, 1265
+class="cmti-10">1285
\glsxtrp  1266
+class="cmti-10">1286
\glsxtrpageref  1267
+class="cmti-10">1287
\glsxtrparen  1268
+class="cmti-10">1288
\Glsxtrpl  1269
+class="cmti-10">1289
\glsxtrpl  1270
+class="cmti-10">1290
\glsxtrpostdescription  1271
+class="cmti-10">1291
\glsxtrposthyphenlong  1272
+class="cmti-10">1292
\glsxtrposthyphenshort  1273
+class="cmti-10">1293
\glsxtrpostlink  1274
+class="cmti-10">1294
\glsxtrpostlinkAddDescOnFirstUse  1275
+class="cmti-10">1295
\glsxtrpostlinkAddSymbolDescOnFirstUse  1276
+class="cmti-10">1296
\glsxtrpostlinkAddSymbolOnFirstUse  1277
+class="cmti-10">1297
\glsxtrpostlinkendsentence  1278
+class="cmti-10">1298
\glsxtrpostlinkhook  1279
+class="cmti-10">1299
\glsxtrpostlongdescription  1280
+class="cmti-10">1300
\glsxtrpostnamehook  1281
+class="cmti-10">1301
\GlsXtrPostNewAbbreviation  1282
+class="cmti-10">1302
\glsxtrprelocation  1283
+class="cmti-10">1303
+ + + \GlsXtrProvideBibTeXFields  1284
+class="cmti-10">1304
\glsxtrprovidecommand  1285
+class="cmti-10">1305
\glsxtrprovidestoragekey  1286
- - - +class="cmti-10">1306
\GlsXtrRecordCount  1287
+class="cmti-10">1307
\GlsXtrRecordCounter  1288
+class="cmti-10">1308
\glsxtrrecordtriggervalue  1289
+class="cmti-10">1309
\glsxtrregularfont  1290
+class="cmti-10">1310
\glsxtrresourcefile  1291
+class="cmti-10">1311
\glsxtrresourceinit  1292
+class="cmti-10">1312
\glsxtrrestorepostpunc  1293
+class="cmti-10">1313
\glsxtrRevertMarks  1294
+class="cmti-10">1314
\glsxtrRevertTocMarks  1295
+class="cmti-10">1315
\glsxtrscsuffix  1296
+class="cmti-10">1316
\glsxtrseealsolabels  1297
+class="cmti-10">1317
\glsxtrseelist  1298
+class="cmti-10">1318
\GlsXtrSetActualChar  1299
+href="glossaries-extra-manual.html#dx1-32050" >1319
\glsxtrsetaliasnoindex  1300
+class="cmti-10">1320
\GlsXtrSetAltModifier  1301
+class="cmti-10">1321
\glsxtrsetcategory  1302
+href="glossaries-extra-manual.html#dx1-28186" >1322
\glsxtrsetcategoryforall  1303
+href="glossaries-extra-manual.html#dx1-28188" >1323
\GlsXtrSetDefaultGlsOpts  1304
+class="cmti-10">1324
\GlsXtrSetEncapChar  1305
+href="glossaries-extra-manual.html#dx1-32053" >1325
\GlsXtrSetEscChar  1306
+href="glossaries-extra-manual.html#dx1-32052" >1326
\GlsXtrSetField  1307
+class="cmti-10">1327
\glsxtrsetfieldifexists  1308
+class="cmti-10">1328
\glsxtrsetgrouptitle  1309
+class="cmti-10">1329
\GlsXtrSetLevelChar  1310
+href="glossaries-extra-manual.html#dx1-32051" >1330
\glsxtrsetpopts  1311
+class="cmti-10">1331
\GlsXtrSetRecordCountAttribute  1312
+class="cmti-10">1332
\Glsxtrshort  1313, 1333, 1314
+class="cmti-10">1334
\glsxtrshort  1315
+class="cmti-10">1335
\glsxtrshortdescname  1316
+class="cmti-10">1336
\glsxtrshorthyphenlong  1317
+class="cmti-10">1337
\glsxtrshortlongdescname  1318
+class="cmti-10">1338
\glsxtrshortlongname  1319, 1339, 1320
+class="cmti-10">1340
\glsxtrshortlonguserdescname  1321
+class="cmti-10">1341
\glsxtrshortnolongname  1322
+class="cmti-10">1342
\GLSxtrshortpl  1323
+class="cmti-10">1343
\Glsxtrshortpl  1324
+class="cmti-10">1344
\glsxtrshortpl  1325
+class="cmti-10">1345
\glsxtrsmsuffix  1326
+class="cmti-10">1346
\glsxtrspacerules  1327
+href="glossaries-extra-manual.html#dx1-37079" >1347
\GlsXtrStandaloneGlossaryType  1328
+class="cmti-10">1348
\GlsXtrStartUnsetBuffering  1329
+class="cmti-10">1349
\GlsXtrStopUnsetBuffering  1330
+class="cmti-10">1350
\glsxtrSubScriptDigitrules  1331
+href="glossaries-extra-manual.html#dx1-37095" >1351
+ + + \Glsxtrsubsequentfmt  1332
+class="cmti-10">1352
\glsxtrsubsequentfmt  1333
+class="cmti-10">1353
\Glsxtrsubsequentplfmt  1334
- - - +class="cmti-10">1354
\glsxtrsubsequentplfmt  1335
+class="cmti-10">1355
\glsxtrSuperScriptDigitrules  1336
+href="glossaries-extra-manual.html#dx1-37096" >1356
\glsxtrtagfont  1337
+class="cmti-10">1357
\GlsXtrTheLinkCounter  1338
+class="cmti-10">1358
\GlsXtrTotalRecordCount  1339
+class="cmti-10">1359
\glsxtrunsrtdo  1340
+class="cmti-10">1360
\GlsXtrUseAbbrStyleFmts  1341
+class="cmti-10">1361
\GlsXtrUseAbbrStyleSetup  1342
+class="cmti-10">1362
\Glsxtrusefield  1343
+class="cmti-10">1363
\glsxtrusefield  1344
+class="cmti-10">1364
\glsxtruserfield  1345
+class="cmti-10">1365
\glsxtruserparen  1346
+class="cmti-10">1366
\glsxtrusersuffix  1347, 1367, 1348
+class="cmti-10">1368
\glsxtrusesee  1349
+class="cmti-10">1369
\glsxtruseseealso  1350
+class="cmti-10">1370
\glsxtruseseeformat  1351, 1371, 1352
+class="cmti-10">1372
\GlsXtrWarnDeprecatedAbbrStyle  1353
+class="cmti-10">1373
\GlsXtrWarning  1354
+class="cmti-10">1374
\glsxtrword  1355
+class="cmti-10">1375
\glsxtrwordsep  1356
+class="cmti-10">1376
\glsxtrwrglossmark  1357
+class="cmti-10">1377

H hyperref package  1358, 1359, 1360, 1361, 1362, 1363, 1364, 1365, 1366, 1367, 1368, 1369, 1370, 1371, 1372, 1373, 1374, 1375, 1376, 1377, 1378, 1379, 1380
+href="glossaries-extra-manual.html#dx1-4114" >1378, 1379, 1380, 1381, 1382, 1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400

I \ifglsxtrinitwrglossbefore  1381
+class="cmti-10">1401
inputenc package  1382
+href="glossaries-extra-manual.html#dx1-36019" >1402

L link-text  1383, 1384, 1385, 1386, 1387, 1388, 1389, 1390, 1391, 1392, 1393, 1394, 1395, 1396, 1397, 1398, 1399, 1400, 1401, 1403, 1404, 1405, 1406, 1407, 1408, 1409, 1410, 1411, 1412, 1413, 1414, 1415, 1416, 1417, 1418, 1419, 1420, 1421, 1402
+class="cmbx-10">1422
location list  1403, 1404, 1405, 1406, 1423, 1424, 1425, 1426, 1407
+class="cmbx-10">1427
\longnewglossaryentry  1408
+class="cmti-10">1428

M makeglossaries  1409, 1410, 1411, 1412, 1429, 1430, 1431, 1432, 1413
+class="cmbx-10">1433
\makeglossaries  1414
+class="cmti-10">1434
makeglossaries-lite  1415, 1435, 1416
+class="cmbx-10">1436
makeglossaries-lite  1417, 1437, 1418
+class="cmbx-10">1438
+ + + makeindex  1419, 1420, 1421, 1422, 1423, 1424, 1425, 1426, 1427, 1428, 1429, 1430, 1431, 1432, 1433, 1434, 1439, 1440, 1441, 1442, 1443, 1444, 1445, 1446, 1447, 1448, 1449, 1450, 1451, 1452, 1453, 1454, 1455, 1456, 1435
+class="cmbx-10">1457
makeindex  1436, 1437, 1438, 1439
+href="glossaries-extra-manual.html#dx1-6042" >1458, 1459, 1460, 1461
memoir class  1440
- - - +href="glossaries-extra-manual.html#dx1-3021" >1462
mfirstuc package  1441, 1442, 1443
+href="glossaries-extra-manual.html#dx1-5" >1463, 1464, 1465

N \newabbreviation  1444
+class="cmti-10">1466
\newabbreviationstyle  1445
+class="cmti-10">1467
\newacronym  1446
+class="cmti-10">1468
\newglossaryentry options
    access  1447, 1448
+href="glossaries-extra-manual.html#dx1-28088" >1469, 1470
    alias  1449, 1450, 1451, 1452, 1453, 1454
+href="glossaries-extra-manual.html#dx1-5024" >1471, 1472, 1473, 1474, 1475, 1476
    category  1455, 1456, 1457, 1458, 1459, 1460
+href="glossaries-extra-manual.html#dx1-5023" >1477, 1478, 1479, 1480, 1481, 1482
    counter  1461
+href="glossaries-extra-manual.html#dx1-6034" >1483
    desc  1462, 1463
+href="glossaries-extra-manual.html#dx1-47038" >1484, 1485
    descplural  1464, 1465
+href="glossaries-extra-manual.html#dx1-47042" >1486, 1487
    description  1466, 1467, 1468, 1469, 1470, 1471, 1472, 1473, 1474, 1475, 1476, 1477, 1478, 1479, 1480, 1481, 1482, 1483, 1484, 1485, 1486, 1487
+href="glossaries-extra-manual.html#dx1-5002" >1488, 1489, 1490, 1491, 1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504, 1505, 1506, 1507, 1508, 1509
    descriptionplural  1488, 1489, 1490, 1491
+href="glossaries-extra-manual.html#dx1-5033" >1510, 1511, 1512, 1513
    first  1492, 1493, 1494, 1495, 1496, 1497, 1498, 1499, 1500, 1501, 1502, 1503, 1504
+href="glossaries-extra-manual.html#dx1-8013" >1514, 1515, 1516, 1517, 1518, 1519, 1520, 1521, 1522, 1523, 1524, 1525, 1526
    firstaccess  1505
+href="glossaries-extra-manual.html#dx1-28098" >1527
    firstplural  1506, 1507, 1508, 1509, 1510, 1511, 1512, 1513, 1514, 1515
+href="glossaries-extra-manual.html#dx1-8014" >1528, 1529, 1530, 1531, 1532, 1533, 1534, 1535, 1536, 1537
    group  1516, 1517, 1518, 1519, 1520
+href="glossaries-extra-manual.html#dx1-36018" >1538, 1539, 1540, 1541, 1542
    location  1521, 1522
+href="glossaries-extra-manual.html#dx1-14026" >1543, 1544
    loclist  1523
+href="glossaries-extra-manual.html#dx1-42035" >1545
    long  1524, 1525, 1526, 1527, 1528, 1529, 1530, 1531, 1532
+href="glossaries-extra-manual.html#dx1-11026" >1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554
    longplural  1533, 1534, 1535, 1536, 1537, 1538
+href="glossaries-extra-manual.html#dx1-11010" >1555, 1556, 1557, 1558, 1559, 1560
    name  1539, 1540, 1541, 1542, 1543, 1544, 1545, 1546, 1547, 1548, 1549, 1550, 1551, 1552, 1553, 1554, 1555, 1556, 1557, 1558, 1559, 1560, 1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590
+href="glossaries-extra-manual.html#dx1-5007" >1561, 1562, 1563, 1564, 1565, 1566, 1567, 1568, 1569, 1570, 1571, 1572, 1573, 1574, 1575, 1576, 1577, 1578, 1579, 1580, 1581, 1582, 1583, 1584, 1585, 1586, 1587, 1588, 1589, 1590, 1591, 1592, 1593, 1594, 1595, 1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608, 1609, 1610, 1611, 1612
    nameshortaccess  1591, 1592
+href="glossaries-extra-manual.html#dx1-28094" >1613, 1614
    parent  1593, 1594, 1595
+href="glossaries-extra-manual.html#dx1-18077" >1615, 1616, 1617
    plural  1596, 1597, 1598, 1599, 1600, 1601, 1602, 1603, 1604, 1605, 1606, 1607, 1608
+href="glossaries-extra-manual.html#dx1-8017" >1618, 1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630
    prefix  1609
+href="glossaries-extra-manual.html#dx1-5021" >1631
    see  1610, 1611, 1612, 1613, 1614, 1615, 1616, 1617, 1618, 1619, 1620, 1621, 1622, 1623, 1624, 1625, 1626, 1627, 1628, 1629, 1630, 1631, 1632, 1633, 1634, 1635, 1636
+href="glossaries-extra-manual.html#dx1-4056" >1632, 1633, 1634, 1635, 1636, 1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656, 1657, 1658
    seealso  1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1645, 1646
+href="glossaries-extra-manual.html#dx1-4057" >1659, 1660, 1661, 1662, 1663, 1664, 1665, 1666, 1667, 1668
    short  1647, 1648, 1649, 1650, 1651, 1652, 1653, 1654, 1655, 1656, 1657, 1658, 1659, 1660, 1661
+href="glossaries-extra-manual.html#dx1-8011" >1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682, 1683
    shortaccess  1662, 1663, 1664, 1665, 1666, 1667
+href="glossaries-extra-manual.html#dx1-28084" >1684, 1685, 1686, 1687, 1688, 1689
    shortplural  1668, 1669, 1670, 1671, 1672, 1673, 1674, 1675, 1676, 1677, 1678, 1679, 1680, 1681, 1682
+href="glossaries-extra-manual.html#dx1-11011" >1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704
    shortpluralaccess  1683, 1684, 1685, 1686
+href="glossaries-extra-manual.html#dx1-28101" >1705, 1706, 1707, 1708
    sort  1687, 1688, 1689, 1690, 1691, 1692, 1693, 1694, 1695, 1696, 1697, 1698, 1699, 1700, 1701, 1702, 1703, 1704
+href="glossaries-extra-manual.html#dx1-4167" >1709, 1710, 1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723, 1724, 1725, 1726, 1727, 1728
    symbol  1705, 1706, 1707, 1708
+href="glossaries-extra-manual.html#dx1-41032" >1729, 1730, 1731, 1732
    symbolplural  1709, 1710
+href="glossaries-extra-manual.html#dx1-47034" >1733, 1734
+ + +     text  1711, 1712, 1713, 1714, 1715, 1716, 1717, 1718, 1719, 1720, 1721, 1722, 1723
+href="glossaries-extra-manual.html#dx1-5009" >1735, 1736, 1737, 1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747
    textaccess  1724
+href="glossaries-extra-manual.html#dx1-28095" >1748
    type  1725, 1726, 1727, 1728
+href="glossaries-extra-manual.html#dx1-13046" >1749, 1750, 1751, 1752
    user1  1729, 1730, 1731
+href="glossaries-extra-manual.html#dx1-23080" >1753, 1754, 1755
number list  1732, 1733, 1734, 1735, 1736, 1737, 1738, 1739, 1740, 1741, 1742, 1743, 1744, 1745, 1746, 1747, 1748, 1749, 1750, 1751, 1752, 1753, 1754, 1755, 1756, 1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1756, 1757, 1758, 1759, 1760, 1761, 1762, 1763, 1764, 1765, 1766, 1767, 1768, 1769, 1770, 1771, 1772, 1773, 1774, 1775, 1776, 1777, 1778, 1779, 1780, 1781, 1782, 1783, 1784, 1785, 1786, 1787, 1788, 1765
- - - +class="cmbx-10">1789

P package options:
    abbreviations  1766, 1767, 1768, 1769, 1770
+href="glossaries-extra-manual.html#dx1-4182" >1790, 1791, 1792, 1793, 1794
    accsupp  1771, 1772, 1773, 1774, 1775
+href="glossaries-extra-manual.html#dx1-4035" >1795, 1796, 1797, 1798, 1799
    acronym  1776
+href="glossaries-extra-manual.html#dx1-4190" >1800
    acronymlists  1777
+href="glossaries-extra-manual.html#dx1-4194" >1801
    automake  1778, 1779
+href="glossaries-extra-manual.html#dx1-5057" >1802, 1803
    autoseeindex  1780, 1781
+href="glossaries-extra-manual.html#dx1-4066" >1804, 1805
        false  1782, 1783
+href="glossaries-extra-manual.html#dx1-4058" >1806, 1807
    counter
        wrglossary  1784
+href="glossaries-extra-manual.html#dx1-4118" >1808
    debug  1785
+href="glossaries-extra-manual.html#dx1-4002" >1809
        all  1786, 1787
+href="glossaries-extra-manual.html#dx1-4005" >1810, 1811
        showtargets  1788, 1789
+href="glossaries-extra-manual.html#dx1-4003" >1812, 1813
        showwrgloss  1790, 1791, 1792
+href="glossaries-extra-manual.html#dx1-4004" >1814, 1815, 1816
        true  1793
+href="glossaries-extra-manual.html#dx1-4007" >1817
    docdef  1794, 1795, 1796, 1797
+href="glossaries-extra-manual.html#dx1-4147" >1818, 1819, 1820, 1821
        restricted  1798, 1799, 1800, 1801
+href="glossaries-extra-manual.html#dx1-4160" >1822, 1823, 1824, 1825
        true  1802, 1803
+href="glossaries-extra-manual.html#dx1-4178" >1826, 1827
    docdefs  1804, 1805, 1806
+href="glossaries-extra-manual.html#dx1-33003" >1828, 1829, 1830
        true  1807
+href="glossaries-extra-manual.html#dx1-4159" >1831
    entrycounter  1808, 1809
+href="glossaries-extra-manual.html#dx1-40002" >1832, 1833
    hyperfirst
        false  1810
+href="glossaries-extra-manual.html#dx1-28030" >1834
    index  1811, 1812
+href="glossaries-extra-manual.html#dx1-5046" >1835, 1836
    indexcounter  1813, 1814, 1815
+href="glossaries-extra-manual.html#dx1-4111" >1837, 1838, 1839
    indexcrossrefs  1816, 1817, 1818, 1819
+href="glossaries-extra-manual.html#dx1-4055" >1840, 1841, 1842, 1843
        false  1820
+href="glossaries-extra-manual.html#dx1-4065" >1844
    indexonlyfirst  1821, 1822, 1823, 1824
+href="glossaries-extra-manual.html#dx1-6003" >1845, 1846, 1847, 1848
    nogroupskip  1825
+href="glossaries-extra-manual.html#dx1-18014" >1849
    nomain  1826
+href="glossaries-extra-manual.html#dx1-3032" >1850
    nomissingglstext  1827
+href="glossaries-extra-manual.html#dx1-4181" >1851
    nonumberlist  1828, 1829, 1830, 1831
+href="glossaries-extra-manual.html#dx1-7026" >1852, 1853, 1854, 1855
    nopostdot  1832, 1833, 1834, 1835
+href="glossaries-extra-manual.html#dx1-4023" >1856, 1857, 1858, 1859
        false  1836, 1837, 1838
+href="glossaries-extra-manual.html#dx1-3004" >1860, 1861, 1862
        true  1839
+href="glossaries-extra-manual.html#dx1-3003" >1863
    noredefwarn
        false  1840
+href="glossaries-extra-manual.html#dx1-3009" >1864
+ + +         true  1841
+href="glossaries-extra-manual.html#dx1-3006" >1865
    notree  1842
+href="glossaries-extra-manual.html#dx1-18057" >1866
    numbers  1843, 1844, 1845
+href="glossaries-extra-manual.html#dx1-4198" >1867, 1868, 1869
    postdot  1846, 1847, 1848
+href="glossaries-extra-manual.html#dx1-3005" >1870, 1871, 1872
    postpunc  1849, 1850, 1851
- - - +href="glossaries-extra-manual.html#dx1-4019" >1873, 1874, 1875
        comma  1852
+href="glossaries-extra-manual.html#dx1-4020" >1876
        dot  1853
+href="glossaries-extra-manual.html#dx1-4021" >1877
        none  1854
+href="glossaries-extra-manual.html#dx1-4022" >1878
    record  1855, 1856, 1857, 1858, 1859, 1860, 1861, 1862, 1863, 1864, 1865, 1866
+href="glossaries-extra-manual.html#dx1-4064" >1879, 1880, 1881, 1882, 1883, 1884, 1885, 1886, 1887, 1888, 1889, 1890, 1891
        alsoindex  1867, 1868, 1869, 1870, 1871, 1872, 1873
+href="glossaries-extra-manual.html#dx1-4009" >1892, 1893, 1894, 1895, 1896, 1897, 1898
        off  1874, 1875
+href="glossaries-extra-manual.html#dx1-5052" >1899, 1900
        only  1876, 1877, 1878, 1879, 1880, 1881, 1882, 1883, 1884, 1885
+href="glossaries-extra-manual.html#dx1-4069" >1901, 1902, 1903, 1904, 1905, 1906, 1907, 1908, 1909, 1910
    section
        chapter  1886
+href="glossaries-extra-manual.html#dx1-14043" >1911
    seeautonumberlist  1887
+href="glossaries-extra-manual.html#dx1-7027" >1912
    seenoindex  1888
+href="glossaries-extra-manual.html#dx1-7016" >1913
        ignore  1889, 1890
+href="glossaries-extra-manual.html#dx1-7018" >1914, 1915
        warn  1891
+href="glossaries-extra-manual.html#dx1-42022" >1916
    shortcuts  1892, 1893
+href="glossaries-extra-manual.html#dx1-4200" >1917, 1918
        abbr  1894, 1895
+href="glossaries-extra-manual.html#dx1-4206" >1919, 1920
        abbreviation  1896, 1897
+href="glossaries-extra-manual.html#dx1-22001" >1921, 1922
        abbreviations  1898, 1899
+href="glossaries-extra-manual.html#dx1-4205" >1923, 1924
        ac  1900, 1901, 1902, 1903, 1904, 1905
+href="glossaries-extra-manual.html#dx1-4203" >1925, 1926, 1927, 1928, 1929, 1930
        acro  1906, 1907
+href="glossaries-extra-manual.html#dx1-4202" >1931, 1932
        acronyms  1908, 1909
+href="glossaries-extra-manual.html#dx1-4201" >1933, 1934
        all  1910, 1911
+href="glossaries-extra-manual.html#dx1-4216" >1935, 1936
        false  1912
+href="glossaries-extra-manual.html#dx1-4222" >1937
        none  1913
+href="glossaries-extra-manual.html#dx1-4221" >1938
        other  1914, 1915
+href="glossaries-extra-manual.html#dx1-4207" >1939, 1940
        true  1916
+href="glossaries-extra-manual.html#dx1-4217" >1941
    sort
        none  1917, 1918
+href="glossaries-extra-manual.html#dx1-4093" >1942, 1943
    stylemods  1919, 1920, 1921, 1922, 1923
+href="glossaries-extra-manual.html#dx1-4044" >1944, 1945, 1946, 1947, 1948
        all  1924
+href="glossaries-extra-manual.html#dx1-4047" >1949
        default  1925
+href="glossaries-extra-manual.html#dx1-4046" >1950
    subentrycounter  1926, 1927
+href="glossaries-extra-manual.html#dx1-40003" >1951, 1952
    symbols  1928, 1929, 1930
+href="glossaries-extra-manual.html#dx1-4195" >1953, 1954, 1955
    toc
        false  1931
+href="glossaries-extra-manual.html#dx1-3002" >1956
        true  1932
+href="glossaries-extra-manual.html#dx1-3001" >1957
    translate
        babel  1933
+href="glossaries-extra-manual.html#dx1-3011" >1958
        true  1934
+href="glossaries-extra-manual.html#dx1-3013" >1959
    undefaction  1935, 1936
+href="glossaries-extra-manual.html#dx1-4048" >1960, 1961
        error  1937, 1938, 1939
+href="glossaries-extra-manual.html#dx1-4049" >1962, 1963, 1964
        warn  1940, 1941, 1942, 1943, 1944, 1945, 1946, 1947, 1948
+href="glossaries-extra-manual.html#dx1-4050" >1965, 1966, 1967, 1968, 1969, 1970, 1971, 1972, 1973
+ + +     xindy  1949
+href="glossaries-extra-manual.html#dx1-7046" >1974, 1975
page (counter)  1950, 1951, 1952, 1953
+href="glossaries-extra-manual.html#dx1-4124" >1976, 1977, 1978, 1979
polyglossia package  1954, 1955
+href="glossaries-extra-manual.html#dx1-41068" >1980, 1981
\pretoglossarypreamble  1956
+class="cmti-10">1982
\printabbreviations  1957
- - - +class="cmti-10">1983
\printglossary options
    nogroupskip  1958
+href="glossaries-extra-manual.html#dx1-18015" >1984
    prefix  1959
+href="glossaries-extra-manual.html#dx1-5020" >1985
    target  1960, 1961
+href="glossaries-extra-manual.html#dx1-5018" >1986, 1987
    targetnameprefix  1962
+href="glossaries-extra-manual.html#dx1-5019" >1988
    title  1963
+href="glossaries-extra-manual.html#dx1-49006" >1989
\printnoidxglossary options
    sort  1964
+href="glossaries-extra-manual.html#dx1-42025" >1990
\printunsrtglossaries  1965
+class="cmti-10">1991
\printunsrtglossary  1966
+class="cmti-10">1992
\printunsrtglossary*  1967
+class="cmti-10">1993
\printunsrtglossaryentryprocesshook  1968
+class="cmti-10">1994
\printunsrtglossaryhandler  1969
+class="cmti-10">1995
\printunsrtglossarypredoglossary  1970
+class="cmti-10">1996
\printunsrtglossaryskipentry  1971
+class="cmti-10">1997
\printunsrtglossaryunit  1972
+class="cmti-10">1998
\printunsrtglossaryunitsetup  1973
+class="cmti-10">1999
\provideignoredglossary  1974
+class="cmti-10">2000

R relsizes package  1975
+href="glossaries-extra-manual.html#dx1-23048" >2001
\RestoreAcronyms  1976
+class="cmti-10">2002
\rGLS  1977
+class="cmti-10">2003
\rGls  1978
+class="cmti-10">2004
\rgls  1979
+class="cmti-10">2005
\rGLSformat  1980
+class="cmti-10">2006
\rGlsformat  1981
+class="cmti-10">2007
\rglsformat  1982
+class="cmti-10">2008
\rGLSpl  1983
+class="cmti-10">2009
\rGlspl  1984
+class="cmti-10">2010
\rglspl  1985
+class="cmti-10">2011
\rGLSplformat  1986
+class="cmti-10">2012
\rGlsplformat  1987
+class="cmti-10">2013
\rglsplformat  1988
+class="cmti-10">2014

S \setabbreviationstyle  1989
+class="cmti-10">2015
slantsc package  1990
+href="glossaries-extra-manual.html#dx1-27021" >2016
soul package  1991, 1992
+href="glossaries-extra-manual.html#dx1-6023" >2017, 2018
+ + + style package  1993
+href="glossaries-extra-manual.html#dx1-14005" >2019
subentrycounter package  1994
+href="glossaries-extra-manual.html#dx1-43019" >2020

T texindy  2021
+textcase package  1995
- - - +href="glossaries-extra-manual.html#dx1-8" >2022
tracklang package  1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
+href="glossaries-extra-manual.html#dx1-4" >2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032
translator package  2006
+href="glossaries-extra-manual.html#dx1-3012" >2033

U upgreek package  2007, 2008, 2009, 2010
+href="glossaries-extra-manual.html#dx1-37064" >2034, 2035, 2036, 2037

W wrglossary (counter)  2011, 2012, 2013, 2014, 2015
+href="glossaries-extra-manual.html#dx1-4119" >2038, 2039, 2040, 2041, 2042

X xfor package  2016, 2017, 2018
+href="glossaries-extra-manual.html#dx1-9" >2043, 2044, 2045
\xglssetwidest  2019
+class="cmti-10">2046
\xglsupdatewidest  2020
+class="cmti-10">2047
\xGlsXtrSetField  2021
+class="cmti-10">2048
xindy  2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029, 2030, 2031, 2032, 2033, 2034, 2035, 2049, 2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059, 2060, 2061, 2062, 2063, 2036
+class="cmbx-10">2064
xindy  2037
+href="glossaries-extra-manual.html#dx1-6046" >2065
xkeyval package  2038
+href="glossaries-extra-manual.html#dx1-7" >2066

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.glstex extension was enforced by version 1.11.

-

10.1Pre version 1.28 used \csedef#1={\protect\ttfamily#1}|main}} \DeleteShortVerb{\|} \MakeShortVerb{"} - \title{glossaries-extra.sty v1.35: + \title{glossaries-extra.sty v1.36: an extension to the glossaries package} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} - \date{2018-08-13} + \date{2018-08-18} \maketitle \begin{abstract} @@ -1398,6 +1398,12 @@ See the \sty{soul} example in \sectionref{sec:glsunset}. \ics{glolinkprefix} to the given value. It should match the prefix for the desired glossary. +\item[{\gloskey[glslink]{thevalue}}] Explicitly set the location to +this value (see below). + +\item[{\gloskey[glslink]{theHvalue}}] Set the corresponding +hyperlink location (see below). + \end{description} There is a new hook that's used each time indexing information is @@ -1459,7 +1465,7 @@ that can't be obtained from a counter. The principle key \gloskey[glslink]{thevalue} is for the location value. The other key \gloskey[glslink]{theHvalue} can be used to extract a prefix value for the first argument of commands like -\ics{glsnoidxdisplayloc}. It's value must be in the format +\ics{glsnoidxdisplayloc}. Its value must be in the format \meta{prefix}\meta{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. @@ -1527,7 +1533,7 @@ This location value will be accepted by \app{makeindex} as it's in the form \meta{num}\meta{sep}\meta{num}. If you want hyperlinks, things are more complicated. First -you need to set the \catattr{externallocation} to the location of +you need to set the \catattr{externallocation} attribute to the location of the PDF file. For example: \begin{verbatim} \glssetcategoryattribute{supplemental}{externallocation}{suppl.pdf} @@ -1562,6 +1568,14 @@ 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. +This method can only be used where there is one external source +for the designated category (identified by the +\catattr{externallocation} attribute). For multiple sources, you need to use +\gls{bib2gls} version 1.7+, which is the better method in general as it can +automatically fetch the relevant locations from the \texttt{.aux} +files of the designated external documents without the need to +explicitly use \cs{glsadd}. + \section{Cross-References (\qt{see} and \qt{see also})} \label{sec:see} @@ -1731,8 +1745,7 @@ In this case \cs{glsentryfmt} uses \ics{glsgenentryfmt}. \item If an entry does has a~value for the \gloskey{short} key and hasn't been marked as a~regular entry through the -\catattr{regular} attribute, it's not -considered a regular entry. +\catattr{regular} attribute, it's not considered a regular entry. In this case \cs{glsentryfmt} uses \ics{glsxtrgenabbrvfmt} (defined by \styfmt{glossaries-extra}) which is governed by the abbreviation style (see \sectionref{sec:abbrstyle}). @@ -2901,7 +2914,14 @@ or use both the \pkgopt{stylemods} and \sty{style} options: \usepackage[stylemods=bookindex,style=bookindex]{glossaries-extra} \end{verbatim} The \glostyle{bookindex} style only supports a maximum -hierarchical level of 2 (top-level, level~1 and level~2). +hierarchical level of 2 (top-level, level~1 and level~2). It's +primarily designed for use with \gls{bib2gls}. It may be used with +other indexing options, but some features may not be present and +UTF-8 characters may cause a problem with non-Unicode engines in +letter group headings or PDF bookmarks. (\gls{bib2gls} uses numeric +identifies by default to avoid these problems. If numbers show up in +the group headings instead of the appropriate characters, check that +you have used the \pkgopt{record} package option.) The number of columns is given by \begin{definition}[\DescribeMacro\glsxtrbookindexcols] @@ -2938,8 +2958,18 @@ For example, if you want the symbol to be included: \ifglshassymbol{#1}{\space (\glossentrysymbol{#1})}{}% } \end{verbatim} +or if you want the description (if set): +\begin{verbatim} +\renewcommand*{\glsxtrbookindexname}[1]{% + \glossentryname{#1}% + \ifglshasdesc{#1}{\space \glossentrydesc{#1}\glspostdescription}{}% +} +\end{verbatim} +(which picks up the post-description hook). + Alternatively you can use the \cs{glsxtrpostname\meta{category}} -hook. +hook to append information after the name according to the entry's +category. Sub-entries are displayed using \begin{definition}[\DescribeMacro\glsxtrbookindexsubname] @@ -5123,7 +5153,7 @@ following punctuation character that's recognised by The inline full form uses the \meta{short} (\meta{long}) style. The \gloskey{name} is set to the short form. The \gloskey{description} is set to the long form. -Note that this style will change \cs{glsxtrfull} (and it's variants) +Note that this style will change \cs{glsxtrfull} (and its variants) so that it fakes non-\gls{firstuse}. (Otherwise the footnote would appear after the inline form.) @@ -6476,6 +6506,11 @@ for the external list. For example: description={external example}} \end{verbatim} +\item[\catattrdef{externallocation}] The value should be the +file name of the target document when manually indexing an +external location (see \sectionref{sec:wrglossary}). In general, +it's better to use \gls{bib2gls} v1.7+ which can handle multiple +external sources and doesn't require this attribute. \end{description} @@ -7182,6 +7217,17 @@ added to the index (as in this document). There are two attributes that govern this: \catattr{indexname} and \catattr{dualindex}. +\begin{important} +The auto-indexing is designed for \gls{makeindex} syntax. If you've +used the \pkgopt{xindy} package option, the automatic escaping of +\gls{xindy} special characters in the \gloskey{sort} field may +result in an incorrect sort value for the \cs{index} command used by +the auto-indexing. Note also that \app{texindy} has a fixed set of +special characters (corresponding to \gls{makeindex}['s] defaults) +that can't be customized. You may want to consider using \gls{bib2gls} and +its dual entries as an alternative approach. +\end{important} + \begin{sloppypar} The \ics{glsxtrpostnamehook} macro, used at the end of \ics{glossentryname} and \ics{Glossentryname}, @@ -7233,6 +7279,16 @@ which needs to be set to the sort value. The default definition is: After this macro is called, \meta{cs} is then processed to escape any of \app{makeindex}'s special characters. Note that this escaping is only performed on the sort not on the actual value. +The escaping of the sort value is performed by +\begin{definition}[\DescribeMacro\glsxtrautoindexesc] +\cs{glsxtrautoindexesc} +\end{definition} +You can redefine this to do nothing if you want to omit the +escaping. You may want to consider providing another field to obtain +the appropriate sort value if the one provided in the \gloskey{sort} +field isn't suitable (because it may already have had special +characters escaped or it may be a numeric value in the case of +sort by use or definition). The command used to perform the actual indexing is: \begin{definition}[\DescribeMacro\glsxtrautoindex] @@ -7964,6 +8020,21 @@ value in the form \cs{glsxtrbib}\meta{field}. For example, with \cs{glsxtrbibtype}. Each of these commands takes the entry label as the sole argument. +\begin{definition}[\DescribeMacro\glsxtrdisplaysupploc] +\cs{glsxtrdisplaysupploc}\marg{prefix}\marg{counter}\marg{format}\marg{src}\marg{location} +\end{definition} +This is used by \gls{bib2gls} version 1.7+ for supplemental +locations, instead of using \cs{glsxtrsupphypernumber} with the +\catattr{externallocation} attribute. This command sets up the +location counter and prefix (used in the formation of hyperlinks) +and then uses +\begin{definition}[\DescribeMacro\glsxtrmultisupplocation] +\cs{glsxtrmultisupplocation}\marg{location}\marg{src}\marg{format} +\end{definition} +to format the actual location (with an external hyperlink, if +supported). + + The \sty{glossaries-extra-bib2gls} package also provides definitions of the missing mathematical Greek commands: \ics{Alpha}, \ics{Beta}, \ics{Epsilon}, \ics{Zeta}, \ics{Eta}, \ics{Iota}, @@ -9704,10 +9775,10 @@ avoid duplicate hypertarget names. For example: }% \ifcsundef{theHsection}% {% - \renewcommand*{\glolinkprefix}{record.#2.\csuse{thesection}.}% + \renewcommand*{\glolinkprefix}{record.\csuse{thesection}.}% }% {% - \renewcommand*{\glolinkprefix}{record.#2.\csuse{theHsection}.}% + \renewcommand*{\glolinkprefix}{record.\csuse{theHsection}.}% }% } \end{verbatim} @@ -9724,10 +9795,10 @@ to use: }% \ifcsundef{theHsection}% {% - \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{thesection}.}}% + \setkeys{printgloss}{targetnameprefix={record.\csuse{thesection}.}}% }% {% - \setkeys{printgloss}{targetnameprefix={record.#2.\csuse{theHsection}.}}% + \setkeys{printgloss}{targetnameprefix={record.\csuse{theHsection}.}}% }% } \end{verbatim} @@ -9744,10 +9815,10 @@ space afterwards: }% \ifcsundef{theHsection}% {% - \renewcommand*{\glolinkprefix}{record.#2.\csuse{thesection}.}% + \renewcommand*{\glolinkprefix}{record.\csuse{thesection}.}% }% {% - \renewcommand*{\glolinkprefix}{record.#2.\csuse{theHsection}.}% + \renewcommand*{\glolinkprefix}{record.\csuse{theHsection}.}% }% \renewcommand*{\glossarysection}[2][]{}% \appto\glossarypostamble{\glspar\medskip\glspar}% 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 52273df5f7b..eb3d13bc2ec 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 ff4aa7e7385..48b8be56b07 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 aaf519a4e88..70214de4fcc 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 452a94e80ae..58b056b9e90 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 82de13d5e1a..fca0e1e122c 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 41169ecbb37..b937f3cc5bb 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 416505c595a..9ec353fa776 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 e570e670b3f..04b2adc06c6 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 88b4fdf59e6..30ade5766d8 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 afab5a71a63..9f965b2fc8f 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 8df861edc6c..095bb13d84a 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 d9976d62cc5..b542c5f4fd2 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 40e564d61b1..8fc81bd561a 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 2da02da409a..38dce48dc81 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 9a152ca9218..037abb01fe3 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 6539cff5dd5..7b143745f8b 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 946833b4bff..3b3ac29f4ff 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 7e2909e125b..d6c9cbdb7e2 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 733afb2e642..0d7033f6013 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 46888698e3d..b562e648cf4 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 7f3d928c77e..19c7150b7be 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 fa210e57637..3eb8e9779a6 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 index 258ae201220..aef14af7065 100644 Binary files a/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.pdf and b/Master/texmf-dist/doc/latex/glossaries-extra/sample-linkcount.pdf differ diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf b/Master/texmf-dist/doc/latex/glossaries-extra/sample-mixed-abbrv-styles.pdf index 3ddf4313c91..ae72f02d504 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 441567235ae..6645448ece6 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 61bd90e2df9..5dd48d0cfe4 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 306363bc208..3e18d8aace6 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 e5c88713332..d4b1f31925d 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 250e7e3e80c..39e97ec5aed 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 3a24b2deb13..f24115c8500 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 e24792019fe..c7f9c67be43 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 d2042880ae5..228b0db9f1b 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 6d3d1b7e84c..540617f3a3e 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 f6fb51e8e21..db1e36acae6 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 775d00965a4..240d9aa30ab 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 6079d9dadbb..e59b37e4831 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 0edb71f1bae..87d6b438bc6 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 98a23b12592..64e0ac647a9 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 91115cda735..be63df079f9 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 6c7c9f83e24..910c7ce9aa4 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 653856028fa..aa73dc2d4f4 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 9a41fce4566..49dfb430609 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 0b1176764bf..c625e9bc207 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 74f0a151e01..aed944fa697 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 34f9705ba82..a0ad64e9a75 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 ba8414530a4..7209cc15114 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 fb15582acf1..6f310deb315 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 816bed40c3a..8a9e2fa5658 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.dtx @@ -2,22 +2,22 @@ % glossaries-extra.dtx generated using makedtx version 1.2 (c) Nicola Talbot % Command line args: % -doc "glossaries-extra-codedoc.tex" -% -comment ".*\.tex" -% -comment ".*\.bib" -% -setambles ".*\.bib=>\nopreamble\nopostamble" -% -macrocode ".*\.tex" -% -macrocode ".*\.bib" -% -section "chapter" -% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" -% -author "Nicola Talbot" % -src "glossaries-extra.sty\Z=>glossaries-extra.sty" % -src "glossaries-extra-bib2gls.sty\Z=>glossaries-extra-bib2gls.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" +% -macrocode ".*\.tex" +% -macrocode ".*\.bib" +% -setambles ".*\.bib=>\nopreamble\nopostamble" +% -comment ".*\.tex" +% -comment ".*\.bib" +% -codetitle "Main Package Code (\\styfmt{glossaries-extra.sty})" +% -section "chapter" % glossaries-extra -% Created on 2018/8/13 19:27 +% Created on 2018/8/18 20:14 %\fi %\iffalse %<*package> @@ -127,7 +127,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{23243} +\CheckSum{23255} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -167,13 +167,13 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \raggedright } -\title{glossaries-extra.sty v1.35: +\title{glossaries-extra.sty v1.36: documented code} \author{Nicola L.C. Talbot\\[10pt] Dickimaw Books\\ \url{http://www.dickimaw-books.com/}} -\date{2018-08-13} +\date{2018-08-18} \begin{document} \DocInput{glossaries-extra.dtx} @@ -218,7 +218,7 @@ Dickimaw Books\\ %\section{Package Initialisation and Options} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossaries-extra}[2018/08/18 v1.36 (NLCT)] % \end{macrocode} % Requires \sty{xkeyval} to define package options. % \begin{macrocode} @@ -12782,6 +12782,16 @@ defined}{}% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsxtrautoindexesc} +%\changes{1.36}{2018-08-18}{new} +% \begin{macrocode} +\newcommand{\glsxtrautoindexesc}{% + \@gls@checkmkidxchars\@glo@sort + \@glsxtr@autoindex@doextra@esc\@glo@sort +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@glsxtr@autoindex@setname} %\changes{0.5.3}{2015-12-09}{new} % Assign \cs{@glo@name} for use with \catattr{indexname} attribute. @@ -12789,8 +12799,7 @@ defined}{}% \newcommand*{\@glsxtr@autoindex@setname}[1]{% \protected@edef\@glo@name{\glsxtrautoindexentry{#1}}% \glsxtrautoindexassignsort{\@glo@sort}{#1}% - \@gls@checkmkidxchars\@glo@sort - \@glsxtr@autoindex@doextra@esc\@glo@sort + \glsxtrautoindexesc \epreto\@glo@name{\@glo@sort\@glsxtr@autoindex@at}% } % \end{macrocode} @@ -22396,7 +22405,7 @@ defined}{}% %automatically loaded by the record option. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-bib2gls}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossaries-extra-bib2gls}[2018/08/18 v1.36 (NLCT)] % \end{macrocode} % %These are some convenient macros for use with custom rules. @@ -22543,6 +22552,41 @@ defined}{}% % \end{macrocode} %\end{macro} % +%Multiple supplementary references are only supported with +%\app{bib2gls}. +%\begin{macro}{\glsxtrmultisupplocation} +%\changes{1.36}{2018-08-18}{new} +%This is like \cs{glsxtrsupphypernumber} but the second argument is +%the external file name (which isn't obtained from the +%\catattr{externallocation} attribute). The third argument is the +%formatting (encap) control sequence \emph{name}. This is ignored by +%default, but is set by \app{bib2gls} to the original encap in case +%it's required. +% \begin{macrocode} +\newcommand*{\glsxtrmultisupplocation}[3]{% + {% + \def\glsxtrsupplocationurl{#2}% + \glshypernumber{#1}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsxtrdisplaysupploc} +%\changes{1.36}{2018-08-18}{new} +%\begin{definition} +%\cs{glsxtrdisplaysupploc}\marg{prefix}\marg{counter}\marg{format}\marg{src}\marg{location} +%\end{definition} +%This is like \cs{glsnoidxdisplayloc} but is used for supplementary +%locations and so requires an extra argument. +% \begin{macrocode} +\newcommand*\glsxtrdisplaysupploc[5]{% + \setentrycounter[#1]{#2}% + \glsxtrmultisupplocation{#5}{#4}{#3}% +} +% \end{macrocode} +%\end{macro} +% %Provide missing Greek letters for use in maths mode. %These commands are recognised by \app{bib2gls} and will be mapped to the %Mathematical Greek Italic letters. This ensures that the Greek @@ -26948,7 +26992,7 @@ defined}{}% %\section{Package Initialisation and Options} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary-bookindex}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossary-bookindex}[2018/08/18 v1.36 (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 5b2ebc98cdd..b5956567208 100644 --- a/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins +++ b/Master/texmf-dist/source/latex/glossaries-extra/glossaries-extra.ins @@ -1,4 +1,4 @@ -% glossaries-extra.ins generated using makedtx version 1.2 2018/8/13 19:27 +% glossaries-extra.ins generated using makedtx version 1.2 2018/8/18 20:14 \input docstrip \preamble diff --git a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-bib2gls.sty b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-bib2gls.sty index 557df0654c6..7dca62e8c98 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-bib2gls.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra-bib2gls.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra-bib2gls}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossaries-extra-bib2gls}[2018/08/18 v1.36 (NLCT)] \newcommand*{\glshex}{\string\u} \newcommand*{\glscapturedgroup}{\string\$} \newcommand*{\GlsXtrIfHasNonZeroChildCount}[3]{% @@ -101,6 +101,16 @@ \glsaddstoragekey{bibtextype}{}{\glsxtrbibtype}% \glsaddstoragekey{volume}{}{\glsxtrbibvolume}% } +\newcommand*{\glsxtrmultisupplocation}[3]{% + {% + \def\glsxtrsupplocationurl{#2}% + \glshypernumber{#1}% + }% +} +\newcommand*\glsxtrdisplaysupploc[5]{% + \setentrycounter[#1]{#2}% + \glsxtrmultisupplocation{#5}{#4}{#3}% +} \providecommand*{\Alpha}{\mathrm{A}} \providecommand*{\Beta}{\mathrm{B}} \providecommand*{\Epsilon}{\mathrm{E}} 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 e3669546914..4be61aae9d4 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossaries-extra.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-extra}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossaries-extra}[2018/08/18 v1.36 (NLCT)] \RequirePackage{xkeyval} \RequirePackage{etoolbox} \@ifpackageloaded{glossaries} @@ -6170,11 +6170,14 @@ defined}{}% {}% } \newcommand*{\glsxtrautoindex}{\index} +\newcommand{\glsxtrautoindexesc}{% + \@gls@checkmkidxchars\@glo@sort + \@glsxtr@autoindex@doextra@esc\@glo@sort +} \newcommand*{\@glsxtr@autoindex@setname}[1]{% \protected@edef\@glo@name{\glsxtrautoindexentry{#1}}% \glsxtrautoindexassignsort{\@glo@sort}{#1}% - \@gls@checkmkidxchars\@glo@sort - \@glsxtr@autoindex@doextra@esc\@glo@sort + \glsxtrautoindexesc \epreto\@glo@name{\@glo@sort\@glsxtr@autoindex@at}% } \newcommand*{\glsxtrautoindexentry}[1]{\string\glsentryname{#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 9d1a5214282..67485ea1419 100644 --- a/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty +++ b/Master/texmf-dist/tex/latex/glossaries-extra/glossary-bookindex.sty @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossary-bookindex}[2018/08/13 v1.35 (NLCT)] +\ProvidesPackage{glossary-bookindex}[2018/08/18 v1.36 (NLCT)] \RequirePackage{multicol} \RequirePackage{glossary-tree} \newcommand{\glsxtrbookindexcols}{2} -- cgit v1.2.3