From c628b1aa9cf528de739c1de45acf3739561619ed Mon Sep 17 00:00:00 2001
From: Norbert Preining
glossaries-extra.sty v1.46: an extension to the
+class="cmr-17">glossaries-extra.sty v1.47: an extension to the
glossaries package
2021-09-20
@@ -896,7 +903,7 @@ before \newacronym. See §??sec:abbreviations 4 Abbreviations for further details.)
@@ -1217,7 +1224,7 @@ class="cmitt-10">xxx⟩ commands will add the accessibility information. (See §??sec:accsupp 12.2 Accessibility Support for further details.)
Note that the value⟩ if it contains any commas.) The value may b omitted if no options need to be passed. See §??sec:glosstylemods 2.11 Glossary Style Modifications for further details. There are two special keyword values: =warn§??sec:glsunset 2.6 First Use Flag for further details.
This option is best used with .aux file.) See §??sec:bib2gls 9 bib2gls: Managing Reference Databases for further details. @@ -1863,7 +1870,7 @@ class="cmtt-10">\glsfmttext and \glsfmtshort, don’t index. (See §??sec:headtitle +class="cmbx-10">5 Entries in Sectioning Titles, Headers, Captions and Contents). You may want to consider using \newabbreviation, but not the “on-the-fly” co §??sec:onthefly 11 On-the-Fly Document Definitions.
@@ -2310,7 +2317,7 @@ class="cmss-10">babel§??sec:lang 14 Multi-Lingual Support for further details.)
The commands used by glossaries to automatically produce an error if an entry is @@ -2775,7 +2782,7 @@ class="cmss-10">categorygeneral. See §??sec:categories 6 Categories for further information about categories.
@@ -2785,7 +2792,7 @@ class="cmss-10">alias, which allows an entry to be alias to another entry. See §??sec:alias +class="cmbx-10">10.5 Entry Aliases for further details. @@ -2798,7 +2805,7 @@ class="cmss-10">see§??sec:see 2.3 Cross-References (“see” and “see also”) for further details. @@ -2902,7 +2909,7 @@ the new abbreviation interface provided by glossaries-extra. (See §??sec:abbreviations +class="cmbx-10">4 Abbreviations.)The indexonlyfirst attribute, see §??sec:categories 6 Categories for further details.) Note that the noindexsoul example in §??sec:glsunset 2.6 First Use Flag.
which fully expands its argument and passes it to \glsseelist. -
The seealso key implements the automatic indexing using -
As from v1.47, glossaries-extra redefines \glsseelist to make it more flexible. +The base package provides \glsseeitem{⟨label⟩} which is used to format each element +in the list and \glsseelastsep for the separator between the final two items +(\glsseesep is used between the other items). The modifications provide two +additional commands: +
+This defaults to \glsseeitem{⟨label⟩} and is used to format the first label in the +list. +
+This defaults to \glsseelastsep and is used if the list consists of three or more +labels. +
The seealso key implements the automatic indexing using +
+
which just does
The command that produces this “see also” text is -
The command that produces this “see also” text is +
+
If \alsoname (provided by language packages) is defined then (provided by language packages) is defined then \seealsoname will simply be defined to \alsoname otherwise it will be defined to see also. -
The language-sensitive The language-sensitive \alsoname is used by general indexing packages, such as
makeidx, so if you redefine , so if you redefine \alsoname the change will apply to normal indexes as well
as glossaries. If you only want to change the text produced by the seealso key
+ id="dx1-8082"> key
without affecting general indexing (with \index) then redefine \seealsoname
instead.
-
+
Recall from the Recall from the glossaries package that commands such as \gls display text at
that point in the document (optionally with a hyperlink to the relevant
@@ -4244,7 +4281,7 @@ whether or not it actually has a hyperlink. The actual text and the way
it’s displayed depends on the command used (such as \gls) and the entry
format.
- The default entry format ( The default entry format (\glsentryfmt) used in the link-text by commands like
@@ -4268,14 +4305,17 @@ entries, which are determined as follows:
An entry that doesn’t have a value for the An entry that doesn’t have a value for the short key is assumed to
be a regular entry, even if the regular2.4 Entry Display Style Modifications
-
If an entry does has a value for the If an entry does has a value for the short key and hasn’t been marked
as a regular entry through the glossaries-extra
This means that entries with a short form can be treated as regular entries rather +
This means that entries with a short form can be treated as regular entries rather than abbreviations if it’s more appropriate for the desired style. -
As from version 1.04, As from version 1.04, \glsentryfmt now puts \glsgenentry in the argument of
the new command
-
+
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
@@ -4362,7 +4399,7 @@ overridden by the textformat attribute.
- For example:
+ For example:
@@ -4370,7 +4407,7 @@ class="cmss-10">textformat You can access the label through You can access the label through \glslabel. For example, you can query the
category:
@@ -4381,7 +4418,7 @@ category:
\renewcommand*{\glsxtrregularfont}[1]{%
\glsifcategory{\glslabel}{general}{\textsf{#1}}{#1}}
- or query the category attribute, for example, provide a custom attribute called
+ or query the category attribute, for example, provide a custom attribute called
font:
@@ -4393,7 +4430,7 @@ class="cmtt-10">font As from version 1.21, it’s simpler to just do, for example:
+ As from version 1.21, it’s simpler to just do, for example:
@@ -4401,21 +4438,21 @@ class="cmtt-10">font:
without redefining without redefining \glsxtrregularfont.
- As from version 1.30, there is also a command for abbreviations that encapsulates
+ As from version 1.30, there is also a command for abbreviations that encapsulates
\glsxtrgenabbrvfmt:
-
+
This also just does its argument by default. Font changes made by abbreviation styles
are within ⟨text⟩.
- The The \glspostlinkhook provided by the glossaries package to insert information
after the link-text produced by commands like \gls and \glstext is redefined
to
-
+
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.
- It may be that you want to check some other setting (rather than a category
+ It may be that you want to check some other setting (rather than a category
attribute) to determine whether or not to discard a following full stop. In which case
you can redefine:
-
+
You can access the field’s label using \glslabel. This command should do ⟨true⟩ if the
@@ -4467,9 +4504,9 @@ definition is simply:
which means that no additional checks are performed. (Only the recognised category
+ which means that no additional checks are performed. (Only the recognised category
attributes will be checked.)
-
- By default
+ By default \glsxtrpostlink just does \glsxtrpostlink⟨category⟩general You can define the post-link hook command using You can define the post-link hook command using \newcommand, for
example:
@@ -4507,15 +4544,15 @@ example:
\glsxtrpostlinkAddDescOnFirstUse
}
- or, as from v1.31, you can use
- or, as from v1.31, you can use
+
+
This is simply a shortcut for: The sentence-ending hook is slightly more complicated. If the command
+ The sentence-ending hook is slightly more complicated. If the command
\glsxtrpostlink⟨category⟩ There are some convenient commands you might want to use when customizing
+ There are some convenient commands you might want to use when customizing
the post-link-text category hooks:
-
+
This will add the description in parentheses on first use.
- For example, suppose you want to append the description in parentheses on For example, suppose you want to append the description in parentheses on first
use for entries in the symbolsymbol
-
-
+
+
This will append the symbol (if defined) in parentheses on first use. (Does nothing if
the symbol hasn’t been set.)
-
+
(New to v1.31.) On first use, this will append \space(⟨description⟩) if the
symbol is defined otherwise it just appends \space(⟨description⟩).
- If you want to provide your own custom format be aware that you can’t use
+ If you want to provide your own custom format be aware that you can’t use
\ifglsused within the post-link-text hook as by this point the first use flag will have
been unset. Instead you can use
-
+
This will do ⟨true⟩ if the last used entry was the first use for that entry, otherwise it
@@ -4617,7 +4654,7 @@ 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
+ For example, if you want to place the description in a footnote after the link-text
on first use for the general
-
- The
+ The short-postfootnote abbreviation style uses the post-link-text hook to place the
footnote after trailing punctuation characters.
-
+
If you are using If you are using bib2gls you may find it more convenient to use the record count
commands described in §??sec:bib2gls 9 The The \glsenableentrycount command is modified to allow for the \glsenableentrycount, but you also need to set the approp
§??sec:categories 6 For example, instead of just doing:
+ For example, instead of just doing:
@@ -4702,7 +4739,7 @@ href="#sec:categories">Categories).
you now need to do:
+ you now need to do:
@@ -4711,24 +4748,24 @@ href="#sec:categories">Categories).
\glsenableentrycount
\glssetcategoryattribute{abbreviation}{entrycount}{1}
- This will enable the entry counting for entries in the This will enable the entry counting for entries in the abbreviation category, but any
entries assigned to other categories will be unchanged.
- Further information about entry counting, including the new per-unit feature, is
+ Further information about entry counting, including the new per-unit feature, is
described in §??sec:entrycount 7.1
+
The The glossaries package provides
-
+
to determine whether or not an entry has been used. This requires the entry to have
been defined. If the entry is undefined, then the underlying boolean variable doesn’t
exist and so is neither true nor false. This command will produce an error with the
@@ -4757,7 +4794,7 @@ class="cmti-10">true The The record option automatically implements bib2gls. In this case, you may prefer
to use:
-
+
(new to v1.34) which does ⟨true⟩ if the entry given by ⟨label⟩ is undefined or if
@@ -4795,23 +4832,23 @@ class="cmtt-10">\glsxtrifwasfirstuse should be used, see §??sec:entryfmtmods 2.4 Entry Display
Style Modifications.)
- There are two new commands provided with version 1.31+:
- There are two new commands provided with version 1.31+:
+
+
and
-
+
These behave like \glslocalreset and \glslocalunset but the argument is a
@@ -4819,7 +4856,7 @@ comma-separated list of labels.
- The internal command used by The internal command used by \glsunset is modified first to allow for the
changing in entry counting, described above, but also to allow for buffering pending
unsets when commands like
\ul{Some text about \gls{html}.}
- This causes the confusing error:
+ This causes the confusing error:
@@ -4843,7 +4880,7 @@ the commands provided with the
Glossary entry `{html}' has not been defined.
- The simplest workaround is to put The simplest workaround is to put \gls{html} inside the argument of \mbox. For
example:
@@ -4854,7 +4891,7 @@ example:
This can work provided it’s not the first use of this entry. It if is, then unsetting the
+ This can work provided it’s not the first use of this entry. It if is, then unsetting the
first use flag causes a problem and results in the error:
@@ -4863,15 +4900,15 @@ first use flag causes a problem and results in the error:
The The glossaries-extra package provides a way of temporarily switching off \glsunset
so that it just makes a note of the entry’s label but doesn’t actually perform the
change:
-
+
The unstarred version doesn’t check for duplicates, so the internal list may
end up with multiple occurrences of the same label. The starred version
only adds a label to the internal list if it’s not already in it. Note that this
@@ -4879,12 +4916,12 @@ buffering only applies to the global \glsunset and does not affect the local
\glslocalunset.
- Later you can restore Later you can restore \glsunset and unset all buffered labels using:
-
+
The starred form \GlsXtrStopUnsetBuffering* uses \glslocalunset instead. For
@@ -4906,37 +4943,37 @@ example:
Next use: \gls{html}.
\end{document}
- Before you stop the unset buffering, you can iterate over the current buffer
+ Before you stop the unset buffering, you can iterate over the current buffer
using
-
+
where ⟨cs⟩ is a control sequence that takes a single argument (which is the entry label).
This is best used with the starred version \GlsXtrStartUnsetBuffering* to avoid
duplicates.
- You can discard the buffer and restore You can discard the buffer and restore \glsunset to its normal behaviour with
(new to v1.42):
-
-
+
- There can still be a problem here as content within
+ There can still be a problem here as content within \mbox can’t break across a
line so you may end up with an overfull line or excessive white space within the
paragraph.
- An alternative is to use An alternative is to use \protect:
@@ -4947,7 +4984,7 @@ class="cmtt-10">\protect but the formatting (underlining in this example) won’t be applied. Another
+ but the formatting (underlining in this example) won’t be applied. Another
possibility is:
@@ -4970,7 +5007,7 @@ possibility is:
Next use: \gls{html}.
\end{document}
- This moves This moves \gls outside of \ul and uses textformattextformat
+
which (protected) fully expands ⟨text⟩ before applying ⟨cs⟩, which must be a control
@@ -5004,12 +5041,12 @@ something that \ul can’t deal with. For example, if an abbreviation style is used
that contains complex formatting or if the field value contains problematic
content.
-
+
Some languages, such as English, have a general rule that plurals are formed from
+ Some languages, such as English, have a general rule that plurals are formed from
the singular with a suffix appended. This isn’t an absolute rule. There are
plenty of exceptions (for example, geese, children, churches, elves, fairies,
sheep). The To make life easier for languages where the majority of plurals can simply be
+ To make life easier for languages where the majority of plurals can simply be
formed by appending a suffix to the singular, the glossaries package lets the plural supplied as well, and you only need to use it for the
exceptions.
- For languages that don’t have this general rule, the For languages that don’t have this general rule, the plural field will always need to
be supplied, where needed.
- There are other plural fields, such as There are other plural fields, such as firstplural, longpluralshortplural If these fields are omitted, the If these fields are omitted, the glossaries package follows these rules: If If firstplural is missing, then \glspluralsuffix is appended to the text\glspluralsuffix If the If the longplural field is missing, then \glspluralsuffix is appended to
@@ -5103,7 +5140,7 @@ class="cmss-10">long If the If the shortplural field is missing then, with the base short field.
This This last case is changed with glossaries-extra. With this extension package, the
\abbrvpluralsuffix is redefined. In most cases its redefined to
use
-
+
which defaults to just \glspluralsuffix. Some of the abbreviation styles have their
@@ -5152,7 +5189,7 @@ class="cmtt-10">\abbrvpluralsuffix, which changes with
the style. Redefining \acrpluralsuffix will have no affect, since it’s not used by the
new abbreviation mechanism.
- If you require a mixture (for example, in a multilingual document), there are two
+ If you require a mixture (for example, in a multilingual document), there are two
attributes that affect the short plural suffix formation. The first is aposplural
'\abbrvpluralsuffix
- That is, an apostrophe followed by That is, an apostrophe followed by \abbrvpluralsuffix is appended. The second
attribute is shortpluralshort
+
Complications arise when you use Complications arise when you use \gls in the value of the name Things can go wrong if we try the following with the Things can go wrong if we try the following with the glossaries package:
@@ -5205,12 +5242,12 @@ class="cmss-10">glossaries
- The main problems are:
+
+ The main problems are:
The first letter upper casing commands, such as \Gls, won’t work for the
@@ -5227,7 +5264,7 @@ href="#glo:firstuse">first use which just doesn’t work. Grouping the which just doesn’t work. Grouping the \gls{ssi} doesn’t work either as this
will effectively try to do
@@ -5237,7 +5274,7 @@ class="cmtt-10">\gls{ssi} This will upper case the label This will upper case the label ssi so the entry won’t be recognised.
This problem will also occur if you use the all capitals version, such as
\GLS The long and abbreviated forms accessed through \glsentrylong and
@@ -5257,7 +5294,7 @@ class="cmtt-10">\glsentryshort The nested commands may end up in the sort key, which will confuse the
@@ -5265,7 +5302,7 @@ class="cmss-10">sort The shtml entry produces inconsistent results depending on whether the ssi
@@ -5282,15 +5319,15 @@ class="cmtt-10">shtml. For example:
This produces:
+ This produces:
This section discusses server side includes (SSI), hypertext
+ This section discusses server side includes (SSI), hypertext
markup language (HTML) and SSI enabled HTML (SHTML). So the So the first use of the shtml entry produces “SSI enabled HTML (SHTML)”.
- Now let’s suppose the Now let’s suppose the html entry is used before the shtml but the ssi entry is
@@ -5304,17 +5341,17 @@ class="cmtt-10">shtml This produces:
+ This produces:
The sample files are either hypertext markup language (HTML)
+ The sample files are either hypertext markup language (HTML)
or server side includes (SSI) enabled HTML (SHTML), but let’s
first discuss SSI. So the So the first use of the shtml entry now produces “server side includes (SSI)
enabled HTML (SHTML)”, which looks a bit strange.
- Now let’s suppose the Now let’s suppose the shtml entry is used before (or without) the other two
entries:
@@ -5324,17 +5361,17 @@ class="cmtt-10">shtml This produces:
+ This produces:
This article is an introduction to server side includes (SSI)
+ This article is an introduction to server side includes (SSI)
enabled hypertext markup language (HTML) (SHTML). So the So the first use of the shtml entry now produces “server side includes (SSI)
enabled hypertext markup language (HTML) (SHTML)”, which is even more
strange.
- This is all aggravated by setting the style using the This is all aggravated by setting the style using the glossaries package’s
\setacronymstyle. For example:
@@ -5345,7 +5382,7 @@ class="cmtt-10">\setacronymstyle as this references the label through the use of as this references the label through the use of \glslabel when displaying the
long and short forms, but this value changes with each use of \gls, so
@@ -5357,7 +5394,7 @@ class="cmtt-10">\glslabel Another oddity occurs if you reset the Another oddity occurs if you reset the html entry between uses of the shtml
entry. For example:
@@ -5368,10 +5405,10 @@ class="cmtt-10">shtml The next use of The next use of shtml produces “Shypertext markup language (HTML)”,
which is downright weird.
- Even without this, the short form has nested formatting commands, which
+ Even without this, the short form has nested formatting commands, which
amount to \acronymfont{S\acronymfont{HTML}}. This may not be a problem
for some styles, but if you use one of the “sm” styles (that use \textsmaller Each time the shtml entry is used, the html entry will also be indexed and
@@ -5395,7 +5432,7 @@ class="cmtt-10">html
If hyperref is in use, you’ll get nested hyperlinks and there’s no consistent way
@@ -5407,7 +5444,7 @@ class="cmss-10">hyperref
For these reasons it’s better to use the simple expandable commands
+ For these reasons it’s better to use the simple expandable commands
like \glsentrytext or
- with with glossaries or:
@@ -5435,7 +5472,7 @@ class="cmss-10">glossaries with with glossaries-extra. This fixes all the above listed problems (as long as you don’t
use \glsdescfirst use issue, but it doesn’t fix any of the other problems listed
above.
- If it’s simply that you want to use the abbreviation font, you can use
+ If it’s simply that you want to use the abbreviation font, you can use
\glsabbrvfont:
@@ -5460,10 +5497,10 @@ class="cmtt-10">\glsabbrvfont This will pick up the font style setting of the outer entry (shtml, in the above case).
+ This will pick up the font style setting of the outer entry (shtml, in the above case).
This isn’t a problem in the above example as all the abbreviations use the same
style.
- However if you’re really determined to use However if you’re really determined to use \gls in a field that may be included
within some
\gls{ssi} enabled \gls{html}
- is treated as
+ is treated as
@@ -5496,7 +5533,7 @@ form
{\glstext[hyper=false,noindex]{ssi}} enabled
{\glstext[hyper=false,noindex]{html}}
- This overcomes problems This overcomes problems 4, 5 and 6 listed above, but still doesn’t fix problems long-noshort-desc).
- Additionally, any instance of the long form commands, such as Additionally, any instance of the long form commands, such as \glsxtrlong or
shtml entry had instead been defined as:
then (using the then (using the long-short style) the first use will be like
{\acronymfont{\glsentryshort{ssi}}} enabled
{\acronymfont{\glsentryshort{html}}} (SHTML)
- whereas if the entry is defined as:
+ whereas if the entry is defined as:
@@ -5573,7 +5610,7 @@ href="#glo:firstuse">first use then the then the first use will be like:
@@ -5584,7 +5621,7 @@ href="#glo:firstuse">first use Note that the first optional argument of Note that the first optional argument of \acrshort or \glsxtrshort is ignored in
this context. (The final optional argument will be inserted, if present.) The
@@ -5595,15 +5632,15 @@ class="cmtt-10">\glsxtrshort Alternatively you can use:
- Alternatively you can use:
+
+
where ⟨field⟩ is the field label and corresponds to a command in the form \gls⟨\glstext) or in the form \glsxtr⟨field⟩ (e.g. \glsxtrshort).
- There’s a shortcut command for the most common fields:
- 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 The \glsxtrp command behaves much like the \glsfmt⟨field⟩ commands described
in §??sec:headtitle 5
+
For example:
@@ -5668,15 +5705,15 @@ For example:
will just switch off the hyperlinks but not the indexing. Be careful using
+ will just switch off the hyperlinks but not the indexing. Be careful using
this command or you can end up back to the original problem of nested
links.
- The hyper link is re-enabled within glossaries. This is done through the
+ The hyper link is re-enabled within glossaries. This is done through the
command:
-
+
which by default just does
@@ -5685,7 +5722,7 @@ which by default just does
You can redefine this if you want to adjust the setting when You can redefine this if you want to adjust the setting when \glsxtrp is used in the
glossary. For example:
@@ -5695,8 +5732,8 @@ glossary. For example:
- For example,
+
+ For example,
@@ -5704,7 +5741,7 @@ glossary. For example:
is equivalent to
+ is equivalent to
@@ -5714,7 +5751,7 @@ glossary. For example:
\glsxtrshort[hyper=false,noindex]{ssi}[]%
}
- in the main body of the document or
+ in the main body of the document or
@@ -5724,8 +5761,8 @@ glossary. For example:
\glsxtrshort[noindex]{ssi}[]%
}
- inside the glossary. (Note the post-link hook is locally disabled.)
- If inside the glossary. (Note the post-link hook is locally disabled.)
+ If \glsxtrp{short}{ssi} occurs in a sectioning mark, it’s equivalent
to
@@ -5735,37 +5772,37 @@ to
(which recognises the (which recognises the headuc attribute.)
- If If hyperref has been loaded, then the bookmark will use \glsentry⟨field⟩
(\glsentryshort{ssi} in the above example).
- There are similar commands
- There are similar commands
+
+
for first letter upper case and
-
+
for all upper case.
-
- You can, with care, protect against issue
+ You can, with care, protect against issue 1 by inserting an empty group at the
start if the long form starts with a command that breaks the first letter uppercasing
commands like \Gls, but you still won’t be able to use the all caps commands, such
as \GLS.
- If you If you really need nested commands, the safest method is
@@ -5795,8 +5832,8 @@ class="cmti-10">really need but be aware that it may have some unexpected results occasionally.
- Example document:
+ but be aware that it may have some unexpected results occasionally.
+ Example document:
@@ -5826,13 +5863,13 @@ Next page.
\printglossaries
\end{document}
-
-
+
+
The The glossaries-extra package provides a new way of dealing with abbreviations and
@@ -5843,7 +5880,7 @@ class="cmtt-10">\newacronym before you define any entries. If you have used commands like before you define any entries. If you have used commands like \acrshort, \acrlong\glsxtrshort For example, the following document using just For example, the following document using just glossaries
@@ -5908,7 +5945,7 @@ class="cmss-10">glossaries can be easily adapted to use can be easily adapted to use glossaries-extra:
@@ -5925,7 +5962,7 @@ class="cmss-10">glossaries-extra Table 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 §??sec:predefabbrvstyles 4.4 Predefined
Abbreviation Styles for further details.
Old Style Name New Style Name The reason for introducing the new style of abbreviation commands provided by
+ The reason for introducing the new style of abbreviation commands provided by
glossaries-extra is because the original acronym commands provided by glossaries are
@@ -6194,13 +6231,13 @@ class="cmss-10">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
@@ -6210,7 +6247,7 @@ class="cmss-10">type
- In general, there’s rarely any need for
+ In general, there’s rarely any need for \RestoreAcronyms. If you have a document
that uses \newacronymstyle\newabbreviationstyle
+
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 Any of the new abbreviation styles that use \glsxtrfullsep (such as \glsacspace with
- The
+ 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
- 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 The \newignoredglossary{⟨targeturl§??sec:categories 6 You can now provide an ignored glossary with:
- 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 The individual glossary displaying commands \printglossary, \printnoidxglossary\printunsrtglossary 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
prefix={⟨prefix\gls label={⟨} and also defines
class="cmtt-10">\@currentlabelname
+
but take care of duplicate labels if it’s not scoped.
groups. This is a boolean key (new to v1.44) designed for use with
… variations). It has no effect
with \printglossary and \printnoidxglossary.
- If true (default), group formation (group header and group skip) will be
+ If true (default), group formation (group header and group skip) will be
attempted if the group key has been defined and set. Note that some styles
@@ -6424,7 +6461,7 @@ class="cmss-10">group leveloffset. This key (new to v1.44) is designed for use with \printunsrtglossary
@@ -6434,7 +6471,7 @@ class="cmtt-10">… The value may either be a simple integer ⟨ The value may either be a simple integer ⟨n⟩ to indicate assignment or in the
form ++⟨N is
it would be treated by the glossary style as though it was actually a
level 1 entry. (Remember that some styles don’t support hierarchical
glossaries.)
- Note that the group formation (if supported) will still occur between entries
+ Note that the group formation (if supported) will still occur between entries
that don’t have a parent, regardless of the level offset. This can cause odd
results but can be switched off with groups. See Gallery: Inner or Nested
Glossaries for an example.
+
The The glossaries-extra-stylemods package (more conveniently loaded through the
stylemods The The glossaries package tries to determine the group title from its label by first
checking if \glsxtr@grouptitle@⟨label⟩
which shouldn’t clash with another package. You can set the group title
using
-
+
For example:
@@ -6516,21 +6553,22 @@ For example:
This uses a global assignment. If you need to scope the change you can
+ This uses a global assignment. If you need to scope the change you can
use
-
-
+
+
The commands The commands \glossentryname and \glossentrydesc\glossentrydescglossname, glossnamefont, glossnamefont, glossdescglossdescfont§??sec:categories 6 Categories). This means you can make simple font or case-changing
modifications to the name and description without defining a new glossary
style.
- (New to version 1.42.) The command (New to version 1.42.) The command \glossentrysymbol is modified to take into
account the glosssymbolfont. Note that, unlike the above, there’s no corresponding
-attribute to change the case as it’s usually not appropriate to change the case of a
-symbol (and for some symbols, such as pictographs, there’s no concept of case). If
-
+
which is defined to just do \glsentrysymbol{⟨label⟩symbol\glsentrypdfsymbol to use a more appropriate field. (If you do redefine this
command, remember that it needs to fully expand.)
- For example, if you are using For example, if you are using glossaries-accsupp, you could use the symbolaccess
\renewcommand{\glsentrypdfsymbol}[1]{\glsentrysymbolaccess{#1}}
- Alternatively, if you are using Alternatively, if you are using bib2gls you can use the TeX parser library to
@@ -6630,7 +6669,7 @@ options:
replicate-fields={symbol=user1},
interpret-fields={user1}
- This stores the interpreted value of the symbol in the This stores the interpreted value of the symbol in the user1 field, so you can then
do:
@@ -6641,59 +6680,60 @@ do:
(You may need XƎLATEX or LuaLATEX with this method.) This allows
+ (You may need XƎLATEX or LuaLATEX with this method.) This allows
\glossentrysymbol to be used in a section heading with standalone definitions.
- If you want to adapt a style to use another field instead of If you want to adapt a style to use another field instead of name, you can
use
-
+
This behaves just like \glossentryname (that is, it obeys \glossentryname (that is, it obeys the glossname, attribute,
+uses either the glossnamefont or
-\glsnamefont and uses the post-name hook) but it uses the given ⟨field⟩ instead of
- There is a hook after 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 §??sec:autoindex 8 As from version 1.04, the post-name hook As from version 1.04, the post-name hook \glsxtrpostnamehook will also use
\glsxtrpostname⟨
- For convenience, as from v1.31, you can use
- For convenience, as from v1.31, you can use
+
+
This is simply a shortcut for: As from version 1.25, the post-name hook also does
- As from version 1.25, the post-name hook also does
+
+
(before \glsxtrpostname⟨category⟩) to allow for additional non-category related code.
This does nothing by default.
- The post-description code used within the glossary is modified so that it also
+ The post-description code used within the glossary is modified so that it also
does
-
+
This occurs before the original \glspostdescription, so if the nopostdot=false
option is used, it will be inserted before the terminating full stop.
- This new command will do This new command will do \glsxtrpostdesc⟨category⟩ if it exists, where
⟨\glsxtrpostdescacronym for entries with the category set
class="cmss-10">acronym
+
This is simply a shortcut for: Since both 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
+ 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
@@ -6833,10 +6873,10 @@ do:
\renewcommand{\glsxtrpostdescgeneral}{\space
(plural: \glsentryplural{\glscurrententrylabel})}
- This means you don’t have to define a custom glossary style, which you may find
+ This means you don’t have to define a custom glossary style, which you may find
more complicated. (It also allows more flexibility if you decide to change the
underlying glossary style.)
-
-
+
+
The number list is now placed inside the argument of
-
+
This is internally used by \glossaryentrynumbers. The \glossaryentrynumbers so that it doesn’t display th
id="dx1-18004">number list, but it
still saves the number list in case it’s required.
-
- For example, to change the font for the entire
+ For example, to change the font for the entire number list redefine
\GlsXtrFormatLocationList as appropriate. Don’t modify \glossaryentrynumbers.
- Sometimes users like to insert “page” or “pages” in front of the Sometimes users like to insert “page” or “pages” in front of the number list. This
is quite fiddly to do with the base glossaries package, but glossaries-extra provides a
way of doing this. First you need to enable this option and specify the text to display
using:
-
+
where ⟨page⟩ is the text to display if the number list only contains a single location and
@@ -6920,25 +6961,25 @@ class="cmti-10">pages⟩ is the text to display otherwise. For examp
An extra run is required when using this command.
- An extra run is required when using this command.
+
- See the accompanying sample file
+ See the accompanying sample file sample-pages.tex.
- Note that Note that bib2gls can be instructed to insert a prefix at the start of non-empty
location lists, which can be used as an alternative to \GlsXtrEnablePreLocationTag.
- Location lists displayed with \printnoidxglossary internally use
-
+
This command is provided by glossaries, but is modified by glossaries-extra to check
@@ -6958,42 +6999,42 @@ class="cmtt-10">( and ) which are discarded to
obtain the actual control sequence name that forms the location formatting
command.
- If the range identifiers aren’t present, this just uses
- If the range identifiers aren’t present, this just uses
+
+
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
- By default the start range command saves the format in
+
+
and does The end command checks that the format matches the start of the range,
+ The end command checks that the format matches the start of the range,
does
-
+
(which does nothing by default), followed by This means that the list
+ This means that the list
@@ -7037,7 +7078,7 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.
\glsnoidxdisplayloc{}{page}{textbf}{1},
\glsnoidxdisplayloc{}{page}{)textbf}{1}.
- doesn’t display any differently from
+ doesn’t display any differently from
@@ -7047,14 +7088,15 @@ class="cmtt-10">\glsxtrlocrangefmt to empty.
\glsnoidxdisplayloc{}{page}{textbf}{1},
\glsnoidxdisplayloc{}{page}{textbf}{1}.
- but it does make it easier to define your own custom list handler that can
+ but it does make it easier to define your own custom list handler that can
accommodate the ranges.
-
+
As from v1.02, As from v1.02, glossaries-extra now includes the package glossaries-extra-stylemods that
@@ -7071,7 +7113,7 @@ class="cmss-10">glossaries-extra. For example:
\usepackage{glossary-longragged}
\usepackage{glossaries-extra-stylemods}
- Alternatively you can load Alternatively you can load glossary-⟨name⟩.sty at the same time by passing ⟨glossaries-extra-stylemods
- Another option is to use the Another option is to use the stylemods key when you load long3col
\usepackage[style=long3col,stylemods]{glossaries-extra}
- Or the value of Or the value of stylemods may be a comma-separated list of the style package
@@ -7116,7 +7158,7 @@ identifiers. For example:
Remember to group the value if it contains any commas:
+ Remember to group the value if it contains any commas:
@@ -7124,13 +7166,17 @@ identifiers. For example:
- Note that the
+ Inline Style
+ Note that the inline style is dealt with slightly differently. The original definition
+ id="dx1-20001"> The
+ Tabular Styles
+ The tabular-like styles, such as -like styles, such as long are adjusted so that the are adjusted so that the \ifglsnogroupskip
+ id="dx1-21004">
conditional (set with nogroupskip) is moved outside of the definition of
+ id="dx1-21005">) is moved outside of the definition of
\glsgroupskip to avoid problems that cause an “Incomplete \iftrue” error with
@@ -7171,21 +7221,21 @@ class="cmtt-10">\printnoidxglossary. This means that if you want to
change this conditional using \setupglossaries or using the nogroupskip option in
+ id="dx1-21006"> option in
\printglossary, \printnoidxglossary or \printunsrtglossary, you must also
reset the glossary style.
- As from version 1.21, the hard-coded As from version 1.21, the hard-coded \space before the number list in many of
the predefined styles is replaced with
-
+
This just defaults to \space but may be redefined as required. For example:
@@ -7195,85 +7245,130 @@ class="cmtt-10">\space
- The
+ List Styles
+ The list styles use
-
+
(which defaults to \glsxtrprelocation) for top-level items and
-
+
(which defaults to \glslistprelocation) for child items.
- As from v1.31, the description (including the post-description hook) is governed
+ As from v1.31, the description (including the post-description hook) is governed
by:
-
+
for the list and and altlist styles (but not the styles (but not the listdotted variations).
- For just the variations).
+ As from v1.47, the item is governed by:
+
+which internally uses \glslistitem. The header item (for the list styles that should
+the group title) is governed by:
+
+This ignores the ⟨group-label⟩ by default and simply places the second argument in the
+optional argument of \item. The ⟨header code⟩ is the formatted group title,
+possibly including a hypertarget. The spacing after the group item is given
+by:
+
+ For just the list style and its letter group variations (not the style and its letter group variations (not the altlist or or listdotted
+ id="dx1-22015">
variations) the number list for child entries is followed by
-
+
which defaults to a full stop.
- The default value of The default value of \glslistdottedwidth is changed so that it’s set at the start
+ id="dx1-22018"> 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 separator between groups (if not The separator between groups (if not nogroupskip) is now given by:
-
+
This defaults to \indexspace with penalties to deter page breaks. This command
isn’t used if nogroupskip is set.
- The is set.
+ The glossary-tree package introduced new commands in v4.22, package introduced new commands in v4.22, \glstreegroupheaderfmt
+ id="dx1-22023">
and \glstreenavigationfmt, which are used to format the letter group
+ id="dx1-22024">, which are used to format the letter group
headings and the navigation elements for the appropriate styles. These two
new commands are defined in terms of \glstreenamefmt since that was
+ id="dx1-22025"> since that was
the command originally used for the group headings and navigation. This
now allows these different elements to be defined independently, but the
most common redefinition is for \glstreenamefmt has been defined, as from v1.31 glossaries-extra-stylemods
+ id="dx1-22026">
defines:
-
+
which simply does \textbf{⟨text⟩\glstreegroupheaderfmt and \glstreenavigationfmt all in terms of
\glstreedefaultnamefmt.
- This means that if you want to change all three to use a particular style you only
+ This means that if you want to change all three to use a particular style you only
need to redefine \glstreedefaultnamefmt, but if you only want to redefine
\glstreenamefmt without affecting the other two commands, then you now
can.
- The separator between groups without headers is given by:
- The separator between groups without headers is given by:
+
+
This defaults to just \indexspace without penalties. This command isn’t
+ id="dx1-22029"> without penalties. This command isn’t
used if nogroupskip is set. (The penalties introduced in v1.41 were moved to
+ id="dx1-22030"> is set. (The penalties introduced in v1.41 were moved to
\glstreeheadergroupskip in v1.42 as they are inappropriate when there’s no
header.)
- The separator between groups with headers is now given by (as from
+ The separator between groups with headers is now given by (as from
v1.42):
-
-
\glssetcategoryattribute{general}{textformat}{textsf}
-
-
-
-
-
-
\newcommand*{\glsxtrifcustomdiscardperiod}[2]{#2}
-
-
-
-
-
-2.5 Entry Counting Modifications
-
\glsenableentrycount
-2.6 First Use Flag
-
-
-
-
-
\ul{Some text about \mbox{\gls{html}}.}
-
! Package soul Error: Reconstruction failed.
-
-
-
-
-
-2.7 Plurals
-
-
-2.8 Nested Links
-
\gls{\uppercase ssi} enabled \gls{html}
-
\uppercase{\gls{ssi}} enabled \gls{html}
-
This section discusses \gls{ssi}, \gls{html} and \gls{shtml}.
-
-
-
-
-
This article is an introduction to \gls{shtml}.
-
-
-
\setacronymstyle{long-short}
-
\gls{shtml} ... \glsreset{html}\gls{shtml}
-
\newacronym{shtml}{SHTML}{\acrshort{ssi} enabled \acrshort{html}}
-
-
-
-
-
\glsxtrsetpopts{hyper=false}
-
-
\glsxtrsetpopts{noindex}
-
\renewcommand{\glossxtrsetpopts}{\glsxtrsetpopts{noindex=false}}
-
\glsxtrp{short}{ssi}
-
{\glsxtrheadshort{ssi}}
-
-
-2.9 Acronym Style Modifications
-
\setabbreviationstyle[acronym]{long-short}
-
-
-
-
\renewcommand*{\glsxtrfullsep}[1]{\glsacspace{#1}}
-
-
-2.10 Glossaries
-
-
- 2.10.1 Glossary Style Modifications
-2.11 Glossary Style Modifications
+
-
\glsxtrsetgrouptitle{A}{A (a)}
-
-Style Hooks
-2.11.1 Style Hooks
+
-
\renewcommand{\glsentrypdfsymbol}[1]{\glsentryuseri{#1}}
-
-
-
-
-
-
-
-
-Number List
-2.11.2 Number List
+
-
-
\GlsXtrEnablePreLocationTag{Page: }{Pages: }
-
-
-
-
-
-
\glsxtrdisplaysingleloc{⟨}
-
\glsxtrdisplaysingleloc{⟨}
The glossaries-extra-stylemods Package
-2.11.3 The glossaries-extra-stylemods Package
+
\usepackage[style=mcoltree,stylemods=mcols]{glossaries-extra}
-
\usepackage[stylemods={mcols,longbooktabs}]{glossaries-extra}
-
-
\renewcommand{\glsxtrprelocation}{\dotfill}
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-