glossaries-extra.sty v1.14: an extension to the glossaries package
| Nicola L.C. Talbot |
| Dickimaw Books |
| http://www.dickimaw-books.com/ |
2017-04-18
Abstract
The glossaries-extra package is an extension to the glossaries package, providing additional features. Some of the features provided by this package are only available with glossaries version 4.19 (or above). This document assumes familiarity with the glossaries package.
Additional resources:
The glossaries package is a flexible package, but it’s also a heavy-weight package that uses a lot of resources. As package developer, I’m caught between those users who complain about the drawbacks of a heavy-weight package with a large user manual and those users who want more features (which necessarily adds to the package weight and manual size).
The glossaries-extra package is an attempt to provide a compromise for this conflict. Version 4.22 of the glossaries package is the last version to incorporate new features.1.1 Future versions of glossaries will just be bug fixes. New features will instead be added to glossaries-extra. This means that the base glossaries package won’t increase in terms of package loading time and allocation of resources, but those users who do want extra features available will have more of a chance of getting their feature requests accepted.
I’m not happy with some of the default settings assumed by the glossaries package, and, judging from code I’ve seen, other users also seem unhappy with them, as certain package options are often used in questions posted on various sites. I can’t change the default behaviour of glossaries as it would break backward compatibility, but since glossaries-extra is a separate package, I have decided to implement some of these commonly-used options by default. You can switch them back if they’re not appropriate.
The new defaults are:
The examples below illustrate the difference in explicit package options between glossaries and glossaries-extra. There may be other differences resulting from modifications to commands provided by glossaries (see §2 Modifications to Existing Commands and Styles).
This is like:
This is like:
This is like:
However
This is like:
Since by the time glossaries-extra has been loaded, glossaries has already redefined memoir’s glossary-related commands.
Another noticeable change is that by default \printglossary will now display information text in the document if the external glossary file doesn’t exist. This is explanatory text to help new users who can’t work out what to do next to complete the document build. Once the document is set up correctly and the external files have been generated, this text will disappear.
This change is mostly likely to be noticed by users with one or more redundant empty glossaries who ignore transcript messages, explicitly use makeindex/xindy on just the non-empty glossary (or glossaries) and use the iterative \printglossaries command instead of \printglossary. For example, consider the following:
The above document will only display the list of acronyms at the place where \printglossaries occurs. However it will also attempt to input the .gls file associated with the main glossary.
If you use makeglossaries, you’ll get the warning message:
(where the original file is called test.tex) but if you simply call makeindex directly to generate the .acr file (without attempting to create the .gls file) then the transcript file will always contain the message:
This doesn’t occur with makeglossaries as it will create the .gls file containing the single command \null.
If you simply change from glossaries to glossaries-extra in this document, you’ll find a change in the resulting PDF if you don’t use makeglossaries and you only generate the .acr file with makeindex.
The transcript file will still contain the message about the missing .gls, but now you’ll also see information in the actual PDF document. The simplest remedy is to follow the advice inserted into the document at that point, which is to add the nomain package option:
If you haven’t already loaded glossaries, you can use any of the package options provided by glossaries when you load glossaries-extra and they will automatically be passed to glossaries (which glossaries-extra will load). If glossaries has already been loaded, then those options will be passed to \setupglossaries, but remember that not all of the glossaries package options may be used in that command.
The new and modified options provided by glossaries-extra are described below:
If you want to define styles that can interface with the accessibility support provided by glossaries-accsupp use the \glsaccess⟨xxx⟩ type of commands instead of \glsentry⟨xxx⟩ (for example, \glsaccesstext instead of \glsentrytext). If glossaries-accsupp hasn’t been loaded those commands are equivalent (for example, \glsaccesstext just does \glsentrytext) but if it has been loaded, then the \glsaccess⟨xxx⟩ commands will add the accessibility information. (See §11.2 Accessibility Support for further details.)
Note that the accsupp option can only be used as a package option (not through \glossariesextrasetup) since the glossaries-accsupp package must be loaded before glossaries-extra if it’s required.
The option may only be set in the preamble.
The record=off option switches off the recording, as per the default behaviour. It implements undefaction=error.
The other values switch on the recording and also undefaction=warn, but record=only will also switch off the indexing mechanism (even if \makeglossaries or \makenoidxglossaries has been used) whereas record=alsoindex will both record and index. Note that record=only will prevent the see from automatically implementing \glssee. (bib2gls deals with the see field.) You may explicitly use \glssee in the document, but bib2gls will ignore the cross-reference if the see field was already set for that entry.
With the recording on, any of the commands that would typically index the entry (such as \gls, \glstext or \glsadd) will add a \glsxtr@record entry to the .aux file. bib2gls can then read these lines to find out which entries have been used. (Remember that commands like \glsentryname don’t index, so any use of these commands won’t add a corresponding \glsxtr@record entry to the .aux file.) See §9 bib2gls: Managing Reference Databases for further details.
With this option, if an entry appears in the glossary before it has been defined, an error will occur (or a warning if the undefaction=warn option is used.) If you edit your document and either remove an entry or change its label, you may need to delete the document’s temporary files (such as the .aux and .gls files).
The glossaries package allows \newglossaryentry within the document environment (when used with makeindex or xindy) but the user manual warns against this usage. By default the glossaries-extra package prohibits this, only allowing definitions within the preamble. If you are really determined to define entries in the document environment, despite all the associated drawbacks, you can restore this with docdef=true. Note that this doesn’t change the prohibitions that the glossaries package has in certain circumstances (for example, when using “option 1”). See the glossaries user manual for further details. A better option if document definitions are required is docdef=restricted. Only use docdef=true if document definitions are necessary and one or more of the glossaries occurs in the front matter.
This option affects commands that internally use \newglossaryentry, such as \newabbreviation, but not the “on-the-fly” commands described in §8 On-the-Fly Document Definitions.
Note that bib2gls can automatically find dependent entries when it parses the .bib source file. The record option automatically implements indexcrossrefs=false.
which is equivalent to
If this command is already defined, it’s left unchanged. Otherwise it’s defined to “Abbreviations” if babel hasn’t been loaded or \acronymname if babel has been loaded. However, if you’re using babel it’s likely you will need to change this. (See §13 Multi-Lingual Support for further details.)
If the abbreviations option is used and the acronym option provided by the glossaries package hasn’t been used, then \acronymtype will be set to \glsxtrabbrvtype so that acronyms defined with \newacronym can be added to the list of abbreviations. If you want acronyms in the main glossary and other abbreviations in the abbreviations glossary then you will need to redefine \acronymtype to main:
Note that there are no analogous options to the glossaries package’s acronymlists option (or associated commands) as the abbreviation mechanism is handled differently with glossaries-extra.
which is equivalent to
which is equivalent to
Note that multiple invocations of the shortcuts option within the same option list will override each other.
After the glossaries-extra package has been loaded, you can set available options using
The abbreviations and docdef options may only be used in the preamble. Additionally, docdef can’t be used after \makenoidxglossaries.
The commands used by glossaries to automatically produce an error if an entry is undefined (such as \glsdoifexists) are changed to take the undefaction option into account.
The \newignoredglossary{⟨type⟩} command now (as from v1.11) has a starred version that doesn’t automatically switch off the hyperlinks. This starred version may be used with the targeturl attribute to create a link to an external URL. (See §5 Categories for further details.) As from v1.12 both the starred and unstarred version check that the glossary doesn’t already exist. (The glossaries package omits this check.)
You can now provide an ignored glossary with:
which will only define the glossary if it doesn’t already exist. This also has a starred version that doesn’t automatically switch off hyperlinks.
The individual glossary displaying commands \printglossary, \printnoidxglossary and \printunsrtglossary have an extra key target. This is a boolean key which can be used to switch off the automatic hypertarget for each entry. Unlike \glsdisablehyper this doesn’t switch off hyperlinks, so any cross-references within the glossary won’t be affected. This is a way of avoiding duplicate target warnings if a glossary needs to be displayed multiple times.
The \newglossaryentry command has two new keys:
The \longnewglossaryentry command now has a starred version (as from v1.12) that doesn’t automatically insert
at the end of the description field.
The descriptionplural key is left unset unless explicitly set in ⟨options⟩.
The unstarred version no longer hard-codes the above code (which removes trailing space and suppresses the post-description hook) but instead uses:
This can be redefined to allow the post-description hook to work but retain the \unskip part if required. For example:
This will discarded unwanted trailing space at the end of the description but won’t suppress the post-description hook.
The unstarred version also alters the base glossaries package’s treatment of the descriptionplural key. Since a plural description doesn’t make much sense for multi-paragraph descriptions, the default behaviour with glossaries-extra’s \longnewglossaryentry is to simply leave the plural description unset unless explicitly set using the descriptionplural key. The glossaries.sty version of this command sets the description’s plural form to the same as the singular.2.1
Note that this modified unstarred version doesn’t append \glsxtrpostlongdescription to the description’s plural form.
The \newterm command (defined through the index package option) is modified so that the category defaults to index. The \newacronym command is modified to use the new abbreviation interface provided by glossaries-extra. (See §3 Abbreviations.)
The \makeglossaries command now has an optional argument.
If ⟨list⟩ is empty, \makeglossaries behaves as per its original definition in the glossaries package, otherwise ⟨list⟩ can be a comma-separated list of glossaries that need processing with an external indexing application.
It should then be possible to use \printglossary for those glossaries listed in ⟨list⟩ and \printnoidxglossary for the other glossaries. (See the accompanying file sample-mixedsort.tex for an example.)
You will need at least version 2.20 of makeglossaries or at least version 1.3 of the Lua alternative makeglossaries-lite.lua (both distributed with glossaries v4.27) to allow for this use of \makeglossaries[⟨list⟩]. Alternatively, use the automake option.
The glossaries-extra package provides extra keys for commands like \gls and \glstext:
The default value is set up using
which is defined as:
This sets the conditional
which is used to determine where to perform the indexing.
This means you can set the wrgloss attribute to after to automatically use this as the default for entries with that category attribute. (Note that adding wrgloss to the default options in \GlsXtrSetDefaultGlsOpts will override \glsxtrinitwrgloss.)
There is a new hook that’s used each time indexing information is written to the external glossary files:
where ⟨label⟩ is the entry’s label. This does nothing by default but may be redefined. (See, for example, the accompanying sample file sample-indexhook.tex, which uses this hook to determine which entries haven’t been indexed.)
As from version 1.14, there are two new keys for \glsadd: thevalue and theHvalue. These keys are designed for manually adding explicit locations rather than obtaining the value from the associated counter. (If you want an automated method, you might want to investigate bib2gls.) This is intended primarily for adding locations in supplementary material that can’t otherwise be picked up by makeindex or xindy. They therefore aren’t available for commands like \gls or \glslink. Remember that the value will still need to be a valid location according to the rules of whichever indexing application you use.
For example, suppose the file suppl.tex contains:
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 S.2. For example:
(By placing \glsadd at the end of the document, it adds the supplementary location to the end of the location list, although the ordering may be changed by the indexing application depending on its location collation settings.)
If you want hyperlinks, things are more complicated. First you need to set the externallocation to the location of the PDF file. For example:
Next you need to add glsxtrsupphypernumber as the format:
Both documents will need to use the hyperref package. Remember that the counter used for the location also needs to match. If \theH⟨counter⟩ is defined in the other document and is not the same as \the⟨counter⟩, then you need to use theHvalue 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 value of the see key is now saved as a field. This isn’t the case with glossaries, where the see attribute is simply used to directly write a line to the corresponding glossary file and is then discarded. This is why the see key can’t be used before \makeglossaries (since the file hasn’t been opened yet). It’s also the reason why the see key doesn’t have any effect when used in entries that are defined in the document environment. Since the value isn’t saved, it’s not available when the .glsdefs file is created at the end of the document and so isn’t available at the start of the document environment on the next run.
This modification allows glossaries-extra to provide
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 see key will now work for entries defined in the document environment, but it’s still best to define entries in the preamble, and the see key still can’t perform any indexing before the file has been opened by \makeglossaries. Note that glossaries v4.24 introduced the seenoindex package option, which can be used to suppress the error when the see key is used before \makeglossaries, so seenoindex=ignore will allow 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 entry using
This internally uses
where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field (if non-empty). By default, this just does \glsseeformat[⟨tag⟩]{⟨xr list⟩}{}, which is how the cross-reference is displayed in the number list. Note that \glsxtrusesee does nothing if the see field hasn’t been set for the entry given by ⟨label⟩.
Suppose you want to suppress the number list using nonumberlist. This will automatically prevent the cross-references from being displayed. The seeautonumberlist package option will automatically enable the number list for entries that have the see key set, but this will also show the rest of the number list.
Another approach in this situation is to use the post description hook with \glsxtrusesee to append the cross-reference after the description. For example:
Now the cross-references can appear even though the number list has been suppressed.
Recall from the glossaries package that commands such as \gls display text at that point in the document (optionally with a hyperlink to the relevant line in the glossary). This text is referred to as the “link-text” regardless of whether or not it actually has a hyperlink. The actual text and the way it’s displayed depends on the command used (such as \gls) and the entry format.
The default entry format (\glsentryfmt) used in the link-text by commands like \gls, \glsxtrfull, \glsxtrshort and \glsxtrlong (but not commands like \glslink, \glsfirst and \glstext) is changed by glossaries-extra to test for regular entries, which are determined as follows:
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, \glsentryfmt now puts \glsgenentry in the argument of the new command
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 you can redefine \glsxtrregularfont. This is more precise than changing \glstextformat which will be applied to all linking commands for all entries.
For example:
You can access the label through \glslabel. For example, you can query the category:
or query the category attribute:
or use the attribute to store the control sequence name:
(Remember the category and attribute settings will only queried here for regular entries, so if the abbreviation style for the acronym category in the above example changes the regular attribute to “false”, \glsxtrregularfont will no longer apply.)
The \glspostlinkhook provided by the glossaries package to insert information after the link-text produced by commands like \gls and \glstext is redefined to
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
if a full stop hasn’t be discarded and
if a full stop has been discarded.
By default \glsxtrpostlink just does \glsxtrpostlink⟨category⟩ if it exists, where ⟨category⟩ is the category label for the current entry. (For example, for the general category, \glsxtrpostlinkgeneral if it has been defined.)
The sentence-ending hook is slightly more complicated. If the command \glsxtrpostlink⟨category⟩ is defined the hook will do that and then insert a full stop with the space factor adjusted to match the end of sentence. If \glsxtrpostlink⟨category⟩ hasn’t been defined, the space factor is adjusted to match the end of sentence. This means that if you have, for example, an entry that ends with a full stop, a redundant following full stop will be discarded and the space factor adjusted (in case the entry is in uppercase) unless the entry is followed by additional material, in which case the following full stop is no longer redundant and needs to be reinserted.
There are some convenient commands you might want to use when customizing the post-link-text category hooks:
This will add the description in parentheses on first use.
For example, suppose you want to append the description in parentheses on first use for entries in the symbol category:
This will append the symbol (if defined) in parentheses on first use.
If you want to provide your own custom format be aware that you can’t use \ifglsused within the post-link-text hook as by this point the first use flag will have been unset. Instead you can use
This will do ⟨true⟩ if the last used entry was the first use for that entry, otherwise it will do ⟨false⟩. (Requires at least glossaries v4.19 to work properly.) This command is locally set by commands like \gls, so don’t rely on it outside of the post-link-text hook.
For example, if you want to place the description in a footnote after the link-text on first use for the general category:
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 \glslink, \gls etc with:
For example, if you mostly don’t want to index entries then you can do:
and then use, for example, \gls[noindex=false]{sample} when you actually want the location added to the number list. These defaults may be overridden by other settings (such as category attributes) in addition to any settings passed in the option argument of commands like \glslink and \gls.
Note that if you don’t want any indexing, just omit \makeglossaries and \printglossaries (or analogous commands). If you want to adjust the default for wrgloss, it’s better to do this by redefining \glsxtrinitwrgloss instead.
Commands like \gls have star (*) and plus (+) modifiers as a short cut for hyper=false and hyper=true. The glossaries-extra package provides a way to add a third modifier, if required, using
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).
Example:
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
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
This command is provided by glossaries, but is modified by glossaries-extra to check for the start and end range formation identifiers ( 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
otherwise it uses
for the start of a range (where the identifier has been stripped from ⟨format⟩) or
for the end of a range (where the identifier has been stripped from ⟨format⟩).
By default the start range command saves the format in
and does
\glsxtrdisplaysingleloc{⟨format⟩}{⟨location⟩}
The end command checks that the format matches the start of the range, does
(which does nothing by default), followed by
\glsxtrdisplaysingleloc{⟨format⟩}{⟨location⟩}
This means that the list
doesn’t display any differently from
but it does make it easier to define your own custom list handler that can accommodate the ranges.
The \glsenableentrycount command is modified to allow for the entrycount attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but you also need to set the appropriate attribute (see §5 Categories).
For example, instead of just doing:
you now need to do:
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 described in §6 Entry Counting.
Some languages, such as English, have a general rule that plurals are formed from the singular with a suffix appended. This isn’t an absolute rule. There are plenty of exceptions (for example, geese, children, churches, elves, fairies, sheep). The glossaries package allows the plural key to be optional when defining entries. In some cases a plural may not make any sense (for example, the term is a symbol) and in some cases the plural may be identical to the singular.
To make life easier for languages where the majority of plurals can simply be formed by appending a suffix to the singular, the glossaries package sets lets the plural field default to the value of the text field with \glspluralsuffix appended. This command is defined to be just the letter “s”. This means that the majority of terms don’t need to have the plural supplied as well, and you only need to use it for the exceptions.
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 firstplural, longplural and shortplural. Again, if you are using a language that doesn’t have a simple suffix rule, you’ll have to supply the plural forms if you need them (and if a plural makes sense in the context).
If these fields are omitted, the glossaries package follows these rules:
This last case is changed with glossaries-extra. With this extension package, the shortplural field defaults to the short field with \abbrvpluralsuffix appended unless overridden by category attributes. This suffix command is set by the abbreviation styles. This means that every time an abbreviation style is implemented, \abbrvpluralsuffix is redefined. In most cases its redefined to use
which defaults to just \glspluralsuffix. Some of the abbreviation styles have their own command for the plural suffix, such as \glsxtrscsuffix which is defined as:
So if you want to completely strip all the plural suffixes used for abbreviations then you need to redefine \glsxtrabbrvpluralsuffix not \abbrvpluralsuffix, which changes with the style. Redefining \acrpluralsuffix will have no affect, since it’s not used by the new abbreviation mechanism.
If you require a mixture (for example, in a multilingual document), there are two attributes that affect the short plural suffix formation. The first is aposplural which uses the suffix
That is, an apostrophe followed by \abbrvpluralsuffix is appended. The second attribute is noshortplural which suppresses the suffix and simply sets shortplural to the same as short.
Complications arise when you use \gls in the value of the name field (or text or first fields, if set). This tends to occur with abbreviations that extend other abbreviations. For example, SHTML is an abbreviation for SSI enabled HTML, where SSI is an abbreviation for Server Side Includes and HTML is an abbreviation for Hypertext Markup Language.
Things can go wrong if we try the following with the glossaries package:
The main problems are:
which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this will effectively try to do
This will upper case the label ssi so the entry won’t be recognised. This problem will also occur if you use the all capitals version, such as \GLS.
This produces:
This section discusses server side includes (SSI), hypertext markup language (HTML) and SSI enabled HTML (SHTML).
So the first use of the shtml entry produces “SSI enabled HTML (SHTML)”.
Now let’s suppose the html entry is used before the shtml but the ssi entry is used after the shtml entry, for example:
This produces:
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 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 shtml entry is used before (or without) the other two entries:
This produces:
This article is an introduction to server side includes (SSI) enabled hypertext markup language (HTML) (SHTML).
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 glossaries package’s \setacronymstyle. For example:
as this references the label through the use of \glslabel when displaying the long and short forms, but this value changes with each use of \gls, so instead of displaying “(SHTML)” at the end of the first use, it now displays “(HTML)”, since \glslabel has been changed to html by \gls{html}.
Another oddity occurs if you reset the html entry between uses of the shtml entry. For example:
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 amount to \acronymfont{S\acronymfont{HTML}}. This may not be a problem for some styles, but if you use one of the “sm” styles (that use \textsmaller), this will produce an odd result.
For these reasons it’s better to use the simple expandable commands like \glsentrytext or \glsentryshort in the definition of other entries (although that doesn’t fix the first problem). Alternatively use something like:
with glossaries or:
with glossaries-extra. This fixes all the above listed problems (as long as you don’t use \glsdesc). Note that replacing \gls with \acrshort in the original example may fix the first use issue, but it doesn’t fix any of the other problems listed above.
If it’s simply that you want to use the abbreviation font, you can use \glsabbrvfont:
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 \gls in a field that may be included within some link-text, glossaries-extra patches internals used by the linking commands so that if \gls (or plural or case changing variants) occurs in the link-text it will behave as though you used \glstext[hyper=false,noindex] instead. Grouping is also added so that, for example, when \gls{shtml} is used for the first time the long form
is treated as
This overcomes problems 4, 5 and 6 listed above, but still doesn’t fix problems 1 and 2. Problem 3 usually won’t be an issue as most abbreviation styles set the sort key to the short form, so using these commands in the long form but not the short form will only affect entries with a style that sorts according to the long form (such as long-noshort-desc).
Additionally, any instance of the long form commands, such as \glsxtrlong or \acrlong will be temporarily redefined to just use
(or case-changing versions). Similarly the short form commands, such as \glsxtrshort or \acrshort will use \glsentryshort in the argument of either \glsabbrvfont (for \glsxtrshort) or \acronymfont (for \acrshort). So if the shtml entry had instead been defined as:then (using the long-short style) the first use will be like
whereas if the entry is defined as:
then the first use will be like:
Note that the first optional argument of \acrshort or \glsxtrshort is ignored in this context. (The final optional argument will be inserted, if present.) The abbreviation style that governs \glsabbrvfont will be set for \glsxtrshort. Note that \acrshort doesn’t set the abbreviation style.
Alternatively you can use:
where ⟨field⟩ is the field label and corresponds to a command in the form \gls⟨field⟩ (e.g. \glstext) or in the form \glsxtr⟨field⟩ (e.g. \glsxtrshort).
There’s a shortcut command for the most common fields:
which is equivalent to \glsxtrp{short}{⟨label⟩}, and
which is equivalent to \glsxtrp{text}{⟨label⟩}.
The \glsxtrp command behaves much like the \glsfmt⟨field⟩ commands described in §4 Entries in Sectioning Titles, Headers, Captions and Contents but the post-link hook is also suppressed and extra grouping is added. It automatically sets hyper to false and noindex to true. If you want to change this, you can use
For example:
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 command:
which by default just does
You can redefine this if you want to adjust the setting when \glsxtrp is used in the glossary. For example:
For example,
is equivalent to
in the main body of the document or
inside the glossary. (Note the post-link hook is locally disabled.)
If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent to
(which recognises the headuc attribute.)
If hyperref has been loaded, then the bookmark will use \glsentry⟨field⟩ (\glsentryshort{ssi} in the above example).
There are similar commands
for first letter upper case and
for all upper case.
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 really need nested commands, the safest method is
but be aware that it may have some unexpected results occasionally.
Example document:
The glossaries-extra package provides a new way of dealing with abbreviations and redefines \newacronym to use \newabbreviation (see §3 Abbreviations). The simplest way to update a document that uses \newacronym from glossaries to glossaries-extra is do just add
before you define any entries. For example, the following document using just glossaries
can be easily adapted to use glossaries-extra:
Table 2.1 lists the nearest equivalent glossaries-extra abbreviation styles for the predefined acronym styles provided by glossaries, but note that the new styles use different formatting commands. See §3.4 Predefined Abbreviation Styles for further details.
The reason for introducing the new style of abbreviation commands provided by glossaries-extra is because the original acronym commands provided by glossaries are too restrictive to work with the internal modifications made by glossaries-extra. However, if you really want to restore the generic acronym function provided by glossaries you can use
(before any use of \newacronym).
\RestoreAcronyms should not be used in combination with the newer glossaries-extra abbreviations. Don’t combine old and new style entries with the same type. The original glossaries acronym mechanism doesn’t work well with the newer glossaries-extra commands.
In general, there’s rarely any need for \RestoreAcronyms. If you have a document that uses \newacronymstyle, then it’s best to either stick with just glossaries for that document or define an equivalent abbreviation style with \newabbreviationstyle. (See §3.5 Defining New Abbreviation Styles for further details.)
The space command \glsacspace used by the long-sp-short acronym style provided by glossaries is modified so that it uses
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 \glsxtrfullsep (such as long-short) can easily be changed to use \glsacspace with
The first use acronym font command
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
is redefined to use the subsequent use abbreviation font command \glsabbrvfont. This will be reset if you use \RestoreAcronyms.
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 glossaries package tries to determine the group title from its label by first checking if \⟨label⟩groupname exists. If it doesn’t exist, then the title is assumed to be the same as the label. For example, when typesetting the “A” letter group, glossaries first checks if \Agroupname exists. This could potentially cause conflict with another package that may have some other meaning for \Agroupname, so glossaries-extra first checks for the existence of the internal command \glsxtr@grouptitle@⟨label⟩ which shouldn’t clash with another package. You can set the group title using
For example:
The commands \glossentryname and \glossentrydesc are modified to take into account the glossname, glossdesc and glossdescfont attributes (see §5 Categories). This means you can make simple case-changing modifications to the name and description without defining a new glossary style.
There is a hook after \glossentryname and \Glossentryname:
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
See §7 Auto-Indexing for further details.
As from version 1.04, the post-name hook \glsxtrpostnamehook will also use \glsxtrpostname⟨category⟩ if it exists. You can use \glscurrententrylabel to obtain the entry label with the definition of this command. For example, suppose you are using a glossary style the doesn’t display the symbol, you can insert the symbol after the name for a particular category, say, the “symbol” category:
The post-description code used within the glossary is modified so that it also does
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 \glsxtrpostdesc⟨category⟩ if it exists, where ⟨category⟩ is the category label associated with the current entry. For example \glsxtrpostdescgeneral for entries with the category set to general or \glsxtrpostdescacronym for entries with the category set to acronym.
Since both \glossentry and \subglossentry set
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 description in the glossary, but only for entries in the general category, then you could do:
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.)
The number list is now placed inside the argument of
This is internally used by \glossaryentrynumbers. The nonumberlist option redefines \glossaryentrynumbers so that it doesn’t display the number list, but it still saves the number list in case it’s required.
If you want to, for example, change the font for the entire number list then redefine \GlsXtrFormatLocationList as appropriate. Don’t modify \glossaryentrynumbers.
Sometimes users like to insert “page” or “pages” in front of the number list. This 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:
where ⟨page⟩ is the text to display if the number list only contains a single location and ⟨pages⟩ is the text to display otherwise. For example:
An extra run is required when using this command.
See the accompanying sample file sample-pages.tex.
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.
As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that will redefine the predefined styles to include the post-description hook (for those that are missing it). You will need to make sure the styles have already been defined before loading glossaries-extra. For example:
Alternatively you can load glossary-⟨name⟩.sty at the same time by passing ⟨name⟩ as a package option to glossaries-extra-stylemods. For example:
Another option is to use the stylemods key when you load glossaries-extra. You can omit a value if you only want to use the predefined styles that are automatically loaded by glossaries (for example, the long3col style):
Or the value of stylemods may be a comma-separated list of the style package identifiers. For example:
Remember to group the value if it contains any commas:
Note that the inline style is dealt with slightly differently. The original definition provided by the glossary-inline package uses \glspostdescription at the end of the glossary (not after each entry description) within the definition of \glspostinline. The style modification changes this so that \glspostinline just does a full stop followed by space factor adjustment, and the description \glsinlinedescformat and sub-entry description formats \glsinlinesubdescformat are redefined to include \glsxtrpostdescription (not \glspostdescription). This means that the modified inline style isn’t affected by the nopostdot option, but the post-description category hook can still be used.
As from version 1.05, the glossaries-extra-stylemods package provides some additional commands for use with the alttree style to make it easier to modify. These commands are only defined if the glossary-tree package has already been loaded, which is typically the case unless the notree option has been used when loading glossaries.
This is like \glssetwidest (provided by glossary-tree) but performs a protected expansion on ⟨name⟩. This has a localised effect. For a global setting, use
The widest entry value can later be retrieved using
for the top-level entries and
for sub-entries, where ⟨level⟩ is the level number.
The command \glsfindwidesttoplevelname provided by glossary-tree has a CamelCase synonym:
Similar commands are also provided:
This has an additional check that the entry has been used. Naturally this is only useful if the glossaries that use the alttree style occur at the end of the document. This command should be placed just before the start of the glossary. (Alternatively, place it at the end of the document and save the value in the auxiliary file for the next run.)
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.
This is like the previous command but doesn’t check if the entry has been used.
This is like \glsFindWidestUsedTopLevelName but also sets the first two sub-levels as well. Any entry that has a great-grandparent is ignored.
This is like the previous command but doesn’t check if the entry has been used.
This is like \glsFindWidestUsedAnyName but also measures the symbol. The length of the widest symbol is stored in ⟨register⟩.
This is like the previous command but it doesn’t check if the entry has been used.
This is like \glsFindWidestUsedAnyNameSymbol but also measures the number list. This requires \glsentrynumberlist (see the glossaries user manual). The length of the widest symbol is stored in ⟨symbol register⟩ and the length of the widest number list is stored in ⟨location register⟩.
This is like the previous command but it doesn’t check if the entry has been used.
This is like \glsFindWidestUsedAnyNameSymbolLocation but doesn’t measure the symbol. The length of the widest number list is stored in ⟨register⟩.
This is like the previous command but doesn’t check if the entry has been used.
The layout of the symbol, description and number list is governed by
for top-level entries and
for sub-entries.
There is now a user level command that performs the initialisation for the alttree style:
The paragraph indent for subsequent paragraphs in multi-paragraph descriptions is provided by the length
For additional commands that are available with the alttree style, see the documented code (glossaries-extra-code.pdf). For examples, see the accompanying sample files sample-alttree.tex, sample-alttree-sym.tex and sample-alttree-marginpar.tex.
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 glossaries package is misnamed as it’s more often than not used for initialisms instead. Acronyms tend not to be expanded on first use (although they may need to be described for readers unfamiliar with the term). They are therefore more like a regular term, which may or may not require a description in the glossary.
The glossaries-extra package corrects this misnomer, and provides better abbreviation handling, with
This sets the category key to abbreviation by default, but that value may be overridden in ⟨options⟩. The category may have attributes that modify the way abbreviations are defined. For example, the insertdots attribute will automatically insert full stops (periods) into ⟨short⟩ or the noshortplural attribute will set the default value of the shortplural key to just ⟨short⟩ (without appending the plural suffix). See §5 Categories for further details.
See §2.5 Nested Links regarding the pitfalls of using commands like \gls or \glsxtrshort within ⟨short⟩ or ⟨long⟩.
The \newacronym command provided by the glossaries package is redefined by glossaries-extra to use \newabbreviation with the category set to acronym (see also §2.6 Acronym Style Modifications) so
is
now
equivalent
to
\newabbreviation[type=\acronymtype,category=acronym,⟨options⟩]
{⟨label⟩}
{⟨short⟩}
{⟨long⟩}
The \newabbreviation command is superficially similar to the glossaries package’s \newacronym but you can apply different styles to different categories. The default style is short-nolong for entries in the acronym category and short-long for entries in the abbreviation category. (These aren’t the same as the acronym styles provided by the glossaries package, although they may produce similar results.)
The short form is displayed within commands like \gls using
on first use and
for subsequent use.
If you use the long-short style, \glsabbrvfont is redefine to use
whereas the long-short-sc style redefines \glsabbrvfont to use \glsxtrscfont. If you want to use a different font-changing command you can either redefine \glsabbrvdefaultfont and use one of the base styles, such as long-short, or define a new style in a similar manner to the “sc”, “sm” or “em” styles.
Similarly the basic styles redefine \glsfirstabbrvfont to use
whereas the font modifier styles, such as long-short-sc, use their own custom command, such as \glsfirstscfont.
The commands that display the full form for abbreviations use \glsfirstabbrvfont to display the short form and
to display the long form on first use or for the inline full format. Commands like \glsxtrlong use
instead.
As with \glsabbrvfont, this command is changed by all styles. Currently all predefined abbreviation styles, except the “long-em” (emphasize long form) versions, provided by glossaries-extra redefine \glsfirstlongfont to use
and \glslongfont to use
You can redefine these command if you want to change the font used by the long form for all your abbreviations (except for the emphasize-long styles), or you can define your own abbreviation style that provides a different format for only those abbreviations defined with that style.
The “long-em” (emphasize long) styles use
instead of \glsfirstlongdefaultfont{⟨long-form⟩} and
instead of \glslongdefaultfont{⟨long-form⟩}. The first form \glsfirstlongemfont is initialised to use \glslongemfont.
Note that by default inserted material (provided in the final optional argument of commands like \gls), is placed outside the font command in the predefined styles. To move it inside, use:
This applies to all the predefined styles. For example:
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 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).
There are two types of full forms. The display full form, which is used on first use by commands like \gls and the inline full form, which is used by commands like \glsxtrfull. For some of the abbreviation styles, such as long-short, the display and inline forms are the same. In the case of styles such as short-nolong or short-footnote, the display and inline full forms are different.
These formatting commands aren’t stored in the short, shortplural, long or longplural fields, which means they won’t be used within commands like \glsentryshort (but they are used within commands like \glsxtrshort and \glsfmtshort). Note that \glsxtrlong and the case-changing variants don’t use \glsfirstlongfont.
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
before you define your abbreviations.
This command (robustly) defines ⟨cs⟩ (a control sequence) to accept a single argument, which is the letter (or letters) that needs to be tagged. The normal behaviour of this command within the document is to simply do its argument, but in the glossary it’s activated for those categories that have the tagging attribute set to “true”. For those cases it will use
This command defaults to \underline{⟨text⟩} but may be redefined as required.
The control sequence ⟨cs⟩ can’t already be defined when used with the unstarred version of \GlsXtrEnableInitialTagging for safety reasons. The starred version will overwrite any previous definition of ⟨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 \GlsXtrEnableInitialTagging is a comma-separated list of category names. The tagging attribute will automatically be set for those categories. You can later set this attribute for other categories (see §5 Categories) but this must be done before the glossary is displayed.
The accompanying sample file sample-mixtures.tex uses initial tagging for both the acronym and abbreviation categories:
This defines the command \itag which can be used in the definitions. For example:
The underlining of the tagged letters only occurs in the glossary and then only for entries with the tagging attribute set.
The abbreviation style must be set before abbreviations are defined using:
where ⟨style-name⟩ is the name of the style and ⟨category⟩ is the category label (abbreviation by default). New abbreviations will pick up the current style according to their given category. If there is no style set for the category, the fallback is the style for the abbreviation category. Some styles may automatically modify one or more of the attributes associated with the given category. For example, the long-noshort and short-nolong styles set the regular attribute to true.
Note that \setacronymstyle is disabled by glossaries-extra. Use
Abbreviations can be used with the standard glossaries commands, such as \gls, but don’t use the acronym commands like \acrshort (which use \acronymfont). The short form can be produced with:
(Use this instead of \acrshort.)
The long form can be produced with
(Use this instead of \acrlong.)
The inline full form can be produced with
(This this instead of \acrfull.)
As mentioned earlier, the inline full form may not necessarily match the format used on first use with \gls. For example, the short-nolong style only displays the short form on first use, but the full form will display the long form followed by the short form in parentheses.
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 long form:
First letter upper case inline full form:
All upper case short form:
All upper case long form:
All upper case inline full form:
Plural forms are also available.
Short form plurals:
Long form plurals:
Full form plurals:
The abbreviation shortcut commands can be enabled using the package option shortcuts=abbreviation (or shortcuts=abbr). This defines the commands listed in table 3.1.
There are two types of abbreviation styles: those that treat the abbreviation as a regular entry (so that \gls uses \glsgenentryfmt) and those that don’t treat the abbreviation as a regular entry (so that \gls uses \glsxtrgenabbrvfmt).
The regular entry abbreviation styles set the regular attribute to “true” for the category assigned to each abbreviation with that style. This means that on first use, \gls uses the value of the first field and on subsequent use \gls uses the value of the text field (and analogously for the plural and case-changing versions). The short and long fields are set as appropriate and may be accessed through commands like \glsxtrshort.
The other abbreviation styles don’t modify the regular attribute. The first and text fields (and their plural forms) are set and can be accessed through commands like \glsfirst, but they aren’t used by commands like \gls, which instead use the short form (stored in the short key) and the display full format (through commands like \glsxtrfullformat that are defined by the style).
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 “sc” styles all use
which is defined as
and
which is defined as
The default plural suffix for the short form is set to
This just defined as
The \glstextup command is provided by glossaries and is used to switch off the small caps font for the suffix. If you override the default short plural using the shortplural key when you define the abbreviation you will need to make the appropriate adjustment if necessary. (Remember that the default plural suffix behaviour can be modified through the use of the aposplural and noshortplural attributes. See §5 Categories for further details.)
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 uppercase, you won’t get small capitals unless you redefine \glsxtrscfont to convert its argument to lowercase. For example:
The “sm” styles all use
This is defined as:
and
which is defined as
If you want to use this style, you must explicitly load the relsize package which defines the \textsmaller command. If you want to easily switch between the “sc” and “sm” styles, you may find it easier to redefine this command to convert to upper case:
The default plural suffix for the short form is set to
This just does \glspluralsuffix.
The “em” styles all use
which is defined as:
and
which is defined as:
Some of the styles use
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:
or
The new naming scheme for abbreviation styles is as follows:
This is for the parenthetical styles. The -⟨modifier⟩ parts may be omitted. These styles display ⟨field1⟩ followed by ⟨field2⟩ in parentheses. If ⟨field2⟩ starts with “no” then the parenthetical element is omitted from the display style but is included in the inline style.
If the -⟨modifier⟩ part is present, then the field has a font changing command applied to it.
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:
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 -⟨modifier1⟩ is present, ⟨field1⟩ has a font-changing command applied to it.
Examples:
Like ⟨style⟩ but the description key must be provided when defining abbreviations with this style.
Examples:
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:
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.
The following abbreviation styles set the regular attribute to “true” for all categories that have abbreviations defined with any of these styles.
The name and sort keys are set to the long form and 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 automatically append the short form to the description. The inline full form will display ⟨long⟩ (⟨short⟩).
The following abbreviation styles will set the regular attribute to “false” if it has previously been set. If it hasn’t already been set, it’s left unset. Other attributes may also be set, depending on the style.
(which defaults to useri) using \ifglshasfield (provided by glossaries). If the field hasn’t been set, the style behaves like the long-short style and produces ⟨long⟩ (⟨short⟩) but if the field has been set, the contents of that field are inserted within the parentheses in the form ⟨long⟩ (⟨short⟩, ⟨field-value⟩). The format is governed by
where ⟨text⟩ is the short form (for the long-short-user style) or the long form (for the short-long-user style). This command first inserts a space using \glsxtrfullsep and then the parenthetical content. The ⟨text⟩ argument includes the font formatting command, \glsfirstabbrvfont{⟨short⟩} in the case of the long-short-user style and \glsfirstlongfont{⟨long⟩} in the case of the short-long-user style.
For example:
On first use, \gls{tug} will appear as:
TEX User Group (TUG)
whereas \gls{dante} will appear as:
Deutschsprachige Anwendervereinigung TEX e.V (DANTE, German Speaking TEX User Group)
The short form is formatted according to
and the plural suffix is given by
These may be redefined as appropriate. For example, if you want a smallcaps style, you can just set these commands to those used by the long-short-sc style:
For example:
The description must be supplied by the user. The long and short forms are separated by \glsxtrfullsep.
The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short form. The description is set to the long form.
As from version 1.05, all the footnote styles use:
to format the long form on first use or for the full form and
to format the long form elsewhere (for example, when used with \glsxtrlong).
As from version 1.07, all the footnote styles use:
By default, this just does \footnote{⟨long⟩} (the first argument is ignored). For example, to make the footnote text link to the relevant place in the glossary:
or to include the short form with a hyperlink:
Note that I haven’t used commands like \glsxtrshort to avoid interference (see §2.2 Entry Display Style Modifications and §2.5 Nested Links).
The inline full form uses the ⟨short⟩ (⟨long⟩) style. The name is set to the short form. The description is set to the long form. Note that this style will change \glsxtrfull (and it’s variants) so that it fakes non-first use. (Otherwise the footnote would appear after the inline form.)
New abbreviation styles may be defined using:
where ⟨name⟩ is the name of the new style (as used in the mandatory argument of \setabbreviationstyle). This is similar but not identical to the glossaries package’s \newacronymstyle command.
The ⟨setup⟩ argument deals with the way the entry is defined and may set attributes for the given abbreviation category. This argument should redefine
to set the entry fields including the name (defaults to the short form if omitted), sort, first, firstplural. Other fields may also be set, such as text, plural and description.
For example, the long-short style has the following in ⟨setup⟩:
Note that the first and firstplural are set even though they’re not used by \gls.
The ⟨setup⟩ argument may also redefine
which can be used to assign attributes. (This will automatically be initialised to do nothing.)
For example, the short-footnote includes the following in ⟨setup⟩:
This sets the nohyperfirst attribute to “true”. It also unsets the regular attribute if it has previously been set. Note that 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 following token registers.
Short value (defined by glossaries):
Short plural value (defined by glossaries-extra):
(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 glossaries):
Long plural value (defined by glossaries-extra):
(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.)
There are two other registers available that are defined by glossaries:
which contains the entry’s label and
which contains the values provided in the optional argument of \newabbreviation.
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):
This may be used inside the definition of \GlsXtrPostNewAbbreviation.
If you want to base a style on an existing style, you can use
where ⟨name⟩ is the name of the existing style. For example, the short-sc-footnote and short-sm-footnote styles both simply use
within ⟨setup⟩.
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 shortplural key):
(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 first use or in the full forms:
The font used for the short form on subsequent use or through commands like \glsxtrshort:
The font used for the long form on first use or in the full forms:
The font used for the long form in commands like \glsxtrlong use:
Display full form singular no case-change (used by \gls on first use for abbreviations without the regular attribute set):
Display full form singular first letter converted to upper case (used by \Gls on first use for abbreviations without the regular attribute set):
Display full form plural no case-change (used by \glspl on first use for abbreviations without the regular attribute set):
Display full form plural first letter converted to upper case (used by \Glspl on first use for abbreviations without the regular attribute set):
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 \glsentryfull, \glsxtrfull and \GLSxtrfull):
Inline singular first letter converted to upper case (used by \Glsentryfull and \Glsxtrfull):
Inline plural no case-change (used by \glsentryfullpl, \glsxtrfullpl and \GLSxtrfullpl):
Inline plural first letter converted to upper case (used by \Glsentryfullpl and \Glsxtrfullpl):
If you want to provide support for glossaries-accsupp use the following \glsaccess⟨xxx⟩ commands (§11.2 Accessibility Support) within the definitions of \glsxtrfullformat etc instead of the analogous \glsentry⟨xxx⟩ commands. (If you don’t use glossaries-accsupp, they will just do the corresponding \glsentry⟨xxx⟩ command.)
For example, the short-long style has the following in ⟨fmts⟩:
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
within ⟨fmts⟩, where ⟨name⟩ is the name of the existing style. For example, the short-sc-long style has the following in ⟨fmts⟩:
and the short-sm-long style has:
The simplest examples of creating a new style based on an existing style are the “em” styles, such as the short-em-long style, which is defined as:
The glossaries user manual cautions against using commands like \gls in chapter or section titles. The principle problems are:
Similar problems can also occur with captions (except for the page header and bookmark issues).
To get around all these problems, the glossaries user manual recommends using the expandable non-hyperlink commands, such as \glsentrytext (for regular entries) or \glsentryshort (for abbreviations). This is the simplest solution, but doesn’t allow for special formatting that’s applied to the entry through commands like \glstext or \glsxtrshort. This means that if, for example, you are using one of the abbreviation styles that uses \textsc then the short form displayed with \glsentryshort won’t use small caps. If you only have one abbreviation style in use, you can explicitly enclose \glsentryshort{⟨label⟩} in the argument of \glsabbrvfont, like this:
Or, if you are using hyperref:
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 \glsxtrshort redefine \glsabbrvfont to match the entry’s style before displaying it. In this case, the above example doesn’t take into account the shifting definitions of \glsabbrvfont and will use whatever happens to be the last abbreviation style in use. More complicated solutions interfere with the upper casing used by the standard page styles that display the chapter or section title in the page header using \MakeUppercase.
The glossaries-extra package tries to resolve this by modifying \markright and \markboth. If you don’t like this change, you can restore their former definitions using
In this case, you’ll have to use the glossaries manual’s recommendations of either simply using \glsentryshort (as above) or use the sectioning command’s option argument to provide an alternative for the table of contents and page header. For example:
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 \texorpdfstring if hyperref has been loaded so that the expandable non-formatted version is added to the PDF bookmarks. Note that since the commands that convert the first letter to upper case aren’t expandable, the non-case-changing version is used for the bookmarks.
These commands essentially behave as though you have used \glsxtrshort (or equivalent) with the options noindex and hyper=false. The text produced won’t be converted to upper case in the page headings by default. If you want the text converted to upper case you need to set the headuc attribute to “true” for the appropriate category.
Display the short form:
Display the plural short form:
First letter upper case singular short form:
(No case-change applied to PDF bookmarks.)
First letter upper case plural short form:
(No case-change applied to PDF bookmarks.)
Display the long form:
Display the plural long form:
First letter upper case singular long form:
(No case-change applied to PDF bookmarks.)
First letter upper case plural long form:
(No case-change applied to PDF bookmarks.)
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 plural full form:
First letter upper case singular full form:
(No case-change applied to PDF bookmarks.)
First letter upper case plural full form:
(No case-change applied to PDF bookmarks.)
There are also equivalent commands for the value of the text field:
First letter converted to upper case:
(No case-change applied to PDF bookmarks.)
The plural equivalents:
and
Similarly for the value of the first field:
First letter converted to upper case:
(No case-change applied to PDF bookmarks.)
The plural equivalents:
and
Each entry defined by \newglossaryentry (or commands that internally use it such as \newabbreviation) is assigned a category through the category key. You may add any category that you like, but since the category is a label used in the creation of some control sequences, avoid problematic characters within the category label. (So take care if you have babel shorthands on that make some characters active.)
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 \newglossaryentry is labelled general. Abbreviations defined with \newabbreviation have the category set to abbreviation by default. Abbreviations defined with \newacronym have the category set to acronym by default.
Additionally, if you have enabled \newterm with the index package option that command will set the category to index by default. If you have enabled \glsxtrnewsymbol with the symbols package option, that command will set the category to symbol. If you have enabled \glsxtrnewnumber with the numbers package option, that command will set the category to number.
You can obtain the category label for a given entry using
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
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 general and acronym categories have the attribute regular set to “true” to indicate that all entries with either of those categories are regular entries (as opposed to abbreviations). This attribute is accessed by \glsentryfmt to determine whether to use \glsgenentryfmt or \glsxtrgenabbrvfmt.
Other attributes recognised by glossaries-extra are:
to do nothing.
Note that this can cause a problem if you access a field that doesn’t end with a full stop. For example:
Here the short and long fields end with a full stop, but the user1 field doesn’t. The simplest solution in this situation is to put the sentence terminator in the final optional argument. For example:
This will bring the punctuation character inside the link-text and it won’t be discarded.
This attribute is best used with the discardperiod attribute set to “true”.
With glossaries, commands like \cgls use \cglsformat only if the previous usage count for that entry was equal to 1. With glossaries-extra the test is now for entries that have the entrycount attribute set and where the previous usage count for that entry is less than or equal to the value of that attribute.
For example:
(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 limitations for both the first letter uppercasing and the title casing commands. See the mfirstuc user manual for further details.
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, such as the list styles which put the name in the optional argument of \item.
(See also the accompanying sample file sample-external.tex.) If the URL contains awkward characters (such as % or ~) remember that the base glossaries package provides commands like \glspercentchar and \glstildechar that expand to literal characters.
If you want to a named anchor within the target URL (notionally adding #⟨name⟩ to the URL), then you also need to set targetname to the anchor ⟨name⟩. You may use \glslabel within ⟨name⟩ which is set by commands like \gls to the entry’s label.
All the predefined glossary styles start each entry listing with \glstarget which sets the anchor to \glolinkprefix\glslabel, so if you want entries to link to glossaries in the URL given by targeturl, you can just do:
(If the target document changed \glolinkprefix then you will need to adjust the above as appropriate.)
If the anchor is in the form ⟨name1⟩.⟨name2⟩ then use targetname for the ⟨name2⟩ part and targetcategory for the ⟨name1⟩ part.
For example:
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 glossary and entries that link to an external URL then you can use the starred form of \newignoredglossary for the external list. For example:
An attribute can be set using:
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 regular attribute to “true”:
If you need to lookup the category label for a particular entry, you can use the shortcut command:
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:
Again there is a shortcut if you need to lookup the category label for a given entry:
You can test if an attribute has been assigned to a given category using:
This uses etoolbox’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:
You can test the value of an attribute for a particular category using:
This tests if the attribute (given by ⟨attribute-label⟩) for the category (given by ⟨category-label⟩) is set and equal to ⟨value⟩. If true, ⟨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:
This does “NO HYPER” if the general category has the nohyper attribute set to true otherwise if does “HYPER”.
With boolean-style attributes like nohyper, make sure you always test for true not false in case the attribute hasn’t been set.
Again there’s a shortcut if you need to lookup the category label from a particular entry:
There’s also a shortcut to determine if a particular category has the regular attribute set to “true”:
Alternatively, if you need to lookup the category for a particular entry:
Note that if the regular 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 “false”:
or for a particular entry:
Again, if the regular attribute hasn’t been set, the above do ⟨false-part⟩, so these reverse commands aren’t logically opposite in the strict sense.
You can iterate through all entries with a given category using:
This iterates through all entries in the glossaries identified by the comma-separated list ⟨glossary-labels⟩ that have the category given by ⟨category-label⟩ and performs ⟨body⟩ for each match. Within ⟨body⟩, you can use ⟨glossary-cs⟩ and ⟨label-cs⟩ (which much be control sequences) to access the current glossary and entry label. If ⟨glossary-labels⟩ is omitted, all glossaries are assumed.
Similarly, you can iterate through all entries that have a category with a given attribute using:
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 field changing commands, such as \glsfielddef. Alternatively, you can use
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 expand ⟨category-label⟩ and make the change global.
You can also change the category for all entries with a glossary or glossaries using:
where ⟨glossary-labels⟩ is a comma-separated list of glossary labels.
As mentioned in §2.3 Entry Counting Modifications, glossaries-extra modifies the \glsenableentrycount command to allow for the entrycount attribute. This means that you not only need to enable entry counting with \glsenableentrycount, but you also need to set the appropriate attribute (see §5 Categories).
With glossaries-extra, you may use \cgls instead of \gls even if you haven’t enabled entry counting. You will only get a warning if you use \glsenableentrycount without setting the entrycount attribute. (With glossaries, commands like \cgls will generate a warning if \glsenableentrycount hasn’t been used.) The abbreviation shortcut \ab uses \cgls (see §3.3 Shortcut Commands) unlike the acronym shortcut \ac which uses \gls.
All upper case versions (not provided by glossaries) are also available:
and
These are analogous to \cgls and \cglspl but they use
and
which convert the analogous \cglsformat and \cglsplformat to upper case.
Just using glossaries:
If you switch to glossaries-extra you must set the entrycount attribute:
When activated with \glsenableentrycount, commands such as \cgls now use
to determine if the entry trips the entry count trigger. The ⟨trigger code⟩ uses commands like \cglsformat and unsets the first use flag. The ⟨normal code⟩ is the code that would ordinarily be performed by whatever the equivalent command is (for example, \cgls will use \cglsformat in ⟨trigger code⟩ but the usual \gls behaviour in ⟨normal code⟩).
The default definition is:
This means that if an entry is assigned to a category that has the entrycount 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 four:
There is a convenient command provided to enable entry counting, set the entrycount attribute and redefine \gls, etc to use \cgls etc:
The first argument ⟨categories⟩ is a comma-separated list of categories. For each category, the entrycount attribute is set to ⟨value⟩. In addition, this does:
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 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
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.
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-name⟩ needs to be expandable. Since hyperref also has a similar requirement and provides \theH⟨counter-name⟩ as an expandable alternative, glossaries-extra will use \theH⟨counter-name⟩ if it exists otherwise it will use \the⟨counter-name⟩.
The per-unit counting function uses two attributes: entrycount (as before) and unitcount (the name of the counter).
Both the original document-wide counting mechanism and the per-unit counting mechanism provide a command that can be used to access the current count value for this run:
and the final value from the previous run:
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:
which gives the sum of all the per-unit totals from the previous run for the entry given by ⟨label⟩, and
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:
In this document, the css entry is used three times in the first chapter. This is more than the trigger value of 2, so \gls{css} is expanded on first use with the short form used on subsequent use, and the css entries in that chapter are added to the glossary. In the second chapter, the css entry is only used once, which trips the suppression trigger, so in that chapter, the long form is used and \gls{css} doesn’t get a line added to the glossary file.
The 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 sample entry has only been used once, but it doesn’t trip the indexing suppression because it’s in the general category, which hasn’t been listed in \GlsXtrEnableEntryUnitCounting.
The per-unit entry counting can be used for other purposes. In the following 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
which is used at the end of the macro the determines whether or not to suppress the hyperlink.
This only produces a hyperlink for the first instance of \gls{sample} on each page.
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.
It’s possible that you may also want a normal index as well as the glossary, and you may want entries to automatically be added to the index (as in this document). There are two attributes that govern this: indexname and dualindex.
The \glsxtrpostnamehook macro, used at the end of \glossentryname and \Glossentryname, checks the indexname attribute for the category associated with that entry. Since \glossentryname is used in the default glossary styles, this makes a convenient way of automatically indexing each entry name at its location in the glossary without fiddling around with the value of the name key.
The internal macro used by the glossaries package to write the information to the external glossary file is modified to check for the dualindex attribute.
In both cases, the indexing is done through
This uses the standard \index command with the sort value taken from the entry’s sort key and the actual value set to \glsentryname{⟨label⟩}. 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:
will set the encap to textbf which will display the relevant page number in bold whereas
won’t apply any formatting to the page number in the index.
By default the format key won’t be used with the dualindex attribute. You can allow the format key to override the attribute value by using the preamble-only command:
If you use this command and hyperref has been loaded, then the theindex environment will be modified to redefine \glshypernumber to allow formats that use that command.
The \glsxtrdoautoindexname command will attempt to escape any of \makeindex’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 \encapchar have been defined before glossaries-extra is loaded).
If this isn’t the case, you can use the following preamble-only commands to set the correct characters.
Set the actual character to ⟨char⟩.
Set the level character to ⟨char⟩.
Set the escape (quote) character to ⟨char⟩.
Set the encap character to ⟨char⟩.
The glossaries package advises against defining entries in the document environment. As mentioned in §1.2 New or Modified Package Options above, this ability is disabled by default with glossaries-extra but can be enabled using the docdefs package options.
Although this can be problematic, the glossaries-extra package provides a way of defining and using entries within the document environment without the tricks used with the docdefs option. There are limitations with this approach, so take care with it. This function is disabled by default, but can be enabled using the preamble-only command:
When used, this defines the commands described below.
If an entry with the label ⟨label⟩ has already been defined, this just does \gls [⟨gls-options⟩]{⟨label⟩}. If ⟨label⟩ hasn’t been defined, this will define the entry using:
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
For example, this warning will be generated on the second instance of \glsxtr below:
If you are considering doing something like:
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 \glsxtr:
This is like \glsxtr but uses \glspl instead of \gls.
This is like \glsxtr but uses \Gls instead of \gls.
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 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 without switching to XƎLATEX or LuaLATEX then there is a starred version of \GlsXtrEnableOnTheFly that allows you to use UTF-8 characters in ⟨label⟩, but it’s experimental and may not work in some cases.
There is a new command line application under development called bib2gls, which works in much the same way as bibtex. Instead of storing all your entry definitions in a .tex and loading them using \input or \loadglsentries, the entries can instead be stored in a .bib file and bib2gls can selectively write the appropriate commands to a .glstex file which is loaded using \glsxtrresourcefile (or \GlsXtrLoadResources).
This means that you can use a reference managing system, such as JabRef, to maintain the database and it reduces the TEX overhead by only defining the entries that are actually required in the document. If you currently have a .tex file that contains hundreds of definitions, but you only use a dozen or so in your document, then the build time is needlessly slowed by the unrequired definitions that occur when the file is input.
Although bib2gls isn’t ready yet, there have been some new commands and options added to glossaries-extra to help assist the integration of bib2gls into the document build process.
An example of the contents of .bib file that stores glossary entries that can be extracted with bib2gls:
The follow provides some abbreviations:
Here are some symbols:
To ensure that bib2gls can find out which entries have been used in the document, you need the record package. Option:
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 xindy rule), then just use record=alsoindex and continue to use \makeglossaries and \printglossary (or \printglossaries), but instruct bib2gls to omit sorting to save time.
The .glstex file created by \bib2gls is loaded using:
(Don’t include the file extension in ⟨filename⟩.) There’s a shortcut version that sets ⟨filename⟩ \jobname:
On the first use, this command is a shortcut for
which is incremented at the end of \GlsXtrLoadResources. Any advisory notes regarding \glsxtrresourcefile also apply to \GlsXtrLoadResources.
The \glsxtrresourcefile command writes the line
The options are ignored by glossaries-extra but are picked up by bib2gls and are used to supply various information, such as the name of the .bib files and any changes to the default behaviour.
Since the .glstex won’t exist on the first LATEX run, the record package option additionally switches on undefaction=warn. Any use of commands like \gls or \glstext will produce ?? in the document, since they are undefined at this point. Once bib2gls has created the .glstex file the references should be resolved.
Note that as from v1.12, \glsxtrresourcefile temporarily switches the category code of @ to 11 (letter) while it reads the file to allow for any internal commands stored in the location field.
Since the .glstex file only defines those references used within the document and the definitions have been written in the order corresponding to bib2gls sorted list, the glossaries can simply be displayed using \printunsrtglossary (or \printunsrtglossaries), described in §10.2 Display All Entries Without Sorting or Indexing.
Suppose the .bib examples shown above have been stored in the files terms.bib, abbrvs.bib and symbols.bib which may either be in the current directory or on TEX’s path. Then the document might look like:
The document build process (assuming the document is called mydoc) is:
This creates a single glossary containing the entries: bird, duck, goose, html, M, shtml and ssi (in that order). The bird, shtml and M entries were added because bib2gls detected (from the .aux file) that they had been used in the document. The other entries were added because bib2gls detected (from the .bib files) that they are referenced by the used entries. In the case of duck and goose, they are in the see field for bird. In the case of ssi and html, they are referenced in the description field of shtml. These cross-referenced entries won’t have a location list when the glossary is first displayed, but depending on how they are referenced, they may pick up a location list on the next document build.
The entries can be separated into different glossaries with different sort methods:
(By default, entries are sorted according to the operating system’s locale. If this doesn’t match the document language, you need to set this in the option list, for example sort=de-CH-1996 for Swiss German using the new orthography.)
Note that \glsaddall doesn’t work in this case as it has to iterate over the glossary lists, which will be empty on the first run and on subsequent runs will only contain those entries that have been selected by bib2gls. Instead, if you want to add all entries to the glossary, you need to tell bib2gls this in the options list:
The bib2gls user manual will contain more detail.
The glossaries package provides \glsrefentry entry to cross-reference entries when used with the entrycounter or subentrycounter options. The glossaries-extra package provides a supplementary command
that works in the same way except that it uses \pageref instead of \ref.
You can copy an entry to another glossary using
This appends ⟨entry-label⟩ to the end of the internal list for the glossary given by ⟨glossary-type⟩. Be careful if you use the hyperref package as this may cause duplicate hypertargets. You will need to change \glolinkprefix to another value or disable hyperlinks when you display the duplicate. Alternatively, use the new target key to switch off the targets:
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
or prepend using
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
The default value is useri. Note that the value must be the control sequence name without the initial backslash.
For example:
There are two commands provided that allow you to apply the command to an argument:
This effectively does
This is defined as noindex but may be redefined as appropriate. Note that the replacement text of \GlsXtrFmtDefaultOptions is prepended to the optional argument of \glslink.
For example:
If the default options are set to noindex then \glsxtrfmt won’t index, but will create a hyperlink (if hyperref has been loaded). This can be changed so that it also suppresses the hyperlink:
Note that \glsxtrfmt won’t work with PDF bookmarks. Instead you can use
This uses \texorpdfstring and will simply expand to ⟨text⟩ within the PDF bookmarks, but in the document it will do ⟨cs⟩{⟨text⟩} if a control sequence name has been provided or just ⟨text⟩ otherwise.
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:
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 \glsaddstoragekey, ⟨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:
This tests if ⟨key⟩ is available for use in the ⟨key⟩= list in the second argument of \newglossaryentry (or the optional argument of commands like \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 these only change the specified field, not any related values. For example, changing the value of the text field won’t update the plural field. There are also some fields that should really only be set when entries are defined (such as the parent field). Unexpected results may occur if they are subsequently changed.
Sets the field given by ⟨field⟩ to ⟨value⟩ for the entry given by ⟨label⟩. No expansion is performed. It’s not necessary for the field to have been defined as a key. You can access the value later with \glsxtrusefield. Note that \glsxtrifkeydefined only tests if a key has been defined for use with commands like \newglossaryentry. If a field without a corresponding key is assigned a value, the key remains undefined. This command is robust.
\GlsXtrSetField uses
where ⟨label⟩ is the entry label and ⟨code⟩ is the assignment code.
This command just uses \glsdoifexists{⟨label⟩}{⟨code⟩} (ignoring the ⟨field⟩ argument), so by default it causes an error if the entry doesn’t exist. This can be changed to a warning with undefaction=warn. You can redefine \glsxtrsetfieldifexists to simply do ⟨code⟩ if you want to skip the existence check. Alternatively you can instead use
This simply uses etoolbox’s \csdef without any checks. This command isn’t robust. There is also a version that uses \csedef instead:
As \GlsXtrSetField but globally.
As \GlsXtrSetField but uses protected expansion.
As \gGlsXtrSetField but uses protected expansion.
Sets the field given by ⟨field⟩ to the replacement text of ⟨cs⟩ for the entry given by ⟨label⟩ (using \let).
As \GlsXtrLetField but the control sequence name is supplied instead.
Sets the field given by ⟨field-1⟩ for the entry given by ⟨label-1⟩ to the field given by ⟨field-2⟩ for the entry given by ⟨label-2⟩. There’s no check for the existence of ⟨label-2⟩, but \glsxtrsetfieldifexists{⟨label-1⟩}{⟨field-1⟩}{⟨code⟩} is still used, as for \GlsXtrSetField.
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:
This works in the same way as commands like \glsentrytext but the field label is specified in the first argument. Note that the ⟨field-label⟩ corresponds to the internal field tag, which isn’t always the same as the key name. See Table 4.1 of the glossaries 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 \Glsentrytext):
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 etoolbox’s \listcsadd:
where ⟨label⟩ is the entry’s label, ⟨field⟩ is the entry’s field and ⟨item⟩ is the item to add. There are analogous commands that use \listgadd, \listeadd and \listxadd:
You can then iterate over the list using:
or
that internally use \dolistcsloop and \forlistloop, respectively.
There are also commands that use \ifinlistcs:
and \xifinlistcs
See the etoolbox’s user manual for further details of these commands, in particular the limitations of \ifinlist.
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:
For example:
Each time an entry is referenced with commands like \gls or \glstext, the .aux file will not only contain the \glsxtr@record command but also
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.
This behaves like \printnoidxglossary but never sorts the entries and always lists all the defined entries for the given glossary (and doesn’t require \makenoidxglossaries).
There’s also a starred form
which is equivalent to
This means you now have the option to simply list all entries on the first LATEX run without the need for a post-processor, however there will be no number list in this case, as that has to be set by a post-processor such as bib2gls (see §9 bib2gls: Managing Reference Databases).
For example:
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 \printnoidxglossary (except for the sort key, which isn’t available).
All glossaries may be displayed in the order of their definition using:
which is analogous to \printnoidxglossaries. This just iterates over all defined glossaries (that aren’t on the ignored list) and does \printunsrtglossary[type=⟨type⟩].
The \printunsrtglossary command internally uses
for each item in the list, where ⟨label⟩ is the current label.
By default this just does
which determines whether to use \glossentry or \subglossentry and checks the location and loclist fields for the number list.
You can redefine the handler if required.
For example, if the preamble includes:
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:
Alternatively you can use the starred form of \printunsrtglossary which will localise the change:
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 \glolinkprefix to avoid duplicate hypertarget names. For example:
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:
There’s a shortcut command that does this:
The above example can simply be replaced with:
This shortcut command is actually defined to use \printunsrtglossary* with
so if you want to just make some minor modifications you can do
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 record (or record=alsoindex) package option.
This temporary change in the hypertarget prefix means you need to explicitly use \hyperlink to create a link to it as commands like \gls will try to link to the target created with the default definition of \gloslinkprefix. This isn’t a problem if you want a primary glossary of all terms produced using just \printunsrtglossary (in the front or back matter) which can be the target for all glossary references and then just use \printunsrtglossaryunit for a quick summary at the start of a section etc.
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 existence when the aliased entry is defined. This is to allow the possibility of defining the other entry after the aliased entry. (For example, when used with bib2gls.)
If an entry ⟨entry-1⟩ is made an alias of ⟨entry-2⟩ then:
Note that with record=only, the location list for aliased entries is controlled with bib2gls’s settings.
The index suppression trigger is performed by
This is performed after the default options provided by \GlsXtrSetDefaultGlsOpts have been set. With record=only, \glsxtrsetaliasnoindex will default to do nothing.
Within the definition of \glsxtrsetaliasnoindex you can use
to index ⟨entry-2⟩.
The index suppression command can be redefined to index the main term instead. For example:
The value of the alias field can be accessed using
The glossaries bundle provides additional support packages glossaries-prefix (for prefixing) and glossaries-accsupp (for accessibility support). These packages aren’t automatically loaded.
If prefixing is required, you can simply load glossaries-prefix after glossaries-extra. For example:
The glossaries-accsupp needs to be loaded before glossaries-extra or through the accsupp package option:
If you don’t load glossaries-accsupp or you load glossaries-accsupp after glossaries-extra the new \glsaccess⟨xxx⟩ commands described below will simply be equivalent to the corresponding \glsentry⟨xxx⟩ commands.
The following \glsaccess⟨xxx⟩ commands add accessibility information wrapped around the corresponding \glsentry⟨xxx⟩ commands. There is no check for existence of the entry nor do any of these commands add formatting, hyperlinks or indexing information.
This displays the value of the name field for the entry identified by ⟨label⟩.
If the glossaries-accsupp package isn’t loaded, this is simply defined as:
otherwise it’s defined as:
(\glsnameaccessdisplay is defined by the glossaries-accsupp package.) The first letter upper case version is:
Without the glossaries-accsupp package this is just defined as:
With the glossaries-accsupp package this is defined as:
The following commands are all defined in an analogous manner.
This displays the value of the text field.
This displays the value of the text field with the first letter converted to upper case.
This displays the value of the plural field.
This displays the value of the plural field with the first letter converted to upper case.
This displays the value of the first field.
This displays the value of the first field with the first letter converted to upper case.
This displays the value of the firstplural field.
This displays the value of the firstplural field with the first letter converted to upper case.
This displays the value of the symbol field.
This displays the value of the symbol field with the first letter converted to upper case.
This displays the value of the symbolplural field.
This displays the value of the symbolplural field with the first letter converted to upper case.
This displays the value of the desc field.
This displays the value of the desc field with the first letter converted to upper case.
This displays the value of the descplural field.
This displays the value of the descplural field with the first letter converted to upper case.
This displays the value of the short field.
This displays the value of the short field with the first letter converted to upper case.
This displays the value of the shortplural field.
This displays the value of the shortplural field with the first letter converted to upper case.
This displays the value of the long field.
This displays the value of the long field with the first letter converted to upper case.
This displays the value of the longplural field.
This displays the value of the longplural field with the first letter converted to upper case.
The following sample files are provided with this package:
There’s only one command provided by glossaries-extra that you’re likely to want to change in your document and that’s \abbreviationsname (§1.2 New or Modified Package Options) if you use the abbreviations package option to automatically create the glossary labelled abbreviations. If this command doesn’t already exist, it will be defined to “Abbreviations” if babel hasn’t been loaded, otherwise it will be defined as \acronymname (provided by glossaries).
You can redefine it in the usual way. For example:
Or using babel or polyglossia captions hook:
Alternatively you can use the title key when you print the list of abbreviations. For example:
or
The other fixed text commands are the diagnostic messages, which shouldn’t appear in the final draft of your document.
The glossaries-extra package has the facility to load language modules if they exist, but won’t warn if they don’t.
If you want to write your own language module, you just need to create a file called glossariesxtr-⟨lang⟩.ldf, where ⟨lang⟩ is the language name (see the tracklang package). For example, glossariesxtr-french.ldf.
The simplest code for this file is:
You can adapt this for other languages by replacing all instances of the language identifier french and the translated text Abr\’eviations as appropriate. This .ldf file then needs to be put somewhere on TEX’s path so that it can be found by glossaries-extra. You might also want to consider uploading it to CTAN so that it can be useful to others. (Please don’t send it to me. I already have more packages than I am able to maintain.)
If you additionally want to provide translations for the diagnostic messages used when a glossary is missing, you need to redefine the following commands:
This produces the following text in English:
This document is incomplete. The external file associated with the glossary ‘⟨label⟩’ (which should be called ⟨file⟩) hasn’t been created.
This produces the following text in English:
This has probably happened because there are no entries defined in this glossary.
This produces the following text in English:
If you don’t want this glossary, add nomain to your package option list when you load glossaries-extra.sty. For example:
This produces the following text in English:
Did you forget to use type=⟨label⟩ when you defined your entries? If you tried to load entries into this glossary with \loadglsentries did you remember to use [⟨label⟩] as the optional argument? If you did, check that the definitions in the file you loaded all had the type set to \glsdefaulttype.
This produces the following text in English:
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.
This produces the following text in English:
You need to either replace \makenoidxglossaries with \makeglossaries or replace \printglossary (or \printglossaries) with \printnoidxglossary (or \printnoidxglossaries) and then rebuild this document.
This produces the following text in English:
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.
This produces the following text in English:
This message will be removed once the problem has been fixed.
This is advice on how to generate the glossary files. See the documented code (glossaries-extra-code.pdf) for further details.
This is the message produced when the automake option is used, but the document needs a rerun or the shell escape setting doesn’t permit the execution of the external application. This command also generates a warning in the transcript file. See the documented code for further details.
A
B
babel package 238, 239, 240, 241, 242, 243, 244, 245
bib2gls 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272
bib2gls 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299
C
categories:
abbreviation 300, 301, 302, 303
acronym 304, 305, 306, 307, 308, 309
general 310, 311, 312, 313, 314, 315, 316, 317
index 318, 319
number 320
symbol 321, 322
category attributes:
aposplural 323, 324, 325, 326
discardperiod 327, 328, 329, 330, 331
dualindex 332, 333, 334, 335, 336, 337, 338
entrycount 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349
externallocation 350
glossdesc 351, 352, 353
glossdescfont 354, 355
glossname 356, 357
glossnamefont 358
headuc 359, 360, 361, 362
indexname 363, 364, 365, 366, 367
indexonlyfirst 368, 369, 370
insertdots 371, 372
nohyper 373, 374, 375
nohyperfirst 376, 377, 378, 379, 380
noshortplural 381, 382, 383, 384, 385
pluraldiscardperiod 386, 387
regular 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407
retainfirstuseperiod 408
tagging 409, 410, 411, 412
targetcategory 413
targetname 414, 415
targeturl 416, 417, 418, 419, 420
unitcount 421
wrgloss 422, 423
\cGLS 424
\cGLSformat 425
\cGLSpl 426
\cGLSplformat 427
\csGlsXtrLetField 428
\CustomAbbreviationFields 429
D
datatool-base package 430
E
\eglssetwidest 431
\eGlsXtrSetField 432
entry location 433, 434, 435
etoolbox package 436, 437, 438, 439, 440, 441
F
first use 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 482, 483, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495
first use flag 496, 497, 498, 499, 500
first use text 501, 502
fontenc package 503
G
\gGlsXtrSetField 504
glossaries package 505, 506, 507, 508, 509, 510, 511, 512, 513
glossaries-accsupp package 514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 527, 528
glossaries-extra package 529, 530
glossaries-extra-stylemods package 531, 532, 533, 534
glossaries-prefix package 535, 536, 537
\glossariesextrasetup 538
glossary styles:
alttree 539, 540, 541, 542, 543, 544, 545
inline 546, 547
long3col 548
glossary-inline package 549
glossary-tree package 550, 551, 552
\glossxtrsetpopts 553
\glsabbrvdefaultfont 554
\glsabbrvemfont 555
\glsabbrvfont 556, 557
\glsabbrvuserfont 558
\Glsaccessdesc 559
\glsaccessdesc 560
\Glsaccessdescplural 561
\glsaccessdescplural 562
\Glsaccessfirst 563
\glsaccessfirst 564
\Glsaccessfirstplural 565
\glsaccessfirstplural 566
\Glsaccesslong 567
\glsaccesslong 568
\Glsaccesslongpl 569
\glsaccesslongpl 570
\Glsaccessname 571
\glsaccessname 572
\Glsaccessplural 573
\glsaccessplural 574
\Glsaccessshort 575
\glsaccessshort 576
\Glsaccessshortpl 577
\glsaccessshortpl 578
\Glsaccesssymbol 579
\glsaccesssymbol 580
\Glsaccesssymbolplural 581
\glsaccesssymbolplural 582
\Glsaccesstext 583
\glsaccesstext 584
\glsacspace 585
\glsacspacemax 586
\glsadd options
theHvalue 587, 588
thevalue 589, 590, 591
\glscategory 592
\glscategorylabel 593
\glscurrententrylabel 594
\glsentrycurrcount 595
\glsentryprevcount 596
\glsentryprevmaxcount 597
\glsentryprevtotalcount 598
\glsFindWidestAnyName 599
\glsFindWidestAnyNameLocation 600
\glsFindWidestAnyNameSymbol 601
\glsFindWidestAnyNameSymbolLocation 602
\glsFindWidestLevelTwo 603
\glsFindWidestTopLevelName 604
\glsFindWidestUsedAnyName 605
\glsFindWidestUsedAnyNameLocation 606
\glsFindWidestUsedAnyNameSymbol 607
\glsFindWidestUsedAnyNameSymbolLocation 608
\glsFindWidestUsedLevelTwo 609
\glsFindWidestUsedTopLevelName 610
\glsfirstabbrvdefaultfont 611
\glsfirstabbrvemfont 612
\glsfirstabbrvfont 613, 614
\glsfirstlongdefaultfont 615
\glsfirstlongemfont 616
\glsfirstlongfont 617, 618
\glsfirstlongfootnotefont 619
\Glsfmtfirst 620
\glsfmtfirst 621
\Glsfmtfirstpl 622
\glsfmtfirstpl 623
\Glsfmtfull 624
\glsfmtfull 625
\Glsfmtfullpl 626
\glsfmtfullpl 627
\Glsfmtlong 628
\glsfmtlong 629
\Glsfmtlongpl 630
\glsfmtlongpl 631
\Glsfmtplural 632
\glsfmtplural 633
\Glsfmtshort 634
\glsfmtshort 635
\Glsfmtshortpl 636
\glsfmtshortpl 637
\Glsfmttext 638
\glsfmttext 639
\glsforeachwithattribute 640
\glsgetattribute 641
\glsgetcategoryattribute 642
\glsgetwidestname 643
\glsgetwidestsubname 644
\glshasattribute 645
\glshascategoryattribute 646
\glsifattribute 647
\glsifcategory 648
\glsifcategoryattribute 649
\glsifnotregular 650
\glsifnotregularcategory 651
\glsifregular 652
\glsifregularcategory 653
\glskeylisttok 654
\glslabeltok 655
\glslink options
format 656, 657
hyper 658, 659, 660
hyper=false 661
noindex 662, 663, 664, 665, 666, 667, 668
wrgloss 669, 670, 671, 672
\glslinkcheckfirsthyperhook 673
\glslongdefaultfont 674
\glslongemfont 675
\glslongfont 676, 677
\glslongfootnotefont 678
\glslongpltok 679
\glslongtok 680
\glsnoidxdisplayloc 681
\glsps 682
\glspt 683
\glssetattribute 684
\glssetcategoryattribute 685
\glssetregularcategory 686
\glsshortpltok 687
\glsshorttok 688
\Glsxtr 689
\glsxtr 690
\glsxtrabbrvfootnote 691
\glsxtrabbrvpluralsuffix 692
\glsxtraddallcrossrefs 693
\glsxtralias 694
\glsxtrAltTreeIndent 695
\glsxtralttreeInit 696
\glsxtralttreeSubSymbolDescLocation 697
\glsxtralttreeSymbolDescLocation 698
\glsxtrchecknohyperfirst 699
\glsxtrcopytoglossary 700
\glsxtrdeffield 701
\glsxtrdisplayendloc 702
\glsxtrdisplayendlochook 703
\glsxtrdisplaysingleloc 704
\glsxtrdisplaystartloc 705
\glsxtrdoautoindexname 706
\glsxtrdowrglossaryhook 707
\glsxtredeffield 708
\GlsXtrEnableEntryCounting 709
\GlsXtrEnableEntryUnitCounting 710
\GlsXtrEnableIndexFormatOverride 711
\GlsXtrEnableInitialTagging 712
\GlsXtrEnableOnTheFly 713
\GlsXtrEnablePreLocationTag 714
\glsxtrentryfmt 715
\glsxtrfielddolistloop 716
\glsxtrfieldforlistloop 717
\glsxtrfieldifinlist 718
\glsxtrfieldlistadd 719
\glsxtrfieldlisteadd 720
\glsxtrfieldlistgadd 721
\glsxtrfieldlistxadd 722
\glsxtrfieldtitlecasecs 723
\glsxtrfieldxifinlist 724
\glsxtrfirstscfont 725
\glsxtrfirstsmfont 726
\glsxtrfmt 727
\GlsXtrFmtDefaultOptions 728
\GlsXtrFmtField 729
\GlsXtrFormatLocationList 730
\GLSxtrfull 731
\Glsxtrfull 732
\glsxtrfull 733
\Glsxtrfullformat 734
\glsxtrfullformat 735
\GLSxtrfullpl 736
\Glsxtrfullpl 737
\glsxtrfullpl 738
\Glsxtrfullplformat 739
\glsxtrfullplformat 740
\glsxtrfullsep 741
\glsxtrifcounttrigger 742
\glsxtrifkeydefined 743
\glsxtrifwasfirstuse 744
\glsxtrindexaliased 745
\glsxtrinitwrgloss 746
\Glsxtrinlinefullformat 747
\glsxtrinlinefullformat 748
\Glsxtrinlinefullplformat 749
\glsxtrinlinefullplformat 750
\glsxtrinsertinsidetrue 751
\GlsXtrLetField 752
\GlsXtrLetFieldToField 753
\GlsXtrLoadResources 754
\glsxtrlocrangefmt 755
\Glsxtrlong 756, 757
\glsxtrlong 758
\GLSxtrlongpl 759
\Glsxtrlongpl 760
\glsxtrlongpl 761
\glsxtrlongshortdescsort 762
\glsxtrnewnumber 763
\glsxtrnewsymbol 764
\GlsXtrNoGlsWarningAutoMake 765
\GlsXtrNoGlsWarningBuildInfo 766
\GlsXtrNoGlsWarningCheckFile 767
\GlsXtrNoGlsWarningEmptyMain 768
\GlsXtrNoGlsWarningEmptyNotMain 769
\GlsXtrNoGlsWarningEmptyStart 770
\GlsXtrNoGlsWarningHead 771
\GlsXtrNoGlsWarningMisMatch 772
\GlsXtrNoGlsWarningNoOut 773
\GlsXtrNoGlsWarningTail 774
\Glsxtrp 775, 776
\glsxtrp 777
\glsxtrpageref 778
\Glsxtrpl 779
\glsxtrpl 780
\glsxtrpostdescription 781
\glsxtrpostlink 782
\glsxtrpostlinkAddDescOnFirstUse 783
\glsxtrpostlinkAddSymbolOnFirstUse 784
\glsxtrpostlinkendsentence 785
\glsxtrpostlinkhook 786
\glsxtrpostlongdescription 787
\glsxtrpostnamehook 788
\GlsXtrPostNewAbbreviation 789
\glsxtrprovidestoragekey 790
\GlsXtrRecordCounter 791
\glsxtrregularfont 792
\glsxtrresourcefile 793
\glsxtrRevertMarks 794
\glsxtrscfont 795
\glsxtrscsuffix 796
\GlsXtrSetActualChar 797
\glsxtrsetaliasnoindex 798
\GlsXtrSetAltModifier 799
\glsxtrsetcategory 800
\glsxtrsetcategoryforall 801
\GlsXtrSetDefaultGlsOpts 802
\GlsXtrSetEncapChar 803
\GlsXtrSetEscChar 804
\GlsXtrSetField 805
\glsxtrsetfieldifexists 806
\glsxtrsetgrouptitle 807
\GlsXtrSetLevelChar 808
\glsxtrsetpopts 809
\Glsxtrshort 810, 811
\glsxtrshort 812
\GLSxtrshortpl 813
\Glsxtrshortpl 814
\glsxtrshortpl 815
\glsxtrsmfont 816
\glsxtrsmsuffix 817
\glsxtrtagfont 818
\glsxtrunsrtdo 819
\GlsXtrUseAbbrStyleFmts 820
\GlsXtrUseAbbrStyleSetup 821
\Glsxtrusefield 822
\glsxtrusefield 823
\glsxtruserfield 824
\glsxtruserparen 825
\glsxtrusersuffix 826
\glsxtrusesee 827
\glsxtruseseeformat 828
\GlsXtrWarnDeprecatedAbbrStyle 829
\GlsXtrWarning 830
H
hyperref package 831, 832, 833, 834, 835, 836, 837, 838, 839, 840, 841, 842, 843, 844, 845, 846, 847, 848
I
\ifglsxtrinitwrglossbefore 849
L
link-text 850, 851, 852, 853, 854, 855, 856, 857, 858, 859, 860, 861, 862, 863, 864, 865, 866, 867
location list 868, 869, 870, 871, 872
\longnewglossaryentry 873
M
makeglossaries 874, 875, 876, 877, 878
\makeglossaries 879
makeglossaries-lite.lua 880, 881
makeglossaries-lite.lua 882, 883
makeindex 884, 885, 886, 887, 888, 889, 890, 891, 892, 893
memoir class 894
mfirstuc package 895, 896, 897
N
\newabbreviation 898
\newabbreviationstyle 899
\newacronym 900
\newglossaryentry options
alias 901, 902, 903, 904, 905
category 906, 907, 908, 909, 910
desc 911, 912
descplural 913, 914
description 915, 916, 917, 918, 919, 920, 921, 922, 923, 924, 925, 926, 927, 928, 929, 930, 931, 932, 933
descriptionplural 934, 935, 936, 937
first 938, 939, 940, 941, 942, 943, 944, 945, 946, 947, 948, 949
firstplural 950, 951, 952, 953, 954, 955, 956, 957, 958, 959
location 960
loclist 961
long 962, 963, 964, 965, 966, 967, 968, 969
longplural 970, 971, 972, 973, 974, 975
name 976, 977, 978, 979, 980, 981, 982, 983, 984, 985, 986, 987, 988, 989, 990, 991, 992, 993, 994, 995, 996, 997, 998, 999
parent 1000, 1001
plural 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1011, 1012, 1013, 1014
see 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032
short 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046
shortplural 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060
sort 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072
symbol 1073, 1074, 1075
symbolplural 1076, 1077
text 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089
type 1090, 1091
user1 1092, 1093, 1094
number list 1095, 1096, 1097, 1098, 1099, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116
P
package options:
abbreviations 1117, 1118, 1119, 1120, 1121
accsupp 1122, 1123, 1124
acronym 1125
acronymlists 1126
automake 1127, 1128
docdef 1129, 1130, 1131, 1132
restricted 1133
true 1134, 1135
docdefs 1136, 1137, 1138
entrycounter 1139
hyperfirst
false 1140
index 1141, 1142
indexcrossrefs 1143, 1144, 1145
false 1146
indexonlyfirst 1147, 1148, 1149, 1150
nomain 1151
nomissingglstext 1152
nonumberlist 1153, 1154, 1155, 1156
nopostdot 1157, 1158
false 1159, 1160
true 1161
noredefwarn
false 1162
true 1163
notree 1164
numbers 1165, 1166, 1167
record 1168, 1169, 1170, 1171, 1172, 1173
alsoindex 1174, 1175, 1176, 1177
off 1178, 1179
only 1180, 1181, 1182, 1183
seeautonumberlist 1184
seenoindex 1185
ignore 1186
shortcuts 1187, 1188
abbr 1189, 1190
abbreviation 1191
abbreviations 1192
acro 1193
acronyms 1194
all 1195
false 1196
none 1197
other 1198
true 1199
stylemods 1200, 1201, 1202
subentrycounter 1203
symbols 1204, 1205, 1206
toc
false 1207
true 1208
translate
babel 1209
true 1210
undefaction 1211, 1212
error 1213, 1214
warn 1215, 1216, 1217, 1218, 1219
page (counter) 1220, 1221
polyglossia package 1222
\pretoglossarypreamble 1223
\printabbreviations 1224
\printglossary options
target 1225, 1226
title 1227
\printnoidxglossary options
sort 1228
\printunsrtglossaries 1229
\printunsrtglossary 1230, 1231
\printunsrtglossaryhandler 1232
\printunsrtglossaryunit 1233
\printunsrtglossaryunitsetup 1234
\provideignoredglossary 1235
R
relsize package 1236
\RestoreAcronyms 1237
S
\setabbreviationstyle 1238
slantsc package 1239
T
textcase package 1240
tracklang package 1241, 1242
translator package 1243
X
xfor package 1244
\xglssetwidest 1245
\xGlsXtrSetField 1246
xindy 1247, 1248, 1249, 1250, 1251, 1252, 1253, 1254
xkeyval package 1255
1.14.21 was originally intended as the last release of glossaries to incorporate new features, but a few new minor features slipped in with some bug fixes in v4.21.
2.1The descriptionplural key is a throwback to the base package’s original acronym mechanism before the introduction of the long and short keys, where the long form was stored in the description field and the short form was stored in the symbol field.
9.1Version 1.11 only allowed one use of \GlsXtrLoadResources per document.
9.2v1.08 assumed ⟨filename⟩.tex but that’s potentially dangerous if, for example, ⟨filename⟩ happens to be the same as \jobname. The .glstex extension was enforced by version 1.11.