From b4449269786ca00b3c302d244f99e83d31a6b0d6 Mon Sep 17 00:00:00 2001
From: Karl Berry
glossaries-extra.sty v1.36: an extension to the
+class="cmr-17">glossaries-extra.sty v1.37: an extension to the
glossaries package
2018-08-18
Note that the accsupp option can only be used as a package option (not - through option can only be used as a package option (and can’t + be set with \glossariesextrasetup) since the glossaries-accsupp package must be - loaded before package must + be loaded before glossaries-extra if it’s required.
This option is best used with counter=chapter or counter=section if you + want the title included in the location list. If the indexing counter is the + default page, only the location number is shown. Similarly for + counter=equation (or equations=true). +
The glossaries should be displayed using The glossaries should be displayed using \printglossary (or
\printglossaries). This option is expected to be used with bib2gls’s
+ id="dx1-4115">’s
sort=none setting and so glossaries-extra-bib2gls is not automatically
+ id="dx1-4116"> is not automatically
+
+
+
loaded.
- The document build process is (assuming the file is called The document build process is (assuming the file is called myDoc.tex):
@@ -1467,16 +1538,16 @@ class="cmtt-10">myDoc.tex With the recording on (
+ With the recording on (record=only or or record=alsoindex), any of the commands
+ id="dx1-4118">
makeglossaries myDoc
pdflatex myDoc
-
+
-
By default (with
+
By default (with hyperref), the page numbers in ), the page numbers in number lists link back to the top of the relevant page (provided the format uses \glshypernumber). The indexcounter option is designed to link back to the place within the page where + id="dx1-4151"> option is designed to link back to the place within the page where the indexing occurred. It does this by creating a new counter (called wrglossary) + id="dx1-4152">) that’s incremented with \refstepcounter every time an entry is indexed (but not via cross-referencing commands, such as \label is placed class="cmtt-10">\pageref
. The location, as seen by the indexing application, is the value of the wrglossary counter but this value is substituted with the page + id="dx1-4153"> counter but this value is substituted with the page reference when number list is typeset. Since the counter is used by all + id="dx1-4154">number list is typeset. Since the counter is used by all entries and is incremented every time any indexing occurs, neither makeindex nor xindy can correctly collate the lists. For example, if the first term to be referenced is indexed three times on page 5 without any intervening terms then the actual locations obtained from wrglossary + id="dx1-4157"> will be 1, 2 and 3, which xindy and makeindex will try to form into the range 1–3, but they should actually all simply appear as page 5, whereas it can actually end up with 5–5. Conversely, a range may not be formed where it would naturally occur if just the page counter was + id="dx1-4160"> counter was used. -Since Since bib2gls
See the See the bib2gls documentation for the documentation for the save-index-counter resource option
for more details.
@@ -1648,7 +1788,7 @@ class="cmtt-10">save-index-counter resource option
docdef
Remember that if Remember that if \newglossaryentry wouldn’t be allowed in the
document environment with the base environment with the base glossaries package, then it still
won’t be allowed with docdefs=true. If your glossaries occur at the
+ id="dx1-4182">. If your glossaries occur at the
end of the document, consider using docdef=restricted instead.
+ id="dx1-4183"> instead.
With this option, if an entry appears in the glossary before it has been +
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 + id="dx1-4191"> 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 .gls files). href="#styopt.docdef">docdef=restricted but + id="dx1-4193"> but creates the .glsdefs file for atom’s autocomplete support. This file @@ -1765,22 +1905,22 @@ class="cmss-10">glossaries-extra and so associated problems with the href="#styopt.docdef">docdef=restricted, entries may + id="dx1-4194">, entries may be defined in the preamble or anywhere in the document, but they may only be referenced after they have been defined. Entries must be defined before the associated glossary is displayed. -
The The glossaries package allows \newglossaryentry within the document
+ id="dx1-4195">
environment (when used with makeindex or xindy) but the user manual warns
against this usage. By default the 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
+ id="dx1-4199"> environment, despite all the associated drawbacks, you
can restore this with docdef=true. Note that this doesn’t change the
+ id="dx1-4201">. 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
href="#styopt.docdef">docdef=restricted. Only use . Only use docdef=true if document definitions
+ id="dx1-4203"> if document definitions
are necessary and one or more of the glossaries occurs in the front
matter.
- This option affects commands that internally use This option affects commands that internally use \newglossaryentry, such as
\newabbreviation, but not the “on-the-fly” commands described in On-the-Fly Document Definitions
+
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 hasn’t been loaded or \acronymname if
babel has been loaded. However, if you’re using has been loaded. However, if you’re using babel it’s likely you
+ id="dx1-4210"> it’s likely you
will need to change this. (See §13 Multi-Lingual Support for further
details.)
-
- If the
+ If the abbreviations option is used and the option is used and the acronym option provided by the
+ id="dx1-4213">
- Note that there are no analogous options to the
+ Note that there are no analogous options to the glossaries package’s acronymlists
+ id="dx1-4217">
option (or associated commands) as the abbreviation mechanism is handled
differently with glossaries-extra.
@@ -1933,13 +2073,13 @@ class="cmss-10">glossaries-extra
+
which is equivalent to
+
which is equivalent to Note that multiple invocations of the Note that multiple invocations of the shortcuts option After the After the glossaries-extra package has been loaded, you can set available options
using
-
+
The abbreviations and and docdef options may only be used in the preamble. Additionally,
+ id="dx1-4249"> options may only be used in the preamble. Additionally,
docdef can’t be used after can’t be used after \makenoidxglossaries.
+ id="dx1-4251">.
The The glossaries package provides \nopostdesc which may be used in the descriptionglossaries-extra
+
which has a similar function but only suppresses the post-description punctuation. It
doesn’t suppress the use of \glsxtrpostdescription which allows the use of
@@ -2213,12 +2353,12 @@ class="cmtt-10">\glsxtrpostdescription
+
These commands have no effect outside of the glossary (except with standalone
entries that use \glsxtractivatenopost and §10.3
Standalone Entry Items).
- The The glossaries package provides
-
+
to format items in a cross-reference list (identified with the see key or
- If you want to restore the If you want to restore the glossaries v3.0+ definition just do:
- The commands used by The glossaries-extra package provides \glsxtrhiername and its case-changing
+variants that may be used within the definition of \glsseeitemformat if required.
+These display the hierarchy for sub-entries rather than just the name, which may be
+more helpful in cross-references. See §2.2 Cross-References (“see” and “see also”) for
+further details.
+ The commands used by glossaries to automatically produce an error if an entry is
undefined (such as \glsdoifexists) are changed to take the ) are changed to take the undefaction option into
+ id="dx1-5014"> option into
account.
- The The \newignoredglossary{⟨type⟩} command now (as from v1.11) has a starred
@@ -2304,7 +2456,7 @@ version that doesn’t automatically switch off the hyperlinks. This starred
be used with the targeturl attribute to create a link to an external URL. (See attribute to create a link to an external URL. (See §5
Categories for furt
check that the glossary doesn’t already exist. (The glossaries package omits this
check.)
- You can now provide an ignored glossary with:
- You can now provide an ignored glossary with:
+
+
which will only define the glossary if it doesn’t already exist. This also has a starred
version that doesn’t automatically switch off hyperlinks.
- The individual glossary displaying commands The individual glossary displaying commands \printglossary, , \printnoidxglossary
+ id="dx1-5019">
and \printunsrtglossary have two extra keys:
The The \newglossaryentry command has three new keys: The test file The test file example-glossaries-xr.tex contains dummy entries with a mixture of
see, , alias and and seealso keys for use with minimal working examples. There are also
+ id="dx1-5031"> keys for use with minimal working examples. There are also
example-glossaries-*.bib files that correspond to each example-glossaries-*.tex
file for testing bib2gls.
- The .
+ The \longnewglossaryentry command now has a starred version (as from v1.12)
that doesn’t automatically insert
at the end of the description field.
- at the end of the description field.
+
+
The descriptionplural key is left unset unless explicitly set in ⟨ key is left unset unless explicitly set in ⟨options⟩.
- The unstarred version no longer hard-codes the above code (which removes
+ The unstarred version no longer hard-codes the above code (which removes
trailing space and suppresses the post-description hook) but instead uses:
-
+
This can be redefined to allow the post-description hook to work but retain the
\unskip part if required. For example:
@@ -2460,60 +2612,60 @@ class="cmtt-10">\unskip This will discarded unwanted trailing space at the end of the description but won’t
+ This will discarded unwanted trailing space at the end of the description but won’t
suppress the post-description hook.
- The unstarred version also alters the base The unstarred version also alters the base glossaries package’s treatment of the
+ id="dx1-5037"> package’s treatment of the
descriptionplural key. Since a plural description doesn’t make much sense for
+ id="dx1-5038"> key. Since a plural description doesn’t make much sense for
multi-paragraph descriptions, the default behaviour with glossaries-extra’s
+ id="dx1-5039">’s
\longnewglossaryentry is to simply leave the plural description unset
unless explicitly set using the descriptionplural key. The key. The glossaries.sty version
of this command sets the description’s plural form to the same as the
singular.2.1
- Note that this modified unstarred version doesn’t append
+ Note that this modified unstarred version doesn’t append \glsxtrpostlongdescription
to the description’s plural form.
- The The \newterm command (defined through the command (defined through the index package option) is modified
+ id="dx1-5048"> package option) is modified
so that the category defaults to index. The . The \newacronym command is modified
+ id="dx1-5050"> command is modified
to use the new abbreviation interface provided by glossaries-extra. (See §3
Abbreviations.)
- The The \makeglossaries command now has an optional argument.
-
+
If ⟨list⟩ is empty, \makeglossaries behaves as per its original definition in the
@@ -2521,44 +2673,44 @@ class="cmtt-10">\makeglossaries This command is not permitted with the This command is not permitted with the record=only package option. Without
+ id="dx1-5052"> It should then be possible to use .
+ It should then be possible to use \printglossary for those glossaries listed in ⟨list⟩
and \printnoidxglossary for the other glossaries. (See the accompanying file
sample-mixedsort.tex for an example.)
-
-
+ You will need at least version 2.20 of makeglossaries or at least version 1.3 of
the Lua alternative makeglossaries-lite (both distributed with (both distributed with glossaries v4.27) to
allow for this use of \makeglossaries[⟨list⟩]. Alternatively, use the automake
+ id="dx1-5059">
option.
As from version 1.31, there is a new command like As from version 1.31, there is a new command like \glsadd where the mandatory
argument is a comma-separated list of labels:
-
+
This simply iterates over ⟨list⟩ and does \glsadd[⟨]{⟨label⟩} for each entry in the
list.
- The As from version 1.37, you can make commands like \gls or \glslink
+automatically use \glsadd with specific options when a given format is used
+(identified with format={⟨format⟩} in the optional argument of the corresponding
+\gls, \glslink etc).
+
+The optional argument ⟨label⟩ defaults to \glslabel and indicates the label to use in
+\glsadd and so needs to be expandable. The ⟨format list⟩ is a comma-separated list of
+format values that will trigger the automated adding. The ⟨glsadd options⟩ are
+the options to pass to \glsadd with format={⟨format⟩} prepended to the
+list.
+ For example, with:
+
+
+
+ then \gls[format=hyperbf]{sample} will be equivalent to
+
+
+
+ Note that the explicit range markers will prevent a match unless you include
+them in ⟨format list⟩ (in which case, be sure to add both the start and end
+formats).
+ Here’s another example:
+
+
+
+ In this case \gls[format=hyperbf]{sample} will now be equivalent to:
+
+
+
+
+
+The glossaries-extra package provides extra keys for commands like \gls and
\glstext:
The default value is set up using
- The default value is set up using
+
+
which is defined as:
This sets the conditional
- This sets the conditional
+
+
which is used to determine where to perform the indexing.
- This means you can set the This means you can set the wrgloss attribute to will set will set hyperoutside=false for all entries that are assigned to the category
mathrelation and
@@ -2766,10 +3002,10 @@ class="cmtt-10">mathrelation will use will use \mathrel instead of \glstextformat resulting in: There is a new hook that’s used each time indexing information is written to the
+ There is a new hook that’s used each time indexing information is written to the
external glossary files:
-
+
where ⟨label⟩ is the entry’s label. This does nothing by default but may be redefined.
(See, for example, the accompanying sample file sample-indexhook.tex, which uses
this hook to determine which entries haven’t been indexed.)
- There’s also a new hook (from v1.26) that’s used immediately before the options
+ There’s also a new hook (from v1.26) that’s used immediately before the options
are set by the \gls-like and \glstext-like commands:
-
+
(The base package provides \glslinkpostsetkeys that’s used immediately after the
+ id="dx1-6031"> that’s used immediately after the
options are set.)
- As from version 1.30 there are also similar hooks for As from version 1.30 there are also similar hooks for \glsadd:
-
+
and
-
+
For example, to default to using the equation counter in maths mode:
+ id="dx1-6034"> counter in maths mode:
(This can be overridden with an explicit use of In this case, the counter can be overridden with an explicit use of counter in the optional argument
-of in the
+optional argument of \gls or \glsadd.) Alternatively, to enforce this (overriding the option
-argument):
+class="cmtt-10">\glsadd. (As from version 1.37, a simpler method is to
+just use the equations package option.)
+ Alternatively, to enforce this (overriding the option argument):
- As from version 1.14, there are two new keys for
+ As from version 1.14, there are two new keys for \glsadd: thevalue and and theHvalue.
+ id="dx1-6038">.
These keys are designed for manually adding explicit locations rather than obtaining
the value from the associated counter. As from version 1.19, these two keys are also
available for commands like \gls and \glslink. The thevalue keys is intended
+ id="dx1-6039"> keys is intended
primarily for adding locations in supplementary material that can’t be obtained from
a counter.
- The principle key The principle key thevalue is for the location value. The other key is for the location value. The other key theHvalue can
+ id="dx1-6041"> can
be used to extract a prefix value for the first argument of commands like
\glsnoidxdisplayloc. Its value must be in the format ⟨. Its value must be in the format ⟨prefix⟩⟨location⟩. In general,
there’s little need for this key as the prefix is typically associated with a counter that
can be used to form hypertargets.
-
- For example,
+ For example, makeindex will only accept locations in the form [⟨ will only accept locations in the form [⟨num⟩⟨sep⟩]*⟨num⟩
@@ -2952,38 +3192,38 @@ instances of a number followed by the recognised separator character (set
with \glsSetCompositor). This means that makeindex won’t accept, for
+ id="dx1-6045"> won’t accept, for
example,
This location value will be accepted by This location value will be accepted by bib2gls For example, suppose the file For example, suppose the file suppl.tex contains:
This has an entry on page S.2. Suppose another document wants to include this
+ This has an entry on page S.2. Suppose another document wants to include this
location in the glossary. Then this can be done by setting thevalue to to S.2. For
example:
This location value will be accepted by This location value will be accepted by makeindex as it’s in the form ⟨ as it’s in the form ⟨num⟩⟨sep⟩⟨num⟩.
- If you want hyperlinks, things are more complicated. First you need to set the
+ If you want hyperlinks, things are more complicated. First you need to set the
externallocation attribute to the location of the PDF file. For example:
+ id="dx1-6053"> attribute to the location of the PDF file. For example:
Next you need to add Next you need to add glsxtrsupphypernumber as the format:
Both documents will need to use the Both documents will need to use the hyperref package. Remember that the counter
+ id="dx1-6054"> package. Remember that the counter
used for the location also needs to match. If \theH⟨counter⟩ is defined in the other
document and doesn’t match in the referencing document, then you need to use
theHvalue to set the appropriate value. See the accompanying sample files
+ id="dx1-6055"> 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.
-
- For example, if both
+ For example, if both sample-suppl-hyp.pdf and sample-suppl-main-hyp.pdf
are in the same directory, then viewing sample-suppl-main-hyp.pdf in Evince will
take you to the correct location in the linked document (when you click on the S.2
external link), but Okular will take you to the top of the first page of the linked
document.
- This method can only be used where there is one external source for the
+ This method can only be used where there is one external source for the
designated category (identified by the externallocation attribute). For multiple
+ id="dx1-6057"> attribute). For multiple
sources, you need to use bib2gls version 1.7+, which is the better method in
+ id="dx1-6059"> version 1.7+, which is the better method in
general as it can automatically fetch the relevant locations from the .aux files
of the designated external documents without the need to explicitly use
\glsadd.
-
+
The value of the The value of the see key is now saved as a field. This isn’t the case with glossaries,
@@ -3122,9 +3362,9 @@ class="cmss-10">document This modification allows 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 As a by-product of this enhancement, the see key will now work for entries
defined in the see
value to be stored even though it may not be possible to index it at that
point.
- As from version 1.06, you can display the cross-referenced information for a given
+ As from version 1.06, you can display the cross-referenced information for a given
entry using
-
+
This internally uses
-
+
where ⟨tag⟩ and ⟨xr list⟩ are obtained from the value of the entry’s see field hasn’t been set for the entry given by
⟨label⟩.
- Suppose you want to suppress the number list using As with the base glossaries package, \glsseeformat is defined to do \emph{⟨tag⟩}
+\glsseelist{⟨xr list⟩}. The third argument is always ignored and is present for
+makeindex, which always requires a final argument to encapsulate the associated
+location. The command
+
+used to iterate over the list of cross-reference labels is also unchanged from
+the base glossaries package, with each item in the list formatted according
+to:
+
+This is defined by the glossaries package to:
+ The command:
+
+performs a recursive action:
+ The first step above is skipped if the entry doesn’t have a parent. Each level is separated
+by:
+
+which defaults to “ ⊳ ”. This can be redefined as appropriate.
+ There are some case-changing variants:
+
+The top-level has the first letter changed to upper case (either \Glsaccessshort or
+\Glsaccessname). There’s no case-change for sub-entries.
+
+All levels have the first letter changed to upper case (either \Glsaccessshort or
+\Glsaccessname).
+
+The top-level is converted to upper case (either \GLSaccessshort or \GLSaccessname).
+There’s no case-change for sub-entries.
+
+All levels are converted to upper case (either \GLSaccessshort or \GLSaccessname).
+ Suppose you want to suppress the number list using nonumberlist. This
+ id="dx1-7048">. This
will automatically prevent the cross-references from being displayed. The
seeautonumberlist package option will automatically enable the number list for entries
+ id="dx1-7049"> 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
+ id="dx1-7051"> key set, but this will also show the rest of the number
list.
- Another approach in this situation is to use the post description hook
+
+
+
+ Another approach in this situation is to use the post description hook
with \glsxtrusesee to append the cross-reference after the description. For
example:
@@ -3233,22 +3641,22 @@ example:
Now the cross-references can appear even though the Now the cross-references can appear even though the number list has been
suppressed.
- As from v1.16, there’s a separate You can display the formatted list of cross-references stored in the You can display the formatted list of cross-references stored in the seealso key
+ id="dx1-7057"> key
using:
-
+
This works in much the same way as \glsxtrusesee but it internally uses
-
+
For example:
- The actual unformatted comma-separated list ⟨
+ The actual unformatted comma-separated list ⟨xr-list⟩ stored in the seealso field
+ id="dx1-7060"> field
can be accessed with:
-
+
This will just expand to the ⟨xr-labels⟩ provided in the value of the seealso key. There’s
+ id="dx1-7062"> key. There’s
no corresponding command to access the see field. If you really need to access it, you
+ id="dx1-7063"> field. If you really need to access it, you
can use commands like \glsxtrfielduse, but remember that it may start with
[⟨tag⟩], so it can’t be automatically treated as a simple comma-separated
list.
- The base As mentioned above, the base glossaries package provides \glsseelist, which requires a
-comma-separated list of labels as the argument. The argument isn’t fully expanded,
-so it’s not suitable to use, for example, , which
+requires a comma-separated list of labels as the argument. The argument isn’t fully
+expanded, so it’s not suitable to use, for example, \glsxtrseealsolabels{⟨label⟩} as the
-argument. For convenience, } as
+the argument. For convenience, glossaries-extra provides
-
+
which fully expands its argument and passes it to \glsseelist.
- The The seealso key implements the automatic indexing using
-
+
which just does
+
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
@@ -3400,7 +3808,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 § 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
@@ -3511,62 +3919,62 @@ overridden by the textformat attribute.
- For example:
+ For example:
You can access the label through You can access the label through \glslabel. For example, you can query the
category:
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:
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:
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
@@ -3625,12 +4033,12 @@ 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:
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
@@ -3790,7 +4198,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.
- You can set the default options used by 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, and then use, for example, \gls[noindex=false]{sample} when you actually want
the location added to the \glslink Note that if you don’t want Note that if you don’t want any indexing, just omit \makeglossaries and
wrgloss\glsxtrinitwrgloss
- If you want to change the default value of
+ If you want to change the default value of format, you can instead use:
-
+
This has the advantage of also working for \glsadd. For example, if you
want all locations in the back matter to appear in italic (unless explicitly
@@ -3898,12 +4306,12 @@ overridden):
-
-
-
-
-2. Modifications to Existing Commands and Styles
-
-
-
-
\ifglshasshort{\glslabel}{\glsaccesstext{#1}}{\glsaccessname{#1}}%
}
-
this doesn’t switch
-
-
-
-2.1 Entry Indexing
-
-
+
for specific instances. Note that this opti
doesn’t have an effect if the indexing has been suppressed through other
settings (such as noindex).
-
-
\glsifattribute{\glslabel}{wrgloss}{after}%
{%
@@ -2679,31 +2915,31 @@ class="cmtt-10">\glsxtrinitwrgloss
}%
}
-
-
-
-
-
\ifmmode \setkeys{glslink}{counter=equation}\fi}
\renewcommand{\glsaddpresetkeys}{%
\ifmmode \setkeys{glossadd}{counter=equation}\fi}
\ifmmode \setkeys{glslink}{counter=equation}\fi}
\renewcommand{\glsaddpostsetkeys}{%
\ifmmode \setkeys{glossadd}{counter=equation}\fi}
\usepackage{glossaries-extra}
\newglossaryentry{sample}{name={sample},description={an example}}
@@ -2994,17 +3234,17 @@ class="cmtt-10">suppl.tex contains:
\gls{sample}.
\end{document}
\usepackage{glossaries-extra}
\makeglossaries
@@ -3015,59 +3255,59 @@ example:
\glsadd[thevalue={S.2}]{sample}
\end{document}
\newglossaryentry{sample}{category=supplemental,
name={sample},description={an example}}
2.2 Cross-References (“see” and “see also”)
-
-
-
-
+
+
+
+
+
+
+
+
+
+
\ifglshasfield{see}{\glscurrententrylabel}
{, \glsxtrusesee{\glscurrententrylabel}}%
{}%
}
-
-
\ifglshasfield{see}{\glscurrententrylabel}
{, \glsxtrusesee{\glscurrententrylabel}}%
@@ -3301,27 +3709,27 @@ For example:
{}%
}
-
-
-2.3 Entry Display Style Modifications
-
-
\glsifcategory{\glslabel}{general}{\textsf{#1}}{#1}}
\renewcommand*{\glsxtrregularfont}[1]{%
\glsifattribute{\glslabel}{font}{sf}{\textsf{#1}}{#1}}
-
-
-
-
-
\glsxtrpostlinkAddDescOnFirstUse
}
-
-
\glsxtrpostlinkAddDescOnFirstUse
}
-
-
-
\glsxtrifwasfirstuse{\footnote{\glsentrydesc{\glslabel}}}{}%
}
-
-