From 14ce8b68fe7df49e8a8891bb94c63b9a846da232 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Sun, 29 Sep 2019 03:00:46 +0000 Subject: CTAN sync 201909290300 --- macros/latex/contrib/glossaries/CHANGES | 7 + macros/latex/contrib/glossaries/README | 4 +- .../latex/contrib/glossaries/glossaries-code.pdf | Bin 1195352 -> 1197366 bytes .../latex/contrib/glossaries/glossaries-user.html | 1668 ++++++++++---------- .../latex/contrib/glossaries/glossaries-user.pdf | Bin 893233 -> 891961 bytes .../latex/contrib/glossaries/glossaries-user.tex | 42 +- macros/latex/contrib/glossaries/glossaries.dtx | 1100 +++++++------ macros/latex/contrib/glossaries/glossaries.ins | 2 +- .../latex/contrib/glossaries/glossariesbegin.html | 26 +- .../latex/contrib/glossaries/glossariesbegin.pdf | Bin 186454 -> 186413 bytes .../latex/contrib/glossaries/glossariesbegin.tex | 4 +- .../contrib/glossaries/glossary2glossaries.html | 77 +- .../contrib/glossaries/glossary2glossaries.pdf | Bin 143132 -> 143123 bytes .../contrib/glossaries/glossary2glossaries.tex | 2 +- .../latex/contrib/glossaries/makeglossaries-lite.1 | 2 +- macros/latex/contrib/glossaries/makeglossaries.1 | 2 +- .../samples/glossary-lipsum-examples.pdf | Bin 248669 -> 248676 bytes .../contrib/glossaries/samples/minimalgls.pdf | Bin 49958 -> 49963 bytes .../contrib/glossaries/samples/minimalgls.tex | 82 +- .../contrib/glossaries/samples/mwe-acr-desc.pdf | Bin 37957 -> 37969 bytes .../latex/contrib/glossaries/samples/mwe-acr.pdf | Bin 33649 -> 33661 bytes .../latex/contrib/glossaries/samples/mwe-gls.pdf | Bin 29939 -> 29951 bytes .../contrib/glossaries/samples/sample-FnDesc.pdf | Bin 58817 -> 58822 bytes .../contrib/glossaries/samples/sample-FnDesc.tex | 10 +- .../glossaries/samples/sample-chap-hyperfirst.pdf | Bin 54822 -> 54828 bytes .../glossaries/samples/sample-chap-hyperfirst.tex | 20 +- .../contrib/glossaries/samples/sample-crossref.pdf | Bin 53456 -> 53462 bytes .../contrib/glossaries/samples/sample-crossref.tex | 10 +- .../glossaries/samples/sample-custom-acronym.pdf | Bin 82185 -> 82190 bytes .../glossaries/samples/sample-custom-acronym.tex | 48 +- .../contrib/glossaries/samples/sample-dot-abbr.pdf | Bin 52796 -> 52806 bytes .../contrib/glossaries/samples/sample-dot-abbr.tex | 12 +- .../contrib/glossaries/samples/sample-dual.pdf | Bin 36455 -> 36467 bytes .../contrib/glossaries/samples/sample-dual.tex | 18 +- .../glossaries/samples/sample-entrycount.pdf | Bin 36839 -> 36845 bytes .../glossaries/samples/sample-entrycount.tex | 12 +- .../contrib/glossaries/samples/sample-entryfmt.pdf | Bin 34904 -> 34909 bytes .../contrib/glossaries/samples/sample-entryfmt.tex | 10 +- .../glossaries/samples/sample-font-abbr.pdf | Bin 50703 -> 50715 bytes .../glossaries/samples/sample-font-abbr.tex | 8 +- .../contrib/glossaries/samples/sample-ignored.pdf | Bin 31810 -> 31816 bytes .../contrib/glossaries/samples/sample-ignored.tex | 10 +- .../contrib/glossaries/samples/sample-index.pdf | Bin 43379 -> 43385 bytes .../contrib/glossaries/samples/sample-index.tex | 24 +- .../contrib/glossaries/samples/sample-inline.pdf | Bin 147381 -> 147485 bytes .../contrib/glossaries/samples/sample-inline.tex | 32 +- .../contrib/glossaries/samples/sample-langdict.pdf | Bin 38855 -> 38866 bytes .../contrib/glossaries/samples/sample-langdict.tex | 26 +- .../contrib/glossaries/samples/sample-newkeys.pdf | Bin 39198 -> 39204 bytes .../contrib/glossaries/samples/sample-newkeys.tex | 11 +- .../glossaries/samples/sample-noidxapp-utf8.pdf | Bin 96000 -> 96349 bytes .../glossaries/samples/sample-noidxapp-utf8.tex | 18 +- .../contrib/glossaries/samples/sample-noidxapp.pdf | Bin 67077 -> 67085 bytes .../contrib/glossaries/samples/sample-noidxapp.tex | 17 +- .../glossaries/samples/sample-nomathhyper.pdf | Bin 41745 -> 41752 bytes .../glossaries/samples/sample-nomathhyper.tex | 16 +- .../glossaries/samples/sample-numberlist.pdf | Bin 41979 -> 41985 bytes .../glossaries/samples/sample-numberlist.tex | 12 +- .../contrib/glossaries/samples/sample-prefix.pdf | Bin 43259 -> 43266 bytes .../contrib/glossaries/samples/sample-prefix.tex | 12 +- .../latex/contrib/glossaries/samples/sample-si.pdf | Bin 21710 -> 21722 bytes .../latex/contrib/glossaries/samples/sample-si.tex | 10 +- .../samples/sample-storage-abbr-desc.pdf | Bin 39892 -> 39905 bytes .../samples/sample-storage-abbr-desc.tex | 14 +- .../glossaries/samples/sample-storage-abbr.pdf | Bin 37659 -> 37671 bytes .../glossaries/samples/sample-storage-abbr.tex | 14 +- macros/latex/contrib/glossaries/samples/sample.pdf | Bin 104265 -> 104381 bytes macros/latex/contrib/glossaries/samples/sample.tex | 50 +- .../contrib/glossaries/samples/sample4col.pdf | Bin 43320 -> 43333 bytes .../contrib/glossaries/samples/sample4col.tex | 10 +- .../latex/contrib/glossaries/samples/sampleAcr.pdf | Bin 65506 -> 65512 bytes .../latex/contrib/glossaries/samples/sampleAcr.tex | 14 +- .../contrib/glossaries/samples/sampleAcrDesc.pdf | Bin 65613 -> 65618 bytes .../contrib/glossaries/samples/sampleAcrDesc.tex | 28 +- .../contrib/glossaries/samples/sampleCustomAcr.pdf | Bin 93612 -> 93618 bytes .../contrib/glossaries/samples/sampleCustomAcr.tex | 52 +- .../latex/contrib/glossaries/samples/sampleDB.pdf | Bin 47043 -> 47048 bytes .../latex/contrib/glossaries/samples/sampleDB.tex | 10 +- .../contrib/glossaries/samples/sampleDesc.pdf | Bin 48396 -> 48402 bytes .../contrib/glossaries/samples/sampleDesc.tex | 30 +- .../latex/contrib/glossaries/samples/sampleEq.pdf | Bin 155760 -> 155616 bytes .../latex/contrib/glossaries/samples/sampleEq.tex | 14 +- .../contrib/glossaries/samples/sampleEqPg.pdf | Bin 169225 -> 169073 bytes .../contrib/glossaries/samples/sampleEqPg.tex | 68 +- .../contrib/glossaries/samples/sampleFnAcrDesc.pdf | Bin 91343 -> 91349 bytes .../contrib/glossaries/samples/sampleFnAcrDesc.tex | 31 +- .../latex/contrib/glossaries/samples/sampleNtn.pdf | Bin 99000 -> 99121 bytes .../latex/contrib/glossaries/samples/sampleNtn.tex | 27 +- .../contrib/glossaries/samples/samplePeople.pdf | Bin 47459 -> 47465 bytes .../contrib/glossaries/samples/samplePeople.tex | 16 +- .../latex/contrib/glossaries/samples/sampleSec.pdf | Bin 65669 -> 65674 bytes .../latex/contrib/glossaries/samples/sampleSec.tex | 12 +- .../contrib/glossaries/samples/sampleSort.pdf | Bin 95383 -> 95497 bytes .../contrib/glossaries/samples/sampleSort.tex | 29 +- .../contrib/glossaries/samples/sampleaccsupp.pdf | Bin 41155 -> 41167 bytes .../contrib/glossaries/samples/sampleaccsupp.tex | 11 +- .../contrib/glossaries/samples/sampleacronyms.pdf | Bin 37201 -> 37213 bytes .../contrib/glossaries/samples/sampleacronyms.tex | 18 +- .../contrib/glossaries/samples/sampletree.pdf | Bin 66912 -> 66917 bytes .../contrib/glossaries/samples/sampletree.tex | 14 +- .../contrib/glossaries/samples/sampleutf8.pdf | Bin 44939 -> 44951 bytes .../contrib/glossaries/samples/sampleutf8.tex | 20 +- .../latex/contrib/glossaries/samples/samplexdy.pdf | Bin 133968 -> 134115 bytes .../contrib/glossaries/samples/samplexdy2.pdf | Bin 68399 -> 68406 bytes .../contrib/glossaries/samples/samplexdy2.tex | 40 +- .../contrib/glossaries/samples/samplexdy3.pdf | Bin 178997 -> 179160 bytes 106 files changed, 2014 insertions(+), 1862 deletions(-) (limited to 'macros/latex/contrib/glossaries') diff --git a/macros/latex/contrib/glossaries/CHANGES b/macros/latex/contrib/glossaries/CHANGES index fb9bc0861a..1ddbd44ab6 100644 --- a/macros/latex/contrib/glossaries/CHANGES +++ b/macros/latex/contrib/glossaries/CHANGES @@ -1,5 +1,12 @@ glossaries change log: +v4.43 (2019-09-28): + + * glossaries.sty: + + - added check for LaTeX kernel 2019/10/01 (new kernel affects + accent stripping of UTF-8 characters with \makenoidxglossaries) + v4.42 (2019-01-06): * glossaries.sty: diff --git a/macros/latex/contrib/glossaries/README b/macros/latex/contrib/glossaries/README index 4f0e0ea8e5..57f06c7d5c 100644 --- a/macros/latex/contrib/glossaries/README +++ b/macros/latex/contrib/glossaries/README @@ -1,6 +1,6 @@ -LaTeX Package : glossaries v4.42 +LaTeX Package : glossaries v4.43 -Last Modified : 2019-01-06 +Last Modified : 2019-09-28 Author : Nicola Talbot diff --git a/macros/latex/contrib/glossaries/glossaries-code.pdf b/macros/latex/contrib/glossaries/glossaries-code.pdf index 4401858727..0b01413312 100644 Binary files a/macros/latex/contrib/glossaries/glossaries-code.pdf and b/macros/latex/contrib/glossaries/glossaries-code.pdf differ diff --git a/macros/latex/contrib/glossaries/glossaries-user.html b/macros/latex/contrib/glossaries/glossaries-user.html index df8866e01c..5692dfce9e 100644 --- a/macros/latex/contrib/glossaries/glossaries-user.html +++ b/macros/latex/contrib/glossaries/glossaries-user.html @@ -151,8 +151,9 @@ span.LATEX span.TEX{ position:relative; left: -0.4em; } div.float, div.figure {margin-left: auto; margin-right: auto;} div.float img {text-align:center;} div.figure img {text-align:center;} -.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} -.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +.marginpar,.reversemarginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p,.reversemarginpar p{margin-top:0.4em; margin-bottom:0.4em;} +.reversemarginpar{float:left;} table.equation {width:100%;} .equation td{text-align:center; } td.equation { margin-top:1em; margin-bottom:1em; } @@ -224,6 +225,7 @@ table.gather {width:100%;} div.gather-star {text-align:center;} table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; } div.longtable{text-align:center;} +table.longtable{margin-left:auto; margin-right: auto;} .supertabular {text-align:center} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} @@ -309,7 +311,7 @@ span#textcolor62{color:#00FF00} >

User Manual for glossaries.sty v4.42 +class="cmr-17">User Manual for glossaries.sty v4.43

http://www.dickimaw-books.com/

2019-01-06

+class="cmr-12">2019-09-28

@@ -482,7 +484,7 @@ class="cmtt-10">glossaries-code.pdf
Advanced users wishing to know more about the inner workings of all the packages provided in the glossaries bundle should read “Documented - Code for glossaries v4.42”. + Code for glossaries v4.43”.
INSTALL
o. Depending on the font, the backslash character may appear as a dash when used in the main document text, so \foo will appear as: —foo. -

Earlier versions of

Earlier versions of glossaries used this technique to write information to the files used by the indexing applications to prevent problems caused by fragile commands. Now, this is only used for the

Option 5

Requires

Requires

Requires

Requires

Can N/A

Efficient N/A

Can N/A

Any

Are

Can

Can

Maximum

\glsdisplaynumberlist @@ -1735,7 +1737,7 @@ class="pzdr-">✔

\newglossaryentry @@ -1765,7 +1767,7 @@ class="tcrm-0900">※

Requires

Default makeindex’s quote character using: -



\GlsSetQuote  Command Name Command Name

Translator Key Word

Word

Purpose

\glossaryname

Glossary

Glossary

Title of the @@ -4659,9 +4661,9 @@ class="td10">

Title style="vertical-align:baseline;" id="TBL-3-3-">\acronymname

Acronyms

Acronyms

Title of the @@ -4680,11 +4682,11 @@ class="cmss-10">acronym\entryname

Notation (glossaries)

(glossaries)

Header for first @@ -4706,11 +4708,11 @@ class="td10">

Header style="vertical-align:baseline;" id="TBL-3-5-">\descriptionname

Description (glossaries)

(glossaries)

Header for second @@ -4732,11 +4734,11 @@ class="td10">

Header style="vertical-align:baseline;" id="TBL-3-6-">\symbolname

Symbol (glossaries)

(glossaries)

Header for symbol @@ -4755,13 +4757,13 @@ class="td10">

Header style="vertical-align:baseline;" id="TBL-3-7-">\pagelistname

Page List (glossaries)

(glossaries)

Header for page @@ -4780,11 +4782,11 @@ class="td10">

Header style="vertical-align:baseline;" id="TBL-3-8-">\glssymbolsgroupname

Symbols (glossaries)

(glossaries)

Header for symbols @@ -4803,11 +4805,11 @@ class="td10">

Header style="vertical-align:baseline;" id="TBL-3-9-">\glsnumbersgroupname

Numbers (glossaries)

(glossaries)

Header for numbers @@ -6320,7 +6322,7 @@ information can be gathered by a front-end, editor or script to make the glossar appropriate. This section describes how the information is stored in the auxiliary file.

The file extensions used by each defined glossary are given by -



\@newglossary 

The indexing application’s style file is specified by -



\@istfilename 

Word or letter ordering is specified by: -



\@glsorder  xindy should be used, the language and code page for each glossary is specified by -



\@xdylanguage \@gls@codepage  Top

General Options

nowarn
This suppresses all warnings generated by the glossaries package. Don’t use this option if you’re new to using debug=showtargets will override this option.
nolangwarn
This suppresses the warning generated by a missing language module.
noredefwarn
If you load glossaries with a class or another package that already defines glossary related commands, by default nowarn option described above.
debug
Introduced in version 4.24. The default setting is debug=false. This was a @@ -6558,7 +6560,7 @@ class="cmss-10">nowarndebug=showtargets option will additionally use -



\glsshowtarget  debug
seenoindex
Introduced in version 4.24, this option may take one of three values: error, warn or @@ -6695,9 +6697,9 @@ class="cmtt-10">\makeglossaries to speed up the compilation of a draft do indexing.
nomain
This suppresses the creation of the main glossary and associated .glo file, if unrequired. Note that if you use this option, you must create another glossary in which @@ -6780,9 +6782,9 @@ class="cmtt-10">\gls.
sanitizesort
This is a boolean option that determines whether or not to sanitize the sort @@ -6827,55 +6829,97 @@ class="cmss-10">sanitizesort=false.

esclocations
This is a boolean option. (The default is esclocations=true, but + \makenoidxglossaries changes it to esclocations=false.) Both makeindex and xindy + are fussy about the location formats (makeindex more so than xindy) so the glossaries + package tries to ensure that special characters are escaped and allows for the location to + be substituted for a format that’s more acceptable to the indexing application. This + requires a bit of trickery to circumvent the problem posed by TEX’s asynchronous + output routine, which can go wrong and also adds to the complexity of the document + build. +

If you’re sure that your locations will always expand to an acceptable format (or you’re + prepared to post-process the glossary file before passing it to the relevant indexing + application) then use esclocations=false to avoid the complex escaping of location values. + (See “Writing information to associated files” in the documented code for further + details.) +

+savewrites
This is a boolean option to minimise the number of write registers used by the glossaries package. (Default is savewrites=false.) There are only a limited number of + id="dx1-23050">.) There are only a limited number of write registers, and if you have a large number of glossaries or if you are using a class or other packages that create a lot of external files, you may exceed the maximum number of available registers. If savewrites is set, the glossary information will be stored in token + id="dx1-23051"> is set, the glossary information will be stored in token registers until the end of the document when they will be written to the external files. -

This option can significantly slow document compilation and may cause the indexing to +

This option can significantly slow document compilation and may cause the indexing to fail. Page numbers in the number list will be incorrect on page boundaries due + id="dx1-23052"> will be incorrect on page boundaries due to TEX’s asynchronous output routine. As an alternative, you can use the scrwfile package (part of the KOMA-Script bundle) and not use this option. + id="dx1-23053"> package (part of the KOMA-Script bundle) and not use this option.
-

-

You can also reduce the number of write registers by using Options 

+ + +

You can also reduce the number of write registers by using Options 1 or 4 or by ensuring you define all your glossary entries in the preamble. -

If you want to use T

If you want to use TEX’s \write18 mechanism to call mechanism to call makeindex or or xindy from + id="dx1-23056"> from your document and use savewrites, you must create the external files with + id="dx1-23057">, you must create the external files with \glswritefiles before you call makeindex//xindy. Also set . Also set \glswritefiles to nothing or \relax before the end of the document to avoid rewriting the files. For @@ -6889,105 +6933,105 @@ class="cmtt-10">\relax before the end of the document to avoid rewriting  
-t \jobname.glg -o \jobname.gls \jobname}  
\let\glswritefiles\relax
-

-

+

+

In general, this package option is best avoided.

translate
This can take the following values:
translate=true
If babel has been loaded and the has been loaded and the translator package is installed, + id="dx1-23063"> package is installed, translator will be loaded and the translations will be provided by the will be loaded and the translations will be provided by the translator + id="dx1-23065"> package interface. You can modify the translations by providing your own dictionary. If the translator package isn’t installed and package isn’t installed and babel is loaded, the + id="dx1-23067"> is loaded, the glossaries-babel package will be loaded and the translations will be provided + id="dx1-23068"> package will be loaded and the translations will be provided using babel’s \addto\captionlanguage⟩ mechanism. If polyglossia has been + id="dx1-23069"> has been loaded, glossaries-polyglossia will be loaded. + id="dx1-23070"> will be loaded.
translate=false
Don’t provide translations, even if babel or or polyglossia has been + id="dx1-23073"> has been loaded. (Note that babel provides the command provides the command \glossaryname so that will + id="dx1-23075"> so that will still be translated if you have loaded babel.) + id="dx1-23076">.)
translate=babel
Don’t load the translator package. Instead load package. Instead load glossaries-babel. -

I recommend you use . +

I recommend you use translate=babel if you have any problems with the + id="dx1-23080"> if you have any problems with the translations or with PDF bookmarks, but to maintain backward compatibility, if babel has been loaded the default is has been loaded the default is translate=true.
-

+ id="dx1-23082">.

+

-

If

If translate is specified without a value, is specified without a value, translate=true is assumed. If is assumed. If translate isn’t + id="dx1-23085"> isn’t specified, translate=true is assumed if is assumed if babel, , polyglossia or or translator have been loaded. + id="dx1-23089"> have been loaded. Otherwise translate=false is assumed. -

See is assumed. +

See §1.4.1 Changing the Fixed Names for further details. @@ -6995,23 +7039,23 @@ href="#sec:fixednames">Changing the Fixed Names

The values must be fully expanded, so

The values must be fully expanded, so don’t try nohypertypes=\acronymtype. You + id="dx1-23095">. You may also use -



\GlsDeclareNoHyperList{list}

-

+

instead or additionally. See §6 Links to Glossary Entries for further details.

hyperfirst
This is a boolean option that specifies whether each term has a hyperlink on first use. The default is hyperfirst=true (terms on (terms on first use have a hyperlink, unless explicitly suppressed using starred versions of commands such as \gls* or + id="dx1-23099"> or by identifying the glossary with nohypertypes, described above). Note that + id="dx1-23100">, described above). Note that nohypertypes overrides overrides hyperfirst=true. This option only affects commands that + id="dx1-23102">. This option only affects commands that check the first use flag, such as the \gls-like commands (for example, \gls or + id="dx1-23103"> or \glsdisp), but not the ), but not the \glstext-like commands (for example, \glslink or + id="dx1-23105"> or \glstext). -

The ). +

The hyperfirst setting applies to all glossary types (unless identified by setting applies to all glossary types (unless identified by nohypertypes or + id="dx1-23108"> or defined with \newignoredglossary). It can be overridden on an individual basis by + id="dx1-23109">). It can be overridden on an individual basis by explicitly setting the hyper key when referencing an entry (or by using the plus or + id="dx1-23110"> key when referencing an entry (or by using the plus or starred version of the referencing command). -

It may be that you only want to apply this to just the acronyms (where the first use +

It may be that you only want to apply this to just the acronyms (where the first use explains the meaning of the acronym) but not for ordinary glossary entries (where the first use is identical to subsequent uses). In this case, you can use hyperfirst=false + id="dx1-23111"> and apply \glsunsetall to all the regular (non-acronym) glossaries. For example: @@ -7104,32 +7148,32 @@ class="cmtt-10">\glsunsetall to all the regular (non-acronym) glossaries.  
 % at the end of the preamble  
 \glsunsetall[main]

-

-

Alternatively you can redefine the hook -


+

Alternatively you can redefine the hook +


\glslinkcheckfirsthyperhook  \glslinkcheckfirsthyperhook

-

+

which is used by the commands that check the first use flag, such as \gls. Within the + id="dx1-23113">. Within the definition of this command, you can use \glslabel to reference the entry label and + id="dx1-23114"> to reference the entry label and \glstype to reference the glossary type. You can also use to reference the glossary type. You can also use \ifglsused to determine if + id="dx1-23116"> to determine if the entry has been used. You can test if an entry is an acronym by checking if it has the long key set using key set using \ifglshaslong. For example, to switch off the hyperlink on first use + id="dx1-23118">. For example, to switch off the hyperlink on first use just for acronyms: @@ -7142,14 +7186,14 @@ class="cmtt-10">\ifglshaslong }%  
}

-

-

Note that this hook isn’t used by the commands that don’t check the

+

Note that this hook isn’t used by the commands that don’t check the first use flag, such as \glstext. (You can, instead, redefine . (You can, instead, redefine \glslinkpostsetkeys, which is used by both + id="dx1-23120">, which is used by both the \gls-like and \glstext-like commands.)

indexonlyfirst
This is a boolean option that specifies whether to only add information to the external glossary file on first use. The default is indexonlyfirst=false, which will add a + id="dx1-23122">, which will add a line to the file every time one of the \gls-like or \glstext-like commands are used. Note that \glsadd will always add information to the external glossary + id="dx1-23123"> will always add information to the external glossary file2.1 (since + id="x1-23124f1"> (since that’s the purpose of that command). -

You can customise this by redefining -


You can customise this by redefining +


\glswriteentry  \glswriteentry{label}{wr-code}

-

+

where ⟨label⟩ is the entry’s label and ⟨wr-code⟩ is the code that writes the entry’s @@ -7206,16 +7250,16 @@ class="cmtt-10">\glswriteentry  
  \fi  
}

-

This checks the

This checks the indexonlyfirst package option (using package option (using \ifglsindexonlyfirst) and does ⟨wr-code⟩ if this is false otherwise it only does ⟨wr-code⟩ of the entry hasn’t been used. -

For example, suppose you only want to index the first use for entries in the

For example, suppose you only want to index the first use for entries in the acronym glossary and not in the main (or any other) glossary: @@ -7229,64 +7273,64 @@ class="cmtt-10">main (or any other) glossary:  
 {#2}%  
}

-

Here I’ve used

Here I’ve used \ifthenelse to ensure the arguments of \equal are fully expanded before the comparison is made.

savenumberlist
This is a boolean option that specifies whether or not to gather and store the number list for each entry. The default is for each entry. The default is savenumberlist=false. (See + id="dx1-23129">. (See \glsentrynumberlist and and \glsdisplaynumberlist in in §9 Using Glossary Terms Without Links.) This is always true if you use Option 1.
-

+

-

Top

2.2 Sectioning, Headings and TOC Options

toc
Add the glossaries to the table of contents. Note that an extra LATEX run is required with this option. Alternatively, you can switch this function on and off using -



\glstoctrue  \glstoctrue

-

+

and -



\glstocfalse  \glstocfalse

-

+

numberline
When used with toc, this will add numberline
section
This is a ⟨key⟩=⟨value⟩ option. Its value should be the name of a sectional unit @@ -7323,40 +7367,40 @@ class="cmti-10">value⟩ option. Its value should be the name of a s
\usepackage[section=subsection]{glossaries}
-

You can omit the value if you want to use sections, i.e.  +

You can omit the value if you want to use sections, i.e. 

\usepackage[section]{glossaries}
-

is equivalent to +

is equivalent to

\usepackage[section=section]{glossaries}
-

You can change this value later in the document using -


You can change this value later in the document using +


\setglossarysection  \setglossarysection{name}

-

+

where ⟨name⟩ is the sectional unit. -

The start of each glossary adds information to the page header via -


The start of each glossary adds information to the page header via +


\glsglossarymark  \glsglossarymark{glossary title}

-

+

By default this uses \@mkboth2.22.2 \renewcommand{\glsglossarymark}[1]{\markright{#1}}

-

or to prevent it from changing the headers: +

or to prevent it from changing the headers:

\renewcommand{\glsglossarymark}[1]{}
-

If you want

If you want \glsglossarymark to use \MakeUppercase in the header, use the ucmark option described below. -

Occasionally you may find that another package defines

Occasionally you may find that another package defines \cleardoublepage when it is not required. This may cause an unwanted blank page to appear before each glossary. - This can be fixed by redefining \glsclearpage \glsclearpage:

\renewcommand*{\glsclearpage}{\clearpage}
-

+

ucmark
This is a boolean option (default: ucmark=false, unless \MakeTextUppercase2.3. You can test whether this option has been set or not using -



\ifglsucmark  true part\else false part\fi

-

+

For example: @@ -7439,7 +7483,7 @@ class="cmtt-10">\fi


 
    \markright{#1}%  
  \fi} -

If

If memoir has been loaded and ucfirst\memUChead

numberedsection
The glossaries are placed in unnumbered sectional units by default, but this can be changed using numberedsection\section) and is assigned a label (via \label). The label is formed from -



\glsautoprefix  \glsautoprefix type

-

+

where ⟨type⟩ is the label identifying that glossary. The default value of glossaries using: \usepackage[section,numberedsection=autolabel]  
  {glossaries}

-

then each glossary will appear in a numbered section, and can be referenced using +

then each glossary will appear in a numbered section, and can be referenced using something like: @@ -7512,7 +7556,7 @@ class="cmss-10">glossaries using: The main glossary is in section~\ref{main} and  
the list of acronyms is in section~\ref{acronym}. -

If you can’t decide whether to have the acronyms in the main glossary or a +

If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you can use \acronymtype which is set to acronym The list of acronyms is in section~\ref{\acronymtype}. -

You can redefine the prefix if the default label clashes with another label in your +

You can redefine the prefix if the default label clashes with another label in your document. For example: @@ -7538,7 +7582,7 @@ class="cmss-10">acronym \renewcommand*{\glsautoprefix}{glo:} -

will add

will add glo: to the automatically generated label, so you can then, for example, refer to the list of acronyms as follows: @@ -7548,7 +7592,7 @@ class="cmtt-10">glo: to the automatically generated label, so you can the The list of acronyms is in  
section~\ref{glo:\acronymtype}. -

Or, if you are undecided on a prefix: +

Or, if you are undecided on a prefix:

@@ -7556,7 +7600,7 @@ class="cmtt-10">glo: to the automatically generated label, so you can the The list of acronyms is in  
section~\ref{\glsautoprefix\acronymtype}. -

+

  • namerefnameref\usepackage[numberedsection=nameref]{glossaries} -

    Now

    Now \nameref{main} will display the (TOC) section title associated with the main glossary. As above, you can redefine \glsautoprefix to provide a prefix for the label.

  • -

    +

    -

    Top

    2.3 Glossary Appearance Options

    entrycounter
    This is a boolean option. (Default is entrycounter=false.) If set, each main (level 0) glossary entry will be numbered when using the standard glossary styles. - This option creates the counter glossaryentry glossaryentry. -

    If you use this option, you can reference the entry number within the document +

    If you use this option, you can reference the entry number within the document using -



    \glsrefentry  \glsrefentry{label}

    -

    +

    where ⟨label⟩ is the label associated with that glossary entry. The labelling systems uses ⟨label⟩, where ⟨label⟩ is the entry’s label and ⟨prefix⟩ is given by -



    \GlsEntryCounterLabelPrefix  \GlsEntryCounterLabelPrefix

    -

    +

    (which defaults to glsentry-). -

    If you use

    If you use \glsrefentry, you must run LATEX twice after creating the glossary files using xindy to ensure the cross-references are up-to-date.
    -

    +

    counterwithin
    This is a ⟨key⟩=⟨value⟩ option where ⟨glossaryentry counter will be reset every time ⟨value⟩ is incremented. -

    The

    The glossaryentry counter isn’t automatically reset at the start of each glossary, except when glossary section numbering is on and the counter used by counterwithin -

    -

    If you want the counter reset at the start of each glossary, you can redefine +

    +

    If you want the counter reset at the start of each glossary, you can redefine \glossarypreamble to use -



    \glsresetentrycounter  \glsresetentrycounter

    -

    +

    which sets glossaryentry to zero: @@ -7692,7 +7736,7 @@ class="cmss-10">glossaryentry  \glsresetentrycounter  
    }

    -

    or if you are using

    or if you are using \setglossarypreamble, add it to each glossary preamble, as required. For example: @@ -7709,17 +7753,17 @@ class="cmtt-10">\setglossarypreamble  The preamble text here for the main glossary.  
    }

    -

    +

    subentrycounter
    This is a boolean option. (Default is subentrycounter=false.) If set, each level 1 glossary entry will be numbered when using the standard glossary - styles. This option creates the counter glossarysubentry label⟩ is the label associated with the sub-entry.
    style
    This is a ⟨key⟩=⟨value⟩ option. (Default is glossary-superglossary-tree. Alternatively, you can set the style using -



    \setglossarystyle{style name}

    -

    +

    (See §15 Glossary Styles for further details.)

    nolong
    This prevents the glossaries package from automatically loading glossary-longglossary-long).
    nosuper
    This prevents the glossaries package from automatically loading glossary-superglossary-super
    nolist
    This prevents the glossaries package from automatically loading glossary-liststyle
    notree
    This prevents the glossaries package from automatically loading glossary-treeglossary-tree.
    nostyles
    This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary style package (such as glossary-mcols\printglossary\usepackage{glossary-mcols}  
    \setglossarystyle{mcoltree} -

    -

    -esclocations
    This is a boolean option. (The default is esclocations=true, but - \makenoidxglossaries changes it to esclocations=false.) Both makeindex and xindy - are fussy about the location formats (makeindex more so than xindy) so the glossaries - package tries to ensure that special characters are escaped and allows for the location to - be substituted for a format that’s more acceptable to the indexing application. This - requires a bit of trickery to circumvent the problem posed by TEX’s asynchronous - output routine, which can go wrong and also adds to the complexity of the document - build. -

    If you’re sure that your locations will always expand to an acceptable format (or you’re - prepared to post-process the glossary file before passing it to the relevant indexing - application) then use esclocations=false to avoid the complex escaping of location values. - (See “Writing information to associated files” in the documented code for further - details.) +

    nonumberlist
    This option will suppress the associated number lists in the glossaries (see also + id="dx1-25060">s in the glossaries (see also §5 2 or 3 (makeindex or or xindy) then the + id="dx1-25062">) then the locations must still be valid. This package option merely prevents the number list from + id="dx1-25063"> from being displayed, but both makeindex and and xindy still require a location or + id="dx1-25065"> still require a location or cross-reference for each term that’s indexed. Remember that number list includes any + id="dx1-25066"> includes any cross-references, so suppressing the number list will also hide the cross-references (see + id="dx1-25067"> will also hide the cross-references (see below).
    seeautonumberlist
    If you suppress the number lists with s with nonumberlist, described + id="dx1-25070">, described above, this will also suppress any cross-referencing information supplied by the see key in key in \newglossaryentry or or \glssee. If you use . If you use seeautonumberlist, + id="dx1-25074">, the see key will automatically implement key will automatically implement nonumberlist=false for that entry. + id="dx1-25076"> for that entry. (Note this doesn’t affect \glssee.) For further details see Cross-Referencing Entries.
    counter
    This is a ⟨key⟩=⟨value⟩ option. (Default is counter=page.) The value should be + id="dx1-25078">.) The value should be the name of the default counter to use in the number lists (see s (see §5 Number lists). - -
    nopostdot
    This is a boolean option. If no value is specified, true is assumed. When set to true, this option suppresses the default post description dot used by some of the predefined styles. The default setting is nopostdot=false. + id="dx1-25081">.
    nogroupskip
    This is a boolean option. If no value is specified, true is assumed. When set to true, this option suppresses the default vertical gap between groups used by some of the predefined styles. The default setting is nogroupskip=false. + id="dx1-25083">.
    + +

    Top

    Sorting Options

    sort
    If you use Options 2 or 3, this package option is the only way of specifying how to @@ -8106,7 +8110,7 @@ class="cmss-10">sort=def and sort=use set the sort key to a six digit number via -



    \glssortnumberfmt  2 or 3) or \makenoidxglossaries (Option 1). It - - omits the code used to sanitize or escape the sort value, since it’s not required. This can help to improve the document build speed, especially if there are a large number of entries. This option can’t be used with @@ -8159,7 +8161,7 @@ class="cmss-10">sort=defsort=standard. When the standard sort option is in use, you can hook into the sort mechanism by redefining: -



    \glsprestandardsort  type}{label}

    + +

    where ⟨sort cs⟩ is a temporary control sequence that stores the sort value (which was @@ -8187,7 +8191,7 @@ class="cmtt-10">xindy special characters is performed. By default \glsprestandardsort just does: -



    \glsdosanitizesort  samplePeople.tex.

    ____________________________

    order
    This may take two values: word or \printnoidxglossary

    makeindex
    (Option 2) The glossary information and indexing style file will be written in xindy
    xindy
    (Option 3) The glossary information and indexing style file will be written in glossaries package.

    xindygloss
    (Option 3) This is equivalent to xindy={} (that is, the §11.1 href="#sec:langenc">Language and Encodings.)
    xindynoglsnumbers
    (Option 3) This is equivalent to xindy={glsnumbers=false} and may be used as a document class option.
    automake
    This is option was introduced to version 4.08 as a boolean option. As from version 4.42 it may now take three values: false (default), Top

    Acronym Options

    acronym
    This creates a new glossary with the label acronym. This is equivalent to: @@ -8688,7 +8692,7 @@ class="cmtt-10">acronym. This is equivalent \newglossary[alg]{acronym}{acr}{acn}{\acronymname}

    It will also define -



    \printacronyms  main glossary.)

    acronyms
    This is equivalent to acronym=true and may be used in the document class option list.
    acronymlists
    By default, only the \acronymtype glossary is considered to be a list of acronyms. If you have other lists of acronyms, you can specify them as a @@ -8786,7 +8790,7 @@ class="cmtt-10">main glossary to also contain a list of acronyms,  
      {Statistical Acronyms}

    You can use -



    \DeclareAcronymList  acronymlistslist⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list use: -




    You can determine if a glossary has been identified as being a list of acronyms using: -



    \glsIfListOfAcronyms  }

    shortcuts
    This option provides shortcut commands for acronyms. See §13 Acronyms and Other Abbreviations for further details. Alternatively you can use: -



    \DefineAcronymSynonyms  Acronyms and Other Abbreviations for further details.

    description
    This option changes the definition of \newacronym to allow a description. This @@ -8928,9 +8932,9 @@ class="cmss-10">dua

    smallcaps
    This option changes the definition of \newacronym and the way that acronyms are @@ -8963,9 +8967,9 @@ class="cmss-10">footnote

    smaller
    This option changes the definition of \newacronym and the way that acronyms are @@ -9009,9 +9013,9 @@ class="cmss-10">footnote

    footnote
    This option changes the definition of \newacronym and the way that acronyms are @@ -9073,9 +9077,9 @@ class="cmss-10">description

    dua
    This option changes the definition of \newacronym so that acronyms are always @@ -9105,9 +9109,9 @@ href="#top">Top

    Other available options that don’t fit any of the above categories are:

    symbols
    This option defines a new glossary type with the label symbols via @@ -9116,7 +9120,7 @@ class="cmtt-10">symbols via \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}

    It also defines -



    \printsymbols  \glsxtrnewsymbolglossaries-extra manual for further details.

    numbers
    This option defines a new glossary type with the label numbers via @@ -9172,7 +9176,7 @@ class="cmtt-10">numbers via \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}

    It also defines -



    \printnumbers  \glsxtrnewnumberglossaries-extra manual for further details.

    index
    This option defines a new glossary type with the label index via @@ -9228,7 +9232,7 @@ class="cmtt-10">index via \newglossary[ilg]{index}{ind}{idx}{\indexname}%

    It also defines -



    \newterm  options]
    and -



    \printindex  index
    noglossaryindex
    This option switches off index if index\setupglossaries.
    compatible-2.07
    Compatibility mode for old documents created using version 2.07 or below.
    compatible-3.07
    Compatibility mode for old documents created using version 3.07 or below.
    kernelglossredefs
    As a legacy from the precursor glossary package, the standard glossary @@ -9436,7 +9440,7 @@ href="#top">Top

    Some of the options described above may also be set after the glossaries package has been loaded using -



    \setupglossaries  glossaries-extra manuals.) href="#top">Top

    3.1 Option 1

    The command -



    \makenoidxglossaries  displayed. href="#top">Top

    3.2 Options 2 and 3

    The command -



    \makeglossaries  makeindex style file using -



    \noist  \jobname.xdy (Option 3). This name may be changed using: -



    \setStyleFile  counter package option. The default form of the location number assumes a full stop compositor (e.g. 1.2), but if your location numbers use a different compositor (e.g. 1-2) you need to set this using -



    \glsSetCompositor  \makeglossaries.

    If you use Option 3, you can have a different compositor for page numbers starting with an upper case alphabetical character using: -



    \glsSetAlphaCompositor  §10 Displaying a glossary to find out how to display the glossary.

    New glossary entries are defined using the command: -



    \newglossaryentry  =) with braces to hide them from the key=value list parser. Be careful to ensure that no spurious spaces are included at the start and end of the braces.

    If you have a long description that needs to span multiple paragraphs, use -



    \longnewglossaryentry  \unskip or class="cmtt-10">\nopostdesc.

    There are also commands that will only define the entry if it hasn’t already been defined: -



    \provideglossaryentry  }

    and -



    \longprovideglossaryentry  description
    A brief description of this term (to appear in the glossary). Within this value, you can use -



    \nopostdesc  \nopostdesc

    description={\nopostdesc}. If you want a paragraph break in the description use -



    \glspar  Top

    Plurals

    You may have noticed from above that you can specify the plural form when you define a term. If you omit this, the plural will be obtained by appending -



    \glspluralsuffix  Top

    4.3.1 Document Keys

    A custom key that can be used in the document is defined using: -



    \glsaddkey  sample-newkeys.tex.

    href="#top">Top

    4.3.2 Storage Keys

    A custom key that can be used for simply storing information is defined using: -



    \glsaddstoragekey  sort\glssetnoexpandfield).

    You can switch expansion on or off for individual keys using -




    or -



    \glssetnoexpandfield  shortpl class="cmtt-10">\glssetexpandfield or \glssetnoexpandfield are governed by -



    \glsexpandfields  \glsexpandfields

    and -



    \glsnoexpandfields  Top

    4.6 Loading Entries From a File

    You can store all your glossary entry definitions in another file and use: -



    - +

    Example 7 (Loading Entries from Another File)terms.tex file will be ignored. href="#top">Top

    4.7 Moving Entries to Another Glossary

    As from version 3.02, you can move an entry from one glossary to another using: -



    \glsmoveentry  \c@page class="cmtt-10">\tally{page} expands to \tallynum\c@page) then you need to use: -



    \glsaddprotectedpagefmt  \the\number while it processes the location. If this causes a problem you can disallow it using -



    \glswrallowprimitivemodsfalse  xindy2 and 3), you can replace the separator and the closing number in the range using: -



    \glsSetSuffixF  \glsSetSuffixF{suffix}

    -



    \glsSetSuffixFF  Option 1 doesn’t form ranges. However, with thi number list using: -



    \glsnumberlistloop  Option 1.)

    There is a predefined handler that’s used to display the number list in the glossary: -



    \glsnoidxdisplayloc  Top

    \writeist before the file is closed. You can set the code to be performed then using: -



    \GlsSetWriteIstHook  }

    If you want the ⟨code⟩ to write any information to the file, you need to use -



    \glswrite 

    The way the link text is displayed depends on -



    \glstextformat  tabularx by placing the following command (new to v4.28) in the preamble: -



    \glspatchtabularx  beamer§14 Unsetting and Resetting Entry Flags for more details. -



    \gls  longshort keys.

    There are two upper case variants: -



    \Gls  insert]

    and -



    \GLS  mfirstuc user manual.

    There are plural forms that are analogous to \gls: -



    \glspl  }[insert]

    -



    \Glspl  }[insert]

    -



    \GLSpl 

    -



    \glsdisp  §6.1 The \gls-Like Commands (First Use Flag Queried). -



    \glslink  link text.

    -



    \glstext  link text

    There are also analogous commands: -



    \Glstext  }[insert]

    -



    \GLStext  \glslink. For example: href="#sec:glsnolink">§9 Using Glossary Terms Without Links.) -



    \glsfirst  firstlink text.

    There are also analogous uppercasing commands: -



    \Glsfirst  }[insert]

    -



    \GLSfirst  \gls or \glspl on subsequent use.)

    -



    \glsplural  plurallink text.

    There are also analogous uppercasing commands: -



    \Glsplural  }[insert]

    -



    \GLSplural  }[insert]

    -



    \glsfirstplural  firstplurallink text.

    There are also analogous uppercasing commands: -



    \Glsfirstplural  }[insert]

    -



    \GLSfirstplural  }[insert]

    -



    \glsname  \glstext or class="cmtt-10">\glsfirst instead of \glsname.

    There are also analogous uppercasing commands: -



    \Glsname  }[insert]

    -



    \GLSname  \Acrlong, class="cmtt-10">\Acrshort or \Acrfull.

    -



    \glssymbol  symbollink text.

    There are also analogous uppercasing commands: -



    \Glssymbol  }[insert]

    -



    \GLSsymbol  }[insert]

    -



    \glsdesc  descriptionlink text.

    There are also analogous uppercasing commands: -



    \Glsdesc  }[insert]

    -



    \GLSdesc  ]

    \glslink{sample}{\glsentrytitlecase{sample}{desc}}

    -



    \glsuseri  user1link text.

    There are also analogous uppercasing commands: -



    \Glsuseri  }[insert]

    -



    \GLSuseri  }[insert]

    -



    \glsuserii  user2link text.

    There are also analogous uppercasing commands: -



    \Glsuserii  }[insert]

    -



    \GLSuserii  }[insert]

    -



    \glsuseriii  user3link text.

    There are also analogous uppercasing commands: -



    \Glsuseriii  }[insert]

    -



    \GLSuseriii  }[insert]

    -



    \glsuseriv  user4link text.

    There are also analogous uppercasing commands: -



    \Glsuseriv  }[insert]

    -



    \GLSuseriv  ]

    -



    \glsuserv  user5link text.

    There are also analogous uppercasing commands: -



    \Glsuserv  }[insert]

    -



    \GLSuserv  }[insert]

    -



    \glsuservi  user6link text.

    There are also analogous uppercasing commands: -



    \Glsuservi  }[insert]

    -



    \GLSuservi  \gls-like commands is governed by6.3: -



    \glsentryfmt  \glsentryfmt

    This may be redefined but if you only want the change the display style for a given glossary, then you need to use -



    \defglsentryfmt  definition⟩ argument of \defglsentryfmt, or if you want to redefine \glsentryfmt, you may use the following commands: -



    \glslabel  \glslabel

    This is the label of the entry being referenced. As from version 4.08, you can also access the glossary entry type using: -



    \glstype  \edef so the replacement text is the actual glossary type rather than \glsentrytype{\glslabel}. -



    \glscustomtext  etoolbox\ifdefempty to determine if \glscustomtext is empty.) -



    \glsinsert  \gls, \glspl and their upper case variants. -



    \glsifplural  true text⟩ otherwise it does ⟨false text⟩. -



    \glscapscase  first uc⟩. If \GLS or \GLSpl were used, this does ⟨all caps⟩. -



    \glsifhyperon  \glsifhyper is now deprecated. If you want to know if the command used to reference this entry was used with the star or plus variant, you can use: -



    \glslinkvar  \glslabel.

    If you only want to make minor modifications to \glsentryfmt, you can use -



    \glsgenentryfmt  \newacronym) you can use: -



    \glsgenacfmt  firstfirstplural keys. The first use singular text is obtained via: -



    \genacrfullformat  }

    instead of from the first key, and the first use plural text is obtained via: -



    \genplacrfullformat  \firstacronymfont. There are also first letter upper case versions: -



    \Genacrfullformat  insert}

    and -



    \Genplacrfullformat  \gls-like and \glstext-like commands use -



    \glslinkpostsetkeys  options⟩ are set. This macro does nothing by default but can be redefined. (For example, to switch off the hyperlink under certain conditions.) This version also introduces -



    \glspostlinkhook  nohypertypes package option).

    You can disable or enable links using: -



    \glsdisablehyper  \glsdisablehyper

    and -



    \glsenablehyper  Top

    7. Adding an Entry to the Glossary Without Generating Text

    It is possible to add a line to the glossary file without generating any text at that point in the document using: -



    \glsadd  set:

    To add all entries that have been defined, use: -



    \glsaddall  5.)

    There is now a variation of \glsaddall that skips any entries that have already been used: -



    \glsaddallunused  \newterm
  • After you have defined the entry, use -



    \glssee  see key or the command \glssee, the cross-referencing information will be typeset in the glossary according to: -



    \glsseeformat  8.2

    The list of labels is dealt with by \glsseelist, which iterates through the list and typesets each entry in the label. The entries are separated by -



    \glsseesep  \glsseesep

    or (for the last pair) -



    \glsseelastsep  \space\andname\space” respectively. The list entry text is displayed using: -



    \glsseeitemformat 

    If you want to title case a field, you can use: -



    \glsentrytitlecase  §6.1 The \gls-Like Commands (First Use Flag Queried)). -



    \glsentryname  \glsentryname{label}

    -



    \Glsentryname  \Glsentrylong, \Glsentryshort or \Glsentryfull.

    -



    \glossentryname 

    -



    \Glossentryname  }

    This is like \glossentryname but makes the first letter of the name upper case. -



    \glsentrytext  \glsentrytext{label}

    -



    \Glsentrytext  \Glsentrytext makes the first letter upper case. The firs expandable (unless the text contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryplural  \glsentryplural{label}

    -



    \Glsentryplural  label⟩. -



    \glsentryfirst  \glsentryfirst{label}

    -



    \Glsentryfirst  label⟩. -



    \glsentryfirstplural  \glsentryfirstplural{label}

    -



    \Glsentryfirstplural  label⟩. -



    \glsentrydesc  \glsentrydesc{label}

    -



    \Glsentrydesc  label⟩. -



    \glossentrydesc  } but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in the predefined glossary styles to display the description. -



    \Glossentrydesc  }

    This is like \glossentrydesc but converts the first letter to upper case. This command is not expandable. -



    \glsentrydescplural  \glsentrydescplural{label}

    -



    \Glsentrydescplural  \Glsentrydescplural makes the first letter upper case. Th the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentrysymbol  \glsentrysymbol{label}

    -



    \Glsentrysymbol  label⟩. -



    \glsletentryfield  \tmp: \glsletentryfield{\tmp}{apple}{desc}

    -



    \glossentrysymbol  } but also checks for the existence of ⟨label⟩. This command is not expandable. It’s used in some of the predefined glossary styles to display the symbol. -



    \Glossentrysymbol  }

    This is like \glossentrysymbol but converts the first letter to upper case. This command is not expandable. -



    \glsentrysymbolplural  \glsentrysymbolplural{label}

    -



    \Glsentrysymbolplural  \Glsentrysymbolplural makes the first letter upper case. (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨label⟩. -



    \glsentryuseri  \glsentryuseri{label}

    -



    \Glsentryuseri  \Glsentryuseri{label}

    -



    \glsentryuserii  \glsentryuserii{label}

    -



    \Glsentryuserii  \Glsentryuserii{label}

    -



    \glsentryuseriii  \glsentryuseriii{label}

    -



    \Glsentryuseriii  \Glsentryuseriii{label}

    -



    \glsentryuseriv  \glsentryuseriv{label}

    -



    \Glsentryuseriv  }

    -



    \glsentryuserv  \glsentryuserv{label}

    -



    \Glsentryuserv  \Glsentryuserv{label}

    -



    \glsentryuservi  \glsentryuservi{label}

    -



    \Glsentryuservi  label⟩. -



    \glshyperlink  Option 1 or with the savenumberlist package option: -



    \glsentrynumberlist  \glsentrynumberlist{label}

    -



    \glsdisplaynumberlist  \glsentrynumberlist, simply displays the number list as is. The second command, \glsdisplaynumberlist, formats the list using: -



    \glsnumlistsep  \glsnumlistsep

    as the separator between all but the last two elements and -



    \glsnumlistlastsep  Option 1:
    -



    \printnoidxglossaries  3:
    -



    \printglossaries  Option 1:
    -



    \printnoidxglossary  3:
    -



    \printglossary  numberedsection package option. Each glossary sets the page header via the command -



    \glsglossarymark  §2.2 Sectioning, Headings and TOC Options.

    Information can be added to the start of the glossary (after the title and before the main body of the glossary) by redefining -



    \glossarypreamble 

    This needs to be done before the glossary is displayed.

    If you want a different preamble per glossary you can use -



    \setglossarypreamble  \glsdefaulttype is used. for any other glossaries.

    There is an analogous command to \glossarypreamble called -



    \glossarypostamble 

    ____________________________

    Within each glossary, each entry name is formatted according to -



    \glsnamefont  xindy style file, the glossaries package provides the following commands: -



    \glsopenbrace  \glsopenbrace

    -



    \glsclosebrace  \{ and \} don’t expand to a simple brace character when written to a file.) Similarly, you can write a percent character using: -



    \glspercentchar  \glspercentchar

    and a tilde character using: -



    \glstildechar  ~n so you can use class="cmtt-10">\glstildechar n to write this correctly (or you can do \string~n). A backslash can be written to a file using -



    \glsbackslash  \glsbackslash

    ngerman) you can use: -



    \glsquote  xindy doesn’t support that language, then you can specify the required language using: -



    \GlsSetXdyLanguage  inputenc\inputencodingname. Alternatively, you can specify the encoding using: -



    \GlsSetXdyCodePage  before \makeglossaries using: -



    \GlsAddXdyCounters  xindy style file, but if you want to use another attribute, you need to add it using: -



    \GlsAddXdyAttribute  \GlsAddXdyAttribute.

    If the location numbers include formatting commands, then you need to add a location style in the appropriate format using -



    \GlsAddXdyLocation  11.3 This ordering can be changed using: -



    \GlsSetXdyLocationClassOrder  number list consists of a sequence of consecutive numbers, the range will be concatenated. The number of consecutive locations that causes a range formation defaults to 2, but can be changed using: -



    \GlsSetXdyMinRangeLength  numeric-sort module: class="cmtt-10">glsnumbers=false, the default behaviour is to locate the number group before the “A” letter group. If you are not using a Roman alphabet, you need to change this using: -



    \GlsSetXdyFirstLetterAfterDigits  fontspec.) The starred form will sanitize the argument to prevent expansion. Alternatively you can use: -



    \GlsSetXdyNumberGroupOrder  \makeglossariesTop

    12. Defining New Glossaries

    A new glossary can be defined using: -



    \newglossary  EX).

    There is also a starred version (new to v4.08): -



    \newglossary*  counter]
    or you can also use: -



    \altnewglossary  \printglossaries. To define an ignored glossary, use -



    \newignoredglossary  sample-entryfmt.tex defines an ignored glossary.)

    You can test if a glossary is an ignored one using: -



    \ifignoredglossary  acronym. If you are not sure whether the acronym option has been used, you can identify the list of acronyms by the command -\acronymtype first used in the document. This provides a useful means to define abbreviations. For convenience, the glossaries package defines the command: -



    \newacronym  link text\glstextformat. -



    \acrshort  \newacronym implicitly sets.

    There are also analogous upper case variants: -



    \Acrshort  }[insert]

    -



    \ACRshort  insert]

    There are also plural versions: -



    \acrshortpl  }[insert]

    -



    \Acrshortpl  }[insert]

    -



    \ACRshortpl  shortplural\newacronym implicitly sets. -



    \acrlong  long\newacronym implicitly sets.

    There are also analogous upper case variants: -



    \Acrlong  }[insert]

    -



    \ACRlong  insert]

    Again there are also plural versions: -



    \acrlongpl  }[insert]

    -



    \Acrlongpl  }[insert]

    -



    \ACRlongpl  link text from the complete full form. These full-form commands have star and plus variants and optional arguments that are passed to the above commands. -



    \acrfull  insert]

    This is a shortcut for -



    \acrfullfmt  }}
    where -



    \acrfullformat  ) hasn’t been documented code, glossaries-code.pdf.)

    There are also analogous upper case variants: -



    \Acrfull  ]

    -



    \ACRfull  insert]

    and plural versions: -



    \acrfullpl  }[insert]

    -



    \Acrfullpl  }[insert]

    -



    \ACRfullpl  §9 href="#sec:glsnolink">Using Glossary Terms Without Links.

    The long form can be accessed using: -



    \glsentrylong  label}

    or, with the first letter converted to upper case: -



    \Glsentrylong  label}

    Plural forms: -



    \glsentrylongpl  \glsentrylongpl{label}

    -



    \Glsentrylongpl  label}

    Similarly, to access the short form: -



    \glsentryshort  label}

    or, with the first letter converted to upper case: -



    \Glsentryshort  label}

    Plural forms: -



    \glsentryshortpl  \glsentryshortpl{label}

    -



    \Glsentryshortpl  label}

    And the full form can be obtained using: -



    \glsentryfull  \glsentryfull{label}

    -



    \Glsentryfull  \Glsentryfull{label}

    -



    \glsentryfullpl  }

    -



    \Glsentryfullpl  Top

    Changing the Abbreviation Style

    It may be that the default style doesn’t suit your requirements in which case you can switch to another style using -



    \setacronymstyle  \genacrfullformat\setacronymstyle the name key is set to -



    \acronymentry  }

    and the sort key is set to -



    \acronymsort  Top

    Predefined Acronym Styles

    The glossaries package provides a number of predefined styles. These styles apply -



    \firstacronymfont  text}

    to the short form on first use and -



    \acronymfont  description

    The long-sp-short style was introduced in version 4.16 and uses -



    \glsacspace  Top

    glossaries package don’t suit your requirements. In this case you can define your own style using: -



    \newacronymstyle  definitions⟩.

    Within \newacronymstyle’s ⟨definitions⟩ argument you can also redefine -



    \GenericAcronymFields  \GenericAcronymFields

    This is a list of additional fields to be set in \newacronym. You can use the following token -registers to access the entry label, long form and short form: \glslabeltok \glslabeltok, -\glslongtok \glslongtok and \glslongtok and \glsshorttok 

    It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨display⟩ you can use -



    \GlsUseAcrEntryDispStyle  display⟩ definition from the style given by ɾ class="cmti-10">style name⟩. Within ⟨definitions⟩ you can use -



    \GlsUseAcrStyleDefs  definitions⟩):  
      \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  
    }
    -

    (

    (\glstextup 13.1 provides the command: -



    \oldacronym  text key, even though you haven’t used the glossary entry. The former can be achieved by one of the following commands: -



    \glsreset  \glsreset{label}

    -



    \glslocalreset  label}

    while the latter can be achieved by one of the following commands: -



    \glsunset  \glsunset{label}

    -



    \glslocalunset  label}

    You can also reset or unset all entries for a given glossary or list of glossaries using: -



    \glsresetall  \glsresetall[glossary list]

    -



    \glslocalresetall  \glslocalresetall[glossary list]

    -



    \glsunsetall  \glsunsetall[glossary list]

    -



    \glslocalunsetall 

    You can determine whether an entry’s first use flag is set using: -



    \ifglsused  \newacronym

    To enable this function, use -



    \glsenableentrycount  document

    You can access these fields using -




    for the currcount field, and -



    \glsentryprevcount 

    When you enable the entry count using \glsenableentrycount, you also enable the following commands: -



    \cgls  insert]

    (no case-change, singular) -



    \cglspl  insert]

    (no case-change, plural) -



    \cGls  insert]

    (first letter uppercase, singular), and -



    \cGlspl  \cgls, \cglspl, \cGls or \cGlspl. -



    \cglsformat  }insert
    otherwise. -



    \cglsplformat  }insert
    otherwise. -



    \cGlsformat  }insert
    otherwise. -



    \cGlsplformat  \printglossary2 and 3) or using the command: -



    \setglossarystyle 

    The tabular-like styles that allow multi-line descriptions and page lists use the length -\glsdescwidth \glsdescwidth to set the width of the description column and the -length \glspagelistwidth \glsgroupskip. class="cmss-10">listdotted style use the command -



    \glspostdescription  listgroupEX to ensure the group information is up to date. In the navigation line, each group is separated by -



    \glshypernavsep  \item instead of after it to prevent a spurious space at the start. This can cause a problem if the navigation line is too long. As from v4.22, if you need to adjust this, you can redefine -



    \glslistnavigationitem  \item[], followed by the name followed by a href="#glo:numberlist">number list and the symbol. The length -



    \glslistdottedwidth  longtable behaviour with: -



    \glsrestoreLToutput  nostyles package options.

    These styles all format the entry name using: -



    \glstreenamefmt  \glstreenamefont may be counteracted by another font chan class="cmtt-10">\glsnamefont (or in \acronymfont). The tree-like styles that also display the header use -



    \glstreegroupheaderfmt  indexhypergroup), format the navigation line using -



    \glstreenavigationfmt  \item. class="cmss-10">alttree style (and those derived from it), the space before the description for top-level entries is produced with -



    \glstreepredesc  treenonamealttree styles (and those derived from them), the space before the description for child entries is produced with -



    \glstreechildpredesc  index\indexspace.

    Each main level item is started with -



    \glstreeitem  \glstreeitem

    The level 1 entries are started with -



    \glstreesubitem  \glstreesubitem

    The level 2 entries are started with -



    \glstreesubsubitem  makeindexxindy if you want - more than three levels.) Each sub-level is indented by \glstreeindent alttreetree style except that the indentation for each level is determined by the width of the text specified by -



    \glssetwidest  level⟩ is omitted, 0 is

    As from v4.22, the glossary-tree package also provides -



    \glsfindwidesttoplevelname  glossary-mcols

    The name is placed inside a left-aligned \makebox. As from v4.19, this can now be adjusted by redefining -



    \glstreenamebox  \setglossarystyle.

    The default number of columns is 2, but can be changed by redefining -



    \glsmcols  \setglossarystyle

    The inline style is governed by the following: -



    \glsinlineseparator  \glsinlineseparator

    This defaults to “; ” and is used between main (i.e. level 0) entries. -



    \glsinlinesubseparator  \glsinlinesubseparator

    This defaults to “, ” and is used between sub-entries. -



    \glsinlineparentchildseparator  \glsinlineparentchildseparator

    This defaults to “: ” and is used between a parent main entry and its first sub-entry. -



    \glspostinline  \glspostinline

    This defaults to “; ” and is used at the end of the glossary. -



    \glsinlinenameformat 

    Sub-entry names are formatted according to -



    \glsinlinesubnameformat  {} so the sub-entry name is ignored.

    If the description has been suppressed (according to \ifglsdescsuppressed) then -



    \glsinlineemptydescformat  }

    (which defaults to nothing) is used, otherwise the description is formatted according to -



    \glsinlinedescformat 

    The sub-entry description is formatted according to: -



    \glsinlinesubdescformat  Top

    Defining your own glossary style

    If the predefined styles don’t fit your requirements, you can define your own style using: -



    \newglossarystyle  name⟩ is the name of the new glossary style (to be class="cmtt-10">\setglossarystyle). The second argument ⟨definitions⟩ needs to redefine all of the following: -



    theglossary description environment. -



    \glossaryheader  longheader glossary style redefines \glossaryheader to do a header row. -



    \glsgroupheading  \glsgroupheading is a label not the group title. The group title can be obtained via -



    \glsgetgrouptitle  label⟩. You can redefine \glsgetgrouptitle if this is unsuitable for your document.

    A navigation hypertarget can be created using -



    \glsnavhypertarget  }

    This typically requires \glossaryheader to be redefined to use -



    \glsnavigation  \newglossarystyle##1 instead of #1 etc.) -



    \glsgroupskip  nogroupskip can be used to suppress this default gap for the predefined styles. -



    \glossentry  §9 Using Glossary Terms Without Links for further details.) You can also use the following commands: -



    \glsentryitem  \glossentry before \glstarget. The format of the counter is controlled by the macro -



    \glsentrycounterlabel  \glsentrycounterlabel

    relevant line in the glossary. Your new glossary style must therefore redefine \glossentry to set the appropriate target. This is done using -



    \glstarget  nonumberlist package option. -



    \subglossentry  \glossentry described above. -



    \glssubentryitem  \subglossentry before \glstarget. The format of the counter is controlled by the macro -



    \glssubentrycounterlabel  \printglossary (which \printglossaries calls) sets -



    \currentglossary 

    For further details of these commands, see “Displaying the glossary” in the documented code (glossaries-code.pdf). - +

    Example 27 (Creating a completely new style)§2.7.2 of “LEX for Administrative Work”.)

    -



    \forallglossaries  body⟩ is performed. If ⟨glossary list⟩ is omitted, the default is to iterate over all glossaries (except the ignored ones). -



    \forallacronyms  acronymlists\forallglossaries. -



    \forglsentries  glossary label⟩ is omitted, \glsdefaulttype (usually the main glossary) is used. -



    \forallglsentries  body⟩.)

    Top

    16.2 Conditionals

    -



    \ifglossaryexists  label⟩ exists. If it does ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglsentryexists  §4.8.1 Technical Issues for further details.) -



    \glsdoifexists  code⟩ if the entry given by ⟨label⟩ exists. If it doesn’t exist, an error is generated. (This command uses \ifglsentryexists.) -



    \glsdoifnoexists  }

    Does the reverse of \glsdoifexists. (This command uses \ifglsentryexists.) -



    \glsdoifexistsorwarn  }

    As \glsdoifexists but issues a warning rather than an error if the entry doesn’t exist. -



    \glsdoifexistsordo  label⟩ exists otherwise generate an error and do & class="cmti-10">else code⟩. -



    \glsdoifnoexistsordo  label⟩ doesn’t exist otherwise generate an e class="cmti-10">else code⟩. -



    \ifglsused  §14 Unsetting and Resetting Entry Flags. -



    \ifglshaschildren  label⟩ has any sub-entries. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshasparent  label⟩ has a parent entry. If it does, ⟨true part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshassymbol  symboltrue part⟩ is performed, otherwise ⟨false part⟩. -



    \ifglshaslong  false part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -



    \ifglshasshort  false part⟩. This should be true for any entry tha class="cmtt-10">\newacronym. There is no check for the existence of ⟨label⟩. -



    \ifglshasdesc  label⟩. If it has, ⟨true part⟩ is performed, otherwise ⟨false part⟩. Compare with: -



    \ifglsdescsuppressed  false part⟩. There is no check for the existence of ⟨label⟩.

    For all other fields you can use: -



    \ifglshasfield  \ifglshasshort, an error occurs if the entry is undefined.

    As from version 4.23, within ⟨true part⟩ you can use -



    \glscurrentfieldvalue  user1sample.

    You can test if the value of the field is equal to a given string using: -



    \ifglsfieldeq  \foo” with “\foo”).

    You can test if the value of a field is equal to the replacement text of a command using: -



    \ifglsfielddefeq  \foo” is equal to class="cmtt-10">\foo”.

    There is a similar command that requires the control sequence name (without the leading backslash) instead of the actual control sequence: -



    \ifglsfieldcseq  \ifdefstrequal. href="#top">Top

    16.3 Fetching and Updating the Value of a Field

    You can fetch the value of a given field and store it in a control sequence using: -



    \glsfieldfetch  label⟩ and ⟨field⟩ are as above and ⟨definition⟩ is the new value of the field. -



    \glsfielddef  }

    This uses \def to change the value of the field (so it will be localised by any grouping). -



    \glsfieldedef  \edef to change the value of the field (so it will be localised by any grouping). Any fragile commands contained in the ⟨definition⟩ must be protected. -



    \glsfieldgdef  \gdef to change the value of the field. -



    \glsfieldxdef  §6 Links to Glossary Entries for further details.) -



    \pgls  label}[insert]. -



    \Pgls  } class="cmtt-10">[⟨insert]. -



    \PGLS  \pgls but converts the prefix to upper case and uses \GLS instead of \gls. -



    \pglspl  label}[insert]. -



    \Pglspl  } class="cmtt-10">[⟨insert]. -



    \PGLSpl  sample-prefix.tex.

    ____________________________

    This package also provides the commands described below, none of which perform any check to determine the entry’s existence. -



    \ifglshasprefix  prefix key.

    This package also provides the following commands: -



    \ifglshasprefixplural  label⟩ has a non-empty value for the prefixplural key. -



    \ifglshasprefixfirst  label⟩ has a non-empty value for the prefixfirst key. -



    \ifglshasprefixfirstplural  label⟩ has a non-empty value for the prefixfirstplural key. -



    \glsentryprefix  prefix key for the entry given by ⟨label⟩. -



    \glsentryprefixfirst  prefixfirstlabel⟩. -



    \glsentryprefixplural  prefixplural key for the entry given by ⟨label⟩. (No check is performed to determine if the entry exists.) -



    \glsentryprefixfirstplural  17.2: -



    \Glsentryprefix  \Glsentryprefix{label}

    -



    \Glsentryprefixfirst  \Glsentryprefixfirst{label}

    -



    \Glsentryprefixplural  \Glsentryprefixplural{label}

    -



    \Glsentryprefixfirstplural  103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 273, 274
    glossaries-babel package  275, 276
    +href="glossaries-user.html#dx1-23068" >275, 276
    glossaries-extra package  277, glossaries-extra-stylemods package  302
    glossaries-polyglossia package  303
    +href="glossaries-user.html#dx1-23070" >303
    glossaries-prefix package  304, 770, 771
        hyper  772, 772, 773, 774, 775, local  779
    \glslinkcheckfirsthyperhook  780
    \glslinkpostsetkeys  896
    \glswriteentry  897

    H @@ -29138,13 +29142,13 @@ href="glossaries-user.html#dx1-20021" >1199, 1200, 1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1203, 1204, 1205, 1206, 1207, 1208, 1209, 1210, 1211, 1212, format  1347
        long  1348, 1348, 1349, 1350, 1351, see  1456, 1457, 1458, 1459, 1460, 1459, 1460, 1461, 1462, 1463, 1633, 1634, 1635, 1636, 1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1637, 1638, 1639, 1640, 1641, 1642, 1643, 1644, 1645, 1646, 1647, 1744, 1745
        counter  1746, 1746, 1747, 1748, 1749, 1750
            page  1751
    +href="glossaries-user.html#dx1-25078" >1751
        counterwithin  1752, true  1784
        esclocations  1785
    +href="glossaries-user.html#dx1-23040" >1785
            false  1786, 1787, 1786, 1787, 1788
            true  1789
    +href="glossaries-user.html#dx1-23041" >1789
        footnote  1790, 1794, 1795
        hyperfirst  1796, 1797, 1796, 1797, 1798, 1799
            false  1800, 1800, 1801, 1802, 1803, 1804
            true  1805, 1806
    +href="glossaries-user.html#dx1-23098" >1805, 1806
        index  1807, 1812, 1813
        indexonlyfirst  1814, 1815, 1814, 1815, 1816
            false  1817
    +href="glossaries-user.html#dx1-23122" >1817
        kernelglossredefs  1818
    @@ -29996,7 +30000,7 @@ href="glossaries-user.html#dx1-29029" >1824
        nogroupskip  1825, 1826, 1826, 1827, 1828, 1829, 1831, 1832
            false  1833
    +href="glossaries-user.html#dx1-25083" >1833
        nohypertypes  1834, 1835, 1836, 1837, 1834, 1835, 1836, 1837, 1838, 1839, 1840, 1861
        nonumberlist  1862, 1863, 1864, 1863, 1864, 1865, 1866, 1867, 1870, 1871
        nopostdot  1872, 1872, 1873
            false  1874
    +href="glossaries-user.html#dx1-25081" >1874
        1886
        notranslate  1887, 1888, 1888, 1889
        notree  1940, 1941
        savenumberlist  1942, 1942, 1943
            false  1944
    +href="glossaries-user.html#dx1-23129" >1944
        savewrites  1945, 1946, 1947
    +href="glossaries-user.html#dx1-23049" >1945, 1946, 1947
            false  1948
    +href="glossaries-user.html#dx1-23050" >1948
        section  1949, 1950
        seeautonumberlist  1951, 1952, 1951, 1952, 1953, 1954
        2026, 2027
        translate  2028, 2029, 2030, 2028, 2029, 2030, 2031
            babel  2032, 2033, 2034, 2035, 2036, 2037
    +href="glossaries-user.html#dx1-23077" >2036, 2037
            false  2038, 2039, 2040, 2041
    +href="glossaries-user.html#dx1-23071" >2039, 2040, 2041
            true  2042, 2043, 2044, 2045
    +href="glossaries-user.html#dx1-23061" >2042, 2043, 2044, 2045
        ucfirst  2046
    @@ -30416,9 +30420,9 @@ href="glossaries-user.html#dx1-14002" >2081, 2082, 2083, 2084, 2085, 2086, 2087
    +href="glossaries-user.html#dx1-23069" >2085, 2086, 2087
    \printacronyms  2125, 2126
    scrwfile package  2127
    +href="glossaries-user.html#dx1-23053" >2127
    \SetAcronymLists  2165, 2166, 2167, 2168, 2169, 2170, 2171, 2172, 2173, 2174, 2169, 2170, 2171, 2172, 2173, 2174, 2175

    X @@ -30700,13 +30704,13 @@ href="glossaries-user.html#dx1-19024" >2252, 2253, 2254, 2255, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2256, 2257, 2258, 2259, 2260, 2261, 2262, 2263, 2264, 2265,  distributions for Windows class="cmr-8">provide makeglossaries.exe.

    -

    2.1bug fix in v4.16 has corrected the code to ensure this.

    -

    2.2unless memoirmemoiris loaded, which case it uses \markboth

    -

    2.3Actually it uses \mfirstucMakeUppercase\nopreamble\nopostamble" -% -setambles ".*\.tex=>\nopreamble\nopostamble" -% -setambles ".*\.xdy=>\nopreamble\nopostamble" +% -author "Nicola Talbot" +% -comment ".*\.perl" +% -comment ".*\.tex" +% -comment ".*\.xdy" % -src "glossaries\.sty\Z=>glossaries.sty" % -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty" % -src "(glossary-.+)\.(sty)\Z=>\1.\2" @@ -20,18 +21,17 @@ % -src "(samplexdy-mc.*\.xdy)\Z=>\1" % -src "(database.*\.tex)\Z=>\1" % -src "(.*\.perl)\Z=>\1" -% -codetitle "Main Package Code" -% -author "Nicola Talbot" % -macrocode ".*\.perl" % -macrocode ".*\.tex" % -macrocode ".*\.xdy" % -section "chapter" +% -codetitle "Main Package Code" % -doc "glossaries-manual.tex" -% -comment ".*\.perl" -% -comment ".*\.tex" -% -comment ".*\.xdy" +% -setambles ".*\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" +% -setambles ".*\.xdy=>\nopreamble\nopostamble" % glossaries -% Created on 2019/1/6 19:06 +% Created on 2019/9/28 15:01 %\fi %\iffalse %<*package> @@ -145,7 +145,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{19625} +\CheckSum{19658} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -172,12 +172,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\fi %\MakeShortVerb{"} % -% \title{Documented Code For glossaries v4.42} +% \title{Documented Code For glossaries v4.43} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2019-01-06} +% \date{2019-09-28} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -193,7 +193,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %glossaries package}. % %\item[\url{glossaries-user.pdf}] -%For the main user guide, read \qt{glossaries.sty v4.42: +%For the main user guide, read \qt{glossaries.sty v4.43: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -248,7 +248,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} %\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle} % Required packages: @@ -282,7 +282,8 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \RequirePackage{amsgen} % \end{macrocode} %\changes{3.0}{2011-04-02}{etoolbox now loaded} -% As from v3.0, now loading \sty{etoolbox}: +% As from v3.0, now loading \sty{etoolbox} (this is now redundant as +% \sty{datatool-base} loads \sty{etoolbox}): % \begin{macrocode} \RequirePackage{etoolbox} % \end{macrocode} @@ -1739,10 +1740,18 @@ false,nolabel,autolabel,nameref}[nolabel]{% %just do their argument. (This will be localised since %\cs{glsnoidxstripaccents} is used within a group.) Anything outside %this standard set really shouldn't be using -%\cs{makenoidxglossaries}. +%\cs{makenoidxglossaries}. It's much better to use \app{xindy} or +%\app{bib2gls} with the correct language setting. % \begin{macrocode} \newcommand*\glsnoidxstripaccents{% \let\IeC\@firstofone + \let\add@accent@\@secondoftwo + \let\@text@composite@x\@secondoftwo + \let\@tabacckludge\@secondoftwo + \expandafter\def\csname \encodingdefault-cmd\endcsname##1##2##3{##3}% + \expandafter\def\csname OT1-cmd\endcsname##1##2##3{##3}% + \expandafter\def\csname T1-cmd\endcsname##1##2##3{##3}% + \expandafter\def\csname PD1-cmd\endcsname##1##2##3{##3}% \let\'\@firstofone \let\`\@firstofone \let\^\@firstofone @@ -1783,6 +1792,16 @@ false,nolabel,autolabel,nameref}[nolabel]{% \def\DH{DH}% } % \end{macrocode} +%\changes{4.43}{2019-09-28}{add check for LaTeX version 2019/10/01} +%Need to check if the LaTeX kernel is at least version 2019/10/01 as +%that changes the way that UTF-8 characters expand. +% \begin{macrocode} +\@ifl@t@r\fmtversion{2019/10/01} +{% + \appto\glsnoidxstripaccents{\let\UTFviii@two@octets\UTFviii@two@octets@combine}% +} +{} +% \end{macrocode} %\end{macro} % % Before defining the \pkgopt{sanitize} package option, The @@ -19177,7 +19196,7 @@ you % \cs{gls}\marg{label}} on subsequent use. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Pass all options to \sty{glossaries}: % \begin{macrocode} @@ -19592,7 +19611,7 @@ you %\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} -\ProvidesPackage{glossary-hypernav}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % % The commands defined in this package are provided to @@ -19785,7 +19804,7 @@ you % This defines an in-line style where the entries are % comma-separated with just the name and description displayed. % \begin{macrocode} -\ProvidesPackage{glossary-inline}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-inline}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % %\begin{style}{inline} @@ -19976,7 +19995,7 @@ you % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-list}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} %\begin{macro}{\indexspace} %\changes{4.13}{2015-02-03}{new} @@ -20258,7 +20277,7 @@ you % The glossary styles defined in the \isty{glossary-long} package % used the \env{longtable} environment in the glossary. % \begin{macrocode} -\ProvidesPackage{glossary-long}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-long}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} @@ -20755,7 +20774,7 @@ you % \url{http://tex.stackexchange.com/a/56890} % % \begin{macrocode} -\ProvidesPackage{glossary-longbooktabs}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Requires \sty{booktabs} package: % \begin{macrocode} @@ -21096,7 +21115,7 @@ you % used the \env{longtable} environment in the glossary and use % ragged right formatting for the multiline columns. % \begin{macrocode} -\ProvidesPackage{glossary-longragged}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-longragged}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -21529,7 +21548,7 @@ you %use the \sty{multicol} package. These use the tree-like glossary %styles in a multicol environment. % \begin{macrocode} -\ProvidesPackage{glossary-mcols}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-mcols}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -21966,7 +21985,7 @@ you % The glossary styles defined in the \isty{glossary-super} package % use the \env{supertabular} environment. % \begin{macrocode} -\ProvidesPackage{glossary-super}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-super}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} @@ -22498,7 +22517,7 @@ you % are like those provided by the \isty{glossary-super} package, % except that the multiline columns have ragged right justification. % \begin{macrocode} -\ProvidesPackage{glossary-superragged}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-superragged}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -22938,7 +22957,7 @@ you % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossary-tree}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % %\begin{macro}{\indexspace} @@ -23659,7 +23678,7 @@ you % hyperlinks may not work properly. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} %\begin{macro}{\GlsAddXdyAttribute} % Adds an attribute in old format. @@ -24020,7 +24039,7 @@ you %\section{glossaries-compatible-307} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % % Compatibility macros for predefined glossary styles: @@ -24828,7 +24847,7 @@ you % \end{macrocode} % Package version number now in line with main glossaries package number. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2019/01/06 v4.42 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2019/09/28 v4.43 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -27271,7 +27290,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries-babel}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -27315,7 +27334,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2019/01/06 v4.42 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2019/09/28 v4.43 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -27356,46 +27375,47 @@ you %\fi %\iffalse % \begin{macrocode} - % This file is public domain. - % - % This is a minimal file for testing and debugging - % the glossaries package. Change the class file as - % desired, and add the relevant package options to - % both the class file and the glossaries package. - % Change the sample glossary entry and acronym if - % required. If the problem occurs with an additional - % glossary, add in the relevant \newglossary command - % and a sample entry. - % - % Only add extra packages or commands if they - % contribute to whatever problem you are trying to - % test. - % - % Remember that the document will not be complete - % until you have successfully completed all of the - % following steps: - % 1. latex minimalgls - % 2. makeglossaries minimalgls (note no extension) - % 3. latex minimalgls - % A further run through LaTeX will be required to ensure that - % the table of contents is up to date if the toc option - % is used. - % Alternatively, if you use arara, you can add the following - % directives in your document: - % - % arara: pdflatex: { synctex: on } - % arara: makeglossaries - % arara: pdflatex: { synctex: on } +%<

    The glossaries package v4.42: a guide for +class="cmr-17">The glossaries package v4.43: a guide for beginners

    @@ -268,7 +268,7 @@ class="td11"> Nicola L.C. Talbot

    2019-01-06

    +class="cmr-12">2019-09-28

    @@ -1762,7 +1762,7 @@ id="TBL-2-2" />

    Option 4

    Requires glossaries-extra

    Requires an external @@ -1809,7 +1809,7 @@ class="pzdr-">✔

    Requires Perl?

    Requires Java?

    Can sort extended @@ -1850,7 +1850,7 @@ class="pzdr-">✔

    Efficient sort algorithm?

    Can use different @@ -1881,7 +1881,7 @@ class="pzdr-">✘

    Any problematic sort @@ -1895,7 +1895,7 @@ class="pzdr-">✔

    Can form ranges @@ -1912,7 +1912,7 @@ class="pzdr-">✔

    Can have non-standard diff --git a/macros/latex/contrib/glossaries/glossariesbegin.pdf b/macros/latex/contrib/glossaries/glossariesbegin.pdf index 456669e405..0a03bf1c66 100644 Binary files a/macros/latex/contrib/glossaries/glossariesbegin.pdf and b/macros/latex/contrib/glossaries/glossariesbegin.pdf differ diff --git a/macros/latex/contrib/glossaries/glossariesbegin.tex b/macros/latex/contrib/glossaries/glossariesbegin.tex index d630031205..50a0bfccd9 100644 --- a/macros/latex/contrib/glossaries/glossariesbegin.tex +++ b/macros/latex/contrib/glossaries/glossariesbegin.tex @@ -31,10 +31,10 @@ \texorpdfstring{{\frenchspacing\obeyspaces\ttfamily#1}}{#1}} \newcommand*{\file}[1]{\texorpdfstring{\texttt{#1}}{#1}} -\title{The glossaries package v4.42: +\title{The glossaries package v4.43: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2019-01-06} +\date{2019-09-28} \ifpdf \externaldocument{glossaries-user} diff --git a/macros/latex/contrib/glossaries/glossary2glossaries.html b/macros/latex/contrib/glossaries/glossary2glossaries.html index 56312bb11a..bc00961cad 100644 --- a/macros/latex/contrib/glossaries/glossary2glossaries.html +++ b/macros/latex/contrib/glossaries/glossary2glossaries.html @@ -126,8 +126,9 @@ span.LATEX span.TEX{ position:relative; left: -0.4em; } div.float, div.figure {margin-left: auto; margin-right: auto;} div.float img {text-align:center;} div.figure img {text-align:center;} -.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} -.marginpar p{margin-top:0.4em; margin-bottom:0.4em;} +.marginpar,.reversemarginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;} +.marginpar p,.reversemarginpar p{margin-top:0.4em; margin-bottom:0.4em;} +.reversemarginpar{float:left;} table.equation {width:100%;} .equation td{text-align:center; } td.equation { margin-top:1em; margin-bottom:1em; } @@ -200,7 +201,7 @@ class="td11">Nicola L.C. Talbot

    2019-01-06

    +class="cmr-12">2019-09-28

    @@ -517,7 +518,7 @@ href="#top">Top

    Defining new glossary types

    If you have created new glossary types, you will need to replace all instances of -


    The glossary package allows you to add information to the glossary for a predefined term without producing any text in the document using -


  • The glossary package allows you to add information to the glossary for a predefined term with the given text using -





    Any occurrences of this command will need to be replaced with -



    glossaries \glslinkglossaries package treats acronyms in exactly the same way as normal glossary terms. In fact, in the glossaries package, the default definition of: -





    is a shortcut for: -



    glossaries \newglossaryentry\useacronym\⟨acr-name⟩, then you will need to replace all occurrences of -





    with -



    glossaries \gls\⟨acr-name⟩. For example, if your document originally had the following: -



    glossary @@ -1228,7 +1229,7 @@ class="cmss-10">glossary

    then you can change this to: -



    glossaries @@ -1289,7 +1290,7 @@ class="cmtt-10">\oldacronym\newacronym) you can replace -



    glossary \acrsh}


    with -





    and you can replace -



    glossary \acrln}
    with -



    glossaries \acrlongTop

    \ifacronymfirstuse

    The glossary package command -