diff options
| author | Karl Berry <karl@freefriends.org> | 2020-02-14 22:27:37 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2020-02-14 22:27:37 +0000 |
| commit | 607682851f2a709e970de0672a2ea1e180352523 (patch) | |
| tree | 56019dc6fd2e884a84a8554d9cbae26a78f1649e | |
| parent | 49f9aa88e37f97ad037d7a09c20526c9afb854fc (diff) | |
glossaries (14feb20)
git-svn-id: svn://tug.org/texlive/trunk@53777 c570f23f-e606-0410-a88d-b1316a301751
149 files changed, 45812 insertions, 20612 deletions
diff --git a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries index d42214c5fff..fe1e1248d9b 100755 --- a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries +++ b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 4.44 +# Version : 4.45 # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -31,7 +31,7 @@ # glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl. # Also makeglossaries and makeglossaries-lite.lua. -my $version="4.44 (2019-12-06)"; +my $version="4.45 (2020-01-18)"; # History: # v4.43: @@ -1140,7 +1140,8 @@ sub makeindex{ # This is a subroutine in case of possible extension. # For example, what happens in the event of 'textbf' and 'emph'? # Should one override the other or be combined? Combining is harder -# as it would need a corresponding LaTeX command. +# as it would need a corresponding LaTeX command. (bib2gls deals +# with this better through its --map-formats switcn.) # 2.21 check for range encap moved earlier sub encap_overrides{ diff --git a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua index 22b1c75147a..5e2272ff094 100755 --- a/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua +++ b/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua @@ -36,6 +36,8 @@ Also makeglossaries and makeglossaries-lite.lua. History: + * 4.45: + - no change. * 4.44: - no change. * 4.41: @@ -66,7 +68,7 @@ - changed first line from lua to texlua --]] -thisversion = "4.44 (2019-12-06)" +thisversion = "4.45 (2020-01-18)" quiet = false dryrun = false diff --git a/Master/texmf-dist/doc/latex/glossaries/CHANGES b/Master/texmf-dist/doc/latex/glossaries/CHANGES index b6699410781..3149706a906 100644 --- a/Master/texmf-dist/doc/latex/glossaries/CHANGES +++ b/Master/texmf-dist/doc/latex/glossaries/CHANGES @@ -1,5 +1,52 @@ glossaries change log: +v4.45 (2020-02-13): + + * glossaries-accsupp.sty: + + - new associated accessibility keys for the user fields + + - new commands: \glsaccessibility, \glsfieldaccsupp, \xglsfieldaccsupp, + \glsshortaccsupp, \glsshortplaccsupp (determine Alt/ActualText/E + according to the field) + + - added accessibility support to \glstext, \glsplural, \glsfirst, + \glsfirstplural, \glssymbol, \glsname, \glsdesc, + \glsdescplural, \glsuseri, \glsuserii, \glsuseriii, \glsuseriv, + \glsuserv, \glsuservi and their case variants + + - bug fixes: + + - added field existence checks for \gls...accessdisplay commands + + - removed symbol use backward compatibility as it causes + interference + + * glossaries-prefix.sty: + + - new command \glsprefixsep + + * glossaries.sty: + + - new package options: + + disablemakegloss + restoremakegloss + writeglslabels + + - package option debug now also accepts value 'showaccsupp' + + - detokenize label before passing to \glsshowtarget + + - new commands: \glsentryparent, \glsshowtargetouter and \glsshowtargetfont + + - made robust: \ifglshaschildren, \ifglshassymbol, \ifglshaslong, + \ifglshasshort, \ifglshasfield + + - Bug fix: + + - added existence check to \glsentrytitlecase + v4.44 (2019-12-06): * glossaries-prefix.sty: diff --git a/Master/texmf-dist/doc/latex/glossaries/INSTALL b/Master/texmf-dist/doc/latex/glossaries/INSTALL index e9ba724de8d..f966ec2d29e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/INSTALL +++ b/Master/texmf-dist/doc/latex/glossaries/INSTALL @@ -1,8 +1,8 @@ INSTALLATION -The best method of installing is through your TeX package -manager, but if you need to use the manual method for some -reason, follow the instructions below. +The best (and recommended) method of installing is through your TeX package +manager (for example, `tlmgr install glossaries`), but if you need to use +the manual method for some reason, follow the instructions below. If you have downloaded the glossaries package using the TeX Directory Structure (TDS), that is you have downloaded the archive diff --git a/Master/texmf-dist/doc/latex/glossaries/README b/Master/texmf-dist/doc/latex/glossaries/README deleted file mode 100644 index cbf39bc9886..00000000000 --- a/Master/texmf-dist/doc/latex/glossaries/README +++ /dev/null @@ -1,81 +0,0 @@ -LaTeX Package : glossaries v4.44 - -Last Modified : 2019-12-06 - -Author : Nicola Talbot - -Package FAQ : http://www.dickimaw-books.com/faqs/glossariesfaq.html - -This package is provided to assist generating glossaries. -The package supports abbreviations and multiple glossaries. -New entries are defined to have a name and description (and -optionally an associated symbol). Plural forms can also be -specified. New glossary styles can be defined, and preambles -and postambles can be specified. There is provision for loading -a database of terms, only terms used in the text will be added -to the relevant glossary. - -*This package replaces the glossary package which is now obsolete.* - -glossaries-accsupp.sty is an experimental package that uses the -accsupp package to provide accessibility support for the -glossaries package. - -The glossaries package may be extended with the -separately-distributed glossaries-extra package -(https://ctan.org/pkg/glossaries-extra), which provides -more options and improved abbreviation handling. - -The mfirstuc package is now a separate bundle -(https://ctan.org/pkg/mfirstuc). - -INSTALLATION - -See INSTALL file for installation instructions. - -REQUIREMENTS - -mfirstuc -ifthen -xkeyval *at least version 2.5f (2006/11/18)* -xfor -amsgen -etoolbox -longtable (unless you use the nolong or nostyles package options) -datatool-base -textcase -tracklang (to determine if any language modules need to be loaded) - -If the supertabular package is installed, it will also be loaded -unless the nosuper or nostyles package options are used. If the -supertabular package isn't installed, you can still use the -glossaries package, but you won't be able to use any of the styles -defined in glossaries-super.sty. If you want to use -glossary-longragged.sty or glossary-superragged.sty you will also -need the array package. If you want to use glossary-mcols you will -also need the multicol package. - -Note that the current version of the glossaries package doesn't -load xspace. - -If you want to use the experimental glossaries-accsupp.sty -you will also need the accsupp package. - -LaTeX2HTML - -This package comes with a LaTeX2HTML style file glossaries.perl -which should be placed in the relevant LaTeX2HTML -styles directory, but note that these styles only supply a sub-set -of the commands provided by glossaries.sty, so some -commands may not be implemented or may be implemented in a different -way. This file has not be tested with recent versions of -LaTeX2HTML and may no longer be compatible. - -LICENCE - -This material is subject to the LaTeX Project Public License. -See http://www.ctan.org/license/lppl1.3 -for the details of that license. - -Author's home page: http://www.dickimaw-books.com/ - diff --git a/Master/texmf-dist/doc/latex/glossaries/README.md b/Master/texmf-dist/doc/latex/glossaries/README.md new file mode 100644 index 00000000000..ccb9d839693 --- /dev/null +++ b/Master/texmf-dist/doc/latex/glossaries/README.md @@ -0,0 +1,128 @@ +# glossaries v4.45 (2020-02-13) + +Author: Nicola Talbot ([contact](http://www.dickimaw-books.com/contact)) + +## LICENCE + +This material is subject to the LaTeX Project Public License. +See http://www.ctan.org/license/lppl1.3 +for the details of that license. + +Copyright 2007-2020 Nicola Talbot + +## DESCRIPTION + +This package is provided to assist generating glossaries. +The package supports abbreviations and multiple glossaries. +New entries are defined to have a name and description (and +optionally an associated symbol). Plural forms can also be +specified. New glossary styles can be defined, and preambles +and postambles can be specified. There is provision for loading +a database of terms where only terms used in the text will be added +to the relevant glossary. + +*This package replaces the glossary package which is now obsolete.* + +### Included supplementary files: + + - glossaries-prefix.sty: allows for the inclusion of a prefix (such + as a determiner) before terms. + + - glossaries-accsupp.sty: an experimental package that uses the + [accsupp](https://ctan.org/pkg/accsupp) package to + provide accessibility support for the glossaries package. + + - glossary style packages (such as glossary-list.sty and + glossary-index.sty). Note that the list styles may be incompatible with + classes or packages that redefine the `description` environment. + + - a set of files containing lorem ipsum dummy entries for testing + and debugging. + +### Excluded supplementary packages (separate installation required): + + - language support packages, + e.g. [glossaries-english.sty](https://ctan.org/pkg/glossaries-english). + + - [glossaries-extra.sty](https://ctan.org/pkg/glossaries-extra) extends + glossaries.sty, providing more options and better abbreviation handling. + + - [bib2gls](https://ctan.org/pkg/bib2gls) alternative indexing + application designed specifically for use with glossaries-extra.sty + +## RELATED MATERIAL + + - [Package FAQ](http://www.dickimaw-books.com/faqs/glossariesfaq.html) + + - [Bug tracker](https://www.dickimaw-books.com/bugtracker.php?category=glossaries) + + - [Gallery](https://www.dickimaw-books.com/gallery/#glossaries) + + - [Document Build Advice](https://www.dickimaw-books.com/latex/buildglossaries/) + +## INSTALLATION + +The best and recommended method is through your TeX package manager, +otherwise see INSTALL file for installation instructions. + +To test your installation, compile `minimalgls.tex` which is provided +with the sample files: + +```bash +pdflatex minimalgls +makeglossaries minimalgls +pdflatex minimalgls +``` +or (if you don't have Perl installed): + +```bash +pdflatex minimalgls +makeglossaries-lite minimalgls +pdflatex minimalgls +``` + +## REQUIREMENTS + + - amsgen + - datatool-base + - etoolbox + - ifthen + - mfirstuc + - textcase + - tracklang + - xfor + - xkeyval *at least version 2.5f (2006/11/18)* + +If you want to use glossaries-accsupp.sty you will also need the accsupp package. + +Some of the glossary styles require additional packages, which are +automatically loaded by the corresponding `glossary-`*name*`.sty` +package. + + - The `long` styles require longtable.sty. + + - The `super` styles require supertabular.sty. + + - The `ragged` styles required array.sty. + + - The `mcols` styles require multicol.sty. + + - The `booktab` styles require booktabs.sty. + +If you want to use the `sm` acronym styles you will also need +relsizes.sty. This needs to be explicitly loaded in your document if +required. + +If you want to use `\oldacronym` with `\xspace` you will also need +xspace.sty. This needs to be explicitly loaded in your document if +required. (Not recommended.) + +## LaTeX2HTML + +This package comes with a LaTeX2HTML style file glossaries.perl +which should be placed in the relevant LaTeX2HTML +styles directory, but note that this style only supplies a sub-set +of the commands provided by glossaries.sty, so some +commands may not be implemented or may be implemented in a different +way. This file has not be tested with recent versions of +LaTeX2HTML and may no longer be compatible. diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf Binary files differindex 6cadc9faf14..b6168ca4e48 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html index 66646c2c869..abe7f89e46c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html @@ -45,17 +45,11 @@ .cmssbx-10{ font-family: sans-serif; font-weight: bold;} .cmssbx-10{ font-family: sans-serif; font-weight: bold;} .cmr-9{font-size:90%;} -.tcrm-0800{font-size:80%;} .cmtt-8{font-size:80%;font-family: monospace;} .cmtt-8{font-family: monospace;} .cmtt-8{font-family: monospace;} .cmtt-8{font-family: monospace;} .cmtt-8{font-family: monospace;} -.cmss-8{font-size:80%; font-family: sans-serif;} -.cmss-8{ font-family: sans-serif;} -.cmss-8{ font-family: sans-serif;} -.cmss-8{ font-family: sans-serif;} -.cmss-8{ font-family: sans-serif;} .cmtt-9{font-size:90%;font-family: monospace;} .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} @@ -70,20 +64,28 @@ .cmmi-9{font-size:90%;font-style: italic;} .msam-10x-x-90{font-size:90%;} .pzdr-x-x-90{font-size:90%;} +.cmss-8{font-size:80%; font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} +.cmss-8{ font-family: sans-serif;} .cmbx-12{font-size:120%; font-weight: bold;} .cmbx-12{ font-weight: bold;} +.tctt-1000{font-family: monospace;} +.cmti-8{font-size:80%; font-style: italic;} .cmitt-10{font-family: monospace; font-style: italic;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} +.cmssi-10{ font-family: sans-serif; font-style: oblique;} .cmbxti-10{ font-weight: bold; font-style: italic;} -.cmssbx-10x-x-120{font-size:120%; font-family: sans-serif; font-weight: bold;} -.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} -.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} -.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} -.cmssbx-10x-x-120{ font-family: sans-serif; font-weight: bold;} .small-caps{font-variant: small-caps; } -p.noindent { text-indent: 0em } -td p.noindent { text-indent: 0em; margin-top:0em; } -p.nopar { text-indent: 0em; } -p.indent{ text-indent: 1.5em } +p{margin-top:0;margin-bottom:0} +p.indent{text-indent:0;} +p + p{margin-top:1em;} +p + div, p + pre {margin-top:1em;} +div + p, pre + p {margin-top:1em;} @media print {div.crosslinks {visibility:hidden;}} a img { border-top: 0; border-left: 0; border-right: 0; } center { margin-top:1em; margin-bottom:1em; } @@ -106,7 +108,7 @@ div.obeylines-v p { margin-top:0; margin-bottom:0; } td.displaylines {text-align:center; white-space:nowrap;} .centerline {text-align:center;} .rightline {text-align:right;} -div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; } .fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } div.fbox {display:table} div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } @@ -231,70 +233,1063 @@ 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} +pre.prompt {color: white; background: black; font-weight: bold; padding-bottom: 2ex; padding-left: 1em; padding-right: 1em;} +.warningsymbol { color: red; font-weight: bold;} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} -span#textcolor1{color:#00FF00} -span#textcolor2{color:#00FF00} -span#textcolor3{color:#00FF00} -span#textcolor4{color:#FF0000} -span#textcolor5{color:#FF0000} -span#textcolor6{color:#00FF00} -span#textcolor7{color:#FF0000} -span#textcolor8{color:#FF0000} -span#textcolor9{color:#FF0000} -span#textcolor10{color:#00FF00} -span#textcolor11{color:#00FF00} -span#textcolor12{color:#00FF00} -span#textcolor13{color:#FF0000} -span#textcolor14{color:#00FF00} -span#textcolor15{color:#00FF00} +span#textcolor1{color:#008080} +span#textcolor2{color:#008080} +span#textcolor4{color:#008080} +span#textcolor5{color:#008080} +span#textcolor6{color:#008080} +span#textcolor7{color:#008080} +span#textcolor8{color:#008080} +span#textcolor9{color:#008080} +span#textcolor10{color:#008080} +span#textcolor11{color:#008080} +span#textcolor12{color:#008080} +span#textcolor13{color:#008080} +span#textcolor14{color:#008080} +span#textcolor15{color:#008080} span#textcolor16{color:#00FF00} span#textcolor17{color:#00FF00} span#textcolor18{color:#00FF00} span#textcolor19{color:#FF0000} -span#textcolor20{color:#00FF00} -span#textcolor21{color:#FF0000} +span#textcolor20{color:#FF0000} +span#textcolor21{color:#00FF00} span#textcolor22{color:#FF0000} -span#textcolor23{color:#00FF00} -span#textcolor24{color:#00FF00} -span#textcolor25{color:#FF0000} +span#textcolor23{color:#FF0000} +span#textcolor24{color:#FF0000} +span#textcolor25{color:#00FF00} span#textcolor26{color:#00FF00} span#textcolor27{color:#00FF00} -span#textcolor28{color:#00FF00} +span#textcolor28{color:#FF0000} span#textcolor29{color:#00FF00} -span#textcolor30{color:#FF0000} -span#textcolor31{color:#FF0000} +span#textcolor30{color:#00FF00} +span#textcolor31{color:#00FF00} span#textcolor32{color:#00FF00} -span#textcolor33{color:#FF0000} +span#textcolor33{color:#00FF00} span#textcolor34{color:#FF0000} -span#textcolor35{color:#FF0000} -span#textcolor36{color:#00FF00} -span#textcolor37{color:#00FF00} +span#textcolor35{color:#00FF00} +span#textcolor36{color:#FF0000} +span#textcolor37{color:#FF0000} span#textcolor38{color:#00FF00} span#textcolor39{color:#00FF00} span#textcolor40{color:#FF0000} span#textcolor41{color:#00FF00} span#textcolor42{color:#00FF00} -span#textcolor43{color:#FF0000} +span#textcolor43{color:#00FF00} span#textcolor44{color:#00FF00} -span#textcolor45{color:#00FF00} -span#textcolor46{color:#00FF00} -span#textcolor47{color:#FF0000} -span#textcolor48{color:#00FF00} +span#textcolor45{color:#FF0000} +span#textcolor46{color:#FF0000} +span#textcolor47{color:#00FF00} +span#textcolor48{color:#FF0000} span#textcolor49{color:#FF0000} -span#textcolor50{color:#00FF00} +span#textcolor50{color:#FF0000} span#textcolor51{color:#00FF00} span#textcolor52{color:#00FF00} span#textcolor53{color:#00FF00} -span#textcolor54{color:#FF0000} +span#textcolor54{color:#00FF00} span#textcolor55{color:#FF0000} span#textcolor56{color:#00FF00} -span#textcolor57{color:#FF0000} -span#textcolor58{color:#00FF00} -span#textcolor59{color:#FF0000} -span#textcolor60{color:#FF0000} +span#textcolor57{color:#00FF00} +span#textcolor58{color:#FF0000} +span#textcolor59{color:#00FF00} +span#textcolor60{color:#00FF00} span#textcolor61{color:#00FF00} -span#textcolor62{color:#00FF00} +span#textcolor62{color:#FF0000} +span#textcolor63{color:#00FF00} +span#textcolor64{color:#FF0000} +span#textcolor65{color:#00FF00} +span#textcolor66{color:#00FF00} +span#textcolor67{color:#00FF00} +span#textcolor68{color:#00FF00} +span#textcolor69{color:#FF0000} +span#textcolor70{color:#FF0000} +span#textcolor71{color:#00FF00} +span#textcolor72{color:#FF0000} +span#textcolor73{color:#00FF00} +span#textcolor74{color:#FF0000} +span#textcolor75{color:#FF0000} +span#textcolor76{color:#00FF00} +span#textcolor77{color:#00FF00} +span#textcolor78{color:#008080} +span#textcolor79{color:#008080} +span#textcolor80{color:#008080} +span#textcolor81{color:#008080} +span#textcolor82{color:#008080} +span#textcolor83{color:#008080} +span#textcolor84{color:#008080} +span#textcolor85{color:#008080} +span#textcolor86{color:#008080} +span#textcolor87{color:#008080} +span#textcolor88{color:#008080} +span#textcolor89{color:#008080} +span#textcolor90{color:#008080} +span#textcolor91{color:#008080} +span#textcolor92{color:#008080} +span#textcolor93{color:#008080} +span#textcolor94{color:#008080} +span#textcolor95{color:#008080} +span#textcolor96{color:#008080} +span#textcolor97{color:#008080} +span#textcolor98{color:#008080} +span#textcolor99{color:#008080} +span#textcolor100{color:#008080} +span#textcolor101{color:#008080} +span#textcolor102{color:#008080} +span#textcolor103{color:#008080} +span#textcolor104{color:#008080} +span#textcolor105{color:#008080} +span#textcolor106{color:#008080} +span#textcolor107{color:#008080} +span#textcolor108{color:#008080} +span#textcolor109{color:#008080} +span#textcolor110{color:#008080} +span#textcolor111{color:#008080} +span#textcolor112{color:#008080} +span#textcolor113{color:#008080} +span#textcolor114{color:#008080} +span#textcolor115{color:#008080} +span#textcolor116{color:#008080} +span#textcolor117{color:#008080} +span#textcolor118{color:#008080} +span#textcolor119{color:#008080} +span#textcolor120{color:#008080} +span#textcolor121{color:#008080} +span#textcolor122{color:#008080} +span#textcolor123{color:#008080} +span#textcolor124{color:#008080} +span#textcolor125{color:#008080} +span#textcolor126{color:#008080} +span#textcolor127{color:#008080} +span#textcolor128{color:#008080} +span#textcolor129{color:#008080} +span#textcolor130{color:#008080} +span#textcolor131{color:#008080} +span#textcolor132{color:#008080} +span#textcolor133{color:#008080} +span#textcolor134{color:#008080} +span#textcolor135{color:#008080} +span#textcolor136{color:#008080} +span#textcolor137{color:#008080} +span#textcolor138{color:#008080} +span#textcolor139{color:#008080} +span#textcolor140{color:#008080} +span#textcolor141{color:#008080} +span#textcolor142{color:#008080} +span#textcolor143{color:#008080} +span#textcolor144{color:#008080} +span#textcolor145{color:#008080} +span#textcolor146{color:#008080} +span#textcolor147{color:#008080} +span#textcolor148{color:#008080} +span#textcolor149{color:#008080} +span#textcolor150{color:#008080} +span#textcolor151{color:#008080} +span#textcolor152{color:#008080} +span#textcolor153{color:#008080} +span#textcolor154{color:#008080} +span#textcolor155{color:#008080} +span#textcolor156{color:#008080} +span#textcolor157{color:#008080} +span#textcolor158{color:#008080} +span#textcolor159{color:#008080} +span#textcolor160{color:#008080} +span#textcolor161{color:#008080} +span#textcolor162{color:#008080} +span#textcolor163{color:#008080} +span#textcolor164{color:#008080} +span#textcolor165{color:#008080} +span#textcolor166{color:#008080} +span#textcolor167{color:#008080} +span#textcolor168{color:#008080} +span#textcolor169{color:#008080} +span#textcolor170{color:#008080} +span#textcolor171{color:#008080} +span#textcolor172{color:#008080} +span#textcolor173{color:#008080} +span#textcolor174{color:#008080} +span#textcolor175{color:#008080} +span#textcolor176{color:#008080} +span#textcolor177{color:#008080} +span#textcolor178{color:#008080} +span#textcolor179{color:#008080} +span#textcolor180{color:#008080} +span#textcolor181{color:#008080} +span#textcolor182{color:#008080} +span#textcolor183{color:#008080} +span#textcolor184{color:#008080} +span#textcolor185{color:#008080} +span#textcolor186{color:#008080} +span#textcolor187{color:#008080} +span#textcolor188{color:#008080} +span#textcolor189{color:#008080} +span#textcolor190{color:#008080} +span#textcolor191{color:#008080} +span#textcolor192{color:#008080} +span#textcolor193{color:#008080} +span#textcolor194{color:#008080} +span#textcolor195{color:#008080} +span#textcolor196{color:#008080} +span#textcolor197{color:#008080} +span#textcolor198{color:#008080} +span#textcolor199{color:#008080} +span#textcolor200{color:#008080} +span#textcolor201{color:#008080} +span#textcolor202{color:#008080} +span#textcolor203{color:#008080} +span#textcolor204{color:#008080} +span#textcolor205{color:#008080} +span#textcolor206{color:#008080} +span#textcolor207{color:#008080} +span#textcolor208{color:#008080} +span#textcolor209{color:#008080} +span#textcolor210{color:#008080} +span#textcolor211{color:#008080} +span#textcolor212{color:#008080} +span#textcolor213{color:#008080} +span#textcolor214{color:#008080} +span#textcolor215{color:#008080} +span#textcolor216{color:#008080} +span#textcolor217{color:#008080} +span#textcolor218{color:#008080} +span#textcolor219{color:#008080} +span#textcolor220{color:#008080} +span#textcolor221{color:#008080} +span#textcolor222{color:#008080} +span#textcolor223{color:#008080} +span#textcolor224{color:#008080} +span#textcolor225{color:#008080} +span#textcolor226{color:#008080} +span#textcolor227{color:#008080} +span#textcolor228{color:#008080} +span#textcolor229{color:#008080} +span#textcolor230{color:#008080} +span#textcolor231{color:#008080} +span#textcolor232{color:#008080} +span#textcolor233{color:#008080} +span#textcolor234{color:#008080} +span#textcolor235{color:#008080} +span#textcolor236{color:#008080} +span#textcolor237{color:#008080} +span#textcolor238{color:#008080} +span#textcolor239{color:#008080} +span#textcolor240{color:#008080} +span#textcolor241{color:#008080} +span#textcolor242{color:#008080} +span#textcolor243{color:#008080} +span#textcolor244{color:#008080} +span#textcolor245{color:#008080} +span#textcolor246{color:#008080} +span#textcolor247{color:#008080} +span#textcolor248{color:#008080} +span#textcolor249{color:#008080} +span#textcolor250{color:#008080} +span#textcolor251{color:#008080} +span#textcolor252{color:#008080} +span#textcolor253{color:#008080} +span#textcolor254{color:#008080} +span#textcolor255{color:#008080} +span#textcolor256{color:#008080} +span#textcolor257{color:#008080} +span#textcolor258{color:#008080} +span#textcolor259{color:#008080} +span#textcolor260{color:#008080} +span#textcolor261{color:#008080} +span#textcolor262{color:#008080} +span#textcolor263{color:#008080} +span#textcolor264{color:#008080} +span#textcolor265{color:#008080} +span#textcolor266{color:#008080} +span#textcolor267{color:#008080} +span#textcolor268{color:#008080} +span#textcolor269{color:#008080} +span#textcolor270{color:#008080} +span#textcolor271{color:#008080} +span#textcolor272{color:#008080} +span#textcolor273{color:#008080} +span#textcolor274{color:#008080} +span#textcolor275{color:#008080} +span#textcolor276{color:#008080} +span#textcolor277{color:#008080} +span#textcolor278{color:#008080} +span#textcolor279{color:#008080} +span#textcolor280{color:#008080} +span#textcolor281{color:#008080} +span#textcolor282{color:#008080} +span#textcolor283{color:#008080} +span#textcolor284{color:#008080} +span#textcolor285{color:#008080} +span#textcolor286{color:#008080} +span#textcolor287{color:#008080} +span#textcolor288{color:#008080} +span#textcolor289{color:#008080} +span#textcolor290{color:#008080} +span#textcolor291{color:#008080} +span#textcolor292{color:#008080} +span#textcolor293{color:#008080} +span#textcolor294{color:#008080} +span#textcolor295{color:#008080} +span#textcolor296{color:#008080} +span#textcolor297{color:#008080} +span#textcolor298{color:#008080} +span#textcolor299{color:#008080} +span#textcolor300{color:#008080} +span#textcolor301{color:#008080} +span#textcolor302{color:#008080} +span#textcolor303{color:#008080} +span#textcolor304{color:#008080} +span#textcolor305{color:#008080} +span#textcolor306{color:#008080} +span#textcolor307{color:#008080} +span#textcolor308{color:#008080} +span#textcolor309{color:#008080} +span#textcolor310{color:#008080} +span#textcolor311{color:#008080} +span#textcolor312{color:#008080} +span#textcolor313{color:#008080} +span#textcolor314{color:#008080} +span#textcolor315{color:#008080} +span#textcolor316{color:#008080} +span#textcolor317{color:#008080} +span#textcolor318{color:#008080} +span#textcolor319{color:#008080} +span#textcolor320{color:#008080} +span#textcolor321{color:#008080} +span#textcolor322{color:#008080} +span#textcolor323{color:#008080} +span#textcolor324{color:#008080} +span#textcolor325{color:#008080} +span#textcolor326{color:#008080} +span#textcolor327{color:#008080} +span#textcolor328{color:#008080} +span#textcolor329{color:#008080} +span#textcolor330{color:#008080} +span#textcolor331{color:#008080} +span#textcolor332{color:#008080} +span#textcolor333{color:#008080} +span#textcolor334{color:#008080} +span#textcolor335{color:#008080} +span#textcolor336{color:#008080} +span#textcolor337{color:#008080} +span#textcolor338{color:#008080} +span#textcolor339{color:#008080} +span#textcolor340{color:#008080} +span#textcolor341{color:#008080} +span#textcolor342{color:#008080} +span#textcolor343{color:#008080} +span#textcolor344{color:#008080} +span#textcolor345{color:#008080} +span#textcolor346{color:#008080} +span#textcolor347{color:#008080} +span#textcolor348{color:#008080} +span#textcolor349{color:#008080} +span#textcolor350{color:#008080} +span#textcolor351{color:#008080} +span#textcolor352{color:#008080} +span#textcolor353{color:#008080} +span#textcolor354{color:#008080} +span#textcolor355{color:#008080} +span#textcolor356{color:#008080} +span#textcolor357{color:#008080} +span#textcolor358{color:#008080} +span#textcolor359{color:#008080} +span#textcolor360{color:#008080} +span#textcolor361{color:#008080} +span#textcolor362{color:#008080} +span#textcolor363{color:#008080} +span#textcolor364{color:#008080} +span#textcolor365{color:#008080} +span#textcolor366{color:#008080} +span#textcolor367{color:#008080} +span#textcolor368{color:#008080} +span#textcolor369{color:#008080} +span#textcolor370{color:#008080} +span#textcolor371{color:#008080} +span#textcolor372{color:#008080} +span#textcolor373{color:#008080} +span#textcolor374{color:#008080} +span#textcolor375{color:#008080} +span#textcolor376{color:#008080} +span#textcolor377{color:#008080} +span#textcolor378{color:#008080} +span#textcolor379{color:#008080} +span#textcolor380{color:#008080} +span#textcolor381{color:#008080} +span#textcolor382{color:#008080} +span#textcolor383{color:#008080} +span#textcolor384{color:#008080} +span#textcolor385{color:#008080} +span#textcolor386{color:#008080} +span#textcolor387{color:#008080} +span#textcolor388{color:#008080} +span#textcolor389{color:#008080} +span#textcolor390{color:#008080} +span#textcolor391{color:#008080} +span#textcolor392{color:#008080} +span#textcolor393{color:#008080} +span#textcolor394{color:#008080} +span#textcolor395{color:#008080} +span#textcolor396{color:#008080} +span#textcolor397{color:#008080} +span#textcolor398{color:#008080} +span#textcolor399{color:#008080} +span#textcolor400{color:#008080} +span#textcolor401{color:#008080} +span#textcolor402{color:#008080} +span#textcolor403{color:#008080} +span#textcolor404{color:#008080} +span#textcolor405{color:#008080} +span#textcolor406{color:#008080} +span#textcolor407{color:#008080} +span#textcolor408{color:#008080} +span#textcolor409{color:#008080} +span#textcolor410{color:#008080} +span#textcolor411{color:#008080} +span#textcolor412{color:#008080} +span#textcolor413{color:#008080} +span#textcolor414{color:#008080} +span#textcolor415{color:#008080} +span#textcolor416{color:#008080} +span#textcolor417{color:#008080} +span#textcolor418{color:#008080} +span#textcolor419{color:#008080} +span#textcolor420{color:#008080} +span#textcolor421{color:#008080} +span#textcolor422{color:#008080} +span#textcolor423{color:#008080} +span#textcolor424{color:#008080} +span#textcolor425{color:#008080} +span#textcolor426{color:#008080} +span#textcolor427{color:#008080} +span#textcolor428{color:#008080} +span#textcolor429{color:#008080} +span#textcolor430{color:#008080} +span#textcolor431{color:#008080} +span#textcolor432{color:#008080} +span#textcolor433{color:#008080} +span#textcolor434{color:#008080} +span#textcolor435{color:#008080} +span#textcolor436{color:#008080} +span#textcolor437{color:#008080} +span#textcolor438{color:#008080} +span#textcolor439{color:#008080} +span#textcolor440{color:#008080} +span#textcolor441{color:#008080} +span#textcolor442{color:#008080} +span#textcolor443{color:#008080} +span#textcolor444{color:#008080} +span#textcolor445{color:#008080} +span#textcolor446{color:#008080} +span#textcolor447{color:#008080} +span#textcolor448{color:#008080} +span#textcolor449{color:#008080} +span#textcolor450{color:#008080} +span#textcolor451{color:#008080} +span#textcolor452{color:#008080} +span#textcolor453{color:#008080} +span#textcolor454{color:#008080} +span#textcolor455{color:#008080} +span#textcolor456{color:#008080} +span#textcolor457{color:#008080} +span#textcolor458{color:#008080} +span#textcolor459{color:#008080} +span#textcolor460{color:#008080} +span#textcolor461{color:#008080} +span#textcolor462{color:#008080} +span#textcolor463{color:#008080} +span#textcolor464{color:#008080} +span#textcolor465{color:#008080} +span#textcolor466{color:#008080} +span#textcolor467{color:#008080} +span#textcolor468{color:#008080} +span#textcolor469{color:#008080} +span#textcolor470{color:#008080} +span#textcolor471{color:#008080} +span#textcolor472{color:#008080} +span#textcolor473{color:#008080} +span#textcolor474{color:#008080} +span#textcolor475{color:#008080} +span#textcolor476{color:#008080} +span#textcolor477{color:#008080} +span#textcolor478{color:#008080} +span#textcolor479{color:#008080} +span#textcolor480{color:#008080} +span#textcolor481{color:#008080} +span#textcolor482{color:#008080} +span#textcolor483{color:#008080} +span#textcolor484{color:#008080} +span#textcolor485{color:#008080} +span#textcolor486{color:#008080} +span#textcolor487{color:#008080} +span#textcolor488{color:#008080} +span#textcolor489{color:#008080} +span#textcolor490{color:#008080} +span#textcolor491{color:#008080} +span#textcolor492{color:#008080} +span#textcolor493{color:#008080} +span#textcolor494{color:#008080} +span#textcolor495{color:#008080} +span#textcolor496{color:#008080} +span#textcolor497{color:#008080} +span#textcolor498{color:#008080} +span#textcolor499{color:#008080} +span#textcolor500{color:#008080} +span#textcolor501{color:#008080} +span#textcolor502{color:#008080} +span#textcolor503{color:#008080} +span#textcolor504{color:#008080} +span#textcolor505{color:#008080} +span#textcolor506{color:#008080} +span#textcolor507{color:#008080} +span#textcolor508{color:#008080} +span#textcolor509{color:#008080} +span#textcolor510{color:#008080} +span#textcolor511{color:#008080} +span#textcolor512{color:#008080} +span#textcolor513{color:#008080} +span#textcolor514{color:#008080} +span#textcolor515{color:#008080} +span#textcolor516{color:#008080} +span#textcolor517{color:#008080} +span#textcolor518{color:#008080} +span#textcolor519{color:#008080} +span#textcolor520{color:#008080} +span#textcolor521{color:#008080} +span#textcolor522{color:#008080} +span#textcolor523{color:#008080} +span#textcolor524{color:#008080} +span#textcolor525{color:#008080} +span#textcolor526{color:#008080} +span#textcolor527{color:#008080} +span#textcolor528{color:#008080} +span#textcolor529{color:#008080} +span#textcolor530{color:#008080} +span#textcolor531{color:#008080} +span#textcolor532{color:#008080} +span#textcolor533{color:#008080} +span#textcolor534{color:#008080} +span#textcolor535{color:#008080} +span#textcolor536{color:#008080} +span#textcolor537{color:#008080} +span#textcolor538{color:#008080} +span#textcolor539{color:#008080} +span#textcolor540{color:#008080} +span#textcolor541{color:#008080} +span#textcolor542{color:#008080} +span#textcolor543{color:#008080} +span#textcolor544{color:#008080} +span#textcolor545{color:#008080} +span#textcolor546{color:#008080} +span#textcolor547{color:#008080} +span#textcolor548{color:#008080} +span#textcolor549{color:#008080} +span#textcolor550{color:#008080} +span#textcolor551{color:#008080} +span#textcolor552{color:#008080} +span#textcolor553{color:#008080} +span#textcolor554{color:#008080} +span#textcolor555{color:#008080} +span#textcolor556{color:#008080} +span#textcolor557{color:#008080} +span#textcolor558{color:#008080} +span#textcolor559{color:#008080} +span#textcolor560{color:#008080} +span#textcolor561{color:#008080} +span#textcolor562{color:#008080} +span#textcolor563{color:#008080} +span#textcolor564{color:#008080} +span#textcolor565{color:#008080} +span#textcolor566{color:#008080} +span#textcolor567{color:#008080} +span#textcolor568{color:#008080} +span#textcolor569{color:#008080} +span#textcolor570{color:#008080} +span#textcolor571{color:#008080} +span#textcolor572{color:#008080} +span#textcolor573{color:#008080} +span#textcolor574{color:#008080} +span#textcolor575{color:#008080} +span#textcolor576{color:#008080} +span#textcolor577{color:#008080} +span#textcolor578{color:#008080} +span#textcolor579{color:#008080} +span#textcolor580{color:#008080} +span#textcolor581{color:#008080} +span#textcolor582{color:#008080} +span#textcolor583{color:#008080} +span#textcolor584{color:#008080} +span#textcolor585{color:#008080} +span#textcolor586{color:#008080} +span#textcolor587{color:#008080} +span#textcolor588{color:#008080} +span#textcolor589{color:#008080} +span#textcolor590{color:#008080} +span#textcolor591{color:#008080} +span#textcolor592{color:#008080} +span#textcolor593{color:#008080} +span#textcolor594{color:#008080} +span#textcolor595{color:#008080} +span#textcolor596{color:#008080} +span#textcolor597{color:#008080} +span#textcolor598{color:#008080} +span#textcolor599{color:#008080} +span#textcolor600{color:#008080} +span#textcolor601{color:#008080} +span#textcolor602{color:#008080} +span#textcolor603{color:#008080} +span#textcolor604{color:#008080} +span#textcolor605{color:#008080} +span#textcolor606{color:#008080} +span#textcolor607{color:#008080} +span#textcolor608{color:#008080} +span#textcolor609{color:#008080} +span#textcolor610{color:#008080} +span#textcolor611{color:#008080} +span#textcolor612{color:#008080} +span#textcolor613{color:#008080} +span#textcolor614{color:#008080} +span#textcolor615{color:#008080} +span#textcolor616{color:#008080} +span#textcolor617{color:#008080} +span#textcolor618{color:#008080} +span#textcolor619{color:#008080} +span#textcolor620{color:#008080} +span#textcolor621{color:#008080} +span#textcolor622{color:#008080} +span#textcolor623{color:#008080} +span#textcolor624{color:#008080} +span#textcolor625{color:#008080} +span#textcolor626{color:#008080} +span#textcolor627{color:#008080} +span#textcolor628{color:#008080} +span#textcolor629{color:#008080} +span#textcolor630{color:#008080} +span#textcolor631{color:#008080} +span#textcolor632{color:#008080} +span#textcolor633{color:#008080} +span#textcolor634{color:#008080} +span#textcolor635{color:#008080} +span#textcolor636{color:#008080} +span#textcolor637{color:#008080} +span#textcolor638{color:#008080} +span#textcolor639{color:#008080} +span#textcolor640{color:#008080} +span#textcolor641{color:#008080} +span#textcolor642{color:#008080} +span#textcolor643{color:#008080} +span#textcolor644{color:#008080} +span#textcolor645{color:#008080} +span#textcolor646{color:#008080} +span#textcolor647{color:#008080} +span#textcolor648{color:#008080} +span#textcolor649{color:#008080} +span#textcolor650{color:#008080} +span#textcolor651{color:#008080} +span#textcolor652{color:#008080} +span#textcolor653{color:#008080} +span#textcolor654{color:#008080} +span#textcolor655{color:#008080} +span#textcolor656{color:#008080} +span#textcolor657{color:#008080} +span#textcolor658{color:#008080} +span#textcolor659{color:#008080} +span#textcolor660{color:#008080} +span#textcolor661{color:#008080} +span#textcolor662{color:#008080} +span#textcolor663{color:#008080} +span#textcolor664{color:#008080} +span#textcolor665{color:#008080} +span#textcolor666{color:#008080} +span#textcolor667{color:#008080} +span#textcolor668{color:#008080} +span#textcolor669{color:#008080} +span#textcolor670{color:#008080} +span#textcolor671{color:#008080} +span#textcolor672{color:#008080} +span#textcolor673{color:#008080} +span#textcolor674{color:#008080} +span#textcolor675{color:#008080} +span#textcolor676{color:#008080} +span#textcolor677{color:#008080} +span#textcolor678{color:#008080} +span#textcolor679{color:#008080} +span#textcolor680{color:#008080} +span#textcolor681{color:#008080} +span#textcolor682{color:#008080} +span#textcolor683{color:#008080} +span#textcolor684{color:#008080} +span#textcolor685{color:#008080} +span#textcolor686{color:#008080} +span#textcolor687{color:#008080} +span#textcolor688{color:#008080} +span#textcolor689{color:#008080} +span#textcolor690{color:#008080} +span#textcolor691{color:#008080} +span#textcolor692{color:#008080} +span#textcolor693{color:#008080} +span#textcolor694{color:#008080} +span#textcolor695{color:#008080} +span#textcolor696{color:#008080} +span#textcolor697{color:#008080} +span#textcolor698{color:#008080} +span#textcolor699{color:#008080} +span#textcolor700{color:#008080} +span#textcolor701{color:#008080} +span#textcolor702{color:#008080} +span#textcolor703{color:#008080} +span#textcolor704{color:#008080} +span#textcolor705{color:#008080} +span#textcolor706{color:#008080} +span#textcolor707{color:#008080} +span#textcolor708{color:#008080} +span#textcolor709{color:#008080} +span#textcolor710{color:#008080} +span#textcolor711{color:#008080} +span#textcolor712{color:#008080} +span#textcolor713{color:#008080} +span#textcolor714{color:#008080} +span#textcolor715{color:#008080} +span#textcolor716{color:#008080} +span#textcolor717{color:#008080} +span#textcolor718{color:#008080} +span#textcolor719{color:#008080} +span#textcolor720{color:#008080} +span#textcolor721{color:#008080} +span#textcolor722{color:#008080} +span#textcolor723{color:#008080} +span#textcolor724{color:#008080} +span#textcolor725{color:#008080} +span#textcolor726{color:#008080} +span#textcolor727{color:#008080} +span#textcolor728{color:#008080} +span#textcolor729{color:#008080} +span#textcolor730{color:#008080} +span#textcolor731{color:#008080} +span#textcolor732{color:#008080} +span#textcolor733{color:#008080} +span#textcolor734{color:#008080} +span#textcolor735{color:#008080} +span#textcolor736{color:#008080} +span#textcolor737{color:#008080} +span#textcolor738{color:#008080} +span#textcolor739{color:#008080} +span#textcolor740{color:#008080} +span#textcolor741{color:#008080} +span#textcolor742{color:#008080} +span#textcolor743{color:#008080} +span#textcolor744{color:#008080} +span#textcolor745{color:#008080} +span#textcolor746{color:#008080} +span#textcolor747{color:#008080} +span#textcolor748{color:#008080} +span#textcolor749{color:#008080} +span#textcolor750{color:#008080} +span#textcolor751{color:#008080} +span#textcolor752{color:#008080} +span#textcolor753{color:#008080} +span#textcolor754{color:#008080} +span#textcolor755{color:#008080} +span#textcolor756{color:#008080} +span#textcolor757{color:#008080} +span#textcolor758{color:#008080} +span#textcolor759{color:#008080} +span#textcolor760{color:#008080} +span#textcolor761{color:#008080} +span#textcolor762{color:#008080} +span#textcolor763{color:#008080} +span#textcolor764{color:#008080} +span#textcolor765{color:#008080} +span#textcolor766{color:#008080} +span#textcolor767{color:#008080} +span#textcolor768{color:#008080} +span#textcolor769{color:#008080} +span#textcolor770{color:#008080} +span#textcolor771{color:#008080} +span#textcolor772{color:#008080} +span#textcolor773{color:#008080} +span#textcolor774{color:#008080} +span#textcolor775{color:#008080} +span#textcolor776{color:#008080} +span#textcolor777{color:#008080} +span#textcolor778{color:#008080} +span#textcolor779{color:#008080} +span#textcolor780{color:#008080} +span#textcolor781{color:#008080} +span#textcolor782{color:#008080} +span#textcolor783{color:#008080} +span#textcolor784{color:#008080} +span#textcolor785{color:#008080} +span#textcolor786{color:#008080} +span#textcolor787{color:#008080} +span#textcolor788{color:#008080} +span#textcolor789{color:#008080} +span#textcolor790{color:#008080} +span#textcolor791{color:#008080} +span#textcolor792{color:#008080} +span#textcolor793{color:#008080} +span#textcolor794{color:#008080} +span#textcolor795{color:#008080} +span#textcolor796{color:#008080} +span#textcolor797{color:#008080} +span#textcolor798{color:#008080} +span#textcolor799{color:#008080} +span#textcolor800{color:#008080} +span#textcolor801{color:#008080} +span#textcolor802{color:#008080} +span#textcolor803{color:#008080} +span#textcolor804{color:#008080} +span#textcolor805{color:#008080} +span#textcolor806{color:#008080} +span#textcolor807{color:#008080} +span#textcolor808{color:#008080} +span#textcolor809{color:#008080} +span#textcolor810{color:#008080} +span#textcolor811{color:#008080} +span#textcolor812{color:#008080} +span#textcolor813{color:#008080} +span#textcolor814{color:#008080} +span#textcolor815{color:#008080} +span#textcolor816{color:#008080} +span#textcolor817{color:#008080} +span#textcolor818{color:#008080} +span#textcolor819{color:#008080} +span#textcolor820{color:#008080} +span#textcolor821{color:#008080} +span#textcolor822{color:#008080} +span#textcolor823{color:#008080} +span#textcolor824{color:#008080} +span#textcolor825{color:#008080} +span#textcolor826{color:#008080} +span#textcolor827{color:#008080} +span#textcolor828{color:#008080} +span#textcolor829{color:#008080} +span#textcolor830{color:#008080} +span#textcolor831{color:#008080} +span#textcolor832{color:#008080} +span#textcolor833{color:#008080} +span#textcolor834{color:#008080} +span#textcolor835{color:#008080} +span#textcolor836{color:#008080} +span#textcolor837{color:#008080} +span#textcolor838{color:#008080} +span#textcolor839{color:#008080} +span#textcolor840{color:#008080} +span#textcolor841{color:#008080} +span#textcolor842{color:#008080} +span#textcolor843{color:#008080} +span#textcolor844{color:#008080} +span#textcolor845{color:#008080} +span#textcolor846{color:#008080} +span#textcolor847{color:#008080} +span#textcolor848{color:#008080} +span#textcolor849{color:#008080} +span#textcolor850{color:#008080} +span#textcolor851{color:#008080} +span#textcolor852{color:#008080} +span#textcolor853{color:#008080} +span#textcolor854{color:#008080} +span#textcolor855{color:#008080} +span#textcolor856{color:#008080} +span#textcolor857{color:#008080} +span#textcolor858{color:#008080} +span#textcolor859{color:#008080} +span#textcolor860{color:#008080} +span#textcolor861{color:#008080} +span#textcolor862{color:#008080} +span#textcolor863{color:#008080} +span#textcolor864{color:#008080} +span#textcolor865{color:#008080} +span#textcolor866{color:#008080} +span#textcolor867{color:#008080} +span#textcolor868{color:#008080} +span#textcolor869{color:#008080} +span#textcolor870{color:#008080} +span#textcolor871{color:#008080} +span#textcolor872{color:#008080} +span#textcolor873{color:#008080} +span#textcolor874{color:#008080} +span#textcolor875{color:#008080} +span#textcolor876{color:#008080} +span#textcolor877{color:#008080} +span#textcolor878{color:#008080} +span#textcolor879{color:#008080} +span#textcolor880{color:#008080} +span#textcolor881{color:#008080} +span#textcolor882{color:#008080} +span#textcolor883{color:#008080} +span#textcolor884{color:#008080} +span#textcolor885{color:#008080} +span#textcolor886{color:#008080} +span#textcolor887{color:#008080} +span#textcolor888{color:#008080} +span#textcolor889{color:#008080} +span#textcolor890{color:#008080} +span#textcolor891{color:#008080} +span#textcolor892{color:#008080} +span#textcolor893{color:#008080} +span#textcolor894{color:#008080} +span#textcolor895{color:#008080} +span#textcolor896{color:#008080} +span#textcolor897{color:#008080} +span#textcolor898{color:#008080} +span#textcolor899{color:#008080} +span#textcolor900{color:#008080} +span#textcolor901{color:#008080} +span#textcolor902{color:#008080} +span#textcolor903{color:#008080} +span#textcolor904{color:#008080} +span#textcolor905{color:#008080} +span#textcolor906{color:#008080} +span#textcolor907{color:#008080} +span#textcolor908{color:#008080} +span#textcolor909{color:#008080} +span#textcolor910{color:#008080} +span#textcolor911{color:#008080} +span#textcolor912{color:#008080} +span#textcolor913{color:#008080} +span#textcolor914{color:#008080} +span#textcolor915{color:#008080} +span#textcolor916{color:#008080} +span#textcolor917{color:#008080} +span#textcolor918{color:#008080} +span#textcolor919{color:#008080} +span#textcolor920{color:#008080} +span#textcolor921{color:#008080} +span#textcolor922{color:#008080} +span#textcolor923{color:#008080} +span#textcolor924{color:#008080} +span#textcolor925{color:#008080} +span#textcolor926{color:#008080} +span#textcolor927{color:#008080} +span#textcolor928{color:#008080} +span#textcolor929{color:#008080} +span#textcolor930{color:#008080} +span#textcolor931{color:#008080} +span#textcolor932{color:#008080} +span#textcolor933{color:#008080} +span#textcolor934{color:#008080} +span#textcolor935{color:#008080} +span#textcolor936{color:#008080} +span#textcolor937{color:#008080} +span#textcolor938{color:#008080} +span#textcolor939{color:#008080} +span#textcolor940{color:#008080} +span#textcolor941{color:#008080} +span#textcolor942{color:#008080} +span#textcolor943{color:#008080} +span#textcolor944{color:#008080} +span#textcolor945{color:#008080} +span#textcolor946{color:#008080} +span#textcolor947{color:#008080} +span#textcolor948{color:#008080} +span#textcolor949{color:#008080} +span#textcolor950{color:#008080} +span#textcolor951{color:#008080} +span#textcolor952{color:#008080} +span#textcolor953{color:#008080} +span#textcolor954{color:#008080} +span#textcolor955{color:#008080} +span#textcolor956{color:#008080} +span#textcolor957{color:#008080} +span#textcolor958{color:#008080} +span#textcolor959{color:#008080} +span#textcolor960{color:#008080} +span#textcolor961{color:#008080} +span#textcolor962{color:#008080} +span#textcolor963{color:#008080} +span#textcolor964{color:#008080} +span#textcolor965{color:#008080} +span#textcolor966{color:#008080} +span#textcolor967{color:#008080} +span#textcolor968{color:#008080} +span#textcolor969{color:#008080} +span#textcolor970{color:#008080} +span#textcolor971{color:#008080} +span#textcolor972{color:#008080} +span#textcolor973{color:#008080} +span#textcolor974{color:#008080} +span#textcolor975{color:#008080} +span#textcolor976{color:#008080} +span#textcolor977{color:#008080} +span#textcolor978{color:#008080} +span#textcolor979{color:#008080} +span#textcolor980{color:#008080} +span#textcolor981{color:#008080} +span#textcolor982{color:#008080} +span#textcolor983{color:#008080} +span#textcolor984{color:#008080} +span#textcolor985{color:#008080} +span#textcolor986{color:#008080} +span#textcolor987{color:#008080} +span#textcolor988{color:#008080} +span#textcolor989{color:#008080} +span#textcolor990{color:#008080} +span#textcolor991{color:#008080} +span#textcolor992{color:#008080} +span#textcolor993{color:#008080} +span#textcolor994{color:#008080} +span#textcolor995{color:#008080} +span#textcolor996{color:#008080} +span#textcolor997{color:#008080} +span#textcolor998{color:#008080} +span#textcolor999{color:#008080} +span#textcolor1000{color:#008080} +span#textcolor1001{color:#008080} +span#textcolor1002{color:#008080} +span#textcolor1003{color:#008080} +span#textcolor1004{color:#008080} +span#textcolor1005{color:#008080} +span#textcolor1006{color:#008080} +span#textcolor1007{color:#008080} +span#textcolor1008{color:#008080} +span#textcolor1009{color:#008080} +span#textcolor1010{color:#008080} +span#textcolor1011{color:#008080} +span#textcolor1012{color:#008080} +span#textcolor1013{color:#008080} +span#textcolor1014{color:#008080} +span#textcolor1015{color:#008080} +span#textcolor1016{color:#008080} +span#textcolor1017{color:#008080} +span#textcolor1018{color:#008080} +span#textcolor1019{color:#008080} +span#textcolor1020{color:#008080} +span#textcolor1021{color:#008080} +span#textcolor1022{color:#008080} +span#textcolor1023{color:#008080} +span#textcolor1024{color:#008080} +span#textcolor1025{color:#008080} +span#textcolor1026{color:#008080} +span#textcolor1027{color:#008080} +span#textcolor1028{color:#008080} +span#textcolor1029{color:#008080} +span#textcolor1030{color:#008080} +span#textcolor1031{color:#008080} +span#textcolor1032{color:#008080} +span#textcolor1033{color:#008080} +span#textcolor1034{color:#008080} +span#textcolor1035{color:#008080} +span#textcolor1036{color:#008080} +span#textcolor1037{color:#008080} +span#textcolor1038{color:#008080} +span#textcolor1039{color:#008080} +span#textcolor1040{color:#008080} +span#textcolor1041{color:#008080} +span#textcolor1042{color:#008080} +span#textcolor1043{color:#008080} +span#textcolor1044{color:#008080} +span#textcolor1045{color:#008080} +span#textcolor1046{color:#008080} +span#textcolor1047{color:#008080} +span#textcolor1048{color:#008080} +span#textcolor1049{color:#008080} +span#textcolor1050{color:#008080} +span#textcolor1051{color:#008080} +span#textcolor1052{color:#008080} +span#textcolor1053{color:#008080} +span#textcolor3{color:#008080} /* end css.sty */ @@ -302,193 +1297,191 @@ span#textcolor62{color:#00FF00} </style> </head><body > -<!--l. 458--><p class="noindent" ><a +<!--l. 679--><p class="noindent" ><a id="top"></a> -</p><!--l. 458--><p class="indent" > - - -</p><!--l. 458--><p class="indent" > - - +</p><!--l. 679--><p class="indent" > + + +</p><!--l. 679--><p class="indent" > + + </p> <div class="center" > -<!--l. 458--><p class="noindent" > -</p><!--l. 458--><p class="noindent" ><span -class="cmr-17">User Manual for glossaries.sty v4.44</span> +<!--l. 679--><p class="noindent" > +</p><!--l. 679--><p class="noindent" ><span +class="cmr-17">User Manual for glossaries.sty v4.45</span> </p> <div class="tabular"> <table id="TBL-1" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-1-1g"><col id="TBL-1-1" /></colgroup><tr style="vertical-align:baseline;" id="TBL-1-1-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-1-1" -class="td11"> <span -class="cmr-12">Nicola L.C. Talbot </span></td> +class="td11"> <span +class="cmr-12">Nicola L.C. Talbot </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-1-2-"><td style="white-space:nowrap; text-align:center;" id="TBL-1-2-1" class="td11"> <a -href="http://www.dickimaw-books.com/" class="url" ><span -class="cmtt-12">http://www.dickimaw-books.com/</span></a> </td></tr></table> +href="http://www.dickimaw-books.com/contact" ><span +class="cmtt-12">dickimaw-books.com/contact</span></a> </td></tr></table> </div> -<!--l. 458--><p class="noindent" ><span -class="cmr-12">2019-12-06</span></p></div> +<!--l. 679--><p class="noindent" ><span +class="cmr-12">2020-02-13</span></p></div> <div class="abstract" > -<!--l. 460--><p class="indent" > - - +<!--l. 681--><p class="indent" > + + </p> <div class="center" > -<!--l. 460--><p class="noindent" > -</p><!--l. 460--><p class="noindent" ><span +<!--l. 681--><p class="noindent" > +</p><!--l. 681--><p class="noindent" ><span class="cmbx-10">Abstract</span></p></div> -<!--l. 461--><p class="noindent" >The <span -class="cmss-10">glossaries </span>package provides a means to define terms or abbreviations or symbols that can be -referenced within your document. Sorted lists with collated <a -href="#glo:entrylocation">locations</a> can be generated either -using <span class="TEX">T<span -class="E">E</span>X</span> or using a supplementary <a -href="#glo:indexingapp">indexing application</a>. -</p><!--l. 466--><p class="indent" > Additional features not provided here may be available through the extension package -<a +<!--l. 682--><p class="noindent" >The <span +class="cmss-10">glossaries </span>package provides a means to define terms or abbreviations or symbols that can be referenced within +your document. Sorted lists with collated <a +href="#glo:entrylocation">locations</a> can be generated either using <span class="TEX">T<span +class="E">E</span>X</span> or using a +supplementary <a +href="#glo:indexingapp">indexing application</a>. Sample documents are provided with the <span +class="cmss-10">glossaries </span>package. These are +listed in <a +href="#sec:samples">§19 </a><a +href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>. +</p><!--l. 688--><p class="indent" > + + +</p> + </div> +<!--l. 690--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> Additional features not provided here may be available through the extension package <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> which, if required, needs to be installed separately. New features will be added -to <span -class="cmss-10">glossaries-extra</span>. Versions of the <span -class="cmss-10">glossaries </span>package after v4.21 will mostly be just bug fixes. -Note that <a +class="cmss-10">glossaries-extra</span></a> which, +if required, needs to be installed separately. New features will be added to <span +class="cmss-10">glossaries-extra</span>. Versions of the +<span +class="cmss-10">glossaries </span>package after v4.21 will mostly be just bug fixes or minor maintenance. Note that <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> provides an extra indexing option (<a +class="cmss-10">glossaries-extra</span></a> +provides an extra indexing option (<a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-2"></a></a>) which isn’t available -with just the base <span -class="cmss-10">glossaries</span><a - id="dx1-3"></a> package. -</p><!--l. 474--><p class="indent" > - - -</p> - </div> -<!--l. 476--><p class="indent" > If you require multilingual support you must also separately install the relevant language -module. Each language module is distributed under the name <span + id="dx1-2"></a></a>) which isn’t available with just the base <span +class="cmss-10">glossaries </span>package. +</div> +</p><!--l. 698--><p class="noindent" > +</p><!--l. 700--><p class="indent" > If you require multilingual support you must also separately install the relevant language module. Each +language module is distributed under the name <span class="cmtt-10">glossaries-</span>⟨<span -class="cmti-10">language</span>⟩, -where ⟨<span -class="cmti-10">language</span>⟩ is the root language name. For example, <span -class="cmtt-10">glossaries-french </span>or -<span +class="cmti-10">language</span>⟩, where ⟨<span +class="cmti-10">language</span>⟩ is the root language +name. For example, <span +class="cmtt-10">glossaries-french </span>or <span class="cmtt-10">glossaries-german</span>. If a language module is required, the <span -class="cmss-10">glossaries </span>package will -automatically try to load it and will give a warning if the module isn’t found. See <a -href="#sec:languages"><span -class="tcrm-1000">§</span>1.4 -</a><a -href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> for further details. If there isn’t any support available for your -language, use the <span +class="cmss-10">glossaries</span> +package will automatically try to load it and will give a warning if the module isn’t found. See <a +href="#sec:languages">§1.3 </a><a +href="#sec:languages">Multi-Lingual +Support<!--tex4ht:ref: sec:languages --></a> for further details. If there isn’t any support available for your language, use the <span class="cmss-10">nolangwarn</span><a - id="dx1-4"></a> package option to suppress the warning and provide your own -translations. (For example, use the <span -class="cmss-10">title</span><a - id="dx1-5"></a> key in <span -class="cmtt-10">\printglossary</span>.) -</p><!--l. 489--><p class="indent" > The <span -class="cmss-10">glossaries </span>package requires a number of other packages including, but not limited to, + id="dx1-3"></a> package +option to suppress the warning and provide your own translations. (For example, use the <span +class="cmtt-10">title</span><a + id="dx1-4"></a> key in <span +class="cmtt-10">\printglossary</span>.) +</p><!--l. 713--><p class="indent" > The <span +class="cmss-10">glossaries </span>package requires a number of other packages including, but not limited to, <span class="cmss-10">tracklang</span><a - id="dx1-6"></a>, <span + id="dx1-5"></a>, <span class="cmss-10">mfirstuc</span><a - id="dx1-7"></a>, <span + id="dx1-6"></a>, +<span class="cmss-10">etoolbox</span><a - id="dx1-8"></a>, <span + id="dx1-7"></a>, <span class="cmss-10">xkeyval</span><a - id="dx1-9"></a> (at least version dated 2006/11/18), <span + id="dx1-8"></a> (at least version dated 2006/11/18), <span class="cmss-10">textcase</span><a - id="dx1-10"></a>, <span + id="dx1-9"></a>, <span class="cmss-10">xfor</span><a - id="dx1-11"></a>, -<span + id="dx1-10"></a>, <span class="cmss-10">datatool-base</span><a - id="dx1-12"></a> (part of the <span + id="dx1-11"></a> (part of the <span class="cmss-10">datatool</span><a - id="dx1-13"></a> bundle) and <span + id="dx1-12"></a> bundle) +and <span class="cmss-10">amsgen</span><a - id="dx1-14"></a>. These packages are all available in the -latest <span class="TEX">T<span + id="dx1-13"></a>. These packages are all available in the latest <span class="TEX">T<span class="E">E</span>X</span> Live and Mik<span class="TEX">T<span -class="E">E</span>X</span> distributions. If any of them are missing, please update your -<span class="TEX">T<span -class="E">E</span>X</span> distribution using your update manager. For help on this see, for example, -<a +class="E">E</span>X</span> distributions. If any of them +are missing, please update your <span class="TEX">T<span +class="E">E</span>X</span> distribution using your update manager. For help on this +see, for example, <a href="http://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution" >How do I update my <span class="TEX">T<span class="E">E</span>X</span> distribution?</a> or (for Linux users) <a href="http://tex.stackexchange.com/questions/14925/updating-tex-on-linux" >Updating <span class="TEX">T<span class="E">E</span>X</span> on Linux</a>. -</p><!--l. 504--><p class="indent" > Note that occasionally you may find that certain packages need to be loaded <span -class="cmti-10">after</span> -packages that are required by <span +</p><!--l. 728--><p class="indent" > Note that occasionally you may find that certain packages need to be loaded <span +class="cmti-10">after </span>packages that are required +by <span class="cmss-10">glossaries</span>. For example, a package ⟨<span -class="cmti-10">X</span>⟩ might need to be loaded -after <span +class="cmti-10">X</span>⟩ might need to be loaded after <span class="cmss-10">amsgen</span><a - id="dx1-15"></a>. In which case, load the required package first (for example, <span + id="dx1-14"></a>. In which case, load the required +package first (for example, <span class="cmss-10">amsgen</span><a - id="dx1-16"></a>), then ⟨<span -class="cmti-10">X</span>⟩, -and finally load <span + id="dx1-15"></a>), then ⟨<span +class="cmti-10">X</span>⟩, and finally load <span class="cmss-10">glossaries</span>. -</p><!--l. 510--><p class="indent" > <div class="important" title="Important Note"> Documents have wide-ranging styles when it comes to presenting glossaries or lists of -terms or notation. People have their own preferences and to a large extent this -is determined by the kind of information that needs to go in the glossary. They -may just have symbols with terse descriptions or they may have long technical -words with complicated descriptions. The <span -class="cmss-10">glossaries </span>package is flexible enough to -accommodate such varied requirements, but this flexibility comes at a price: a big +</p><!--l. 734--><p class="indent" > <div class="important" title="Important Note"> Documents have wide-ranging styles when it comes to presenting glossaries or lists of terms or +notation. People have their own preferences and to a large extent this is determined by the kind of +information that needs to go in the glossary. They may just have symbols with terse descriptions +or they may have long technical words with complicated descriptions. The <span +class="cmss-10">glossaries </span>package is +flexible enough to accommodate such varied requirements, but this flexibility comes at a price: a big manual. -</p><!--l. 520--><p class="indent" > 😱 If you’re freaking out at the size of this manual, start with <span -class="cmtt-10">glossariesbegin.pdf </span>(“The -glossaries package: a guide for beginnners”). You should find it in the same directory as this -document or try <span -class="cmtt-10">texdoc glossariesbegin.pdf</span>. Once you’ve got to grips with -the basics, then come back to this manual to find out how to adjust the settings. -</div> -</p><!--l. 526--><p class="noindent" > -</p><!--l. 528--><p class="noindent" >The <span +</p><!--l. 744--><p class="indent" > 😱 If you’re freaking out at the size of this manual, start with <span +class="cmtt-10">glossariesbegin.pdf </span>(“The glossaries package: +a guide for beginnners”). You should find it in the same directory as this document or try <span +class="cmtt-10">texdoc</span> +<span +class="cmtt-10">glossariesbegin.pdf</span>. Once you’ve got to grips with the basics, then come back to this manual to find out how +to adjust the settings. </div> +</p><!--l. 750--><p class="noindent" > +</p><!--l. 752--><p class="noindent" >The <span class="cmss-10">glossaries </span>bundle comes with the following documentation: </p><dl class="description"><dt class="description"> <a href="glossariesbegin.pdf" class="url" ><span class="cmtt-10">glossariesbegin.pdf</span></a> </dt><dd -class="description">If you are a complete beginner, start with <a -href="glossariesbegin.html" >“The glossaries - package: a guide for beginners”</a>. +class="description">If you are a complete beginner, start with <a +href="glossariesbegin.html" >“The glossaries package: a guide for + beginners”</a>. </dd><dt class="description"> <a href="glossary2glossaries.pdf" class="url" ><span class="cmtt-10">glossary2glossaries.pdf</span></a> </dt><dd class="description">If you are moving over from the obsolete <span class="cmss-10">glossary</span><a - id="dx1-17"></a> package, - read <a -href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a>. + id="dx1-16"></a> package, read <a +href="glossary2glossaries.html" >“Upgrading + from the glossary package to the glossaries package”</a>. + + </dd><dt class="description"> <span class="cmbx-10">glossaries-user.pdf</span> </dt><dd class="description">This document is the main user guide for the <span class="cmss-10">glossaries </span>package. - - </dd><dt class="description"> <a href="glossaries-code.pdf" class="url" ><span class="cmtt-10">glossaries-code.pdf</span></a> </dt><dd -class="description">Advanced users wishing to know more about the inner workings - of all the packages provided in the <span -class="cmss-10">glossaries </span>bundle should read “Documented - Code for glossaries v4.44”. +class="description">Advanced users wishing to know more about the inner workings of all the + packages provided in the <span +class="cmss-10">glossaries </span>bundle should read “Documented Code for glossaries v4.45”. </dd><dt class="description"> <span class="cmbx-10">INSTALL</span> </dt><dd @@ -499,44 +1492,43 @@ class="cmbx-10">CHANGES</span> </dt><dd class="description">Change log. </dd><dt class="description"> <span -class="cmbx-10">README</span> </dt><dd +class="cmbx-10">README.md</span> </dt><dd class="description">Package summary. </dd></dl> -<!--l. 557--><p class="noindent" >Related resources: </p> +<!--l. 781--><p class="noindent" >Related resources: </p> <ul class="itemize1"> - <li class="itemize"><span -class="cmss-10">glossaries-extra </span>and <a -href="#glo:bib2gls"><span -class="cmtt-10">bib2gls</span><a - id="dx1-18"></a></a>: An Introductory Guide. (<a + <li class="itemize"><a href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span -class="cmtt-10">bib2gls-begin.pdf</span></a>). +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory Guide</a>. </li> <li class="itemize"><a href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" ><span class="cmss-10">glossaries </span>FAQ</a> </li> <li class="itemize"><a -href="http://www.dickimaw-books.com/gallery/#glossaries" ><span -class="cmss-10">glossaries </span>gallery</a> +href="https://www.dickimaw-books.com/gallery/#glossaries" ><span +class="cmtt-10">https://www.dickimaw-books.com/gallery/#glossaries</span></a><span +class="cmss-10">glossaries </span>gallery </li> <li class="itemize"><a -href="http://www.dickimaw-books.com/gallery/glossaries-styles/" >a summary of all glossary styles provided by <span -class="cmss-10">glossaries</span></a> +href="https://www.dickimaw-books.com/gallery/glossaries-styles/" >a summary of all glossary styles provided by <span +class="cmss-10">glossaries </span>and <span +class="cmss-10">glossaries-extra</span></a> </li> <li class="itemize"><a -href="http://www.dickimaw-books.com/gallery/glossaries-performance.shtml" ><span -class="cmss-10">glossaries </span>performance</a> (comparing document build times for the different options - provided by <span -class="cmss-10">glossaries </span>and <span -class="cmss-10">glossaries-extra</span>). +href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml" ><span +class="cmss-10">glossaries </span>performance</a> (comparing document build times for the different options provided by + <span +class="cmss-10">glossaries </span>and <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>). </li> <li class="itemize"><a href="http://www.dickimaw-books.com/latex/thesis/" >Using LaTeX to Write a PhD Thesis</a> (chapter 6). </li> <li class="itemize"><a -href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document - build</a> +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build</a> </li> <li class="itemize">The <a href="http://ctan.org/pkg/glossaries-extra" ><span @@ -545,56 +1537,64 @@ class="cmss-10">glossaries-extra </span>package</a> <li class="itemize"><a href="http://ctan.org/pkg/bib2gls" ><span class="cmtt-10">bib2gls</span></a></li></ul> -<!--l. 590--><p class="indent" > <div class="important" title="Important Note"> If you use <span +<!--l. 811--><p class="indent" > <div class="important" title="Important Note"><span class="warningsymbol">⚠</span> If you use <span class="cmss-10">hyperref</span><a - id="dx1-19"></a> and <span + id="dx1-17"></a> and <span class="cmss-10">glossaries</span>, you must load <span class="cmss-10">hyperref</span><a - id="dx1-20"></a> <span -class="cmti-10">first</span>. Similarly the <span + id="dx1-18"></a> <span +class="cmti-10">first </span>(although <span +class="cmss-10">hyperref</span><a + id="dx1-19"></a> should be loaded after +most other packages). Similarly the <span class="cmss-10">doc</span><a - id="dx1-21"></a> package -must also be loaded before <span + id="dx1-20"></a> package must also be loaded before <span class="cmss-10">glossaries</span>. (If <span class="cmss-10">doc</span><a - id="dx1-22"></a> is loaded, the file extensions for the default main -glossary are changed to <span + id="dx1-21"></a> is loaded, the file +extensions for the default main glossary are changed to <span class="cmtt-10">gls2</span><a - id="dx1-23"></a>, <span + id="dx1-22"></a>, <span class="cmtt-10">glo2</span><a - id="dx1-24"></a> and <span -class="cmtt-10">.glg2</span><a - id="dx1-25"></a> to avoid conflict with <span + id="dx1-23"></a> and <span +class="cmtt-10">glg2</span><a + id="dx1-24"></a> to avoid conflict with <span class="cmss-10">doc</span><a - id="dx1-26"></a>’s changes + id="dx1-25"></a>’s changes glossary.)<a id="pdflatexnote"></a> - - -</p><!--l. 599--><p class="indent" > If you are using <span + + +</p><!--l. 821--><p class="indent" > If you are using <span class="cmss-10">hyperref</span><a - id="dx1-27"></a>, it’s best to use <span + id="dx1-26"></a>, it’s best to use <span class="cmtt-10">pdflatex</span><a - id="dx1-28"></a> rather than <span + id="dx1-27"></a> rather than <span class="cmtt-10">latex</span><a - id="dx1-29"></a> (DVI format) as -<span -class="cmtt-10">pdflatex </span>deals with hyperlinks much better. If you use the DVI format, you will encounter -problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is -an issue with the DVI format not with <span -class="cmss-10">glossaries</span>. If you really need to use the DVI format and -have a problem with hyperlinks in maths mode, I recommend you use <a + id="dx1-28"></a> (DVI format) as <span +class="cmtt-10">pdflatex </span>deals with +hyperlinks much better. If you use the DVI format, you will encounter problems where you have long hyperlinks +or hyperlinks in subscripts or superscripts. This is an issue with the DVI format not with <span +class="cmss-10">glossaries</span>. If you really +need to use the DVI format and have a problem with hyperlinks in maths mode, I recommend you use +<a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> with the -<span -class="cmtt-10">hyperoutside </span>and <span -class="cmtt-10">textformat </span>attributes set to appropriate values for problematic entries. -</div> -</p><!--l. 609--><p class="noindent" > - - - - +class="cmss-10">glossaries-extra</span></a> with the <span id="textcolor1"><span +class="cmss-10">hyperoutside</span></span><a + id="dx1-29"></a> and <span id="textcolor2"><span +class="cmss-10">textformat</span></span><a + id="dx1-30"></a> attributes set to appropriate values for problematic entries. +</div> +</p><!--l. 831--><p class="noindent" > +</p><!--l. 834--><p class="indent" > <strong>The <span +class="cmss-10">glossaries </span>package replaces the <span +class="cmss-10">glossary </span>package which is now obsolete.</strong> Please see the document +<a +href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> for assistance in upgrading. + + + + </p> <h2 class="likechapterHead"><a id="x1-1000"></a>Contents</h2> @@ -606,187 +1606,219 @@ href="#sec:intro" id="QQ2-1-5">Introduction</a></span> <br />  <span class="sectionToc" >1.1 <a href="#sec:indexingoptions" id="QQ2-1-6">Indexing Options</a></span> <br />  <span class="sectionToc" >1.2 <a -href="#sec:samples" id="QQ2-1-13">Sample Documents</a></span> -<br />  <span class="sectionToc" >1.3 <a href="#sec:lipsum" id="QQ2-1-14">Dummy Entries for Testing</a></span> -<br />  <span class="sectionToc" >1.4 <a +<br />  <span class="sectionToc" >1.3 <a href="#sec:languages" id="QQ2-1-15">Multi-Lingual Support</a></span> -<br />   <span class="subsectionToc" >1.4.1 <a +<br />   <span class="subsectionToc" >1.3.1 <a href="#sec:fixednames" id="QQ2-1-16">Changing the Fixed Names</a></span> -<br />  <span class="sectionToc" >1.5 <a +<br />  <span class="sectionToc" >1.4 <a href="#sec:makeglossaries" id="QQ2-1-19">Generating the Associated Glossary Files</a></span> -<br />   <span class="subsectionToc" >1.5.1 <a +<br />   <span class="subsectionToc" >1.4.1 <a href="#sec:makeglossariesapp" id="QQ2-1-21">Using the makeglossaries Perl Script</a></span> -<br />   <span class="subsectionToc" >1.5.2 <a +<br />   <span class="subsectionToc" >1.4.2 <a href="#sec:makeglossarieslua" id="QQ2-1-22">Using the makeglossaries-lite Lua Script</a></span> -<br />   <span class="subsectionToc" >1.5.3 <a +<br />   <span class="subsectionToc" >1.4.3 <a href="#sec:xindyapp" id="QQ2-1-23">Using xindy explicitly (Option 3)</a></span> -<br />   <span class="subsectionToc" >1.5.4 <a +<br />   <span class="subsectionToc" >1.4.4 <a href="#sec:makeindexapp" id="QQ2-1-24">Using makeindex explicitly (Option 2)</a></span> -<br />   <span class="subsectionToc" >1.5.5 <a +<br />  <span class="sectionToc" >1.5 <a href="#sec:notedev" id="QQ2-1-25">Note to Front-End and Script Developers</a></span> +<br />   <span class="subsectionToc" >1.5.1 <a +href="#sec:notedev.makeindex.xindy" id="QQ2-1-26">MakeIndex and Xindy</a></span> +<br />   <span class="subsectionToc" >1.5.2 <a +href="#sec:notedev.labels" id="QQ2-1-27">Entry Labels</a></span> +<br />   <span class="subsectionToc" >1.5.3 <a +href="#sec:notedev.bib2gls" id="QQ2-1-28">Bib2Gls</a></span> <br /> <span class="chapterToc" >2 <a -href="#sec:pkgopts" id="QQ2-1-26">Package Options</a></span> +href="#sec:pkgopts" id="QQ2-1-29">Package Options</a></span> <br />  <span class="sectionToc" >2.1 <a -href="#sec:pkgopts-general" id="QQ2-1-27">General Options</a></span> +href="#sec:pkgopts-general" id="QQ2-1-30">General Options</a></span> <br />  <span class="sectionToc" >2.2 <a -href="#sec:pkgopts-sec" id="QQ2-1-28">Sectioning, Headings and TOC Options</a></span> +href="#sec:pkgopts-sec" id="QQ2-1-42">Sectioning, Headings and TOC Options</a></span> <br />  <span class="sectionToc" >2.3 <a -href="#sec:pkgopts-printglos" id="QQ2-1-29">Glossary Appearance Options</a></span> +href="#sec:pkgopts-printglos" id="QQ2-1-48">Glossary Appearance Options</a></span> <br />  <span class="sectionToc" >2.4 <a -href="#sec:pkgopts-sort" id="QQ2-1-30">Sorting Options</a></span> +href="#sec:pkgopts-indexing" id="QQ2-1-65">Indexing Options</a></span> <br />  <span class="sectionToc" >2.5 <a -href="#sec:pkgopts-acronym" id="QQ2-1-31">Acronym Options</a></span> -<br />   <span class="subsectionToc" >2.5.1 <a -href="#sec:pkgopts-old-acronym" id="QQ2-1-32">Deprecated Acronym Style Options</a></span> +href="#sec:pkgopts-sort" id="QQ2-1-75">Sorting Options</a></span> <br />  <span class="sectionToc" >2.6 <a -href="#sec:pkgopts-other" id="QQ2-1-33">Other Options</a></span> +href="#sec:pkgopts-type" id="QQ2-1-86">Glossary Type Options</a></span> <br />  <span class="sectionToc" >2.7 <a -href="#sec:setupglossaries" id="QQ2-1-34">Setting Options After the Package is Loaded</a></span> +href="#sec:pkgopts-acronym" id="QQ2-1-93">Acronym and Abbreviation Options</a></span> +<br />   <span class="subsectionToc" >2.7.1 <a +href="#sec:pkgopts-old-acronym" id="QQ2-1-99">Deprecated Acronym Style Options</a></span> +<br />  <span class="sectionToc" >2.8 <a +href="#sec:pkgopts-other" id="QQ2-1-105">Other Options</a></span> +<br />  <span class="sectionToc" >2.9 <a +href="#sec:setupglossaries" id="QQ2-1-112">Setting Options After the Package is Loaded</a></span> <br /> <span class="chapterToc" >3 <a -href="#sec:setup" id="QQ2-1-35">Setting Up</a></span> +href="#sec:setup" id="QQ2-1-113">Setting Up</a></span> <br />  <span class="sectionToc" >3.1 <a -href="#sec:setupopt1" id="QQ2-1-36">Option 1</a></span> +href="#sec:setupopt1" id="QQ2-1-114">Option 1</a></span> <br />  <span class="sectionToc" >3.2 <a -href="#sec:setupopt23" id="QQ2-1-37">Options 2 and 3</a></span> +href="#sec:setupopt23" id="QQ2-1-115">Options 2 and 3</a></span> <br /> <span class="chapterToc" >4 <a -href="#sec:newglosentry" id="QQ2-1-38">Defining Glossary Entries</a></span> +href="#sec:newglosentry" id="QQ2-1-116">Defining Glossary Entries</a></span> <br />  <span class="sectionToc" >4.1 <a -href="#sec:plurals" id="QQ2-1-39">Plurals</a></span> +href="#sec:plurals" id="QQ2-1-117">Plurals</a></span> <br />  <span class="sectionToc" >4.2 <a -href="#sec:grammar" id="QQ2-1-40">Other Grammatical Constructs</a></span> +href="#sec:grammar" id="QQ2-1-118">Other Grammatical Constructs</a></span> <br />  <span class="sectionToc" >4.3 <a -href="#sec:addkey" id="QQ2-1-41">Additional Keys</a></span> +href="#sec:addkey" id="QQ2-1-119">Additional Keys</a></span> <br />   <span class="subsectionToc" >4.3.1 <a -href="#sec:glsaddkey" id="QQ2-1-42">Document Keys</a></span> +href="#sec:glsaddkey" id="QQ2-1-120">Document Keys</a></span> <br />   <span class="subsectionToc" >4.3.2 <a -href="#sec:glsaddstoragekey" id="QQ2-1-43">Storage Keys</a></span> +href="#sec:glsaddstoragekey" id="QQ2-1-121">Storage Keys</a></span> + + <br />  <span class="sectionToc" >4.4 <a -href="#sec:expansion" id="QQ2-1-44">Expansion</a></span> +href="#sec:expansion" id="QQ2-1-122">Expansion</a></span> <br />  <span class="sectionToc" >4.5 <a -href="#sec:subentries" id="QQ2-1-46">Sub-Entries</a></span> +href="#sec:subentries" id="QQ2-1-124">Sub-Entries</a></span> <br />   <span class="subsectionToc" >4.5.1 <a -href="#sec:hierarchical" id="QQ2-1-47">Hierarchical Categories</a></span> +href="#sec:hierarchical" id="QQ2-1-125">Hierarchical Categories</a></span> <br />   <span class="subsectionToc" >4.5.2 <a -href="#sec:homographs" id="QQ2-1-48">Homographs</a></span> - - +href="#sec:homographs" id="QQ2-1-126">Homographs</a></span> <br />  <span class="sectionToc" >4.6 <a -href="#sec:loadglsentries" id="QQ2-1-49">Loading Entries From a File</a></span> +href="#sec:loadglsentries" id="QQ2-1-127">Loading Entries From a File</a></span> <br />  <span class="sectionToc" >4.7 <a -href="#sec:moveentry" id="QQ2-1-50">Moving Entries to Another Glossary</a></span> +href="#sec:moveentry" id="QQ2-1-128">Moving Entries to Another Glossary</a></span> <br />  <span class="sectionToc" >4.8 <a -href="#sec:docdefs" id="QQ2-1-51">Drawbacks With Defining Entries in the Document Environment</a></span> +href="#sec:docdefs" id="QQ2-1-129">Drawbacks With Defining Entries in the Document Environment</a></span> <br />   <span class="subsectionToc" >4.8.1 <a -href="#sec:techissues" id="QQ2-1-52">Technical Issues</a></span> +href="#sec:techissues" id="QQ2-1-130">Technical Issues</a></span> <br />   <span class="subsectionToc" >4.8.2 <a -href="#sec:goodpractice" id="QQ2-1-53">Good Practice Issues</a></span> +href="#sec:goodpractice" id="QQ2-1-131">Good Practice Issues</a></span> <br /> <span class="chapterToc" >5 <a -href="#sec:numberlists" id="QQ2-1-54">Number lists</a></span> +href="#sec:numberlists" id="QQ2-1-132">Number lists</a></span> <br />  <span class="sectionToc" >5.1 <a -href="#sec:encap" id="QQ2-1-55">Encap Values</a></span> +href="#sec:encap" id="QQ2-1-133">Encap Values</a></span> <br />  <span class="sectionToc" >5.2 <a -href="#sec:locationsyntax" id="QQ2-1-56">Locations</a></span> +href="#sec:locationsyntax" id="QQ2-1-134">Locations</a></span> <br />  <span class="sectionToc" >5.3 <a -href="#sec:ranges" id="QQ2-1-57">Range Formations</a></span> +href="#sec:ranges" id="QQ2-1-135">Range Formations</a></span> <br />  <span class="sectionToc" >5.4 <a -href="#sec:isthook" id="QQ2-1-58">Style Hook</a></span> +href="#sec:isthook" id="QQ2-1-136">Style Hook</a></span> <br /> <span class="chapterToc" >6 <a -href="#sec:glslink" id="QQ2-1-59">Links to Glossary Entries</a></span> +href="#sec:glslink" id="QQ2-1-137">Links to Glossary Entries</a></span> <br />  <span class="sectionToc" >6.1 <a -href="#sec:gls-like" id="QQ2-1-61">The <span +href="#sec:gls-like" id="QQ2-1-139">The <span class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</a></span> <br />  <span class="sectionToc" >6.2 <a -href="#sec:glstext-like" id="QQ2-1-62">The <span +href="#sec:glstext-like" id="QQ2-1-140">The <span class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)</a></span> <br />  <span class="sectionToc" >6.3 <a -href="#sec:glsdisplay" id="QQ2-1-63">Changing the format of the link text</a></span> +href="#sec:glsdisplay" id="QQ2-1-141">Changing the format of the link text</a></span> <br />  <span class="sectionToc" >6.4 <a -href="#sec:disablehyperlinks" id="QQ2-1-64">Enabling and disabling hyperlinks to glossary entries</a></span> +href="#sec:disablehyperlinks" id="QQ2-1-142">Enabling and disabling hyperlinks to glossary entries</a></span> <br /> <span class="chapterToc" >7 <a -href="#sec:glsadd" id="QQ2-1-65">Adding an Entry to the Glossary Without Generating Text</a></span> +href="#sec:glsadd" id="QQ2-1-143">Adding an Entry to the Glossary Without Generating Text</a></span> <br /> <span class="chapterToc" >8 <a -href="#sec:crossref" id="QQ2-1-66">Cross-Referencing Entries</a></span> +href="#sec:crossref" id="QQ2-1-144">Cross-Referencing Entries</a></span> <br />  <span class="sectionToc" >8.1 <a -href="#sec:customxr" id="QQ2-1-67">Customising Cross-reference Text</a></span> +href="#sec:customxr" id="QQ2-1-145">Customising Cross-reference Text</a></span> <br /> <span class="chapterToc" >9 <a -href="#sec:glsnolink" id="QQ2-1-68">Using Glossary Terms Without Links</a></span> +href="#sec:glsnolink" id="QQ2-1-146">Using Glossary Terms Without Links</a></span> <br /> <span class="chapterToc" >10 <a -href="#sec:printglossary" id="QQ2-1-69">Displaying a glossary</a></span> +href="#sec:printglossary" id="QQ2-1-147">Displaying a glossary</a></span> <br /> <span class="chapterToc" >11 <a -href="#sec:xindy" id="QQ2-1-70">Xindy (Option 3)</a></span> +href="#sec:xindy" id="QQ2-1-148">Xindy (Option 3)</a></span> <br />  <span class="sectionToc" >11.1 <a -href="#sec:langenc" id="QQ2-1-71">Language and Encodings</a></span> +href="#sec:langenc" id="QQ2-1-149">Language and Encodings</a></span> <br />  <span class="sectionToc" >11.2 <a -href="#sec:xindyloc" id="QQ2-1-72">Locations and Number lists</a></span> +href="#sec:xindyloc" id="QQ2-1-150">Locations and Number lists</a></span> <br />  <span class="sectionToc" >11.3 <a -href="#sec:groups" id="QQ2-1-73">Glossary Groups</a></span> +href="#sec:groups" id="QQ2-1-151">Glossary Groups</a></span> <br /> <span class="chapterToc" >12 <a -href="#sec:newglossary" id="QQ2-1-74">Defining New Glossaries</a></span> +href="#sec:newglossary" id="QQ2-1-152">Defining New Glossaries</a></span> <br /> <span class="chapterToc" >13 <a -href="#sec:acronyms" id="QQ2-1-75">Acronyms and Other Abbreviations</a></span> +href="#sec:acronyms" id="QQ2-1-153">Acronyms and Other Abbreviations</a></span> <br />  <span class="sectionToc" >13.1 <a -href="#sec:setacronymstyle" id="QQ2-1-77">Changing the Abbreviation Style</a></span> +href="#sec:setacronymstyle" id="QQ2-1-155">Changing the Abbreviation Style</a></span> <br />   <span class="subsectionToc" >13.1.1 <a -href="#sec:predefinedacrstyles" id="QQ2-1-78">Predefined Acronym Styles</a></span> +href="#sec:predefinedacrstyles" id="QQ2-1-156">Predefined Acronym Styles</a></span> <br />   <span class="subsectionToc" >13.1.2 <a -href="#sec:customacronym" id="QQ2-1-79">Defining A Custom Acronym Style</a></span> +href="#sec:customacronym" id="QQ2-1-157">Defining A Custom Acronym Style</a></span> <br />  <span class="sectionToc" >13.2 <a -href="#sec:disploa" id="QQ2-1-80">Displaying the List of Acronyms</a></span> +href="#sec:disploa" id="QQ2-1-158">Displaying the List of Acronyms</a></span> <br />  <span class="sectionToc" >13.3 <a -href="#sec:oldacronym" id="QQ2-1-81">Upgrading From the glossary Package</a></span> +href="#sec:oldacronym" id="QQ2-1-159">Upgrading From the glossary Package</a></span> <br /> <span class="chapterToc" >14 <a -href="#sec:glsunset" id="QQ2-1-83">Unsetting and Resetting Entry Flags</a></span> +href="#sec:glsunset" id="QQ2-1-161">Unsetting and Resetting Entry Flags</a></span> <br />  <span class="sectionToc" >14.1 <a -href="#sec:enableentrycount" id="QQ2-1-84">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span> +href="#sec:enableentrycount" id="QQ2-1-162">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span> <br /> <span class="chapterToc" >15 <a -href="#sec:styles" id="QQ2-1-85">Glossary Styles</a></span> +href="#sec:styles" id="QQ2-1-163">Glossary Styles</a></span> <br />  <span class="sectionToc" >15.1 <a -href="#sec:predefinedstyles" id="QQ2-1-86">Predefined Styles</a></span> +href="#sec:predefinedstyles" id="QQ2-1-164">Predefined Styles</a></span> <br />   <span class="subsectionToc" >15.1.1 <a -href="#sec:liststyles" id="QQ2-1-88">List Styles</a></span> +href="#sec:liststyles" id="QQ2-1-166">List Styles</a></span> <br />   <span class="subsectionToc" >15.1.2 <a -href="#sec:longstyles" id="QQ2-1-89">Longtable Styles</a></span> +href="#sec:longstyles" id="QQ2-1-167">Longtable Styles</a></span> <br />   <span class="subsectionToc" >15.1.3 <a -href="#sec:longraggedstyles" id="QQ2-1-90">Longtable Styles (Ragged Right)</a></span> +href="#sec:longraggedstyles" id="QQ2-1-168">Longtable Styles (Ragged Right)</a></span> <br />   <span class="subsectionToc" >15.1.4 <a -href="#sec:longbooktabsstyles" id="QQ2-1-91">Longtable Styles (<span +href="#sec:longbooktabsstyles" id="QQ2-1-169">Longtable Styles (<span class="cmss-10">booktabs</span>)</a></span> <br />   <span class="subsectionToc" >15.1.5 <a -href="#sec:superstyles" id="QQ2-1-92">Supertabular Styles</a></span> +href="#sec:superstyles" id="QQ2-1-170">Supertabular Styles</a></span> <br />   <span class="subsectionToc" >15.1.6 <a -href="#sec:superraggedstyles" id="QQ2-1-93">Supertabular Styles (Ragged Right)</a></span> +href="#sec:superraggedstyles" id="QQ2-1-171">Supertabular Styles (Ragged Right)</a></span> <br />   <span class="subsectionToc" >15.1.7 <a -href="#sec:treestyles" id="QQ2-1-94">Tree-Like Styles</a></span> +href="#sec:treestyles" id="QQ2-1-172">Tree-Like Styles</a></span> + + <br />   <span class="subsectionToc" >15.1.8 <a -href="#sec:mcolstyles" id="QQ2-1-95">Multicols Style</a></span> +href="#sec:mcolstyles" id="QQ2-1-173">Multicols Style</a></span> <br />   <span class="subsectionToc" >15.1.9 <a -href="#sec:inline" id="QQ2-1-97">In-Line Style</a></span> +href="#sec:inline" id="QQ2-1-175">In-Line Style</a></span> <br />  <span class="sectionToc" >15.2 <a -href="#sec:newglossarystyle" id="QQ2-1-98">Defining your own glossary style</a></span> +href="#sec:newglossarystyle" id="QQ2-1-176">Defining your own glossary style</a></span> <br /> <span class="chapterToc" >16 <a -href="#sec:utilities" id="QQ2-1-99">Utilities</a></span> - - +href="#sec:utilities" id="QQ2-1-177">Utilities</a></span> <br />  <span class="sectionToc" >16.1 <a -href="#sec:loops" id="QQ2-1-100">Loops</a></span> +href="#sec:loops" id="QQ2-1-178">Loops</a></span> <br />  <span class="sectionToc" >16.2 <a -href="#sec:conditionals" id="QQ2-1-101">Conditionals</a></span> +href="#sec:conditionals" id="QQ2-1-179">Conditionals</a></span> <br />  <span class="sectionToc" >16.3 <a -href="#sec:fetchset" id="QQ2-1-102">Fetching and Updating the Value of a Field</a></span> +href="#sec:fetchset" id="QQ2-1-180">Fetching and Updating the Value of a Field</a></span> <br /> <span class="chapterToc" >17 <a -href="#sec:prefix" id="QQ2-1-103">Prefixes or Determiners</a></span> +href="#sec:prefix" id="QQ2-1-181">Prefixes or Determiners</a></span> <br /> <span class="chapterToc" >18 <a -href="#sec:accsupp" id="QQ2-1-104">Accessibility Support</a></span> +href="#sec:accsupp" id="QQ2-1-182">Accessibility Support</a></span> <br /> <span class="chapterToc" >19 <a -href="#sec:trouble" id="QQ2-1-105">Troubleshooting</a></span> +href="#sec:samples" id="QQ2-1-183">Sample Documents</a></span> +<br />  <span class="sectionToc" >19.1 <a +href="#sec:samplesbasic" id="QQ2-1-184">Basic</a></span> +<br />  <span class="sectionToc" >19.2 <a +href="#sec:sampleacronyms" id="QQ2-1-187">Acronyms and First Use</a></span> +<br />  <span class="sectionToc" >19.3 <a +href="#sec:samplecounter" id="QQ2-1-197">Non-Page Locations</a></span> +<br />  <span class="sectionToc" >19.4 <a +href="#sec:samplestype" id="QQ2-1-201">Multiple Glossaries</a></span> +<br />  <span class="sectionToc" >19.5 <a +href="#sec:samplessort" id="QQ2-1-206">Sorting</a></span> +<br />  <span class="sectionToc" >19.6 <a +href="#sec:samplesparent" id="QQ2-1-209">Child Entries</a></span> +<br />  <span class="sectionToc" >19.7 <a +href="#sec:samplescrossref" id="QQ2-1-213">Cross-Referencing</a></span> +<br />  <span class="sectionToc" >19.8 <a +href="#sec:samplescustomkeys" id="QQ2-1-215">Custom Keys</a></span> +<br />  <span class="sectionToc" >19.9 <a +href="#sec:samplesxindy" id="QQ2-1-220">Xindy (Option 3)</a></span> +<br />  <span class="sectionToc" >19.10 <a +href="#sec:samplesnoidx" id="QQ2-1-225">No Indexing Application (Option 1)</a></span> +<br />  <span class="sectionToc" >19.11 <a +href="#sec:samplesother" id="QQ2-1-228">Other</a></span> +<br /> <span class="chapterToc" >20 <a +href="#sec:trouble" id="QQ2-1-237">Troubleshooting</a></span> </div> - - - - - - + + + + + + <h2 class="likechapterHead"><a id="x1-2000"></a>List of Tables</h2> <div class="tableofcontents"><span class="lotToc" >1.1 <a @@ -805,15 +1837,15 @@ effect of using xspace</a></span><br /><span class="lotToc" >15.1 <a href="#tab:styles">Glossary Styles</a></span><br /><span class="lotToc" >15.2 <a href="#tab:mcols">Multicolumn Styles</a></span><br /> </div> - - - - + + + + <!--l. 1--><p class="indent" > <a id="likesection.1"></a><a id="Q1-1-3"></a> - - + + </p> <h2 class="likechapterHead"><a id="x1-3000"></a>Glossary</h2> @@ -828,35 +1860,35 @@ class="cmtt-10">\usepackage[</span></td><td class="tabbing"><span class="cmtt-10">xindy,</span> </td></tr></table> -<!--l. 1--><p class="indent" > </p><table +<!--l. 1--><p class="indent" > </p><table cellpadding="0" border="0" cellspacing="0" class="tabbing"><tr style="vertical-align:baseline;" class="tabbing"><td style="width:94;" class="tabbing"> </td><td class="tabbing"><span class="cmtt-10">nonumberlist,</span></td></tr></table> -<!--l. 1--><p class="indent" > </p><table +<!--l. 1--><p class="indent" > </p><table cellpadding="0" border="0" cellspacing="0" class="tabbing"><tr style="vertical-align:baseline;" class="tabbing"><td style="width:94;" class="tabbing"></td><td class="tabbing"><span class="cmtt-10">toc,</span></td></tr></table> -<!--l. 1--><p class="indent" > </p><table +<!--l. 1--><p class="indent" > </p><table cellpadding="0" border="0" cellspacing="0" class="tabbing"><tr style="vertical-align:baseline;" class="tabbing"><td style="width:94;" class="tabbing"></td><td class="tabbing"><span class="cmtt-10">nopostdot,</span></td></tr></table> -<!--l. 1--><p class="indent" > </p><table +<!--l. 1--><p class="indent" > </p><table cellpadding="0" border="0" cellspacing="0" class="tabbing"><tr style="vertical-align:baseline;" class="tabbing"><td style="width:94;" class="tabbing"></td><td class="tabbing"><span class="cmtt-10">style=altlist,</span></td></tr></table> -<!--l. 1--><p class="indent" > </p><table +<!--l. 1--><p class="indent" > </p><table cellpadding="0" border="0" cellspacing="0" class="tabbing"><tr style="vertical-align:baseline;" class="tabbing"><td style="width:94;" @@ -874,127 +1906,158 @@ class="cmtt-10">bib2gls</span><a id="dx1-3001"></a> </dt><dd class="description"><br class="newline" />An <a -href="#glo:indexingapp">indexing application</a> that combines two functions in one: (1) fetches entry - definition from a <span -class="cmtt-10">.bib </span>file based on information provided in the <span -class="cmtt-10">.aux </span>file (similar - to <span -class="cmtt-10">bibtex</span>); (2) hierarchically sorts and collates location lists (similar to <span -class="cmtt-10">makeindex</span> - and <span -class="cmtt-10">xindy</span>). This application is designed for use with <span -class="cmss-10">glossaries-extra </span>and can’t be - used with just the base <span -class="cmss-10">glossaries </span>package. <br +href="#glo:indexingapp">indexing application</a> that combines two functions in one: (1) fetches entry definition from a <span +class="cmtt-10">bib</span><a + id="dx1-3002"></a> + file based on information provided in the <span +class="cmtt-10">aux</span><a + id="dx1-3003"></a> file (similar to <span +class="cmtt-10">bibtex</span>); (2) hierarchically sorts and + collates location lists (similar to <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-3004"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-3005"></a></a>). This application is designed for use with + <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and can’t be used with just the base <span +class="cmss-10">glossaries </span>package. See <a +href="#option4">Option 4</a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:cli"></a><span class="cmbx-10">Command Line Interface (CLI)</span> </dt><dd class="description"><br -class="newline" />An application that doesn’t have a graphical user interface. That is, an application - that doesn’t have any windows, buttons or menus and can be run in <a -href="http://www.dickimaw-books.com/latex/novices/html/terminal.html" >a command - prompt or terminal</a>. <br +class="newline" />An application that doesn’t have a graphical user interface. That is, an application that doesn’t + have any windows, buttons or menus and can be run in <a +href="http://www.dickimaw-books.com/latex/novices/html/terminal.html" >a command prompt or terminal</a>. <br +class="newline" /> + </dd><dt class="description"> +<a + id="glo:convertgls2bib"></a><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-3006"></a> </dt><dd +class="description"><br +class="newline" />An application provided with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-3007"></a></a> that converts <span +class="cmtt-10">tex</span><a + id="dx1-3008"></a> files containing entry definitions to <span +class="cmtt-10">bib</span><a + id="dx1-3009"></a> + files suitable for use with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-3010"></a></a>. This application is designed for files that just contain entry + definitions, but it can work on a complete document file. However, there will be a lot of “undefined + command” warnings as <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-3011"></a></a> only has a limited set of known commands. You can limit + it so that it only parses the preamble with the <span +class="cmtt-10">--preamble-only </span>switch (requires at least <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-3012"></a></a> + v2.0). <br class="newline" /> </dd><dt class="description"> <a id="glo:entrylocation"></a><span class="cmbx-10">Entry location</span><a - id="dx1-3002"></a> </dt><dd + id="dx1-3013"></a> </dt><dd class="description"><br -class="newline" />The location of the entry in the document. This defaults to the page number on - which the entry appears. An entry may have multiple locations. <br +class="newline" />The location of the entry in the document. This defaults to the page number on which the entry + appears. An entry may have multiple locations. <br class="newline" /> </dd><dt class="description"> <a id="glo:exlatinalph"></a><span class="cmbx-10">Extended Latin Alphabet</span><a - id="dx1-3003"></a> </dt><dd + id="dx1-3014"></a> </dt><dd class="description"><br class="newline" />An alphabet consisting of <a href="#glo:latinchar">Latin character<a - id="dx1-3004"></a>s</a> and <a + id="dx1-3015"></a>s</a> and <a href="#glo:exlatinchar">extended Latin character<a - id="dx1-3005"></a>s</a>. <br + id="dx1-3016"></a>s</a>. <br class="newline" /> - - </dd><dt class="description"> <a id="glo:exlatinchar"></a><span class="cmbx-10">Extended Latin Character</span><a - id="dx1-3006"></a> </dt><dd + id="dx1-3017"></a> </dt><dd class="description"><br class="newline" />A character that’s created by combining <a href="#glo:latinchar">Latin character<a - id="dx1-3007"></a>s</a> to form ligatures (e.g. æ) - or by applying diacritical marks to a Latin character<a - id="dx1-3008"></a> or characters (e.g. á or ø). - See also <a + id="dx1-3018"></a>s</a> to form ligatures (e.g. æ) or by applying + diacritical marks to a Latin character<a + id="dx1-3019"></a> or characters (e.g. á). See also <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-3009"></a></a>. <br + id="dx1-3020"></a></a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:firstuse"></a><span class="cmbx-10">First use</span><a - id="dx1-3010"></a> </dt><dd + id="dx1-3021"></a> </dt><dd class="description"><br -class="newline" />The first time a glossary entry is used (from the start of the document or after - a reset) with one of the following commands: <span +class="newline" />The first time a glossary entry is used (from the start of the document or after a reset) with one + of the following commands: <span class="cmtt-10">\gls</span><a - id="dx1-3011"></a>, <span + id="dx1-3022"></a>, <span class="cmtt-10">\Gls</span><a - id="dx1-3012"></a>, <span + id="dx1-3023"></a>, <span class="cmtt-10">\GLS</span><a - id="dx1-3013"></a>, <span + id="dx1-3024"></a>, <span class="cmtt-10">\glspl</span><a - id="dx1-3014"></a>, <span + id="dx1-3025"></a>, <span class="cmtt-10">\Glspl</span><a - id="dx1-3015"></a>, - <span + id="dx1-3026"></a>, <span class="cmtt-10">\GLSpl</span><a - id="dx1-3016"></a> or <span + id="dx1-3027"></a> or <span class="cmtt-10">\glsdisp</span><a - id="dx1-3017"></a>. (See <a -href="#glo:firstuseflag">first use flag</a> & <a + id="dx1-3028"></a>. (See <a +href="#glo:firstuseflag">first use + flag</a> & <a href="#glo:firstusetext">first use text</a>.) <br class="newline" /> </dd><dt class="description"> <a id="glo:firstuseflag"></a><span class="cmbx-10">First use flag</span><a - id="dx1-3018"></a> </dt><dd + id="dx1-3029"></a> </dt><dd class="description"><br -class="newline" />A conditional that determines whether or not the entry has been used according - to the rules of <a -href="#glo:firstuse">first use</a>. Commands to unset or reset this conditional are described - in <a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a -href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br +class="newline" />A conditional that determines whether or not the entry has been used according to the rules of + <a +href="#glo:firstuse">first use</a>. Commands to unset or reset this conditional are described in <a +href="#sec:glsunset">§14 </a><a +href="#sec:glsunset">Unsetting and Resetting + Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:firstusetext"></a><span class="cmbx-10">First use text</span><a - id="dx1-3019"></a> </dt><dd + id="dx1-3030"></a> </dt><dd class="description"><br -class="newline" />The text that is displayed on <a -href="#glo:firstuse">first use</a>, which is governed by the <span -class="cmss-10">first</span><a - id="dx1-3020"></a> and +class="newline" />The text that is displayed on <a +href="#glo:firstuse">first use</a>, which is governed by the <span +class="cmtt-10">first</span><a + id="dx1-3031"></a> and <span +class="cmtt-10">firstplural</span><a + id="dx1-3032"></a> keys of <span -class="cmss-10">firstplural</span><a - id="dx1-3021"></a> keys of <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-3022"></a>. (May be overridden by <span + id="dx1-3033"></a>. (May be overridden by <span class="cmtt-10">\glsdisp</span><a - id="dx1-3023"></a> or by - <span + id="dx1-3034"></a> or by <span class="cmtt-10">\defglsentry</span><a - id="dx1-3024"></a>.) <br + id="dx1-3035"></a>.) <br class="newline" /> </dd><dt class="description"> <a @@ -1002,11 +2065,11 @@ class="newline" /> class="cmssbx-10">glossaries-extra</span> </dt><dd class="description"><br class="newline" />A separate package that extends the <span -class="cmss-10">glossaries </span>package, providing new features - or improving existing features. If you want to use <span -class="cmss-10">glossaries-extra</span>, you must have - both the <span -class="cmss-10">glossaries </span>package and the <span +class="cmss-10">glossaries </span>package, providing new features or improving existing + features. If you want to use <span +class="cmss-10">glossaries-extra</span>, you must have both the <span +class="cmss-10">glossaries </span>package and the + <span class="cmss-10">glossaries-extra </span>package installed. <br class="newline" /> </dd><dt class="description"> @@ -1016,38 +2079,37 @@ class="cmbx-10">Indexing application</span> </dt><dd class="description"><br class="newline" />An application (piece of software) separate from <span class="TEX">T<span class="E">E</span>X</span>/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> that collates and - sorts information that has an associated page reference. Generally the information - is an index entry but in this case the information is a glossary entry. There are - two main indexing applications that are used with <span class="TEX">T<span +class="E">E</span>X</span></span> that collates and sorts information + that has an associated page reference. Generally the information is an index entry but in this case + the information is a glossary entry. There are two main indexing applications that are used with + <span class="TEX">T<span class="E">E</span>X</span>: <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-3025"></a></a> and <a + id="dx1-3036"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-3026"></a></a>. - These are both <a + id="dx1-3037"></a></a>. These are both <a href="#glo:cli">command line interface (CLI)</a> applications. <br class="newline" /> + + </dd><dt class="description"> <a id="glo:latinalph"></a><span class="cmbx-10">Latin Alphabet</span><a - id="dx1-3027"></a> </dt><dd + id="dx1-3038"></a> </dt><dd class="description"><br class="newline" />The alphabet consisting of <a href="#glo:latinchar">Latin character<a - id="dx1-3028"></a>s</a>. See also <a + id="dx1-3039"></a>s</a>. See also <a href="#glo:exlatinalph">extended Latin alphabet</a>. <br class="newline" /> - - </dd><dt class="description"> <a id="glo:latinchar"></a><span class="cmbx-10">Latin Character</span><a - id="dx1-3029"></a> </dt><dd + id="dx1-3040"></a> </dt><dd class="description"><br class="newline" />One of the letters <span class="cmtt-10">a</span>, …, <span @@ -1055,149 +2117,180 @@ class="cmtt-10">z</span>, <span class="cmtt-10">A</span>, …, <span class="cmtt-10">Z</span>. See also <a href="#glo:exlatinchar">extended Latin character<a - id="dx1-3030"></a></a>. <br + id="dx1-3041"></a></a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:linktext"></a><span class="cmbx-10">Link text</span><a - id="dx1-3031"></a> </dt><dd + id="dx1-3042"></a> </dt><dd class="description"><br class="newline" />The text produced by commands such as <span class="cmtt-10">\gls</span><a - id="dx1-3032"></a>. It may or may not be a hyperlink - to the glossary. <br + id="dx1-3043"></a>. It may or may not be a hyperlink to the glossary. + <br class="newline" /> </dd><dt class="description"> <a id="glo:makeglossaries"></a><span class="cmtt-10">makeglossaries</span><a - id="dx1-3033"></a> </dt><dd + id="dx1-3044"></a> </dt><dd class="description"><br -class="newline" />A custom designed Perl script interface to <a +class="newline" />A custom designed Perl script interface to <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-3034"></a></a> and <a + id="dx1-3045"></a></a> and <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-3035"></a></a> provided - with the <span -class="cmss-10">glossaries </span>package. <span class="TEX">T<span -class="E">E</span>X</span> distributions on Windows convert the original - <span -class="cmtt-10">makeglossaries </span>script into an executable <span -class="cmtt-10">makeglossaries.exe </span>for convenience - (but Perl is still required). <br + id="dx1-3046"></a></a> provided with the <span +class="cmss-10">glossaries</span> + package. <span class="TEX">T<span +class="E">E</span>X</span> distributions on Windows convert the original <span +class="cmtt-10">makeglossaries </span>script into an + executable <span +class="cmtt-10">makeglossaries.exe </span>for convenience (but Perl is still required). <br class="newline" /> </dd><dt class="description"> <a id="glo:makeglossariesgui"></a><span class="cmtt-10">makeglossariesgui</span><a - id="dx1-3036"></a> </dt><dd + id="dx1-3047"></a> </dt><dd class="description"><br class="newline" />A Java GUI alternative to <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-3037"></a></a> that also provides diagnostic tools. - Available separately on <a + id="dx1-3048"></a></a> that also provides diagnostic tools. Available separately + on <a href="http://ctan.org/pkg/makeglossariesgui" >CTAN</a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:makeglossaries-lite.lua"></a><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-3038"></a> </dt><dd + id="dx1-3049"></a> </dt><dd class="description"><br -class="newline" />A custom designed Lua script interface to <a +class="newline" />A custom designed Lua script interface to <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-3039"></a></a> and <a + id="dx1-3050"></a></a> and <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-3040"></a></a> provided with - the <span -class="cmss-10">glossaries </span>package. This is a cut-down alternative to the Perl <span -class="cmtt-10">makeglossaries</span> - script. If you have Perl installed, use the Perl script instead. This script is actually - distributed with the file name <span + id="dx1-3051"></a></a> provided with the <span +class="cmss-10">glossaries</span> + package. This is a cut-down alternative to the Perl <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-3052"></a></a> script. If you have Perl + installed, use the Perl script instead. This script is actually distributed with the file name + <span class="cmtt-10">makeglossaries-lite.lua</span>, but <span class="TEX">T<span -class="E">E</span>X</span> Live (on - Unix-like systems) creates a symbolic link called <span -class="cmtt-10">makeglossaries-lite </span>(without - the <span -class="cmtt-10">.lua </span>extension) to the actual <span -class="cmtt-10">makeglossaries-lite.lua </span>script. <br +class="E">E</span>X</span> Live (on Unix-like systems) creates a symbolic link called + <span +class="cmtt-10">makeglossaries-lite </span>(without the <span +class="cmtt-10">.lua </span>extension) to the actual <span +class="cmtt-10">makeglossaries-lite.lua</span> + script. <br class="newline" /> </dd><dt class="description"> <a id="glo:makeindex"></a><span class="cmtt-10">makeindex</span><a - id="dx1-3041"></a> </dt><dd + id="dx1-3053"></a> </dt><dd class="description"><br class="newline" />An <a -href="#glo:indexingapp">indexing application</a>. <br +href="#glo:indexingapp">indexing application</a>. See <a +href="#option2">Option 2</a>. <br class="newline" /> </dd><dt class="description"> <a id="glo:nonlatinalph"></a><span class="cmbx-10">Non-Latin Alphabet</span><a - id="dx1-3042"></a> </dt><dd + id="dx1-3054"></a> </dt><dd class="description"><br class="newline" />An alphabet consisting of <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-3043"></a>s</a>. <br + id="dx1-3055"></a>s</a>. <br class="newline" /> + + </dd><dt class="description"> <a id="glo:nonlatinchar"></a><span class="cmbx-10">Non-Latin Character</span><a - id="dx1-3044"></a> </dt><dd + id="dx1-3056"></a> </dt><dd class="description"><br class="newline" />An <a href="#glo:exlatinchar">extended Latin character<a - id="dx1-3045"></a></a> or a character that isn’t a <a + id="dx1-3057"></a></a> or a character that isn’t a <a href="#glo:latinchar">Latin character<a - id="dx1-3046"></a></a>. <br + id="dx1-3058"></a></a>. <br class="newline" /> - - </dd><dt class="description"> <a id="glo:numberlist"></a><span class="cmbx-10">Number list</span><a - id="dx1-3047"></a> </dt><dd + id="dx1-3059"></a> </dt><dd class="description"><br class="newline" />A list of <a -href="#glo:entrylocation">entry locations</a> (also called a location list). The number list can be - suppressed using the <span +href="#glo:entrylocation">entry locations</a> (also called a location list). The number list can be suppressed using the + <span class="cmss-10">nonumberlist</span><a - id="dx1-3048"></a> package option. <br + id="dx1-3060"></a> package option. <br class="newline" /> </dd><dt class="description"> <a id="glo:sanitize"></a><span class="cmbx-10">Sanitize</span><a - id="dx1-3049"></a> </dt><dd + id="dx1-3061"></a> </dt><dd class="description"><br -class="newline" />Converts command names into character sequences. That is, a command called, - say, <span -class="cmtt-10">\foo</span>, is converted into the sequence of characters: <span +class="newline" />Converts command names into character sequences. That is, a command called, say, <span +class="cmtt-10">\foo</span>, is + converted into the sequence of characters: <span class="cmtt-10">\</span>, <span class="cmtt-10">f</span>, <span class="cmtt-10">o</span>, <span -class="cmtt-10">o</span>. Depending on - the font, the backslash character may appear as a dash when used in the main - document text, so <span +class="cmtt-10">o</span>. Depending on the font, the backslash character + may appear as a dash when used in the main document text, so <span class="cmtt-10">\foo </span>will appear as: —foo. - <!--l. 306--><p class="noindent" >Earlier versions of <span -class="cmss-10">glossaries </span>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 <span -class="cmss-10">sort</span><a - id="dx1-3050"></a> key. <br + <!--l. 496--><p class="noindent" >Earlier versions of <span +class="cmss-10">glossaries </span>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 <span +class="cmtt-10">sort</span><a + id="dx1-3062"></a> + key. <br class="newline" /> </p></dd><dt class="description"> <a + id="glo:smallcaps"></a><span +class="cmbx-10">Small caps</span><a + id="dx1-3063"></a> </dt><dd +class="description"><br +class="newline" />Small capitals. The <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> kernel provides <span +class="cmtt-10">\textsc</span><a + id="dx1-3064"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">text</span>⟩<span +class="cmtt-10">} </span>to produce small capitals. This uses + a font where lowercase letters have a small capital design. Uppercase letters have the standard + height and there’s no noticeable difference with uppercase characters in corresponding non-small + caps fonts. This means that for a small caps appearance, you need to use lowercase letters in the + ⟨<span +class="cmti-10">text</span>⟩ argument. The <a + id="dx1-3065"></a>package provides <span +class="cmtt-10">\textsmaller</span><a + id="dx1-3066"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">text</span>⟩<span +class="cmtt-10">} </span>which simulates small caps by reducing + the size of the font, so in this case the contents of ⟨<span +class="cmti-10">text</span>⟩ should be uppercase (otherwise the effect + is simply smaller lowercase letters). Some fonts don’t support small caps combined with bold or + slanted properties. In this case, there will be a font substitution warning and one of the properties + (such as small caps or slanted) will be dropped. <br +class="newline" /> + </dd><dt class="description"> +<a id="glo:latexexlatinchar"></a><span class="cmbx-10">Standard </span><span class="LATEX"><span class="cmbx-10">L</span><span class="A"><span @@ -1207,208 +2300,422 @@ class="E"><span class="cmbx-10">E</span></span><span class="cmbx-10">X</span></span></span><span class="cmbx-10"> Extended Latin Character</span><a - id="dx1-3051"></a> </dt><dd + id="dx1-3067"></a> </dt><dd class="description"><br class="newline" />An <a href="#glo:exlatinchar">extended Latin character<a - id="dx1-3052"></a></a> that can be created by a core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> command, - such as <span -class="cmtt-10">\o </span>(ø) or <span -class="cmtt-10">\’e </span>(é). That is, the character can be produced without the - need to load a particular package. <br + id="dx1-3068"></a></a> that can be created by a core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> command, such as <span +class="cmtt-10">\o </span>(ø) or + <span +class="cmtt-10">\’e </span>(é). That is, the character can be produced without the need to load a particular package. <br class="newline" /> </dd><dt class="description"> <a id="glo:xindy"></a><span class="cmtt-10">xindy</span><a - id="dx1-3053"></a> </dt><dd + id="dx1-3069"></a> </dt><dd class="description"><br class="newline" />A flexible <a -href="#glo:indexingapp">indexing application</a> with multilingual support written in Perl. <br +href="#glo:indexingapp">indexing application</a> with multilingual support written in Perl. See <a +href="#option3">Option 3</a>. <br class="newline" /></dd></dl> - - -<!--l. 626--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a + + +<!--l. 853--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a id="sec:intro"></a>Introduction</h2> -</p><!--l. 629--><p class="indent" > The <span -class="cmss-10">glossaries </span>package is provided to assist generating lists of terms, symbols or -abbreviations. (For convenience, these lists are all referred to as glossaries in this manual.) -The package has a certain amount of flexibility, allowing the user to customize -the format of the glossary and define multiple glossaries. It also supports glossary -styles that include symbols (in addition to a name and description) for glossary -entries. There is provision for loading a database of glossary terms. Only those terms +</p><!--l. 856--><p class="indent" > The <span +class="cmss-10">glossaries </span>package is provided to assist generating lists of terms, symbols or abbreviations. (For +convenience, these lists are all referred to as glossaries in this manual. The terms, symbols and abbreviations are +collectively referred to as entries.) The package has a certain amount of flexibility, allowing the user +to customize the format of the glossary and define multiple glossaries. It also supports glossary +styles that include an associated symbol (in addition to a name and description) for each glossary +entry. +</p><!--l. 866--><p class="indent" > There is provision for loading a database of glossary entries. Only those entries indexed<span class="footnote-mark"><a href="#fn1x1" id="fn1x1-bk"><sup class="textsuperscript">1.1</sup></a></span><a id="x1-4001f1"></a> in -the document will be added to the glossary. -</p><!--l. 643--><p class="indent" > The <span -class="cmss-10">glossaries-extra </span>package, which is distributed as a separated bundle, extends the -capabilities of the <span -class="cmss-10">glossaries </span>package. The simplest document can be created with -<span -class="cmss-10">glossaries-extra </span>(which internally loads the <span -class="cmss-10">glossaries </span>package): - - +the document will be displayed in the glossary. (Unless you use <a +href="#option5">Option 5</a>, which doesn’t use any indexing but +will instead list all defined entries in order of definition.) +</p><!--l. 875--><p class="indent" > It’s not necessary to actually have a glossary in the document. You may be interested in using this package +just as means to consistently format certain types of terms, such as abbreviations, or you may prefer to have +descriptions scattered about the document and be able to easily link to the relevant description +(<a +href="#option6">Option 6</a>). +</p><!--l. 881--><p class="indent" > The simplest document is one without a glossary: + + </p> <div class="verbatim" id="verbatim-1"> \documentclass{article}  <br />\usepackage[ - <br /> sort=none,% no sorting or indexing required - <br /> abbreviations,% create list of abbreviations - <br /> symbols,% create list of symbols - <br /> postdot % append a full stop after the descriptions - <br />]{glossaries-extra} - <br />\newglossaryentry % provided by glossaries.sty + <br />  sort=none % no sorting or indexing required + <br />] + <br />{glossaries} + <br />\newglossaryentry  <br /> {cafe}% label  <br /> {% definition:  <br />   name={caf\'e},  <br />   description={small restaurant selling refreshments}  <br /> } - <br />\newabbreviation % provided by glossaries-extra.sty + <br />\setacronymstyle{long-short} + <br />\newacronym  <br /> {html}% label  <br /> {HTML}% short form  <br /> {hypertext markup language}% long form - <br />\glsxtrnewsymbol % provided by glossaries-extra.sty 'symbols' option - <br /> [description={Archimedes' constant}]% options + <br />\newglossaryentry  <br /> {pi}% label - <br /> {\ensuremath{\pi}}% symbol + <br /> {% definition: + <br />   name={\ensuremath{\pi}}, + <br />   description={Archimedes' Constant} + <br /> } + <br />\newglossaryentry + <br /> {distance}% label + <br /> {% definition: + <br />   name={distance}, + <br />   description={the length between two points}, + <br />   symbol={m} + <br /> }  <br />\begin{document}  <br />First use: \gls{cafe}, \gls{html}, \gls{pi}.  <br />Next use: \gls{cafe}, \gls{html}, \gls{pi}. - <br />\printunsrtglossaries % list all defined entries + <br />\Gls{distance} (\glsentrydesc{distance}) is measured in + <br />\glssymbol{distance}.  <br />\end{document} </div> -<!--l. 681--><p class="nopar" > -</p><!--l. 684--><p class="indent" > <span -class="cmbx-10">The </span><span -class="cmssbx-10">glossaries </span><span -class="cmbx-10">package replaces the </span><span -class="cmssbx-10">glossary</span><a - id="dx1-4005"></a> <span -class="cmbx-10">package which is now obsolete.</span> -Please see the document <a -href="glossary2glossaries.html" >“Upgrading from the glossary package to the glossaries package”</a> for -assistance in upgrading. -</p><!--l. 688--><p class="indent" > One of the strengths of this package is its flexibility, however the drawback of this is the -necessity of having a large manual that covers all the various settings. If you are -daunted by the size of the manual, try starting off with the much shorter <a -href="glossariesbegin.html" >guide for -beginners</a>. -</p><!--l. 694--><p class="indent" > <div class="important" title="Important Note"> There’s a common misconception that you have to have Perl installed in order to use -the <span -class="cmss-10">glossaries </span>package. Perl is <span -class="cmti-10">not </span>a requirement but it does increase the available -options, particularly if you use an <a +<!--l. 925--><p class="nopar" > (This is a trivial example. For a real document I recommend you use <span +class="cmss-10">siunitx</span><a + id="dx1-4006"></a> for units.) +</p><!--l. 929--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package, which is distributed as a separate bundle, extends the capabilities +of the <span +class="cmss-10">glossaries </span>package. The simplest document with a glossary can be created with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (which + + +internally loads the <span +class="cmss-10">glossaries </span>package): + + +</p> + <div class="verbatim" id="verbatim-2"> +\documentclass{article} +</div> +<!--l. 937--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span> +<br /><span +class="cmtt-10"> sort=none,%</span><span +class="cmtt-10"> no</span><span +class="cmtt-10"> sorting</span><span +class="cmtt-10"> or</span><span +class="cmtt-10"> indexing</span><span +class="cmtt-10"> required</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor4"><span +class="cmtt-10">abbreviations</span></span><span +class="cmtt-10">,%</span><span +class="cmtt-10"> create</span><span +class="cmtt-10"> list</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> abbreviations</span> +<br /><span +class="cmtt-10"> symbols,%</span><span +class="cmtt-10"> create</span><span +class="cmtt-10"> list</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> symbols</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor5"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span +class="cmtt-10"> %</span><span +class="cmtt-10"> append</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> full</span><span +class="cmtt-10"> stop</span><span +class="cmtt-10"> after</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> descriptions</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor6"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,style=index</span><span +class="cmtt-10"> %</span><span +class="cmtt-10"> set</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> default</span><span +class="cmtt-10"> glossary</span><span +class="cmtt-10"> style</span> +<br /><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-3"> +\newglossaryentry % provided by glossaries.sty + <br /> {cafe}% label + <br /> {% definition: + <br />   name={caf\'e}, + <br />   description={small restaurant selling refreshments} + <br /> } +</div> +<!--l. 954--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> provided</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> glossaries-extra.sty:</span> +<br /><span id="textcolor7"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-4007"></a><span +class="cmtt-10">{long-short}</span> +<br /> +<br /><span id="textcolor8"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-4008"></a><span +class="cmtt-10"> %</span><span +class="cmtt-10"> provided</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> glossaries-extra.sty</span> +<br /><span +class="cmtt-10"> {html}%</span><span +class="cmtt-10"> label</span> +<br /><span +class="cmtt-10"> {HTML}%</span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> form</span> +<br /><span +class="cmtt-10"> {hypertext</span><span +class="cmtt-10"> markup</span><span +class="cmtt-10"> language}%</span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> form</span> +<br /> +<br /><span +class="cmtt-10">%</span><span +class="cmtt-10"> provided</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> glossaries-extra.sty</span><span +class="cmtt-10"> 'symbols'</span><span +class="cmtt-10"> option:</span> +<br /><span id="textcolor9"><span +class="cmtt-10">\glsxtrnewsymbol</span></span><a + id="dx1-4009"></a> +<br /><span +class="cmtt-10"> [description={Archimedes'</span><span +class="cmtt-10"> constant}]%</span><span +class="cmtt-10"> options</span> +<br /><span +class="cmtt-10"> {pi}%</span><span +class="cmtt-10"> label</span> +<br /><span +class="cmtt-10"> {\ensuremath{\pi}}%</span><span +class="cmtt-10"> symbol</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-4"> +\newglossaryentry % provided by glossaries.sty + <br /> {distance}% label + <br /> {% definition: + <br />   name={distance}, + <br />   description={the length between two points}, + <br />   symbol={m} + <br /> } + <br />\begin{document} + <br />First use: \gls{cafe}, \gls{html}, \gls{pi}. + <br />Next use: \gls{cafe}, \gls{html}, \gls{pi}. + <br />\Gls{distance} is measured in \glssymbol{distance}. +</div> +<!--l. 984--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor10"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-4010"></a><span +class="cmtt-10"> %</span><span +class="cmtt-10"> list</span><span +class="cmtt-10"> all</span><span +class="cmtt-10"> defined</span><span +class="cmtt-10"> entries</span> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> Note the difference in the way the abbreviation (HTML) and symbol (<span +class="cmmi-10">π</span>) are defined in the two above +examples. The <span id="textcolor11"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-4011"></a>, <span id="textcolor12"><span +class="cmss-10">postdot</span></span><a + id="dx1-4012"></a> and <span id="textcolor13"><span +class="cmss-10">stylemods</span></span><a + id="dx1-4013"></a> options are specific to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. Other options are +passed to the base <span +class="cmss-10">glossaries </span>package. +<!--l. 995--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> In this document, commands and options displayed in teal, such as <span id="textcolor14"><span +class="cmtt-10">\newabbreviation</span></span> and <span id="textcolor15"><span +class="cmss-10">stylemods</span></span><a + id="dx1-4014"></a>, are +only available with the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package. There are also some commands and options (such as +<span +class="cmtt-10">\makeglossaries </span>and <span +class="cmss-10">symbols</span><a + id="dx1-4015"></a>) that are provided by the base <span +class="cmss-10">glossaries </span>package but are redefined by the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details of those commands. +</div> +</p><!--l. 1003--><p class="noindent" > +</p><!--l. 1005--><p class="indent" > One of the strengths of the <span +class="cmss-10">glossaries </span>package is its flexibility, however the drawback of this is the necessity of +having a large manual that covers all the various settings. If you are daunted by the size of the manual, try +starting off with the much shorter <a +href="glossariesbegin.html" >guide for beginners</a>. +</p><!--l. 1011--><p class="indent" > <div class="important" title="Important Note"> There’s a common misconception that you have to have Perl installed in order to use the <span +class="cmss-10">glossaries</span> +package. Perl is <span +class="cmti-10">not </span>a requirement (as demonstrated by the above examples) but it does increase the +available options, particularly if you use an <a href="#glo:exlatinalph">extended Latin alphabet</a> or a <a href="#glo:nonlatinalph">non-Latin alphabet</a>. </div> - - -</p><!--l. 699--><p class="noindent" > -</p><!--l. 701--><p class="indent" > This document uses the <span -class="cmss-10">glossaries </span>package. For example, when viewing the PDF version of -this document in a hyperlinked-enabled PDF viewer (such as Adobe Reader or -Okular) if you click on the word “<a +</p><!--l. 1017--><p class="noindent" > +</p><!--l. 1019--><p class="indent" > This document uses the <span +class="cmss-10">glossaries </span>package. For example, when viewing the PDF version of this document in +a hyperlinked-enabled PDF viewer (such as Adobe Reader or Okular) if you click on the word “<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-4006"></a></a>” you’ll be taken to the entry in the glossary -where there’s a brief description of the term “<span + id="dx1-4016"></a></a>” you’ll be +taken to the entry in the glossary where there’s a brief description of the term “<span class="cmtt-10">xindy</span><a - id="dx1-4007"></a>”. This is the way the <span -class="cmss-10">glossaries</span> -mechanism works. An <a -href="#glo:indexingapp">indexing application</a> is used to generated the sorted list of -terms. The <a -href="#glo:indexingapp">indexing applications</a> are <a -href="#glo:cli">command line interface (CLI)</a> tools, which -means they can be run directly from a command prompt or terminal, or can be -integrated into some text editors, or you can use a build tool such as <span + id="dx1-4017"></a>”. This is the way the +<span +class="cmss-10">glossaries </span>mechanism works. An <a +href="#glo:indexingapp">indexing application</a> is used to generated the sorted list of terms. The <a +href="#glo:indexingapp">indexing +applications</a> are <a +href="#glo:cli">command line interface (CLI)</a> tools, which means they can be run directly from a command + + +prompt or terminal, or can be integrated into some text editors, or you can use a build tool such as <span class="cmtt-10">arara</span><a - id="dx1-4008"></a> to run -them. -</p><!--l. 713--><p class="indent" > The remainder of this introductory section covers the following: </p> + id="dx1-4018"></a> to +run them. +</p><!--l. 1031--><p class="indent" > Neither of the above two examples require an <a +href="#glo:indexingapp">indexing application</a>. The first is just using the <span +class="cmss-10">glossaries</span> +package for consistent formatting, and there is no list. The second has lists but they are unsorted (see +<a +href="#option5">Option 5</a>). +</p><!--l. 1036--><p class="indent" > The remainder of this introductory section covers the following: </p> <ul class="itemize1"> <li class="itemize"><a -href="#sec:indexingoptions"><span -class="tcrm-1000">§</span>1.1 </a><a +href="#sec:indexingoptions">§1.1 </a><a href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> lists the available indexing options. </li> <li class="itemize"><a -href="#sec:samples"><span -class="tcrm-1000">§</span>1.2 </a><a +href="#sec:samples">§19 </a><a href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a> lists the sample documents provided with this package. </li> <li class="itemize"><a -href="#sec:lipsum"><span -class="tcrm-1000">§</span>1.3 </a><a -href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a> lists the dummy glossary files that may be used - for testing. +href="#sec:lipsum">§1.2 </a><a +href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a> lists the dummy glossary files that may be used for testing. </li> <li class="itemize"><a -href="#sec:languages"><span -class="tcrm-1000">§</span>1.4 </a><a -href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a - language other than English. +href="#sec:languages">§1.3 </a><a +href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a> provides information for users who wish to write in a language other + than English. </li> <li class="itemize"><a -href="#sec:makeglossaries"><span -class="tcrm-1000">§</span>1.5 </a><a +href="#sec:makeglossaries">§1.4 </a><a href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> describes how to use an <a -href="#glo:indexingapp">indexing - application</a> to create the sorted glossaries for your document (Options <a +href="#glo:indexingapp">indexing application</a> to create + the sorted glossaries for your document (Options <a href="#option2">2</a> or <a href="#option3">3</a>). </li></ul> -<!--l. 733--><p class="noindent" ><a +<!--l. 1056--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.1 </span> <a id="sec:indexingoptions"></a>Indexing Options</h3> -<!--l. 736--><p class="noindent" >The basic idea behind the <span -class="cmss-10">glossaries </span>package is that you first define your entries (terms, -symbols or abbreviations). Then you can reference these within your document (like <span -class="cmtt-10">\cite </span>or -<span -class="cmtt-10">\ref</span>). You can also, optionally, display a list of the entries you have referenced in your -document (the glossary). This last part, displaying the glossary, is the part that most new -users find difficult. There are three options available with the base <span -class="cmss-10">glossaries </span>package and two -further options with the extension package <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>. An overview of these options is -given in <a -href="#tab:options">table 1.1</a>. -</p><!--l. 748--><p class="indent" > If you are developing a class or package that loads <span -class="cmss-10">glossaries</span>, I recommend that you -don’t force the user into a particular indexing method by adding an unconditional -<span -class="cmtt-10">\makeglossaries </span>into your class or package code. Aside from forcing the user into a -particular indexing method, it means that they’re unable to use any commands that must -come before <span -class="cmtt-10">\makeglossaries </span>(such as <span -class="cmtt-10">\newglossary</span>) and they can’t switch off the indexing -whilst working on a draft document. -</p><!--l. 757--><p class="indent" > For a comparison of the various methods when used with large entry sets or when used -with symbols such as <span -class="cmtt-10">\alpha</span>, see the <a -href="http://www.dickimaw-books.com/gallery/glossaries-performance.shtml" ><span -class="cmss-10">glossaries </span>performance page</a>. - - +<!--l. 1059--><p class="noindent" >The basic idea behind the <span +class="cmss-10">glossaries </span>package is that you first define your entries (terms, symbols or +abbreviations). Then you can reference these within your document (like <span +class="cmtt-10">\cite </span>or <span +class="cmtt-10">\ref</span>). You can also, +optionally, display a list of the entries you have referenced in your document (the glossary). This last part, +displaying the glossary, is the part that most new users find difficult. There are three options available with the +base <span +class="cmss-10">glossaries </span>package (Options <a +href="#option1">1</a>–<a +href="#option3">3</a>). The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package provides two extra options for lists +(Options <a +href="#option4">4</a> and <a +href="#option5">5</a>) as well as an option for standalone descriptions within the document body +(<a +href="#option6">Option 6</a>). +</p><!--l. 1070--><p class="indent" > An overview of Options <a +href="#option1">1</a>–<a +href="#option5">5</a> is given in <a +href="#tab:options">table 1.1</a>. <a +href="#option6">Option 6</a> is omitted from the table as it doesn’t +produce a list. For a more detailed comparison of the various methods, see the <a +href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml" ><span +class="cmss-10">glossaries </span>performance +page</a>. +</p><!--l. 1076--><p class="indent" > <div class="important" title="Important Note"> If you are developing a class or package that loads <span +class="cmss-10">glossaries</span>, I recommend that you don’t +force the user into a particular indexing method by adding an unconditional <span +class="cmtt-10">\makeglossaries</span> +into your class or package code. Aside from forcing the user into a particular indexing method, it +means that they’re unable to use any commands that must come before <span +class="cmtt-10">\makeglossaries </span>(such +as <span +class="cmtt-10">\newglossary</span>) and they can’t switch off the indexing whilst working on a draft document. +</div> +</p><!--l. 1085--><p class="noindent" > +</p><!--l. 1087--><p class="indent" > Strictly speaking, Options <a +href="#option5">5</a> and <a +href="#option6">6</a> aren’t actually indexing options as no indexing is performed. In the +case of <a +href="#option5">Option 5</a>, all defined entries are listed in order of definition. In the case of <a +href="#option6">Option 6</a>, the +entry hypertargets and descriptions are manually inserted at appropriate points in the document. + + +These two options are included here for completeness and for comparison with the actual indexing +options. </p> <div class="table"> - - -<!--l. 761--><p class="indent" > <a + + +<!--l. 1094--><p class="indent" > <a id="tab:options"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 1.1: </span><span class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50011 --> - - + + <div class="tabular"> <table id="TBL-2" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-2-1g"><col @@ -1419,7 +2726,7 @@ id="TBL-2-4" /><col id="TBL-2-5" /><col id="TBL-2-6" /></colgroup><tr style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:normal; text-align:left;" id="TBL-2-1-1" -class="td01"><!--l. 769--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" +class="td01"><!--l. 1102--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2" class="td11"> <a href="#option1"><span class="cmbx-10">Option</span><span @@ -1442,77 +2749,77 @@ class="cmbx-10">Option</span><span class="cmbx-10"> 5</span></a></td> </tr><tr style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:normal; text-align:left;" id="TBL-2-2-1" -class="td01"><!--l. 771--><p class="noindent" ><span +class="td01"><!--l. 1104--><p class="noindent" ><span class="cmr-9">Requires</span> <a href="#glo:glossaries-extra"><span class="cmss-9">glossaries-extra</span></a><span -class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" -class="td11"> <span id="textcolor1"><span +class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2" +class="td11"> <span id="textcolor16"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3" -class="td11"> <span id="textcolor2"><span +class="td11"> <span id="textcolor17"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4" -class="td11"> <span id="textcolor3"><span +class="td11"> <span id="textcolor18"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-5" -class="td11"> <span id="textcolor4"><span +class="td11"> <span id="textcolor19"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-6" -class="td10"> <span id="textcolor5"><span +class="td10"> <span id="textcolor20"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:normal; text-align:left;" id="TBL-2-3-1" -class="td01"><!--l. 773--><p class="noindent" ><span +class="td01"><!--l. 1106--><p class="noindent" ><span class="cmr-9">Requires</span> <span class="cmr-9">an</span> <span class="cmr-9">external</span> <span -class="cmr-9">application?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2" -class="td11"> <span id="textcolor6"><span +class="cmr-9">application?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2" +class="td11"> <span id="textcolor21"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3" -class="td11"> <span id="textcolor7"><span +class="td11"> <span id="textcolor22"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4" -class="td11"> <span id="textcolor8"><span +class="td11"> <span id="textcolor23"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-5" -class="td11"> <span id="textcolor9"><span +class="td11"> <span id="textcolor24"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-6" -class="td10"> <span id="textcolor10"><span +class="td10"> <span id="textcolor25"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:normal; text-align:left;" id="TBL-2-4-1" -class="td01"><!--l. 775--><p class="noindent" ><span +class="td01"><!--l. 1108--><p class="noindent" ><span class="cmr-9">Requires</span> <span -class="cmr-9">Perl?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2" -class="td11"> <span id="textcolor11"><span +class="cmr-9">Perl?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2" +class="td11"> <span id="textcolor26"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3" -class="td11"> <span id="textcolor12"><span +class="td11"> <span id="textcolor27"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4" -class="td11"> <span id="textcolor13"><span +class="td11"> <span id="textcolor28"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-5" -class="td11"> <span id="textcolor14"><span +class="td11"> <span id="textcolor29"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-6" -class="td10"> <span id="textcolor15"><span +class="td10"> <span id="textcolor30"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:normal; text-align:left;" id="TBL-2-5-1" -class="td01"><!--l. 777--><p class="noindent" ><span +class="td01"><!--l. 1110--><p class="noindent" ><span class="cmr-9">Requires</span> <span -class="cmr-9">Java?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" -class="td11"> <span id="textcolor16"><span +class="cmr-9">Java?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2" +class="td11"> <span id="textcolor31"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3" -class="td11"> <span id="textcolor17"><span +class="td11"> <span id="textcolor32"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4" -class="td11"> <span id="textcolor18"><span +class="td11"> <span id="textcolor33"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-5" -class="td11"> <span id="textcolor19"><span +class="td11"> <span id="textcolor34"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-6" -class="td10"> <span id="textcolor20"><span +class="td10"> <span id="textcolor35"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:normal; text-align:left;" id="TBL-2-6-1" -class="td01"><!--l. 779--><p class="noindent" ><span +class="td01"><!--l. 1112--><p class="noindent" ><span class="cmr-9">Can</span> <span class="cmr-9">sort</span> @@ -1530,37 +2837,37 @@ href="#glo:nonlatinalph"><span class="cmr-9">non-Latin</span> <span class="cmr-9">alphabets</span></a><span -class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2" -class="td11"> <span id="textcolor21"><span +class="cmr-9">?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2" +class="td11"> <span id="textcolor36"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="tcrm-0900">*</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3" -class="td11"> <span id="textcolor22"><span +class="td11"> <span id="textcolor37"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4" -class="td11"> <span id="textcolor23"><span +class="td11"> <span id="textcolor38"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-5" -class="td11"> <span id="textcolor24"><span +class="td11"> <span id="textcolor39"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-6" class="td10"> N/A </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:normal; text-align:left;" id="TBL-2-7-1" -class="td01"><!--l. 782--><p class="noindent" ><span +class="td01"><!--l. 1115--><p class="noindent" ><span class="cmr-9">Efficient</span> <span class="cmr-9">sort</span> <span -class="cmr-9">algorithm?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" -class="td11"> <span id="textcolor25"><span +class="cmr-9">algorithm?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2" +class="td11"> <span id="textcolor40"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3" -class="td11"> <span id="textcolor26"><span +class="td11"> <span id="textcolor41"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4" -class="td11"> <span id="textcolor27"><span +class="td11"> <span id="textcolor42"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-5" -class="td11"> <span id="textcolor28"><span +class="td11"> <span id="textcolor43"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-6" class="td10"> N/A </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-8-"><td style="white-space:normal; text-align:left;" id="TBL-2-8-1" -class="td01"><!--l. 784--><p class="noindent" ><span +class="td01"><!--l. 1117--><p class="noindent" ><span class="cmr-9">Can</span> <span class="cmr-9">use</span> @@ -1577,42 +2884,42 @@ class="cmr-9">for</span> <span class="cmr-9">each</span> <span -class="cmr-9">glossary?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2" -class="td11"> <span id="textcolor29"><span +class="cmr-9">glossary?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-2" +class="td11"> <span id="textcolor44"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3" -class="td11"> <span id="textcolor30"><span +class="td11"> <span id="textcolor45"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="tcrm-0900">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-4" -class="td11"> <span id="textcolor31"><span +class="td11"> <span id="textcolor46"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="tcrm-0900">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-5" -class="td11"> <span id="textcolor32"><span +class="td11"> <span id="textcolor47"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-6" class="td10"> N/A </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-9-"><td style="white-space:normal; text-align:left;" id="TBL-2-9-1" -class="td01"><!--l. 788--><p class="noindent" ><span +class="td01"><!--l. 1121--><p class="noindent" ><span class="cmr-9">Any</span> <span class="cmr-9">problematic</span> <span class="cmr-9">sort</span> <span -class="cmr-9">values?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2" -class="td11"> <span id="textcolor33"><span +class="cmr-9">values?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-2" +class="td11"> <span id="textcolor48"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-3" -class="td11"> <span id="textcolor34"><span +class="td11"> <span id="textcolor49"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-4" -class="td11"> <span id="textcolor35"><span +class="td11"> <span id="textcolor50"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-5" -class="td11"> <span id="textcolor36"><span +class="td11"> <span id="textcolor51"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-6" -class="td10"> <span id="textcolor37"><span +class="td10"> <span id="textcolor52"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="tcrm-0900">‡</span></sup> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-10-"><td style="white-space:normal; text-align:left;" id="TBL-2-10-1" -class="td01"><!--l. 790--><p class="noindent" ><span +class="td01"><!--l. 1123--><p class="noindent" ><span class="cmr-9">Are</span> <span class="cmr-9">entries</span> @@ -1633,21 +2940,21 @@ class="cmr-9">separate</span> <span class="cmr-9">unique</span> <span -class="cmr-9">entries?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2" -class="td11"> <span id="textcolor38"><span +class="cmr-9">entries?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-2" +class="td11"> <span id="textcolor53"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-3" -class="td11"> <span id="textcolor39"><span +class="td11"> <span id="textcolor54"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-4" -class="td11"> <span id="textcolor40"><span +class="td11"> <span id="textcolor55"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="tcrm-0900">§</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-5" -class="td11"> <span id="textcolor41"><span +class="td11"> <span id="textcolor56"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-6" -class="td10"> <span id="textcolor42"><span +class="td10"> <span id="textcolor57"><span class="pzdr-">✔</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-11-"><td style="white-space:normal; text-align:left;" id="TBL-2-11-1" -class="td01"><!--l. 793--><p class="noindent" ><span +class="td01"><!--l. 1126--><p class="noindent" ><span class="cmr-9">Can</span> <span class="cmr-9">automatically</span> @@ -1662,20 +2969,20 @@ class="cmr-9">the</span> <span class="cmr-9">location</span> <span -class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2" -class="td11"> <span id="textcolor43"><span +class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-2" +class="td11"> <span id="textcolor58"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-3" -class="td11"> <span id="textcolor44"><span +class="td11"> <span id="textcolor59"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-4" -class="td11"> <span id="textcolor45"><span +class="td11"> <span id="textcolor60"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-5" -class="td11"> <span id="textcolor46"><span +class="td11"> <span id="textcolor61"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-6" -class="td10"> <span id="textcolor47"><span +class="td10"> <span id="textcolor62"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-12-"><td style="white-space:normal; text-align:left;" id="TBL-2-12-1" -class="td01"><!--l. 795--><p class="noindent" ><span +class="td01"><!--l. 1128--><p class="noindent" ><span class="cmr-9">Can</span> <span class="cmr-9">have</span> @@ -1690,29 +2997,29 @@ class="cmr-9">the</span> <span class="cmr-9">location</span> <span -class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-2" -class="td11"> <span id="textcolor48"><span +class="cmr-9">lists?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-2" +class="td11"> <span id="textcolor63"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-3" -class="td11"> <span id="textcolor49"><span +class="td11"> <span id="textcolor64"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-4" -class="td11"> <span id="textcolor50"><span +class="td11"> <span id="textcolor65"><span class="pzdr-">✔</span></span><sup class="textsuperscript"><span class="msam-10x-x-90">♢</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-5" -class="td11"> <span id="textcolor51"><span +class="td11"> <span id="textcolor66"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-6" -class="td10"> <span id="textcolor52"><span +class="td10"> <span id="textcolor67"><span class="pzdr-">✔</span></span><sup class="textsuperscript"><span class="tcrm-0900">¶</span></sup> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-13-"><td style="white-space:normal; text-align:left;" id="TBL-2-13-1" -class="td01"><!--l. 800--><p class="noindent" ><span +class="td01"><!--l. 1133--><p class="noindent" ><span class="cmr-9">Maximum</span> <span class="cmr-9">hierarchical</span> <span class="cmr-9">depth</span> <span -class="cmr-9">(style-dependent)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-2" +class="cmr-9">(style-dependent)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-2" class="td11"> <span class="cmsy-10">∞</span><sup class="textsuperscript"><span class="cmr-9">#</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-3" @@ -1725,24 +3032,24 @@ class="td10"> <span class="cmsy-10">∞ </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-2-14-"><td style="white-space:normal; text-align:left;" id="TBL-2-14-1" -class="td01"><!--l. 802--><p class="noindent" ><span +class="td01"><!--l. 1135--><p class="noindent" ><span class="cmtt-9">\glsdisplaynumberlist</span><a id="dx1-5002"></a> <span -class="cmr-9">reliable?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-2" -class="td11"> <span id="textcolor53"><span +class="cmr-9">reliable?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-2" +class="td11"> <span id="textcolor68"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-3" -class="td11"> <span id="textcolor54"><span +class="td11"> <span id="textcolor69"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-4" -class="td11"> <span id="textcolor55"><span +class="td11"> <span id="textcolor70"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-5" -class="td11"> <span id="textcolor56"><span +class="td11"> <span id="textcolor71"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-6" -class="td10"> <span id="textcolor57"><span +class="td10"> <span id="textcolor72"><span class="pzdr-">✘</span></span> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-15-"><td style="white-space:normal; text-align:left;" id="TBL-2-15-1" -class="td01"><!--l. 804--><p class="noindent" ><span +class="td01"><!--l. 1137--><p class="noindent" ><span class="cmtt-9">\newglossaryentry</span><a id="dx1-5003"></a> <span @@ -1758,7 +3065,7 @@ class="cmr-9">environment?</span> <span class="cmr-9">(Not</span> <span -class="cmr-9">recommended.)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-2" +class="cmr-9">recommended.)</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-2" class="td11"> <span class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-3" class="td11"> <span @@ -1772,28 +3079,28 @@ class="td10"> <span class="pzdr-">✔</span><sup class="textsuperscript">⁑</sup> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-16-"><td style="white-space:normal; text-align:left;" id="TBL-2-16-1" -class="td01"><!--l. 807--><p class="noindent" ><span +class="td01"><!--l. 1140--><p class="noindent" ><span class="cmr-9">Requires</span> <span class="cmr-9">additional</span> <span class="cmr-9">write</span> <span -class="cmr-9">registers?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-2" -class="td11"> <span id="textcolor58"><span +class="cmr-9">registers?</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-2" +class="td11"> <span id="textcolor73"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-3" -class="td11"> <span id="textcolor59"><span +class="td11"> <span id="textcolor74"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-4" -class="td11"> <span id="textcolor60"><span +class="td11"> <span id="textcolor75"><span class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-5" -class="td11"> <span id="textcolor61"><span +class="td11"> <span id="textcolor76"><span class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-6" -class="td10"> <span id="textcolor62"><span +class="td10"> <span id="textcolor77"><span class="pzdr-">✘</span></span><sup class="textsuperscript"><span class="cmmi-9">⋆</span></sup> </td> </tr><tr style="vertical-align:baseline;" id="TBL-2-17-"><td style="white-space:normal; text-align:left;" id="TBL-2-17-1" -class="td01"><!--l. 809--><p class="noindent" ><span +class="td01"><!--l. 1142--><p class="noindent" ><span class="cmr-9">Default</span> <span class="cmr-9">value</span> @@ -1805,7 +3112,7 @@ class="cmss-9">sanitizesort</span><a <span class="cmr-9">package</span> <span -class="cmr-9">option</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-2" +class="cmr-9">option</span> </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-2" class="td11"> <span class="cmtt-10">false </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-3" class="td11"> <span @@ -1818,11 +3125,11 @@ class="pzdr-x-x-90">✾</span></sup> </td><td style="white-space:nowrap class="td10"> <span class="cmtt-10">true</span><sup class="textsuperscript"><span class="pzdr-x-x-90">✾</span></sup> </td> -</tr></table> - +</tr></table> + </div> -<!--l. 817--><p class="noindent" >________________________________________________________________________ -</p><!--l. 819--><p class="noindent" ><sup class="textsuperscript"><span +<!--l. 1150--><p class="noindent" >______________________________________________________________________________________ +</p><!--l. 1152--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">*</span></sup> <span class="cmr-8">Strips standard </span><span class="LATEX"><span class="cmr-8">L</span><span class="A"><span @@ -1838,375 +3145,535 @@ class="cmr-8">T</span><span class="E"><span class="cmr-8">E</span></span><span class="cmr-8">X</span></span></span><span -class="cmr-8"> commands) so, for</span> -<span -class="cmr-8">example, </span><span +class="cmr-8"> commands) so, for example, </span><span class="cmtt-8">\AA</span><a id="dx1-5007"></a> <span -class="cmr-8">is treated the same as A.</span> -</p><!--l. 822--><p class="noindent" ><sup class="textsuperscript"><span +class="cmr-8">is treated</span> +<span +class="cmr-8">the same as A.</span> +</p><!--l. 1155--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">†</span></sup> <span -class="cmr-8">Only with the hybrid method provided with </span><span -class="cmss-8">glossaries-extra</span><a - id="dx1-5008"></a><span +class="cmr-8">Only with the hybrid method provided with </span><a +href="#glo:glossaries-extra"><span +class="cmss-8">glossaries-extra</span></a><span class="cmr-8">.</span> -</p><!--l. 823--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1156--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">‡</span></sup> <span class="cmr-8">Provided </span><span -class="cmss-8">sort=none</span><a - id="dx1-5009"></a> <span +class="cmss-8">sort</span><span +class="cmtt-8">=</span><span +class="cmss-8">none</span><a + id="dx1-5008"></a> <span class="cmr-8">is used.</span> -</p><!--l. 824--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1157--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">§</span></sup> <span class="cmr-8">Entries with the same sort value are merged.</span> -</p><!--l. 825--><p class="noindent" ><sup class="textsuperscript"><span -class="msam-10x-x-90">♢</span> </sup> <span +</p><!--l. 1158--><p class="noindent" ><sup class="textsuperscript"><span +class="msam-10x-x-90">♢</span></sup> <span class="cmr-8">Requires some setting up.</span> -</p><!--l. 826--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1159--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">¶</span></sup> <span -class="cmr-8">The locations must be set explicitly through the custom </span><span -class="cmss-8">location</span><a - id="dx1-5010"></a> <span +class="cmr-8">The locations must be set explicitly through the custom </span><span id="textcolor78"><span +class="cmtt-8">location</span></span><a + id="dx1-5009"></a> <span class="cmr-8">field provided by </span><span class="cmss-8">glossaries-extra</span><span class="cmr-8">.</span> -</p><!--l. 829--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1162--><p class="noindent" ><sup class="textsuperscript"><span class="cmr-9">#</span></sup> <span class="cmr-8">Unlimited but unreliable.</span> -</p><!--l. 830--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1163--><p class="noindent" ><sup class="textsuperscript"><span class="tcrm-0900">※</span></sup> <span class="cmr-8">Entries are defined in </span><span -class="cmtt-8">.bib </span><span +class="cmtt-8">bib</span><a + id="dx1-5010"></a> <span class="cmr-8">format. </span><span class="cmtt-8">\newglossaryentry </span><span class="cmr-8">should not be used explicitly.</span> -</p><!--l. 832--><p class="noindent" ><sup class="textsuperscript">⁑</sup> <span -class="cmr-8">Provided </span><span -class="cmss-8">docdefs=true </span><span -class="cmr-8">or </span><span -class="cmss-8">docdefs=restricted </span><span +</p><!--l. 1165--><p class="noindent" ><sup class="textsuperscript">⁑</sup> <span +class="cmr-8">Provided </span><span id="textcolor79"><span +class="cmss-8">docdef</span><span +class="cmtt-8">=</span><span +class="cmss-8">true</span></span><a + id="dx1-5011"></a> <span +class="cmr-8">or </span><span id="textcolor80"><span +class="cmss-8">docdef</span><span +class="cmtt-8">=</span><span +class="cmss-8">restricted</span></span><a + id="dx1-5012"></a> <span class="cmr-8">but not recommended.</span> -</p><!--l. 834--><p class="noindent" ><sup class="textsuperscript"><span -class="cmmi-9">⋆</span> </sup> <span -class="cmr-8">Provided </span><span -class="cmss-8">docdefs=false </span><span -class="cmr-8">or </span><span -class="cmss-8">docdefs=restricted</span><span +</p><!--l. 1167--><p class="noindent" ><sup class="textsuperscript"><span +class="cmmi-9">⋆</span></sup> <span +class="cmr-8">Provided </span><span id="textcolor81"><span +class="cmss-8">docdef</span><span +class="cmtt-8">=</span><span +class="cmss-8">false</span></span><a + id="dx1-5013"></a> <span +class="cmr-8">or </span><span id="textcolor82"><span +class="cmss-8">docdef</span><span +class="cmtt-8">=</span><span +class="cmss-8">restricted</span></span><a + id="dx1-5014"></a><span class="cmr-8">.</span> -</p><!--l. 836--><p class="noindent" ><sup class="textsuperscript"><span +</p><!--l. 1169--><p class="noindent" ><sup class="textsuperscript"><span class="pzdr-x-x-90">✾</span></sup> <span class="cmr-8">Irrelevant with </span><span -class="cmss-8">sort=none</span><a - id="dx1-5011"></a><span -class="cmr-8">. (The </span><span -class="cmss-8">record=only </span><span +class="cmss-8">sort</span><span +class="cmtt-8">=</span><span +class="cmss-8">none</span><a + id="dx1-5015"></a><span +class="cmr-8">. (The </span><span id="textcolor83"><span +class="cmss-8">record</span><span +class="cmtt-8">=</span><span +class="cmss-8">only</span></span><a + id="dx1-5016"></a> <span class="cmr-8">option automatically switches this on.)</span> - - + + </p> </div><hr class="endfloat" /> </div> <a - id="x1-5012r1"></a> + id="x1-5017r1"></a> <h4 class="likesubsectionHead"><a - id="x1-60001"></a><a + id="x1-60001"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option1">🔗</a><a id="option1"></a>Option 1 (<span class="TEX">T<span class="E">E</span>X</span>)</h4> -<!--l. 843--><p class="noindent" >This option doesn’t require an external <a -href="#glo:indexingapp">indexing application</a> but, with the default -alphabetic sorting, it’s very slow with severe limitations. If you want a sorted list, it -doesn’t work well for <a -href="#glo:exlatinalph">extended Latin alphabets</a> or <a -href="#glo:nonlatinalph">non-Latin alphabets</a>. However, if -you use the <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-6001"></a> package option (the default for Option 1) then the +<!--l. 1176--><p class="noindent" >Example Document: + + +</p> + <div class="verbatim" id="verbatim-5"> +\documentclass{article} + <br />\usepackage{glossaries} +</div> +<!--l. 1180--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-6001"></a></strong><span +class="cmtt-10"> %</span><span +class="cmtt-10"> use</span><span +class="cmtt-10"> TeX</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> sort</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-6"> +\newglossaryentry{sample}{name={sample}, + <br />  description={an example}} + <br />\begin{document} + <br />\gls{sample}. +</div> +<!--l. 1189--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\printnoidxglossary</span><a + id="dx1-6002"></a></strong> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> You can place all your entry definitions in a separate file and load it in the preamble with <span +class="cmtt-10">\loadglsentries</span><a + id="dx1-6003"></a> +(<span +class="cmti-10">after </span><span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-6004"></a>). +<!--l. 1198--><p class="indent" > This option doesn’t require an external <a +href="#glo:indexingapp">indexing application</a> but, with the default alphabetic sorting, it’s +very slow with severe limitations. If you want a sorted list, it doesn’t work well for <a +href="#glo:exlatinalph">extended Latin alphabets</a> or <a +href="#glo:nonlatinalph">non-Latin alphabets</a>. However, if you use the <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-6005"></a> package option (the default for Option 1) then +the <a href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> accent commands</a> will be ignored, so if an entry’s name is set to -<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">{\’e}lite</span></span></span> then the sort value will default to <span +class="E">E</span>X</span></span> accent commands</a> will be ignored, so if an entry’s name is set to <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">{\’e}lite</span></span></span> then the sort +value will default to <span class="cmtt-10">elite </span>if <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-6002"></a> is used and -will default to <span class="obeylines-h"><span class="verb"><span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-6006"></a> is used and will default to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\’elite</span></span></span> if <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-6003"></a> is used. If you have any other kinds of -commands that don’t expand to ASCII characters, such as <span -class="cmtt-10">\alpha </span>or <span -class="cmtt-10">\si</span>, then you -must use <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-6004"></a> or change the sort method (<span -class="cmss-10">sort=use</span><a - id="dx1-6005"></a> or <span -class="cmss-10">sort=def</span><a - id="dx1-6006"></a>) in the +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-6007"></a> is used. If +you have any other kinds of commands that don’t expand to ASCII characters, such as <span +class="cmtt-10">\alpha </span>or +<span +class="cmtt-10">\si</span>, then you must use <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-6008"></a> or change the sort method (<span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-6009"></a> or <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-6010"></a>) in the package options or explicitly set the <span -class="cmss-10">sort</span><a - id="dx1-6007"></a> key when you define the relevant entries. For -example: - - -</p> - <div class="verbatim" id="verbatim-2"> -\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, - <br /> sort={alpha},description={...}} -</div> -<!--l. 862--><p class="nopar" > -</p><!--l. 864--><p class="indent" > This option works best with the <span -class="cmss-10">sort=def</span><a - id="dx1-6008"></a> or <span -class="cmss-10">sort=use</span><a - id="dx1-6009"></a> setting. For any other setting, be -prepared for a long document build time, especially if you have a lot of entries defined. <span -class="cmbx-10">This</span> -<span -class="cmbx-10">option is intended as a last resort for alphabetical sorting. </span>This option allows a -mixture of sort methods. (For example, sorting by word order for one glossary and order of -use for another.) This option is not suitable for hierarchical glossaries and does not form +class="cmtt-10">sort</span><a + id="dx1-6011"></a> key when you define the relevant entries. For example: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-6012"></a><span +class="cmtt-10">{alpha}{name={\ensuremath{\alpha}},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">sort={alpha}</span></strong><span +class="cmtt-10">,description={...}}</span> +</div> +</div> +<!--l. 1218--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has a modified <span +class="cmss-10">symbols</span><a + id="dx1-6013"></a> package option that provides <span id="textcolor84"><span +class="cmtt-10">\glsxtrnewsymbol</span></span><a + id="dx1-6014"></a>, which +automatically sets the <span +class="cmtt-10">sort</span><a + id="dx1-6015"></a> key to the entry label (instead of the <span +class="cmtt-10">name</span><a + id="dx1-6016"></a>). </div> +</p><!--l. 1222--><p class="noindent" > +</p><!--l. 1224--><p class="indent" > This option works best with the <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-6017"></a> or <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-6018"></a> setting. For any other setting, be prepared for a long +document build time, especially if you have a lot of entries defined. <strong>This option is intended as a last resort for +alphabetical sorting.</strong> This option allows a mixture of sort methods. (For example, sorting by word order for one +glossary and order of use for another.) This option is not suitable for hierarchical glossaries and does not form ranges in the <a href="#glo:numberlist">number list<a - id="dx1-6010"></a>s</a>. If you really can’t use an <a -href="#glo:indexingapp">indexing application</a> consider using -<a -href="#option5">Option 5</a> instead. -</p><!--l. 875--><p class="indent" > + id="dx1-6019"></a>s</a>. If you really can’t use an <a +href="#glo:indexingapp">indexing application</a> consider using <a +href="#option5">Option 5</a> +instead. +</p><!--l. 1235--><p class="indent" > </p><ol class="enumerate1" > <li - class="enumerate" id="x1-6012x1">Add - - - <div class="verbatim" id="verbatim-3"> + class="enumerate" id="x1-6021x1">Add + + + <div class="verbatim" id="verbatim-7"> \makenoidxglossaries </div> - <!--l. 879--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining - Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>). + <!--l. 1239--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining Glossary + Entries<!--tex4ht:ref: sec:newglosentry --></a>). </p></li> <li - class="enumerate" id="x1-6014x2">Put - - - <div class="verbatim" id="verbatim-4"> + class="enumerate" id="x1-6023x2">Put + + + <div class="verbatim" id="verbatim-8"> \printnoidxglossary </div> - <!--l. 886--><p class="nopar" > where you want your list of entries to appear (described in <a -href="#sec:printglossary"><span -class="tcrm-1000">§</span>10 </a><a -href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). - Alternatively, to display all glossaries use the iterative command: - - + <!--l. 1246--><p class="nopar" > where you want your list of entries to appear (described in <a +href="#sec:printglossary">§10 </a><a +href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). Alternatively, to + display all glossaries use the iterative command: + + </p> - <div class="verbatim" id="verbatim-5"> + <div class="verbatim" id="verbatim-9"> \printnoidxglossaries </div> - <!--l. 892--><p class="nopar" > + <!--l. 1252--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-6016x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> twice on your document. (As you would do to make a table of contents - appear.) For example, click twice on the “typeset” or “build” or “PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span>” button - in your editor.</li></ol> -<!--l. 899--><p class="indent" > Complete example: - - + class="enumerate" id="x1-6025x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> twice on your document. (As you would do to make a table of contents appear.) For + example, click twice on the “typeset” or “build” or “PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>” button in your editor.</li></ol> +<a + id="x1-6026r2"></a> +<!--l. 1259--><p class="noindent" > </p> - <div class="verbatim" id="verbatim-6"> + <h4 class="likesubsectionHead"><a + id="x1-70002"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option2">🔗</a><a + id="option2"></a>Option 2 (<span +class="cmtt-10">makeindex</span>)</h4> +<!--l. 1261--><p class="noindent" >Example document: + + +</p> + <div class="verbatim" id="verbatim-10"> \documentclass{article}  <br />\usepackage{glossaries} - <br />\makenoidxglossaries % use TeX to sort - <br />\newglossaryentry{sample}{name={sample}, - <br />  description={an example}} +</div> +<!--l. 1265--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\makeglossaries</span><a + id="dx1-7001"></a></strong><span +class="cmtt-10"> %</span><span +class="cmtt-10"> open</span><span +class="cmtt-10"> glossary</span><span +class="cmtt-10"> files</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-11"> +\newglossaryentry{sample}{name={sample}, + <br /> description={an example}}  <br />\begin{document}  <br />\gls{sample}. - <br />\printnoidxglossary - <br />\end{document} </div> -<!--l. 910--><p class="nopar" > -<a - id="x1-6017r2"></a> -</p><!--l. 912--><p class="noindent" > -</p> - <h4 class="likesubsectionHead"><a - id="x1-70002"></a><a - id="option2"></a>Option 2 (<span -class="cmtt-10">makeindex</span>)</h4> -<!--l. 914--><p class="noindent" >This option uses a <a +<!--l. 1274--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\printglossary</span><a + id="dx1-7002"></a></strong> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> You can place all your entry definitions in a separate file and load it in the preamble with <span +class="cmtt-10">\loadglsentries</span><a + id="dx1-7003"></a> +(<span +class="cmti-10">after </span><span +class="cmtt-10">\makeglossaries</span><a + id="dx1-7004"></a>). +<!--l. 1283--><p class="indent" > This option uses a <a href="#glo:cli">CLI</a> application called <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7001"></a></a> to sort the entries. This application -comes with all modern <span class="TEX">T<span + id="dx1-7005"></a></a> to sort the entries. This application comes with all +modern <span class="TEX">T<span class="E">E</span>X</span> distributions, but it’s hard-coded for the non-extended <a -href="#glo:latinalph">Latin -alphabet<a - id="dx1-7002"></a></a>. It can’t correctly sort accent commands (such as <span +href="#glo:latinalph">Latin alphabet<a + id="dx1-7006"></a></a>. It can’t correctly sort +accent commands (such as <span class="cmtt-10">\’ </span>or <span -class="cmtt-10">\c</span>) and fails with UTF-8 -characters, especially for any sort values that start with a UTF-8 character (as it separates -the octets resulting in an invalid file encoding). This process involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> write -the glossary information to a temporary file which <a +class="cmtt-10">\c</span>) and fails with UTF-8 characters, especially for any sort values that start +with a UTF-8 character (as it separates the octets resulting in an invalid file encoding). This process involves +making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> write the glossary information to a temporary file which <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7003"></a></a> reads. Then <a + id="dx1-7007"></a></a> reads. Then <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7004"></a></a> writes -a new file containing the code to typeset the glossary. Then <span -class="cmtt-10">\printglossary </span>reads this file in -on the next run. -</p><!--l. 926--><p class="indent" > This option works best if you want to sort entries according to the English alphabet and -you don’t want to install Perl (or Java or you don’t want to use <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>). This method -can also work with the restricted shell escape since <a + id="dx1-7008"></a></a> +writes a new file containing the code to typeset the glossary. Then <span +class="cmtt-10">\printglossary </span>reads this file in on the +next run. +</p><!--l. 1295--><p class="indent" > This option works best if you want to sort entries according to the English alphabet and you don’t want to +install Perl or Java. This method can also work with the restricted shell escape since <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7005"></a></a> is considered a trusted -application. (So you should be able to use the <span + id="dx1-7009"></a></a> is considered a +trusted application. (So you should be able to use the <span class="cmss-10">automake</span><a - id="dx1-7006"></a> package option provided the shell -escape hasn’t been completely disabled.) -</p><!--l. 934--><p class="indent" > This method can form ranges in the <a + id="dx1-7010"></a> package option provided the shell escape hasn’t +been completely disabled.) +</p><!--l. 1302--><p class="indent" > This method can form ranges in the <a href="#glo:numberlist">number list<a - id="dx1-7007"></a></a> but only accepts limited number formats: -<span + id="dx1-7011"></a></a> but only accepts limited number formats: <span class="cmtt-10">\arabic</span>, <span -class="cmtt-10">\roman</span>, <span +class="cmtt-10">\roman</span>, +<span class="cmtt-10">\Roman</span>, <span class="cmtt-10">\alph </span>and <span class="cmtt-10">\Alph</span>. -</p><!--l. 938--><p class="indent" > This option does not allow a mixture of sort methods. All glossaries must be sorted -according to the same method: word/letter ordering or order of use or order of definition. If -you need word ordering for one glossary and letter ordering for another you’ll have to -explicitly call <a +</p><!--l. 1306--><p class="indent" > This option does not allow a mixture of sort methods. All glossaries must be sorted according to the same +method: word/letter ordering or order of use or order of definition. If you need word ordering for one +glossary and letter ordering for another you’ll have to explicitly call <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7008"></a></a> for each glossary type. (The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-7009"></a> package allows a hybrid -mix of Options <a + id="dx1-7012"></a></a> for each glossary +type. +</p><!--l. 1313--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package allows a hybrid mix of Options <a href="#option1">1</a> and <a -href="#option2">2</a> to provide word/letter ordering with <a -href="#option2">Option 2</a> and order of -use/definition with <a -href="#option1">Option 1</a>. See the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-7010"></a> documentation for further -details.) -</p><!--l. 949--><p class="indent" > +href="#option2">2</a> to provide word/letter ordering +with <a +href="#option2">Option 2</a> and order of use/definition with <a +href="#option1">Option 1</a>. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> documentation +for further details. See also the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> alternative to <a +href="#ex:sampleSort"><span +class="cmtt-10">sampleSort.tex</span></a> in <a +href="#sec:samplessort">§19.5 </a><a +href="#sec:samplessort">Sorting<!--tex4ht:ref: sec:samplessort --></a>. +</div> +</p><!--l. 1320--><p class="noindent" > +</p><!--l. 1322--><p class="indent" > </p><ol class="enumerate1" > <li - class="enumerate" id="x1-7012x1">If you want to use <a + class="enumerate" id="x1-7014x1">If you want to use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7013"></a>’s</a> <span + id="dx1-7015"></a>’s</a> <span class="cmtt-10">-g</span><a - id="dx1-7014"></a> option you must change the quote character using - - - <span + id="dx1-7016"></a> option you must change the quote character using <span class="cmtt-10">\GlsSetQuote</span><a - id="dx1-7015"></a>. For example: - - - <div class="verbatim" id="verbatim-7"> + id="dx1-7017"></a>. For + example: + + + <div class="verbatim" id="verbatim-12"> \GlsSetQuote{+} </div> - <!--l. 954--><p class="nopar" > This must be used before <span + <!--l. 1327--><p class="nopar" > This must be used before <span class="cmtt-10">\makeglossaries</span>. Note that if you are using <span class="cmss-10">babel</span><a - id="dx1-7016"></a>, the - shorthands aren’t enabled until the start of the document, so you won’t be able to use - the shorthands in definitions made in the preamble. + id="dx1-7018"></a>, the shorthands aren’t + enabled until the start of the document, so you won’t be able to use the shorthands in definitions made in + the preamble. </p></li> <li - class="enumerate" id="x1-7018x2">Add - - - <div class="verbatim" id="verbatim-8"> + class="enumerate" id="x1-7020x2">Add + + + <div class="verbatim" id="verbatim-13"> \makeglossaries </div> - <!--l. 963--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining - Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>). + <!--l. 1336--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining Glossary + Entries<!--tex4ht:ref: sec:newglosentry --></a>). </p></li> <li - class="enumerate" id="x1-7020x3">Put - - - <div class="verbatim" id="verbatim-9"> + class="enumerate" id="x1-7022x3">Put + + + <div class="verbatim" id="verbatim-14"> \printglossary </div> - <!--l. 971--><p class="nopar" > where you want your list of entries to appear (described in <a -href="#sec:printglossary"><span -class="tcrm-1000">§</span>10 </a><a -href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). - Alternatively, to display all glossaries use the iterative command: - - + <!--l. 1344--><p class="nopar" > where you want your list of entries to appear (described in <a +href="#sec:printglossary">§10 </a><a +href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>). Alternatively, to + display all glossaries use the iterative command: + + </p> - <div class="verbatim" id="verbatim-10"> + <div class="verbatim" id="verbatim-15"> \printglossaries </div> - <!--l. 977--><p class="nopar" > + <!--l. 1350--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-7022x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + class="enumerate" id="x1-7024x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> on your document. This creates files with the extensions <span -class="cmtt-10">.glo </span>and <span -class="cmtt-10">.ist</span> - (for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="cmtt-10">glo</span><a + id="dx1-7025"></a> and <span +class="cmtt-10">ist</span><a + id="dx1-7026"></a> (for example, if your + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> document is called <span -class="cmtt-10">myDoc.tex</span>, then you’ll have two - extra files called <span -class="cmtt-10">myDoc.glo </span>and <span -class="cmtt-10">myDoc.ist</span>). If you look at your document - at this point, you won’t see the glossary as it hasn’t been created yet. (If - you use <span -class="cmss-10">glossaries-extra</span><a - id="dx1-7023"></a> you’ll see the section heading and some boilerplate +class="cmtt-10">myDoc.tex</span>, then you’ll have two extra files called <span +class="cmtt-10">myDoc.glo </span>and + <span +class="cmtt-10">myDoc.ist</span>). If you look at your document at this point, you won’t see the glossary as it hasn’t been + created yet. (If you use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> you’ll see the section heading and some boilerplate text.) - </li> + <!--l. 1361--><p class="noindent" >If you have used package options such as <span +class="cmss-10">symbols</span><a + id="dx1-7027"></a> there will also be other sets of files corresponding to the + extra glossaries that were created by those options. + </p></li> <li - class="enumerate" id="x1-7025x5">Run <a + class="enumerate" id="x1-7029x5"><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.run">🔗</a><a + id="makeindex.run"></a> Run <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7026"></a></a> with the <span + id="dx1-7030"></a></a> with the <span class="cmtt-10">.glo </span>file as the input file and the <span -class="cmtt-10">.ist </span>file as the style so - that it creates an output file with the extension <span -class="cmtt-10">.gls</span>. If you have access to a - terminal or a command prompt (for example, the MSDOS command prompt for - Windows users or the bash console for Unix-like users) then you need to run the - command: - - - <div class="verbatim" id="verbatim-11"> - makeindex -s myDoc.ist -o myDoc.gls myDoc.glo -</div> - <!--l. 996--><p class="nopar" > (Replace <span +class="cmtt-10">.ist </span>file as the style so that it creates an + output file with the extension <span +class="cmtt-10">.gls</span>. If you have access to a terminal or a command prompt (for example, + the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to + run the command: + <!--l. 1371--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s myDoc.ist -o myDoc.gls myDoc.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + (Replace <span class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> document file. Avoid spaces in the - file name if possible.) If you don’t know how to use the command prompt, - then you can probably access <a +class="E">E</span>X</span></span> document file. Avoid spaces in the file name if + possible. The <span +class="tctt-1000">$ </span>symbol indicates the command prompt and should be omitted.) + </p><!--l. 1378--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span +class="cmtt-10">type</span><a + id="dx1-7031"></a>. See <a +href="#sec:makeindexapp">§1.4.4 </a><a +href="#sec:makeindexapp">Using <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7027"></a></a> via your text editor, but each editor - has a different method of doing this, so I can’t give a general description. - You will have to check your editor’s manual. The simplest approach is to use - <span + id="dx1-7032"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> + for further details. <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-7033"></a></a> must be called for each set of files. </div> + </p><!--l. 1382--><p class="noindent" > + </p><!--l. 1384--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably access <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-7034"></a></a> via your + text editor, but each editor has a different method of doing this. See <a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or + makeglossaries-lite or bib2gls into the document build</a> for some examples. + </p><!--l. 1390--><p class="noindent" >Alternatively, run <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-7035"></a></a> indirectly via the <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-7036"></a></a> script: + </p><!--l. 1392--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries myDoc + <br /></pre><spacer type=vertical size=10> + + + <br /></span> + Note that the file extension isn’t supplied in this case. (Replace <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-7037"></a></a> with + <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-7038"></a></a> if you don’t have Perl installed.) This will pick up all the file extensions + from the <span +class="cmtt-10">aux</span><a + id="dx1-7039"></a> file and run <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-7040"></a></a> the appropriate number of times with all the necessary + switches. + </p><!--l. 1402--><p class="noindent" >The simplest approach is to use <span class="cmtt-10">arara</span><a - id="dx1-7028"></a> and add the following comment lines to the start of your document: + id="dx1-7041"></a> and add the following comment lines to the start of your document: </p><div class="alltt"> <div class="obeylines-v"> <span @@ -2224,292 +3691,359 @@ class="cmtt-10"> pdflatex</span> </div> </div> (Replace <span class="cmtt-10">makeglossaries </span>with <span -class="cmtt-10">makeglossaries-lite </span>if you don’t have Perl - installed.) - <!--l. 1013--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter - ordering you need to add the <span +class="cmtt-10">makeglossarieslite </span>in the second line above if you don’t have Perl + installed. Note that there’s no hyphen in this case.) + <!--l. 1413--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to + add the <span class="cmtt-10">-l</span><a - id="dx1-7029"></a> switch: - - -</p> - <div class="verbatim" id="verbatim-12"> - makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo -</div> - <!--l. 1018--><p class="nopar" > (See <a -href="#sec:makeindexapp"><span -class="tcrm-1000">§</span>1.5.4 </a><a + id="dx1-7042"></a> switch: + </p><!--l. 1416--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + (See <a +href="#sec:makeindexapp">§1.4.4 </a><a href="#sec:makeindexapp">Using <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-7030"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using - <span + id="dx1-7043"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span class="cmtt-10">makeindex</span><a - id="dx1-7031"></a> explicitly.) If you use <a + id="dx1-7044"></a> explicitly.) If you + use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-7032"></a></a> or <a + id="dx1-7045"></a></a> or <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-7033"></a></a> - then use the <span -class="cmss-10">order=letter</span><a - id="dx1-7034"></a> package option and the <span + id="dx1-7046"></a></a> then use the <span +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a + id="dx1-7047"></a> package option and the <span class="cmtt-10">-l</span><a - id="dx1-7035"></a> option will be added - automatically. + id="dx1-7048"></a> option + will be added automatically. </p></li> <li - class="enumerate" id="x1-7037x6">Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> on - your document again. You’ll need to repeat the process if you have used the <span + class="enumerate" id="x1-7050x6"><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.relatex">🔗</a><a + id="makeindex.relatex"></a> Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document + again.</li></ol> +<!--l. 1428--><p class="noindent" >You’ll need to repeat the last step if you have used the <span class="cmss-10">toc</span><a - id="dx1-7038"></a> option - (unless you’re using <span -class="cmss-10">glossaries-extra</span><a - id="dx1-7039"></a>) to ensure the section heading is added - to the table of contents. You’ll also need to repeat the process if you have - any cross-references which can’t be indexed until the glossary file has been - created.</li></ol> -<!--l. 1034--><p class="indent" > Complete example: - - -</p> - <div class="verbatim" id="verbatim-13"> -\documentclass{article} - <br />\usepackage{glossaries} - <br />\makeglossaries % open glossary files - <br />\newglossaryentry{sample}{name={sample}, - <br /> description={an example}} - <br />\begin{document} - <br />\gls{sample}. - <br />\printglossary - <br />\end{document} -</div> -<!--l. 1045--><p class="nopar" > + id="dx1-7051"></a> option (unless you’re using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>) to ensure the +section heading is added to the table of contents. You’ll also need to repeat steps <a +href="#makeindex.run">5<!--tex4ht:ref: makeindex.run --></a> and <a +href="#makeindex.relatex">6<!--tex4ht:ref: makeindex.relatex --></a> if you have any +cross-references which can’t be indexed until the glossary file has been created. <a - id="x1-7040r3"></a> -</p><!--l. 1047--><p class="noindent" > + id="x1-7052r3"></a> +</p><!--l. 1435--><p class="noindent" > </p> <h4 class="likesubsectionHead"><a - id="x1-80003"></a><a + id="x1-80003"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option3">🔗</a><a id="option3"></a>Option 3 (<span class="cmtt-10">xindy</span>)</h4> -<!--l. 1049--><p class="noindent" >This option uses a <a +<!--l. 1437--><p class="noindent" >Example document: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /><span +class="cmtt-10">\usepackage[</span><strong><span +class="cmtt-10">xindy</span></strong><span +class="cmtt-10">]{glossaries}</span> +<br /><strong><span +class="cmtt-10">\makeglossaries</span><a + id="dx1-8001"></a></strong><span +class="cmtt-10"> %</span><span +class="cmtt-10"> open</span><span +class="cmtt-10"> glossary</span><span +class="cmtt-10"> files</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-16"> +\newglossaryentry{sample}{name={sample}, + <br /> description={an example}} + <br />\begin{document} + <br />\gls{sample}. +</div> +<!--l. 1448--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\printglossary</span><a + id="dx1-8002"></a></strong> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> You can place all your entry definitions in a separate file and load it in the preamble with <span +class="cmtt-10">\loadglsentries</span><a + id="dx1-8003"></a> +(<span +class="cmti-10">after </span><span +class="cmtt-10">\makeglossaries</span><a + id="dx1-8004"></a>). +<!--l. 1457--><p class="indent" > This option uses a <a href="#glo:cli">CLI</a> application called <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8001"></a></a> to sort the entries. This application is more -flexible than <span + id="dx1-8005"></a></a> to sort the entries. This application is more flexible than +<span class="cmtt-10">makeindex </span>and is able to sort <a href="#glo:exlatinalph">extended Latin alphabets</a> or <a -href="#glo:nonlatinalph">non-Latin alphabets</a>, -however it does still have some limitations. -</p><!--l. 1054--><p class="indent" > The <a +href="#glo:nonlatinalph">non-Latin alphabets</a>, however it does still have some +limitations. +</p><!--l. 1462--><p class="indent" > The <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8002"></a></a> application comes with both <span class="TEX">T<span + id="dx1-8006"></a></a> application comes with both <span class="TEX">T<span class="E">E</span>X</span> Live and MiK<span class="TEX">T<span class="E">E</span>X</span>, but since <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8003"></a></a> is a -Perl script, you will also need to install Perl, if you don’t already have it. In a similar way to -<a -href="#option2">Option 2</a>, this option involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> write the glossary information to -a temporary file which <a + id="dx1-8007"></a></a> is a Perl script, you will +also need to install Perl, if you don’t already have it. In a similar way to <a +href="#option2">Option 2</a>, this option involves making +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> write the glossary information to a temporary file which <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8004"></a></a> reads. Then <a + id="dx1-8008"></a></a> reads. Then <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8005"></a></a> writes a new file containing the -code to typeset the glossary. Then <span + id="dx1-8009"></a></a> writes a new file +containing the code to typeset the glossary. Then <span class="cmtt-10">\printglossary </span>reads this file in on the next run. -</p><!--l. 1062--><p class="indent" > This is the best option with just the base <span -class="cmss-10">glossaries </span>package if you want to sort according -to a language other than English or if you want non-standard location lists, but it can require -some setting up (see <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a -href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>). There are some problems with certain sort -values: </p> +</p><!--l. 1470--><p class="indent" > This is the best option with just the base <span +class="cmss-10">glossaries </span>package if you want to sort according to a language +other than English or if you want non-standard location lists, but it can require some setting up (see <a +href="#sec:xindy">§11 </a><a +href="#sec:xindy">Xindy +(Option 3)<!--tex4ht:ref: sec:xindy --></a>). There are some problems with certain sort values: </p> <ul class="itemize1"> <li class="itemize">entries with the same sort value are merged by <span class="cmtt-10">xindy</span><a - id="dx1-8006"></a> into a single glossary line - so you must make sure that each entry has a unique sort value; + id="dx1-8010"></a> into a single glossary line so you must make + sure that each entry has a unique sort value; </li> <li class="itemize"><span class="cmtt-10">xindy</span><a - id="dx1-8007"></a> forbids empty sort values; + id="dx1-8011"></a> forbids empty sort values; </li> <li class="itemize"><span class="cmtt-10">xindy</span><a - id="dx1-8008"></a> automatically strips control sequences, the math-shift character <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">$</span></span></span> and - braces <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">{}</span></span></span> from the sort value, which is usually desired but this can cause the sort - value to collapse to an empty string which <span + id="dx1-8012"></a> automatically strips control sequences, the math-shift character <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">$</span></span></span> and braces <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">{}</span></span></span> from the + sort value, which is usually desired but this can cause the sort value to collapse to an empty string + which <span class="cmtt-10">xindy</span><a - id="dx1-8009"></a> forbids.</li></ul> -<!--l. 1077--><p class="noindent" >In these problematic cases, you must set the <span -class="cmss-10">sort</span><a - id="dx1-8010"></a> field explicitly. For example: - - -</p> - <div class="verbatim" id="verbatim-14"> -\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, - <br /> sort={alpha},description={...}} -</div> -<!--l. 1082--><p class="nopar" > -</p><!--l. 1084--><p class="indent" > All glossaries must be sorted according to the same method (word/letter ordering, order -of use, or order of definition). (The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-8011"></a> package allows a hybrid mix -of Options <a + id="dx1-8013"></a> forbids.</li></ul> +<!--l. 1485--><p class="noindent" >In these problematic cases, you must set the <span +class="cmtt-10">sort</span><a + id="dx1-8014"></a> field explicitly. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{alpha}{name={\ensuremath{\alpha}},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">sort={alpha},</span></strong><span +class="cmtt-10">description={...}}</span> + + +</div> +</div> +<!--l. 1491--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has a modified <span +class="cmss-10">symbols</span><a + id="dx1-8015"></a> package option that provides <span id="textcolor85"><span +class="cmtt-10">\glsxtrnewsymbol</span></span><a + id="dx1-8016"></a>, which +automatically sets the <span +class="cmtt-10">sort</span><a + id="dx1-8017"></a> key to the entry label (instead of the <span +class="cmtt-10">name</span><a + id="dx1-8018"></a>). </div> +</p><!--l. 1495--><p class="noindent" > +</p><!--l. 1497--><p class="indent" > All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of +definition). +</p><!--l. 1500--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package allows a hybrid mix of Options <a href="#option1">1</a> and <a -href="#option3">3</a> to provide word/letter ordering with <a -href="#option3">Option 3</a> and order of -use/definition with <a -href="#option1">Option 1</a>. See the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-8012"></a> documentation for further -details.) -</p><!--l. 1091--><p class="indent" > +href="#option3">3</a> to provide word/letter ordering with +<a +href="#option3">Option 3</a> and order of use/definition with <a +href="#option1">Option 1</a>. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> documentation for further details. +</div> +</p><!--l. 1505--><p class="noindent" > +</p><!--l. 1507--><p class="indent" > </p><ol class="enumerate1" > <li - class="enumerate" id="x1-8014x1">Add the <span + class="enumerate" id="x1-8020x1">Add the <span class="cmss-10">xindy</span><a - id="dx1-8015"></a> option to the <span + id="dx1-8021"></a> option to the <span class="cmss-10">glossaries </span>package option list: - - - <div class="verbatim" id="verbatim-15"> + + + <div class="verbatim" id="verbatim-17"> \usepackage[xindy]{glossaries} </div> - <!--l. 1096--><p class="nopar" > If you are using a non-Latin script you’ll also need to either switch off the creation of - the number group: - - + <!--l. 1512--><p class="nopar" > If you are using a non-Latin script you’ll also need to either switch off the creation of the number + group: + + </p> - <div class="verbatim" id="verbatim-16"> + <div class="verbatim" id="verbatim-18"> \usepackage[xindy={glsnumbers=false}]{glossaries} </div> - <!--l. 1101--><p class="nopar" > or use either <span + <!--l. 1517--><p class="nopar" > or use either <span class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits{</span>⟨<span class="cmti-10">letter</span>⟩<span -class="cmtt-10">} </span>or <span -class="cmtt-10">\GlsSetXdyNumberGroupOrder</span> - <span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">} </span>(to indicate the first letter group to follow the + digits) or <span +class="cmtt-10">\GlsSetXdyNumberGroupOrder{</span>⟨<span class="cmti-10">spec</span>⟩<span -class="cmtt-10">} </span>to indicate where the number group should be placed (see <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a -href="#sec:xindy">Xindy (Option - 3)<!--tex4ht:ref: sec:xindy --></a>). +class="cmtt-10">} </span>to indicate where the number group should be placed (see + <a +href="#sec:xindy">§11 </a><a +href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>). </p></li> <li - class="enumerate" id="x1-8017x2">Add <span -class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your entries, as - described in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>). + class="enumerate" id="x1-8023x2">Add <span +class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your entries, as described in <a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining + Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>). </li> <li - class="enumerate" id="x1-8019x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + class="enumerate" id="x1-8025x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> on your document. This creates files with the extensions <span -class="cmtt-10">.glo </span>and <span -class="cmtt-10">.xdy</span> - (for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="cmtt-10">glo</span><a + id="dx1-8026"></a> and <span +class="cmtt-10">xdy</span><a + id="dx1-8027"></a> (for example, if your + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> document is called <span -class="cmtt-10">myDoc.tex</span>, then you’ll have two extra - files called <span +class="cmtt-10">myDoc.tex</span>, then you’ll have two extra files called <span class="cmtt-10">myDoc.glo </span>and <span -class="cmtt-10">myDoc.xdy</span>). If you look at your document at this point, you - won’t see the glossary as it hasn’t been created yet. (If you’re using the extension - package <span -class="cmss-10">glossaries-extra</span><a - id="dx1-8020"></a>, you’ll see the section header and some boilerplate +class="cmtt-10">myDoc.xdy</span>). + If you look at your document at this point, you won’t see the glossary as it hasn’t been created yet. (If + you’re using the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, you’ll see the section header and some boilerplate text.) - </li> + <!--l. 1535--><p class="noindent" >If you have used package options such as <span +class="cmss-10">symbols</span><a + id="dx1-8028"></a> there will also be other sets of files corresponding to the + extra glossaries that were created by those options. + </p></li> <li - class="enumerate" id="x1-8022x4">Run <a + class="enumerate" id="x1-8030x4">Run <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8023"></a></a> with the <span + id="dx1-8031"></a></a> with the <span class="cmtt-10">.glo </span>file as the input file and the <span -class="cmtt-10">.xdy </span>file as a module so that it - creates an output file with the extension <span -class="cmtt-10">.gls</span>. You also need to set the language name - and input encoding. If you have access to a terminal or a command prompt - (for example, the MSDOS command prompt for Windows users or the bash - console for Unix-like users) then you need to run the command (all on one +class="cmtt-10">.xdy </span>file as a module so that it creates an output + file with the extension <span +class="cmtt-10">.gls</span>. You also need to set the language name and input encoding. If you have + access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows + users or the bash console for Unix-like users) then you need to run the command (all on one line): - - - <div class="verbatim" id="verbatim-17"> - xindy -L english -C utf8 -I xindy -M myDoc -  <br />-t myDoc.glg -o myDoc.gls myDoc.glo -</div> - <!--l. 1129--><p class="nopar" > (Replace <span + <!--l. 1547--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + (Replace <span class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> document file. Avoid spaces in the - file name. If necessary, also replace <span +class="E">E</span>X</span></span> document file. Avoid spaces in the file name. If + necessary, also replace <span class="cmtt-10">english </span>with the name of your language and <span -class="cmtt-10">utf8</span> - with your input encoding, for example, <span +class="cmtt-10">utf8 </span>with your input encoding, for + example, <span class="cmtt-10">-L</span><a - id="dx1-8024"></a> <span + id="dx1-8032"></a> <span class="cmtt-10">german -C</span><a - id="dx1-8025"></a> <span -class="cmtt-10">din5007-utf8</span>.) Note that it’s - much simpler to use <a + id="dx1-8033"></a> <span +class="cmtt-10">din5007-utf8</span>.) + </p><!--l. 1556--><p class="noindent" ><div class="important" title="Important Note"> The file extensions vary according to the glossary <span +class="cmtt-10">type</span><a + id="dx1-8034"></a>. See <a +href="#sec:xindyapp">§1.4.3 </a><a +href="#sec:xindyapp">Using <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-8035"></a></a> explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for + further details. <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-8036"></a></a> must be called for each set of files. </div> + </p><!--l. 1560--><p class="noindent" > + </p><!--l. 1562--><p class="noindent" >It’s much simpler to use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-8026"></a></a> instead: - - -</p> - <div class="verbatim" id="verbatim-18"> - makeglossaries myDoc -</div> - <!--l. 1138--><p class="nopar" > (Remember that <a + id="dx1-8037"></a></a> instead: + </p><!--l. 1563--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries myDoc + + + <br /></pre><spacer type=vertical size=10> + <br /></span> + Note that the file extension isn’t supplied in this case. This will pick up all the file extensions from the <span +class="cmtt-10">aux</span><a + id="dx1-8038"></a> + file and run <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8027"></a></a> is a Perl script so if you can use <a + id="dx1-8039"></a></a> the appropriate number of times with all the necessary switches. + </p><!--l. 1571--><p class="noindent" >There’s no benefit in using <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-8040"></a></a> with <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8028"></a></a> then you can also use - <a + id="dx1-8041"></a></a>. (Remember that <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-8042"></a></a> is a Perl + script so if you can use <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-8043"></a></a> then you can also use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-8029"></a></a>, and if you don’t want to use <a + id="dx1-8044"></a></a>, and if you don’t want + to use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-8030"></a></a> because you don’t want - to install Perl, then you can’t use <a + id="dx1-8045"></a></a> because you don’t want to install Perl, then you can’t use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8031"></a></a> either.) - </p><!--l. 1144--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably - access <a + id="dx1-8046"></a></a> + either.) + </p><!--l. 1577--><p class="noindent" >If you don’t know how to use the command prompt, then you can probably access <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8032"></a></a> or <a + id="dx1-8047"></a></a> or + <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-8033"></a></a> via your text editor, but each editor has a - different method of doing this, so I can’t give a general description. You - will have to check your editor’s manual. Again, a convenient method is to - use <span -class="cmtt-10">arara </span>and add the follow comment lines to the start of your document: - </p><div class="alltt"> + id="dx1-8048"></a></a> via your text editor, but each editor has a different method of doing this. See + <a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build</a> for some + examples. + </p><!--l. 1583--><p class="noindent" >Again, a convenient method is to use <span +class="cmtt-10">arara </span>and add the follow comment lines to the start of your + document: </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">%</span><span @@ -2525,1985 +4059,1689 @@ class="cmtt-10"> arara:</span><span class="cmtt-10"> pdflatex</span> </div> </div> - <!--l. 1156--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter - ordering you need to add the <span -class="cmss-10">order=letter</span><a - id="dx1-8034"></a> package option: - - + <!--l. 1591--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to + add the <span +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a + id="dx1-8049"></a> package option: + + </p> <div class="verbatim" id="verbatim-19"> \usepackage[xindy,order=letter]{glossaries} </div> - <!--l. 1161--><p class="nopar" > (and return to the previous step). This option is picked up by <a + <!--l. 1596--><p class="nopar" > (and return to the previous step). This option is picked up by <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-8035"></a></a>. If you - are explicitly using <a + id="dx1-8050"></a></a>. If you are explicitly using + <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8036"></a></a> then you’ll need to add <span -class="cmtt-10">-M ord/letorder </span>to the options list. - See <a -href="#sec:xindyapp"><span -class="tcrm-1000">§</span>1.5.3 </a><a + id="dx1-8051"></a></a> then you’ll need to add <span +class="cmtt-10">-M ord/letorder </span>to the options list. See <a +href="#sec:xindyapp">§1.4.3 </a><a href="#sec:xindyapp">Using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-8037"></a></a> explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span + id="dx1-8052"></a></a> explicitly + (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span class="cmtt-10">xindy</span><a - id="dx1-8038"></a> - explicitly. + id="dx1-8053"></a> explicitly. </p></li> <li - class="enumerate" id="x1-8040x5">Once you have successfully completed the previous step, you can now run - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> on your document again. As with the previous option, you may need to - repeat the process to ensure the table of contents and cross-references are - resolved. + class="enumerate" id="x1-8055x5">Once you have successfully completed the previous step, you can now run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> on your document + again. As with <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-8056"></a></a> (<a +href="#option2">Option 2</a>), you may need to repeat the previous step and this step to ensure + the table of contents and cross-references are resolved. </li></ol> -<!--l. 1175--><p class="indent" > Complete example: - - -</p> - <div class="verbatim" id="verbatim-20"> -\documentclass{article} - <br />\usepackage[xindy]{glossaries} - <br />\makeglossaries % open glossary files - <br />\newglossaryentry{sample}{name={sample}, - <br /> description={an example}} - <br />\begin{document} - <br />\gls{sample}. - <br />\printglossary - <br />\end{document} -</div> -<!--l. 1186--><p class="nopar" > <a - id="x1-8041r4"></a> -</p><!--l. 1188--><p class="noindent" > + id="x1-8057r4"></a> +<!--l. 1610--><p class="noindent" > </p> <h4 class="likesubsectionHead"><a - id="x1-90004"></a><a + id="x1-90004"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option4">🔗</a><a id="option4"></a>Option 4 (<span class="cmtt-10">bib2gls</span>)</h4> -<!--l. 1190--><p class="noindent" >This option is only available with the extension package <a +<!--l. 1612--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This option is only available with the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>. This method uses +class="cmss-10">glossaries-extra</span></a> extension package. This method uses <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a id="dx1-9001"></a></a> to both fetch entry definitions from <span -class="cmtt-10">.bib </span>files and to hierarchically sort and -collate. -</p><!--l. 1195--><p class="indent" > All entries must be provided in one or more <span -class="cmtt-10">.bib </span>files. (See the <a +class="cmtt-10">bib</span><a + id="dx1-9002"></a> files and to hierarchically sort and collate. +</p><!--l. 1617--><p class="indent" > Example document: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /><span +class="cmtt-10">\usepackage[</span><span id="textcolor86"><span +class="cmtt-10">record=nameref</span></span><span +class="cmtt-10">]{glossaries-extra}</span> +<br /><span id="textcolor87"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-9003"></a><span +class="cmtt-10">[</span><span id="textcolor88"><span +class="cmtt-10">src</span></span><a + id="dx1-9004"></a><span +class="cmtt-10">={entries}]</span> +<br /><span +class="cmtt-10">\begin{document}</span> +<br /><span +class="cmtt-10">\gls{sample},</span><span +class="cmtt-10"> \gls{alpha},</span><span +class="cmtt-10"> \gls{html}.</span> +<br /><span id="textcolor89"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-9005"></a> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> where the file <span +class="cmtt-10">entries.bib </span>contains: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor90"><span +class="cmtt-10">@entry</span></span><a + id="dx1-9006"></a><span +class="cmtt-10">{sample,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={sample},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={an</span><span +class="cmtt-10"> example}</span> +<br /><span +class="cmtt-10">}</span> + + +<br /><span id="textcolor91"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-9007"></a><span +class="cmtt-10">{alpha,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={\ensuremath{\alpha}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={...}</span> +<br /><span +class="cmtt-10">}</span> +<br /><span id="textcolor92"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-9008"></a><span +class="cmtt-10">{html,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short={HTML},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long={hypertext</span><span +class="cmtt-10"> markup</span><span +class="cmtt-10"> language}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 1643--><p class="indent" > All entries must be provided in one or more <span +class="cmtt-10">bib</span><a + id="dx1-9009"></a> files. See the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-9002"></a></a> user manual for -the required format.) The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-9003"></a> package needs to be loaded with the <span -class="cmss-10">record </span>package -option - - -</p> - <div class="verbatim" id="verbatim-21"> -\usepackage[record]{glossaries-extra} + id="dx1-9010"></a></a> user manual for the required +format. +</p><!--l. 1646--><p class="indent" > <div class="important" title="Important Note"> Note that the <span +class="cmtt-10">sort</span><a + id="dx1-9011"></a> key should not be used. Each entry type (<span id="textcolor93"><span +class="cmtt-10">@entry</span></span><a + id="dx1-9012"></a>, <span id="textcolor94"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-9013"></a>, <span id="textcolor95"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-9014"></a>) +has a particular field that’s used for the sort value by default (<span +class="cmtt-10">name</span><a + id="dx1-9015"></a>, the label, <span +class="cmtt-10">short</span><a + id="dx1-9016"></a>). You will +break this mechanism if you explicitly use the <span +class="cmtt-10">sort</span><a + id="dx1-9017"></a> key. See <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a> for examples. +</div> +</p><!--l. 1653--><p class="noindent" > +</p><!--l. 1655--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package needs to be loaded with the <span id="textcolor96"><span +class="cmss-10">record</span></span><a + id="dx1-9018"></a> package option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor97"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">]{glossaries-extra}</span> </div> -<!--l. 1201--><p class="nopar" > or (equivalently) - - -</p> - <div class="verbatim" id="verbatim-22"> -\usepackage[record=only]{glossaries-extra} +</div> or (equivalently) <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor98"><span +class="cmtt-10">record=only</span></span><span +class="cmtt-10">]{glossaries-extra}</span> </div> -<!--l. 1205--><p class="nopar" > (It’s possible to use a hybrid of this method and Options <a +</div> or (with at least <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> v1.37 and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-9019"></a></a> v1.8): <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor99"><span +class="cmtt-10">record=nameref</span></span><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> The <span id="textcolor100"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-9020"></a> option is the best method. +<!--l. 1670--><p class="indent" > (It’s possible to use a hybrid of this method and Options <a href="#option2">2</a> or <a -href="#option3">3</a> with <span -class="cmss-10">record=alsoindex </span>but in -general there is little need for this and it complicates the build process.) -</p><!--l. 1210--><p class="indent" > Each resource set is loaded with <span -class="cmtt-10">\GlsXtrLoadResources[</span>⟨<span +href="#option3">3</a> with <span id="textcolor101"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">alsoindex</span></span><a + id="dx1-9021"></a> but in general there is +little need for this and it complicates the build process.) +</p><!--l. 1674--><p class="indent" > Each resource set is loaded with <span id="textcolor102"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-9022"></a><span +class="cmtt-10">[</span>⟨<span class="cmti-10">options</span>⟩<span -class="cmtt-10">]</span>. For example: - - -</p> - <div class="verbatim" id="verbatim-23"> -\GlsXtrLoadResources - <br />[% definitions in entries1.bib and entries2.bib: - <br /> src={entries1,entries2}, - <br /> sort={de-CH-1996}% sort according to this locale - <br />] -</div> -<!--l. 1218--><p class="nopar" > You can have multiple resource commands. -</p><!--l. 1221--><p class="indent" > The glossary is displayed using - - -</p> - <div class="verbatim" id="verbatim-24"> -\printunsrtglossary -</div> -<!--l. 1224--><p class="nopar" > Alternatively all glossaries can be displayed using the iterative command: - - -</p> - <div class="verbatim" id="verbatim-25"> -\printunsrtglossaries -</div> -<!--l. 1229--><p class="nopar" > The document is build using: - - -</p> - <div class="verbatim" id="verbatim-26"> -pdflatex myDoc - <br />bib2gls myDoc - <br />pdflatex myDoc +class="cmtt-10">]</span>. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor103"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-9023"></a> +<br /><span +class="cmtt-10">[%</span><span +class="cmtt-10"> definitions</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> entries1.bib</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> entries2.bib:</span> + + +<br /><span +class="cmtt-10"> </span><span id="textcolor104"><span +class="cmtt-10">src</span></span><a + id="dx1-9024"></a><span +class="cmtt-10">={entries1,entries2},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor105"><span +class="cmtt-10">sort</span></span><a + id="dx1-9025"></a><span +class="cmtt-10">={de-CH-1996}%</span><span +class="cmtt-10"> sort</span><span +class="cmtt-10"> according</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> this</span><span +class="cmtt-10"> locale</span> +<br /><span +class="cmtt-10">]</span> </div> -<!--l. 1235--><p class="nopar" > If letter groups are required, you need the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">--group</span></span></span> switch: - - -</p> - <div class="verbatim" id="verbatim-27"> -bib2gls --group myDoc +</div> The <span +class="cmtt-10">bib</span><a + id="dx1-9026"></a> files are identified as a comma-separated list in the value of the <span id="textcolor106"><span +class="cmtt-10">src</span></span><a + id="dx1-9027"></a> key. The <span id="textcolor107"><span +class="cmtt-10">sort</span></span><a + id="dx1-9028"></a> option identifies the +sorting method. This may be a locale identifier for alphabetic sorting, but there are other sort methods +available, such as character code or numeric. One resource set may cover multiple glossaries or one glossary may +be split across multiple resource sets, forming logical sub-blocks. +<!--l. 1691--><p class="indent" > If you want to ensure that all entries are selected, even if they haven’t been referenced in the document, then +add the option <span id="textcolor108"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">=all</span><a + id="dx1-9029"></a>. (There are also ways of filtering the selection or you can even have a +random selection by shuffling and truncating the list. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-9030"></a></a> user manual for further +details.) +</p><!--l. 1697--><p class="indent" > The glossary is displayed using: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor109"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-9031"></a> </div> -<!--l. 1239--><p class="nopar" > Unlike Options <a +</div> Alternatively all glossaries can be displayed using the iterative command: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor110"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-9032"></a> +</div> +</div> The document is built using: +<!--l. 1707--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />bib2gls myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +If letter groups are required, you need the <span id="textcolor111"><span +class="cmtt-10">--group</span></span><a + id="dx1-9033"></a> switch: +</p><!--l. 1713--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />bib2gls --group myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +or with <span +class="cmtt-10">arara</span><a + id="dx1-9034"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> bib2gls:</span><span +class="cmtt-10"> {</span><span +class="cmtt-10"> group:</span><span +class="cmtt-10"> on</span><span +class="cmtt-10"> }</span> +</div> +</div> (You will also need an appropriate glossary style.) +<!--l. 1722--><p class="indent" > Unlike Options <a href="#option2">2</a> and <a -href="#option3">3</a>, this method doesn’t create a file containing the typeset glossary but -simply determines which entries are needed for the document, their associated locations and -(if required) their associated letter group. This option allows a mixture of sort methods. -(For example, sorting by word order for one glossary and order of use for another -or even sorting one block of the glossary differently to another block in the same -glossary.) -</p><!--l. 1249--><p class="indent" > This method supports Unicode and (with at least Java 8) uses the Common -Locale Data Repository, which provides more extensive language support than -<a +href="#option3">3</a>, this method doesn’t create a file containing the typeset glossary but simply +determines which entries are needed for the document, their associated locations and (if required) their +associated letter group. This option allows a mixture of sort methods. For example, sorting by word order for + + +one glossary and order of use for another or even sorting one block of the glossary differently to another block in +the same glossary. See <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a>. +</p><!--l. 1731--><p class="indent" > This method supports Unicode and uses the Common Locale Data Repository, which provides more extensive language support +than <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-9004"></a></a>.<span class="footnote-mark"><a + id="dx1-9035"></a></a>.<span class="footnote-mark"><a href="#fn2x1" id="fn2x1-bk"><sup class="textsuperscript">1.2</sup></a></span><a - id="x1-9005f2"></a> The + id="x1-9036f2"></a> The locations in the <a href="#glo:numberlist">number list<a - id="dx1-9007"></a></a> may be in any format. If <a + id="dx1-9038"></a></a> may be in any format. If <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-9008"></a></a> can deduce a numerical value it -will attempt to form ranges otherwise it will simply list the locations. -</p><!--l. 1258--><p class="indent" > Complete example: - - -</p> - <div class="verbatim" id="verbatim-28"> -\documentclass{article} - <br />\usepackage[record]{glossaries-extra} - <br />\GlsXtrLoadResources[src={entries}] - <br />\begin{document} - <br />\gls{sample}. - <br />\printunsrtglossary - <br />\end{document} -</div> -<!--l. 1267--><p class="nopar" > where <span -class="cmtt-10">entries.bib </span>contains - - -</p> - <div class="verbatim" id="verbatim-29"> -@entry{sample, - <br /> name={sample}, - <br /> description={an example} - <br />} -</div> -<!--l. 1274--><p class="nopar" > See the <a + id="dx1-9039"></a></a> can deduce a numerical value it will attempt to +form ranges otherwise it will simply list the locations. +</p><!--l. 1739--><p class="indent" > See <a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory Guide</a> or the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-9009"></a></a> user manual for further details. + id="dx1-9040"></a></a> user manual for further details of +this method, and also <a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document +build</a>. <a - id="x1-9010r5"></a> -</p><!--l. 1277--><p class="noindent" > + id="x1-9041r5"></a> +</p><!--l. 1745--><p class="noindent" > </p> <h4 class="likesubsectionHead"><a - id="x1-100005"></a><a + id="x1-100005"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option5">🔗</a><a id="option5"></a>Option 5 (no sorting)</h4> -<!--l. 1279--><p class="noindent" >This option is only available with the extension package <a +<!--l. 1747--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This option is only available with the extension package <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a>. No <a -href="#glo:indexingapp">indexing -application</a> is required. This method is best used with the package option <span -class="cmss-10">sort=none</span><a - id="dx1-10001"></a>. - - +href="#glo:indexingapp">indexing application</a> +is required. +</p><!--l. 1751--><p class="indent" > Example document: + + </p> - <div class="verbatim" id="verbatim-30"> -\usepackage[sort=none]{glossaries-extra} + <div class="verbatim" id="verbatim-20"> +\documentclass{article} + <br />\usepackage[sort=none]{glossaries-extra} + <br />\newglossaryentry{sample}{name={sample}, + <br /> description={an example}} + <br />\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + <br /> description={...}} + <br />\begin{document} + <br />\gls{sample}. +</div> +<!--l. 1761--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor112"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-10001"></a> +<br /><span +class="cmtt-10">\end{document}</span> +</div> </div> -<!--l. 1284--><p class="nopar" > There’s no “activation” command (such as <span +<!--l. 1767--><p class="indent" > This method is best used with the package option <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">none</span><a + id="dx1-10002"></a> (as shown above). There’s no “activation” +command (such as <span class="cmtt-10">\makeglossaries </span>for Options <a href="#option2">2</a> and <a href="#option3">3</a>). -</p><!--l. 1288--><p class="indent" > All entries must be defined before the glossary is displayed (preferably in the preamble) in -the required order, and child entries must be defined immediately after their parent entry if -they must be kept together in the glossary -</p><!--l. 1293--><p class="indent" > The glossary is displayed using - - -</p> - <div class="verbatim" id="verbatim-31"> -\printunsrtglossary -</div> -<!--l. 1296--><p class="nopar" > Alternatively all glossaries can be displayed using the iterative command: - - -</p> - <div class="verbatim" id="verbatim-32"> -\printunsrtglossaries -</div> -<!--l. 1301--><p class="nopar" > This will display <span -class="cmti-10">all </span>defined entries, regardless of whether or not they have been used in the -document. The <a +</p><!--l. 1771--><p class="indent" > All entries must be defined before the glossary is displayed (preferably in the preamble) in the +required order, and child entries must be defined immediately after their parent entry if they must be +kept together in the glossary. (Some glossary styles indent entries that have a parent but it’s the +<a +href="#glo:indexingapp">indexing application</a> that ensures the child entries are listed immediately after the parent. If you’re +opting to use this manual approach then it’s your responsibility to define the entries in the correct +order.) You can place all your entry definitions in a separate file and load it in the preamble with +<span +class="cmtt-10">\loadglsentries</span><a + id="dx1-10003"></a>. +</p><!--l. 1782--><p class="indent" > The glossary is displayed using: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor113"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-10004"></a> +</div> +</div> Alternatively all glossaries can be displayed using the iterative command: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor114"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-10005"></a> +</div> +</div> This will display <span +class="cmti-10">all </span>defined entries, regardless of whether or not they have been used in the document. The +<a href="#glo:numberlist">number list<a - id="dx1-10002"></a>s</a> have to be set explicitly otherwise they won’t appear. Note -that this uses the same command for displaying the glossary as <a -href="#option4">Option 4</a>. This is -because <a + id="dx1-10006"></a>s</a> have to be set explicitly otherwise they won’t appear. Note that this uses the same command for +displaying the glossary as <a +href="#option4">Option 4</a>. This is because <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-10003"></a></a> takes advantage of this method by defining the wanted entries -in the required order and setting the locations (and letter group information, if + id="dx1-10007"></a></a> takes advantage of this method by defining the +wanted entries in the required order and setting the locations (and letter group information, if required). -</p><!--l. 1310--><p class="indent" > This just requires a single <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> call - - -</p> - <div class="verbatim" id="verbatim-33"> -pdflatex myDoc -</div> -<!--l. 1313--><p class="nopar" > unless the glossary needs to appear in the table of contents, in which case a second run is -required. - - + + +<!--l. 1799--><p class="indent" > Therefore, the above example document has a glossary containing the entries: sample and <span +class="cmmi-10">α </span>(in +that order). Note that the <span +class="cmtt-10">alpha </span>entry has been included even though it wasn’t referenced in the +document. +</p><!--l. 1804--><p class="indent" > This just requires a single <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call: +</p><!--l. 1805--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +unless the glossary needs to appear in the table of contents, in which case a second run is required: +</p><!--l. 1810--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +(Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all +the other options above.) +</p><!--l. 1818--><p class="indent" > See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> documentation for further details of this method. +<a + id="x1-10008r6"></a> +</p><!--l. 1820--><p class="noindent" > </p> - <div class="verbatim" id="verbatim-34"> -pdflatex myDoc - <br />pdflatex myDoc -</div> -<!--l. 1319--><p class="nopar" > (Naturally if the document also contains citations, and so on, then additional steps are -required. Similarly for all the other options above.) -</p><!--l. 1324--><p class="indent" > Complete example: - - + <h4 class="likesubsectionHead"><a + id="x1-110006"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option6">🔗</a><a + id="option6"></a>Option 6 (standalone)</h4> +<!--l. 1822--><p class="noindent" ><br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This option is only available with the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension +package.<span class="footnote-mark"><a +href="#fn3x1" id="fn3x1-bk"><sup class="textsuperscript">1.3</sup></a></span><a + id="x1-11001f3"></a> +Instead of creating a list, this has standalone definitions throughout the document. The entry name may or may +not be in a section heading. +</p><!--l. 1832--><p class="indent" > You can either define entries in the document preamble (or in an external file loaded with <span +class="cmtt-10">\loadglsentries</span><a + id="dx1-11004"></a>), as +with <a +href="#option5">Option 5</a>, for example: + + </p> - <div class="verbatim" id="verbatim-35"> + <div class="verbatim" id="verbatim-21"> \documentclass{article} - <br />\usepackage[sort=none]{glossaries-extra} - <br />\newglossaryentry{sample}{name={sample}, - <br /> description={an example}} - <br />\begin{document} - <br />\gls{sample}. - <br />\printunsrtglossary + <br />\usepackage[colorlinks]{hyperref} + <br />\usepackage[sort=none, + <br />   nostyles% <- no glossary styles are required + <br /> ]{glossaries-extra} + <br />\newglossaryentry{set}{name={set}, + <br />  description={a collection of any kind of objects}, + <br />  symbol={\ensuremath{\mathcal{S}}} + <br />} + <br />\newglossaryentry{function}{name={function}, + <br />  description={a rule that assigns every element in the + <br />  domain \gls{set} to an element in the range \gls{set}}, + <br />  symbol={\ensuremath{f(x)}} + <br />} +</div> +<!--l. 1852--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{\termdef}[1]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \section{</span><span id="textcolor115"><span +class="cmtt-10">\glsxtrglossentry</span></span><a + id="dx1-11005"></a><span +class="cmtt-10">{#1}</span><span +class="cmtt-10"> \glsentrysymbol</span><a + id="dx1-11006"></a><span +class="cmtt-10">{#1}}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \begin{quote}\em\Glsentrydesc</span><a + id="dx1-11007"></a><span +class="cmtt-10">{#1}.\end{quote}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> + + + <div class="verbatim" id="verbatim-22"> +\begin{document} + <br />\tableofcontents + <br />\section{Introduction} + <br />Sample document about \glspl{function} and \glspl{set}. + <br />\termdef{set} + <br />More detailed information about \glspl{set} with examples. + <br />\termdef{function} + <br />More detailed information about \glspl{function} with examples.  <br />\end{document} </div> -<!--l. 1334--><p class="nopar" > See the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-10004"></a> documentation for further details. -</p><!--l. 1338--><p class="noindent" > -</p> -<!--l. 1338--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a - id="sec:samples"></a>Sample Documents</h3> -<!--l. 1341--><p class="noindent" >The <span -class="cmss-10">glossaries </span>package is provided with some sample documents that illustrate the -various functions. These should be located in the <span -class="cmtt-10">samples </span>subdirectory (folder) -of the <span -class="cmss-10">glossaries </span>documentation directory. This location varies according to your -operating system and <span class="TEX">T<span -class="E">E</span>X</span> distribution. You can use <span -class="cmtt-10">texdoc </span>to locate the main -glossaries documentation. For example, in a <a -href="http://www.dickimaw-books.com/latex/novices/html/terminal.html" >terminal or command prompt</a>, type: -<spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">texdoc -l glossaries</span></span> -</p><!--l. 1351--><p class="indent" > <spacer type=vertical size=10> -This should display a list of all the files in the glossaries documentation directory with -their full pathnames. (The GUI version of <span -class="cmtt-10">texdoc </span>may also provide you with the -information.) -</p><!--l. 1356--><p class="indent" > If you can’t find the sample files on your computer, they are also available from your nearest -CTAN mirror at <a -href="http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/" class="url" ><span -class="cmtt-10">http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/</span></a>. -</p><!--l. 1360--><p class="indent" > The sample documents are listed -below<span class="footnote-mark"><a -href="#fn3x1" id="fn3x1-bk"><sup class="textsuperscript">1.3</sup></a></span><a - id="x1-11001f3"></a> If -you prefer to use UTF-8 aware engines (<span -class="cmtt-10">xelatex </span>or <span -class="cmtt-10">lualatex</span>) remember that you’ll need to -switch from <span -class="cmss-10">fontenc </span>& <span -class="cmss-10">inputenc </span>to <span -class="cmss-10">fontspec </span>where appropriate. The <a +<!--l. 1875--><p class="nopar" > Or you can use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11008"></a></a> if you want to manage a large database of terms. For example (requires <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package -provides some additional sample files. - </p><dl class="description"><dt class="description"> -<span -class="cmtt-10">minimalgls.tex</span> </dt><dd -class="description"><a - id="x1-11002r1"></a> This document is a minimal working example. You can test your - installation using this file. To create the complete document you will need to do the - following steps: - <ol class="enumerate1" > - <li - class="enumerate" id="x1-11004x1">Run <span -class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> either by typing <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex minimalgls</span></span> - - - <!--l. 1379--><p class="noindent" ><spacer type=vertical size=10> - in a terminal or by using the relevant button or menu item in your text editor or - front-end. This will create the required associated files but you will not see the - glossary. If you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> you will also get warnings about non-existent - references that look something like: - - -</p> - <div class="verbatim" id="verbatim-36"> - pdfTeX warning (dest): name{glo:aca} has been -  <br />referenced but does not exist, -  <br />replaced by a fixed one -</div> - <!--l. 1389--><p class="nopar" > These warnings may be ignored on the first run. - </p><!--l. 1392--><p class="noindent" >If you get a <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">Missing</span><span -class="cmtt-10"> \begin{document}</span></span></span> error, then it’s most likely that - your version of <span -class="cmss-10">xkeyval</span><a - id="dx1-11005"></a> is out of date. Check the log file for a warning - of that nature. If this is the case, you will need to update the <span -class="cmss-10">xkeyval</span> - package. - </p></li> - <li - class="enumerate" id="x1-11007x2">If you have Perl installed, run <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11008"></a></a> on the document (<a -href="#sec:makeglossaries"><span -class="tcrm-1000">§</span>1.5 </a><a -href="#sec:makeglossaries">Generating - the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>). This can be done on a terminal by typing - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries minimalgls</span></span> - <!--l. 1402--><p class="noindent" ><spacer type=vertical size=10> - otherwise do <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries-lite minimalgls</span></span> - </p><!--l. 1406--><p class="noindent" ><spacer type=vertical size=10> - If for some reason you want to call <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11009"></a></a> explicitly, you can do this in a - terminal by typing (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls</span> - <span -class="cmtt-10">minimalgls.glo</span></span> - </p><!--l. 1411--><p class="noindent" ><spacer type=vertical size=10> - (See <a -href="#sec:makeindexapp"><span -class="tcrm-1000">§</span>1.5.4 </a><a -href="#sec:makeindexapp">Using <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11010"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using - <span -class="cmtt-10">makeindex</span><a - id="dx1-11011"></a> explicitly.) - </p><!--l. 1415--><p class="noindent" >Note that if the file name contains spaces, you will need to use the double-quote - character to delimit the name. - </p></li> - <li - class="enumerate" id="x1-11013x3">Run <span -class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> again (as step 1)</li></ol> - <!--l. 1420--><p class="noindent" >You should now have a complete document. The number following each entry in the - glossary is the location number. By default, this is the page number where the entry - was referenced. - </p><!--l. 1424--><p class="noindent" >There are three other files that can be used as a <a -href="http://www.dickimaw-books.com/latex/minexample/" >minimal working example</a>: - <span -class="cmtt-10">mwe-gls.tex</span>, <span -class="cmtt-10">mwe-acr.tex </span>and <span -class="cmtt-10">mwe-acr-desc.tex</span>. - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-noidxapp.tex</span> </dt><dd -class="description"><a - id="x1-11014r2"></a> This document illustrates how to use the <span -class="cmss-10">glossaries </span>package without - an external <a -href="#glo:indexingapp">indexing application</a> (<a -href="#option1">Option 1</a>). To create the complete document, you - need to do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-noidxapp</span> - - - <br /><span -class="cmtt-10">latex sample-noidxapp</span></span> - <!--l. 1435--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-noidxapp-utf8.tex</span> </dt><dd -class="description"><a - id="x1-11015r3"></a> As the previous example, except that it uses the <span -class="cmss-10">inputenc</span><a - id="dx1-11016"></a> - package. To create the complete document, you need to do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-noidxapp-utf8</span> - <br /><span -class="cmtt-10">latex sample-noidxapp-utf8</span></span> - <!--l. 1443--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample4col.tex</span> </dt><dd -class="description"><a - id="x1-11017r4"></a> This document illustrates a four column glossary where the entries have a - symbol in addition to the name and description. To create the complete document, you - need to do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample4col</span> - <br /><span -class="cmtt-10">makeglossaries sample4col</span> - <br /><span -class="cmtt-10">latex sample4col</span></span> - <!--l. 1453--><p class="noindent" ><spacer type=vertical size=10> - or <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample4col</span> - <br /><span -class="cmtt-10">makeglossaries-lite sample4col</span> - <br /><span -class="cmtt-10">latex sample4col</span></span> - </p><!--l. 1459--><p class="noindent" ><spacer type=vertical size=10> - The vertical gap between entries is the gap created at the start of each group. This can - be suppressed using the <span -class="cmss-10">nogroupskip</span><a - id="dx1-11018"></a> package option. - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleAcr.tex</span> </dt><dd -class="description"><a - id="x1-11019r5"></a> This document has some sample abbreviations. It also adds the glossary to - the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is required to ensure the - document is up to date: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleAcr</span> - <br /><span -class="cmtt-10">makeglossaries sampleAcr</span> - <br /><span -class="cmtt-10">latex sampleAcr</span> - <br /><span -class="cmtt-10">latex sampleAcr</span></span> - <!--l. 1473--><p class="noindent" ><spacer type=vertical size=10> - (or use <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11020"></a></a>). - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleAcrDesc.tex</span> </dt><dd -class="description"><a - id="x1-11021r6"></a> This is similar to the previous example, except that the abbreviations - have an associated description. As with the previous example, the glossary is - - - added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is required: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleAcrDesc</span> - <br /><span -class="cmtt-10">makeglossaries sampleAcrDesc</span> - <br /><span -class="cmtt-10">latex sampleAcrDesc</span> - <br /><span -class="cmtt-10">latex sampleAcrDesc</span></span> - <!--l. 1485--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleDesc.tex</span> </dt><dd -class="description"><a - id="x1-11022r7"></a> This is similar to the previous example, except that it defines the - abbreviations using <span -class="cmtt-10">\newglossaryentry</span><a - id="dx1-11023"></a> instead of <span -class="cmtt-10">\newacronym</span><a - id="dx1-11024"></a>. As with the previous - example, the glossary is added to the table of contents, so an extra run through - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleDesc</span> - <br /><span -class="cmtt-10">makeglossaries sampleDesc</span> - <br /><span -class="cmtt-10">latex sampleDesc</span> - <br /><span -class="cmtt-10">latex sampleDesc</span></span> - <!--l. 1497--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleCustomAcr.tex</span> </dt><dd -class="description"><a - id="x1-11025r8"></a> This document has some sample abbreviations with a custom - acronym style. It also adds the glossary to the table of contents, so an extra run through - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleCustomAcr</span> - <br /><span -class="cmtt-10">makeglossaries sampleCustomAcr</span> - <br /><span -class="cmtt-10">latex sampleCustomAcr</span> - <br /><span -class="cmtt-10">latex sampleCustomAcr</span></span> - <!--l. 1507--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleFnAcrDesc.tex</span> </dt><dd -class="description"><a - id="x1-11026r9"></a> This is similar to <a -href="#x1-11021r6"><span -class="cmtt-10">sampleAcrDesc.tex</span></a>, except that it uses the - <span -class="cmss-10">footnote-sc-desc</span><a - id="dx1-11027"></a> style. As with the previous example, the glossary is added to the table - of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is required: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleFnAcrDesc</span> - <br /><span -class="cmtt-10">makeglossaries sampleFnAcrDesc</span> - <br /><span -class="cmtt-10">latex sampleFnAcrDesc</span> - <br /><span -class="cmtt-10">latex sampleFnAcrDesc</span></span> - <!--l. 1518--><p class="noindent" ><spacer type=vertical size=10> - - - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-FnDesc.tex</span> </dt><dd -class="description"><a - id="x1-11028r10"></a> This example defines a custom display format that puts the description - in a footnote on first use. <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-FnDesc</span> - <br /><span -class="cmtt-10">makeglossaries sample-FnDesc</span> - <br /><span -class="cmtt-10">latex sample-FnDesc</span></span> - <!--l. 1527--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-custom-acronym.tex</span> </dt><dd -class="description"><a - id="x1-11029r11"></a> This document illustrates how to define your own acronym - style if the predefined styles don’t suit your requirements. <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-custom-acronym</span> - <br /><span -class="cmtt-10">makeglossaries sample-custom-acronym</span> - <br /><span -class="cmtt-10">latex sample-custom-acronym</span></span> - <!--l. 1536--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-crossref.tex</span> </dt><dd -class="description"><a - id="x1-11030r12"></a> This document illustrates how to cross-reference entries in the - glossary. <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-crossref</span> - <br /><span -class="cmtt-10">makeglossaries sample-crossref</span> - <br /><span -class="cmtt-10">latex sample-crossref</span></span> - <!--l. 1545--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-dot-abbr.tex</span> </dt><dd -class="description"><a - id="x1-11031r13"></a> This document illustrates how to use the post link hook to adjust the - space factor after abbreviations. <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-dot-abbr</span> - <br /><span -class="cmtt-10">makeglossaries sampledot-abbrf</span> - <br /><span -class="cmtt-10">latex sample-dot-abbr</span></span> - <!--l. 1553--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleDB.tex</span> </dt><dd -class="description"><a - id="x1-11032r14"></a> This document illustrates how to load external files containing the glossary - definitions. It also illustrates how to define a new glossary type. This document has the - <a -href="#glo:numberlist">number list<a - id="dx1-11033"></a></a> suppressed and uses <span -class="cmtt-10">\glsaddall</span><a - id="dx1-11034"></a> to add all the entries to the - glossaries without referencing each one explicitly. To create the document do: - <spacer type=vertical size=10><span class="obeylines-h"> - - - <br /><span -class="cmtt-10">latex sampleDB</span> - <br /><span -class="cmtt-10">makeglossaries sampleDB</span> - <br /><span -class="cmtt-10">latex sampleDB</span></span> - <!--l. 1565--><p class="noindent" ><spacer type=vertical size=10> - or <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleDB</span> - <br /><span -class="cmtt-10">makeglossaries-lite sampleDB</span> - <br /><span -class="cmtt-10">latex sampleDB</span></span> - </p><!--l. 1571--><p class="noindent" ><spacer type=vertical size=10> - The glossary definitions are stored in the accompanying files <span -class="cmtt-10">database1.tex </span>and - <span -class="cmtt-10">database2.tex</span>. If for some reason you want to call <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11035"></a></a> explicitly you must have - a separate call for each glossary: - </p><ol class="enumerate1" > - <li - class="enumerate" id="x1-11037x1"> - Create - the - main - glossary - (all - on - one - line): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex</span> - <span -class="cmtt-10">-s</span> - <span -class="cmtt-10">sampleDB.ist</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleDB.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleDB.gls</span> - <span -class="cmtt-10">sampleDB.glo</span></span> - <!--l. 1580--><p class="noindent" ><spacer type=vertical size=10> - </p></li> - <li - class="enumerate" id="x1-11039x2"> - Create - the - secondary - glossary - (all - on - - - one - line): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex</span> - <span -class="cmtt-10">-s</span> - <span -class="cmtt-10">sampleDB.ist</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleDB.nlg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleDB.not</span> - <span -class="cmtt-10">sampleDB.ntn</span></span> - <!--l. 1584--><p class="noindent" ><spacer type=vertical size=10> - Note that both <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11040"></a></a> and <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11041"></a></a> do this all in one call, - so they not only make it easier because you don’t need to supply all the switches - and remember all the extensions but they also call <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11042"></a></a> the appropriate - number of times.</p></li></ol> - </dd><dt class="description"> -<span -class="cmtt-10">sampleEq.tex</span> </dt><dd -class="description"><a - id="x1-11043r15"></a> This document illustrates how to change the location to something other - than the page number. In this case, the <span -class="cmtt-10">equation </span>counter is used since all glossary - entries appear inside an <span -class="cmss-10">equation</span><a - id="dx1-11044"></a><a - id="dx1-11045"></a> environment. To create the document do: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleEq</span> - <br /><span -class="cmtt-10">makeglossaries sampleEq</span> - <br /><span -class="cmtt-10">latex sampleEq</span></span> - <!--l. 1600--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleEqPg.tex</span> </dt><dd -class="description"><a - id="x1-11046r16"></a> This is similar to the previous example, but the <a -href="#glo:numberlist">number list<a - id="dx1-11047"></a>s</a> - are a mixture of page numbers and equation numbers. This example adds - the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is required: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleEqPg</span> - <br /><span -class="cmtt-10">makeglossaries sampleEqPg</span> - <br /><span -class="cmtt-10">latex sampleEqPg</span> - <br /><span -class="cmtt-10">latex sampleEqPg</span></span> - <!--l. 1612--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleSec.tex</span> </dt><dd -class="description"><a - id="x1-11048r17"></a> This document also illustrates how to change the location to something - other than the page number. In this case, the <span -class="cmtt-10">section </span>counter is used. This example - adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is required: - <spacer type=vertical size=10><span class="obeylines-h"> - - - <br /><span -class="cmtt-10">latex sampleSec</span> - <br /><span -class="cmtt-10">makeglossaries sampleSec</span> - <br /><span -class="cmtt-10">latex sampleSec</span> - <br /><span -class="cmtt-10">latex sampleSec</span></span> - <!--l. 1624--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sampleNtn.tex</span> </dt><dd -class="description"><a - id="x1-11049r18"></a> This document illustrates how to create an additional glossary type. This - example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is required: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleNtn</span> - <br /><span -class="cmtt-10">makeglossaries sampleNtn</span> - <br /><span -class="cmtt-10">latex sampleNtn</span> - <br /><span -class="cmtt-10">latex sampleNtn</span></span> - <!--l. 1635--><p class="noindent" ><spacer type=vertical size=10> - Note that if you want to call <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11050"></a></a> explicitly instead of using <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11051"></a></a> or - <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11052"></a></a> then you need to call <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11053"></a></a> twice: - </p><ol class="enumerate1" > - <li - class="enumerate" id="x1-11055x1"> - Create - the - main - glossary - (all - on - one - line): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex</span> - <span -class="cmtt-10">-s</span> - <span -class="cmtt-10">sampleNtn.ist</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleNtn.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleNtn.gls</span> - <span -class="cmtt-10">sampleNtn.glo</span></span> - <!--l. 1643--><p class="noindent" ><spacer type=vertical size=10> - </p></li> - - - <li - class="enumerate" id="x1-11057x2"> - Create - the - secondary - glossary - (all - on - one - line): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex</span> - <span -class="cmtt-10">-s</span> - <span -class="cmtt-10">sampleNtn.ist</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleNtn.nlg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleNtn.not</span> - <span -class="cmtt-10">sampleNtn.ntn</span></span> - <!--l. 1647--><p class="noindent" ><spacer type=vertical size=10> - </p></li></ol> - </dd><dt class="description"> -<span -class="cmtt-10">sample.tex</span> </dt><dd -class="description"><a - id="x1-11058r19"></a> This document illustrates some of the basics, including how to create child - entries that use the same name as the parent entry. This example adds the glossary to - the table of contents and it also uses <span -class="cmtt-10">\glsrefentry</span><a - id="dx1-11059"></a>, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is - required: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample</span> - <br /><span -class="cmtt-10">makeglossaries sample</span> - <br /><span -class="cmtt-10">latex sample</span> - <br /><span -class="cmtt-10">latex sample</span></span> - <!--l. 1660--><p class="noindent" ><spacer type=vertical size=10> - You can see the difference between word and letter ordering if you substitute - <span -class="cmss-10">order=word</span><a - id="dx1-11060"></a> with <span -class="cmss-10">order=letter</span><a - id="dx1-11061"></a>. (Note that this will only have an effect if you use - <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11062"></a></a> or <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11063"></a></a>. If you use <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11064"></a></a> explicitly, you will - need to use the <span -class="cmtt-10">-l</span><a - id="dx1-11065"></a> switch to indicate letter ordering.) - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-inline.tex</span> </dt><dd -class="description"><a - id="x1-11066r20"></a> This document is like <span -class="cmtt-10">sample.tex</span>, above, but uses the <span -class="cmss-10">inline</span><a - id="dx1-11067"></a> glossary - style to put the glossary in a footnote. - </dd><dt class="description"> -<span -class="cmtt-10">sampletree.tex</span> </dt><dd -class="description"><a - id="x1-11068r21"></a> This document illustrates a hierarchical glossary structure where child - entries have different names to their corresponding parent entry. To create the - document do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampletree</span> - - - <br /><span -class="cmtt-10">makeglossaries sampletree</span> - <br /><span -class="cmtt-10">latex sampletree</span></span> - <!--l. 1680--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-dual.tex</span> </dt><dd -class="description"><a - id="x1-11069r22"></a> This document illustrates how to define an entry that both appears in - the list of acronyms and in the main glossary. To create the document do: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-dual</span> - <br /><span -class="cmtt-10">makeglossaries sample-dual</span> - <br /><span -class="cmtt-10">latex sample-dual</span></span> - <!--l. 1689--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-langdict.tex</span> </dt><dd -class="description"><a - id="x1-11070r23"></a> This document illustrates how to use the glossaries package to create - English to French and French to English dictionaries. To create the document do: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-langdict</span> - <br /><span -class="cmtt-10">makeglossaries sample-langdict</span> - <br /><span -class="cmtt-10">latex sample-langdict</span></span> - <!--l. 1699--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> +class="cmss-10">glossaries-extra</span></a> +v1.42, see below): </p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">samplexdy.tex</span> </dt><dd -class="description"><a - id="x1-11071r24"></a> This document illustrates how to use the <span -class="cmss-10">glossaries </span>package with <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11072"></a></a> - instead of <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11073"></a></a>. The document uses UTF8 encoding (with the <span -class="cmss-10">inputenc</span><a - id="dx1-11074"></a> package). - The encoding is picked up by <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11075"></a></a>. By default, this document will - create a <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11076"></a></a> style file called <span -class="cmtt-10">samplexdy.xdy</span>, but if you uncomment the - lines - - - <div class="verbatim" id="verbatim-37"> - \setStyleFile{samplexdy-mc} -  <br />\noist -  <br />\GlsSetXdyLanguage{} +class="cmtt-10">\documentclass{article}</span> +<br /> +<br /><span +class="cmtt-10">\usepackage[colorlinks]{hyperref}</span> +<br /><span +class="cmtt-10">\usepackage[</span><span id="textcolor116"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> nostyles%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> no</span><span +class="cmtt-10"> glossary</span><span +class="cmtt-10"> styles</span><span +class="cmtt-10"> are</span><span +class="cmtt-10"> required</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> ]{glossaries-extra}</span> +<br /> +<br /><span id="textcolor117"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-11009"></a><span +class="cmtt-10">[</span><span id="textcolor118"><span +class="cmtt-10">src</span></span><a + id="dx1-11010"></a><span +class="cmtt-10">=terms,</span><span id="textcolor119"><span +class="cmtt-10">sort</span></span><a + id="dx1-11011"></a><span +class="cmtt-10">=none,</span><span id="textcolor120"><span +class="cmtt-10">save-locations</span></span><a + id="dx1-11012"></a><span +class="cmtt-10">=false]</span> +<br /> +<br /><span +class="cmtt-10">\newcommand*{\termdef}[1]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \section{</span><span id="textcolor121"><span +class="cmtt-10">\glsxtrglossentry</span></span><a + id="dx1-11013"></a><span +class="cmtt-10">{#1}</span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\glossentrysymbol</span><a + id="dx1-11014"></a></strong><span +class="cmtt-10">{#1}}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsadd</span><a + id="dx1-11015"></a><span +class="cmtt-10">{#1}%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> index</span><span +class="cmtt-10"> this</span><span +class="cmtt-10"> entry</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \begin{quote}\em\Glsentrydesc</span><a + id="dx1-11016"></a><span +class="cmtt-10">{#1}.\end{quote}%</span> +<br /><span +class="cmtt-10">}</span> </div> - <!--l. 1712--><p class="nopar" > it will set the style file to <span -class="cmtt-10">samplexdy-mc.xdy </span>instead. This provides an additional letter - group for entries starting with “Mc” or “Mac”. If you use <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11077"></a></a> or - <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11078"></a></a>, you don’t need to supply any additional information. If you - don’t use <span -class="cmtt-10">makeglossaries</span><a - id="dx1-11079"></a>, you will need to specify the required information. Note that - if you set the style file to <span -class="cmtt-10">samplexdy-mc.xdy </span>you must also specify <span -class="cmtt-10">\noist</span><a - id="dx1-11080"></a>, otherwise - the <span -class="cmss-10">glossaries </span>package will overwrite <span -class="cmtt-10">samplexdy-mc.xdy </span>and you will lose the “Mc” - letter group. - </p><!--l. 1725--><p class="noindent" >To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex samplexdy</span> - <br /><span -class="cmtt-10">makeglossaries samplexdy</span> - <br /><span -class="cmtt-10">latex samplexdy</span></span> - </p><!--l. 1730--><p class="noindent" ><spacer type=vertical size=10> - If you don’t have Perl installed then you can’t use <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11081"></a></a>, but you also can’t - use <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11082"></a></a>! However, if for some reason you want to call <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11083"></a></a> explicitly instead of using - <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11084"></a></a> (or <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11085"></a></a>): </p> - <ul class="itemize1"> - <li class="itemize"> - if - you - are - using - the - default - style - file - <span -class="cmtt-10">samplexdy.xdy</span>, - then - do - (no - line - breaks): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-L</span> - <span -class="cmtt-10">english</span> - - - <span -class="cmtt-10">-C</span> - <span -class="cmtt-10">utf8</span> - <span -class="cmtt-10">-I</span> - <span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-M</span> - <span -class="cmtt-10">samplexdy</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">samplexdy.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">samplexdy.gls</span> - <span -class="cmtt-10">samplexdy.glo</span></span> - <!--l. 1741--><p class="noindent" ><spacer type=vertical size=10> - </p></li> - <li class="itemize"> - if - you - are - using - <span -class="cmtt-10">samplexdy-mc.xdy</span>, - then - do - (no - line - breaks): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-I</span> - <span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-M</span> - <span -class="cmtt-10">samplexdy-mc</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">samplexdy.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">samplexdy.gls</span> - <span -class="cmtt-10">samplexdy.glo</span></span> - <!--l. 1746--><p class="noindent" ><spacer type=vertical size=10> - </p></li></ul> - </dd><dt class="description"> -<span -class="cmtt-10">samplexdy2.tex</span> </dt><dd -class="description"><a - id="x1-11086r25"></a> This document illustrates how to use the <span -class="cmss-10">glossaries </span>package where the - location numbers don’t follow a standard format. This example will only work with - <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11087"></a></a>. To create the document do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">pdflatex samplexdy2</span> - - - <br /><span -class="cmtt-10">makeglossaries samplexdy2</span> - <br /><span -class="cmtt-10">pdflatex samplexdy2</span></span> - <!--l. 1757--><p class="noindent" ><spacer type=vertical size=10> - The - explicit - <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11088"></a></a> - call - is: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-L</span> - <span -class="cmtt-10">english</span> - <span -class="cmtt-10">-C</span> - <span -class="cmtt-10">utf8</span> - <span -class="cmtt-10">-I</span> - <span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-M</span> - <span -class="cmtt-10">samplexdy2</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">samplexdy2.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">samplexdy2.gls</span> - <span -class="cmtt-10">samplexdy2.glo</span></span> - </p><!--l. 1761--><p class="noindent" ><spacer type=vertical size=10> - See <a -href="#sec:xindyloc"><span -class="tcrm-1000">§</span>11.2 </a><a -href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details. - </p></dd><dt class="description"> -<span -class="cmtt-10">samplexdy3.tex</span> </dt><dd -class="description"><a - id="x1-11089r26"></a> This document is like <a -href="#x1-11071r24"><span -class="cmtt-10">samplexdy.tex</span></a> but uses the command - <span -class="cmtt-10">\Numberstring </span>from the <span -class="cmss-10">fmtcount</span><a - id="dx1-11090"></a> package to format the page numbers. - </dd><dt class="description"> -<span -class="cmtt-10">sampleutf8.tex</span> </dt><dd -class="description"><a - id="x1-11091r27"></a> This is another example that uses <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11092"></a></a>. Unlike <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11093"></a></a>, <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11094"></a></a> can - cope with <a -href="#glo:nonlatinchar">non-Latin character<a - id="dx1-11095"></a>s</a>. This document uses UTF8 encoding. To create the - document do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleutf8</span> - <br /><span -class="cmtt-10">makeglossaries sampleutf8</span> - <br /><span -class="cmtt-10">latex sampleutf8</span></span> - <!--l. 1776--><p class="noindent" ><spacer type=vertical size=10> - The - explicit - <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-11096"></a></a> - call - - - is - (no - line - breaks): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-L</span> - <span -class="cmtt-10">english</span> - <span -class="cmtt-10">-C</span> - <span -class="cmtt-10">utf8</span> - <span -class="cmtt-10">-I</span> - <span -class="cmtt-10">xindy</span> - <span -class="cmtt-10">-M</span> - <span -class="cmtt-10">sampleutf8</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleutf8.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleutf8.gls</span> - <span -class="cmtt-10">sampleutf8.glo</span></span> - </p><!--l. 1781--><p class="noindent" ><spacer type=vertical size=10> - </p><!--l. 1783--><p class="noindent" >If you remove the <span -class="cmss-10">xindy</span><a - id="dx1-11097"></a> option from <span -class="cmtt-10">sampleutf8.tex </span>and do: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleutf8</span> - <br /><span -class="cmtt-10">makeglossaries sampleutf8</span> - <br /><span -class="cmtt-10">latex sampleutf8</span></span> - </p><!--l. 1789--><p class="noindent" ><spacer type=vertical size=10> - or <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleutf8</span> - <br /><span -class="cmtt-10">makeglossaries-lite sampleutf8</span> - <br /><span -class="cmtt-10">latex sampleutf8</span></span> - </p><!--l. 1795--><p class="noindent" ><spacer type=vertical size=10> - you - will - see - that - the - entries - that - start - with - an - <a -href="#glo:exlatinchar">extended - - - Latin - character<a - id="dx1-11098"></a></a> - now - appear - in - the - symbols - group, - and - the - word - “manœuvre” - is - now - after - “manor” - instead - of - before - it. - If - you - want - to - explicitly - call - <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-11099"></a></a> - (no - line - breaks): - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex</span> - <span -class="cmtt-10">-s</span> - <span -class="cmtt-10">sampleutf8.ist</span> - <span -class="cmtt-10">-t</span> - <span -class="cmtt-10">sampleutf8.glg</span> - <span -class="cmtt-10">-o</span> - <span -class="cmtt-10">sampleutf8.gls</span> - <span -class="cmtt-10">sampleutf8.glo</span></span> - </p><!--l. 1802--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-index.tex</span> </dt><dd -class="description"><a - id="x1-11100r28"></a> This document uses the <span -class="cmss-10">glossaries </span>package to create both a glossary and - an index. This requires two <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-11101"></a></a> (or <a -href="#glo:makeglossaries-lite.lua"><span -class="cmtt-10">makeglossaries-lite</span><a - id="dx1-11102"></a></a>) calls to ensure - the document is up to date: <spacer type=vertical size=10><span class="obeylines-h"> - - - <br /><span -class="cmtt-10">latex sample-index</span> - <br /><span -class="cmtt-10">makeglossaries sample-index</span> - <br /><span -class="cmtt-10">latex sample-index</span> - <br /><span -class="cmtt-10">makeglossaries sample-index</span> - <br /><span -class="cmtt-10">latex sample-index</span></span> - <!--l. 1815--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">sample-newkeys.tex</span> </dt><dd -class="description"><a - id="x1-11103r29"></a> This document illustrates how add custom keys (using <span -class="cmtt-10">\glsaddkey</span>). - </dd><dt class="description"> -<span -class="cmtt-10">sample-storage-abbr.tex</span> </dt><dd -class="description"><a - id="x1-11104r30"></a> This document illustrates how add custom storage keys (using - <span -class="cmtt-10">\glsaddstoragekey</span>). - </dd><dt class="description"> -<span -class="cmtt-10">sample-storage-abbr-desc.tex</span> </dt><dd -class="description"><a - id="x1-11105r31"></a> An extension of the previous example where the user - needs to provide a description. - </dd><dt class="description"> -<span -class="cmtt-10">sample-chap-hyperfirst.tex</span> </dt><dd -class="description"><a - id="x1-11106r32"></a> This document illustrates how to add a custom key using - <span -class="cmtt-10">\glsaddstoragekey </span>and hook into the <a -href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> and <a -href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> mechanism used to - determine whether or not to hyperlink an entry. - </dd><dt class="description"> -<span -class="cmtt-10">sample-font-abbr.tex</span> </dt><dd -class="description"><a - id="x1-11107r33"></a> This document illustrates how to different fonts for abbreviations - within the style. - </dd><dt class="description"> -<span -class="cmtt-10">sample-numberlist.tex</span> </dt><dd -class="description"><a - id="x1-11108r34"></a> This document illustrates how to reference the <a -href="#glo:numberlist">number list<a - id="dx1-11109"></a></a> in the - document text. This requires an additional <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-numberlist</span> - <br /><span -class="cmtt-10">makeglossaries sample-numberlist</span> - <br /><span -class="cmtt-10">latex sample-numberlist</span> - <br /><span -class="cmtt-10">latex sample-numberlist</span></span> - <!--l. 1842--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> -<span -class="cmtt-10">samplePeople.tex</span> </dt><dd -class="description"><a - id="x1-11110r35"></a> This document illustrates how you can hook into the standard sort - mechanism to adjust the way the sort key is set. This requires an additional run to - ensure the table of contents is up-to-date: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex samplePeople</span> - <br /><span -class="cmtt-10">makeglossaries samplePeople</span> - <br /><span -class="cmtt-10">latex samplePeople</span> - - - <br /><span -class="cmtt-10">latex samplePeople</span></span> - <!--l. 1853--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> +</div> + + + <div class="verbatim" id="verbatim-23"> +\begin{document} + <br />\tableofcontents + <br />\section{Introduction} + <br />Sample document about \glspl{function} and \glspl{set}. + <br />\termdef{set} + <br />More detailed information about \glspl{set} with examples. + <br />\termdef{function} + <br />More detailed information about \glspl{function} with examples. + <br />\end{document} +</div> +<!--l. 1910--><p class="nopar" > Where the file <span +class="cmtt-10">terms.bib </span>contains: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor122"><span +class="cmtt-10">@entry</span></span><a + id="dx1-11017"></a><span +class="cmtt-10">{set,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={set},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={a</span><span +class="cmtt-10"> collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> any</span><span +class="cmtt-10"> kind</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> objects},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> symbol={\ensuremath{\mathcal{S}}}</span> +<br /><span +class="cmtt-10">}</span> +<br /><span id="textcolor123"><span +class="cmtt-10">@entry</span></span><a + id="dx1-11018"></a><span +class="cmtt-10">{function,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={function},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={a</span><span +class="cmtt-10"> rule</span><span +class="cmtt-10"> that</span><span +class="cmtt-10"> assigns</span><span +class="cmtt-10"> every</span><span +class="cmtt-10"> element</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> domain</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \gls{set}</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> an</span><span +class="cmtt-10"> element</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> range</span><span +class="cmtt-10"> \gls{set}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> symbol={\ensuremath{f(x)}}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The advantage in this approach (with <span +class="cmtt-10">\loadglsentries</span><a + id="dx1-11019"></a> or <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11020"></a></a>) is that you can use an existing database +of entries shared across multiple documents, ensuring consistent notation for all of them. +<!--l. 1930--><p class="indent" > In both cases, there’s no need to load all the glossary styles packages, as they’re not required, so I’ve used +the <span +class="cmss-10">nostyles</span><a + id="dx1-11021"></a> package option to prevent them from being loaded. +</p><!--l. 1934--><p class="indent" > In the first case, you need the <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">none</span><a + id="dx1-11022"></a> package option (as in <a +href="#option5">Option 5</a>) and then define the terms in the +preamble. No external tool is required. Just run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> as normal. (Twice to ensure that the table of contents +is up to date.) +</p><!--l. 1938--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + + + <br /></span> +</p><!--l. 1943--><p class="indent" > In the second case, you need the <span id="textcolor124"><span +class="cmss-10">record</span></span><a + id="dx1-11023"></a> package option (as in <a +href="#option4">Option 4</a>) since <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11024"></a></a> is needed to select the +required entries, but you don’t need a sorted list: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor125"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-11025"></a><span +class="cmtt-10">[</span><span id="textcolor126"><span +class="cmtt-10">src</span></span><a + id="dx1-11026"></a><span +class="cmtt-10">={terms},</span><strong><span id="textcolor127"><span +class="cmtt-10">sort</span></span><span +class="cmtt-10">=none</span></strong><span +class="cmtt-10">]</span> +</div> +</div> This will ensure that any entries indexed in the document (through commands like <span +class="cmtt-10">\gls</span><a + id="dx1-11027"></a> or <span +class="cmtt-10">\glsadd</span><a + id="dx1-11028"></a>) will be +selected by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11029"></a></a>, but it will skip the sorting step. (The chances are you probably also won’t need location +lists either. If so, you can add the option <span id="textcolor128"><span +class="cmtt-10">save-locations</span></span><span +class="cmtt-10">=false</span><a + id="dx1-11030"></a>.) +<!--l. 1955--><p class="indent" > Remember that for this second case you need to run <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11031"></a></a> as per <a +href="#option4">Option 4</a>: +</p><!--l. 1956--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />bib2gls myDoc + <br />pdflatex myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 1963--><p class="indent" > For both cases (with or without <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11032"></a></a>), instead of listing all the entries using <span id="textcolor129"><span +class="cmtt-10">\printunsrtglossary</span></span>, you +use <span id="textcolor130"><span +class="cmtt-10">\glsxtrglossentry</span></span><a + id="dx1-11033"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">} </span>where you want the name (and anchor with <span +class="cmss-10">hyperref</span><a + id="dx1-11034"></a>) to appear in the +document. This will allow the <a +href="#glo:linktext">link text<a + id="dx1-11035"></a></a> created by commands like <span +class="cmtt-10">\gls </span>to link to that point in the document. +The description can simply be displayed with <span +class="cmtt-10">\glsentrydesc</span><a + id="dx1-11036"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">} </span>or <span +class="cmtt-10">\Glsentrydesc</span><a + id="dx1-11037"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">}</span>, as in the above +examples. In both examples, I’ve defined a custom command <span +class="cmtt-10">\termdef </span>to simplify the code and ensure +consistency. Extra styling, such as placing the description in a coloured frame, can be added to this custom +definition as required. +</p><!--l. 1976--><p class="indent" > (Instead of using <span +class="cmtt-10">\glsentrydesc </span>or <span +class="cmtt-10">\Glsentrydesc</span>, you can use <span +class="cmtt-10">\glossentrydesc</span><a + id="dx1-11038"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">}</span>, which +will obey attributes such as <span id="textcolor131"><span +class="cmss-10">glossdesc</span></span><a + id="dx1-11039"></a> and <span id="textcolor132"><span +class="cmss-10">glossdescfont</span></span><a + id="dx1-11040"></a>. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further +details.) +</p><!--l. 1981--><p class="indent" > The symbol (if required) can be displayed with either <span +class="cmtt-10">\glsentrysymbol</span><a + id="dx1-11041"></a><span +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">} </span>or <span +class="cmtt-10">\glossentrysymbol</span><a + id="dx1-11042"></a> <span -class="cmtt-10">sampleSort.tex</span> </dt><dd -class="description"><a - id="x1-11111r36"></a> This is another document that illustrates how to hook into the standard - sort mechanism. An additional run is required to ensure the table of contents is - up-to-date: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sampleSort</span> - <br /><span -class="cmtt-10">makeglossaries sampleSort</span> - <br /><span -class="cmtt-10">latex sampleSort</span> - <br /><span -class="cmtt-10">latex sampleSort</span></span> - <!--l. 1863--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> +class="cmtt-10">{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">}</span>. In the first example, I’ve used <span +class="cmtt-10">\glsentrysymbol</span>. In the second I’ve used <span +class="cmtt-10">\glossentrysymbol</span><a + id="dx1-11043"></a>. The +latter is necessary with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11044"></a></a> if the symbol needs to go in a section title as the entries aren’t defined on the +first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. +</p><!--l. 1988--><p class="indent" > In normal document text, <span +class="cmtt-10">\glsentrysymbol </span>will silently do nothing if the entry hasn’t been defined, but +when used in a section heading it will expand to an undefined internal command when written to the <span +class="cmtt-10">aux</span><a + id="dx1-11045"></a> file, +which triggers an error. +</p><!--l. 1993--><p class="indent" > The <span +class="cmtt-10">\glossentrysymbol</span><a + id="dx1-11046"></a> command performs an existence check, which triggers a warning if the entry is undefined. +(All entries will be undefined before the first <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11047"></a></a> call.) You need at least <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> v1.42 to use this command in +a section title.<span class="footnote-mark"><a +href="#fn4x1" id="fn4x1-bk"><sup class="textsuperscript">1.4</sup></a></span><a + id="x1-11048f4"></a> +If <span +class="cmss-10">hyperref</span><a + id="dx1-11049"></a> has been loaded, this will use <span +class="cmtt-10">\texorpdfstring</span><a + id="dx1-11050"></a> to allow a simple expansion for the PDF bookmarks +(see the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details). +</p><!--l. 2004--><p class="indent" > If you want to test if the <span +class="cmtt-10">symbol</span><a + id="dx1-11051"></a> field has been set, you need to use <span +class="cmtt-10">\ifglshassymbol</span><a + id="dx1-11052"></a> outside of the section +title. For example: </p><div class="alltt"> + + +<div class="obeylines-v"> <span -class="cmtt-10">sample-nomathhyper.tex</span> </dt><dd -class="description"><a - id="x1-11112r37"></a> This document illustrates how to selectively enable and disable - entry hyperlinks in <span -class="cmtt-10">\glsentryfmt</span><a - id="dx1-11113"></a>. - </dd><dt class="description"> +class="cmtt-10">\ifglshassymbol{#1}%</span> +<br /><span +class="cmtt-10">{\section{</span><span id="textcolor133"><span +class="cmtt-10">\glsxtrglossentry</span></span><span +class="cmtt-10">{#1}</span><span +class="cmtt-10"> \glossentrysymbol{#1}}}</span> +<br /><span +class="cmtt-10">{\section{</span><span id="textcolor134"><span +class="cmtt-10">\glsxtrglossentry</span></span><span +class="cmtt-10">{#1}}}</span> +</div> +</div> +<!--l. 2013--><p class="indent" > In both of the above examples, the section titles start with a lowercase character (because the <span +class="cmtt-10">name</span><a + id="dx1-11053"></a> value is +all lowercase in entry definitions). You can apply automatic case-change with the <span id="textcolor135"><span +class="cmss-10">glossname</span></span><a + id="dx1-11054"></a> attribute. For +example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor136"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-11055"></a><span +class="cmtt-10">{general}{glossname}{firstuc}</span> +</div> +</div> or (for title-case) <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor137"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-11056"></a><span +class="cmtt-10">{general}{glossname}{title}</span> +</div> +</div> However, this won’t apply the case-change in the table of contents or bookmarks. +<!--l. 2027--><p class="indent" > In the second example, you can instead use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11057"></a></a> to apply a case-change: </p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">sample-entryfmt.tex</span> </dt><dd -class="description"><a - id="x1-11114r38"></a> This document illustrates how to change the way an entry is - displayed in the text. - </dd><dt class="description"> +class="cmtt-10">\GlsXtrLoadResources[</span><span id="textcolor138"><span +class="cmtt-10">src</span></span><a + id="dx1-11058"></a><span +class="cmtt-10">=terms,</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor139"><span +class="cmtt-10">sort</span></span><a + id="dx1-11059"></a><span +class="cmtt-10">=none,</span><span id="textcolor140"><span +class="cmtt-10">save-locations</span></span><a + id="dx1-11060"></a><span +class="cmtt-10">=false</span><strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor141"><span +class="cmtt-10">replicate-fields</span></span><a + id="dx1-11061"></a><span +class="cmtt-10">={name=text},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor142"><span +class="cmtt-10">name-case-change</span></span><span +class="cmtt-10">=firstuc</span></strong> +<br /><span +class="cmtt-10">]</span> +</div> +</div> (Or <span id="textcolor143"><span +class="cmtt-10">name-case-change</span></span><span +class="cmtt-10">=title</span><a + id="dx1-11062"></a> for title-case.) This copies the <span +class="cmtt-10">name</span><a + id="dx1-11063"></a> value to the <span +class="cmtt-10">text</span><a + id="dx1-11064"></a> field and +then applies a case-change to the <span +class="cmtt-10">name</span><a + id="dx1-11065"></a> field (leaving the <span +class="cmtt-10">text</span><a + id="dx1-11066"></a> field unchanged). The name in the +section titles now starts with a capital but the <a +href="#glo:linktext">link text<a + id="dx1-11067"></a></a> produced by commands like <span +class="cmtt-10">\gls</span><a + id="dx1-11068"></a> is still +lowercase. +<!--l. 2043--><p class="indent" > In the first example (without <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11069"></a></a>) you need to do this manually. For example: </p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">sample-prefix.tex</span> </dt><dd -class="description"><a - id="x1-11115r39"></a> This document illustrates the use of the <span -class="cmss-10">glossaries-prefix</span><a - id="dx1-11116"></a> package. - An additional run is required to ensure the table of contents is up-to-date: - <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex sample-prefix</span> - <br /><span -class="cmtt-10">makeglossaries sample-prefix</span> - <br /><span -class="cmtt-10">latex sample-prefix</span> - <br /><span -class="cmtt-10">latex sample-prefix</span></span> - <!--l. 1879--><p class="noindent" ><spacer type=vertical size=10> - </p></dd><dt class="description"> +class="cmtt-10">\newglossaryentry{set}{name={</span><strong><span +class="cmtt-10">S</span></strong><span +class="cmtt-10">et},</span><strong><span +class="cmtt-10">text={set}</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={a</span><span +class="cmtt-10"> collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> any</span><span +class="cmtt-10"> kind</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> objects},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> symbol={\ensuremath{\mathcal{S}}}</span> +<br /><span +class="cmtt-10">}</span> + + +</div> +</div> +<!--l. 2052--><p class="indent" > Note that if you use the default <span id="textcolor144"><span +class="cmtt-10">save-locations</span></span><span +class="cmtt-10">=true</span><a + id="dx1-11070"></a> with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11071"></a></a>, it’s possible to combine Options <a +href="#option4">4</a> +and <a +href="#option6">6</a> to have both standalone definitions and an index. Now I do need a glossary style. In this case I’m going +to use <span id="textcolor145"><span +class="cmss-10">bookindex</span></span><a + id="dx1-11072"></a>, which is provided in the <span +class="cmss-10">glossary-bookindex</span><a + id="dx1-11073"></a> package (bundled with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>). I don’t +need any of the other style packages, so I can still keep the <span +class="cmss-10">nostyles</span><a + id="dx1-11074"></a> option and just load <span +class="cmss-10">glossary-bookindex</span><a + id="dx1-11075"></a>: +</p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">sampleaccsupp.tex</span> </dt><dd -class="description"><a - id="x1-11117r40"></a> This document uses the experimental <span -class="cmss-10">glossaries-accsupp</span><a - id="dx1-11118"></a> package. The - symbol is set to the replacement text. Note that some PDF viewers don’t use the - accessibility support. Information about the <span -class="cmss-10">glossaries-accsupp </span>package can be found in - <a -href="#sec:accsupp"><span -class="tcrm-1000">§</span>18 </a><a -href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>. - </dd><dt class="description"> +class="cmtt-10">\usepackage[</span><span id="textcolor146"><span +class="cmtt-10">record=nameref</span></span><span +class="cmtt-10">,%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> using</span><span +class="cmtt-10"> bib2gls</span> +<br /><span +class="cmtt-10"> nostyles,%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> don't</span><span +class="cmtt-10"> load</span><span +class="cmtt-10"> default</span><span +class="cmtt-10"> style</span><span +class="cmtt-10"> packages</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor147"><span +class="cmtt-10">stylemods=bookindex</span></span><span +class="cmtt-10">,%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> load</span><span +class="cmtt-10"> glossary-bookindex.sty</span> +<br /><span +class="cmtt-10"> style=</span><span id="textcolor148"><span +class="cmtt-10">bookindex</span></span><span +class="cmtt-10">%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> set</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> default</span><span +class="cmtt-10"> style</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> 'bookindex'</span> +<br /><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> I also need to sort the entries, so the resource command is now: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor149"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-11076"></a><span +class="cmtt-10">[</span><span id="textcolor150"><span +class="cmtt-10">src</span></span><a + id="dx1-11077"></a><span +class="cmtt-10">=terms,%</span><span +class="cmtt-10"> definitions</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> terms.bib</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor151"><span +class="cmtt-10">sort</span></span><a + id="dx1-11078"></a><span +class="cmtt-10">=en-GB,%</span><span +class="cmtt-10"> sort</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> this</span><span +class="cmtt-10"> locale</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor152"><span +class="cmtt-10">replicate-fields</span></span><a + id="dx1-11079"></a><span +class="cmtt-10">={name=text},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor153"><span +class="cmtt-10">name-case-change</span></span><span +class="cmtt-10">={firstuc}</span> +<br /><span +class="cmtt-10">]</span> +</div> +</div> At the end of the document, I can add the glossary: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor154"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-11080"></a><span +class="cmtt-10">[title=Index,target=false]</span> +</div> +</div> Note that I’ve had to switch off the hypertargets with <a + id="dx1-11081"></a><span id="textcolor155"><span +class="cmtt-10">target=false</span></span> (otherwise there would be duplicate +targets). If you want letter group headings you need to use the <span id="textcolor156"><span +class="cmtt-10">--group</span></span><a + id="dx1-11082"></a> switch: +<!--l. 2083--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />bib2gls --group myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +or if you are using <span +class="cmtt-10">arara</span><a + id="dx1-11083"></a>: </p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">sample-ignored.tex</span> </dt><dd -class="description"><a - id="x1-11119r41"></a> This document defines an ignored glossary for common terms that - don’t need a definition. - - - </dd><dt class="description"> +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> bib2gls:</span><span +class="cmtt-10"> {</span><span +class="cmtt-10"> group:</span><span +class="cmtt-10"> on</span><span +class="cmtt-10"> }</span> +</div> +</div> + + +<!--l. 2091--><p class="indent" > The <span id="textcolor157"><span +class="cmss-10">bookindex</span></span><a + id="dx1-11084"></a> style doesn’t show the description, so only the name and location is displayed. Remember +that the name has had a case-conversion so it now starts with an initial capital. If you feel this is inappropriate +for the index, you can adjust the <span id="textcolor158"><span +class="cmss-10">bookindex</span></span><a + id="dx1-11085"></a> style so that it uses the <span +class="cmtt-10">text</span><a + id="dx1-11086"></a> field instead. For example: +</p><div class="alltt"> +<div class="obeylines-v"> <span -class="cmtt-10">sample-entrycount.tex</span> </dt><dd -class="description"><a - id="x1-11120r42"></a> This document uses <span -class="cmtt-10">\glsenableentrycount</span><a - id="dx1-11121"></a> and <span -class="cmtt-10">\cgls</span><a - id="dx1-11122"></a> (described - in <a -href="#sec:enableentrycount"><span -class="tcrm-1000">§</span>14.1 </a><a -href="#sec:enableentrycount">Counting the Number of Times an Entry has been Used (First Use - Flag Unset)<!--tex4ht:ref: sec:enableentrycount --></a>) so that acronyms only used once don’t appear in the list of - acronyms.</dd></dl> -<!--l. 1897--><p class="noindent" > -</p> -<!--l. 1897--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a +class="cmtt-10">\renewcommand*{</span><span id="textcolor159"><span +class="cmtt-10">\glsxtrbookindexname</span></span><a + id="dx1-11087"></a><span +class="cmtt-10">}[1]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor160"><span +class="cmtt-10">\glossentrynameother</span></span><a + id="dx1-11088"></a><span +class="cmtt-10">{#1}{text}}</span> +</div> +</div> See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details about this style. +<!--l. 2104--><p class="indent" > Note that on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run none of the entries will be defined. Once they are defined, the page +numbers may shift due to the increased amount of document text. You may therefore need to repeat the +document build to ensure the page numbers are correct. +</p><!--l. 2109--><p class="indent" > If there are extra terms that need to be included in the index that don’t have a description, you can define +them with <span id="textcolor161"><span +class="cmtt-10">@index</span></span><a + id="dx1-11089"></a> in the <span +class="cmtt-10">bib</span><a + id="dx1-11090"></a> file. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor162"><span +class="cmtt-10">@index</span></span><a + id="dx1-11091"></a><span +class="cmtt-10">{element}</span> +<br /><span id="textcolor163"><span +class="cmtt-10">@index</span></span><a + id="dx1-11092"></a><span +class="cmtt-10">{member,</span><span id="textcolor164"><span id="textcolor165"><span +class="cmtt-10">alias</span></span><a + id="dx1-11093"></a></span><span +class="cmtt-10">={element}}</span> +</div> +</div> They can be used in the document as usual: + + + <div class="verbatim" id="verbatim-24"> +The objects that make up a set are the \glspl{element} + <br />or \glspl{member}. +</div> +<!--l. 2120--><p class="nopar" > See <a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory Guide</a> or the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-11094"></a></a> user manual for further +details. +</p><!--l. 2124--><p class="indent" > The <span +class="cmss-10">glossaries </span>package comes with a number of sample documents that illustrate the various functions. These +are listed in <a +href="#sec:samples">§19 </a><a +href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>. +</p><!--l. 2128--><p class="noindent" > +</p> +<!--l. 2128--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a id="sec:lipsum"></a>Dummy Entries for Testing</h3> -<!--l. 1900--><p class="noindent" >In addition to the sample files described above, <span +<!--l. 2131--><p class="noindent" >In addition to the sample files described above, <span class="cmss-10">glossaries</span><a - id="dx1-12001"></a> also provides some files containing -lorum ipsum dummy entries. These are provided for testing purposes and are on <span class="TEX">T<span -class="E">E</span>X</span>’s path -(in <span + id="dx1-12001"></a> also provides some files containing lorum +ipsum dummy entries. These are provided for testing purposes and are on <span class="TEX">T<span +class="E">E</span>X</span>’s path (in +<span class="cmtt-10">tex/latex/glossaries/test-entries</span>) so they can be included via <span class="cmtt-10">\input</span><a - id="dx1-12002"></a> or -<span + id="dx1-12002"></a> or <span class="cmtt-10">\loadglsentries</span><a - id="dx1-12003"></a>. The files are as follows: + id="dx1-12003"></a>. The +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides <span +class="cmtt-10">bib</span><a + id="dx1-12004"></a> versions of all these files for use with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-12005"></a></a>. The files are as +follows: </p><dl class="description"><dt class="description"> <span class="cmbx-10">example-glossaries-brief.tex</span> </dt><dd class="description">These entries all have brief descriptions. For example: - - - <div class="verbatim" id="verbatim-38"> + + + <div class="verbatim" id="verbatim-25"> \newglossaryentry{lorem}{name={lorem},description={ipsum}} </div> - <!--l. 1910--><p class="nopar" > + <!--l. 2145--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-long.tex</span> </dt><dd class="description">These entries all have long descriptions. For example: - - - <div class="verbatim" id="verbatim-39"> + + + <div class="verbatim" id="verbatim-26"> \newglossaryentry{loremipsum}{name={lorem ipsum},  <br />description={dolor sit amet, consectetuer adipiscing  <br />elit. Ut purus elit, vestibulum ut, placerat ac,  <br />adipiscing vitae, felis. Curabitur dictum gravida  <br />mauris.}} </div> - <!--l. 1920--><p class="nopar" > + <!--l. 2155--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-multipar.tex</span> </dt><dd -class="description">These entries all have multi-paragraph descriptions. - </dd><dt class="description"> +class="description">These entries all have multi-paragraph descriptions. For example: + + + <div class="verbatim" id="verbatim-27"> + \longnewglossaryentry{loremi-ii}{name={lorem 1--2}}% +  <br />{% +  <br />Lorem ipsum ... +  <br />Nam dui ligula... +  <br />} +</div> + <!--l. 2166--><p class="nopar" > + </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-symbols.tex</span> </dt><dd class="description">These entries all use the <span -class="cmss-10">symbol</span><a - id="dx1-12004"></a> key. For example: - - - <div class="verbatim" id="verbatim-40"> +class="cmtt-10">symbol</span><a + id="dx1-12006"></a> key. For example: + + + <div class="verbatim" id="verbatim-28"> \newglossaryentry{alpha}{name={alpha},  <br />symbol={\ensuremath{\alpha}},  <br />description={Quisque ullamcorper placerat ipsum.}} </div> - <!--l. 1931--><p class="nopar" > + <!--l. 2174--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-symbolnames.tex</span> </dt><dd class="description">Similar to the previous file but the <span -class="cmss-10">symbol</span><a - id="dx1-12005"></a> key isn’t - used. Instead the symbol is stored in the <span -class="cmss-10">name</span><a - id="dx1-12006"></a> key. For example: - - - <div class="verbatim" id="verbatim-41"> +class="cmtt-10">symbol</span><a + id="dx1-12007"></a> key isn’t used. Instead the + symbol is stored in the <span +class="cmtt-10">name</span><a + id="dx1-12008"></a> key. For example: + + + <div class="verbatim" id="verbatim-29"> \newglossaryentry{sym.alpha}{sort={alpha},  <br />name={\ensuremath{\alpha}},  <br />description={Quisque ullamcorper placerat ipsum.}} </div> - <!--l. 1940--><p class="nopar" > + <!--l. 2183--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-images.tex</span> </dt><dd class="description">These entries use the <span -class="cmss-10">user1</span><a - id="dx1-12007"></a> key to store the name of an - image file. (The images are provided by the <span +class="cmtt-10">user1</span><a + id="dx1-12009"></a> key to store the name of an image file. (The + images are provided by the <span class="cmss-10">mwe</span><a - id="dx1-12008"></a> package and should be on <span class="TEX">T<span -class="E">E</span>X</span>’s - path.) One entry doesn’t have an associated image to help test for a missing - key. - </dd><dt class="description"> + id="dx1-12010"></a> package and should be on <span class="TEX">T<span +class="E">E</span>X</span>’s path.) One entry doesn’t have an + associated image to help test for a missing key. The descriptions are long to allow for tests with the text + wrapping around the image. For example: + + + <div class="verbatim" id="verbatim-30"> + \longnewglossaryentry{sedfeugiat}{name={sed feugiat}, +  <br />user1={example-image}}% +  <br />{% +  <br />Cum sociis natoque... +  <br />Etiam... +  <br />} +</div> + <!--l. 2199--><p class="nopar" > + </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-acronym.tex</span> </dt><dd class="description">These entries are all abbreviations. For example: - - - <div class="verbatim" id="verbatim-42"> + + + <div class="verbatim" id="verbatim-31"> \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum  <br />dolor} </div> - <!--l. 1952--><p class="nopar" > + <!--l. 2206--><p class="nopar" > + </p><!--l. 2207--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, then <span +class="cmtt-10">\newacronym</span><a + id="dx1-12011"></a> is redefined to use <span id="textcolor166"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-12012"></a> + with the <span id="textcolor167"><span id="textcolor168"><span +class="cmtt-10">category</span></span><a + id="dx1-12013"></a></span> key set to <span +class="cmtt-10">acronym </span>(rather than the default <span +class="cmtt-10">abbreviation</span>). This means that you need + to set the abbreviation style for the <span +class="cmtt-10">acronym </span>category. For example: + + +</p> + <div class="verbatim" id="verbatim-32"> + \setabbreviationstyle[acronym]{long-short} +</div> + <!--l. 2216--><p class="nopar" > </div> + </p><!--l. 2217--><p class="noindent" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-acronym-desc.tex</span> </dt><dd -class="description">These entries are all abbreviations that use the +class="description">This file contains entries that are all abbreviations that use the <span -class="cmss-10">description</span><a - id="dx1-12009"></a> key. For example: - - - <div class="verbatim" id="verbatim-43"> +class="cmtt-10">description</span><a + id="dx1-12014"></a> key. For example: + + + <div class="verbatim" id="verbatim-33"> \newacronym[type=\glsdefaulttype,  <br />  description={fringilla a, euismod sodales,  <br />  sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} </div> - <!--l. 1961--><p class="nopar" > + <!--l. 2227--><p class="nopar" > + </p><!--l. 2228--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, then <span +class="cmtt-10">\newacronym</span><a + id="dx1-12015"></a> is redefined to use <span id="textcolor169"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-12016"></a> + with the <span id="textcolor170"><span id="textcolor171"><span +class="cmtt-10">category</span></span><a + id="dx1-12017"></a></span> key set to <span +class="cmtt-10">acronym </span>(rather than the default <span +class="cmtt-10">abbreviation</span>). This means that you need + to set the abbreviation style for the <span +class="cmtt-10">acronym </span>category. For example: + + +</p> + <div class="verbatim" id="verbatim-34"> + \setabbreviationstyle[acronym]{long-short-desc} +</div> + <!--l. 2237--><p class="nopar" > </div> + </p><!--l. 2238--><p class="noindent" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-acronyms-lang.tex</span> </dt><dd -class="description">These entries are all abbreviations, where some of - them have a translation supplied in the <span -class="cmss-10">user1</span><a - id="dx1-12010"></a> key. For example: - - - <div class="verbatim" id="verbatim-44"> +class="description">These entries are all abbreviations, where some of them have + a translation supplied in the <span +class="cmtt-10">user1</span><a + id="dx1-12018"></a> key. For example: + + + <div class="verbatim" id="verbatim-35"> \newacronym[type=\glsdefaulttype,user1={love itself}]  <br /> {li}{LI}{lorem ipsum} </div> - <!--l. 1970--><p class="nopar" > + <!--l. 2247--><p class="nopar" > + </p><!--l. 2248--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, then <span +class="cmtt-10">\newacronym</span><a + id="dx1-12019"></a> is redefined to use <span id="textcolor172"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-12020"></a> + with the <span id="textcolor173"><span id="textcolor174"><span +class="cmtt-10">category</span></span><a + id="dx1-12021"></a></span> key set to <span +class="cmtt-10">acronym </span>(rather than the default <span +class="cmtt-10">abbreviation</span>). This means that you need + to set the abbreviation style for the <span +class="cmtt-10">acronym </span>category. For example: + + +</p> + <div class="verbatim" id="verbatim-36"> + \setabbreviationstyle[acronym]{long-short-user} +</div> + <!--l. 2257--><p class="nopar" > </div> + </p><!--l. 2258--><p class="noindent" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-parent.tex</span> </dt><dd -class="description">These are hierarchical entries where the child entries use - the <span -class="cmss-10">name</span><a - id="dx1-12011"></a> key. For example: - - - <div class="verbatim" id="verbatim-45"> +class="description">These are hierarchical entries where the child entries use the <span +class="cmtt-10">name</span><a + id="dx1-12022"></a> key. For + example: + + + <div class="verbatim" id="verbatim-37"> \newglossaryentry{sedmattis}{name={sed mattis},  <br />description={erat sit amet}  <br />\newglossaryentry{gravida}{parent={sedmattis},  <br />  name={gravida},description={malesuada}} </div> - <!--l. 1981--><p class="nopar" > + <!--l. 2269--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-childnoname.tex</span> </dt><dd -class="description">These are hierarchical entries where the child - entries don’t use the <span -class="cmss-10">name</span><a - id="dx1-12012"></a> key. For example: - - - <div class="verbatim" id="verbatim-46"> +class="description">These are hierarchical entries where the child entries don’t use the + <span +class="cmtt-10">name</span><a + id="dx1-12023"></a> key. For example: + + + <div class="verbatim" id="verbatim-38"> \newglossaryentry{scelerisque}{name={scelerisque},  <br />  description={at}} +  <br />\newglossaryentry{vestibulum}{parent={scelerisque}, +  <br />  description={eu, nulla}} </div> - <!--l. 1989--><p class="nopar" > + <!--l. 2280--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-cite.tex</span> </dt><dd class="description">These entries use the <span -class="cmss-10">user1</span><a - id="dx1-12013"></a> key to store a citation - key (or comma-separated list of citation keys). The citations are defined in - <span -class="cmtt-10">xampl.bib</span>, which should be available on all modern <span class="TEX">T<span -class="E">E</span>X</span> distributions. One - entry doesn’t have an associated citation to help test for a missing key. For +class="cmtt-10">user1</span><a + id="dx1-12024"></a> key to store a citation key (or comma-separated list + of citation keys). The citations are defined in <span +class="cmtt-10">xampl.bib</span>, which should be available on all modern + <span class="TEX">T<span +class="E">E</span>X</span> distributions. One entry doesn’t have an associated citation to help test for a missing key. For example: - - - <div class="verbatim" id="verbatim-47"> + + + <div class="verbatim" id="verbatim-39"> \newglossaryentry{fusce}{name={fusce},  <br />description={suscipit cursus sem},user1={article-minimal}} </div> - <!--l. 2001--><p class="nopar" > + <!--l. 2292--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">example-glossaries-url.tex</span> </dt><dd class="description">These entries use the <span -class="cmss-10">user1</span><a - id="dx1-12014"></a> key to store an URL associated - with the entry. For example: - - - <div class="verbatim" id="verbatim-48"> +class="cmtt-10">user1</span><a + id="dx1-12025"></a> key to store an URL associated with the entry. For + example: + + + <div class="verbatim" id="verbatim-40"> \newglossaryentry{aenean-url}{name={aenean},  <br /> description={adipiscing auctor est},  <br /> user1={http://uk.tug.org/}} </div> - <!--l. 2010--><p class="nopar" ></p></dd></dl> -<!--l. 2013--><p class="indent" > The sample file <span -class="cmtt-10">glossary-lipsum-examples.tex </span>in the <span -class="cmtt-10">doc/latex/glossaries/samples</span> -directory uses all these files. See also <a -href="http://www.dickimaw-books.com/gallery/#glossaries" class="url" ><span -class="cmtt-10">http://www.dickimaw-books.com/gallery/#glossaries</span></a>. -The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-12015"></a> package provides additional test files. -</p><!--l. 2019--><p class="noindent" > + <!--l. 2301--><p class="nopar" ></p></dd></dl> +<!--l. 2304--><p class="indent" > The sample file <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/glossary-lipsum-examples.tex" ><span +class="cmtt-10">glossary-lipsum-examples.tex</span></a> in the <span +class="cmtt-10">doc/latex/glossaries/samples </span>directory uses all +these files. See also <a +href="https://www.dickimaw-books.com/gallery/#glossaries" ><span +class="cmtt-10">https://www.dickimaw-books.com/gallery/#glossaries</span></a>. +</p><!--l. 2308--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides the additional test file: + </p><dl class="description"><dt class="description"> +<span +class="cmbx-10">example-glossaries-xr.tex</span> </dt><dd +class="description">These entries use the <span +class="cmtt-10">see</span><a + id="dx1-12026"></a> key provided by the base <span +class="cmss-10">glossaries </span>package and also the + <span id="textcolor175"><span id="textcolor176"><span +class="cmtt-10">alias</span></span><a + id="dx1-12027"></a></span> and <span id="textcolor177"><span id="textcolor178"><span +class="cmtt-10">seealso</span></span><a + id="dx1-12028"></a></span> keys that require <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. For example: + + + <div class="verbatim" id="verbatim-41"> + \newglossaryentry{alias-lorem}{name={alias-lorem}, +  <br /> description={ipsum},alias={lorem}} +  <br />\newglossaryentry{amet}{name={amet},description={consectetuer}, +  <br /> see={dolor}} +  <br />\newglossaryentry{arcu}{name={arcu},description={libero}, +  <br /> seealso={placerat,vitae,curabitur}} +</div> + <!--l. 2325--><p class="nopar" ></p></dd></dl> +<!--l. 2328--><p class="noindent" > </p> -<!--l. 2019--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a +<!--l. 2328--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a id="sec:languages"></a>Multi-Lingual Support</h3> -<!--l. 2022--><p class="noindent" >As from version 1.17, the <span +<!--l. 2331--><p class="noindent" ><div class="important" title="Important Note"> The <span +class="cmss-10">glossaries </span>package uses the <span +class="cmss-10">tracklang </span>package to determine the document languages. Unfortunately, because +there isn’t a standard language identification framework provided with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>, <span +class="cmss-10">tracklang </span>isn’t always able to +detect the selected languages either as a result of using an unknown interface or where the interface doesn’t +provide a way of detecting the language. See <a +href="https://www.dickimaw-books.com/latex/tracklang/" >Localisation with <span +class="cmtt-10">tracklang.tex</span></a> for further details. +</div> +</p><!--l. 2341--><p class="noindent" > +</p><!--l. 2343--><p class="noindent" >As from version 1.17, the <span class="cmss-10">glossaries </span>package can be used with <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a id="dx1-13001"></a></a> as well as <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-13002"></a></a>. If -you are writing in a language that uses an <a + id="dx1-13002"></a></a>. If you are writing in a +language that uses an <a href="#glo:exlatinalph">extended Latin alphabet</a> or <a -href="#glo:nonlatinalph">non-Latin alphabet</a> it’s -best to use <a +href="#glo:nonlatinalph">non-Latin alphabet</a> it’s best to use <a href="#option3">Option 3</a> (<span class="cmtt-10">xindy</span><a - id="dx1-13003"></a>) or <a + id="dx1-13003"></a>) or +<a href="#option4">Option 4</a> (<a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a id="dx1-13004"></a></a>) as <span class="cmtt-10">makeindex</span><a id="dx1-13005"></a> (<a -href="#option2">Option 2</a>) is hard-coded -for the non-extended <a +href="#option2">Option 2</a>) is hard-coded for the non-extended <a href="#glo:latinalph">Latin alphabet<a id="dx1-13006"></a></a> and <a -href="#option1">Option 1</a> can performed limited ASCII -comparisons. -</p><!--l. 2030--><p class="indent" > This means that with Options <a +href="#option1">Option 1</a> +can only perform limited ASCII comparisons. +</p><!--l. 2351--><p class="indent" > This means that with Options <a href="#option3">3</a> or <a -href="#option4">4</a> you are not restricted to the A, …, Z letter -groups. If you want to use <span +href="#option4">4</a> you are not restricted to the A, …, Z letter groups. If you want to use +<span class="cmtt-10">xindy</span><a id="dx1-13007"></a>, remember to use the <span class="cmss-10">xindy</span><a - id="dx1-13008"></a> package option. For -example: - - + id="dx1-13008"></a> package option. For example: + + </p> - <div class="verbatim" id="verbatim-49"> + <div class="verbatim" id="verbatim-42"> \documentclass[frenchb]{article}  <br />\usepackage[utf8]{inputenc}  <br />\usepackage[T1]{fontenc}  <br />\usepackage{babel}  <br />\usepackage[xindy]{glossaries} </div> -<!--l. 2039--><p class="nopar" > If you want to use <span +<!--l. 2360--><p class="nopar" > If you want to use <span class="cmtt-10">bib2gls</span><a - id="dx1-13009"></a>, you need to use the <span -class="cmss-10">record</span><a - id="dx1-13010"></a> option with <span -class="cmss-10">glossaries-extra</span><a - id="dx1-13011"></a> -and supply the definitions in <span -class="cmtt-10">.bib </span>files. (See the <a + id="dx1-13009"></a>, you need to use the <span id="textcolor179"><span +class="cmss-10">record</span></span><a + id="dx1-13010"></a> option with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and supply the definitions in +<span +class="cmtt-10">bib</span><a + id="dx1-13011"></a> files. (See the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-13012"></a></a> user manual for further -details.) -</p><!--l. 2045--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a + id="dx1-13012"></a></a> user manual for further details.) +</p><!--l. 2366--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-13013"></a></a>, such as é, looks like a plain character -in your <span -class="cmtt-10">.tex</span><a - id="dx1-13014"></a> file, with standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> it’s actually a macro and can therefore -cause expansion problems. You may need to switch off the field expansions with -<span + id="dx1-13013"></a></a>, such as é, looks like a plain character in your <span +class="cmtt-10">tex</span><a + id="dx1-13014"></a> file, with +standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> it’s actually a macro and can therefore cause expansion problems. You may need to switch +off the field expansions with <span class="cmtt-10">\glsnoexpandfields</span>. This issue doesn’t occur with XeLaTeX or Lua<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>. </div> -</p><!--l. 2051--><p class="noindent" > -</p><!--l. 2053--><p class="indent" > With <span +</p><!--l. 2372--><p class="noindent" > +</p><!--l. 2374--><p class="indent" > With <span class="cmss-10">inputenc</span><a id="dx1-13015"></a>, if you use a <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-13016"></a></a> (or other expandable) character at the -start of an entry name, you must place it in a group, or it will cause a problem for -commands that convert the first letter to upper case (e.g. <span + id="dx1-13016"></a></a> (or other expandable) character at the start of an entry +name, you must place it in a group, or it will cause a problem for commands that convert the first letter to +upper case (e.g. <span class="cmtt-10">\Gls</span><a - id="dx1-13017"></a>). For example: -</p><div class="alltt"> + id="dx1-13017"></a>). For example: </p><div class="alltt"> <div class="obeylines-v"> -<span class="verb"><span -class="cmtt-10">\newglossaryentry}{elite}{name={{</span></span><span -class="cmtt-10">é</span><span class="verb"><span -class="cmtt-10">}lite},</span></span> +<span +class="cmtt-10">\newglossaryentry{elite}{name={{</span><span +class="cmtt-10">é</span><span +class="cmtt-10">}lite},</span> <br /><span -class="cmtt-10">description=</span><span class="verb"><span -class="cmtt-10">{select</span><span +class="cmtt-10">description={select</span><span class="cmtt-10"> group</span><span class="cmtt-10"> or</span><span -class="cmtt-10"> class}}</span></span> +class="cmtt-10"> class}}</span> </div> -</div> (With newer versions of <span -class="cmss-10">mfirstuc</span><a - id="dx1-13018"></a> and <span -class="cmss-10">datatool-base</span><a - id="dx1-13019"></a> you may be able to omit this grouping.) -For further details, see the “UTF-8” section in the <span +</div> For further details, see the “UTF-8” section in the <span class="cmss-10">mfirstuc</span><a - id="dx1-13020"></a> user manual. -<!--l. 2066--><p class="indent" > If you are using <a + id="dx1-13018"></a> user manual. +<!--l. 2385--><p class="indent" > If you are using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-13021"></a></a> or <a + id="dx1-13019"></a></a> or <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-13022"></a></a>, the application needs to know the encoding of the -<span -class="cmtt-10">.tex</span><a - id="dx1-13023"></a> file. This information is added to the <span -class="cmtt-10">.aux</span><a - id="dx1-13024"></a> file and can be picked up by <a + id="dx1-13020"></a></a>, the application needs to know the encoding of the <span +class="cmtt-10">tex</span><a + id="dx1-13021"></a> file. This +information is added to the <span +class="cmtt-10">aux</span><a + id="dx1-13022"></a> file and can be picked up by <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-13025"></a></a> -and <a + id="dx1-13023"></a></a> and <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-13026"></a></a>. If you use <a + id="dx1-13024"></a></a>. If you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-13027"></a></a> explicitly instead of via <span + id="dx1-13025"></a></a> +explicitly instead of via <span class="cmtt-10">makeglossaries</span><a - id="dx1-13028"></a>, you may need to -specify the encoding using the <span + id="dx1-13026"></a>, you may need to specify the encoding using the <span class="cmtt-10">-C</span><a - id="dx1-13029"></a> option. Read the <span + id="dx1-13027"></a> option. Read the +<span class="cmtt-10">xindy</span><a - id="dx1-13030"></a> manual for further details of this -option. -</p><!--l. 2075--><p class="indent" > As from v4.24, if you are writing in German (for example, using the <span + id="dx1-13028"></a> manual for further details of this option. +</p><!--l. 2394--><p class="indent" > As from v4.24, if you are writing in German (for example, using the <span class="cmss-10">ngerman</span><a - id="dx1-13031"></a> + id="dx1-13029"></a> package<span class="footnote-mark"><a -href="#fn4x1" id="fn4x1-bk"><sup class="textsuperscript">1.4</sup></a></span><a - id="x1-13032f4"></a> +href="#fn5x1" id="fn5x1-bk"><sup class="textsuperscript">1.5</sup></a></span><a + id="x1-13030f5"></a> or <span class="cmss-10">babel</span><a - id="dx1-13033"></a> with the <span -class="cmss-10">ngerman</span><a - id="dx1-13034"></a> package option), and you want to use <a + id="dx1-13031"></a> with the <span +class="cmss-10">ngerman </span>package option), and you want to use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-13035"></a>’s</a> <span + id="dx1-13032"></a>’s</a> <span class="cmtt-10">-g</span><a - id="dx1-13036"></a> option, you’ll -need to change <a + id="dx1-13033"></a> option, you’ll need to change +<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-13037"></a>’s</a> quote character using: -</p><!--l. 2079--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetQuote</span><span -class="cmtt-9"> </span></span><a - id="dx1-13038"></a> <span + id="dx1-13034"></a>’s</a> quote character using: +</p><!--l. 2399--><p class="indent" > <hr><div title="Definition"><a + id="dx1-13035"></a> <span class="cmtt-10">\GlsSetQuote{</span>⟨<span class="cmitt-10">character</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 2081--><p class="noindent" > +</p><!--l. 2401--><p class="noindent" > Note that ⟨<span class="cmti-10">character</span>⟩ may not be one of <span class="obeylines-h"><span class="verb"><span class="cmtt-10">?</span></span></span> (question mark), <span class="obeylines-h"><span class="verb"><span class="cmtt-10">|</span></span></span> (pipe) or <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">!</span></span></span> (exclamation mark). -For example: - - +class="cmtt-10">!</span></span></span> (exclamation mark). For +example: + + </p> - <div class="verbatim" id="verbatim-50"> + <div class="verbatim" id="verbatim-43"> \GlsSetQuote{+} </div> -<!--l. 2087--><p class="nopar" > This must be done before <span +<!--l. 2407--><p class="nopar" > This must be done before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-13039"></a> and any entry definitions. It’s only applicable -for <span + id="dx1-13036"></a> and any entry definitions. It’s only applicable for <span class="cmtt-10">makeindex</span><a - id="dx1-13040"></a>. This option in conjunction with <span + id="dx1-13037"></a>. This +option in conjunction with <span class="cmss-10">ngerman</span><a - id="dx1-13041"></a> will also cause <span + id="dx1-13038"></a> will also cause <span class="cmtt-10">makeglossaries</span><a - id="dx1-13042"></a> to -use the <span + id="dx1-13039"></a> to use the <span class="cmtt-10">-g</span><a - id="dx1-13043"></a> switch when invoking <span + id="dx1-13040"></a> switch when invoking +<span class="cmtt-10">makeindex</span><a - id="dx1-13044"></a>. -</p><!--l. 2094--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span + id="dx1-13041"></a>. +</p><!--l. 2414--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span class="cmss-10">babel</span><a - id="dx1-13045"></a>’s shorthands. These aren’t switched on until the start of the -document, so any entries defined in the preamble won’t be able to use those shorthands. -However, if you define the entries in the document and any of those shorthands happen to be -special characters for <a + id="dx1-13042"></a>’s shorthands. These aren’t switched on until the start of the document, so any entries +defined in the preamble won’t be able to use those shorthands. However, if you define the entries in the +document and any of those shorthands happen to be special characters for <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-13046"></a></a> or <a + id="dx1-13043"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-13047"></a></a> (such as the double-quote) then this will interfere -with code that tries to escape any of those characters that occur in the <span -class="cmss-10">sort</span><a - id="dx1-13048"></a> key. -</div> -</p><!--l. 2103--><p class="noindent" > -</p><!--l. 2105--><p class="indent" > In general, it’s best not to use <span + id="dx1-13044"></a></a> (such as the +double-quote) then this will interfere with code that tries to escape any of those characters that occur in the +<span +class="cmtt-10">sort</span><a + id="dx1-13045"></a> key. </div> +</p><!--l. 2423--><p class="noindent" > +</p><!--l. 2425--><p class="indent" > In general, it’s best not to use <span class="cmss-10">babel</span><a - id="dx1-13049"></a>’s shorthands in entry definitions. For example: - - + id="dx1-13046"></a>’s shorthands in entry definitions. For example: + + </p> - <div class="verbatim" id="verbatim-51"> + <div class="verbatim" id="verbatim-44"> \documentclass{article}  <br />\usepackage[ngerman]{babel}  <br />\usepackage{glossaries} @@ -4517,19 +5755,19 @@ class="cmss-10">babel</span><a  <br />\printglossaries  <br />\end{document} </div> -<!--l. 2126--><p class="nopar" > -</p><!--l. 2128--><p class="indent" > The <span +<!--l. 2446--><p class="nopar" > +</p><!--l. 2448--><p class="indent" > The <span class="cmss-10">ngerman</span><a - id="dx1-13050"></a> package has the shorthands on in the preamble, so they can be used if + id="dx1-13047"></a> package has the shorthands on in the preamble, so they can be used in definitions if <span -class="cmtt-10">\GlsSetQuote </span>has changed the <a +class="cmtt-10">\GlsSetQuote </span>has been used to change the <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-13051"></a></a> quote character. Example: - - + id="dx1-13048"></a></a> quote character. Example: + + </p> - <div class="verbatim" id="verbatim-52"> + <div class="verbatim" id="verbatim-45"> \documentclass{article}  <br />\usepackage[ngerman]{babel}  <br />\usepackage{glossaries} @@ -4542,96 +5780,101 @@ class="cmtt-10">makeindex</span><a  <br />\printglossaries  <br />\end{document} </div> -<!--l. 2149--><p class="nopar" > -</p><!--l. 2151--><p class="noindent" > +<!--l. 2469--><p class="nopar" > +</p><!--l. 2471--><p class="noindent" > </p> -<!--l. 2151--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.1 </span> <a +<!--l. 2471--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.3.1 </span> <a id="sec:fixednames"></a>Changing the Fixed Names</h4> -<!--l. 2154--><p class="noindent" >The fixed names are produced using the commands listed in <a -href="#tab:predefinednames">table 1.2</a>. If you aren’t using a -language package such as <span +<!--l. 2474--><p class="noindent" >The fixed names are produced using the commands listed in <a +href="#tab:predefinednames">table 1.2</a>. If you aren’t using a language package +such as <span class="cmss-10">babel</span><a id="dx1-14001"></a> or <span class="cmss-10">polyglossia</span><a - id="dx1-14002"></a> that uses caption hooks, you can just redefine -these commands as appropriate. If you are using <span + id="dx1-14002"></a> that uses caption hooks, you can just redefine these commands as appropriate. If +you are using <span class="cmss-10">babel</span><a id="dx1-14003"></a> or <span class="cmss-10">polyglossia</span><a - id="dx1-14004"></a>, you need to use their -caption hooks to change the defaults. See <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words babel uses</a> or read the <span + id="dx1-14004"></a>, you need to use their caption hooks to change the defaults. +See <a +href="https://texfaq.org/FAQ-latexwords" >changing the words babel uses</a> or read the <span class="cmss-10">babel</span><a - id="dx1-14005"></a> or -<span + id="dx1-14005"></a> or <span class="cmss-10">polyglossia</span><a - id="dx1-14006"></a> documentation. If you have loaded <span + id="dx1-14006"></a> documentation. If you have +loaded <span class="cmss-10">babel</span><a id="dx1-14007"></a>, then <span class="cmss-10">glossaries</span><a - id="dx1-14008"></a> will attempt to load -<span + id="dx1-14008"></a> will attempt to load <span class="cmss-10">translator</span><a id="dx1-14009"></a>, unless you have used the <span class="cmss-10">notranslate</span><a - id="dx1-14010"></a>, <span -class="cmss-10">translate=false</span><a + id="dx1-14010"></a>, +<span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a id="dx1-14011"></a> or <span -class="cmss-10">translate=babel</span><a - id="dx1-14012"></a> package -options. If the <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-14012"></a> package options. If the <span class="cmss-10">translator</span><a - id="dx1-14013"></a> package is loaded, the translations are provided by dictionary files -(for example, <span -class="cmtt-10">glossaries-dictionary-English.dict</span>). See the <span + id="dx1-14013"></a> package is loaded, the translations +are provided by dictionary files (for example, <span +class="cmtt-10">glossaries-dictionary-English.dict</span>). See the +<span class="cmss-10">translator</span><a - id="dx1-14014"></a> package for advice -on changing translations provided by <span + id="dx1-14014"></a> package for advice on changing translations provided by <span class="cmss-10">translator</span><a - id="dx1-14015"></a> dictionaries. If you can’t work out -how to modify these dictionary definitions, try switching to <span + id="dx1-14015"></a> dictionaries. If you +can’t work out how to modify these dictionary definitions, try switching to <span class="cmss-10">babel</span><a id="dx1-14016"></a>’s interface using <span -class="cmss-10">translate=babel</span><a +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a id="dx1-14017"></a>: - - + + </p> - <div class="verbatim" id="verbatim-53"> + <div class="verbatim" id="verbatim-46"> \documentclass[english,french]{article}  <br />\usepackage{babel}  <br />\usepackage[translate=babel]{glossaries} </div> -<!--l. 2175--><p class="nopar" > and then use <span +<!--l. 2495--><p class="nopar" > and then use <span class="cmss-10">babel</span><a - id="dx1-14018"></a>’s caption hook mechanism. Note that if you pass the language options -directly to <span + id="dx1-14018"></a>’s caption hook mechanism. Note that if you pass the language options directly to <span class="cmss-10">babel</span><a - id="dx1-14019"></a> rather that using the document class options or otherwise passing the same -options to <span + id="dx1-14019"></a> +rather that using the document class options or otherwise passing the same options to <span class="cmss-10">translator</span><a id="dx1-14020"></a>, then <span class="cmss-10">translator</span><a - id="dx1-14021"></a> won’t pick up the language and no dictionaries will be -loaded and <span + id="dx1-14021"></a> +won’t pick up the language and no dictionaries will be loaded and <span class="cmss-10">babel</span><a - id="dx1-14022"></a>’s caption hooks will be used instead. + id="dx1-14022"></a>’s caption hooks will be used +instead. </p> <div class="table"> - - -<!--l. 2183--><p class="indent" > <a + + +<!--l. 2503--><p class="indent" > <a id="tab:predefinednames"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 1.2: </span><span class="content">Customised Text</span></div><!--tex4ht:label?: x1-140232 --> - - + + <div class="tabular"> <table id="TBL-3" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-3-1g"><col @@ -4641,34 +5884,34 @@ id="TBL-3-3" /></colgroup><tr style="vertical-align:baseline;" id="TBL-3-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-1-1" class="td01"><span class="cmbx-10">Command Name </span></td><td style="white-space:normal; text-align:left;" id="TBL-3-1-2" -class="td11"> <!--l. 2189--><p class="noindent" ><span +class="td11"> <!--l. 2509--><p class="noindent" ><span class="cmbx-10">Translator</span> <span class="cmbx-10">Key</span> <span -class="cmbx-10">Word</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-1-3" -class="td10"> <!--l. 2190--><p class="noindent" ><span -class="cmbx-10">Purpose</span> </p></td> +class="cmbx-10">Word</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-1-3" +class="td10"> <!--l. 2510--><p class="noindent" ><span +class="cmbx-10">Purpose</span> </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-2-1" class="td01"><span class="cmtt-10">\glossaryname</span><a id="dx1-14024"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-2-2" -class="td11"> <!--l. 2191--><p class="noindent" ><span -class="cmtt-10">Glossary</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-2-3" -class="td10"> <!--l. 2191--><p class="noindent" >Title +class="td11"> <!--l. 2511--><p class="noindent" ><span +class="cmtt-10">Glossary</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-2-3" +class="td10"> <!--l. 2511--><p class="noindent" >Title of the main - glossary. </p></td> + glossary. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-3-1" class="td01"><span class="cmtt-10">\acronymname</span><a id="dx1-14025"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-3-2" -class="td11"> <!--l. 2192--><p class="noindent" ><span -class="cmtt-10">Acronyms</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-3-3" -class="td10"> <!--l. 2192--><p class="noindent" >Title +class="td11"> <!--l. 2512--><p class="noindent" ><span +class="cmtt-10">Acronyms</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-3-3" +class="td10"> <!--l. 2512--><p class="noindent" >Title of the list @@ -4681,17 +5924,17 @@ class="td10"> <!--l. 2192--><p class="noindent" >Title option <span class="cmss-10">acronym</span><a - id="dx1-14026"></a>). </p></td> + id="dx1-14026"></a>). </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-4-1" class="td01"><span class="cmtt-10">\entryname</span><a id="dx1-14027"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-4-2" -class="td11"> <!--l. 2194--><p class="noindent" ><span +class="td11"> <!--l. 2514--><p class="noindent" ><span class="cmtt-10">Notation</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-4-3" -class="td10"> <!--l. 2195--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-4-3" +class="td10"> <!--l. 2515--><p class="noindent" >Header for first column @@ -4707,17 +5950,17 @@ class="td10"> <!--l. 2195--><p class="noindent" >Header glossaries that support - headers). </p></td> + headers). </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-5-1" class="td01"><span class="cmtt-10">\descriptionname</span><a id="dx1-14028"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-5-2" -class="td11"> <!--l. 2197--><p class="noindent" ><span +class="td11"> <!--l. 2517--><p class="noindent" ><span class="cmtt-10">Description</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-5-3" -class="td10"> <!--l. 2198--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-5-3" +class="td10"> <!--l. 2518--><p class="noindent" >Header for second column @@ -4733,17 +5976,17 @@ class="td10"> <!--l. 2198--><p class="noindent" >Header glossaries that support - headers). </p></td> + headers). </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-6-1" class="td01"><span class="cmtt-10">\symbolname</span><a id="dx1-14029"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-6-2" -class="td11"> <!--l. 2200--><p class="noindent" ><span +class="td11"> <!--l. 2520--><p class="noindent" ><span class="cmtt-10">Symbol</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-6-3" -class="td10"> <!--l. 2200--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-6-3" +class="td10"> <!--l. 2520--><p class="noindent" >Header for symbol column @@ -4756,19 +5999,19 @@ class="td10"> <!--l. 2200--><p class="noindent" >Header that support this - option. </p></td> + option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-7-1" class="td01"><span class="cmtt-10">\pagelistname</span><a id="dx1-14030"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-7-2" -class="td11"> <!--l. 2202--><p class="noindent" ><span +class="td11"> <!--l. 2522--><p class="noindent" ><span class="cmtt-10">Page</span> <span class="cmtt-10">List</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-7-3" -class="td10"> <!--l. 2203--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-7-3" +class="td10"> <!--l. 2523--><p class="noindent" >Header for page list @@ -4781,17 +6024,17 @@ class="td10"> <!--l. 2203--><p class="noindent" >Header that support this - option. </p></td> + option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-8-1" class="td01"><span class="cmtt-10">\glssymbolsgroupname</span><a id="dx1-14031"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-8-2" -class="td11"> <!--l. 2205--><p class="noindent" ><span +class="td11"> <!--l. 2525--><p class="noindent" ><span class="cmtt-10">Symbols</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-8-3" -class="td10"> <!--l. 2206--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-8-3" +class="td10"> <!--l. 2526--><p class="noindent" >Header for symbols section @@ -4804,17 +6047,17 @@ class="td10"> <!--l. 2206--><p class="noindent" >Header that support this - option. </p></td> + option. </p></td> </tr><tr style="vertical-align:baseline;" id="TBL-3-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-3-9-1" class="td01"><span class="cmtt-10">\glsnumbersgroupname</span><a id="dx1-14032"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-9-2" -class="td11"> <!--l. 2208--><p class="noindent" ><span +class="td11"> <!--l. 2528--><p class="noindent" ><span class="cmtt-10">Numbers</span> <span -class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-9-3" -class="td10"> <!--l. 2208--><p class="noindent" >Header +class="cmtt-10">(glossaries)</span> </p></td><td style="white-space:normal; text-align:left;" id="TBL-3-9-3" +class="td10"> <!--l. 2528--><p class="noindent" >Header for numbers section @@ -4827,153 +6070,162 @@ class="td10"> <!--l. 2208--><p class="noindent" >Header that support this - option. </p></td> -</tr></table> - + option. </p></td> +</tr></table> + </div> - - + + </div><hr class="endfloat" /> </div> -<!--l. 2214--><p class="indent" > As from version 4.12, multilingual support is provided by separate language modules that -need to be installed in addition to installing the <span -class="cmss-10">glossaries </span>package. You only need to install -the modules for the languages that you require. If the language module has an -unmaintained status, you can volunteer to take over the maintenance by contacting me at -<a +<!--l. 2534--><p class="indent" > As from version 4.12, multilingual support is provided by separate language modules that need to be +installed in addition to installing the <span +class="cmss-10">glossaries </span>package. You only need to install the modules for the languages +that you require. If the language module has an unmaintained status, you can volunteer to take over the +maintenance by contacting me at <a href="http://www.dickimaw-books.com/contact.html" class="url" ><span class="cmtt-10">http://www.dickimaw-books.com/contact.html</span></a>. The <span class="cmss-10">translator</span><a - id="dx1-14033"></a> dictionary files for <span -class="cmss-10">glossaries</span> -are now provided by the appropriate language module. For further details about -information specific to a given language, please see the documentation for that language + id="dx1-14033"></a> +dictionary files for <span +class="cmss-10">glossaries </span>are now provided by the appropriate language module. For further details +about information specific to a given language, please see the documentation for that language module. -</p><!--l. 2226--><p class="indent" > Examples of use: </p> +</p><!--l. 2546--><p class="indent" > Examples of use: </p> <ul class="itemize1"> <li class="itemize">Using <span class="cmss-10">babel</span><a id="dx1-14034"></a> and <span class="cmss-10">translator</span><a id="dx1-14035"></a>: - - - <div class="verbatim" id="verbatim-54"> + + + <div class="verbatim" id="verbatim-47"> \documentclass[english,french]{article}  <br />\usepackage{babel}  <br />\usepackage{glossaries} </div> - <!--l. 2233--><p class="nopar" > (<span + <!--l. 2553--><p class="nopar" > (<span class="cmss-10">translator</span><a id="dx1-14036"></a> is automatically loaded). </p></li> <li class="itemize">Using <span class="cmss-10">babel</span><a id="dx1-14037"></a>: - - - <div class="verbatim" id="verbatim-55"> + + + <div class="verbatim" id="verbatim-48"> \documentclass[english,french]{article}  <br />\usepackage{babel}  <br />\usepackage[translate=babel]{glossaries} </div> - <!--l. 2241--><p class="nopar" > (<span + <!--l. 2561--><p class="nopar" > (<span class="cmss-10">translator</span><a - id="dx1-14038"></a> isn’t loaded). + id="dx1-14038"></a> isn’t loaded). The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-14039"></a> as the default if <span +class="cmss-10">babel</span><a + id="dx1-14040"></a> has been + loaded. </p></li> <li class="itemize">Using <span class="cmss-10">polyglossia</span><a - id="dx1-14039"></a>: - - - <div class="verbatim" id="verbatim-56"> + id="dx1-14041"></a>: + + + <div class="verbatim" id="verbatim-49"> \documentclass{article}  <br />\usepackage{polyglossia}  <br />\setmainlanguage{english}  <br />\usepackage{glossaries} </div> - <!--l. 2250--><p class="nopar" > + <!--l. 2572--><p class="nopar" > </p> </li></ul> -<!--l. 2254--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations may not -be appropriate. If you are using the <span +<!--l. 2576--><p class="indent" > Due to the varied nature of glossaries, it’s likely that the predefined translations may not be +appropriate. If you are using the <span class="cmss-10">babel</span><a - id="dx1-14040"></a> package and the <span -class="cmss-10">glossaries </span>package option + id="dx1-14042"></a> package and the <span +class="cmss-10">glossaries </span>package option <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-14043"></a>, you +need to be familiar with the advice given in <a +href="https://texfaq.org/FAQ-latexwords" >changing the words babel uses</a>. If you are using the <span -class="cmss-10">translate=babel</span><a - id="dx1-14041"></a>, you need to be familiar with the advice given in <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords" >changing the words -babel uses</a>. If you are using the <span class="cmss-10">translator</span><a - id="dx1-14042"></a> package, then you can provide your own -dictionary with the necessary modifications (using <span -class="cmtt-10">\deftranslation</span>) and load it using -<span -class="cmtt-10">\usedictionary</span>. If you simply want to change the title of a glossary, you can use the + id="dx1-14044"></a> package, then you can provide your own dictionary with the necessary modifications (using <span -class="cmss-10">title</span><a - id="dx1-14043"></a> key in commands like <span +class="cmtt-10">\deftranslation</span>) and load it using <span +class="cmtt-10">\usedictionary</span>. If you simply want to change the title of a glossary, you +can use the <span +class="cmtt-10">title</span><a + id="dx1-14045"></a> key in commands like <span class="cmtt-10">\printglossary </span>(but not the iterative commands like <span class="cmtt-10">\printglossaries</span>). -</p><!--l. 2266--><p class="indent" > <div class="important" title="Important Note"> Note that the <span +</p><!--l. 2588--><p class="indent" > <div class="important" title="Important Note"> Note that the <span class="cmss-10">translator</span><a - id="dx1-14044"></a> dictionaries are loaded at the beginning of the document, so it -won’t have any effect if you put <span -class="cmtt-10">\deftranslation </span>in the preamble. It should be put in your -personal dictionary instead (as in the example below). See the <span + id="dx1-14046"></a> dictionaries are loaded at the beginning of the document, so it won’t have any effect +if you put <span +class="cmtt-10">\deftranslation </span>in the preamble. It should be put in your personal dictionary instead (as in the +example below). See the <span class="cmss-10">translator</span><a - id="dx1-14045"></a> documentation for -further details. (Now with <span + id="dx1-14047"></a> documentation for further details. (Now with <span class="cmss-10">beamer</span><a - id="dx1-14046"></a> documentation.) </div> -</p><!--l. 2273--><p class="noindent" > -</p><!--l. 2275--><p class="indent" > Your custom dictionary doesn’t have to be just a translation from English to another -language. You may prefer to have a dictionary for a particular type of document. For -example, suppose your institution’s in-house reports have to have the glossary labelled as -“Nomenclature” and the page list should be labelled “Location”, then you can create a file -called, say, - - + id="dx1-14048"></a> documentation.) +</div> +</p><!--l. 2595--><p class="noindent" > +</p><!--l. 2597--><p class="indent" > Your custom dictionary doesn’t have to be just a translation from English to another language. You may +prefer to have a dictionary for a particular type of document. For example, suppose your institution’s in-house +reports have to have the glossary labelled as “Nomenclature” and the page list should be labelled “Location”, +then you can create a file called, say, + + </p> - <div class="verbatim" id="verbatim-57"> + <div class="verbatim" id="verbatim-50"> myinstitute-glossaries-dictionary-English.dict </div> -<!--l. 2283--><p class="nopar" > that contains the following: - - +<!--l. 2605--><p class="nopar" > that contains the following: + + </p> - <div class="verbatim" id="verbatim-58"> + <div class="verbatim" id="verbatim-51"> \ProvidesDictionary{myinstitute-glossaries-dictionary}{English}  <br />\deftranslation{Glossary}{Nomenclature}  <br />\deftranslation{Page List (glossaries)}{Location} </div> -<!--l. 2289--><p class="nopar" > You can now load it using: - - +<!--l. 2611--><p class="nopar" > You can now load it using: + + </p> - <div class="verbatim" id="verbatim-59"> + <div class="verbatim" id="verbatim-52"> \usedictionary{myinstitute-glossaries-dictionary} </div> -<!--l. 2293--><p class="nopar" > (Make sure that <span -class="cmtt-10">myinstitute-glossaries-dictionary-English.dict </span>can be -found by <span class="TEX">T<span -class="E">E</span>X</span>.) If you want to share your custom dictionary, you can upload it to -<a +<!--l. 2615--><p class="nopar" > (Make sure that <span +class="cmtt-10">myinstitute-glossaries-dictionary-English.dict </span>can be found by <span class="TEX">T<span +class="E">E</span>X</span>.) If you want to +share your custom dictionary, you can upload it to <a href="http://www.ctan.org/" >CTAN</a>. -</p><!--l. 2298--><p class="indent" > If you are using <span +</p><!--l. 2620--><p class="indent" > If you are using <span class="cmss-10">babel</span><a - id="dx1-14047"></a> and don’t want to use the <span + id="dx1-14049"></a> and don’t want to use the <span class="cmss-10">translator</span><a - id="dx1-14048"></a> interface, you can use the -package option <span -class="cmss-10">translate=babel</span><a - id="dx1-14049"></a>. For example: - - + id="dx1-14050"></a> interface, you can use the package option +<span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-14051"></a>. For example: + + </p> - <div class="verbatim" id="verbatim-60"> + <div class="verbatim" id="verbatim-53"> \documentclass[british]{article}  <br />\usepackage{babel}  <br />\usepackage[translate=babel]{glossaries} @@ -4982,66 +6234,66 @@ class="cmss-10">translate=babel</span><a  <br />    \renewcommand*{\acronymname}{List of Acronyms}%  <br />} </div> -<!--l. 2311--><p class="nopar" > -</p><!--l. 2313--><p class="indent" > Note that <a +<!--l. 2633--><p class="nopar" > +</p><!--l. 2635--><p class="indent" > Note that <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-14050"></a></a> and <a + id="dx1-14052"></a></a> and <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-14051"></a></a> provide much better multi-lingual support than <a + id="dx1-14053"></a></a> provide much better multi-lingual support than <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-14052"></a></a>, -so I recommend that you use Options <a + id="dx1-14054"></a></a>, so I recommend +that you use Options <a href="#option3">3</a> or <a -href="#option4">4</a> if you have glossary entries that contain -<a +href="#option4">4</a> if you have glossary entries that contain <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-14053"></a>s</a>. See <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a -href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on <a + id="dx1-14055"></a>s</a>. See <a +href="#sec:xindy">§11 </a><a +href="#sec:xindy">Xindy +(Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-14054"></a></a>, and see the -<a + id="dx1-14056"></a></a>, and see the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-14055"></a></a> user manual for further details of that application. + id="dx1-14057"></a></a> user manual for further details of that +application. </p> <h5 class="subsubsectionHead"><a id="pluralsuffix"></a>Creating a New Language Module</h5> -<!--l. 2323--><p class="noindent" >The <span +<!--l. 2645--><p class="noindent" >The <span class="cmss-10">glossaries </span>package now uses the <span class="cmss-10">tracklang</span><a - id="dx1-15001"></a> package to determine which language modules -need to be loaded. If you want to create a new language module, you should first read the -<span + id="dx1-15001"></a> package to determine which language modules need +to be loaded. If you want to create a new language module, you should first read the <span class="cmss-10">tracklang</span><a - id="dx1-15002"></a> documentation. -</p><!--l. 2328--><p class="indent" > To create a new language module, you need to at least create two files: <span + id="dx1-15002"></a> +documentation. +</p><!--l. 2650--><p class="indent" > To create a new language module, you need to at least create two files called: <span class="cmtt-10">glossaries-</span>⟨<span class="cmti-10">lang</span>⟩<span -class="cmtt-10">.ldf</span> -and <span +class="cmtt-10">.ldf</span><a + id="dx1-15003"></a> and +<span class="cmtt-10">glossaries-dictionary-</span>⟨<span class="cmti-10">Lang</span>⟩<span -class="cmtt-10">.dict </span>where ⟨<span -class="cmti-10">lang</span>⟩ is the root language name (for -example, <span +class="cmtt-10">.dict</span><a + id="dx1-15004"></a> where ⟨<span +class="cmti-10">lang</span>⟩ is the root language name (for example, <span class="cmtt-10">english</span>) and ⟨<span -class="cmti-10">Lang</span>⟩ is the language name used by <span +class="cmti-10">Lang</span>⟩ is +the language name used by <span class="cmss-10">translator</span><a - id="dx1-15003"></a> (for example, -<span + id="dx1-15005"></a> (for example, <span class="cmtt-10">English</span>). -</p><!--l. 2335--><p class="indent" > Here’s an example of <span +</p><!--l. 2657--><p class="indent" > Here’s an example of <span class="cmtt-10">glossaries-dictionary-English.dict</span>: - - + + </p> - <div class="verbatim" id="verbatim-61"> + <div class="verbatim" id="verbatim-54"> \ProvidesDictionary{glossaries-dictionary}{English}  <br />\providetranslation{Glossary}{Glossary}  <br />\providetranslation{Acronyms}{Acronyms} @@ -5052,23 +6304,22 @@ class="cmtt-10">glossaries-dictionary-English.dict</span>:  <br />\providetranslation{Symbols (glossaries)}{Symbols}  <br />\providetranslation{Numbers (glossaries)}{Numbers} </div> -<!--l. 2347--><p class="nopar" > You can use this as a template for your dictionary file. Change <span +<!--l. 2669--><p class="nopar" > You can use this as a template for your dictionary file. Change <span class="cmtt-10">English </span>to the <span class="cmss-10">translator</span><a - id="dx1-15004"></a> name -for your language (so that it matches the file name <span + id="dx1-15006"></a> name for your +language (so that it matches the file name <span class="cmtt-10">glossaries-dictionary-</span>⟨<span class="cmti-10">Lang</span>⟩<span -class="cmtt-10">.dict</span>) -and, for each <span -class="cmtt-10">\providetranslation</span>, change the second argument to the appropriate -translation. -</p><!--l. 2355--><p class="indent" > Here’s an example of <span +class="cmtt-10">.dict</span>) and, for each +<span +class="cmtt-10">\providetranslation</span>, change the second argument to the appropriate translation. +</p><!--l. 2677--><p class="indent" > Here’s an example of <span class="cmtt-10">glossaries-english.ldf</span>: - - + + </p> - <div class="verbatim" id="verbatim-62"> + <div class="verbatim" id="verbatim-55"> \ProvidesGlossariesLang{english}  <br />\glsifusedtranslatordict{English}  <br />{% @@ -5114,8 +6365,8 @@ class="cmtt-10">glossaries-english.ldf</span>:  <br />      \csappto{captions\CurrentTrackedLanguage}%  <br />      {%  <br />        \glossariescaptionsenglish - - + +  <br />      }%  <br />    }%  <br />    {% @@ -5127,64 +6378,59 @@ class="cmtt-10">glossaries-english.ldf</span>:  <br />\renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}  <br />\renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}} </div> -<!--l. 2413--><p class="nopar" > This is a somewhat longer file, but again you can use it as a template. Replace <span -class="cmtt-10">English </span>with -the <span +<!--l. 2735--><p class="nopar" > This is a somewhat longer file, but again you can use it as a template. Replace <span +class="cmtt-10">English </span>with the <span class="cmss-10">translator</span><a - id="dx1-15005"></a> language label ⟨<span + id="dx1-15007"></a> +language label ⟨<span class="cmti-10">Lang</span>⟩ used for the dictionary file and replace <span -class="cmtt-10">english </span>with the -root language name ⟨<span -class="cmti-10">lang</span>⟩. Within the definition of <span +class="cmtt-10">english </span>with the root language name ⟨<span +class="cmti-10">lang</span>⟩. Within +the definition of <span class="cmtt-10">\glossariescaptions</span>⟨<span -class="cmti-10">lang</span>⟩, replace the -English text (such as “Glossaries”) with the appropriate translation. -</p><!--l. 2423--><p class="indent" > <span -class="cmbx-10">Note: </span>the suffixes used to generate the plural forms when the plural hasn’t been specified -are given by <span -class="cmtt-10">\glspluralsuffix </span>(for general entries) and <span -class="cmtt-10">\glsupacrpluralsuffix </span>for -acronyms where the suffix needs to be set using <span -class="cmtt-10">\glstextup </span>to counteract the effects of -<span -class="cmtt-10">\textsc </span>and <span -class="cmtt-10">\glsacrpluralsuffix </span>for other acronym styles. There’s no guarantee when -these commands will be expanded. They may be expanded on definition or they may be -expanded on use, depending on the <span -class="cmss-10">glossaries </span>configuration. -</p><!--l. 2433--><p class="indent" > <div class="important" title="Important Note"> Therefore these plural suffix command definitions aren’t included in the caption -mechanism as that’s typically not switched on until the start of the document. <span -class="cmbx-10">This means</span> -<span -class="cmbx-10">that the suffix in effect will be for the last loaded language that redefined these</span> -<span -class="cmbx-10">commands. </span>It’s best to initialise these commands to the most common suffix required in -your document and use the <span -class="cmss-10">plural</span><a - id="dx1-15006"></a>, <span -class="cmss-10">longplural</span><a - id="dx1-15007"></a>, <span -class="cmss-10">shortplural</span><a - id="dx1-15008"></a> etc keys to override exceptions. -</div> -</p><!--l. 2442--><p class="noindent" > -</p><!--l. 2444--><p class="indent" > If you want to add a regional variation, create a file called <span +class="cmti-10">lang</span>⟩, replace the English text (such as “Glossaries”) with the +appropriate translation. +</p><!--l. 2745--><p class="indent" > <span class="warningsymbol">⚠</span> The suffixes used to generate the plural forms when the plural hasn’t been specified are given by +<span +class="cmtt-10">\glspluralsuffix </span>(for general entries). For abbreviations defined with <span +class="cmtt-10">\newacronym</span>, <span +class="cmtt-10">\glsupacrpluralsuffix</span> +is used for acronyms where the suffix needs to be set using <span +class="cmtt-10">\glstextup </span>to counteract the effects of <span +class="cmtt-10">\textsc </span>and +<span +class="cmtt-10">\glsacrpluralsuffix </span>for other acronym styles. There’s no guarantee when these commands will be expanded. +They may be expanded on definition or they may be expanded on use, depending on the <span +class="cmss-10">glossaries</span> +configuration. +</p><!--l. 2756--><p class="indent" > <div class="important" title="Important Note"> Therefore these plural suffix command definitions aren’t included in the caption mechanism as that’s +typically not switched on until the start of the document. <strong>This means that the suffix in effect will be for the last +loaded language that redefined these commands.</strong> It’s best to initialise these commands to the most common +suffix required in your document and use the <span +class="cmtt-10">plural</span><a + id="dx1-15008"></a>, <span +class="cmtt-10">longplural</span><a + id="dx1-15009"></a>, <span +class="cmtt-10">shortplural</span><a + id="dx1-15010"></a> etc keys to override exceptions. +</div> +</p><!--l. 2765--><p class="noindent" > +</p><!--l. 2767--><p class="indent" > If you want to add a regional variation, create a file called <span class="cmtt-10">glossaries-</span>⟨<span class="cmti-10">iso lang</span>⟩<span class="cmtt-10">-</span>⟨<span -class="cmti-10">iso</span> -<span -class="cmti-10">country</span>⟩<span -class="cmtt-10">.ldf</span>, where ⟨<span +class="cmti-10">iso country</span>⟩<span +class="cmtt-10">.ldf</span>, +where ⟨<span class="cmti-10">iso lang</span>⟩ is the ISO language code and ⟨<span -class="cmti-10">iso country</span>⟩ is the ISO country -code. For example, <span -class="cmtt-10">glossaries-en-GB.ldf</span>. This file can load the root language file and -make the appropriate changes, for example: - - +class="cmti-10">iso country</span>⟩ is the ISO country code. For example, +<span +class="cmtt-10">glossaries-en-GB.ldf</span>. This file can load the root language file and make the appropriate changes, for +example: + + </p> - <div class="verbatim" id="verbatim-63"> + <div class="verbatim" id="verbatim-56">  \ProvidesGlossariesLang{en-GB}  <br /> \RequireGlossariesLang{english}  <br /> \glsifusedtranslatordict{British} @@ -5204,20 +6450,19 @@ make the appropriate changes, for example:  <br />   }%  <br /> } </div> -<!--l. 2469--><p class="nopar" > -</p><!--l. 2471--><p class="indent" > If the translations includes <a +<!--l. 2792--><p class="nopar" > +</p><!--l. 2794--><p class="indent" > If the translations includes <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-15009"></a>s</a>, it’s necessary to provide code that’s -independent of the input encoding. Remember that while some users may use UTF-8, others -may use Latin-1 or any other supported encoding, but while users won’t appreciate -you enforcing your preference on them, it’s useful to provide a UTF-8 version for -XeLaTeX users. -</p><!--l. 2478--><p class="indent" > The <span + id="dx1-15011"></a>s</a>, it’s necessary to provide code that’s independent of the +input encoding. Remember that while some users may use UTF-8, others may use Latin-1 or any other +supported encoding, but while users won’t appreciate you enforcing your preference on them, it’s useful to +provide a UTF-8 version for XeLaTeX users. +</p><!--l. 2801--><p class="indent" > The <span class="cmtt-10">glossaries-irish.ldf </span>file provides this as follows: - - + + </p> - <div class="verbatim" id="verbatim-64"> + <div class="verbatim" id="verbatim-57"> \ProvidesGlossariesLang{irish}  <br />\glsifusedtranslatordict{Irish}  <br />{% @@ -5253,24 +6498,24 @@ class="cmtt-10">glossaries-irish.ldf </span>file provides this as follows:  <br />  \glossariescaptionsirish  <br />} </div> -<!--l. 2515--><p class="nopar" > (Again you can use this as a template. Replace <span -class="cmtt-10">irish </span>with your root language label and +<!--l. 2838--><p class="nopar" > (Again you can use this as a template. Replace <span +class="cmtt-10">irish </span>with your root language label and <span +class="cmtt-10">Irish </span>with the <span -class="cmtt-10">Irish </span>with the <span class="cmss-10">translator</span><a - id="dx1-15010"></a> dictionary label.) -</p><!--l. 2520--><p class="indent" > There are now two extra files: <span -class="cmtt-10">glossaries-irish-noenc.ldf </span>and <span -class="cmtt-10">glossaries-irish-utf8.ldf</span>. -</p><!--l. 2523--><p class="indent" > These both define <span + id="dx1-15012"></a> dictionary label.) +</p><!--l. 2843--><p class="indent" > There are now two extra files: <span +class="cmtt-10">glossaries-irish-noenc.ldf </span>(no encoding information) and +<span +class="cmtt-10">glossaries-irish-utf8.ldf </span>(UTF-8). +</p><!--l. 2847--><p class="indent" > These both define <span class="cmtt-10">\glossariescaptionsirish </span>but the <span class="cmtt-10">*-noenc.ldf </span>uses <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> accent -commands: - - +class="E">E</span>X</span></span> accent commands: + + </p> - <div class="verbatim" id="verbatim-65"> + <div class="verbatim" id="verbatim-58"> \@ifpackageloaded{polyglossia}%  <br />{%  <br />  \newcommand*{\glossariescaptionsirish}{% @@ -5297,110 +6542,107 @@ commands:  <br />  }%  <br />} </div> -<!--l. 2551--><p class="nopar" > whereas the <span -class="cmtt-10">*-utf8.ldf </span>replaces the accent commands with the appropriate UTF-8 -characters. -</p><!--l. 2556--><p class="noindent" > +<!--l. 2875--><p class="nopar" > whereas the <span +class="cmtt-10">*-utf8.ldf </span>replaces the accent commands with the appropriate UTF-8 characters. +</p><!--l. 2880--><p class="noindent" > </p> -<!--l. 2556--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.5 </span> <a +<!--l. 2880--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a id="sec:makeglossaries"></a>Generating the Associated Glossary Files</h3> -<!--l. 2559--><p class="noindent" ><div class="important" title="Important Note"> This section is only applicable if you have chosen Options <a +<!--l. 2883--><p class="noindent" ><div class="important" title="Important Note"> This section is only applicable if you have chosen Options <a href="#option2">2</a> or <a -href="#option3">3</a>. You can ignore this section -if you have chosen any of the other options. If you want to alphabetically sort your entries -always remember to use the <span -class="cmss-10">sort</span><a +href="#option3">3</a>. You can ignore this section if you have +chosen any of the other options. If you want to alphabetically sort your entries always remember to +use the <span +class="cmtt-10">sort</span><a id="dx1-16001"></a> key if the <span -class="cmss-10">name</span><a +class="cmtt-10">name</span><a id="dx1-16002"></a> contains any <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> commands. +class="E">E</span>X</span></span> commands (except if you’re using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-16003"></a></a>). </div> -</p><!--l. 2564--><p class="noindent" > -</p><!--l. 2566--><p class="noindent" >If this section seriously confuses you, and you can’t work out how to run external -tools like <a +</p><!--l. 2889--><p class="noindent" > +</p><!--l. 2891--><p class="noindent" >If this section seriously confuses you, and you can’t work out how to run external tools like <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16003"></a></a> or <a + id="dx1-16004"></a></a> or +<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16004"></a></a>, you can try using the <span + id="dx1-16005"></a></a>, you can try using the <span class="cmss-10">automake</span><a - id="dx1-16005"></a> package -option, described in <a -href="#sec:pkgopts-sort"><span -class="tcrm-1000">§</span>2.4 </a><a -href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>, but you will need <span class="TEX">T<span -class="E">E</span>X</span>’s shell escape -enabled. - - -</p><!--l. 2572--><p class="indent" > In order to generate a sorted glossary with compact <a + id="dx1-16006"></a> package option, described in <a +href="#sec:pkgopts-sort">§2.5 </a><a +href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>, but you will need +<span class="TEX">T<span +class="E">E</span>X</span>’s shell escape enabled. See also <a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the +document build</a>. +</p><!--l. 2900--><p class="indent" > In order to generate a sorted glossary with compact <a href="#glo:numberlist">number list<a - id="dx1-16006"></a>s</a>, it is necessary to use an -external <a -href="#glo:indexingapp">indexing application</a> as an intermediate step (unless you have chosen <a -href="#option1">Option 1</a>, -which uses <span class="TEX">T<span -class="E">E</span>X</span> to do the sorting or <a -href="#option5">Option 5</a>, which doesn’t perform any sorting). It is this -application that creates the file containing the code required to typeset the glossary. <span -class="cmbx-10">If this</span> -<span -class="cmbx-10">step is omitted, the glossaries will not appear in your document. </span>The two -indexing applications that are most commonly used with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-16007"></a>s</a>, it is necessary to use an external <a +href="#glo:indexingapp">indexing + + +application</a> as an intermediate step (unless you have chosen <a +href="#option1">Option 1</a>, which uses <span class="TEX">T<span +class="E">E</span>X</span> to do the +sorting or <a +href="#option5">Option 5</a>, which doesn’t perform any sorting). It is this application that creates the file +containing the code required to typeset the glossary. <strong>If this step is omitted, the glossaries will +not appear in your document.</strong> The two indexing applications that are most commonly used with +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> are <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16007"></a></a> and -<a + id="dx1-16008"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16008"></a></a>. As from version 1.17, the <span -class="cmss-10">glossaries </span>package can be used with either of these -applications. Previous versions were designed to be used with <span + id="dx1-16009"></a></a>. As from version 1.17, the <span +class="cmss-10">glossaries </span>package can be used with either of +these applications. Previous versions were designed to be used with <span class="cmtt-10">makeindex</span><a - id="dx1-16009"></a> only. With -the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-16010"></a> package, you can also use <a + id="dx1-16010"></a> only. With the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package, you can also use <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-16011"></a></a> as the indexing application. -(See the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-16012"></a> and <a + id="dx1-16011"></a></a> as the indexing application. (See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +and <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-16013"></a></a> user manuals for further details.) Note that -<span + id="dx1-16012"></a></a> user manuals for further details.) Note that <span class="cmtt-10">xindy</span><a - id="dx1-16014"></a> and <span + id="dx1-16013"></a> and <span class="cmtt-10">bib2gls</span><a - id="dx1-16015"></a> have much better multi-lingual support than <span + id="dx1-16014"></a> have much better +multi-lingual support than <span class="cmtt-10">makeindex</span><a - id="dx1-16016"></a>, so -<span + id="dx1-16015"></a>, so <span class="cmtt-10">xindy</span><a - id="dx1-16017"></a> or <span + id="dx1-16016"></a> or <span class="cmtt-10">bib2gls</span><a - id="dx1-16018"></a> are recommended if you’re not writing in English. Commands -that only have an effect when <span + id="dx1-16017"></a> are recommended if you’re not writing in +English. Commands that only have an effect when <span class="cmtt-10">xindy</span><a - id="dx1-16019"></a> is used are described in <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a + id="dx1-16018"></a> is used are described in <a +href="#sec:xindy">§11 </a><a href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>. -</p><!--l. 2592--><p class="indent" > <div class="important" title="Important Note"> This is a multi-stage process, but there are methods of automating document compilation -using applications such as <span +</p><!--l. 2920--><p class="indent" > <div class="important" title="Important Note"> This is a multi-stage process, but there are methods of automating document compilation using applications +such as <span class="cmtt-10">latexmk</span><a - id="dx1-16020"></a> and <span + id="dx1-16019"></a> and <span class="cmtt-10">arara</span><a - id="dx1-16021"></a>. With <span + id="dx1-16020"></a>. With <span class="cmtt-10">arara</span><a - id="dx1-16022"></a> you can just add special -comments to your document source: </p><div class="alltt"> + id="dx1-16021"></a> you can just add special comments to your document source: +</p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">%</span><span @@ -5417,134 +6659,129 @@ class="cmtt-10"> pdflatex</span> </div> </div> With <span class="cmtt-10">latexmk</span><a - id="dx1-16023"></a> you need to set up the required dependencies. </div> -<!--l. 2603--><p class="noindent" > -</p><!--l. 2605--><p class="indent" > The <span + id="dx1-16022"></a> you need to set up the required dependencies. </div> +<!--l. 2931--><p class="noindent" > +</p><!--l. 2933--><p class="indent" > The <span class="cmss-10">glossaries </span>package comes with the Perl script <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16024"></a></a> which will run -<a + id="dx1-16023"></a></a> which will run <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16025"></a></a> or <a + id="dx1-16024"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16026"></a></a> on all the glossary files using a customized style file (which is created by -<span + id="dx1-16025"></a></a> on all +the glossary files using a customized style file (which is created by <span class="cmtt-10">\makeglossaries</span><a - id="dx1-16027"></a>). See <a -href="#sec:makeglossariesapp"><span -class="tcrm-1000">§</span>1.5.1 </a><a -href="#sec:makeglossariesapp">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further details. Perl is -stable, cross-platform, open source software that is used by a number of <span class="TEX">T<span -class="E">E</span>X</span>-related -applications (including <span + id="dx1-16026"></a>). See <a +href="#sec:makeglossariesapp">§1.4.1 +</a><a +href="#sec:makeglossariesapp">Using the makeglossaries Perl Script<!--tex4ht:ref: sec:makeglossariesapp --></a> for further details. Perl is stable, cross-platform, open source +software that is used by a number of <span class="TEX">T<span +class="E">E</span>X</span>-related applications (including <span class="cmtt-10">xindy</span><a - id="dx1-16028"></a> and <span + id="dx1-16027"></a> and <span class="cmtt-10">latexmk</span><a - id="dx1-16029"></a>). Most Unix-like operating systems come with -a Perl interpreter. <span class="TEX">T<span -class="E">E</span>X</span> Live also comes with a Perl interpreter. MiK<span class="TEX">T<span -class="E">E</span>X</span> doesn’t come -with a Perl interpreter so if you are a Windows MiK<span class="TEX">T<span -class="E">E</span>X</span> user you will need to install Perl if -you want to use <a + id="dx1-16028"></a>). +Most Unix-like operating systems come with a Perl interpreter. <span class="TEX">T<span +class="E">E</span>X</span> Live also comes with a Perl +interpreter. MiK<span class="TEX">T<span +class="E">E</span>X</span> doesn’t come with a Perl interpreter so if you are a Windows MiK<span class="TEX">T<span +class="E">E</span>X</span> user +you will need to install Perl if you want to use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16030"></a></a> or <a + id="dx1-16029"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16031"></a></a>. Further information is available at -<a + id="dx1-16030"></a></a>. Further information is +available at <a href="http://www.perl.org/about.html" class="url" ><span class="cmtt-10">http://www.perl.org/about.html</span></a> and <a href="http://tex.stackexchange.com/questions/158796/miktex-and-perl-scripts-and-one-python-script" >MiKTeX and Perl scripts (and one Python script)</a>. -</p><!--l. 2621--><p class="indent" > The advantages of using <span +</p><!--l. 2949--><p class="indent" > The advantages of using <span class="cmtt-10">makeglossaries</span><a - id="dx1-16032"></a>: </p> + id="dx1-16031"></a>: </p> <ul class="itemize1"> <li class="itemize">It automatically detects whether to use <span class="cmtt-10">makeindex</span><a - id="dx1-16033"></a> or <span + id="dx1-16032"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-16034"></a> and sets the relevant - application switches. + id="dx1-16033"></a> and sets the relevant application + switches. </li> <li class="itemize">One call of <span class="cmtt-10">makeglossaries</span><a - id="dx1-16035"></a> will run <span + id="dx1-16034"></a> will run <span class="cmtt-10">makeindex</span><a - id="dx1-16036"></a>/<span + id="dx1-16035"></a>/<span class="cmtt-10">xindy</span><a - id="dx1-16037"></a> for each glossary type. + id="dx1-16036"></a> for each glossary type. </li> - - <li class="itemize">If things go wrong, <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16038"></a></a> will scan the messages from <a + id="dx1-16037"></a></a> will scan the messages from <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16039"></a></a> or - <a + id="dx1-16038"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16040"></a></a> and attempt to diagnose the problem in relation to the <span -class="cmss-10">glossaries </span>package. - This will hopefully provide more helpful messages in some cases. If it can’t diagnose - the problem, you will have to read the relevant transcript file and see if you can - work it out from the <span + id="dx1-16039"></a></a> and attempt + to diagnose the problem in relation to the <span +class="cmss-10">glossaries </span>package. This will hopefully provide more + helpful messages in some cases. If it can’t diagnose the problem, you will have to read the relevant + transcript file and see if you can work it out from the <span class="cmtt-10">makeindex</span><a - id="dx1-16041"></a> or <span + id="dx1-16040"></a> or <span class="cmtt-10">xindy</span><a - id="dx1-16042"></a> messages. + id="dx1-16041"></a> messages. + + </li> <li class="itemize">If <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16043"></a></a> warns about multiple encap values, <a + id="dx1-16042"></a></a> warns about multiple encap values, <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16044"></a></a> will detect this - and attempt to correct the problem.<span class="footnote-mark"><a -href="#fn5x1" id="fn5x1-bk"><sup class="textsuperscript">1.5</sup></a></span><a - id="x1-16045f5"></a> + id="dx1-16043"></a></a> will detect this and attempt to + correct the problem.<span class="footnote-mark"><a +href="#fn6x1" id="fn6x1-bk"><sup class="textsuperscript">1.6</sup></a></span><a + id="x1-16044f6"></a> This correction is only provided by <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16047"></a></a> when <a + id="dx1-16046"></a></a> when <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16048"></a></a> is used since - <a + id="dx1-16047"></a></a> is used since <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16049"></a></a> uses the order of the attributes list to determine which format should take - precedence. (See <span -class="cmtt-10">\GlsAddXdyAttribute </span>in <a -href="#sec:xindyloc"><span -class="tcrm-1000">§</span>11.2 </a><a -href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.) + id="dx1-16048"></a></a> uses the + order of the <a + id="dx1-16049"></a>attributes list to determine which format should take precedence. (see <a +href="#sec:xindyloc">§11.2 </a><a +href="#sec:xindyloc">Locations + and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.) </li></ul> -<!--l. 2647--><p class="indent" > As from version 4.16, the <span -class="cmss-10">glossaries </span>package also comes with a Lua script called -<a +<!--l. 2975--><p class="indent" > As from version 4.16, the <span +class="cmss-10">glossaries </span>package also comes with a Lua script called <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-16050"></a></a>. This is a <span + id="dx1-16050"></a></a>. This +is a <span class="cmti-10">trimmed-down </span>alternative to the <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16051"></a></a> Perl -script. It doesn’t have some of the options that the Perl version has and it doesn’t attempt to -diagnose any problems, but since modern <span class="TEX">T<span -class="E">E</span>X</span> distributions come with Lua<span class="TEX">T<span -class="E">E</span>X</span> (and -therefore have a Lua interpreter) you don’t need to install anything else in order to use -<a + id="dx1-16051"></a></a> Perl script. It doesn’t have some of the options that the +Perl version has and it doesn’t attempt to diagnose any problems, but since modern <span class="TEX">T<span +class="E">E</span>X</span> distributions come +with Lua<span class="TEX">T<span +class="E">E</span>X</span> (and therefore have a Lua interpreter) you don’t need to install anything else in order to +use <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a id="dx1-16052"></a></a> so it’s an alternative to <a @@ -5556,29 +6793,28 @@ href="#option2">Option 2</a> href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a id="dx1-16054"></a></a>). -</p><!--l. 2657--><p class="indent" > If things go wrong and you can’t work out why your glossaries aren’t being generated -correctly, you can use <a +</p><!--l. 2985--><p class="indent" > If things go wrong and you can’t work out why your glossaries aren’t being generated correctly, you can use +<a href="#glo:makeglossariesgui"><span class="cmtt-10">makeglossariesgui</span><a - id="dx1-16055"></a></a> as a diagnostic tool. Once you’ve fixed the -problem, you can then go back to using <a + id="dx1-16055"></a></a> as a diagnostic tool. Once you’ve fixed the problem, you can then go back to using +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-16056"></a></a> or <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a id="dx1-16057"></a></a>. -</p><!--l. 2663--><p class="indent" > Whilst I strongly recommended that you use the <a +</p><!--l. 2991--><p class="indent" > Whilst I strongly recommended that you use the <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16058"></a></a> Perl script or -the <a + id="dx1-16058"></a></a> Perl script or the <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-16059"></a></a> Lua script, it is possible to use the <span -class="cmss-10">glossaries </span>package -without using those applications. However, note that some commands and package -options have no effect if you explicitly run <a + id="dx1-16059"></a></a> +Lua script, it is possible to use the <span +class="cmss-10">glossaries </span>package without using those applications. However, note that some +commands and package options have no effect if you explicitly run <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a id="dx1-16060"></a></a>/<a @@ -5587,142 +6823,139 @@ class="cmtt-10">xindy</span><a id="dx1-16061"></a></a>. These are listed in <a href="#tab:makeglossariesCmds">table 1.3</a>. -</p><!--l. 2670--><p class="indent" > <div class="important" title="Important Note"> If you are choosing not to use <span +</p><!--l. 2998--><p class="indent" > <div class="important" title="Important Note"> If you are choosing not to use <span class="cmtt-10">makeglossaries</span><a - id="dx1-16062"></a> because you don’t want to install Perl, -you will only be able to use <span + id="dx1-16062"></a> because you don’t want to install Perl, you will only be able +to use <span class="cmtt-10">makeindex</span><a id="dx1-16063"></a> as <span class="cmtt-10">xindy</span><a - id="dx1-16064"></a> also requires Perl. (Other useful Perl -scripts include <span + id="dx1-16064"></a> also requires Perl. (Other useful Perl scripts include <span class="cmtt-10">epstopdf </span>and <span -class="cmtt-10">latexmk</span>, so it’s well-worth the effort to install Perl.) -</div> -</p><!--l. 2676--><p class="noindent" > -</p><!--l. 2678--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside -the glossary, you will need to do an additional <a +class="cmtt-10">latexmk</span>, so it’s +well-worth the effort to install Perl.) </div> +</p><!--l. 3004--><p class="noindent" > +</p><!--l. 3006--><p class="indent" > Note that if any of your entries use an entry that is not referenced outside the glossary, you will need to do an +additional <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-16065"></a></a>, <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16066"></a></a> or -<a + id="dx1-16066"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a id="dx1-16067"></a></a> run, as appropriate. For example, suppose you have defined the following entries:<span class="footnote-mark"><a -href="#fn6x1" id="fn6x1-bk"><sup class="textsuperscript">1.6</sup></a></span><a - id="x1-16068f6"></a> - - +href="#fn7x1" id="fn7x1-bk"><sup class="textsuperscript">1.7</sup></a></span><a + id="x1-16068f7"></a> + + </p> - <div class="verbatim" id="verbatim-66"> + <div class="verbatim" id="verbatim-59"> \newglossaryentry{citrusfruit}{name={citrus fruit},  <br />description={fruit of any citrus tree. (See also  <br />\gls{orange})}}  <br />\newglossaryentry{orange}{name={orange},  <br />description={an orange coloured fruit.}} </div> -<!--l. 2691--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{citrusfruit}</span></span></span> in your document but don’t reference -the <span -class="cmtt-10">orange </span>entry, then the <span -class="cmtt-10">orange </span>entry won’t appear in your glossary until you -first create the glossary and then do another run of <a +<!--l. 3019--><p class="nopar" > and suppose you have <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{citrusfruit}</span></span></span> in your document but don’t reference the <span +class="cmtt-10">orange </span>entry, then the +<span +class="cmtt-10">orange </span>entry won’t appear in your glossary until you first create the glossary and then do another run of +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-16070"></a></a>, <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16071"></a></a> -or <a + id="dx1-16071"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a id="dx1-16072"></a></a>. For example, if the document is called <span -class="cmtt-10">myDoc.tex</span>, then you must do: -<spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex myDoc</span> - <br /><span -class="cmtt-10">makeglossaries myDoc</span> - <br /><span -class="cmtt-10">latex myDoc</span> - <br /><span -class="cmtt-10">makeglossaries myDoc</span> - <br /><span -class="cmtt-10">latex myDoc</span></span> -</p><!--l. 2705--><p class="indent" > <spacer type=vertical size=10> -(Note that if you use <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>, this will be done automatically for you if -the <span -class="cmss-10">indexcrossrefs </span>feature is enabled. See the <span -class="cmss-10">glossaries-extra </span>user guide for further -details.) -</p><!--l. 2711--><p class="indent" > Likewise, an additional <a +class="cmtt-10">myDoc.tex</span>, then you must +do: +</p><!--l. 3027--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />makeglossaries myDoc + <br />pdflatex myDoc + <br />makeglossaries myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +(In the case of <a +href="#option4">Option 4</a>, <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-16073"></a></a> will scan the description for instances of commands like <span +class="cmtt-10">\gls </span>to ensure they +are selected but an extra <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-16074"></a></a> call is required to ensure the locations are included, if locations lists are +required. See the and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-16075"></a></a> manual for further details.) +</p><!--l. 3040--><p class="indent" > Likewise, an additional <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16073"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run may be required if the -document pages shift with re-runs. For example, if the page numbering is not reset after the -table of contents, the insertion of the table of contents on the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run may push -glossary entries across page boundaries, which means that the <a + id="dx1-16076"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run may be required if the document pages shift with +re-runs. For example, if the page numbering is not reset after the table of contents, the insertion of the table of +contents on the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run may push glossary entries across page boundaries, which means that the +<a href="#glo:numberlist">number list<a - id="dx1-16074"></a>s</a> in the glossary -may need updating. -</p><!--l. 2719--><p class="indent" > The examples in this document assume that you are accessing <a + id="dx1-16077"></a>s</a> in the glossary may need updating. +</p><!--l. 3048--><p class="indent" > The examples in this document assume that you are accessing <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-16075"></a></a>, <a + id="dx1-16078"></a></a>, <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16076"></a></a> or -<a + id="dx1-16079"></a></a> or <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16077"></a></a> via a terminal. Windows users can use the MSDOS Prompt which is usually -accessed via the <span + id="dx1-16080"></a></a> via a +terminal. Windows users can use the MSDOS Prompt which is usually accessed via the <span class="cmss-10">Start-</span><span class="cmmi-10">></span><span -class="cmss-10">All Programs </span>menu or <span +class="cmss-10">All Programs</span> +menu or <span class="cmss-10">Start-</span><span class="cmmi-10">></span><span class="cmss-10">All Programs-</span><span class="cmmi-10">></span><span -class="cmss-10">Accessories</span> -menu. -</p><!--l. 2725--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the -required application. See <a -href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into -the document build</a>. -</p><!--l. 2731--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span -class="cmtt-10">.glg</span><a - id="dx1-16078"></a> or <span -class="cmtt-10">.alg</span><a - id="dx1-16079"></a>) for -messages. +class="cmss-10">Accessories </span>menu. +</p><!--l. 3054--><p class="indent" > Alternatively, your text editor may have the facility to create a function that will call the required +application. See <a +href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document +build</a>. +</p><!--l. 3060--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span +class="cmtt-10">glg</span><a + id="dx1-16081"></a> or <span +class="cmtt-10">alg</span><a + id="dx1-16082"></a>) for messages. </p> <div class="table"> - - -<!--l. 2734--><p class="indent" > <a + + +<!--l. 3063--><p class="indent" > <a id="tab:makeglossariesCmds"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 1.3: </span><span class="content">Commands and package options that have no effect when using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16081"></a></a> or -<a + id="dx1-16084"></a></a> or <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16082"></a></a> explicitly</span></div><!--tex4ht:label?: x1-160803 --> + id="dx1-16085"></a></a> explicitly</span></div><!--tex4ht:label?: x1-160833 --> <div class="tabular"> <table id="TBL-4" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-4-1g"><col @@ -5735,35 +6968,39 @@ class="cmbx-10">Command or Package Option </span></td><td style="white-s class="td11"> <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-16083"></a></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3" + id="dx1-16086"></a></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-3" class="td10"> <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-16084"></a></a> </td> + id="dx1-16087"></a></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-1" class="td01"><span -class="cmss-10">order=letter</span><a - id="dx1-16085"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2" +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a + id="dx1-16088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-2" class="td11"> use <span class="cmtt-10">-l</span><a - id="dx1-16086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3" + id="dx1-16089"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-2-3" class="td10"> use <span class="cmtt-10">-M</span><a - id="dx1-16087"></a> <span + id="dx1-16090"></a> <span class="cmtt-10">ord/letorder</span></td> </tr><tr style="vertical-align:baseline;" id="TBL-4-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-1" class="td01"><span -class="cmss-10">order=word</span><a - id="dx1-16088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2" +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">word</span><a + id="dx1-16091"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-2" class="td11"> default </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-3-3" class="td10"> default </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-1" class="td01"><span class="cmss-10">xindy</span><a - id="dx1-16089"></a>=<span + id="dx1-16092"></a>=<span class="cmsy-10">{</span><span class="cmss-10">language=</span>⟨<span class="cmti-10">lang</span>⟩<span @@ -5773,79 +7010,78 @@ class="cmsy-10">} </span></td><td style="white-space:nowrap; text-align:left;" class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-3" class="td10"> use <span class="cmtt-10">-L</span><a - id="dx1-16090"></a> ⟨<span + id="dx1-16093"></a> ⟨<span class="cmti-10">lang</span>⟩ <span class="cmtt-10">-C</span><a - id="dx1-16091"></a> ⟨<span + id="dx1-16094"></a> ⟨<span class="cmti-10">code</span>⟩ </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-1" class="td01"><span class="cmtt-10">\GlsSetXdyLanguage</span><a - id="dx1-16092"></a><span + id="dx1-16095"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">lang</span>⟩<span class="cmtt-10">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-2" class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-5-3" class="td10"> use <span class="cmtt-10">-L</span><a - id="dx1-16093"></a> ⟨<span + id="dx1-16096"></a> ⟨<span class="cmti-10">lang</span>⟩ </td> </tr><tr style="vertical-align:baseline;" id="TBL-4-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-1" class="td01"><span class="cmtt-10">\GlsSetXdyCodePage</span><a - id="dx1-16094"></a><span + id="dx1-16097"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">code</span>⟩<span class="cmtt-10">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-2" class="td11"> N/A </td><td style="white-space:nowrap; text-align:left;" id="TBL-4-6-3" class="td10"> use <span class="cmtt-10">-C</span><a - id="dx1-16095"></a> ⟨<span + id="dx1-16098"></a> ⟨<span class="cmti-10">code</span>⟩ </td></tr></table> </div> - - + + </div><hr class="endfloat" /> </div> -<!--l. 2757--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.1 </span> <a +<!--l. 3086--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.1 </span> <a id="sec:makeglossariesapp"></a>Using the makeglossaries Perl Script</h4> -<!--l. 2760--><p class="noindent" >The <a +<!--l. 3089--><p class="noindent" >The <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-17001"></a></a> script picks up the relevant information from the auxiliary (<span -class="cmtt-10">.aux</span><a - id="dx1-17002"></a>) file -and will either call <a +class="cmtt-10">aux</span><a + id="dx1-17002"></a>) file and will either call +<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a id="dx1-17003"></a></a> or <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-17004"></a></a>, depending on the supplied information. Therefore, -you only need to pass the document’s name without the extension to <span + id="dx1-17004"></a></a>, depending on the supplied information. Therefore, you only need to pass the document’s +name without the extension to <span class="cmtt-10">makeglossaries</span><a - id="dx1-17005"></a>. For -example, if your document is called <span -class="cmtt-10">myDoc.tex</span>, type the following in your terminal: -<spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">latex myDoc</span> - <br /><span -class="cmtt-10">makeglossaries myDoc</span> - <br /><span -class="cmtt-10">latex myDoc</span></span> -</p><!--l. 2771--><p class="indent" > <spacer type=vertical size=10> + id="dx1-17005"></a>. For example, if your document is called <span +class="cmtt-10">myDoc.tex</span>, type the +following in your terminal: +</p><!--l. 3096--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex myDoc + <br />makeglossaries myDoc + <br />pdflatex myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> You may need to explicitly load <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17006"></a></a> into Perl: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">perl makeglossaries myDoc</span></span> -</p><!--l. 2775--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 2777--><p class="indent" > Windows users: <span class="TEX">T<span + id="dx1-17006"></a></a> into Perl: +</p><!--l. 3102--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />perl makeglossaries myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 3106--><p class="indent" > Windows users: <span class="TEX">T<span class="E">E</span>X</span> Live on Windows has its own internal Perl interpreter and provides <span class="cmtt-10">makeglossaries.exe </span>as a convenient wrapper for the <a @@ -5857,13 +7093,13 @@ class="cmtt-10">makeglossaries.exe </span>but doesn’t provide a Per required even if you run MiKTeX’s <span class="cmtt-10">makeglossaries.exe</span>, so with MiKTeX you’ll need to install Perl.<span class="footnote-mark"><a -href="#fn7x1" id="fn7x1-bk"><sup class="textsuperscript">1.7</sup></a></span><a - id="x1-17008f7"></a> +href="#fn8x1" id="fn8x1-bk"><sup class="textsuperscript">1.8</sup></a></span><a + id="x1-17008f8"></a> There’s more information about this at <a href="http://tex.stackexchange.com/q/158796/19862" class="url" ><span -class="cmtt-10">http://tex.stackexchange.com/q/158796/19862</span></a> -on the TeX.SX site. -</p><!--l. 2789--><p class="indent" > The <a +class="cmtt-10">http://tex.stackexchange.com/q/158796/19862</span></a> on the TeX.SX +site. +</p><!--l. 3118--><p class="indent" > The <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-17009"></a></a> script attempts to fork the <a @@ -5872,79 +7108,79 @@ class="cmtt-10">makeindex</span><a id="dx1-17010"></a></a>/<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-17011"></a></a> process -using <span -class="cmtt-10">open() </span>on the piped redirection <span class="obeylines-h"><span class="verb"><span + id="dx1-17011"></a></a> process using <span +class="cmtt-10">open() </span>on the piped +redirection <span class="obeylines-h"><span class="verb"><span class="cmtt-10">2>&1</span><span -class="cmtt-10"> |</span></span></span> and parses the processor output to -help diagnose problems. If this method fails <a +class="cmtt-10"> |</span></span></span> and parses the processor output to help diagnose problems. If this method fails +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17012"></a></a> will print an “Unable -to fork” warning and will retry without redirection. If you run <a + id="dx1-17012"></a></a> will print an “Unable to fork” warning and will retry without redirection. If you run +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17013"></a></a> -on an operating system that doesn’t support this form of redirection, then you -can use the <span + id="dx1-17013"></a></a> on an operating system that doesn’t support this form of redirection, then you can use the <span class="cmtt-10">-Q</span><a - id="dx1-17014"></a> switch to suppress this warning or you can use the <span + id="dx1-17014"></a> +switch to suppress this warning or you can use the <span class="cmtt-10">-k</span><a - id="dx1-17015"></a> switch to -make <a + id="dx1-17015"></a> switch to make <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17016"></a></a> automatically use the fallback method without attempting -the redirection. Without this redirection, the <span + id="dx1-17016"></a></a> automatically use the +fallback method without attempting the redirection. Without this redirection, the <span class="cmtt-10">-q</span><a - id="dx1-17017"></a> (quiet) switch doesn’t work as -well. -</p><!--l. 2801--><p class="indent" > You can specify in which directory the <span -class="cmtt-10">.aux</span><a + id="dx1-17017"></a> (quiet) switch doesn’t +work as well. +</p><!--l. 3130--><p class="indent" > You can specify in which directory the <span +class="cmtt-10">aux</span><a id="dx1-17018"></a>, <span -class="cmtt-10">.glo</span><a +class="cmtt-10">glo</span><a id="dx1-17019"></a> etc files are located using the <span -class="cmtt-10">-d </span>switch. -For example: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">pdflatex -output-directory myTmpDir myDoc</span> - <br /><span -class="cmtt-10">makeglossaries -d myTmpDir myDoc</span></span> -</p><!--l. 2807--><p class="indent" > <spacer type=vertical size=10> +class="cmtt-10">-d </span>switch. For +example: +</p><!--l. 3133--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex -output-directory myTmpDir myDoc + <br />makeglossaries -d myTmpDir myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> Note that <span class="cmtt-10">makeglossaries</span><a id="dx1-17020"></a> assumes by default that <span class="cmtt-10">makeindex</span><a id="dx1-17021"></a>/<span class="cmtt-10">xindy</span><a - id="dx1-17022"></a> is on your operating -system’s path. If this isn’t the case, you can specify the full pathname using <span + id="dx1-17022"></a> is on your operating system’s path. If +this isn’t the case, you can specify the full pathname using <span class="cmtt-10">-m</span><a - id="dx1-17023"></a> -⟨<span + id="dx1-17023"></a> ⟨<span class="cmti-10">path/to/makeindex</span>⟩ for <span class="cmtt-10">makeindex</span><a id="dx1-17024"></a> or <span class="cmtt-10">-x</span><a - id="dx1-17025"></a> ⟨<span + id="dx1-17025"></a> +⟨<span class="cmti-10">path/to/xindy</span>⟩ for <span class="cmtt-10">xindy</span><a id="dx1-17026"></a>. -</p><!--l. 2814--><p class="indent" > As from <a + + +</p><!--l. 3143--><p class="indent" > As from <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-17027"></a></a> v2.18, if you are using <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-17028"></a></a>, there’s a check for -<span + id="dx1-17028"></a></a>, there’s a check for <span class="cmtt-10">makeindex</span><a - id="dx1-17029"></a>’s multiple encap warning. This is where different encap values (location formats) -are used on the same location for the same entry. For example: - - + id="dx1-17029"></a>’s multiple encap +warning. This is where different encap values (location formats) are used on the same location for the same +entry. For example: + + </p> - <div class="verbatim" id="verbatim-67"> + <div class="verbatim" id="verbatim-60"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\makeglossaries @@ -5954,382 +7190,369 @@ are used on the same location for the same entry. For example:  <br />\printglossaries  <br />\end{document} </div> -<!--l. 2830--><p class="nopar" > If you explicitly use <a +<!--l. 3159--><p class="nopar" > If you explicitly use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-17030"></a></a>, this will cause a warning and the location list -will be “1, <span -class="cmbx-10">1</span>”. That is, the page number will be repeated with each format. As -from v2.18, <a + id="dx1-17030"></a></a>, this will cause a warning and the location list will be “1, <span +class="cmbx-10">1</span>”. That is, the page +number will be repeated with each format. As from v2.18, <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17031"></a></a> will check for this warning and, if found, will attempt -to correct the problem by removing duplicate locations and retrying. There’s no -similar check for <a + id="dx1-17031"></a></a> will check for this warning +and, if found, will attempt to correct the problem by removing duplicate locations and retrying. +There’s no similar check for <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a id="dx1-17032"></a></a> as <span class="cmtt-10">xindy</span><a id="dx1-17033"></a> won’t produce any warning and will simply discard duplicates. -</p><!--l. 2839--><p class="indent" > The <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-17034"></a></a> script contains POD (Plain Old Documentation). If you want, you -can create a man page for <span -class="cmtt-10">makeglossaries</span><a - id="dx1-17035"></a> using <span -class="cmtt-10">pod2man</span><a - id="dx1-17036"></a> and move the resulting file onto -the man path. Alternatively do <span -class="cmtt-10">makeglossaries --help </span>for a list of all options or -<span -class="cmtt-10">makeglossaries --version </span>for the version number. -</p><!--l. 2846--><p class="indent" > <div class="important" title="Important Note"> When upgrading the <span -class="cmss-10">glossaries </span>package, make sure you also upgrade your version of -<a +</p><!--l. 3168--><p class="indent" > For a complete list of options do <span +class="cmtt-10">makeglossaries --help</span>. +</p><!--l. 3170--><p class="indent" > <div class="important" title="Important Note"> When upgrading the <span +class="cmss-10">glossaries </span>package, make sure you also upgrade your version of <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-17037"></a></a>. The current version is 4.44. </div> -</p><!--l. 2850--><p class="noindent" > -</p><!--l. 2852--><p class="noindent" > + id="dx1-17034"></a></a>. The +current version is 4.45. </div> +</p><!--l. 3174--><p class="noindent" > +</p><!--l. 3176--><p class="noindent" > </p> -<!--l. 2852--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.2 </span> <a +<!--l. 3176--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.2 </span> <a id="sec:makeglossarieslua"></a>Using the makeglossaries-lite Lua Script</h4> -<!--l. 2855--><p class="noindent" >The Lua alternative to the <a +<!--l. 3179--><p class="noindent" >The Lua alternative to the <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-18001"></a></a> Perl script requires a Lua interpreter, which -should already be available if you have a modern <span class="TEX">T<span + id="dx1-18001"></a></a> Perl script requires a Lua interpreter, which should already be +available if you have a modern <span class="TEX">T<span class="E">E</span>X</span> distribution that includes Lua<span class="TEX">T<span -class="E">E</span>X</span>. -Lua is a light-weight, cross-platform scripting language, but because it’s light-weight it -doesn’t have the full-functionality of heavy-weight scripting languages, such as Perl. The -<a +class="E">E</span>X</span>. Lua is a light-weight, cross-platform +scripting language, but because it’s light-weight it doesn’t have the full-functionality of heavy-weight scripting +languages, such as Perl. The <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-18002"></a></a> script is therefore limited by this and some of the options -available to the <a + id="dx1-18002"></a></a> script is therefore limited by this and some of the +options available to the <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-18003"></a></a> Perl script aren’t available here. (In particular the <span class="cmtt-10">-d</span><a id="dx1-18004"></a> option.) -</p><!--l. 2865--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="TEX">T<span -class="E">E</span>X</span> Live on Unix-like systems creates a symbolic link called -<span -class="cmtt-10">makeglossaries-lite </span>(without the <span -class="cmtt-10">.lua </span>extension) to the actual <span -class="cmtt-10">makeglossaries-lite.lua</span> -script, so you may not need to supply the extension. </div> -</p><!--l. 2871--><p class="noindent" > - - -</p><!--l. 2873--><p class="indent" > The <a +</p><!--l. 3189--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="TEX">T<span +class="E">E</span>X</span> Live on Unix-like systems creates a symbolic link called <span +class="cmtt-10">makeglossaries-lite </span>(without +the <span +class="cmtt-10">lua</span><a + id="dx1-18005"></a> extension) to the actual <span +class="cmtt-10">makeglossaries-lite.lua </span>script, so you may not need to supply the +extension. </div> +</p><!--l. 3195--><p class="noindent" > +</p><!--l. 3197--><p class="indent" > The <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-18005"></a></a> script can be invoked in the same way as <a + id="dx1-18006"></a></a> script can be invoked in the same way as <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-18006"></a></a>. -For example, if your document is called <span -class="cmtt-10">myDoc.tex</span>, then do <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries-lite.lua myDoc</span></span> -</p><!--l. 2878--><p class="indent" > <spacer type=vertical size=10> -or <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries-lite myDoc</span></span> -</p><!--l. 2882--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 2884--><p class="indent" > <span -class="cmti-10">Some </span>of the options available with <a + id="dx1-18007"></a></a>. For example, if your +document is called <span +class="cmtt-10">myDoc.tex</span>, then do +</p><!--l. 3200--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries-lite.lua myDoc + <br /></pre><spacer type=vertical size=10> + + + <br /></span> +or +</p><!--l. 3204--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries-lite myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 3208--><p class="indent" > <span +class="cmti-10">Some </span>of the options available with the Perl <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-18007"></a></a> are also available with + id="dx1-18008"></a></a> script are also available with the Lua <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-18008"></a></a>. For a complete list of available options, do <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries-lite.lua --help</span></span> -</p><!--l. 2889--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 2893--><p class="noindent" > -</p> -<!--l. 2893--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.3 </span> <a + id="dx1-18009"></a></a> script. For a complete list of available options, do +</p><!--l. 3211--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries-lite.lua --help + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 3217--><p class="noindent" > +</p> +<!--l. 3217--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.3 </span> <a id="sec:xindyapp"></a>Using <a href="#glo:xindy"><span class="cmtt-10">xindy</span></a> explicitly (Option 3)</h4> -<!--l. 2896--><p class="noindent" ><a +<!--l. 3220--><p class="noindent" ><a href="#glo:xindy"><span class="cmtt-10">Xindy</span><a id="dx1-19001"></a></a> comes with <span class="TEX">T<span class="E">E</span>X</span> Live. It has also been added to Mik<span class="TEX">T<span -class="E">E</span>X</span>, but if you don’t have it -installed, see <a -href="http://tex.stackexchange.com/questions/71167/how-to-use-xindy-with-miktex" >How to use Xindy with MikTeX</a> on <a +class="E">E</span>X</span>, but if you don’t have it installed, see <a +href="http://tex.stackexchange.com/questions/71167/how-to-use-xindy-with-miktex" >How to +use Xindy with MikTeX</a> on <a href="http://www.stackexchange.com/" ><span class="TEX">T<span class="E">E</span>X</span> on StackExchange</a>. -</p><!--l. 2902--><p class="indent" > If you want to use <a +</p><!--l. 3226--><p class="indent" > If you want to use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19002"></a></a> to process the glossary files, you must make sure you have used -the <span + id="dx1-19002"></a></a> to process the glossary files, you must make sure you have used the <span class="cmss-10">xindy</span><a - id="dx1-19003"></a> package option: - - + id="dx1-19003"></a> package +option: + + </p> - <div class="verbatim" id="verbatim-68"> + <div class="verbatim" id="verbatim-61"> \usepackage[xindy]{glossaries} </div> -<!--l. 2907--><p class="nopar" > This is required regardless of whether you use <a +<!--l. 3231--><p class="nopar" > This is required regardless of whether you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19004"></a></a> explicitly or whether it’s -called implicitly via applications such as <a + id="dx1-19004"></a></a> explicitly or whether it’s called implicitly via applications +such as <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-19005"></a></a>. This causes the glossary -entries to be written in raw <span + id="dx1-19005"></a></a>. This causes the glossary entries to be written in raw <span class="cmtt-10">xindy</span><a - id="dx1-19006"></a> format, so you need to use <span + id="dx1-19006"></a> format, so you need to use +<span class="cmtt-10">-I</span><a id="dx1-19007"></a> <span class="cmtt-10">xindy </span><span class="cmti-10">not </span><span class="cmtt-10">-I</span><a - id="dx1-19008"></a> -<span + id="dx1-19008"></a> <span class="cmtt-10">tex</span>. -</p><!--l. 2914--><p class="indent" > To run <a +</p><!--l. 3238--><p class="indent" > To run <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19009"></a></a> type the following in your terminal (all on one line): <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy -L </span>⟨<span -class="cmitt-10">language</span>⟩ <span -class="cmtt-10">-C </span>⟨<span -class="cmitt-10">encoding</span>⟩ <span -class="cmtt-10">-I xindy -M </span>⟨<span -class="cmitt-10">style</span>⟩ <span -class="cmtt-10">-t </span>⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.glg -o </span>⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.gls</span> -⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.glo</span></span> -</p><!--l. 2918--><p class="indent" > <spacer type=vertical size=10> + id="dx1-19009"></a></a> type the following in your terminal (all on one line): +</p><!--l. 3240--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L ⟨<span +class="cmti-10">language</span>⟩ -C ⟨<span +class="cmti-10">encoding</span>⟩ -I xindy -M ⟨<span +class="cmti-10">style</span>⟩ -t ⟨<span +class="cmti-10">base</span>⟩.glg -o ⟨<span +class="cmti-10">base</span>⟩.gls ⟨<span +class="cmti-10">base</span>⟩.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> where ⟨<span class="cmti-10">language</span>⟩ is the required language name, ⟨<span class="cmti-10">encoding</span>⟩ is the encoding, ⟨<span -class="cmti-10">base</span>⟩ is the name of -the document without the <span -class="cmtt-10">.tex</span><a +class="cmti-10">base</span>⟩ is the name of the document +without the <span +class="cmtt-10">tex</span><a id="dx1-19010"></a> extension and ⟨<span class="cmti-10">style</span>⟩ is the name of the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19011"></a></a> style file -without the <span -class="cmtt-10">.xdy</span><a - id="dx1-19012"></a> extension. The default name for this style file is ⟨<span + id="dx1-19011"></a></a> style file without the <span +class="cmtt-10">xdy</span><a + id="dx1-19012"></a> extension. The default +name for this style file is ⟨<span class="cmti-10">base</span>⟩<span -class="cmtt-10">.xdy</span><a - id="dx1-19013"></a> but can be -changed via <span +class="cmtt-10">xdy</span><a + id="dx1-19013"></a> but can be changed via <span class="cmtt-10">\setStyleFile</span><a id="dx1-19014"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">style</span>⟩<span -class="cmtt-10">}</span>. You may need to specify the full path name depending -on the current working directory. If any of the file names contain spaces, you must delimit -them using double-quotes. -</p><!--l. 2929--><p class="indent" > For example, if your document is called <span -class="cmtt-10">myDoc.tex </span>and you are using UTF8 encoding in -English, then type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls</span> -<span -class="cmtt-10">myDoc.glo</span></span> -</p><!--l. 2934--><p class="indent" > <spacer type=vertical size=10> -</p><!--l. 2936--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of -the other glossaries (including the list of acronyms if you have used the <span +class="cmtt-10">}</span>. You may need to specify the +full path name depending on the current working directory. If any of the file names contain spaces, you must +delimit them using double-quotes. +</p><!--l. 3253--><p class="indent" > For example, if your document is called <span +class="cmtt-10">myDoc.tex </span>and you are using UTF8 encoding in English, then type +the following in your terminal: +</p><!--l. 3256--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 3260--><p class="indent" > Note that this just creates the main glossary. You need to do the same for each of the other glossaries +(including the list of acronyms if you have used the <span class="cmss-10">acronym</span><a - id="dx1-19015"></a> -package option), substituting <span -class="cmtt-10">.glg</span><a + id="dx1-19015"></a> package option), substituting <span +class="cmtt-10">glg</span><a id="dx1-19016"></a>, <span -class="cmtt-10">.gls</span><a +class="cmtt-10">gls</span><a id="dx1-19017"></a> and <span -class="cmtt-10">.glo</span><a - id="dx1-19018"></a> with the relevant extensions. For -example, if you have used the <span +class="cmtt-10">glo</span><a + id="dx1-19018"></a> +with the relevant extensions. For example, if you have used the <span class="cmss-10">acronym</span><a - id="dx1-19019"></a> package option, then you would need to do: -<spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr</span> + id="dx1-19019"></a> package option, then you would need to +do: +</p><!--l. 3267--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn + <br /></pre><spacer type=vertical size=10> + <br /></span> +For additional glossaries, the extensions are those supplied when you created the glossary with <span -class="cmtt-10">myDoc.acn</span></span> -</p><!--l. 2945--><p class="indent" > <spacer type=vertical size=10> -For additional glossaries, the extensions are those supplied when you created the glossary -with <span class="cmtt-10">\newglossary</span><a id="dx1-19020"></a>. -</p><!--l. 2949--><p class="indent" > Note that if you use <a +</p><!--l. 3273--><p class="indent" > Note that if you use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-19021"></a></a> instead, you can replace all those calls to <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19022"></a></a> -with just one call to <span + id="dx1-19022"></a></a> with just one call to +<span class="cmtt-10">makeglossaries</span><a - id="dx1-19023"></a>: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries myDoc</span></span> -</p><!--l. 2954--><p class="indent" > <spacer type=vertical size=10> + id="dx1-19023"></a>: +</p><!--l. 3276--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> Note also that some commands and package options have no effect if you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-19024"></a></a> explicitly -instead of using <span + id="dx1-19024"></a></a> explicitly instead of using +<span class="cmtt-10">makeglossaries</span><a id="dx1-19025"></a>. These are listed in <a href="#tab:makeglossariesCmds">table 1.3</a>. -</p><!--l. 2962--><p class="noindent" > + + +</p><!--l. 3286--><p class="noindent" > </p> - - -<!--l. 2962--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.4 </span> <a +<!--l. 3286--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.4.4 </span> <a id="sec:makeindexapp"></a>Using <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span></a> explicitly (Option 2)</h4> -<!--l. 2965--><p class="noindent" >If you want to use <a +<!--l. 3289--><p class="noindent" >If you want to use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a id="dx1-20001"></a></a> explicitly, you must make sure that you haven’t used the <span class="cmss-10">xindy</span><a - id="dx1-20002"></a> -package option or the glossary entries will be written in the wrong format. To run <span + id="dx1-20002"></a> package option or +the glossary entries will be written in the wrong format. To run <span class="cmtt-10">makeindex</span><a - id="dx1-20003"></a>, -type the following in your terminal: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex -s </span>⟨<span -class="cmitt-10">style</span>⟩<span -class="cmtt-10">.ist -t </span>⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.glg -o </span>⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.gls </span>⟨<span -class="cmitt-10">base</span>⟩<span -class="cmtt-10">.glo</span></span> -</p><!--l. 2972--><p class="indent" > <spacer type=vertical size=10> + id="dx1-20003"></a>, type the following in your +terminal: +</p><!--l. 3294--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s ⟨<span +class="cmti-10">style</span>⟩.ist -t ⟨<span +class="cmti-10">base</span>⟩.glg -o ⟨<span +class="cmti-10">base</span>⟩.gls ⟨<span +class="cmti-10">base</span>⟩.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> where ⟨<span class="cmti-10">base</span>⟩ is the name of your document without the <span -class="cmtt-10">.tex</span><a +class="cmtt-10">tex</span><a id="dx1-20004"></a> extension and ⟨<span class="cmti-10">style</span>⟩<span -class="cmtt-10">.ist</span><a - id="dx1-20005"></a> is the -name of the <a +class="cmtt-10">ist</span><a + id="dx1-20005"></a> is the name of the +<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a id="dx1-20006"></a></a> style file. By default, this is ⟨<span class="cmti-10">base</span>⟩<span -class="cmtt-10">.ist</span><a - id="dx1-20007"></a>, but may be changed via -<span +class="cmtt-10">ist</span><a + id="dx1-20007"></a>, but may be changed via <span class="cmtt-10">\setStyleFile</span><a id="dx1-20008"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">style</span>⟩<span -class="cmtt-10">}</span>. Note that there are other options, such as <span +class="cmtt-10">}</span>. Note +that there are other options, such as <span class="cmtt-10">-l</span><a - id="dx1-20009"></a> (letter ordering). See -the <span + id="dx1-20009"></a> (letter ordering). See the <span class="cmtt-10">makeindex</span><a - id="dx1-20010"></a> manual for further details. -</p><!--l. 2981--><p class="indent" > For example, if your document is called <span -class="cmtt-10">myDoc.tex</span>, then type the following at the -terminal: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo</span></span> -</p><!--l. 2985--><p class="indent" > <spacer type=vertical size=10> -Note that this only creates the main glossary. If you have additional glossaries (for example, if -you have used the <span + id="dx1-20010"></a> manual for further +details. +</p><!--l. 3305--><p class="indent" > For example, if your document is called <span +class="cmtt-10">myDoc.tex</span>, then type the following at the terminal: +</p><!--l. 3307--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the +<span class="cmss-10">acronym</span><a id="dx1-20011"></a> package option) then you must call <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-20012"></a></a> for each glossary, -substituting <span -class="cmtt-10">.glg</span><a + id="dx1-20012"></a></a> for each glossary, substituting <span +class="cmtt-10">glg</span><a id="dx1-20013"></a>, <span -class="cmtt-10">.gls</span><a +class="cmtt-10">gls</span><a id="dx1-20014"></a> and <span -class="cmtt-10">.glo</span><a - id="dx1-20015"></a> with the relevant extensions. For example, if you have used -the <span +class="cmtt-10">glo</span><a + id="dx1-20015"></a> with +the relevant extensions. For example, if you have used the <span class="cmss-10">acronym</span><a - id="dx1-20016"></a> package option, then you need to type the following in your terminal: -<spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn</span></span> -</p><!--l. 2996--><p class="indent" > <spacer type=vertical size=10> -For additional glossaries, the extensions are those supplied when you created the glossary -with <span + id="dx1-20016"></a> package option, then you need to type the +following in your terminal: +</p><!--l. 3318--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn + <br /></pre><spacer type=vertical size=10> + <br /></span> +For additional glossaries, the extensions are those supplied when you created the glossary with +<span class="cmtt-10">\newglossary</span><a id="dx1-20017"></a>. -</p><!--l. 3000--><p class="indent" > Note that if you use <a +</p><!--l. 3324--><p class="indent" > Note that if you use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-20018"></a></a> instead, you can replace all those calls to <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-20019"></a></a> -with just one call to <span + id="dx1-20019"></a></a> with just one call +to <span class="cmtt-10">makeglossaries</span><a - id="dx1-20020"></a>: <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">makeglossaries myDoc</span></span> -</p><!--l. 3005--><p class="indent" > <spacer type=vertical size=10> + id="dx1-20020"></a>: +</p><!--l. 3327--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries myDoc + <br /></pre><spacer type=vertical size=10> + <br /></span> Note also that some commands and package options have no effect if you use <span class="cmtt-10">makeindex</span><a - id="dx1-20021"></a> -explicitly instead of using <a + id="dx1-20021"></a> explicitly instead of +using <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a id="dx1-20022"></a></a>. These are listed in <a href="#tab:makeglossariesCmds">table 1.3</a>. -</p><!--l. 3012--><p class="noindent" > +</p><!--l. 3335--><p class="noindent" > </p> -<!--l. 3012--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.5 </span> <a - id="sec:notedev"></a>Note to Front-End and Script Developers</h4> -<!--l. 3015--><p class="noindent" >The information needed to determine whether to use <a +<!--l. 3335--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.5 </span> <a + id="sec:notedev"></a>Note to Front-End and Script Developers</h3> +<!--l. 3338--><p class="noindent" >The information needed to determine whether to use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-21001"></a></a> or <a + id="dx1-21001"></a></a>, <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-21002"></a></a> and the -information needed to call those applications is stored in the auxiliary file. This -information can be gathered by a front-end, editor or script to make the glossaries where -appropriate. This section describes how the information is stored in the auxiliary -file. -</p><!--l. 3022--><p class="indent" > The file extensions used by each defined glossary are given by -</p><!--l. 3023--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\@newglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-21003"></a> <span + id="dx1-21002"></a></a> or <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-21003"></a></a> is stored in the <span +class="cmtt-10">aux</span><a + id="dx1-21004"></a> file. +This information can be gathered by a front-end, editor or script to make the glossaries where appropriate. This +section describes how the information is stored in the auxiliary file. + + +</p><!--l. 3344--><p class="noindent" > +</p> +<!--l. 3344--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.1 </span> <a + id="sec:notedev.makeindex.xindy"></a>MakeIndex and Xindy</h4> +<!--l. 3347--><p class="noindent" >The file extensions used by each defined (but not ignored) glossary are given by +</p><!--l. 3348--><p class="indent" > <hr><div title="Definition"><a + id="dx1-22001"></a> <span class="cmtt-10">\@newglossary{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -6339,80 +7562,122 @@ class="cmitt-10">out-ext</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">in-ext</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 3025--><p class="noindent" > +</p><!--l. 3350--><p class="noindent" > where ⟨<span class="cmti-10">in-ext</span>⟩ is the extension of the <a href="#glo:indexingapp"><span -class="cmti-10">indexing application’s</span></a> input file (the output file from the -<span -class="cmss-10">glossaries </span>package’s point of view), ⟨<span +class="cmti-10">indexing application’s</span></a> input file (the output file from the <span +class="cmss-10">glossaries </span>package’s +point of view), ⟨<span class="cmti-10">out-ext</span>⟩ is the extension of the <span -class="cmti-10">indexing application’s</span> -output file (the input file from the <span -class="cmss-10">glossaries </span>package’s point of view) and ⟨<span -class="cmti-10">log</span>⟩ is the -extension of the indexing application’s transcript file. The label for the glossary - - -is also given for information purposes only, but is not required by the indexing -applications. For example, the information for the default main glossary is written +class="cmti-10">indexing application’s </span>output file (the input file from the <span +class="cmss-10">glossaries</span> +package’s point of view) and ⟨<span +class="cmti-10">log</span>⟩ is the extension of the indexing application’s transcript file. The label for the +glossary is also given. This isn’t required with <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-22002"></a></a>, but with <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-22003"></a></a> it’s needed to pick up the associated +language and encoding (see below). For example, the information for the default main glossary is written as: - - + + </p> - <div class="verbatim" id="verbatim-69"> + <div class="verbatim" id="verbatim-62"> \@newglossary{main}{glg}{gls}{glo} </div> -<!--l. 3038--><p class="nopar" > -</p><!--l. 3040--><p class="indent" > The <a +<!--l. 3364--><p class="nopar" > If <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span>’s</a> hybrid method has been used (with <span +class="cmtt-10">\makeglossaries[</span>⟨<span +class="cmti-10">sub-list</span>⟩<span +class="cmtt-10">]</span>), then the sub-list of +glossaries that need to be processed will be identified with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor180"><span +class="cmtt-10">\glsxtr@makeglossaries</span></span><a + id="dx1-22004"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">list</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 3372--><p class="indent" > The <a href="#glo:indexingapp">indexing application’s</a> style file is specified by -</p><!--l. 3041--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\@istfilename</span><span -class="cmtt-9"> </span></span><a - id="dx1-21004"></a> <span +</p><!--l. 3373--><p class="indent" > <hr><div title="Definition"><a + id="dx1-22005"></a> <span class="cmtt-10">\@istfilename{</span>⟨<span class="cmitt-10">filename</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 3043--><p class="noindent" > +</p><!--l. 3375--><p class="noindent" > The file extension indicates whether to use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-21005"></a></a> (<span -class="cmtt-10">.ist</span><a - id="dx1-21006"></a>) or <a + id="dx1-22006"></a></a> (<span +class="cmtt-10">ist</span><a + id="dx1-22007"></a>) or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-22008"></a></a> (<span +class="cmtt-10">xdy</span><a + id="dx1-22009"></a>). Note that the glossary information +is formatted differently depending on which indexing application is supposed to be used, so it’s important to call +the correct one. +</p><!--l. 3382--><p class="indent" > For example, with <span +class="cmtt-10">arara</span><a + id="dx1-22010"></a> you can easily determine whether to run <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-22011"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> makeglossaries</span><span +class="cmtt-10"> if</span><span +class="cmtt-10"> found("aux",</span><span +class="cmtt-10"> "@istfilename")</span> +</div> +</div> It’s more complicated if you want to explicitly run <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-22012"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-21007"></a></a> (<span -class="cmtt-10">.xdy</span><a - id="dx1-21008"></a>). -Note that the glossary information is formatted differently depending on which -indexing application is supposed to be used, so it’s important to call the correct -one. -</p><!--l. 3050--><p class="indent" > Word or letter ordering is specified by: -</p><!--l. 3051--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\@glsorder</span><span -class="cmtt-9"> </span></span><a - id="dx1-21009"></a> <span + id="dx1-22013"></a></a> +<!--l. 3389--><p class="indent" > <div class="important" title="Important Note"> Note that if you choose to explicitly call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-22014"></a></a> or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-22015"></a></a> then the user will miss out on the diagnostic +information and the encap-clash fix that <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-22016"></a></a> also provides. </div> +</p><!--l. 3394--><p class="noindent" > +</p><!--l. 3396--><p class="indent" > Word or letter ordering is specified by: +</p><!--l. 3397--><p class="indent" > <hr><div title="Definition"><a + id="dx1-22017"></a> <span class="cmtt-10">\@glsorder{</span>⟨<span class="cmitt-10">order</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 3053--><p class="noindent" > +</p><!--l. 3399--><p class="noindent" > where ⟨<span class="cmti-10">order</span>⟩ can be either <span class="cmtt-10">word </span>or <span class="cmtt-10">letter</span>. -</p><!--l. 3056--><p class="indent" > If <a +</p><!--l. 3402--><p class="indent" > If <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-21010"></a></a> should be used, the language and code page for each glossary is specified -by -</p><!--l. 3058--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\@xdylanguage</span><span -class="cmtt-9"> </span></span><a - id="dx1-21011"></a><span class="reversemarginpar"><span -class="cmtt-9">\@gls@codepage</span><span -class="cmtt-9"> </span></span><a - id="dx1-21012"></a> <span + id="dx1-22018"></a></a> should be used, the language and code page for each glossary is specified by +</p><!--l. 3404--><p class="indent" > <hr><div title="Definition"><a + id="dx1-22019"></a><a + id="dx1-22020"></a> <span class="cmtt-10">\@xdylanguage{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -6424,22 +7689,23 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 3061--><p class="noindent" > +</p><!--l. 3407--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ identifies the glossary, ⟨<span class="cmti-10">language</span>⟩ is the root language (e.g. <span class="cmtt-10">english</span>) and ⟨<span -class="cmti-10">code</span>⟩ is -the encoding (e.g. <span +class="cmti-10">code</span>⟩ is the encoding +(e.g. <span class="cmtt-10">utf8</span>). These commands are omitted if <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-21013"></a></a> should be -used. -</p><!--l. 3067--><p class="indent" > If <a + id="dx1-22021"></a></a> should be used. +</p><!--l. 3413--><p class="indent" > If <a href="#option1">Option 1</a> has been used, the <span -class="cmtt-10">.aux </span>file will contain -</p><!--l. 3069--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">aux</span><a + id="dx1-22022"></a> file will contain +</p><!--l. 3414--><p class="indent" > <hr><div title="Definition"><a + id="dx1-22023"></a> <span class="cmtt-10">\@gls@reference{</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -6447,1728 +7713,2483 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 3070--><p class="noindent" > -for every time an entry has been referenced. If <a +</p><!--l. 3416--><p class="noindent" > +for every time an entry has been referenced. + + +</p><!--l. 3419--><p class="noindent" > +</p> +<!--l. 3419--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.2 </span> <a + id="sec:notedev.labels"></a>Entry Labels</h4> +<!--l. 3422--><p class="noindent" >If you need to gather labels for auto-completion, the <span +class="cmss-10">writeglslabels</span><a + id="dx1-23001"></a> package option will create a file containing the +labels of all defined entries (regardless of whether or not the entry has been used in the document). The +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package also provides <span id="textcolor181"><span +class="cmss-10">docdef</span><span +class="cmtt-10">=</span><span +class="cmss-10">atom</span></span><a + id="dx1-23002"></a>, which will create the <span +class="cmtt-10">glsdefs</span><a + id="dx1-23003"></a> file but will act like +<span id="textcolor182"><span +class="cmss-10">docdef</span><span +class="cmtt-10">=</span><span +class="cmss-10">restricted</span></span><a + id="dx1-23004"></a>. +</p><!--l. 3429--><p class="noindent" > +</p> +<!--l. 3429--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.3 </span> <a + id="sec:notedev.bib2gls"></a>Bib2Gls</h4> +<!--l. 3432--><p class="noindent" ><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24001"></a></a></span>If <a href="#option4">Option 4</a> has been used, the <span -class="cmtt-10">.aux </span>file will -contain one or more instances of -</p><!--l. 3074--><p class="indent" > <hr><div title="Definition"><span -class="cmtt-10">\glsxtr@resource{</span>⟨<span +class="cmtt-10">aux</span><a + id="dx1-24002"></a> file will contain one or more instances of </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor183"><span +class="cmtt-10">\glsxtr@resource</span></span><a + id="dx1-24003"></a><span +class="cmtt-10">{</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">basename</span>⟩<span -class="cmtt-10">} </span></div><hr> -</p><!--l. 3075--><p class="noindent" > - - -</p> -<!--l. 3077--><p class="indent" > </div> -</p><!--l. 3077--><p class="noindent" ><a +class="cmtt-10">}</span> +</div> +</div> where ⟨<span +class="cmti-10">basename</span>⟩ is the basename of the <span +class="cmtt-10">glstex</span><a + id="dx1-24004"></a> file that needs to be created by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24005"></a></a>. If <span +class="cmtt-10">src=</span> +<span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">bib list</span>⟩<span +class="cmtt-10">} </span>isn’t present in ⟨<span +class="cmti-10">options</span>⟩ then ⟨<span +class="cmti-10">basename</span>⟩ also indicates the name of the associated <span +class="cmtt-10">bib</span><a + id="dx1-24006"></a> +file. +<!--l. 3442--><p class="indent" > For example, with <span +class="cmtt-10">arara</span><a + id="dx1-24007"></a> you can easily determine whether or not to run <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24008"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> bib2gls</span><span +class="cmtt-10"> if</span><span +class="cmtt-10"> found("aux",</span><span +class="cmtt-10"> "glsxtr@resource")</span> +</div> +</div> (It gets more complicated if both <span id="textcolor184"><span +class="cmtt-10">\glsxtr@resource</span></span><a + id="dx1-24009"></a> and <span +class="cmtt-10">\@istfilename </span>are present as that indicates the +hybrid <span id="textcolor185"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">alsoindex</span></span><a + id="dx1-24010"></a> option.) +<!--l. 3451--><p class="indent" > Remember that with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24011"></a></a>, the entries will never be defined on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call (because their +definitions are contained in the <span +class="cmtt-10">glstex</span><a + id="dx1-24012"></a> file created by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24013"></a></a>). You can also pick up labels from the records in +<span +class="cmtt-10">aux</span><a + id="dx1-24014"></a> file, which will be in the form: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor186"><span +class="cmtt-10">\glsxtr@record</span></span><a + id="dx1-24015"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">h-prefix</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">counter</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">format</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">loc</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> or (with <span id="textcolor187"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-24016"></a>) <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor188"><span +class="cmtt-10">\glsxtr@record@nameref</span></span><a + id="dx1-24017"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">href</span><span +class="cmitt-10"> prefix</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">counter</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">format</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">location</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">title</span>⟩<span +class="cmtt-10">}</span> +<span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">href</span><span +class="cmitt-10"> anchor</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">href</span><span +class="cmitt-10"> value</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> or (with <span +class="cmtt-10">\glssee</span>) <div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor189"><span +class="cmtt-10">\glsxtr@recordsee</span></span><a + id="dx1-24018"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">xr</span><span +class="cmitt-10"> list</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> You can also pick up the commands defined with <span id="textcolor190"><span +class="cmtt-10">\glsxtrnewglslike</span></span><a + id="dx1-24019"></a>, which are added to the <span +class="cmtt-10">aux</span><a + id="dx1-24020"></a> file for +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-24021"></a>’s</a> benefit: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor191"><span +class="cmtt-10">\@glsxtr@newglslike</span></span><a + id="dx1-24022"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label-prefix</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">cs</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> If <span id="textcolor192"><span +class="cmtt-10">\GlsXtrSetAltModifier</span></span><a + id="dx1-24023"></a> is used, then the modifier is identified with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor193"><span +class="cmtt-10">\@glsxtr@altmodifier</span></span><a + id="dx1-24024"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">character</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> Label prefixes (for the <span id="textcolor194"><span +class="cmtt-10">\dgls</span></span><a + id="dx1-24025"></a> set of commands) are identified with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor195"><span +class="cmtt-10">\@glsxtr@prefixlabellist</span></span><a + id="dx1-24026"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">list</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> + + +<!--l. 3484--><p class="indent" > </div> +</p><!--l. 3484--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">2. <a id="sec:pkgopts"></a>Package Options</h2> -</p><!--l. 3080--><p class="indent" > This section describes the available <span -class="cmss-10">glossaries </span>package options. You may omit the -<span -class="cmtt-10">=true </span>for boolean options. (For example, <span +</p><!--l. 3487--><p class="indent" > This section describes the available <span +class="cmss-10">glossaries </span>package options. You may omit the <span +class="cmtt-10">=true </span>for boolean options. +(For example, <span class="cmss-10">acronym</span><a - id="dx1-22001"></a> is equivalent to <span -class="cmss-10">acronym=true</span><a - id="dx1-22002"></a>). -The <a + id="dx1-25001"></a> is equivalent to <span +class="cmss-10">acronym</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-25002"></a>). +</p><!--l. 3491--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a> package has additional options described in the <span -class="cmss-10">glossaries-extra</span> -manual. -</p><!--l. 3086--><p class="indent" > <div class="important" title="Important Note"> Note that ⟨<span +class="cmss-10">glossaries-extra </span>manual. The extension +package also has some different default settings to the base package. Those that are available at the time of +writing are included here. Future versions of <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> may have additional package options or new values +for existing settings that aren’t listed here. </div> +</p><!--l. 3498--><p class="noindent" > +</p><!--l. 3500--><p class="indent" > <div class="important" title="Important Note"> Note that ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ package options can’t be passed via the document class options. -(This includes options where the ⟨<span +class="cmti-10">value</span>⟩ package options can’t be passed via the document class options. (This includes options +where the ⟨<span class="cmti-10">value</span>⟩ part may be omitted, such as <span class="cmss-10">acronym</span><a - id="dx1-22003"></a>.) -This is a general limitation not restricted to the <span -class="cmss-10">glossaries </span>package. Options that -aren’t ⟨<span + id="dx1-25003"></a>.) This is a general limitation not restricted to the +<span +class="cmss-10">glossaries </span>package. Options that aren’t ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ (such as <span class="cmss-10">makeindex</span><a - id="dx1-22004"></a>) may be passed via the document class options. -</div> -</p><!--l. 3093--><p class="noindent" > + id="dx1-25004"></a>) may be passed via the document class +options. </div> +</p><!--l. 3507--><p class="noindent" > </p> -<!--l. 3095--><p class="noindent" ><a +<!--l. 3509--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.1 </span> <a id="sec:pkgopts-general"></a>General Options</h3> - <dl class="description"><dt class="description"> -<a +<!--l. 3512--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-270002.1"></a><a id="pkgopt:nowarn"></a><span -class="cmssbx-10">nowarn</span><a - id="dx1-23001"></a> </dt><dd -class="description">This suppresses all warnings generated by the <span -class="cmss-10">glossaries </span>package. Don’t use this - option if you’re new to using <span -class="cmss-10">glossaries </span>as the warnings are designed to help detect - common mistakes (such as forgetting to use <span +class="cmss-10">nowarn</span></h4> +<!--l. 3512--><p class="noindent" >This suppresses all warnings generated by the <span +class="cmss-10">glossaries </span>package. Don’t use this option if you’re new to using +<span +class="cmss-10">glossaries </span>as the warnings are designed to help detect common mistakes (such as forgetting to use +<span class="cmtt-10">\makeglossaries</span><a - id="dx1-23002"></a>). Note that the - <span -class="cmss-10">debug=true</span><a - id="dx1-23003"></a> and <span -class="cmss-10">debug=showtargets</span><a - id="dx1-23004"></a> will override this option. - </dd><dt class="description"> -<a + id="dx1-27001"></a>). Note that if you use <span +class="cmss-10">debug</span><a + id="dx1-27002"></a> with any value other than <span +class="cmss-10">false </span>it will override this +option. +</p><!--l. 3519--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-280002.1"></a><a id="pkgopt:nolangwarn"></a><span -class="cmssbx-10">nolangwarn</span><a - id="dx1-23005"></a> </dt><dd -class="description">This suppresses the warning generated by a missing language module. - </dd><dt class="description"> -<a +class="cmss-10">nolangwarn</span></h4> +<!--l. 3519--><p class="noindent" >This suppresses the warning generated by a missing language module. +</p><!--l. 3522--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-290002.1"></a><a id="pkgopt:noredefwarn"></a><span -class="cmssbx-10">noredefwarn</span><a - id="dx1-23006"></a> </dt><dd -class="description">If you load <span -class="cmss-10">glossaries </span>with a class or another package that already defines - glossary related commands, by default <span -class="cmss-10">glossaries </span>will warn you that it’s redefining - those commands. If you are aware of the consequences of using <span -class="cmss-10">glossaries </span>with that - class or package and you don’t want to be warned about it, use this option to - suppress those warnings. Other warnings will still be issued unless you use the - <span +class="cmss-10">noredefwarn</span></h4> +<!--l. 3522--><p class="noindent" >If you load <span +class="cmss-10">glossaries </span>with a class or another package that already defines glossary related commands, by default +<span +class="cmss-10">glossaries </span>will warn you that it’s redefining those commands. If you are aware of the consequences of using +<span +class="cmss-10">glossaries </span>with that class or package and you don’t want to be warned about it, use this option to suppress those +warnings. Other warnings will still be issued unless you use the <span class="cmss-10">nowarn</span><a - id="dx1-23007"></a> option described above. - </dd><dt class="description"> -<a + id="dx1-29001"></a> option described above. (This option is +automatically switched on by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>.) + + +</p><!--l. 3532--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-300002.1"></a><a id="pkgopt:debug"></a><span -class="cmssbx-10">debug</span><a - id="dx1-23008"></a> </dt><dd -class="description">Introduced in version 4.24. The default setting is <span -class="cmss-10">debug=false</span><a - id="dx1-23009"></a>. This was a - boolean option but as from v4.32 it now accepts the values: <span +class="cmss-10">debug=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3532--><p class="noindent" >Introduced in version 4.24. The default setting is <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-30001"></a>. The following values are available: <span class="cmss-10">false</span>, <span -class="cmss-10">true </span>and - <span -class="cmss-10">showtargets</span>. If no value is given, <span -class="cmss-10">debug=true</span><a - id="dx1-23010"></a> is assumed. Both <span -class="cmss-10">debug=true</span><a - id="dx1-23011"></a> - and <span -class="cmss-10">debug=showtargets</span><a - id="dx1-23012"></a> switch on the debug mode (and will automatically - cancel the <span +class="cmss-10">true</span>, +<span +class="cmss-10">showtargets </span>(v4.32+) and <span +class="cmss-10">showaccsupp </span>(v4.45+). If no value is given, <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-30002"></a> is assumed. +</p><!--l. 3538--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides extra values <span id="textcolor196"><span +class="cmss-10">showwrgloss</span></span><a + id="dx1-30003"></a>, that may be used to show where the indexing +is occurring, and <span id="textcolor197"><span +class="cmss-10">all</span></span><a + id="dx1-30004"></a>, which switches on all debugging options. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. +</div> +</p><!--l. 3544--><p class="noindent" > +</p><!--l. 3546--><p class="indent" > All values other than <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-30005"></a> switch on the debug mode (and will automatically cancel the <span class="cmss-10">nowarn</span><a - id="dx1-23013"></a> option). The <span -class="cmss-10">debug=showtargets</span><a - id="dx1-23014"></a> option will additionally - use - <!--l. 3126--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsshowtarget</span><span -class="cmtt-9"> </span></span><a - id="dx1-23015"></a> <span + id="dx1-30006"></a> +option). The <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">showtargets</span><a + id="dx1-30007"></a> option will additionally use: +</p><!--l. 3549--><p class="indent" > <hr><div title="Definition"><a + id="dx1-30008"></a> <span class="cmtt-10">\glsshowtarget{</span>⟨<span class="cmitt-10">target name</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3128--><p class="noindent" > - to show the hypertarget or hyperlink name in the margin when <span -class="cmtt-10">\glsdohypertarget </span>is - used by commands like <span +</p><!--l. 3551--><p class="noindent" > +to show the hypertarget or hyperlink name when <span +class="cmtt-10">\glsdohypertarget </span>is used by commands like +<span class="cmtt-10">\glstarget </span>and when <span -class="cmtt-10">\glsdohyperlink </span>is used by commands - - - like <span -class="cmtt-10">\gls</span>. This puts the information in the margin using <span -class="cmtt-10">\marginpar</span><a - id="dx1-23016"></a> unless math mode - or inner mode are detected, in which case it puts the information in line enclosed by - square brackets. The <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package provides an additional setting that may be - used to show where the indexing is occurring. See the <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> manual for further - details. - </p><!--l. 3139--><p class="noindent" >The purpose of the debug mode can be demonstrated with the following example - document: - - +class="cmtt-10">\glsdohyperlink </span>is used by commands like <span +class="cmtt-10">\gls</span>. In math mode or inner +mode, this puts the target name in square brackets just before the link or anchor. In outer mode it +uses: +</p><!--l. 3557--><p class="indent" > <hr><div title="Definition"><a + id="dx1-30009"></a> <span +class="cmtt-10">\glsshowtargetouter{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 3559--><p class="noindent" > +which by default places the target name in the margin. The font is given by: +</p><!--l. 3562--><p class="indent" > <hr><div title="Definition"><a + id="dx1-30010"></a> <span +class="cmtt-10">\glsshowtargetfont </span></div><hr> +</p><!--l. 3564--><p class="noindent" > +The default definition is <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ttfamily\small</span></span></span>. This command is included in the definition of +<span +class="cmtt-10">\glsshowtargetouter</span>, so if you want to redefine that command remember to include the font. For +example: + + </p> - <div class="verbatim" id="verbatim-70"> - \documentclass{article} -  <br />\usepackage{glossaries} -  <br />\newglossaryentry{sample1}{name={sample1}, -  <br />  description={example}} -  <br />\newglossaryentry{sample2}{name={sample2}, -  <br />  description={example}} -  <br />\glsadd{sample2} -  <br />\makeglossaries -  <br />\begin{document} -  <br />\gls{sample1}. -  <br />\printglossaries -  <br />\end{document} + <div class="verbatim" id="verbatim-63"> +\renewcommand*{\glsshowtargetouter}[1]{% + <br /> {\glsshowtargetfont [#1]}} +</div> +<!--l. 3572--><p class="nopar" > +</p><!--l. 3574--><p class="indent" > Similarly, the <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">showaccsupp</span><a + id="dx1-30011"></a> will add the accessibility support information using: +</p><!--l. 3576--><p class="indent" > <hr><div title="Definition"><a + id="dx1-30012"></a> <span +class="cmtt-10">\glsshowaccsupp{</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">tag</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">replacement text</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 3578--><p class="noindent" > +This internally uses <span +class="cmtt-10">\glsshowtarget</span><a + id="dx1-30013"></a>. This option is provided for use with <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-30014"></a>. +</p><!--l. 3582--><p class="indent" > The purpose of the debug mode can be demonstrated with the following example document: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /><span +class="cmtt-10">\usepackage{glossaries}</span> +<br /><span +class="cmtt-10">\newglossaryentry{sample1}{name={sample1},description={example}}</span> +<br /><span +class="cmtt-10">\newglossaryentry{sample2}{name={sample2},description={example}}</span> +<br /><strong><span +class="cmtt-10">\glsadd</span><a + id="dx1-30015"></a></strong><span +class="cmtt-10">{sample2}%</span><span +class="cmtt-10"> <-</span><span +class="cmtt-10"> does</span><span +class="cmtt-10"> nothing</span><span +class="cmtt-10"> here</span> +<br /><strong><span +class="cmtt-10">\makeglossaries</span><a + id="dx1-30016"></a></strong> +<br /><span +class="cmtt-10">\begin{document}</span> +<br /><span +class="cmtt-10">\gls{sample1}.</span> +<br /><span +class="cmtt-10">\printglossaries</span> +<br /><span +class="cmtt-10">\end{document}</span> </div> - <!--l. 3154--><p class="nopar" > In this case, only the <span +</div> In this case, only the <span class="cmtt-10">sample1 </span>entry has been indexed, even though <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsadd{sample2}</span></span></span> - appears in the source code. This is because <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsadd{sample2}</span></span></span> has been used before the - associated file is opened by <span +class="cmtt-10">\glsadd{sample2}</span></span></span> appears in the source +code. This is because <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsadd{sample2}</span></span></span> has been used before the associated file is opened by +<span class="cmtt-10">\makeglossaries</span><a - id="dx1-23017"></a>. Since the file isn’t open yet, the - information can’t be written to it, which is why the <span -class="cmtt-10">sample2 </span>entry doesn’t appear in - the glossary. - </p><!--l. 3162--><p class="noindent" >This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user - to want to use <span -class="cmss-10">glossaries </span>to format the entries (e.g. abbreviation expansion) but not - display any lists of terms, abbreviations, symbols etc. Without <span -class="cmtt-10">\makeglossaries </span>the - indexing is suppressed but, other than that, commands like <span -class="cmtt-10">\gls </span>behave as - usual. It’s also possible that the user may want to temporarily comment out - <span + id="dx1-30017"></a>. Since the file isn’t open yet, the information can’t be written to it, which is why the <span +class="cmtt-10">sample2</span> +entry doesn’t appear in the glossary. +<!--l. 3603--><p class="indent" > Without <span +class="cmtt-10">\makeglossaries </span>the indexing is suppressed with Options <a +href="#option2">2</a> and <a +href="#option3">3</a> but, other than that, +commands like <span +class="cmtt-10">\gls </span>behave as usual. +</p><!--l. 3606--><p class="indent" > This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use +<span +class="cmss-10">glossaries </span>to format the entries (e.g. abbreviation expansion) but not display any lists of terms, abbreviations, +symbols etc (or the user may prefer to use the unsorted Options <a +href="#option5">5</a> or <a +href="#option6">6</a>). It’s also possible that the user may +want to temporarily comment out <span class="cmtt-10">\makeglossaries </span>in order to suppress the indexing while working on a draft - version to speed compilation. Therefore <span -class="cmtt-10">\makeglossaries </span>can’t be used to - enable <span -class="cmtt-10">\newglossaryentry </span>and <span -class="cmtt-10">\glsadd</span>. They must be enabled by default. (It - does, however, enable the <span -class="cmss-10">see</span><a - id="dx1-23018"></a> key as that’s a more common problem. See - below.) - </p><!--l. 3176--><p class="noindent" >The debug mode, enabled with the <span +version to speed compilation, or the user may prefer to use Options <a +href="#option1">1</a> or <a +href="#option4">4</a> for indexing, which don’t use +<span +class="cmtt-10">\makeglossaries</span>. +</p><!--l. 3616--><p class="indent" > Therefore <span +class="cmtt-10">\makeglossaries </span>can’t be used to enable <span +class="cmtt-10">\newglossaryentry </span>and commands like <span +class="cmtt-10">\gls </span>and +<span +class="cmtt-10">\glsadd</span>. These commands must be enabled by default. (It does, however, enable the <span +class="cmtt-10">see</span><a + id="dx1-30018"></a> key as that’s a more +common problem. See below.) +</p><!--l. 3621--><p class="indent" > The debug mode, enabled with the <span class="cmss-10">debug</span><a - id="dx1-23019"></a> option, - - + id="dx1-30019"></a> option, + + </p> - <div class="verbatim" id="verbatim-71"> - \usepackage[debug]{glossaries} + <div class="verbatim" id="verbatim-64"> +\usepackage[debug]{glossaries} </div> - <!--l. 3179--><p class="nopar" > will write information to the log file when the indexing can’t occur because the - associated file isn’t open. The message is written in the form - </p><div class="quote"> - <!--l. 3184--><p class="noindent" >Package glossaries Info: wrglossary(⟨<span +<!--l. 3624--><p class="nopar" > will write information to the log file when the indexing can’t occur because the associated file isn’t open. The +message is written in the form + </p><div class="quote"> + <!--l. 3629--><p class="noindent" >Package glossaries Info: wrglossary(⟨<span class="cmti-10">type</span>⟩)(⟨<span -class="cmti-10">text</span>⟩) on input line ⟨<span -class="cmti-10">line</span> - <span -class="cmti-10">number</span>⟩.</p></div> - <!--l. 3187--><p class="noindent" >where ⟨<span +class="cmti-10">text</span>⟩) on input line ⟨<span +class="cmti-10">line number</span>⟩.</p></div> +<!--l. 3632--><p class="noindent" >where ⟨<span class="cmti-10">type</span>⟩ is the glossary label and ⟨<span -class="cmti-10">text</span>⟩ is the line of text that would’ve been written to - the associated file if it had been open. So if any entries haven’t appeared in the glossary - but you’re sure you used commands like <span -class="cmtt-10">\glsadd </span>or <span -class="cmtt-10">\glsaddall</span>, try switching - on the <span +class="cmti-10">text</span>⟩ is the line of text that would’ve been written to the associated file if it had +been open. So if any entries haven’t appeared in the glossary but you’re sure you used commands like <span +class="cmtt-10">\glsadd</span> +or <span +class="cmtt-10">\glsaddall</span>, try switching on the <span class="cmss-10">debug</span><a - id="dx1-23020"></a> option and see if any information has been written to the log - file. - </p></dd><dt class="description"> -<a - id="pkgopt:seenoindex"></a><span -class="cmssbx-10">seenoindex</span><a - id="dx1-23021"></a> </dt><dd -class="description">Introduced in version 4.24, this option may take one of three values: <span -class="cmss-10">error</span>, <span -class="cmss-10">warn </span>or - <span -class="cmss-10">ignore</span>. The <span -class="cmss-10">see</span><a - id="dx1-23022"></a> key automatically indexes the cross-referenced entry using <span -class="cmtt-10">\glsadd</span>. This - means that it suffers from the same problem as the above. If used before - the relevant glossary file has been opened, the indexing can’t be performed. - Since this is easy to miss, the <span -class="cmss-10">glossaries </span>package by default issues an error - message if the <span -class="cmss-10">see</span><a - id="dx1-23023"></a> key is used before <span -class="cmtt-10">\makeglossaries</span>. This option allows - you to change the error into just a warning (<span -class="cmss-10">seenoindex=warn</span><a - id="dx1-23024"></a>) or ignore it - (<span -class="cmss-10">seenoindex=ignore</span><a - id="dx1-23025"></a>) if, for example, you want to temporarily comment out - <span -class="cmtt-10">\makeglossaries </span>to speed up the compilation of a draft document by omitting the - indexing. - </dd><dt class="description"> -<a - id="pkgopt:nomain"></a><span -class="cmssbx-10">nomain</span><a - id="dx1-23026"></a> </dt><dd -class="description">This suppresses the creation of the main glossary and associated <span -class="cmtt-10">.glo </span>file, if - unrequired. Note that if you use this option, you must create another glossary in which - to put all your entries (either via the <span -class="cmss-10">acronym</span><a - id="dx1-23027"></a> (or <span -class="cmss-10">acronyms</span><a - id="dx1-23028"></a>) package option described in - <a -href="#sec:pkgopts-acronym"><span -class="tcrm-1000">§</span>2.5 </a><a -href="#sec:pkgopts-acronym">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a> or via the <span -class="cmss-10">symbols</span><a - id="dx1-23029"></a>, <span -class="cmss-10">numbers</span><a - id="dx1-23030"></a> or <span -class="cmss-10">index</span><a - id="dx1-23031"></a> options described - in <a -href="#sec:pkgopts-other"><span -class="tcrm-1000">§</span>2.6 </a><a -href="#sec:pkgopts-other">Other Options<!--tex4ht:ref: sec:pkgopts-other --></a> or via <span -class="cmtt-10">\newglossary</span><a - id="dx1-23032"></a> described in <a -href="#sec:newglossary"><span -class="tcrm-1000">§</span>12 </a><a -href="#sec:newglossary">Defining New - Glossaries<!--tex4ht:ref: sec:newglossary --></a>). - <!--l. 3218--><p class="noindent" ><div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a -href="#glo:makeglossaries"><span -class="cmtt-10">makeglossaries</span><a - id="dx1-23033"></a></a> will - produce a warning. </div> - </p><!--l. 3221--><p class="noindent" > - </p><div class="alltt"> - - - <div class="obeylines-v"> - <span -class="cmtt-10">Warning:</span><span -class="cmtt-10"> File</span><span -class="cmtt-10"> '</span><span -class="cmitt-10">filename</span><span -class="cmtt-10">.glo'</span><span -class="cmtt-10"> is</span><span -class="cmtt-10"> empty.</span> - <br /><span -class="cmtt-10">Have</span><span -class="cmtt-10"> you</span><span -class="cmtt-10"> used</span><span -class="cmtt-10"> any</span><span -class="cmtt-10"> entries</span><span -class="cmtt-10"> defined</span><span -class="cmtt-10"> in</span><span -class="cmtt-10"> glossary</span> - <br /><span -class="cmtt-10">'main'?</span> - <br /><span -class="cmtt-10">Remember</span><span -class="cmtt-10"> to</span><span -class="cmtt-10"> use</span><span -class="cmtt-10"> package</span><span -class="cmtt-10"> option</span><span -class="cmtt-10"> 'nomain'</span><span -class="cmtt-10"> if</span> - <br /><span -class="cmtt-10">you</span><span -class="cmtt-10"> don't</span><span -class="cmtt-10"> want</span><span -class="cmtt-10"> to</span><span -class="cmtt-10"> use</span><span -class="cmtt-10"> the</span><span -class="cmtt-10"> main</span><span -class="cmtt-10"> glossary.</span> -</div> - </div> If you did actually want to use the main glossary and you see this warning, check - that you have referenced the entries in that glossary via commands such as - <span -class="cmtt-10">\gls</span><a - id="dx1-23034"></a>. - </dd><dt class="description"> -<a - id="pkgopt:sanitizesort"></a><span -class="cmssbx-10">sanitizesort</span><a - id="dx1-23035"></a> </dt><dd -class="description">This is a boolean option that determines whether or not to <a -href="#glo:sanitize">sanitize<a - id="dx1-23036"></a></a> the sort - value when writing to the external glossary file. For example, suppose you define an - entry as follows: - - - <div class="verbatim" id="verbatim-72"> - \newglossaryentry{hash}{name={\#},sort={#}, -  <br /> description={hash symbol}} -</div> - <!--l. 3240--><p class="nopar" > The sort value (<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">#</span></span></span>) must be sanitized before writing it to the glossary file, otherwise - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> will try to interpret it as a parameter reference. If, on the other hand, you - want the sort value expanded, you need to switch off the sanitization. For example, - suppose you do: - - -</p> - <div class="verbatim" id="verbatim-73"> - \newcommand{\mysortvalue}{AAA} -  <br />\newglossaryentry{sample}{% -  <br />  name={sample}, -  <br />  sort={\mysortvalue}, -  <br />  description={an example}} -</div> - <!--l. 3252--><p class="nopar" > and you actually want <span -class="cmtt-10">\mysortvalue </span>expanded, so that the entry is sorted according - to <span -class="cmtt-10">AAA</span>, then use the package option <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-23037"></a>. - </p><!--l. 3257--><p class="noindent" >The default for Options <a + id="dx1-30020"></a> option and see if any information has been written to the log +file. +</p><!--l. 3639--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-310002.1"></a><a + id="pkgopt:savewrites"></a><span +class="cmss-10">savewrites=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3639--><p class="noindent" >This is a boolean option to minimise the number of write registers used by the <span +class="cmss-10">glossaries </span>package. The default is +<span +class="cmss-10">savewrites</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-31001"></a>. With Options <a href="#option2">2</a> and <a -href="#option3">3</a> is <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-23038"></a>, and the default for <a -href="#option1">Option 1</a> is - <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-23039"></a>. - </p></dd><dt class="description"> -<a - id="pkgopt:esclocations"></a><span -class="cmssbx-10">esclocations</span><a - id="dx1-23040"></a> </dt><dd -class="description">This is a boolean option. (The default is <span -class="cmss-10">esclocations=true</span><a - id="dx1-23041"></a>, but - <span -class="cmtt-10">\makenoidxglossaries</span><a - id="dx1-23042"></a> changes it to <span -class="cmss-10">esclocations=false</span><a - id="dx1-23043"></a>.) Both <a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-23044"></a></a> and <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-23045"></a></a> - are fussy about the location formats (<a -href="#glo:makeindex"><span -class="cmtt-10">makeindex</span><a - id="dx1-23046"></a></a> more so than <a -href="#glo:xindy"><span -class="cmtt-10">xindy</span><a - id="dx1-23047"></a></a>) so the <span -class="cmss-10">glossaries</span> - 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 <span class="TEX">T<span -class="E">E</span>X</span>’s asynchronous - output routine, which can go wrong and also adds to the complexity of the document - build. - <!--l. 3271--><p class="noindent" >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 <span -class="cmss-10">esclocations=false</span><a - id="dx1-23048"></a> to avoid the complex escaping of location values. - (See “Writing information to associated files” in the documented code for further - details.) - </p></dd><dt class="description"> +href="#option3">3</a>, one write register is required per (non-ignored) glossary and one for the +style file. +</p><!--l. 3645--><p class="indent" > With all options except Options <a +href="#option1">1</a> and <a +href="#option4">4</a>, another write register is required if the <span +class="cmtt-10">docdefs</span><a + id="dx1-31002"></a> file is needed to +save document definitions. With both Options <a +href="#option1">1</a> and <a +href="#option4">4</a>, no write registers are required (document definitions +aren’t permitted and indexing information is written to the <span +class="cmtt-10">aux</span><a + id="dx1-31003"></a> file). If you really need document definitions +but you want to minimise the number of write registers then consider using <span id="textcolor198"><span +class="cmss-10">docdef</span><span +class="cmtt-10">=</span><span +class="cmss-10">restricted</span></span><a + id="dx1-31004"></a> with <a - id="pkgopt:savewrites"></a><span -class="cmssbx-10">savewrites</span><a - id="dx1-23049"></a> </dt><dd -class="description">This is a boolean option to minimise the number of write registers used by the - <span -class="cmss-10">glossaries </span>package. (Default is <span -class="cmss-10">savewrites=false</span><a - id="dx1-23050"></a>.) 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 <span +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. +</p><!--l. 3654--><p class="indent" > 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 <span class="cmss-10">savewrites</span><a - id="dx1-23051"></a> 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. - <!--l. 3288--><p class="noindent" ><div class="important" title="Important Note"> This option can significantly slow document compilation and may cause the indexing to - fail. Page numbers in the <a + id="dx1-31005"></a> 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. +</p><!--l. 3662--><p class="indent" > <div class="important" title="Important Note"> This option can significantly slow document compilation and may cause the indexing to fail. Page numbers +in the <a href="#glo:numberlist">number list<a - id="dx1-23052"></a></a> will be incorrect on page boundaries due - to <span class="TEX">T<span -class="E">E</span>X</span>’s asynchronous output routine. As an alternative, you can use the - <span + id="dx1-31006"></a></a> will be incorrect on page boundaries due to <span class="TEX">T<span +class="E">E</span>X</span>’s asynchronous output routine. As an +alternative, you can use the <span class="cmss-10">scrwfile</span><a - id="dx1-23053"></a> package (part of the KOMA-Script bundle) and not use this option. - </div> - </p><!--l. 3294--><p class="noindent" > - - - </p><!--l. 3296--><p class="noindent" >You can also reduce the number of write registers by using Options <a -href="#option1">1</a> or <a -href="#option4">4</a> or by - ensuring you define all your glossary entries in the preamble. - </p><!--l. 3300--><p class="noindent" ><div class="important" title="Important Note"> If you want to use <span class="TEX">T<span + id="dx1-31007"></a> package (part of the KOMA-Script bundle) and not use this option. +</div> +</p><!--l. 3668--><p class="noindent" > +</p><!--l. 3670--><p class="indent" > By way of comparison, <span +class="cmtt-10">sample-multi2.tex </span>provided with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-31008"></a></a> has a total of +15 glossaries. With Options <a +href="#option2">2</a> or <a +href="#option3">3</a>, this would require 46 associated files and 16 write +registers.<span class="footnote-mark"><a +href="#fn1x2" id="fn1x2-bk"><sup class="textsuperscript">2.1</sup></a></span><a + id="x1-31009f1"></a> +With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-31011"></a></a>, no write registers are required and there are only 10 associated files for that particular document +(9 resource files and 1 transcript file). + + +</p><!--l. 3680--><p class="indent" > <span class="warningsymbol">⚠</span> If you want to use <span class="TEX">T<span class="E">E</span>X</span>’s <span class="cmtt-10">\write18</span><a - id="dx1-23054"></a> mechanism to call <a + id="dx1-31012"></a> mechanism to call <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-23055"></a></a> or <a + id="dx1-31013"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-23056"></a></a> from - your document and use <span + id="dx1-31014"></a></a> from your document and use +<span class="cmss-10">savewrites</span><a - id="dx1-23057"></a>, you must create the external files with - <span + id="dx1-31015"></a>, you must create the external files with <span class="cmtt-10">\glswritefiles </span>before you call <span class="cmtt-10">makeindex</span><a - id="dx1-23058"></a>/<span + id="dx1-31016"></a>/<span class="cmtt-10">xindy</span><a - id="dx1-23059"></a>. Also set <span -class="cmtt-10">\glswritefiles </span>to - nothing or <span + id="dx1-31017"></a>. Also set +<span +class="cmtt-10">\glswritefiles </span>to nothing or <span class="cmtt-10">\relax </span>before the end of the document to avoid rewriting the files. For - example: - - -</p> - <div class="verbatim" id="verbatim-74"> - \glswritefiles -  <br />\write18{makeindex -s \istfilename\space -  <br />-t \jobname.glg -o \jobname.gls \jobname} -  <br />\let\glswritefiles\relax -</div> - <!--l. 3312--><p class="nopar" > </div> - </p><!--l. 3313--><p class="noindent" > - In general, this package option is best avoided. - </p></dd><dt class="description"> -<a +example: + + +</p> + <div class="verbatim" id="verbatim-65"> +\glswritefiles + <br />\write18{makeindex -s \istfilename\space + <br />-t \jobname.glg -o \jobname.gls \jobname} + <br />\let\glswritefiles\relax +</div> +<!--l. 3692--><p class="nopar" > +</p><!--l. 3694--><p class="noindent" >In general, this package option is best avoided. +</p><!--l. 3697--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-320002.1"></a><a id="pkgopt:translate"></a><span -class="cmssbx-10">translate</span><a - id="dx1-23060"></a> </dt><dd -class="description">This can take the following values: - <dl class="description"><dt class="description"> - <span -class="cmssbx-10">translate=true</span><a - id="dx1-23061"></a> </dt><dd +class="cmss-10">translate=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3697--><p class="noindent" >This can take the following values: + </p><dl class="description"><dt class="description"> +<span +class="cmssbx-10">true</span><a + id="dx1-32001"></a> </dt><dd class="description">If <span class="cmss-10">babel</span><a - id="dx1-23062"></a> has been loaded and the <span + id="dx1-32002"></a> has been loaded and the <span class="cmss-10">translator</span><a - id="dx1-23063"></a> package is installed, - <span + id="dx1-32003"></a> package is installed, <span class="cmss-10">translator</span><a - id="dx1-23064"></a> will be loaded and the translations will be provided by the <span + id="dx1-32004"></a> will be loaded and the + translations will be provided by the <span class="cmss-10">translator</span><a - id="dx1-23065"></a> - package interface. You can modify the translations by providing your own - dictionary. If the <span + id="dx1-32005"></a> package interface. You can modify the translations + by providing your own dictionary. If the <span class="cmss-10">translator</span><a - id="dx1-23066"></a> package isn’t installed and <span + id="dx1-32006"></a> package isn’t installed and <span class="cmss-10">babel</span><a - id="dx1-23067"></a> is loaded, the - <span + id="dx1-32007"></a> is loaded, + the <span class="cmss-10">glossaries-babel</span><a - id="dx1-23068"></a> package will be loaded and the translations will be provided - using <span -class="cmss-10">babel</span>’s <span + id="dx1-32008"></a> package will be loaded and the translations will be provided using <span +class="cmss-10">babel</span>’s + <span class="cmtt-10">\addto\caption</span>⟨<span -class="cmti-10">language</span>⟩ mechanism. If <span +class="cmti-10">language</span>⟩ mechanism. If <span class="cmss-10">polyglossia</span><a - id="dx1-23069"></a> has been - loaded, <span + id="dx1-32009"></a> has been loaded, <span class="cmss-10">glossaries-polyglossia</span><a - id="dx1-23070"></a> will be loaded. - </dd><dt class="description"> - <span -class="cmssbx-10">translate=false</span><a - id="dx1-23071"></a> </dt><dd + id="dx1-32010"></a> will be + loaded. + </dd><dt class="description"> +<span +class="cmssbx-10">false</span><a + id="dx1-32011"></a> </dt><dd class="description">Don’t provide translations, even if <span class="cmss-10">babel</span><a - id="dx1-23072"></a> or <span + id="dx1-32012"></a> or <span class="cmss-10">polyglossia</span><a - id="dx1-23073"></a> has been - loaded. (Note that <span + id="dx1-32013"></a> has been loaded. (Note that <span class="cmss-10">babel</span><a - id="dx1-23074"></a> provides the command <span + id="dx1-32014"></a> provides + the command <span class="cmtt-10">\glossaryname</span><a - id="dx1-23075"></a> so that will - still be translated if you have loaded <span + id="dx1-32015"></a> so that will still be translated if you have loaded <span class="cmss-10">babel</span><a - id="dx1-23076"></a>.) - </dd><dt class="description"> - <span -class="cmssbx-10">translate=babel</span><a - id="dx1-23077"></a> </dt><dd + id="dx1-32016"></a>.) + </dd><dt class="description"> +<span +class="cmssbx-10">babel</span><a + id="dx1-32017"></a> </dt><dd class="description">Don’t load the <span class="cmss-10">translator</span><a - id="dx1-23078"></a> package. Instead load <span + id="dx1-32018"></a> package. Instead load <span class="cmss-10">glossaries-babel</span><a - id="dx1-23079"></a>. - <!--l. 3339--><p class="noindent" ><div class="important" title="Important Note"> I recommend you use <span -class="cmss-10">translate=babel</span><a - id="dx1-23080"></a> if you have any problems with the - translations or with PDF bookmarks, but to maintain backward compatibility, if - <span + id="dx1-32019"></a>. + <!--l. 3720--><p class="noindent" ><div class="important" title="Important Note"> I recommend you use <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-32020"></a> if you have any problems with the translations or with PDF + bookmarks, but to maintain backward compatibility, if <span class="cmss-10">babel</span><a - id="dx1-23081"></a> has been loaded the default is <span -class="cmss-10">translate=true</span><a - id="dx1-23082"></a>. </div> - </p><!--l. 3344--><p class="noindent" > + id="dx1-32021"></a> has been loaded the default is <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-32022"></a>. + </div> + </p><!--l. 3725--><p class="noindent" > </p> - </dd></dl> - <!--l. 3348--><p class="noindent" >If <span + </dd></dl> +<!--l. 3729--><p class="indent" > If <span class="cmss-10">translate</span><a - id="dx1-23083"></a> is specified without a value, <span -class="cmss-10">translate=true</span><a - id="dx1-23084"></a> is assumed. If <span + id="dx1-32023"></a> is specified without a value, <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-32024"></a> is assumed. If <span class="cmss-10">translate</span><a - id="dx1-23085"></a> isn’t - specified, <span -class="cmss-10">translate=true</span><a - id="dx1-23086"></a> is assumed if <span + id="dx1-32025"></a> isn’t specified, +<span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-32026"></a> is assumed if <span class="cmss-10">babel</span><a - id="dx1-23087"></a>, <span + id="dx1-32027"></a>, <span class="cmss-10">polyglossia</span><a - id="dx1-23088"></a> or <span + id="dx1-32028"></a> or <span class="cmss-10">translator</span><a - id="dx1-23089"></a> have been loaded. - Otherwise <span -class="cmss-10">translate=false</span><a - id="dx1-23090"></a> is assumed. - </p><!--l. 3354--><p class="noindent" >See <a -href="#sec:fixednames"><span -class="tcrm-1000">§</span>1.4.1 </a><a + id="dx1-32029"></a> have been loaded. Otherwise <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-32030"></a> is +assumed. +</p><!--l. 3735--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, if <span +class="cmss-10">babel</span><a + id="dx1-32031"></a> is detected then <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">babel</span><a + id="dx1-32032"></a> is automatically passed to the base <span +class="cmss-10">glossaries</span><a + id="dx1-32033"></a> +package. </div> + + +</p><!--l. 3739--><p class="noindent" > +</p><!--l. 3741--><p class="indent" > See <a +href="#sec:fixednames">§1.3.1 </a><a href="#sec:fixednames">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details. - - - </p></dd><dt class="description"> -<a +</p><!--l. 3743--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-330002.1"></a><a id="pkgopt:notranslate"></a><span -class="cmssbx-10">notranslate</span><a - id="dx1-23091"></a> </dt><dd -class="description">This is equivalent to <span -class="cmss-10">translate=false</span><a - id="dx1-23092"></a> and may be passed via the document class - options. - </dd><dt class="description"> -<a - id="pkgopt:nohypertypes"></a><span -class="cmssbx-10">nohypertypes</span><a - id="dx1-23093"></a> </dt><dd -class="description">Use this option if you have multiple glossaries and you want to suppress the - entry hyperlinks for a particular glossary or glossaries. The value of this option should - be a comma-separated list of glossary types where <span -class="cmtt-10">\gls</span><a - id="dx1-23094"></a> etc shouldn’t have hyperlinks - by default. Make sure you enclose the value in braces if it contains any commas. - Example: - - - <div class="verbatim" id="verbatim-75"> - \usepackage[acronym,nohypertypes={acronym,notation}] -  <br />  {glossaries} -  <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} -</div> - <!--l. 3370--><p class="nopar" > The values must be fully expanded, so <span -class="cmbx-10">don’t </span>try <span -class="cmtt-10">nohypertypes=\acronymtype</span><a - id="dx1-23095"></a>. You - may also use - </p><!--l. 3374--><p class="noindent" ><hr><div title="Definition"><span -class="cmtt-10">\GlsDeclareNoHyperList</span><a - id="dx1-23096"></a><span -class="cmtt-10">{</span>⟨<span -class="cmitt-10">list</span>⟩<span -class="cmtt-10">} </span></div><hr> - </p><!--l. 3375--><p class="noindent" > - instead or additionally. See <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details. - </p></dd><dt class="description"> -<a +class="cmss-10">notranslate</span></h4> +<!--l. 3743--><p class="noindent" >This is equivalent to <span +class="cmss-10">translate</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-33001"></a> and may be passed via the document class options. +</p><!--l. 3747--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-340002.1"></a><a id="pkgopt:hyperfirst"></a><span -class="cmssbx-10">hyperfirst</span><a - id="dx1-23097"></a> </dt><dd -class="description">This is a boolean option that specifies whether each term has a hyperlink on <a -href="#glo:firstuse">first - use</a>. The default is <span -class="cmss-10">hyperfirst=true</span><a - id="dx1-23098"></a> (terms on <a -href="#glo:firstuse">first use</a> have a hyperlink, unless - explicitly suppressed using starred versions of commands such as <span +class="cmss-10">hyperfirst=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3747--><p class="noindent" >This is a boolean option that specifies whether each term has a hyperlink on <a +href="#glo:firstuse">first use</a>. The default is +<span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-34001"></a> (terms on <a +href="#glo:firstuse">first use</a> have a hyperlink, unless explicitly suppressed using starred versions of +commands such as <span class="cmtt-10">\gls*</span><a - id="dx1-23099"></a> or - by identifying the glossary with <span + id="dx1-34002"></a> or by identifying the glossary with <span class="cmss-10">nohypertypes</span><a - id="dx1-23100"></a>, described above). Note that - <span + id="dx1-34003"></a>, described above). Note that +<span class="cmss-10">nohypertypes</span><a - id="dx1-23101"></a> overrides <span -class="cmss-10">hyperfirst=true</span><a - id="dx1-23102"></a>. This option only affects commands that - check the <a -href="#glo:firstuseflag">first use flag</a>, such as the <a + id="dx1-34004"></a> overrides <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-34005"></a>. This option only affects commands that check the <a +href="#glo:firstuseflag">first use flag</a>, such as +the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> commands (for example, <span class="cmtt-10">\gls</span><a - id="dx1-23103"></a> or - <span + id="dx1-34006"></a> or <span class="cmtt-10">\glsdisp</span><a - id="dx1-23104"></a>), but not the <a + id="dx1-34007"></a>), but not the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands (for example, <span +class="cmtt-10">\glstext</span>-like</a> commands (for example, +<span class="cmtt-10">\glslink</span><a - id="dx1-23105"></a> or - <span + id="dx1-34008"></a> or <span class="cmtt-10">\glstext</span><a - id="dx1-23106"></a>). - <!--l. 3391--><p class="noindent" >The <span + id="dx1-34009"></a>). +</p><!--l. 3759--><p class="indent" > The <span class="cmss-10">hyperfirst</span><a - id="dx1-23107"></a> setting applies to all glossary types (unless identified by <span + id="dx1-34010"></a> setting applies to all glossary types (unless identified by <span class="cmss-10">nohypertypes</span><a - id="dx1-23108"></a> or - defined with <span + id="dx1-34011"></a> or defined +with <span class="cmtt-10">\newignoredglossary</span><a - id="dx1-23109"></a>). It can be overridden on an individual basis by - explicitly setting the <span -class="cmss-10">hyper</span><a - id="dx1-23110"></a> key when referencing an entry (or by using the plus or - starred version of the referencing command). - </p><!--l. 3398--><p class="noindent" >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 <span -class="cmss-10">hyperfirst=false</span><a - id="dx1-23111"></a> - and apply <span + id="dx1-34012"></a>). It can be overridden on an individual basis by explicitly setting the +<span +class="cmtt-10">hyper</span><a + id="dx1-34013"></a> key when referencing an entry (or by using the plus or starred version of the referencing +command). +</p><!--l. 3766--><p class="indent" > 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 <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-34014"></a> and apply <span class="cmtt-10">\glsunsetall </span>to all the regular (non-acronym) glossaries. For - example: - - +example: + + </p> - <div class="verbatim" id="verbatim-76"> -  \usepackage[acronym,hyperfirst=false]{glossaries} -  <br /> % acronym and glossary entry definitions -  <br /> % at the end of the preamble -  <br /> \glsunsetall[main] -</div> - <!--l. 3410--><p class="nopar" > - </p><!--l. 3412--><p class="noindent" >Alternatively you can redefine the hook - </p><!--l. 3413--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslinkcheckfirsthyperhook</span><span -class="cmtt-9"> </span></span><a - id="dx1-23112"></a> <span + <div class="verbatim" id="verbatim-66"> + \usepackage[acronym,hyperfirst=false]{glossaries} + <br /> % acronym and glossary entry definitions + <br /> % at the end of the preamble + <br /> \glsunsetall[main] +</div> +<!--l. 3778--><p class="nopar" > +</p><!--l. 3780--><p class="indent" > Alternatively you can redefine the hook +</p><!--l. 3781--><p class="indent" > <hr><div title="Definition"><a + id="dx1-34015"></a> <span class="cmtt-10">\glslinkcheckfirsthyperhook </span></div><hr> - </p><!--l. 3415--><p class="noindent" > - which is used by the commands that check the <a +</p><!--l. 3783--><p class="noindent" > +which is used by the commands that check the <a href="#glo:firstuseflag">first use flag</a>, such as <span class="cmtt-10">\gls</span><a - id="dx1-23113"></a>. Within the - definition of this command, you can use <span + id="dx1-34016"></a>. Within the definition of this +command, you can use <span class="cmtt-10">\glslabel</span><a - id="dx1-23114"></a> to reference the entry label and - <span + id="dx1-34017"></a> to reference the entry label and <span class="cmtt-10">\glstype</span><a - id="dx1-23115"></a> to reference the glossary type. You can also use <span + id="dx1-34018"></a> to reference the glossary type. You +can also use <span class="cmtt-10">\ifglsused</span><a - id="dx1-23116"></a> to determine if - the entry has been used. You can test if an entry is an acronym by checking if it has the - <span -class="cmss-10">long</span><a - id="dx1-23117"></a> key set using <span + id="dx1-34019"></a> to determine if the entry has been used. You can test if an entry is an acronym by +checking if it has the <span +class="cmtt-10">long</span><a + id="dx1-34020"></a> key set using <span class="cmtt-10">\ifglshaslong</span><a - id="dx1-23118"></a>. For example, to switch off the hyperlink on first use - just for acronyms: - - + id="dx1-34021"></a>. For example, to switch off the hyperlink on first use +just for acronyms: + + </p> - <div class="verbatim" id="verbatim-77"> - \renewcommand*{\glslinkcheckfirsthyperhook}{% -  <br /> \ifglsused{\glslabel}{}% -  <br /> {% -  <br />   \ifglshaslong{\glslabel}{\setkeys{glslink}{hyper=false}}{}% -  <br /> }% -  <br />} + <div class="verbatim" id="verbatim-67"> +\renewcommand*{\glslinkcheckfirsthyperhook}{% + <br /> \ifglsused{\glslabel}{}% + <br /> {% + <br />   \ifglshaslong{\glslabel}{\setkeys{glslink}{hyper=false}}{}% + <br /> }% + <br />} </div> - <!--l. 3431--><p class="nopar" > - </p><!--l. 3433--><p class="noindent" >Note that this hook isn’t used by the commands that don’t check the <a -href="#glo:firstuseflag">first use flag</a>, such - as <span +<!--l. 3799--><p class="nopar" > +</p><!--l. 3801--><p class="indent" > Note that this hook isn’t used by the commands that don’t check the <a +href="#glo:firstuseflag">first use flag</a>, such as +<span class="cmtt-10">\glstext</span><a - id="dx1-23119"></a>. (You can, instead, redefine <span + id="dx1-34022"></a>. (You can, instead, redefine <span class="cmtt-10">\glslinkpostsetkeys</span><a - id="dx1-23120"></a>, which is used by both - the <a + id="dx1-34023"></a>, which is used by both the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> and <a -href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands.) - </p></dd><dt class="description"> +class="cmtt-10">\gls</span>-like</a> and <a - id="pkgopt:indexonlyfirst"></a><span -class="cmssbx-10">indexonlyfirst</span><a - id="dx1-23121"></a> </dt><dd -class="description">This is a boolean option that specifies whether to only add information to the - external glossary file on <a -href="#glo:firstuse">first use</a>. The default is <span -class="cmss-10">indexonlyfirst=false</span><a - id="dx1-23122"></a>, which will add a - line to the file every time one of the <a -href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> or <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands are - used. Note that <span -class="cmtt-10">\glsadd</span><a - id="dx1-23123"></a> will always add information to the external glossary - file<span class="footnote-mark"><a -href="#fn1x2" id="fn1x2-bk"><sup class="textsuperscript">2.1</sup></a></span><a - id="x1-23124f1"></a> (since - that’s the purpose of that command). - <!--l. 3447--><p class="noindent" >You can customise this by redefining - </p><!--l. 3448--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glswriteentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-23125"></a> <span -class="cmtt-10">\glswriteentry{</span>⟨<span -class="cmitt-10">label</span>⟩<span -class="cmtt-10">}{</span>⟨<span -class="cmitt-10">wr-code</span>⟩<span -class="cmtt-10">} </span></div><hr> - </p><!--l. 3450--><p class="noindent" > - where ⟨<span -class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span -class="cmti-10">wr-code</span>⟩ is the code that writes the entry’s - information to the external file. The default definition of <span -class="cmtt-10">\glswriteentry</span> - is: - - -</p> - <div class="verbatim" id="verbatim-78"> - \newcommand*{\glswriteentry}[2]{% -  <br />  \ifglsindexonlyfirst -  <br />    \ifglsused{#1}{}{#2}% -  <br />  \else -  <br />    #2% -  <br />  \fi -  <br />} -</div> - <!--l. 3462--><p class="nopar" > This checks the <span -class="cmss-10">indexonlyfirst</span><a - id="dx1-23126"></a> package option (using <span -class="cmtt-10">\ifglsindexonlyfirst</span>) and does - ⟨<span -class="cmti-10">wr-code</span>⟩ if this is <span -class="cmss-10">false </span>otherwise it only does ⟨<span -class="cmti-10">wr-code</span>⟩ of the entry hasn’t been - used. - </p><!--l. 3468--><p class="noindent" >For example, suppose you only want to index the first use for entries in the <span +class="cmtt-10">\glstext</span>-like</a> commands.) +</p><!--l. 3806--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a method of disabling the <a +href="#glo:firstuse">first use</a> hyperlink according to the entry’s +associated category. For example, if you only to switch off the <a +href="#glo:firstuse">first use</a> hyperlink for abbreviations and +acronyms then you simply need to set the <span id="textcolor199"><span +class="cmss-10">nohyperfirst</span></span><a + id="dx1-34024"></a> attribute for the <span +class="cmtt-10">abbreviation </span>and <span class="cmtt-10">acronym</span> - glossary and not in the <span -class="cmtt-10">main </span>(or any other) glossary: - - +categories. (Instead of using the <span +class="cmss-10">nohyperfirst</span><a + id="dx1-34025"></a> package option.) See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further +details. +</p><!--l. 3815--><p class="noindent" > </p> - <div class="verbatim" id="verbatim-79"> - \renewcommand*{\glswriteentry}[2]{% -  <br /> \ifthenelse{\equal{\glsentrytype{#1}}{acronym}} -  <br /> {\ifglsused{#1}{}{#2}}% -  <br /> {#2}% -  <br />} + <h4 class="likesubsectionHead"><a + id="x1-350002.1"></a><a + id="pkgopt:writeglslabels"></a><span +class="cmss-10">writeglslabels</span></h4> +<!--l. 3815--><p class="noindent" >This is a valueless option that will create a file called <span +class="cmtt-10">\jobname.glslabels</span><a + id="dx1-35001"></a> at the end of the document. This file +simply contains a list of all defined entry labels (including those in any ignored glossaries). It’s provided for the +benefit of text editors that need to know labels for auto-completion<a + id="dx1-35002"></a>. (See also <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span>’s</a> <span id="textcolor200"><span +class="cmss-10">docdef</span><span +class="cmtt-10">=</span><span +class="cmss-10">atom</span></span><a + id="dx1-35003"></a> +package option.) +</p><!--l. 3823--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> Note that with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-35004"></a></a> the file will only contain the entries that <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-35005"></a></a> has selected from the <span +class="cmtt-10">bib</span><a + id="dx1-35006"></a> files. </div> - <!--l. 3477--><p class="nopar" > Here I’ve used <span -class="cmtt-10">\ifthenelse </span>to ensure the arguments of <span -class="cmtt-10">\equal </span>are fully expanded - before the comparison is made. - </p></dd><dt class="description"> -<a - id="pkgopt:savenumberlist"></a><span -class="cmssbx-10">savenumberlist</span><a - id="dx1-23127"></a> </dt><dd -class="description">This is a boolean option that specifies whether or not to gather and - store the <a -href="#glo:numberlist">number list<a - id="dx1-23128"></a></a> for each entry. The default is <span -class="cmss-10">savenumberlist=false</span><a - id="dx1-23129"></a>. (See +</p><!--l. 3826--><p class="noindent" > +</p><!--l. 3828--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-360002.1"></a><span id="textcolor201"><a + id="pkgopt:undefaction"></a><span id="textcolor202"><span +class="cmss-10">undefaction</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 3830--><p class="noindent" >The value may be one of: + </p><dl class="description"><dt class="description"> +<span +class="cmssbx-10">error</span> </dt><dd +class="description">generate an error if a referenced entry is undefined (default, and only available setting with just <span -class="cmtt-10">\glsentrynumberlist</span><a - id="dx1-23130"></a> and <span -class="cmtt-10">\glsdisplaynumberlist</span><a - id="dx1-23131"></a> in <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a -href="#sec:glsnolink">Using Glossary Terms - Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) This is always true if you use <a -href="#option1">Option 1</a>. - </dd></dl> -<!--l. 3490--><p class="noindent" > +class="cmss-10">glossaries</span>); + </dd><dt class="description"> +<span +class="cmssbx-10">warn</span> </dt><dd +class="description">only warn if a referenced entry is undefined (automatically activated with <a +href="#option4">Option 4</a>).</dd></dl> + + +<!--l. 3839--><p class="noindent" > </p> -<!--l. 3490--><p class="noindent" ><a + <h4 class="likesubsectionHead"><a + id="x1-370002.1"></a><span id="textcolor203"><a + id="pkgopt:docdef"></a><span id="textcolor204"><span +class="cmss-10">docdef</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 3841--><p class="noindent" >This option governs the use of <span +class="cmtt-10">\newglossaryentry</span>. Available values: + </p><dl class="description"><dt class="description"> +<span +class="cmssbx-10">false</span> </dt><dd +class="description"><span +class="cmtt-10">\newglossaryentry </span>is not permitted in the <span +class="cmss-10">document</span><a + id="dx1-37001"></a><a + id="dx1-37002"></a> environment (default with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> + and for <a +href="#option1">Option 1</a> with just the base <span +class="cmss-10">glossaries </span>package); + </dd><dt class="description"> +<span +class="cmssbx-10">restricted</span> </dt><dd +class="description"><span +class="cmtt-10">\newglossaryentry </span>is only permitted in the <span +class="cmss-10">document</span><a + id="dx1-37003"></a><a + id="dx1-37004"></a> environment if it occurs before + <span +class="cmtt-10">\printglossary </span>(not available for some indexing options); + </dd><dt class="description"> +<span +class="cmssbx-10">atom</span> </dt><dd +class="description">as <span +class="cmss-10">restricted </span>but creates the <span +class="cmtt-10">docdefs</span><a + id="dx1-37005"></a> file for use by <span +class="cmtt-10">atom</span><a + id="dx1-37006"></a> (without the limitations of <span id="textcolor205"><span +class="cmss-10">docdef</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span></span><a + id="dx1-37007"></a>); + </dd><dt class="description"> +<span +class="cmssbx-10">true</span> </dt><dd +class="description"><span +class="cmtt-10">\newglossaryentry </span>is permitted in the <span +class="cmss-10">document</span><a + id="dx1-37008"></a><a + id="dx1-37009"></a> environment where it would normally be + permitted by the base <span +class="cmss-10">glossaries </span>package. This will create the <span +class="cmtt-10">docdefs</span><a + id="dx1-37010"></a> file if <span +class="cmtt-10">\newglossaryentry</span> + is found in the <span +class="cmss-10">document</span><a + id="dx1-37011"></a><a + id="dx1-37012"></a> environment.</dd></dl> +<!--l. 3863--><p class="noindent" > +</p> +<!--l. 3863--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.2 </span> <a id="sec:pkgopts-sec"></a>Sectioning, Headings and TOC Options</h3> - <dl class="description"><dt class="description"> -<a +<!--l. 3866--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-390002.2"></a><a id="pkgopt:toc"></a><span -class="cmssbx-10">toc</span><a - id="dx1-24001"></a> </dt><dd -class="description">Add the glossaries to the table of contents. Note that an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run is - required with this option. Alternatively, you can switch this function on and off - using - <!--l. 3497--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstoctrue</span><span -class="cmtt-9"> </span></span><a - id="dx1-24002"></a> <span +class="cmss-10">toc=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3866--><p class="noindent" >Add the glossaries to the table of contents. Note that an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required with this option. +Alternatively, you can switch this function on and off using +</p><!--l. 3869--><p class="indent" > <hr><div title="Definition"><a + id="dx1-39001"></a> <span class="cmtt-10">\glstoctrue </span></div><hr> - </p><!--l. 3499--><p class="noindent" > - and - </p><!--l. 3501--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstocfalse</span><span -class="cmtt-9"> </span></span><a - id="dx1-24003"></a> <span +</p><!--l. 3871--><p class="noindent" > +and +</p><!--l. 3873--><p class="indent" > <hr><div title="Definition"><a + id="dx1-39002"></a> <span class="cmtt-10">\glstocfalse </span></div><hr> - </p><!--l. 3503--><p class="noindent" > - </p></dd><dt class="description"> -<a +</p><!--l. 3875--><p class="noindent" > +The default value is <span +class="cmss-10">toc</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-39003"></a> for the base <span +class="cmss-10">glossaries </span>package and <span +class="cmss-10">toc</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-39004"></a> for <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. +</p><!--l. 3880--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-400002.2"></a><a id="pkgopt:numberline"></a><span -class="cmssbx-10">numberline</span><a - id="dx1-24004"></a> </dt><dd -class="description">When used with <span -class="cmss-10">toc</span><a - id="dx1-24005"></a>, this will add <span +class="cmss-10">numberline=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> + + +<!--l. 3880--><p class="noindent" >When used with the above <span +class="cmss-10">toc</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-40001"></a> option, this will add <span class="cmtt-10">\numberline</span><a - id="dx1-24006"></a><span class="obeylines-h"><span class="verb"><span + id="dx1-40002"></a><span class="obeylines-h"><span class="verb"><span class="cmtt-10">{}</span></span></span> in the final argument of - <span +<span class="cmtt-10">\addcontentsline</span><a - id="dx1-24007"></a>. This will align the table of contents entry with the numbered - section titles. Note that this option has no effect if the <span + id="dx1-40003"></a>. This will align the table of contents entry with the numbered section titles. Note that this +option has no effect if the <span class="cmss-10">toc</span><a - id="dx1-24008"></a> option is omitted. If <span + id="dx1-40004"></a> option is omitted. If <span class="cmss-10">toc</span><a - id="dx1-24009"></a> is - used without <span + id="dx1-40005"></a> is used without <span class="cmss-10">numberline</span><a - id="dx1-24010"></a>, the title will be aligned with the section numbers rather than - the section titles. - - - </dd><dt class="description"> -<a + id="dx1-40006"></a>, the title will be aligned with +the section numbers rather than the section titles. +</p><!--l. 3889--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-410002.2"></a><a id="pkgopt:section"></a><span -class="cmssbx-10">section</span><a - id="dx1-24011"></a> </dt><dd -class="description">This is a ⟨<span -class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ option. Its value should be the name of a sectional unit - (e.g. chapter). This will make the glossaries appear in the named sectional unit, - otherwise each glossary will appear in a chapter, if chapters exist, otherwise in a section. - Unnumbered sectional units will be used by default. Example: - - - <div class="verbatim" id="verbatim-80"> - \usepackage[section=subsection]{glossaries} +class="cmss-10">section=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3891--><p class="noindent" >This option indicates the sectional unit to use for the glossary. The value should be the control +sequence <span +class="cmti-10">name </span>without the leading backslash or following star (e.g. just <span +class="cmtt-10">chapter </span>not <span +class="cmtt-10">\chapter </span>or +<span +class="cmtt-10">chapter*</span>). +</p><!--l. 3896--><p class="indent" > The default behaviour is for the glossary heading to use <span +class="cmtt-10">\chapter</span>, if that command exists, or <span +class="cmtt-10">\section</span> +otherwise. The starred or unstarred form is determined by the <span +class="cmss-10">numberedsection</span><a + id="dx1-41001"></a> option. +</p><!--l. 3900--><p class="indent" > Example: + + +</p> + <div class="verbatim" id="verbatim-68"> +\usepackage[section=subsection]{glossaries} </div> - <!--l. 3521--><p class="nopar" > You can omit the value if you want to use sections, i.e.  - - +<!--l. 3903--><p class="nopar" > You can omit the value if you want to use <span +class="cmtt-10">\section</span>, i.e.  + + </p> - <div class="verbatim" id="verbatim-81"> - \usepackage[section]{glossaries} + <div class="verbatim" id="verbatim-69"> +\usepackage[section]{glossaries} </div> - <!--l. 3525--><p class="nopar" > is equivalent to - - +<!--l. 3907--><p class="nopar" > is equivalent to + + </p> - <div class="verbatim" id="verbatim-82"> - \usepackage[section=section]{glossaries} + <div class="verbatim" id="verbatim-70"> +\usepackage[section=section]{glossaries} </div> - <!--l. 3529--><p class="nopar" > You can change this value later in the document using - </p><!--l. 3531--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setglossarysection</span><span -class="cmtt-9"> </span></span><a - id="dx1-24012"></a> <span +<!--l. 3911--><p class="nopar" > You can change this value later in the document using +</p><!--l. 3913--><p class="indent" > <hr><div title="Definition"><a + id="dx1-41002"></a> <span class="cmtt-10">\setglossarysection{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3533--><p class="noindent" > - where ⟨<span +</p><!--l. 3915--><p class="noindent" > +where ⟨<span class="cmti-10">name</span>⟩ is the sectional unit. - </p><!--l. 3536--><p class="noindent" >The start of each glossary adds information to the page header via - </p><!--l. 3537--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsglossarymark</span><span -class="cmtt-9"> </span></span><a - id="dx1-24013"></a> <span +</p><!--l. 3918--><p class="indent" > The start of each glossary adds information to the page header via +</p><!--l. 3919--><p class="indent" > <hr><div title="Definition"><a + id="dx1-41003"></a> <span class="cmtt-10">\glsglossarymark{</span>⟨<span class="cmitt-10">glossary title</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3539--><p class="noindent" > - By default this uses <span +</p><!--l. 3921--><p class="noindent" > +By default this uses <span class="cmtt-10">\@mkboth</span><span class="footnote-mark"><a href="#fn2x2" id="fn2x2-bk"><sup class="textsuperscript">2.2</sup></a></span><a - id="x1-24014f2"></a> - but you may need to redefine it. For example, to only change the right header: - - + id="x1-41004f2"></a> +but you may need to redefine it. For example, to only change the right header: + + </p> - <div class="verbatim" id="verbatim-83"> - \renewcommand{\glsglossarymark}[1]{\markright{#1}} + <div class="verbatim" id="verbatim-71"> +\renewcommand{\glsglossarymark}[1]{\markright{#1}} </div> - <!--l. 3546--><p class="nopar" > or to prevent it from changing the headers: - - +<!--l. 3928--><p class="nopar" > or to prevent it from changing the headers: + + </p> - <div class="verbatim" id="verbatim-84"> - \renewcommand{\glsglossarymark}[1]{} + <div class="verbatim" id="verbatim-72"> +\renewcommand{\glsglossarymark}[1]{} </div> - <!--l. 3550--><p class="nopar" > If you want <span +<!--l. 3932--><p class="nopar" > If you want <span class="cmtt-10">\glsglossarymark </span>to use <span class="cmtt-10">\MakeUppercase </span>in the header, use the <span class="cmss-10">ucmark</span><a - id="dx1-24017"></a> - option described below. - </p><!--l. 3554--><p class="noindent" >Occasionally you may find that another package defines <span -class="cmtt-10">\cleardoublepage </span>when it is - not required. This may cause an unwanted blank page to appear before each glossary. - This can be fixed by redefining <span class="reversemarginpar"><span -class="cmtt-9">\glsclearpage</span><span -class="cmtt-9"> </span></span><a - id="dx1-24018"></a><span + id="dx1-41007"></a> option described +below. +</p><!--l. 3936--><p class="indent" > Occasionally you may find that another package defines <span +class="cmtt-10">\cleardoublepage </span>when it is not required. This +may cause an unwanted blank page to appear before each glossary. This can be fixed by redefining +<a + id="dx1-41008"></a><span class="cmtt-10">\glsclearpage</span>: - - + + </p> - <div class="verbatim" id="verbatim-85"> - \renewcommand*{\glsclearpage}{\clearpage} + <div class="verbatim" id="verbatim-73"> +\renewcommand*{\glsclearpage}{\clearpage} </div> - <!--l. 3560--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 3942--><p class="nopar" > +</p><!--l. 3944--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-420002.2"></a><a id="pkgopt:ucmark"></a><span -class="cmssbx-10">ucmark</span><a - id="dx1-24019"></a> </dt><dd -class="description">This is a boolean option (default: <span -class="cmss-10">ucmark=false</span><a - id="dx1-24020"></a>, unless <span +class="cmss-10">ucmark=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3944--><p class="noindent" >This is a boolean option. The default is <span +class="cmss-10">ucmark</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-42001"></a>, unless <span class="cmss-10">memoir</span><a - id="dx1-24021"></a> has been loaded, - in which case it defaults to <span -class="cmss-10">ucmark=true</span><a - id="dx1-24022"></a>). If set, <span + id="dx1-42002"></a> has been loaded, in which case the default +is <span +class="cmss-10">ucmark</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-42003"></a>. +</p><!--l. 3948--><p class="indent" > If set, <span class="cmtt-10">\glsglossarymark</span><a - id="dx1-24023"></a> uses - <span + id="dx1-42004"></a> uses +<span class="cmtt-10">\MakeTextUppercase</span><a - id="dx1-24024"></a><span class="footnote-mark"><a + id="dx1-42005"></a><span class="footnote-mark"><a href="#fn3x2" id="fn3x2-bk"><sup class="textsuperscript">2.3</sup></a></span><a - id="x1-24025f3"></a>. - You can test whether this option has been set or not using - <!--l. 3573--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsucmark</span><span -class="cmtt-9"> </span></span><a - id="dx1-24030"></a> <span -class="cmtt-10">\ifglsucmark </span>⟨<span + id="x1-42006f3"></a>. +You can test whether this option has been set or not using +</p><!--l. 3957--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\ifglsucmark</span><a + id="dx1-42011"></a> ⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">\else </span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">\fi </span></div><hr> - </p><!--l. 3575--><p class="noindent" > - For example: - - -</p> - <div class="verbatim" id="verbatim-86"> - \renewcommand{\glsglossarymark}[1]{% -  <br />  \ifglsucmark -  <br />    \markright{\MakeTextUppercase{#1}}% -  <br />  \else -  <br />    \markright{#1}% -  <br />  \fi} -</div> - <!--l. 3584--><p class="nopar" > If <span +</p><!--l. 3958--><p class="noindent" > +For example: + + +</p> + <div class="verbatim" id="verbatim-74"> +\renewcommand{\glsglossarymark}[1]{% + <br />  \ifglsucmark + <br />    \markright{\MakeTextUppercase{#1}}% + <br />  \else + <br />    \markright{#1}% + <br />  \fi} +</div> +<!--l. 3967--><p class="nopar" > If <span class="cmss-10">memoir</span><a - id="dx1-24031"></a> has been loaded and <span -class="cmss-10">ucfirst</span><a - id="dx1-24032"></a> is set, then <span + id="dx1-42012"></a> has been loaded and <span +class="cmss-10">ucmark</span><a + id="dx1-42013"></a> is set, then <span class="cmss-10">memoir</span><a - id="dx1-24033"></a>’s <span + id="dx1-42014"></a>’s <span class="cmtt-10">\memUChead</span><a - id="dx1-24034"></a> is - used. - </p></dd><dt class="description"> -<a + id="dx1-42015"></a> is used. +</p><!--l. 3971--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-430002.2"></a><a id="pkgopt:numberedsection"></a><span -class="cmssbx-10">numberedsection</span><a - id="dx1-24035"></a> </dt><dd -class="description">The glossaries are placed in unnumbered sectional units by default, but - this can be changed using <span +class="cmss-10">numberedsection=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 3972--><p class="noindent" >The glossaries are placed in unnumbered sectional units by default, but this can be changed using +<span class="cmss-10">numberedsection</span><a - id="dx1-24036"></a>. This option can take one of the following - values: - <ul class="itemize1"> - <li class="itemize"><span + id="dx1-43001"></a>. This option can take one of the following values: </p> + <ul class="itemize1"> + <li class="itemize"><span class="cmss-10">false</span><a - id="dx1-24037"></a>: - no number, i.e. use starred form of sectioning command (e.g. <span -class="cmtt-10">\chapter* </span>or - <span + id="dx1-43002"></a>: no number, i.e. use starred form of sectioning command (e.g. <span +class="cmtt-10">\chapter* </span>or <span class="cmtt-10">\section*</span>); - </li> - <li class="itemize"><span + </li> + <li class="itemize"><span class="cmss-10">nolabel</span><a - id="dx1-24038"></a>: use a numbered section, i.e. the unstarred form of sectioning - command (e.g. <span -class="cmtt-10">\chapter </span>or <span + id="dx1-43003"></a>: use a numbered section, i.e. the unstarred form of sectioning command (e.g. <span +class="cmtt-10">\chapter </span>or + <span class="cmtt-10">\section</span>), but the section not labelled; - </li> - <li class="itemize"><span + </li> + <li class="itemize"><span class="cmss-10">autolabel</span><a - id="dx1-24039"></a>: numbered with automatic labelling. Each glossary uses the unstarred - form of a sectioning command (e.g. <span + id="dx1-43004"></a>: numbered with automatic labelling. Each glossary uses the unstarred form of a sectioning + command (e.g. <span class="cmtt-10">\chapter </span>or <span -class="cmtt-10">\section</span>) and is assigned a label - (via <span +class="cmtt-10">\section</span>) and is assigned a label (via <span class="cmtt-10">\label</span><a - id="dx1-24040"></a>). The label is formed from - <!--l. 3605--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsautoprefix</span><span -class="cmtt-9"> </span></span><a - id="dx1-24041"></a> <span + id="dx1-43005"></a>). The label is formed + from + <!--l. 3988--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-43006"></a> <span class="cmtt-10">\glsautoprefix </span>⟨<span class="cmitt-10">type</span>⟩ </div><hr> - </p><!--l. 3607--><p class="noindent" > - where ⟨<span -class="cmti-10">type</span>⟩ is the label identifying that glossary. The default value of - <span -class="cmtt-10">\glsautoprefix </span>is empty. For example, if you load <span + </p><!--l. 3990--><p class="noindent" > + where ⟨<span +class="cmti-10">type</span>⟩ is the label identifying that glossary. The default value of <span +class="cmtt-10">\glsautoprefix </span>is empty. For + example, if you load <span class="cmss-10">glossaries </span>using: - - + + </p> - <div class="verbatim" id="verbatim-87"> - \usepackage[section,numberedsection=autolabel] -  <br />  {glossaries} + <div class="verbatim" id="verbatim-75"> + \usepackage[section,numberedsection=autolabel] +  <br />  {glossaries} </div> - <!--l. 3615--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using - something like: - - + <!--l. 3998--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using something + like: + + </p> - <div class="verbatim" id="verbatim-88"> - The main glossary is in section~\ref{main} and -  <br />the list of acronyms is in section~\ref{acronym}. + <div class="verbatim" id="verbatim-76"> + The main glossary is in section~\ref{main} and +  <br />the list of acronyms is in section~\ref{acronym}. </div> - <!--l. 3621--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a - separate list of acronyms, you can use <span + <!--l. 4004--><p class="nopar" > If you can’t decide whether to have the acronyms in the main glossary or a separate list of acronyms, you + can use <span class="cmtt-10">\acronymtype</span><a - id="dx1-24042"></a> which is set to <span -class="cmtt-10">main </span>if the - <span + id="dx1-43007"></a> which is set to <span +class="cmtt-10">main </span>if the <span class="cmss-10">acronym</span><a - id="dx1-24043"></a> option is not used and is set to <span -class="cmtt-10">acronym </span>if the <span + id="dx1-43008"></a> option is not used and is set to <span +class="cmtt-10">acronym </span>if the + <span class="cmss-10">acronym</span><a - id="dx1-24044"></a> option is used. For - example: - - -</p> - <div class="verbatim" id="verbatim-89"> - The list of acronyms is in section~\ref{\acronymtype}. -</div> - <!--l. 3629--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your - document. For example: - - -</p> - <div class="verbatim" id="verbatim-90"> - \renewcommand*{\glsautoprefix}{glo:} -</div> - <!--l. 3635--><p class="nopar" > will add <span -class="cmtt-10">glo: </span>to the automatically generated label, so you can then, for example, - refer to the list of acronyms as follows: - - -</p> - <div class="verbatim" id="verbatim-91"> - The list of acronyms is in -  <br />section~\ref{glo:\acronymtype}. -</div> - <!--l. 3641--><p class="nopar" > Or, if you are undecided on a prefix: - - -</p> - <div class="verbatim" id="verbatim-92"> - The list of acronyms is in -  <br />section~\ref{\glsautoprefix\acronymtype}. -</div> - <!--l. 3646--><p class="nopar" > - </p></li> - <li class="itemize"><span + id="dx1-43009"></a> option is used. For example: + + +</p> + <div class="verbatim" id="verbatim-77"> + The list of acronyms is in section~\ref{\acronymtype}. +</div> + <!--l. 4012--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your document. For + example: + + +</p> + <div class="verbatim" id="verbatim-78"> + \renewcommand*{\glsautoprefix}{glo:} +</div> + <!--l. 4018--><p class="nopar" > will add <span +class="cmtt-10">glo: </span>to the automatically generated label, so you can then, for example, refer to the list of + acronyms as follows: + + +</p> + <div class="verbatim" id="verbatim-79"> + The list of acronyms is in +  <br />section~\ref{glo:\acronymtype}. +</div> + <!--l. 4024--><p class="nopar" > Or, if you are undecided on a prefix: + + +</p> + <div class="verbatim" id="verbatim-80"> + The list of acronyms is in +  <br />section~\ref{\glsautoprefix\acronymtype}. +</div> + <!--l. 4029--><p class="nopar" > + </p></li> + <li class="itemize"><span class="cmss-10">nameref</span><a - id="dx1-24045"></a>: this is like <span + id="dx1-43010"></a>: this is like <span class="cmss-10">autolabel</span><a - id="dx1-24046"></a> but uses an unnumbered sectioning command - (e.g. <span + id="dx1-43011"></a> but uses an unnumbered sectioning command (e.g. <span class="cmtt-10">\chapter*</span><a - id="dx1-24047"></a> or <span + id="dx1-43012"></a> or + <span class="cmtt-10">\section*</span><a - id="dx1-24048"></a>). It’s designed for use with the <span + id="dx1-43013"></a>). It’s designed for use with the <span class="cmss-10">nameref</span><a - id="dx1-24049"></a> package. - For example: - - - <div class="verbatim" id="verbatim-93"> - \usepackage{nameref} -  <br />\usepackage[numberedsection=nameref]{glossaries} -</div> - <!--l. 3655--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\nameref{main}</span></span></span> will display the (TOC) section title associated with the - <span -class="cmtt-10">main </span>glossary. As above, you can redefine <span -class="cmtt-10">\glsautoprefix </span>to provide a prefix for - the label.</p></li></ul> - </dd></dl> -<!--l. 3663--><p class="noindent" > + id="dx1-43014"></a> package. For example: + + + <div class="verbatim" id="verbatim-81"> + \usepackage{nameref} +  <br />\usepackage[numberedsection=nameref]{glossaries} +</div> + <!--l. 4038--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\nameref{main}</span></span></span> will display the (TOC) section title associated with the <span +class="cmtt-10">main </span>glossary. As above, + you can redefine <span +class="cmtt-10">\glsautoprefix </span>to provide a prefix for the label.</p></li></ul> +<!--l. 4044--><p class="noindent" > </p> -<!--l. 3663--><p class="noindent" ><a +<!--l. 4044--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.3 </span> <a id="sec:pkgopts-printglos"></a>Glossary Appearance Options</h3> - <dl class="description"><dt class="description"> -<a +<!--l. 4047--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-450002.3"></a><a + id="pkgopt:savenumberlist"></a><span +class="cmss-10">savenumberlist=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4047--><p class="noindent" >This is a boolean option that specifies whether or not to gather and store the <a +href="#glo:numberlist">number list<a + id="dx1-45001"></a></a> for each entry. The +default is <span +class="cmss-10">savenumberlist</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-45002"></a>. (See <span +class="cmtt-10">\glsentrynumberlist</span><a + id="dx1-45003"></a> and <span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-45004"></a> in <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary +Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) This is always true if you use <a +href="#option1">Option 1</a>. +</p><!--l. 4054--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you use the <span id="textcolor206"><span +class="cmss-10">record</span></span><a + id="dx1-45005"></a> option (with either no value or <span id="textcolor207"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">only</span></span><a + id="dx1-45006"></a> or <span id="textcolor208"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-45007"></a>) then this package option +has no effect. With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-45008"></a></a>, the <a +href="#glo:numberlist">number list<a + id="dx1-45009"></a>s</a> are automatically saved with the default <span id="textcolor209"><span +class="cmtt-10">save-locations</span></span><span +class="cmtt-10">=true</span><a + id="dx1-45010"></a> +and <span id="textcolor210"><span +class="cmtt-10">save-loclist</span></span><span +class="cmtt-10">=true</span><a + id="dx1-45011"></a> resource settings. </div> +</p><!--l. 4061--><p class="noindent" > +</p><!--l. 4063--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-460002.3"></a><a id="pkgopt:entrycounter"></a><span -class="cmssbx-10">entrycounter</span><a - id="dx1-25001"></a> </dt><dd -class="description">This is a boolean option. (Default is <span -class="cmss-10">entrycounter=false</span><a - id="dx1-25002"></a>.) If set, each main - (level 0) glossary entry will be numbered when using the standard glossary styles. - This option creates the counter <span class="reversemarginpar"><span -class="cmtt-9">glossaryentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-25003"></a><a - id="dx1-25004"></a><span +class="cmss-10">entrycounter=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4063--><p class="noindent" >This is a boolean option. (Default is <span +class="cmss-10">entrycounter</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-46001"></a>.) If set, each main (level 0) glossary entry will be +numbered when using the standard glossary styles. This option creates the counter <a + id="dx1-46002"></a><a + id="dx1-46003"></a><span class="cmss-10">glossaryentry</span>. - <!--l. 3673--><p class="noindent" >If you use this option, you can reference the entry number within the document - using - </p><!--l. 3675--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsrefentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-25005"></a> <span +</p><!--l. 4069--><p class="indent" > If you use this option, you can reference the entry number within the document using +</p><!--l. 4071--><p class="indent" > <hr><div title="Definition"><a + id="dx1-46004"></a> <span class="cmtt-10">\glsrefentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3677--><p class="noindent" > - where ⟨<span -class="cmti-10">label</span>⟩ is the label associated with that glossary entry. The labelling - systems uses ⟨<span +</p><!--l. 4073--><p class="noindent" > +where ⟨<span +class="cmti-10">label</span>⟩ is the label associated with that glossary entry. The labelling systems uses ⟨<span class="cmti-10">prefix</span>⟩⟨<span class="cmti-10">label</span>⟩, where ⟨<span -class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span -class="cmti-10">prefix</span>⟩ is given - by - </p><!--l. 3681--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsEntryCounterLabelPrefix</span><span -class="cmtt-9"> </span></span><a - id="dx1-25006"></a> <span +class="cmti-10">label</span>⟩ is +the entry’s label and ⟨<span +class="cmti-10">prefix</span>⟩ is given by +</p><!--l. 4077--><p class="indent" > <hr><div title="Definition"><a + id="dx1-46005"></a> <span class="cmtt-10">\GlsEntryCounterLabelPrefix </span></div><hr> - </p><!--l. 3683--><p class="noindent" > - (which defaults to <span +</p><!--l. 4079--><p class="noindent" > +(which defaults to <span class="cmtt-10">glsentry-</span>). - </p><!--l. 3686--><p class="noindent" ><div class="important" title="Important Note"> If you use <span +</p><!--l. 4082--><p class="indent" > <div class="important" title="Important Note"> If you use <span class="cmtt-10">\glsrefentry</span>, you must run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> twice after creating the glossary files - using <a +class="E">E</span>X</span></span> twice after creating the glossary files using +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-25007"></a></a>, <a + id="dx1-46006"></a></a>, <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-25008"></a></a> or <a + id="dx1-46007"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-25009"></a></a> to ensure the cross-references are - up-to-date. </div> - </p><!--l. 3691--><p class="noindent" > - </p></dd><dt class="description"> -<a + id="dx1-46008"></a></a> to ensure the cross-references are up-to-date. </div> + + +</p><!--l. 4087--><p class="noindent" > +</p><!--l. 4089--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-470002.3"></a><a id="pkgopt:counterwithin"></a><span -class="cmssbx-10">counterwithin</span><a - id="dx1-25010"></a> </dt><dd -class="description">This is a ⟨<span +class="cmss-10">counterwithin=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4089--><p class="noindent" >This is a ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ option where ⟨<span -class="cmti-10">value</span>⟩ is the name of a counter. If used, this - option will automatically set <span -class="cmss-10">entrycounter=true</span><a - id="dx1-25011"></a> and the <span +class="cmti-10">value</span>⟩ is the name of a counter. If used, this option will automatically set +<span +class="cmss-10">entrycounter</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-47001"></a> and the <span class="cmss-10">glossaryentry</span><a - id="dx1-25012"></a> counter will be - reset every time ⟨<span + id="dx1-47002"></a> counter will be reset every time ⟨<span class="cmti-10">value</span>⟩ is incremented. - <!--l. 3700--><p class="noindent" ><div class="important" title="Important Note"> The <span +</p><!--l. 4096--><p class="indent" > <div class="important" title="Important Note"> The <span class="cmss-10">glossaryentry</span><a - id="dx1-25013"></a> counter isn’t automatically reset at the start of each glossary, except - when glossary section numbering is on and the counter used by <span + id="dx1-47003"></a> counter isn’t automatically reset at the start of each glossary, except when glossary section +numbering is on and the counter used by <span class="cmss-10">counterwithin</span><a - id="dx1-25014"></a> is the - same as the counter used in the glossary’s sectioning command. </div> - - - </p><!--l. 3705--><p class="noindent" > - </p><!--l. 3707--><p class="noindent" >If you want the counter reset at the start of each glossary, you can redefine - <span + id="dx1-47004"></a> is the same as the counter used in the glossary’s +sectioning command. </div> +</p><!--l. 4101--><p class="noindent" > +</p><!--l. 4103--><p class="indent" > If you want the counter reset at the start of each glossary, you can modify the glossary preamble +(<span class="cmtt-10">\glossarypreamble</span><a - id="dx1-25015"></a> to use - </p><!--l. 3709--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsresetentrycounter</span><span -class="cmtt-9"> </span></span><a - id="dx1-25016"></a> <span + id="dx1-47005"></a>) to use +</p><!--l. 4105--><p class="indent" > <hr><div title="Definition"><a + id="dx1-47006"></a> <span class="cmtt-10">\glsresetentrycounter </span></div><hr> - </p><!--l. 3711--><p class="noindent" > - which sets <span +</p><!--l. 4107--><p class="noindent" > +which sets <span class="cmss-10">glossaryentry</span><a - id="dx1-25017"></a> to zero: - - + id="dx1-47007"></a> to zero: + + </p> - <div class="verbatim" id="verbatim-94"> - \renewcommand{\glossarypreamble}{% -  <br />  \glsresetentrycounter -  <br />} + <div class="verbatim" id="verbatim-82"> +\renewcommand{\glossarypreamble}{% + <br />  \glsresetentrycounter + <br />} </div> - <!--l. 3717--><p class="nopar" > or if you are using <span +<!--l. 4113--><p class="nopar" > or if you are using <span class="cmtt-10">\setglossarypreamble</span><a - id="dx1-25018"></a>, add it to each glossary preamble, as - required. For example: - - -</p> - <div class="verbatim" id="verbatim-95"> - \setglossarypreamble[acronym]{% -  <br />  \glsresetentrycounter -  <br />  The preamble text here for the list of acronyms. -  <br />} -  <br />\setglossarypreamble{% -  <br />  \glsresetentrycounter -  <br />  The preamble text here for the main glossary. -  <br />} + id="dx1-47008"></a>, add it to each glossary preamble, as required. For +example: + + +</p> + <div class="verbatim" id="verbatim-83"> +\setglossarypreamble[acronym]{% + <br />  \glsresetentrycounter + <br />  The preamble text here for the list of acronyms. + <br />} + <br />\setglossarypreamble{% + <br />  \glsresetentrycounter + <br />  The preamble text here for the main glossary. + <br />} </div> - <!--l. 3729--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 4125--><p class="nopar" > +</p><!--l. 4127--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-480002.3"></a><a id="pkgopt:subentrycounter"></a><span -class="cmssbx-10">subentrycounter</span><a - id="dx1-25019"></a> </dt><dd -class="description">This is a boolean option. (Default is <span -class="cmss-10">subentrycounter=false</span><a - id="dx1-25020"></a>.) If set, each - level 1 glossary entry will be numbered when using the standard glossary - styles. This option creates the counter <span class="reversemarginpar"><span -class="cmtt-9">glossarysubentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-25021"></a><a - id="dx1-25022"></a><span -class="cmss-10">glossarysubentry</span>. - The counter is reset with each main (level 0) entry. Note that this package - option is independent of <span +class="cmss-10">subentrycounter=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4127--><p class="noindent" >This is a boolean option. (Default is <span +class="cmss-10">subentrycounter</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-48001"></a>.) If set, each level 1 glossary entry will be numbered +when using the standard glossary styles. This option creates the counter <a + id="dx1-48002"></a><a + id="dx1-48003"></a><span +class="cmss-10">glossarysubentry</span>. The counter is reset +with each main (level 0) entry. Note that this package option is independent of <span class="cmss-10">entrycounter</span><a - id="dx1-25023"></a>. You can reference the number within the - document using <span + id="dx1-48004"></a>. You can reference +the number within the document using <span class="cmtt-10">\glsrefentry</span><a - id="dx1-25024"></a><span + id="dx1-48005"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>where ⟨<span class="cmti-10">label</span>⟩ is the label associated with the - sub-entry. - </dd><dt class="description"> -<a +sub-entry. +</p><!--l. 4138--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-490002.3"></a><a id="pkgopt:style"></a><span -class="cmssbx-10">style</span><a - id="dx1-25025"></a> </dt><dd -class="description">This is a ⟨<span +class="cmss-10">style=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4138--><p class="noindent" >This is a ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ option. (Default is <span -class="cmss-10">style=list</span><a - id="dx1-25026"></a>, unless <span +class="cmss-10">style</span><span +class="cmtt-10">=</span><span +class="cmss-10">list</span><a + id="dx1-49001"></a>, unless <span class="cmss-10">classicthesis</span><a - id="dx1-25027"></a> has been loaded, in - which case the default is <span -class="cmss-10">style=index</span><a - id="dx1-25028"></a>.) Its value should be the name of the - glossary style to use. This key may only be used for styles defined in <span + id="dx1-49002"></a> has been loaded, in which case the default is +<span +class="cmss-10">style</span><span +class="cmtt-10">=</span><span +class="cmss-10">index</span><a + id="dx1-49003"></a>.) Its value should be the name of the glossary style to use. This key may only be used for styles +defined in <span class="cmss-10">glossary-list</span><a - id="dx1-25029"></a>, - <span + id="dx1-49004"></a>, <span class="cmss-10">glossary-long</span><a - id="dx1-25030"></a>, <span + id="dx1-49005"></a>, <span class="cmss-10">glossary-super</span><a - id="dx1-25031"></a> or <span + id="dx1-49006"></a> or <span class="cmss-10">glossary-tree</span><a - id="dx1-25032"></a>. Alternatively, you can set the style - using - <!--l. 3750--><p class="noindent" ><hr><div title="Definition"><span + id="dx1-49007"></a>. Alternatively, you can set the style +using +</p><!--l. 4146--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\setglossarystyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3751--><p class="noindent" > - (See <a -href="#sec:styles"><span -class="tcrm-1000">§</span>15 </a><a +</p><!--l. 4147--><p class="noindent" > +(See <a +href="#sec:styles">§15 </a><a href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for further details.) - </p></dd><dt class="description"> -<a +</p><!--l. 4150--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-500002.3"></a><a id="pkgopt:nolong"></a><span -class="cmssbx-10">nolong</span><a - id="dx1-25033"></a> </dt><dd -class="description">This prevents the <span +class="cmss-10">nolong</span></h4> +<!--l. 4150--><p class="noindent" >This prevents the <span class="cmss-10">glossaries </span>package from automatically loading <span class="cmss-10">glossary-long</span><a - id="dx1-25034"></a> (which - means that the <span + id="dx1-50001"></a> (which means that the <span class="cmss-10">longtable</span><a - id="dx1-25035"></a> package also won’t be loaded). This reduces overhead by not - defining unwanted styles and commands. Note that if you use this option, you won’t be - able to use any of the glossary styles defined in the <span -class="cmss-10">glossary-long </span>package (unless you - explicitly load <span + id="dx1-50002"></a> +package also won’t be loaded). This reduces overhead by not defining unwanted styles and commands. Note that +if you use this option, you won’t be able to use any of the glossary styles defined in the <span +class="cmss-10">glossary-long </span>package +(unless you explicitly load <span class="cmss-10">glossary-long</span><a - id="dx1-25036"></a>). - </dd><dt class="description"> -<a + id="dx1-50003"></a>). + + +</p><!--l. 4158--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-510002.3"></a><a id="pkgopt:nosuper"></a><span -class="cmssbx-10">nosuper</span><a - id="dx1-25037"></a> </dt><dd -class="description">This prevents the <span +class="cmss-10">nosuper</span></h4> +<!--l. 4158--><p class="noindent" >This prevents the <span class="cmss-10">glossaries </span>package from automatically loading <span class="cmss-10">glossary-super</span><a - id="dx1-25038"></a> (which - means that the <span + id="dx1-51001"></a> (which means that the +<span class="cmss-10">supertabular</span><a - id="dx1-25039"></a> package also won’t be loaded). This reduces overhead by - not defining unwanted styles and commands. Note that if you use this option, you won’t - be able to use any of the glossary styles defined in the <span -class="cmss-10">glossary-super </span>package (unless you - explicitly load <span + id="dx1-51002"></a> package also won’t be loaded). This reduces overhead by not defining unwanted styles and +commands. Note that if you use this option, you won’t be able to use any of the glossary styles defined in the +<span +class="cmss-10">glossary-super </span>package (unless you explicitly load <span class="cmss-10">glossary-super</span><a - id="dx1-25040"></a>). - - - </dd><dt class="description"> -<a + id="dx1-51003"></a>). +</p><!--l. 4166--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-520002.3"></a><a id="pkgopt:nolist"></a><span -class="cmssbx-10">nolist</span><a - id="dx1-25041"></a> </dt><dd -class="description">This prevents the <span +class="cmss-10">nolist</span></h4> +<!--l. 4166--><p class="noindent" >This prevents the <span class="cmss-10">glossaries </span>package from automatically loading <span class="cmss-10">glossary-list</span><a - id="dx1-25042"></a>. This - reduces overhead by not defining unwanted styles. Note that if you use this option, you - won’t be able to use any of the glossary styles defined in the <span -class="cmss-10">glossary-list </span>package (unless - you explicitly load <span + id="dx1-52001"></a>. This reduces overhead by not +defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles +defined in the <span +class="cmss-10">glossary-list </span>package (unless you explicitly load <span class="cmss-10">glossary-list</span><a - id="dx1-25043"></a>). Note that since the default style is <span + id="dx1-52002"></a>). Note that since the default style is <span class="cmss-10">list</span><a - id="dx1-25044"></a> (unless - <span + id="dx1-52003"></a> +(unless <span class="cmss-10">classicthesis</span><a - id="dx1-25045"></a> has been loaded), you will also need to use the <span + id="dx1-52004"></a> has been loaded), you will also need to use the <span class="cmss-10">style</span><a - id="dx1-25046"></a> option to set the style - to something else. - </dd><dt class="description"> -<a + id="dx1-52005"></a> option to set the style to something +else. +</p><!--l. 4177--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-530002.3"></a><a id="pkgopt:notree"></a><span -class="cmssbx-10">notree</span><a - id="dx1-25047"></a> </dt><dd -class="description">This prevents the <span +class="cmss-10">notree</span></h4> +<!--l. 4177--><p class="noindent" >This prevents the <span class="cmss-10">glossaries </span>package from automatically loading <span class="cmss-10">glossary-tree</span><a - id="dx1-25048"></a>. This - reduces overhead by not defining unwanted styles. Note that if you use this - option, you won’t be able to use any of the glossary styles defined in the - <span + id="dx1-53001"></a>. This reduces overhead by not +defining unwanted styles. Note that if you use this option, you won’t be able to use any of the glossary styles +defined in the <span class="cmss-10">glossary-tree </span>package (unless you explicitly load <span class="cmss-10">glossary-tree</span><a - id="dx1-25049"></a>). Note that if - <span + id="dx1-53002"></a>). Note that if <span class="cmss-10">classicthesis</span><a - id="dx1-25050"></a> has been loaded, the default style is <span + id="dx1-53003"></a> has been +loaded, the default style is <span class="cmss-10">index</span><a - id="dx1-25051"></a>, which is provided by - <span + id="dx1-53004"></a>, which is provided by <span class="cmss-10">glossary-tree</span><a - id="dx1-25052"></a>. - </dd><dt class="description"> -<a + id="dx1-53005"></a>. +</p><!--l. 4186--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-540002.3"></a><a id="pkgopt:nostyles"></a><span -class="cmssbx-10">nostyles</span><a - id="dx1-25053"></a> </dt><dd -class="description">This prevents all the predefined styles from being loaded. If you use this option, you - need to load a glossary style package (such as <span +class="cmss-10">nostyles</span></h4> +<!--l. 4186--><p class="noindent" >This prevents all the predefined styles from being loaded. If you use this option, you need to load a glossary +style package (such as <span class="cmss-10">glossary-mcols</span><a - id="dx1-25054"></a>). Also if you use - this option, you can’t use the <span + id="dx1-54001"></a>). Also if you use this option, you can’t use the <span class="cmss-10">style</span><a - id="dx1-25055"></a> package option. Instead you must either - use <span + id="dx1-54002"></a> package option. Instead +you must either use <span class="cmtt-10">\setglossarystyle</span><a - id="dx1-25056"></a><span + id="dx1-54003"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">style</span>⟩<span class="cmtt-10">} </span>or the <span -class="cmss-10">style</span><a - id="dx1-25057"></a> key in the optional argument to - <span +class="cmtt-10">style</span><a + id="dx1-54004"></a> key in the optional argument to <span class="cmtt-10">\printglossary</span><a - id="dx1-25058"></a>. Example: - - - <div class="verbatim" id="verbatim-96"> - \usepackage[nostyles]{glossaries} -  <br />\usepackage{glossary-mcols} -  <br />\setglossarystyle{mcoltree} -</div> - <!--l. 3801--><p class="nopar" > - </p></dd><dt class="description"> -<a + id="dx1-54005"></a>. +Example: + + +</p> + <div class="verbatim" id="verbatim-84"> +\usepackage[nostyles]{glossaries} + <br />\usepackage{glossary-mcols} + <br />\setglossarystyle{mcoltree} +</div> +<!--l. 4197--><p class="nopar" > +</p><!--l. 4199--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-550002.3"></a><a id="pkgopt:nonumberlist"></a><span -class="cmssbx-10">nonumberlist</span><a - id="dx1-25059"></a> </dt><dd -class="description">This option will suppress the associated <a +class="cmss-10">nonumberlist</span></h4> +<!--l. 4199--><p class="noindent" >This option will suppress the associated <a href="#glo:numberlist">number list<a - id="dx1-25060"></a>s</a> in the glossaries (see also - <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a -href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). Note that if you use Options <a + id="dx1-55001"></a>s</a> in the glossaries (see also <a +href="#sec:numberlists">§5 </a><a +href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). Note +that if you use Options <a href="#option2">2</a> or <a href="#option3">3</a> (<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-25061"></a></a> or <a + id="dx1-55002"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-25062"></a></a>) then the - locations must still be valid. This package option merely prevents the <a + id="dx1-55003"></a></a>) then the locations must still be valid. This +package option merely prevents the <a href="#glo:numberlist">number list<a - id="dx1-25063"></a></a> from - being displayed, but both <a + id="dx1-55004"></a></a> from being displayed, but both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-25064"></a></a> and <a + id="dx1-55005"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-25065"></a></a> still require a location or - cross-reference for each term that’s indexed. Remember that <a + id="dx1-55006"></a></a> +still require a location or cross-reference for each term that’s indexed. Remember that <a href="#glo:numberlist">number list<a - id="dx1-25066"></a></a> includes any - cross-references, so suppressing the <a + id="dx1-55007"></a></a> +includes any cross-references, so suppressing the <a href="#glo:numberlist">number list<a - id="dx1-25067"></a></a> will also hide the cross-references (see - below). - </dd><dt class="description"> -<a + id="dx1-55008"></a></a> will also hide the cross-references (see +below). +</p><!--l. 4210--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-560002.3"></a><a id="pkgopt:seeautonumberlist"></a><span -class="cmssbx-10">seeautonumberlist</span><a - id="dx1-25068"></a> </dt><dd -class="description">If you suppress the <a +class="cmss-10">seeautonumberlist</span></h4> +<!--l. 4210--><p class="noindent" >If you suppress the <a href="#glo:numberlist">number list<a - id="dx1-25069"></a>s</a> with <span + id="dx1-56001"></a>s</a> with <span class="cmss-10">nonumberlist</span><a - id="dx1-25070"></a>, described - above, this will also suppress any cross-referencing information supplied by - the <span -class="cmss-10">see</span><a - id="dx1-25071"></a> key in <span + id="dx1-56002"></a>, described above, this will also suppress any cross-referencing +information supplied by the <span +class="cmtt-10">see</span><a + id="dx1-56003"></a> key in <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-25072"></a> or <span + id="dx1-56004"></a> or <span class="cmtt-10">\glssee</span><a - id="dx1-25073"></a>. If you use <span + id="dx1-56005"></a>. If you use <span class="cmss-10">seeautonumberlist</span><a - id="dx1-25074"></a>, - the <span -class="cmss-10">see</span><a - id="dx1-25075"></a> key will automatically implement <span -class="cmss-10">nonumberlist=false</span><a - id="dx1-25076"></a> for that entry. - (Note this doesn’t affect <span -class="cmtt-10">\glssee</span>.) For further details see <a -href="#sec:crossref"><span -class="tcrm-1000">§</span>8 </a><a -href="#sec:crossref">Cross-Referencing - Entries<!--tex4ht:ref: sec:crossref --></a>. - </dd><dt class="description"> -<a + id="dx1-56006"></a>, the <span +class="cmtt-10">see</span><a + id="dx1-56007"></a> +key will automatically implement <span +class="cmtt-10">nonumberlist=false</span><a + id="dx1-56008"></a> for that entry. (Note this doesn’t affect <span +class="cmtt-10">\glssee</span>.) For +further details see <a +href="#sec:crossref">§8 </a><a +href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>. +</p><!--l. 4219--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-570002.3"></a><a id="pkgopt:counter"></a><span -class="cmssbx-10">counter</span><a - id="dx1-25077"></a> </dt><dd -class="description">This is a ⟨<span +class="cmss-10">counter=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4219--><p class="noindent" >This is a ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ option. (Default is <span -class="cmss-10">counter=page</span><a - id="dx1-25078"></a>.) The value should be - the name of the default counter to use in the <a +class="cmss-10">counter</span><span +class="cmtt-10">=</span><span +class="cmss-10">page</span><a + id="dx1-57001"></a>.) The value should be the name of the default counter to +use in the <a href="#glo:numberlist">number list<a - id="dx1-25079"></a>s</a> (see <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a -href="#sec:numberlists">Number - lists<!--tex4ht:ref: sec:numberlists --></a>). - </dd><dt class="description"> -<a + id="dx1-57002"></a>s</a> (see <a +href="#sec:numberlists">§5 </a><a +href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). +</p><!--l. 4224--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-580002.3"></a><a id="pkgopt:nopostdot"></a><span -class="cmssbx-10">nopostdot</span><a - id="dx1-25080"></a> </dt><dd -class="description">This is a boolean option. If no value is specified, <span -class="cmtt-10">true </span>is assumed. When set to - <span -class="cmtt-10">true</span>, this option suppresses the default post description dot used by some of the - predefined styles. The default setting is <span -class="cmss-10">nopostdot=false</span><a - id="dx1-25081"></a>. - </dd><dt class="description"> +class="cmss-10">nopostdot=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4224--><p class="noindent" >This is a boolean option. If no value is specified, <span +class="cmss-10">true</span><a + id="dx1-58001"></a> is assumed. When set to <span +class="cmss-10">true</span><a + id="dx1-58002"></a>, this option suppresses the +default post description dot used by some of the predefined styles. +</p><!--l. 4229--><p class="indent" > The default setting is <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-58003"></a> for the base <span +class="cmss-10">glossaries </span>package and <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-58004"></a> for <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + + +</p><!--l. 4233--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor211"><span +class="cmss-10">postdot</span></span><a + id="dx1-58005"></a>, which is equivalent to <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-58006"></a>, and also <span id="textcolor212"><span +class="cmss-10">postpunc</span></span><a + id="dx1-58007"></a>, +which allows you to choose a different punctuation character. </div> +</p><!--l. 4238--><p class="noindent" > +</p><!--l. 4240--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-590002.3"></a><a id="pkgopt:nogroupskip"></a><span -class="cmssbx-10">nogroupskip</span><a - id="dx1-25082"></a> </dt><dd -class="description">This is a boolean option. If no value is specified, <span -class="cmtt-10">true </span>is assumed. When set to - <span -class="cmtt-10">true</span>, this option suppresses the default vertical gap between groups used by some of - the predefined styles. The default setting is <span -class="cmss-10">nogroupskip=false</span><a - id="dx1-25083"></a>. - </dd></dl> - - -<!--l. 3842--><p class="noindent" > +class="cmss-10">nogroupskip=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4240--><p class="noindent" >This is a boolean option. If no value is specified, <span +class="cmss-10">true </span>is assumed. When set to <span +class="cmss-10">true</span>, this option suppresses the +default vertical gap between letter groups used by some of the predefined styles. The default setting is +<span +class="cmss-10">nogroupskip</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-59001"></a>. +</p><!--l. 4246--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you are using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-59002"></a></a> without the <span +class="cmtt-10">--group </span>(or <span +class="cmtt-10">-g</span>) switch then you don’t need to use <span +class="cmss-10">nogroupskip</span><span +class="cmtt-10">=</span><span +class="cmss-10">true </span>as +there won’t be any letter groups. </div> +</p><!--l. 4251--><p class="noindent" > +</p><!--l. 4253--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-600002.3"></a><span id="textcolor213"><a + id="pkgopt:stylemods"></a><span id="textcolor214"><span +class="cmss-10">stylemods</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">list</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4255--><p class="noindent" >Load the <span +class="cmss-10">glossaries-extra-stylemods</span><a + id="dx1-60001"></a> package and patch the predefined styles. The ⟨<span +class="cmti-10">list</span>⟩ argument is +optional. If present, this will also load <span +class="cmss-10">glossary-</span>⟨<span +class="cmssi-10">element</span>⟩<span +class="cmss-10">.sty </span>for each ⟨<span +class="cmti-10">element</span>⟩ in the comma-separated +⟨<span +class="cmti-10">list</span>⟩. +</p><!--l. 4260--><p class="noindent" > </p> -<!--l. 3842--><p class="noindent" ><a +<!--l. 4260--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.4 </span> <a + id="sec:pkgopts-indexing"></a>Indexing Options</h3> +<!--l. 4263--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-620002.4"></a><a + id="pkgopt:seenoindex"></a><span +class="cmss-10">seenoindex=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4263--><p class="noindent" >Introduced in version 4.24, this option may take one of three values: <span +class="cmss-10">error</span>, <span +class="cmss-10">warn </span>or <span +class="cmss-10">ignore</span>. The <span +class="cmtt-10">see</span><a + id="dx1-62001"></a> key +automatically indexes the cross-referenced entry using <span +class="cmtt-10">\glsadd</span>. This means that if this key is +used in an entry definition before the relevant glossary file has been opened, the indexing can’t be +performed. Since this is easy to miss, the <span +class="cmss-10">glossaries </span>package by default issues an error message if the +<span +class="cmtt-10">see</span><a + id="dx1-62002"></a> key is used before <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-62003"></a>. This option allows you to change the error into just a +warning (<span +class="cmss-10">seenoindex</span><span +class="cmtt-10">=</span><span +class="cmss-10">warn</span><a + id="dx1-62004"></a>) or ignore it (<span +class="cmss-10">seenoindex</span><span +class="cmtt-10">=</span><span +class="cmss-10">ignore</span><a + id="dx1-62005"></a>) if, for example, you want to temporarily +comment out <span +class="cmtt-10">\makeglossaries </span>to speed up the compilation of a draft document by omitting the +indexing. + + +</p><!--l. 4277--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-630002.4"></a><a + id="pkgopt:esclocations"></a><span +class="cmss-10">esclocations=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4277--><p class="noindent" >This is a boolean option. The default is <span +class="cmss-10">esclocations</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-63001"></a>, which is needed for Options <a +href="#option2">2</a> and <a +href="#option3">3</a>. With <a +href="#option1">Option 1</a> +<span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-63002"></a> changes it to <span +class="cmss-10">esclocations</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-63003"></a>. With <a +href="#option4">Option 4</a> (<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-63004"></a></a>), this setting is +ignored. +</p><!--l. 4283--><p class="indent" > Both <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-63005"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-63006"></a></a> are fussy about the location formats (<a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-63007"></a></a> more so than <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-63008"></a></a>) so the +<span +class="cmss-10">glossaries </span>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 <span class="TEX">T<span +class="E">E</span>X</span>’s asynchronous output routine, which can go wrong and also adds to the complexity of +the document build. +</p><!--l. 4292--><p class="indent" > 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 <span +class="cmss-10">esclocations</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-63009"></a> to +avoid the complex escaping of location values. (See “Writing information to associated files” in the documented +code for further details.) +</p><!--l. 4300--><p class="indent" > This isn’t an issue for Options <a +href="#option1">1</a> or <a +href="#option4">4</a> as the locations are written to the <span +class="cmtt-10">aux</span><a + id="dx1-63010"></a> file so no syntax conversion is +required. +</p><!--l. 4303--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-640002.4"></a><a + id="pkgopt:indexonlyfirst"></a><span +class="cmss-10">indexonlyfirst=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4303--><p class="noindent" >This is a boolean option that specifies whether to only add information to the external glossary file on <a +href="#glo:firstuse">first use</a>. +The default is <span +class="cmss-10">indexonlyfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-64001"></a>, which will add a line to the file every time one of the <a +href="#sec:gls-like"><span +class="cmtt-10">\gls</span>-like</a> or +<a +href="#sec:glstext-like"><span +class="cmtt-10">\glstext</span>-like</a> commands are used. Note that <span +class="cmtt-10">\glsadd</span><a + id="dx1-64002"></a> will always add information to the external glossary +file<span class="footnote-mark"><a +href="#fn4x2" id="fn4x2-bk"><sup class="textsuperscript">2.4</sup></a></span><a + id="x1-64003f4"></a> (since +that’s the purpose of that command). +</p><!--l. 4312--><p class="indent" > <div class="important" title="Important Note"> Resetting the <a +href="#glo:firstuseflag">first use flag</a> with commands like <span +class="cmtt-10">\glsreset</span><a + id="dx1-64004"></a> after an entry has been indexed will cause that +entry to be indexed multiple times if it’s used again after the reset. Likewise unsetting the <a +href="#glo:firstuseflag">first use flag</a> before +an entry has been indexed will prevent it from being indexed (unless specifically indexed with <span +class="cmtt-10">\glsadd</span>). +</div> +</p><!--l. 4319--><p class="noindent" > +</p><!--l. 4321--><p class="indent" > You can customise this by redefining +</p><!--l. 4322--><p class="indent" > <hr><div title="Definition"><a + id="dx1-64005"></a> <span +class="cmtt-10">\glswriteentry{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">wr-code</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 4324--><p class="noindent" > +where ⟨<span +class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span +class="cmti-10">wr-code</span>⟩ is the code that writes the entry’s information to the external file. +The default definition of <span +class="cmtt-10">\glswriteentry </span>is: + + +</p> + <div class="verbatim" id="verbatim-85"> +\newcommand*{\glswriteentry}[2]{% + <br />  \ifglsindexonlyfirst + <br />    \ifglsused{#1}{}{#2}% + <br />  \else + <br />    #2% + <br />  \fi + <br />} +</div> +<!--l. 4336--><p class="nopar" > This checks the <span +class="cmss-10">indexonlyfirst</span><a + id="dx1-64006"></a> package option (using <span +class="cmtt-10">\ifglsindexonlyfirst</span>) and does ⟨<span +class="cmti-10">wr-code</span>⟩ if this is <span +class="cmss-10">false</span> +otherwise it only does ⟨<span +class="cmti-10">wr-code</span>⟩ of the entry hasn’t been used. +</p><!--l. 4342--><p class="indent" > For example, suppose you only want to index the first use for entries in the <span +class="cmtt-10">acronym </span>glossary and not in the +<span +class="cmtt-10">main </span>(or any other) glossary: + + +</p> + <div class="verbatim" id="verbatim-86"> +\renewcommand*{\glswriteentry}[2]{% + <br /> \ifthenelse{\equal{\glsentrytype{#1}}{acronym}} + <br /> {\ifglsused{#1}{}{#2}}% + <br /> {#2}% + <br />} +</div> +<!--l. 4351--><p class="nopar" > Here I’ve used <span +class="cmtt-10">\ifthenelse </span>to ensure the arguments of <span +class="cmtt-10">\equal </span>are fully expanded before the comparison is +made. +</p><!--l. 4355--><p class="indent" > With the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package it’s possible to only index <a +href="#glo:firstuse">first use</a> for particular categories. For example, if +you only want this enabled for abbreviations and acronyms then you can set the <span id="textcolor215"><span +class="cmss-10">indexonlyfirst</span></span><a + id="dx1-64007"></a> attribute for the +<span +class="cmtt-10">abbreviation </span>and <span +class="cmtt-10">acronym </span>categories. (Instead of using the <span +class="cmss-10">indexonlyfirst</span><a + id="dx1-64008"></a> package option.) See the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. +</p><!--l. 4363--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-650002.4"></a><span id="textcolor216"><a + id="pkgopt:indexcrossrefs"></a><span id="textcolor217"><span +class="cmss-10">indexcrossrefs</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4365--><p class="noindent" >If <span +class="cmss-10">true</span>, this will automatically index any cross-referenced entries that haven’t been marked as used at +the end of the document. Increases document build time. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further +details. +</p><!--l. 4370--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-660002.4"></a><span id="textcolor218"><a + id="pkgopt:autoseeindex"></a><span id="textcolor219"><span +class="cmss-10">autoseeindex</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4372--><p class="noindent" >If <span +class="cmss-10">true</span>, makes the <span +class="cmtt-10">see</span><a + id="dx1-66001"></a> and <span id="textcolor220"><span id="textcolor221"><span +class="cmtt-10">seealso</span></span><a + id="dx1-66002"></a></span> keys automatically index the cross-reference when the entry is defined +(default, and the only option with just the base <span +class="cmss-10">glossaries </span>package). +</p><!--l. 4377--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-670002.4"></a><span id="textcolor222"><a + id="pkgopt:record"></a><span id="textcolor223"><span +class="cmss-10">record</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4379--><p class="noindent" >If not <span +class="cmss-10">off</span>, this option indicates that <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-67001"></a></a> is required. If the value is omitted, <span +class="cmss-10">only </span>is assumed. Permitted +values: + </p><dl class="description"><dt class="description"> +<span +class="cmssbx-10">off</span> </dt><dd +class="description"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-67002"></a></a> isn’t being used; + </dd><dt class="description"> +<span +class="cmssbx-10">only</span> </dt><dd +class="description"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-67003"></a></a> is being used to fetch entries from a <span +class="cmtt-10">bib</span><a + id="dx1-67004"></a> file, to sort the entries and collate the <a +href="#glo:numberlist">number + list<a + id="dx1-67005"></a>s</a>, where the location information is the same as for Options <a +href="#option1">1</a>–<a +href="#option3">3</a>; + + + </dd><dt class="description"> +<span +class="cmssbx-10">nameref</span> </dt><dd +class="description">like <span +class="cmss-10">only </span>but provides extra information that allows the associated title to be used instead of + the location number; + </dd><dt class="description"> +<span +class="cmssbx-10">alsoindex</span> </dt><dd +class="description">a hybrid approach where <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-67006"></a></a> is begin used to fetch entries from a <span +class="cmtt-10">bib</span><a + id="dx1-67007"></a> file but <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-67008"></a></a> + or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-67009"></a></a> are used for the indexing. This requires a more complicated document build and isn’t + recommended.</dd></dl> +<!--l. 4398--><p class="noindent" >See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. +</p><!--l. 4400--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-680002.4"></a><span id="textcolor224"><a + id="pkgopt:equations"></a><span id="textcolor225"><span +class="cmss-10">equations</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4402--><p class="noindent" >If <span +class="cmss-10">true</span>, this option will cause the default location counter to automatically switch to <span +class="cmtt-10">equation </span>when inside a +numbered equation environment. +</p><!--l. 4406--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-690002.4"></a><span id="textcolor226"><a + id="pkgopt:floats"></a><span id="textcolor227"><span +class="cmss-10">floats</span></span><span +class="cmss-10">=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 4408--><p class="noindent" >If <span +class="cmss-10">true</span>, this option will cause the default location counter to automatically switch to the corresponding counter +when inside a float. (Remember that with floats it’s the <span +class="cmtt-10">\caption </span>command that increments the counter so the +location will be incorrect if an entry is indexed within the float before the caption.) +</p><!--l. 4414--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-700002.4"></a><span id="textcolor228"><a + id="pkgopt:indexcounter"></a><span id="textcolor229"><span +class="cmss-10">indexcounter</span></span> (glossaries-extra.sty)</span></h4> +<!--l. 4416--><p class="noindent" >This valueless option is primarily intended for use with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-70001"></a></a> and <span +class="cmss-10">hyperref</span><a + id="dx1-70002"></a> allowing the page location +hyperlink to the relevant point in the page (rather than the top of the page). Unexpected results will occur with +other indexing methods. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. +</p><!--l. 4422--><p class="noindent" > +</p> +<!--l. 4422--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.5 </span> <a id="sec:pkgopts-sort"></a>Sorting Options</h3> - <dl class="description"><dt class="description"> +<!--l. 4425--><p class="noindent" >This section is mostly for Options <a +href="#option2">2</a> and <a +href="#option3">3</a>. Only the <span +class="cmss-10">sort</span><a + id="dx1-71001"></a> and <span +class="cmss-10">order</span><a + id="dx1-71002"></a> options are applicable for <a +href="#option1">Option 1</a>. +</p><!--l. 4428--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> With Options <a +href="#option4">4</a>–<a +href="#option6">6</a>, only <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">none</span><a + id="dx1-71003"></a> is applicable (and this is automatically implemented by +<span id="textcolor230"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">only</span></span><a + id="dx1-71004"></a> and <span id="textcolor231"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-71005"></a>). With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-71006"></a></a>, the sort method is provided in the optional argument of +<span id="textcolor232"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-71007"></a> not with the <span +class="cmss-10">sort </span>package option. There’s no sorting with Options <a +href="#option5">5</a> and <a +href="#option6">6</a>. +</div> + + +</p><!--l. 4435--><p class="noindent" > +</p><!--l. 4437--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-720002.5"></a><a + id="pkgopt:sanitizesort"></a><span +class="cmss-10">sanitizesort=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4437--><p class="noindent" >This is a boolean option that determines whether or not to <a +href="#glo:sanitize">sanitize<a + id="dx1-72001"></a></a> the sort value when writing to the external +glossary file. For example, suppose you define an entry as follows: + + +</p> + <div class="verbatim" id="verbatim-87"> +\newglossaryentry{hash}{name={\#},sort={#}, + <br /> description={hash symbol}} +</div> +<!--l. 4444--><p class="nopar" > The sort value (<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">#</span></span></span>) must be sanitized before writing it to the glossary file, otherwise <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> will try to +interpret it as a parameter reference. If, on the other hand, you want the sort value expanded, you need to +switch off the sanitization. For example, suppose you do: + + +</p> + <div class="verbatim" id="verbatim-88"> +\newcommand{\mysortvalue}{AAA} + <br />\newglossaryentry{sample}{% + <br />  name={sample}, + <br />  sort={\mysortvalue}, + <br />  description={an example}} +</div> +<!--l. 4456--><p class="nopar" > and you actually want <span +class="cmtt-10">\mysortvalue </span>expanded, so that the entry is sorted according to <span +class="cmtt-10">AAA</span>, then use the +package option <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-72002"></a>. +</p><!--l. 4461--><p class="indent" > The default for Options <a +href="#option2">2</a> and <a +href="#option3">3</a> is <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-72003"></a>, and the default for <a +href="#option1">Option 1</a> is <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-72004"></a>. +</p><!--l. 4464--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-730002.5"></a><a id="pkgopt:sort"></a><span -class="cmssbx-10">sort</span><a - id="dx1-26001"></a> </dt><dd -class="description">If you use Options <a +class="cmss-10">sort=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4464--><p class="noindent" >If you use Options <a href="#option2">2</a> or <a -href="#option3">3</a>, this package option is the only way of specifying how to - sort the glossaries. Only <a -href="#option1">Option 1</a> allows you to specify sort methods for individual - glossaries via the <span -class="cmss-10">sort</span><a - id="dx1-26002"></a> key in the optional argument of <span +href="#option3">3</a>, this package option is the only way of specifying how to sort the glossaries. Only +<a +href="#option1">Option 1</a> allows you to specify sort methods for individual glossaries via the <span +class="cmtt-10">sort</span><a + id="dx1-73001"></a> key in the optional argument +of <span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-26003"></a>. If - you have multiple glossaries in your document and you are using <a -href="#option1">Option 1</a>, only - use the package options <span -class="cmss-10">sort=def</span><a - id="dx1-26004"></a> or <span -class="cmss-10">sort=use</span><a - id="dx1-26005"></a> if you want to set this sort method - for <span -class="cmti-10">all </span>your glossaries. - <!--l. 3856--><p class="noindent" >This is a ⟨<span + id="dx1-73002"></a>. If you have multiple glossaries in your document and you are using <a +href="#option1">Option 1</a>, +only use the package options <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-73003"></a> or <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-73004"></a> if you want to set this sort method for <span +class="cmti-10">all </span>your +glossaries. +</p><!--l. 4474--><p class="indent" > This is a ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ option where ⟨<span class="cmti-10">value</span>⟩ may be one of the following: </p> - <ul class="itemize1"> - <li class="itemize"><span + <ul class="itemize1"> + <li class="itemize"><span class="cmss-10">standard</span><a - id="dx1-26006"></a> : entries are sorted according to the value of the <span -class="cmss-10">sort</span><a - id="dx1-26007"></a> key used in - <span + id="dx1-73005"></a> : entries are sorted according to the value of the <span +class="cmtt-10">sort</span><a + id="dx1-73006"></a> key used in <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-26008"></a> (if present) or the <span -class="cmss-10">name</span><a - id="dx1-26009"></a> key (if <span -class="cmss-10">sort</span><a - id="dx1-26010"></a> key is missing); - </li> - <li class="itemize"><span + id="dx1-73007"></a> (if + present) or the <span +class="cmtt-10">name</span><a + id="dx1-73008"></a> key (if <span +class="cmtt-10">sort</span><a + id="dx1-73009"></a> key is missing); + </li> + <li class="itemize"><span class="cmss-10">def</span><a - id="dx1-26011"></a> : entries are sorted in the order in which they were defined (the <span -class="cmss-10">sort</span><a - id="dx1-26012"></a> key - in <span -class="cmtt-10">\newglossaryentry </span>is ignored); - </li> - <li class="itemize"><span + id="dx1-73010"></a> : entries are sorted in the order in which they were defined (the <span +class="cmtt-10">sort</span><a + id="dx1-73011"></a> key in <span +class="cmtt-10">\newglossaryentry</span> + is ignored); + </li> + <li class="itemize"><span class="cmss-10">use</span><a - id="dx1-26013"></a> : entries are sorted according to the order in which they are used in the - document (the <span -class="cmss-10">sort</span><a - id="dx1-26014"></a> key in <span + id="dx1-73012"></a> : entries are sorted according to the order in which they are used in the document (the <span +class="cmtt-10">sort</span><a + id="dx1-73013"></a> + key in <span class="cmtt-10">\newglossaryentry </span>is ignored). - <!--l. 3872--><p class="noindent" >Both <span -class="cmss-10">sort=def</span><a - id="dx1-26015"></a> and <span -class="cmss-10">sort=use</span><a - id="dx1-26016"></a> set the sort key to a six digit number via - </p><!--l. 3874--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssortnumberfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-26017"></a> <span + <!--l. 4490--><p class="noindent" >Both <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-73014"></a> and <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-73015"></a> set the sort key to a six digit number via + </p><!--l. 4492--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-73016"></a> <span class="cmtt-10">\glssortnumberfmt{</span>⟨<span class="cmitt-10">number</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 3876--><p class="noindent" > - (padded with leading zeros, where necessary). This can be redefined, if required, - before the entries are defined (in the case of <span -class="cmss-10">sort=def</span><a - id="dx1-26018"></a>) or before the entries are - used (in the case of <span -class="cmss-10">sort=use</span><a - id="dx1-26019"></a>). - </p></li> - <li class="itemize"><span + </p><!--l. 4494--><p class="noindent" > + (padded with leading zeros, where necessary). This can be redefined, if required, before the entries are + defined (in the case of <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-73017"></a>) or before the entries are used (in the case of <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-73018"></a>). + </p></li> + <li class="itemize"><span class="cmss-10">none</span><a - id="dx1-26020"></a> : this setting is new to version 4.30 and is only for documents that don’t use - <span -class="cmtt-10">\makeglossaries </span>(Options <a + id="dx1-73019"></a> : this setting is new to version 4.30 and is only for documents that don’t use <span +class="cmtt-10">\makeglossaries</span> + (Options <a href="#option2">2</a> or <a href="#option3">3</a>) or <span class="cmtt-10">\makenoidxglossaries </span>(<a -href="#option1">Option 1</a>). 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 - <span +href="#option1">Option 1</a>). 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. + + + <!--l. 4507--><p class="noindent" >This option can’t be used with <span class="cmtt-10">\printglossary </span>or <span -class="cmtt-10">\printnoidxglossary </span>(or the iterative versions - <span +class="cmtt-10">\printnoidxglossary </span>(or the iterative + versions <span class="cmtt-10">\printglossaries </span>or <span -class="cmtt-10">\printnoidxglossaries</span>). It may be used with - <span -class="cmss-10">glossaries-extra</span><a - id="dx1-26021"></a>’s <span +class="cmtt-10">\printnoidxglossaries</span>). It may be used with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>’s + <span class="cmtt-10">\printunsrtglossary </span>(<a -href="#option5">Option 5</a>).</li></ul> - <!--l. 3893--><p class="noindent" >Note that the group styles (such as <span +href="#option5">Option 5</a>).</p></li></ul> +<!--l. 4513--><p class="noindent" >Note that the group styles (such as <span class="cmss-10">listgroup</span><a - id="dx1-26022"></a>) are incompatible with the <span -class="cmss-10">sort=use</span><a - id="dx1-26023"></a> and - <span -class="cmss-10">sort=def</span><a - id="dx1-26024"></a> options. - </p><!--l. 3897--><p class="noindent" >The default is <span -class="cmss-10">sort=standard</span><a - id="dx1-26025"></a>. When the standard sort option is in use, you can hook into - the sort mechanism by redefining: - </p><!--l. 3900--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsprestandardsort</span><span -class="cmtt-9"> </span></span><a - id="dx1-26026"></a> <span + id="dx1-73020"></a>) are incompatible with the <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-73021"></a> and <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-73022"></a> options. +</p><!--l. 4517--><p class="indent" > The default is <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">standard</span><a + id="dx1-73023"></a>. When the standard sort option is in use, you can hook into the sort mechanism +by redefining: +</p><!--l. 4520--><p class="indent" > <hr><div title="Definition"><a + id="dx1-73024"></a> <span class="cmtt-10">\glsprestandardsort{</span>⟨<span class="cmitt-10">sort cs</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -8176,2223 +10197,2488 @@ class="cmitt-10">type</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> - - - </p><!--l. 3902--><p class="noindent" > - where ⟨<span -class="cmti-10">sort cs</span>⟩ is a temporary control sequence that stores the sort value (which was - either explicitly set via the <span -class="cmss-10">sort</span><a - id="dx1-26027"></a> key or implicitly set via the <span -class="cmss-10">name</span><a - id="dx1-26028"></a> key) before any - escaping of the <a +</p><!--l. 4522--><p class="noindent" > +where ⟨<span +class="cmti-10">sort cs</span>⟩ is a temporary control sequence that stores the sort value (which was either explicitly set via the +<span +class="cmtt-10">sort</span><a + id="dx1-73025"></a> key or implicitly set via the <span +class="cmtt-10">name</span><a + id="dx1-73026"></a> key) before any escaping of the <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26029"></a></a>/<a + id="dx1-73027"></a></a>/<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26030"></a></a> special characters is performed. By default - <span + id="dx1-73028"></a></a> special characters is +performed. By default <span class="cmtt-10">\glsprestandardsort </span>just does: - </p><!--l. 3908--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdosanitizesort</span><span -class="cmtt-9"> </span></span><a - id="dx1-26031"></a> <span +</p><!--l. 4528--><p class="indent" > <hr><div title="Definition"><a + id="dx1-73029"></a> <span class="cmtt-10">\glsdosanitizesort </span></div><hr> - </p><!--l. 3910--><p class="noindent" > - which <a +</p><!--l. 4530--><p class="noindent" > +which <a href="#glo:sanitize">sanitize<a - id="dx1-26032"></a>s</a> ⟨<span + id="dx1-73030"></a>s</a> ⟨<span class="cmti-10">sort cs</span>⟩ if the <span class="cmss-10">sanitizesort</span><a - id="dx1-26033"></a> package option is set (or does nothing if the - package option <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-26034"></a> is used). - </p><!--l. 3915--><p class="noindent" >The other arguments, ⟨<span + id="dx1-73031"></a> package option is set (or does nothing if the package option +<span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-73032"></a> is used). +</p><!--l. 4535--><p class="indent" > The other arguments, ⟨<span class="cmti-10">type</span>⟩ and ⟨<span -class="cmti-10">label</span>⟩, are the glossary type and the entry label for the - current entry. Note that ⟨<span +class="cmti-10">label</span>⟩, are the glossary type and the entry label for the current entry. Note +that ⟨<span class="cmti-10">type</span>⟩ will always be a control sequence, but ⟨<span -class="cmti-10">label</span>⟩ will be in the - form used in the first argument of <span +class="cmti-10">label</span>⟩ will be in the form used in the first argument of +<span class="cmtt-10">\newglossaryentry</span><a - id="dx1-26035"></a>. - </p><!--l. 3920--><p class="noindent" ><div class="important" title="Important Note"> Redefining <span -class="cmtt-10">\glsprestandardsort </span>won’t affect any entries that have already been - defined and will have no effect at all if you are using <span -class="cmss-10">sort=def</span><a - id="dx1-26036"></a> or <span -class="cmss-10">sort=use</span><a - id="dx1-26037"></a>. - </div> - </p><!--l. 3924--><p class="noindent" > + id="dx1-73033"></a>. +</p><!--l. 4540--><p class="indent" > <div class="important" title="Important Note"> Redefining <span +class="cmtt-10">\glsprestandardsort </span>won’t affect any entries that have already been defined and will have no +effect at all if you are using <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-73034"></a> or <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-73035"></a>. </div> +</p><!--l. 4544--><p class="noindent" > <a - id="x1-26038r1"></a> - </p><!--l. 3926--><p class="noindent" ><span + id="ex:diffsorts"></a> +</p><!--l. 4546--><p class="noindent" ><span class="cmbx-12">Example 1</span><span -class="cmbx-12"> (Mixing Alphabetical and Order of Definition</span> - <span -class="cmbx-12">Sorting)</span><a - id="x1-26039"></a> - </p><!--l. 3927--><p class="noindent" >Suppose I have three glossaries: <span +class="cmbx-12"> (Mixing Alphabetical and Order of Definition Sorting)</span><a + id="x1-73037"></a> +</p><!--l. 4547--><p class="indent" > Suppose I have three glossaries: <span class="cmtt-10">main</span>, <span class="cmtt-10">acronym </span>and <span -class="cmtt-10">notation</span>, and let’s suppose I want - the <span -class="cmtt-10">main </span>and <span +class="cmtt-10">notation</span>, and let’s suppose I want the <span +class="cmtt-10">main </span>and +<span class="cmtt-10">acronym </span>glossaries to be sorted alphabetically, but the <span -class="cmtt-10">notation </span>type - should be sorted in order of definition. - </p><!--l. 3933--><p class="noindent" >For <a -href="#option1">Option 1</a>, I just need to set the <span -class="cmss-10">sort</span><a - id="dx1-26040"></a> key in the optional argument of - <span +class="cmtt-10">notation </span>type should be sorted in order of +definition. +</p><!--l. 4553--><p class="indent" > For <a +href="#option1">Option 1</a>, the <span +class="cmtt-10">sort</span><a + id="dx1-73038"></a> option can be used in <span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-26041"></a>: - - + id="dx1-73039"></a>: + + </p> - <div class="verbatim" id="verbatim-97"> - \printnoidxglossary[sort=word] -  <br />\printnoidxglossary[type=acronym,sort=word] -  <br />\printnoidxglossary[type=notation,sort=def] + <div class="verbatim" id="verbatim-89"> +\printnoidxglossary[sort=word] + <br />\printnoidxglossary[type=acronym,sort=word] + <br />\printnoidxglossary[type=notation,sort=def] </div> - <!--l. 3939--><p class="nopar" > - </p><!--l. 3941--><p class="noindent" >For Options <a +<!--l. 4559--><p class="nopar" > +</p><!--l. 4561--><p class="indent" > For Options <a href="#option2">2</a> or <a href="#option3">3</a>, I can set the sort to <span -class="cmtt-10">standard </span>(which is the default, but can be - explicitly set via the package option <span -class="cmss-10">sort=standard</span><a - id="dx1-26042"></a>), and I can either define all my <span -class="cmtt-10">main</span> - and <span -class="cmtt-10">acronym </span>entries, then redefine <span +class="cmtt-10">standard </span>(which is the default, but can be explicitly set via the +package option <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">standard</span><a + id="dx1-73040"></a>), and I can either define all my <span +class="cmtt-10">main </span>and <span +class="cmtt-10">acronym </span>entries, then redefine +<span class="cmtt-10">\glsprestandardsort </span>to set ⟨<span -class="cmti-10">sort cs</span>⟩ to an - incremented integer, and then define all my <span -class="cmtt-10">notation </span>entries. Alternatively, I can - redefine <span +class="cmti-10">sort cs</span>⟩ to an incremented integer, and then define all my <span +class="cmtt-10">notation </span>entries. +Alternatively, I can redefine <span class="cmtt-10">\glsprestandardsort </span>to check for the glossary type and only modify ⟨<span class="cmti-10">sort cs</span>⟩ if - ⟨<span +⟨<span class="cmti-10">type</span>⟩ is <span class="cmtt-10">notation</span>. - </p><!--l. 3951--><p class="noindent" >The first option can be achieved as follows: - - -</p> - <div class="verbatim" id="verbatim-98"> - \newcounter{sortcount} -  <br />\renewcommand{\glsprestandardsort}[3]{% -  <br />  \stepcounter{sortcount}% -  <br />  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% -  <br />} +</p><!--l. 4571--><p class="indent" > The first option can be achieved as follows: + + +</p> + <div class="verbatim" id="verbatim-90"> +\newcounter{sortcount} + <br />\renewcommand{\glsprestandardsort}[3]{% + <br />  \stepcounter{sortcount}% + <br />  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% + <br />} </div> - <!--l. 3959--><p class="nopar" > The second option can be achieved as follows: - - -</p> - <div class="verbatim" id="verbatim-99"> - \newcounter{sortcount} -  <br />\renewcommand{\glsprestandardsort}[3]{% -  <br />  \ifdefstring{#2}{notation}% -  <br />  {% -  <br />     \stepcounter{sortcount}% -  <br />     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% -  <br />  }% -  <br />  {% -  <br />     \glsdosanitizesort -  <br />  }% -  <br />} +<!--l. 4579--><p class="nopar" > The second option can be achieved as follows: + + +</p> + <div class="verbatim" id="verbatim-91"> +\newcounter{sortcount} + <br />\renewcommand{\glsprestandardsort}[3]{% + <br />  \ifdefstring{#2}{notation}% + <br />  {% + <br />     \stepcounter{sortcount}% + <br />     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% + <br />  }% + <br />  {% + <br />     \glsdosanitizesort + <br />  }% + <br />} </div> - <!--l. 3974--><p class="nopar" > (<span +<!--l. 4594--><p class="nopar" > (<span class="cmtt-10">\ifdefstring </span>is defined by the <span class="cmss-10">etoolbox</span><a - id="dx1-26043"></a> package.) For a complete document, see the - sample file <a -href="#x1-11111r36"><span + id="dx1-73041"></a> package.) For a complete document, see the sample file +<a +href="#ex:sampleSort"><span class="cmtt-10">sampleSort.tex</span></a>. </p> - <div class="center" +<div class="center" > -<!--l. 3977--><p class="noindent" > -</p><!--l. 3977--><p class="noindent" >____________________________</p></div> +<!--l. 4597--><p class="noindent" > +</p><!--l. 4597--><p class="noindent" >____________________________</p></div> <a - id="x1-26044r2"></a> - <!--l. 3979--><p class="noindent" ><span + id="ex:customsort"></a> +<!--l. 4599--><p class="noindent" ><span class="cmbx-12">Example 2</span><span -class="cmbx-12"> (Customizing Standard Sort (Options 2 or</span> - <span -class="cmbx-12">3))</span><a - id="x1-26045"></a> - </p><!--l. 3980--><p class="noindent" >Suppose you want a glossary of people and you want the names listed as ⟨<span -class="cmti-10">first-name</span>⟩ - ⟨<span -class="cmti-10">surname</span>⟩ in the glossary, but you want the names sorted by ⟨<span +class="cmbx-12"> (Customizing Standard Sort (Options 2 or 3))</span><a + id="x1-73043"></a> +</p><!--l. 4600--><p class="indent" > Suppose you want a glossary of people and you want the names listed as ⟨<span +class="cmti-10">first-name</span>⟩ ⟨<span +class="cmti-10">surname</span>⟩ in the glossary, +but you want the names sorted by ⟨<span class="cmti-10">surname</span>⟩, ⟨<span -class="cmti-10">first-name</span>⟩. You - can do this by defining a command called, say, <span +class="cmti-10">first-name</span>⟩. You can do this by defining a command called, say, +<span class="cmtt-10">\name{</span>⟨<span class="cmti-10">first-name</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmti-10">surname</span>⟩<span -class="cmtt-10">} </span>that you - can use in the <span -class="cmss-10">name</span><a - id="dx1-26046"></a> key when you define the entry, but hook into the standard - sort mechanism to temporarily redefine <span +class="cmtt-10">} </span>that you can use in the <span +class="cmtt-10">name</span><a + id="dx1-73044"></a> key when you define the entry, but +hook into the standard sort mechanism to temporarily redefine <span class="cmtt-10">\name </span>while the sort value is being - set. - </p><!--l. 3989--><p class="noindent" >First, define two commands to set the person’s name: - - +set. +</p><!--l. 4609--><p class="indent" > First, define two commands to set the person’s name: + + </p> - <div class="verbatim" id="verbatim-100"> - \newcommand{\sortname}[2]{#2, #1} -  <br />\newcommand{\textname}[2]{#1 #2} + <div class="verbatim" id="verbatim-92"> +\newcommand{\sortname}[2]{#2, #1} + <br />\newcommand{\textname}[2]{#1 #2} </div> - <!--l. 3993--><p class="nopar" > and <span +<!--l. 4613--><p class="nopar" > and <span class="cmtt-10">\name </span>needs to be initialised to <span class="cmtt-10">\textname</span>: - - + + </p> - <div class="verbatim" id="verbatim-101"> - \let\name\textname + <div class="verbatim" id="verbatim-93"> +\let\name\textname </div> - <!--l. 3997--><p class="nopar" > Now redefine <span +<!--l. 4617--><p class="nopar" > Now redefine <span class="cmtt-10">\glsprestandardsort </span>so that it temporarily sets <span class="cmtt-10">\name </span>to <span -class="cmtt-10">\sortname</span> - and expands the sort value, then sets <span +class="cmtt-10">\sortname </span>and expands the sort +value, then sets <span class="cmtt-10">\name </span>to <span -class="cmtt-10">\textname </span>so that the person’s name - appears as ⟨<span +class="cmtt-10">\textname </span>so that the person’s name appears as ⟨<span class="cmti-10">first-name</span>⟩ ⟨<span -class="cmti-10">surname</span>⟩ in the text: - - -</p> - <div class="verbatim" id="verbatim-102"> - \renewcommand{\glsprestandardsort}[3]{% -  <br /> \let\name\sortname -  <br /> \edef#1{\expandafter\expandonce\expandafter{#1}}% -  <br /> \let\name\textname -  <br /> \glsdosanitizesort -  <br />} +class="cmti-10">surname</span>⟩ in the +text: + + +</p> + <div class="verbatim" id="verbatim-94"> +\renewcommand{\glsprestandardsort}[3]{% + <br /> \let\name\sortname + <br /> \edef#1{\expandafter\expandonce\expandafter{#1}}% + <br /> \let\name\textname + <br /> \glsdosanitizesort + <br />} </div> - <!--l. 4009--><p class="nopar" > (The somewhat complicate use of <span -class="cmtt-10">\expandafter </span>etc helps to protect fragile commands, - but care is still needed.) - </p><!--l. 4013--><p class="noindent" >Now the entries can be defined: - - -</p> - <div class="verbatim" id="verbatim-103"> - \newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}}, -  <br />  description={some information about Joe Bloggs}} -  <br />\newglossaryentry{johnsmith}{name={\name{John}{Smith}}, -  <br />  description={some information about John Smith}} -</div> - <!--l. 4020--><p class="nopar" > For a complete document, see the sample file <a -href="#x1-11110r35"><span +<!--l. 4629--><p class="nopar" > (The somewhat complicate use of <span +class="cmtt-10">\expandafter </span>etc helps to protect fragile commands, but care is still +needed.) +</p><!--l. 4633--><p class="indent" > Now the entries can be defined: + + +</p> + <div class="verbatim" id="verbatim-95"> +\newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}}, + <br />  description={some information about Joe Bloggs}} + <br />\newglossaryentry{johnsmith}{name={\name{John}{Smith}}, + <br />  description={some information about John Smith}} +</div> +<!--l. 4640--><p class="nopar" > For a complete document, see the sample file <a +href="#ex:samplePeople"><span class="cmtt-10">samplePeople.tex</span></a>. </p> - <div class="center" +<div class="center" > -<!--l. 4022--><p class="noindent" > -</p><!--l. 4022--><p class="noindent" >____________________________</p></div> - </dd><dt class="description"> -<a +<!--l. 4642--><p class="noindent" > +</p><!--l. 4642--><p class="noindent" >____________________________</p></div> +<!--l. 4644--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-740002.5"></a><a id="pkgopt:order"></a><span -class="cmssbx-10">order</span><a - id="dx1-26047"></a> </dt><dd -class="description">This may take two values: <span +class="cmss-10">order=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4644--><p class="noindent" >This may take two values: <span class="cmss-10">word</span><a - id="dx1-26048"></a> or <span + id="dx1-74001"></a> or <span class="cmss-10">letter</span><a - id="dx1-26049"></a>. The default is word ordering. - <!--l. 4028--><p class="noindent" ><div class="important" title="Important Note"> Note that the <span + id="dx1-74002"></a>. The default is word ordering. +</p><!--l. 4648--><p class="indent" > <div class="important" title="Important Note"> Note that with Options <a +href="#option2">2</a> and <a +href="#option3">3</a>, the <span class="cmss-10">order</span><a - id="dx1-26050"></a> option has no effect if you don’t use <a + id="dx1-74003"></a> option has no effect if you don’t use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-26051"></a></a>. - </div> - </p><!--l. 4031--><p class="noindent" > - </p><!--l. 4033--><p class="noindent" >If you use <a + id="dx1-74004"></a></a>. +</div> +</p><!--l. 4651--><p class="noindent" > +</p><!--l. 4653--><p class="indent" > If you use <a href="#option1">Option 1</a>, this setting will be used if you use <span -class="cmss-10">sort</span><a - id="dx1-26052"></a><span -class="cmtt-10">=standard </span>in the optional - argument of <span +class="cmtt-10">sort</span><a + id="dx1-74005"></a><span +class="cmtt-10">=standard </span>in the optional argument of +<span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-26053"></a>: - - + id="dx1-74006"></a>: + + </p> - <div class="verbatim" id="verbatim-104"> - \printnoidxglossary[sort=standard] + <div class="verbatim" id="verbatim-96"> +\printnoidxglossary[sort=standard] </div> - <!--l. 4038--><p class="nopar" > Alternatively, you can specify the order for individual glossaries: - - +<!--l. 4658--><p class="nopar" > Alternatively, you can specify the order for individual glossaries: + + </p> - <div class="verbatim" id="verbatim-105"> - \printnoidxglossary[sort=word] -  <br />\printnoidxglossary[type=acronym,sort=letter] + <div class="verbatim" id="verbatim-97"> +\printnoidxglossary[sort=word] + <br />\printnoidxglossary[type=acronym,sort=letter] </div> - <!--l. 4043--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 4663--><p class="nopar" > +</p><!--l. 4665--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-74007"></a></a>, use the <span id="textcolor233"><span +class="cmtt-10">break-at</span></span><a + id="dx1-74008"></a> option in <span id="textcolor234"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-74009"></a> instead of <span +class="cmss-10">order</span>. </div> +</p><!--l. 4668--><p class="noindent" > +</p><!--l. 4670--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-750002.5"></a><a id="pkgopt:makeindex"></a><span -class="cmssbx-10">makeindex</span><a - id="dx1-26054"></a> </dt><dd -class="description">(<a -href="#option2">Option 2</a>) The glossary information and indexing style file will be written in - <a +class="cmss-10">makeindex</span></h4> +<!--l. 4670--><p class="noindent" >(<a +href="#option2">Option 2</a>) The glossary information and indexing style file will be written in <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26055"></a></a> format. If you use <a + id="dx1-75001"></a></a> format. If you use +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-26056"></a></a>, it will automatically detect that it - needs to call <span + id="dx1-75002"></a></a>, it will automatically detect that it needs to call <span class="cmtt-10">makeindex</span><a - id="dx1-26057"></a>. If you don’t use <span + id="dx1-75003"></a>. If you don’t use <span class="cmtt-10">makeglossaries</span><a - id="dx1-26058"></a>, you need to remember - to use <span + id="dx1-75004"></a>, +you need to remember to use <span class="cmtt-10">makeindex</span><a - id="dx1-26059"></a> not <a + id="dx1-75005"></a> not <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26060"></a></a>. The indexing style file will been given a <span -class="cmtt-10">.ist</span><a - id="dx1-26061"></a> - extension. - <!--l. 4053--><p class="noindent" >You may omit this package option if you are using <a -href="#option2">Option 2</a> as this is the default. It’s - available in case you need to override the effect of an earlier occurrence of <span + id="dx1-75006"></a></a>. The indexing style file will been given a <span +class="cmtt-10">ist</span><a + id="dx1-75007"></a> +extension. +</p><!--l. 4678--><p class="indent" > You may omit this package option if you are using <a +href="#option2">Option 2</a> as this is the default. It’s available in case you +need to override the effect of an earlier occurrence of <span class="cmss-10">xindy</span><a - id="dx1-26062"></a> in the - package option list. - </p></dd><dt class="description"> -<a + id="dx1-75008"></a> in the package option list. +</p><!--l. 4682--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-760002.5"></a><a id="pkgopt:xindy"></a><span -class="cmssbx-10">xindy</span><a - id="dx1-26063"></a> </dt><dd -class="description">(<a -href="#option3">Option 3</a>) The glossary information and indexing style file will be written in - <a +class="cmss-10">xindy</span></h4> +<!--l. 4682--><p class="noindent" >(<a +href="#option3">Option 3</a>) The glossary information and indexing style file will be written in <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26064"></a></a> format. If you use <a + id="dx1-76001"></a></a> format. If you use +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-26065"></a></a>, it will automatically detect that it - needs to call <span + id="dx1-76002"></a></a>, it will automatically detect that it needs to call <span class="cmtt-10">xindy</span><a - id="dx1-26066"></a>. If you don’t use <span + id="dx1-76003"></a>. If you don’t use <span class="cmtt-10">makeglossaries</span><a - id="dx1-26067"></a>, you need to remember - to use <span + id="dx1-76004"></a>, +you need to remember to use <span class="cmtt-10">xindy</span><a - id="dx1-26068"></a> not <a + id="dx1-76005"></a> not <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26069"></a></a>. The indexing style file will been given a <span -class="cmtt-10">.xdy</span><a - id="dx1-26070"></a> - extension. - <!--l. 4064--><p class="noindent" >This package option may additionally have a value that is a ⟨<span + id="dx1-76006"></a></a>. The indexing style file will been given a <span +class="cmtt-10">xdy</span><a + id="dx1-76007"></a> +extension. +</p><!--l. 4689--><p class="indent" > This package option may additionally have a value that is a ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ comma-separated - list to override the language and codepage. For example: - - +class="cmti-10">value</span>⟩ comma-separated list to override the +language and codepage. For example: + + </p> - <div class="verbatim" id="verbatim-106"> - \usepackage[xindy={language=english,codepage=utf8}] -  <br />  {glossaries} + <div class="verbatim" id="verbatim-98"> +\usepackage[xindy={language=english,codepage=utf8}] + <br />  {glossaries} </div> - <!--l. 4070--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to - true, but can be suppressed. For example: - - +<!--l. 4695--><p class="nopar" > You can also specify whether you want a number group in the glossary. This defaults to true, but can be +suppressed. For example: + + </p> - <div class="verbatim" id="verbatim-107"> - \usepackage[xindy={glsnumbers=false}]{glossaries} + <div class="verbatim" id="verbatim-99"> +\usepackage[xindy={glsnumbers=false}]{glossaries} </div> - <!--l. 4075--><p class="nopar" > If no value is supplied to this package option (either simply writing <span -class="cmtt-10">xindy </span>or writing - <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">xindy={}</span></span></span>) then the language, codepage and number group settings are unchanged. See - <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a -href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on using <a +<!--l. 4700--><p class="nopar" > If no value is supplied to this package option (either simply writing <span +class="cmtt-10">xindy </span>or writing <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">xindy={}</span></span></span>) then the +language, codepage and number group settings are unchanged. See <a +href="#sec:xindy">§11 </a><a +href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details on +using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26071"></a></a> with the <span -class="cmss-10">glossaries</span> - package. - </p></dd><dt class="description"> -<a + id="dx1-76008"></a></a> with the <span +class="cmss-10">glossaries </span>package. +</p><!--l. 4707--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-770002.5"></a><a id="pkgopt:xindygloss"></a><span -class="cmssbx-10">xindygloss</span><a - id="dx1-26072"></a> </dt><dd -class="description">(<a +class="cmss-10">xindygloss</span></h4> +<!--l. 4707--><p class="noindent" >(<a href="#option3">Option 3</a>) This is equivalent to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">xindy={}</span></span></span> (that is, the <span class="cmss-10">xindy</span><a - id="dx1-26073"></a> option without any - value supplied) and may be used as a document class option. The language and code - page can be set via <span + id="dx1-77001"></a> option without any value supplied) and may be +used as a document class option. The language and code page can be set via <span class="cmtt-10">\GlsSetXdyLanguage</span><a - id="dx1-26074"></a> and <span + id="dx1-77002"></a> and +<span class="cmtt-10">\GlsSetXdyCodePage</span><a - id="dx1-26075"></a> (see <a -href="#sec:langenc"><span -class="tcrm-1000">§</span>11.1 - </a><a + id="dx1-77003"></a> (see <a +href="#sec:langenc">§11.1 </a><a href="#sec:langenc">Language and Encodings<!--tex4ht:ref: sec:langenc --></a>.) - </dd><dt class="description"> -<a +</p><!--l. 4713--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-780002.5"></a><a id="pkgopt:xindynoglsnumbers"></a><span -class="cmssbx-10">xindynoglsnumbers</span><a - id="dx1-26076"></a> </dt><dd -class="description">(<a +class="cmss-10">xindynoglsnumbers</span></h4> +<!--l. 4713--><p class="noindent" >(<a href="#option3">Option 3</a>) This is equivalent to <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">xindy={glsnumbers=false}</span></span></span> and may - be used as a document class option. - </dd><dt class="description"> -<a +class="cmtt-10">xindy={glsnumbers=false}</span></span></span> and may be used as a document class +option. +</p><!--l. 4717--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-790002.5"></a><a id="pkgopt:automake"></a><span -class="cmssbx-10">automake</span><a - id="dx1-26077"></a> </dt><dd -class="description">This is option was introduced to version 4.08 as a boolean option. As from version - 4.42 it may now take three values: <span +class="cmss-10">automake=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4717--><p class="noindent" >This is option was introduced to version 4.08 as a boolean option. As from version 4.42 it may now take three +values: <span class="cmtt-10">false </span>(default), <span class="cmtt-10">true </span>or <span -class="cmtt-10">immediate</span>. If no option is - supplied, <span -class="cmtt-10">immediate </span>is assumed. The option <span -class="cmss-10">automake=true</span><a - id="dx1-26078"></a> will attempt to run - <a +class="cmtt-10">immediate</span>. If no option is supplied, <span +class="cmtt-10">immediate </span>is assumed. The +option <span +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-79001"></a> will attempt to run <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26079"></a></a> or <a + id="dx1-79002"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26080"></a></a> using <span class="TEX">T<span + id="dx1-79003"></a></a> using <span class="TEX">T<span class="E">E</span>X</span>’s <span class="cmtt-10">\write18</span><a - id="dx1-26081"></a> mechanism at the end of the document. - The option <span -class="cmss-10">automake=immediate</span><a - id="dx1-26082"></a> will attempt to run <a + id="dx1-79004"></a> mechanism +at the end of the document. The option <span +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">immediate</span><a + id="dx1-79005"></a> will attempt to run <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26083"></a></a> or <a + id="dx1-79006"></a></a> or +<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26084"></a></a> at the start - of <span + id="dx1-79007"></a></a> at the start of <span class="cmtt-10">\makeglossaries</span><a - id="dx1-26085"></a> using <span + id="dx1-79008"></a> using <span class="cmtt-10">\immediate </span>(before the glossary files have been - opened). - <!--l. 4103--><p class="noindent" >In the case of <span -class="cmss-10">automake=true</span><a - id="dx1-26086"></a>, the associated files are created at the end of the - document ready for the next <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run. Since there is a possibility of commands such - as <span -class="cmtt-10">\gls </span>occurring on the last page of the document, it’s not possible to use <span -class="cmtt-10">\immediate</span> - to close the associated file or with <span -class="cmtt-10">\write18 </span>since the writing of the final - indexing lines may have been delayed. In certain situations this can mean that - the <span +opened). +</p><!--l. 4728--><p class="indent" > In the case of <span +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-79009"></a>, the associated files are created at the end of the document ready for +the next <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. Since there is a possibility of commands such as <span +class="cmtt-10">\gls </span>occurring on the +last page of the document, it’s not possible to use <span +class="cmtt-10">\immediate </span>to close the associated file or with +<span +class="cmtt-10">\write18 </span>since the writing of the final indexing lines may have been delayed. In certain situations +this can mean that the <span class="cmtt-10">\write18 </span>fails. In such cases, you will need to use <span -class="cmss-10">automake=immediate</span><a - id="dx1-26087"></a> - instead. - </p><!--l. 4113--><p class="noindent" >With <span -class="cmss-10">automake=immediate</span><a - id="dx1-26088"></a>, you will get a warning on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run as the - associated glossary files don’t exist yet. - </p><!--l. 4117--><p class="noindent" >Since this mechanism can be a security risk, some <span class="TEX">T<span -class="E">E</span>X</span> distributions disable it - completely, in which case this option won’t have an effect. (If this option doesn’t appear - to work, search the log file for “runsystem” and see if it is followed by “enabled” or - “disabled”.) - </p><!--l. 4123--><p class="noindent" >Some distributions allow <span -class="cmtt-10">\write18 </span>in a restricted mode. This mode has a limited - number of trusted applications, which usually includes <a +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">immediate</span><a + id="dx1-79010"></a> +instead. +</p><!--l. 4738--><p class="indent" > With <span +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">immediate</span><a + id="dx1-79011"></a>, you will get a warning on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run as the associated glossary files +don’t exist yet. + + +</p><!--l. 4742--><p class="indent" > Since this mechanism can be a security risk, some <span class="TEX">T<span +class="E">E</span>X</span> distributions disable it completely, in which case +this option won’t have an effect. (If this option doesn’t appear to work, search the log file for “runsystem” and +see if it is followed by “enabled” or “disabled”.) +</p><!--l. 4748--><p class="indent" > Some distributions allow <span +class="cmtt-10">\write18 </span>in a restricted mode. This mode has a limited number of trusted +applications, which usually includes <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-26089"></a></a> but may not include - <a + id="dx1-79012"></a></a> but may not include <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26090"></a></a>. So if you have the restricted mode on, <span + id="dx1-79013"></a></a>. So if you have the restricted mode +on, <span class="cmss-10">automake</span><a - id="dx1-26091"></a> should work with <span + id="dx1-79014"></a> should work with <span class="cmtt-10">makeindex</span><a - id="dx1-26092"></a> - but may not work with <a + id="dx1-79015"></a> but may not work with <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-26093"></a></a>. - - - </p><!--l. 4129--><p class="noindent" >However even in unrestricted mode this option may not work with <span + id="dx1-79016"></a></a>. +</p><!--l. 4754--><p class="indent" > However even in unrestricted mode this option may not work with <span class="cmtt-10">xindy</span><a - id="dx1-26094"></a> as <span + id="dx1-79017"></a> as <span class="cmtt-10">xindy</span><a - id="dx1-26095"></a> uses - language names that don’t always correspond with <span + id="dx1-79018"></a> uses language names that +don’t always correspond with <span class="cmtt-10">\babel</span><a - id="dx1-26096"></a>’s language names. (The - <a + id="dx1-79019"></a>’s language names. (The <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-26097"></a></a> script applies mappings to assist you.) Note that you still need - at least two <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-79020"></a></a> script applies mappings to assist +you.) Note that you still need at least two <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> runs to ensure the document is up-to-date with this - setting. - </p><!--l. 4136--><p class="noindent" >Since this package option attempts to run the <a -href="#glo:indexingapp">indexing application</a> on every - <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> run, its use should be considered a last resort for those who can’t work out - how to incorporate the indexing application into their document build. The default - value for this option is <span -class="cmss-10">automake=false</span><a - id="dx1-26098"></a>. +setting. +</p><!--l. 4761--><p class="indent" > Since this package option attempts to run the <a +href="#glo:indexingapp">indexing application</a> on every <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run, its use should be +considered a last resort for those who can’t work out how to incorporate the indexing application into their +document build. The default value for this option is <span +class="cmss-10">automake</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-79021"></a>. +</p><!--l. 4767--><p class="noindent" > </p> - </dd></dl> -<!--l. 4144--><p class="noindent" > + <h4 class="likesubsectionHead"><a + id="x1-800002.5"></a><a + id="pkgopt:disablemakegloss"></a><span +class="cmss-10">disablemakegloss</span></h4> +<!--l. 4767--><p class="noindent" >This valueless option indicates that <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-80001"></a> and <span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-80002"></a> should be disabled. This +option is provided in the event that you have to use a class or package that disregards the advice in <a +href="#sec:indexingoptions">§1.1 </a><a +href="#sec:indexingoptions">Indexing +Options<!--tex4ht:ref: sec:indexingoptions --></a> and automatically performs <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-80003"></a> or <span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-80004"></a> but you don’t want this. (For +example, you want to use a different indexing method or you want to disable indexing while working on a draft +document.) +</p><!--l. 4777--><p class="indent" > This option may be passed in the standard document class option list or passed using <span +class="cmtt-10">\PassOptionsToPackage</span> +before <span +class="cmss-10">glossaries</span><a + id="dx1-80005"></a> is loaded. Note that this does nothing if <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-80006"></a> or <span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-80007"></a> has +already been used whilst enabled. +</p><!--l. 4783--><p class="noindent" > </p> -<!--l. 4144--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.5 </span> <a - id="sec:pkgopts-acronym"></a>Acronym Options</h3> - <dl class="description"><dt class="description"> -<a + <h4 class="likesubsectionHead"><a + id="x1-810002.5"></a><a + id="pkgopt:restoremakegloss"></a><span +class="cmss-10">restoremakegloss</span></h4> +<!--l. 4783--><p class="noindent" >Cancels the effect of <span +class="cmss-10">disablemakegloss</span><a + id="dx1-81001"></a>. This option may be used in <span +class="cmtt-10">\setupglossaries</span>. It issues a +warning if <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-81002"></a> or <span +class="cmtt-10">\makenoidxglossaries</span><a + id="dx1-81003"></a> has already been used whilst enabled. For +example, suppose the class <span +class="cmss-10">customclass.cls </span>automatically loads <span +class="cmss-10">glossaries </span>and does <span +class="cmtt-10">\makeglossaries</span> +but you need an extra glossary, which has to be defined before <span +class="cmtt-10">\makeglossaries</span>, then you can +do: + + +</p> + <div class="verbatim" id="verbatim-100"> +\documentclass[disablemakegloss]{customclass} + <br />\newglossary*{functions}{Functions} + <br />\setupglossaries{restoremakegloss} + <br />\makeglossaries +</div> +<!--l. 4796--><p class="nopar" > or + + +</p> + <div class="verbatim" id="verbatim-101"> +\PassOptionsToPackage{disablemakegloss}{glossaries} + <br />\documentclass{customclass} + <br />\newglossary*{functions}{Functions} + <br />\setupglossaries{restoremakegloss} + <br />\makeglossaries +</div> +<!--l. 4804--><p class="nopar" > +</p><!--l. 4806--><p class="indent" > Note that restoring these commands doesn’t necessarily mean that they can be used. It just means that their +normal behaviour given the current settings will apply. For example, if you use the <span id="textcolor235"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">only</span></span><a + id="dx1-81004"></a> or <span id="textcolor236"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-81005"></a> +options with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> then you can’t use <span +class="cmtt-10">\makeglossaries </span>or <span +class="cmtt-10">\makenoidxglossaries </span>regardless of +<span +class="cmss-10">restoremakegloss</span><a + id="dx1-81006"></a>. +</p><!--l. 4813--><p class="noindent" > +</p> +<!--l. 4813--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.6 </span> <a + id="sec:pkgopts-type"></a>Glossary Type Options</h3> +<!--l. 4816--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-830002.6"></a><a + id="pkgopt:nohypertypes"></a><span +class="cmss-10">nohypertypes=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">list</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4816--><p class="noindent" >Use this option if you have multiple glossaries and you want to suppress the entry hyperlinks for a particular +glossary or glossaries. The value of this option should be a comma-separated list of glossary types where <span +class="cmtt-10">\gls</span><a + id="dx1-83001"></a> +etc shouldn’t have hyperlinks by default. Make sure you enclose the value in braces if it contains any commas. +Example: + + +</p> + <div class="verbatim" id="verbatim-102"> +\usepackage[acronym,nohypertypes={acronym,notation}] + <br />  {glossaries} + <br />\newglossary[nlg]{notation}{not}{ntn}{Notation} +</div> +<!--l. 4826--><p class="nopar" > The values must be fully expanded, so <strong>don’t</strong> try <span +class="cmtt-10">nohypertypes=\acronymtype</span><a + id="dx1-83002"></a>. You may also +use +</p><!--l. 4830--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">\GlsDeclareNoHyperList</span><a + id="dx1-83003"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">list</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 4831--><p class="noindent" > +instead or additionally. See <a +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details. +</p><!--l. 4835--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-840002.6"></a><a + id="pkgopt:nomain"></a><span +class="cmss-10">nomain</span></h4> +<!--l. 4835--><p class="noindent" >This suppresses the creation of the main glossary and associated <span +class="cmtt-10">glo</span><a + id="dx1-84001"></a> file, if unrequired. Note that if you use this +option, you must create another glossary in which to put all your entries (either via the <span +class="cmss-10">acronym</span><a + id="dx1-84002"></a> (or <span +class="cmss-10">acronyms</span><a + id="dx1-84003"></a>) +package option described in <a +href="#sec:pkgopts-acronym">§2.7 </a><a +href="#sec:pkgopts-acronym">Acronym and Abbreviation Options<!--tex4ht:ref: sec:pkgopts-acronym --></a> or via the <span +class="cmss-10">symbols</span><a + id="dx1-84004"></a>, <span +class="cmss-10">numbers</span><a + id="dx1-84005"></a> or +<span +class="cmss-10">index</span><a + id="dx1-84006"></a> options described in <a +href="#sec:pkgopts-other">§2.8 </a><a +href="#sec:pkgopts-other">Other Options<!--tex4ht:ref: sec:pkgopts-other --></a> or via <span +class="cmtt-10">\newglossary</span><a + id="dx1-84007"></a> described in <a +href="#sec:newglossary">§12 </a><a +href="#sec:newglossary">Defining New +Glossaries<!--tex4ht:ref: sec:newglossary --></a>). +</p><!--l. 4845--><p class="indent" > <div class="important" title="Important Note"> If you don’t use the main glossary and you don’t use this option, <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-84008"></a></a> will produce a warning. +</div> +</p><!--l. 4848--><p class="noindent" > +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">Warning:</span><span +class="cmtt-10"> File</span><span +class="cmtt-10"> '</span><span +class="cmitt-10">filename</span><span +class="cmtt-10">.glo'</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> empty.</span> +<br /><span +class="cmtt-10">Have</span><span +class="cmtt-10"> you</span><span +class="cmtt-10"> used</span><span +class="cmtt-10"> any</span><span +class="cmtt-10"> entries</span><span +class="cmtt-10"> defined</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> glossary</span> +<br /><span +class="cmtt-10">'main'?</span> +<br /><span +class="cmtt-10">Remember</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> use</span><span +class="cmtt-10"> package</span><span +class="cmtt-10"> option</span><span +class="cmtt-10"> 'nomain'</span><span +class="cmtt-10"> if</span> +<br /><span +class="cmtt-10">you</span><span +class="cmtt-10"> don't</span><span +class="cmtt-10"> want</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> use</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> main</span><span +class="cmtt-10"> glossary.</span> +</div> +</div> If you did actually want to use the main glossary and you see this warning, check that you have referenced the +entries in that glossary via commands such as <span +class="cmtt-10">\gls</span><a + id="dx1-84009"></a>. +<!--l. 4860--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-850002.6"></a><a + id="pkgopt:symbols"></a><span +class="cmss-10">symbols</span></h4> +<!--l. 4860--><p class="noindent" >This valueless option defines a new glossary type with the label <span +class="cmtt-10">symbols </span>via + + +</p> + <div class="verbatim" id="verbatim-103"> +\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} +</div> +<!--l. 4864--><p class="nopar" > It also defines +</p><!--l. 4866--><p class="indent" > <hr><div title="Definition"><a + id="dx1-85001"></a> <span +class="cmtt-10">\printsymbols[</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">] </span></div><hr> +</p><!--l. 4868--><p class="noindent" > +which is a synonym for </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printglossary</span><a + id="dx1-85002"></a><span +class="cmtt-10">[type=symbols,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> +<!--l. 4874--><p class="indent" > If you use <a +href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printnoidxglossary</span><a + id="dx1-85003"></a><span +class="cmtt-10">[type=symbols,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> to display the list of symbols. +<!--l. 4880--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span +class="cmss-10">nomain</span><a + id="dx1-85004"></a> package option if you’re only interested in using this <span +class="cmtt-10">symbols </span>glossary and +don’t intend to use the <span +class="cmtt-10">main </span>glossary. </div> +</p><!--l. 4884--><p class="noindent" > +</p><!--l. 4886--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has a slightly modified version of this option which additionally provides +<span id="textcolor237"><span +class="cmtt-10">\glsxtrnewsymbol</span></span><a + id="dx1-85005"></a> as a convenient shortcut method for defining symbols. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for +further details. </div> +</p><!--l. 4891--><p class="noindent" > +</p><!--l. 4893--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-860002.6"></a><a + id="pkgopt:numbers"></a><span +class="cmss-10">numbers</span></h4> +<!--l. 4893--><p class="noindent" >This valueless option defines a new glossary type with the label <span +class="cmtt-10">numbers </span>via + + +</p> + <div class="verbatim" id="verbatim-104"> +\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} +</div> +<!--l. 4897--><p class="nopar" > It also defines +</p><!--l. 4899--><p class="indent" > <hr><div title="Definition"><a + id="dx1-86001"></a> <span +class="cmtt-10">\printnumbers[</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">] </span></div><hr> +</p><!--l. 4901--><p class="noindent" > +which is a synonym for </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printglossary</span><a + id="dx1-86002"></a><span +class="cmtt-10">[type=numbers,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> +<!--l. 4907--><p class="indent" > If you use <a +href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printnoidxglossary</span><a + id="dx1-86003"></a><span +class="cmtt-10">[type=numbers,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> to display the list of numbers. +<!--l. 4913--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span +class="cmss-10">nomain</span><a + id="dx1-86004"></a> package option if you’re only interested in using this <span +class="cmtt-10">numbers </span>glossary and +don’t intend to use the <span +class="cmtt-10">main </span>glossary. </div> +</p><!--l. 4917--><p class="noindent" > +</p><!--l. 4919--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has a slightly modified version of this option which additionally provides +<span id="textcolor238"><span +class="cmtt-10">\glsxtrnewnumber</span></span><a + id="dx1-86005"></a> as a convenient shortcut method for defining numbers. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for +further details. </div> +</p><!--l. 4924--><p class="noindent" > +</p><!--l. 4926--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-870002.6"></a><a + id="pkgopt:index"></a><span +class="cmss-10">index</span></h4> +<!--l. 4926--><p class="noindent" >This valueless option defines a new glossary type with the label <span +class="cmtt-10">index </span>via + + +</p> + <div class="verbatim" id="verbatim-105"> +\newglossary[ilg]{index}{ind}{idx}{\indexname}% +</div> +<!--l. 4930--><p class="nopar" > It also defines +</p><!--l. 4932--><p class="indent" > <hr><div title="Definition"><a + id="dx1-87001"></a> <span +class="cmtt-10">\newterm[</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]{</span>⟨<span +class="cmitt-10">term</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 4934--><p class="noindent" > +which is a synonym for </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-87002"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">term</span>⟩<span +class="cmtt-10">}[type=index,name={</span>⟨<span +class="cmitt-10">term</span>⟩<span +class="cmtt-10">},%</span> +<br /><span +class="cmtt-10">description=\nopostdesc</span><a + id="dx1-87003"></a><span +class="cmtt-10">,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> and +<!--l. 4941--><p class="indent" > <hr><div title="Definition"><a + id="dx1-87004"></a> <span +class="cmtt-10">\printindex[</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">] </span></div><hr> +</p><!--l. 4943--><p class="noindent" > +which is a synonym for </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printglossary</span><a + id="dx1-87005"></a><span +class="cmtt-10">[type=index,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> +<!--l. 4949--><p class="indent" > If you use <a +href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printnoidxglossary</span><a + id="dx1-87006"></a><span +class="cmtt-10">[type=index,</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]</span> +</div> +</div> to display this glossary. +<!--l. 4955--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span +class="cmss-10">nomain</span><a + id="dx1-87007"></a> package option if you’re only interested in using this <span +class="cmtt-10">index </span>glossary and +don’t intend to use the <span +class="cmtt-10">main </span>glossary. Note that you can’t mix this option with <span +class="cmtt-10">\index</span><a + id="dx1-87008"></a>. Either use +<span +class="cmss-10">glossaries </span>for the indexing or use a custom indexing package, such as <span +class="cmss-10">makeidx</span><a + id="dx1-87009"></a>, <span +class="cmss-10">index</span><a + id="dx1-87010"></a> or <span +class="cmss-10">imakeidx</span><a + id="dx1-87011"></a>. (You +can, of course, load one of those packages and load <span +class="cmss-10">glossaries </span>without the <span +class="cmss-10">index</span><a + id="dx1-87012"></a> package option.) +</div> +</p><!--l. 4964--><p class="noindent" > +</p><!--l. 4966--><p class="indent" > Since the index isn’t designed for terms with descriptions, you might also want to disable the hyperlinks for +this glossary using the package option <span +class="cmss-10">nohypertypes</span><span +class="cmtt-10">=</span><span +class="cmss-10">index</span><a + id="dx1-87013"></a> or the command <spacer type=vertical size=10><span class="obeylines-h"> + <br /><span +class="cmtt-10">\GlsDeclareNoHyperList</span><a + id="dx1-87014"></a><span class="verb"><span +class="cmtt-10">{index}</span></span> + <br /><spacer type=vertical size=10></span> +</p><!--l. 4973--><p class="indent" > The example file <a +href="#ex:sample-index"><span +class="cmtt-10">sample-index.tex</span></a> illustrates the use of the <span +class="cmss-10">index</span><a + id="dx1-87015"></a> package option. + + +</p><!--l. 4976--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-880002.6"></a><a + id="pkgopt:noglossaryindex"></a><span +class="cmss-10">noglossaryindex</span></h4> +<!--l. 4976--><p class="noindent" >This valueless option switches off <span +class="cmss-10">index</span><a + id="dx1-88001"></a> if <span +class="cmss-10">index</span><a + id="dx1-88002"></a> has been passed implicitly (for example, through global +document options). This option can’t be used in <span +class="cmtt-10">\setupglossaries</span>. +</p><!--l. 4982--><p class="noindent" > +</p> +<!--l. 4982--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.7 </span> <a + id="sec:pkgopts-acronym"></a>Acronym and Abbreviation Options</h3> +<!--l. 4985--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-900002.7"></a><a id="pkgopt:acronym"></a><span -class="cmssbx-10">acronym</span><a - id="dx1-27001"></a> </dt><dd -class="description">This creates a new glossary with the label <span -class="cmtt-10">acronym</span>. This is equivalent - to: - - - <div class="verbatim" id="verbatim-108"> - \newglossary[alg]{acronym}{acr}{acn}{\acronymname} -</div> - <!--l. 4152--><p class="nopar" > It will also define - </p><!--l. 4154--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printacronyms</span><span -class="cmtt-9"> </span></span><a - id="dx1-27002"></a> <span +class="cmss-10">acronym=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 4985--><p class="noindent" >If true, this creates a new glossary with the label <span +class="cmtt-10">acronym</span>. This is equivalent to: + + +</p> + <div class="verbatim" id="verbatim-106"> +\newglossary[alg]{acronym}{acr}{acn}{\acronymname} +</div> +<!--l. 4989--><p class="nopar" > It will also define +</p><!--l. 4991--><p class="indent" > <hr><div title="Definition"><a + id="dx1-90001"></a> <span class="cmtt-10">\printacronyms[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 4156--><p class="noindent" > - that’s equivalent to </p><div class="alltt"> - <div class="obeylines-v"> - <span +</p><!--l. 4993--><p class="noindent" > +that’s equivalent to </p><div class="alltt"> +<div class="obeylines-v"> +<span class="cmtt-10">\printglossary</span><a - id="dx1-27003"></a><span + id="dx1-90002"></a><span class="cmtt-10">[type=acronym,</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]</span> </div> - </div> (unless that command is already defined before the beginning of the document or the - package option <span +</div> (unless that command is already defined before the beginning of the document or the package option +<span class="cmss-10">compatible-3.07</span><a - id="dx1-27004"></a> is used). - <!--l. 4164--><p class="noindent" >If you are using <a + id="dx1-90003"></a> is used). +<!--l. 5001--><p class="indent" > If you are using <a href="#option1">Option 1</a>, you need to use </p><div class="alltt"> - <div class="obeylines-v"> - <span +<div class="obeylines-v"> +<span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-27005"></a><span + id="dx1-90004"></a><span class="cmtt-10">[type=acronym,</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]</span> </div> - </div> to display the list of acronyms. - <!--l. 4170--><p class="noindent" >If the <span +</div> to display the list of acronyms. +<!--l. 5007--><p class="indent" > If the <span class="cmss-10">acronym</span><a - id="dx1-27006"></a> package option is used, <span + id="dx1-90005"></a> package option is used, <span class="cmtt-10">\acronymtype</span><a - id="dx1-27007"></a> is set to <span + id="dx1-90006"></a> is set to <span class="cmtt-10">acronym </span>otherwise it is set to - <span +<span class="cmtt-10">main</span>.<span class="footnote-mark"><a -href="#fn4x2" id="fn4x2-bk"><sup class="textsuperscript">2.4</sup></a></span><a - id="x1-27008f4"></a> - Entries that are defined using <span +href="#fn5x2" id="fn5x2-bk"><sup class="textsuperscript">2.5</sup></a></span><a + id="x1-90007f5"></a> +Entries that are defined using <span class="cmtt-10">\newacronym</span><a - id="dx1-27014"></a> are placed in the glossary whose label is - given by <span + id="dx1-90013"></a> are placed in the glossary whose label is given by <span class="cmtt-10">\acronymtype</span><a - id="dx1-27015"></a>, unless another glossary is explicitly specified. - </p><!--l. 4180--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span + id="dx1-90014"></a>, +unless another glossary is explicitly specified. +</p><!--l. 5017--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span class="cmss-10">nomain</span><a - id="dx1-27016"></a> package option if you’re only interested in using - this <span -class="cmtt-10">acronym </span>glossary. (That is, you don’t intend to use the <span -class="cmtt-10">main </span>glossary.) - </div> - </p><!--l. 4184--><p class="noindent" > - </p></dd><dt class="description"> -<a + id="dx1-90015"></a> package option if you’re only interested in using this <span +class="cmtt-10">acronym </span>glossary. (That +is, you don’t intend to use the <span +class="cmtt-10">main </span>glossary.) </div> +</p><!--l. 5021--><p class="noindent" > +</p><!--l. 5023--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package comes with an analogous <span id="textcolor239"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-90016"></a> option, which creates a new +glossary with the label <span +class="cmtt-10">abbreviations </span>and sets the command <span id="textcolor240"><span +class="cmtt-10">\glsxtrabbrvtype</span></span><a + id="dx1-90017"></a> to this. If the <span +class="cmss-10">acronym</span><a + id="dx1-90018"></a> option +hasn’t also been used, then <span +class="cmtt-10">\acronymtype</span><a + id="dx1-90019"></a> will be set to <span id="textcolor241"><span +class="cmtt-10">\glsxtrabbrvtype</span></span><a + id="dx1-90020"></a>. This enables both <span +class="cmtt-10">\newacronym</span><a + id="dx1-90021"></a> +and <span id="textcolor242"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-90022"></a> to use the same glossary. +</p><!--l. 5032--><p class="indent" > Make sure you have at least v1.42 of <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> if you use the <span +class="cmss-10">acronym</span><a + id="dx1-90023"></a> (or <span +class="cmss-10">acronyms</span><a + id="dx1-90024"></a>) package option +with the extension package to avoid a bug that interferes with the abbreviation style. </div> +</p><!--l. 5036--><p class="noindent" > +</p><!--l. 5038--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-910002.7"></a><a id="pkgopt:acronyms"></a><span -class="cmssbx-10">acronyms</span><a - id="dx1-27017"></a> </dt><dd -class="description">This is equivalent to <span -class="cmss-10">acronym=true</span><a - id="dx1-27018"></a> and may be used in the document class option - list. - </dd><dt class="description"> -<a +class="cmss-10">acronyms</span></h4> +<!--l. 5038--><p class="noindent" >This is equivalent to <span +class="cmss-10">acronym</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-91001"></a> and may be used in the document class option list. + + +</p><!--l. 5042--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-920002.7"></a><span id="textcolor243"><a + id="pkgopt:abbreviations"></a><span id="textcolor244"><span +class="cmss-10">abbreviations</span></span> (glossaries-extra.sty)</span></h4> +<!--l. 5044--><p class="noindent" >This valueless option creates a new glossary type using: + + +</p> + <div class="verbatim" id="verbatim-107"> +\newglossary[glg-abr]{abbreviations}{gls-abr}{glo-abr}{\abbreviationsname} +</div> +<!--l. 5047--><p class="nopar" > The label can be accessed with <span id="textcolor245"><span +class="cmtt-10">\glsxtrabbrvtype</span></span><a + id="dx1-92001"></a>, which is analogous to <span +class="cmtt-10">\acronymtype</span>. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +manual for further details. +</p><!--l. 5052--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-930002.7"></a><a id="pkgopt:acronymlists"></a><span -class="cmssbx-10">acronymlists</span><a - id="dx1-27019"></a> </dt><dd -class="description">By default, only the <span -class="cmtt-10">\acronymtype </span>glossary is considered to be a list of - acronyms. If you have other lists of acronyms, you can specify them as a - comma-separated list in the value of <span +class="cmss-10">acronymlists=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 5052--><p class="noindent" >By default, only the <span +class="cmtt-10">\acronymtype </span>glossary is considered to be a list of acronyms. If you have other lists of +acronyms, you can specify them as a comma-separated list in the value of <span class="cmss-10">acronymlists</span><a - id="dx1-27020"></a>. For example, if you use the <span + id="dx1-93001"></a>. For example, if you use +the <span class="cmss-10">acronym</span><a - id="dx1-27021"></a> - package option but you also want the <span -class="cmtt-10">main </span>glossary to also contain a list of acronyms, - you can do: - - - <div class="verbatim" id="verbatim-109"> - \usepackage[acronym,acronymlists={main}]{glossaries} -</div> - <!--l. 4198--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add - glossaries you haven’t defined yet. For example: - - -</p> - <div class="verbatim" id="verbatim-110"> - \usepackage[acronym,acronymlists={main,acronym2}] -  <br />  {glossaries} -  <br />\newglossary[alg2]{acronym2}{acr2}{acn2}% -  <br />  {Statistical Acronyms} -</div> - <!--l. 4206--><p class="nopar" > You can use - </p><!--l. 4208--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\DeclareAcronymList</span><span -class="cmtt-9"> </span></span><a - id="dx1-27022"></a> <span + id="dx1-93002"></a> package option but you also want the <span +class="cmtt-10">main </span>glossary to also contain a list of acronyms, you can +do: + + +</p> + <div class="verbatim" id="verbatim-108"> +\usepackage[acronym,acronymlists={main}]{glossaries} +</div> +<!--l. 5060--><p class="nopar" > No check is performed to determine if the listed glossaries exist, so you can add glossaries you haven’t defined +yet. For example: + + +</p> + <div class="verbatim" id="verbatim-109"> +\usepackage[acronym,acronymlists={main,acronym2}] + <br />  {glossaries} + <br />\newglossary[alg2]{acronym2}{acr2}{acn2}% + <br />  {Statistical Acronyms} +</div> +<!--l. 5068--><p class="nopar" > You can use +</p><!--l. 5070--><p class="indent" > <hr><div title="Definition"><a + id="dx1-93003"></a> <span class="cmtt-10">\DeclareAcronymList{</span>⟨<span class="cmitt-10">list</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 4210--><p class="noindent" > - instead of or in addition to the <span +</p><!--l. 5072--><p class="noindent" > +instead of or in addition to the <span class="cmss-10">acronymlists</span><a - id="dx1-27023"></a> option. This will add the glossaries given in - ⟨<span -class="cmti-10">list</span>⟩ to the list of glossaries that are identified as lists of acronyms. To replace the list of - acronym lists with a new list use: - </p><!--l. 4215--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\SetAcronymLists</span><span -class="cmtt-9"> </span></span><a - id="dx1-27024"></a> <span + id="dx1-93004"></a> option. This will add the glossaries given in ⟨<span +class="cmti-10">list</span>⟩ to the list of +glossaries that are identified as lists of acronyms. To replace the list of acronym lists with a new list +use: +</p><!--l. 5077--><p class="indent" > <hr><div title="Definition"><a + id="dx1-93005"></a> <span class="cmtt-10">\SetAcronymLists{</span>⟨<span class="cmitt-10">list</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 4217--><p class="noindent" > - </p><!--l. 4219--><p class="noindent" >You can determine if a glossary has been identified as being a list of acronyms - using: - </p><!--l. 4221--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsIfListOfAcronyms</span><span -class="cmtt-9"> </span></span><a - id="dx1-27025"></a> <span +</p><!--l. 5079--><p class="noindent" > +</p><!--l. 5081--><p class="indent" > You can determine if a glossary has been identified as being a list of acronyms using: +</p><!--l. 5083--><p class="indent" > <hr><div title="Definition"><a + id="dx1-93006"></a> <span class="cmtt-10">\glsIfListOfAcronyms{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span -class="cmtt-10">}</span> - </div><hr> - </p><!--l. 4223--><p class="noindent" > - </p></dd><dt class="description"> -<a +class="cmtt-10">} </span></div><hr> +</p><!--l. 5085--><p class="noindent" > +</p><!--l. 5087--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> This option is incompatible with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span>’s</a> abbreviation mechanism. </div> +</p><!--l. 5090--><p class="noindent" > +</p><!--l. 5092--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-940002.7"></a><a id="pkgopt:shortcuts"></a><span -class="cmssbx-10">shortcuts</span><a - id="dx1-27026"></a> </dt><dd -class="description">This option provides shortcut commands for acronyms. See <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and - Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details. Alternatively you can use: - <!--l. 4228--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\DefineAcronymSynonyms</span><span -class="cmtt-9"> </span></span><a - id="dx1-27027"></a> <span +class="cmss-10">shortcuts</span></h4> +<!--l. 5092--><p class="noindent" >This option provides shortcut commands for acronyms. See <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further +details. Alternatively you can use: +</p><!--l. 5095--><p class="indent" > <hr><div title="Definition"><a + id="dx1-94001"></a> <span class="cmtt-10">\DefineAcronymSynonyms </span></div><hr> - </p><!--l. 4230--><p class="noindent" > - </p></dd></dl> -<!--l. 4233--><p class="noindent" > +</p><!--l. 5097--><p class="noindent" > +</p><!--l. 5099--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides additional shortcuts. </div> +</p><!--l. 5101--><p class="noindent" > +</p><!--l. 5103--><p class="noindent" > </p> -<!--l. 4233--><p class="noindent" ><a -href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">2.5.1 </span> <a +<!--l. 5103--><p class="noindent" ><a +href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">2.7.1 </span> <a id="sec:pkgopts-old-acronym"></a>Deprecated Acronym Style Options</h4> -<!--l. 4236--><p class="noindent" >The package options listed in this section are now deprecated but are kept for -backward-compatibility. Use <span +<!--l. 5106--><p class="noindent" >The package options listed in this section are now deprecated but are kept for backward-compatibility. Use +<span class="cmtt-10">\setacronymstyle</span><a - id="dx1-28001"></a> instead. See <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other -Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details. - </p><dl class="description"><dt class="description"> -<a + id="dx1-95001"></a> instead. See <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details. + + +</p><!--l. 5110--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-960002.7.1"></a><a id="pkgopt:description"></a><span -class="cmssbx-10">description</span><a - id="dx1-28002"></a> </dt><dd -class="description">This option changes the definition of <span +class="cmss-10">description</span></h4> +<!--l. 5110--><p class="noindent" >This option changes the definition of <span class="cmtt-10">\newacronym</span><a - id="dx1-28003"></a> to allow a description. This - option may be replaced by - - - <div class="verbatim" id="verbatim-111"> - \setacronymstyle{long-short-desc} -</div> - <!--l. 4246--><p class="nopar" > or (with <span + id="dx1-96001"></a> to allow a description. This option may be replaced +by + + +</p> + <div class="verbatim" id="verbatim-110"> +\setacronymstyle{long-short-desc} +</div> +<!--l. 5115--><p class="nopar" > or (with <span class="cmss-10">smallcaps</span><a - id="dx1-28004"></a>) - - + id="dx1-96002"></a>) + + </p> - <div class="verbatim" id="verbatim-112"> - \setacronymstyle{long-sc-short-desc} + <div class="verbatim" id="verbatim-111"> +\setacronymstyle{long-sc-short-desc} </div> - <!--l. 4250--><p class="nopar" > or (with <span +<!--l. 5119--><p class="nopar" > or (with <span class="cmss-10">smaller</span><a - id="dx1-28005"></a>) - - + id="dx1-96003"></a>) + + </p> - <div class="verbatim" id="verbatim-113"> - \setacronymstyle{long-sm-short-desc} + <div class="verbatim" id="verbatim-112"> +\setacronymstyle{long-sm-short-desc} </div> - <!--l. 4254--><p class="nopar" > or (with <span +<!--l. 5123--><p class="nopar" > or (with <span class="cmss-10">footnote</span><a - id="dx1-28006"></a>) - - + id="dx1-96004"></a>) + + </p> - <div class="verbatim" id="verbatim-114"> - \setacronymstyle{footnote-desc} + <div class="verbatim" id="verbatim-113"> +\setacronymstyle{footnote-desc} </div> - <!--l. 4258--><p class="nopar" > or (with <span +<!--l. 5127--><p class="nopar" > or (with <span class="cmss-10">footnote</span><a - id="dx1-28007"></a> and <span + id="dx1-96005"></a> and <span class="cmss-10">smallcaps</span><a - id="dx1-28008"></a>) - - + id="dx1-96006"></a>) + + </p> - <div class="verbatim" id="verbatim-115"> - \setacronymstyle{footnote-sc-desc} + <div class="verbatim" id="verbatim-114"> +\setacronymstyle{footnote-sc-desc} </div> - <!--l. 4262--><p class="nopar" > or (with <span +<!--l. 5131--><p class="nopar" > or (with <span class="cmss-10">footnote</span><a - id="dx1-28009"></a> and <span + id="dx1-96007"></a> and <span class="cmss-10">smaller</span><a - id="dx1-28010"></a>) - - + id="dx1-96008"></a>) + + </p> - <div class="verbatim" id="verbatim-116"> - \setacronymstyle{footnote-sm-desc} + <div class="verbatim" id="verbatim-115"> +\setacronymstyle{footnote-sm-desc} </div> - <!--l. 4266--><p class="nopar" > or (with <span +<!--l. 5135--><p class="nopar" > or (with <span class="cmss-10">dua</span><a - id="dx1-28011"></a>) - - + id="dx1-96009"></a>) + + </p> - <div class="verbatim" id="verbatim-117"> - \setacronymstyle{dua-desc} + <div class="verbatim" id="verbatim-116"> +\setacronymstyle{dua-desc} </div> - <!--l. 4270--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 5139--><p class="nopar" > +</p><!--l. 5141--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-970002.7.1"></a><a id="pkgopt:smallcaps"></a><span -class="cmssbx-10">smallcaps</span><a - id="dx1-28012"></a> </dt><dd -class="description">This option changes the definition of <span +class="cmss-10">smallcaps</span></h4> +<!--l. 5141--><p class="noindent" >This option changes the definition of <span class="cmtt-10">\newacronym</span><a - id="dx1-28013"></a> and the way that acronyms are - displayed. This option may be replaced by: - - - <div class="verbatim" id="verbatim-118"> - \setacronymstyle{long-sc-short} -</div> - <!--l. 4277--><p class="nopar" > or (with <span + id="dx1-97001"></a> and the way that acronyms are displayed. This option may +be replaced by: + + +</p> + <div class="verbatim" id="verbatim-117"> +\setacronymstyle{long-sc-short} +</div> +<!--l. 5146--><p class="nopar" > or (with <span class="cmss-10">description</span><a - id="dx1-28014"></a>) - - + id="dx1-97002"></a>) + + </p> - <div class="verbatim" id="verbatim-119"> - \setacronymstyle{long-sc-short-desc} + <div class="verbatim" id="verbatim-118"> +\setacronymstyle{long-sc-short-desc} </div> - <!--l. 4281--><p class="nopar" > or (with <span +<!--l. 5150--><p class="nopar" > or (with <span class="cmss-10">description</span><a - id="dx1-28015"></a> and <span + id="dx1-97003"></a> and <span class="cmss-10">footnote</span><a - id="dx1-28016"></a>) - - + id="dx1-97004"></a>) + + </p> - <div class="verbatim" id="verbatim-120"> - \setacronymstyle{footnote-sc-desc} + <div class="verbatim" id="verbatim-119"> +\setacronymstyle{footnote-sc-desc} </div> - <!--l. 4285--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 5154--><p class="nopar" > +</p><!--l. 5156--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-980002.7.1"></a><a id="pkgopt:smaller"></a><span -class="cmssbx-10">smaller</span><a - id="dx1-28017"></a> </dt><dd -class="description">This option changes the definition of <span +class="cmss-10">smaller</span></h4> +<!--l. 5156--><p class="noindent" >This option changes the definition of <span class="cmtt-10">\newacronym</span><a - id="dx1-28018"></a> and the way that acronyms are - displayed. - <!--l. 4289--><p class="noindent" ><div class="important" title="Important Note"> If you use this option, you will need to include the <span + id="dx1-98001"></a> and the way that acronyms are displayed. +</p><!--l. 5158--><p class="indent" > <div class="important" title="Important Note"> If you use this option, you will need to include the <span class="cmss-10">relsize</span><a - id="dx1-28019"></a> package or otherwise define - <span + id="dx1-98002"></a> package or otherwise define <span class="cmtt-10">\textsmaller</span><a - id="dx1-28020"></a> or redefine <span + id="dx1-98003"></a> or +redefine <span class="cmtt-10">\acronymfont</span><a - id="dx1-28021"></a>. </div> - </p><!--l. 4293--><p class="noindent" > - This option may be replaced by: - - + id="dx1-98004"></a>. </div> +</p><!--l. 5162--><p class="noindent" > +This option may be replaced by: + + </p> - <div class="verbatim" id="verbatim-121"> - \setacronymstyle{long-sm-short} + <div class="verbatim" id="verbatim-120"> +\setacronymstyle{long-sm-short} </div> - <!--l. 4297--><p class="nopar" > or (with <span +<!--l. 5166--><p class="nopar" > or (with <span class="cmss-10">description</span><a - id="dx1-28022"></a>) - - + id="dx1-98005"></a>) + + </p> - <div class="verbatim" id="verbatim-122"> - \setacronymstyle{long-sm-short-desc} + <div class="verbatim" id="verbatim-121"> +\setacronymstyle{long-sm-short-desc} </div> - <!--l. 4301--><p class="nopar" > or (with <span +<!--l. 5170--><p class="nopar" > or (with <span class="cmss-10">description</span><a - id="dx1-28023"></a> and <span + id="dx1-98006"></a> and <span class="cmss-10">footnote</span><a - id="dx1-28024"></a>) - - + id="dx1-98007"></a>) + + </p> - <div class="verbatim" id="verbatim-123"> - \setacronymstyle{footnote-sm-desc} + <div class="verbatim" id="verbatim-122"> +\setacronymstyle{footnote-sm-desc} </div> - <!--l. 4305--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 5174--><p class="nopar" > +</p><!--l. 5176--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-990002.7.1"></a><a id="pkgopt:footnote"></a><span -class="cmssbx-10">footnote</span><a - id="dx1-28025"></a> </dt><dd -class="description">This option changes the definition of <span +class="cmss-10">footnote</span></h4> +<!--l. 5176--><p class="noindent" >This option changes the definition of <span class="cmtt-10">\newacronym</span><a - id="dx1-28026"></a> and the way that acronyms are - displayed. This option may be replaced by: - - - <div class="verbatim" id="verbatim-124"> - \setacronymstyle{footnote} -</div> - <!--l. 4312--><p class="nopar" > or (with <span + id="dx1-99001"></a> and the way that acronyms are displayed. This option may +be replaced by: + + +</p> + <div class="verbatim" id="verbatim-123"> +\setacronymstyle{footnote} +</div> +<!--l. 5181--><p class="nopar" > or (with <span class="cmss-10">smallcaps</span><a - id="dx1-28027"></a>) - - + id="dx1-99002"></a>) + + </p> - <div class="verbatim" id="verbatim-125"> - \setacronymstyle{footnote-sc} + <div class="verbatim" id="verbatim-124"> +\setacronymstyle{footnote-sc} </div> - <!--l. 4316--><p class="nopar" > or (with <span +<!--l. 5185--><p class="nopar" > or (with <span class="cmss-10">smaller</span><a - id="dx1-28028"></a>) - - + id="dx1-99003"></a>) + + </p> - <div class="verbatim" id="verbatim-126"> - \setacronymstyle{footnote-sm} + <div class="verbatim" id="verbatim-125"> +\setacronymstyle{footnote-sm} </div> - <!--l. 4320--><p class="nopar" > or (with <span +<!--l. 5189--><p class="nopar" > or (with <span class="cmss-10">description</span><a - id="dx1-28029"></a>) - - + id="dx1-99004"></a>) + + </p> - <div class="verbatim" id="verbatim-127"> - \setacronymstyle{footnote-desc} + <div class="verbatim" id="verbatim-126"> +\setacronymstyle{footnote-desc} </div> - <!--l. 4324--><p class="nopar" > or (with <span +<!--l. 5193--><p class="nopar" > or (with <span class="cmss-10">smallcaps</span><a - id="dx1-28030"></a> and <span + id="dx1-99005"></a> and <span class="cmss-10">description</span><a - id="dx1-28031"></a>) - - + id="dx1-99006"></a>) + + </p> - <div class="verbatim" id="verbatim-128"> - \setacronymstyle{footnote-sc-desc} + <div class="verbatim" id="verbatim-127"> +\setacronymstyle{footnote-sc-desc} </div> - <!--l. 4328--><p class="nopar" > or (with <span +<!--l. 5197--><p class="nopar" > or (with <span class="cmss-10">smaller</span><a - id="dx1-28032"></a> and <span + id="dx1-99007"></a> and <span class="cmss-10">description</span><a - id="dx1-28033"></a>) - - + id="dx1-99008"></a>) + + </p> - <div class="verbatim" id="verbatim-129"> - \setacronymstyle{footnote-sm-desc} + <div class="verbatim" id="verbatim-128"> +\setacronymstyle{footnote-sm-desc} </div> - <!--l. 4332--><p class="nopar" > - </p></dd><dt class="description"> -<a +<!--l. 5201--><p class="nopar" > +</p><!--l. 5203--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1000002.7.1"></a><a id="pkgopt:dua"></a><span -class="cmssbx-10">dua</span><a - id="dx1-28034"></a> </dt><dd -class="description">This option changes the definition of <span +class="cmss-10">dua</span></h4> +<!--l. 5203--><p class="noindent" >This option changes the definition of <span class="cmtt-10">\newacronym</span><a - id="dx1-28035"></a> so that acronyms are always - expanded. This option may be replaced by: - - - <div class="verbatim" id="verbatim-130"> - \setacronymstyle{dua} -</div> - <!--l. 4340--><p class="nopar" > or (with <span -class="cmss-10">description</span><a - id="dx1-28036"></a>) - - + id="dx1-100001"></a> so that acronyms are always expanded. This option may be +replaced by: + + </p> - <div class="verbatim" id="verbatim-131"> - \setacronymstyle{dua-desc} + <div class="verbatim" id="verbatim-129"> +\setacronymstyle{dua} </div> - <!--l. 4344--><p class="nopar" > +<!--l. 5208--><p class="nopar" > or (with <span +class="cmss-10">description</span><a + id="dx1-100002"></a>) + + </p> - </dd></dl> -<!--l. 4348--><p class="noindent" > + <div class="verbatim" id="verbatim-130"> +\setacronymstyle{dua-desc} +</div> +<!--l. 5212--><p class="nopar" > +</p><!--l. 5214--><p class="noindent" > </p> -<!--l. 4348--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.6 </span> <a +<!--l. 5214--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.8 </span> <a id="sec:pkgopts-other"></a>Other Options</h3> -<!--l. 4351--><p class="noindent" >Other available options that don’t fit any of the above categories are: - </p><dl class="description"><dt class="description"> -<a - id="pkgopt:symbols"></a><span -class="cmssbx-10">symbols</span><a - id="dx1-29001"></a> </dt><dd -class="description">This option defines a new glossary type with the label <span -class="cmtt-10">symbols </span>via - - - <div class="verbatim" id="verbatim-132"> - \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} -</div> - <!--l. 4358--><p class="nopar" > It also defines - </p><!--l. 4360--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printsymbols</span><span -class="cmtt-9"> </span></span><a - id="dx1-29002"></a> <span -class="cmtt-10">\printsymbols[</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">] </span></div><hr> - </p><!--l. 4362--><p class="noindent" > - which is a synonym for </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printglossary</span><a - id="dx1-29003"></a><span -class="cmtt-10">[type=symbols,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> - <!--l. 4368--><p class="noindent" >If you use <a -href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printnoidxglossary</span><a - id="dx1-29004"></a><span -class="cmtt-10">[type=symbols,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> to display the list of symbols. - <!--l. 4374--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span -class="cmss-10">nomain</span><a - id="dx1-29005"></a> package option if you’re only interested in using this - <span -class="cmtt-10">symbols </span>glossary and don’t intend to use the <span -class="cmtt-10">main </span>glossary. </div> - </p><!--l. 4378--><p class="noindent" > - </p><!--l. 4380--><p class="noindent" >The <span -class="cmss-10">glossaries-extra </span>package has a slightly modified version of this option which - additionally provides <span -class="cmtt-10">\glsxtrnewsymbol</span><a - id="dx1-29006"></a> as a convenient shortcut method for defining - symbols. See the <span -class="cmss-10">glossaries-extra </span>manual for further details. - </p></dd><dt class="description"> -<a - id="pkgopt:numbers"></a><span -class="cmssbx-10">numbers</span><a - id="dx1-29007"></a> </dt><dd -class="description">This option defines a new glossary type with the label <span -class="cmtt-10">numbers </span>via - - - <div class="verbatim" id="verbatim-133"> - \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} -</div> - <!--l. 4389--><p class="nopar" > It also defines - </p><!--l. 4391--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printnumbers</span><span -class="cmtt-9"> </span></span><a - id="dx1-29008"></a> <span -class="cmtt-10">\printnumbers[</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">] </span></div><hr> - </p><!--l. 4393--><p class="noindent" > - which is a synonym for </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printglossary</span><a - id="dx1-29009"></a><span -class="cmtt-10">[type=numbers,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> - <!--l. 4399--><p class="noindent" >If you use <a -href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printnoidxglossary</span><a - id="dx1-29010"></a><span -class="cmtt-10">[type=numbers,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> to display the list of numbers. - <!--l. 4405--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span -class="cmss-10">nomain</span><a - id="dx1-29011"></a> package option if you’re only interested in using this - <span -class="cmtt-10">numbers </span>glossary and don’t intend to use the <span -class="cmtt-10">main </span>glossary. </div> - </p><!--l. 4409--><p class="noindent" > - </p><!--l. 4411--><p class="noindent" >The <span -class="cmss-10">glossaries-extra </span>package has a slightly modified version of this option which - additionally provides <span -class="cmtt-10">\glsxtrnewnumber</span><a - id="dx1-29012"></a> as a convenient shortcut method for defining - numbers. See the <span -class="cmss-10">glossaries-extra </span>manual for further details. - </p></dd><dt class="description"> -<a - id="pkgopt:index"></a><span -class="cmssbx-10">index</span><a - id="dx1-29013"></a> </dt><dd -class="description">This option defines a new glossary type with the label <span -class="cmtt-10">index </span>via - - - <div class="verbatim" id="verbatim-134"> - \newglossary[ilg]{index}{ind}{idx}{\indexname}% -</div> - <!--l. 4420--><p class="nopar" > It also defines - </p><!--l. 4422--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newterm</span><span -class="cmtt-9"> </span></span><a - id="dx1-29014"></a> <span -class="cmtt-10">\newterm[</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]{</span>⟨<span -class="cmitt-10">term</span>⟩<span -class="cmtt-10">} </span></div><hr> - </p><!--l. 4424--><p class="noindent" > - which is a synonym for </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\newglossaryentry</span><a - id="dx1-29015"></a><span +<!--l. 5217--><p class="noindent" >Other available options that don’t fit any of the above categories are described below. +</p><!--l. 5220--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1020002.8"></a><span id="textcolor246"><a + id="pkgopt:accsupp"></a><span id="textcolor247"><span +class="cmss-10">accsupp</span></span> (glossaries-extra.sty)</span></h4> +<!--l. 5222--><p class="noindent" >Load the <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-102001"></a> package. +</p><!--l. 5224--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1030002.8"></a><span id="textcolor248"><a + id="pkgopt:prefix"></a><span id="textcolor249"><span +class="cmss-10">prefix</span></span> (glossaries-extra.sty)</span></h4> +<!--l. 5226--><p class="noindent" >Load the <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-103001"></a> package. +</p><!--l. 5228--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1040002.8"></a><span id="textcolor250"><a + id="pkgopt:nomissingglstext"></a><span id="textcolor251"><span +class="cmss-10">nomissingglstext</span></span><span +class="cmss-10">=</span><span class="cmtt-10">{</span>⟨<span -class="cmitt-10">term</span>⟩<span -class="cmtt-10">}[type=index,name={</span>⟨<span -class="cmitt-10">term</span>⟩<span -class="cmtt-10">},%</span> - <br /><span -class="cmtt-10">description=\nopostdesc</span><a - id="dx1-29016"></a><span -class="cmtt-10">,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> and - <!--l. 4431--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printindex</span><span -class="cmtt-9"> </span></span><a - id="dx1-29017"></a> <span -class="cmtt-10">\printindex[</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">] </span></div><hr> - </p><!--l. 4433--><p class="noindent" > - which is a synonym for </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printglossary</span><a - id="dx1-29018"></a><span -class="cmtt-10">[type=index,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> - <!--l. 4439--><p class="noindent" >If you use <a -href="#option1">Option 1</a>, you need to use: </p><div class="alltt"> - <div class="obeylines-v"> - <span -class="cmtt-10">\printnoidxglossary</span><a - id="dx1-29019"></a><span -class="cmtt-10">[type=index,</span>⟨<span -class="cmitt-10">options</span>⟩<span -class="cmtt-10">]</span> -</div> - </div> to display this glossary. - <!--l. 4445--><p class="noindent" ><div class="important" title="Important Note"> Remember to use the <span -class="cmss-10">nomain</span><a - id="dx1-29020"></a> package option if you’re only interested in using this - <span -class="cmtt-10">index </span>glossary and don’t intend to use the <span -class="cmtt-10">main </span>glossary. Note that you can’t mix this - option with <span -class="cmtt-10">\index</span><a - id="dx1-29021"></a>. Either use <span -class="cmss-10">glossaries </span>for the indexing or use a custom - indexing package, such as <span -class="cmss-10">makeidx</span><a - id="dx1-29022"></a>, <span -class="cmss-10">index</span><a - id="dx1-29023"></a> or <span -class="cmss-10">imakeidx</span><a - id="dx1-29024"></a>. (You can, of course, load - one of those packages and load <span -class="cmss-10">glossaries </span>without the <span -class="cmss-10">index</span><a - id="dx1-29025"></a> package option.) - </div> - </p><!--l. 4454--><p class="noindent" > - - - </p><!--l. 4456--><p class="noindent" >Since the index isn’t designed for terms with descriptions, you might also want to - disable the hyperlinks for this glossary using the package option <span -class="cmss-10">nohypertypes=index</span><a - id="dx1-29026"></a> or - the command <spacer type=vertical size=10><span class="obeylines-h"> - <br /><span -class="cmtt-10">\GlsDeclareNoHyperList</span><a - id="dx1-29027"></a><span class="verb"><span -class="cmtt-10">{index}</span></span> - <br /><spacer type=vertical size=10></span> - </p><!--l. 4463--><p class="noindent" >The example file <a -href="#x1-11100r28"><span -class="cmtt-10">sample-index.tex</span></a> illustrates the use of the <span -class="cmss-10">index</span><a - id="dx1-29028"></a> package - option. - </p></dd><dt class="description"> -<a - id="pkgopt:noglossaryindex"></a><span -class="cmssbx-10">noglossaryindex</span><a - id="dx1-29029"></a> </dt><dd -class="description">This option switches off <span -class="cmss-10">index</span><a - id="dx1-29030"></a> if <span -class="cmss-10">index</span><a - id="dx1-29031"></a> has been passed implicitly (for - example, through global document options). This option can’t be used in - <span -class="cmtt-10">\setupglossaries</span>. - </dd><dt class="description"> -<a +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">} </span>(glossaries-extra.sty)</span></h4> +<!--l. 5230--><p class="noindent" >This option may be used to suppress the boilerplate text generated by <span +class="cmtt-10">\printglossary </span>if the glossary file is +missing. +</p><!--l. 5233--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1050002.8"></a><a id="pkgopt:compatible-2.07"></a><span -class="cmssbx-10">compatible-2.07</span><a - id="dx1-29032"></a> </dt><dd -class="description">Compatibility mode for old documents created using version 2.07 or - below. - </dd><dt class="description"> -<a +class="cmss-10">compatible-2.07=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 5233--><p class="noindent" >Compatibility mode for old documents created using version 2.07 or below. + + +</p><!--l. 5236--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1060002.8"></a><a id="pkgopt:compatible-3.07"></a><span -class="cmssbx-10">compatible-3.07</span><a - id="dx1-29033"></a> </dt><dd -class="description">Compatibility mode for old documents created using version 3.07 or - below. - </dd><dt class="description"> -<a +class="cmss-10">compatible-3.07=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">boolean</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 5236--><p class="noindent" >Compatibility mode for old documents created using version 3.07 or below. +</p><!--l. 5239--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="x1-1070002.8"></a><a id="pkgopt:kernelglossredefs"></a><span -class="cmssbx-10">kernelglossredefs</span><a - id="dx1-29034"></a> </dt><dd -class="description">As a legacy from the precursor <span +class="cmss-10">kernelglossredefs=</span><span +class="cmtt-10">{</span>⟨<span +class="cmssi-10">value</span>⟩<span +class="cmtt-10">}</span></h4> +<!--l. 5239--><p class="noindent" >As a legacy from the precursor <span class="cmss-10">glossary</span><a - id="dx1-29035"></a> package, the standard glossary - commands provided by the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-107001"></a> package, the standard glossary commands provided by the +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> kernel (<span class="cmtt-10">\makeglossary </span>and <span -class="cmtt-10">\glossary</span>) are - redefined in terms of the <span -class="cmss-10">glossaries </span>package’s commands. However, they were never - documented in this user manual, and the conversion guide (<a -href="glossary2glossaries.html" >“Upgrading from - the glossary package to the glossaries package”</a>) explicitly discourages their - use. - <!--l. 4486--><p class="noindent" >The use of those kernel commands (instead of the appropriate commands documented - in this user guide) are deprecated, and you will now get a warning if you try using - them. - </p><!--l. 4490--><p class="noindent" >In the event that you require the original form of these kernel commands, - for example, if you need to use the <span -class="cmss-10">glossaries </span>package with another class or - package that also performs glossary-style indexing, then you can restore these - commands to their previous definition (that is, their definitions prior to loading the - <span -class="cmss-10">glossaries </span>package) with the package option <span -class="cmss-10">kernelglossredefs=false</span><a - id="dx1-29036"></a>. You may - also need to use the <span +class="cmtt-10">\glossary</span>) are redefined in terms of the <span +class="cmss-10">glossaries </span>package’s commands. +However, they were never documented in this user manual, and the conversion guide (<a +href="glossary2glossaries.html" >“Upgrading from the +glossary package to the glossaries package”</a>) explicitly discourages their use. +</p><!--l. 5248--><p class="indent" > The use of those kernel commands (instead of the appropriate commands documented in this user guide) are +deprecated, and you will now get a warning if you try using them. +</p><!--l. 5252--><p class="indent" > In the event that you require the original form of these kernel commands, for example, if you need to use the +<span +class="cmss-10">glossaries </span>package with another class or package that also performs glossary-style indexing, then you can restore +these commands to their previous definition (that is, their definitions prior to loading the <span +class="cmss-10">glossaries </span>package) +with the package option <span +class="cmss-10">kernelglossredefs</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-107002"></a>. You may also need to use the <span class="cmss-10">nomain</span><a - id="dx1-29037"></a> option in the event of file extension conflicts. (In - which case, you must provide a new default glossary for use with the <span + id="dx1-107003"></a> option in the event of file +extension conflicts. (In which case, you must provide a new default glossary for use with the <span class="cmss-10">glossaries</span><a - id="dx1-29038"></a> - package.) - </p><!--l. 4501--><p class="noindent" >This option may take one of three values: <span -class="cmss-10">true </span>(redefine with warnings, default), - <span -class="cmss-10">false </span>(restore previous definitions) or <span -class="cmss-10">nowarn </span>(redefine without warnings, not - recommended). - </p><!--l. 4506--><p class="noindent" >Note that the only glossary-related commands provided by the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> kernel are - <span + id="dx1-107004"></a> +package.) +</p><!--l. 5263--><p class="indent" > This option may take one of three values: <span +class="cmss-10">true </span>(redefine with warnings, default), <span +class="cmss-10">false </span>(restore previous +definitions) or <span +class="cmss-10">nowarn </span>(redefine without warnings, not recommended). +</p><!--l. 5268--><p class="indent" > The only glossary-related commands provided by the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> kernel are <span class="cmtt-10">\makeglossary </span>and <span -class="cmtt-10">\glossary</span>. Other packages or classes may provide additional - - - glossary-related commands or environments that conflict with <span -class="cmss-10">glossaries </span>(such as - <span +class="cmtt-10">\glossary</span>. +Other packages or classes may provide additional glossary-related commands or environments that conflict with +<span +class="cmss-10">glossaries </span>(such as <span class="cmtt-10">\printglossary </span>and <span class="cmss-10">theglossary</span><a - id="dx1-29039"></a><a - id="dx1-29040"></a>). These non-kernel commands aren’t affected by this - package option, and you will have to find some way to resolve the conflict if you require - both glossary mechanisms. (The <span + id="dx1-107005"></a><a + id="dx1-107006"></a>). These non-kernel commands aren’t affected by this +package option, and you will have to find some way to resolve the conflict if you require both glossary +mechanisms. (The <span class="cmss-10">glossaries</span><a - id="dx1-29041"></a> package will override the existing definitions - of <span -class="cmtt-10">\printglossary </span>and <span + id="dx1-107007"></a> package will override the existing definitions of <span +class="cmtt-10">\printglossary </span>and +<span class="cmss-10">theglossary</span><a - id="dx1-29042"></a><a - id="dx1-29043"></a>.) - </p><!--l. 4516--><p class="noindent" >In general, if possible, it’s best to stick with just one package that provides a glossary - mechanism. (The <span + id="dx1-107008"></a><a + id="dx1-107009"></a>.) +</p><!--l. 5278--><p class="indent" > In general, if possible, it’s best to stick with just one package that provides a glossary mechanism. (The +<span class="cmss-10">glossaries </span>package does check for the <span class="cmss-10">doc</span><a - id="dx1-29044"></a> package and patches - <span + id="dx1-107010"></a> package and patches <span class="cmtt-10">\PrintChanges</span>.) +</p><!--l. 5282--><p class="noindent" > </p> - </dd></dl> -<!--l. 4522--><p class="noindent" > -</p> -<!--l. 4522--><p class="noindent" ><a -href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.7 </span> <a +<!--l. 5282--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.9 </span> <a id="sec:setupglossaries"></a>Setting Options After the Package is Loaded</h3> -<!--l. 4525--><p class="noindent" >Some of the options described above may also be set after the <span -class="cmss-10">glossaries </span>package has been -loaded using -</p><!--l. 4527--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setupglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-30001"></a> <span +<!--l. 5285--><p class="noindent" >Some of the options described above may also be set after the <span +class="cmss-10">glossaries </span>package has been loaded +using +</p><!--l. 5287--><p class="indent" > <hr><div title="Definition"><a + id="dx1-108001"></a> <span class="cmtt-10">\setupglossaries{</span>⟨<span class="cmitt-10">key-val list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4529--><p class="noindent" > -The following package options <span -class="cmbx-10">can’t </span>be used in <span +</p><!--l. 5289--><p class="noindent" > +The following package options <strong>can’t</strong> be used in <span class="cmtt-10">\setupglossaries</span>: <span class="cmss-10">xindy</span><a - id="dx1-30002"></a>, <span + id="dx1-108002"></a>, <span class="cmss-10">xindygloss</span><a - id="dx1-30003"></a>, -<span + id="dx1-108003"></a>, <span class="cmss-10">xindynoglsnumbers</span><a - id="dx1-30004"></a>, <span + id="dx1-108004"></a>, +<span class="cmss-10">makeindex</span><a - id="dx1-30005"></a>, <span + id="dx1-108005"></a>, <span class="cmss-10">nolong</span><a - id="dx1-30006"></a>, <span + id="dx1-108006"></a>, <span class="cmss-10">nosuper</span><a - id="dx1-30007"></a>, <span + id="dx1-108007"></a>, <span class="cmss-10">nolist</span><a - id="dx1-30008"></a>, <span + id="dx1-108008"></a>, <span class="cmss-10">notree</span><a - id="dx1-30009"></a>, <span + id="dx1-108009"></a>, <span class="cmss-10">nostyles</span><a - id="dx1-30010"></a>, <span + id="dx1-108010"></a>, <span class="cmss-10">nomain</span><a - id="dx1-30011"></a>, <span + id="dx1-108011"></a>, <span class="cmss-10">compatible-2.07</span><a - id="dx1-30012"></a>, -<span + id="dx1-108012"></a>, <span class="cmss-10">translate</span><a - id="dx1-30013"></a>, <span + id="dx1-108013"></a>, <span class="cmss-10">notranslate</span><a - id="dx1-30014"></a>, <span + id="dx1-108014"></a>, +<span class="cmss-10">acronym</span><a - id="dx1-30015"></a>. These options have to be set while the package is loading, -except for the <span + id="dx1-108015"></a>. These options have to be set while the package is loading, except for the <span class="cmss-10">xindy</span><a - id="dx1-30016"></a> sub-options which can be set using commands like <span + id="dx1-108016"></a> sub-options +which can be set using commands like <span class="cmtt-10">\GlsSetXdyLanguage</span><a - id="dx1-30017"></a> -(see <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a -href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details). -</p><!--l. 4541--><p class="indent" > <div class="important" title="Important Note"> If you need to use this command, use it as soon as possible after loading <span -class="cmss-10">glossaries</span> -otherwise you might end up using it too late for the change to take effect. For example, if you -try changing the acronym styles (such as <span + id="dx1-108017"></a> (see <a +href="#sec:xindy">§11 </a><a +href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further +details). + + +</p><!--l. 5301--><p class="indent" > <div class="important" title="Important Note"> If you need to use this command, use it as soon as possible after loading <span +class="cmss-10">glossaries </span>otherwise you might end +up using it too late for the change to take effect. For example, if you try changing the acronym styles (such as +<span class="cmss-10">smallcaps</span><a - id="dx1-30018"></a>) after you have started defining your -acronyms, you are likely to get unexpected results. If you try changing the sort -option after you have started to define entries, you may get unexpected results. + id="dx1-108018"></a>) after you have started defining your acronyms, you are likely to get unexpected results. If you try +changing the sort option after you have started to define entries, you may get unexpected results. </div> -</p><!--l. 4549--><p class="noindent" > - - +</p><!--l. 5309--><p class="noindent" > + + </p> -<!--l. 4551--><p class="indent" > </div> -</p><!--l. 4551--><p class="noindent" ><a +<!--l. 5311--><p class="indent" > </div> +</p><!--l. 5311--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">3. <a id="sec:setup"></a>Setting Up</h2> -</p><!--l. 4554--><p class="indent" > In the preamble you need to indicate whether you want to use <a +</p><!--l. 5314--><p class="indent" > In the preamble you need to indicate whether you want to use <a href="#option1">Option 1</a>, <a -href="#option2">Option 2</a> or -<a -href="#option3">Option 3</a>. It’s not possible to mix these options within a document, although some -combinations are possible with <span -class="cmss-10">glossaries-extra</span>. (For Options <a +href="#option2">Option 2</a> or <a +href="#option3">Option 3</a>. It’s not +possible to mix these options within a document, although some combinations are possible with <span +class="cmss-10">glossaries-extra</span>. +(For Options <a href="#option4">4</a> and <a href="#option5">5</a> see the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-31001"></a></a> and -<a + id="dx1-109001"></a></a> and <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a> manuals.) </p> -<!--l. 4560--><p class="noindent" ><a +<!--l. 5320--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3.1 </span> <a id="sec:setupopt1"></a>Option 1</h3> -<!--l. 4563--><p class="noindent" >The command -</p><!--l. 4564--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\makenoidxglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-32001"></a> <span +<!--l. 5323--><p class="noindent" >The command +</p><!--l. 5324--><p class="indent" > <hr><div title="Definition"><a + id="dx1-110001"></a> <span class="cmtt-10">\makenoidxglossaries </span></div><hr> -</p><!--l. 4566--><p class="noindent" > -must be placed in the preamble. This sets up the internal commands required to make -<a -href="#option1">Option 1</a> work. <span -class="cmbx-10">If you omit </span><span -class="cmtt-10">\makenoidxglossaries </span><span -class="cmbx-10">none of the glossaries will be</span> -<span -class="cmbx-10">displayed.</span> -</p><!--l. 4572--><p class="noindent" > -</p> -<!--l. 4572--><p class="noindent" ><a +</p><!--l. 5326--><p class="noindent" > +must be placed in the preamble. This sets up the internal commands required to make <a +href="#option1">Option 1</a> work. <strong>If you +omit <span +class="cmtt-10">\makenoidxglossaries </span>none of the glossaries will be displayed.</strong> +</p><!--l. 5332--><p class="noindent" > +</p> +<!--l. 5332--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3.2 </span> <a id="sec:setupopt23"></a>Options 2 and 3</h3> -<!--l. 4575--><p class="noindent" >The command -</p><!--l. 4576--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\makeglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-33001"></a> <span +<!--l. 5335--><p class="noindent" >The command +</p><!--l. 5336--><p class="indent" > <hr><div title="Definition"><a + id="dx1-111001"></a> <span class="cmtt-10">\makeglossaries </span></div><hr> -</p><!--l. 4578--><p class="noindent" > +</p><!--l. 5338--><p class="noindent" > must be placed in the preamble in order to create the customised <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-33002"></a></a> (<span -class="cmtt-10">.ist</span><a - id="dx1-33003"></a>) or <a + id="dx1-111002"></a></a> (<span +class="cmtt-10">ist</span><a + id="dx1-111003"></a>) or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-33004"></a></a> -(<span -class="cmtt-10">.xdy</span><a - id="dx1-33005"></a>) style file (for Options <a + id="dx1-111004"></a></a> (<span +class="cmtt-10">xdy</span><a + id="dx1-111005"></a>) style file (for +Options <a href="#option2">2</a> or <a -href="#option3">3</a>, respectively) and to ensure that glossary entries are -written to the appropriate output files. <span -class="cmbx-10">If you omit </span><span -class="cmtt-10">\makeglossaries </span><span -class="cmbx-10">none of the</span> -<span -class="cmbx-10">glossary files will be created.</span> -</p><!--l. 4586--><p class="indent" > <div class="important" title="Important Note"> Note that some of the commands provided by the <span -class="cmss-10">glossaries </span>package must not be used -after <span -class="cmtt-10">\makeglossaries </span>as they are required when creating the customised style file. If -you attempt to use those commands after <span -class="cmtt-10">\makeglossaries </span>you will generate an -error. -</p><!--l. 4593--><p class="indent" > Similarly, there are some commands that must not be used before <span -class="cmtt-10">\makeglossaries</span>. +href="#option3">3</a>, respectively) and to ensure that glossary entries are written to the appropriate output files. <strong>If +you omit <span +class="cmtt-10">\makeglossaries </span>none of the glossary files will be created.</strong> +</p><!--l. 5346--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you are using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, <span +class="cmtt-10">\makeglossaries </span>has an optional argument that allows you to +have a hybrid of Options <a +href="#option1">1</a> or <a +href="#option2">2</a> or Options <a +href="#option1">1</a> or <a +href="#option3">3</a>. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. </div> -</p><!--l. 4595--><p class="noindent" > -</p><!--l. 4597--><p class="indent" > You can suppress the creation of the customised <a +</p><!--l. 5350--><p class="noindent" > +</p><!--l. 5353--><p class="indent" > <span class="warningsymbol">⚠</span> Note that some of the commands provided by the <span +class="cmss-10">glossaries </span>package must not be used after +<span +class="cmtt-10">\makeglossaries </span>as they are required when creating the customised style file. If you attempt to use those +commands after <span +class="cmtt-10">\makeglossaries </span>you will generate an error. Similarly, there are some commands that must +not be used before <span +class="cmtt-10">\makeglossaries</span>. +</p><!--l. 5361--><p class="indent" > You can suppress the creation of the customised <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-33006"></a></a> or <a + id="dx1-111006"></a></a> or <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-33007"></a></a> style file -using -</p><!--l. 4599--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\noist</span><span -class="cmtt-9"> </span></span><a - id="dx1-33008"></a> <span + id="dx1-111007"></a></a> style file using +</p><!--l. 5363--><p class="indent" > <hr><div title="Definition"><a + id="dx1-111008"></a> <span class="cmtt-10">\noist </span></div><hr> -</p><!--l. 4601--><p class="noindent" > +</p><!--l. 5365--><p class="noindent" > That this command must not be used after <span class="cmtt-10">\makeglossaries</span>. -</p><!--l. 4603--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span -class="cmtt-10">.xdy</span><a - id="dx1-33009"></a> file created when using <span -class="cmss-10">glossaries </span>version 2.07 or -below, you will need to use the <span +</p><!--l. 5367--><p class="indent" > <div class="important" title="Important Note"> Note that if you have a custom <span +class="cmtt-10">xdy</span><a + id="dx1-111009"></a> file created when using <span +class="cmss-10">glossaries </span>version 2.07 or below, you will need to +use the <span class="cmss-10">compatible-2.07</span><a - id="dx1-33010"></a> package option with it. </div> -</p><!--l. 4607--><p class="noindent" > - - -</p><!--l. 4609--><p class="indent" > The default name for the customised style file is given by <span + id="dx1-111010"></a> package option with it. </div> +</p><!--l. 5371--><p class="noindent" > +</p><!--l. 5373--><p class="indent" > The default name for the customised style file is given by <span class="cmtt-10">\jobname</span><a - id="dx1-33011"></a><span -class="cmtt-10">.ist</span><a - id="dx1-33012"></a> (<a -href="#option2">Option 2</a>) or -<span + id="dx1-111011"></a><span +class="cmtt-10">ist</span><a + id="dx1-111012"></a> (<a +href="#option2">Option 2</a>) or <span class="cmtt-10">\jobname</span><a - id="dx1-33013"></a><span -class="cmtt-10">.xdy</span><a - id="dx1-33014"></a> (<a + id="dx1-111013"></a><span +class="cmtt-10">xdy</span><a + id="dx1-111014"></a> +(<a href="#option3">Option 3</a>). This name may be changed using: -</p><!--l. 4613--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setStyleFile</span><span -class="cmtt-9"> </span></span><a - id="dx1-33015"></a> <span +</p><!--l. 5377--><p class="indent" > <hr><div title="Definition"><a + id="dx1-111015"></a> <span class="cmtt-10">\setStyleFile{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4615--><p class="noindent" > + + +</p><!--l. 5379--><p class="noindent" > where ⟨<span -class="cmti-10">name</span>⟩ is the name of the style file without the extension. Note that this command must -not be used after <span +class="cmti-10">name</span>⟩ is the name of the style file without the extension. Note that this command must not be used after +<span class="cmtt-10">\makeglossaries</span>. -</p><!--l. 4620--><p class="indent" > Each glossary entry is assigned a <a +</p><!--l. 5384--><p class="indent" > Each glossary entry is assigned a <a href="#glo:numberlist">number list<a - id="dx1-33016"></a></a> that lists all the locations in the document -where that entry was used. By default, the location refers to the page number but this may -be overridden using the <span + id="dx1-111016"></a></a> that lists all the locations in the document where that entry +was used. By default, the location refers to the page number but this may be overridden using the +<span class="cmss-10">counter</span><a - id="dx1-33017"></a> 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 -</p><!--l. 4627--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsSetCompositor</span><span -class="cmtt-9"> </span></span><a - id="dx1-33018"></a> <span + id="dx1-111017"></a> 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 +</p><!--l. 5391--><p class="indent" > <hr><div title="Definition"><a + id="dx1-111018"></a> <span class="cmtt-10">\glsSetCompositor{</span>⟨<span class="cmitt-10">symbol</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4629--><p class="noindent" > +</p><!--l. 5393--><p class="noindent" > For example: - - + + </p> - <div class="verbatim" id="verbatim-135"> + <div class="verbatim" id="verbatim-131"> \glsSetCompositor{-} </div> -<!--l. 4633--><p class="nopar" > This command must not be used after <span +<!--l. 5397--><p class="nopar" > This command must not be used after <span class="cmtt-10">\makeglossaries</span>. -</p><!--l. 4636--><p class="indent" > If you use <a -href="#option3">Option 3</a>, you can have a different compositor for page numbers starting with -an upper case alphabetical character using: -</p><!--l. 4638--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsSetAlphaCompositor</span><span -class="cmtt-9"> </span></span><a - id="dx1-33019"></a> <span +</p><!--l. 5400--><p class="indent" > If you use <a +href="#option3">Option 3</a>, you can have a different compositor for page numbers starting with an upper case +alphabetical character using: +</p><!--l. 5402--><p class="indent" > <hr><div title="Definition"><a + id="dx1-111019"></a> <span class="cmtt-10">\glsSetAlphaCompositor{</span>⟨<span class="cmitt-10">symbol</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4640--><p class="noindent" > +</p><!--l. 5404--><p class="noindent" > This command has no effect if you use <a href="#option2">Option 2</a>. For example, if you want <a href="#glo:numberlist">number list<a - id="dx1-33020"></a>s</a> -containing a mixture of A-1 and 2.3 style formats, then do: - - + id="dx1-111020"></a>s</a> containing a mixture of +A-1 and 2.3 style formats, then do: + + </p> - <div class="verbatim" id="verbatim-136"> + <div class="verbatim" id="verbatim-132"> \glsSetCompositor{.}\glsSetAlphaCompositor{-} </div> -<!--l. 4646--><p class="nopar" > See <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a +<!--l. 5410--><p class="nopar" > See <a +href="#sec:numberlists">§5 </a><a href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a> for further information about <a href="#glo:numberlist">number list<a - id="dx1-33021"></a>s</a>. - - + id="dx1-111021"></a>s</a>. + + </p> -<!--l. 4650--><p class="indent" > </div> -</p><!--l. 4650--><p class="noindent" ><a +<!--l. 5414--><p class="indent" > </div> +</p><!--l. 5414--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">4. <a id="sec:newglosentry"></a>Defining Glossary Entries</h2> -</p><!--l. 4653--><p class="indent" > All glossary entries must be defined before they are used, so it is better to define them in -the preamble to ensure this. In fact, some commands such as <span -class="cmtt-10">\longnewglossaryentry</span> -may only be used in the preamble. See <a -href="#sec:docdefs"><span -class="tcrm-1000">§</span>4.8 </a><a -href="#sec:docdefs">Drawbacks With Defining Entries in -the Document Environment<!--tex4ht:ref: sec:docdefs --></a> for a discussion of the problems with defining entries -within the document instead of in the preamble. (The <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package has an -option that provides a restricted form of document definitions that avoids some of -the issues discussed in <a -href="#sec:docdefs"><span -class="tcrm-1000">§</span>4.8 </a><a +</p><!--l. 5417--><p class="indent" > All glossary entries must be defined before they are used, so it is better to define them in the +preamble to ensure this. In fact, some commands such as <span +class="cmtt-10">\longnewglossaryentry </span>may only be used +in the preamble. See <a +href="#sec:docdefs">§4.8 </a><a +href="#sec:docdefs">Drawbacks With Defining Entries in the Document Environment<!--tex4ht:ref: sec:docdefs --></a> for a +discussion of the problems with defining entries within the document instead of in the preamble. +(The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has an option that provides a restricted form of document definitions +that avoids some of the issues discussed in <a +href="#sec:docdefs">§4.8 </a><a href="#sec:docdefs">Drawbacks With Defining Entries in the Document Environment<!--tex4ht:ref: sec:docdefs --></a>.) -</p><!--l. 4662--><p class="indent" > <div class="important" title="Important Note"> <a +</p><!--l. 5426--><p class="indent" > <div class="important" title="Important Note"> <a href="#option1">Option 1</a> enforces the preamble-only restriction on <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-34001"></a>. <a -href="#option4">Option 4</a> -requires that definitions are provided in <span -class="cmtt-10">.bib </span>format. <a -href="#option5">Option 5</a> requires either -preamble-only definitions or the use of the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-34002"></a> package option <span -class="cmss-10">docdef=restricted</span>. -</div> -</p><!--l. 4668--><p class="noindent" > -</p><!--l. 4670--><p class="indent" > Only those entries that are indexed in the document (using any of the commands -described in <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a -href="#sec:glsadd"><span -class="tcrm-1000">§</span>7 </a><a -href="#sec:glsadd">Adding an Entry to the Glossary Without -Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a -href="#sec:crossref"><span -class="tcrm-1000">§</span>8 </a><a -href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. See <a -href="#sec:printglossary"><span -class="tcrm-1000">§</span>10 -</a><a -href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the glossary. -</p><!--l. 4678--><p class="indent" > New glossary entries are defined using the command: -</p><!--l. 4679--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newglossaryentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-34003"></a> <span + id="dx1-112001"></a>. <a +href="#option4">Option 4</a> requires that definitions +are provided in <span +class="cmtt-10">bib</span><a + id="dx1-112002"></a> format. <a +href="#option5">Option 5</a> requires either preamble-only definitions or the use of the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +package option <span +class="cmss-10">docdef=restricted</span>. </div> +</p><!--l. 5432--><p class="noindent" > +</p><!--l. 5434--><p class="indent" > Only those entries that are indexed in the document (using any of the commands described in <a +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to +Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a +href="#sec:glsadd">§7 </a><a +href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> or <a +href="#sec:crossref">§8 </a><a +href="#sec:crossref">Cross-Referencing +Entries<!--tex4ht:ref: sec:crossref --></a>) will appear in the glossary. See <a +href="#sec:printglossary">§10 </a><a +href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the +glossary. +</p><!--l. 5442--><p class="indent" > New glossary entries are defined using the command: +</p><!--l. 5443--><p class="indent" > <hr><div title="Definition"><a + id="dx1-112003"></a> <span class="cmtt-10">\newglossaryentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">key=value list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4681--><p class="noindent" > +</p><!--l. 5445--><p class="noindent" > This is a short command, so values in ⟨<span -class="cmti-10">key-val list</span>⟩ can’t contain any paragraph breaks. Take -care to enclose values containing any commas (<span +class="cmti-10">key-val list</span>⟩ can’t contain any paragraph breaks. Take care to enclose +values containing any commas (<span class="cmtt-10">,</span>) or equal signs (<span -class="cmtt-10">=</span>) 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. -</p><!--l. 4688--><p class="indent" > If you have a long description that needs to span multiple paragraphs, use -</p><!--l. 4690--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\longnewglossaryentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-34004"></a> <span +class="cmtt-10">=</span>) with braces to hide them from the key=value list +parser. +</p><!--l. 5451--><p class="indent" > If you have a long description that needs to span multiple paragraphs, use +</p><!--l. 5453--><p class="indent" > <hr><div title="Definition"><a + id="dx1-112004"></a> <span class="cmtt-10">\longnewglossaryentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">key=value list</span>⟩<span class="cmtt-10">}{</span>⟨<span -class="cmitt-10">long</span> -<span -class="cmitt-10">description</span>⟩<span +class="cmitt-10">long description</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4693--><p class="noindent" > -instead. Note that this command may only be used in the preamble. Be careful of unwanted -spaces. <span -class="cmtt-10">\longnewglossaryentry </span>will remove trailing spaces in the description (via <span -class="cmtt-10">\unskip</span>) -but won’t remove leading spaces (otherwise it would interfere with commands like -<span -class="cmtt-10">\Glsentrydesc</span>). This command also appends <span -class="cmtt-10">\nopostdesc </span>to the end of the description, -which suppresses the post-description hook. The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-34005"></a> package provides a -starred version of <span -class="cmtt-10">\longnewglossaryentry </span>that doesn’t append either <span -class="cmtt-10">\unskip </span>or +</p><!--l. 5456--><p class="noindent" > +instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. <span +class="cmtt-10">\longnewglossaryentry </span>will remove trailing spaces in the description (via <span +class="cmtt-10">\unskip</span>) but won’t remove leading +spaces. This command also appends <span +class="cmtt-10">\nopostdesc </span>to the end of the description, which suppresses the +post-description hook. The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a starred version of <span +class="cmtt-10">\longnewglossaryentry </span>that +doesn’t append either <span +class="cmtt-10">\unskip </span>or <span class="cmtt-10">\nopostdesc</span>. -</p><!--l. 4704--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been -defined: -</p><!--l. 4706--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\provideglossaryentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-34006"></a> <span +</p><!--l. 5466--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been defined: +</p><!--l. 5468--><p class="indent" > <hr><div title="Definition"><a + id="dx1-112005"></a> <span class="cmtt-10">\provideglossaryentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">key=value list</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 4708--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 5470--><p class="noindent" > and -</p><!--l. 4710--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\longprovideglossaryentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-34007"></a> <span +</p><!--l. 5472--><p class="indent" > <hr><div title="Definition"><a + id="dx1-112006"></a> <span class="cmtt-10">\longprovideglossaryentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">key=value list</span>⟩<span -class="cmtt-10">}</span> - - -<span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">}{</span>⟨<span class="cmitt-10">long description</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 4713--><p class="noindent" > +</p><!--l. 5475--><p class="noindent" > (These are both preamble-only commands.) -</p><!--l. 4716--><p class="indent" > For all the above commands, the first argument, ⟨<span -class="cmti-10">label</span>⟩, must be a unique label with which -to identify this entry. <span -class="cmbx-10">This can’t contain any non-expandable commands</span> -<span -class="cmbx-10">or active characters. </span>The reason for this restriction is that the label is used to -construct internal commands that store the associated information (similarly to -commands like <span +</p><!--l. 5478--><p class="indent" > For all the above commands, the first argument, ⟨<span +class="cmti-10">label</span>⟩, must be a unique label with which to identify this +entry. <strong>This can’t contain any non-expandable commands or active characters.</strong> The reason for this restriction +is that the label is used to construct internal commands that store the associated information +(similarly to commands like <span class="cmtt-10">\label</span>) and therefore must be able to expand to a valid control sequence name. -</p><!--l. 4724--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a +</p><!--l. 5486--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a href="#glo:exlatinchar">extended Latin character<a - id="dx1-34008"></a></a> or other <a + id="dx1-112007"></a></a> or other <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-34009"></a></a>, such as é -or ß, looks like a plain character in your <span -class="cmtt-10">.tex </span>file, it’s actually a macro (an active character) -and therefore can’t be used in the label. (This applies to <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> rather than XeLaTeX.) -Also be careful of <span + id="dx1-112008"></a></a>, such as é or ß, looks + + +like a plain character in your <span +class="cmtt-10">.tex </span>file, it’s actually a macro (an active character) and therefore +can’t be used in the label. (This applies to <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> rather than XeLaTeX.) Also be careful of +<span class="cmss-10">babel</span><a - id="dx1-34010"></a>’s options that change certain punctuation characters (such as <span + id="dx1-112009"></a>’s options that change certain punctuation characters (such as <span class="cmtt-10">: </span>or <span -class="cmtt-10">-</span>) -to active characters. </div> -</p><!--l. 4732--><p class="noindent" > -</p><!--l. 4734--><p class="indent" > The second argument, ⟨<span +class="cmtt-10">-</span>) to active characters. +</div> +</p><!--l. 5494--><p class="noindent" > +</p><!--l. 5496--><p class="indent" > The second argument, ⟨<span class="cmti-10">key=value list</span>⟩, is a ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ list that supplies the relevant -information about this entry. There are two required fields: <span -class="cmss-10">description</span><a - id="dx1-34011"></a> and either <span -class="cmss-10">name</span><a - id="dx1-34012"></a> or -<span -class="cmss-10">parent</span><a - id="dx1-34013"></a>. The description is set in the third argument of <span -class="cmtt-10">\longnewglossaryentry </span>and -<span -class="cmtt-10">\longprovideglossaryentry</span>. With the other commands it’s set via the <span -class="cmss-10">description</span><a - id="dx1-34014"></a> key. As is -typical with ⟨<span +class="cmti-10">value</span>⟩ list that supplies the relevant information about this +entry. There are two required fields: <span +class="cmtt-10">description</span><a + id="dx1-112010"></a> and either <span +class="cmtt-10">name</span><a + id="dx1-112011"></a> or <span +class="cmtt-10">parent</span><a + id="dx1-112012"></a>. The description is set in the third +argument of <span +class="cmtt-10">\longnewglossaryentry </span>and <span +class="cmtt-10">\longprovideglossaryentry</span>. With the other commands it’s set via +the <span +class="cmtt-10">description</span><a + id="dx1-112013"></a> key. As is typical with ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ lists, values that contain a comma or equal sign must be enclosed in -braces. Available fields are listed below. Additional fields are provided by the supplementary -packages <span +class="cmti-10">value</span>⟩ lists, values that contain a comma or equal sign +must be enclosed in braces. Available fields are listed below. Additional fields are provided by the +supplementary packages <span class="cmss-10">glossaries-prefix</span><a - id="dx1-34015"></a> (<a -href="#sec:prefix"><span -class="tcrm-1000">§</span>17 </a><a + id="dx1-112014"></a> (<a +href="#sec:prefix">§17 </a><a href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span class="cmss-10">glossaries-accsupp</span><a - id="dx1-34016"></a> (<a -href="#sec:accsupp"><span -class="tcrm-1000">§</span>18 -</a><a -href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>) and also by <a + id="dx1-112015"></a> (<a +href="#sec:accsupp">§18 </a><a +href="#sec:accsupp">Accessibility +Support<!--tex4ht:ref: sec:accsupp --></a>) and also by <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>. You can also define your own custom keys -(see <a -href="#sec:addkey"><span -class="tcrm-1000">§</span>4.3 </a><a -href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>). +class="cmss-10">glossaries-extra</span></a>. You can also define your own custom keys (see <a +href="#sec:addkey">§4.3 </a><a +href="#sec:addkey">Additional +Keys<!--tex4ht:ref: sec:addkey --></a>). </p><dl class="description"><dt class="description"> <span -class="cmssbx-10">name</span><a - id="dx1-34017"></a> </dt><dd -class="description">The name of the entry (as it will appear in the glossary). If this key is omitted - and the <span -class="cmss-10">parent</span><a - id="dx1-34018"></a> key is supplied, this value will be the same as the parent’s name. - <!--l. 4755--><p class="noindent" ><div class="important" title="Important Note"> If the <span -class="cmss-10">name</span><a - id="dx1-34019"></a> key contains any commands, you must also use the <span -class="cmss-10">sort</span><a - id="dx1-34020"></a> key (described - below) if you intend sorting the entries alphabetically, otherwise the entries can’t be - sorted correctly. </div> - </p><!--l. 4759--><p class="noindent" > +class="cmtt-10">name</span><a + id="dx1-112016"></a> </dt><dd +class="description">The name of the entry (as it will appear in the glossary). If this key is omitted and the <span +class="cmtt-10">parent</span><a + id="dx1-112017"></a> + key is supplied, this value will be the same as the parent’s name. + <!--l. 5517--><p class="noindent" ><div class="important" title="Important Note"> If the <span +class="cmtt-10">name</span><a + id="dx1-112018"></a> key contains any commands, you must also use the <span +class="cmtt-10">sort</span><a + id="dx1-112019"></a> key (described below) if + you intend sorting the entries alphabetically, otherwise the entries can’t be sorted correctly. + </div> + </p><!--l. 5521--><p class="noindent" > </p></dd><dt class="description"> <span -class="cmssbx-10">description</span><a - id="dx1-34021"></a> </dt><dd -class="description">A brief description of this term (to appear in the glossary). Within this value, - you can use - <!--l. 4763--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\nopostdesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-34022"></a> <span +class="cmtt-10">description</span><a + id="dx1-112020"></a> </dt><dd +class="description">A brief description of this term (to appear in the glossary). Within this value, you can + use: + <!--l. 5525--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-112021"></a> <span class="cmtt-10">\nopostdesc </span></div><hr> - </p><!--l. 4765--><p class="noindent" > - to suppress the description terminator for this entry. For example, if this - entry is a parent entry that doesn’t require a description, you can do - <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">description={\nopostdesc}</span></span></span>. If you want a paragraph break in the description - use - </p><!--l. 4771--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspar</span><span -class="cmtt-9"> </span></span><a - id="dx1-34023"></a> <span + </p><!--l. 5527--><p class="noindent" > + to suppress the description terminator for this entry. For example, if this entry is a parent entry that + doesn’t require a description, you can do <span +class="cmtt-10">description={\nopostdesc}</span>. If you want a paragraph break in + the description use: + </p><!--l. 5533--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-112022"></a> <span class="cmtt-10">\glspar </span></div><hr> - - - </p><!--l. 4773--><p class="noindent" > + </p><!--l. 5535--><p class="noindent" > or, better, use <span -class="cmtt-10">\longnewglossaryentry</span>. However, note that not all glossary styles - support multi-line descriptions. If you are using one of the tabular-like glossary styles - that permit multi-line descriptions, use <span +class="cmtt-10">\longnewglossaryentry</span>. However, note that not all glossary styles support multi-line + descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use + <span class="cmtt-10">\newline</span><a - id="dx1-34024"></a> not <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\</span></span></span> if you want to force a line - break. + id="dx1-112023"></a> not <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\\</span></span></span> if you want to force a line break. + </p><!--l. 5542--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, use <span id="textcolor252"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-112024"></a> instead of <span +class="cmtt-10">\nopostdesc </span>to suppress the post-description + punctuation. </div> + </p><!--l. 5545--><p class="noindent" > </p></dd><dt class="description"> <span -class="cmssbx-10">parent</span><a - id="dx1-34025"></a> </dt><dd -class="description">The label of the parent entry. Note that the parent entry must be defined before its - sub-entries. See <a -href="#sec:subentries"><span -class="tcrm-1000">§</span>4.5 </a><a +class="cmtt-10">parent</span><a + id="dx1-112025"></a> </dt><dd +class="description">The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See <a +href="#sec:subentries">§4.5 + </a><a href="#sec:subentries">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details. + + </dd><dt class="description"> <span -class="cmssbx-10">descriptionplural</span><a - id="dx1-34026"></a> </dt><dd -class="description">The plural form of the description, if required. If omitted, the value is set to - the same as the <span -class="cmss-10">description</span><a - id="dx1-34027"></a> key. +class="cmtt-10">descriptionplural</span><a + id="dx1-112026"></a> </dt><dd +class="description">The plural form of the description, if required. If omitted, the value is set to the same as + the <span +class="cmtt-10">description</span><a + id="dx1-112027"></a> key. </dd><dt class="description"> <span -class="cmssbx-10">text</span><a - id="dx1-34028"></a> </dt><dd +class="cmtt-10">text</span><a + id="dx1-112028"></a> </dt><dd class="description">How this entry will appear in the document text when using <span class="cmtt-10">\gls</span><a - id="dx1-34029"></a> (or one of its - upper case variants). If this field is omitted, the value of the <span -class="cmss-10">name</span><a - id="dx1-34030"></a> key is - used. + id="dx1-112029"></a> (or one of its upper case variants). If + this field is omitted, the value of the <span +class="cmtt-10">name</span><a + id="dx1-112030"></a> key is used. </dd><dt class="description"> <span -class="cmssbx-10">first</span><a - id="dx1-34031"></a> </dt><dd +class="cmtt-10">first</span><a + id="dx1-112031"></a> </dt><dd class="description">How the entry will appear in the document text on <a href="#glo:firstuse">first use</a> with <span class="cmtt-10">\gls</span><a - id="dx1-34032"></a> (or one of its - upper case variants). If this field is omitted, the value of the <span -class="cmss-10">text</span><a - id="dx1-34033"></a> key is used. Note that - if you use <span + id="dx1-112032"></a> (or one of its upper case + variants). If this field is omitted, the value of the <span +class="cmtt-10">text</span><a + id="dx1-112033"></a> key is used. Note that if you use <span class="cmtt-10">\glspl</span><a - id="dx1-34034"></a>, <span + id="dx1-112034"></a>, + <span class="cmtt-10">\Glspl</span><a - id="dx1-34035"></a>, <span + id="dx1-112035"></a>, <span class="cmtt-10">\GLSpl</span><a - id="dx1-34036"></a>, <span + id="dx1-112036"></a>, <span class="cmtt-10">\glsdisp</span><a - id="dx1-34037"></a> before using <span + id="dx1-112037"></a> before using <span class="cmtt-10">\gls</span><a - id="dx1-34038"></a>, the <span -class="cmss-10">firstplural</span><a - id="dx1-34039"></a> value - won’t be used with <span + id="dx1-112038"></a>, the <span +class="cmtt-10">firstplural</span><a + id="dx1-112039"></a> value won’t be used with + <span class="cmtt-10">\gls</span><a - id="dx1-34040"></a>. + id="dx1-112040"></a>. </dd><dt class="description"> <span -class="cmssbx-10">plural</span><a - id="dx1-34041"></a> </dt><dd +class="cmtt-10">plural</span><a + id="dx1-112041"></a> </dt><dd class="description">How the entry will appear in the document text when using <span class="cmtt-10">\glspl</span><a - id="dx1-34042"></a> (or one - of its upper case variants). If this field is omitted, the value is obtained by - appending <span + id="dx1-112042"></a> (or one of its upper case variants). + If this field is omitted, the value is obtained by appending <span class="cmtt-10">\glspluralsuffix</span><a - id="dx1-34043"></a> to the value of the <span -class="cmss-10">text</span><a - id="dx1-34044"></a> field. The default value of - <span + id="dx1-112043"></a> to the value of the <span +class="cmtt-10">text</span><a + id="dx1-112044"></a> + field. The default value of <span class="cmtt-10">\glspluralsuffix</span><a - id="dx1-34045"></a> is the letter “s”. + id="dx1-112045"></a> is the letter “s”. </dd><dt class="description"> <span -class="cmssbx-10">firstplural</span><a - id="dx1-34046"></a> </dt><dd +class="cmtt-10">firstplural</span><a + id="dx1-112046"></a> </dt><dd class="description">How the entry will appear in the document text on <a href="#glo:firstuse">first use</a> with <span class="cmtt-10">\glspl</span><a - id="dx1-34047"></a> (or one - of its upper case variants). If this field is omitted, the value is obtained from the <span -class="cmss-10">plural</span><a - id="dx1-34048"></a> - key, if the <span -class="cmss-10">first</span><a - id="dx1-34049"></a> key is omitted, or by appending <span + id="dx1-112047"></a> (or one of its upper case + variants). If this field is omitted, the value is obtained from the <span +class="cmtt-10">plural</span><a + id="dx1-112048"></a> key, if the <span +class="cmtt-10">first</span><a + id="dx1-112049"></a> key is omitted, or + by appending <span class="cmtt-10">\glspluralsuffix</span><a - id="dx1-34050"></a> to the value of - the <span -class="cmss-10">first</span><a - id="dx1-34051"></a> field, if the <span -class="cmss-10">first</span><a - id="dx1-34052"></a> field is present. Note that if you use <span + id="dx1-112050"></a> to the value of the <span +class="cmtt-10">first</span><a + id="dx1-112051"></a> field, if the <span +class="cmtt-10">first</span><a + id="dx1-112052"></a> field is present. Note that if + you use <span class="cmtt-10">\gls</span><a - id="dx1-34053"></a>, <span + id="dx1-112053"></a>, <span class="cmtt-10">\Gls</span><a - id="dx1-34054"></a>, - <span + id="dx1-112054"></a>, <span class="cmtt-10">\GLS</span><a - id="dx1-34055"></a>, <span + id="dx1-112055"></a>, <span class="cmtt-10">\glsdisp </span>before using <span class="cmtt-10">\glspl</span><a - id="dx1-34056"></a>, the <span -class="cmss-10">firstplural</span><a - id="dx1-34057"></a> value won’t be used with + id="dx1-112056"></a>, the <span +class="cmtt-10">firstplural</span><a + id="dx1-112057"></a> value won’t be used with <span class="cmtt-10">\glspl</span><a - id="dx1-34058"></a>. - <!--l. 4815--><p class="noindent" ><span -class="cmbx-10">Note: </span>prior to version 1.13, the default value of <span -class="cmss-10">firstplural</span><a - id="dx1-34059"></a> was always taken by - appending “s” to the <span -class="cmss-10">first</span><a - id="dx1-34060"></a> key, which meant that you had to specify both <span -class="cmss-10">plural</span><a - id="dx1-34061"></a> and + id="dx1-112058"></a>. + <!--l. 5583--><p class="noindent" ><span class="warningsymbol">⚠</span> Note: prior to version 1.13, the default value of <span +class="cmtt-10">firstplural</span><a + id="dx1-112059"></a> was always taken by appending “s” to the <span -class="cmss-10">firstplural</span><a - id="dx1-34062"></a>, even if you hadn’t used the <span -class="cmss-10">first</span><a - id="dx1-34063"></a> key. +class="cmtt-10">first</span><a + id="dx1-112060"></a> key, which meant that you had to specify both <span +class="cmtt-10">plural</span><a + id="dx1-112061"></a> and <span +class="cmtt-10">firstplural</span><a + id="dx1-112062"></a>, even if you hadn’t used + the <span +class="cmtt-10">first</span><a + id="dx1-112063"></a> key. </p></dd><dt class="description"> <span -class="cmssbx-10">symbol</span><a - id="dx1-34064"></a> </dt><dd -class="description">This field is provided to allow the user to specify an associated symbol. If - omitted, the value is set to <span -class="cmtt-10">\relax</span>. Note that not all glossary styles display the - symbol. +class="cmtt-10">symbol</span><a + id="dx1-112064"></a> </dt><dd +class="description">This field is provided to allow the user to specify an associated symbol. If omitted, the value is set to + <span +class="cmtt-10">\relax</span>. Note that not all glossary styles display the symbol. </dd><dt class="description"> <span -class="cmssbx-10">symbolplural</span><a - id="dx1-34065"></a> </dt><dd +class="cmtt-10">symbolplural</span><a + id="dx1-112065"></a> </dt><dd class="description">This is the plural form of the symbol (as passed to <span class="cmtt-10">\glsdisplay</span><a - id="dx1-34066"></a> and - - - <span + id="dx1-112066"></a> and <span class="cmtt-10">\glsdisplayfirst</span><a - id="dx1-34067"></a> by <span + id="dx1-112067"></a> by + <span class="cmtt-10">\glspl</span><a - id="dx1-34068"></a>, <span + id="dx1-112068"></a>, <span class="cmtt-10">\Glspl</span><a - id="dx1-34069"></a> and <span + id="dx1-112069"></a> and <span class="cmtt-10">\GLSpl</span><a - id="dx1-34070"></a>). If omitted, the value is set to the - same as the <span -class="cmss-10">symbol</span><a - id="dx1-34071"></a> key. + id="dx1-112070"></a>). If omitted, the value is set to the same as the <span +class="cmtt-10">symbol</span><a + id="dx1-112071"></a> key. </dd><dt class="description"> <span -class="cmssbx-10">sort</span><a - id="dx1-34072"></a> </dt><dd +class="cmtt-10">sort</span><a + id="dx1-112072"></a> </dt><dd class="description">This value indicates how this entry should be sorted. If omitted, the value is given by the <span -class="cmss-10">name</span><a - id="dx1-34073"></a> field unless one of the package options <span -class="cmss-10">sort=def</span><a - id="dx1-34074"></a> and <span -class="cmss-10">sort=use</span><a - id="dx1-34075"></a> have been - used. In general, it’s best to use the <span -class="cmss-10">sort</span><a - id="dx1-34076"></a> key if the <span -class="cmss-10">name</span><a - id="dx1-34077"></a> contains commands - (e.g. <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\ensuremath{\alpha}</span></span></span>). You can also override the <span -class="cmss-10">sort</span><a - id="dx1-34078"></a> key by redefining - <span +class="cmtt-10">name</span><a + id="dx1-112073"></a> field unless one of the package options <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-112074"></a> and <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-112075"></a> have been used. In general, + it’s best to use the <span +class="cmtt-10">sort</span><a + id="dx1-112076"></a> key if the <span +class="cmtt-10">name</span><a + id="dx1-112077"></a> contains commands (e.g. <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ensuremath{\alpha}</span></span></span>). + You can also override the <span +class="cmtt-10">sort</span><a + id="dx1-112078"></a> key by redefining <span class="cmtt-10">\glsprestandardsort</span><a - id="dx1-34079"></a> (see <a -href="#sec:pkgopts-sort"><span -class="tcrm-1000">§</span>2.4 </a><a -href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>). - <!--l. 4839--><p class="noindent" ><a + id="dx1-112079"></a> (see <a +href="#sec:pkgopts-sort">§2.5 </a><a +href="#sec:pkgopts-sort">Sorting + Options<!--tex4ht:ref: sec:pkgopts-sort --></a>). + <!--l. 5607--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> The <span +class="cmtt-10">sort</span><a + id="dx1-112080"></a> key shouldn’t be used with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-112081"></a></a>. It has a system of fallbacks that allow different types of + entries to obtain the sort value from the most relevant field. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-112082"></a></a> manual for further details + and see also <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a>. </div> + </p><!--l. 5613--><p class="noindent" > + + + </p><!--l. 5615--><p class="noindent" ><a href="#option1">Option 1</a> by default strips the <a href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> accents</a> (that is, accents generated by - core <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> accents</a> (that is, accents generated by core + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> commands) from the <span -class="cmss-10">name</span><a - id="dx1-34080"></a> key when it sets the <span -class="cmss-10">sort</span><a - id="dx1-34081"></a> key. So with - <a +class="cmtt-10">name</span><a + id="dx1-112083"></a> key when it sets the <span +class="cmtt-10">sort</span><a + id="dx1-112084"></a> key. So with <a href="#option1">Option 1</a>: - - + + </p> - <div class="verbatim" id="verbatim-137"> + <div class="verbatim" id="verbatim-133"> \newglossaryentry{elite}{%  <br />  name={{\'e}lite},  <br />  description={select group of people}  <br />} </div> - <!--l. 4848--><p class="nopar" > This is equivalent to: - - + <!--l. 5624--><p class="nopar" > This is equivalent to: + + </p> - <div class="verbatim" id="verbatim-138"> + <div class="verbatim" id="verbatim-134"> \newglossaryentry{elite}{%  <br />  name={{\'e}lite},  <br />  description={select group of people},  <br />  sort={elite}  <br />} </div> - <!--l. 4856--><p class="nopar" > Unless you use the package option <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-34082"></a>, in which case it’s equivalent - to: - - + <!--l. 5632--><p class="nopar" > Unless you use the package option <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-112085"></a>, in which case it’s equivalent to: + + </p> - <div class="verbatim" id="verbatim-139"> + <div class="verbatim" id="verbatim-135"> \newglossaryentry{elite}{%  <br />  name={{\'e}lite},  <br />  description={select group of people},  <br />  sort={\'elite}  <br />} </div> - <!--l. 4865--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a - symbol. - </p><!--l. 4869--><p class="noindent" >Similarly if you use the <span + <!--l. 5641--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a symbol. + </p><!--l. 5645--><p class="noindent" >Similarly if you use the <span class="cmss-10">inputenc</span><a - id="dx1-34083"></a> package: </p><div class="alltt"> + id="dx1-112086"></a> package: </p><div class="alltt"> <div class="obeylines-v"> - <span class="verb"><span -class="cmtt-10">\newglossaryentry{elite}{%</span></span> + <span +class="cmtt-10">\newglossaryentry{elite}{%</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> name=</span><span class="verb"><span -class="cmtt-10">{{</span></span><span -class="cmtt-10">é</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">lite</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">,</span> +class="cmtt-10"> name={{</span><span +class="cmtt-10">é</span><span +class="cmtt-10">}lite},</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> description=</span><span class="verb"><span -class="cmtt-10">{select</span><span +class="cmtt-10"> description={select</span><span class="cmtt-10"> group</span><span class="cmtt-10"> of</span><span -class="cmtt-10"> people}</span></span> - <br /><span class="verb"><span -class="cmtt-10">}</span></span> +class="cmtt-10"> people}</span> + <br /><span +class="cmtt-10">}</span> </div> </div> This is equivalent to <div class="alltt"> <div class="obeylines-v"> - <span class="verb"><span -class="cmtt-10">\newglossaryentry{elite}{%</span></span> + <span +class="cmtt-10">\newglossaryentry{elite}{%</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> name=</span><span class="verb"><span -class="cmtt-10">{{</span></span><span -class="cmtt-10">é</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">lite</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">,</span> +class="cmtt-10"> name=i{{</span><span +class="cmtt-10">é</span><span +class="cmtt-10">}lite},</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> description=</span><span class="verb"><span -class="cmtt-10">{select</span><span +class="cmtt-10"> description={select</span><span class="cmtt-10"> group</span><span class="cmtt-10"> of</span><span -class="cmtt-10"> people}</span></span><span -class="cmtt-10">,</span> +class="cmtt-10"> people},</span> <br /><span class="cmtt-10"> </span><span class="cmtt-10"> sort=elite</span> - <br /><span class="verb"><span -class="cmtt-10">}</span></span> + <br /><span +class="cmtt-10">}</span> </div> </div> Unless you use the package option <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-34084"></a>, in which case it’s equivalent to: - <div class="alltt"> +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-112087"></a>, in which case it’s equivalent to: <div class="alltt"> <div class="obeylines-v"> - <span class="verb"><span -class="cmtt-10">\newglossaryentry{elite}{%</span></span> + <span +class="cmtt-10">\newglossaryentry{elite}{%</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> name=</span><span class="verb"><span -class="cmtt-10">{{</span></span><span -class="cmtt-10">é</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">lite</span><span class="verb"><span -class="cmtt-10">}</span></span><span -class="cmtt-10">,</span> +class="cmtt-10"> name={{</span><span +class="cmtt-10">é</span><span +class="cmtt-10">}lite},</span> <br /><span class="cmtt-10"> </span><span -class="cmtt-10"> description=</span><span class="verb"><span -class="cmtt-10">{select</span><span +class="cmtt-10"> description={select</span><span class="cmtt-10"> group</span><span class="cmtt-10"> of</span><span -class="cmtt-10"> people}</span></span><span -class="cmtt-10">,</span> +class="cmtt-10"> people},</span> <br /><span class="cmtt-10"> </span><span class="cmtt-10"> sort=</span><span class="cmtt-10">é</span><span class="cmtt-10">lite</span> - <br /><span class="verb"><span -class="cmtt-10">}</span></span> + <br /><span +class="cmtt-10">}</span> </div> </div> Again, this will place the entry before the “A” group. - - - <!--l. 4895--><p class="noindent" >With Options <a + <!--l. 5671--><p class="noindent" >With Options <a href="#option2">2</a> and <a href="#option3">3</a>, the default value of <span -class="cmss-10">sort</span><a - id="dx1-34085"></a> will either be set to the <span -class="cmss-10">name</span><a - id="dx1-34086"></a> - key (if <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-34087"></a>) or it will set it to the expansion of the <span -class="cmss-10">name</span><a - id="dx1-34088"></a> key (if - <span -class="cmss-10">sanitizesort=false</span><a - id="dx1-34089"></a>). - </p><!--l. 4900--><p class="noindent" ><div class="important" title="Important Note"> Take care with <a +class="cmtt-10">sort</span><a + id="dx1-112088"></a> will either be set to the <span +class="cmtt-10">name</span><a + id="dx1-112089"></a> key (if <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-112090"></a>) or + it will set it to the expansion of the <span +class="cmtt-10">name</span><a + id="dx1-112091"></a> key (if <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-112092"></a>). + + + </p><!--l. 5676--><p class="noindent" ><div class="important" title="Important Note"> Take care with <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-34090"></a></a> (<a + id="dx1-112093"></a></a> (<a href="#option3">Option 3</a>): if you have entries with the same <span -class="cmss-10">sort</span><a - id="dx1-34091"></a> value they will - be treated as the same entry. If you use <a +class="cmtt-10">sort</span><a + id="dx1-112094"></a> value they will be treated as + the same entry. If you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-34092"></a></a> and aren’t using the <span + id="dx1-112095"></a></a> and aren’t using the <span class="cmtt-10">def </span>or <span -class="cmtt-10">use </span>sort - methods, <span -class="cmbx-10">always </span>use the <span -class="cmss-10">sort</span><a - id="dx1-34093"></a> key for entries where the name just consists of a control - sequence (for example <span +class="cmtt-10">use </span>sort methods, <strong>always</strong> use + the <span +class="cmtt-10">sort</span><a + id="dx1-112096"></a> key for entries where the name just consists of a control sequence (for example + <span class="cmtt-10">name=</span><span class="cmsy-10">{</span><span class="cmtt-10">\alpha</span><span class="cmsy-10">}</span>). - </p><!--l. 4908--><p class="noindent" >Take care if you use <a + </p><!--l. 5684--><p class="noindent" >Take care if you use <a href="#option1">Option 1</a> and the <span -class="cmss-10">name</span><a - id="dx1-34094"></a> contains fragile commands. You will either - need to explicitly set the <span -class="cmss-10">sort</span><a - id="dx1-34095"></a> key or use the <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-34096"></a> package option (unless you - use the <span +class="cmtt-10">name</span><a + id="dx1-112097"></a> contains fragile commands. You will either need to explicitly + set the <span +class="cmtt-10">sort</span><a + id="dx1-112098"></a> key or use the <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-112099"></a> package option (unless you use the <span class="cmtt-10">def </span>or <span -class="cmtt-10">use </span>sort methods). </div> - </p><!--l. 4912--><p class="noindent" > +class="cmtt-10">use </span>sort methods). + </div> + </p><!--l. 5688--><p class="noindent" > </p></dd><dt class="description"> <span -class="cmssbx-10">type</span><a - id="dx1-34097"></a> </dt><dd -class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the - default glossary is assumed unless <span +class="cmtt-10">type</span><a + id="dx1-112100"></a> </dt><dd +class="description">This specifies the label of the glossary in which this entry belongs. If omitted, the default glossary is + assumed unless <span class="cmtt-10">\newacronym</span><a - id="dx1-34098"></a> is used (see <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other - Abbreviations<!--tex4ht:ref: sec:acronyms --></a>). + id="dx1-112101"></a> is used (see <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>). </dd><dt class="description"> <span -class="cmssbx-10">user1</span><a - id="dx1-34099"></a><span +class="cmtt-10">user1</span><a + id="dx1-112102"></a><span class="cmbx-10">, </span><span class="cmbx-10">…, </span><span -class="cmssbx-10">user6</span><a - id="dx1-34100"></a><a - id="dx1-34101"></a><a - id="dx1-34102"></a><a - id="dx1-34103"></a><a - id="dx1-34104"></a> </dt><dd -class="description">Six keys provided for any additional information the user may want to - specify. (For example, an associated dimension or an alternative plural or some other - grammatical construct.) Alternatively, you can add new keys using <span +class="cmtt-10">user6</span><a + id="dx1-112103"></a><a + id="dx1-112104"></a><a + id="dx1-112105"></a><a + id="dx1-112106"></a><a + id="dx1-112107"></a> </dt><dd +class="description">Six keys provided for any additional information the user may want to specify. (For + example, an associated dimension or an alternative plural or some other grammatical construct.) + Alternatively, you can add new keys using <span class="cmtt-10">\glsaddkey</span><a - id="dx1-34105"></a> or - <span + id="dx1-112108"></a> or <span class="cmtt-10">\glsaddstoragekey</span><a - id="dx1-34106"></a> (see <a -href="#sec:addkey"><span -class="tcrm-1000">§</span>4.3 </a><a -href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>). + id="dx1-112109"></a> (see <a +href="#sec:addkey">§4.3 </a><a +href="#sec:addkey">Additional + Keys<!--tex4ht:ref: sec:addkey --></a>). </dd><dt class="description"> <span -class="cmssbx-10">nonumberlist</span><a - id="dx1-34107"></a> </dt><dd +class="cmtt-10">nonumberlist</span><a + id="dx1-112110"></a> </dt><dd class="description">A boolean key. If the value is missing or is <span class="cmtt-10">true</span>, this will suppress the <a href="#glo:numberlist">number list<a - id="dx1-34108"></a></a> just for this entry. Conversely, if you have used the package option <span + id="dx1-112111"></a></a> just for this entry. Conversely, if you have used the package option <span class="cmss-10">nonumberlist</span><a - id="dx1-34109"></a>, you + id="dx1-112112"></a>, you can activate the number list<a - id="dx1-34110"></a> just for this entry with <span -class="cmss-10">nonumberlist=false</span><a - id="dx1-34111"></a>. (See <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a + id="dx1-112113"></a> just for this entry with <span +class="cmtt-10">nonumberlist=false</span><a + id="dx1-112114"></a>. (See <a +href="#sec:numberlists">§5 </a><a href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) </dd><dt class="description"> <span -class="cmssbx-10">see</span><a - id="dx1-34112"></a> </dt><dd +class="cmtt-10">see</span><a + id="dx1-112115"></a> </dt><dd class="description">Cross-reference another entry. Using the <span -class="cmss-10">see</span><a - id="dx1-34113"></a> key will <span -class="cmti-10">automatically add this entry to the</span> - <span -class="cmti-10">glossary</span>, but will not automatically add the cross-referenced entry. The referenced entry - should be supplied as the value to this key. If you want to override the “see” tag, - you can supply the new tag in square brackets before the label. For example - <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">see</span><a + id="dx1-112116"></a> key will <span +class="cmti-10">automatically add this entry to the glossary</span>, but will + not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to + this key. If you want to override the “see” tag, you can supply the new tag in square brackets before the + label. For example <span class="obeylines-h"><span class="verb"><span class="cmtt-10">see=[see</span><span -class="cmtt-10"> also]{anotherlabel}</span></span></span>. <span -class="cmbx-10">Note that if you have suppressed the </span><a -href="#glo:numberlist"><span -class="cmbx-10">number</span> - <span -class="cmbx-10">list</span><a - id="dx1-34114"></a></a><span -class="cmbx-10">, the cross-referencing information won’t appear in the glossary, as it</span> - <span -class="cmbx-10">forms part of the number list</span><a - id="dx1-34115"></a><span -class="cmbx-10">. </span>You can override this for individual glossary - entries using <span -class="cmss-10">nonumberlist=false</span><a - id="dx1-34116"></a> (see above). Alternatively, you can use the - <span +class="cmtt-10"> also]{anotherlabel}</span></span></span>. <strong>Note that if you have suppressed the <a +href="#glo:numberlist">number list<a + id="dx1-112117"></a></a>, + the cross-referencing information won’t appear in the glossary, as it forms part of the number list<a + id="dx1-112118"></a>.</strong> You can + override this for individual glossary entries using <span +class="cmtt-10">nonumberlist=false</span><a + id="dx1-112119"></a> (see above). Alternatively, you + can use the <span class="cmss-10">seeautonumberlist</span><a - id="dx1-34117"></a> package option. For further details, see <a -href="#sec:crossref"><span -class="tcrm-1000">§</span>8 </a><a + id="dx1-112120"></a> package option. For further details, see <a +href="#sec:crossref">§8 </a><a href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>. - <!--l. 4947--><p class="noindent" >This key essentially provides a convenient shortcut that performs </p><div class="alltt"> + <!--l. 5723--><p class="noindent" >This key essentially provides a convenient shortcut that performs </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\glssee[</span>⟨<span @@ -10404,230 +12690,300 @@ class="cmitt-10">xr-label</span><span class="cmitt-10"> list</span>⟩<span class="cmtt-10">}</span> </div> - - </div> after the entry has been defined. - <!--l. 4953--><p class="noindent" ><div class="important" title="Important Note"> For Options <a + <!--l. 5729--><p class="noindent" ><div class="important" title="Important Note"> For Options <a href="#option2">2</a> and <a href="#option3">3</a>, <span class="cmtt-10">\makeglossaries</span><a - id="dx1-34118"></a> must be used before any occurrence of - <span + id="dx1-112121"></a> must be used before any occurrence of <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-34119"></a> that contains the <span -class="cmss-10">see</span><a - id="dx1-34120"></a> key. This key should not be used with entries - defined in the <span + id="dx1-112122"></a> that + contains the <span +class="cmtt-10">see</span><a + id="dx1-112123"></a> key. This key should not be used with entries defined in the <span class="cmss-10">document</span><a - id="dx1-34121"></a><a - id="dx1-34122"></a> environment. </div> - </p><!--l. 4957--><p class="noindent" > - Since it’s useful to suppress the indexing while working on a draft document, - consider using the <span -class="cmss-10">seenoindex</span><a - id="dx1-34123"></a> package option to warn or ignore the <span -class="cmss-10">see</span><a - id="dx1-34124"></a> key while + id="dx1-112124"></a><a + id="dx1-112125"></a> environment. + </div> + + + </p><!--l. 5733--><p class="noindent" > + Since it’s useful to suppress the indexing while working on a draft document, consider using the <span -class="cmtt-10">\makeglossaries </span>is commented out. - </p><!--l. 4963--><p class="noindent" >If you use the <span -class="cmss-10">see</span><a - id="dx1-34125"></a> key, you may want to consider using the <a +class="cmss-10">seenoindex</span><a + id="dx1-112126"></a> package option to warn or ignore the <span +class="cmtt-10">see</span><a + id="dx1-112127"></a> key while <span +class="cmtt-10">\makeglossaries </span>is commented + out. + </p><!--l. 5739--><p class="noindent" >If you use the <span +class="cmtt-10">see</span><a + id="dx1-112128"></a> key, you may want to consider using the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package which - additionally provides a <span +class="cmss-10">glossaries-extra</span></a> package which additionally + provides a <span class="cmtt-10">seealso </span>and <span -class="cmtt-10">alias </span>key. If you want to avoid the automatic - indexing triggered by the <span -class="cmss-10">see</span><a - id="dx1-34126"></a> key, consider using <a +class="cmtt-10">alias </span>key. If you want to avoid the automatic indexing triggered by the <span +class="cmtt-10">see</span><a + id="dx1-112129"></a> key, + consider using <a href="#option4">Option 4</a>. -</p> + </p></dd><dt class="description"> +<span id="textcolor253"><span id="textcolor254"><span +class="cmtt-10">seealso</span></span><a + id="dx1-112130"></a></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and is similar to <span +class="cmtt-10">see</span><a + id="dx1-112131"></a> but it doesn’t allow for the + optional tag. The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides <span id="textcolor255"><span +class="cmtt-10">\seealsoname</span></span><a + id="dx1-112132"></a> and <span +class="cmtt-10">seealso={</span>⟨<span +class="cmitt-10">list</span>⟩<span +class="cmtt-10">} </span>is essentially like + <span +class="cmtt-10">see=[</span><span id="textcolor256"><span +class="cmtt-10">\seealsoname</span></span><a + id="dx1-112133"></a><span +class="cmtt-10">]</span>⟨<span +class="cmitt-10">list</span>⟩ (Options <a +href="#option3">3</a> and <a +href="#option4">4</a> may treat these differently). + </dd><dt class="description"> +<span id="textcolor257"><span id="textcolor258"><span +class="cmtt-10">alias</span></span><a + id="dx1-112134"></a></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and is another form of cross-referencing. An entry can be + aliased to another entry with <span +class="cmtt-10">alias={</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}</span>. This behaves like <span +class="cmtt-10">see={</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span>but also alters the + behaviour of commands like <span +class="cmtt-10">\gls </span>so that they index the entry given by ⟨<span +class="cmti-10">label</span>⟩ instead of the original entry. + More variations with the key are available with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-112135"></a></a>. + </dd><dt class="description"> +<span id="textcolor259"><span id="textcolor260"><span +class="cmtt-10">category</span></span><a + id="dx1-112136"></a></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and is used to assign a category to the entry. The value + should be a label that can be used to identify the category. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further + details. </dd></dl> -<!--l. 4971--><p class="indent" > The following keys are reserved for <span +<!--l. 5770--><p class="indent" > The following keys are reserved for <span class="cmtt-10">\newacronym</span><a - id="dx1-34127"></a> (see <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other -Abbreviations<!--tex4ht:ref: sec:acronyms --></a>): <span -class="cmss-10">long</span><a - id="dx1-34128"></a>, <span -class="cmss-10">longplural</span><a - id="dx1-34129"></a>, <span -class="cmss-10">short</span><a - id="dx1-34130"></a> and <span -class="cmss-10">shortplural</span><a - id="dx1-34131"></a>. -</p><!--l. 4975--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a + id="dx1-112137"></a> (see <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>) +and also for <span id="textcolor261"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-112138"></a> (see the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual): <span +class="cmtt-10">long</span><a + id="dx1-112139"></a>, <span +class="cmtt-10">longplural</span><a + id="dx1-112140"></a>, <span +class="cmtt-10">short</span><a + id="dx1-112141"></a> and +<span +class="cmtt-10">shortplural</span><a + id="dx1-112142"></a>. +</p><!--l. 5775--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> There are also special internal field names used by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-112143"></a></a>. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-112144"></a></a> manual for further details. +</div> +</p><!--l. 5778--><p class="noindent" > +</p><!--l. 5780--><p class="indent" > The supplementary packages <span +class="cmss-10">glossaries-prefix </span>(<a +href="#sec:prefix">§17 </a><a +href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span +class="cmss-10">glossaries-accsupp </span>(<a +href="#sec:accsupp">§18 +</a><a +href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>) provide additional keys. +</p><!--l. 5783--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> or <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands within the <span -class="cmss-10">text</span><a - id="dx1-34132"></a>, <span -class="cmss-10">first</span><a - id="dx1-34133"></a>, <span -class="cmss-10">short</span><a - id="dx1-34134"></a> -or <span -class="cmss-10">long</span><a - id="dx1-34135"></a> keys (or their plural equivalent) or any other key that you plan to access through -those commands. (For example, the <span -class="cmss-10">symbol</span><a - id="dx1-34136"></a> key if you intend to use <span -class="cmtt-10">\glssymbol</span>.) Otherwise -you end up with nested links, which can cause complications and they won’t work with the -case-changing commands. You can use them within the value of keys that won’t be accessed -through those commands. For example, the <span -class="cmss-10">description</span><a - id="dx1-34137"></a> key if you don’t use <span -class="cmtt-10">\glsdesc</span>. -Additionally, they’ll confuse the entry formatting commands, such as <span +class="cmtt-10">text</span><a + id="dx1-112145"></a>, <span +class="cmtt-10">first</span><a + id="dx1-112146"></a>, <span +class="cmtt-10">short</span><a + id="dx1-112147"></a> or <span +class="cmtt-10">long</span><a + id="dx1-112148"></a> keys +(or their plural equivalent) or any other key that you plan to access through those commands. (For example, the +<span +class="cmtt-10">symbol</span><a + id="dx1-112149"></a> key if you intend to use <span +class="cmtt-10">\glssymbol</span>.) Otherwise you end up with nested links, which can cause +complications and they won’t work with the case-changing commands. You can use them within the value of +keys that won’t be accessed through those commands. For example, the <span +class="cmtt-10">description</span><a + id="dx1-112150"></a> key if you don’t +use <span +class="cmtt-10">\glsdesc</span>. Additionally, they’ll confuse the entry formatting commands, such as <span class="cmtt-10">\glslabel</span>. </div> -</p><!--l. 4988--><p class="noindent" > -</p><!--l. 4990--><p class="indent" > Note that if the name starts with <a +</p><!--l. 5796--><p class="noindent" > +</p><!--l. 5798--><p class="indent" > Note that if the name starts with <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-34138"></a></a>, you must group the -character, otherwise it will cause a problem for commands like <span + id="dx1-112151"></a></a>, you must group the character, otherwise it will cause +a problem for commands like <span class="cmtt-10">\Gls</span><a - id="dx1-34139"></a> and <span + id="dx1-112152"></a> and <span class="cmtt-10">\Glspl</span><a - id="dx1-34140"></a>. For -example: - - + id="dx1-112153"></a>. For example: + + </p> - <div class="verbatim" id="verbatim-140"> + <div class="verbatim" id="verbatim-136"> \newglossaryentry{elite}{name={{\'e}lite},  <br />description={select group or class}} </div> -<!--l. 4997--><p class="nopar" > Note that the same applies if you are using the <span +<!--l. 5805--><p class="nopar" > Note that the same applies if you are using the <span class="cmss-10">inputenc</span><a - id="dx1-34141"></a> package: </p><div class="alltt"> + id="dx1-112154"></a> package: </p><div class="alltt"> <div class="obeylines-v"> -<span class="verb"><span -class="cmtt-10">\newglossaryentry{elite}{name={{</span></span><span -class="cmtt-10">é</span><span class="verb"><span -class="cmtt-10">}lite},</span></span> +<span +class="cmtt-10">\newglossaryentry{elite}{name={{</span><span +class="cmtt-10">é</span><span +class="cmtt-10">}lite},</span> <br /><span -class="cmtt-10">description=</span><span class="verb"><span -class="cmtt-10">{select</span><span +class="cmtt-10">description={select</span><span class="cmtt-10"> group</span><span class="cmtt-10"> or</span><span -class="cmtt-10"> class}}</span></span> +class="cmtt-10"> class}}</span> </div> </div> (This doesn’t apply for XeLaTeX documents using the <span class="cmss-10">fontspec</span><a - id="dx1-34142"></a> package. For further details, -see the “UTF-8” section in the <span + id="dx1-112155"></a> package. For further details, see the “UTF-8” +section in the <span class="cmss-10">mfirstuc</span><a - id="dx1-34143"></a> user manual.) -<!--l. 5008--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span -class="cmss-10">sort</span><a - id="dx1-34144"></a> key if you -are using <a + id="dx1-112156"></a> user manual.) +<!--l. 5816--><p class="indent" > Note that in both of the above examples, you will also need to supply the <span +class="cmtt-10">sort</span><a + id="dx1-112157"></a> key if you are +using <a href="#option2">Option 2</a> whereas <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-34145"></a></a> (<a + id="dx1-112158"></a></a> (<a href="#option3">Option 3</a>) is usually able to sort <a href="#glo:nonlatinchar">non-Latin character<a - id="dx1-34146"></a>s</a> -correctly. <a + id="dx1-112159"></a>s</a> correctly. +<a href="#option1">Option 1</a> discards accents from <a href="#glo:latexexlatinchar">standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> extended Latin character<a - id="dx1-34147"></a>s</a> unless -you use the <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-34148"></a>. + id="dx1-112160"></a>s</a> unless you use the +<span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-112161"></a>. </p> -<!--l. 5016--><p class="noindent" ><a +<!--l. 5824--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.1 </span> <a id="sec:plurals"></a>Plurals</h3> -<!--l. 5019--><p class="noindent" >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 -</p><!--l. 5022--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspluralsuffix</span><span -class="cmtt-9"> </span></span><a - id="dx1-35001"></a> <span +<!--l. 5827--><p class="noindent" >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 +</p><!--l. 5830--><p class="indent" > <hr><div title="Definition"><a + id="dx1-113001"></a> <span class="cmtt-10">\glspluralsuffix </span></div><hr> -</p><!--l. 5024--><p class="noindent" > +</p><!--l. 5832--><p class="noindent" > to the singular form. This command defaults to the letter “s”. For example: - - + + </p> - <div class="verbatim" id="verbatim-141"> + <div class="verbatim" id="verbatim-137"> \newglossaryentry{cow}{name=cow,description={a fully grown  <br />female of any bovine animal}} </div> -<!--l. 5030--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you -are writing in archaic English, you may want to use “kine” as the plural form, in which case -you would have to do: - - +<!--l. 5838--><p class="nopar" > defines a new entry whose singular form is “cow” and plural form is “cows”. However, if you are writing in +archaic English, you may want to use “kine” as the plural form, in which case you would have to +do: + + </p> - <div class="verbatim" id="verbatim-142"> + <div class="verbatim" id="verbatim-138"> \newglossaryentry{cow}{name=cow,plural=kine,  <br />description={a fully grown female of any bovine animal}} </div> -<!--l. 5038--><p class="nopar" > -</p><!--l. 5040--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use -the <span -class="cmss-10">plural</span><a - id="dx1-35002"></a> key for one of them and one of the user keys to specify the other plural form. For -example: - - +<!--l. 5846--><p class="nopar" > +</p><!--l. 5848--><p class="indent" > If you are writing in a language that supports multiple plurals (for a given term) then use the <span +class="cmtt-10">plural</span><a + id="dx1-113002"></a> key for +one of them and one of the user keys to specify the other plural form. For example: + + </p> - <div class="verbatim" id="verbatim-143"> + <div class="verbatim" id="verbatim-139"> \newglossaryentry{cow}{%  <br />  name=cow,%  <br />  description={a fully grown female of any bovine animal  <br />               (plural cows, archaic plural kine)},%  <br />  user1={kine}} </div> -<!--l. 5050--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span +<!--l. 5858--><p class="nopar" > You can then use <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspl{cow}</span></span></span> to produce “cows” and <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsuseri{cow}</span></span></span> to produce “kine”. -You can, of course, define an easy to remember synonym. For example: - - +class="cmtt-10">\glsuseri{cow}</span></span></span> to produce “kine”. You can, of course, +define an easy to remember synonym. For example: + + </p> - <div class="verbatim" id="verbatim-144"> + <div class="verbatim" id="verbatim-140"> \let\glsaltpl\glsuseri </div> -<!--l. 5056--><p class="nopar" > Then you don’t have to remember which key you used to store the second plural. -Alternatively, you can define your own keys using <span +<!--l. 5864--><p class="nopar" > Then you don’t have to remember which key you used to store the second plural. Alternatively, you can define +your own keys using <span class="cmtt-10">\glsaddkey</span><a - id="dx1-35003"></a>, described in <a -href="#sec:addkey"><span -class="tcrm-1000">§</span>4.3 </a><a -href="#sec:addkey">Additional -Keys<!--tex4ht:ref: sec:addkey --></a>. -</p><!--l. 5061--><p class="indent" > If you are using a language that usually forms plurals by appending a different letter, or -sequence of letters, you can redefine <span -class="cmtt-10">\glspluralsuffix </span>as required. However, this must be -done <span -class="cmti-10">before </span>the entries are defined. For languages that don’t form plurals by simply -appending a suffix, all the plural forms must be specified using the <span -class="cmss-10">plural</span><a - id="dx1-35004"></a> key (and the -<span -class="cmss-10">firstplural</span><a - id="dx1-35005"></a> key where necessary). -</p><!--l. 5069--><p class="noindent" > -</p> -<!--l. 5069--><p class="noindent" ><a + id="dx1-113003"></a>, described in <a +href="#sec:addkey">§4.3 </a><a +href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>. +</p><!--l. 5869--><p class="indent" > If you are using a language that usually forms plurals by appending a different letter, or sequence of letters, +you can redefine <span +class="cmtt-10">\glspluralsuffix </span>as required. However, this must be done <span +class="cmti-10">before </span>the entries are defined. For +languages that don’t form plurals by simply appending a suffix, all the plural forms must be specified using the +<span +class="cmtt-10">plural</span><a + id="dx1-113004"></a> key (and the <span +class="cmtt-10">firstplural</span><a + id="dx1-113005"></a> key where necessary). +</p><!--l. 5877--><p class="noindent" > +</p> +<!--l. 5877--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.2 </span> <a id="sec:grammar"></a>Other Grammatical Constructs</h3> -<!--l. 5072--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example: - - +<!--l. 5880--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example: + + </p> - <div class="verbatim" id="verbatim-145"> + <div class="verbatim" id="verbatim-141"> \let\glsing\glsuseri  <br />\let\glsd\glsuserii  <br />\newcommand*{\ingkey}{user1} @@ -10641,73 +12997,66 @@ href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span cla  <br />  }%  <br />} </div> -<!--l. 5089--><p class="nopar" > With the above definitions, I can now define terms like this: - - +<!--l. 5897--><p class="nopar" > With the above definitions, I can now define terms like this: + + </p> - <div class="verbatim" id="verbatim-146"> + <div class="verbatim" id="verbatim-142"> \newword{play}{to take part in activities for enjoyment}  <br />\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using  <br />the legs} </div> -<!--l. 5095--><p class="nopar" > and use them in the text: - - +<!--l. 5903--><p class="nopar" > and use them in the text: + + </p> - <div class="verbatim" id="verbatim-147"> + <div class="verbatim" id="verbatim-143"> Peter is \glsing{play} in the park today.  <br />Jane \glsd{play} in the park yesterday.  <br />Peter and Jane \glsd{run} in the park last week. </div> -<!--l. 5103--><p class="nopar" > -</p><!--l. 5105--><p class="indent" > Alternatively, you can define your own keys using <span +<!--l. 5911--><p class="nopar" > +</p><!--l. 5913--><p class="indent" > Alternatively, you can define your own keys using <span class="cmtt-10">\glsaddkey</span><a - id="dx1-36001"></a>, described below in <a -href="#sec:addkey"><span -class="tcrm-1000">§</span>4.3 -</a><a -href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>. -</p><!--l. 5108--><p class="noindent" > + id="dx1-114001"></a>, described below in <a +href="#sec:addkey">§4.3 </a><a +href="#sec:addkey">Additional +Keys<!--tex4ht:ref: sec:addkey --></a>. +</p><!--l. 5916--><p class="noindent" > </p> -<!--l. 5108--><p class="noindent" ><a +<!--l. 5916--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.3 </span> <a id="sec:addkey"></a>Additional Keys</h3> -<!--l. 5111--><p class="noindent" >You can now also define your own custom keys using the commands described in this section. -There are two types of keys: those for use within the document and those to store information -used behind the scenes by other commands. -</p><!--l. 5116--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you -might want to reference this unit in your document. In this case use <span -class="cmtt-10">\glsaddkey </span>described in -<a -href="#sec:glsaddkey"><span -class="tcrm-1000">§</span>4.3.1 </a><a -href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>. If, on the other hand, you want to add a key to indicate to a -glossary style or acronym style that this entry should be formatted differently to -other entries, then you can use <span +<!--l. 5919--><p class="noindent" >You can now also define your own custom keys using the commands described in this section. There are two +types of keys: those for use within the document and those to store information used behind the scenes by other +commands. +</p><!--l. 5924--><p class="indent" > For example, if you want to add a key that indicates the associated unit for a term, you might want to +reference this unit in your document. In this case use <span +class="cmtt-10">\glsaddkey </span>described in <a +href="#sec:glsaddkey">§4.3.1 </a><a +href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>. If, on the +other hand, you want to add a key to indicate to a glossary style or acronym style that this entry should be +formatted differently to other entries, then you can use <span class="cmtt-10">\glsaddstoragekey </span>described in <a -href="#sec:glsaddstoragekey"><span -class="tcrm-1000">§</span>4.3.2 </a><a +href="#sec:glsaddstoragekey">§4.3.2 </a><a href="#sec:glsaddstoragekey">Storage Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>. -</p><!--l. 5124--><p class="indent" > In both cases, a new command ⟨<span -class="cmti-10">no link cs</span>⟩ will be defined that can be used to access the -value of this key (analogous to commands such as <span -class="cmtt-10">\glsentrytext</span>). This can be used in an -expandable context (provided any fragile commands stored in the key have been protected). -The new keys must be added using <span -class="cmtt-10">\glsaddkey </span>or <span -class="cmtt-10">\glsaddstoragekey </span>before glossary -entries are defined. -</p><!--l. 5131--><p class="noindent" > -</p> -<!--l. 5131--><p class="noindent" ><a +</p><!--l. 5932--><p class="indent" > In both cases, a new command ⟨<span +class="cmti-10">no link cs</span>⟩ will be defined that can be used to access the value of this key +(analogous to commands such as <span +class="cmtt-10">\glsentrytext</span>). This can be used in an expandable context (provided any +fragile commands stored in the key have been protected). The new keys must be added using <span +class="cmtt-10">\glsaddkey </span>or +<span +class="cmtt-10">\glsaddstoragekey </span>before glossary entries are defined. +</p><!--l. 5939--><p class="noindent" > +</p> +<!--l. 5939--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.3.1 </span> <a id="sec:glsaddkey"></a>Document Keys</h4> -<!--l. 5134--><p class="noindent" >A custom key that can be used in the document is defined using: -</p><!--l. 5135--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsaddkey</span><span -class="cmtt-9"> </span></span><a - id="dx1-38001"></a> <span +<!--l. 5942--><p class="noindent" >A custom key that can be used in the document is defined using: +</p><!--l. 5943--><p class="indent" > <hr><div title="Definition"><a + id="dx1-116001"></a> <span class="cmtt-10">\glsaddkey{</span>⟨<span class="cmitt-10">key</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -10716,86 +13065,84 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">no link cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">no link ucfirst cs</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">}{</span>⟨<span class="cmitt-10">link cs</span>⟩<span class="cmtt-10">}{</span>⟨<span -class="cmitt-10">link ucfirst cs</span>⟩<span +class="cmitt-10">link ucfirst</span> +<span +class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">link allcaps cs</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 5143--><p class="noindent" > +</p><!--l. 5951--><p class="noindent" > where: </p><dl class="description"><dt class="description"> ⟨<span class="cmbxti-10">key</span>⟩ </dt><dd -class="description">is the new key to use in <span +class="description">is the new key to use in <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-38002"></a> (or similar commands such as + id="dx1-116002"></a> (or similar commands such as <span class="cmtt-10">\longnewglossaryentry</span><a - id="dx1-38003"></a>); - - + id="dx1-116003"></a>); + + </dd><dt class="description"> ⟨<span class="cmbxti-10">default value</span>⟩ </dt><dd -class="description">is the default value to use if this key isn’t used in an entry definition - (this may reference the current entry label via <span -class="cmtt-10">\glslabel</span>, but you will have to - switch on expansion via the starred version of <span -class="cmtt-10">\glsaddkey </span>and protect fragile - commands); +class="description">is the default value to use if this key isn’t used in an entry definition (this may reference + the current entry label via <span +class="cmtt-10">\glslabel</span>, but you will have to switch on expansion via the starred + version of <span +class="cmtt-10">\glsaddkey </span>and protect fragile commands); </dd><dt class="description"> ⟨<span class="cmbxti-10">no link cs</span>⟩ </dt><dd class="description">is the control sequence to use analogous to commands like <span class="cmtt-10">\glsentrytext</span><a - id="dx1-38004"></a>; + id="dx1-116004"></a>; </dd><dt class="description"> ⟨<span class="cmbxti-10">no link ucfirst cs</span>⟩ </dt><dd -class="description">is the control sequence to use analogous to commands like - <span +class="description">is the control sequence to use analogous to commands like <span class="cmtt-10">\Glsentrytext</span><a - id="dx1-38005"></a>; + id="dx1-116005"></a>; </dd><dt class="description"> ⟨<span class="cmbxti-10">link cs</span>⟩ </dt><dd class="description">is the control sequence to use analogous to commands like <span class="cmtt-10">\glstext</span><a - id="dx1-38006"></a>; + id="dx1-116006"></a>; </dd><dt class="description"> ⟨<span class="cmbxti-10">link ucfirst cs</span>⟩ </dt><dd class="description">is the control sequence to use analogous to commands like <span class="cmtt-10">\Glstext</span><a - id="dx1-38007"></a>; + id="dx1-116007"></a>; </dd><dt class="description"> ⟨<span class="cmbxti-10">link allcaps cs</span>⟩ </dt><dd class="description">is the control sequence to use analogous to commands like <span class="cmtt-10">\GLStext</span><a - id="dx1-38008"></a>.</dd></dl> -<!--l. 5164--><p class="noindent" >The starred version of <span -class="cmtt-10">\glsaddkey </span>switches on expansion for this key. The unstarred version -doesn’t override the current expansion setting. + id="dx1-116008"></a>.</dd></dl> +<!--l. 5972--><p class="noindent" >The starred version of <span +class="cmtt-10">\glsaddkey </span>switches on expansion for this key. The unstarred version doesn’t override the +current expansion setting. <a - id="x1-38009r3"></a> -</p><!--l. 5168--><p class="noindent" ><span + id="ex:addkey"></a> +</p><!--l. 5976--><p class="noindent" ><span class="cmbx-12">Example 3</span><span class="cmbx-12"> (Defining Custom Keys)</span><a - id="x1-38010"></a> -</p><!--l. 5169--><p class="indent" > Suppose I want to define two new keys, <span + id="x1-116010"></a> +</p><!--l. 5977--><p class="indent" > Suppose I want to define two new keys, <span class="cmtt-10">ed </span>and <span -class="cmtt-10">ing</span>, that default to the entry text followed -by “ed” and “ing”, respectively. The default value will need expanding in both cases, so I -need to use the starred form: - - +class="cmtt-10">ing</span>, that default to the entry text followed by “ed” and +“ing”, respectively. The default value will need expanding in both cases, so I need to use the starred +form: + + </p> - <div class="verbatim" id="verbatim-148"> + <div class="verbatim" id="verbatim-144">  % Define "ed" key:  <br /> \glsaddkey*  <br />  {ed}% key @@ -10815,11 +13162,11 @@ need to use the starred form:  <br />  {\Glsing}% command analogous to \Glstext  <br />  {\GLSing}% command analogous to \GLStext </div> -<!--l. 5193--><p class="nopar" > Now I can define some entries: - - +<!--l. 6001--><p class="nopar" > Now I can define some entries: + + </p> - <div class="verbatim" id="verbatim-149"> + <div class="verbatim" id="verbatim-145">  % No need to override defaults for this entry:  <br /> \newglossaryentry{jump}{name={jump},description={}}  <br /> % Need to override defaults on these entries: @@ -10832,91 +13179,83 @@ need to use the starred form:  <br />   ing={waddling},%  <br />   description={}} </div> -<!--l. 5211--><p class="nopar" > -</p><!--l. 5213--><p class="indent" > These entries can later be used in the document: - - +<!--l. 6019--><p class="nopar" > +</p><!--l. 6021--><p class="indent" > These entries can later be used in the document: + + </p> - <div class="verbatim" id="verbatim-150"> + <div class="verbatim" id="verbatim-146"> The dog \glsed{jump} over the duck.  <br />The duck was \glsing{waddle} round the dog.  <br />The dog \glsed{run} away from the duck. </div> -<!--l. 5220--><p class="nopar" > For a complete document, see the sample file <a -href="#x1-11103r29"><span +<!--l. 6028--><p class="nopar" > For a complete document, see the sample file <a +href="#ex:sample-newkeys"><span class="cmtt-10">sample-newkeys.tex</span></a>. </p> <div class="center" > -<!--l. 5222--><p class="noindent" > -</p><!--l. 5222--><p class="noindent" >____________________________</p></div> -<!--l. 5224--><p class="noindent" > +<!--l. 6030--><p class="noindent" > +</p><!--l. 6030--><p class="noindent" >____________________________</p></div> +<!--l. 6032--><p class="noindent" > </p> -<!--l. 5224--><p class="noindent" ><a +<!--l. 6032--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.3.2 </span> <a id="sec:glsaddstoragekey"></a>Storage Keys</h4> -<!--l. 5227--><p class="noindent" >A custom key that can be used for simply storing information is defined using: -</p><!--l. 5229--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsaddstoragekey</span><span -class="cmtt-9"> </span></span><a - id="dx1-39001"></a> <span +<!--l. 6035--><p class="noindent" >A custom key that can be used for simply storing information is defined using: +</p><!--l. 6037--><p class="indent" > <hr><div title="Definition"><a + id="dx1-117001"></a> <span class="cmtt-10">\glsaddstoragekey{</span>⟨<span class="cmitt-10">key</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">default value</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">no link cs</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 5231--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 6039--><p class="noindent" > where the arguments are as the first three arguments of <span -class="cmtt-10">\glsaddkey</span>, described above in -<a -href="#sec:glsaddkey"><span -class="tcrm-1000">§</span>4.3.1 </a><a -href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>. -</p><!--l. 5235--><p class="indent" > This is essentially the same as <span -class="cmtt-10">\glsaddkey </span>except that it doesn’t define the additional -commands. You can access or update the value of your new field using the commands -described in <a -href="#sec:fetchset"><span -class="tcrm-1000">§</span>16.3 </a><a -href="#sec:fetchset">Fetching and Updating the Value of a Field<!--tex4ht:ref: sec:fetchset --></a>. +class="cmtt-10">\glsaddkey</span>, described above in <a +href="#sec:glsaddkey">§4.3.1 </a><a +href="#sec:glsaddkey">Document +Keys<!--tex4ht:ref: sec:glsaddkey --></a>. +</p><!--l. 6043--><p class="indent" > This is essentially the same as <span +class="cmtt-10">\glsaddkey </span>except that it doesn’t define the additional commands. You can +access or update the value of your new field using the commands described in <a +href="#sec:fetchset">§16.3 </a><a +href="#sec:fetchset">Fetching and Updating the +Value of a Field<!--tex4ht:ref: sec:fetchset --></a>. <a - id="x1-39002r4"></a> -</p><!--l. 5240--><p class="noindent" ><span + id="ex:addstoragekey"></a> +</p><!--l. 6048--><p class="noindent" ><span class="cmbx-12">Example 4</span><span -class="cmbx-12"> (Defining Custom Storage Key (Acronyms and</span> -<span -class="cmbx-12">Initialisms))</span><a - id="x1-39003"></a> -</p><!--l. 5241--><p class="indent" > Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, -but I want them all in the same glossary and I want the acronyms on first use to be displayed -with the short form followed by the long form in parentheses, but the opposite way round for -other forms of abbreviations. (The <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package provides a simpler way of achieving -this.) -</p><!--l. 5248--><p class="indent" > Here I can define a new key that determines whether the term is actually an acronym -rather than some other form of abbreviation. I’m going to call this key <span +class="cmbx-12"> (Defining Custom Storage Key (Acronyms and Initialisms))</span><a + id="x1-117003"></a> +</p><!--l. 6049--><p class="indent" > Suppose I want to define acronyms and other forms of abbreviations, such as initialisms, but I want them all +in the same glossary and I want the acronyms on first use to be displayed with the short form followed by the +long form in parentheses, but the opposite way round for other forms of abbreviations. (The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +package provides a simpler way of achieving this.) +</p><!--l. 6056--><p class="indent" > Here I can define a new key that determines whether the term is actually an acronym rather +than some other form of abbreviation. I’m going to call this key <span class="cmtt-10">abbrtype </span>(since <span -class="cmtt-10">type</span> -already exists): - - +class="cmtt-10">type </span>already +exists): + + </p> - <div class="verbatim" id="verbatim-151"> + <div class="verbatim" id="verbatim-147"> \glsaddstoragekey  <br /> {abbrtype}% key/field name  <br /> {word}% default value if not explicitly set  <br /> {\abbrtype}% custom command to access the value if required </div> -<!--l. 5257--><p class="nopar" > -</p><!--l. 5259--><p class="indent" > Now I can define a style that looks up the value of this new key to determine how to -display the full form: - - +<!--l. 6065--><p class="nopar" > +</p><!--l. 6067--><p class="indent" > Now I can define a style that looks up the value of this new key to determine how to display the full +form: + + </p> - <div class="verbatim" id="verbatim-152"> + <div class="verbatim" id="verbatim-148"> \newacronymstyle  <br /> {mystyle}% style name  <br /> {% Use the generic display @@ -10963,8 +13302,8 @@ display the full form:  <br />      (\protect\firstacronymfont{\glsentryshortpl{##1}})%  <br />    }%  <br />  }% - - + +  <br />  % plural and first letter upper case  <br />  \renewcommand*{\Genplacrfullformat}[2]{%  <br />    \ifglsfieldeq{##1}{abbrtype}{word} @@ -10990,31 +13329,31 @@ display the full form:  <br />  \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%  <br /> } </div> -<!--l. 5332--><p class="nopar" > Remember that the new style needs to be set before defining any terms: - - +<!--l. 6140--><p class="nopar" > Remember that the new style needs to be set before defining any terms: + + </p> - <div class="verbatim" id="verbatim-153"> + <div class="verbatim" id="verbatim-149"> \setacronymstyle{mystyle} </div> -<!--l. 5337--><p class="nopar" > -</p><!--l. 5339--><p class="indent" > Since it’s a bit confusing to use <span +<!--l. 6145--><p class="nopar" > +</p><!--l. 6147--><p class="indent" > Since it’s a bit confusing to use <span class="cmtt-10">\newacronym</span><a - id="dx1-39004"></a> for something that’s not technically an -acronym, let’s define a new command for initialisms: - - + id="dx1-117004"></a> for something that’s not technically an acronym, let’s define a +new command for initialisms: + + </p> - <div class="verbatim" id="verbatim-154"> + <div class="verbatim" id="verbatim-150"> \newcommand*{\newinitialism}[4][]{%  <br />  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%  <br />} </div> -<!--l. 5346--><p class="nopar" > Now the entries can all be defined: - - +<!--l. 6154--><p class="nopar" > Now the entries can all be defined: + + </p> - <div class="verbatim" id="verbatim-155"> + <div class="verbatim" id="verbatim-151"> \newacronym{radar}{radar}{radio detecting and ranging}  <br />\newacronym{laser}{laser}{light amplification by stimulated  <br />emission of radiation} @@ -11023,152 +13362,151 @@ acronym, let’s define a new command for initialisms:  <br />\newinitialism{dsp}{DSP}{digital signal processing}  <br />\newinitialism{atm}{ATM}{automated teller machine} </div> -<!--l. 5356--><p class="nopar" > On <a +<!--l. 6164--><p class="nopar" > On <a href="#glo:firstuse">first use</a>, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{radar}</span></span></span> will produce “radar (radio detecting and ranging)” but <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{dsp}</span></span></span> -will produce “DSP (digital signal processing)”. -</p><!--l. 5361--><p class="indent" > For a complete document, see the sample file <a -href="#x1-11104r30"><span +class="cmtt-10">\gls{dsp}</span></span></span> will produce +“DSP (digital signal processing)”. +</p><!--l. 6169--><p class="indent" > For a complete document, see the sample file <a +href="#ex:sample-storage-abbr"><span class="cmtt-10">sample-storage-abbr.tex</span></a>. </p> <div class="center" > -<!--l. 5363--><p class="noindent" > -</p><!--l. 5363--><p class="noindent" >____________________________</p></div> -<!--l. 5365--><p class="indent" > In the above example, if <span -class="cmtt-10">\newglossaryentry </span>is explicitly used (instead of through -<span -class="cmtt-10">\newacronym</span>) the <span -class="cmtt-10">abbrtype </span>key will be set to its default value of “word” but the -<span -class="cmtt-10">\ifglshaslong </span>test in the custom acronym style will be false (since the <span -class="cmss-10">long</span><a - id="dx1-39005"></a> key hasn’t been -set) so the display style will switch to that given by <span -class="cmtt-10">\glsgenentryfmt </span>and they’ll be no test -performed on the <span +<!--l. 6171--><p class="noindent" > +</p><!--l. 6171--><p class="noindent" >____________________________</p></div> +<!--l. 6173--><p class="indent" > In the above example, if <span +class="cmtt-10">\newglossaryentry </span>is explicitly used (instead of through <span +class="cmtt-10">\newacronym</span>) the +<span +class="cmtt-10">abbrtype </span>key will be set to its default value of “word” but the <span +class="cmtt-10">\ifglshaslong </span>test in the custom acronym style +will be false (since the <span +class="cmtt-10">long</span><a + id="dx1-117005"></a> key hasn’t been set) so the display style will switch to that given by +<span +class="cmtt-10">\glsgenentryfmt </span>and they’ll be no test performed on the <span class="cmtt-10">abbrtype </span>field. <a - id="x1-39006r5"></a> -</p><!--l. 5374--><p class="noindent" ><span + id="ex:addstoragekey2"></a> +</p><!--l. 6182--><p class="noindent" ><span class="cmbx-12">Example 5</span><span -class="cmbx-12"> (Defining Custom Storage Key (Acronyms and</span> +class="cmbx-12"> (Defining Custom Storage Key (Acronyms and Non-Acronyms with</span> <span -class="cmbx-12">Non-Acronyms with Descriptions))</span><a - id="x1-39007"></a> -</p><!--l. 5375--><p class="indent" > The previous example can be modified if the <span -class="cmss-10">description</span><a - id="dx1-39008"></a> also needs to be provided. Here -I’ve changed “word” to “acronym”: - - +class="cmbx-12">Descriptions))</span><a + id="x1-117007"></a> +</p><!--l. 6183--><p class="indent" > The previous example can be modified if the <span +class="cmtt-10">description</span><a + id="dx1-117008"></a> also needs to be provided. Here I’ve changed +“word” to “acronym”: + + </p> - <div class="verbatim" id="verbatim-156"> + <div class="verbatim" id="verbatim-152"> \glsaddstoragekey  <br /> {abbrtype}% key/field name  <br /> {acronym}% default value if not explicitly set  <br /> {\abbrtype}% custom command to access the value if required </div> -<!--l. 5383--><p class="nopar" > This may seem a little odd for non-abbreviated entries defined using <span -class="cmtt-10">\newglossaryentry</span> -directly, but <span +<!--l. 6191--><p class="nopar" > This may seem a little odd for non-abbreviated entries defined using <span +class="cmtt-10">\newglossaryentry </span>directly, but +<span class="cmtt-10">\ifglshaslong</span><a - id="dx1-39009"></a> can be used to determine whether or not to reference the value -of this new <span -class="cmtt-10">abbrtype </span>field. -</p><!--l. 5389--><p class="indent" > The new acronym style has a minor modification that forces the user to specify a -description. In the previous example, the line: - - + id="dx1-117009"></a> can be used to determine whether or not to reference the value of this new <span +class="cmtt-10">abbrtype</span> +field. +</p><!--l. 6197--><p class="indent" > The new acronym style has a minor modification that forces the user to specify a description. In the +previous example, the line: + + </p> - <div class="verbatim" id="verbatim-157"> + <div class="verbatim" id="verbatim-153">    \renewcommand*{\GenericAcronymFields}{%  <br />     description={\the\glslongtok}}% </div> -<!--l. 5394--><p class="nopar" > needs to be changed to: - - +<!--l. 6202--><p class="nopar" > needs to be changed to: + + </p> - <div class="verbatim" id="verbatim-158"> + <div class="verbatim" id="verbatim-154">    \renewcommand*{\GenericAcronymFields}{}% </div> -<!--l. 5398--><p class="nopar" > Additionally, to accommodate the change in the default value of the <span -class="cmtt-10">abbrtype </span>key, all -instances of - - +<!--l. 6206--><p class="nopar" > Additionally, to accommodate the change in the default value of the <span +class="cmtt-10">abbrtype </span>key, all instances +of + + </p> - <div class="verbatim" id="verbatim-159"> + <div class="verbatim" id="verbatim-155">     \ifglsfieldeq{##1}{abbrtype}{word} </div> -<!--l. 5403--><p class="nopar" > need to be changed to: - - +<!--l. 6211--><p class="nopar" > need to be changed to: + + </p> - <div class="verbatim" id="verbatim-160"> + <div class="verbatim" id="verbatim-156">     \ifglsfieldeq{##1}{abbrtype}{acronym} </div> -<!--l. 5407--><p class="nopar" > -</p><!--l. 5409--><p class="indent" > Once this new style has been set, the new acronyms can be defined using the optional -argument to set the description: - - +<!--l. 6215--><p class="nopar" > +</p><!--l. 6217--><p class="indent" > Once this new style has been set, the new acronyms can be defined using the optional argument to set the +description: + + </p> - <div class="verbatim" id="verbatim-161"> + <div class="verbatim" id="verbatim-157"> \newacronym[description={system for detecting the position and  <br />speed of aircraft, ships, etc}]{radar}{radar}{radio detecting  <br />and ranging} </div> -<!--l. 5415--><p class="nopar" > -</p><!--l. 5417--><p class="indent" > No change is required for the definition of <span -class="cmtt-10">\newinitialism </span>but again the optional -argument is required to set the description: - - +<!--l. 6223--><p class="nopar" > +</p><!--l. 6225--><p class="indent" > No change is required for the definition of <span +class="cmtt-10">\newinitialism </span>but again the optional argument is required to +set the description: + + </p> - <div class="verbatim" id="verbatim-162"> + <div class="verbatim" id="verbatim-158"> \newinitialism[description={mathematical manipulation of an  <br />information signal}]{dsp}{DSP}{digital signal processing} </div> -<!--l. 5422--><p class="nopar" > -</p><!--l. 5424--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms: - - +<!--l. 6230--><p class="nopar" > +</p><!--l. 6232--><p class="indent" > We can also accommodate contractions in a similar manner to the initialisms: + + </p> - <div class="verbatim" id="verbatim-163"> + <div class="verbatim" id="verbatim-159"> \newcommand*{\newcontraction}[4][]{%  <br />  \newacronym[abbrtype=contraction,#1]{#2}{#3}{#4}%  <br />} </div> -<!--l. 5430--><p class="nopar" > The contractions can similarly been defined using this new command: - - +<!--l. 6238--><p class="nopar" > The contractions can similarly been defined using this new command: + + </p> - <div class="verbatim" id="verbatim-164"> + <div class="verbatim" id="verbatim-160"> \newcontraction[description={front part of a ship below the  <br />deck}]{focsle}{fo'c's'le}{forecastle} </div> -<!--l. 5435--><p class="nopar" > -</p><!--l. 5437--><p class="indent" > Since the custom acronym style just checks if <span +<!--l. 6243--><p class="nopar" > +</p><!--l. 6245--><p class="indent" > Since the custom acronym style just checks if <span class="cmtt-10">abbrtype </span>is <span -class="cmtt-10">acronym</span>, the contractions will -be treated the same as the initialisms, but the style could be modified by a further test of the -<span -class="cmtt-10">abbrtype </span>value if required. -</p><!--l. 5442--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word: - - +class="cmtt-10">acronym</span>, the contractions will be treated the +same as the initialisms, but the style could be modified by a further test of the <span +class="cmtt-10">abbrtype </span>value if +required. +</p><!--l. 6250--><p class="indent" > To test regular non-abbreviated entries, I’ve also defined a simple word: + + </p> - <div class="verbatim" id="verbatim-165"> + <div class="verbatim" id="verbatim-161"> \newglossaryentry{apple}{name={apple},description={a fruit}} </div> -<!--l. 5446--><p class="nopar" > -</p><!--l. 5448--><p class="indent" > Now for a new glossary style that provides information about the abbreviation (in -addition to the description): - - +<!--l. 6254--><p class="nopar" > +</p><!--l. 6256--><p class="indent" > Now for a new glossary style that provides information about the abbreviation (in addition to the +description): + + </p> - <div class="verbatim" id="verbatim-166"> + <div class="verbatim" id="verbatim-162"> \newglossarystyle  <br /> {mystyle}% style name  <br /> {% base it on the "list" style @@ -11181,101 +13519,96 @@ addition to the description):  <br />       \glossentrydesc{##1}\glspostdescription\space ##2}%  <br /> } </div> -<!--l. 5462--><p class="nopar" > This uses <span +<!--l. 6270--><p class="nopar" > This uses <span class="cmtt-10">\ifglshaslong</span><a - id="dx1-39010"></a> to determine whether or not the term is an abbreviation. If it has -an abbreviation, the full form is supplied in parentheses and <span -class="cmtt-10">\abbrtype </span>(defined by -<span -class="cmtt-10">\glsaddstoragekey </span>earlier) is used to indicate the type of abbreviation. -</p><!--l. 5469--><p class="indent" > With this style set, the <span + id="dx1-117010"></a> to determine whether or not the term is an abbreviation. If it has an abbreviation, +the full form is supplied in parentheses and <span +class="cmtt-10">\abbrtype </span>(defined by <span +class="cmtt-10">\glsaddstoragekey </span>earlier) is used to +indicate the type of abbreviation. +</p><!--l. 6277--><p class="indent" > With this style set, the <span class="cmtt-10">apple </span>entry is simply displayed in the glossary as </p><dl class="description"><dt class="description"> <span class="cmbx-10">apple</span> </dt><dd class="description">a fruit.</dd></dl> -<!--l. 5474--><p class="noindent" >but the abbreviations are displayed in the form +<!--l. 6282--><p class="noindent" >but the abbreviations are displayed in the form </p><dl class="description"><dt class="description"> <span class="cmbx-10">laser</span> </dt><dd -class="description">(acronym: light amplification by stimulated emission of radiation) device that - creates a narrow beam of intense light.</dd></dl> -<!--l. 5480--><p class="noindent" >(for acronyms) or +class="description">(acronym: light amplification by stimulated emission of radiation) device that creates a narrow + beam of intense light.</dd></dl> +<!--l. 6288--><p class="noindent" >(for acronyms) or </p><dl class="description"><dt class="description"> <span class="cmbx-10">DSP</span> </dt><dd -class="description">(initialism: digital signal processing) mathematical manipulation of an - information signal.</dd></dl> -<!--l. 5485--><p class="noindent" >(for initalisms) or +class="description">(initialism: digital signal processing) mathematical manipulation of an information signal.</dd></dl> +<!--l. 6293--><p class="noindent" >(for initalisms) or </p><dl class="description"><dt class="description"> <span class="cmbx-10">fo’c’s’le</span> </dt><dd class="description">(contraction: forecastle) front part of a ship below the deck.</dd></dl> -<!--l. 5490--><p class="noindent" >(for contractions). -</p><!--l. 5492--><p class="indent" > For a complete document, see <a -href="#x1-11105r31"><span +<!--l. 6298--><p class="noindent" >(for contractions). +</p><!--l. 6300--><p class="indent" > For a complete document, see <a +href="#ex:sample-storage-abbr-desc"><span class="cmtt-10">sample-storage-abbr-desc.tex</span></a>. </p> <div class="center" > -<!--l. 5493--><p class="noindent" > -</p><!--l. 5493--><p class="noindent" >____________________________</p></div> - - -<!--l. 5495--><p class="noindent" > +<!--l. 6301--><p class="noindent" > +</p><!--l. 6301--><p class="noindent" >____________________________</p></div> + + +<!--l. 6303--><p class="noindent" > </p> -<!--l. 5495--><p class="noindent" ><a +<!--l. 6303--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.4 </span> <a id="sec:expansion"></a>Expansion</h3> -<!--l. 5498--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span -class="cmss-10">name</span><a - id="dx1-40001"></a>, +<!--l. 6306--><p class="noindent" >When you define new glossary entries expansion is performed by default, except for the <span +class="cmtt-10">name</span><a + id="dx1-118001"></a>, <span +class="cmtt-10">description</span><a + id="dx1-118002"></a>, +<span +class="cmtt-10">descriptionplural</span><a + id="dx1-118003"></a>, <span +class="cmtt-10">symbol</span><a + id="dx1-118004"></a>, <span +class="cmtt-10">symbolplural</span><a + id="dx1-118005"></a> and <span +class="cmtt-10">sort</span><a + id="dx1-118006"></a> keys (these keys all have expansion suppressed via <span -class="cmss-10">description</span><a - id="dx1-40002"></a>, <span -class="cmss-10">descriptionplural</span><a - id="dx1-40003"></a>, <span -class="cmss-10">symbol</span><a - id="dx1-40004"></a>, <span -class="cmss-10">symbolplural</span><a - id="dx1-40005"></a> and <span -class="cmss-10">sort</span><a - id="dx1-40006"></a> keys (these keys all have expansion -suppressed via <span class="cmtt-10">\glssetnoexpandfield</span>). -</p><!--l. 5504--><p class="indent" > You can switch expansion on or off for individual keys using -</p><!--l. 5505--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssetexpandfield</span><span -class="cmtt-9"> </span></span><a - id="dx1-40007"></a> <span +</p><!--l. 6312--><p class="indent" > You can switch expansion on or off for individual keys using +</p><!--l. 6313--><p class="indent" > <hr><div title="Definition"><a + id="dx1-118007"></a> <span class="cmtt-10">\glssetexpandfield{</span>⟨<span class="cmitt-10">field</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 5507--><p class="noindent" > +</p><!--l. 6315--><p class="noindent" > or -</p><!--l. 5509--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssetnoexpandfield</span><span -class="cmtt-9"> </span></span><a - id="dx1-40008"></a> <span +</p><!--l. 6317--><p class="indent" > <hr><div title="Definition"><a + id="dx1-118008"></a> <span class="cmtt-10">\glssetnoexpandfield{</span>⟨<span class="cmitt-10">field</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 5511--><p class="noindent" > +</p><!--l. 6319--><p class="noindent" > respectively, where ⟨<span -class="cmti-10">field</span>⟩ is the field tag corresponding to the key. In most cases, this is the -same as the name of the key except for those listed in <a +class="cmti-10">field</span>⟩ is the field tag corresponding to the key. In most cases, this is the same as the name of +the key except for those listed in <a href="#tab:fieldmap">table 4.1</a>. </p> <div class="table"> - - -<!--l. 5516--><p class="indent" > <a + + +<!--l. 6324--><p class="indent" > <a id="tab:fieldmap"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 4.1: </span><span -class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-400091 --> +class="content">Key to Field Mappings</span></div><!--tex4ht:label?: x1-1180091 --> <div class="tabular"> <table id="TBL-5" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-5-1g"><col @@ -11283,191 +13616,178 @@ id="TBL-5-1" /><col id="TBL-5-2" /></colgroup><tr style="vertical-align:baseline;" id="TBL-5-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-1" class="td11"> <span -class="cmbx-10">Key </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-2" +class="cmbx-10">Key </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-5-1-2" class="td11"> <span class="cmbx-10">Field </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-1" class="td11"> <span -class="cmss-10">sort</span><a - id="dx1-40010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2" +class="cmtt-10">sort</span><a + id="dx1-118010"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-2-2" class="td11"> <span class="cmtt-10">sortvalue </span></td></tr><tr style="vertical-align:baseline;" id="TBL-5-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-1" class="td11"> <span -class="cmss-10">firstplural</span><a - id="dx1-40011"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2" +class="cmtt-10">firstplural</span><a + id="dx1-118011"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-3-2" class="td11"> <span class="cmtt-10">firstpl</span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-1" class="td11"> <span -class="cmss-10">description</span><a - id="dx1-40012"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2" +class="cmtt-10">description</span><a + id="dx1-118012"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-4-2" class="td11"> <span class="cmtt-10">desc </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-1" class="td11"> <span -class="cmss-10">descriptionplural</span><a - id="dx1-40013"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2" +class="cmtt-10">descriptionplural</span><a + id="dx1-118013"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-5-2" class="td11"> <span class="cmtt-10">descplural </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-1" class="td11"> <span -class="cmss-10">user1</span><a - id="dx1-40014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2" +class="cmtt-10">user1</span><a + id="dx1-118014"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-6-2" class="td11"> <span class="cmtt-10">useri </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-1" class="td11"> <span -class="cmss-10">user2</span><a - id="dx1-40015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2" +class="cmtt-10">user2</span><a + id="dx1-118015"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-7-2" class="td11"> <span class="cmtt-10">userii </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-1" class="td11"> <span -class="cmss-10">user3</span><a - id="dx1-40016"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2" +class="cmtt-10">user3</span><a + id="dx1-118016"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-8-2" class="td11"> <span class="cmtt-10">useriii </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-1" class="td11"> <span -class="cmss-10">user4</span><a - id="dx1-40017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2" +class="cmtt-10">user4</span><a + id="dx1-118017"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-9-2" class="td11"> <span class="cmtt-10">useriv </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-1" class="td11"> <span -class="cmss-10">user5</span><a - id="dx1-40018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2" +class="cmtt-10">user5</span><a + id="dx1-118018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-10-2" class="td11"> <span class="cmtt-10">userv </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-1" class="td11"> <span -class="cmss-10">user6</span><a - id="dx1-40019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-2" +class="cmtt-10">user6</span><a + id="dx1-118019"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-11-2" class="td11"> <span class="cmtt-10">uservi </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-1" class="td11"> <span -class="cmss-10">longplural</span><a - id="dx1-40020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-2" +class="cmtt-10">longplural</span><a + id="dx1-118020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-12-2" class="td11"> <span class="cmtt-10">longpl </span></td> </tr><tr style="vertical-align:baseline;" id="TBL-5-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-1" class="td11"> <span -class="cmss-10">shortplural</span><a - id="dx1-40021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-2" +class="cmtt-10">shortplural</span><a + id="dx1-118021"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-5-13-2" class="td11"> <span class="cmtt-10">shortpl </span></td></tr></table> </div> - - + + </div><hr class="endfloat" /> </div> -<!--l. 5537--><p class="indent" > Any keys that haven’t had the expansion explicitly set using <span -class="cmtt-10">\glssetexpandfield </span>or -<span -class="cmtt-10">\glssetnoexpandfield </span>are governed by -</p><!--l. 5539--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsexpandfields</span><span -class="cmtt-9"> </span></span><a - id="dx1-40022"></a> <span +<!--l. 6345--><p class="indent" > Any keys that haven’t had the expansion explicitly set using <span +class="cmtt-10">\glssetexpandfield </span>or <span +class="cmtt-10">\glssetnoexpandfield</span> +are governed by +</p><!--l. 6347--><p class="indent" > <hr><div title="Definition"><a + id="dx1-118022"></a> <span class="cmtt-10">\glsexpandfields </span></div><hr> -</p><!--l. 5541--><p class="noindent" > +</p><!--l. 6349--><p class="noindent" > and -</p><!--l. 5543--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnoexpandfields</span><span -class="cmtt-9"> </span></span><a - id="dx1-40023"></a> <span +</p><!--l. 6351--><p class="indent" > <hr><div title="Definition"><a + id="dx1-118023"></a> <span class="cmtt-10">\glsnoexpandfields </span></div><hr> -</p><!--l. 5545--><p class="noindent" > -</p><!--l. 5547--><p class="indent" > If your entries contain any fragile commands, I recommend you switch off expansion via -<span -class="cmtt-10">\glsnoexpandfields</span>. (This should be used before you define the entries.) +</p><!--l. 6353--><p class="noindent" > +</p><!--l. 6355--><p class="indent" > If your entries contain any fragile commands, I recommend you switch off expansion via <span +class="cmtt-10">\glsnoexpandfields</span>. +(This should be used before you define the entries.) </p> -<!--l. 5551--><p class="noindent" ><a +<!--l. 6359--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.5 </span> <a id="sec:subentries"></a>Sub-Entries</h3> -<!--l. 5554--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the -glossary into categories, in which case the sub-entry will have a different name to its parent -entry, or it may be used to distinguish different definitions for the same word, in which -case the sub-entries will have the same name as the parent entry. Note that not all -glossary styles support hierarchical entries and may display all the entries in a -flat format. Of the styles that support sub-entries, some display the sub-entry’s -name whilst others don’t. Therefore you need to ensure that you use a suitable -style. (See <a -href="#sec:styles"><span -class="tcrm-1000">§</span>15 </a><a -href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined styles.) As from version 3.0, -level 1 sub-entries are automatically numbered in the predefined styles if you use the -<span +<!--l. 6362--><p class="noindent" >As from version 1.17, it is possible to specify sub-entries. These may be used to order the glossary into +categories, in which case the sub-entry will have a different name to its parent entry, or it may be used to +distinguish different definitions for the same word, in which case the sub-entries will have the same name as the +parent entry. Note that not all glossary styles support hierarchical entries and may display all the entries in a +flat format. Of the styles that support sub-entries, some display the sub-entry’s name whilst others don’t. +Therefore you need to ensure that you use a suitable style. (See <a +href="#sec:styles">§15 </a><a +href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for a list of predefined +styles.) As from version 3.0, level 1 sub-entries are automatically numbered in the predefined styles +if you use the <span class="cmss-10">subentrycounter</span><a - id="dx1-41001"></a> package option (see <a -href="#sec:pkgopts-printglos"><span -class="tcrm-1000">§</span>2.3 </a><a + id="dx1-119001"></a> package option (see <a +href="#sec:pkgopts-printglos">§2.3 </a><a href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further details). -</p><!--l. 5569--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child -entries are used in the document. If the parent entry is not referenced in the document, it will -not have a <a +</p><!--l. 6377--><p class="indent" > Note that the parent entry will automatically be added to the glossary if any of its child entries are used in +the document. If the parent entry is not referenced in the document, it will not have a <a href="#glo:numberlist">number list<a - id="dx1-41002"></a></a>. Note also that <a + id="dx1-119002"></a></a>. Note also +that <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-41003"></a></a> has a restriction on the maximum -sub-entry depth. -</p><!--l. 5575--><p class="noindent" > + id="dx1-119003"></a></a> has a restriction on the maximum sub-entry depth. +</p><!--l. 6383--><p class="noindent" > </p> -<!--l. 5575--><p class="noindent" ><a +<!--l. 6383--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.5.1 </span> <a id="sec:hierarchical"></a>Hierarchical Categories</h4> -<!--l. 5578--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and -then define the sub-entries using the relevant category entry as the value of the <span -class="cmss-10">parent</span><a - id="dx1-42001"></a> -key. +<!--l. 6386--><p class="noindent" >To arrange a glossary with hierarchical categories, you need to first define the category and then define the +sub-entries using the relevant category entry as the value of the <span +class="cmtt-10">parent</span><a + id="dx1-120001"></a> key. <a - id="x1-42002r6"></a> -</p><!--l. 5583--><p class="noindent" ><span + id="ex:hierarchical"></a> +</p><!--l. 6391--><p class="noindent" ><span class="cmbx-12">Example 6</span><span class="cmbx-12"> (Hierarchical Categories—Greek and Roman Mathematical</span> <span class="cmbx-12">Symbols)</span><a - id="x1-42003"></a> -</p><!--l. 5585--><p class="indent" > Suppose I want a glossary of mathematical symbols that are divided into Greek letters - - -and Roman letters. Then I can define the categories as follows: - - + id="x1-120003"></a> +</p><!--l. 6393--><p class="indent" > Suppose I want a glossary of mathematical symbols that are divided into Greek letters and Roman letters. +Then I can define the categories as follows: + + </p> - <div class="verbatim" id="verbatim-167"> + <div class="verbatim" id="verbatim-163"> \newglossaryentry{greekletter}{name={Greek letters},  <br />description={\nopostdesc}}  <br />\newglossaryentry{romanletter}{name={Roman letters},  <br />description={\nopostdesc}} </div> -<!--l. 5594--><p class="nopar" > -</p><!--l. 5596--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the -descriptions to <span +<!--l. 6402--><p class="nopar" > +</p><!--l. 6404--><p class="indent" > Note that in this example, the category entries don’t need a description so I have set the descriptions to +<span class="cmtt-10">\nopostdesc</span><a - id="dx1-42004"></a>. This gives a blank description and suppresses the description -terminator. -</p><!--l. 5601--><p class="indent" > I can now define my sub-entries as follows: - - + id="dx1-120004"></a>. This gives a blank description and suppresses the description terminator. +</p><!--l. 6409--><p class="indent" > I can now define my sub-entries as follows: + + </p> - <div class="verbatim" id="verbatim-168"> + <div class="verbatim" id="verbatim-164"> \newglossaryentry{pi}{name={\ensuremath{\pi}},sort={pi},  <br />description={ratio of the circumference of a circle to  <br />the diameter}, @@ -11476,41 +13796,40 @@ terminator.  <br />description={Euler's constant},  <br />parent=romanletter} </div> -<!--l. 5611--><p class="nopar" > For a complete document, see the sample file <a -href="#x1-11068r21"><span +<!--l. 6419--><p class="nopar" > For a complete document, see the sample file <a +href="#ex:sampletree"><span class="cmtt-10">sampletree.tex</span></a>. </p> <div class="center" > -<!--l. 5613--><p class="noindent" > -</p><!--l. 5613--><p class="noindent" >____________________________</p></div> -<!--l. 5615--><p class="noindent" > +<!--l. 6421--><p class="noindent" > +</p><!--l. 6421--><p class="noindent" >____________________________</p></div> +<!--l. 6423--><p class="noindent" > </p> -<!--l. 5615--><p class="noindent" ><a +<!--l. 6423--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.5.2 </span> <a id="sec:homographs"></a>Homographs</h4> -<!--l. 5618--><p class="noindent" >Sub-entries that have the same name as the parent entry, don’t need to have the -<span -class="cmss-10">name</span><a - id="dx1-43001"></a> key. For example, the word “glossary” can mean a list of technical words or a -collection of glosses. In both cases the plural is “glossaries”. So first define the parent -entry: - - +<!--l. 6426--><p class="noindent" >Sub-entries that have the same name as the parent entry, don’t need to have the <span +class="cmtt-10">name</span><a + id="dx1-121001"></a> key. For example, the +word “glossary” can mean a list of technical words or a collection of glosses. In both cases the plural is +“glossaries”. So first define the parent entry: + + </p> - <div class="verbatim" id="verbatim-169"> + <div class="verbatim" id="verbatim-165"> \newglossaryentry{glossary}{name=glossary,  <br />description={\nopostdesc},  <br />plural={glossaries}} </div> -<!--l. 5627--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be -suppressed using <span +<!--l. 6435--><p class="nopar" > Again, the parent entry has no description, so the description terminator needs to be suppressed using +<span class="cmtt-10">\nopostdesc</span><a - id="dx1-43002"></a>. -</p><!--l. 5631--><p class="indent" > Now define the two different meanings of the word: - - + id="dx1-121002"></a>. +</p><!--l. 6439--><p class="indent" > Now define the two different meanings of the word: + + </p> - <div class="verbatim" id="verbatim-170"> + <div class="verbatim" id="verbatim-166"> \newglossaryentry{glossarylist}{  <br />description={list of technical words},  <br />sort={1}, @@ -11520,38 +13839,39 @@ class="cmtt-10">\nopostdesc</span><a  <br />sort={2},  <br />parent={glossary}} </div> -<!--l. 5642--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s <a -href="#glo:numberlist">number -list<a - id="dx1-43003"></a></a>, whereas if I reference any of the child entries, the location will be added to the child -entry’s number list. Note also that since the sub-entries have the same name, the <span -class="cmss-10">sort</span><a - id="dx1-43004"></a> key is -required unless you are using the <span -class="cmss-10">sort=use</span><a - id="dx1-43005"></a> or <span -class="cmss-10">sort=def</span><a - id="dx1-43006"></a> package options (see <a -href="#sec:pkgopts-sort"><span -class="tcrm-1000">§</span>2.4 -</a><a +<!--l. 6450--><p class="nopar" > Note that if I reference the parent entry, the location will be added to the parent’s <a +href="#glo:numberlist">number list<a + id="dx1-121003"></a></a>, whereas if I +reference any of the child entries, the location will be added to the child entry’s number list. Note also that since +the sub-entries have the same name, the <span +class="cmtt-10">sort</span><a + id="dx1-121004"></a> key is required unless you are using the <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-121005"></a> or +<span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-121006"></a> package options (see <a +href="#sec:pkgopts-sort">§2.5 </a><a href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>). You can use the <span class="cmss-10">subentrycounter</span><a - id="dx1-43007"></a> package option to automatically -number the first-level child entries. See <a -href="#sec:pkgopts-printglos"><span -class="tcrm-1000">§</span>2.3 </a><a + id="dx1-121007"></a> package option to +automatically number the first-level child entries. See <a +href="#sec:pkgopts-printglos">§2.3 </a><a href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a> for further details. -</p><!--l. 5654--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the -parent entry, so the <span -class="cmss-10">plural</span><a - id="dx1-43008"></a> key was not required for the child entries. However, if the -sub-entries have different plurals, they will need to be specified. For example: - - +</p><!--l. 6462--><p class="indent" > In the above example, the plural form for both of the child entries is the same as the parent entry, so the +<span +class="cmtt-10">plural</span><a + id="dx1-121008"></a> key was not required for the child entries. However, if the sub-entries have different plurals, they will +need to be specified. For example: + + </p> - <div class="verbatim" id="verbatim-171"> + <div class="verbatim" id="verbatim-167"> \newglossaryentry{bravo}{name={bravo},  <br />description={\nopostdesc}}  <br />\newglossaryentry{bravocry}{description={cry of approval @@ -11565,89 +13885,84 @@ sub-entries have different plurals, they will need to be specified. For example:  <br />plural={bravoes},  <br />parent=bravo} </div> -<!--l. 5673--><p class="nopar" > -</p><!--l. 5676--><p class="noindent" > +<!--l. 6481--><p class="nopar" > +</p><!--l. 6484--><p class="noindent" > </p> -<!--l. 5676--><p class="noindent" ><a +<!--l. 6484--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.6 </span> <a id="sec:loadglsentries"></a>Loading Entries From a File</h3> -<!--l. 5679--><p class="noindent" >You can store all your glossary entry definitions in another file and use: -</p><!--l. 5681--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\loadglsentries</span><span -class="cmtt-9"> </span></span><a - id="dx1-44001"></a> <span +<!--l. 6487--><p class="noindent" >You can store all your glossary entry definitions in another file and use: +</p><!--l. 6489--><p class="indent" > <hr><div title="Definition"><a + id="dx1-122001"></a> <span class="cmtt-10">\loadglsentries[</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">filename</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 5683--><p class="noindent" > +</p><!--l. 6491--><p class="noindent" > where ⟨<span class="cmti-10">filename</span>⟩ is the name of the file containing all the <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-44002"></a> or -<span + id="dx1-122002"></a> or <span class="cmtt-10">\longnewglossaryentry</span><a - id="dx1-44003"></a> commands. The optional argument ⟨<span -class="cmti-10">type</span>⟩ is the name of the glossary -to which those entries should belong, for those entries where the <span -class="cmss-10">type</span><a - id="dx1-44004"></a> key has been omitted -(or, more specifically, for those entries whose type has been specified by <span + id="dx1-122003"></a> +commands. The optional argument ⟨<span +class="cmti-10">type</span>⟩ is the name of the glossary to which those entries should +belong, for those entries where the <span +class="cmtt-10">type</span><a + id="dx1-122004"></a> key has been omitted (or, more specifically, for those entries +whose type has been specified by <span class="cmtt-10">\glsdefaulttype</span><a - id="dx1-44005"></a>, -which is what <span + id="dx1-122005"></a>, which is what <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-44006"></a> uses by default). -</p><!--l. 5693--><p class="indent" > This is a preamble-only command. You may also use <span + id="dx1-122006"></a> uses by +default). +</p><!--l. 6501--><p class="indent" > This is a preamble-only command. You may also use <span class="cmtt-10">\input</span><a - id="dx1-44007"></a> to load the file but don’t use -<span + id="dx1-122007"></a> to load the file but don’t use <span class="cmtt-10">\include</span><a - id="dx1-44008"></a>. If you find that your file is becoming unmanageably large, you may want to -consider switching to <a + id="dx1-122008"></a>. If you +find that your file is becoming unmanageably large, you may want to consider switching to <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-44009"></a></a> and use an application such as JabRef to manage the entry -definitions. -</p><!--l. 5699--><p class="indent" > <div class="important" title="Important Note"> If you want to use <span + id="dx1-122009"></a></a> and use an +application such as JabRef to manage the entry definitions. +</p><!--l. 6507--><p class="indent" > <div class="important" title="Important Note"> If you want to use <span class="cmtt-10">\AtBeginDocument</span><a - id="dx1-44010"></a> to <span -class="cmtt-10">\input </span>all your entries automatically at the -start of the document, add the <span + id="dx1-122010"></a> to <span +class="cmtt-10">\input </span>all your entries automatically at the start of the document, +add the <span class="cmtt-10">\AtBeginDocument </span>command <span class="cmti-10">before </span>you load the <span class="cmss-10">glossaries</span><a - id="dx1-44011"></a> -package (and <span + id="dx1-122011"></a> package (and <span class="cmss-10">babel</span><a - id="dx1-44012"></a>, if you are also loading that) to avoid the creation of the <span -class="cmtt-10">.glsdefs</span><a - id="dx1-44013"></a> file and -any associated problems that are caused by defining commands in the <span + id="dx1-122012"></a>, if you are also loading +that) to avoid the creation of the <span +class="cmtt-10">glsdefs</span><a + id="dx1-122013"></a> file and any associated problems that are caused by defining +commands in the <span class="cmss-10">document</span><a - id="dx1-44014"></a><a - id="dx1-44015"></a> -environment. (See <a -href="#sec:docdefs"><span -class="tcrm-1000">§</span>4.8 </a><a -href="#sec:docdefs">Drawbacks With Defining Entries in the Document Environment<!--tex4ht:ref: sec:docdefs --></a>.) -</div> -</p><!--l. 5708--><p class="noindent" > - - + id="dx1-122014"></a><a + id="dx1-122015"></a> environment. (See <a +href="#sec:docdefs">§4.8 </a><a +href="#sec:docdefs">Drawbacks With Defining Entries in the Document +Environment<!--tex4ht:ref: sec:docdefs --></a>.) </div> +</p><!--l. 6516--><p class="noindent" > + + <a - id="x1-44016r7"></a> -</p><!--l. 5710--><p class="noindent" ><span + id="ex:loadgls"></a> +</p><!--l. 6518--><p class="noindent" ><span class="cmbx-12">Example 7</span><span class="cmbx-12"> (Loading Entries from Another File)</span><a - id="x1-44017"></a> -</p><!--l. 5711--><p class="indent" > Suppose I have a file called <span + id="x1-122017"></a> +</p><!--l. 6519--><p class="indent" > Suppose I have a file called <span class="cmtt-10">myentries.tex </span>which contains: - - + + </p> - <div class="verbatim" id="verbatim-172"> + <div class="verbatim" id="verbatim-168"> \newglossaryentry{perl}{type=main,  <br />name={Perl},  <br />description={A scripting language}} @@ -11657,1061 +13972,1008 @@ class="cmtt-10">myentries.tex </span>which contains:  <br />name={html},  <br />description={A mark up language}} </div> -<!--l. 5723--><p class="nopar" > and suppose in my document preamble I use the command: - - +<!--l. 6531--><p class="nopar" > and suppose in my document preamble I use the command: + + </p> - <div class="verbatim" id="verbatim-173"> + <div class="verbatim" id="verbatim-169"> \loadglsentries[languages]{myentries} </div> -<!--l. 5727--><p class="nopar" > then this will add the entries <span +<!--l. 6535--><p class="nopar" > then this will add the entries <span class="cmtt-10">tex </span>and <span -class="cmtt-10">html </span>to the glossary whose type is given by -<span -class="cmtt-10">languages</span>, but the entry <span -class="cmtt-10">perl </span>will be added to the main glossary, since it explicitly sets the -type to <span -class="cmtt-10">main</span>. </p> +class="cmtt-10">html </span>to the glossary whose type is given by <span +class="cmtt-10">languages</span>, +but the entry <span +class="cmtt-10">perl </span>will be added to the main glossary, since it explicitly sets the type to <span +class="cmtt-10">main</span>. +</p> <div class="center" > -<!--l. 5732--><p class="noindent" > -</p><!--l. 5732--><p class="noindent" >____________________________</p></div> -<!--l. 5734--><p class="indent" > <span -class="cmbx-10">Note: </span>if you use <span +<!--l. 6540--><p class="noindent" > +</p><!--l. 6540--><p class="noindent" >____________________________</p></div> +<!--l. 6543--><p class="indent" > <span class="warningsymbol">⚠</span> Note: if you use <span class="cmtt-10">\newacronym</span><a - id="dx1-44018"></a> (see <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>) the type is -set as <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">type=\acronymtype</span></span></span> unless you explicitly override it. For example, if my file -<span -class="cmtt-10">myacronyms.tex </span>contains: - - -</p> - <div class="verbatim" id="verbatim-174"> + id="dx1-122018"></a> (see <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>) the type is set +as <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">type=\acronymtype</span></span></span> unless you explicitly override it. For example, if my file <span +class="cmtt-10">myacronyms.tex</span> +contains: + + +</p> + <div class="verbatim" id="verbatim-170"> \newacronym{aca}{aca}{a contrived acronym} </div> -<!--l. 5740--><p class="nopar" > then (supposing I have defined a new glossary type called <span +<!--l. 6548--><p class="nopar" > then (supposing I have defined a new glossary type called <span class="cmtt-10">altacronym</span>) - - + + </p> - <div class="verbatim" id="verbatim-175"> + <div class="verbatim" id="verbatim-171"> \loadglsentries[altacronym]{myacronyms} </div> -<!--l. 5745--><p class="nopar" > will add <span +<!--l. 6553--><p class="nopar" > will add <span class="cmtt-10">aca </span>to the glossary type <span class="cmtt-10">acronym</span>, if the package option <span class="cmss-10">acronym</span><a - id="dx1-44019"></a> has been specified, + id="dx1-122019"></a> has been specified, or will add <span class="cmtt-10">aca </span>to the glossary type <span class="cmtt-10">altacronym</span>, if the package option <span class="cmss-10">acronym</span><a - id="dx1-44020"></a> is not + id="dx1-122020"></a> is not specified.<span class="footnote-mark"><a href="#fn1x4" id="fn1x4-bk"><sup class="textsuperscript">4.1</sup></a></span><a - id="x1-44021f1"></a> -</p><!--l. 5753--><p class="indent" > If you have used the <span + id="x1-122021f1"></a> +</p><!--l. 6561--><p class="indent" > If you have used the <span class="cmss-10">acronym</span><a - id="dx1-44025"></a> package option, there are two possible solutions to this -problem: + id="dx1-122025"></a> package option, there are two possible solutions to this problem: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-44027x1">Change <span + class="enumerate" id="x1-122027x1">Change <span class="cmtt-10">myacronyms.tex </span>so that entries are defined in the form: - - - <div class="verbatim" id="verbatim-176"> + + + <div class="verbatim" id="verbatim-172"> \newacronym[type=\glsdefaulttype]{aca}{aca}{a  <br />contrived acronym} </div> - <!--l. 5761--><p class="nopar" > and do: - - + <!--l. 6569--><p class="nopar" > and do: + + </p> - <div class="verbatim" id="verbatim-177"> + <div class="verbatim" id="verbatim-173"> \loadglsentries[altacronym]{myacronyms} </div> - <!--l. 5765--><p class="nopar" > + <!--l. 6573--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-44029x2">Temporarily change <span + class="enumerate" id="x1-122029x2">Temporarily change <span class="cmtt-10">\acronymtype </span>to the target glossary: - - - <div class="verbatim" id="verbatim-178"> + + + <div class="verbatim" id="verbatim-174"> \let\orgacronymtype\acronymtype  <br />\renewcommand{\acronymtype}{altacronym}  <br />\loadglsentries{myacronyms}  <br />\let\acronymtype\orgacronymtype </div> - <!--l. 5773--><p class="nopar" ></p></li></ol> -<!--l. 5776--><p class="indent" > Note that only those entries that have been used in the text will appear in the relevant -glossaries. Note also that <span + <!--l. 6581--><p class="nopar" ></p></li></ol> +<!--l. 6584--><p class="indent" > Note that only those entries that have been used in the text will appear in the relevant glossaries. Note also +that <span class="cmtt-10">\loadglsentries </span>may only be used in the preamble. -</p><!--l. 5781--><p class="indent" > Remember that you can use <span +</p><!--l. 6589--><p class="indent" > Remember that you can use <span class="cmtt-10">\provideglossaryentry</span><a - id="dx1-44030"></a> rather than <span + id="dx1-122030"></a> rather than <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-44031"></a>. -Suppose you want to maintain a large database of acronyms or terms that you’re likely to use -in your documents, but you may want to use a modified version of some of those entries. -(Suppose, for example, one document may require a more detailed description.) Then if you -define the entries using <span -class="cmtt-10">\provideglossaryentry </span>in your database file, you can override the -definition by simply using <span -class="cmtt-10">\newglossaryentry </span>before loading the file. For example, suppose -your file (called, say, <span + id="dx1-122031"></a>. Suppose you want +to maintain a large database of acronyms or terms that you’re likely to use in your documents, but you may +want to use a modified version of some of those entries. (Suppose, for example, one document may require a +more detailed description.) Then if you define the entries using <span +class="cmtt-10">\provideglossaryentry </span>in your database file, +you can override the definition by simply using <span +class="cmtt-10">\newglossaryentry </span>before loading the file. For example, +suppose your file (called, say, <span class="cmtt-10">terms.tex</span>) contains: - - + + </p> - <div class="verbatim" id="verbatim-179"> + <div class="verbatim" id="verbatim-175"> \provideglossaryentry{mallard}{name=mallard,  <br /> description={a type of duck}} </div> -<!--l. 5794--><p class="nopar" > but suppose your document requires a more detailed description, you can do: - - +<!--l. 6602--><p class="nopar" > but suppose your document requires a more detailed description, you can do: + + </p> - <div class="verbatim" id="verbatim-180"> + <div class="verbatim" id="verbatim-176"> \usepackage{glossaries}  <br />\makeglossaries  <br />\newglossaryentry{mallard}{name=mallard,  <br /> description={a dabbling duck where the male has a green head}}  <br />\loadglsentries{terms} </div> -<!--l. 5805--><p class="nopar" > Now the <span +<!--l. 6613--><p class="nopar" > Now the <span class="cmtt-10">mallard </span>definition in the <span class="cmtt-10">terms.tex </span>file will be ignored. -</p><!--l. 5809--><p class="noindent" > +</p><!--l. 6617--><p class="noindent" > </p> -<!--l. 5809--><p class="noindent" ><a +<!--l. 6617--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.7 </span> <a id="sec:moveentry"></a>Moving Entries to Another Glossary</h3> -<!--l. 5812--><p class="noindent" >As from version 3.02, you can move an entry from one glossary to another using: -</p><!--l. 5814--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsmoveentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-45001"></a> <span +<!--l. 6620--><p class="noindent" >As from version 3.02, you can move an entry from one glossary to another using: +</p><!--l. 6622--><p class="indent" > <hr><div title="Definition"><a + id="dx1-123001"></a> <span class="cmtt-10">\glsmoveentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">target glossary label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 5816--><p class="noindent" > +</p><!--l. 6624--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the unique label identifying the required entry and ⟨<span -class="cmti-10">target glossary label</span>⟩ is the -unique label identifying the glossary in which to put the entry. -</p><!--l. 5821--><p class="indent" > Note that no check is performed to determine the existence of the target glossary. If -you want to move an entry to a glossary that’s skipped by <span +class="cmti-10">target glossary label</span>⟩ is the unique label +identifying the glossary in which to put the entry. +</p><!--l. 6629--><p class="indent" > Note that no check is performed to determine the existence of the target glossary. If you want to move an +entry to a glossary that’s skipped by <span class="cmtt-10">\printglossaries</span><a - id="dx1-45002"></a>, -then define an ignored glossary with <span + id="dx1-123002"></a>, then define an ignored glossary with +<span class="cmtt-10">\newignoredglossary</span><a - id="dx1-45003"></a>. (See <a -href="#sec:newglossary"><span -class="tcrm-1000">§</span>12 </a><a -href="#sec:newglossary">Defining New -Glossaries<!--tex4ht:ref: sec:newglossary --></a>.) -</p><!--l. 5827--><p class="indent" > <div class="important" title="Important Note"> Unpredictable results may occur if you move an entry to a different glossary from its -parent or children. </div> -</p><!--l. 5830--><p class="noindent" > -</p><!--l. 5832--><p class="noindent" > + id="dx1-123003"></a>. (See <a +href="#sec:newglossary">§12 </a><a +href="#sec:newglossary">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>.) +</p><!--l. 6635--><p class="indent" > <div class="important" title="Important Note"> Unpredictable results may occur if you move an entry to a different glossary from its parent or children. +</div> +</p><!--l. 6638--><p class="noindent" > +</p><!--l. 6640--><p class="noindent" > </p> -<!--l. 5832--><p class="noindent" ><a +<!--l. 6640--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4.8 </span> <a id="sec:docdefs"></a>Drawbacks With Defining Entries in the Document Environment</h3> -<!--l. 5835--><p class="noindent" >Originally, <span +<!--l. 6643--><p class="noindent" >Originally, <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-46001"></a> (and <span + id="dx1-124001"></a> (and <span class="cmtt-10">\newacronym</span><a - id="dx1-46002"></a>) could only be used in the preamble. I -reluctantly removed this restriction in version 1.13, but there are issues with defining -commands in the <span + id="dx1-124002"></a>) could only be used in the preamble. I reluctantly removed +this restriction in version 1.13, but there are issues with defining commands in the <span class="cmss-10">document</span><a - id="dx1-46003"></a><a - id="dx1-46004"></a> environment instead of the preamble, which is why the restriction -is maintained for newer commands. This restriction is also reimposed for <span -class="cmtt-10">\newglossaryentry</span> -by the new <a + id="dx1-124003"></a><a + id="dx1-124004"></a> environment +instead of the preamble, which is why the restriction is maintained for newer commands. This restriction is also +reimposed for <span +class="cmtt-10">\newglossaryentry </span>by the new <a href="#option1">Option 1</a>. (The <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package automatically reimposes this -restriction for Options <a +class="cmss-10">glossaries-extra</span></a> package automatically +reimposes this restriction for Options <a href="#option2">2</a> and <a href="#option3">3</a> but provides a package option to allow document definitions.) - - -</p><!--l. 5845--><p class="noindent" > + + +</p><!--l. 6653--><p class="noindent" > </p> -<!--l. 5845--><p class="noindent" ><a +<!--l. 6653--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.8.1 </span> <a id="sec:techissues"></a>Technical Issues</h4> -<!--l. 5848--><p class="noindent" > +<!--l. 6656--><p class="noindent" > </p><ol class="enumerate1" > <li - class="enumerate" id="x1-47002x1">If you define an entry mid-way through your document, but subsequently shuffle - sections around, you could end up using an entry before it has been defined. + class="enumerate" id="x1-125002x1">If you define an entry mid-way through your document, but subsequently shuffle sections around, + you could end up using an entry before it has been defined. </li> <li - class="enumerate" id="x1-47004x2">Entry information is required when displaying the glossary. If this occurs at the - start of the document, but the entries aren’t defined until later, then the entry - details are being looked up before the entry has been defined. + class="enumerate" id="x1-125004x2">Entry information is required when displaying the glossary. If this occurs at the start of the + document, but the entries aren’t defined until later, then the entry details are being looked up + before the entry has been defined. </li> <li - class="enumerate" id="x1-47006x3">If you use a package, such as <span + class="enumerate" id="x1-125006x3">If you use a package, such as <span class="cmss-10">babel</span><a - id="dx1-47007"></a>, that makes certain characters active at the start - of the <span + id="dx1-125007"></a>, that makes certain characters active at the start of the <span class="cmss-10">document</span><a - id="dx1-47008"></a><a - id="dx1-47009"></a> environment, there will be a problem if those characters have - a special significance when defining glossary entries. These characters include the - double-quote <span class="obeylines-h"><span class="verb"><span + id="dx1-125008"></a><a + id="dx1-125009"></a> + environment, there will be a problem if those characters have a special significance when defining + glossary entries. These characters include the double-quote <span class="obeylines-h"><span class="verb"><span class="cmtt-10">"</span></span></span> character, the exclamation mark <span -class="cmtt-10">! </span>character, the question mark - <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">!</span> + character, the question mark <span class="obeylines-h"><span class="verb"><span class="cmtt-10">?</span></span></span> character, and the pipe <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">|</span></span></span> character. They must not be active when defining - a glossary entry where they occur in the <span -class="cmss-10">sort</span><a - id="dx1-47010"></a> key (and they should be avoided in - the label if they may be active at any point in the document). Additionally, the - comma <span -class="cmtt-10">, </span>character and the equals <span -class="cmtt-10">= </span>character should not be active when using - commands that have ⟨<span +class="cmtt-10">|</span></span></span> character. They must not be active when + defining a glossary entry where they occur in the <span +class="cmtt-10">sort</span><a + id="dx1-125010"></a> key (and they should be avoided in the label + if they may be active at any point in the document). Additionally, the comma <span +class="cmtt-10">, </span>character and the + equals <span +class="cmtt-10">= </span>character should not be active when using commands that have ⟨<span class="cmti-10">key</span>⟩=⟨<span class="cmti-10">value</span>⟩ arguments. </li></ol> -<!--l. 5874--><p class="noindent" >To overcome the first two problems, as from version 4.0 the <span -class="cmss-10">glossaries </span>package modifies the -definition of <span +<!--l. 6682--><p class="noindent" >To overcome the first two problems, as from version 4.0 the <span +class="cmss-10">glossaries </span>package modifies the definition of +<span class="cmtt-10">\newglossaryentry </span>at the beginning of the <span class="cmss-10">document</span><a - id="dx1-47011"></a><a - id="dx1-47012"></a> environment so that the -definitions are written to an external file (<span -class="cmtt-10">\jobname.glsdefs</span><a - id="dx1-47013"></a>) which is then read in at the -start of the document on the next run. The entry will then only be defined in the -<span + id="dx1-125011"></a><a + id="dx1-125012"></a> environment so that the definitions are written to an +external file (<span +class="cmtt-10">\jobnameglsdefs</span><a + id="dx1-125013"></a>) which is then read in at the start of the document on the next run. The entry +will then only be defined in the <span class="cmss-10">document</span><a - id="dx1-47014"></a><a - id="dx1-47015"></a> environment if it doesn’t already exist. This means that the entry can now -be looked up in the glossary, even if the glossary occurs at the beginning of the + id="dx1-125014"></a><a + id="dx1-125015"></a> environment if it doesn’t already exist. This means that the +entry can now be looked up in the glossary, even if the glossary occurs at the beginning of the document. -</p><!--l. 5884--><p class="indent" > There are drawbacks to this mechanism: if you modify an entry definition, you need a -second run to see the effect of your modification; this method requires an extra <span -class="cmtt-10">\newwrite</span>, -which may exceed <span class="TEX">T<span -class="E">E</span>X</span>’s maximum allocation; unexpected expansion issues could occur; the -<span -class="cmss-10">see</span><a - id="dx1-47016"></a> key isn’t stored, which means it can’t be added to the <span -class="cmtt-10">.glsdefs</span><a - id="dx1-47017"></a> file when it’s -created at the end of the document (and therefore won’t be present on subsequent +</p><!--l. 6692--><p class="indent" > There are drawbacks to this mechanism: if you modify an entry definition, you need a second run to see the +effect of your modification; this method requires an extra <span +class="cmtt-10">\newwrite</span>, which may exceed <span class="TEX">T<span +class="E">E</span>X</span>’s maximum +allocation; unexpected expansion issues could occur; the <span +class="cmtt-10">see</span><a + id="dx1-125016"></a> key isn’t stored, which means it can’t be added to +the <span +class="cmtt-10">glsdefs</span><a + id="dx1-125017"></a> file when it’s created at the end of the document (and therefore won’t be present on subsequent runs). -</p><!--l. 5892--><p class="indent" > The <a +</p><!--l. 6700--><p class="indent" > The <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a> package provides a setting (but only for Options <a href="#option2">2</a> and <a -href="#option3">3</a>) that allows -<span -class="cmtt-10">\newglossaryentry </span>to occur in the document environment but doesn’t create the -<span -class="cmtt-10">.glsdefs</span><a - id="dx1-47018"></a> file. This circumvents some problems but it means that you can’t display -any of the glossaries before all the entries have been defined (so it’s all right if all -the glossaries are at the end of the document but not if any occur in the front +href="#option3">3</a>) that allows <span +class="cmtt-10">\newglossaryentry</span> +to occur in the document environment but doesn’t create the <span +class="cmtt-10">glsdefs</span><a + id="dx1-125018"></a> file. This circumvents some problems but +it means that you can’t display any of the glossaries before all the entries have been defined (so +it’s all right if all the glossaries are at the end of the document but not if any occur in the front matter). - - -</p><!--l. 5900--><p class="noindent" > +</p><!--l. 6708--><p class="noindent" > </p> -<!--l. 5900--><p class="noindent" ><a +<!--l. 6708--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">4.8.2 </span> <a id="sec:goodpractice"></a>Good Practice Issues</h4> -<!--l. 5903--><p class="noindent" >The above section covers technical issues that can cause your document to have compilation -errors or produce incorrect output. This section focuses on good writing practice. The main -reason cited by users wanting to define entries within the <span +<!--l. 6711--><p class="noindent" >The above section covers technical issues that can cause your document to have compilation errors or produce +incorrect output. This section focuses on good writing practice. The main reason cited by users wanting to + + +define entries within the <span class="cmss-10">document</span><a - id="dx1-48001"></a><a - id="dx1-48002"></a> environment -rather than in the preamble is that they want to write the definition as they type in -their document text. This suggests a “stream of consciousness” style of writing -that may be acceptable in certain literary genres but is inappropriate for factual + id="dx1-126001"></a><a + id="dx1-126002"></a> environment rather than in the preamble is that they want to +write the definition as they type in their document text. This suggests a “stream of consciousness” +style of writing that may be acceptable in certain literary genres but is inappropriate for factual documents. -</p><!--l. 5912--><p class="indent" > When you write technical documents, regardless of whether it’s a PhD thesis or an article -for a journal or proceedings, you must plan what you write in advance. If you plan in -advance, you should have a fairly good idea of the type of terminology that your -document will contain, so while you are planning, create a new file with all your -entry definitions. If, while you’re writing your document, you remember another -term you need, then you can switch over to your definition file and add it. Most -text editors have the ability to have more than one file open at a time. The other -advantage to this approach is that if you forget the label, you can look it up in -the definition file rather than searching through your document text to find the +</p><!--l. 6720--><p class="indent" > When you write technical documents, regardless of whether it’s a PhD thesis or an article for a journal or +proceedings, you must plan what you write in advance. If you plan in advance, you should have a fairly good +idea of the type of terminology that your document will contain, so while you are planning, create a new file +with all your entry definitions. If, while you’re writing your document, you remember another term you need, +then you can switch over to your definition file and add it. Most text editors have the ability to have more than +one file open at a time. The other advantage to this approach is that if you forget the label, you +can look it up in the definition file rather than searching through your document text to find the definition. - - + + </p> -<!--l. 5925--><p class="indent" > </div> -</p><!--l. 5925--><p class="noindent" ><a +<!--l. 6733--><p class="indent" > </div> +</p><!--l. 6733--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">5. <a id="sec:numberlists"></a>Number lists</h2> -</p><!--l. 5928--><p class="indent" > Each entry in the glossary has an associated <a +</p><!--l. 6736--><p class="indent" > Each entry in the glossary has an associated <a href="#glo:numberlist">number list<a - id="dx1-49001"></a></a>. By default, these numbers refer -to the pages on which that entry has been indexed (using any of the commands described in -<a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a -href="#sec:glsadd"><span -class="tcrm-1000">§</span>7 </a><a -href="#sec:glsadd">Adding an Entry to the Glossary Without Generating -Text<!--tex4ht:ref: sec:glsadd --></a>). The number list can be suppressed using the <span + id="dx1-127001"></a></a>. By default, these numbers refer to the +pages on which that entry has been indexed (using any of the commands described in <a +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to +Glossary Entries<!--tex4ht:ref: sec:glslink --></a> and <a +href="#sec:glsadd">§7 </a><a +href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>). The number list +can be suppressed using the <span class="cmss-10">nonumberlist</span><a - id="dx1-49002"></a> package option, or an -alternative counter can be set as the default using the <span + id="dx1-127002"></a> package option, or an alternative counter can be set as +the default using the <span class="cmss-10">counter</span><a - id="dx1-49003"></a> package option. The number -list is also referred to as the location list<a - id="dx1-49004"></a>. -</p><!--l. 5937--><p class="indent" > <a + id="dx1-127003"></a> package option. The number list is also referred to as the location +list<a + id="dx1-127004"></a>. +</p><!--l. 6745--><p class="indent" > <a href="#glo:numberlist">Number list<a - id="dx1-49005"></a>s</a> are more common with indexes rather than glossaries (although you can use -the <span -class="cmss-10">glossaries </span>package for indexes as well). However, the <span -class="cmss-10">glossaries </span>package makes use of -<a + id="dx1-127005"></a>s</a> are more common with indexes rather than glossaries (although you can use the <span +class="cmss-10">glossaries</span> +package for indexes as well). However, the <span +class="cmss-10">glossaries </span>package makes use of <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-49006"></a></a> or <a + id="dx1-127006"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-49007"></a></a> to hierarchically sort and collate the entries since they are readily -available with most modern <span class="TEX">T<span -class="E">E</span>X</span> distributions. Since these are both designed as <a -href="#glo:indexingapp">indexing -applications</a> they both require that terms either have a valid location or a cross-reference. -Even if you use <span + id="dx1-127007"></a></a> to hierarchically +sort and collate the entries since they are readily available with most modern <span class="TEX">T<span +class="E">E</span>X</span> distributions. Since these +are both designed as <a +href="#glo:indexingapp">indexing applications</a> they both require that terms either have a valid location or a +cross-reference. Even if you use <span class="cmss-10">nonumberlist</span><a - id="dx1-49008"></a>, the locations must still be provided and acceptable -to the <a -href="#glo:indexingapp">indexing application</a> or they will cause an error during the indexing stage, -which will interrupt the document build. However, if you’re not interested in the -locations, each entry only needs to be indexed once, so consider using <span + id="dx1-127008"></a>, the locations must still be provided and acceptable to the <a +href="#glo:indexingapp">indexing +application</a> or they will cause an error during the indexing stage, which will interrupt the document build. +However, if you’re not interested in the locations, each entry only needs to be indexed once, so consider using +<span class="cmss-10">indexonlyfirst</span><a - id="dx1-49009"></a>, -which can improve the document build time by only indexing the <a + id="dx1-127009"></a>, which can improve the document build time by only indexing the <a href="#glo:firstuse">first use</a> of each term. -</p><!--l. 5952--><p class="indent" > The <span +</p><!--l. 6760--><p class="indent" > The <span class="cmtt-10">\glsaddall</span><a - id="dx1-49010"></a> command (see <a -href="#sec:glsadd"><span -class="tcrm-1000">§</span>7 </a><a -href="#sec:glsadd">Adding an Entry to the Glossary Without Generating -Text<!--tex4ht:ref: sec:glsadd --></a>), which is used to automatically index all entries, iterates over all defined entries and -does <span + id="dx1-127010"></a> command (see <a +href="#sec:glsadd">§7 </a><a +href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a>), which is used +to automatically index all entries, iterates over all defined entries and does <span class="cmtt-10">\glsadd{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">} </span>for each entry (where ⟨<span -class="cmti-10">label</span>⟩ is that entry’s label). This means that -<span -class="cmtt-10">\glsaddall </span>automatically adds the same location to every entry’s <a +class="cmtt-10">} </span>for +each entry (where ⟨<span +class="cmti-10">label</span>⟩ is that entry’s label). This means that <span +class="cmtt-10">\glsaddall </span>automatically adds +the same location to every entry’s <a href="#glo:numberlist">number list<a - id="dx1-49011"></a></a>, which looks -weird if the number list<a - id="dx1-49012"></a> hasn’t been suppressed. -</p><!--l. 5959--><p class="indent" > With <a + id="dx1-127011"></a></a>, which looks weird if the number list<a + id="dx1-127012"></a> hasn’t been +suppressed. +</p><!--l. 6767--><p class="indent" > With <a href="#option4">Option 4</a>, the indexing is performed by <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-49013"></a></a>, which was specifically designed for -the <a + id="dx1-127013"></a></a>, which was specifically designed for the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package. So it will allow any location format, and its <span -class="cmtt-10">selection=all</span> -option will select all entries without adding an unwanted location to the <a +class="cmss-10">glossaries-extra</span></a> +package. So it will allow any location format, and its <span +class="cmtt-10">selection=all </span>option will select all entries without +adding an unwanted location to the <a href="#glo:numberlist">number list<a - id="dx1-49014"></a></a>. If -<a + id="dx1-127014"></a></a>. If <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-49015"></a></a> can deduce a numerical value for a location, it will attempt to form a range over -consecutive locations, otherwise it won’t try to form a range and the location will just form -an individual item in the list. <a + id="dx1-127015"></a></a> can deduce a numerical value for a location, it will +attempt to form a range over consecutive locations, otherwise it won’t try to form a range and the location will +just form an individual item in the list. <a href="#option1">Option 1</a> also allows any location but it doesn’t form ranges. </p> -<!--l. 5969--><p class="noindent" ><a +<!--l. 6777--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.1 </span> <a id="sec:encap"></a>Encap Values</h3> -<!--l. 5972--><p class="noindent" >Each location in the <a +<!--l. 6780--><p class="noindent" >Each location in the <a href="#glo:numberlist">number list<a - id="dx1-50001"></a></a> is encapsulated with a command formed from the <span + id="dx1-128001"></a></a> is encapsulated with a command formed from the <span class="cmti-10">encap</span><a - id="dx1-50002"></a> -value. By default this is the <span + id="dx1-128002"></a> value. By default this +is the <span class="cmtt-10">\glsnumberformat</span><a - id="dx1-50003"></a> command, which corresponds to the encap -<span -class="cmtt-10">glsnumberformat</span>, but this may be overridden using the <span -class="cmss-10">format</span><a - id="dx1-50004"></a> key in the optional argument -to commands like <span + id="dx1-128003"></a> command, which corresponds to the encap <span +class="cmtt-10">glsnumberformat</span>, but this may be +overridden using the <span +class="cmtt-10">format</span><a + id="dx1-128004"></a> key in the optional argument to commands like <span class="cmtt-10">\gls</span>. (See <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>.) For example, you may want the -location to appear in bold to indicate the principle use of a term or symbol. If the encap -starts with an open parenthesis <span class="obeylines-h"><span class="verb"><span +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to Glossary +Entries<!--tex4ht:ref: sec:glslink --></a>.) For example, you may want the location to appear in bold to indicate the principle use of a term or +symbol. If the encap starts with an open parenthesis <span class="obeylines-h"><span class="verb"><span class="cmtt-10">(</span></span></span> this signifies the start of a range and if the encap starts with close parenthesis <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">)</span></span></span> this signifies the end of a range. These must always occur in -matching pairs. -</p><!--l. 5984--><p class="indent" > The <span +class="cmtt-10">)</span></span></span> this signifies the end of a range. These must always occur in matching +pairs. +</p><!--l. 6792--><p class="indent" > The <span class="cmss-10">glossaries </span>package provides the command <span class="cmtt-10">\glsignore</span><a - id="dx1-50005"></a> which ignores its argument. -This is the format used by <span -class="cmtt-10">\glsaddallunused </span>to suppress the location, which works fine as -long as no other locations are added to the <a + id="dx1-128005"></a> which ignores its argument. This is the format +used by <span +class="cmtt-10">\glsaddallunused </span>to suppress the location, which works fine as long as no other locations are added to +the <a href="#glo:numberlist">number list<a - id="dx1-50006"></a></a>. For example, if you use - - -<span class="obeylines-h"><span class="verb"><span + id="dx1-128006"></a></a>. For example, if you use <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{sample}</span></span></span> on page 2 then reset the <a -href="#glo:firstuseflag">first use flag</a> and then use <span -class="cmtt-10">\glsaddallunused </span>on -page 10, the <a +href="#glo:firstuseflag">first use flag</a> and then use +<span +class="cmtt-10">\glsaddallunused </span>on page 10, the <a href="#glo:numberlist">number list<a - id="dx1-50007"></a></a> for <span + id="dx1-128007"></a></a> for <span class="cmtt-10">sample </span>will be <span class="obeylines-h"><span class="verb"><span class="cmtt-10">2,</span><span -class="cmtt-10"> \glsignore{10}</span></span></span> which will result in “2, ” -which has a spurious comma. -</p><!--l. 5993--><p class="indent" > This isn’t a problem with <a +class="cmtt-10"> \glsignore{10}</span></span></span> which will result in +“2, ” which has a spurious comma. +</p><!--l. 6801--><p class="indent" > This isn’t a problem with <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-50008"></a></a> because you’d use <span -class="cmtt-10">selection=all </span>instead of -<span -class="cmtt-10">\glsaddallunused</span>, but even if you explicitly had, for example, <span -class="cmtt-10">\gls[format=glsignore]</span> -<span -class="cmtt-10">{</span>⟨<span + id="dx1-128008"></a></a> because you’d use <span +class="cmtt-10">selection=all </span>instead of <span +class="cmtt-10">\glsaddallunused</span>, but +even if you explicitly had, for example, <span +class="cmtt-10">\gls[format=glsignore]{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>for some reason, <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-50009"></a></a> will recognise <span -class="cmtt-10">glsignore </span>as a special encap indicating an -ignored location, so it will select the entry but not add that location to the <a + id="dx1-128009"></a></a> will + + +recognise <span +class="cmtt-10">glsignore </span>as a special encap indicating an ignored location, so it will select the entry but not add +that location to the <a href="#glo:numberlist">number list<a - id="dx1-50010"></a></a>. It’s a -problem for all the other options (except <a -href="#option5">Option 5</a>, which doesn’t perform any -indexing). -</p><!--l. 6003--><p class="indent" > Complications can arise if you use different encap values for the same location. For -example, suppose on page 10 you have both the default <span + id="dx1-128010"></a></a>. It’s a problem for all the other options (except <a +href="#option5">Option 5</a>, which doesn’t +perform any indexing). +</p><!--l. 6811--><p class="indent" > Complications can arise if you use different encap values for the same location. For example, suppose on +page 10 you have both the default <span class="cmtt-10">glsnumberformat </span>and <span -class="cmtt-10">textbf</span> -encaps. While it may seem apparent that <span +class="cmtt-10">textbf </span>encaps. While it may seem apparent that +<span class="cmtt-10">textbf </span>should override <span -class="cmtt-10">glsnumberformat </span>in this -situation, the <a -href="#glo:indexingapp">indexing application</a> may not know it. This is therefore something you need to -be careful about if you use the <span -class="cmss-10">format</span><a - id="dx1-50011"></a> key or if you use a command that implicitly sets -it. -</p><!--l. 6012--><p class="indent" > In the case of <a +class="cmtt-10">glsnumberformat </span>in this situation, the <a +href="#glo:indexingapp">indexing application</a> may not know it. This is +therefore something you need to be careful about if you use the <span +class="cmtt-10">format</span><a + id="dx1-128011"></a> key or if you use a command that +implicitly sets it. +</p><!--l. 6820--><p class="indent" > In the case of <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-50012"></a></a>, it only accepts one encap (according to the order of precedence given -in the <a + id="dx1-128012"></a></a>, it only accepts one encap (according to the order of precedence given in the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-50013"></a></a> module) and discards the others for identical locations (for the same -entry). This can cause a problem if a discarded location forms the start or end of a -range. -</p><!--l. 6017--><p class="indent" > In the case of <a + id="dx1-128013"></a></a> +module) and discards the others for identical locations (for the same entry). This can cause a problem if a +discarded location forms the start or end of a range. +</p><!--l. 6825--><p class="indent" > In the case of <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-50014"></a></a>, it accepts different encaps for the same location, but warns -about it. This leads to a <a + id="dx1-128014"></a></a>, it accepts different encaps for the same location, but warns about it. This leads to +a <a href="#glo:numberlist">number list<a - id="dx1-50015"></a></a> with the same location repeated in different formats. If -you use the <a + id="dx1-128015"></a></a> with the same location repeated in different formats. If you use the <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-50016"></a></a> Perl script with <a + id="dx1-128016"></a></a> Perl script +with <a href="#option2">Option 2</a> it will detect <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-50017"></a></a>’s warning -and attempt to fix the problem, ensuring that the <span -class="cmtt-10">glsnumberformat </span>encap always has the -least precedence unless it includes a range identifier. Other conflicting encaps will have the -last one override earlier ones for the same location with range identifiers taking + id="dx1-128017"></a></a>’s warning and attempt to fix the problem, ensuring that the +<span +class="cmtt-10">glsnumberformat </span>encap always has the least precedence unless it includes a range identifier. Other conflicting +encaps will have the last one override earlier ones for the same location with range identifiers taking priority. -</p><!--l. 6027--><p class="indent" > No discard occurs with <a -href="#option1">Option 1</a> so again you get the same location repeated in different -formats. With <a +</p><!--l. 6835--><p class="indent" > No discard occurs with <a +href="#option1">Option 1</a> so again you get the same location repeated in different formats. With +<a href="#option4">Option 4</a>, <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-50018"></a></a> will discard according to order of precedence, -giving priority to start and end range encaps. (See the <a + id="dx1-128018"></a></a> will discard according to order of precedence, giving priority to start and end range encaps. +(See the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-50019"></a></a> manual for further -details.) -</p><!--l. 6032--><p class="noindent" > + id="dx1-128019"></a></a> manual for further details.) +</p><!--l. 6840--><p class="noindent" > </p> -<!--l. 6032--><p class="noindent" ><a +<!--l. 6840--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.2 </span> <a id="sec:locationsyntax"></a>Locations</h3> -<!--l. 6035--><p class="noindent" >Neither <a +<!--l. 6843--><p class="noindent" >Neither <a href="#option1">Option 1</a> nor <a -href="#option4">Option 4</a> care about the location syntax as long as it’s valid -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> code (and doesn’t contain fragile commands). In both cases, the indexing is -performed by writing a line to the <span -class="cmtt-10">.aux </span>file. The write operation is deferred to avoid the -problems associated with <span class="TEX">T<span -class="E">E</span>X</span>’s asynchronous output routine. (See, for example, <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage" >Finding if -you’re on an odd or an even page</a> for more details on this issue.) Unfortunately Options <a -href="#option2">2</a> -and <a +href="#option4">Option 4</a> care about the location syntax as long as it’s valid <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> code (and doesn’t +contain fragile commands). In both cases, the indexing is performed by writing a line to the <span +class="cmtt-10">aux</span><a + id="dx1-129001"></a> file. The write +operation is deferred to avoid the problems associated with <span class="TEX">T<span +class="E">E</span>X</span>’s asynchronous output routine. (See, for +example, <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage" >Finding if you’re on an odd or an even page</a> for more details on this issue.) Unfortunately +Options <a +href="#option2">2</a> and <a href="#option3">3</a> are far more problematic and need some complex code to deal with awkward locations. -</p><!--l. 6046--><p class="indent" > If you know that your locations will always expand to a format acceptable to your chosen -<a -href="#glo:indexingapp">indexing application</a> then use the package option <span -class="cmss-10">esclocations=false</span><a - id="dx1-51001"></a> to bypass this operation. -This setting only affects Options <a +</p><!--l. 6854--><p class="indent" > If you know that your locations will always expand to a format acceptable to your chosen <a +href="#glo:indexingapp">indexing +application</a> then use the package option <span +class="cmss-10">esclocations</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-129002"></a> to bypass this operation. This setting only affects +Options <a href="#option2">2</a> and <a -href="#option3">3</a> as the problem doesn’t arise with the other - - -indexing options. -</p><!--l. 6052--><p class="indent" > Both <a +href="#option3">3</a> as the problem doesn’t arise with the other indexing options. +</p><!--l. 6860--><p class="indent" > Both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51002"></a></a> and <a + id="dx1-129003"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51003"></a></a> are fussy about the syntax of the locations. In the -case of <a + id="dx1-129004"></a></a> are fussy about the syntax of the locations. In the case of <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51004"></a></a>, only the numbering system obtained with <span + id="dx1-129005"></a></a>, only the +numbering system obtained with <span class="cmtt-10">\arabic</span>, <span -class="cmtt-10">\roman</span>, -<span +class="cmtt-10">\roman</span>, <span class="cmtt-10">\Roman</span>, <span class="cmtt-10">\alph </span>and <span -class="cmtt-10">\Alph </span>or composites formed from them with the same separator -(set with <span +class="cmtt-10">\Alph </span>or composites formed from them +with the same separator (set with <span class="cmtt-10">\glsSetCompositor{</span>⟨<span class="cmti-10">char</span>⟩<span class="cmtt-10">}</span>) are accepted. (<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51005"></a></a> won’t accept an -empty location.) In the case of <a + id="dx1-129006"></a></a> won’t accept an empty +location.) In the case of <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51006"></a></a>, you can define your own location classes, -but if the location contains a robust command then the leading backslash must be -escaped. The <span + id="dx1-129007"></a></a>, you can define your own location classes, but if the location contains a robust +command then the leading backslash must be escaped. The <span class="cmss-10">glossaries</span><a - id="dx1-51007"></a> package tries to do this, but it’s caught between two conflicting -requirements: + id="dx1-129008"></a> package tries to do this, but it’s caught +between two conflicting requirements: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-51009x1">The location must be fully expanded before <span class="obeylines-h"><span class="verb"><span + class="enumerate" id="x1-129010x1">The location must be fully expanded before <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\</span></span></span> can be converted to <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\</span></span></span> (there’s no - point converting <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\\</span></span></span> (there’s no point converting + <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\thepage</span></span></span> to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\\thepage</span></span></span>); </li> + + <li - class="enumerate" id="x1-51011x2">The page number can’t be expanded until the deferred write operation (so <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\c@page</span></span></span> - mustn’t expand in the previous step but <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\the\c@page</span></span></span> mustn’t be converted to + class="enumerate" id="x1-129012x2">The page number can’t be expanded until the deferred write operation (so <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\c@page</span></span></span> mustn’t + expand in the previous step but <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\the\c@page</span></span></span> mustn’t be converted to <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\\the\\c@page</span></span></span> and <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\the\\c@page</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\number\c@page</span></span></span> mustn’t be converted to <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\number\\c@page</span></span></span> - etc).</li></ol> -<!--l. 6072--><p class="noindent" >There’s a certain amount of trickery needed to deal with this conflict and the code requires -the location to be in a form that doesn’t embed the counter’s internal register in -commands like <span -class="cmtt-10">\value</span>. For example, suppose you have a robust command called -<span -class="cmtt-10">\tallynum </span>that takes a number as the argument and an expandable command called -<span -class="cmtt-10">\tally </span>that converts a counter name into the associated register or number to -pass to <span +class="cmtt-10">\\number\\c@page</span></span></span> etc).</li></ol> +<!--l. 6880--><p class="noindent" >There’s a certain amount of trickery needed to deal with this conflict and the code requires the location to be in a +form that doesn’t embed the counter’s internal register in commands like <span +class="cmtt-10">\value</span>. For example, +suppose you have a robust command called <span +class="cmtt-10">\tallynum </span>that takes a number as the argument and an +expandable command called <span +class="cmtt-10">\tally </span>that converts a counter name into the associated register or +number to pass to <span class="cmtt-10">\tallynum</span>. Let’s suppose that this command is used to represent the page number: - - + + </p> - <div class="verbatim" id="verbatim-181"> + <div class="verbatim" id="verbatim-177"> \renewcommand{\thepage}{\tally{page}} </div> -<!--l. 6082--><p class="nopar" > Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a -paragraph that started on page 1. With <a +<!--l. 6890--><p class="nopar" > Now let’s suppose that a term is indexed at the beginning of page 2 at the end of a paragraph that started on +page 1. With <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51012"></a></a>, the location <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\tally{page}</span></span></span> needs to be -written to the file as <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\tallynum{2}</span></span></span>. If it’s written as <span class="obeylines-h"><span class="verb"><span + id="dx1-129013"></a></a>, the location <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\tally{page}</span></span></span> needs to be written to the file as <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\\tallynum{2}</span></span></span>. If it’s written +as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\tallynum{2}</span></span></span> then <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51013"></a></a> will -interpret <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\t</span></span></span> as the character “t” (which means the location would appear as “tallynum2”). So -<span + id="dx1-129014"></a></a> will interpret <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\t</span></span></span> as the character “t” (which means the location would appear as +“tallynum2”). So <span class="cmss-10">glossaries</span><a - id="dx1-51014"></a> tries to expand <span + id="dx1-129015"></a> tries to expand <span class="cmtt-10">\thepage </span>without expanding <span class="cmtt-10">\c@page </span>and then escapes all the -backslashes, except for the page counter’s internal command. The following definitions of -<span -class="cmtt-10">\tally </span>will work: </p> +backslashes, except for the page counter’s internal command. The following definitions of <span +class="cmtt-10">\tally </span>will work: +</p> <ul class="itemize1"> <li class="itemize">In the following, <span class="cmtt-10">\arabic </span>works as its internal command <span -class="cmtt-10">\c@arabic </span>is temporarily - redefined to check for <span +class="cmtt-10">\c@arabic </span>is temporarily redefined to check for + <span class="cmtt-10">\c@page</span>: - - - <div class="verbatim" id="verbatim-182"> + + + <div class="verbatim" id="verbatim-178"> \newcommand{\tally}[1]{\tallynum{\arabic{#1}}} </div> - <!--l. 6098--><p class="nopar" > + <!--l. 6906--><p class="nopar" > </p></li> <li class="itemize">The form <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\expandafter\the\csname</span><span class="cmtt-10"> c@</span></span></span>⟨<span class="cmti-10">counter</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">\endcsname</span></span></span> also works (provided <span -class="cmtt-10">\the</span> - is allowed to be temporarily redefined, see below): - - - <div class="verbatim" id="verbatim-183"> +class="cmtt-10">\the </span>is allowed to be + temporarily redefined, see below): + + + <div class="verbatim" id="verbatim-179"> \newcommand{\tally}[1]{%  <br /> \tallynum{\expandafter\the\csname c@#1\endcsname}} </div> - <!--l. 6106--><p class="nopar" > + <!--l. 6914--><p class="nopar" > </p></li> <li class="itemize"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\expandafter\the\value</span></span></span><span class="cmtt-10">{</span>⟨<span class="cmti-10">counter</span>⟩<span -class="cmtt-10">} </span>now also works (with the same condition as - above): - - - <div class="verbatim" id="verbatim-184"> +class="cmtt-10">} </span>now also works (with the same condition as above): + + + <div class="verbatim" id="verbatim-180"> \newcommand{\tally}[1]{\tallynum{\expandafter\the\value{#1}}} </div> - <!--l. 6112--><p class="nopar" > + <!--l. 6920--><p class="nopar" > </p></li> <li class="itemize">Another variation that will work: - - - <div class="verbatim" id="verbatim-185"> + + + <div class="verbatim" id="verbatim-181"> \newcommand{\tally}[1]{%  <br />  \expandafter\tallynum\expandafter{\the\csname c@#1\endcsname}} </div> - <!--l. 6118--><p class="nopar" > + <!--l. 6926--><p class="nopar" > </p></li> <li class="itemize">and also: - - - <div class="verbatim" id="verbatim-186"> + + + <div class="verbatim" id="verbatim-182"> \newcommand{\tally}[1]{\tallynum{\the\csname c@#1\endcsname}} </div> - <!--l. 6123--><p class="nopar" ></p></li></ul> -<!--l. 6125--><p class="noindent" >The following <span + <!--l. 6931--><p class="nopar" ></p></li></ul> +<!--l. 6933--><p class="noindent" >The following <span class="cmti-10">don’t work</span>: </p> <ul class="itemize1"> <li class="itemize">This definition leads to the premature expansion of <span -class="cmtt-10">\c@page </span>to “1” when, in this case, - it should be “2”: - - - <div class="verbatim" id="verbatim-187"> +class="cmtt-10">\c@page </span>to “1” when, in this case, it should be + “2”: + + + <div class="verbatim" id="verbatim-183"> \newcommand{\tally}[1]{\tallynum{\the\value{#1}}} </div> - <!--l. 6131--><p class="nopar" > + <!--l. 6939--><p class="nopar" > </p></li> <li class="itemize">This definition leads to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\\c@page</span></span></span> in the glossary file: - - - <div class="verbatim" id="verbatim-188"> + + + <div class="verbatim" id="verbatim-184"> \newcommand{\tally}[1]{\tallynum{\csname c@#1\endcsname}} </div> - <!--l. 6135--><p class="nopar" ></p></li></ul> -<!--l. 6137--><p class="noindent" >If you have a numbering system where <span class="obeylines-h"><span class="verb"><span + <!--l. 6943--><p class="nopar" ></p></li></ul> +<!--l. 6945--><p class="noindent" >If you have a numbering system where <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\</span></span></span>⟨<span class="cmti-10">cs name</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">{page}</span></span></span> expands to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\</span></span></span>⟨<span class="cmti-10">internal cs name</span>⟩<span -class="cmtt-10">\c@page</span> -(for example, if <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\c@page </span>(for example, if +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">\tally{page}</span></span></span> expands to <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\tallynum\c@page</span></span></span>) then you need to -use: -</p><!--l. 6142--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsaddprotectedpagefmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-51015"></a> <span +class="cmtt-10">\tallynum\c@page</span></span></span>) then you need to use: +</p><!--l. 6950--><p class="indent" > <hr><div title="Definition"><a + id="dx1-129016"></a> <span class="cmtt-10">\glsaddprotectedpagefmt{</span>⟨<span class="cmitt-10">internal cs name</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 6144--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 6952--><p class="noindent" > Note that the backslash must be omitted from ⟨<span -class="cmti-10">internal cs name</span>⟩ and the corresponding -command must be able to process a count register as the (sole) argument. -</p><!--l. 6149--><p class="indent" > For example, suppose you have a style <span +class="cmti-10">internal cs name</span>⟩ and the corresponding command must be able +to process a count register as the (sole) argument. +</p><!--l. 6957--><p class="indent" > For example, suppose you have a style <span class="cmtt-10">samplenum </span>that is implemented as follows: - - + + </p> - <div class="verbatim" id="verbatim-189"> + <div class="verbatim" id="verbatim-185">  \newcommand*{\samplenum}[1]{%  <br />   \expandafter\@samplenum\csname c@#1\endcsname}  <br /> \newcommand*{\@samplenum}[1]{\two@digits{#1}} </div> -<!--l. 6156--><p class="nopar" > (That is, it displays the value of the counter as a two-digit number.) Then to ensure the -location is correct for entries in page-spanning paragraphs, you need to do: - - +<!--l. 6964--><p class="nopar" > (That is, it displays the value of the counter as a two-digit number.) Then to ensure the location is correct for +entries in page-spanning paragraphs, you need to do: + + </p> - <div class="verbatim" id="verbatim-190"> + <div class="verbatim" id="verbatim-186"> \glsaddprotectedpagefmt{@samplenum} </div> -<!--l. 6162--><p class="nopar" > (If you are using a different counter for the location, such as <span +<!--l. 6970--><p class="nopar" > (If you are using a different counter for the location, such as <span class="cmtt-10">section </span>or <span -class="cmtt-10">equation</span>, you don’t -need to worry about this provided the inner command is expandable.) -</p><!--l. 6167--><p class="indent" > If the inner macro (as given by <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">equation</span>, you don’t need to worry +about this provided the inner command is expandable.) +</p><!--l. 6975--><p class="indent" > If the inner macro (as given by <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\</span></span></span>⟨<span -class="cmti-10">internal cs name</span>⟩) contains non-expandable -commands then you may need to redefine <span +class="cmti-10">internal cs name</span>⟩) contains non-expandable commands then you may need +to redefine <span class="cmtt-10">\gls</span>⟨<span class="cmti-10">internal cs name</span>⟩<span -class="cmtt-10">page </span>after using +class="cmtt-10">page </span>after using </p><div class="alltt"> +<div class="obeylines-v"> <span class="cmtt-10">\glsaddprotectedpagefmt{</span>⟨<span -class="cmti-10">internal cs name</span>⟩<span -class="cmtt-10">}</span>. This command doesn’t take any arguments as -<span +class="cmitt-10">internal</span><span +class="cmitt-10"> cs</span><span +class="cmitt-10"> name</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> This command doesn’t take any arguments as <span class="cmti-10">the location is assumed to be given by </span><span -class="cmitt-10">\c@page </span>because that’s the only occasion this -command should be used. For example, suppose now my page counter format uses small caps -Roman numerals: - - -</p> - <div class="verbatim" id="verbatim-191"> +class="cmitt-10">\c@page </span>because that’s +the only occasion this command should be used. For example, suppose now my page counter format uses small +caps Roman numerals: + + + <div class="verbatim" id="verbatim-187">  \newcommand*{\samplenum}[1]{%  <br />  \expandafter\@samplenum\csname c@#1\endcsname}  <br /> \newcommand*{\@samplenum}[1]{\textsc{\romannumeral#1}} </div> -<!--l. 6178--><p class="nopar" > Again, the inner macro needs to be identified using: - - +<!--l. 6989--><p class="nopar" > Again, the inner macro needs to be identified using: + + </p> - <div class="verbatim" id="verbatim-192"> + <div class="verbatim" id="verbatim-188"> \glsaddprotectedpagefmt{@samplenum} </div> -<!--l. 6182--><p class="nopar" > However, since <span -class="cmtt-10">\textsc </span>isn’t fully expandable, the location is written to the file as -<span class="obeylines-h"><span class="verb"><span +<!--l. 6993--><p class="nopar" > However, since <span +class="cmtt-10">\textsc </span>isn’t fully expandable, the location is written to the file as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\textsc</span><span class="cmtt-10"> </span><span -class="cmtt-10"> {i}</span></span></span> (for page 1), <span class="obeylines-h"><span class="verb"><span +class="cmtt-10"> {i}</span></span></span> (for page 1), +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">\textsc</span><span class="cmtt-10"> </span><span -class="cmtt-10"> {ii}</span></span></span> (for page 2), etc. This format may cause a -problem for the <a -href="#glo:indexingapp">indexing application</a> (particularly for <a +class="cmtt-10"> {ii}</span></span></span> (for page 2), etc. This format may cause a problem for the <a +href="#glo:indexingapp">indexing application</a> +(particularly for <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51016"></a></a>). To compensate for this, -the <span + id="dx1-129017"></a></a>). To compensate for this, the <span class="cmtt-10">\gls</span>⟨<span class="cmti-10">internal cs name</span>⟩<span -class="cmtt-10">page </span>command may be redefined so that it expands to a format -that’s acceptable to the indexing application. For example: - - +class="cmtt-10">page </span>command +may be redefined so that it expands to a format that’s acceptable to the indexing application. For +example: + + </p> - <div class="verbatim" id="verbatim-193"> + <div class="verbatim" id="verbatim-189"> \renewcommand*{\gls@samplenumpage}{\romannumeral\c@page} </div> -<!--l. 6192--><p class="nopar" > While this modification means that the <a +<!--l. 7003--><p class="nopar" > While this modification means that the <a href="#glo:numberlist">number list<a - id="dx1-51017"></a></a> in the glossary won’t exactly match the -format of the page numbers (displaying lower case Roman numbers instead of small cap -Roman numerals) this method will at least work correctly for both <a + id="dx1-129018"></a></a> in the glossary won’t exactly match the format of the page +numbers (displaying lower case Roman numbers instead of small cap Roman numerals) this method +will at least work correctly for both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51018"></a></a> and <a + id="dx1-129019"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51019"></a></a>. If -you are using <a + id="dx1-129020"></a></a>. If you are using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51020"></a></a>, the following definition: - - + id="dx1-129021"></a></a>, the following +definition: + + </p> - <div class="verbatim" id="verbatim-194"> + <div class="verbatim" id="verbatim-190">  \renewcommand*{\gls@samplenumpage}{%  <br />   \glsbackslash\string\textsc{\romannumeral\c@page}} </div> -<!--l. 6202--><p class="nopar" > combined with - - +<!--l. 7013--><p class="nopar" > combined with + + </p> - <div class="verbatim" id="verbatim-195"> + <div class="verbatim" id="verbatim-191"> \GlsAddXdyLocation{romansc}{:sep "\string\textsc\glsopenbrace"  <br /> "roman-numbers-lowercase" :sep "\glsclosebrace"} </div> -<!--l. 6207--><p class="nopar" > will now have lowercase Roman numerals in the location list (see <a -href="#sec:xindyloc"><span -class="tcrm-1000">§</span>11.2 </a><a -href="#sec:xindyloc">Locations and -Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details on that command). Take care of the backslashes. The location -(which ends up in the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">:locref</span></span></span> attribute) needs <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\\</span></span></span> but the location class (identified with -<span -class="cmtt-10">\GlsAddXdyLocation</span>) just has a single backslash. Note that this example will cause problems -if your locations should be hyperlinks. -</p><!--l. 6216--><p class="indent" > Another possibility that may work with both <a +<!--l. 7018--><p class="nopar" > will now have lowercase Roman numerals in the location list (see <a +href="#sec:xindyloc">§11.2 </a><a +href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a> for +further details on that command). Take care of the backslashes. The location (which ends up in the +<span +class="cmtt-10">:locref</span><a + id="dx1-129022"></a> attribute) needs <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\\</span></span></span> but the location class (identified with <span +class="cmtt-10">\GlsAddXdyLocation</span>) just +has a single backslash. Note that this example will cause problems if your locations should be +hyperlinks. +</p><!--l. 7027--><p class="indent" > Another possibility that may work with both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-51021"></a></a> and <a + id="dx1-129023"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-51022"></a></a> is to redefine -<span + id="dx1-129024"></a></a> is to redefine <span class="cmtt-10">\gls</span>⟨<span class="cmti-10">internal cs name</span>⟩<span -class="cmtt-10">page </span>(<span -class="cmtt-10">\gls@samplenumpage </span>in this example) to just expand to the -decimal page number (<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\number\c@page</span></span></span>) and redefine <span +class="cmtt-10">page</span> +(<span +class="cmtt-10">\gls@samplenumpage </span>in this example) to just expand to the decimal page number (<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\number\c@page</span></span></span>) and +redefine <span class="cmtt-10">\glsnumberformat</span><a - id="dx1-51023"></a> to change the -displayed format: - - + id="dx1-129025"></a> to change the displayed format: + + </p> - <div class="verbatim" id="verbatim-196"> + <div class="verbatim" id="verbatim-192"> \renewcommand*{\gls@samplenumpage}{\number\c@page}  <br />\renewcommand*{\glsnumberformat}[1]{\textsc{\romannumeral#1}} </div> -<!--l. 6224--><p class="nopar" > -</p><!--l. 6226--><p class="indent" > <div class="important" title="Important Note"> If you redefine <span +<!--l. 7035--><p class="nopar" > +</p><!--l. 7037--><p class="indent" > <div class="important" title="Important Note"> If you redefine <span class="cmtt-10">\gls</span>⟨<span class="cmti-10">internal cs name</span>⟩<span class="cmtt-10">page</span>, you must make sure that <span -class="cmtt-10">\c@page </span>is expanded -when it’s written to the file. (So don’t, for example, hide <span -class="cmtt-10">\c@page </span>inside a robust command.) -</div> -</p><!--l. 6231--><p class="noindent" > -</p><!--l. 6233--><p class="indent" > The mechanism that allows this to work temporarily redefines <span +class="cmtt-10">\c@page </span>is expanded when it’s written +to the file. (So don’t, for example, hide <span +class="cmtt-10">\c@page </span>inside a robust command.) </div> +</p><!--l. 7042--><p class="noindent" > +</p><!--l. 7044--><p class="indent" > The mechanism that allows this to work temporarily redefines <span class="cmtt-10">\the</span><a - id="dx1-51024"></a> and <span + id="dx1-129026"></a> and <span class="cmtt-10">\number</span><a - id="dx1-51025"></a> while it -processes the location. If this causes a problem you can disallow it using -</p><!--l. 6236--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glswrallowprimitivemodsfalse</span><span -class="cmtt-9"> </span></span><a - id="dx1-51026"></a> <span + id="dx1-129027"></a> while it processes the +location. If this causes a problem you can disallow it using +</p><!--l. 7047--><p class="indent" > <hr><div title="Definition"><a + id="dx1-129028"></a> <span class="cmtt-10">\glswrallowprimitivemodsfalse </span></div><hr> -</p><!--l. 6238--><p class="noindent" > +</p><!--l. 7049--><p class="noindent" > but you will need to find some other way to ensure the location expands correctly. -</p><!--l. 6242--><p class="noindent" > +</p><!--l. 7053--><p class="noindent" > </p> -<!--l. 6242--><p class="noindent" ><a +<!--l. 7053--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.3 </span> <a id="sec:ranges"></a>Range Formations</h3> -<!--l. 6245--><p class="noindent" >Both <a +<!--l. 7056--><p class="noindent" >Both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-52001"></a></a> and <a + id="dx1-130001"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-52002"></a></a> (Options <a + id="dx1-130002"></a></a> (Options <a href="#option2">2</a> and <a -href="#option3">3</a>) concatenate a sequence of 3 or more -consecutive pages into a range. With <span +href="#option3">3</a>) concatenate a sequence of 3 or more consecutive pages into a +range. With <span class="cmtt-10">xindy</span><a - id="dx1-52003"></a> (<a -href="#option3">Option 3</a>) you can vary the minimum sequence -length using <span + id="dx1-130003"></a> (<a +href="#option3">Option 3</a>) you can vary the minimum sequence length using <span class="cmtt-10">\GlsSetXdyMinRangeLength</span><a - id="dx1-52004"></a><span + id="dx1-130004"></a> +<span class="cmtt-10">{</span>⟨<span class="cmti-10">n</span>⟩<span class="cmtt-10">} </span>where ⟨<span -class="cmti-10">n</span>⟩ is either an integer or the keyword -<span -class="cmtt-10">none </span>which indicates that there should be no range formation (see <a -href="#sec:xindyloc"><span -class="tcrm-1000">§</span>11.2 </a><a -href="#sec:xindyloc">Locations and -Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details). -</p><!--l. 6253--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="cmti-10">n</span>⟩ is either an integer or the keyword <span +class="cmtt-10">none </span>which indicates that there should be no range formation +(see <a +href="#sec:xindyloc">§11.2 </a><a +href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a> for further details). +</p><!--l. 7064--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\GlsSetXdyMinRangeLength </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-52005"></a> and has -no effect if <span + id="dx1-130005"></a> and has no effect if <span class="cmtt-10">\noist</span><a - id="dx1-52006"></a> is used. </div> -</p><!--l. 6256--><p class="noindent" > -</p><!--l. 6258--><p class="indent" > With both <a + id="dx1-130006"></a> +is used. </div> +</p><!--l. 7067--><p class="noindent" > +</p><!--l. 7069--><p class="indent" > With both <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-52007"></a></a> and <a + id="dx1-130007"></a></a> and <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-52008"></a></a> (Options <a + id="dx1-130008"></a></a> (Options <a href="#option2">2</a> and <a -href="#option3">3</a>), you can replace the separator and -the closing number in the range using: -</p><!--l. 6260--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsSetSuffixF</span><span -class="cmtt-9"> </span></span><a - id="dx1-52009"></a> <span +href="#option3">3</a>), you can replace the separator and the closing number +in the range using: +</p><!--l. 7071--><p class="indent" > <hr><div title="Definition"><a + id="dx1-130009"></a> <span class="cmtt-10">\glsSetSuffixF{</span>⟨<span class="cmitt-10">suffix</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6262--><p class="noindent" > -</p><!--l. 6263--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsSetSuffixFF</span><span -class="cmtt-9"> </span></span><a - id="dx1-52010"></a> <span +</p><!--l. 7073--><p class="noindent" > +</p><!--l. 7074--><p class="indent" > <hr><div title="Definition"><a + id="dx1-130010"></a> <span class="cmtt-10">\glsSetSuffixFF{</span>⟨<span class="cmitt-10">suffix</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6265--><p class="noindent" > -where the former command specifies the suffix to use for a 2 page list and the latter specifies -the suffix to use for longer lists. For example: - - +</p><!--l. 7076--><p class="noindent" > +where the former command specifies the suffix to use for a 2 page list and the latter specifies the suffix to use for +longer lists. For example: + + </p> - <div class="verbatim" id="verbatim-197"> + <div class="verbatim" id="verbatim-193"> \glsSetSuffixF{f.}  <br />\glsSetSuffixFF{ff.} </div> -<!--l. 6272--><p class="nopar" > Note that if you use <a +<!--l. 7083--><p class="nopar" > Note that if you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-52011"></a></a> (<a -href="#option3">Option 3</a>), you will also need to set the minimum range length -to 1 if you want to change these suffixes: - - + id="dx1-130011"></a></a> (<a +href="#option3">Option 3</a>), you will also need to set the minimum range length to 1 if you want to +change these suffixes: + + </p> - <div class="verbatim" id="verbatim-198"> + <div class="verbatim" id="verbatim-194"> \GlsSetXdyMinRangeLength{1} </div> -<!--l. 6278--><p class="nopar" > Note that if you use the <span +<!--l. 7089--><p class="nopar" > Note that if you use the <span class="cmss-10">hyperref</span><a - id="dx1-52012"></a> package, you will need to use <span + id="dx1-130012"></a> package, you will need to use <span class="cmtt-10">\nohyperpage</span><a - id="dx1-52013"></a> in the suffix to -ensure that the hyperlinks work correctly. For example: - - + id="dx1-130013"></a> in the suffix to ensure that the +hyperlinks work correctly. For example: + + </p> - <div class="verbatim" id="verbatim-199"> + <div class="verbatim" id="verbatim-195"> \glsSetSuffixF{\nohyperpage{f.}}  <br />\glsSetSuffixFF{\nohyperpage{ff.}} </div> -<!--l. 6285--><p class="nopar" > -</p><!--l. 6287--><p class="indent" > <div class="important" title="Important Note"> Note that <span +<!--l. 7096--><p class="nopar" > +</p><!--l. 7098--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\glsSetSuffixF </span>and <span class="cmtt-10">\glsSetSuffixFF </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-52014"></a> -and have no effect if <span + id="dx1-130014"></a> and have no +effect if <span class="cmtt-10">\noist</span><a - id="dx1-52015"></a> is used. </div> -</p><!--l. 6291--><p class="noindent" > -</p><!--l. 6293--><p class="indent" > It’s also possible to concatenate a sequence of consecutive locations into a range or have -suffixes with <a + id="dx1-130015"></a> is used. </div> +</p><!--l. 7102--><p class="noindent" > +</p><!--l. 7104--><p class="indent" > It’s also possible to concatenate a sequence of consecutive locations into a range or have suffixes with +<a href="#option4">Option 4</a>, but with <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-52016"></a></a> these implicit ranges can’t be merged with -explicit ranges (created with the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">(</span></span></span> and <span class="obeylines-h"><span class="verb"><span + id="dx1-130016"></a></a> these implicit ranges can’t be merged with explicit ranges (created with the <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">(</span></span></span> and +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">)</span></span></span> encaps). See the <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-52017"></a></a> manual for further -details. -</p><!--l. 6299--><p class="indent" > <a -href="#option1">Option 1</a> doesn’t form ranges. However, with this option you can iterate over an entry’s -<a + id="dx1-130017"></a></a> manual for further details. +</p><!--l. 7110--><p class="indent" > <a +href="#option1">Option 1</a> doesn’t form ranges. However, with this option you can iterate over an entry’s <a href="#glo:numberlist">number list<a - id="dx1-52018"></a></a> using: -</p><!--l. 6301--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnumberlistloop</span><span -class="cmtt-9"> </span></span><a - id="dx1-52019"></a> <span + id="dx1-130018"></a></a> +using: +</p><!--l. 7112--><p class="indent" > <hr><div title="Definition"><a + id="dx1-130019"></a> <span class="cmtt-10">\glsnumberlistloop{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">handler cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">xr handler cs</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 6304--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 7115--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span -class="cmti-10">handler cs</span>⟩ is a handler control sequence of the -form: -</p><!--l. 6308--><p class="indent" > <hr><div title="Definition">⟨<span +class="cmti-10">handler cs</span>⟩ is a handler control sequence of the form: +</p><!--l. 7119--><p class="indent" > <hr><div title="Definition">⟨<span class="cmitt-10">handler cs</span>⟩<span class="cmtt-10">{</span>⟨<span class="cmitt-10">prefix</span>⟩<span @@ -12722,68 +14984,65 @@ class="cmitt-10">format</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6309--><p class="noindent" > +</p><!--l. 7120--><p class="noindent" > where ⟨<span class="cmti-10">prefix</span>⟩ is the <span class="cmss-10">hyperref</span><a - id="dx1-52020"></a> prefix, ⟨<span -class="cmti-10">counter</span>⟩ is the name of the counter used for the location, -⟨<span -class="cmti-10">format</span>⟩ is the format used to display the location (e.g. <span + id="dx1-130020"></a> prefix, ⟨<span +class="cmti-10">counter</span>⟩ is the name of the counter used for the location, ⟨<span +class="cmti-10">format</span>⟩ is the +format used to display the location (e.g. <span class="cmtt-10">textbf</span>) and ⟨<span -class="cmti-10">location</span>⟩ is the location. -The third argument is the control sequence to use for any cross-references in the list. This -handler should have the syntax: -</p><!--l. 6317--><p class="indent" > <hr><div title="Definition">⟨<span +class="cmti-10">location</span>⟩ is the location. The third argument +is the control sequence to use for any cross-references in the list. This handler should have the +syntax: +</p><!--l. 7128--><p class="indent" > <hr><div title="Definition">⟨<span class="cmitt-10">xr handler cs</span>⟩<span class="cmtt-10">[</span>⟨<span class="cmitt-10">tag</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">xr list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6318--><p class="noindent" > +</p><!--l. 7129--><p class="noindent" > where ⟨<span class="cmti-10">tag</span>⟩ is the cross-referenced text (e.g. “see”) and ⟨<span -class="cmti-10">xr list</span>⟩ is a comma-separated list of -labels. (This actually has a third argument but it’s always empty when used with -<a +class="cmti-10">xr list</span>⟩ is a comma-separated list of labels. (This actually +has a third argument but it’s always empty when used with <a href="#option1">Option 1</a>.) -</p><!--l. 6323--><p class="indent" > For example, if on page 12 I have used - - +</p><!--l. 7134--><p class="indent" > For example, if on page 12 I have used + + </p> - <div class="verbatim" id="verbatim-200"> + <div class="verbatim" id="verbatim-196"> \gls[format=textbf]{apple} </div> -<!--l. 6327--><p class="nopar" > and on page 18 I have used - - +<!--l. 7138--><p class="nopar" > and on page 18 I have used + + </p> - <div class="verbatim" id="verbatim-201"> + <div class="verbatim" id="verbatim-197"> \gls[format=emph]{apple} </div> -<!--l. 6331--><p class="nopar" > then - - +<!--l. 7142--><p class="nopar" > then + + </p> - <div class="verbatim" id="verbatim-202"> + <div class="verbatim" id="verbatim-198"> \glsnumberlistloop{apple}{\myhandler} </div> -<!--l. 6335--><p class="nopar" > will be equivalent to: - - +<!--l. 7146--><p class="nopar" > will be equivalent to: + + </p> - <div class="verbatim" id="verbatim-203"> + <div class="verbatim" id="verbatim-199"> \myhandler{}{page}{textbf}{12}%  <br />\myhandler{}{page}{emph}{18}% </div> -<!--l. 6340--><p class="nopar" > There is a predefined handler that’s used to display the <a +<!--l. 7151--><p class="nopar" > There is a predefined handler that’s used to display the <a href="#glo:numberlist">number list<a - id="dx1-52021"></a></a> in the glossary: -</p><!--l. 6343--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnoidxdisplayloc</span><span -class="cmtt-9"> </span></span><a - id="dx1-52022"></a> <span + id="dx1-130021"></a></a> in the glossary: +</p><!--l. 7154--><p class="indent" > <hr><div title="Definition"><a + id="dx1-130022"></a> <span class="cmtt-10">\glsnoidxdisplayloc{</span>⟨<span class="cmitt-10">prefix</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -12792,11 +15051,10 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">format</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 6345--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 7156--><p class="noindent" > The predefined handler used for the cross-references in the glossary is: -</p><!--l. 6348--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 7159--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsseeformat[</span>⟨<span class="cmitt-10">tag</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -12804,485 +15062,450 @@ class="cmitt-10">xr list</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6349--><p class="noindent" > +</p><!--l. 7160--><p class="noindent" > which is described in <a -href="#sec:customxr"><span -class="tcrm-1000">§</span>8.1 </a><a +href="#sec:customxr">§8.1 </a><a href="#sec:customxr">Customising Cross-reference Text<!--tex4ht:ref: sec:customxr --></a>. -</p><!--l. 6352--><p class="indent" > <div class="important" title="Important Note"> <span +</p><!--l. 7163--><p class="indent" > <div class="important" title="Important Note"> <span class="cmtt-10">\glsnumberlistloop </span>is not available for Options <a href="#option2">2</a> and <a href="#option3">3</a>. </div> -</p><!--l. 6354--><p class="noindent" > -</p><!--l. 6356--><p class="noindent" > +</p><!--l. 7165--><p class="noindent" > +</p><!--l. 7167--><p class="noindent" > </p> -<!--l. 6356--><p class="noindent" ><a +<!--l. 7167--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5.4 </span> <a id="sec:isthook"></a>Style Hook</h3> -<!--l. 6359--><p class="noindent" >As from version 4.24, there’s a hook that’s used near the end of <span +<!--l. 7170--><p class="noindent" >As from version 4.24, there’s a hook that’s used near the end of <span class="cmtt-10">\writeist</span><a - id="dx1-53001"></a> before the file is -closed. You can set the code to be performed then using: -</p><!--l. 6362--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetWriteIstHook</span><span -class="cmtt-9"> </span></span><a - id="dx1-53002"></a> <span + id="dx1-131001"></a> before the file is closed. You can set +the code to be performed then using: +</p><!--l. 7173--><p class="indent" > <hr><div title="Definition"><a + id="dx1-131002"></a> <span class="cmtt-10">\GlsSetWriteIstHook{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6364--><p class="noindent" > +</p><!--l. 7175--><p class="noindent" > If you want the ⟨<span class="cmti-10">code</span>⟩ to write any information to the file, you need to use -</p><!--l. 6367--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glswrite</span><span -class="cmtt-9"> </span></span><a - id="dx1-53003"></a> <span +</p><!--l. 7178--><p class="indent" > <hr><div title="Definition"><a + id="dx1-131003"></a> <span class="cmtt-10">\write\glswrite{</span>⟨<span class="cmitt-10">style information</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6369--><p class="noindent" > +</p><!--l. 7180--><p class="noindent" > Make sure you use the correct format within ⟨<span -class="cmti-10">style information</span>⟩. For example, if you are using -<span +class="cmti-10">style information</span>⟩. For example, if you are using <span class="cmtt-10">makeindex</span><a - id="dx1-53004"></a>: - - + id="dx1-131004"></a>: + + </p> - <div class="verbatim" id="verbatim-204"> + <div class="verbatim" id="verbatim-200"> \GlsSetWriteIstHook{%  <br /> \write\glswrite{page_precedence "arnAR"}%  <br /> \write\glswrite{line_max 80}%  <br />} </div> -<!--l. 6377--><p class="nopar" > This changes the page type precedence<a - id="dx1-53005"></a> and the maximum line length used by -<span +<!--l. 7188--><p class="nopar" > This changes the page type precedence<a + id="dx1-131005"></a> and the maximum line length used by <span class="cmtt-10">makeindex</span><a - id="dx1-53006"></a>. -</p><!--l. 6381--><p class="indent" > Remember that if you switch to <span + id="dx1-131006"></a>. +</p><!--l. 7192--><p class="indent" > Remember that if you switch to <span class="cmtt-10">xindy</span><a - id="dx1-53007"></a>, this will no longer be valid code. - - + id="dx1-131007"></a>, this will no longer be valid code. + + </p> -<!--l. 6384--><p class="indent" > </div> -</p><!--l. 6384--><p class="noindent" ><a +<!--l. 7195--><p class="indent" > </div> +</p><!--l. 7195--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">6. <a id="sec:glslink"></a>Links to Glossary Entries</h2> -</p><!--l. 6387--><p class="indent" > Once you have defined a glossary entry using <span +</p><!--l. 7198--><p class="indent" > Once you have defined a glossary entry using <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-54001"></a> (<a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining -Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>) or <span + id="dx1-132001"></a> (<a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>) or +<span class="cmtt-10">\newacronym</span><a - id="dx1-54002"></a> (see <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>), you -can refer to that entry in the document using one of the commands listed in <a -href="#sec:gls-like"><span -class="tcrm-1000">§</span>6.1 -</a><a + id="dx1-132002"></a> (see <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>), you can refer to that entry in the document using +one of the commands listed in <a +href="#sec:gls-like">§6.1 </a><a href="#sec:gls-like">The <span class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a> or <a -href="#sec:glstext-like"><span -class="tcrm-1000">§</span>6.2 </a><a +href="#sec:glstext-like">§6.2 </a><a href="#sec:glstext-like">The <span class="cmtt-10">\glstext</span>-Like -Commands (First Use Flag Not Queried)<!--tex4ht:ref: sec:glstext-like --></a>. The text which appears at that point in the -document when using one of these commands is referred to as the <a +Commands (First Use Flag Not Queried)<!--tex4ht:ref: sec:glstext-like --></a>. The text which appears at that point in the document when using +one of these commands is referred to as the <a href="#glo:linktext">link text<a - id="dx1-54003"></a></a> (even if -there are no hyperlinks). These commands also add a line to an external file that is -used to generate the relevant entry in the glossary. This information includes an -associated location that is added to the <a + id="dx1-132003"></a></a> (even if there are no hyperlinks). These commands also +add a line to an external file that is used to generate the relevant entry in the glossary. This information +includes an associated location that is added to the <a href="#glo:numberlist">number list<a - id="dx1-54004"></a></a> for that entry. By default, the -location refers to the page number. For further information on number lists, see <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 -</a><a -href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>. These external files need to be post-processed by <a + id="dx1-132004"></a></a> for that entry. By default, the location refers to +the page number. For further information on number lists, see <a +href="#sec:numberlists">§5 </a><a +href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>. These external files need to be +post-processed by <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-54005"></a></a> or <a + id="dx1-132005"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-54006"></a></a> -unless you have chosen Options <a + id="dx1-132006"></a></a> unless you have chosen Options <a href="#option1">1</a> or <a -href="#option4">4</a>. If you don’t use <span +href="#option4">4</a>. If you don’t use +<span class="cmtt-10">\makeglossaries</span><a - id="dx1-54007"></a> these -external files won’t be created. (Options <a + id="dx1-132007"></a> these external files won’t be created. (Options <a href="#option1">1</a> and <a href="#option4">4</a> write the information to the <span -class="cmtt-10">.aux</span><a - id="dx1-54008"></a> +class="cmtt-10">aux</span><a + id="dx1-132008"></a> file.) -</p><!--l. 6405--><p class="indent" > Note that repeated use of these commands for the same entry can cause the <a +</p><!--l. 7216--><p class="indent" > Note that repeated use of these commands for the same entry can cause the <a href="#glo:numberlist">number list<a - id="dx1-54009"></a></a> to -become quite long, which may not be particular helpful to the reader. In this case, -you can use the non-indexing commands described in <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a -href="#sec:glsnolink">Using Glossary Terms -Without Links<!--tex4ht:ref: sec:glsnolink --></a> or you can use the supplemental <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package, which -provides a means to suppress the automated indexing of the commands listed in this -chapter. -</p><!--l. 6413--><p class="indent" > <div class="important" title="Important Note"> I strongly recommend that you don’t use the commands defined in this chapter in the -arguments of sectioning or caption commands or any other command that has a moving -argument. -</p><!--l. 6418--><p class="indent" > Aside from problems with expansion issues, PDF bookmarks and possible nested -hyperlinks in the table of contents (or list of whatever) any use of the commands + id="dx1-132009"></a></a> to become quite +long, which may not be particular helpful to the reader. In this case, you can use the non-indexing commands described in <a -href="#sec:gls-like"><span -class="tcrm-1000">§</span>6.1 </a><a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> or you can use the supplemental <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +package, which provides a means to suppress the automated indexing of the commands listed in this +chapter. +</p><!--l. 7224--><p class="indent" > <div class="important" title="Important Note"> I strongly recommend that you don’t use the commands defined in this chapter in the arguments of +sectioning or caption commands or any other command that has a moving argument. +</p><!--l. 7229--><p class="indent" > Aside from problems with expansion issues, PDF bookmarks and possible nested hyperlinks in the table of +contents (or list of whatever) any use of the commands described in <a +href="#sec:gls-like">§6.1 </a><a href="#sec:gls-like">The <span -class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a> will have their -<a +class="cmtt-10">\gls</span>-Like Commands (First Use +Flag Queried)<!--tex4ht:ref: sec:gls-like --></a> will have their <a href="#glo:firstuseflag">first use flag</a> unset when they appear in the table of contents (or list of whatever). </div> -</p><!--l. 6423--><p class="noindent" > -</p><!--l. 6425--><p class="indent" > The above warning is particularly important if you are using the <span -class="cmss-10">glossaries </span>package in -conjunction with the <span +</p><!--l. 7234--><p class="noindent" > +</p><!--l. 7236--><p class="indent" > The above warning is particularly important if you are using the <span +class="cmss-10">glossaries </span>package in conjunction with the +<span class="cmss-10">hyperref</span><a - id="dx1-54010"></a> package. Instead, use one of the <span -class="cmti-10">expandable </span>commands listed in -<a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a -href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> (such as <span + id="dx1-132010"></a> package. Instead, use one of the <span +class="cmti-10">expandable </span>commands listed in <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> +(such as <span class="cmtt-10">\glsentrytext</span><a - id="dx1-54011"></a> <span -class="cmti-10">but not </span>the non-expandable -case changing versions like <span + id="dx1-132011"></a> <span +class="cmti-10">but not </span>the non-expandable case changing versions like <span class="cmtt-10">\Glsentrytext</span><a - id="dx1-54012"></a>). Alternatively, provide an alternative via the -optional argument to the sectioning/caption command or use <span + id="dx1-132012"></a>). Alternatively, +provide an alternative via the optional argument to the sectioning/caption command or use <span class="cmss-10">hyperref</span><a - id="dx1-54013"></a>’s <span + id="dx1-132013"></a>’s +<span class="cmtt-10">\texorpdfstring</span><a - id="dx1-54014"></a>. -Examples: - - + id="dx1-132014"></a>. Examples: + + </p> - <div class="verbatim" id="verbatim-205"> + <div class="verbatim" id="verbatim-201"> \chapter{An overview of \glsentrytext{perl}}  <br />\chapter[An overview of Perl]{An overview of \gls{perl}}  <br />\chapter{An overview of \texorpdfstring{\gls{perl}}{Perl}} </div> -<!--l. 6437--><p class="nopar" > If you want to retain the formatting that’s available through commands like <span -class="cmtt-10">\acrshort </span>(for -example, if you are using one of the small caps styles), then you might want to consider the -<a +<!--l. 7248--><p class="nopar" > If you want to retain the formatting that’s available through commands like <span +class="cmtt-10">\acrshort </span>(for example, if you are +using one of the small caps styles), then you might want to consider the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package which provides commands for this purpose. -</p><!--l. 6444--><p class="indent" > If you want the <a +class="cmss-10">glossaries-extra</span></a> package which provides +commands for this purpose. +</p><!--l. 7255--><p class="indent" > If you want the <a href="#glo:linktext">link text<a - id="dx1-54015"></a></a> to produce a hyperlink to the corresponding entry details in the -glossary, you should load the <span + id="dx1-132015"></a></a> to produce a hyperlink to the corresponding entry details in the glossary, you +should load the <span class="cmss-10">hyperref</span><a - id="dx1-54016"></a> package <span + id="dx1-132016"></a> package <span class="cmti-10">before </span>the <span -class="cmss-10">glossaries </span>package. That’s what I’ve -done in this document, so if you see a hyperlinked term, such as <a +class="cmss-10">glossaries </span>package. That’s what I’ve done in this document, so if you +see a hyperlinked term, such as <a href="#glo:linktext">link text<a - id="dx1-54017"></a></a>, you can click on -the word or phrase and it will take you to a brief description in this document’s -glossary. -</p><!--l. 6452--><p class="indent" > <div class="important" title="Important Note"> If you use the <span + id="dx1-132017"></a></a>, you can click on the word or phrase and it will take you to a brief +description in this document’s glossary. +</p><!--l. 7263--><p class="indent" > <div class="important" title="Important Note"> If you use the <span class="cmss-10">hyperref</span><a - id="dx1-54018"></a> package, I strongly recommend you use <span + id="dx1-132018"></a> package, I strongly recommend you use <span class="cmtt-10">pdflatex</span><a - id="dx1-54019"></a> rather than -<span + id="dx1-132019"></a> rather than <span class="cmtt-10">latex</span><a - id="dx1-54020"></a> to compile your document, if possible. The DVI format of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> has limitations with -the hyperlinks that can cause a problem when used with the <span -class="cmss-10">glossaries </span>package. Firstly, the -DVI format can’t break a hyperlink across a line whereas PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> can. This means that -long glossary entries (for example, the full form of an acronym) won’t be able to break across -a line with the DVI format. Secondly, the DVI format doesn’t correctly size hyperlinks in -subscripts or superscripts. This means that if you define a term that may be used as a -subscript or superscript, if you use the DVI format, it won’t come out the correct + id="dx1-132020"></a> to compile your +document, if possible. The DVI format of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> has limitations with the hyperlinks that can cause a problem +when used with the <span +class="cmss-10">glossaries </span>package. Firstly, the DVI format can’t break a hyperlink across a line +whereas PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> can. This means that long glossary entries (for example, the full form of an +acronym) won’t be able to break across a line with the DVI format. Secondly, the DVI format doesn’t +correctly size hyperlinks in subscripts or superscripts. This means that if you define a term that may +be used as a subscript or superscript, if you use the DVI format, it won’t come out the correct size. -</p><!--l. 6466--><p class="indent" > These are limitations of the DVI format not of the <span +</p><!--l. 7277--><p class="indent" > These are limitations of the DVI format not of the <span class="cmss-10">glossaries</span><a - id="dx1-54021"></a> package. </div> -</p><!--l. 6468--><p class="noindent" > -</p><!--l. 6470--><p class="indent" > It may be that you only want terms in certain glossaries to have hyperlinks, but not for -other glossaries. In this case, you can use the package option <span + id="dx1-132021"></a> package. </div> +</p><!--l. 7279--><p class="noindent" > +</p><!--l. 7281--><p class="indent" > It may be that you only want terms in certain glossaries to have hyperlinks, but not for other glossaries. In +this case, you can use the package option <span class="cmss-10">nohypertypes</span><a - id="dx1-54022"></a> to identify the -glossary lists that shouldn’t have hyperlinked <a + id="dx1-132022"></a> to identify the glossary lists that shouldn’t have +hyperlinked <a href="#glo:linktext">link text<a - id="dx1-54023"></a></a>. See <a -href="#sec:pkgopts-general"><span -class="tcrm-1000">§</span>2.1 </a><a -href="#sec:pkgopts-general">General Options<!--tex4ht:ref: sec:pkgopts-general --></a> for further -details. -</p><!--l. 6476--><p class="indent" > The way the <a + id="dx1-132023"></a></a>. See <a +href="#sec:pkgopts-general">§2.1 </a><a +href="#sec:pkgopts-general">General Options<!--tex4ht:ref: sec:pkgopts-general --></a> for further details. +</p><!--l. 7287--><p class="indent" > The way the <a href="#glo:linktext">link text<a - id="dx1-54024"></a></a> is displayed depends on -</p><!--l. 6477--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstextformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-54025"></a> <span + id="dx1-132024"></a></a> is displayed depends on +</p><!--l. 7288--><p class="indent" > <hr><div title="Definition"><a + id="dx1-132025"></a> <span class="cmtt-10">\glstextformat{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6479--><p class="noindent" > +</p><!--l. 7290--><p class="noindent" > For example, to make all <a href="#glo:linktext">link text<a - id="dx1-54026"></a></a> appear in a sans-serif font, do: - - + id="dx1-132026"></a></a> appear in a sans-serif font, do: + + </p> - <div class="verbatim" id="verbatim-206"> + <div class="verbatim" id="verbatim-202"> \renewcommand*{\glstextformat}[1]{\textsf{#1}} </div> -<!--l. 6484--><p class="nopar" > Further customisation can be done via <span +<!--l. 7295--><p class="nopar" > Further customisation can be done via <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-54027"></a> or by redefining <span + id="dx1-132027"></a> or by redefining <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-54028"></a>. See -<a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a> for further details. -</p><!--l. 6489--><p class="indent" > Each entry has an associated conditional referred to as the <a -href="#glo:firstuseflag">first use flag</a>. Some of the -commands described in this chapter automatically unset this flag and can also use it -to determine what text should be displayed. These types of commands are the -<a + id="dx1-132028"></a>. See <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the +format of the link text<!--tex4ht:ref: sec:glsdisplay --></a> for further details. +</p><!--l. 7300--><p class="indent" > Each entry has an associated conditional referred to as the <a +href="#glo:firstuseflag">first use flag</a>. Some of the commands described in +this chapter automatically unset this flag and can also use it to determine what text should be displayed. +These types of commands are the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> commands and are described in <a -href="#sec:gls-like"><span -class="tcrm-1000">§</span>6.1 </a><a +href="#sec:gls-like">§6.1 </a><a href="#sec:gls-like">The <span -class="cmtt-10">\gls</span>-Like Commands (First Use -Flag Queried)<!--tex4ht:ref: sec:gls-like --></a>. The commands that don’t reference or change the <a +class="cmtt-10">\gls</span>-Like +Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a>. The commands that don’t reference or change the <a href="#glo:firstuseflag">first use flag</a> are <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands and are described in <a -href="#sec:glstext-like"><span -class="tcrm-1000">§</span>6.2 </a><a +href="#sec:glstext-like">§6.2 </a><a href="#sec:glstext-like">The <span -class="cmtt-10">\glstext</span>-Like Commands (First Use -Flag Not Queried)<!--tex4ht:ref: sec:glstext-like --></a>. See <a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a -href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for commands that unset -(mark the entry as having been used) or reset (mark the entry as not used) the <a -href="#glo:firstuseflag">first use -flag</a> without referencing the entries. -</p><!--l. 6501--><p class="indent" > The <a +class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not +Queried)<!--tex4ht:ref: sec:glstext-like --></a>. See <a +href="#sec:glsunset">§14 </a><a +href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for commands that unset (mark the entry as +having been used) or reset (mark the entry as not used) the <a +href="#glo:firstuseflag">first use flag</a> without referencing the +entries. +</p><!--l. 7312--><p class="indent" > The <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> and <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands all take a first optional argument that is a -comma-separated list of ⟨<span +class="cmtt-10">\glstext</span>-like</a> commands all take a first optional argument that is a comma-separated +list of ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ options, described below. They also have a star-variant, -which inserts <span -class="cmtt-10">hyper=false </span>at the start of the list of options and a plus-variant, which -inserts <span -class="cmtt-10">hyper=true </span>at the start of the list of options. For example <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls*{sample}</span></span></span> -is the same as <span class="obeylines-h"><span class="verb"><span +class="cmti-10">value</span>⟩ options, described below. They also have a star-variant, which inserts <span +class="cmtt-10">hyper=false </span>at the +start of the list of options and a plus-variant, which inserts <span +class="cmtt-10">hyper=true </span>at the start of the list of options. For +example <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls*{sample}</span></span></span> is the same as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls[hyper=false]{sample}</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls+{sample}</span></span></span> is the same as <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls[hyper=true]{sample}</span></span></span>, whereas just <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{sample}</span></span></span> will use the default hyperlink -setting which depends on a number of factors (such as whether the entry is in a glossary that -has been identified in the <span +class="cmtt-10">\gls{sample}</span></span></span> will use the default hyperlink setting which depends +on a number of factors (such as whether the entry is in a glossary that has been identified in the +<span class="cmss-10">nohypertypes</span><a - id="dx1-54029"></a> list). You can override the <span -class="cmss-10">hyper</span><a - id="dx1-54030"></a> key in the variant’s -optional argument, for example, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls*[hyper=true]{sample}</span></span></span> but this creates redundancy -and is best avoided. The <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package provides the option to add a third custom -variant. -</p><!--l. 6518--><p class="indent" > <div class="important" title="Important Note"> Avoid nesting these commands. For example don’t do <span + id="dx1-132029"></a> list). You can override the <span +class="cmtt-10">hyper</span><a + id="dx1-132030"></a> key in the variant’s optional argument, for example, +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls*[hyper=true]{sample}</span></span></span> but this creates redundancy and is best avoided. The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package +provides the option to add a third custom variant. +</p><!--l. 7329--><p class="indent" > <div class="important" title="Important Note"> Avoid nesting these commands. For example don’t do <span class="cmtt-10">\glslink{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span><span class="cmsy-10">{</span><span -class="cmtt-10">\gls</span> -<span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">\gls{</span>⟨<span class="cmitt-10">label2</span>⟩<span class="cmtt-10">}</span><span -class="cmsy-10">} </span>as this is likely to cause problems. By implication, this means that -you should avoid using any of these commands within the <span -class="cmss-10">text</span><a - id="dx1-54031"></a>, <span -class="cmss-10">first</span><a - id="dx1-54032"></a>, <span -class="cmss-10">short</span><a - id="dx1-54033"></a> or <span -class="cmss-10">long</span><a - id="dx1-54034"></a> -keys (or their plural equivalent) or any other key that you plan to access through -these commands. (For example, the <span -class="cmss-10">symbol</span><a - id="dx1-54035"></a> key if you intend to use <span +class="cmsy-10">} </span>as this is likely to +cause problems. By implication, this means that you should avoid using any of these commands within the +<span +class="cmtt-10">text</span><a + id="dx1-132031"></a>, <span +class="cmtt-10">first</span><a + id="dx1-132032"></a>, <span +class="cmtt-10">short</span><a + id="dx1-132033"></a> or <span +class="cmtt-10">long</span><a + id="dx1-132034"></a> keys (or their plural equivalent) or any other key that you plan to +access through these commands. (For example, the <span +class="cmtt-10">symbol</span><a + id="dx1-132035"></a> key if you intend to use <span class="cmtt-10">\glssymbol</span>.) </div> -</p><!--l. 6528--><p class="noindent" > -</p><!--l. 6530--><p class="indent" > The keys listed below are available for the optional argument. The <a +</p><!--l. 7339--><p class="noindent" > +</p><!--l. 7341--><p class="indent" > The keys listed below are available for the optional argument. The <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package -provides additional keys. (See the <span +class="cmss-10">glossaries-extra</span></a> package provides +additional keys. (See the <span class="cmss-10">glossaries-extra </span>manual for further details.) </p><dl class="description"><dt class="description"> <span -class="cmssbx-10">hyper</span><a - id="dx1-54036"></a> </dt><dd -class="description">This is a boolean key which can be used to enable/disable the hyperlink - to the relevant entry in the glossary. If this key is omitted, the value is - determined by current settings, as indicated above. For example, when used with - a <a +class="cmtt-10">hyper</span><a + id="dx1-132036"></a> </dt><dd +class="description">This is a boolean key which can be used to enable/disable the hyperlink to the relevant entry in + the glossary. If this key is omitted, the value is determined by current settings, as indicated above. + For example, when used with a <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> command, if this is the first use and the <span -class="cmss-10">hyperfirst=false</span><a - id="dx1-54037"></a> package - option has been used, then the default value is <span -class="cmtt-10">hyper=false</span>. The hyperlink - can be forced on using <span -class="cmtt-10">hyper=true </span>unless the hyperlinks have been suppressed - using <span +class="cmtt-10">\gls</span>-like</a> command, if this is the first use and the <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-132037"></a> + package option has been used, then the default value is <span +class="cmtt-10">hyper=false</span>. The hyperlink can be forced + on using <span +class="cmtt-10">hyper=true </span>unless the hyperlinks have been suppressed using <span class="cmtt-10">\glsdisablehyper</span><a - id="dx1-54038"></a>. You must load the <span + id="dx1-132038"></a>. You + must load the <span class="cmss-10">hyperref</span><a - id="dx1-54039"></a> package before the <span + id="dx1-132039"></a> package before the <span class="cmss-10">glossaries</span><a - id="dx1-54040"></a> - package to ensure the hyperlinks work. - - + id="dx1-132040"></a> package to ensure the hyperlinks work. </dd><dt class="description"> <span -class="cmssbx-10">format</span><a - id="dx1-54041"></a> </dt><dd -class="description">This specifies how to format the associated location number for this entry in the - glossary. This value is equivalent to the <a +class="cmtt-10">format</span><a + id="dx1-132041"></a> </dt><dd +class="description">This specifies how to format the associated location number for this entry in the glossary. This value is + equivalent to the <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-54042"></a></a> encap value, and (as with - <span + id="dx1-132042"></a></a> encap value, and (as with <span class="cmtt-10">\index</span><a - id="dx1-54043"></a>) the value needs to be the name of a command <span -class="cmti-10">without </span>the initial - backslash. As with <span + id="dx1-132043"></a>) the value needs to be the name of a + command <span +class="cmti-10">without </span>the initial backslash. As with <span class="cmtt-10">\index</span><a - id="dx1-54044"></a>, the characters <span class="obeylines-h"><span class="verb"><span + id="dx1-132044"></a>, the characters <span class="obeylines-h"><span class="verb"><span class="cmtt-10">(</span></span></span> and <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">)</span></span></span> can also be used to specify the - beginning and ending of a number range and they must be in matching pairs. (For - example, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls[format={(}]{sample}</span></span></span> on one page to start the range and later +class="cmtt-10">)</span></span></span> can also be used to specify + the beginning and ending of a number range and they must be in matching pairs. (For example, + + <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls[format={)}]{sample}</span></span></span> to close the range.) Again as with <span +class="cmtt-10">\gls[format={(}]{sample}</span></span></span> on one page to start the range and later <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls[format={)}]{sample}</span></span></span> to + close the range.) Again as with <span class="cmtt-10">\index</span><a - id="dx1-54045"></a>, the command - should be the name of a command which takes an argument (which will be the - associated location). Be careful not to use a declaration (such as <span -class="cmtt-10">bfseries</span>) instead of a - text block command (such as <span -class="cmtt-10">textbf</span>) as the effect is not guaranteed to be - localised. If you want to apply more than one style to a given entry (e.g. <span -class="cmbx-10">bold</span> - and <span + id="dx1-132045"></a>, the command should be the name of a command + which takes an argument (which will be the associated location). Be careful not to use a + declaration (such as <span +class="cmtt-10">bfseries</span>) instead of a text block command (such as <span +class="cmtt-10">textbf</span>) as the + effect is not guaranteed to be localised. If you want to apply more than one style to a given + entry (e.g. <span +class="cmbx-10">bold </span>and <span class="cmti-10">italic</span>) you will need to create a command that applies both formats, e.g.  - - - <div class="verbatim" id="verbatim-207"> + + + <div class="verbatim" id="verbatim-203"> \newcommand*{\textbfem}[1]{\textbf{\emph{#1}}} </div> - <!--l. 6564--><p class="nopar" > and use that command. - </p><!--l. 6567--><p class="noindent" >In this document, the standard formats refer to the standard text block commands such - as <span + <!--l. 7375--><p class="nopar" > and use that command. + </p><!--l. 7378--><p class="noindent" >In this document, the standard formats refer to the standard text block commands such as <span class="cmtt-10">\textbf</span><a - id="dx1-54046"></a> or <span + id="dx1-132046"></a> or + <span class="cmtt-10">\emph</span><a - id="dx1-54047"></a> or any of the commands listed in <a -href="#tab:hyperxx">table 6.1</a>. You can combine - a range and format using <span class="obeylines-h"><span class="verb"><span + id="dx1-132047"></a> or any of the commands listed in <a +href="#tab:hyperxx">table 6.1</a>. You can combine a range and format using <span class="obeylines-h"><span class="verb"><span class="cmtt-10">(</span></span></span>⟨<span -class="cmti-10">format</span>⟩ to start the range and <span class="obeylines-h"><span class="verb"><span +class="cmti-10">format</span>⟩ to + start the range and <span class="obeylines-h"><span class="verb"><span class="cmtt-10">)</span></span></span>⟨<span -class="cmti-10">format</span>⟩ to end - the range. The ⟨<span -class="cmti-10">format</span>⟩ part must match. For example, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">format={(emph}</span></span></span> and +class="cmti-10">format</span>⟩ to end the range. The ⟨<span +class="cmti-10">format</span>⟩ part must match. For example, <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">format={(emph}</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="cmtt-10">format={)emph}</span></span></span>. - </p><!--l. 6574--><p class="noindent" ><div class="important" title="Important Note"> If you use <a + </p><!--l. 7385--><p class="noindent" ><div class="important" title="Important Note"> If you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-54048"></a></a> instead of <a + id="dx1-132048"></a></a> instead of <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-54049"></a></a>, you must specify any non-standard - formats that you want to use with the <span -class="cmss-10">format</span><a - id="dx1-54050"></a> key using <span + id="dx1-132049"></a></a>, you must specify any non-standard formats that you want to use + with the <span +class="cmtt-10">format</span><a + id="dx1-132050"></a> key using <span class="cmtt-10">\GlsAddXdyAttribute</span><a - id="dx1-54051"></a> - <span + id="dx1-132051"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">name</span>⟩<span class="cmtt-10">}</span>. So if you use <span class="cmtt-10">xindy</span><a - id="dx1-54052"></a> with the above example, you would need to - add: - - + id="dx1-132052"></a> with the above example, + you would need to add: + + </p> - <div class="verbatim" id="verbatim-208"> + <div class="verbatim" id="verbatim-204"> \GlsAddXdyAttribute{textbfem} </div> - <!--l. 6582--><p class="nopar" > See <a -href="#sec:xindy"><span -class="tcrm-1000">§</span>11 </a><a + <!--l. 7393--><p class="nopar" > See <a +href="#sec:xindy">§11 </a><a href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further details. </div> - </p><!--l. 6584--><p class="noindent" > - </p><!--l. 6586--><p class="noindent" >If you are using hyperlinks and you want to change the font of the hyperlinked location, - don’t use <span + </p><!--l. 7395--><p class="noindent" > + </p><!--l. 7397--><p class="noindent" >If you are using hyperlinks and you want to change the font of the hyperlinked location, don’t use + <span class="cmtt-10">\hyperpage</span><a - id="dx1-54053"></a> (provided by the <span + id="dx1-132053"></a> (provided by the <span class="cmss-10">hyperref</span><a - id="dx1-54054"></a> package) as the locations may not refer - to a page number. Instead, the <span -class="cmss-10">glossaries </span>package provides number formats listed in - <a -href="#tab:hyperxx">table 6.1</a>. + id="dx1-132054"></a> package) as the locations may not refer to a page number. Instead, + the <span +class="cmss-10">glossaries </span>package provides number formats listed in <a +href="#tab:hyperxx">table 6.1</a>. These commands are designed to work + with the particular location formats created by <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-132055"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-132056"></a></a> and shouldn’t be used in other + contexts. </p> <div class="table"> - <!--l. 6592--><p class="noindent" ><a + <!--l. 7406--><p class="noindent" ><a id="tab:hyperxx"></a></p><hr class="float" /><div class="float" > <div class="caption" ><span class="id">Table 6.1: </span><span -class="content">Predefined Hyperlinked Location Formats</span></div><!--tex4ht:label?: x1-540551 --> +class="content">Predefined Hyperlinked Location Formats</span></div><!--tex4ht:label?: x1-1320571 --> <div class="tabular"> <table id="TBL-6" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-6-1g"><col @@ -13291,223 +15514,291 @@ id="TBL-6-2" /></colgroup><tr style="vertical-align:baseline;" id="TBL-6-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-1" class="td11"> <span class="cmtt-10">hyperrm</span><a - id="dx1-54056"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-2" + id="dx1-132058"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-1-2" class="td11"> serif hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-1" class="td11"> <span class="cmtt-10">hypersf</span><a - id="dx1-54057"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-2" + id="dx1-132059"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-2-2" class="td11"> sans-serif hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-1" class="td11"> <span class="cmtt-10">hypertt</span><a - id="dx1-54058"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-2" + id="dx1-132060"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-3-2" class="td11"> monospaced hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-1" class="td11"> <span class="cmtt-10">hyperbf</span><a - id="dx1-54059"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-2" + id="dx1-132061"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-4-2" class="td11"> bold hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-1" class="td11"> <span class="cmtt-10">hypermd</span><a - id="dx1-54060"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-2" + id="dx1-132062"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-5-2" class="td11"> medium weight hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-1" class="td11"> <span class="cmtt-10">hyperit</span><a - id="dx1-54061"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-2" + id="dx1-132063"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-6-2" class="td11"> italic hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-1" class="td11"> <span class="cmtt-10">hypersl</span><a - id="dx1-54062"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-2" + id="dx1-132064"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-7-2" class="td11"> slanted hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-1" class="td11"> <span class="cmtt-10">hyperup</span><a - id="dx1-54063"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-2" + id="dx1-132065"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-8-2" class="td11"> upright hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-1" class="td11"> <span class="cmtt-10">hypersc</span><a - id="dx1-54064"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-2" + id="dx1-132066"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-9-2" class="td11"> small caps hyperlink </td> </tr><tr style="vertical-align:baseline;" id="TBL-6-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-6-10-1" class="td11"> <span class="cmtt-10">hyperemph</span><a - id="dx1-54065"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-10-2" + id="dx1-132067"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-6-10-2" class="td11"> emphasized hyperlink </td></tr></table> </div> </div><hr class="endfloat" /> </div> - <!--l. 6612--><p class="noindent" >Note that if the <span + <!--l. 7426--><p class="noindent" >Note that if the <span class="cmtt-10">\hyperlink</span><a - id="dx1-54066"></a> command hasn’t been defined, the <span + id="dx1-132068"></a> command hasn’t been defined, the <span class="cmtt-10">hyper</span>⟨<span -class="cmti-10">xx</span>⟩ formats are - equivalent to the analogous <span +class="cmti-10">xx</span>⟩ formats are equivalent to the + analogous <span class="cmtt-10">text</span>⟨<span class="cmti-10">xx</span>⟩ font commands (and <span -class="cmtt-10">hyperemph </span>is equivalent to - <span -class="cmtt-10">emph</span>). If you want to make a new format, you will need to define a command - which takes one argument and use that. For example, if you want the location - number to be in a bold sans-serif font, you can define a command called, say, +class="cmtt-10">hyperemph </span>is equivalent to <span +class="cmtt-10">emph</span>). If you want to make a new + format, you will need to define a command which takes one argument and use that. For example, if you + want the location number to be in a bold sans-serif font, you can define a command called, say, <span class="cmtt-10">\hyperbsf</span><a - id="dx1-54067"></a>: - - + id="dx1-132069"></a>: + + </p> - <div class="verbatim" id="verbatim-209"> + <div class="verbatim" id="verbatim-205"> \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} </div> - <!--l. 6622--><p class="nopar" > and then use <span + <!--l. 7436--><p class="nopar" > and then use <span class="cmtt-10">hyperbsf </span>as the value for the <span -class="cmss-10">format</span><a - id="dx1-54068"></a> +class="cmtt-10">format</span><a + id="dx1-132070"></a> key.<span class="footnote-mark"><a href="#fn1x6" id="fn1x6-bk"><sup class="textsuperscript">6.1</sup></a></span><a - id="x1-54069f1"></a> - Remember that if you use <a + id="x1-132071f1"></a> + </p><!--l. 7442--><p class="noindent" ><div class="important" title="Important Note"> When defining a custom location format command that uses one of the <span +class="cmtt-10">\hyper</span>⟨<span +class="cmitt-10">xx</span>⟩<a + id="dx1-132072"></a> commands, make sure + that the argument of <span +class="cmtt-10">\hyper</span>⟨<span +class="cmitt-10">xx</span>⟩<a + id="dx1-132073"></a> is just the location. Any formatting must be outside of <span +class="cmtt-10">\hyper</span>⟨<span +class="cmitt-10">xx</span>⟩<a + id="dx1-132074"></a> (as in + the above <span +class="cmtt-10">\hyperbfsf </span>example). </div> + </p><!--l. 7448--><p class="noindent" > + </p><!--l. 7450--><p class="noindent" >Remember that if you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-54070"></a></a>, you will need to add this to the list of location - attributes: - - + id="dx1-132075"></a></a>, you will need to add this to the list of location <a + id="dx1-132076"></a>attributes: + + </p> - <div class="verbatim" id="verbatim-210"> + <div class="verbatim" id="verbatim-206"> \GlsAddXdyAttribute{hyperbsf} </div> - <!--l. 6630--><p class="nopar" > + <!--l. 7454--><p class="nopar" > </p></dd><dt class="description"> <span -class="cmssbx-10">counter</span><a - id="dx1-54071"></a> </dt><dd -class="description">This specifies which counter to use for this location. This overrides the default - counter used by this entry. (See also <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a +class="cmtt-10">counter</span><a + id="dx1-132077"></a> </dt><dd +class="description">This specifies which counter to use for this location. This overrides the default counter used by this + entry. (See also <a +href="#sec:numberlists">§5 </a><a href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>.) </dd><dt class="description"> <span -class="cmssbx-10">local</span><a - id="dx1-54072"></a> </dt><dd +class="cmtt-10">local</span><a + id="dx1-132078"></a> </dt><dd class="description">This is a boolean key that only makes a difference when used with <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands - that change the entry’s <a +class="cmtt-10">\gls</span>-like</a> commands that change the + entry’s <a href="#glo:firstuseflag">first use flag</a>. If <span -class="cmtt-10">local=true</span>, the change to the first use flag will - be localised to the current scope. The default is <span +class="cmtt-10">local=true</span>, the change to the first use flag will be localised to the current scope. + The default is <span class="cmtt-10">local=false</span>. + </dd><dt class="description"> +<span id="textcolor262"><span id="textcolor263"><span +class="cmtt-10">noindex</span></span><a + id="dx1-132079"></a></span> </dt><dd +class="description">This is a boolean key that suppresses the indexing. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor264"><span id="textcolor265"><span +class="cmtt-10">hyperoutside</span></span><a + id="dx1-132080"></a></span> </dt><dd +class="description">This is a boolean key that determines whether to put the hyperlink outside of <span +class="cmtt-10">\glstextformat</span><a + id="dx1-132081"></a>. + Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor266"><span id="textcolor267"><span +class="cmtt-10">wrgloss</span></span><a + id="dx1-132082"></a></span> </dt><dd +class="description">This key determines whether to index before (<span +class="cmtt-10">wrgloss=before</span>) or after (<span +class="cmtt-10">wrgloss=after</span>) the <a +href="#glo:linktext">link + text<a + id="dx1-132083"></a></a>. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor268"><span id="textcolor269"><span +class="cmtt-10">textformat</span></span><a + id="dx1-132084"></a></span> </dt><dd +class="description">This key identifies the name of the control sequence to encapsulate the <a +href="#glo:linktext">link text<a + id="dx1-132085"></a></a> instead of the + default <span +class="cmtt-10">\glstextformat</span><a + id="dx1-132086"></a>. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor270"><span id="textcolor271"><span +class="cmtt-10">prefix</span></span><a + id="dx1-132087"></a></span> </dt><dd +class="description">This key locally redefines <span +class="cmtt-10">\glolinkprefix</span><a + id="dx1-132088"></a> to the given value. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor272"><span id="textcolor273"><span +class="cmtt-10">thevalue</span></span><a + id="dx1-132089"></a></span> </dt><dd +class="description">This key explicitly sets the location. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. + </dd><dt class="description"> +<span id="textcolor274"><span id="textcolor275"><span +class="cmtt-10">theHvalue</span></span><a + id="dx1-132090"></a></span> </dt><dd +class="description">This key explicitly sets the hyperlink location. Only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. </dd></dl> -<!--l. 6644--><p class="indent" > <div class="important" title="Important Note"> The <a +<!--l. 7497--><p class="indent" > <div class="important" title="Important Note"> The <a href="#glo:linktext">link text<a - id="dx1-54073"></a></a> isn’t scoped by default. Any unscoped declarations in the <a + id="dx1-132091"></a></a> isn’t scoped by default with just the base <span +class="cmss-10">glossaries </span>package. Any unscoped declarations in the +<a href="#glo:linktext">link text<a - id="dx1-54074"></a></a> may -affect subsequent text. </div> -</p><!--l. 6647--><p class="noindent" > + id="dx1-132092"></a></a> may affect subsequent text. </div> +</p><!--l. 7501--><p class="noindent" > </p> -<!--l. 6649--><p class="noindent" ><a + + +<!--l. 7503--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6.1 </span> <a id="sec:gls-like"></a>The <span class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</h3> -<!--l. 6652--><p class="noindent" >This section describes the commands that unset (mark as used) the <a -href="#glo:firstuseflag">first use flag</a> on -completion, and in most cases they use the current state of the flag to determine the text to -be displayed. As described above, these commands all have a star-variant (<span -class="cmtt-10">hyper=false</span>) and -a plus-variant (<span -class="cmtt-10">hyper=true</span>) and have an optional first argument that is a ⟨<span +<!--l. 7506--><p class="noindent" >This section describes the commands that unset (mark as used) the <a +href="#glo:firstuseflag">first use flag</a> on completion, and in most +cases they use the current state of the flag to determine the text to be displayed. As described above, these +commands all have a star-variant (<span +class="cmtt-10">hyper=false</span>) and a plus-variant (<span +class="cmtt-10">hyper=true</span>) and have an optional first +argument that is a ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ -list. -</p><!--l. 6659--><p class="indent" > These commands use <span +class="cmti-10">value</span>⟩ list. These commands use <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-55001"></a> or the equivalent definition provided by + id="dx1-133001"></a> or the equivalent definition provided by <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-55002"></a> to determine the automatically generated text and its format (see <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 -</a><a -href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). -</p><!--l. 6663--><p class="indent" > Apart from <span + id="dx1-133002"></a> to determine the automatically generated text and its format (see <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the format of +the link text<!--tex4ht:ref: sec:glsdisplay --></a>). +</p><!--l. 7516--><p class="indent" > Apart from <span class="cmtt-10">\glsdisp</span><a - id="dx1-55003"></a>, the commands described in this section also have a <span -class="cmti-10">final </span>optional -argument ⟨<span -class="cmti-10">insert</span>⟩ which may be used to insert material into the automatically generated -text. -</p><!--l. 6667--><p class="indent" > <div class="important" title="Important Note"> Since the commands have a final optional argument, take care if you actually want to -display an open square bracket after the command when the final optional argument is -absent. Insert an empty set of braces <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">{}</span></span></span> immediately before the opening square bracket to -prevent it from being interpreted as the final argument. For example: - - -</p> - <div class="verbatim" id="verbatim-211"> + id="dx1-133003"></a>, the commands described in this section also have a <span +class="cmti-10">final </span>optional argument ⟨<span +class="cmti-10">insert</span>⟩ +which may be used to insert material into the automatically generated text. +</p><!--l. 7520--><p class="indent" > <div class="important" title="Important Note"> Since the commands have a final optional argument, take care if you actually want to display an open +square bracket after the command when the final optional argument is absent. Insert an empty set of braces <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">{}</span></span></span> +immediately before the opening square bracket to prevent it from being interpreted as the final argument. For +example: + + +</p> + <div class="verbatim" id="verbatim-207"> \gls{sample} {}[Editor's comment] </div> -<!--l. 6676--><p class="nopar" > -</p><!--l. 6678--><p class="indent" > Don’t use any of the <a +<!--l. 7529--><p class="nopar" > +</p><!--l. 7531--><p class="indent" > Don’t use any of the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> or <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands in the ⟨<span -class="cmti-10">insert</span>⟩ argument. -</div> -</p><!--l. 6680--><p class="noindent" > -</p><!--l. 6682--><p class="indent" > Take care using these commands within commands or environments that are processed -multiple times as this can confuse the first use flag query and state change. This includes -frames with overlays in <span +class="cmti-10">insert</span>⟩ argument. </div> +</p><!--l. 7533--><p class="noindent" > +</p><!--l. 7535--><p class="indent" > Take care using these commands within commands or environments that are processed multiple times as this +can confuse the first use flag query and state change. This includes frames with overlays in <span class="cmss-10">beamer</span><a - id="dx1-55004"></a> and the <span + id="dx1-133004"></a> and the +<span class="cmss-10">tabularx </span>environment provided by <span class="cmss-10">tabularx</span><a - id="dx1-55005"></a>. The + id="dx1-133005"></a>. The <span +class="cmss-10">glossaries </span>package automatically deals with this issue in <span -class="cmss-10">glossaries </span>package automatically deals with this issue in <span class="cmss-10">amsmath</span><a - id="dx1-55006"></a>’s <span -class="cmss-10">align </span>environment. You can -apply a patch to <span + id="dx1-133006"></a>’s <span +class="cmss-10">align </span>environment. You can apply a patch to <span class="cmss-10">tabularx</span><a - id="dx1-55007"></a> by placing the following command (new to v4.28) in the -preamble: -</p><!--l. 6690--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspatchtabularx</span><span -class="cmtt-9"> </span></span><a - id="dx1-55008"></a> <span + id="dx1-133007"></a> by placing the following command (new to +v4.28) in the preamble: +</p><!--l. 7543--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133008"></a> <span class="cmtt-10">\glspatchtabularx </span></div><hr> -</p><!--l. 6692--><p class="noindent" > +</p><!--l. 7545--><p class="noindent" > This does nothing if <span class="cmss-10">tabularx</span><a - id="dx1-55009"></a> hasn’t been loaded. There’s no patch available for <span + id="dx1-133009"></a> hasn’t been loaded. There’s no patch available for <span class="cmss-10">beamer</span><a - id="dx1-55010"></a>. See -<a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a -href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for more details. -</p><!--l. 6697--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\gls</span><span -class="cmtt-9"> </span></span><a - id="dx1-55011"></a> <span + id="dx1-133010"></a>. See <a +href="#sec:glsunset">§14 </a><a +href="#sec:glsunset">Unsetting and +Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a> for more details. +</p><!--l. 7550--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133011"></a> <span class="cmtt-10">\gls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13515,33 +15806,31 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6699--><p class="noindent" > +</p><!--l. 7552--><p class="noindent" > This command typically determines the <a href="#glo:linktext">link text<a - id="dx1-55012"></a></a> from the values of the <span -class="cmss-10">text</span><a - id="dx1-55013"></a> or <span -class="cmss-10">first</span><a - id="dx1-55014"></a> keys -supplied when the entry was defined using <span + id="dx1-133012"></a></a> from the values of the <span +class="cmtt-10">text</span><a + id="dx1-133013"></a> or <span +class="cmtt-10">first</span><a + id="dx1-133014"></a> keys supplied when the +entry was defined using <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-55015"></a>. However, if the entry was -defined using <span + id="dx1-133015"></a>. However, if the entry was defined using <span class="cmtt-10">\newacronym</span><a - id="dx1-55016"></a> and <span + id="dx1-133016"></a> and +<span class="cmtt-10">\setacronymstyle</span><a - id="dx1-55017"></a> was used, then the link text<a - id="dx1-55018"></a> will usually -be determined from the <span -class="cmss-10">long</span><a - id="dx1-55019"></a> or <span -class="cmss-10">short</span><a - id="dx1-55020"></a> keys. -</p><!--l. 6707--><p class="indent" > There are two upper case variants: -</p><!--l. 6708--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Gls</span><span -class="cmtt-9"> </span></span><a - id="dx1-55021"></a> <span + id="dx1-133017"></a> was used, then the link text<a + id="dx1-133018"></a> will usually be determined from the <span +class="cmtt-10">long</span><a + id="dx1-133019"></a> or <span +class="cmtt-10">short</span><a + id="dx1-133020"></a> +keys. +</p><!--l. 7560--><p class="indent" > There are two upper case variants: +</p><!--l. 7561--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133021"></a> <span class="cmtt-10">\Gls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13549,12 +15838,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6710--><p class="noindent" > +</p><!--l. 7563--><p class="noindent" > and -</p><!--l. 6712--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLS</span><span -class="cmtt-9"> </span></span><a - id="dx1-55022"></a> <span +</p><!--l. 7565--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133022"></a> <span class="cmtt-10">\GLS[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13562,169 +15849,165 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6714--><p class="noindent" > -which make the first letter of the link text or all the link text upper case, respectively. For the -former, the uppercasing of the first letter is performed by <span +</p><!--l. 7567--><p class="noindent" > +which make the first letter of the link text or all the link text upper case, respectively. For the former, the +uppercasing of the first letter is performed by <span class="cmtt-10">\makefirstuc</span><a - id="dx1-55023"></a>. -</p><!--l. 6719--><p class="indent" > <div class="important" title="Important Note"> The first letter uppercasing command <span -class="cmtt-10">\makefirstuc </span>has limitations which must be taken -into account if you use <span -class="cmtt-10">\Gls </span>or any of the other commands that convert the first letter to -uppercase. </div> -</p><!--l. 6724--><p class="noindent" > + id="dx1-133023"></a>. +</p><!--l. 7572--><p class="indent" > <div class="important" title="Important Note"> The first letter uppercasing command <span +class="cmtt-10">\makefirstuc </span>has limitations which must be taken into +account if you use <span +class="cmtt-10">\Gls </span>or any of the other commands that convert the first letter to uppercase. +</div> +</p><!--l. 7577--><p class="noindent" > The upper casing is performed as follows: </p> <ul class="itemize1"> <li class="itemize">If the first thing in the <a href="#glo:linktext">link text<a - id="dx1-55024"></a></a> is a command follow by a group, the upper casing is - performed on the first object of the group. For example, if an entry has been defined - as - - - <div class="verbatim" id="verbatim-212"> + id="dx1-133024"></a></a> is a command follow by a group, the upper casing is performed on the + first object of the group. For example, if an entry has been defined as + + + <div class="verbatim" id="verbatim-208"> \newglossaryentry{sample}{  <br /> name={\emph{sample} phrase},  <br /> sort={sample phrase},  <br /> description={an example}} </div> - <!--l. 6735--><p class="nopar" > Then <span + <!--l. 7588--><p class="nopar" > Then <span class="cmtt-10">\Gls</span><span class="obeylines-h"><span class="verb"><span class="cmtt-10">{sample}</span></span></span> will set the <a href="#glo:linktext">link text<a - id="dx1-55025"></a></a> - to<span class="footnote-mark"><a + id="dx1-133025"></a></a> to<span class="footnote-mark"><a href="#fn2x6" id="fn2x6-bk"><sup class="textsuperscript">6.2</sup></a></span><a - id="x1-55026f2"></a> - - + id="x1-133026f2"></a> + + </p> - <div class="verbatim" id="verbatim-213"> + <div class="verbatim" id="verbatim-209"> \emph{\MakeUppercase sample} phrase </div> - <!--l. 6741--><p class="nopar" > which will appear as <span + <!--l. 7594--><p class="nopar" > which will appear as <span class="cmti-10">Sample </span>phrase. </p></li> <li class="itemize">If the first thing in the <a href="#glo:linktext">link text<a - id="dx1-55027"></a></a> isn’t a command or is a command but isn’t followed by - a group, then the upper casing will be performed on that first thing. For example, if an - entry has been defined as: - - - <div class="verbatim" id="verbatim-214"> + id="dx1-133027"></a></a> isn’t a command or is a command but isn’t followed by a group, then the + upper casing will be performed on that first thing. For example, if an entry has been defined + as: + + + <div class="verbatim" id="verbatim-210"> \newglossaryentry{sample}{  <br />  name={\oe-ligature},  <br />  sort={oe-ligature},  <br />  description={an example}  <br />} </div> - <!--l. 6754--><p class="nopar" > Then <span + <!--l. 7607--><p class="nopar" > Then <span class="cmtt-10">\Gls</span><span class="obeylines-h"><span class="verb"><span class="cmtt-10">{sample}</span></span></span> will set the <a href="#glo:linktext">link text<a - id="dx1-55028"></a></a> to - - + id="dx1-133028"></a></a> to + + </p> - <div class="verbatim" id="verbatim-215"> + <div class="verbatim" id="verbatim-211"> \MakeUppercase \oe-ligature </div> - <!--l. 6758--><p class="nopar" > which will appear as Œ-ligature. + <!--l. 7611--><p class="nopar" > which will appear as Œ-ligature. </p></li> <li class="itemize">If you have <span class="cmss-10">mfirstuc</span><a - id="dx1-55029"></a> v2.01 or above, an extra case is added. If the first thing is <span -class="cmtt-10">\protect</span> - it will be discarded and the above rules will then be tried. + id="dx1-133029"></a> v2.01 or above, an extra case is added. If the first thing is <span +class="cmtt-10">\protect </span>it will be + discarded and the above rules will then be tried. </li></ul> -<!--l. 6766--><p class="noindent" >(Note the use of the <span -class="cmss-10">sort</span><a - id="dx1-55030"></a> key in the above examples.) -</p><!--l. 6768--><p class="indent" > There are hundreds of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> packages that altogether define thousands of commands -with various syntax and it’s impossible for <span +<!--l. 7619--><p class="noindent" >(Note the use of the <span +class="cmtt-10">sort</span><a + id="dx1-133030"></a> key in the above examples.) +</p><!--l. 7621--><p class="indent" > There are hundreds of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> packages that altogether define thousands of commands with +various syntax and it’s impossible for <span class="cmss-10">mfirstuc</span><a - id="dx1-55031"></a> to take them all into account. The above -rules are quite simplistic and are designed for <a + id="dx1-133031"></a> to take them all into account. The above rules are +quite simplistic and are designed for <a href="#glo:linktext">link text<a - id="dx1-55032"></a></a> that starts with a text-block -command (such as <span + id="dx1-133032"></a></a> that starts with a text-block command (such as +<span class="cmtt-10">\emph</span>) or a command that produces a character (such as <span -class="cmtt-10">\oe</span>). This means -that if your <a +class="cmtt-10">\oe</span>). This means that if your <a href="#glo:linktext">link text<a - id="dx1-55033"></a></a> starts with something that doesn’t adhere to <span + id="dx1-133033"></a></a> +starts with something that doesn’t adhere to <span class="cmss-10">mfirstuc</span><a - id="dx1-55034"></a>’s assumptions then -things are likely to go wrong. -</p><!--l. 6777--><p class="indent" > For example, starting with a math-shift symbol: - - + id="dx1-133034"></a>’s assumptions then things are likely to go +wrong. +</p><!--l. 7630--><p class="indent" > For example, starting with a math-shift symbol: + + </p> - <div class="verbatim" id="verbatim-216"> + <div class="verbatim" id="verbatim-212"> \newglossaryentry{sample}{  <br />  name={$a$},  <br />  sort={a},  <br />  description={an example}  <br />} </div> -<!--l. 6784--><p class="nopar" > This falls into case 2 above, so the <a +<!--l. 7637--><p class="nopar" > This falls into case 2 above, so the <a href="#glo:linktext">link text<a - id="dx1-55035"></a></a> will be set to - - + id="dx1-133035"></a></a> will be set to + + </p> - <div class="verbatim" id="verbatim-217"> + <div class="verbatim" id="verbatim-213"> \MakeUppercase $a$ </div> -<!--l. 6788--><p class="nopar" > This attempts to uppercase the math-shift <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">$</span></span></span>, which will go wrong. In this case it’s not -appropriate to perform any case-changing, but it may be that you want to use <span -class="cmtt-10">\Gls</span> -programmatically without checking if the text contains any maths. In this case, the simplest -solution is to insert an empty brace at the start: - - +<!--l. 7641--><p class="nopar" > This attempts to uppercase the math-shift <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">$</span></span></span>, which will go wrong. In this case it’s not appropriate to perform +any case-changing, but it may be that you want to use <span +class="cmtt-10">\Gls </span>programmatically without checking if +the text contains any maths. In this case, the simplest solution is to insert an empty brace at the +start: + + </p> - <div class="verbatim" id="verbatim-218"> + <div class="verbatim" id="verbatim-214"> \newglossaryentry{sample}{  <br />  name={{}$a$},  <br />  sort={a},  <br />  description={an example}  <br />} </div> -<!--l. 6801--><p class="nopar" > Now the <a +<!--l. 7654--><p class="nopar" > Now the <a href="#glo:linktext">link text<a - id="dx1-55036"></a></a> will be set to - - + id="dx1-133036"></a></a> will be set to + + </p> - <div class="verbatim" id="verbatim-219"> + <div class="verbatim" id="verbatim-215"> \MakeUppercase{}$a$ </div> -<!--l. 6805--><p class="nopar" > and the <span +<!--l. 7658--><p class="nopar" > and the <span class="cmtt-10">\uppercase </span>becomes harmless. -</p><!--l. 6808--><p class="indent" > Another issue occurs when the <a +</p><!--l. 7661--><p class="indent" > Another issue occurs when the <a href="#glo:linktext">link text<a - id="dx1-55037"></a></a> starts with a command followed by an argument -(case 1) but the argument is a label, identifier or something else that shouldn’t have a -case-change. A common example is when the <a + id="dx1-133037"></a></a> starts with a command followed by an argument (case 1) but the +argument is a label, identifier or something else that shouldn’t have a case-change. A common example is when +the <a href="#glo:linktext">link text<a - id="dx1-55038"></a></a> starts with one of the commands -described in this chapter. (But you haven’t done that, have you? What with the warning not -to do it at the beginning of the chapter.) Or when the <a + id="dx1-133038"></a></a> starts with one of the commands described in this chapter. (But you haven’t done that, have you? +What with the warning not to do it at the beginning of the chapter.) Or when the <a href="#glo:linktext">link text<a - id="dx1-55039"></a></a> starts with one of the -non-linking commands described in <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a + id="dx1-133039"></a></a> starts +with one of the non-linking commands described in <a +href="#sec:glsnolink">§9 </a><a href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>. For example: - - + + </p> - <div class="verbatim" id="verbatim-220"> + <div class="verbatim" id="verbatim-216"> \newglossaryentry{sample}{name={sample},description={an example}}  <br />\newglossaryentry{sample2}{  <br />   name={\glsentrytext{sample} two}, @@ -13732,33 +16015,31 @@ example:  <br />   description={another example}  <br /> } </div> -<!--l. 6823--><p class="nopar" > Now the <a +<!--l. 7676--><p class="nopar" > Now the <a href="#glo:linktext">link text<a - id="dx1-55040"></a></a> will be set to: - - + id="dx1-133040"></a></a> will be set to: + + </p> - <div class="verbatim" id="verbatim-221"> + <div class="verbatim" id="verbatim-217"> \glsentrytext{\MakeUppercase sample} two </div> -<!--l. 6827--><p class="nopar" > This will generate an error because there’s no entry with the label given by -<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\MakeUppercase</span><span -class="cmtt-10"> sample</span></span></span>. The best solution here is to write the term out in the <span -class="cmss-10">text</span><a - id="dx1-55041"></a> field and -use the command in the <span -class="cmss-10">name</span><a - id="dx1-55042"></a> field. If you don’t use <span -class="cmtt-10">\glsname </span>anywhere in your document, -you can use <span +<!--l. 7680--><p class="nopar" > This will generate an error because there’s no entry with the label “<span +class="cmtt-10">\MakeUppercase sample</span>”. The best +solution here is to write the term out in the <span +class="cmtt-10">text</span><a + id="dx1-133041"></a> field and use the command in the <span +class="cmtt-10">name</span><a + id="dx1-133042"></a> field. If you don’t use +<span +class="cmtt-10">\glsname </span>anywhere in your document, you can use <span class="cmtt-10">\gls </span>in the <span -class="cmss-10">name</span><a - id="dx1-55043"></a> field: - - +class="cmtt-10">name</span><a + id="dx1-133043"></a> field: + + </p> - <div class="verbatim" id="verbatim-222"> + <div class="verbatim" id="verbatim-218"> \newglossaryentry{sample}{name={sample},description={an example}}  <br />\newglossaryentry{sample2}{  <br />   name={\gls{sample} two}, @@ -13767,68 +16048,64 @@ class="cmss-10">name</span><a  <br />   description={another example}  <br /> } </div> -<!--l. 6841--><p class="nopar" > -</p><!--l. 6843--><p class="indent" > If the <a +<!--l. 7694--><p class="nopar" > +</p><!--l. 7696--><p class="indent" > If the <a href="#glo:linktext">link text<a - id="dx1-55044"></a></a> starts with a command that has an optional argument or with multiple -arguments where the actual text isn’t in the first argument, then <span -class="cmtt-10">\makefirstuc </span>will also fail. -For example: - - + id="dx1-133044"></a></a> starts with a command that has an optional argument or with multiple arguments where the +actual text isn’t in the first argument, then <span +class="cmtt-10">\makefirstuc </span>will also fail. For example: + + </p> - <div class="verbatim" id="verbatim-223"> + <div class="verbatim" id="verbatim-219"> \newglossaryentry{sample}{  <br /> name={\textcolor{blue}{sample} phrase},  <br /> sort={sample phrase},  <br /> description={an example}} </div> -<!--l. 6852--><p class="nopar" > Now the <a +<!--l. 7705--><p class="nopar" > Now the <a href="#glo:linktext">link text<a - id="dx1-55045"></a></a> will be set to: - - + id="dx1-133045"></a></a> will be set to: + + </p> - <div class="verbatim" id="verbatim-224"> + <div class="verbatim" id="verbatim-220"> \textcolor{\MakeUppercase blue}{sample} phrase </div> -<!--l. 6856--><p class="nopar" > This won’t work because <span class="obeylines-h"><span class="verb"><span +<!--l. 7709--><p class="nopar" > This won’t work because <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\MakeUppercase</span><span -class="cmtt-10"> blue</span></span></span> isn’t a recognised colour name. In this case -you will have to define a helper command where the first argument is the text. For -example: - - +class="cmtt-10"> blue</span></span></span> isn’t a recognised colour name. In this case you will have to +define a helper command where the first argument is the text. For example: + + </p> - <div class="verbatim" id="verbatim-225"> + <div class="verbatim" id="verbatim-221"> \newglossaryentry{sample}{  <br />\newcommand*{\blue}[1]{\textcolor{blue}{#1}}  <br /> name={\blue{sample} phrase},  <br /> sort={sample phrase},  <br /> description={an example}} </div> -<!--l. 6866--><p class="nopar" > In fact, since the whole design ethos of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is the separation of content and style, it’s -better to use a semantic command. For example: - - +<!--l. 7719--><p class="nopar" > In fact, since the whole design ethos of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is the separation of content and style, it’s better to use a +semantic command. For example: + + </p> - <div class="verbatim" id="verbatim-226"> + <div class="verbatim" id="verbatim-222"> \newglossaryentry{sample}{  <br />\newcommand*{\keyword}[1]{\textcolor{blue}{#1}}  <br /> name={\keyword{sample} phrase},  <br /> sort={sample phrase},  <br /> description={an example}} </div> -<!--l. 6876--><p class="nopar" > For further details see the <span +<!--l. 7729--><p class="nopar" > For further details see the <span class="cmss-10">mfirstuc</span><a - id="dx1-55046"></a> user manual. -</p><!--l. 6879--><p class="indent" > There are plural forms that are analogous to <span + id="dx1-133046"></a> user manual. +</p><!--l. 7732--><p class="indent" > There are plural forms that are analogous to <span class="cmtt-10">\gls</span>: -</p><!--l. 6880--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-55047"></a> <span +</p><!--l. 7733--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133047"></a> <span class="cmtt-10">\glspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13836,11 +16113,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6882--><p class="noindent" > -</p><!--l. 6883--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-55048"></a> <span +</p><!--l. 7735--><p class="noindent" > +</p><!--l. 7736--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133048"></a> <span class="cmtt-10">\Glspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13848,11 +16123,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6885--><p class="noindent" > -</p><!--l. 6886--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-55049"></a> <span +</p><!--l. 7738--><p class="noindent" > +</p><!--l. 7739--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133049"></a> <span class="cmtt-10">\GLSpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13860,61 +16133,59 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6888--><p class="noindent" > +</p><!--l. 7741--><p class="noindent" > These typically determine the link text from the <span -class="cmss-10">plural</span><a - id="dx1-55050"></a> or <span -class="cmss-10">firstplural</span><a - id="dx1-55051"></a> keys supplied when the -entry was defined using <span +class="cmtt-10">plural</span><a + id="dx1-133050"></a> or <span +class="cmtt-10">firstplural</span><a + id="dx1-133051"></a> keys supplied when the entry was +defined using <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-55052"></a> or, if the entry is an abbreviation and -<span -class="cmtt-10">\setacronymstyle </span>was used, from the <span -class="cmss-10">longplural</span><a - id="dx1-55053"></a> or <span -class="cmss-10">shortplural</span><a - id="dx1-55054"></a> keys. -</p><!--l. 6895--><p class="indent" > <div class="important" title="Important Note"> Be careful when you use glossary entries in math mode especially if you are using <span + id="dx1-133052"></a> or, if the entry is an abbreviation and <span +class="cmtt-10">\setacronymstyle </span>was used, from the +<span +class="cmtt-10">longplural</span><a + id="dx1-133053"></a> or <span +class="cmtt-10">shortplural</span><a + id="dx1-133054"></a> keys. +</p><!--l. 7748--><p class="indent" > <div class="important" title="Important Note"> Be careful when you use glossary entries in math mode especially if you are using <span class="cmss-10">hyperref</span><a - id="dx1-55055"></a> -as it can affect the spacing of subscripts and superscripts. For example, suppose you have -defined the following entry: - - + id="dx1-133055"></a> as it can affect +the spacing of subscripts and superscripts. For example, suppose you have defined the following +entry: + + </p> - <div class="verbatim" id="verbatim-227"> + <div class="verbatim" id="verbatim-223"> \newglossaryentry{Falpha}{name={F_\alpha},  <br />description=sample} </div> -<!--l. 6903--><p class="nopar" > and later you use it in math mode: - - +<!--l. 7756--><p class="nopar" > and later you use it in math mode: + + </p> - <div class="verbatim" id="verbatim-228"> + <div class="verbatim" id="verbatim-224"> $\gls{Falpha}^2$ </div> -<!--l. 6907--><p class="nopar" > This will result in <span +<!--l. 7760--><p class="nopar" > This will result in <span class="cmmi-10">F</span><sub><span class="cmmi-7">α</span></sub><sup><span class="cmr-7">2</span></sup> instead of <span class="cmmi-10">F</span><sub><span class="cmmi-7">α</span></sub><sup><span -class="cmr-7">2</span></sup>. In this situation it’s best to bring the superscript into -the hyperlink using the final ⟨<span +class="cmr-7">2</span></sup>. In this situation it’s best to bring the superscript into the hyperlink +using the final ⟨<span class="cmti-10">insert</span>⟩ optional argument: - - + + </p> - <div class="verbatim" id="verbatim-229"> + <div class="verbatim" id="verbatim-225"> $\gls{Falpha}[^2]$ </div> -<!--l. 6913--><p class="nopar" > </div> -</p><!--l. 6914--><p class="noindent" > -</p><!--l. 6916--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdisp</span><span -class="cmtt-9"> </span></span><a - id="dx1-55056"></a> <span +<!--l. 7766--><p class="nopar" > </div> +</p><!--l. 7767--><p class="noindent" > +</p><!--l. 7769--><p class="indent" > <hr><div title="Definition"><a + id="dx1-133056"></a> <span class="cmtt-10">\glsdisp[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13922,65 +16193,56 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">link text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6918--><p class="noindent" > +</p><!--l. 7771--><p class="noindent" > This behaves in the same way as the above commands, except that the ⟨<span -class="cmti-10">link text</span>⟩ is explicitly -set. There’s no final optional argument as any inserted material can be added to the ⟨<span -class="cmti-10">link text</span>⟩ -argument. -</p><!--l. 6924--><p class="indent" > <div class="important" title="Important Note"> Don’t use any of the <a +class="cmti-10">link text</span>⟩ is explicitly set. There’s no final +optional argument as any inserted material can be added to the ⟨<span +class="cmti-10">link text</span>⟩ argument. +</p><!--l. 7777--><p class="indent" > <div class="important" title="Important Note"> Don’t use any of the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> or <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands in the ⟨<span -class="cmti-10">link text</span>⟩ argument of -<span -class="cmtt-10">\glsdisp</span>. </div> -</p><!--l. 6927--><p class="noindent" > -</p><!--l. 6929--><p class="noindent" > +class="cmti-10">link text</span>⟩ argument of <span +class="cmtt-10">\glsdisp</span>. +</div> +</p><!--l. 7780--><p class="noindent" > +</p><!--l. 7782--><p class="noindent" > </p> -<!--l. 6929--><p class="noindent" ><a +<!--l. 7782--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6.2 </span> <a id="sec:glstext-like"></a>The <span class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)</h3> -<!--l. 6932--><p class="noindent" >This section describes the commands that don’t change or reference the <a -href="#glo:firstuseflag">first use flag</a>. -As described above, these commands all have a star-variant (<span -class="cmtt-10">hyper=false</span>) and a -plus-variant (<span -class="cmtt-10">hyper=true</span>) and have an optional first argument that is a ⟨<span +<!--l. 7785--><p class="noindent" >This section describes the commands that don’t change or reference the <a +href="#glo:firstuseflag">first use flag</a>. As described above, these +commands all have a star-variant (<span +class="cmtt-10">hyper=false</span>) and a plus-variant (<span +class="cmtt-10">hyper=true</span>) and have an optional first +argument that is a ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ -list. These commands also don’t use <span +class="cmti-10">value</span>⟩ list. These commands also don’t use <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-56001"></a> or the equivalent definition + id="dx1-134001"></a> or the equivalent definition provided by <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-56002"></a> (see <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). -Additional commands for abbreviations are described in <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 </a><a -href="#sec:acronyms">Acronyms and Other -Abbreviations<!--tex4ht:ref: sec:acronyms --></a>. -</p><!--l. 6942--><p class="indent" > Apart from <span + id="dx1-134002"></a> (see <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>). Additional commands for +abbreviations are described in <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>. +</p><!--l. 7795--><p class="indent" > Apart from <span class="cmtt-10">\glslink</span><a - id="dx1-56003"></a>, the commands described in this section also have a <span -class="cmti-10">final</span> -optional argument ⟨<span -class="cmti-10">insert</span>⟩ which may be used to insert material into the automatically -generated text. See the caveat above in <a -href="#sec:gls-like"><span -class="tcrm-1000">§</span>6.1 </a><a -href="#sec:gls-like">The <span -class="cmtt-10">\gls</span>-Like Commands (First Use Flag -Queried)<!--tex4ht:ref: sec:gls-like --></a>. -</p><!--l. 6947--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslink</span><span -class="cmtt-9"> </span></span><a - id="dx1-56004"></a> <span + id="dx1-134003"></a>, the commands described in this section also have a <span +class="cmti-10">final </span>optional argument ⟨<span +class="cmti-10">insert</span>⟩ +which may be used to insert material into the automatically generated text. See the caveat above in <a +href="#sec:gls-like">§6.1 </a><a +href="#sec:gls-like">The +<span +class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a>. +</p><!--l. 7800--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134004"></a> <span class="cmtt-10">\glslink[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -13988,25 +16250,23 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">link text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 6949--><p class="noindent" > +</p><!--l. 7802--><p class="noindent" > This command explicitly sets the <a href="#glo:linktext">link text<a - id="dx1-56005"></a></a> as given in the final argument. -</p><!--l. 6953--><p class="indent" > <div class="important" title="Important Note"> Don’t use any of the <a + id="dx1-134005"></a></a> as given in the final argument. +</p><!--l. 7806--><p class="indent" > <div class="important" title="Important Note"> Don’t use any of the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> or <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands in the argument of -<span -class="cmtt-10">\glslink</span>. By extension, this means that you can’t use them in the value of fields that are -used to form <a +class="cmtt-10">\glstext</span>-like</a> commands in the argument of <span +class="cmtt-10">\glslink</span>. By +extension, this means that you can’t use them in the value of fields that are used to form <a href="#glo:linktext">link text<a - id="dx1-56006"></a></a>. </div> -</p><!--l. 6958--><p class="noindent" > -</p><!--l. 6960--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstext</span><span -class="cmtt-9"> </span></span><a - id="dx1-56007"></a> <span + id="dx1-134006"></a></a>. +</div> +</p><!--l. 7811--><p class="noindent" > +</p><!--l. 7813--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134007"></a> <span class="cmtt-10">\glstext[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14014,19 +16274,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6962--><p class="noindent" > +</p><!--l. 7815--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">text</span><a - id="dx1-56008"></a> key as the <a +class="cmtt-10">text</span><a + id="dx1-134008"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56009"></a></a>. - - -</p><!--l. 6966--><p class="indent" > There are also analogous commands: -</p><!--l. 6967--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glstext</span><span -class="cmtt-9"> </span></span><a - id="dx1-56010"></a> <span + id="dx1-134009"></a></a>. +</p><!--l. 7819--><p class="indent" > There are also analogous commands: +</p><!--l. 7820--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134010"></a> <span class="cmtt-10">\Glstext[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14034,11 +16290,11 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6969--><p class="noindent" > -</p><!--l. 6970--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLStext</span><span -class="cmtt-9"> </span></span><a - id="dx1-56011"></a> <span +</p><!--l. 7822--><p class="noindent" > + + +</p><!--l. 7823--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134011"></a> <span class="cmtt-10">\GLStext[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14046,30 +16302,26 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6972--><p class="noindent" > -These convert the first character or all the characters to uppercase, respectively. See the note -on <span -class="cmtt-10">\Gls </span>above for details on the limitations of converting the first letter to upper -case. -</p><!--l. 6977--><p class="indent" > There’s no equivalent command for title-casing, but you can use the more generic -command <span +</p><!--l. 7825--><p class="noindent" > +These convert the first character or all the characters to uppercase, respectively. See the note on <span +class="cmtt-10">\Gls </span>above for +details on the limitations of converting the first letter to upper case. +</p><!--l. 7830--><p class="indent" > There’s no equivalent command for title-casing, but you can use the more generic command +<span class="cmtt-10">\glsentrytitlecase</span><a - id="dx1-56012"></a> in combination with <span + id="dx1-134012"></a> in combination with <span class="cmtt-10">\glslink</span>. For example: - - + + </p> - <div class="verbatim" id="verbatim-230"> + <div class="verbatim" id="verbatim-226"> \glslink{sample}{\glsentrytitlecase{sample}{text}} </div> -<!--l. 6982--><p class="nopar" > (See <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a +<!--l. 7835--><p class="nopar" > (See <a +href="#sec:glsnolink">§9 </a><a href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>.) -</p><!--l. 6985--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-56013"></a> <span +</p><!--l. 7838--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134013"></a> <span class="cmtt-10">\glsfirst[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14077,17 +16329,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6987--><p class="noindent" > +</p><!--l. 7840--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">first</span><a - id="dx1-56014"></a> key as the <a +class="cmtt-10">first</span><a + id="dx1-134014"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56015"></a></a>. -</p><!--l. 6991--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 6992--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-56016"></a> <span + id="dx1-134015"></a></a>. +</p><!--l. 7844--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7845--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134016"></a> <span class="cmtt-10">\Glsfirst[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14095,11 +16345,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6994--><p class="noindent" > -</p><!--l. 6995--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-56017"></a> <span +</p><!--l. 7847--><p class="noindent" > +</p><!--l. 7848--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134017"></a> <span class="cmtt-10">\GLSfirst[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14107,39 +16355,36 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 6997--><p class="noindent" > -</p><!--l. 6999--><p class="indent" > <div class="important" title="Important Note"> The value of the <span -class="cmss-10">first</span><a - id="dx1-56018"></a> key (and <span -class="cmss-10">firstplural</span><a - id="dx1-56019"></a> key) doesn’t necessarily match the text produced -by <span +</p><!--l. 7850--><p class="noindent" > +</p><!--l. 7852--><p class="indent" > <div class="important" title="Important Note"> The value of the <span +class="cmtt-10">first</span><a + id="dx1-134018"></a> key (and <span +class="cmtt-10">firstplural</span><a + id="dx1-134019"></a> key) doesn’t necessarily match the text produced by <span class="cmtt-10">\gls</span><a - id="dx1-56020"></a> (or <span + id="dx1-134020"></a> (or +<span class="cmtt-10">\glspl</span><a - id="dx1-56021"></a>) on <a + id="dx1-134021"></a>) on <a href="#glo:firstuse">first use</a> as the <a href="#glo:linktext">link text<a - id="dx1-56022"></a></a> used by <span + id="dx1-134022"></a></a> used by <span class="cmtt-10">\gls</span><a - id="dx1-56023"></a> may be modified -through commands like <span + id="dx1-134023"></a> may be modified through commands like <span class="cmtt-10">\defglsentry</span><a - id="dx1-56024"></a>. (Similarly, the value of the <span -class="cmss-10">text</span><a - id="dx1-56025"></a> and <span -class="cmss-10">plural</span><a - id="dx1-56026"></a> keys -don’t necessarily match the link text<a - id="dx1-56027"></a> used by <span + id="dx1-134024"></a>. +(Similarly, the value of the <span +class="cmtt-10">text</span><a + id="dx1-134025"></a> and <span +class="cmtt-10">plural</span><a + id="dx1-134026"></a> keys don’t necessarily match the link text<a + id="dx1-134027"></a> used by <span class="cmtt-10">\gls </span>or <span -class="cmtt-10">\glspl </span>on subsequent use.) -</div> -</p><!--l. 7007--><p class="noindent" > -</p><!--l. 7009--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56028"></a> <span +class="cmtt-10">\glspl</span> +on subsequent use.) </div> +</p><!--l. 7860--><p class="noindent" > +</p><!--l. 7862--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134028"></a> <span class="cmtt-10">\glsplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14147,17 +16392,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7011--><p class="noindent" > +</p><!--l. 7864--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">plural</span><a - id="dx1-56029"></a> key as the <a +class="cmtt-10">plural</span><a + id="dx1-134029"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56030"></a></a>. -</p><!--l. 7015--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7016--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56031"></a> <span + id="dx1-134030"></a></a>. +</p><!--l. 7868--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7869--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134031"></a> <span class="cmtt-10">\Glsplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14165,11 +16408,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7018--><p class="noindent" > -</p><!--l. 7019--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56032"></a> <span +</p><!--l. 7871--><p class="noindent" > +</p><!--l. 7872--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134032"></a> <span class="cmtt-10">\GLSplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14177,11 +16418,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7021--><p class="noindent" > -</p><!--l. 7023--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56033"></a> <span +</p><!--l. 7874--><p class="noindent" > +</p><!--l. 7876--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134033"></a> <span class="cmtt-10">\glsfirstplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14189,17 +16428,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7025--><p class="noindent" > +</p><!--l. 7878--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">firstplural</span><a - id="dx1-56034"></a> key as the <a +class="cmtt-10">firstplural</span><a + id="dx1-134034"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56035"></a></a>. -</p><!--l. 7029--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7030--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56036"></a> <span + id="dx1-134035"></a></a>. +</p><!--l. 7882--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7883--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134036"></a> <span class="cmtt-10">\Glsfirstplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14207,11 +16444,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7032--><p class="noindent" > -</p><!--l. 7033--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-56037"></a> <span +</p><!--l. 7885--><p class="noindent" > +</p><!--l. 7886--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134037"></a> <span class="cmtt-10">\GLSfirstplural[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14219,11 +16454,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7035--><p class="noindent" > -</p><!--l. 7037--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsname</span><span -class="cmtt-9"> </span></span><a - id="dx1-56038"></a> <span +</p><!--l. 7888--><p class="noindent" > +</p><!--l. 7890--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134038"></a> <span class="cmtt-10">\glsname[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14231,28 +16464,26 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> - - -</p><!--l. 7039--><p class="noindent" > +</p><!--l. 7892--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">name</span><a - id="dx1-56039"></a> key as the <a +class="cmtt-10">name</span><a + id="dx1-134039"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56040"></a></a>. Note that this may be -different from the values of the <span -class="cmss-10">text</span><a - id="dx1-56041"></a> or <span -class="cmss-10">first</span><a - id="dx1-56042"></a> keys. In general it’s better to use <span -class="cmtt-10">\glstext </span>or -<span -class="cmtt-10">\glsfirst </span>instead of <span + id="dx1-134040"></a></a>. Note that this may be different from the + + +values of the <span +class="cmtt-10">text</span><a + id="dx1-134041"></a> or <span +class="cmtt-10">first</span><a + id="dx1-134042"></a> keys. In general it’s better to use <span +class="cmtt-10">\glstext </span>or <span +class="cmtt-10">\glsfirst </span>instead of +<span class="cmtt-10">\glsname</span>. -</p><!--l. 7045--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7046--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsname</span><span -class="cmtt-9"> </span></span><a - id="dx1-56043"></a> <span +</p><!--l. 7898--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7899--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134043"></a> <span class="cmtt-10">\Glsname[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14260,11 +16491,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7048--><p class="noindent" > -</p><!--l. 7049--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSname</span><span -class="cmtt-9"> </span></span><a - id="dx1-56044"></a> <span +</p><!--l. 7901--><p class="noindent" > +</p><!--l. 7902--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134044"></a> <span class="cmtt-10">\GLSname[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14272,18 +16501,16 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7051--><p class="noindent" > -</p><!--l. 7053--><p class="indent" > <div class="important" title="Important Note"> In general it’s best to avoid <span +</p><!--l. 7904--><p class="noindent" > +</p><!--l. 7906--><p class="indent" > <div class="important" title="Important Note"> In general it’s best to avoid <span class="cmtt-10">\Glsname </span>with acronyms. Instead, consider using <span -class="cmtt-10">\Acrlong</span>, +class="cmtt-10">\Acrlong</span>, <span +class="cmtt-10">\Acrshort </span>or <span -class="cmtt-10">\Acrshort </span>or <span class="cmtt-10">\Acrfull</span>. </div> -</p><!--l. 7056--><p class="noindent" > -</p><!--l. 7058--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-56045"></a> <span +</p><!--l. 7909--><p class="noindent" > +</p><!--l. 7911--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134045"></a> <span class="cmtt-10">\glssymbol[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14291,17 +16518,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7060--><p class="noindent" > +</p><!--l. 7913--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">symbol</span><a - id="dx1-56046"></a> key as the <a +class="cmtt-10">symbol</span><a + id="dx1-134046"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56047"></a></a>. -</p><!--l. 7064--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7065--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glssymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-56048"></a> <span + id="dx1-134047"></a></a>. +</p><!--l. 7917--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7918--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134048"></a> <span class="cmtt-10">\Glssymbol[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14309,11 +16534,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7067--><p class="noindent" > -</p><!--l. 7068--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSsymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-56049"></a> <span +</p><!--l. 7920--><p class="noindent" > +</p><!--l. 7921--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134049"></a> <span class="cmtt-10">\GLSsymbol[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14321,11 +16544,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7070--><p class="noindent" > -</p><!--l. 7072--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-56050"></a> <span +</p><!--l. 7923--><p class="noindent" > +</p><!--l. 7925--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134050"></a> <span class="cmtt-10">\glsdesc[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14333,17 +16554,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7074--><p class="noindent" > +</p><!--l. 7927--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">description</span><a - id="dx1-56051"></a> key as the <a +class="cmtt-10">description</span><a + id="dx1-134051"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56052"></a></a>. -</p><!--l. 7078--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7079--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsdesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-56053"></a> <span + id="dx1-134052"></a></a>. +</p><!--l. 7931--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7932--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134053"></a> <span class="cmtt-10">\Glsdesc[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14351,11 +16570,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7081--><p class="noindent" > -</p><!--l. 7082--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSdesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-56054"></a> <span +</p><!--l. 7934--><p class="noindent" > +</p><!--l. 7935--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134054"></a> <span class="cmtt-10">\GLSdesc[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14363,19 +16580,17 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7084--><p class="noindent" > -</p><!--l. 7086--><p class="indent" > If you want the title case version you can use - - +</p><!--l. 7937--><p class="noindent" > +</p><!--l. 7939--><p class="indent" > If you want the title case version you can use + + </p> - <div class="verbatim" id="verbatim-231"> + <div class="verbatim" id="verbatim-227"> \glslink{sample}{\glsentrytitlecase{sample}{desc}} </div> -<!--l. 7089--><p class="nopar" > -</p><!--l. 7091--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuseri</span><span -class="cmtt-9"> </span></span><a - id="dx1-56055"></a> <span +<!--l. 7942--><p class="nopar" > +</p><!--l. 7944--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134055"></a> <span class="cmtt-10">\glsuseri[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14383,17 +16598,15 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7093--><p class="noindent" > +</p><!--l. 7946--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user1</span><a - id="dx1-56056"></a> key as the <a +class="cmtt-10">user1</span><a + id="dx1-134056"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56057"></a></a>. -</p><!--l. 7097--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7098--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuseri</span><span -class="cmtt-9"> </span></span><a - id="dx1-56058"></a> <span + id="dx1-134057"></a></a>. +</p><!--l. 7950--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7951--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134058"></a> <span class="cmtt-10">\Glsuseri[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14401,11 +16614,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7100--><p class="noindent" > -</p><!--l. 7101--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuseri</span><span -class="cmtt-9"> </span></span><a - id="dx1-56059"></a> <span +</p><!--l. 7953--><p class="noindent" > +</p><!--l. 7954--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134059"></a> <span class="cmtt-10">\GLSuseri[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14413,11 +16624,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7103--><p class="noindent" > -</p><!--l. 7105--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuserii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56060"></a> <span +</p><!--l. 7956--><p class="noindent" > +</p><!--l. 7958--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134060"></a> <span class="cmtt-10">\glsuserii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14425,17 +16634,15 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7107--><p class="noindent" > +</p><!--l. 7960--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user2</span><a - id="dx1-56061"></a> key as the <a +class="cmtt-10">user2</span><a + id="dx1-134061"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56062"></a></a>. -</p><!--l. 7111--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7112--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuserii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56063"></a> <span + id="dx1-134062"></a></a>. +</p><!--l. 7964--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7965--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134063"></a> <span class="cmtt-10">\Glsuserii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14443,11 +16650,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7114--><p class="noindent" > -</p><!--l. 7115--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuserii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56064"></a> <span +</p><!--l. 7967--><p class="noindent" > +</p><!--l. 7968--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134064"></a> <span class="cmtt-10">\GLSuserii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14455,11 +16660,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7117--><p class="noindent" > -</p><!--l. 7119--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuseriii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56065"></a> <span +</p><!--l. 7970--><p class="noindent" > +</p><!--l. 7972--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134065"></a> <span class="cmtt-10">\glsuseriii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14467,17 +16670,15 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7121--><p class="noindent" > +</p><!--l. 7974--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user3</span><a - id="dx1-56066"></a> key as the <a +class="cmtt-10">user3</span><a + id="dx1-134066"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56067"></a></a>. -</p><!--l. 7125--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7126--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuseriii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56068"></a> <span + id="dx1-134067"></a></a>. +</p><!--l. 7978--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7979--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134068"></a> <span class="cmtt-10">\Glsuseriii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14485,11 +16686,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7128--><p class="noindent" > -</p><!--l. 7129--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuseriii</span><span -class="cmtt-9"> </span></span><a - id="dx1-56069"></a> <span +</p><!--l. 7981--><p class="noindent" > +</p><!--l. 7982--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134069"></a> <span class="cmtt-10">\GLSuseriii[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14497,11 +16696,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7131--><p class="noindent" > -</p><!--l. 7133--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuseriv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56070"></a> <span +</p><!--l. 7984--><p class="noindent" > +</p><!--l. 7986--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134070"></a> <span class="cmtt-10">\glsuseriv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14509,17 +16706,15 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7135--><p class="noindent" > +</p><!--l. 7988--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user4</span><a - id="dx1-56071"></a> key as the <a +class="cmtt-10">user4</span><a + id="dx1-134071"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56072"></a></a>. -</p><!--l. 7139--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7140--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuseriv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56073"></a> <span + id="dx1-134072"></a></a>. +</p><!--l. 7992--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 7993--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134073"></a> <span class="cmtt-10">\Glsuseriv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14527,11 +16722,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7142--><p class="noindent" > -</p><!--l. 7143--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuseriv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56074"></a> <span +</p><!--l. 7995--><p class="noindent" > +</p><!--l. 7996--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134074"></a> <span class="cmtt-10">\GLSuseriv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14539,13 +16732,11 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> - - -</p><!--l. 7145--><p class="noindent" > -</p><!--l. 7147--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuserv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56075"></a> <span + + +</p><!--l. 7998--><p class="noindent" > +</p><!--l. 8000--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134075"></a> <span class="cmtt-10">\glsuserv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14553,17 +16744,15 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7149--><p class="noindent" > +</p><!--l. 8002--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user5</span><a - id="dx1-56076"></a> key as the <a +class="cmtt-10">user5</span><a + id="dx1-134076"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56077"></a></a>. -</p><!--l. 7153--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7154--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuserv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56078"></a> <span + id="dx1-134077"></a></a>. +</p><!--l. 8006--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 8007--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134078"></a> <span class="cmtt-10">\Glsuserv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14571,11 +16760,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7156--><p class="noindent" > -</p><!--l. 7157--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuserv</span><span -class="cmtt-9"> </span></span><a - id="dx1-56079"></a> <span +</p><!--l. 8009--><p class="noindent" > +</p><!--l. 8010--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134079"></a> <span class="cmtt-10">\GLSuserv[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14583,11 +16770,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7159--><p class="noindent" > -</p><!--l. 7161--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsuservi</span><span -class="cmtt-9"> </span></span><a - id="dx1-56080"></a> <span +</p><!--l. 8012--><p class="noindent" > +</p><!--l. 8014--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134080"></a> <span class="cmtt-10">\glsuservi[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14595,17 +16780,15 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7163--><p class="noindent" > +</p><!--l. 8016--><p class="noindent" > This command always uses the value of the <span -class="cmss-10">user6</span><a - id="dx1-56081"></a> key as the <a +class="cmtt-10">user6</span><a + id="dx1-134081"></a> key as the <a href="#glo:linktext">link text<a - id="dx1-56082"></a></a>. -</p><!--l. 7167--><p class="indent" > There are also analogous uppercasing commands: -</p><!--l. 7168--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsuservi</span><span -class="cmtt-9"> </span></span><a - id="dx1-56083"></a> <span + id="dx1-134082"></a></a>. +</p><!--l. 8020--><p class="indent" > There are also analogous uppercasing commands: +</p><!--l. 8021--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134083"></a> <span class="cmtt-10">\Glsuservi[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14613,11 +16796,9 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7170--><p class="noindent" > -</p><!--l. 7171--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GLSuservi</span><span -class="cmtt-9"> </span></span><a - id="dx1-56084"></a> <span +</p><!--l. 8023--><p class="noindent" > +</p><!--l. 8024--><p class="indent" > <hr><div title="Definition"><a + id="dx1-134084"></a> <span class="cmtt-10">\GLSuservi[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -14625,141 +16806,127 @@ class="cmitt-10">text</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7173--><p class="noindent" > -</p><!--l. 7175--><p class="noindent" > +</p><!--l. 8026--><p class="noindent" > +</p><!--l. 8028--><p class="noindent" > </p> -<!--l. 7175--><p class="noindent" ><a +<!--l. 8028--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6.3 </span> <a id="sec:glsdisplay"></a>Changing the format of the link text</h3> -<!--l. 7178--><p class="noindent" >The default format of the <a +<!--l. 8031--><p class="noindent" ><div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides ways of altering the format according to the category. See the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual for further details. </div> +</p><!--l. 8035--><p class="noindent" > +</p><!--l. 8037--><p class="noindent" >The default format of the <a href="#glo:linktext">link text<a - id="dx1-57001"></a></a> for the <a + id="dx1-135001"></a></a> for the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> commands is governed by<span class="footnote-mark"><a href="#fn3x6" id="fn3x6-bk"><sup class="textsuperscript">6.3</sup></a></span><a - id="x1-57002f3"></a>: -</p><!--l. 7182--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-57006"></a> <span + id="x1-135002f3"></a>: +</p><!--l. 8041--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135006"></a> <span class="cmtt-10">\glsentryfmt </span></div><hr> -</p><!--l. 7184--><p class="noindent" > -This may be redefined but if you only want the change the display style for a given glossary, -then you need to use -</p><!--l. 7187--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\defglsentryfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-57007"></a> <span +</p><!--l. 8043--><p class="noindent" > +This may be redefined but if you only want the change the display style for a given glossary, then you need to +use +</p><!--l. 8046--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135007"></a> <span class="cmtt-10">\defglsentryfmt[</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">definition</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7189--><p class="noindent" > +</p><!--l. 8048--><p class="noindent" > instead of redefining <span class="cmtt-10">\glsentryfmt</span>. The optional first argument ⟨<span -class="cmti-10">type</span>⟩ is the glossary type. -This defaults to <span +class="cmti-10">type</span>⟩ is the glossary type. This defaults to +<span class="cmtt-10">\glsdefaulttype</span><a - id="dx1-57008"></a> if omitted. The second argument is the entry format -definition. -</p><!--l. 7195--><p class="indent" > <div class="important" title="Important Note"> Note that <span -class="cmtt-10">\glsentryfmt </span>is the default display format for entries. Once the display format -has been changed for an individual glossary using <span + id="dx1-135008"></a> if omitted. The second argument is the entry format definition. +</p><!--l. 8054--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="cmtt-10">\glsentryfmt </span>is the default display format for entries. Once the display format has been +changed for an individual glossary using <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-57009"></a>, redefining -<span -class="cmtt-10">\glsentryfmt </span>won’t have an effect on that glossary, you must instead use <span -class="cmtt-10">\defglsentryfmt</span> -again. Note that glossaries that have been identified as lists of acronyms (via the package -option <span + id="dx1-135009"></a>, redefining <span +class="cmtt-10">\glsentryfmt </span>won’t have an +effect on that glossary, you must instead use <span +class="cmtt-10">\defglsentryfmt </span>again. Note that glossaries that +have been identified as lists of acronyms (via the package option <span class="cmss-10">acronymlists</span><a - id="dx1-57010"></a> or the command <span + id="dx1-135010"></a> or the command + + +<span class="cmtt-10">\DeclareAcronymList</span><a - id="dx1-57011"></a>, see <a -href="#sec:pkgopts-acronym"><span -class="tcrm-1000">§</span>2.5 </a><a -href="#sec:pkgopts-acronym">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>) use -<span -class="cmtt-10">\defglsentryfmt </span>to set their display style. </div> - - -</p><!--l. 7205--><p class="noindent" > -</p><!--l. 7207--><p class="indent" > Within the ⟨<span + id="dx1-135011"></a>, see <a +href="#sec:pkgopts-acronym">§2.7 </a><a +href="#sec:pkgopts-acronym">Acronym and Abbreviation Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>) use <span +class="cmtt-10">\defglsentryfmt </span>to set their display +style. </div> +</p><!--l. 8064--><p class="noindent" > +</p><!--l. 8066--><p class="indent" > Within the ⟨<span class="cmti-10">definition</span>⟩ argument of <span -class="cmtt-10">\defglsentryfmt</span>, or if you want to redefine -<span -class="cmtt-10">\glsentryfmt</span>, you may use the following commands: -</p><!--l. 7211--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslabel</span><span -class="cmtt-9"> </span></span><a - id="dx1-57012"></a> <span +class="cmtt-10">\defglsentryfmt</span>, or if you want to redefine <span +class="cmtt-10">\glsentryfmt</span>, you may use +the following commands: +</p><!--l. 8070--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135012"></a> <span class="cmtt-10">\glslabel </span></div><hr> -</p><!--l. 7213--><p class="noindent" > -This is the label of the entry being referenced. As from version 4.08, you can also access the -glossary entry type using: -</p><!--l. 7216--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstype</span><span -class="cmtt-9"> </span></span><a - id="dx1-57013"></a> <span +</p><!--l. 8072--><p class="noindent" > +This is the label of the entry being referenced. As from version 4.08, you can also access the glossary entry type +using: +</p><!--l. 8075--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135013"></a> <span class="cmtt-10">\glstype </span></div><hr> -</p><!--l. 7218--><p class="noindent" > +</p><!--l. 8077--><p class="noindent" > This is defined using <span class="cmtt-10">\edef</span><a - id="dx1-57014"></a> so the replacement text is the actual glossary type rather than + id="dx1-135014"></a> so the replacement text is the actual glossary type rather than <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrytype{\glslabel}</span></span></span>. -</p><!--l. 7222--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glscustomtext</span><span -class="cmtt-9"> </span></span><a - id="dx1-57015"></a> <span +</p><!--l. 8081--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135015"></a> <span class="cmtt-10">\glscustomtext </span></div><hr> -</p><!--l. 7224--><p class="noindent" > +</p><!--l. 8083--><p class="noindent" > This is the custom text supplied in <span class="cmtt-10">\glsdisp</span>. It’s always empty for <span class="cmtt-10">\gls</span><a - id="dx1-57016"></a>, <span + id="dx1-135016"></a>, <span class="cmtt-10">\glspl</span><a - id="dx1-57017"></a> and their -upper case variants. (You can use <span + id="dx1-135017"></a> and their upper case variants. +(You can use <span class="cmss-10">etoolbox</span><a - id="dx1-57018"></a>’s <span + id="dx1-135018"></a>’s <span class="cmtt-10">\ifdefempty </span>to determine if <span -class="cmtt-10">\glscustomtext </span>is -empty.) -</p><!--l. 7230--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinsert</span><span -class="cmtt-9"> </span></span><a - id="dx1-57019"></a> <span +class="cmtt-10">\glscustomtext </span>is empty.) +</p><!--l. 8089--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135019"></a> <span class="cmtt-10">\glsinsert </span></div><hr> -</p><!--l. 7232--><p class="noindent" > +</p><!--l. 8091--><p class="noindent" > The custom text supplied in the final optional argument to <span class="cmtt-10">\gls</span>, <span class="cmtt-10">\glspl </span>and their upper case variants. -</p><!--l. 7236--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsifplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-57020"></a> <span +</p><!--l. 8095--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135020"></a> <span class="cmtt-10">\glsifplural{</span>⟨<span class="cmitt-10">true text</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7238--><p class="noindent" > +</p><!--l. 8097--><p class="noindent" > If <span class="cmtt-10">\glspl</span>, <span class="cmtt-10">\Glspl </span>or <span class="cmtt-10">\GLSpl </span>was used, this command does ⟨<span class="cmti-10">true text</span>⟩ otherwise it does ⟨<span -class="cmti-10">false</span> -<span -class="cmti-10">text</span>⟩. -</p><!--l. 7242--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glscapscase</span><span -class="cmtt-9"> </span></span><a - id="dx1-57021"></a> <span +class="cmti-10">false text</span>⟩. +</p><!--l. 8101--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135021"></a> <span class="cmtt-10">\glscapscase{</span>⟨<span class="cmitt-10">no case</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -14767,55 +16934,54 @@ class="cmitt-10">first uc</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">all caps</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7244--><p class="noindent" > +</p><!--l. 8103--><p class="noindent" > If <span class="cmtt-10">\gls</span>, <span class="cmtt-10">\glspl </span>or <span class="cmtt-10">\glsdisp </span>were used, this does ⟨<span class="cmti-10">no case</span>⟩. If <span class="cmtt-10">\Gls </span>or <span -class="cmtt-10">\Glspl </span>were used, this -does ⟨<span -class="cmti-10">first uc</span>⟩. If <span +class="cmtt-10">\Glspl </span>were used, this does ⟨<span +class="cmti-10">first uc</span>⟩. If +<span class="cmtt-10">\GLS </span>or <span class="cmtt-10">\GLSpl </span>were used, this does ⟨<span class="cmti-10">all caps</span>⟩. -</p><!--l. 7249--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsifhyperon</span><span -class="cmtt-9"> </span></span><a - id="dx1-57022"></a> <span +</p><!--l. 8108--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135022"></a> <span class="cmtt-10">\glsifhyperon{</span>⟨<span class="cmitt-10">hyper true</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">hyper false</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7251--><p class="noindent" > +</p><!--l. 8110--><p class="noindent" > This will do ⟨<span -class="cmti-10">hyper true</span>⟩ if the hyperlinks are on for the current reference, otherwise it will -do ⟨<span -class="cmti-10">hyper false</span>⟩. The hyperlink may be off even if it wasn’t explicitly switched off -with the <span -class="cmss-10">hyper</span><a - id="dx1-57023"></a> key or the use of a starred command. It may be off because the -<span +class="cmti-10">hyper true</span>⟩ if the hyperlinks are on for the current reference, otherwise it will do ⟨<span +class="cmti-10">hyper false</span>⟩. The +hyperlink may be off even if it wasn’t explicitly switched off with the <span +class="cmtt-10">hyper</span><a + id="dx1-135023"></a> key or the use of a starred +command. It may be off because the <span class="cmss-10">hyperref</span><a - id="dx1-57024"></a> package hasn’t been loaded or because <span + id="dx1-135024"></a> package hasn’t been loaded or because <span class="cmtt-10">\glsdisablehyper</span><a - id="dx1-57025"></a> has been used or -because the entry is in a glossary type that’s had the hyperlinks switched off (using -<span + id="dx1-135025"></a> +has been used or because the entry is in a glossary type that’s had the hyperlinks switched off +(using <span class="cmss-10">nohypertypes</span><a - id="dx1-57026"></a>) or because it’s the <a + id="dx1-135026"></a>) or because it’s the <a href="#glo:firstuse">first use</a> and the hyperlinks have been suppressed on first use. -</p><!--l. 7262--><p class="indent" > Note that <span +</p><!--l. 8121--><p class="indent" > <div class="important" title="Important Note"> The <span +class="cmtt-10">\glsifhyperon </span>command should be used instead of <span class="cmtt-10">\glsifhyper</span><a - id="dx1-57027"></a> 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: -</p><!--l. 7265--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslinkvar</span><span -class="cmtt-9"> </span></span><a - id="dx1-57028"></a> <span + id="dx1-135027"></a>, which is now deprecated (and no +longer documented). </div> +</p><!--l. 8124--><p class="noindent" > +</p><!--l. 8126--><p class="indent" > If you want to know if the command used to reference this entry was used with the star or plus variant, you +can use: +</p><!--l. 8128--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135028"></a> <span class="cmtt-10">\glslinkvar{</span>⟨<span class="cmitt-10">unmodified</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -14823,549 +16989,510 @@ class="cmitt-10">star</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">plus</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7267--><p class="noindent" > +</p><!--l. 8130--><p class="noindent" > This will do ⟨<span class="cmti-10">unmodified</span>⟩ if the unmodified version was used, or will do ⟨<span -class="cmti-10">star</span>⟩ if the starred -version was used, or will do ⟨<span -class="cmti-10">plus</span>⟩ if the plus version was used. Note that this doesn’t -take into account if the <span -class="cmss-10">hyper</span><a - id="dx1-57029"></a> key was used to override the default setting, so this -command shouldn’t be used to guess whether or not the hyperlink is on for this - - -reference. -</p><!--l. 7276--><p class="indent" > Note that you can also use commands such as <span +class="cmti-10">star</span>⟩ if the starred version was used, or + + +will do ⟨<span +class="cmti-10">plus</span>⟩ if the plus version was used. Note that this doesn’t take into account if the <span +class="cmtt-10">hyper</span><a + id="dx1-135029"></a> key was used to +override the default setting, so this command shouldn’t be used to guess whether or not the hyperlink is on for +this reference. +</p><!--l. 8139--><p class="indent" > Note that you can also use commands such as <span class="cmtt-10">\ifglsused</span><a - id="dx1-57030"></a> within the definition of -<span + id="dx1-135030"></a> within the definition of <span class="cmtt-10">\glsentryfmt </span>(see <a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a +href="#sec:glsunset">§14 +</a><a href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>). -</p><!--l. 7279--><p class="indent" > The commands <span +</p><!--l. 8142--><p class="indent" > The commands <span class="cmtt-10">\glslabel</span><a - id="dx1-57031"></a>, <span + id="dx1-135031"></a>, <span class="cmtt-10">\glstype</span><a - id="dx1-57032"></a>, <span + id="dx1-135032"></a>, <span class="cmtt-10">\glsifplural</span><a - id="dx1-57033"></a>, <span + id="dx1-135033"></a>, <span class="cmtt-10">\glscapscase</span><a - id="dx1-57034"></a>, <span -class="cmtt-10">\glscustomtext</span><a - id="dx1-57035"></a> and -<span + id="dx1-135034"></a>, <span class="cmtt-10">\glsinsert</span><a - id="dx1-57036"></a> are typically updated at the start of the <a + id="dx1-135035"></a> and <span +class="cmtt-10">\glscustomtext</span><a + id="dx1-135036"></a> are +typically updated at the start of the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> and <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands -so they can usually be accessed in the hook user commands, such as <span +class="cmtt-10">\glstext</span>-like</a> commands so they can usually be accessed in +the hook user commands, such as <span class="cmtt-10">\glspostlinkhook</span><a - id="dx1-57037"></a> and -<span + id="dx1-135037"></a> and <span class="cmtt-10">\glslinkpostsetkeys</span><a - id="dx1-57038"></a>. -</p><!--l. 7285--><p class="indent" > <div class="important" title="Important Note"> This means that using commands like <span + id="dx1-135038"></a>. +</p><!--l. 8148--><p class="indent" > <div class="important" title="Important Note"> This means that using commands like <span class="cmtt-10">\gls</span><a - id="dx1-57039"></a> within the fields that are accessed using the -<a + id="dx1-135039"></a> within the fields that are accessed using the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> or <a +class="cmtt-10">\gls</span>-like</a> or +<a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands (such as the <span -class="cmss-10">first</span><a - id="dx1-57040"></a>, <span -class="cmss-10">text</span><a - id="dx1-57041"></a>, <span -class="cmss-10">long</span><a - id="dx1-57042"></a> or <span -class="cmss-10">short</span><a - id="dx1-57043"></a> keys) will cause a -problem. The entry formatting performed by <span -class="cmtt-10">\glsentryfmt </span>and related commands isn’t -scoped (otherwise if would cause problems for <span -class="cmtt-10">\glspostlinkhook </span>which may need to look -ahead as well as look behind). This means that any nested commands will, at the very least, -change the label stored in <span -class="cmtt-10">\glslabel</span>. </div> -</p><!--l. 7295--><p class="noindent" > -</p><!--l. 7297--><p class="indent" > If you only want to make minor modifications to <span +class="cmtt-10">first</span><a + id="dx1-135040"></a>, <span +class="cmtt-10">text</span><a + id="dx1-135041"></a>, <span +class="cmtt-10">long</span><a + id="dx1-135042"></a> or <span +class="cmtt-10">short</span><a + id="dx1-135043"></a> keys) will cause a problem. The entry +formatting performed by <span +class="cmtt-10">\glsentryfmt </span>and related commands isn’t scoped (otherwise if would +cause problems for <span +class="cmtt-10">\glspostlinkhook </span>which may need to look ahead as well as look behind). This +means that any nested commands will, at the very least, change the label stored in <span +class="cmtt-10">\glslabel</span>. +</div> +</p><!--l. 8158--><p class="noindent" > +</p><!--l. 8160--><p class="indent" > If you only want to make minor modifications to <span class="cmtt-10">\glsentryfmt</span>, you can use -</p><!--l. 7299--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsgenentryfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-57044"></a> <span +</p><!--l. 8162--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135044"></a> <span class="cmtt-10">\glsgenentryfmt </span></div><hr> -</p><!--l. 7301--><p class="noindent" > +</p><!--l. 8164--><p class="noindent" > This uses the above commands to display just the <span -class="cmss-10">first</span><a - id="dx1-57045"></a>, <span -class="cmss-10">text</span><a - id="dx1-57046"></a>, <span -class="cmss-10">plural</span><a - id="dx1-57047"></a> or <span -class="cmss-10">firstplural</span><a - id="dx1-57048"></a> keys (or the -custom text) with the insert text appended. -</p><!--l. 7306--><p class="indent" > Alternatively, if want to change the entry format for abbreviations (defined via -<span +class="cmtt-10">first</span><a + id="dx1-135045"></a>, <span +class="cmtt-10">text</span><a + id="dx1-135046"></a>, <span +class="cmtt-10">plural</span><a + id="dx1-135047"></a> or <span +class="cmtt-10">firstplural</span><a + id="dx1-135048"></a> keys (or the custom +text) with the insert text appended. +</p><!--l. 8169--><p class="indent" > Alternatively, if you want to change the entry format for abbreviations (defined via <span class="cmtt-10">\newacronym</span><a - id="dx1-57049"></a>) you can use: -</p><!--l. 7308--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsgenacfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-57050"></a> <span + id="dx1-135049"></a>) you can +use: +</p><!--l. 8171--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135050"></a> <span class="cmtt-10">\glsgenacfmt </span></div><hr> -</p><!--l. 7310--><p class="noindent" > +</p><!--l. 8173--><p class="noindent" > This uses the values from the <span -class="cmss-10">long</span><a - id="dx1-57051"></a>, <span -class="cmss-10">short</span><a - id="dx1-57052"></a>, <span -class="cmss-10">longplural</span><a - id="dx1-57053"></a> and <span -class="cmss-10">shortplural</span><a - id="dx1-57054"></a> keys, rather than -using the <span -class="cmss-10">text</span><a - id="dx1-57055"></a>, <span -class="cmss-10">plural</span><a - id="dx1-57056"></a>, <span -class="cmss-10">first</span><a - id="dx1-57057"></a> and <span -class="cmss-10">firstplural</span><a - id="dx1-57058"></a> keys. The first use singular text is obtained -via: -</p><!--l. 7315--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\genacrfullformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-57059"></a> <span +class="cmtt-10">long</span><a + id="dx1-135051"></a>, <span +class="cmtt-10">short</span><a + id="dx1-135052"></a>, <span +class="cmtt-10">longplural</span><a + id="dx1-135053"></a> and <span +class="cmtt-10">shortplural</span><a + id="dx1-135054"></a> keys, rather than using the <span +class="cmtt-10">text</span><a + id="dx1-135055"></a>, +<span +class="cmtt-10">plural</span><a + id="dx1-135056"></a>, <span +class="cmtt-10">first</span><a + id="dx1-135057"></a> and <span +class="cmtt-10">firstplural</span><a + id="dx1-135058"></a> keys. The first use singular text is obtained via: +</p><!--l. 8178--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135059"></a> <span class="cmtt-10">\genacrfullformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7317--><p class="noindent" > +</p><!--l. 8180--><p class="noindent" > instead of from the <span -class="cmss-10">first</span><a - id="dx1-57060"></a> key, and the first use plural text is obtained via: -</p><!--l. 7320--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\genplacrfullformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-57061"></a> <span +class="cmtt-10">first</span><a + id="dx1-135060"></a> key, and the first use plural text is obtained via: +</p><!--l. 8183--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135061"></a> <span class="cmtt-10">\genplacrfullformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7322--><p class="noindent" > +</p><!--l. 8185--><p class="noindent" > instead of from the <span -class="cmss-10">firstplural</span><a - id="dx1-57062"></a> key. In both cases, ⟨<span +class="cmtt-10">firstplural</span><a + id="dx1-135062"></a> key. In both cases, ⟨<span class="cmti-10">label</span>⟩ is the entry’s label and ⟨<span -class="cmti-10">insert</span>⟩ is the -insert text provided in the final optional argument of commands like <span +class="cmti-10">insert</span>⟩ is the insert text +provided in the final optional argument of commands like <span class="cmtt-10">\gls</span><a - id="dx1-57063"></a>. The default -behaviour is to do the long form (or plural long form) followed by ⟨<span -class="cmti-10">insert</span>⟩ and a space -and the short form (or plural short form) in parentheses, where the short form -is in the argument of <span + id="dx1-135063"></a>. The default behaviour is to do the long form (or +plural long form) followed by ⟨<span +class="cmti-10">insert</span>⟩ and a space and the short form (or plural short form) in parentheses, where +the short form is in the argument of <span class="cmtt-10">\firstacronymfont</span><a - id="dx1-57064"></a>. There are also first letter upper case + id="dx1-135064"></a>. There are also first letter upper case versions: -</p><!--l. 7331--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Genacrfullformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-57065"></a> <span +</p><!--l. 8194--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135065"></a> <span class="cmtt-10">\Genacrfullformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7333--><p class="noindent" > +</p><!--l. 8196--><p class="noindent" > and -</p><!--l. 7335--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Genplacrfullformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-57066"></a> <span +</p><!--l. 8198--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135066"></a> <span class="cmtt-10">\Genplacrfullformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7337--><p class="noindent" > -By default these perform a protected expansion on their no-case-change equivalents and then -use <span +</p><!--l. 8200--><p class="noindent" > +By default these perform a protected expansion on their no-case-change equivalents and then use <span class="cmtt-10">\makefirstuc</span><a - id="dx1-57067"></a> to convert the first character to upper case. If there are issues -caused by this expansion, you will need to redefine those commands to explicitly - - -use commands like <span + id="dx1-135067"></a> +to convert the first character to upper case. If there are issues caused by this expansion, you will need to +redefine those commands to explicitly use commands like <span class="cmtt-10">\Glsentrylong</span><a - id="dx1-57068"></a> (which is what the predefined acronym styles, -such as <span + id="dx1-135068"></a> (which is what the predefined +acronym styles, such as <span class="cmss-10">long-short</span><a - id="dx1-57069"></a>, do). Otherwise, you only need to redefine <span + id="dx1-135069"></a>, do). Otherwise, you only need to redefine <span class="cmtt-10">\genacrfullformat</span><a - id="dx1-57070"></a> -and <span + id="dx1-135070"></a> and + + +<span class="cmtt-10">\genplacrfullformat</span><a - id="dx1-57071"></a> to change the behaviour of <span + id="dx1-135071"></a> to change the behaviour of <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-57072"></a>. See <a -href="#sec:acronyms"><span -class="tcrm-1000">§</span>13 -</a><a -href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further details on changing the style of -acronyms. -</p><!--l. 7349--><p class="indent" > <div class="important" title="Important Note"> Note that <span + id="dx1-135072"></a>. See <a +href="#sec:acronyms">§13 </a><a +href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> +for further details on changing the style of acronyms. +</p><!--l. 8212--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\glsentryfmt </span>(or the formatting given by <span -class="cmtt-10">\defglsentryfmt</span>) is not used by -the <a +class="cmtt-10">\defglsentryfmt</span>) is not used by the +<a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands. </div> -</p><!--l. 7352--><p class="noindent" > -</p><!--l. 7354--><p class="indent" > As from version 4.16, both the <a +</p><!--l. 8215--><p class="noindent" > +</p><!--l. 8217--><p class="indent" > As from version 4.16, both the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> and <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands use -</p><!--l. 7356--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslinkpostsetkeys</span><span -class="cmtt-9"> </span></span><a - id="dx1-57073"></a> <span +</p><!--l. 8219--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135073"></a> <span class="cmtt-10">\glslinkpostsetkeys </span></div><hr> -</p><!--l. 7358--><p class="noindent" > +</p><!--l. 8221--><p class="noindent" > after the ⟨<span -class="cmti-10">options</span>⟩ 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 -</p><!--l. 7362--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspostlinkhook</span><span -class="cmtt-9"> </span></span><a - id="dx1-57074"></a> <span +class="cmti-10">options</span>⟩ 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 +</p><!--l. 8225--><p class="indent" > <hr><div title="Definition"><a + id="dx1-135074"></a> <span class="cmtt-10">\glspostlinkhook </span></div><hr> -</p><!--l. 7364--><p class="noindent" > +</p><!--l. 8227--><p class="noindent" > which is done after the link text has been displayed and also <span class="cmti-10">after </span>the <a -href="#glo:firstuseflag">first use flag</a> has been -unset (see example <a -href="#x1-72077r25">25<!--tex4ht:ref: ex:dotabbr --></a>). +href="#glo:firstuseflag">first use flag</a> has been unset (see +example <a +href="#ex:dotabbr">25<!--tex4ht:ref: ex:dotabbr --></a>). <a - id="x1-57075r8"></a> -</p><!--l. 7369--><p class="noindent" ><span + id="ex:customfmt"></a> +</p><!--l. 8232--><p class="noindent" ><span class="cmbx-12">Example 8</span><span class="cmbx-12"> (Custom Entry Display in Text)</span><a - id="x1-57076"></a> -</p><!--l. 7370--><p class="indent" > Suppose you want a glossary of measurements and units, you can use the <span -class="cmss-10">symbol</span><a - id="dx1-57077"></a> key to -store the unit: - - + id="x1-135076"></a> +</p><!--l. 8233--><p class="indent" > Suppose you want a glossary of measurements and units, you can use the <span +class="cmtt-10">symbol</span><a + id="dx1-135077"></a> key to store the +unit: + + </p> - <div class="verbatim" id="verbatim-232"> + <div class="verbatim" id="verbatim-228"> \newglossaryentry{distance}{name=distance,  <br />description={The length between two points},  <br />symbol={km}} </div> -<!--l. 7376--><p class="nopar" > and now suppose you want <span class="obeylines-h"><span class="verb"><span +<!--l. 8239--><p class="nopar" > and now suppose you want <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{distance}</span></span></span> to produce “distance (km)” on <a -href="#glo:firstuse">first use</a>, then -you can redefine <span +href="#glo:firstuse">first use</a>, then you can redefine +<span class="cmtt-10">\glsentryfmt</span><a - id="dx1-57078"></a> as follows: - - + id="dx1-135078"></a> as follows: + + </p> - <div class="verbatim" id="verbatim-233"> + <div class="verbatim" id="verbatim-229"> \renewcommand*{\glsentryfmt}{%  <br />  \glsgenentryfmt  <br />  \ifglsused{\glslabel}{}{\space (\glsentrysymbol{\glslabel})}%  <br />} </div> -<!--l. 7385--><p class="nopar" > -</p><!--l. 7387--><p class="indent" > (Note that I’ve used <span +<!--l. 8248--><p class="nopar" > +</p><!--l. 8250--><p class="indent" > (Note that I’ve used <span class="cmtt-10">\glsentrysymbol</span><a - id="dx1-57079"></a> rather than <span + id="dx1-135079"></a> rather than <span class="cmtt-10">\glssymbol</span><a - id="dx1-57080"></a> to avoid nested -hyperlinks.) -</p><!--l. 7390--><p class="indent" > Note also that all of the <a + id="dx1-135080"></a> to avoid nested hyperlinks.) +</p><!--l. 8253--><p class="indent" > Note also that all of the <a href="#glo:linktext">link text<a - id="dx1-57081"></a></a> will be formatted according to <span + id="dx1-135081"></a></a> will be formatted according to <span class="cmtt-10">\glstextformat</span><a - id="dx1-57082"></a> -(described earlier). So if you do, say: - - + id="dx1-135082"></a> (described earlier). So if +you do, say: + + </p> - <div class="verbatim" id="verbatim-234"> + <div class="verbatim" id="verbatim-230"> \renewcommand{\glstextformat}[1]{\textbf{#1}}  <br />\renewcommand*{\glsentryfmt}{%  <br />  \glsgenentryfmt  <br />  \ifglsused{\glslabel}{}{\space(\glsentrysymbol{\glslabel})}%  <br />} </div> -<!--l. 7398--><p class="nopar" > then <span class="obeylines-h"><span class="verb"><span +<!--l. 8261--><p class="nopar" > then <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{distance}</span></span></span> will produce “<span class="cmbx-10">distance (km)</span>”. -</p><!--l. 7401--><p class="indent" > For a complete document, see the sample file <a -href="#x1-11114r38"><span +</p><!--l. 8264--><p class="indent" > For a complete document, see the sample file <a +href="#ex:sample-entryfmt"><span class="cmtt-10">sample-entryfmt.tex</span></a>. </p> <div class="center" > -<!--l. 7402--><p class="noindent" > -</p><!--l. 7402--><p class="noindent" >____________________________</p></div> +<!--l. 8265--><p class="noindent" > +</p><!--l. 8265--><p class="noindent" >____________________________</p></div> <a - id="x1-57083r9"></a> -<!--l. 7404--><p class="noindent" ><span + id="ex:defglsentryfmt"></a> +<!--l. 8267--><p class="noindent" ><span class="cmbx-12">Example 9</span><span class="cmbx-12"> (Custom Format for Particular Glossary)</span><a - id="x1-57084"></a> -</p><!--l. 7405--><p class="indent" > Suppose you have created a new glossary called <span -class="cmtt-10">notation </span>and you want to change -the way the entry is displayed on <a -href="#glo:firstuse">first use</a> so that it includes the symbol, you can -do: - - + id="x1-135084"></a> +</p><!--l. 8268--><p class="indent" > Suppose you have created a new glossary called <span +class="cmtt-10">notation </span>and you want to change the way the entry is +displayed on <a +href="#glo:firstuse">first use</a> so that it includes the symbol, you can do: + + </p> - <div class="verbatim" id="verbatim-235"> + <div class="verbatim" id="verbatim-231"> \defglsentryfmt[notation]{\glsgenentryfmt  <br /> \ifglsused{\glslabel}{}{\space  <br />   (denoted \glsentrysymbol{\glslabel})}} </div> -<!--l. 7412--><p class="nopar" > Now suppose you have defined an entry as follows: - - +<!--l. 8275--><p class="nopar" > Now suppose you have defined an entry as follows: + + </p> - <div class="verbatim" id="verbatim-236"> + <div class="verbatim" id="verbatim-232"> \newglossaryentry{set}{type=notation,  <br />  name=set,  <br />  description={A collection of objects},  <br />  symbol={$S$}  <br />} </div> -<!--l. 7420--><p class="nopar" > The <a +<!--l. 8283--><p class="nopar" > The <a href="#glo:firstuse">first time</a> you reference this entry it will be displayed as: “set (denoted <span -class="cmmi-10">S</span>)” (assuming -<span +class="cmmi-10">S</span>)” (assuming <span class="cmtt-10">\gls</span><a - id="dx1-57085"></a> was used). -</p><!--l. 7424--><p class="indent" > Alternatively, if you expect all the symbols to be set in math mode, you can -do: - - + id="dx1-135085"></a> was +used). +</p><!--l. 8287--><p class="indent" > Alternatively, if you expect all the symbols to be set in math mode, you can do: + + </p> - <div class="verbatim" id="verbatim-237"> + <div class="verbatim" id="verbatim-233"> \defglsentryfmt[notation]{\glsgenentryfmt  <br /> \ifglsused{\glslabel}{}{\space  <br />   (denoted $\glsentrysymbol{\glslabel}$)}} </div> -<!--l. 7430--><p class="nopar" > and define entries like this: - - +<!--l. 8293--><p class="nopar" > and define entries like this: + + </p> - <div class="verbatim" id="verbatim-238"> + <div class="verbatim" id="verbatim-234"> \newglossaryentry{set}{type=notation,  <br />  name=set,  <br />  description={A collection of objects},  <br />  symbol={S}  <br />} </div> -<!--l. 7438--><p class="nopar" > </p> +<!--l. 8301--><p class="nopar" > </p> <div class="center" > -<!--l. 7439--><p class="noindent" > -</p><!--l. 7439--><p class="noindent" >____________________________</p></div> -<!--l. 7441--><p class="indent" > Remember that if you use the <span -class="cmss-10">symbol</span><a - id="dx1-57086"></a> key, you need to use a glossary style that displays -the symbol, as many of the styles ignore it. -</p><!--l. 7445--><p class="noindent" > -</p> -<!--l. 7445--><p class="noindent" ><a +<!--l. 8302--><p class="noindent" > +</p><!--l. 8302--><p class="noindent" >____________________________</p></div> +<!--l. 8304--><p class="indent" > Remember that if you use the <span +class="cmtt-10">symbol</span><a + id="dx1-135086"></a> key, you need to use a glossary style that displays the symbol, as many +of the styles ignore it. +</p><!--l. 8308--><p class="noindent" > +</p> +<!--l. 8308--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6.4 </span> <a id="sec:disablehyperlinks"></a>Enabling and disabling hyperlinks to glossary entries</h3> -<!--l. 7448--><p class="noindent" >If you load the <span +<!--l. 8311--><p class="noindent" >If you load the <span class="cmss-10">hyperref</span><a - id="dx1-58001"></a> or <span + id="dx1-136001"></a> or <span class="cmss-10">html</span><a - id="dx1-58002"></a> packages prior to loading the <span -class="cmss-10">glossaries </span>package, the -<a + id="dx1-136002"></a> packages prior to loading the <span +class="cmss-10">glossaries </span>package, the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> and <a +class="cmtt-10">\gls</span>-like</a> and +<a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands will automatically have hyperlinks to the relevant -glossary entry, unless the <span -class="cmss-10">hyper</span><a - id="dx1-58003"></a> option has been switched off (either explicitly or through -implicit means, such as via the <span +class="cmtt-10">\glstext</span>-like</a> commands will automatically have hyperlinks to the relevant glossary entry, unless the <span +class="cmtt-10">hyper</span><a + id="dx1-136003"></a> +option has been switched off (either explicitly or through implicit means, such as via the <span class="cmss-10">nohypertypes</span><a - id="dx1-58004"></a> package option). -</p><!--l. 7455--><p class="indent" > You can disable or enable links using: -</p><!--l. 7456--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdisablehyper</span><span -class="cmtt-9"> </span></span><a - id="dx1-58005"></a> <span + id="dx1-136004"></a> package +option). +</p><!--l. 8318--><p class="indent" > You can disable or enable links using: +</p><!--l. 8319--><p class="indent" > <hr><div title="Definition"><a + id="dx1-136005"></a> <span class="cmtt-10">\glsdisablehyper </span></div><hr> -</p><!--l. 7458--><p class="noindent" > +</p><!--l. 8321--><p class="noindent" > and -</p><!--l. 7460--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsenablehyper</span><span -class="cmtt-9"> </span></span><a - id="dx1-58006"></a> <span +</p><!--l. 8323--><p class="indent" > <hr><div title="Definition"><a + id="dx1-136006"></a> <span class="cmtt-10">\glsenablehyper </span></div><hr> -</p><!--l. 7462--><p class="noindent" > -respectively. The effect can be localised by placing the commands within a group. Note that -you should only use <span +</p><!--l. 8325--><p class="noindent" > +respectively. The effect can be localised by placing the commands within a group. Note that you should only use +<span class="cmtt-10">\glsenablehyper </span>if the commands <span class="cmtt-10">\hyperlink</span><a - id="dx1-58007"></a> and <span + id="dx1-136007"></a> and <span class="cmtt-10">\hypertarget</span><a - id="dx1-58008"></a> have -been defined (for example, by the <span + id="dx1-136008"></a> have been defined (for example, by the +<span class="cmss-10">hyperref</span><a - id="dx1-58009"></a> package). -</p><!--l. 7468--><p class="indent" > You can disable just the <a + id="dx1-136009"></a> package). +</p><!--l. 8331--><p class="indent" > You can disable just the <a href="#glo:firstuse">first use</a> links using the package option <span -class="cmss-10">hyperfirst=false</span><a - id="dx1-58010"></a>. Note -that this option only affects the <a +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-136010"></a>. Note that this option only +affects the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> commands that recognise the <a -href="#glo:firstuseflag">first use -flag</a>. +href="#glo:firstuseflag">first use flag</a>. <a - id="x1-58011r10"></a> -</p><!--l. 7472--><p class="noindent" ><span + id="ex:hyperdesc"></a> +</p><!--l. 8335--><p class="noindent" ><span class="cmbx-12">Example 10</span><span class="cmbx-12"> (First Use With Hyperlinked Footnote Description)</span><a - id="x1-58012"></a> -</p><!--l. 7473--><p class="indent" > Suppose I want the first use to have a hyperlink to the description in a footnote instead of -hyperlinking to the relevant place in the glossary. First I need to disable the hyperlinks on -first use via the package option <span -class="cmss-10">hyperfirst=false</span><a - id="dx1-58013"></a>: - - + id="x1-136012"></a> +</p><!--l. 8336--><p class="indent" > Suppose I want the first use to have a hyperlink to the description in a footnote instead of hyperlinking to +the relevant place in the glossary. First I need to disable the hyperlinks on first use via the package option +<span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-136013"></a>: + + </p> - <div class="verbatim" id="verbatim-239"> + <div class="verbatim" id="verbatim-235"> \usepackage[hyperfirst=false]{glossaries} </div> -<!--l. 7479--><p class="nopar" > Now I need to redefine <span +<!--l. 8342--><p class="nopar" > Now I need to redefine <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-58014"></a> (see <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format of the link -text<!--tex4ht:ref: sec:glsdisplay --></a>): - - + id="dx1-136014"></a> (see <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>): + + </p> - <div class="verbatim" id="verbatim-240"> + <div class="verbatim" id="verbatim-236"> \renewcommand*{\glsentryfmt}{%  <br />  \glsgenentryfmt  <br />  \ifglsused{\glslabel}{}{\footnote{\glsentrydesc{\glslabel}}}%  <br />} </div> -<!--l. 7487--><p class="nopar" > -</p><!--l. 7489--><p class="indent" > Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the -sample file <a -href="#x1-11028r10"><span +<!--l. 8350--><p class="nopar" > +</p><!--l. 8352--><p class="indent" > Now the first use won’t have hyperlinked text, but will be followed by a footnote. See the sample file +<a +href="#ex:sample-FnDesc"><span class="cmtt-10">sample-FnDesc.tex</span></a> for a complete document. </p> <div class="center" > -<!--l. 7492--><p class="noindent" > -</p><!--l. 7492--><p class="noindent" >____________________________</p></div> -<!--l. 7494--><p class="indent" > Note that the <span +<!--l. 8355--><p class="noindent" > +</p><!--l. 8355--><p class="noindent" >____________________________</p></div> +<!--l. 8357--><p class="indent" > Note that the <span class="cmss-10">hyperfirst</span><a - id="dx1-58015"></a> option applies to all defined glossaries. It may be that you only -want to disable the hyperlinks on <a -href="#glo:firstuse">first use</a> for glossaries that have a different form on first use. -This can be achieved by noting that since the entries that require hyperlinking for all -instances have identical first and subsequent text, they can be unset via <span + id="dx1-136015"></a> option applies to all defined glossaries. It may be that you only want to disable the +hyperlinks on <a +href="#glo:firstuse">first use</a> for glossaries that have a different form on first use. This can be achieved by noting that +since the entries that require hyperlinking for all instances have identical first and subsequent text, they can be +unset via <span class="cmtt-10">\glsunsetall</span><a - id="dx1-58016"></a> (see -<a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a + id="dx1-136016"></a> (see <a +href="#sec:glsunset">§14 </a><a href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>) so that the <span class="cmss-10">hyperfirst</span><a - id="dx1-58017"></a> option doesn’t get + id="dx1-136017"></a> option doesn’t get applied. <a - id="x1-58018r11"></a> -</p><!--l. 7504--><p class="noindent" ><span + id="ex:hyperfirst"></a> +</p><!--l. 8367--><p class="noindent" ><span class="cmbx-12">Example 11</span><span -class="cmbx-12"> (Suppressing Hyperlinks on First Use Just For</span> -<span -class="cmbx-12">Acronyms)</span><a - id="x1-58019"></a> -</p><!--l. 7505--><p class="indent" > Suppose I want to suppress the hyperlink on <a -href="#glo:firstuse">first use</a> for acronyms but not for entries in -the main glossary. I can load the <span +class="cmbx-12"> (Suppressing Hyperlinks on First Use Just For Acronyms)</span><a + id="x1-136019"></a> +</p><!--l. 8368--><p class="indent" > Suppose I want to suppress the hyperlink on <a +href="#glo:firstuse">first use</a> for acronyms but not for entries in the main glossary. +I can load the <span class="cmss-10">glossaries </span>package using: - - + + </p> - <div class="verbatim" id="verbatim-241"> + <div class="verbatim" id="verbatim-237"> \usepackage[hyperfirst=false,acronym]{glossaries} </div> -<!--l. 7510--><p class="nopar" > Once all glossary entries have been defined I then do: - - +<!--l. 8373--><p class="nopar" > Once all glossary entries have been defined I then do: + + </p> - <div class="verbatim" id="verbatim-242"> + <div class="verbatim" id="verbatim-238"> \glsunsetall[main] </div> -<!--l. 7514--><p class="nopar" > +<!--l. 8377--><p class="nopar" > </p> <div class="center" > -<!--l. 7516--><p class="noindent" > -</p><!--l. 7516--><p class="noindent" >____________________________</p></div> -<!--l. 7518--><p class="indent" > For more complex requirements, you might find it easier to switch off all hyperlinks via -<span +<!--l. 8379--><p class="noindent" > +</p><!--l. 8379--><p class="noindent" >____________________________</p></div> +<!--l. 8381--><p class="indent" > For more complex requirements, you might find it easier to switch off all hyperlinks via <span class="cmtt-10">\glsdisablehyper</span><a - id="dx1-58020"></a> and put the hyperlinks (where required) within the definition of -<span + id="dx1-136020"></a> +and put the hyperlinks (where required) within the definition of <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-58021"></a> (see <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>) via <span + id="dx1-136021"></a> (see <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the format of +the link text<!--tex4ht:ref: sec:glsdisplay --></a>) via <span class="cmtt-10">\glshyperlink</span><a - id="dx1-58022"></a> (see <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 -</a><a + id="dx1-136022"></a> (see <a +href="#sec:glsnolink">§9 </a><a href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>). <a - id="x1-58023r12"></a> -</p><!--l. 7525--><p class="noindent" ><span + id="ex:nomathhyper"></a> +</p><!--l. 8388--><p class="noindent" ><span class="cmbx-12">Example 12</span><span class="cmbx-12"> (Only Hyperlink in Text Mode Not Math Mode)</span><a - id="x1-58024"></a> -</p><!--l. 7526--><p class="indent" > This is a bit of a contrived example, but suppose, for some reason, I only want the -<a + id="x1-136024"></a> +</p><!--l. 8389--><p class="indent" > This is a bit of a contrived example, but suppose, for some reason, I only want the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands to have hyperlinks when used in text mode, but not in math mode. -I can do this by adding the glossary to the list of nohypertypes and redefining -<span +class="cmtt-10">\gls</span>-like</a> commands to +have hyperlinks when used in text mode, but not in math mode. I can do this by adding the glossary to the list +of nohypertypes and redefining <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-58025"></a>: - - + id="dx1-136025"></a>: + + </p> - <div class="verbatim" id="verbatim-243"> + <div class="verbatim" id="verbatim-239"> \GlsDeclareNoHyperList{main}  <br />\renewcommand*{\glsentryfmt}{%  <br />  \ifmmode @@ -15377,74 +17504,70 @@ class="cmtt-10">\glsentryfmt</span><a  <br />  \fi  <br />} </div> -<!--l. 7543--><p class="nopar" > Note that this doesn’t affect the <a +<!--l. 8406--><p class="nopar" > Note that this doesn’t affect the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands, which will have the hyperlinks off -unless they’re forced on using the plus variant. -</p><!--l. 7548--><p class="indent" > See the sample file <a -href="#x1-11112r37"><span +class="cmtt-10">\glstext</span>-like</a> commands, which will have the hyperlinks off unless they’re +forced on using the plus variant. +</p><!--l. 8411--><p class="indent" > See the sample file <a +href="#ex:sample-nomathhyper"><span class="cmtt-10">sample-nomathhyper.tex</span></a> for a complete document. </p> <div class="center" > -<!--l. 7550--><p class="noindent" > -</p><!--l. 7550--><p class="noindent" >____________________________</p></div> +<!--l. 8413--><p class="noindent" > +</p><!--l. 8413--><p class="noindent" >____________________________</p></div> <a - id="x1-58026r13"></a> -<!--l. 7552--><p class="noindent" ><span + id="ex:chap-hyperfirst"></a> +<!--l. 8415--><p class="noindent" ><span class="cmbx-12">Example 13</span><span class="cmbx-12"> (One Hyper Link Per Entry Per Chapter)</span><a - id="x1-58027"></a> -</p><!--l. 7553--><p class="indent" > Here’s a more complicated example that will only have the hyperlink on the first time an -entry is used per chapter. This doesn’t involve resetting the <a -href="#glo:firstuseflag">first use flag</a>. Instead it adds -a new key using <span + id="x1-136027"></a> +</p><!--l. 8416--><p class="indent" > Here’s a more complicated example that will only have the hyperlink on the first time an entry is +used per chapter. This doesn’t involve resetting the <a +href="#glo:firstuseflag">first use flag</a>. Instead it adds a new key using +<span class="cmtt-10">\glsaddstoragekey</span><a - id="dx1-58028"></a> (see <a -href="#sec:glsaddstoragekey"><span -class="tcrm-1000">§</span>4.3.2 </a><a -href="#sec:glsaddstoragekey">Storage Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>) that keeps track of the -chapter number that the entry was last used in: - - + id="dx1-136028"></a> (see <a +href="#sec:glsaddstoragekey">§4.3.2 </a><a +href="#sec:glsaddstoragekey">Storage Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>) that keeps track of the chapter number that the entry was last +used in: + + </p> - <div class="verbatim" id="verbatim-244"> + <div class="verbatim" id="verbatim-240"> \glsaddstoragekey{chapter}{0}{\glschapnum} </div> -<!--l. 7560--><p class="nopar" > This creates a new user command called <span +<!--l. 8423--><p class="nopar" > This creates a new user command called <span class="cmtt-10">\glschapnum </span>that’s analogous to <span -class="cmtt-10">\glsentrytext</span>. -The default value for this key is 0. I then define my glossary entries as usual. -</p><!--l. 7565--><p class="indent" > Next I redefine the hook <span +class="cmtt-10">\glsentrytext</span>. The default value +for this key is 0. I then define my glossary entries as usual. +</p><!--l. 8428--><p class="indent" > Next I redefine the hook <span class="cmtt-10">\glslinkpostsetkeys</span><a - id="dx1-58029"></a> (see <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format of the link -text<!--tex4ht:ref: sec:glsdisplay --></a>) so that it determines the current chapter number (which is stored in <span -class="cmtt-10">\currentchap</span> -using <span -class="cmtt-10">\edef</span>). This value is then compared with the value of the entry’s <span -class="cmtt-10">chapter </span>key that I -defined earlier. If they’re the same, this entry has already been used in this chapter so the -hyperlink is switched off using <span + id="dx1-136029"></a> (see <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a>) so that it +determines the current chapter number (which is stored in <span +class="cmtt-10">\currentchap </span>using <span +class="cmtt-10">\edef</span>). This value is then +compared with the value of the entry’s <span +class="cmtt-10">chapter </span>key that I defined earlier. If they’re the same, this entry +has already been used in this chapter so the hyperlink is switched off using <span class="cmss-10">xkeyval</span><a - id="dx1-58030"></a>’s <span -class="cmtt-10">\setkeys </span>command. If the chapter number isn’t the -same, then this entry hasn’t been used in the current chapter. The <span -class="cmtt-10">chapter </span>field is -updated using <span + id="dx1-136030"></a>’s <span +class="cmtt-10">\setkeys</span> +command. If the chapter number isn’t the same, then this entry hasn’t been used in the current +chapter. The <span +class="cmtt-10">chapter </span>field is updated using <span class="cmtt-10">\glsfieldxdef</span><a - id="dx1-58031"></a> (<a -href="#sec:fetchset"><span -class="tcrm-1000">§</span>16.3 </a><a -href="#sec:fetchset">Fetching and Updating the Value of a Field<!--tex4ht:ref: sec:fetchset --></a>) -provided the user hasn’t switched off the hyperlink. (This test is performed using + id="dx1-136031"></a> (<a +href="#sec:fetchset">§16.3 </a><a +href="#sec:fetchset">Fetching and Updating the +Value of a Field<!--tex4ht:ref: sec:fetchset --></a>) provided the user hasn’t switched off the hyperlink. (This test is performed using <span class="cmtt-10">\glsifhyperon</span>. - - + + </p> - <div class="verbatim" id="verbatim-245"> + <div class="verbatim" id="verbatim-241"> \renewcommand*{\glslinkpostsetkeys}{%  <br /> \edef\currentchap{\arabic{chapter}}%  <br /> \ifnum\currentchap=\glschapnum{\glslabel}\relax @@ -15454,147 +17577,206 @@ class="cmtt-10">\glsifhyperon</span>.  <br /> \fi  <br />} </div> -<!--l. 7586--><p class="nopar" > Note that this will be confused if you use <span -class="cmtt-10">\gls </span>etc when the chapter counter is 0. (That is, -before the first <span +<!--l. 8449--><p class="nopar" > Note that this will be confused if you use <span +class="cmtt-10">\gls </span>etc when the chapter counter is 0. (That is, before the first +<span class="cmtt-10">\chapter</span>.) -</p><!--l. 7590--><p class="indent" > See the sample file <a -href="#x1-11106r32"><span -class="cmtt-10">sample-chap-hyperfirst.tex</span></a> for a complete document. -</p> +</p><!--l. 8453--><p class="indent" > See the sample file <a +href="#ex:sample-chap-hyperfirst"><span +class="cmtt-10">sample-chap-hyperfirst.tex</span></a> for a complete document. </p> <div class="center" > -<!--l. 7592--><p class="noindent" > -</p><!--l. 7592--><p class="noindent" >____________________________</p></div> - - -<!--l. 7594--><p class="indent" > </div> -</p><!--l. 7594--><p class="noindent" ><a +<!--l. 8455--><p class="noindent" > +</p><!--l. 8455--><p class="noindent" >____________________________</p></div> + + +<!--l. 8457--><p class="indent" > </div> +</p><!--l. 8457--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">7. <a id="sec:glsadd"></a>Adding an Entry to the Glossary Without Generating Text</h2> -</p><!--l. 7597--><p class="indent" > It is possible to add a line to the glossary file without generating any text at that point in -the document using: -</p><!--l. 7599--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsadd</span><span -class="cmtt-9"> </span></span><a - id="dx1-59001"></a> <span +</p><!--l. 8460--><p class="indent" > It is possible to add a line to the glossary file without generating any text at that point in the document +using: +</p><!--l. 8462--><p class="indent" > <hr><div title="Definition"><a + id="dx1-137001"></a> <span class="cmtt-10">\glsadd[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7601--><p class="noindent" > +</p><!--l. 8464--><p class="noindent" > This is similar to the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands, only it doesn’t produce any text (so -therefore, there is no <span -class="cmss-10">hyper</span><a - id="dx1-59002"></a> key available in ⟨<span -class="cmti-10">options</span>⟩ but all the other options that can be -used with <a +class="cmtt-10">\glstext</span>-like</a> commands, only it doesn’t produce any text (so therefore, there is no <span +class="cmtt-10">hyper</span><a + id="dx1-137002"></a> +key available in ⟨<span +class="cmti-10">options</span>⟩ but all the other options that can be used with <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands can be passed to <span -class="cmtt-10">\glsadd</span>). For example, to -add a page range to the glossary number list for the entry whose label is given by +class="cmtt-10">\glstext</span>-like</a> commands can be passed +to <span +class="cmtt-10">\glsadd</span>). For example, to add a page range to the glossary number list for the entry whose label is given by <span class="cmtt-10">set</span>: - - + + </p> - <div class="verbatim" id="verbatim-246"> + <div class="verbatim" id="verbatim-242"> \glsadd[format=(]{set}  <br />Lots of text about sets spanning many pages.  <br />\glsadd[format=)]{set} </div> -<!--l. 7612--><p class="nopar" > -</p><!--l. 7614--><p class="indent" > To add all entries that have been defined, use: -</p><!--l. 7615--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsaddall</span><span -class="cmtt-9"> </span></span><a - id="dx1-59003"></a> <span +<!--l. 8475--><p class="nopar" > +</p><!--l. 8477--><p class="indent" > To add all entries that have been defined, use: +</p><!--l. 8478--><p class="indent" > <hr><div title="Definition"><a + id="dx1-137003"></a> <span class="cmtt-10">\glsaddall[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7617--><p class="noindent" > +</p><!--l. 8480--><p class="noindent" > The optional argument is the same as for <span class="cmtt-10">\glsadd</span>, except there is also a key <span -class="cmss-10">types</span><a - id="dx1-59004"></a> which can -be used to specify which glossaries to use. This should be a comma separated list. For -example, if you only want to add all the entries belonging to the list of acronyms (specified by -the glossary type <span +class="cmtt-10">types</span><a + id="dx1-137004"></a> which can be +used to specify which glossaries to use. This should be a comma-separated list. For example, if +you only want to add all the entries belonging to the list of acronyms (specified by the glossary +type <span class="cmtt-10">\acronymtype</span><a - id="dx1-59005"></a>) and a list of notation (specified by the glossary type -<span -class="cmtt-10">notation</span>) then you can do: - - + id="dx1-137005"></a>) and a list of notation (specified by the glossary type <span +class="cmtt-10">notation</span>) then you can +do: + + </p> - <div class="verbatim" id="verbatim-247"> + <div class="verbatim" id="verbatim-243"> \glsaddall[types={\acronymtype,notation}] </div> -<!--l. 7628--><p class="nopar" > -</p><!--l. 7630--><p class="indent" > <div class="important" title="Important Note"> Note that <span +<!--l. 8491--><p class="nopar" > If you are using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-137006"></a></a> with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you can’t use <span +class="cmtt-10">\glsaddall</span>. Instead use the <span +class="cmss-10">selection=all </span>resource +option to select all entries in the given <span +class="cmtt-10">bib</span><a + id="dx1-137007"></a> files. +</p><!--l. 8496--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\glsadd </span>and <span class="cmtt-10">\glsaddall </span>add the current location to the <a href="#glo:numberlist">number list<a - id="dx1-59006"></a></a>. In the -case of <span -class="cmtt-10">\glsaddall</span>, all entries in the glossary will have the same location in the number list. -If you want to use <span -class="cmtt-10">\glsaddall</span>, it’s best to suppress the number list with the <span + id="dx1-137008"></a></a>. In the case of <span +class="cmtt-10">\glsaddall</span>, +all entries in the glossary will have the same location in the number list. If you want to use <span +class="cmtt-10">\glsaddall</span>, it’s +best to suppress the number list with the <span class="cmss-10">nonumberlist</span><a - id="dx1-59007"></a> -package option. (See sections <a + id="dx1-137009"></a> package option. (See sections <a href="#sec:pkgopts-printglos">2.3<!--tex4ht:ref: sec:pkgopts-printglos --></a> and <a -href="#sec:numberlists">5<!--tex4ht:ref: sec:numberlists --></a>.) </div> -</p><!--l. 7637--><p class="noindent" > -</p><!--l. 7639--><p class="indent" > There is now a variation of <span -class="cmtt-10">\glsaddall </span>that skips any entries that have already been -used: -</p><!--l. 7641--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsaddallunused</span><span -class="cmtt-9"> </span></span><a - id="dx1-59008"></a> <span +href="#sec:numberlists">5<!--tex4ht:ref: sec:numberlists --></a>.) +</div> +</p><!--l. 8503--><p class="noindent" > +</p><!--l. 8505--><p class="indent" > There is now a variation of <span +class="cmtt-10">\glsaddall </span>that skips any entries that have already been used: +</p><!--l. 8507--><p class="indent" > <hr><div title="Definition"><a + id="dx1-137010"></a> <span class="cmtt-10">\glsaddallunused[</span>⟨<span class="cmitt-10">list</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 7643--><p class="noindent" > +</p><!--l. 8509--><p class="noindent" > This command uses <span -class="cmtt-10">\glsadd[format=@gobble] </span>which will ignore this location in the number -list. The optional argument ⟨<span -class="cmti-10">list</span>⟩ is a comma-separated list of glossary types. If omitted, it -defaults to the list of all defined glossaries. -</p><!--l. 7649--><p class="indent" > If you want to use <span -class="cmtt-10">\glsaddallunused</span>, it’s best to place the command at the end of the -document to ensure that all the commands you intend to use have already been -used. Otherwise you could end up with a spurious comma or dash in the location -list. +class="cmtt-10">\glsadd[format=glsignore] </span>which will ignore this location in the number list. The +optional argument ⟨<span +class="cmti-10">list</span>⟩ is a comma-separated list of glossary types. If omitted, it defaults to the list of all defined +glossaries. +</p><!--l. 8515--><p class="indent" > <div class="important" title="Important Note"> If you want to use <span +class="cmtt-10">\glsaddallunused</span>, it’s best to place the command at the end of the document to ensure +that all the commands you intend to use have already been used. Otherwise you could end up with a spurious +comma or dash in the location list. </div> +</p><!--l. 8520--><p class="noindent" > +</p><!--l. 8522--><p class="indent" > With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-137011"></a></a>, <span +class="cmtt-10">glsignore </span>indicates an “ignored location” which influences selection but +isn’t added to the location list. In this case, if you use <span +class="cmss-10">selection=all </span>then only those entries that have been +explicitly indexed in the document will have location lists. The other entries that were selected as a result of +<span +class="cmss-10">selection=all </span>won’t have location lists. +</p><!--l. 8530--><p class="indent" > Base <span +class="cmss-10">glossaries</span><a + id="dx1-137012"></a> package only: + + +</p> + <div class="verbatim" id="verbatim-244"> +\documentclass{article} + <br />\usepackage{glossaries} + <br />\makeglossaries + <br />\newglossaryentry{cat}{name={cat},description={feline}} + <br />\newglossaryentry{dog}{name={dog},description={canine}} + <br />\begin{document} + <br />\gls{cat}. + <br />\printglossaries + <br />\glsaddallunused % <- make sure dog is also listed + <br />\end{document} +</div> +<!--l. 8542--><p class="nopar" > Corresponding <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-137013"></a></a> document code: + + +</p> + <div class="verbatim" id="verbatim-245"> +\documentclass{article} + <br />\usepackage[record]{glossaries-extra} + <br />\GlsXtrLoadResources[src={entries},selection=all] + <br />\begin{document} + <br />\gls{cat}. + <br />\printunsrtglossaries + <br />\end{document} +</div> +<!--l. 8552--><p class="nopar" > With the file <span +class="cmtt-10">entries.bib</span>: + + +</p> + <div class="verbatim" id="verbatim-246"> +@entry{cat,name={cat},description={feline}} + <br />@entry{dog,name={dog},description={canine}} +</div> +<!--l. 8557--><p class="nopar" > <a - id="x1-59009r14"></a> -</p><!--l. 7654--><p class="noindent" ><span + id="ex:dual"></a> +</p><!--l. 8559--><p class="noindent" ><span class="cmbx-12">Example 14</span><span class="cmbx-12"> (Dual Entries)</span><a - id="x1-59010"></a> -</p><!--l. 7655--><p class="indent" > The example file <a -href="#x1-11069r22"><span + id="x1-137015"></a> +</p><!--l. 8560--><p class="indent" > The example file <a +href="#ex:sample-dual"><span class="cmtt-10">sample-dual.tex</span></a> makes use of <span -class="cmtt-10">\glsadd </span>to allow for an entry that -should appear both in the main glossary and in the list of acronyms. This example sets up the -list of acronyms using the <span +class="cmtt-10">\glsadd </span>to allow for an entry that should appear both in +the main glossary and in the list of acronyms. This example sets up the list of acronyms using the <span class="cmss-10">acronym</span><a - id="dx1-59011"></a> package option: - - + id="dx1-137016"></a> +package option: + + </p> - <div class="verbatim" id="verbatim-248"> + <div class="verbatim" id="verbatim-247"> \usepackage[acronym]{glossaries} </div> -<!--l. 7661--><p class="nopar" > A new command is then defined to make it easier to define dual entries: - - +<!--l. 8566--><p class="nopar" > A new command is then defined to make it easier to define dual entries: + + </p> - <div class="verbatim" id="verbatim-249"> + <div class="verbatim" id="verbatim-248"> \newcommand*{\newdualentry}[5][]{%  <br />  \newglossaryentry{main-#2}{name={#4},%  <br />  text={#3\glsadd{#2}},% @@ -15604,11 +17786,11 @@ class="cmss-10">acronym</span><a  <br />  \newacronym{#2}{#3\glsadd{main-#2}}{#4}%  <br />} </div> -<!--l. 7673--><p class="nopar" > This has the following syntax: </p><div class="alltt"> +<!--l. 8578--><p class="nopar" > This has the following syntax: </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\newdualentry</span><a - id="dx1-59012"></a><span + id="dx1-137017"></a><span class="cmtt-10">[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -15622,137 +17804,142 @@ class="cmitt-10">description</span>⟩<span class="cmtt-10">}</span> </div> </div> You can then define a new dual entry: - - - <div class="verbatim" id="verbatim-250"> + + + <div class="verbatim" id="verbatim-249"> \newdualentry{svm}% label  <br />  {SVM}% abbreviation  <br />  {support vector machine}% long form  <br />  {Statistical pattern recognition technique}% description </div> -<!--l. 7684--><p class="nopar" > Now you can reference the acronym with <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{svm}</span></span></span> or you can reference the entry in the -main glossary with <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{main-svm}</span></span></span>. </p> +<!--l. 8589--><p class="nopar" > Now you can reference the acronym with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span> or you can reference the entry in the main glossary with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{main-svm}</span></span></span>. +</p><!--l. 8593--><p class="indent" > Note that with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-137018"></a></a>, there are special dual entry types that implement this behaviour. That is, if an +entry is referenced then its corresponding dual entry will automatically be selected as well. So there +is less need for <span +class="cmtt-10">\glsadd </span>with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-137019"></a></a>. (Although it can still be useful, as shown in <a +href="#option6">Option 6</a>.) +</p> <div class="center" > -<!--l. 7687--><p class="noindent" > -</p><!--l. 7687--><p class="noindent" >____________________________</p></div> - - -<!--l. 7689--><p class="indent" > </div> -</p><!--l. 7689--><p class="noindent" ><a +<!--l. 8598--><p class="noindent" > +</p><!--l. 8598--><p class="noindent" >____________________________</p></div> + + +<!--l. 8600--><p class="indent" > </div> +</p><!--l. 8600--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">8. <a id="sec:crossref"></a>Cross-Referencing Entries</h2> -</p><!--l. 7692--><p class="indent" > <div class="important" title="Important Note"> You must use <span +</p><!--l. 8603--><p class="indent" > <div class="important" title="Important Note"> You must use <span class="cmtt-10">\makeglossaries</span><a - id="dx1-60001"></a> (Options <a + id="dx1-138001"></a> (Options <a href="#option2">2</a> or <a href="#option3">3</a>) or <span class="cmtt-10">\makenoidxglossaries</span><a - id="dx1-60002"></a> -(<a + id="dx1-138002"></a> (<a href="#option1">Option 1</a>) <span -class="cmti-10">before </span>defining any terms that cross-reference entries. If any of the terms that -you have cross-referenced don’t appear in the glossary, check that you have put -<span +class="cmti-10">before</span> +defining any terms that cross-reference entries. If any of the terms that you have cross-referenced +don’t appear in the glossary, check that you have put <span class="cmtt-10">\makeglossaries</span>/<span -class="cmtt-10">\makenoidxglossaries </span>before all entry definitions. The <a +class="cmtt-10">\makenoidxglossaries</span> +before all entry definitions. The <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> -package provides better cross-reference handling. </div> -</p><!--l. 7700--><p class="noindent" > -</p><!--l. 7702--><p class="indent" > There are several ways of cross-referencing entries in the glossary: +class="cmss-10">glossaries-extra</span></a> package provides better cross-reference handling. +</div> +</p><!--l. 8611--><p class="noindent" > +</p><!--l. 8613--><p class="indent" > There are several ways of cross-referencing entries in the glossary: </p><ol class="enumerate1" > <li - class="enumerate" id="x1-60004x1">You can use commands such as <span + class="enumerate" id="x1-138004x1">You can use commands such as <span class="cmtt-10">\gls</span><a - id="dx1-60005"></a> in the entries description. For example: - - - <div class="verbatim" id="verbatim-251"> + id="dx1-138005"></a> in the entries description. For example: + + + <div class="verbatim" id="verbatim-250"> \newglossaryentry{apple}{name=apple,  <br />description={firm, round fruit. See also \gls{pear}}} </div> - <!--l. 7711--><p class="nopar" > Note that with this method, if you don’t use the cross-referenced term in the main part - of the document, you will need two runs of <a + <!--l. 8622--><p class="nopar" > Note that with this method, if you don’t use the cross-referenced term in the main part of the document, + you will need two runs of <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-60006"></a></a>: - - -</p> - <div class="verbatim" id="verbatim-252"> - latex filename -  <br />makeglossaries filename -  <br />latex filename -  <br />makeglossaries filename -  <br />latex filename -</div> - <!--l. 7721--><p class="nopar" > + id="dx1-138006"></a></a>: + </p><!--l. 8626--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex filename + <br />makeglossaries filename + <br />pdflatex filename + <br />makeglossaries filename + <br />pdflatex filename + <br /></pre><spacer type=vertical size=10> + <br /></span> </p></li> <li - class="enumerate" id="x1-60008x2">As described in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a + class="enumerate" id="x1-138008x2">As described in <a +href="#sec:newglosentry">§4 </a><a href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>, you can use the <span -class="cmss-10">see</span><a - id="dx1-60009"></a> key when you define - the entry. For example: - - - <div class="verbatim" id="verbatim-253"> +class="cmtt-10">see</span><a + id="dx1-138009"></a> key when you define the entry. For + example: + + + <div class="verbatim" id="verbatim-251"> \newglossaryentry{MaclaurinSeries}{name={Maclaurin  <br />series},  <br />description={Series expansion},  <br />see={TaylorsTheorem}} </div> - <!--l. 7730--><p class="nopar" > Note that in this case, the entry with the <span -class="cmss-10">see</span><a - id="dx1-60010"></a> key will automatically be added to the - glossary, but the cross-referenced entry won’t. You therefore need to ensure that you - use the cross-referenced term with the commands described in <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to - Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a -href="#sec:glsadd"><span -class="tcrm-1000">§</span>7 </a><a -href="#sec:glsadd">Adding an Entry to the Glossary Without Generating - Text<!--tex4ht:ref: sec:glsadd --></a>. - </p><!--l. 7737--><p class="noindent" >The “see” tag is produce using <span + <!--l. 8641--><p class="nopar" > Note that in this case, the entry with the <span +class="cmtt-10">see</span><a + id="dx1-138010"></a> key will automatically be added to the glossary, but the + cross-referenced entry won’t. You therefore need to ensure that you use the cross-referenced term with the + commands described in <a +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a +href="#sec:glsadd">§7 </a><a +href="#sec:glsadd">Adding an Entry to the Glossary Without + Generating Text<!--tex4ht:ref: sec:glsadd --></a>. + </p><!--l. 8648--><p class="noindent" >The “see” tag is produce using <span class="cmtt-10">\seename</span><a - id="dx1-60011"></a>, but can be overridden in specific instances - using square brackets at the start of the <span -class="cmss-10">see</span><a - id="dx1-60012"></a> value. For example: - - + id="dx1-138011"></a>, but can be overridden in specific instances using square brackets + at the start of the <span +class="cmtt-10">see</span><a + id="dx1-138012"></a> value. For example: + + </p> - <div class="verbatim" id="verbatim-254"> + <div class="verbatim" id="verbatim-252"> \newglossaryentry{MaclaurinSeries}{name={Maclaurin  <br />series},  <br />description={Series expansion},  <br />see=[see also]{TaylorsTheorem}} </div> - <!--l. 7745--><p class="nopar" > Take care if you want to use the optional argument of commands such as <span + <!--l. 8656--><p class="nopar" > Take care if you want to use the optional argument of commands such as <span class="cmtt-10">\newacronym</span><a - id="dx1-60013"></a> - or <span + id="dx1-138013"></a> or <span class="cmtt-10">\newterm</span><a - id="dx1-60014"></a> as the value will need to be grouped. For example: - - + id="dx1-138014"></a> as + the value will need to be grouped. For example: + + </p> - <div class="verbatim" id="verbatim-255"> + <div class="verbatim" id="verbatim-253"> \newterm{seal}  <br />\newterm[see={[see also]seal}]{sea lion} </div> - <!--l. 7752--><p class="nopar" > Similarly if the value contains a list. For example: - - + <!--l. 8663--><p class="nopar" > Similarly if the value contains a list. For example: + + </p> - <div class="verbatim" id="verbatim-256"> + <div class="verbatim" id="verbatim-254"> \glossaryentry{lemon}{  <br />  name={lemon},  <br />  description={Yellow citrus fruit} @@ -15769,14 +17956,12 @@ class="cmtt-10">\newterm</span><a  <br />  see={lemon,lime}  <br />} </div> - <!--l. 7770--><p class="nopar" > + <!--l. 8681--><p class="nopar" > </p></li> <li - class="enumerate" id="x1-60016x3">After you have defined the entry, use - <!--l. 7773--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssee</span><span -class="cmtt-9"> </span></span><a - id="dx1-60017"></a> <span + class="enumerate" id="x1-138016x3">After you have defined the entry, use + <!--l. 8684--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-138017"></a> <span class="cmtt-10">\glssee[</span>⟨<span class="cmitt-10">tag</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -15784,63 +17969,59 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">xr label list</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 7775--><p class="noindent" > + </p><!--l. 8686--><p class="noindent" > where ⟨<span class="cmti-10">xr label list</span>⟩ is a comma-separated list of entry labels to be cross-referenced, ⟨<span -class="cmti-10">label</span>⟩ - is the label of the entry doing the cross-referencing and ⟨<span -class="cmti-10">tag</span>⟩ is the “see” tag. (The - default value of ⟨<span +class="cmti-10">label</span>⟩ is the label of the + entry doing the cross-referencing and ⟨<span +class="cmti-10">tag</span>⟩ is the “see” tag. (The default value of ⟨<span class="cmti-10">tag</span>⟩ is <span class="cmtt-10">\seename</span><a - id="dx1-60018"></a>.) For example: - - + id="dx1-138018"></a>.) For + example: + + </p> - <div class="verbatim" id="verbatim-257"> + <div class="verbatim" id="verbatim-255"> \glssee[see also]{series}{FourierSeries,TaylorsTheorem} </div> - <!--l. 7783--><p class="nopar" > Note that this automatically adds the entry given by ⟨<span -class="cmti-10">label</span>⟩ to the glossary - but doesn’t add the cross-referenced entries (specified by ⟨<span -class="cmti-10">xr label list</span>⟩) to the - glossary.</p></li></ol> -<!--l. 7789--><p class="indent" > In both cases 2 and 3 above, the cross-referenced information appears in the <a + <!--l. 8694--><p class="nopar" > Note that this automatically adds the entry given by ⟨<span +class="cmti-10">label</span>⟩ to the glossary but doesn’t add the + cross-referenced entries (specified by ⟨<span +class="cmti-10">xr label list</span>⟩) to the glossary.</p></li></ol> +<!--l. 8700--><p class="indent" > In both cases 2 and 3 above, the cross-referenced information appears in the <a href="#glo:numberlist">number list<a - id="dx1-60019"></a></a>, -whereas in case 1, the cross-referenced information appears in the description. (See the -<a -href="#x1-11030r12"><span -class="cmtt-10">sample-crossref.tex</span></a> example file that comes with this package.) This means that in -cases 2 and 3, the cross-referencing information won’t appear if you have suppressed the -number list<a - id="dx1-60020"></a>. In this case, you will need to activate the number list<a - id="dx1-60021"></a> for the given entries using -<span -class="cmss-10">nonumberlist=false</span><a - id="dx1-60022"></a>. Alternatively, if you just use the <span -class="cmss-10">see</span><a - id="dx1-60023"></a> key instead of <span + id="dx1-138019"></a></a>, whereas in case 1, +the cross-referenced information appears in the description. (See the <a +href="#ex:sample-crossref"><span +class="cmtt-10">sample-crossref.tex</span></a> example file that +comes with this package.) This means that in cases 2 and 3, the cross-referencing information won’t appear if +you have suppressed the number list<a + id="dx1-138020"></a>. In this case, you will need to activate the number list<a + id="dx1-138021"></a> for +the given entries using <span +class="cmtt-10">nonumberlist=false</span><a + id="dx1-138022"></a>. Alternatively, if you just use the <span +class="cmtt-10">see</span><a + id="dx1-138023"></a> key instead +of <span class="cmtt-10">\glssee</span><a - id="dx1-60024"></a>, you -can automatically activate the number list<a - id="dx1-60025"></a> using the <span + id="dx1-138024"></a>, you can automatically activate the number list<a + id="dx1-138025"></a> using the <span class="cmss-10">seeautonumberlist</span><a - id="dx1-60026"></a> package + id="dx1-138026"></a> package option. </p> -<!--l. 7801--><p class="noindent" ><a +<!--l. 8712--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8.1 </span> <a id="sec:customxr"></a>Customising Cross-reference Text</h3> -<!--l. 7804--><p class="noindent" >When you use either the <span -class="cmss-10">see</span><a - id="dx1-61001"></a> key or the command <span -class="cmtt-10">\glssee</span>, the cross-referencing information -will be typeset in the glossary according to: -</p><!--l. 7807--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsseeformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-61002"></a> <span +<!--l. 8715--><p class="noindent" >When you use either the <span +class="cmtt-10">see</span><a + id="dx1-139001"></a> key or the command <span +class="cmtt-10">\glssee</span>, the cross-referencing information will be typeset in +the glossary according to: +</p><!--l. 8718--><p class="indent" > <hr><div title="Definition"><a + id="dx1-139002"></a> <span class="cmtt-10">\glsseeformat[</span>⟨<span class="cmitt-10">tag</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -15848,7 +18029,7 @@ class="cmitt-10">label-list</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7809--><p class="noindent" > +</p><!--l. 8720--><p class="noindent" > The default definition of <span class="cmtt-10">\glsseeformat </span>is: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span @@ -15860,199 +18041,181 @@ class="cmtt-10">}</span> <br /><spacer type=vertical size=10></span> Note that the location is always ignored.<span class="footnote-mark"><a href="#fn1x8" id="fn1x8-bk"><sup class="textsuperscript">8.1</sup></a></span><a - id="x1-61003f1"></a> + id="x1-139003f1"></a> For example, if you want the tag to appear in bold, you can do:<span class="footnote-mark"><a href="#fn2x8" id="fn2x8-bk"><sup class="textsuperscript">8.2</sup></a></span><a - id="x1-61005f2"></a> - - + id="x1-139005f2"></a> + + </p> - <div class="verbatim" id="verbatim-258"> + <div class="verbatim" id="verbatim-256"> \renewcommand*{\glsseeformat}[3][\seename]{\textbf{#1}  <br /> \glsseelist{#2}} </div> -<!--l. 7825--><p class="nopar" > -</p><!--l. 7828--><p class="indent" > The list of labels is dealt with by <span -class="cmtt-10">\glsseelist</span>, which iterates through the list and -typesets each entry in the label. The entries are separated by -</p><!--l. 7831--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsseesep</span><span -class="cmtt-9"> </span></span><a - id="dx1-61008"></a> <span +<!--l. 8736--><p class="nopar" > +</p><!--l. 8739--><p class="indent" > The list of labels is dealt with by <span +class="cmtt-10">\glsseelist</span>, which iterates through the list and typesets each entry in +the label. The entries are separated by +</p><!--l. 8742--><p class="indent" > <hr><div title="Definition"><a + id="dx1-139008"></a> <span class="cmtt-10">\glsseesep </span></div><hr> -</p><!--l. 7833--><p class="noindent" > +</p><!--l. 8744--><p class="noindent" > or (for the last pair) -</p><!--l. 7835--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsseelastsep</span><span -class="cmtt-9"> </span></span><a - id="dx1-61009"></a> <span +</p><!--l. 8746--><p class="indent" > <hr><div title="Definition"><a + id="dx1-139009"></a> <span class="cmtt-10">\glsseelastsep </span></div><hr> -</p><!--l. 7837--><p class="noindent" > +</p><!--l. 8748--><p class="noindent" > These default to “<span class="obeylines-h"><span class="verb"><span class="cmtt-10">,\space</span></span></span>” and “<span class="cmtt-10">\space\andname</span><a - id="dx1-61010"></a><span -class="cmtt-10">\space</span>” respectively. The list entry text is -displayed using: -</p><!--l. 7841--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsseeitemformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-61011"></a> <span + id="dx1-139010"></a><span +class="cmtt-10">\space</span>” respectively. The list entry text is displayed +using: +</p><!--l. 8752--><p class="indent" > <hr><div title="Definition"><a + id="dx1-139011"></a> <span class="cmtt-10">\glsseeitemformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7843--><p class="noindent" > +</p><!--l. 8754--><p class="noindent" > This defaults to <span class="cmtt-10">\glsentrytext</span><a - id="dx1-61012"></a><span + id="dx1-139012"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>.<span class="footnote-mark"><a href="#fn3x8" id="fn3x8-bk"><sup class="textsuperscript">8.3</sup></a></span><a - id="x1-61013f3"></a> + id="x1-139013f3"></a> For example, to make the cross-referenced list use small caps: - - + + </p> - <div class="verbatim" id="verbatim-259"> + <div class="verbatim" id="verbatim-257"> \renewcommand{\glsseeitemformat}[1]{%  <br />  \textsc{\glsentrytext{#1}}} </div> -<!--l. 7851--><p class="nopar" > -</p><!--l. 7853--><p class="indent" > <div class="important" title="Important Note"> You can use <span +<!--l. 8762--><p class="nopar" > +</p><!--l. 8764--><p class="indent" > <div class="important" title="Important Note"> You can use <span class="cmtt-10">\glsseeformat</span><a - id="dx1-61016"></a> and <span + id="dx1-139016"></a> and <span class="cmtt-10">\glsseelist</span><a - id="dx1-61017"></a> in the main body of the text, but they -won’t automatically add the cross-referenced entries to the glossary. If you want them added -with that location, you can do: - - + id="dx1-139017"></a> in the main body of the text, but they won’t automatically +add the cross-referenced entries to the glossary. If you want them added with that location, you can +do: + + </p> - <div class="verbatim" id="verbatim-260"> + <div class="verbatim" id="verbatim-258"> Some information (see also  <br />\glsseelist{FourierSeries,TaylorsTheorem}%  <br />\glsadd{FourierSeries}\glsadd{TaylorsTheorem}). </div> -<!--l. 7862--><p class="nopar" > </div> -</p><!--l. 7863--><p class="noindent" > - - +<!--l. 8773--><p class="nopar" > </div> +</p><!--l. 8774--><p class="noindent" > + + </p> -<!--l. 7865--><p class="indent" > </div> -</p><!--l. 7865--><p class="noindent" ><a +<!--l. 8776--><p class="indent" > </div> +</p><!--l. 8776--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">9. <a id="sec:glsnolink"></a>Using Glossary Terms Without Links</h2> -</p><!--l. 7868--><p class="indent" > The commands described in this section display entry details without adding any -information to the glossary. They don’t use <span +</p><!--l. 8779--><p class="indent" > The commands described in this section display entry details without adding any information to the +glossary. They don’t use <span class="cmtt-10">\glstextformat</span><a - id="dx1-62001"></a>, they don’t have any optional -arguments, they don’t affect the <a -href="#glo:firstuseflag">first use flag</a> and, apart from <span + id="dx1-140001"></a>, they don’t have any optional arguments, they don’t affect the <a +href="#glo:firstuseflag">first +use flag</a> and, apart from <span class="cmtt-10">\glshyperlink</span><a - id="dx1-62002"></a>, they don’t -produce hyperlinks. -</p><!--l. 7874--><p class="indent" > <div class="important" title="Important Note"> Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need -to provide an alternative via <span + id="dx1-140002"></a>, they don’t produce hyperlinks. +</p><!--l. 8785--><p class="indent" > <div class="important" title="Important Note"> Commands that aren’t expandable will be ignored by PDF bookmarks, so you will need to provide an +alternative via <span class="cmss-10">hyperref</span><a - id="dx1-62003"></a>’s <span -class="cmtt-10">\texorpdfstring </span>if you want to use them in -sectioning commands. (This isn’t specific to the <span + id="dx1-140003"></a>’s <span +class="cmtt-10">\texorpdfstring </span>if you want to use them in sectioning commands. (This isn’t specific +to the <span class="cmss-10">glossaries </span>package.) See the <span class="cmss-10">hyperref</span><a - id="dx1-62004"></a> -documentation for further details. All the commands that convert the first letter to upper -case aren’t expandable. The other commands depend on whether their corresponding keys + id="dx1-140004"></a> documentation for further details. All the commands that convert the +first letter to upper case aren’t expandable. The other commands depend on whether their corresponding keys were assigned non-expandable values. </div> -</p><!--l. 7883--><p class="noindent" > -</p><!--l. 7885--><p class="indent" > If you want to title case a field, you can use: -</p><!--l. 7886--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrytitlecase</span><span -class="cmtt-9"> </span></span><a - id="dx1-62005"></a> <span +</p><!--l. 8794--><p class="noindent" > +</p><!--l. 8796--><p class="indent" > If you want to title case a field, you can use: +</p><!--l. 8797--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140005"></a> <span class="cmtt-10">\glsentrytitlecase{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">field</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7888--><p class="noindent" > +</p><!--l. 8799--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the label identifying the glossary entry, ⟨<span class="cmti-10">field</span>⟩ is the field label (see <a -href="#tab:fieldmap">table 4.1</a>). -For example: - - +href="#tab:fieldmap">table 4.1</a>). For +example: + + </p> - <div class="verbatim" id="verbatim-261"> + <div class="verbatim" id="verbatim-259"> \glsentrytitlecase{sample}{desc} </div> -<!--l. 7894--><p class="nopar" > (If you want title-casing in your glossary style, you might want to investigate the -<span -class="cmss-10">glossaries-extra</span><a - id="dx1-62006"></a> package.) -</p><!--l. 7898--><p class="indent" > Note that this command has the same limitations as <span -class="cmtt-10">\makefirstuc </span>which is used by -commands like <span -class="cmtt-10">\Gls </span>and <span -class="cmtt-10">\Glsentryname </span>to upper-case the first letter (see the notes about -<span +<!--l. 8805--><p class="nopar" > (If you want title-casing in your glossary style, you might want to investigate the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package.) This +command will trigger an error if the entry is undefined. +</p><!--l. 8810--><p class="indent" > Note that this command has the same limitations as <span +class="cmtt-10">\makefirstuc </span>which is used by commands like <span +class="cmtt-10">\Gls</span> +and <span +class="cmtt-10">\Glsentryname </span>to upper-case the first letter (see the notes about <span class="cmtt-10">\Gls </span>in <a -href="#sec:gls-like"><span -class="tcrm-1000">§</span>6.1 </a><a +href="#sec:gls-like">§6.1 </a><a href="#sec:gls-like">The <span -class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a>). -</p><!--l. 7902--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryname</span><span -class="cmtt-9"> </span></span><a - id="dx1-62007"></a> <span +class="cmtt-10">\gls</span>-Like Commands +(First Use Flag Queried)<!--tex4ht:ref: sec:gls-like --></a>). +</p><!--l. 8814--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140006"></a> <span class="cmtt-10">\glsentryname{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7904--><p class="noindent" > -</p><!--l. 7905--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryname</span><span -class="cmtt-9"> </span></span><a - id="dx1-62008"></a> <span +</p><!--l. 8816--><p class="noindent" > +</p><!--l. 8817--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140007"></a> <span class="cmtt-10">\Glsentryname{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7907--><p class="noindent" > +</p><!--l. 8819--><p class="noindent" > These commands display the name of the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩, as specified by the -<span -class="cmss-10">name</span><a - id="dx1-62009"></a> key. <span -class="cmtt-10">\Glsentryname </span>makes the first letter upper case. Neither of these commands check -for the existence of ⟨<span -class="cmti-10">label</span>⟩. The first form <span -class="cmtt-10">\glsentryname </span>is expandable (unless the name -contains unexpandable commands). Note that this may be different from the values of the -<span -class="cmss-10">text</span><a - id="dx1-62010"></a> or <span -class="cmss-10">first</span><a - id="dx1-62011"></a> keys. In general it’s better to use <span -class="cmtt-10">\glsentrytext </span>or <span -class="cmtt-10">\glsentryfirst </span>instead of +class="cmti-10">label</span>⟩, as specified by the <span +class="cmtt-10">name</span><a + id="dx1-140008"></a> key. <span +class="cmtt-10">\Glsentryname </span>makes the first letter upper case. Neither of these commands check for the existence of ⟨<span +class="cmti-10">label</span>⟩. +The first form <span +class="cmtt-10">\glsentryname </span>is expandable (unless the name contains unexpandable commands). Note that +this may be different from the values of the <span +class="cmtt-10">text</span><a + id="dx1-140009"></a> or <span +class="cmtt-10">first</span><a + id="dx1-140010"></a> keys. In general it’s better to use <span +class="cmtt-10">\glsentrytext </span>or +<span +class="cmtt-10">\glsentryfirst </span>instead of <span class="cmtt-10">\glsentryname</span>. -</p><!--l. 7918--><p class="indent" > <div class="important" title="Important Note"> In general it’s best to avoid <span -class="cmtt-10">\Glsentryname </span>with abbreviations. Instead, consider using +</p><!--l. 8830--><p class="indent" > <div class="important" title="Important Note"> In general it’s best to avoid <span +class="cmtt-10">\Glsentryname </span>with abbreviations. Instead, consider using <span +class="cmtt-10">\Glsentrylong</span>, <span -class="cmtt-10">\Glsentrylong</span>, <span class="cmtt-10">\Glsentryshort </span>or <span class="cmtt-10">\Glsentryfull</span>. </div> -</p><!--l. 7921--><p class="noindent" > -</p><!--l. 7923--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossentryname</span><span -class="cmtt-9"> </span></span><a - id="dx1-62012"></a> <span +</p><!--l. 8833--><p class="noindent" > +</p><!--l. 8835--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140011"></a> <span class="cmtt-10">\glossentryname{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7925--><p class="noindent" > +</p><!--l. 8837--><p class="noindent" > This is like <span class="cmtt-10">\glsnamefont</span><span class="cmsy-10">{</span><span @@ -16060,234 +18223,194 @@ class="cmtt-10">\glsentryname{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}</span><span class="cmsy-10">} </span>but also checks for the existence of ⟨<span -class="cmti-10">label</span>⟩. -This command is not expandable. It’s used in the predefined glossary styles, so if you want to -change the way the name is formatted in the glossary, you can redefine <span -class="cmtt-10">\glsnamefont </span>to use -the required fonts. For example: - - -</p> - <div class="verbatim" id="verbatim-262"> +class="cmti-10">label</span>⟩. This command is +not expandable. It’s used in the predefined glossary styles, so if you want to change the way the +name is formatted in the glossary, you can redefine <span +class="cmtt-10">\glsnamefont </span>to use the required fonts. For +example: + + +</p> + <div class="verbatim" id="verbatim-260"> \renewcommand*{\glsnamefont}[1]{\textmd{\sffamily #1}} </div> -<!--l. 7934--><p class="nopar" > -</p><!--l. 7935--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glossentryname</span><span -class="cmtt-9"> </span></span><a - id="dx1-62013"></a> <span +<!--l. 8846--><p class="nopar" > +</p><!--l. 8847--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140012"></a> <span class="cmtt-10">\Glossentryname{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7937--><p class="noindent" > +</p><!--l. 8849--><p class="noindent" > This is like <span class="cmtt-10">\glossentryname </span>but makes the first letter of the name upper case. -</p><!--l. 7941--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrytext</span><span -class="cmtt-9"> </span></span><a - id="dx1-62014"></a> <span +</p><!--l. 8853--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140013"></a> <span class="cmtt-10">\glsentrytext{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7943--><p class="noindent" > -</p><!--l. 7944--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrytext</span><span -class="cmtt-9"> </span></span><a - id="dx1-62015"></a> <span +</p><!--l. 8855--><p class="noindent" > +</p><!--l. 8856--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140014"></a> <span class="cmtt-10">\Glsentrytext{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7946--><p class="noindent" > +</p><!--l. 8858--><p class="noindent" > These commands display the subsequent use text for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩, as -specified by the <span -class="cmss-10">text</span><a - id="dx1-62016"></a> key. <span -class="cmtt-10">\Glsentrytext </span>makes the first letter upper case. The first form is -expandable (unless the text contains unexpandable commands). The second form is not -expandable. Neither checks for the existence of ⟨<span +class="cmti-10">label</span>⟩, as specified by the <span +class="cmtt-10">text</span><a + id="dx1-140015"></a> +key. <span +class="cmtt-10">\Glsentrytext </span>makes the first letter upper case. The first form is expandable (unless the text contains +unexpandable commands). The second form is not expandable. Neither checks for the existence of +⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 7954--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62017"></a> <span +</p><!--l. 8866--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140016"></a> <span class="cmtt-10">\glsentryplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7956--><p class="noindent" > -</p><!--l. 7957--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62018"></a> <span +</p><!--l. 8868--><p class="noindent" > +</p><!--l. 8869--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140017"></a> <span class="cmtt-10">\Glsentryplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7959--><p class="noindent" > +</p><!--l. 8871--><p class="noindent" > These commands display the subsequent use plural text for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩, -as specified by the <span -class="cmss-10">plural</span><a - id="dx1-62019"></a> key. <span -class="cmtt-10">\Glsentryplural </span>makes the first letter upper case. -The first form is expandable (unless the value of that key contains unexpandable -commands). The second form is not expandable. Neither checks for the existence of -⟨<span +class="cmti-10">label</span>⟩, as specified by the +<span +class="cmtt-10">plural</span><a + id="dx1-140018"></a> key. <span +class="cmtt-10">\Glsentryplural </span>makes the first letter upper case. The first form is expandable (unless the value +of that key contains unexpandable commands). The second form is not expandable. Neither checks for the +existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 7968--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-62020"></a> <span +</p><!--l. 8880--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140019"></a> <span class="cmtt-10">\glsentryfirst{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7970--><p class="noindent" > -</p><!--l. 7971--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-62021"></a> <span +</p><!--l. 8882--><p class="noindent" > +</p><!--l. 8883--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140020"></a> <span class="cmtt-10">\Glsentryfirst{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7973--><p class="noindent" > +</p><!--l. 8885--><p class="noindent" > These commands display the <a href="#glo:firstusetext">first use text</a> for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩, -as specified by the <span -class="cmss-10">first</span><a - id="dx1-62022"></a> key. <span -class="cmtt-10">\Glsentryfirst </span>makes the first letter upper case. -The first form is expandable (unless the value of that key contains unexpandable -commands). The second form is not expandable. Neither checks for the existence of +class="cmti-10">label</span>⟩, as specified by the <span +class="cmtt-10">first</span><a + id="dx1-140021"></a> key. +<span +class="cmtt-10">\Glsentryfirst </span>makes the first letter upper case. The first form is expandable (unless the value of that key +contains unexpandable commands). The second form is not expandable. Neither checks for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 7981--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62023"></a> <span +</p><!--l. 8893--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140022"></a> <span class="cmtt-10">\glsentryfirstplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7983--><p class="noindent" > -</p><!--l. 7984--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62024"></a> <span +</p><!--l. 8895--><p class="noindent" > +</p><!--l. 8896--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140023"></a> <span class="cmtt-10">\Glsentryfirstplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7986--><p class="noindent" > +</p><!--l. 8898--><p class="noindent" > These commands display the plural form of the <a -href="#glo:firstusetext">first use text</a> for the glossary entry given by -⟨<span -class="cmti-10">label</span>⟩, as specified by the <span -class="cmss-10">firstplural</span><a - id="dx1-62025"></a> key. <span -class="cmtt-10">\Glsentryfirstplural </span>makes the first letter upper -case. The first form is expandable (unless the value of that key contains unexpandable - - -commands). The second form is not expandable. Neither checks for the existence of -⟨<span +href="#glo:firstusetext">first use text</a> for the glossary entry given by ⟨<span +class="cmti-10">label</span>⟩, as specified +by the <span +class="cmtt-10">firstplural</span><a + id="dx1-140024"></a> key. <span +class="cmtt-10">\Glsentryfirstplural </span>makes the first letter upper case. The first form is expandable +(unless the value of that key contains unexpandable commands). The second form is not expandable. Neither +checks for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 7995--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrydesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-62026"></a> <span +</p><!--l. 8907--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140025"></a> <span class="cmtt-10">\glsentrydesc{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 7997--><p class="noindent" > -</p><!--l. 7998--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrydesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-62027"></a> <span + + +</p><!--l. 8909--><p class="noindent" > +</p><!--l. 8910--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140026"></a> <span class="cmtt-10">\Glsentrydesc{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8000--><p class="noindent" > +</p><!--l. 8912--><p class="noindent" > These commands display the description for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩. <span -class="cmtt-10">\Glsentrydesc</span> -makes the first letter upper case. The first form is expandable (unless the value of that key -contains unexpandable commands). The second form is not expandable. Neither checks for -the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 8007--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossentrydesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-62028"></a> <span +</p><!--l. 8916--><p class="indent" > <span +class="cmtt-10">\Glsentrydesc </span>makes the first letter upper case. The first form is expandable (unless the value of that key +contains unexpandable commands). The second form is not expandable. Neither checks for the existence of +⟨<span +class="cmti-10">label</span>⟩. +</p><!--l. 8921--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140027"></a> <span class="cmtt-10">\glossentrydesc{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8009--><p class="noindent" > +</p><!--l. 8923--><p class="noindent" > This is like <span class="cmtt-10">\glsentrydesc{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>but also checks for the existence of ⟨<span -class="cmti-10">label</span>⟩. This -command is not expandable. It’s used in the predefined glossary styles to display the -description. -</p><!--l. 8014--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glossentrydesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-62029"></a> <span +class="cmti-10">label</span>⟩. This command is not expandable. +It’s used in the predefined glossary styles to display the description. +</p><!--l. 8928--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140028"></a> <span class="cmtt-10">\Glossentrydesc{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8016--><p class="noindent" > +</p><!--l. 8930--><p class="noindent" > This is like <span class="cmtt-10">\glossentrydesc </span>but converts the first letter to upper case. This command is not expandable. -</p><!--l. 8020--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrydescplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62030"></a> <span +</p><!--l. 8934--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140029"></a> <span class="cmtt-10">\glsentrydescplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8022--><p class="noindent" > -</p><!--l. 8023--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrydescplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62031"></a> <span +</p><!--l. 8936--><p class="noindent" > +</p><!--l. 8937--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140030"></a> <span class="cmtt-10">\Glsentrydescplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8025--><p class="noindent" > +</p><!--l. 8939--><p class="noindent" > These commands display the plural description for the glossary entry given by ⟨<span +class="cmti-10">label</span>⟩. <span +class="cmtt-10">\Glsentrydescplural</span> +makes the first letter upper case. The first form is expandable (unless the value of that key contains +unexpandable commands). The second form is not expandable. Neither checks for the existence of +⟨<span class="cmti-10">label</span>⟩. -<span -class="cmtt-10">\Glsentrydescplural </span>makes the first letter upper case. The first form is expandable (unless -the value of that key contains unexpandable commands). The second form is not expandable. -Neither checks for the existence of ⟨<span -class="cmti-10">label</span>⟩. -</p><!--l. 8034--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrysymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-62032"></a> <span +</p><!--l. 8948--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140031"></a> <span class="cmtt-10">\glsentrysymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8036--><p class="noindent" > -</p><!--l. 8037--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrysymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-62033"></a> <span +</p><!--l. 8950--><p class="noindent" > +</p><!--l. 8951--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140032"></a> <span class="cmtt-10">\Glsentrysymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8039--><p class="noindent" > +</p><!--l. 8953--><p class="noindent" > These commands display the symbol for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩. <span -class="cmtt-10">\Glsentrysymbol</span> -makes the first letter upper case. The first form is expandable (unless the value of that key -contains unexpandable commands). The second form is not expandable. Neither checks for -the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 8047--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsletentryfield</span><span -class="cmtt-9"> </span></span><a - id="dx1-62034"></a> <span +</p><!--l. 8957--><p class="indent" > <span +class="cmtt-10">\Glsentrysymbol </span>makes the first letter upper case. The first form is expandable (unless the value of that +key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of +⟨<span +class="cmti-10">label</span>⟩. +</p><!--l. 8963--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140033"></a> <span class="cmtt-10">\glsletentryfield{</span>⟨<span class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -16295,328 +18418,274 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">field</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8049--><p class="noindent" > -This command doesn’t display anything. It merely fetches the value associated with the given -field (where the available field names are listed in <a -href="#tab:fieldmap">table 4.1</a>) and stores the result in the -control sequence ⟨<span -class="cmti-10">cs</span>⟩. For example, to store the description for the entry whose label is “apple” -in the control sequence <span class="obeylines-h"><span class="verb"><span +</p><!--l. 8965--><p class="noindent" > +This command doesn’t display anything. It merely fetches the value associated with the given field (where +the available field names are listed in <a +href="#tab:fieldmap">table 4.1</a>) and stores the result in the control sequence ⟨<span +class="cmti-10">cs</span>⟩. +For example, to store the description for the entry whose label is “apple” in the control sequence +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">\tmp</span></span></span>: - - + + </p> - <div class="verbatim" id="verbatim-263"> + <div class="verbatim" id="verbatim-261"> \glsletentryfield{\tmp}{apple}{desc} </div> -<!--l. 8058--><p class="nopar" > -</p><!--l. 8060--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossentrysymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-62035"></a> <span +<!--l. 8974--><p class="nopar" > +</p><!--l. 8976--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140034"></a> <span class="cmtt-10">\glossentrysymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8062--><p class="noindent" > +</p><!--l. 8978--><p class="noindent" > This is like <span class="cmtt-10">\glsentrysymbol{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>but also checks for the existence of ⟨<span -class="cmti-10">label</span>⟩. This command -is not expandable. It’s used in some of the predefined glossary styles to display the -symbol. -</p><!--l. 8067--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glossentrysymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-62036"></a> <span +class="cmti-10">label</span>⟩. This command is not expandable. +It’s used in some of the predefined glossary styles to display the symbol. +</p><!--l. 8983--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140035"></a> <span class="cmtt-10">\Glossentrysymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8069--><p class="noindent" > +</p><!--l. 8985--><p class="noindent" > This is like <span -class="cmtt-10">\glossentrysymbol </span>but converts the first letter to upper case. This command is -not expandable. -</p><!--l. 8073--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrysymbolplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62037"></a> <span +class="cmtt-10">\glossentrysymbol </span>but converts the first letter to upper case. This command is not +expandable. +</p><!--l. 8989--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140036"></a> <span class="cmtt-10">\glsentrysymbolplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8075--><p class="noindent" > -</p><!--l. 8076--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrysymbolplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-62038"></a> <span +</p><!--l. 8991--><p class="noindent" > +</p><!--l. 8992--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140037"></a> <span class="cmtt-10">\Glsentrysymbolplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8078--><p class="noindent" > +</p><!--l. 8994--><p class="noindent" > These commands display the plural symbol for the glossary entry given by ⟨<span +class="cmti-10">label</span>⟩. <span +class="cmtt-10">\Glsentrysymbolplural</span> +makes the first letter upper case. The first form is expandable (unless the value of that key contains +unexpandable commands). The second form is not expandable. Neither checks for the existence of +⟨<span class="cmti-10">label</span>⟩. -<span -class="cmtt-10">\Glsentrysymbolplural </span>makes the first letter upper case. The first form is expandable -(unless the value of that key contains unexpandable commands). The second form is not -expandable. Neither checks for the existence of ⟨<span -class="cmti-10">label</span>⟩. -</p><!--l. 8086--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuseri</span><span -class="cmtt-9"> </span></span><a - id="dx1-62039"></a> <span +</p><!--l. 9002--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140038"></a> <span class="cmtt-10">\glsentryuseri{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8088--><p class="noindent" > -</p><!--l. 8089--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuseri</span><span -class="cmtt-9"> </span></span><a - id="dx1-62040"></a> <span +</p><!--l. 9004--><p class="noindent" > +</p><!--l. 9005--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140039"></a> <span class="cmtt-10">\Glsentryuseri{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8091--><p class="noindent" > -</p><!--l. 8092--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuserii</span><span -class="cmtt-9"> </span></span><a - id="dx1-62041"></a> <span +</p><!--l. 9007--><p class="noindent" > +</p><!--l. 9008--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140040"></a> <span class="cmtt-10">\glsentryuserii{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8094--><p class="noindent" > -</p><!--l. 8095--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuserii</span><span -class="cmtt-9"> </span></span><a - id="dx1-62042"></a> <span +</p><!--l. 9010--><p class="noindent" > +</p><!--l. 9011--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140041"></a> <span class="cmtt-10">\Glsentryuserii{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8097--><p class="noindent" > -</p><!--l. 8098--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuseriii</span><span -class="cmtt-9"> </span></span><a - id="dx1-62043"></a> <span +</p><!--l. 9013--><p class="noindent" > +</p><!--l. 9014--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140042"></a> <span class="cmtt-10">\glsentryuseriii{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8100--><p class="noindent" > -</p><!--l. 8101--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuseriii</span><span -class="cmtt-9"> </span></span><a - id="dx1-62044"></a> <span +</p><!--l. 9016--><p class="noindent" > +</p><!--l. 9017--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140043"></a> <span class="cmtt-10">\Glsentryuseriii{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8103--><p class="noindent" > -</p><!--l. 8104--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuseriv</span><span -class="cmtt-9"> </span></span><a - id="dx1-62045"></a> <span +</p><!--l. 9019--><p class="noindent" > +</p><!--l. 9020--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140044"></a> <span class="cmtt-10">\glsentryuseriv{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8106--><p class="noindent" > -</p><!--l. 8107--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuseriv</span><span -class="cmtt-9"> </span></span><a - id="dx1-62046"></a> <span +</p><!--l. 9022--><p class="noindent" > +</p><!--l. 9023--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140045"></a> <span class="cmtt-10">\Glsentryuseriv{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> - - -</p><!--l. 8109--><p class="noindent" > -</p><!--l. 8110--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuserv</span><span -class="cmtt-9"> </span></span><a - id="dx1-62047"></a> <span + + +</p><!--l. 9025--><p class="noindent" > +</p><!--l. 9026--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140046"></a> <span class="cmtt-10">\glsentryuserv{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8112--><p class="noindent" > -</p><!--l. 8113--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuserv</span><span -class="cmtt-9"> </span></span><a - id="dx1-62048"></a> <span +</p><!--l. 9028--><p class="noindent" > +</p><!--l. 9029--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140047"></a> <span class="cmtt-10">\Glsentryuserv{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8115--><p class="noindent" > -</p><!--l. 8116--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryuservi</span><span -class="cmtt-9"> </span></span><a - id="dx1-62049"></a> <span +</p><!--l. 9031--><p class="noindent" > +</p><!--l. 9032--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140048"></a> <span class="cmtt-10">\glsentryuservi{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8118--><p class="noindent" > -</p><!--l. 8119--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryuservi</span><span -class="cmtt-9"> </span></span><a - id="dx1-62050"></a> <span +</p><!--l. 9034--><p class="noindent" > +</p><!--l. 9035--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140049"></a> <span class="cmtt-10">\Glsentryuservi{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8121--><p class="noindent" > +</p><!--l. 9037--><p class="noindent" > These commands display the value of the user keys for the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩. The -lower case forms are expandable (unless the value of the key contains unexpandable -commands). The commands beginning with an upper case letter convert the first letter of the -required value to upper case and are not expandable. None of these commands check for the -existence of ⟨<span +class="cmti-10">label</span>⟩. The lower case forms +are expandable (unless the value of the key contains unexpandable commands). The commands beginning with +an upper case letter convert the first letter of the required value to upper case and are not expandable. None of +these commands check for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 8130--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glshyperlink</span><span -class="cmtt-9"> </span></span><a - id="dx1-62051"></a> <span +</p><!--l. 9046--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140050"></a> <span class="cmtt-10">\glshyperlink[</span>⟨<span class="cmitt-10">link text</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8132--><p class="noindent" > +</p><!--l. 9048--><p class="noindent" > This command provides a hyperlink to the glossary entry given by ⟨<span -class="cmti-10">label</span>⟩ <span -class="cmbx-10">but does not add</span> -<span -class="cmbx-10">any information to the glossary file</span>. The link text is given by <span +class="cmti-10">label</span>⟩ <strong>but does not add +any information to the glossary file</strong>. The link text is given by <span class="cmtt-10">\glsentrytext</span><a - id="dx1-62052"></a><span + id="dx1-140051"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>by default<span class="footnote-mark"><a href="#fn1x9" id="fn1x9-bk"><sup class="textsuperscript">9.1</sup></a></span><a - id="x1-62053f1"></a>, -but can be overridden using the optional argument. Note that the hyperlink will be -suppressed if you have used <span + id="x1-140052f1"></a>, +but can be overridden using the optional argument. Note that the hyperlink will be suppressed if you have used +<span class="cmtt-10">\glsdisablehyper</span><a - id="dx1-62057"></a> or if you haven’t loaded the <span + id="dx1-140056"></a> or if you haven’t loaded the <span class="cmss-10">hyperref</span><a - id="dx1-62058"></a> -package. -</p><!--l. 8143--><p class="indent" > <div class="important" title="Important Note"> If you use <span -class="cmtt-10">\glshyperlink</span>, you need to ensure that the relevant entry has been added to -the glossary using any of the commands described in <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a + id="dx1-140057"></a> package. +</p><!--l. 9059--><p class="indent" > <div class="important" title="Important Note"> If you use <span +class="cmtt-10">\glshyperlink</span>, you need to ensure that the relevant entry has been added to the glossary using +any of the commands described in <a +href="#sec:glslink">§6 </a><a href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> or <a -href="#sec:glsadd"><span -class="tcrm-1000">§</span>7 -</a><a -href="#sec:glsadd">Adding an Entry to the Glossary Without Generating Text<!--tex4ht:ref: sec:glsadd --></a> otherwise you will end up with an -undefined link. </div> -</p><!--l. 8148--><p class="noindent" > -</p><!--l. 8150--><p class="indent" > The next two commands are only available with <a +href="#sec:glsadd">§7 </a><a +href="#sec:glsadd">Adding an Entry to the Glossary Without +Generating Text<!--tex4ht:ref: sec:glsadd --></a> otherwise you will end up with an undefined link. </div> +</p><!--l. 9064--><p class="noindent" > +</p><!--l. 9066--><p class="indent" > The next two commands are only available with <a href="#option1">Option 1</a> or with the <span class="cmss-10">savenumberlist</span><a - id="dx1-62059"></a> -package option: -</p><!--l. 8152--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrynumberlist</span><span -class="cmtt-9"> </span></span><a - id="dx1-62060"></a> <span + id="dx1-140058"></a> package +option: +</p><!--l. 9068--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140059"></a> <span class="cmtt-10">\glsentrynumberlist{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8154--><p class="noindent" > -</p><!--l. 8155--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdisplaynumberlist</span><span -class="cmtt-9"> </span></span><a - id="dx1-62061"></a> <span +</p><!--l. 9070--><p class="noindent" > +</p><!--l. 9071--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140060"></a> <span class="cmtt-10">\glsdisplaynumberlist{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8157--><p class="noindent" > +</p><!--l. 9073--><p class="noindent" > Both display the <a href="#glo:numberlist">number list<a - id="dx1-62062"></a></a> for the entry given by ⟨<span + id="dx1-140061"></a></a> for the entry given by ⟨<span class="cmti-10">label</span>⟩. When used with <a -href="#option1">Option 1</a> a rerun -is required to ensure this list is up-to-date, when used with Options <a +href="#option1">Option 1</a> a rerun is required to +ensure this list is up-to-date, when used with Options <a href="#option2">2</a> or <a -href="#option3">3</a> a run of -<a +href="#option3">3</a> a run of <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-62063"></a></a> (or <a + id="dx1-140062"></a></a> (or <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-62064"></a></a>/<a + id="dx1-140063"></a></a>/<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-62065"></a></a>) followed by one or two runs of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> is -required. -</p><!--l. 8164--><p class="indent" > The first command, <span -class="cmtt-10">\glsentrynumberlist</span>, simply displays the number list as is. The -second command, <span + id="dx1-140064"></a></a>) +followed by one or two runs of <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required. +</p><!--l. 9080--><p class="indent" > The first command, <span +class="cmtt-10">\glsentrynumberlist</span>, simply displays the number list as is. The second command, +<span class="cmtt-10">\glsdisplaynumberlist</span>, formats the list using: -</p><!--l. 8167--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnumlistsep</span><span -class="cmtt-9"> </span></span><a - id="dx1-62066"></a> <span +</p><!--l. 9083--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140065"></a> <span class="cmtt-10">\glsnumlistsep </span></div><hr> - - -</p><!--l. 8169--><p class="noindent" > +</p><!--l. 9085--><p class="noindent" > as the separator between all but the last two elements and -</p><!--l. 8171--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnumlistlastsep</span><span -class="cmtt-9"> </span></span><a - id="dx1-62067"></a> <span +</p><!--l. 9087--><p class="indent" > <hr><div title="Definition"><a + id="dx1-140066"></a> <span class="cmtt-10">\glsnumlistlastsep </span></div><hr> -</p><!--l. 8173--><p class="noindent" > +</p><!--l. 9089--><p class="noindent" > + + between the final two elements. The defaults are <span class="obeylines-h"><span class="verb"><span class="cmtt-10">,␣</span></span></span> and <span class="obeylines-h"><span class="verb"><span class="cmtt-10">␣\&␣</span></span></span>, respectively. -</p><!--l. 8177--><p class="indent" > <div class="important" title="Important Note"> <span +</p><!--l. 9093--><p class="indent" > <div class="important" title="Important Note"> <span class="cmtt-10">\glsdisplaynumberlist </span>is fairly experimental. It works with <a -href="#option1">Option 1</a>, but for -Options <a -href="#option2">2</a> or <a -href="#option3">3</a> it only works when the default counter format is used (that is, when the +href="#option1">Option 1</a>, but for Options <a +href="#option2">2</a> +or <a +href="#option3">3</a> it only works when the default counter format is used (that is, when the <span +class="cmtt-10">format</span><a + id="dx1-140067"></a> key is set to <span -class="cmss-10">format</span><a - id="dx1-62068"></a> key is set to <span class="cmtt-10">glsnumberformat</span>). This command will only work with <span class="cmss-10">hyperref</span><a - id="dx1-62069"></a> if you -choose <a -href="#option1">Option 1</a>. If you try using this command with Options <a + id="dx1-140068"></a> if you choose <a +href="#option1">Option 1</a>. If you try using +this command with Options <a href="#option2">2</a> or <a href="#option3">3</a> and <span class="cmss-10">hyperref</span><a - id="dx1-62070"></a>, -<span -class="cmtt-10">\glsentrynumberlist </span>will be used instead. </div> -</p><!--l. 8185--><p class="noindent" > -</p><!--l. 8187--><p class="indent" > For further information see “Displaying entry details without adding information to the -glossary” in the documented code (<span + id="dx1-140069"></a>, <span +class="cmtt-10">\glsentrynumberlist </span>will be used instead. +</div> +</p><!--l. 9101--><p class="noindent" > +</p><!--l. 9103--><p class="indent" > For further information see “Displaying entry details without adding information to the glossary” in the +documented code (<span class="cmtt-10">glossaries-code.pdf</span>). - - + + </p> -<!--l. 8191--><p class="indent" > </div> -</p><!--l. 8191--><p class="noindent" ><a +<!--l. 9107--><p class="indent" > </div> +</p><!--l. 9107--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">10. <a id="sec:printglossary"></a>Displaying a glossary</h2> -</p><!--l. 8194--><p class="indent" > All defined glossaries may be displayed using: +</p><!--l. 9110--><p class="indent" > All defined glossaries may be displayed using: </p><dl class="description"><dt class="description"> <a href="#option1"><span class="cmbx-10">Option</span><span class="cmbx-10"> 1</span></a><span class="cmbx-10">:</span> </dt><dd -class="description"> - <!--l. 8197--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printnoidxglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-63001"></a> <span -class="cmtt-10">\printnoidxglossaries </span></div><hr> - </p><!--l. 8199--><p class="noindent" > - (Must be used with <span +class="description">(Must be used with <span class="cmtt-10">\makenoidxglossaries</span><a - id="dx1-63002"></a> in the preamble.) + id="dx1-141001"></a> in the preamble.) + <!--l. 9114--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-141002"></a> <span +class="cmtt-10">\printnoidxglossaries </span></div><hr> + </p><!--l. 9116--><p class="noindent" > </p></dd><dt class="description"> <span class="cmbx-10">Options</span><span @@ -16628,64 +18697,72 @@ class="cmbx-10"> </span><a href="#option3"><span class="cmbx-10">3</span></a><span class="cmbx-10">:</span> </dt><dd -class="description"> - <!--l. 8203--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-63003"></a> <span -class="cmtt-10">\printglossaries </span></div><hr> - </p><!--l. 8205--><p class="noindent" > - (Must be used with <span +class="description">(Must be used with <span class="cmtt-10">\makeglossaries</span><a - id="dx1-63004"></a> in the preamble.)</p></dd></dl> -<!--l. 8209--><p class="indent" > These commands will display all the glossaries in the order in which they were defined. -Note that, in the case of Options <a + id="dx1-141003"></a> in the preamble.) + <!--l. 9120--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-141004"></a> <span +class="cmtt-10">\printglossaries </span></div><hr> + </p><!--l. 9122--><p class="noindent" > + </p></dd></dl> +<!--l. 9125--><p class="indent" > These commands will display all the glossaries in the order in which they were defined. +</p><!--l. 9128--><p class="indent" > Note that, in the case of Options <a href="#option2">2</a> and <a -href="#option3">3</a>, no glossaries will appear until you have either used -the Perl script <a +href="#option3">3</a>, no glossaries will appear until you have either used the Perl script +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-63005"></a></a> or Lua script <a + id="dx1-141005"></a></a> or Lua script <a href="#glo:makeglossaries-lite.lua"><span class="cmtt-10">makeglossaries-lite</span><a - id="dx1-63006"></a></a> or have directly used -<a + id="dx1-141006"></a></a> or have directly used <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-63007"></a></a> or <a + id="dx1-141007"></a></a> or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-63008"></a></a> (as described in <a -href="#sec:makeglossaries"><span -class="tcrm-1000">§</span>1.5 </a><a + id="dx1-141008"></a></a> (as described +in <a +href="#sec:makeglossaries">§1.4 </a><a href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a>). -(While the external files are missing, these commands will just do <span -class="cmtt-10">\null </span>for each -missing glossary to assist dictionary style documents that just use <span -class="cmtt-10">\glsaddall</span> -without inserting any text. If you use <a +</p><!--l. 9134--><p class="indent" > <div class="important" title="Important Note"> While the external files are missing, <span +class="cmtt-10">\printglossary </span>will just do <span +class="cmtt-10">\null</span><a + id="dx1-141009"></a> for each missing glossary to assist +dictionary style documents that just use <span +class="cmtt-10">\glsaddall </span>without inserting any text. This use of <span +class="cmtt-10">\null</span><a + id="dx1-141010"></a> ensures that +all indexing information is written before the final page is shipped out. Once the external files are present <span +class="cmtt-10">\null</span> +will no longer be used. This can cause a spurious blank page on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run before the glossary files +have been created. Once these files are present, <span +class="cmtt-10">\null </span>will no longer be used and so shouldn’t cause interference +for the final document. </div> +</p><!--l. 9145--><p class="noindent" > +</p><!--l. 9147--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you use <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a>, it will insert a heading and -boilerplate text when the external files are missing. The extension package also provides -<span +class="cmss-10">glossaries-extra</span></a>, it will insert a heading and boilerplate text when the external files are missing. +The extension package also provides <span class="cmtt-10">\printunsrtglossaries </span>as an alternative. See the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> manual for further -details.) -</p><!--l. 8223--><p class="indent" > If the glossary still does not appear after you re-<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> your document, check the -<span +class="cmss-10">glossaries-extra</span></a> manual +for further details. </div> +</p><!--l. 9152--><p class="noindent" > +</p><!--l. 9154--><p class="indent" > If the glossary still does not appear after you re-<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> your document, check the <span class="cmtt-10">makeindex</span><a - id="dx1-63009"></a>/<span + id="dx1-141011"></a>/<span class="cmtt-10">xindy</span><a - id="dx1-63010"></a> log files to see if there is a problem. With <a -href="#option1">Option 1</a>, you just need two -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> runs to make the glossaries appear, but you may need further runs to make the -<a + id="dx1-141012"></a> log +files to see if there is a problem. With <a +href="#option1">Option 1</a>, you just need two <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> runs to make the glossaries appear, +but you may need further runs to make the <a href="#glo:numberlist">number list<a - id="dx1-63011"></a>s</a> up-to-date. -</p><!--l. 8229--><p class="indent" > An individual glossary can be displayed using: + id="dx1-141013"></a>s</a> up-to-date. +</p><!--l. 9160--><p class="indent" > An individual glossary can be displayed using: </p><dl class="description"><dt class="description"> <a href="#option1"><span @@ -16693,17 +18770,15 @@ class="cmbx-10">Option</span><span class="cmbx-10"> 1</span></a><span class="cmbx-10">:</span> </dt><dd class="description"> - <!--l. 8232--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printnoidxglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-63012"></a> <span + <!--l. 9163--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-141014"></a> <span class="cmtt-10">\printnoidxglossary[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 8234--><p class="noindent" > + </p><!--l. 9165--><p class="noindent" > (Must be used with <span class="cmtt-10">\makenoidxglossaries</span><a - id="dx1-63013"></a> in the preamble.) + id="dx1-141015"></a> in the preamble.) </p></dd><dt class="description"> <span class="cmbx-10">Options</span><span @@ -16716,184 +18791,173 @@ href="#option3"><span class="cmbx-10">3</span></a><span class="cmbx-10">:</span> </dt><dd class="description"> - <!--l. 8238--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\printglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-63014"></a> <span + + + <!--l. 9169--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-141016"></a> <span class="cmtt-10">\printglossary[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">] </span></div><hr> - </p><!--l. 8240--><p class="noindent" > + </p><!--l. 9171--><p class="noindent" > (Must be used with <span class="cmtt-10">\makeglossaries</span><a - id="dx1-63015"></a> in the preamble.)</p></dd></dl> -<!--l. 8243--><p class="noindent" >where ⟨<span + id="dx1-141017"></a> in the preamble.)</p></dd></dl> +<!--l. 9174--><p class="noindent" >where ⟨<span class="cmti-10">options</span>⟩ is a ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ list of options. (Again, when the associated external file is missing, -<span -class="cmtt-10">\null </span>is inserted into the document.) - - -</p><!--l. 8247--><p class="indent" > The following keys are available: +class="cmti-10">value</span>⟩ list of options. (Again, when the associated external file is missing, <span +class="cmtt-10">\null </span>is inserted +into the document.) +</p><!--l. 9178--><p class="indent" > The following keys are available: </p><dl class="description"><dt class="description"> <span -class="cmssbx-10">type</span><a - id="dx1-63016"></a> </dt><dd -class="description">The value of this key specifies which glossary to print. If omitted, the default glossary is - assumed. For example, to print the list of acronyms: - - - <div class="verbatim" id="verbatim-264"> +class="cmtt-10">type</span><a + id="dx1-141018"></a> </dt><dd +class="description">The value of this key specifies which glossary to print. If omitted, the default glossary is assumed. For + example, to print the list of acronyms: + + + <div class="verbatim" id="verbatim-262"> \printglossary[type=\acronymtype] </div> - <!--l. 8254--><p class="nopar" > Note that you can’t display an ignored glossary, so don’t try setting <span -class="cmss-10">type</span><a - id="dx1-63017"></a> to the name of - a glossary that was defined using <span + <!--l. 9185--><p class="nopar" > Note that you can’t display an ignored glossary, so don’t try setting <span +class="cmtt-10">type</span><a + id="dx1-141019"></a> to the name of a glossary that + was defined using <span class="cmtt-10">\newignoredglossary</span><a - id="dx1-63018"></a>, described in <a -href="#sec:newglossary"><span -class="tcrm-1000">§</span>12 </a><a -href="#sec:newglossary">Defining New - Glossaries<!--tex4ht:ref: sec:newglossary --></a>. (You can display an ignored glossary with <span -class="cmtt-10">\printunsrtglossary </span>provided - by <a + id="dx1-141020"></a>, described in <a +href="#sec:newglossary">§12 </a><a +href="#sec:newglossary">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>. (You can display an + ignored glossary with <span +class="cmtt-10">\printunsrtglossary </span>provided by <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a>.) </p></dd><dt class="description"> <span -class="cmssbx-10">title</span><a - id="dx1-63019"></a> </dt><dd -class="description">This is the glossary’s title (overriding the title specified when the glossary was - defined). +class="cmtt-10">title</span><a + id="dx1-141021"></a> </dt><dd +class="description">This is the glossary’s title (overriding the title specified when the glossary was defined). </dd><dt class="description"> <span -class="cmssbx-10">toctitle</span><a - id="dx1-63020"></a> </dt><dd +class="cmtt-10">toctitle</span><a + id="dx1-141022"></a> </dt><dd class="description">This is the title to use for the table of contents (if the <span class="cmss-10">toc</span><a - id="dx1-63021"></a> package option has been - used). It may also be used for the page header, depending on the page style. If omitted, - the value of <span -class="cmss-10">title</span><a - id="dx1-63022"></a> is used. + id="dx1-141023"></a> package option has been used). It may also + be used for the page header, depending on the page style. If omitted, the value of <span +class="cmtt-10">title</span><a + id="dx1-141024"></a> is + used. </dd><dt class="description"> <span -class="cmssbx-10">style</span><a - id="dx1-63023"></a> </dt><dd -class="description">This specifies which glossary style to use for this glossary, overriding the effect of the - <span +class="cmtt-10">style</span><a + id="dx1-141025"></a> </dt><dd +class="description">This specifies which glossary style to use for this glossary, overriding the effect of the <span class="cmss-10">style</span><a - id="dx1-63024"></a> package option or <span + id="dx1-141026"></a> package option + or <span class="cmtt-10">\glossarystyle</span><a - id="dx1-63025"></a>. + id="dx1-141027"></a>. </dd><dt class="description"> <span -class="cmssbx-10">numberedsection</span><a - id="dx1-63026"></a> </dt><dd -class="description">This specifies whether to use a numbered section for this glossary, - overriding the effect of the <span +class="cmtt-10">numberedsection</span><a + id="dx1-141028"></a> </dt><dd +class="description">This specifies whether to use a numbered section for this glossary, overriding the effect of the + <span class="cmss-10">numberedsection</span><a - id="dx1-63027"></a> package option. This key has the same - syntax as the <span + id="dx1-141029"></a> package option. This key has the same syntax as the <span class="cmss-10">numberedsection</span><a - id="dx1-63028"></a> package option, described in <a -href="#sec:pkgopts-sec"><span -class="tcrm-1000">§</span>2.2 </a><a -href="#sec:pkgopts-sec">Sectioning, Headings - and TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. + id="dx1-141030"></a> package option, + described in <a +href="#sec:pkgopts-sec">§2.2 </a><a +href="#sec:pkgopts-sec">Sectioning, Headings and TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. </dd><dt class="description"> <span -class="cmssbx-10">nonumberlist</span><a - id="dx1-63029"></a> </dt><dd +class="cmtt-10">nonumberlist</span><a + id="dx1-141031"></a> </dt><dd class="description">This is a boolean key. If true (<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">nonumberlist=true</span></span></span>) the numberlist is - suppressed for this glossary. If false (<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">nonumberlist=false</span></span></span>) the numberlist is displayed - for this glossary. +class="cmtt-10">nonumberlist=true</span></span></span>) the numberlist is suppressed for this + glossary. If false (<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">nonumberlist=false</span></span></span>) the numberlist is displayed for this glossary. </dd><dt class="description"> <span -class="cmssbx-10">nogroupskip</span><a - id="dx1-63030"></a> </dt><dd -class="description">This is a boolean key. If true the vertical gap between groups is suppressed for - this glossary. +class="cmtt-10">nogroupskip</span><a + id="dx1-141032"></a> </dt><dd +class="description">This is a boolean key. If true the vertical gap between groups is suppressed for this + glossary. </dd><dt class="description"> <span -class="cmssbx-10">nopostdot</span><a - id="dx1-63031"></a> </dt><dd -class="description">This is a boolean key. If true the full stop after the description is suppressed for - this glossary. +class="cmtt-10">nopostdot</span><a + id="dx1-141033"></a> </dt><dd +class="description">This is a boolean key. If true the full stop after the description is suppressed for this + glossary. </dd><dt class="description"> <span -class="cmssbx-10">entrycounter</span><a - id="dx1-63032"></a> </dt><dd -class="description">This is a boolean key. Behaves similar to the package option of the same name. - The corresponding package option must be used to make <span +class="cmtt-10">entrycounter</span><a + id="dx1-141034"></a> </dt><dd +class="description">This is a boolean key. Behaves similar to the package option of the same name. The + corresponding package option must be used to make <span class="cmtt-10">\glsrefentry</span><a - id="dx1-63033"></a> work - correctly. - - + id="dx1-141035"></a> work correctly. </dd><dt class="description"> <span -class="cmssbx-10">subentrycounter</span><a - id="dx1-63034"></a> </dt><dd -class="description">This is a boolean key. Behaves similar to the package option of the same - name. If you want to set both <span -class="cmss-10">entrycounter</span><a - id="dx1-63035"></a> and <span -class="cmss-10">subentrycounter</span><a - id="dx1-63036"></a>, make sure you specify - <span -class="cmss-10">entrycounter</span><a - id="dx1-63037"></a> first. The corresponding package option must be used to make - <span +class="cmtt-10">subentrycounter</span><a + id="dx1-141036"></a> </dt><dd +class="description">This is a boolean key. Behaves similar to the package option of the same name. If you want + to set both <span +class="cmtt-10">entrycounter</span><a + id="dx1-141037"></a> and <span +class="cmtt-10">subentrycounter</span><a + id="dx1-141038"></a>, make sure you specify <span +class="cmtt-10">entrycounter</span><a + id="dx1-141039"></a> first. The + corresponding package option must be used to make <span class="cmtt-10">\glsrefentry</span><a - id="dx1-63038"></a> work correctly. + id="dx1-141040"></a> work correctly. </dd><dt class="description"> <span -class="cmssbx-10">sort</span><a - id="dx1-63039"></a> </dt><dd +class="cmtt-10">sort</span><a + id="dx1-141041"></a> </dt><dd class="description">This key is only available for <a href="#option1">Option 1</a>. Possible values are: <span class="cmtt-10">word </span>(word order), <span -class="cmtt-10">letter</span> - (letter order), <span +class="cmtt-10">letter </span>(letter order), + + + <span class="cmtt-10">standard </span>(word or letter ordering taken from the <span class="cmss-10">order</span><a - id="dx1-63040"></a> package option), - <span + id="dx1-141042"></a> package option), <span class="cmtt-10">use </span>(order of use), <span -class="cmtt-10">def </span>(order of definition) <span +class="cmtt-10">def </span>(order of + definition) <span class="cmtt-10">nocase </span>(case-insensitive) or <span -class="cmtt-10">case</span> - (case-sensitive). Note that the word and letter comparisons (that is, everything other - than <span +class="cmtt-10">case </span>(case-sensitive). Note that the word and letter comparisons + (that is, everything other than <span class="cmtt-10">sort=use </span>and <span -class="cmtt-10">sort=def</span>) just use a simple character code comparison. For a - locale-sensitive sort, you must use either <a +class="cmtt-10">sort=def</span>) just use a simple character code comparison. For + a locale-sensitive sort, you must use either <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-63041"></a></a> (<a + id="dx1-141043"></a></a> (<a href="#option3">Option 3</a>) or <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-63042"></a></a> (<a -href="#option4">Option 4</a>). - Note that <a + id="dx1-141044"></a></a> (<a +href="#option4">Option 4</a>). Note that <a href="#glo:bib2gls"><span class="cmtt-10">bib2gls</span><a - id="dx1-63043"></a></a> provides many other sort options. - <!--l. 8318--><p class="noindent" ><div class="important" title="Important Note"> If you use the <span + id="dx1-141045"></a></a> + provides many other sort options. + <!--l. 9249--><p class="noindent" ><div class="important" title="Important Note"> If you use the <span class="cmtt-10">use </span>or <span -class="cmtt-10">def </span>values make sure that you select a glossary style that doesn’t - have a visual indicator between groups, as the grouping no longer makes sense. Consider - using the <span +class="cmtt-10">def </span>values make sure that you select a glossary style that doesn’t have a visual + indicator between groups, as the grouping no longer makes sense. Consider using the <span class="cmss-10">nogroupskip</span><a - id="dx1-63044"></a> option. </div> - </p><!--l. 8323--><p class="noindent" > - </p><!--l. 8326--><p class="noindent" >The + id="dx1-141046"></a> option. + </div> + </p><!--l. 9254--><p class="noindent" > + </p><!--l. 9257--><p class="noindent" >The word and letter @@ -16903,14 +18967,14 @@ class="cmss-10">nogroupskip</span><a use <span class="cmss-10">datatool</span><a - id="dx1-63045"></a>’s + id="dx1-141047"></a>’s <span class="cmtt-10">\dtlwordindexcompare</span><a - id="dx1-63046"></a> + id="dx1-141048"></a> and <span class="cmtt-10">\dtlletterindexcompare</span><a - id="dx1-63047"></a> + id="dx1-141049"></a> handlers. The case-insensitive @@ -16919,10 +18983,10 @@ class="cmtt-10">\dtlletterindexcompare</span><a uses <span class="cmss-10">datatool</span><a - id="dx1-63048"></a>’s + id="dx1-141050"></a>’s <span class="cmtt-10">\dtlicompare</span><a - id="dx1-63049"></a> + id="dx1-141051"></a> handler. The case-sensitive @@ -16931,135 +18995,190 @@ class="cmtt-10">\dtlicompare</span><a uses <span class="cmss-10">datatool</span><a - id="dx1-63050"></a>’s - - + id="dx1-141052"></a>’s <span class="cmtt-10">\dtlcompare</span><a - id="dx1-63051"></a> + id="dx1-141053"></a> handler. See the <span class="cmss-10">datatool</span><a - id="dx1-63052"></a> + id="dx1-141054"></a> documentation for further + + details. - </p><!--l. 8335--><p class="noindent" >If you don’t get an error with <span + </p><!--l. 9266--><p class="noindent" >If you don’t get an error with <span class="cmtt-10">sort=use </span>and <span -class="cmtt-10">sort=def </span>but you do get an error with one - of the other sort options, then you probably need to use the <span -class="cmss-10">sanitizesort=true</span><a - id="dx1-63053"></a> package - option or make sure none of the entries have fragile commands in their <span -class="cmss-10">sort</span><a - id="dx1-63054"></a> - field.</p></dd></dl> -<!--l. 8342--><p class="indent" > By default, the glossary is started either by <span +class="cmtt-10">sort=def </span>but you do get an error with one of the other sort + options, then you probably need to use the <span +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-141055"></a> package option or make sure none of the + entries have fragile commands in their <span +class="cmtt-10">sort</span><a + id="dx1-141056"></a> field. + </p></dd><dt class="description"> +<a + id="dx1-141057"></a><span id="textcolor276"><span +class="cmtt-10">label={</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}</span></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and labels the glossary with <span +class="cmtt-10">\label{</span>⟨<span +class="cmti-10">label</span>⟩<span +class="cmtt-10">}</span>. This + is an alternative to the package option <span +class="cmss-10">numberedsection</span><span +class="cmtt-10">=</span><span +class="cmss-10">autolabel</span><a + id="dx1-141058"></a> + </dd><dt class="description"> +<a + id="dx1-141059"></a><span id="textcolor277"><span +class="cmtt-10">target</span></span> </dt><dd +class="description">This is a boolean key only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, which can be used to switch off the + automatic hypertarget for each entry. (This refers to the target used by commands like <span +class="cmtt-10">\gls </span>and + <span +class="cmtt-10">\glslink</span>.) + <!--l. 9282--><p class="noindent" >This option is useful with <span id="textcolor278"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-141060"></a> as it allows the same list (of sub-list) of entries to be + displayed multiple times without causing duplicate hypertarget names. + </p></dd><dt class="description"> +<a + id="dx1-141061"></a><span id="textcolor279"><span +class="cmtt-10">prefix={</span>⟨<span +class="cmitt-10">prefix</span>⟩<span +class="cmtt-10">}</span></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and provides another way of avoiding + duplicate hypertarget names is to use a different prefix for those names. This locally redefines + <span +class="cmtt-10">\glolinkprefix</span><a + id="dx1-141062"></a> but note this will also affect the target for any entry referenced within the glossary with + commands like <span +class="cmtt-10">\gls</span>, <span +class="cmtt-10">\glslink </span>or <span +class="cmtt-10">\glshypertarget</span>. + </dd><dt class="description"> +<a + id="dx1-141063"></a><span id="textcolor280"><span +class="cmtt-10">targetnameprefix={</span>⟨<span +class="cmitt-10">prefix</span>⟩<span +class="cmtt-10">}</span></span> </dt><dd +class="description">This key is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. This is similar to the <span +class="cmss-10">prefix</span> + option, but it alters the prefix of the hypertarget anchors without changing <span +class="cmtt-10">\glslinkprefix</span><a + id="dx1-141064"></a> (so it won’t + change the hyperlinks for any entries referenced in the glossary). + </dd></dl> +<!--l. 9303--><p class="indent" > By default, the glossary is started either by <span class="cmtt-10">\chapter*</span><a - id="dx1-63055"></a> or by <span + id="dx1-141065"></a> or by <span class="cmtt-10">\section*</span><a - id="dx1-63056"></a>, depending on -whether or not <span + id="dx1-141066"></a>, depending on whether or not +<span class="cmtt-10">\chapter</span><a - id="dx1-63057"></a> is defined. This can be overridden by the <span + id="dx1-141067"></a> is defined. This can be overridden by the <span class="cmss-10">section</span><a - id="dx1-63058"></a> package option or -the <span + id="dx1-141068"></a> package option or the <span class="cmtt-10">\setglossarysection</span><a - id="dx1-63059"></a> command. Numbered sectional units can be obtained using -the <span + id="dx1-141069"></a> +command. Numbered sectional units can be obtained using the <span class="cmss-10">numberedsection</span><a - id="dx1-63060"></a> package option. Each glossary sets the page header via the -command -</p><!--l. 8348--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsglossarymark</span><span -class="cmtt-9"> </span></span><a - id="dx1-63061"></a> <span + id="dx1-141070"></a> package option. Each glossary +sets the page header via the command +</p><!--l. 9309--><p class="indent" > <hr><div title="Definition"><a + id="dx1-141071"></a> <span class="cmtt-10">\glsglossarymark</span><a - id="dx1-63062"></a><span + id="dx1-141072"></a><span class="cmtt-10">{</span>⟨<span class="cmitt-10">title</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8350--><p class="noindent" > -If this mechanism is unsuitable for your chosen class file or page style package, you will need -to redefine <span +</p><!--l. 9311--><p class="noindent" > +If this mechanism is unsuitable for your chosen class file or page style package, you will need to redefine +<span class="cmtt-10">\glsglossarymark</span><a - id="dx1-63063"></a>. Further information about these options and commands is -given in <a -href="#sec:pkgopts-sec"><span -class="tcrm-1000">§</span>2.2 </a><a -href="#sec:pkgopts-sec">Sectioning, Headings and TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. -</p><!--l. 8356--><p class="indent" > Information can be added to the start of the glossary (after the title and before the main -body of the glossary) by redefining -</p><!--l. 8358--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossarypreamble</span><span -class="cmtt-9"> </span></span><a - id="dx1-63064"></a> <span + id="dx1-141073"></a>. Further information about these options and commands is given in <a +href="#sec:pkgopts-sec">§2.2 </a><a +href="#sec:pkgopts-sec">Sectioning, Headings +and TOC Options<!--tex4ht:ref: sec:pkgopts-sec --></a>. +</p><!--l. 9317--><p class="indent" > Information can be added to the start of the glossary (after the title and before the main body of the +glossary) by redefining +</p><!--l. 9319--><p class="indent" > <hr><div title="Definition"><a + id="dx1-141074"></a> <span class="cmtt-10">\glossarypreamble </span></div><hr> -</p><!--l. 8360--><p class="noindent" > +</p><!--l. 9321--><p class="noindent" > For example: - - + + </p> - <div class="verbatim" id="verbatim-265"> + <div class="verbatim" id="verbatim-263"> \renewcommand{\glossarypreamble}{Numbers in italic  <br />indicate primary definitions.} </div> -<!--l. 8365--><p class="nopar" > This needs to be done before the glossary is displayed. -</p><!--l. 8368--><p class="indent" > If you want a different preamble per glossary you can use -</p><!--l. 8369--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setglossarypreamble</span><span -class="cmtt-9"> </span></span><a - id="dx1-63065"></a> <span +<!--l. 9326--><p class="nopar" > This needs to be done before the glossary is displayed. +</p><!--l. 9329--><p class="indent" > If you want a different preamble per glossary you can use +</p><!--l. 9330--><p class="indent" > <hr><div title="Definition"><a + id="dx1-141075"></a> <span class="cmtt-10">\setglossarypreamble[</span>⟨<span class="cmitt-10">type</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">preamble text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8371--><p class="noindent" > +</p><!--l. 9332--><p class="noindent" > If ⟨<span class="cmti-10">type</span>⟩ is omitted, <span class="cmtt-10">\glsdefaulttype </span>is used. -</p><!--l. 8374--><p class="indent" > For example: - - +</p><!--l. 9335--><p class="indent" > For example: + + </p> - <div class="verbatim" id="verbatim-266"> + <div class="verbatim" id="verbatim-264"> \setglossarypreamble{Numbers in italic  <br />indicate primary definitions.} </div> -<!--l. 8378--><p class="nopar" > This will print the given preamble text for the main glossary, but not have any preamble text -for any other glossaries. -</p><!--l. 8382--><p class="indent" > There is an analogous command to <span +<!--l. 9339--><p class="nopar" > This will print the given preamble text for the main glossary, but not have any preamble text for any other +glossaries. +</p><!--l. 9343--><p class="indent" > There is an analogous command to <span class="cmtt-10">\glossarypreamble </span>called -</p><!--l. 8383--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossarypostamble</span><span -class="cmtt-9"> </span></span><a - id="dx1-63066"></a> <span +</p><!--l. 9344--><p class="indent" > <hr><div title="Definition"><a + id="dx1-141076"></a> <span class="cmtt-10">\glossarypostamble </span></div><hr> -</p><!--l. 8385--><p class="noindent" > +</p><!--l. 9346--><p class="noindent" > which is placed at the end of each glossary. <a - id="x1-63067r15"></a> -</p><!--l. 8388--><p class="noindent" ><span + id="ex:twocolumn"></a> +</p><!--l. 9349--><p class="noindent" ><span class="cmbx-12">Example 15</span><span class="cmbx-12"> (Switch to Two Column Mode for Glossary)</span><a - id="x1-63068"></a> -</p><!--l. 8389--><p class="indent" > Suppose you are using the <span + id="x1-141078"></a> +</p><!--l. 9350--><p class="indent" > Suppose you are using the <span class="cmss-10">superheaderborder</span><a - id="dx1-63069"></a> + id="dx1-141079"></a> style<span class="footnote-mark"><a href="#fn1x10" id="fn1x10-bk"><sup class="textsuperscript">10.1</sup></a></span><a - id="x1-63070f1"></a>, -and you want the glossary to be in two columns, but after the glossary you want to switch -back to one column mode, you could do: - - + id="x1-141080f1"></a>, +and you want the glossary to be in two columns, but after the glossary you want to switch back to one column +mode, you could do: + + </p> - <div class="verbatim" id="verbatim-267"> + <div class="verbatim" id="verbatim-265"> \renewcommand*{\glossarysection}[2][]{%  <br />  \twocolumn[{\chapter*{#2}}]%  <br />  \setlength\glsdescwidth{0.6\linewidth}% @@ -17067,611 +19186,570 @@ back to one column mode, you could do:  <br />}  <br />\renewcommand*{\glossarypostamble}{\onecolumn} </div> -<!--l. 8403--><p class="nopar" > +<!--l. 9364--><p class="nopar" > </p> <div class="center" > -<!--l. 8405--><p class="noindent" > -</p><!--l. 8405--><p class="noindent" >____________________________</p></div> -<!--l. 8407--><p class="indent" > Within each glossary, each entry name is formatted according to -</p><!--l. 8408--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnamefont</span><span -class="cmtt-9"> </span></span><a - id="dx1-63074"></a> <span +<!--l. 9366--><p class="noindent" > +</p><!--l. 9366--><p class="noindent" >____________________________</p></div> +<!--l. 9368--><p class="indent" > Within each glossary, each entry name is formatted according to +</p><!--l. 9369--><p class="indent" > <hr><div title="Definition"><a + id="dx1-141084"></a> <span class="cmtt-10">\glsnamefont{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8410--><p class="noindent" > -which takes one argument: the entry name. This command is always used regardless of the -glossary style. By default, <span -class="cmtt-10">\glsnamefont </span>simply displays its argument in whatever the -surrounding font happens to be. This means that in the list-like glossary styles (defined in -the <span +</p><!--l. 9371--><p class="noindent" > +which takes one argument: the entry name. This command is always used regardless of the glossary style. By +default, <span +class="cmtt-10">\glsnamefont </span>simply displays its argument in whatever the surrounding font happens to be. +This means that in the list-like glossary styles (defined in the <span class="cmss-10">glossary-list</span><a - id="dx1-63075"></a> style file) the name will appear in bold, since the name is placed -in the optional argument of <span -class="cmtt-10">\item</span>, whereas in the tabular styles (defined in the -<span + id="dx1-141085"></a> style file) the name will +appear in bold, since the name is placed in the optional argument of <span +class="cmtt-10">\item</span>, whereas in the tabular +styles (defined in the <span class="cmss-10">glossary-long</span><a - id="dx1-63076"></a> and <span + id="dx1-141086"></a> and <span class="cmss-10">glossary-super</span><a - id="dx1-63077"></a> style files) the name will appear in the normal font. The -hierarchical glossary styles (defined in the <span + id="dx1-141087"></a> style files) the name will appear in the normal +font. The hierarchical glossary styles (defined in the <span class="cmss-10">glossary-tree</span><a - id="dx1-63078"></a> style file) also set the name in + id="dx1-141088"></a> style file) also set the name in bold. -</p><!--l. 8423--><p class="indent" > If you want to change the font for the description, or if you only want to change the name -font for some types of entries but not others, you might want to consider using the -<span -class="cmss-10">glossaries-extra</span><a - id="dx1-63079"></a> package. +</p><!--l. 9384--><p class="indent" > If you want to change the font for the description, or if you only want to change the name +font for some types of entries but not others, you might want to consider using the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +package. <a - id="x1-63080r16"></a> -</p><!--l. 8429--><p class="noindent" ><span + id="ex:glsnamefont"></a> +</p><!--l. 9390--><p class="noindent" ><span class="cmbx-12">Example 16</span><span class="cmbx-12"> (Changing the Font Used to Display Entry Names in the</span> <span class="cmbx-12">Glossary)</span><a - id="x1-63081"></a> -</p><!--l. 8430--><p class="indent" > Suppose you want all the entry names to appear in medium weight small caps in your -glossaries, then you can do: - - + id="x1-141090"></a> +</p><!--l. 9391--><p class="indent" > Suppose you want all the entry names to appear in medium weight small caps in your glossaries, then you +can do: + + </p> - <div class="verbatim" id="verbatim-268"> + <div class="verbatim" id="verbatim-266"> \renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}} </div> -<!--l. 8434--><p class="nopar" > </p> +<!--l. 9395--><p class="nopar" > </p> <div class="center" > -<!--l. 8435--><p class="noindent" > -</p><!--l. 8435--><p class="noindent" >____________________________</p></div> - - -<!--l. 8437--><p class="indent" > </div> -</p><!--l. 8437--><p class="noindent" ><a +<!--l. 9396--><p class="noindent" > +</p><!--l. 9396--><p class="noindent" >____________________________</p></div> + + +<!--l. 9398--><p class="indent" > </div> +</p><!--l. 9398--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">11. <a id="sec:xindy"></a>Xindy (Option 3)</h2> -</p><!--l. 8440--><p class="indent" > If you want to use <a +</p><!--l. 9401--><p class="indent" > If you want to use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-64001"></a></a> to sort the glossary, you must use the package option -<span + id="dx1-142001"></a></a> to sort the glossary, you must use the package option <span class="cmss-10">xindy</span><a - id="dx1-64002"></a>: - - + id="dx1-142002"></a>: + + </p> - <div class="verbatim" id="verbatim-269"> + <div class="verbatim" id="verbatim-267"> \usepackage[xindy]{glossaries} </div> -<!--l. 8444--><p class="nopar" > This ensures that the glossary information is written in <span +<!--l. 9405--><p class="nopar" > This ensures that the glossary information is written in <span class="cmtt-10">xindy</span><a - id="dx1-64003"></a> syntax. -</p><!--l. 8448--><p class="indent" > <a -href="#sec:makeglossaries"><span -class="tcrm-1000">§</span>1.5 </a><a + id="dx1-142003"></a> syntax. +</p><!--l. 9409--><p class="indent" > <a +href="#sec:makeglossaries">§1.4 </a><a href="#sec:makeglossaries">Generating the Associated Glossary Files<!--tex4ht:ref: sec:makeglossaries --></a> covers how to use the external <a -href="#glo:indexingapp">indexing -application</a>, and <a -href="#sec:locationsyntax"><span -class="tcrm-1000">§</span>5.2 </a><a -href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a> covers the issues involved in the location syntax. This section -covers the commands provided by the <span +href="#glo:indexingapp">indexing application</a>, and <a +href="#sec:locationsyntax">§5.2 +</a><a +href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a> covers the issues involved in the location syntax. This section covers the commands provided by the +<span class="cmss-10">glossaries </span>package that allow you to adjust the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-64004"></a></a> -style file (<span -class="cmtt-10">.xdy</span><a - id="dx1-64005"></a>) and parameters. -</p><!--l. 8455--><p class="indent" > To assist writing information to the <a + id="dx1-142004"></a></a> style file (<span +class="cmtt-10">xdy</span><a + id="dx1-142005"></a>) and parameters. +</p><!--l. 9416--><p class="indent" > To assist writing information to the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-64006"></a></a> style file, the <span -class="cmss-10">glossaries </span>package provides the -following commands: -</p><!--l. 8458--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsopenbrace</span><span -class="cmtt-9"> </span></span><a - id="dx1-64007"></a> <span + id="dx1-142006"></a></a> style file, the <span +class="cmss-10">glossaries </span>package provides the following +commands: +</p><!--l. 9419--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142007"></a> <span class="cmtt-10">\glsopenbrace </span></div><hr> -</p><!--l. 8460--><p class="noindent" > -</p><!--l. 8461--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsclosebrace</span><span -class="cmtt-9"> </span></span><a - id="dx1-64008"></a> <span +</p><!--l. 9421--><p class="noindent" > +</p><!--l. 9422--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142008"></a> <span class="cmtt-10">\glsclosebrace </span></div><hr> -</p><!--l. 8463--><p class="noindent" > +</p><!--l. 9424--><p class="noindent" > which produce an open and closing brace. (This is needed because <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\{</span></span></span> and <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\}</span></span></span> don’t expand to -a simple brace character when written to a file.) Similarly, you can write a percent character -using: -</p><!--l. 8468--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspercentchar</span><span -class="cmtt-9"> </span></span><a - id="dx1-64009"></a> <span +class="cmtt-10">\}</span></span></span> don’t expand to a simple brace +character when written to a file.) Similarly, you can write a percent character using: +</p><!--l. 9429--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142009"></a> <span class="cmtt-10">\glspercentchar </span></div><hr> -</p><!--l. 8470--><p class="noindent" > +</p><!--l. 9431--><p class="noindent" > and a tilde character using: -</p><!--l. 8472--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstildechar</span><span -class="cmtt-9"> </span></span><a - id="dx1-64010"></a> <span +</p><!--l. 9433--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142010"></a> <span class="cmtt-10">\glstildechar </span></div><hr> -</p><!--l. 8474--><p class="noindent" > +</p><!--l. 9435--><p class="noindent" > For example, a newline character is specified in a <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-64011"></a></a> style file using <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">~n</span></span></span> so you can use -<span -class="cmtt-10">\glstildechar n </span>to write this correctly (or you can do <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\string~n</span></span></span>). A backslash can be -written to a file using -</p><!--l. 8479--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsbackslash</span><span -class="cmtt-9"> </span></span><a - id="dx1-64012"></a> <span + id="dx1-142011"></a></a> style file using <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">~n</span></span></span> so you can use <span +class="cmtt-10">\glstildechar n </span>to +write this correctly (or you can do <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\string~n</span></span></span>). A backslash can be written to a file using +</p><!--l. 9440--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142012"></a> <span class="cmtt-10">\glsbackslash </span></div><hr> -</p><!--l. 8481--><p class="noindent" > -</p><!--l. 8483--><p class="indent" > In addition, if you are using a package that makes the double quote character active (e.g. -<span +</p><!--l. 9442--><p class="noindent" > +</p><!--l. 9444--><p class="indent" > In addition, if you are using a package that makes the double quote character active (e.g. <span class="cmss-10">ngerman</span><a - id="dx1-64013"></a>) you can use: -</p><!--l. 8485--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsquote</span><span -class="cmtt-9"> </span></span><a - id="dx1-64014"></a> <span + id="dx1-142013"></a>) you can +use: +</p><!--l. 9446--><p class="indent" > <hr><div title="Definition"><a + id="dx1-142014"></a> <span class="cmtt-10">\glsquote{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8487--><p class="noindent" > +</p><!--l. 9448--><p class="noindent" > which will produce <span class="obeylines-h"><span class="verb"><span class="cmtt-10">"</span></span></span>⟨<span class="cmti-10">text</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">"</span></span></span>. Alternatively, you can use <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\string"</span></span></span> to write the double-quote -character. This document assumes that the double quote character has not been made active, -so the examples just use <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">"</span></span></span> for clarity. -</p><!--l. 8493--><p class="indent" > If you want greater control over the <a +class="cmtt-10">\string"</span></span></span> to write the double-quote character. This +document assumes that the double quote character has not been made active, so the examples just use <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">"</span></span></span> for +clarity. +</p><!--l. 9454--><p class="indent" > If you want greater control over the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-64015"></a></a> style file than is available through the -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> commands provided by the <span + id="dx1-142015"></a></a> style file than is available through the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> commands +provided by the <span class="cmss-10">glossaries </span>package, you will need to edit the <span class="cmtt-10">xindy</span><a - id="dx1-64016"></a> -style file. In which case, you must use <span + id="dx1-142016"></a> style file. In which case, you must use +<span class="cmtt-10">\noist</span><a - id="dx1-64017"></a> to prevent the style file from being -overwritten by the <span -class="cmss-10">glossaries </span>package. For additional information about <span + id="dx1-142017"></a> to prevent the style file from being overwritten by the <span +class="cmss-10">glossaries </span>package. For additional +information about <span class="cmtt-10">xindy</span><a - id="dx1-64018"></a>, read -the <span + id="dx1-142018"></a>, read the <span class="cmtt-10">xindy</span><a - id="dx1-64019"></a> documentation. I’m sorry I can’t provide any assistance with writing -<span + id="dx1-142019"></a> documentation. I’m sorry I can’t provide any assistance +with writing <span class="cmtt-10">xindy</span><a - id="dx1-64020"></a> style files. If you need help, I recommend you ask on the <span + id="dx1-142020"></a> style files. If you need help, I recommend you ask on the <span class="cmtt-10">xindy</span><a - id="dx1-64021"></a> mailing list + id="dx1-142021"></a> mailing list (<a href="http://xindy.sourceforge.net/mailing-list.html" class="url" ><span class="cmtt-10">http://xindy.sourceforge.net/mailing-list.html</span></a>). - - </p> -<!--l. 8504--><p class="noindent" ><a +<!--l. 9465--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">11.1 </span> <a id="sec:langenc"></a>Language and Encodings</h3> -<!--l. 8507--><p class="noindent" >When you use <a +<!--l. 9468--><p class="noindent" >When you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-65001"></a></a>, you need to specify the language and encoding used (unless you -have written your own custom <span + id="dx1-143001"></a></a>, you need to specify the language and encoding used (unless you have written your own + + +custom <span class="cmtt-10">xindy</span><a - id="dx1-65002"></a> style file that defines the relevant alphabet -and sort rules). If you use <a + id="dx1-143002"></a> style file that defines the relevant alphabet and sort rules). If you use <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-65003"></a></a>, this information is obtained from the -document’s auxiliary (<span -class="cmtt-10">.aux</span><a - id="dx1-65004"></a>) file. The <a + id="dx1-143003"></a></a>, +this information is obtained from the document’s auxiliary (<span +class="cmtt-10">aux</span><a + id="dx1-143004"></a>) file. The <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-65005"></a></a> script attempts to find the root -language given your document settings, but in the event that it gets it wrong or if -<span + id="dx1-143005"></a></a> script +attempts to find the root language given your document settings, but in the event that it gets +it wrong or if <span class="cmtt-10">xindy</span><a - id="dx1-65006"></a> doesn’t support that language, then you can specify the required language + id="dx1-143006"></a> doesn’t support that language, then you can specify the required language using: -</p><!--l. 8516--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyLanguage</span><span -class="cmtt-9"> </span></span><a - id="dx1-65007"></a> <span +</p><!--l. 9477--><p class="indent" > <hr><div title="Definition"><a + id="dx1-143007"></a> <span class="cmtt-10">\GlsSetXdyLanguage[</span>⟨<span class="cmitt-10">glossary type</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">language</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8518--><p class="noindent" > +</p><!--l. 9479--><p class="noindent" > where ⟨<span -class="cmti-10">language</span>⟩ is the name of the language. The optional argument can be used if you have -multiple glossaries in different languages. If ⟨<span -class="cmti-10">glossary type</span>⟩ is omitted, it will be applied to all -glossaries, otherwise the language setting will only be applied to the glossary given by -⟨<span +class="cmti-10">language</span>⟩ is the name of the language. The optional argument can be used if you have multiple glossaries +in different languages. If ⟨<span +class="cmti-10">glossary type</span>⟩ is omitted, it will be applied to all glossaries, otherwise the language +setting will only be applied to the glossary given by ⟨<span class="cmti-10">glossary type</span>⟩. -</p><!--l. 8526--><p class="indent" > If the <span +</p><!--l. 9487--><p class="indent" > If the <span class="cmss-10">inputenc</span><a - id="dx1-65008"></a> package is used, the encoding will be obtained from the value of -<span + id="dx1-143008"></a> package is used, the encoding will be obtained from the value of <span class="cmtt-10">\inputencodingname</span><a - id="dx1-65009"></a>. Alternatively, you can specify the encoding using: -</p><!--l. 8529--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyCodePage</span><span -class="cmtt-9"> </span></span><a - id="dx1-65010"></a> <span + id="dx1-143009"></a>. +Alternatively, you can specify the encoding using: +</p><!--l. 9490--><p class="indent" > <hr><div title="Definition"><a + id="dx1-143010"></a> <span class="cmtt-10">\GlsSetXdyCodePage{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8531--><p class="noindent" > +</p><!--l. 9492--><p class="noindent" > where ⟨<span class="cmti-10">code</span>⟩ is the name of the encoding. For example: - - + + </p> - <div class="verbatim" id="verbatim-270"> + <div class="verbatim" id="verbatim-268"> \GlsSetXdyCodePage{utf8} </div> -<!--l. 8535--><p class="nopar" > -</p><!--l. 8537--><p class="indent" > Note that you can also specify the language and encoding using the package option +<!--l. 9496--><p class="nopar" > +</p><!--l. 9498--><p class="indent" > Note that you can also specify the language and encoding using the package option <span class="obeylines-h"><span class="verb"><span class="cmtt-10">xindy={language=</span></span></span>⟨<span class="cmti-10">lang</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">,codepage=</span></span></span>⟨<span class="cmti-10">code</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">}</span></span></span>. For example: - - + + </p> - <div class="verbatim" id="verbatim-271"> + <div class="verbatim" id="verbatim-269"> \usepackage[xindy={language=english,codepage=utf8}]{glossaries} </div> -<!--l. 8543--><p class="nopar" > -</p><!--l. 8545--><p class="indent" > If you write your own custom <a +<!--l. 9504--><p class="nopar" > +</p><!--l. 9506--><p class="indent" > If you write your own custom <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-65011"></a></a> style file that includes the language settings, you need -to set the language to nothing: - - + id="dx1-143011"></a></a> style file that includes the language settings, you need to set the +language to nothing: + + </p> - <div class="verbatim" id="verbatim-272"> + <div class="verbatim" id="verbatim-270"> \GlsSetXdyLanguage{} </div> -<!--l. 8550--><p class="nopar" > (and remember to use <span +<!--l. 9511--><p class="nopar" > (and remember to use <span class="cmtt-10">\noist</span><a - id="dx1-65012"></a> to prevent the style file from being overwritten). -</p><!--l. 8554--><p class="indent" > <div class="important" title="Important Note"> The commands <span + id="dx1-143012"></a> to prevent the style file from being overwritten). +</p><!--l. 9515--><p class="indent" > <div class="important" title="Important Note"> The commands <span class="cmtt-10">\GlsSetXdyLanguage </span>and <span -class="cmtt-10">\GlsSetXdyCodePage </span>have no effect if -you don’t use <a +class="cmtt-10">\GlsSetXdyCodePage </span>have no effect if you don’t use +<a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-65013"></a></a>. If you call <a + id="dx1-143013"></a></a>. If you call <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-65014"></a></a> without <span + id="dx1-143014"></a></a> without <span class="cmtt-10">makeglossaries</span><a - id="dx1-65015"></a> you -need to remember to set the language and encoding using the <span + id="dx1-143015"></a> you need to remember to set the language and +encoding using the <span class="cmtt-10">-L</span><a - id="dx1-65016"></a> and <span + id="dx1-143016"></a> and <span class="cmtt-10">-C</span><a - id="dx1-65017"></a> switches. -</div> -</p><!--l. 8560--><p class="noindent" > -</p><!--l. 8562--><p class="noindent" > + id="dx1-143017"></a> switches. </div> +</p><!--l. 9521--><p class="noindent" > +</p><!--l. 9523--><p class="noindent" > </p> -<!--l. 8562--><p class="noindent" ><a +<!--l. 9523--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">11.2 </span> <a id="sec:xindyloc"></a>Locations and Number lists</h3> -<!--l. 8565--><p class="noindent" >If you use <span +<!--l. 9526--><p class="noindent" >If you use <span class="cmss-10">xindy</span><a - id="dx1-66001"></a>, the <span -class="cmss-10">glossaries </span>package needs to know which counters you will be using in the -<a + id="dx1-144001"></a>, the <span +class="cmss-10">glossaries </span>package needs to know which counters you will be using in the <a href="#glo:numberlist">number list<a - id="dx1-66002"></a></a> in order to correctly format the <a + id="dx1-144002"></a></a> in +order to correctly format the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66003"></a></a> style file. Counters specified using the -<span + id="dx1-144003"></a></a> style file. Counters specified using the <span class="cmss-10">counter</span><a - id="dx1-66004"></a> package option or the ⟨<span -class="cmti-10">counter</span>⟩ option of <span + id="dx1-144004"></a> package option or the ⟨<span +class="cmti-10">counter</span>⟩ +option of <span class="cmtt-10">\newglossary</span><a - id="dx1-66005"></a> are automatically taken -care of, but if you plan to use a different counter in the <span -class="cmss-10">counter</span><a - id="dx1-66006"></a> key for commands -like <span + id="dx1-144005"></a> are automatically taken care of, but if you plan to use a different counter in the +<span +class="cmtt-10">counter</span><a + id="dx1-144006"></a> key for commands like <span class="cmtt-10">\glslink</span><a - id="dx1-66007"></a>, then you need to identify these counters <span + id="dx1-144007"></a>, then you need to identify these counters <span class="cmti-10">before </span><span class="cmtt-10">\makeglossaries</span><a - id="dx1-66008"></a> + id="dx1-144008"></a> using: -</p><!--l. 8573--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsAddXdyCounters</span><span -class="cmtt-9"> </span></span><a - id="dx1-66009"></a> <span +</p><!--l. 9534--><p class="indent" > <hr><div title="Definition"><a + id="dx1-144009"></a> <span class="cmtt-10">\GlsAddXdyCounters{</span>⟨<span class="cmitt-10">counter list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8575--><p class="noindent" > +</p><!--l. 9536--><p class="noindent" > where ⟨<span class="cmti-10">counter list</span>⟩ is a comma-separated list of counter names. -</p><!--l. 8578--><p class="indent" > The most likely attributes used in the <span -class="cmss-10">format</span><a - id="dx1-66010"></a> key (<span +</p><!--l. 9539--><p class="indent" > The most likely <a + id="dx1-144010"></a>attributes used in the <span +class="cmtt-10">format</span><a + id="dx1-144011"></a> key (<span class="cmtt-10">textrm</span><a - id="dx1-66011"></a>, <span + id="dx1-144012"></a>, <span class="cmtt-10">hyperrm</span><a - id="dx1-66012"></a> etc) are automatically -added to the <a + id="dx1-144013"></a> etc) are automatically added to the +<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66013"></a></a> style file, but if you want to use another attribute, you need to add it -using: -</p><!--l. 8582--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsAddXdyAttribute</span><span -class="cmtt-9"> </span></span><a - id="dx1-66014"></a> <span + id="dx1-144014"></a></a> style file, but if you want to use another attribute, you need to add it using: +</p><!--l. 9543--><p class="indent" > <hr><div title="Definition"><a + id="dx1-144015"></a> <span class="cmtt-10">\GlsAddXdyAttribute{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8584--><p class="noindent" > +</p><!--l. 9545--><p class="noindent" > where ⟨<span class="cmti-10">name</span>⟩ is the name of the attribute, as used in the <span -class="cmss-10">format</span><a - id="dx1-66015"></a> key. -</p><!--l. 8588--><p class="indent" > Take care if you have multiple instances of the same location with different formats. The -duplicate locations will be discarded according to the order in which the attributes are -listed. Consider defining semantic commands to use for primary references. For -example: - - +class="cmtt-10">format</span><a + id="dx1-144016"></a> key. +</p><!--l. 9549--><p class="indent" > Take care if you have multiple instances of the same location with different formats. The duplicate locations +will be discarded according to the order in which the <a + id="dx1-144017"></a>attributes are listed. Consider defining semantic commands +to use for primary references. For example: + + </p> - <div class="verbatim" id="verbatim-273"> + <div class="verbatim" id="verbatim-271"> \newcommand*{\primary}[1]{\textbf{#1}}  <br />\GlsAddXdyAttribute{primary} </div> -<!--l. 8596--><p class="nopar" > Then in the document: - - +<!--l. 9557--><p class="nopar" > Then in the document: + + </p> - <div class="verbatim" id="verbatim-274"> + <div class="verbatim" id="verbatim-272"> A \gls[format=primary]{duck} is an aquatic bird.  <br />There are lots of different types of \gls{duck}. </div> -<!--l. 8601--><p class="nopar" > This will give the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">format=primary</span></span></span> instance preference over the next use that doesn’t use the -<span -class="cmss-10">format</span><a - id="dx1-66016"></a> key. +<!--l. 9562--><p class="nopar" > This will give the <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">format=primary</span></span></span> instance preference over the next use that doesn’t use the <span +class="cmtt-10">format</span><a + id="dx1-144018"></a> +key. <a - id="x1-66017r17"></a> -</p><!--l. 8605--><p class="noindent" ><span + id="ex:hyperbfit"></a> +</p><!--l. 9566--><p class="noindent" ><span class="cmbx-12">Example 17</span><span class="cmbx-12"> (Custom Font for Displaying a Location)</span><a - id="x1-66018"></a> -</p><!--l. 8606--><p class="indent" > Suppose I want a bold, italic, hyperlinked location. I first need to define a command that -will do this: - - + id="x1-144020"></a> +</p><!--l. 9567--><p class="indent" > Suppose I want a bold, italic, hyperlinked location. I first need to define a command that will do +this: + + </p> - <div class="verbatim" id="verbatim-275"> + <div class="verbatim" id="verbatim-273"> \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} </div> -<!--l. 8610--><p class="nopar" > but with <a +<!--l. 9571--><p class="nopar" > but with <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66019"></a></a>, I also need to add this as an allowed attribute: - - + id="dx1-144021"></a></a>, I also need to add this as an allowed <a + id="dx1-144022"></a>attribute: + + </p> - <div class="verbatim" id="verbatim-276"> + <div class="verbatim" id="verbatim-274"> \GlsAddXdyAttribute{hyperbfit} </div> -<!--l. 8615--><p class="nopar" > Now I can use it in the optional argument of commands like <span +<!--l. 9576--><p class="nopar" > Now I can use it in the optional argument of commands like <span class="cmtt-10">\gls</span><a - id="dx1-66020"></a>: - - + id="dx1-144023"></a>: + + </p> - <div class="verbatim" id="verbatim-277"> + <div class="verbatim" id="verbatim-275"> Here is a \gls[format=hyperbfit]{sample} entry. </div> -<!--l. 8620--><p class="nopar" > (where <span +<!--l. 9581--><p class="nopar" > (where <span class="cmtt-10">sample </span>is the label of the required entry). </p> <div class="center" > -<!--l. 8622--><p class="noindent" > -</p><!--l. 8622--><p class="noindent" >____________________________</p></div> -<!--l. 8624--><p class="indent" > <div class="important" title="Important Note"> Note that <span +<!--l. 9583--><p class="noindent" > +</p><!--l. 9583--><p class="noindent" >____________________________</p></div> +<!--l. 9585--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\GlsAddXdyAttribute </span>has no effect if <span class="cmtt-10">\noist</span><a - id="dx1-66021"></a> is used or if <span + id="dx1-144024"></a> is used or if <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66022"></a> is -omitted. <span + id="dx1-144025"></a> is omitted. +<span class="cmtt-10">\GlsAddXdyAttribute </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66023"></a>. Additionally, -<span -class="cmtt-10">\GlsAddXdyCounters </span>must come before <span + id="dx1-144026"></a>. Additionally, <span +class="cmtt-10">\GlsAddXdyCounters </span>must come +before <span class="cmtt-10">\GlsAddXdyAttribute</span>. </div> -</p><!--l. 8630--><p class="noindent" > -</p><!--l. 8632--><p class="indent" > If the location numbers include formatting commands, then you need to add a location -style in the appropriate format using -</p><!--l. 8634--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsAddXdyLocation</span><span -class="cmtt-9"> </span></span><a - id="dx1-66024"></a> <span +</p><!--l. 9591--><p class="noindent" > +</p><!--l. 9593--><p class="indent" > If the location numbers include formatting commands, then you need to add a location style in the +appropriate format using +</p><!--l. 9595--><p class="indent" > <hr><div title="Definition"><a + id="dx1-144027"></a> <span class="cmtt-10">\GlsAddXdyLocation[</span>⟨<span class="cmitt-10">prefix-location</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definition</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 8636--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 9597--><p class="noindent" > where ⟨<span class="cmti-10">name</span>⟩ is the name of the format and ⟨<span class="cmti-10">definition</span>⟩ is the <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66025"></a></a> definition. The optional -argument ⟨<span + id="dx1-144028"></a></a> definition. The optional argument +⟨<span class="cmti-10">prefix-location</span>⟩ is needed if <span class="cmtt-10">\theH</span>⟨<span -class="cmti-10">counter</span>⟩ either isn’t defined or is different from -<span +class="cmti-10">counter</span>⟩ either isn’t defined or is different from <span class="cmtt-10">\the</span>⟨<span -class="cmti-10">counter</span>⟩. Be sure to also read <a -href="#sec:locationsyntax"><span -class="tcrm-1000">§</span>5.2 </a><a -href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a> for some issues that you may -encounter. -</p><!--l. 8644--><p class="indent" > <div class="important" title="Important Note"> Note that <span +class="cmti-10">counter</span>⟩. Be sure to also +read <a +href="#sec:locationsyntax">§5.2 </a><a +href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a> for some issues that you may encounter. +</p><!--l. 9605--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\GlsAddXdyLocation </span>has no effect if <span class="cmtt-10">\noist</span><a - id="dx1-66026"></a> is used or if <span + id="dx1-144029"></a> is used or if <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66027"></a> is -omitted. <span + id="dx1-144030"></a> is omitted. +<span class="cmtt-10">\GlsAddXdyLocation </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66028"></a>. </div> -</p><!--l. 8648--><p class="noindent" > + id="dx1-144031"></a>. </div> +</p><!--l. 9609--><p class="noindent" > <a - id="x1-66029r18"></a> -</p><!--l. 8650--><p class="noindent" ><span + id="ex:customloc"></a> +</p><!--l. 9611--><p class="noindent" ><span class="cmbx-12">Example 18</span><span class="cmbx-12"> (Custom Numbering System for Locations)</span><a - id="x1-66030"></a> -</p><!--l. 8651--><p class="indent" > Suppose I decide to use a somewhat eccentric numbering system for sections where I -redefine <span -class="cmtt-10">\thesection </span>as follows: - - + id="x1-144033"></a> +</p><!--l. 9612--><p class="indent" > Suppose I decide to use a somewhat eccentric numbering system for sections where I redefine <span +class="cmtt-10">\thesection</span> +as follows: + + </p> - <div class="verbatim" id="verbatim-278"> + <div class="verbatim" id="verbatim-276"> \renewcommand*{\thesection}{[\thechapter]\arabic{section}} </div> -<!--l. 8655--><p class="nopar" > If I haven’t done <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">counter=section</span></span></span> in the package option, I need to specify that the counter -will be used as a location number: - - +<!--l. 9616--><p class="nopar" > If I haven’t done <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">counter=section</span></span></span> in the package option, I need to specify that the counter will be used as a +location number: + + </p> - <div class="verbatim" id="verbatim-279"> + <div class="verbatim" id="verbatim-277"> \GlsAddXdyCounters{section} </div> -<!--l. 8661--><p class="nopar" > Next I need to add the location style (<span -class="cmtt-10">\thechapter </span>is assumed to be the standard -<span class="obeylines-h"><span class="verb"><span +<!--l. 9622--><p class="nopar" > Next I need to add the location style (<span +class="cmtt-10">\thechapter </span>is assumed to be the standard <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\arabic{chapter}</span></span></span>): - - + + </p> - <div class="verbatim" id="verbatim-280"> + <div class="verbatim" id="verbatim-278"> \GlsAddXdyLocation{section}{:sep "[" "arabic-numbers" :sep "]"  <br />  "arabic-numbers"  <br />} </div> -<!--l. 8668--><p class="nopar" > Note that if I have further decided to use the <span +<!--l. 9629--><p class="nopar" > Note that if I have further decided to use the <span class="cmss-10">hyperref</span><a - id="dx1-66031"></a> package and want to redefine -<span -class="cmtt-10">\theHsection </span>as: - - + id="dx1-144034"></a> package and want to redefine <span +class="cmtt-10">\theHsection</span> +as: + + </p> - <div class="verbatim" id="verbatim-281"> + <div class="verbatim" id="verbatim-279"> \renewcommand*{\theHsection}{\thepart.\thesection}  <br />\renewcommand*{\thepart}{\Roman{part}} </div> -<!--l. 8674--><p class="nopar" > then I need to modify the <span +<!--l. 9635--><p class="nopar" > then I need to modify the <span class="cmtt-10">\GlsAddXdyLocation </span>code above to: - - + + </p> - <div class="verbatim" id="verbatim-282"> + <div class="verbatim" id="verbatim-280"> \GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "["  <br />  "arabic-numbers" :sep "]" "arabic-numbers"  <br />} </div> -<!--l. 8680--><p class="nopar" > Since <span +<!--l. 9641--><p class="nopar" > Since <span class="cmtt-10">\Roman</span><a - id="dx1-66032"></a> will result in an empty string if the counter is zero, it’s a good idea to add an -extra location to catch this: - - + id="dx1-144035"></a> will result in an empty string if the counter is zero, it’s a good idea to add an extra location to +catch this: + + </p> - <div class="verbatim" id="verbatim-283"> + <div class="verbatim" id="verbatim-281"> \GlsAddXdyLocation{zero.section}{:sep "["  <br />  "arabic-numbers" :sep "]" "arabic-numbers"  <br />} </div> -<!--l. 8687--><p class="nopar" > This example is illustrated in the sample file <a -href="#x1-11086r25"><span +<!--l. 9648--><p class="nopar" > This example is illustrated in the sample file <a +href="#ex:samplexdy2"><span class="cmtt-10">samplexdy2.tex</span></a>. </p> <div class="center" > -<!--l. 8690--><p class="noindent" > -</p><!--l. 8690--><p class="noindent" >____________________________</p></div> +<!--l. 9651--><p class="noindent" > +</p><!--l. 9651--><p class="noindent" >____________________________</p></div> <a - id="x1-66033r19"></a> -<!--l. 8692--><p class="noindent" ><span + id="ex:dice"></a> +<!--l. 9653--><p class="noindent" ><span class="cmbx-12">Example 19</span><span class="cmbx-12"> (Locations as Dice)</span><a - id="x1-66034"></a> -</p><!--l. 8693--><p class="indent" > Suppose I want a rather eccentric page numbering system that’s represented by the -number of dots on dice. The <span + id="x1-144037"></a> +</p><!--l. 9654--><p class="indent" > Suppose I want a rather eccentric page numbering system that’s represented by the number of +dots on dice. The <span class="cmss-10">stix</span><a - id="dx1-66035"></a> package provides <span + id="dx1-144038"></a> package provides <span class="cmtt-10">\dicei</span>, …, <span -class="cmtt-10">\dicevi </span>that represent the six -sides of a die. I can define a command that takes a number as its argument. If the -number is less than seven, the appropriate <span +class="cmtt-10">\dicevi </span>that represent the six sides of a die. I +can define a command that takes a number as its argument. If the number is less than seven, the +appropriate <span class="cmtt-10">\dice</span>⟨<span -class="cmti-10">n</span>⟩ command is used otherwise it -does <span -class="cmtt-10">\dicevi </span>the required number of times with the leftover in a final <span +class="cmti-10">n</span>⟩ command is used otherwise it does <span +class="cmtt-10">\dicevi </span>the required number of times with the +leftover in a final <span class="cmtt-10">\dice</span>⟨<span -class="cmti-10">n</span>⟩. For -example, the number 16 is represented by <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\dicevi\dicevi\diceiv</span></span></span> (6 + 6 + 4 = 16). -I’ve called this command <span +class="cmti-10">n</span>⟩. For example, the number 16 is represented by <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dicevi\dicevi\diceiv</span></span></span> +(6 + 6 + 4 = 16). I’ve called this command <span class="cmtt-10">\tallynum </span>to match the example given earlier in <a -href="#sec:locationsyntax"><span -class="tcrm-1000">§</span>5.2 +href="#sec:locationsyntax">§5.2 </a><a href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a>: - - + + </p> - <div class="verbatim" id="verbatim-284"> + <div class="verbatim" id="verbatim-282"> \newrobustcmd{\tallynum}[1]{%  <br /> \ifnum\number#1<7  <br />  $\csname dice\romannumeral#1\endcsname$% @@ -17681,57 +19759,55 @@ href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a>:  <br /> \fi  <br />} </div> -<!--l. 8713--><p class="nopar" > Here’s the counter command: - - +<!--l. 9674--><p class="nopar" > Here’s the counter command: + + </p> - <div class="verbatim" id="verbatim-285"> + <div class="verbatim" id="verbatim-283"> newcommand{\tally}[1]{\tallynum{\arabic{#1}}} </div> -<!--l. 8717--><p class="nopar" > The <span +<!--l. 9678--><p class="nopar" > The <span class="cmss-10">page</span><a - id="dx1-66036"></a> counter representation (<span + id="dx1-144039"></a> counter representation (<span class="cmtt-10">\thepage</span>) needs to be changed to use this command: - - + + </p> - <div class="verbatim" id="verbatim-286"> + <div class="verbatim" id="verbatim-284"> \renewcommand*{\thepage}{\tally{page}} </div> -<!--l. 8722--><p class="nopar" > The <span +<!--l. 9683--><p class="nopar" > The <span class="cmtt-10">\tally </span>command expands to <span class="cmtt-10">\tallynum {</span>⟨<span class="cmti-10">number</span>⟩<span -class="cmtt-10">} </span>so this needs a location class that -matches this format: - - +class="cmtt-10">} </span>so this needs a location class that matches this +format: + + </p> - <div class="verbatim" id="verbatim-287"> + <div class="verbatim" id="verbatim-285"> \GlsAddXdyLocation{tally}{%  <br /> :sep "\string\tallynum\space\glsopenbrace"  <br /> "arabic-numbers"  <br /> :sep "\glsclosebrace"  <br />} </div> -<!--l. 8731--><p class="nopar" > The space between <span +<!--l. 9692--><p class="nopar" > The space between <span class="cmtt-10">\tallynum </span>and <span class="cmtt-10">{</span>⟨<span class="cmti-10">number</span>⟩<span class="cmtt-10">} </span>is significant to <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66037"></a></a> so <span -class="cmtt-10">\space </span>is -required. -</p><!--l. 8735--><p class="indent" > Note that <span + id="dx1-144040"></a></a> so <span +class="cmtt-10">\space </span>is required. +</p><!--l. 9696--><p class="indent" > Note that <span class="cmtt-10">\GlsAddXdyLocation{</span>⟨<span class="cmti-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmti-10">definition</span>⟩<span -class="cmtt-10">} </span>will define commands in the -form: -</p><!--l. 8738--><p class="indent" > <hr><div title="Definition"><span +class="cmtt-10">} </span>will define commands in the form: +</p><!--l. 9699--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glsX</span>⟨<span class="cmitt-10">counter</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">X</span></span></span>⟨<span @@ -17741,53 +19817,51 @@ class="cmitt-10">Hprefix</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">location</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8739--><p class="noindent" > +</p><!--l. 9700--><p class="noindent" > for each counter that has been identified either by the <span class="cmss-10">counter</span><a - id="dx1-66038"></a> package option, the ⟨<span -class="cmti-10">counter</span>⟩ -option for <span + id="dx1-144041"></a> package option, the ⟨<span +class="cmti-10">counter</span>⟩ option for +<span class="cmtt-10">\newglossary</span><a - id="dx1-66039"></a> or in the argument of <span + id="dx1-144042"></a> or in the argument of <span class="cmtt-10">\GlsAddXdyCounters</span><a - id="dx1-66040"></a>. The first argument -⟨<span -class="cmti-10">Hprefix</span>⟩ is only relevant when used with the <span + id="dx1-144043"></a>. The first argument ⟨<span +class="cmti-10">Hprefix</span>⟩ is only relevant when +used with the <span class="cmss-10">hyperref</span><a - id="dx1-66041"></a> package and indicates that <span + id="dx1-144044"></a> package and indicates that <span class="cmtt-10">\theH</span>⟨<span -class="cmti-10">counter</span>⟩ -is given by <span +class="cmti-10">counter</span>⟩ is given by <span class="cmtt-10">\Hprefix</span><span class="obeylines-h"><span class="verb"><span class="cmtt-10">.</span></span></span><span class="cmtt-10">\the</span>⟨<span class="cmti-10">counter</span>⟩. -</p><!--l. 8747--><p class="indent" > The sample file <a -href="#x1-11071r24"><span +</p><!--l. 9708--><p class="indent" > The sample file <a +href="#ex:samplexdy"><span class="cmtt-10">samplexdy.tex</span></a>, which comes with the <span -class="cmss-10">glossaries </span>package, uses the default -<span +class="cmss-10">glossaries </span>package, uses the default <span class="cmss-10">page</span><a - id="dx1-66042"></a> counter for locations, and it uses the default <span + id="dx1-144045"></a> counter for +locations, and it uses the default <span class="cmtt-10">\glsnumberformat</span><a - id="dx1-66043"></a> and a custom -<span + id="dx1-144046"></a> and a custom <span class="cmtt-10">\hyperbfit </span>format. A new <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66044"></a></a> location called <span -class="cmtt-10">tallynum</span>, as illustrated above, is defined -to make the page numbers appear as dice. In order for the location numbers to -hyperlink to the relevant pages, I need to redefine the necessary <span + id="dx1-144047"></a></a> location +called <span +class="cmtt-10">tallynum</span>, as illustrated above, is defined to make the page numbers appear as dice. In order for the +location numbers to hyperlink to the relevant pages, I need to redefine the necessary <span class="cmtt-10">\glsX</span>⟨<span class="cmti-10">counter</span>⟩<span class="obeylines-h"><span class="verb"><span class="cmtt-10">X</span></span></span>⟨<span class="cmti-10">format</span>⟩ commands: - - + + </p> - <div class="verbatim" id="verbatim-288"> + <div class="verbatim" id="verbatim-286"> \renewcommand{\glsXpageXglsnumberformat}[2]{%  <br /> \linkpagenumber#2%  <br />} @@ -17796,20 +19870,19 @@ commands:  <br />}  <br />\newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} </div> -<!--l. 8765--><p class="nopar" > Note that the second argument of <span +<!--l. 9726--><p class="nopar" > Note that the second argument of <span class="cmtt-10">\glsXpageXglsnumberformat </span>is in the format <span -class="cmtt-10">\tallynum</span> -<span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">\tallynum{</span>⟨<span class="cmti-10">n</span>⟩<span -class="cmtt-10">} </span>so the line - - +class="cmtt-10">} </span>so the +line + + </p> - <div class="verbatim" id="verbatim-289"> + <div class="verbatim" id="verbatim-287">  \linkpagenumber#2% </div> -<!--l. 8770--><p class="nopar" > does </p><div class="alltt"> +<!--l. 9731--><p class="nopar" > does </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10"> \linkpagenumber\tallynum{</span>⟨<span @@ -17819,34 +19892,32 @@ class="cmtt-10">}</span> </div> so <span class="cmtt-10">\tallynum </span>is the first argument of <span class="cmtt-10">\linkpagenumber </span>and ⟨<span -class="cmti-10">number</span>⟩ is the second -argument. +class="cmti-10">number</span>⟩ is the second argument. <div class="center" > -<!--l. 8777--><p class="noindent" > -</p><!--l. 8777--><p class="noindent" >____________________________</p></div> -<!--l. 8779--><p class="indent" > <div class="important" title="Important Note"> This method is very sensitive to the internal definition of the location command. -</div> -</p><!--l. 8782--><p class="noindent" > +<!--l. 9738--><p class="noindent" > +</p><!--l. 9738--><p class="noindent" >____________________________</p></div> +<!--l. 9740--><p class="indent" > <div class="important" title="Important Note"> This method is very sensitive to the internal definition of the location command. </div> +</p><!--l. 9743--><p class="noindent" > <a - id="x1-66045r20"></a> -</p><!--l. 8784--><p class="noindent" ><span + id="ex:fmtcount"></a> +</p><!--l. 9745--><p class="noindent" ><span class="cmbx-12">Example 20</span><span class="cmbx-12"> (Locations as Words not Digits)</span><a - id="x1-66046"></a> -</p><!--l. 8785--><p class="indent" > Suppose I want the page numbers written as words rather than digits and I use the -<span + id="x1-144049"></a> +</p><!--l. 9746--><p class="indent" > Suppose I want the page numbers written as words rather than digits and I use the <span class="cmss-10">fmtcount</span><a - id="dx1-66047"></a> package to do this. I can redefine <span + id="dx1-144050"></a> package to do +this. I can redefine <span class="cmtt-10">\thepage</span><a - id="dx1-66048"></a> as follows: - - + id="dx1-144051"></a> as follows: + + </p> - <div class="verbatim" id="verbatim-290"> + <div class="verbatim" id="verbatim-288"> \renewcommand*{\thepage}{\Numberstring{page}} </div> -<!--l. 8790--><p class="nopar" > This <span +<!--l. 9751--><p class="nopar" > This <span class="cmti-10">used </span>to get expanded to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\protect</span><span class="cmtt-10"> \Numberstringnum</span><span @@ -17854,56 +19925,54 @@ class="cmtt-10"> </span></span></span><span class="cmtt-10">{</span>⟨<span class="cmti-10">n</span>⟩<span class="cmtt-10">} </span>where ⟨<span -class="cmti-10">n</span>⟩ is the -Arabic page number. This means that I needed to define a new location with the -form: - - +class="cmti-10">n</span>⟩ is the Arabic page number. This +means that I needed to define a new location with the form: + + </p> - <div class="verbatim" id="verbatim-291"> + <div class="verbatim" id="verbatim-289"> \GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space  <br />  \string\Numberstringnum\space\glsopenbrace"  <br />  "arabic-numbers" :sep "\glsclosebrace"} </div> -<!--l. 8798--><p class="nopar" > and if I’d used the <span -class="cmtt-10">\linkpagenumber </span>command from the previous example, it would need -<span -class="cmti-10">three </span>arguments (the first being <span +<!--l. 9759--><p class="nopar" > and if I’d used the <span +class="cmtt-10">\linkpagenumber </span>command from the previous example, it would need <span +class="cmti-10">three </span>arguments (the +first being <span class="cmtt-10">\protect</span>): - - + + </p> - <div class="verbatim" id="verbatim-292"> + <div class="verbatim" id="verbatim-290"> \newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}} </div> -<!--l. 8804--><p class="nopar" > -</p><!--l. 8806--><p class="indent" > The internal definition of <span -class="cmtt-10">\Numberstring </span>has since changed so that it now expands to -<span class="obeylines-h"><span class="verb"><span +<!--l. 9765--><p class="nopar" > +</p><!--l. 9767--><p class="indent" > The internal definition of <span +class="cmtt-10">\Numberstring </span>has since changed so that it now expands to <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Numberstringnum</span><span -class="cmtt-10"> </span></span></span><span +class="cmtt-10"> </span></span></span> +<span class="cmtt-10">{</span>⟨<span class="cmti-10">n</span>⟩<span class="cmtt-10">} </span>(no <span -class="cmtt-10">\protect</span>). This means that the location class definition must be -changed to: - - +class="cmtt-10">\protect</span>). This means that the location class definition must be changed to: + + </p> - <div class="verbatim" id="verbatim-293"> + <div class="verbatim" id="verbatim-291"> \GlsAddXdyLocation{Numberstring}{% no \protect now!  <br />  :sep "\string\Numberstringnum\space\glsopenbrace"  <br />  "arabic-numbers" :sep "\glsclosebrace"} </div> -<!--l. 8814--><p class="nopar" > and <span +<!--l. 9775--><p class="nopar" > and <span class="cmtt-10">\linkpagenumber </span>goes back to only two arguments: - - + + </p> - <div class="verbatim" id="verbatim-294"> + <div class="verbatim" id="verbatim-292"> \newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} </div> -<!--l. 8818--><p class="nopar" > The other change is that <span +<!--l. 9779--><p class="nopar" > The other change is that <span class="cmtt-10">\Numberstring </span>uses </p><div class="alltt"> <div class="obeylines-v"> <span @@ -17921,39 +19990,36 @@ class="cmtt-10">\endcsname</span> </div> </div> so it hides <span class="cmtt-10">\c@page </span>from the location escaping mechanism (see <a -href="#sec:locationsyntax"><span -class="tcrm-1000">§</span>5.2 </a><a -href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a>). This means -that the page number may be incorrect if the indexing occurs during the output -routine. -<!--l. 8832--><p class="indent" > A more recent change to <span +href="#sec:locationsyntax">§5.2 </a><a +href="#sec:locationsyntax">Locations<!--tex4ht:ref: sec:locationsyntax --></a>). This means that the page +number may be incorrect if the indexing occurs during the output routine. +<!--l. 9793--><p class="indent" > A more recent change to <span class="cmss-10">fmtcount</span><a - id="dx1-66049"></a> (v3.03) now puts three instances of <span -class="cmtt-10">\expandafter</span> -before <span class="obeylines-h"><span class="verb"><span + id="dx1-144052"></a> (v3.03) now puts three instances of <span +class="cmtt-10">\expandafter </span>before +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">\the\value</span></span></span> which no longer hides <span -class="cmtt-10">\c@page </span>from the location escaping mechanism, so -the page numbers should once more be correct. Further changes to the <span +class="cmtt-10">\c@page </span>from the location escaping mechanism, so the page +numbers should once more be correct. Further changes to the <span class="cmss-10">fmtcount</span><a - id="dx1-66050"></a> package may -cause a problem again. -</p><!--l. 8838--><p class="indent" > <div class="important" title="Important Note"> When dealing with custom formats where the internal definitions are outside of your -control and liable to change, it’s best to provide a wrapper command. </div> -</p><!--l. 8842--><p class="noindent" > -</p><!--l. 8844--><p class="indent" > Instead of directly using <span + id="dx1-144053"></a> package may cause a problem +again. +</p><!--l. 9799--><p class="indent" > <div class="important" title="Important Note"> When dealing with custom formats where the internal definitions are outside of your control and liable to +change, it’s best to provide a wrapper command. </div> +</p><!--l. 9803--><p class="noindent" > +</p><!--l. 9805--><p class="indent" > Instead of directly using <span class="cmtt-10">\Numberstring </span>in the definition of <span -class="cmtt-10">\thepage</span>, I can provide a -custom command in the same form as the earlier <span +class="cmtt-10">\thepage</span>, I can provide a custom command in +the same form as the earlier <span class="cmtt-10">\tally </span>command: - - + + </p> - <div class="verbatim" id="verbatim-295"> + <div class="verbatim" id="verbatim-293"> \newcommand{\customfmt}[1]{\customfmtnum{\arabic{#1}}}  <br />\newrobustcmd{\customfmtnum}[1]{\Numberstringnum{#1}} </div> -<!--l. 8850--><p class="nopar" > This ensures that the location will always be written to the indexing file in the form: -</p><div class="alltt"> +<!--l. 9811--><p class="nopar" > This ensures that the location will always be written to the indexing file in the form: </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">:locref</span><span @@ -17963,25 +20029,25 @@ class="cmitt-10">n</span>⟩<span class="cmtt-10">}}"</span> </div> </div> So the location class can be defined as: - - - <div class="verbatim" id="verbatim-296"> + + + <div class="verbatim" id="verbatim-294"> \GlsAddXdyLocation{customfmt}{  <br /> :sep "\string\customfmtnum\space\glsopenbrace"  <br /> "arabic-numbers"  <br /> :sep "\glsclosebrace"} </div> -<!--l. 8862--><p class="nopar" > -</p><!--l. 8864--><p class="indent" > The sample file <a -href="#x1-11089r26"><span +<!--l. 9823--><p class="nopar" > +</p><!--l. 9825--><p class="indent" > The sample file <a +href="#ex:samplexdy3"><span class="cmtt-10">samplexdy3.tex</span></a> illustrates this. </p> <div class="center" > -<!--l. 8866--><p class="noindent" > -</p><!--l. 8866--><p class="noindent" >____________________________</p></div> -<!--l. 8868--><p class="indent" > In the <a +<!--l. 9827--><p class="noindent" > +</p><!--l. 9827--><p class="noindent" >____________________________</p></div> +<!--l. 9829--><p class="indent" > In the <a href="#glo:numberlist">number list<a - id="dx1-66051"></a></a>, the locations are sorted according to the list of provided location classes. + id="dx1-144054"></a></a>, the locations are sorted according to the list of provided location classes. The default ordering is: <span class="cmtt-10">roman-page-numbers </span>(i, ii, …), <span class="cmtt-10">arabic-page-numbers </span>(1, 2, …), @@ -17989,41 +20055,36 @@ class="cmtt-10">arabic-page-numbers </span>(1, 2, …), class="cmtt-10">arabic-section-numbers </span>(for example, 1.1 if the compositor is a full stop or 1-1 if the compositor is a hyphen<span class="footnote-mark"><a href="#fn1x11" id="fn1x11-bk"><sup class="textsuperscript">11.1</sup></a></span><a - id="x1-66052f1"></a>), + id="x1-144055f1"></a>), <span class="cmtt-10">alpha-page-numbers </span>(a, b, …), <span -class="cmtt-10">Roman-page-numbers </span>(I, II, …), +class="cmtt-10">Roman-page-numbers </span>(I, II, …), <span +class="cmtt-10">Alpha-page-numbers </span>(A, B, …), <span -class="cmtt-10">Alpha-page-numbers </span>(A, B, …), <span -class="cmtt-10">Appendix-page-numbers </span>(for example, A.1 -if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a +class="cmtt-10">Appendix-page-numbers </span>(for example, A.1 if the Alpha compositor is a full stop or A-1 if the Alpha compositor is a hyphen<span class="footnote-mark"><a href="#fn2x11" id="fn2x11-bk"><sup class="textsuperscript">11.2</sup></a></span><a - id="x1-66054f2"></a>), -user defined location names (as specified by <span + id="x1-144057f2"></a>), user defined +location names (as specified by <span class="cmtt-10">\GlsAddXdyLocation</span><a - id="dx1-66056"></a> in -the order in which they were defined), and finally <span + id="dx1-144059"></a> in the order in which they were defined), and finally <span class="cmtt-10">see </span>(cross-referenced entries).<span class="footnote-mark"><a href="#fn3x11" id="fn3x11-bk"><sup class="textsuperscript">11.3</sup></a></span><a - id="x1-66057f3"></a> + id="x1-144060f3"></a> This ordering can be changed using: -</p><!--l. 8885--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyLocationClassOrder</span><span -class="cmtt-9"> </span></span><a - id="dx1-66058"></a> <span +</p><!--l. 9846--><p class="indent" > <hr><div title="Definition"><a + id="dx1-144061"></a> <span class="cmtt-10">\GlsSetXdyLocationClassOrder{</span>⟨<span class="cmitt-10">location names</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 8887--><p class="noindent" > -where each location name is delimited by double quote marks and separated by white space. -For example: - - +class="cmtt-10">} </span></div><hr> +</p><!--l. 9848--><p class="noindent" > +where each location name is delimited by double quote marks and separated by white space. For +example: + + </p> - <div class="verbatim" id="verbatim-297"> + <div class="verbatim" id="verbatim-295"> \GlsSetXdyLocationClassOrder{  <br />  "arabic-page-numbers"  <br />  "arabic-section-numbers" @@ -18035,129 +20096,116 @@ For example:  <br />  "see"  <br />} </div> -<!--l. 8901--><p class="nopar" > (Remember to add <span class="obeylines-h"><span class="verb"><span +<!--l. 9862--><p class="nopar" > (Remember to add <span class="obeylines-h"><span class="verb"><span class="cmtt-10">"seealso"</span></span></span> if you’re using <a href="#glo:glossaries-extra"><span class="cmss-10">glossaries-extra</span></a>.) -</p><!--l. 8905--><p class="indent" > <div class="important" title="Important Note"> Note that <span +</p><!--l. 9866--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\GlsSetXdyLocationClassOrder </span>has no effect if <span class="cmtt-10">\noist</span><a - id="dx1-66059"></a> is used or if -<span + id="dx1-144062"></a> is used or if <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66060"></a> is omitted. <span -class="cmtt-10">\GlsSetXdyLocationClassOrder </span>must be used before -<span + id="dx1-144063"></a> is +omitted. <span +class="cmtt-10">\GlsSetXdyLocationClassOrder </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66061"></a>. </div> -</p><!--l. 8910--><p class="noindent" > -</p><!--l. 8912--><p class="indent" > If a <a + id="dx1-144064"></a>. </div> +</p><!--l. 9871--><p class="noindent" > +</p><!--l. 9873--><p class="indent" > If a <a href="#glo:numberlist">number list<a - id="dx1-66062"></a></a> 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: -</p><!--l. 8917--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyMinRangeLength</span><span -class="cmtt-9"> </span></span><a - id="dx1-66063"></a> <span + id="dx1-144065"></a></a> 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: +</p><!--l. 9878--><p class="indent" > <hr><div title="Definition"><a + id="dx1-144066"></a> <span class="cmtt-10">\GlsSetXdyMinRangeLength{</span>⟨<span class="cmitt-10">n</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 8919--><p class="noindent" > +</p><!--l. 9880--><p class="noindent" > For example: - - + + </p> - <div class="verbatim" id="verbatim-298"> + <div class="verbatim" id="verbatim-296"> \GlsSetXdyMinRangeLength{3} </div> -<!--l. 8923--><p class="nopar" > The argument may also be the keyword <span -class="cmtt-10">none</span>, to indicate that there should be no range -formations. See the <a +<!--l. 9884--><p class="nopar" > The argument may also be the keyword <span +class="cmtt-10">none</span>, to indicate that there should be no range formations. See the +<a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-66064"></a></a> manual for further details on range formations. -</p><!--l. 8928--><p class="indent" > <div class="important" title="Important Note"> Note that <span + id="dx1-144067"></a></a> manual for further details on range formations. +</p><!--l. 9889--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmtt-10">\GlsSetXdyMinRangeLength </span>has no effect if <span class="cmtt-10">\noist</span><a - id="dx1-66065"></a> is used or if -<span + id="dx1-144068"></a> is used or if <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66066"></a> is omitted. <span -class="cmtt-10">\GlsSetXdyMinRangeLength </span>must be used before + id="dx1-144069"></a> is omitted. <span +class="cmtt-10">\GlsSetXdyMinRangeLength </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-66067"></a>. </div> -</p><!--l. 8933--><p class="noindent" > + id="dx1-144070"></a>. </div> +</p><!--l. 9894--><p class="noindent" > See also <a -href="#sec:ranges"><span -class="tcrm-1000">§</span>5.3 </a><a +href="#sec:ranges">§5.3 </a><a href="#sec:ranges">Range Formations<!--tex4ht:ref: sec:ranges --></a>. -</p><!--l. 8936--><p class="noindent" > +</p><!--l. 9897--><p class="noindent" > </p> -<!--l. 8936--><p class="noindent" ><a +<!--l. 9897--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">11.3 </span> <a id="sec:groups"></a>Glossary Groups</h3> -<!--l. 8939--><p class="noindent" >The glossary is divided into groups according to the first letter of the sort key. The <span -class="cmss-10">glossaries</span> -package also adds a number group by default, unless you suppress it in the <span +<!--l. 9900--><p class="noindent" >The glossary is divided into groups according to the first letter of the sort key. The <span +class="cmss-10">glossaries </span>package also adds a +number group by default, unless you suppress it in the <span class="cmss-10">xindy</span><a - id="dx1-67001"></a> package -option. For example: - - + id="dx1-145001"></a> package option. For example: + + </p> - <div class="verbatim" id="verbatim-299"> + <div class="verbatim" id="verbatim-297"> \usepackage[xindy={glsnumbers=false}]{glossaries} </div> -<!--l. 8945--><p class="nopar" > Any entry that doesn’t go in one of the letter groups or the number group is placed in the -default group. If you want <a +<!--l. 9906--><p class="nopar" > Any entry that doesn’t go in one of the letter groups or the number group is placed in the default group. If you +want <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-67002"></a></a> to sort the number group numerically (rather than by a -string sort) then you need to use <a + id="dx1-145002"></a></a> to sort the number group numerically (rather than by a string sort) then you need to use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-67003"></a>’s</a> <span + id="dx1-145003"></a>’s</a> +<span class="cmtt-10">numeric-sort </span>module: - - + + </p> - <div class="verbatim" id="verbatim-300"> + <div class="verbatim" id="verbatim-298"> \GlsAddXdyStyle{numeric-sort} </div> -<!--l. 8952--><p class="nopar" > -</p><!--l. 8954--><p class="indent" > If you don’t use <span -class="cmtt-10">glsnumbers=false</span>, 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: -</p><!--l. 8959--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyFirstLetterAfterDigits</span><span -class="cmtt-9"> </span></span><a - id="dx1-67004"></a> <span +<!--l. 9913--><p class="nopar" > +</p><!--l. 9915--><p class="indent" > If you don’t use <span +class="cmtt-10">glsnumbers=false</span>, 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: +</p><!--l. 9920--><p class="indent" > <hr><div title="Definition"><a + id="dx1-145004"></a> <span class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits{</span>⟨<span class="cmitt-10">letter</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 8961--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 9922--><p class="noindent" > where ⟨<span class="cmti-10">letter</span>⟩ is the first letter of your alphabet. Take care if you’re using <span class="cmss-10">inputenc</span><a - id="dx1-67005"></a> as -non-ASCII characters are actually active characters that expand. (This isn’t a problem with -the native UTF-8 engines and <span + id="dx1-145005"></a> as non-ASCII characters are +actually active characters that expand. (This isn’t a problem with the native UTF-8 engines and +<span class="cmss-10">fontspec</span><a - id="dx1-67006"></a>.) The starred form will sanitize the argument to -prevent expansion. Alternatively you can use: -</p><!--l. 8970--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsSetXdyNumberGroupOrder</span><span -class="cmtt-9"> </span></span><a - id="dx1-67007"></a> <span + id="dx1-145006"></a>.) The starred form will sanitize the argument to prevent expansion. Alternatively you can +use: +</p><!--l. 9931--><p class="indent" > <hr><div title="Definition"><a + id="dx1-145007"></a> <span class="cmtt-10">\GlsSetXdyNumberGroupOrder{</span>⟨<span class="cmitt-10">relative location</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 8972--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 9933--><p class="noindent" > to change the default </p><div class="alltt"> <div class="obeylines-v"> <span @@ -18168,15 +20216,14 @@ class="cmtt-10">\string"</span> </div> </div> to ⟨<span class="cmti-10">relative location</span>⟩. For example: - - - <div class="verbatim" id="verbatim-301"> + + + <div class="verbatim" id="verbatim-299"> \GlsSetXdyNumberGroupOrder{:after \string"Z\string"} </div> -<!--l. 8980--><p class="nopar" > will put the number group after the “Z” letter group. Again take care of active characters. -There’s a starred version that sanitizes the argument (so don’t use <span -class="cmtt-10">\string </span>in it). -</p><div class="alltt"> +<!--l. 9941--><p class="nopar" > will put the number group after the “Z” letter group. Again take care of active characters. There’s a starred +version that sanitizes the argument (so don’t use <span +class="cmtt-10">\string </span>in it). </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\GlsSetXdyNumberGroupOrder*</span><span @@ -18188,29 +20235,27 @@ class="cmtt-10">"</span><span class="cmsy-10">}</span> </div> </div> -<!--l. 8988--><p class="indent" > <div class="important" title="Important Note"> Note that these commands have no effect if <span +<!--l. 9949--><p class="indent" > <div class="important" title="Important Note"> Note that these commands have no effect if <span class="cmtt-10">\noist</span><a - id="dx1-67008"></a> is used or if <span + id="dx1-145008"></a> is used or if <span class="cmtt-10">\makeglossaries</span><a - id="dx1-67009"></a> is -omitted. <span + id="dx1-145009"></a> is omitted. +<span class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits </span>must be used before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-67010"></a>. + id="dx1-145010"></a>. </div> -</p><!--l. 8993--><p class="noindent" > - - +</p><!--l. 9954--><p class="noindent" > + + </p> -<!--l. 8996--><p class="indent" > </div> -</p><!--l. 8996--><p class="noindent" ><a +<!--l. 9957--><p class="indent" > </div> +</p><!--l. 9957--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">12. <a id="sec:newglossary"></a>Defining New Glossaries</h2> -</p><!--l. 8999--><p class="indent" > A new glossary can be defined using: -</p><!--l. 9000--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-68001"></a> <span +</p><!--l. 9960--><p class="indent" > A new glossary can be defined using: +</p><!--l. 9961--><p class="indent" > <hr><div title="Definition"><a + id="dx1-146001"></a> <span class="cmtt-10">\newglossary[</span>⟨<span class="cmitt-10">log-ext</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18226,53 +20271,49 @@ class="cmitt-10">title</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">counter</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9002--><p class="noindent" > +</p><!--l. 9963--><p class="noindent" > where ⟨<span class="cmti-10">name</span>⟩ is the label to assign to this glossary. The arguments ⟨<span class="cmti-10">in-ext</span>⟩ and ⟨<span -class="cmti-10">out-ext</span>⟩ specify -the extensions to give to the input and output files for that glossary, ⟨<span -class="cmti-10">title</span>⟩ is the default title -for this new glossary and the final optional argument ⟨<span -class="cmti-10">counter</span>⟩ specifies which counter to use -for the associated <a +class="cmti-10">out-ext</span>⟩ specify the extensions to +give to the input and output files for that glossary, ⟨<span +class="cmti-10">title</span>⟩ is the default title for this new glossary and the final +optional argument ⟨<span +class="cmti-10">counter</span>⟩ specifies which counter to use for the associated <a href="#glo:numberlist">number list<a - id="dx1-68002"></a>s</a> (see also <a -href="#sec:numberlists"><span -class="tcrm-1000">§</span>5 </a><a -href="#sec:numberlists">Number lists<!--tex4ht:ref: sec:numberlists --></a>). The first optional argument -specifies the extension for the <a + id="dx1-146002"></a>s</a> (see also <a +href="#sec:numberlists">§5 </a><a +href="#sec:numberlists">Number +lists<!--tex4ht:ref: sec:numberlists --></a>). The first optional argument specifies the extension for the <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-68003"></a></a> (<a + id="dx1-146003"></a></a> (<a href="#option2">Option 2</a>) or <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-68004"></a></a> (<a -href="#option3">Option 3</a>) transcript file (this -information is only used by <a + id="dx1-146004"></a></a> +(<a +href="#option3">Option 3</a>) transcript file (this information is only used by <a href="#glo:makeglossaries"><span class="cmtt-10">makeglossaries</span><a - id="dx1-68005"></a></a> which picks up the information from the -auxiliary file). If you use <a + id="dx1-146005"></a></a> which picks up the +information from the auxiliary file). If you use <a href="#option1">Option 1</a>, the ⟨<span class="cmti-10">log-ext</span>⟩, ⟨<span class="cmti-10">in-ext</span>⟩ and ⟨<span class="cmti-10">out-ext</span>⟩ arguments are ignored. -</p><!--l. 9016--><p class="indent" > <div class="important" title="Important Note"> The glossary label ⟨<span -class="cmti-10">name</span>⟩ must not contain any active characters. It’s generally best to -stick with just characters that have category code 11 (typically the non-extended <a -href="#glo:latinchar">Latin -character<a - id="dx1-68006"></a>s</a> for standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span>). </div> -</p><!--l. 9021--><p class="noindent" > -</p><!--l. 9023--><p class="indent" > There is also a starred version (new to v4.08): -</p><!--l. 9024--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newglossary*</span><span -class="cmtt-9"> </span></span><a - id="dx1-68007"></a> <span +</p><!--l. 9977--><p class="indent" > <div class="important" title="Important Note"> The glossary label ⟨<span +class="cmti-10">name</span>⟩ must not contain any active characters. It’s generally best to stick with just +characters that have category code 11 (typically the non-extended <a +href="#glo:latinchar">Latin character<a + id="dx1-146006"></a>s</a> for standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>). +</div> +</p><!--l. 9982--><p class="noindent" > +</p><!--l. 9984--><p class="indent" > There is also a starred version (new to v4.08): +</p><!--l. 9985--><p class="indent" > <hr><div title="Definition"><a + id="dx1-146007"></a> <span class="cmtt-10">\newglossary*{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -18280,7 +20321,7 @@ class="cmitt-10">title</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">counter</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9026--><p class="noindent" > +</p><!--l. 9987--><p class="noindent" > which is equivalent to </p><div class="alltt"> <div class="obeylines-v"> <span @@ -18303,10 +20344,8 @@ class="cmitt-10">counter</span>⟩<span class="cmtt-10">]</span> </div> </div> or you can also use: -<!--l. 9032--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\altnewglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-68008"></a> <span +<!--l. 9993--><p class="indent" > <hr><div title="Definition"><a + id="dx1-146008"></a> <span class="cmtt-10">\altnewglossary{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -18316,7 +20355,7 @@ class="cmitt-10">title</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">counter</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9034--><p class="noindent" > +</p><!--l. 9995--><p class="noindent" > which is equivalent to </p><div class="alltt"> <div class="obeylines-v"> <span @@ -18339,37 +20378,42 @@ class="cmitt-10">counter</span>⟩<span class="cmtt-10">]</span> </div> </div> -<!--l. 9040--><p class="indent" > It may be that you have some terms that are so common that they don’t need to be listed. -In this case, you can define a special type of glossary that doesn’t create any associated files. -This is referred to as an “ignored glossary” and it’s ignored by commands that iterate -over all the glossaries, such as <span +<!--l. 10001--><p class="indent" > It may be that you have some terms that are so common that they don’t need to be listed. In this case, you +can define a special type of glossary that doesn’t create any associated files. This is referred to as an “ignored +glossary” and it’s ignored by commands that iterate over all the glossaries, such as <span class="cmtt-10">\printglossaries</span><a - id="dx1-68009"></a>. To define an ignored glossary, -use -</p><!--l. 9046--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newignoredglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-68010"></a> <span + id="dx1-146009"></a>. To +define an ignored glossary, use +</p><!--l. 10007--><p class="indent" > <hr><div title="Definition"><a + id="dx1-146010"></a> <span class="cmtt-10">\newignoredglossary{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9048--><p class="noindent" > +</p><!--l. 10009--><p class="noindent" > where ⟨<span -class="cmti-10">name</span>⟩ is the name of the glossary (as above). This glossary type will automatically be - - -added to the <span +class="cmti-10">name</span>⟩ is the name of the glossary (as above). This glossary type will automatically be added to the +<span class="cmss-10">nohypertypes</span><a - id="dx1-68011"></a> list, since there are no hypertargets for the entries in -an ignored glossary. (The sample file <a -href="#x1-11114r38"><span -class="cmtt-10">sample-entryfmt.tex</span></a> defines an ignored -glossary.) -</p><!--l. 9055--><p class="indent" > You can test if a glossary is an ignored one using: -</p><!--l. 9056--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifignoredglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-68012"></a> <span + id="dx1-146011"></a> list, since there are no hypertargets for the entries in an ignored glossary. (The sample file +<a +href="#ex:sample-entryfmt"><span +class="cmtt-10">sample-entryfmt.tex</span></a> defines an ignored glossary.) + + +</p><!--l. 10016--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a starred version of this command that allows hyperlinks (since +ignored glossaries can be useful with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-146012"></a></a>). There is also an analogous <span id="textcolor281"><span +class="cmtt-10">\provideignoredglossary</span></span><a + id="dx1-146013"></a> +command. </div> +</p><!--l. 10021--><p class="noindent" > +</p><!--l. 10023--><p class="indent" > You can test if a glossary is an ignored one using: +</p><!--l. 10024--><p class="indent" > <hr><div title="Definition"><a + id="dx1-146014"></a> <span class="cmtt-10">\ifignoredglossary{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -18377,152 +20421,143 @@ class="cmitt-10">true</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9058--><p class="noindent" > +</p><!--l. 10026--><p class="noindent" > This does ⟨<span class="cmti-10">true</span>⟩ if ⟨<span class="cmti-10">name</span>⟩ was defined as an ignored glossary, otherwise it does ⟨<span class="cmti-10">false</span>⟩. -</p><!--l. 9062--><p class="indent" > Note that the main (default) glossary is automatically created as: - - +</p><!--l. 10030--><p class="indent" > Note that the main (default) glossary is automatically created as: + + </p> - <div class="verbatim" id="verbatim-302"> + <div class="verbatim" id="verbatim-300"> \newglossary{main}{gls}{glo}{\glossaryname} </div> -<!--l. 9065--><p class="nopar" > so it can be identified by the label <span +<!--l. 10033--><p class="nopar" > so it can be identified by the label <span class="cmtt-10">main </span>(unless the <span class="cmss-10">nomain</span><a - id="dx1-68013"></a> package option is used). Using -the <span + id="dx1-146015"></a> package option is used). Using the <span class="cmss-10">acronym</span><a - id="dx1-68014"></a> package option is equivalent to: - - + id="dx1-146016"></a> package +option is equivalent to: + + </p> - <div class="verbatim" id="verbatim-303"> + <div class="verbatim" id="verbatim-301"> \newglossary[alg]{acronym}{acr}{acn}{\acronymname} </div> -<!--l. 9071--><p class="nopar" > so it can be identified by the label <span +<!--l. 10039--><p class="nopar" > so it can be identified by the label <span class="cmtt-10">acronym</span>. If you are not sure whether the <span class="cmss-10">acronym</span><a - id="dx1-68015"></a> -option has been used, you can identify the list of acronyms by the command -<span class="reversemarginpar"><span -class="cmtt-9">\acronymtype</span><span -class="cmtt-9"> </span></span><a - id="dx1-68016"></a><span + id="dx1-146017"></a> option has been used, you +can identify the list of acronyms by the command <a + id="dx1-146018"></a><span class="cmtt-10">\acronymtype </span>which is set to <span class="cmtt-10">acronym</span>, if the <span class="cmss-10">acronym</span><a - id="dx1-68017"></a> option has been used, -otherwise it is set to <span -class="cmtt-10">main</span>. Note that if you are using the main glossary as your list of -acronyms, you need to declare it as a list of acronyms using the package option + id="dx1-146019"></a> +option has been used, otherwise it is set to <span +class="cmtt-10">main</span>. Note that if you are using the main glossary +as your list of acronyms, you need to declare it as a list of acronyms using the package option <span class="cmss-10">acronymlists</span><a - id="dx1-68018"></a>. -</p><!--l. 9082--><p class="indent" > The <span + id="dx1-146020"></a>. +</p><!--l. 10050--><p class="indent" > The <span class="cmss-10">symbols</span><a - id="dx1-68019"></a> package option creates a new glossary with the label <span + id="dx1-146021"></a> package option creates a new glossary with the label <span class="cmtt-10">symbols </span>using: - - + + </p> - <div class="verbatim" id="verbatim-304"> + <div class="verbatim" id="verbatim-302"> \newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} </div> -<!--l. 9086--><p class="nopar" > The <span +<!--l. 10054--><p class="nopar" > The <span class="cmss-10">numbers</span><a - id="dx1-68020"></a> package option creates a new glossary with the label <span + id="dx1-146022"></a> package option creates a new glossary with the label <span class="cmtt-10">numbers </span>using: - - + + </p> - <div class="verbatim" id="verbatim-305"> + <div class="verbatim" id="verbatim-303"> \newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} </div> -<!--l. 9091--><p class="nopar" > The <span +<!--l. 10059--><p class="nopar" > The <span class="cmss-10">index</span><a - id="dx1-68021"></a> package option creates a new glossary with the label <span + id="dx1-146023"></a> package option creates a new glossary with the label <span class="cmtt-10">index </span>using: - - + + </p> - <div class="verbatim" id="verbatim-306"> + <div class="verbatim" id="verbatim-304"> \newglossary[ilg]{index}{ind}{idx}{\indexname} </div> -<!--l. 9096--><p class="nopar" > -</p><!--l. 9098--><p class="indent" > <div class="important" title="Important Note"> Options <a +<!--l. 10064--><p class="nopar" > +</p><!--l. 10066--><p class="indent" > <div class="important" title="Important Note"> Options <a href="#option2">2</a> and <a href="#option3">3</a>: all glossaries must be defined before <span class="cmtt-10">\makeglossaries</span><a - id="dx1-68022"></a> to ensure that -the relevant output files are opened. -</p><!--l. 9102--><p class="indent" > See <a -href="#sec:fixednames"><span -class="tcrm-1000">§</span>1.4.1 </a><a + id="dx1-146024"></a> to ensure that the relevant output +files are opened. +</p><!--l. 10070--><p class="indent" > See <a +href="#sec:fixednames">§1.3.1 </a><a href="#sec:fixednames">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> if you want to redefine <span -class="cmtt-10">\glossaryname</span>, -especially if you are using <span +class="cmtt-10">\glossaryname</span>, especially if you are using +<span class="cmss-10">babel</span><a - id="dx1-68023"></a> or <span + id="dx1-146025"></a> or <span class="cmss-10">translator</span><a - id="dx1-68024"></a>. (Similarly for <span -class="cmtt-10">\glssymbolsgroupname </span>and -<span -class="cmtt-10">\glsnumbersgroupname</span>.) If you want to redefine <span + id="dx1-146026"></a>. (Similarly for <span +class="cmtt-10">\glssymbolsgroupname </span>and <span +class="cmtt-10">\glsnumbersgroupname</span>.) If you +want to redefine <span class="cmtt-10">\indexname</span><a - id="dx1-68025"></a>, just follow the advice in <a -href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fixnam" >How -to change LaTeX’s “fixed names”</a>. </div> -</p><!--l. 9109--><p class="noindent" > - - -</p> -<!--l. 9111--><p class="indent" > </div> -</p><!--l. 9111--><p class="noindent" ><a + id="dx1-146027"></a>, just follow the advice in <a +href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fixnam" >How to change LaTeX’s “fixed names”</a>. +</div> +</p><!--l. 10077--><p class="noindent" > + + +</p> +<!--l. 10079--><p class="indent" > </div> +</p><!--l. 10079--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">13. <a id="sec:acronyms"></a>Acronyms and Other Abbreviations</h2> -</p><!--l. 9114--><p class="indent" > The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-69001"></a> package provides superior abbreviation handling. You may want to -consider using that package instead of the commands described here. -</p><!--l. 9118--><p class="indent" > <div class="important" title="Important Note"> Note that although this chapter uses the term “acronym”, you can also use the -commands described here for initialisms or contractions (as in the case of some of the -examples given below). If the glossary title is no longer applicable (for example, -it should be “Abbreviations” rather than “Acronyms”) then you can change the +</p><!--l. 10082--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides superior abbreviation handling. You may want to consider using that +package instead of the commands described here. </div> +</p><!--l. 10086--><p class="noindent" > +</p><!--l. 10088--><p class="indent" > <div class="important" title="Important Note"> Note that although this chapter uses the term “acronym”, you can also use the commands described here +for initialisms or contractions (as in the case of some of the examples given below). If the glossary title is no +longer applicable (for example, it should be “Abbreviations” rather than “Acronyms”) then you can change the title either by redefining <span class="cmtt-10">\acronymname</span><a - id="dx1-69002"></a> (see <a -href="#sec:languages"><span -class="tcrm-1000">§</span>1.4 </a><a -href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a>) or by -using the <span -class="cmss-10">title</span><a - id="dx1-69003"></a> in the optional argument of <span + id="dx1-147001"></a> (see <a +href="#sec:languages">§1.3 </a><a +href="#sec:languages">Multi-Lingual Support<!--tex4ht:ref: sec:languages --></a>) or by using the <span +class="cmtt-10">title</span><a + id="dx1-147002"></a> in the optional +argument of <span class="cmtt-10">\printglossary</span><a - id="dx1-69004"></a> (or <span -class="cmtt-10">\printacronym</span><a - id="dx1-69005"></a>). -Alternatively consider using the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-69006"></a> package’s <span -class="cmss-10">abbreviations </span>option instead. -</div> -</p><!--l. 9130--><p class="noindent" > -</p><!--l. 9132--><p class="indent" > You may have noticed in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that when you specify a new entry, -you can specify alternate text to use when the term is <a -href="#glo:firstuse">first used</a> in the document. This -provides a useful means to define abbreviations. For convenience, the <span -class="cmss-10">glossaries </span>package -defines the command: -</p><!--l. 9137--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newacronym</span><span -class="cmtt-9"> </span></span><a - id="dx1-69007"></a> <span + id="dx1-147003"></a> (or <span +class="cmtt-10">\printacronyms</span><a + id="dx1-147004"></a>). Alternatively consider using the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package’s +<span id="textcolor282"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-147005"></a> option instead. </div> +</p><!--l. 10100--><p class="noindent" > +</p><!--l. 10102--><p class="indent" > You may have noticed in <a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that when you specify a new entry, you can specify +alternate text to use when the term is <a +href="#glo:firstuse">first used</a> in the document. This provides a useful means to define +abbreviations. For convenience, the <span +class="cmss-10">glossaries </span>package defines the command: +</p><!--l. 10107--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147006"></a> <span class="cmtt-10">\newacronym[</span>⟨<span class="cmitt-10">key-val list</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18532,188 +20567,178 @@ class="cmitt-10">abbrv</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9139--><p class="noindent" > -</p><!--l. 9141--><p class="indent" > This uses <span +</p><!--l. 10109--><p class="noindent" > +</p><!--l. 10111--><p class="indent" > This uses <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-69008"></a> to create an entry with the given label in the glossary given -by <span + id="dx1-147007"></a> to create an entry with the given label in the glossary given by +<span class="cmtt-10">\acronymtype</span><a - id="dx1-69009"></a>. You can specify a different glossary using the <span -class="cmss-10">type</span><a - id="dx1-69010"></a> key within the optional -argument. The <span + id="dx1-147008"></a>. You can specify a different glossary using the <span +class="cmtt-10">type</span><a + id="dx1-147009"></a> key within the optional argument. The +<span class="cmtt-10">\newacronym </span>command also uses the <span -class="cmss-10">long</span><a - id="dx1-69011"></a>, <span -class="cmss-10">longplural</span><a - id="dx1-69012"></a>, <span -class="cmss-10">short</span><a - id="dx1-69013"></a> and <span -class="cmss-10">shortplural</span><a - id="dx1-69014"></a> -keys in <span -class="cmtt-10">\newglossaryentry </span>to store the long and abbreviated forms and their -plurals. -</p><!--l. 9149--><p class="indent" > Note that the same restrictions on the entry ⟨<span +class="cmtt-10">long</span><a + id="dx1-147010"></a>, <span +class="cmtt-10">longplural</span><a + id="dx1-147011"></a>, <span +class="cmtt-10">short</span><a + id="dx1-147012"></a> and <span +class="cmtt-10">shortplural</span><a + id="dx1-147013"></a> keys in <span +class="cmtt-10">\newglossaryentry</span> +to store the long and abbreviated forms and their plurals. +</p><!--l. 10119--><p class="indent" > Note that the same restrictions on the entry ⟨<span class="cmti-10">label</span>⟩ in <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-69015"></a> also apply to -<span + id="dx1-147014"></a> also apply to <span class="cmtt-10">\newacronym </span>(see <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a +href="#sec:newglosentry">§4 +</a><a href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>). -</p><!--l. 9153--><p class="indent" > <div class="important" title="Important Note"> If you haven’t identified the specified glossary type as a list of acronyms (via -the package option <span +</p><!--l. 10123--><p class="indent" > <div class="important" title="Important Note"> If you haven’t identified the specified glossary type as a list of acronyms (via the package option <span class="cmss-10">acronymlists</span><a - id="dx1-69016"></a> or the command <span + id="dx1-147015"></a> +or the command <span class="cmtt-10">\DeclareAcronymList</span><a - id="dx1-69017"></a>, see <a -href="#sec:pkgopts-acronym"><span -class="tcrm-1000">§</span>2.5 -</a><a -href="#sec:pkgopts-acronym">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>) <span -class="cmtt-10">\newacronym </span>will add it to the list and <span -class="cmti-10">reset the display style</span> -for that glossary via <span + id="dx1-147016"></a>, see <a +href="#sec:pkgopts-acronym">§2.7 </a><a +href="#sec:pkgopts-acronym">Acronym and Abbreviation Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>) <span +class="cmtt-10">\newacronym </span>will add it +to the list and <span +class="cmti-10">reset the display style </span>for that glossary via <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-69018"></a>. If you have a mixture of acronyms and -regular entries within the same glossary, care is needed if you want to change the -display style: you must first identify that glossary as a list of acronyms and then -use <span + id="dx1-147017"></a>. If you have a mixture of acronyms +and regular entries within the same glossary, care is needed if you want to change the display style: you must +first identify that glossary as a list of acronyms and then use <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-69019"></a> (not redefine <span + id="dx1-147018"></a> (not redefine <span class="cmtt-10">\glsentryfmt</span><a - id="dx1-69020"></a>) before defining your entries. -</div> -</p><!--l. 9164--><p class="noindent" > -</p><!--l. 9166--><p class="indent" > The optional argument <span + id="dx1-147019"></a>) +before defining your entries. </div> +</p><!--l. 10134--><p class="noindent" > +</p><!--l. 10136--><p class="indent" > The optional argument <span class="cmtt-10">{</span>⟨<span class="cmti-10">key-val list</span>⟩<span -class="cmtt-10">} </span>allows you to specify additional information. Any -key that can be used in the second argument of <span +class="cmtt-10">} </span>allows you to specify additional information. Any key that can be used +in the second argument of <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-69021"></a> can also be used -here in ⟨<span + id="dx1-147020"></a> can also be used here in ⟨<span class="cmti-10">key-val list</span>⟩. For example, <span -class="cmss-10">description</span><a - id="dx1-69022"></a> (when used with one of the styles that -require a description, described in <a -href="#sec:setacronymstyle"><span -class="tcrm-1000">§</span>13.1 </a><a -href="#sec:setacronymstyle">Changing the Abbreviation Style<!--tex4ht:ref: sec:setacronymstyle --></a>) or you can -override plural forms of ⟨<span +class="cmtt-10">description</span><a + id="dx1-147021"></a> +(when used with one of the styles that require a description, described in <a +href="#sec:setacronymstyle">§13.1 </a><a +href="#sec:setacronymstyle">Changing the Abbreviation Style<!--tex4ht:ref: sec:setacronymstyle --></a>) +or you can override plural forms of ⟨<span class="cmti-10">abbrv</span>⟩ or ⟨<span class="cmti-10">long</span>⟩ using the <span -class="cmss-10">shortplural</span><a - id="dx1-69023"></a> or <span -class="cmss-10">longplural</span><a - id="dx1-69024"></a> keys. For +class="cmtt-10">shortplural</span><a + id="dx1-147022"></a> or <span +class="cmtt-10">longplural</span><a + id="dx1-147023"></a> keys. For example: - - + + </p> - <div class="verbatim" id="verbatim-307"> + <div class="verbatim" id="verbatim-305"> \newacronym[longplural={diagonal matrices}]%  <br />  {dm}{DM}{diagonal matrix} </div> -<!--l. 9179--><p class="nopar" > If the <a +<!--l. 10149--><p class="nopar" > If the <a href="#glo:firstuse">first use</a> uses the plural form, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glspl{dm}</span></span></span> will display: diagonal matrices -(DMs). If you want to use the <span -class="cmss-10">longplural</span><a - id="dx1-69025"></a> or <span -class="cmss-10">shortplural</span><a - id="dx1-69026"></a> keys, I recommend you use +class="cmtt-10">\glspl{dm}</span></span></span> will display: diagonal matrices (DMs). If you want to use the <span +class="cmtt-10">longplural</span><a + id="dx1-147024"></a> or <span +class="cmtt-10">shortplural</span><a + id="dx1-147025"></a> keys, I recommend you use <span class="cmtt-10">\setacronymstyle</span><a - id="dx1-69027"></a> to set the display style rather than using one of the pre-version 4.02 -acronym styles. -</p><!--l. 9186--><p class="indent" > As with <span -class="cmss-10">plural</span><a - id="dx1-69028"></a> and <span -class="cmss-10">firstplural</span><a - id="dx1-69029"></a>, if <span -class="cmss-10">longplural</span><a - id="dx1-69030"></a> is missing, it’s obtained by appended -<span + id="dx1-147026"></a> to set the display style rather than +using one of the pre-version 4.02 acronym styles. +</p><!--l. 10156--><p class="indent" > As with <span +class="cmtt-10">plural</span><a + id="dx1-147027"></a> and <span +class="cmtt-10">firstplural</span><a + id="dx1-147028"></a>, if <span +class="cmtt-10">longplural</span><a + id="dx1-147029"></a> is missing, it’s obtained by appended <span class="cmtt-10">\glspluralsuffix</span><a - id="dx1-69031"></a> to the singular form. The short plural <span -class="cmss-10">shortplural</span><a - id="dx1-69032"></a> is obtained (is not -explicitly set) by appending <span + id="dx1-147030"></a> +to the singular form. The short plural <span +class="cmtt-10">shortplural</span><a + id="dx1-147031"></a> is obtained (is not explicitly set) by appending +<span class="cmtt-10">\glsacrpluralsuffix</span><a - id="dx1-69033"></a> to the short form. These commands may -be changed by the associated language files, but they can’t be added to the usual -caption hooks as there’s no guarantee when they’ll be expanded (as <a -href="#pluralsuffix">discussed earlier</a>). -A different approach is used by <span -class="cmss-10">glossaries-extra</span>, which has category attributes to -determine whether or not to append a suffix when forming the default value of -<span -class="cmss-10">shortplural</span><a - id="dx1-69034"></a>. -</p><!--l. 9198--><p class="indent" > Since <span + id="dx1-147032"></a> to the short form. These commands may be changed by the associated +language files, but they can’t be added to the usual caption hooks as there’s no guarantee when +they’ll be expanded (as <a +href="#pluralsuffix">discussed earlier</a>). A different approach is used by <span +class="cmss-10">glossaries-extra</span>, which has +<a + id="dx1-147033"></a>category attributes to determine whether or not to append a suffix when forming the default value of +<span +class="cmtt-10">shortplural</span><a + id="dx1-147034"></a>. +</p><!--l. 10168--><p class="indent" > Since <span class="cmtt-10">\newacronym</span><a - id="dx1-69035"></a> uses <span + id="dx1-147035"></a> uses <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-69036"></a>, you can use commands like <span + id="dx1-147036"></a>, you can use commands like <span class="cmtt-10">\gls</span><a - id="dx1-69037"></a> and -<span + id="dx1-147037"></a> and <span class="cmtt-10">\glsreset</span><a - id="dx1-69038"></a> as with any other glossary entry. -</p><!--l. 9202--><p class="indent" > <div class="important" title="Important Note"> Since <span + id="dx1-147038"></a> as with any +other glossary entry. +</p><!--l. 10172--><p class="indent" > <div class="important" title="Important Note"> Since <span class="cmtt-10">\newacronym </span>sets <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">type=\acronymtype</span></span></span>, if you want to load a file containing -acronym definitions using <span +class="cmtt-10">type=\acronymtype</span></span></span>, if you want to load a file containing acronym definitions using +<span class="cmtt-10">\loadglsentries</span><a - id="dx1-69039"></a><span + id="dx1-147039"></a><span class="cmtt-10">[</span>⟨<span class="cmti-10">type</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">filename</span>⟩<span class="cmtt-10">}</span>, the optional argument ⟨<span -class="cmti-10">type</span>⟩ -will not have an effect unless you explicitly set the type as <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">type=\glsdefaulttype</span></span></span> -in the optional argument to <span +class="cmti-10">type</span>⟩ will not have an effect unless you explicitly set +the type as <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">type=\glsdefaulttype</span></span></span> in the optional argument to <span class="cmtt-10">\newacronym</span><a - id="dx1-69040"></a>. See <a -href="#sec:loadglsentries"><span -class="tcrm-1000">§</span>4.6 </a><a -href="#sec:loadglsentries">Loading Entries From a File<!--tex4ht:ref: sec:loadglsentries --></a>. -</div> -</p><!--l. 9209--><p class="noindent" > + id="dx1-147040"></a>. See <a +href="#sec:loadglsentries">§4.6 </a><a +href="#sec:loadglsentries">Loading Entries From a +File<!--tex4ht:ref: sec:loadglsentries --></a>. </div> +</p><!--l. 10179--><p class="noindent" > <a - id="x1-69041r21"></a> -</p><!--l. 9211--><p class="noindent" ><span + id="ex:newacronym"></a> +</p><!--l. 10181--><p class="noindent" ><span class="cmbx-12">Example 21</span><span class="cmbx-12"> (Defining an Abbreviation)</span><a - id="x1-69042"></a> -</p><!--l. 9212--><p class="indent" > The following defines the abbreviation IDN: - - + id="x1-147042"></a> +</p><!--l. 10182--><p class="indent" > The following defines the abbreviation IDN: + + </p> - <div class="verbatim" id="verbatim-308"> + <div class="verbatim" id="verbatim-306"> \newacronym{idn}{IDN}{identification number} </div> -<!--l. 9215--><p class="nopar" > <span class="obeylines-h"><span class="verb"><span +<!--l. 10185--><p class="nopar" > <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{idn}</span></span></span> will produce “identification number (IDN)” on <a -href="#glo:firstuse">first use</a> and “IDN” on -subsequent uses. If you want to use one of the smallcaps acronym styles, described in <a -href="#sec:setacronymstyle"><span -class="tcrm-1000">§</span>13.1 -</a><a -href="#sec:setacronymstyle">Changing the Abbreviation Style<!--tex4ht:ref: sec:setacronymstyle --></a>, you need to use lower case characters for the shortened -form: - - +href="#glo:firstuse">first use</a> and “IDN” on subsequent uses. If you want +to use one of the <a +href="#glo:smallcaps">small caps<a + id="dx1-147043"></a></a> acronym styles, described in <a +href="#sec:setacronymstyle">§13.1 </a><a +href="#sec:setacronymstyle">Changing the Abbreviation Style<!--tex4ht:ref: sec:setacronymstyle --></a>, you need to use +lower case characters for the shortened form: + + </p> - <div class="verbatim" id="verbatim-309"> + <div class="verbatim" id="verbatim-307"> \newacronym{idn}{idn}{identification number} </div> -<!--l. 9223--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span +<!--l. 10193--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{idn}</span></span></span> will produce “identification number (<span class="cmcsc-10"><span class="small-caps">i</span><span @@ -18723,112 +20748,105 @@ href="#glo:firstuse">first use</a> and “<span class="cmcsc-10"><span class="small-caps">i</span><span class="small-caps">d</span><span -class="small-caps">n</span></span>” on -subsequent uses. </p> +class="small-caps">n</span></span>” on subsequent uses. +</p> <div class="center" > -<!--l. 9227--><p class="noindent" > -</p><!--l. 9227--><p class="noindent" >____________________________</p></div> -<!--l. 9229--><p class="indent" > <div class="important" title="Important Note"> Avoid nested definitions. </div> -</p><!--l. 9231--><p class="noindent" > -</p><!--l. 9233--><p class="indent" > Recall from the warning in <a -href="#sec:newglosentry"><span -class="tcrm-1000">§</span>4 </a><a -href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that you should avoid using the -<a +<!--l. 10197--><p class="noindent" > +</p><!--l. 10197--><p class="noindent" >____________________________</p></div> +<!--l. 10199--><p class="indent" > <div class="important" title="Important Note"> Avoid nested definitions. </div> +</p><!--l. 10201--><p class="noindent" > +</p><!--l. 10203--><p class="indent" > Recall from the warning in <a +href="#sec:newglosentry">§4 </a><a +href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a> that you should avoid using the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> and <a +class="cmtt-10">\gls</span>-like</a> and +<a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands within the value of keys like <span -class="cmss-10">text</span><a - id="dx1-69043"></a> and <span -class="cmss-10">first</span><a - id="dx1-69044"></a> due to -complications arising from nested links. The same applies to abbreviations defined using -<span +class="cmtt-10">text</span><a + id="dx1-147044"></a> and <span +class="cmtt-10">first</span><a + id="dx1-147045"></a> due to complications arising from nested +links. The same applies to abbreviations defined using <span class="cmtt-10">\newacronym</span>. -</p><!--l. 9240--><p class="indent" > For example, suppose you have defined: - - +</p><!--l. 10210--><p class="indent" > For example, suppose you have defined: + + </p> - <div class="verbatim" id="verbatim-310"> + <div class="verbatim" id="verbatim-308"> \newacronym{ssi}{SSI}{server side includes}  <br />\newacronym{html}{HTML}{hypertext markup language} </div> -<!--l. 9244--><p class="nopar" > you may be tempted to do: - - +<!--l. 10214--><p class="nopar" > you may be tempted to do: + + </p> - <div class="verbatim" id="verbatim-311"> + <div class="verbatim" id="verbatim-309"> \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}} </div> -<!--l. 9248--><p class="nopar" > <span -class="cmbx-10">Don’t! </span>This will break the case-changing commands, such as <span +<!--l. 10218--><p class="nopar" > <strong>Don’t!</strong> This will break the case-changing commands, such as <span class="cmtt-10">\Gls</span><a - id="dx1-69045"></a>, it will cause -inconsistencies on <a -href="#glo:firstuse">first use</a>, and, if hyperlinks are enabled, will cause nested hyperlinks. It will -also confuse the commands used by the entry formatting (such as <span + id="dx1-147046"></a>, it will cause inconsistencies on <a +href="#glo:firstuse">first use</a>, and, +if hyperlinks are enabled, will cause nested hyperlinks. It will also confuse the commands used by the entry +formatting (such as <span class="cmtt-10">\glslabel</span><a - id="dx1-69046"></a>). -</p><!--l. 9255--><p class="indent" > Instead, consider doing: - - + id="dx1-147047"></a>). +</p><!--l. 10225--><p class="indent" > Instead, consider doing: + + </p> - <div class="verbatim" id="verbatim-312"> + <div class="verbatim" id="verbatim-310"> \newacronym  <br /> [description={\gls{ssi} enabled \gls{html}}]  <br /> {shtml}{SHTML}{SSI enabled HTML} </div> -<!--l. 9260--><p class="nopar" > or - - +<!--l. 10230--><p class="nopar" > or + + </p> - <div class="verbatim" id="verbatim-313"> + <div class="verbatim" id="verbatim-311"> \newacronym  <br /> [description={\gls{ssi} enabled \gls{html}}]  <br /> {shtml}{SHTML}  <br /> {server side includes enabled hypertext markup language} </div> -<!--l. 9267--><p class="nopar" > Similarly for the <a +<!--l. 10237--><p class="nopar" > Similarly for the <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands. -</p><!--l. 9270--><p class="indent" > Other approaches are available with <span -class="cmss-10">glossaries-extra</span><a - id="dx1-69047"></a>. See the section “Nested Links” in the -<span -class="cmss-10">glossaries-extra </span>user manual. -</p><!--l. 9274--><p class="indent" > <div class="important" title="Important Note"> The commands described below are similar to the <a +</p><!--l. 10240--><p class="indent" > Other approaches are available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. See the section “Nested Links” in the <span +class="cmss-10">glossaries-extra</span> +user manual. +</p><!--l. 10244--><p class="indent" > <div class="important" title="Important Note"> The commands described below are similar to the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands in that they -don’t modify the <a +class="cmtt-10">\glstext</span>-like</a> commands in that they don’t modify the +<a href="#glo:firstuseflag">first use flag</a>. However, their display is governed by <span class="cmtt-10">\defentryfmt</span><a - id="dx1-69048"></a> with -<span + id="dx1-147048"></a> with <span class="cmtt-10">\glscustomtext</span><a - id="dx1-69049"></a> set as appropriate. All caveats that apply to the <a + id="dx1-147049"></a> set as appropriate. All +caveats that apply to the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands -also apply to the following commands. (Including the warning immediately above this box.) -</div> -</p><!--l. 9281--><p class="noindent" > -</p><!--l. 9283--><p class="indent" > The optional arguments are the same as those for the <a +class="cmtt-10">\glstext</span>-like</a> commands also apply to the following commands. (Including the +warning immediately above this box.) </div> +</p><!--l. 10251--><p class="noindent" > +</p><!--l. 10253--><p class="indent" > The optional arguments are the same as those for the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands, -and there are similar star and plus variants that switch off or on the hyperlinks. -As with the <a +class="cmtt-10">\glstext</span>-like</a> commands, and there are similar star +and plus variants that switch off or on the hyperlinks. As with the <a href="#sec:glstext-like"><span class="cmtt-10">\glstext</span>-like</a> commands, the <a href="#glo:linktext">link text<a - id="dx1-69050"></a></a> is placed in the argument of -<span + id="dx1-147050"></a></a> is +placed in the argument of <span class="cmtt-10">\glstextformat</span><a - id="dx1-69051"></a>. -</p><!--l. 9288--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-69052"></a> <span + id="dx1-147051"></a>. +</p><!--l. 10258--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147052"></a> <span class="cmtt-10">\acrshort[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18836,24 +20854,21 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9290--><p class="noindent" > +</p><!--l. 10260--><p class="noindent" > This sets the <a href="#glo:linktext">link text<a - id="dx1-69053"></a></a> to the short form (within the argument of <span + id="dx1-147053"></a></a> to the short form (within the argument of <span class="cmtt-10">\acronymfont</span><a - id="dx1-69054"></a>) for the entry -given by ⟨<span -class="cmti-10">label</span>⟩. The short form is as supplied by the <span -class="cmss-10">short</span><a - id="dx1-69055"></a> key, which <span + id="dx1-147054"></a>) for the entry given by ⟨<span +class="cmti-10">label</span>⟩. +The short form is as supplied by the <span +class="cmtt-10">short</span><a + id="dx1-147055"></a> key, which <span class="cmtt-10">\newacronym</span><a - id="dx1-69056"></a> implicitly -sets. -</p><!--l. 9296--><p class="indent" > There are also analogous upper case variants: -</p><!--l. 9297--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-69057"></a> <span + id="dx1-147056"></a> implicitly sets. +</p><!--l. 10266--><p class="indent" > There are also analogous upper case variants: +</p><!--l. 10267--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147057"></a> <span class="cmtt-10">\Acrshort[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18861,11 +20876,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9299--><p class="noindent" > -</p><!--l. 9300--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-69058"></a> <span +</p><!--l. 10269--><p class="noindent" > +</p><!--l. 10270--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147058"></a> <span class="cmtt-10">\ACRshort[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18873,12 +20886,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9302--><p class="noindent" > +</p><!--l. 10272--><p class="noindent" > There are also plural versions: -</p><!--l. 9304--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrshortpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69059"></a> <span +</p><!--l. 10274--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147059"></a> <span class="cmtt-10">\acrshortpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18886,11 +20897,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9306--><p class="noindent" > -</p><!--l. 9307--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrshortpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69060"></a> <span +</p><!--l. 10276--><p class="noindent" > +</p><!--l. 10277--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147060"></a> <span class="cmtt-10">\Acrshortpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18898,11 +20907,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9309--><p class="noindent" > -</p><!--l. 9310--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRshortpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69061"></a> <span +</p><!--l. 10279--><p class="noindent" > +</p><!--l. 10280--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147061"></a> <span class="cmtt-10">\ACRshortpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18910,17 +20917,14 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9312--><p class="noindent" > +</p><!--l. 10282--><p class="noindent" > The short plural form is as supplied by the <span -class="cmss-10">shortplural</span><a - id="dx1-69062"></a> key, which <span +class="cmtt-10">shortplural</span><a + id="dx1-147062"></a> key, which <span class="cmtt-10">\newacronym</span><a - id="dx1-69063"></a> implicitly -sets. -</p><!--l. 9316--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrlong</span><span -class="cmtt-9"> </span></span><a - id="dx1-69064"></a> <span + id="dx1-147063"></a> implicitly sets. +</p><!--l. 10286--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147064"></a> <span class="cmtt-10">\acrlong[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18928,23 +20932,19 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> - - -</p><!--l. 9318--><p class="noindent" > +</p><!--l. 10288--><p class="noindent" > This sets the <a href="#glo:linktext">link text<a - id="dx1-69065"></a></a> to the long form for the entry given by ⟨<span -class="cmti-10">label</span>⟩. The long form is as -supplied by the <span -class="cmss-10">long</span><a - id="dx1-69066"></a> key, which <span + id="dx1-147065"></a></a> to the long form for the entry given by ⟨<span +class="cmti-10">label</span>⟩. The long form is as supplied by the <span +class="cmtt-10">long</span><a + id="dx1-147066"></a> +key, which <span class="cmtt-10">\newacronym</span><a - id="dx1-69067"></a> implicitly sets. -</p><!--l. 9323--><p class="indent" > There are also analogous upper case variants: -</p><!--l. 9324--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrlong</span><span -class="cmtt-9"> </span></span><a - id="dx1-69068"></a> <span + id="dx1-147067"></a> implicitly sets. +</p><!--l. 10293--><p class="indent" > There are also analogous upper case variants: +</p><!--l. 10294--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147068"></a> <span class="cmtt-10">\Acrlong[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18952,11 +20952,11 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9326--><p class="noindent" > -</p><!--l. 9327--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRlong</span><span -class="cmtt-9"> </span></span><a - id="dx1-69069"></a> <span + + +</p><!--l. 10296--><p class="noindent" > +</p><!--l. 10297--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147069"></a> <span class="cmtt-10">\ACRlong[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18964,12 +20964,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9329--><p class="noindent" > +</p><!--l. 10299--><p class="noindent" > Again there are also plural versions: -</p><!--l. 9331--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrlongpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69070"></a> <span +</p><!--l. 10301--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147070"></a> <span class="cmtt-10">\acrlongpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18977,11 +20975,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9333--><p class="noindent" > -</p><!--l. 9334--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrlongpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69071"></a> <span +</p><!--l. 10303--><p class="noindent" > +</p><!--l. 10304--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147071"></a> <span class="cmtt-10">\Acrlongpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -18989,11 +20985,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9336--><p class="noindent" > -</p><!--l. 9337--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRlongpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69072"></a> <span +</p><!--l. 10306--><p class="noindent" > +</p><!--l. 10307--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147072"></a> <span class="cmtt-10">\ACRlongpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19001,25 +20995,21 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9339--><p class="noindent" > +</p><!--l. 10309--><p class="noindent" > The long plural form is as supplied by the <span -class="cmss-10">longplural</span><a - id="dx1-69073"></a> key, which <span +class="cmtt-10">longplural</span><a + id="dx1-147073"></a> key, which <span class="cmtt-10">\newacronym</span><a - id="dx1-69074"></a> implicitly -sets. -</p><!--l. 9343--><p class="indent" > The commands below display the full form of the acronym, but note that this isn’t -necessarily the same as the form used on <a -href="#glo:firstuse">first use</a>. These full-form commands are shortcuts -that use the above commands, rather than creating the <a + id="dx1-147074"></a> implicitly sets. +</p><!--l. 10313--><p class="indent" > The commands below display the full form of the acronym, but note that this isn’t necessarily the same as +the form used on <a +href="#glo:firstuse">first use</a>. These full-form commands are shortcuts that use the above commands, rather than +creating the <a href="#glo:linktext">link text<a - id="dx1-69075"></a></a> from the complete full form. -These full-form commands have star and plus variants and optional arguments that are -passed to the above commands. -</p><!--l. 9350--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrfull</span><span -class="cmtt-9"> </span></span><a - id="dx1-69076"></a> <span + id="dx1-147075"></a></a> from the complete full form. These full-form commands have star and plus variants and +optional arguments that are passed to the above commands. +</p><!--l. 10320--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147076"></a> <span class="cmtt-10">\acrfull[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19027,12 +21017,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9352--><p class="noindent" > +</p><!--l. 10322--><p class="noindent" > This is a shortcut for -</p><!--l. 9354--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrfullfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-69077"></a> <span +</p><!--l. 10324--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147077"></a> <span class="cmtt-10">\acrfullfmt{</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -19040,59 +21028,48 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9356--><p class="noindent" > +</p><!--l. 10326--><p class="noindent" > which by default does </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\acrfullformat</span> <br /><span -class="cmtt-10"> </span><span -class="cmsy-10">{</span><span -class="cmtt-10">\acrlong[</span>⟨<span +class="cmtt-10"> {\acrlong[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span -class="cmtt-10">}</span><span -class="cmsy-10">}</span> +class="cmtt-10">}}</span> <br /><span -class="cmtt-10"> </span><span -class="cmsy-10">{</span><span -class="cmtt-10">\acrshort[</span>⟨<span +class="cmtt-10"> {\acrshort[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">label</span>⟩<span -class="cmtt-10">}</span><span -class="cmsy-10">}</span> +class="cmtt-10">}}</span> </div> </div> where -<!--l. 9364--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrfullformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-69078"></a> <span +<!--l. 10334--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147078"></a> <span class="cmtt-10">\acrfullformat{</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9366--><p class="noindent" > +</p><!--l. 10336--><p class="noindent" > by default does ⟨<span class="cmti-10">long</span>⟩ (⟨<span -class="cmti-10">short</span>⟩). This command is now deprecated for new acronym styles but is -used by the default for backward compatibility if <span +class="cmti-10">short</span>⟩). This command is now deprecated for new acronym styles but is used by +the default for backward compatibility if <span class="cmtt-10">\setacronymstyle </span>(<a -href="#sec:setacronymstyle"><span -class="tcrm-1000">§</span>13.1 </a><a -href="#sec:setacronymstyle">Changing the -Abbreviation Style<!--tex4ht:ref: sec:setacronymstyle --></a>) hasn’t been used. (For further details of these format commands see the -documented code, <span +href="#sec:setacronymstyle">§13.1 </a><a +href="#sec:setacronymstyle">Changing the Abbreviation +Style<!--tex4ht:ref: sec:setacronymstyle --></a>) hasn’t been used. (For further details of these format commands see the documented code, +<span class="cmtt-10">glossaries-code.pdf</span>.) -</p><!--l. 9375--><p class="indent" > There are also analogous upper case variants: -</p><!--l. 9376--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrfull</span><span -class="cmtt-9"> </span></span><a - id="dx1-69079"></a> <span +</p><!--l. 10345--><p class="indent" > There are also analogous upper case variants: +</p><!--l. 10346--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147079"></a> <span class="cmtt-10">\Acrfull[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19100,13 +21077,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> - - -</p><!--l. 9378--><p class="noindent" > -</p><!--l. 9379--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRfull</span><span -class="cmtt-9"> </span></span><a - id="dx1-69080"></a> <span +</p><!--l. 10348--><p class="noindent" > +</p><!--l. 10349--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147080"></a> <span class="cmtt-10">\ACRfull[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19114,12 +21087,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9381--><p class="noindent" > +</p><!--l. 10351--><p class="noindent" > and plural versions: -</p><!--l. 9383--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acrfullpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69081"></a> <span +</p><!--l. 10353--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147081"></a> <span class="cmtt-10">\acrfullpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19127,11 +21098,11 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9385--><p class="noindent" > -</p><!--l. 9386--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Acrfullpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69082"></a> <span + + +</p><!--l. 10355--><p class="noindent" > +</p><!--l. 10356--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147082"></a> <span class="cmtt-10">\Acrfullpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19139,11 +21110,9 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9388--><p class="noindent" > -</p><!--l. 9389--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ACRfullpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69083"></a> <span +</p><!--l. 10358--><p class="noindent" > +</p><!--l. 10359--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147083"></a> <span class="cmtt-10">\ACRfullpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -19151,25 +21120,25 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 9391--><p class="noindent" > -</p><!--l. 9393--><p class="indent" > If you find the above commands too cumbersome to write, you can use the <span +</p><!--l. 10361--><p class="noindent" > +</p><!--l. 10363--><p class="indent" > If you find the above commands too cumbersome to write, you can use the <span class="cmss-10">shortcuts</span><a - id="dx1-69084"></a> -package option to activate the shorter command names listed in <a + id="dx1-147084"></a> package option to +activate the shorter command names listed in <a href="#tab:shortcuts">table 13.1</a>. </p> <div class="table"> - - -<!--l. 9397--><p class="indent" > <a + + +<!--l. 10367--><p class="indent" > <a id="tab:shortcuts"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 13.1: </span><span class="content">Synonyms provided by the package option <span -class="cmss-10">shortcuts</span></span></div><!--tex4ht:label?: x1-690851 --> +class="cmss-10">shortcuts</span></span></div><!--tex4ht:label?: x1-1470851 --> <div class="tabular"> <table id="TBL-7" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-7-1g"><col @@ -19184,999 +21153,936 @@ class="cmbx-10">Equivalent Command </span></td> style="vertical-align:baseline;" id="TBL-7-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-1" class="td11"> <span class="cmtt-10">\acs</span><a - id="dx1-69086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-2" + id="dx1-147086"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-2-2" class="td11"> <span class="cmtt-10">\acrshort</span><a - id="dx1-69087"></a> </td> + id="dx1-147087"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-1" class="td11"> <span class="cmtt-10">\Acs</span><a - id="dx1-69088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-2" + id="dx1-147088"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-3-2" class="td11"> <span class="cmtt-10">\Acrshort</span><a - id="dx1-69089"></a> </td> + id="dx1-147089"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-1" class="td11"> <span class="cmtt-10">\acsp</span><a - id="dx1-69090"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-2" + id="dx1-147090"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-4-2" class="td11"> <span class="cmtt-10">\acrshortpl</span><a - id="dx1-69091"></a> </td> + id="dx1-147091"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-1" class="td11"> <span class="cmtt-10">\Acsp</span><a - id="dx1-69092"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-2" + id="dx1-147092"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-5-2" class="td11"> <span class="cmtt-10">\Acrshortpl</span><a - id="dx1-69093"></a> </td> + id="dx1-147093"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-1" class="td11"> <span class="cmtt-10">\acl</span><a - id="dx1-69094"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-2" + id="dx1-147094"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-6-2" class="td11"> <span class="cmtt-10">\acrlong</span><a - id="dx1-69095"></a> </td> + id="dx1-147095"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-1" class="td11"> <span class="cmtt-10">\Acl</span><a - id="dx1-69096"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-2" + id="dx1-147096"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-7-2" class="td11"> <span class="cmtt-10">\Acrlong</span><a - id="dx1-69097"></a> </td> + id="dx1-147097"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-1" class="td11"> <span class="cmtt-10">\aclp</span><a - id="dx1-69098"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-2" + id="dx1-147098"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-8-2" class="td11"> <span class="cmtt-10">\acrlongpl</span><a - id="dx1-69099"></a> </td> + id="dx1-147099"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-1" class="td11"> <span class="cmtt-10">\Aclp</span><a - id="dx1-69100"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-2" + id="dx1-147100"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-9-2" class="td11"> <span class="cmtt-10">\Acrlongpl</span><a - id="dx1-69101"></a> </td> + id="dx1-147101"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-1" class="td11"> <span class="cmtt-10">\acf</span><a - id="dx1-69102"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-2" + id="dx1-147102"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-10-2" class="td11"> <span class="cmtt-10">\acrfull</span><a - id="dx1-69103"></a> </td> + id="dx1-147103"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-1" class="td11"> <span class="cmtt-10">\Acf</span><a - id="dx1-69104"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-2" + id="dx1-147104"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-11-2" class="td11"> <span class="cmtt-10">\Acrfull</span><a - id="dx1-69105"></a> </td> + id="dx1-147105"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-1" class="td11"> <span class="cmtt-10">\acfp</span><a - id="dx1-69106"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-2" + id="dx1-147106"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-12-2" class="td11"> <span class="cmtt-10">\acrfullpl</span><a - id="dx1-69107"></a> </td> + id="dx1-147107"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-1" class="td11"> <span class="cmtt-10">\Acfp</span><a - id="dx1-69108"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-2" + id="dx1-147108"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-13-2" class="td11"> <span class="cmtt-10">\Acrfullpl</span><a - id="dx1-69109"></a> </td> + id="dx1-147109"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-14-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-1" class="td11"> <span class="cmtt-10">\ac</span><a - id="dx1-69110"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-2" + id="dx1-147110"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-14-2" class="td11"> <span class="cmtt-10">\gls</span><a - id="dx1-69111"></a> </td> + id="dx1-147111"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-15-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-1" class="td11"> <span class="cmtt-10">\Ac</span><a - id="dx1-69112"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-2" + id="dx1-147112"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-15-2" class="td11"> <span class="cmtt-10">\Gls</span><a - id="dx1-69113"></a> </td> + id="dx1-147113"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-16-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-1" class="td11"> <span class="cmtt-10">\acp</span><a - id="dx1-69114"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-2" + id="dx1-147114"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-16-2" class="td11"> <span class="cmtt-10">\glspl</span><a - id="dx1-69115"></a> </td> + id="dx1-147115"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-7-17-"><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-1" class="td11"> <span class="cmtt-10">\Acp</span><a - id="dx1-69116"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-2" + id="dx1-147116"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-7-17-2" class="td11"> <span class="cmtt-10">\Glspl</span><a - id="dx1-69117"></a> </td></tr></table> + id="dx1-147117"></a> </td></tr></table> </div> - - + + </div><hr class="endfloat" /> </div> -<!--l. 9423--><p class="indent" > It is also possible to access the long and short forms without adding information to the -glossary using commands analogous to <span +<!--l. 10393--><p class="indent" > It is also possible to access the long and short forms without adding information to the glossary using +commands analogous to <span class="cmtt-10">\glsentrytext</span><a - id="dx1-69118"></a> (described in <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a -href="#sec:glsnolink">Using Glossary Terms -Without Links<!--tex4ht:ref: sec:glsnolink --></a>). -</p><!--l. 9427--><p class="indent" > <div class="important" title="Important Note"> The commands that convert the first letter to upper case come with the same caveats as -those for analogous commands like <span + id="dx1-147118"></a> (described in <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>). +</p><!--l. 10397--><p class="indent" > <div class="important" title="Important Note"> The commands that convert the first letter to upper case come with the same caveats as those for analogous +commands like <span class="cmtt-10">\Glsentrytext</span><a - id="dx1-69119"></a> (non-expandable, can’t be used in PDF -bookmarks, care needs to be taken if the first letter is an accented character etc). See <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 -</a><a -href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>. </div> -</p><!--l. 9433--><p class="noindent" > -</p><!--l. 9435--><p class="indent" > The long form can be accessed using: -</p><!--l. 9436--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrylong</span><span -class="cmtt-9"> </span></span><a - id="dx1-69120"></a> <span + id="dx1-147119"></a> (non-expandable, can’t be used in PDF bookmarks, care needs to be +taken if the first letter is an accented character etc). See <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>. +</div> +</p><!--l. 10403--><p class="noindent" > +</p><!--l. 10405--><p class="indent" > The long form can be accessed using: +</p><!--l. 10406--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147120"></a> <span class="cmtt-10">\glsentrylong{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9438--><p class="noindent" > +</p><!--l. 10408--><p class="noindent" > or, with the first letter converted to upper case: -</p><!--l. 9440--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrylong</span><span -class="cmtt-9"> </span></span><a - id="dx1-69121"></a> <span +</p><!--l. 10410--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147121"></a> <span class="cmtt-10">\Glsentrylong{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9442--><p class="noindent" > +</p><!--l. 10412--><p class="noindent" > Plural forms: -</p><!--l. 9444--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrylongpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69122"></a> <span +</p><!--l. 10414--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147122"></a> <span class="cmtt-10">\glsentrylongpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9446--><p class="noindent" > -</p><!--l. 9447--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentrylongpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69123"></a> <span +</p><!--l. 10416--><p class="noindent" > +</p><!--l. 10417--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147123"></a> <span class="cmtt-10">\Glsentrylongpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9449--><p class="noindent" > -</p><!--l. 9451--><p class="indent" > Similarly, to access the short form: -</p><!--l. 9452--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-69124"></a> <span +</p><!--l. 10419--><p class="noindent" > +</p><!--l. 10421--><p class="indent" > Similarly, to access the short form: +</p><!--l. 10422--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147124"></a> <span class="cmtt-10">\glsentryshort{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9454--><p class="noindent" > +</p><!--l. 10424--><p class="noindent" > or, with the first letter converted to upper case: -</p><!--l. 9456--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-69125"></a> <span +</p><!--l. 10426--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147125"></a> <span class="cmtt-10">\Glsentryshort{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9458--><p class="noindent" > +</p><!--l. 10428--><p class="noindent" > Plural forms: -</p><!--l. 9460--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryshortpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69126"></a> <span +</p><!--l. 10430--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147126"></a> <span class="cmtt-10">\glsentryshortpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9462--><p class="noindent" > -</p><!--l. 9463--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryshortpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69127"></a> <span +</p><!--l. 10432--><p class="noindent" > +</p><!--l. 10433--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147127"></a> <span class="cmtt-10">\Glsentryshortpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9465--><p class="noindent" > -</p><!--l. 9467--><p class="indent" > And the full form can be obtained using: -</p><!--l. 9468--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryfull</span><span -class="cmtt-9"> </span></span><a - id="dx1-69128"></a> <span +</p><!--l. 10435--><p class="noindent" > +</p><!--l. 10437--><p class="indent" > And the full form can be obtained using: +</p><!--l. 10438--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147128"></a> <span class="cmtt-10">\glsentryfull{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9470--><p class="noindent" > -</p><!--l. 9471--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryfull</span><span -class="cmtt-9"> </span></span><a - id="dx1-69129"></a> <span +</p><!--l. 10440--><p class="noindent" > +</p><!--l. 10441--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147129"></a> <span class="cmtt-10">\Glsentryfull{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9473--><p class="noindent" > -</p><!--l. 9474--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryfullpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69130"></a> <span +</p><!--l. 10443--><p class="noindent" > +</p><!--l. 10444--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147130"></a> <span class="cmtt-10">\glsentryfullpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> - - -</p><!--l. 9476--><p class="noindent" > -</p><!--l. 9477--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryfullpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-69131"></a> <span +</p><!--l. 10446--><p class="noindent" > + + +</p><!--l. 10447--><p class="indent" > <hr><div title="Definition"><a + id="dx1-147131"></a> <span class="cmtt-10">\Glsentryfullpl{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9479--><p class="noindent" > +</p><!--l. 10449--><p class="noindent" > These again use <span class="cmtt-10">\acrfullformat</span><a - id="dx1-69132"></a> by default, but the new styles described in the section -below use different formatting commands. + id="dx1-147132"></a> by default, but the new styles described in the section below use different +formatting commands. </p> -<!--l. 9484--><p class="noindent" ><a +<!--l. 10454--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">13.1 </span> <a id="sec:setacronymstyle"></a>Changing the Abbreviation Style</h3> -<!--l. 9487--><p class="noindent" >It may be that the default style doesn’t suit your requirements in which case you can switch -to another style using -</p><!--l. 9489--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setacronymstyle</span><span -class="cmtt-9"> </span></span><a - id="dx1-70001"></a> <span +<!--l. 10457--><p class="noindent" >It may be that the default style doesn’t suit your requirements in which case you can switch to another style +using +</p><!--l. 10459--><p class="indent" > <hr><div title="Definition"><a + id="dx1-148001"></a> <span class="cmtt-10">\setacronymstyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9491--><p class="noindent" > +</p><!--l. 10461--><p class="noindent" > where ⟨<span class="cmti-10">style name</span>⟩ is the name of the required style. -</p><!--l. 9494--><p class="indent" > <div class="important" title="Important Note"> You must use <span +</p><!--l. 10464--><p class="indent" > <div class="important" title="Important Note"> You must use <span class="cmtt-10">\setacronymstyle </span><span class="cmti-10">before </span>you define the acronyms with <span -class="cmtt-10">\newacronym</span>. -</div> -</p><!--l. 9497--><p class="noindent" > -</p><!--l. 9499--><p class="indent" > For example: - - +class="cmtt-10">\newacronym</span>. </div> +</p><!--l. 10467--><p class="noindent" > +</p><!--l. 10469--><p class="indent" > For example: + + </p> - <div class="verbatim" id="verbatim-314"> + <div class="verbatim" id="verbatim-312"> \usepackage[acronym]{glossaries}  <br />\makeglossaries  <br />\setacronymstyle{long-sc-short}  <br />\newacronym{html}{html}{hypertext markup language}  <br />\newacronym{xml}{xml}{extensible markup language} </div> -<!--l. 9509--><p class="nopar" > Unpredictable results can occur if you try to use multiple styles. -</p><!--l. 9512--><p class="indent" > <div class="important" title="Important Note"> If you need multiple abbreviation styles, then try using the <a +<!--l. 10479--><p class="nopar" > Unpredictable results can occur if you try to use multiple styles. +</p><!--l. 10482--><p class="indent" > <div class="important" title="Important Note"> If you need multiple abbreviation styles, then try using the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package, which -has better abbreviation management. </div> -</p><!--l. 9516--><p class="noindent" > -</p><!--l. 9518--><p class="indent" > Note that unlike the default behaviour of <span -class="cmtt-10">\newacronym</span>, the styles used via -<span +class="cmss-10">glossaries-extra</span></a> package, which has better +abbreviation management. </div> +</p><!--l. 10486--><p class="noindent" > +</p><!--l. 10488--><p class="indent" > Unlike the default behaviour of <span +class="cmtt-10">\newacronym</span>, the styles used via <span class="cmtt-10">\setacronymstyle </span>don’t use the <span -class="cmss-10">first</span><a - id="dx1-70002"></a> or <span -class="cmss-10">text</span><a - id="dx1-70003"></a> keys, but instead they use <span +class="cmtt-10">first</span><a + id="dx1-148002"></a> or +<span +class="cmtt-10">text</span><a + id="dx1-148003"></a> keys, but instead they use <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-70004"></a> to -set a custom format that uses the <span -class="cmss-10">long</span><a - id="dx1-70005"></a> and <span -class="cmss-10">short</span><a - id="dx1-70006"></a> keys (or their plural equivalents). This -means that these styles cope better with plurals that aren’t formed by simply appending the -singular form with the letter “s”. In fact, most of the predefined styles use <span + id="dx1-148004"></a> to set a custom format that uses the <span +class="cmtt-10">long</span><a + id="dx1-148005"></a> and <span +class="cmtt-10">short</span><a + id="dx1-148006"></a> keys +(or their plural equivalents). This means that these styles cope better with plurals that aren’t formed by simply +appending the singular form with the letter “s”. In fact, most of the predefined styles use <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-70007"></a> and + id="dx1-148007"></a> and modify the definitions of commands like <span class="cmtt-10">\genacrfullformat</span><a - id="dx1-70008"></a>. -</p><!--l. 9528--><p class="indent" > Note that when you use <span + id="dx1-148008"></a>. +</p><!--l. 10498--><p class="indent" > Note that when you use <span class="cmtt-10">\setacronymstyle </span>the <span -class="cmss-10">name</span><a - id="dx1-70009"></a> key is set to -</p><!--l. 9530--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acronymentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-70010"></a> <span +class="cmtt-10">name</span><a + id="dx1-148009"></a> key is set to +</p><!--l. 10500--><p class="indent" > <hr><div title="Definition"><a + id="dx1-148010"></a> <span class="cmtt-10">\acronymentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9532--><p class="noindent" > +</p><!--l. 10502--><p class="noindent" > and the <span -class="cmss-10">sort</span><a - id="dx1-70011"></a> key is set to -</p><!--l. 9534--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acronymsort</span><span -class="cmtt-9"> </span></span><a - id="dx1-70012"></a> <span +class="cmtt-10">sort</span><a + id="dx1-148011"></a> key is set to +</p><!--l. 10504--><p class="indent" > <hr><div title="Definition"><a + id="dx1-148012"></a> <span class="cmtt-10">\acronymsort{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9536--><p class="noindent" > -These commands are redefined by the acronym styles. However, you can redefine them again -after the style has been set but before you use <span -class="cmtt-10">\newacronym</span>. Protected expansion is -performed on <span -class="cmtt-10">\acronymsort </span>when the entry is defined. -</p><!--l. 9542--><p class="noindent" > -</p> -<!--l. 9542--><p class="noindent" ><a +</p><!--l. 10506--><p class="noindent" > +These commands are redefined by the acronym styles. However, you can redefine them again after the style has +been set but before you use <span +class="cmtt-10">\newacronym</span>. Protected expansion is performed on <span +class="cmtt-10">\acronymsort </span>when the entry is +defined. +</p><!--l. 10512--><p class="noindent" > +</p> +<!--l. 10512--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">13.1.1 </span> <a id="sec:predefinedacrstyles"></a>Predefined Acronym Styles</h4> -<!--l. 9545--><p class="noindent" >The <span +<!--l. 10515--><p class="noindent" >The <span class="cmss-10">glossaries </span>package provides a number of predefined styles. These styles apply -</p><!--l. 9547--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\firstacronymfont</span><span -class="cmtt-9"> </span></span><a - id="dx1-71001"></a> <span +</p><!--l. 10517--><p class="indent" > <hr><div title="Definition"><a + id="dx1-149001"></a> <span class="cmtt-10">\firstacronymfont{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9549--><p class="noindent" > +</p><!--l. 10519--><p class="noindent" > to the short form on first use and -</p><!--l. 9551--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\acronymfont</span><span -class="cmtt-9"> </span></span><a - id="dx1-71002"></a> <span +</p><!--l. 10521--><p class="indent" > <hr><div title="Definition"><a + id="dx1-149002"></a> <span class="cmtt-10">\acronymfont{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9553--><p class="noindent" > +</p><!--l. 10523--><p class="noindent" > on subsequent use. The styles modify the definition of <span -class="cmtt-10">\acronymfont </span>as required, but -<span +class="cmtt-10">\acronymfont </span>as required, but <span class="cmtt-10">\firstacronymfont</span><a - id="dx1-71003"></a> is only set once by the package when it’s loaded. By default - - -<span + id="dx1-149003"></a> is +only set once by the package when it’s loaded. By default <span class="cmtt-10">\firstacronymfont</span><a - id="dx1-71004"></a><span + id="dx1-149004"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">text</span>⟩<span -class="cmtt-10">} </span>is the same as <span +class="cmtt-10">} </span>is the same as +<span class="cmtt-10">\acronymfont</span><a - id="dx1-71005"></a><span + id="dx1-149005"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">text</span>⟩<span -class="cmtt-10">}</span>. If you want the short form -displayed differently on first use, you can redefine <span +class="cmtt-10">}</span>. If you want the short form displayed differently on first use, you can redefine +<span class="cmtt-10">\firstacronymfont</span><a - id="dx1-71006"></a> independently of the -acronym style. -</p><!--l. 9563--><p class="indent" > The predefined styles that contain <span + id="dx1-149006"></a> independently of the acronym style. + + +</p><!--l. 10533--><p class="indent" > The predefined styles that contain <span class="cmtt-10">sc </span>in their name (for example <span class="cmss-10">long-sc-short</span><a - id="dx1-71007"></a>) redefine + id="dx1-149007"></a>) redefine <span +class="cmtt-10">\acronymfont </span>to use <span -class="cmtt-10">\acronymfont </span>to use <span class="cmtt-10">\textsc</span><a - id="dx1-71008"></a>, which means that the short form needs to be specified in lower -case. -</p><!--l. 9569--><p class="indent" > <a + id="dx1-149008"></a>, which means that the short form needs to be specified in lower case. +</p><!--l. 10539--><p class="indent" > <a id="boldsc"></a> -</p><!--l. 9570--><p class="indent" > <div class="important" title="Important Note">Some fonts don’t support bold smallcaps, so you may need to redefine <span +</p><!--l. 10540--><p class="indent" > <div class="important" title="Important Note">Some fonts don’t support bold <a +href="#glo:smallcaps">small caps<a + id="dx1-149009"></a></a>, so you may need to redefine <span class="cmtt-10">\glsnamefont</span><a - id="dx1-71009"></a> (see -<a -href="#sec:printglossary"><span -class="tcrm-1000">§</span>10 </a><a -href="#sec:printglossary">Displaying a glossary<!--tex4ht:ref: sec:printglossary --></a>) to switch to medium weight if you are using a glossary style that -displays entry names in bold and you have chosen an acronym style that uses <span + id="dx1-149010"></a> (see <a +href="#sec:printglossary">§10 </a><a +href="#sec:printglossary">Displaying a +glossary<!--tex4ht:ref: sec:printglossary --></a>) to switch to medium weight if you are using a glossary style that displays entry names in bold and you +have chosen an acronym style that uses <span class="cmtt-10">\textsc</span><a - id="dx1-71010"></a>. -</div> -</p><!--l. 9576--><p class="noindent" > -</p><!--l. 9578--><p class="indent" > The predefined styles that contain <span + id="dx1-149011"></a>. </div> +</p><!--l. 10546--><p class="noindent" > +</p><!--l. 10548--><p class="indent" > The predefined styles that contain <span class="cmtt-10">sm </span>in their name (for example <span class="cmss-10">long-sm-short</span><a - id="dx1-71011"></a>) redefine -<span -class="cmtt-10">\acronymfont </span>to use <span + id="dx1-149012"></a>) redefine <span +class="cmtt-10">\acronymfont </span>to +use <span class="cmtt-10">\textsmaller</span><a - id="dx1-71012"></a>. -</p><!--l. 9582--><p class="indent" > <a + id="dx1-149013"></a>. +</p><!--l. 10552--><p class="indent" > <a id="smaller"></a> -</p><!--l. 9583--><p class="indent" > <div class="important" title="Important Note"> Note that the <span -class="cmss-10">glossaries </span>package doesn’t define or load any package that defines -<span +</p><!--l. 10553--><p class="indent" > <div class="important" title="Important Note"> Note that the <span +class="cmss-10">glossaries </span>package doesn’t define or load any package that defines <span class="cmtt-10">\textsmaller</span><a - id="dx1-71013"></a>. If you use one of the acronym styles that set <span + id="dx1-149014"></a>. If you use +one of the acronym styles that set <span class="cmtt-10">\acronymfont</span><a - id="dx1-71014"></a> to <span -class="cmtt-10">\textsmaller</span> -you must explicitly load the <span + id="dx1-149015"></a> to <span +class="cmtt-10">\textsmaller </span>you must explicitly load the <span class="cmss-10">relsize</span><a - id="dx1-71015"></a> package or otherwise define <span + id="dx1-149016"></a> package +or otherwise define <span class="cmtt-10">\textsmaller</span>. </div> -</p><!--l. 9589--><p class="noindent" > -</p><!--l. 9591--><p class="indent" > The remaining predefined styles redefine <span +</p><!--l. 10559--><p class="noindent" > +</p><!--l. 10561--><p class="indent" > The remaining predefined styles redefine <span class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">text</span>⟩<span -class="cmtt-10">} </span>to simply do its argument -⟨<span +class="cmtt-10">} </span>to simply do its argument ⟨<span class="cmti-10">text</span>⟩. -</p><!--l. 9594--><p class="indent" > <div class="important" title="Important Note"> In most cases, the predefined styles adjust <span +</p><!--l. 10564--><p class="indent" > <div class="important" title="Important Note"> In most cases, the predefined styles adjust <span class="cmtt-10">\acrfull</span><a - id="dx1-71016"></a> and <span + id="dx1-149017"></a> and <span class="cmtt-10">\glsentryfull</span><a - id="dx1-71017"></a> (and their -plural and upper case variants) to reflect the style. The only exceptions to this are the <span + id="dx1-149018"></a> (and their plural and upper case +variants) to reflect the style. The only exceptions to this are the <span class="cmss-10">dua</span><a - id="dx1-71018"></a> -and <span + id="dx1-149019"></a> and <span class="cmss-10">footnote</span><a - id="dx1-71019"></a> styles (and their variants). </div> -</p><!--l. 9599--><p class="noindent" > -</p><!--l. 9601--><p class="indent" > The following styles are supplied by the <span + id="dx1-149020"></a> styles (and their variants). +</div> +</p><!--l. 10569--><p class="noindent" > +</p><!--l. 10571--><p class="indent" > The following styles are supplied by the <span class="cmss-10">glossaries </span>package: </p> <ul class="itemize1"> <li class="itemize"><span class="cmss-10">long-short</span><a - id="dx1-71020"></a>, <span + id="dx1-149021"></a>, <span class="cmss-10">long-sc-short</span><a - id="dx1-71021"></a>, <span + id="dx1-149022"></a>, <span class="cmss-10">long-sm-short</span><a - id="dx1-71022"></a>, <span + id="dx1-149023"></a>, <span class="cmss-10">long-sp-short</span><a - id="dx1-71023"></a>: - <!--l. 9607--><p class="noindent" >With these three styles, acronyms are displayed in the form - </p><!--l. 9609--><p class="noindent" ><hr><div title="Definition">⟨<span + id="dx1-149024"></a>: + <!--l. 10577--><p class="noindent" >With these three styles, acronyms are displayed in the form + </p><!--l. 10579--><p class="noindent" ><hr><div title="Definition">⟨<span class="cmitt-10">long</span>⟩ <span class="cmtt-10">(\firstacronymfont</span><a - id="dx1-71024"></a><span + id="dx1-149025"></a><span class="cmtt-10">{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">}) </span></div><hr> - </p><!--l. 9610--><p class="noindent" > + </p><!--l. 10580--><p class="noindent" > on first use and - </p><!--l. 9613--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 10583--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\acronymfont</span><a - id="dx1-71025"></a><span + id="dx1-149026"></a><span class="cmtt-10">{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 9614--><p class="noindent" > + </p><!--l. 10584--><p class="noindent" > on subsequent use. They also set <span class="cmtt-10">\acronymsort{</span>⟨<span class="cmti-10">short</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmti-10">long</span>⟩<span class="cmtt-10">} </span>to just ⟨<span -class="cmti-10">short</span>⟩. This means - that the acronyms are sorted according to their short form. In addition, <span -class="cmtt-10">\acronymentry</span> - <span -class="cmtt-10">{</span>⟨<span +class="cmti-10">short</span>⟩. This means that the + acronyms are sorted according to their short form. In addition, <span +class="cmtt-10">\acronymentry{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">} </span>is set to just the short form (enclosed in <span +class="cmtt-10">} </span>is set to + just the short form (enclosed in <span class="cmtt-10">\acronymfont</span>) and the <span -class="cmss-10">description</span><a - id="dx1-71026"></a> key - is set to the long form. - </p><!--l. 9622--><p class="noindent" >The <span +class="cmtt-10">description</span><a + id="dx1-149027"></a> key is set to the long + form. + </p><!--l. 10592--><p class="noindent" >The <span class="cmss-10">long-sp-short</span><a - id="dx1-71027"></a> style was introduced in version 4.16 and uses - </p><!--l. 9624--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsacspace</span><span -class="cmtt-9"> </span></span><a - id="dx1-71028"></a> <span + id="dx1-149028"></a> style was introduced in version 4.16 and uses + </p><!--l. 10594--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-149029"></a> <span class="cmtt-10">\glsacspace{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> - - - </p><!--l. 9626--><p class="noindent" > - for the space between the long and short forms. This defaults to a non-breakable space - (<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">~</span></span></span>) if (<span + </p><!--l. 10596--><p class="noindent" > + for the space between the long and short forms. This defaults to a non-breakable space (<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">~</span></span></span>) if + (<span class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">short</span>⟩<span -class="cmtt-10">}</span>) is less than 3em, otherwise it uses a normal space. This - may be redefined as required. For example, to always use a non-breakable - space: - - +class="cmtt-10">}</span>) is less than 3em, otherwise it uses a normal space. This may be redefined as + required. For example, to always use a non-breakable space: + + </p> - <div class="verbatim" id="verbatim-315"> + <div class="verbatim" id="verbatim-313"> \renewcommand*{\glsacspace}[1]{~} </div> - <!--l. 9634--><p class="nopar" > + <!--l. 10604--><p class="nopar" > </p></li> <li class="itemize"><span class="cmss-10">short-long</span><a - id="dx1-71029"></a>, <span + id="dx1-149030"></a>, <span class="cmss-10">sc-short-long</span><a - id="dx1-71030"></a>, <span + id="dx1-149031"></a>, <span class="cmss-10">sm-short-long</span><a - id="dx1-71031"></a>: - <!--l. 9639--><p class="noindent" >These three styles are analogous to the above three styles, except the display order is - swapped to - </p><!--l. 9642--><p class="noindent" ><hr><div title="Definition"><span + id="dx1-149032"></a>: + <!--l. 10609--><p class="noindent" >These three styles are analogous to the above three styles, except the display order is swapped + to + </p><!--l. 10612--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\firstacronymfont</span><a - id="dx1-71032"></a><span + id="dx1-149033"></a><span class="cmtt-10">{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">} (</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">) </span></div><hr> - </p><!--l. 9643--><p class="noindent" > + </p><!--l. 10613--><p class="noindent" > on first use. - </p><!--l. 9646--><p class="noindent" >Note, however, that <span + </p><!--l. 10616--><p class="noindent" >Note, however, that <span class="cmtt-10">\acronymsort</span><a - id="dx1-71033"></a> and <span + id="dx1-149034"></a> and <span class="cmtt-10">\acronymentry</span><a - id="dx1-71034"></a> are the same as for the ⟨<span -class="cmti-10">long</span>⟩ - (⟨<span -class="cmti-10">short</span>⟩) styles above, so the acronyms are still sorted according to the short - form. + id="dx1-149035"></a> are the same as for the ⟨<span +class="cmti-10">long</span>⟩ (⟨<span +class="cmti-10">short</span>⟩) styles above, + so the acronyms are still sorted according to the short form. </p></li> <li class="itemize"><span class="cmss-10">long-short-desc</span><a - id="dx1-71035"></a>, <span + id="dx1-149036"></a>, <span class="cmss-10">long-sc-short-desc</span><a - id="dx1-71036"></a>, <span + id="dx1-149037"></a>, <span class="cmss-10">long-sm-short-desc</span><a - id="dx1-71037"></a>, <span + id="dx1-149038"></a>, <span class="cmss-10">long-sp-short-desc</span><a - id="dx1-71038"></a>: - <!--l. 9653--><p class="noindent" >These are like the <span + id="dx1-149039"></a>: + <!--l. 10623--><p class="noindent" >These are like the <span class="cmss-10">long-short</span><a - id="dx1-71039"></a>, <span + id="dx1-149040"></a>, <span class="cmss-10">long-sc-short</span><a - id="dx1-71040"></a>, <span + id="dx1-149041"></a>, <span class="cmss-10">long-sm-short</span><a - id="dx1-71041"></a> and <span + id="dx1-149042"></a> and <span class="cmss-10">long-sp-short</span><a - id="dx1-71042"></a> styles - described above, except that the <span -class="cmss-10">description</span><a - id="dx1-71043"></a> key must be supplied in the optional - argument of <span + id="dx1-149043"></a> styles described above, except + that the <span +class="cmtt-10">description</span><a + id="dx1-149044"></a> key must be supplied in the optional argument of <span class="cmtt-10">\newacronym</span><a - id="dx1-71044"></a>. They also redefine <span + id="dx1-149045"></a>. They also redefine + <span class="cmtt-10">\acronymentry</span><a - id="dx1-71045"></a> to <span + id="dx1-149046"></a> to <span class="cmtt-10">{</span>⟨<span class="cmti-10">long</span>⟩<span class="cmtt-10">} </span>(<span -class="cmtt-10">\acronymfont</span> - <span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">short</span>⟩<span class="cmtt-10">}</span>) and redefine <span class="cmtt-10">\acronymsort</span><a - id="dx1-71046"></a><span + id="dx1-149047"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">short</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmti-10">long</span>⟩<span class="cmtt-10">} </span>to just ⟨<span -class="cmti-10">long</span>⟩. This means that the - acronyms are sorted according to the long form, and in the list of acronyms the name - field has the long form followed by the short form in parentheses. I recommend you use - a glossary style such as <span +class="cmti-10">long</span>⟩. + This means that the acronyms are sorted according to the long form, and in the list of acronyms + the name field has the long form followed by the short form in parentheses. I recommend + you use a glossary style such as <span class="cmss-10">altlist</span><a - id="dx1-71047"></a> with these acronym styles to allow for the long name + id="dx1-149048"></a> with these acronym styles to allow for the long name field. </p></li> <li class="itemize"><span class="cmss-10">short-long-desc</span><a - id="dx1-71048"></a>, <span + id="dx1-149049"></a>, <span class="cmss-10">sc-short-long-desc</span><a - id="dx1-71049"></a>, <span + id="dx1-149050"></a>, <span class="cmss-10">sm-short-long-desc</span><a - id="dx1-71050"></a>: - <!--l. 9668--><p class="noindent" >These styles are analogous to the above three styles, but the first use display style - is: - </p><!--l. 9671--><p class="noindent" ><hr><div title="Definition"><span + id="dx1-149051"></a>: + <!--l. 10638--><p class="noindent" >These styles are analogous to the above three styles, but the first use display style is: + </p><!--l. 10641--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\firstacronymfont{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">} (</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">) </span></div><hr> - </p><!--l. 9672--><p class="noindent" > + </p><!--l. 10642--><p class="noindent" > The definitions of <span class="cmtt-10">\acronymsort </span>and <span -class="cmtt-10">\acronymentry </span>are the same as those for - <span +class="cmtt-10">\acronymentry </span>are the same as those for <span class="cmss-10">long-short-desc</span><a - id="dx1-71051"></a> etc. + id="dx1-149052"></a> + etc. </p></li> <li class="itemize"><span class="cmss-10">dua</span><a - id="dx1-71052"></a>, <span + id="dx1-149053"></a>, <span class="cmss-10">dua-desc</span><a - id="dx1-71053"></a>: - - - <!--l. 9678--><p class="noindent" >With these styles, the <a + id="dx1-149054"></a>: + <!--l. 10648--><p class="noindent" >With these styles, the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands always display the long form regardless of - whether the entry has been used or not. However, <span +class="cmtt-10">\gls</span>-like</a> commands always display the long form regardless of whether + the entry has been used or not. However, <span class="cmtt-10">\acrfull</span><a - id="dx1-71054"></a> and <span + id="dx1-149055"></a> and <span class="cmtt-10">\glsentryfull</span><a - id="dx1-71055"></a> will - display ⟨<span -class="cmti-10">long</span>⟩ (<span + id="dx1-149056"></a> will display ⟨<span +class="cmti-10">long</span>⟩ + (<span class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">short</span>⟩<span class="cmtt-10">}</span>). In the case of <span class="cmss-10">dua</span><a - id="dx1-71056"></a>, the <span -class="cmss-10">name</span><a - id="dx1-71057"></a> and <span -class="cmss-10">sort</span><a - id="dx1-71058"></a> keys are set - to the short form and the description is set to the long form. In the case of <span + id="dx1-149057"></a>, the <span +class="cmtt-10">name</span><a + id="dx1-149058"></a> and <span +class="cmtt-10">sort</span><a + id="dx1-149059"></a> keys are set to the short + form and the description is set to the long form. In the case of <span class="cmss-10">dua-desc</span><a - id="dx1-71059"></a>, the + id="dx1-149060"></a>, the <span +class="cmtt-10">name</span><a + id="dx1-149061"></a> and <span +class="cmtt-10">sort</span><a + id="dx1-149062"></a> + keys are set to the long form and the description is supplied in the optional argument of <span -class="cmss-10">name</span><a - id="dx1-71060"></a> and <span -class="cmss-10">sort</span><a - id="dx1-71061"></a> keys are set to the long form and the description is supplied in the - optional argument of <span class="cmtt-10">\newacronym</span><a - id="dx1-71062"></a>. + id="dx1-149063"></a>. + + </p></li> <li class="itemize"><span class="cmss-10">footnote</span><a - id="dx1-71063"></a>, <span + id="dx1-149064"></a>, <span class="cmss-10">footnote-sc</span><a - id="dx1-71064"></a>, <span + id="dx1-149065"></a>, <span class="cmss-10">footnote-sm</span><a - id="dx1-71065"></a>: - <!--l. 9690--><p class="noindent" >With these three styles, on first use the <a + id="dx1-149066"></a>: + <!--l. 10660--><p class="noindent" >With these three styles, on first use the <a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> commands display: - </p><!--l. 9692--><p class="noindent" ><hr><div title="Definition"><span + </p><!--l. 10662--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\firstacronymfont{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">}\footnote</span><a - id="dx1-71066"></a><span + id="dx1-149067"></a><span class="cmtt-10">{</span>⟨<span class="cmitt-10">long</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 9693--><p class="noindent" > + </p><!--l. 10663--><p class="noindent" > However, <span class="cmtt-10">\acrfull</span><a - id="dx1-71067"></a> and <span + id="dx1-149068"></a> and <span class="cmtt-10">\glsentryfull</span><a - id="dx1-71068"></a> are set to <span + id="dx1-149069"></a> are set to <span class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">short</span>⟩<span class="cmtt-10">} </span>(⟨<span -class="cmti-10">long</span>⟩). On - subsequent use the display is: - </p><!--l. 9697--><p class="noindent" ><hr><div title="Definition"><span +class="cmti-10">long</span>⟩). On subsequent use the + display is: + </p><!--l. 10667--><p class="noindent" ><hr><div title="Definition"><span class="cmtt-10">\acronymfont{</span>⟨<span class="cmitt-10">short</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 9698--><p class="noindent" > + </p><!--l. 10668--><p class="noindent" > The <span -class="cmss-10">sort</span><a - id="dx1-71069"></a> and <span -class="cmss-10">name</span><a - id="dx1-71070"></a> keys are set to the short form, and the <span -class="cmss-10">description</span><a - id="dx1-71071"></a> is set to the long +class="cmtt-10">sort</span><a + id="dx1-149070"></a> and <span +class="cmtt-10">name</span><a + id="dx1-149071"></a> keys are set to the short form, and the <span +class="cmtt-10">description</span><a + id="dx1-149072"></a> is set to the long form. - </p><!--l. 9703--><p class="noindent" ><div class="important" title="Important Note"> In order to avoid nested hyperlinks on <a -href="#glo:firstuse">first use</a> the footnote styles automatically - implement <span -class="cmss-10">hyperfirst=false</span><a - id="dx1-71072"></a> for the acronym lists. </div> - </p><!--l. 9707--><p class="noindent" > + </p><!--l. 10673--><p class="noindent" ><div class="important" title="Important Note"> In order to avoid nested hyperlinks on <a +href="#glo:firstuse">first use</a> the footnote styles automatically implement + <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-149073"></a> for the acronym lists. </div> + </p><!--l. 10677--><p class="noindent" > </p></li> <li class="itemize"><span class="cmss-10">footnote-desc</span><a - id="dx1-71073"></a>, <span + id="dx1-149074"></a>, <span class="cmss-10">footnote-sc-desc</span><a - id="dx1-71074"></a>, <span + id="dx1-149075"></a>, <span class="cmss-10">footnote-sm-desc</span><a - id="dx1-71075"></a>: - <!--l. 9712--><p class="noindent" >These three styles are similar to the previous three styles, but the description - has to be supplied in the optional argument of <span + id="dx1-149076"></a>: + <!--l. 10682--><p class="noindent" >These three styles are similar to the previous three styles, but the description has to be supplied in the + optional argument of <span class="cmtt-10">\newacronym</span><a - id="dx1-71076"></a>. The <span -class="cmss-10">name</span><a - id="dx1-71077"></a> key - is set to the long form followed by the short form in parentheses and the - <span -class="cmss-10">sort</span><a - id="dx1-71078"></a> key is set to the long form. This means that the acronyms will be sorted + id="dx1-149077"></a>. The <span +class="cmtt-10">name</span><a + id="dx1-149078"></a> key is set to the long form followed by the short form in + parentheses and the <span +class="cmtt-10">sort</span><a + id="dx1-149079"></a> key is set to the long form. This means that the acronyms will be sorted according to the long form. In addition, since the <span -class="cmss-10">name</span><a - id="dx1-71079"></a> will typically be quite - wide it’s best to choose a glossary style that can accommodate this, such as - <span +class="cmtt-10">name</span><a + id="dx1-149080"></a> will typically be quite wide it’s best to choose a + glossary style that can accommodate this, such as <span class="cmss-10">altlist</span><a - id="dx1-71080"></a>. + id="dx1-149081"></a>. </p> </li></ul> <a - id="x1-71081r22"></a> -<!--l. 9723--><p class="noindent" ><span + id="ex:acrstyle"></a> +<!--l. 10693--><p class="noindent" ><span class="cmbx-12">Example 22</span><span class="cmbx-12"> (Adapting a Predefined Acronym Style)</span><a - id="x1-71082"></a> -</p><!--l. 9724--><p class="indent" > Suppose I want to use the <span + id="x1-149083"></a> +</p><!--l. 10694--><p class="indent" > Suppose I want to use the <span class="cmss-10">footnote-sc-desc</span><a - id="dx1-71083"></a> style, but I want the <span -class="cmss-10">name</span><a - id="dx1-71084"></a> key set to the short -form followed by the long form in parentheses and the <span -class="cmss-10">sort</span><a - id="dx1-71085"></a> key set to the short form. Then I -need to specify the <span + id="dx1-149084"></a> style, but I want the <span +class="cmtt-10">name</span><a + id="dx1-149085"></a> key set to the short form followed by +the long form in parentheses and the <span +class="cmtt-10">sort</span><a + id="dx1-149086"></a> key set to the short form. Then I need to specify the <span class="cmss-10">footnote-sc-desc</span><a - id="dx1-71086"></a> style: - - + id="dx1-149087"></a> +style: + + </p> - <div class="verbatim" id="verbatim-316"> + <div class="verbatim" id="verbatim-314"> \setacronymstyle{footnote-sc-desc} </div> -<!--l. 9730--><p class="nopar" > and then redefine <span +<!--l. 10700--><p class="nopar" > and then redefine <span class="cmtt-10">\acronymsort</span><a - id="dx1-71087"></a> and <span + id="dx1-149088"></a> and <span class="cmtt-10">\acronymentry</span><a - id="dx1-71088"></a>: - - + id="dx1-149089"></a>: + + </p> - <div class="verbatim" id="verbatim-317"> + <div class="verbatim" id="verbatim-315"> \renewcommand*{\acronymsort}[2]{#1}% sort by short form  <br />\renewcommand*{\acronymentry}[1]{%  <br />  \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})}% </div> -<!--l. 9736--><p class="nopar" > (I’ve used <span +<!--l. 10706--><p class="nopar" > (I’ve used <span class="cmtt-10">\space </span>for extra clarity, but you can just use an actual space instead.) -</p><!--l. 9740--><p class="indent" > Since the default Computer Modern fonts don’t support bold smallcaps, I’m also going to -redefine <span +</p><!--l. 10710--><p class="indent" > Note that the default Computer Modern fonts don’t support bold <a +href="#glo:smallcaps">small caps<a + id="dx1-149090"></a></a>, so another font is required. For +example: + + +</p> + <div class="verbatim" id="verbatim-316"> +\usepackage[T1]{fontenc} +</div> +<!--l. 10714--><p class="nopar" > The alternative is to redefine <span class="cmtt-10">\acronymfont</span><a - id="dx1-71089"></a> so that it always switches to medium weight to ensure the smallcaps -setting is used: - - + id="dx1-149091"></a> so that it always switches to medium weight to ensure the <a +href="#glo:smallcaps">small +caps<a + id="dx1-149092"></a></a> setting is used. For example: + + </p> - <div class="verbatim" id="verbatim-318"> + <div class="verbatim" id="verbatim-317"> \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}} </div> -<!--l. 9746--><p class="nopar" > This isn’t necessary if you use a font that supports bold smallcaps. -</p><!--l. 9749--><p class="indent" > The sample file <a -href="#x1-11026r9"><span +<!--l. 10720--><p class="nopar" > +</p><!--l. 10722--><p class="indent" > The sample file <a +href="#ex:sampleFnAcrDesc"><span class="cmtt-10">sampleFnAcrDesc.tex</span></a> illustrates this example. </p> <div class="center" > -<!--l. 9751--><p class="noindent" > -</p><!--l. 9751--><p class="noindent" >____________________________</p></div> -<!--l. 9753--><p class="noindent" > +<!--l. 10724--><p class="noindent" > +</p><!--l. 10724--><p class="noindent" >____________________________</p></div> +<!--l. 10726--><p class="noindent" > </p> -<!--l. 9753--><p class="noindent" ><a +<!--l. 10726--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">13.1.2 </span> <a id="sec:customacronym"></a>Defining A Custom Acronym Style</h4> -<!--l. 9756--><p class="noindent" >You may find that the predefined acronyms styles that come with the <span -class="cmss-10">glossaries</span> -package don’t suit your requirements. In this case you can define your own style -using: -</p><!--l. 9759--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newacronymstyle</span><span -class="cmtt-9"> </span></span><a - id="dx1-72001"></a> <span +<!--l. 10729--><p class="noindent" >You may find that the predefined acronyms styles that come with the <span +class="cmss-10">glossaries </span>package don’t suit your +requirements. In this case you can define your own style using: +</p><!--l. 10732--><p class="indent" > <hr><div title="Definition"><a + id="dx1-150001"></a> <span class="cmtt-10">\newacronymstyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">display</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definitions</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 9761--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 10734--><p class="noindent" > where ⟨<span -class="cmti-10">style name</span>⟩ is the name of the new style (avoid active characters). The second -argument, ⟨<span -class="cmti-10">display</span>⟩, is equivalent to the mandatory argument of <span +class="cmti-10">style name</span>⟩ is the name of the new style (avoid active characters). The second argument, ⟨<span +class="cmti-10">display</span>⟩, is +equivalent to the mandatory argument of <span class="cmtt-10">\defglsentryfmt</span><a - id="dx1-72002"></a>. You can -simply use <span + id="dx1-150002"></a>. You can simply use <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-72003"></a> or you can customize the display using commands like -<span + id="dx1-150003"></a> or you can +customize the display using commands like <span class="cmtt-10">\ifglsused</span><a - id="dx1-72004"></a>, <span + id="dx1-150004"></a>, <span class="cmtt-10">\glsifplural</span><a - id="dx1-72005"></a> and <span + id="dx1-150005"></a> and <span class="cmtt-10">\glscapscase</span><a - id="dx1-72006"></a>. (See <a -href="#sec:glsdisplay"><span -class="tcrm-1000">§</span>6.3 </a><a -href="#sec:glsdisplay">Changing the format -of the link text<!--tex4ht:ref: sec:glsdisplay --></a> for further details.) If the style is likely to be used with a mixed -glossary (that is entries in that glossary are defined both with <span + id="dx1-150006"></a>. (See <a +href="#sec:glsdisplay">§6.3 </a><a +href="#sec:glsdisplay">Changing +the format of the link text<!--tex4ht:ref: sec:glsdisplay --></a> for further details.) If the style is likely to be used with a mixed glossary (that is +entries in that glossary are defined both with <span class="cmtt-10">\newacronym</span><a - id="dx1-72007"></a> and -<span + id="dx1-150007"></a> and <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-72008"></a>) then you can test if the entry is an acronym and use <span + id="dx1-150008"></a>) then you can test if the +entry is an acronym and use <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-72009"></a> if it -is or <span + id="dx1-150009"></a> if it is or <span class="cmtt-10">\glsgenentryfmt</span><a - id="dx1-72010"></a> if it isn’t. For example, the <span + id="dx1-150010"></a> if it isn’t. For example, the <span class="cmss-10">long-short</span><a - id="dx1-72011"></a> style sets ⟨<span -class="cmti-10">display</span>⟩ -as - - + id="dx1-150011"></a> +style sets ⟨<span +class="cmti-10">display</span>⟩ as + + </p> - <div class="verbatim" id="verbatim-319"> + <div class="verbatim" id="verbatim-318"> \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% </div> -<!--l. 9776--><p class="nopar" > (You can use <span +<!--l. 10749--><p class="nopar" > (You can use <span class="cmtt-10">\ifglshasshort</span><a - id="dx1-72012"></a> instead of <span + id="dx1-150012"></a> instead of <span class="cmtt-10">\ifglshaslong</span><a - id="dx1-72013"></a> to test if the entry is an acronym if -you prefer.) -</p><!--l. 9780--><p class="indent" > The third argument, ⟨<span -class="cmti-10">definitions</span>⟩, can be used to redefine the commands that affect the -display style, such as <span + id="dx1-150013"></a> to test if the entry is an acronym if you +prefer.) +</p><!--l. 10753--><p class="indent" > The third argument, ⟨<span +class="cmti-10">definitions</span>⟩, can be used to redefine the commands that affect the display style, such as +<span class="cmtt-10">\acronymfont</span><a - id="dx1-72014"></a> or, if ⟨<span + id="dx1-150014"></a> or, if ⟨<span class="cmti-10">display</span>⟩ uses <span class="cmtt-10">\glsgenacfmt</span>, <span class="cmtt-10">\genacrfullformat</span><a - id="dx1-72015"></a> -and its variants. -</p><!--l. 9785--><p class="indent" > Note that <span + id="dx1-150015"></a> and its variants. +</p><!--l. 10758--><p class="indent" > Note that <span class="cmtt-10">\setacronymstyle</span><a - id="dx1-72016"></a> redefines <span + id="dx1-150016"></a> redefines <span class="cmtt-10">\glsentryfull</span><a - id="dx1-72017"></a> and <span + id="dx1-150017"></a> and <span class="cmtt-10">\acrfullfmt</span><a - id="dx1-72018"></a> to use -<span + id="dx1-150018"></a> to use <span class="cmtt-10">\genacrfullformat</span><a - id="dx1-72019"></a> (and similarly for the plural and upper case variants). If this isn’t -appropriate for the style (as in the case of styles like <span + id="dx1-150019"></a> (and +similarly for the plural and upper case variants). If this isn’t appropriate for the style (as in the +case of styles like <span class="cmss-10">footnote</span><a - id="dx1-72020"></a> and <span + id="dx1-150020"></a> and <span class="cmss-10">dua</span><a - id="dx1-72021"></a>) <span -class="cmtt-10">\newacronymstyle</span> -should redefine these commands within ⟨<span + id="dx1-150021"></a>) <span +class="cmtt-10">\newacronymstyle </span>should redefine these commands within +⟨<span class="cmti-10">definitions</span>⟩. -</p><!--l. 9793--><p class="indent" > Within <span +</p><!--l. 10766--><p class="indent" > Within <span class="cmtt-10">\newacronymstyle</span>’s ⟨<span class="cmti-10">definitions</span>⟩ argument you can also redefine -</p><!--l. 9795--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GenericAcronymFields</span><span -class="cmtt-9"> </span></span><a - id="dx1-72022"></a> <span +</p><!--l. 10768--><p class="indent" > <hr><div title="Definition"><a + id="dx1-150022"></a> <span class="cmtt-10">\GenericAcronymFields </span></div><hr> -</p><!--l. 9797--><p class="noindent" > +</p><!--l. 10770--><p class="noindent" > This is a list of additional fields to be set in <span class="cmtt-10">\newacronym</span><a - id="dx1-72023"></a>. You can use the following token -registers to access the entry label, long form and short form: <span class="reversemarginpar"><span -class="cmtt-9">\glslabeltok</span><span -class="cmtt-9"> </span></span><a - id="dx1-72024"></a><span -class="cmtt-10">\glslabeltok</span>, -<span class="reversemarginpar"><span -class="cmtt-9">\glslongtok</span><span -class="cmtt-9"> </span></span><a - id="dx1-72025"></a><span -class="cmtt-10">\glslongtok </span>and <span class="reversemarginpar"><span -class="cmtt-9">\glsshorttok</span><span -class="cmtt-9"> </span></span><a - id="dx1-72026"></a><span -class="cmtt-10">\glsshorttok</span>. As with all <span class="TEX">T<span -class="E">E</span>X</span> registers, you -can access their values by preceding the register with <span + id="dx1-150023"></a>. You can use the following token registers to access +the entry label, long form and short form: <a + id="dx1-150024"></a><span +class="cmtt-10">\glslabeltok</span>, <a + id="dx1-150025"></a><span +class="cmtt-10">\glslongtok </span>and <a + id="dx1-150026"></a><span +class="cmtt-10">\glsshorttok</span>. As with all +<span class="TEX">T<span +class="E">E</span>X</span> registers, you can access their values by preceding the register with <span class="cmtt-10">\the</span><a - id="dx1-72027"></a>. For example, the <span + id="dx1-150027"></a>. For example, the <span class="cmss-10">long-short</span><a - id="dx1-72028"></a> style + id="dx1-150028"></a> style does: - - + + </p> - <div class="verbatim" id="verbatim-320"> + <div class="verbatim" id="verbatim-319"> \renewcommand*{\GenericAcronymFields}{%  <br />   description={\the\glslongtok}}% </div> -<!--l. 9808--><p class="nopar" > which sets the <span -class="cmss-10">description</span><a - id="dx1-72029"></a> field to the long form of the acronym whereas the <span +<!--l. 10781--><p class="nopar" > which sets the <span +class="cmtt-10">description</span><a + id="dx1-150029"></a> field to the long form of the acronym whereas the <span class="cmss-10">long-short-desc</span><a - id="dx1-72030"></a> -style does: - - + id="dx1-150030"></a> style +does: + + </p> - <div class="verbatim" id="verbatim-321"> + <div class="verbatim" id="verbatim-320"> \renewcommand*{\GenericAcronymFields}{}% </div> -<!--l. 9813--><p class="nopar" > since the description needs to be specified by the user. -</p><!--l. 9816--><p class="indent" > It may be that you want to define a new acronym style that’s based on an existing style. -Within ⟨<span -class="cmti-10">display</span>⟩ you can use -</p><!--l. 9818--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsUseAcrEntryDispStyle</span><span -class="cmtt-9"> </span></span><a - id="dx1-72031"></a> <span +<!--l. 10786--><p class="nopar" > since the description needs to be specified by the user. +</p><!--l. 10789--><p class="indent" > It may be that you want to define a new acronym style that’s based on an existing style. Within ⟨<span +class="cmti-10">display</span>⟩ you +can use +</p><!--l. 10791--><p class="indent" > <hr><div title="Definition"><a + id="dx1-150031"></a> <span class="cmtt-10">\GlsUseAcrEntryDispStyle{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9820--><p class="noindent" > +</p><!--l. 10793--><p class="noindent" > to use the ⟨<span class="cmti-10">display</span>⟩ definition from the style given by ⟨<span class="cmti-10">style name</span>⟩. Within ⟨<span -class="cmti-10">definitions</span>⟩ you can -use -</p><!--l. 9823--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\GlsUseAcrStyleDefs</span><span -class="cmtt-9"> </span></span><a - id="dx1-72032"></a> <span +class="cmti-10">definitions</span>⟩ you can use +</p><!--l. 10796--><p class="indent" > <hr><div title="Definition"><a + id="dx1-150032"></a> <span class="cmtt-10">\GlsUseAcrStyleDefs{</span>⟨<span class="cmitt-10">style name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 9825--><p class="noindent" > +</p><!--l. 10798--><p class="noindent" > to use the ⟨<span class="cmti-10">definitions</span>⟩ from the style given by ⟨<span class="cmti-10">style name</span>⟩. For example, the <span class="cmss-10">long-sc-short</span><a - id="dx1-72033"></a> -acronym style is based on the <span + id="dx1-150033"></a> acronym style is +based on the <span class="cmss-10">long-short</span><a - id="dx1-72034"></a> style with minor modifications (remember to use <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">##</span></span></span> -instead of <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">#</span></span></span> within ⟨<span + id="dx1-150034"></a> style with minor modifications (remember to use <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">##</span></span></span> instead of <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">#</span></span></span> within +⟨<span class="cmti-10">definitions</span>⟩): - - + + </p> - <div class="verbatim" id="verbatim-322"> + <div class="verbatim" id="verbatim-321"> \newacronymstyle{long-sc-short}%  <br />{% use the same display as "long-short"  <br />  \GlsUseAcrEntryDispStyle{long-short}% @@ -20188,18 +22094,16 @@ class="cmti-10">definitions</span>⟩):  <br />  \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}%  <br />} </div> -<!--l. 9842--><p class="nopar" > (<span class="reversemarginpar"><span -class="cmtt-9">\glstextup</span><span -class="cmtt-9"> </span></span><a - id="dx1-72035"></a><span +<!--l. 10815--><p class="nopar" > (<a + id="dx1-150035"></a><span class="cmtt-10">\glstextup </span>is used to cancel the effect of <span class="cmtt-10">\textsc</span><a - id="dx1-72036"></a>. This defaults to <span + id="dx1-150036"></a>. This defaults to <span class="cmtt-10">\textulc</span><a - id="dx1-72037"></a>, -if defined, otherwise <span + id="dx1-150037"></a>, if defined, otherwise <span class="cmtt-10">\textup</span><a - id="dx1-72038"></a>. For example, the plural of <span + id="dx1-150038"></a>. +For example, the plural of <span class="cmcsc-10"><span class="small-caps">s</span><span class="small-caps">v</span><span @@ -20207,32 +22111,30 @@ class="small-caps">m</span> </span>should be rendered as <span class="cmcsc-10"><span class="small-caps">s</span><span class="small-caps">v</span><span -class="small-caps">m</span></span>s -rather than <span +class="small-caps">m</span></span>s rather than <span class="cmcsc-10"><span class="small-caps">s</span><span class="small-caps">v</span><span class="small-caps">m</span><span class="small-caps">s</span></span>.) <a - id="x1-72039r23"></a> -</p><!--l. 9848--><p class="noindent" ><span + id="ex:customacrstyle"></a> +</p><!--l. 10821--><p class="noindent" ><span class="cmbx-12">Example 23</span><span class="cmbx-12"> (Defining a Custom Acronym Style)</span><a - id="x1-72040"></a> -</p><!--l. 9849--><p class="indent" > Suppose I want my acronym on <a -href="#glo:firstuse">first use</a> to have the short form in the text and the long -form with the description in a footnote. Suppose also that I want the short form to be put in -small caps in the main body of the document, but I want it in normal capitals in the list of -acronyms. In my list of acronyms, I want the long form as the name with the short form in -brackets followed by the description. That is, in the text I want <span + id="x1-150040"></a> +</p><!--l. 10822--><p class="indent" > Suppose I want my acronym on <a +href="#glo:firstuse">first use</a> to have the short form in the text and the long form with the +description in a footnote. Suppose also that I want the short form to be put in small caps in the main body of +the document, but I want it in normal capitals in the list of acronyms. In my list of acronyms, I want the long +form as the name with the short form in brackets followed by the description. That is, in the text I want <span class="cmtt-10">\gls</span><a - id="dx1-72041"></a> on <a -href="#glo:firstuse">first use</a> to display: -<spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-150041"></a> +on <a +href="#glo:firstuse">first use</a> to display: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmtt-10">\textsc</span><a - id="dx1-72042"></a><span + id="dx1-150042"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">abbrv</span>⟩<span class="cmtt-10">}\footnote</span><span class="verb"><span @@ -20244,7 +22146,7 @@ class="cmtt-10">}</span></span> on subsequent use: <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmtt-10">\textsc</span><a - id="dx1-72043"></a><span + id="dx1-150043"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">abbrv</span>⟩<span class="cmtt-10">}</span> @@ -20255,37 +22157,36 @@ class="cmti-10">long</span>⟩ (⟨<span class="cmti-10">short</span>⟩) ⟨<span class="cmti-10">description</span>⟩ <br /><spacer type=vertical size=10></span> -</p><!--l. 9870--><p class="indent" > Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second -argument of <span +</p><!--l. 10843--><p class="indent" > Let’s suppose it’s possible that I may have a mixed glossary. I can check this in the second argument of +<span class="cmtt-10">\newacronymstyle</span><a - id="dx1-72044"></a> using: - - + id="dx1-150044"></a> using: + + </p> - <div class="verbatim" id="verbatim-323"> + <div class="verbatim" id="verbatim-322"> \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% </div> -<!--l. 9874--><p class="nopar" > This will use <span +<!--l. 10847--><p class="nopar" > This will use <span class="cmtt-10">\glsgenentryfmt</span><a - id="dx1-72045"></a> if the entry isn’t an acronym, otherwise it will use -<span + id="dx1-150045"></a> if the entry isn’t an acronym, otherwise it will use <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-72046"></a>. The third argument (⟨<span + id="dx1-150046"></a>. The third +argument (⟨<span class="cmti-10">definitions</span>⟩) of <span class="cmtt-10">\newacronymstyle</span><a - id="dx1-72047"></a> needs to redefine -<span + id="dx1-150047"></a> needs to redefine <span class="cmtt-10">\genacrfullformat</span><a - id="dx1-72048"></a> etc so that the <a -href="#glo:firstuse">first use</a> displays the short form in the text with the long -form in a footnote followed by the description. This is done as follows (remember to use <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">##</span></span></span> -instead of <span class="obeylines-h"><span class="verb"><span + id="dx1-150048"></a> etc so that the <a +href="#glo:firstuse">first +use</a> displays the short form in the text with the long form in a footnote followed by the description. This is done +as follows (remember to use <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">##</span></span></span> instead of <span class="obeylines-h"><span class="verb"><span class="cmtt-10">#</span></span></span>): - - + + </p> - <div class="verbatim" id="verbatim-324"> + <div class="verbatim" id="verbatim-323">  % No case change, singular first use:  <br />  \renewcommand*{\genacrfullformat}[2]{%  <br />   \firstacronymfont{\glsentryshort{##1}}##2% @@ -20307,12 +22208,12 @@ class="cmtt-10">#</span></span></span>):  <br />   \footnote{\glsentrylongpl{##1}: \glsentrydesc{##1}}%  <br />  }% </div> -<!--l. 9903--><p class="nopar" > If you think it inappropriate for the short form to be capitalised at the start of a sentence -you can change the above to: - - +<!--l. 10876--><p class="nopar" > If you think it inappropriate for the short form to be capitalised at the start of a sentence you can change the +above to: + + </p> - <div class="verbatim" id="verbatim-325"> + <div class="verbatim" id="verbatim-324">  % No case change, singular first use:  <br />  \renewcommand*{\genacrfullformat}[2]{%  <br />   \firstacronymfont{\glsentryshort{##1}}##2% @@ -20326,34 +22227,33 @@ you can change the above to:  <br /> \let\Genacrfullformat\genacrfullformat  <br /> \let\Genplacrfullformat\genplacrfullformat </div> -<!--l. 9919--><p class="nopar" > Another variation is to use <span +<!--l. 10892--><p class="nopar" > Another variation is to use <span class="cmtt-10">\Glsentrylong</span><a - id="dx1-72049"></a> and <span + id="dx1-150049"></a> and <span class="cmtt-10">\Glsentrylongpl</span><a - id="dx1-72050"></a> in the footnote instead of -<span + id="dx1-150050"></a> in the footnote instead of <span class="cmtt-10">\glsentrylong</span><a - id="dx1-72051"></a> and <span + id="dx1-150051"></a> +and <span class="cmtt-10">\glsentrylongpl</span><a - id="dx1-72052"></a>. -</p><!--l. 9924--><p class="indent" > Now let’s suppose that commands such as <span + id="dx1-150052"></a>. +</p><!--l. 10897--><p class="indent" > Now let’s suppose that commands such as <span class="cmtt-10">\glsentryfull</span><a - id="dx1-72053"></a> and <span + id="dx1-150053"></a> and <span class="cmtt-10">\acrfull</span><a - id="dx1-72054"></a> shouldn’t use -a footnote, but instead use the format: ⟨<span + id="dx1-150054"></a> shouldn’t use a footnote, but +instead use the format: ⟨<span class="cmti-10">long</span>⟩ (⟨<span -class="cmti-10">short</span>⟩). This means that the style -needs to redefine <span +class="cmti-10">short</span>⟩). This means that the style needs to redefine <span class="cmtt-10">\glsentryfull</span>, <span class="cmtt-10">\acrfullfmt</span><a - id="dx1-72055"></a> and their plural and upper case -variants. -</p><!--l. 9931--><p class="indent" > First, the non-linking commands: - - + id="dx1-150055"></a> +and their plural and upper case variants. +</p><!--l. 10904--><p class="indent" > First, the non-linking commands: + + </p> - <div class="verbatim" id="verbatim-326"> + <div class="verbatim" id="verbatim-325">   \renewcommand*{\glsentryfull}[1]{%  <br />    \glsentrylong{##1}\space  <br />      (\acronymfont{\glsentryshort{##1}})% @@ -20371,11 +22271,11 @@ variants.  <br />      (\acronymfont{\glsentryshortpl{##1}})%  <br />  }% </div> -<!--l. 9949--><p class="nopar" > Now for the linking commands: - - +<!--l. 10922--><p class="nopar" > Now for the linking commands: + + </p> - <div class="verbatim" id="verbatim-327"> + <div class="verbatim" id="verbatim-326">   \renewcommand*{\acrfullfmt}[3]{%  <br />    \glslink[##1]{##2}{%  <br />     \glsentrylong{##2}##3\space @@ -20417,103 +22317,100 @@ variants.  <br />    }%  <br />  }% </div> -<!--l. 9992--><p class="nopar" > (This may cause problems with long hyperlinks, in which case adjust the definitions so that, -for example, only the short form is inside the argument of <span +<!--l. 10965--><p class="nopar" > (This may cause problems with long hyperlinks, in which case adjust the definitions so that, for example, only +the short form is inside the argument of <span class="cmtt-10">\glslink</span><a - id="dx1-72056"></a>.) -</p><!--l. 9997--><p class="indent" > The style also needs to redefine <span + id="dx1-150056"></a>.) +</p><!--l. 10970--><p class="indent" > The style also needs to redefine <span class="cmtt-10">\acronymsort</span><a - id="dx1-72057"></a> so that the acronyms are sorted according -to the long form: - - + id="dx1-150057"></a> so that the acronyms are sorted according to the long +form: + + </p> - <div class="verbatim" id="verbatim-328"> + <div class="verbatim" id="verbatim-327">   \renewcommand*{\acronymsort}[2]{##2}% </div> -<!--l. 10001--><p class="nopar" > If you prefer them to be sorted according to the short form you can change the above -to: - - +<!--l. 10974--><p class="nopar" > If you prefer them to be sorted according to the short form you can change the above to: + + </p> - <div class="verbatim" id="verbatim-329"> + <div class="verbatim" id="verbatim-328">   \renewcommand*{\acronymsort}[2]{##1}% </div> -<!--l. 10006--><p class="nopar" > The acronym font needs to be set to <span +<!--l. 10979--><p class="nopar" > The acronym font needs to be set to <span class="cmtt-10">\textsc</span><a - id="dx1-72058"></a> and the plural suffix adjusted so that the “s” -suffix in the plural short form doesn’t get converted to smallcaps: - - + id="dx1-150058"></a> and the plural suffix adjusted so that the “s” suffix in the plural +short form doesn’t get converted to <a +href="#glo:smallcaps">small caps<a + id="dx1-150059"></a></a>: + + </p> - <div class="verbatim" id="verbatim-330"> + <div class="verbatim" id="verbatim-329">   \renewcommand*{\acronymfont}[1]{\textsc{##1}}%  <br />  \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}% </div> -<!--l. 10013--><p class="nopar" > There are a number of ways of dealing with the format in the list of acronyms. The simplest -way is to redefine <span +<!--l. 10986--><p class="nopar" > There are a number of ways of dealing with the format in the list of acronyms. The simplest way is to redefine +<span class="cmtt-10">\acronymentry</span><a - id="dx1-72059"></a> to the long form followed by the upper case short form in -parentheses: - - + id="dx1-150060"></a> to the long form followed by the upper case short form in parentheses: + + </p> - <div class="verbatim" id="verbatim-331"> + <div class="verbatim" id="verbatim-330">  \renewcommand*{\acronymentry}[1]{%  <br />   \Glsentrylong{##1}\space  <br />     (\MakeTextUppercase{\glsentryshort{##1}})}% </div> -<!--l. 10021--><p class="nopar" > (I’ve used <span +<!--l. 10994--><p class="nopar" > (I’ve used <span class="cmtt-10">\Glsentrylong</span><a - id="dx1-72060"></a> instead of <span + id="dx1-150061"></a> instead of <span class="cmtt-10">\glsentrylong</span><a - id="dx1-72061"></a> to capitalise the name in the -glossary.) -</p><!--l. 10025--><p class="indent" > An alternative approach is to set <span + id="dx1-150062"></a> to capitalise the name in the glossary.) +</p><!--l. 10998--><p class="indent" > An alternative approach is to set <span class="cmtt-10">\acronymentry</span><a - id="dx1-72062"></a> to just the long form and redefine -<span + id="dx1-150063"></a> to just the long form and redefine <span class="cmtt-10">\GenericAcronymFields</span><a - id="dx1-72063"></a> to set the <span -class="cmss-10">symbol</span><a - id="dx1-72064"></a> key to the short form and use a glossary style -that displays the symbol in parentheses after the <span -class="cmss-10">name</span><a - id="dx1-72065"></a> (such as the <span + id="dx1-150064"></a> to +set the <span +class="cmtt-10">symbol</span><a + id="dx1-150065"></a> key to the short form and use a glossary style that displays the symbol in parentheses after the +<span +class="cmtt-10">name</span><a + id="dx1-150066"></a> (such as the <span class="cmss-10">tree</span><a - id="dx1-72066"></a> style) like -this: - - + id="dx1-150067"></a> style) like this: + + </p> - <div class="verbatim" id="verbatim-332"> + <div class="verbatim" id="verbatim-331">  \renewcommand*{\acronymentry}[1]{\Glsentrylong{##1}}%  <br /> \renewcommand*{\GenericAcronymFields}{%  <br />    symbol={\protect\MakeTextUppercase{\the\glsshorttok}}}% </div> -<!--l. 10034--><p class="nopar" > I’m going to use the first approach and set <span +<!--l. 11007--><p class="nopar" > I’m going to use the first approach and set <span class="cmtt-10">\GenericAcronymFields</span><a - id="dx1-72067"></a> to do nothing: - - + id="dx1-150068"></a> to do nothing: + + </p> - <div class="verbatim" id="verbatim-333"> + <div class="verbatim" id="verbatim-332">  \renewcommand*{\GenericAcronymFields}{}% </div> -<!--l. 10039--><p class="nopar" > -</p><!--l. 10041--><p class="indent" > Finally, this style needs to switch off hyperlinks on first use to avoid nested -links: - - +<!--l. 11012--><p class="nopar" > +</p><!--l. 11014--><p class="indent" > Finally, this style needs to switch off hyperlinks on first use to avoid nested links: + + </p> - <div class="verbatim" id="verbatim-334"> + <div class="verbatim" id="verbatim-333">  \glshyperfirstfalse </div> -<!--l. 10045--><p class="nopar" > Putting this all together: - - +<!--l. 11018--><p class="nopar" > Putting this all together: + + </p> - <div class="verbatim" id="verbatim-335"> + <div class="verbatim" id="verbatim-334"> \newacronymstyle{custom-fn}% new style name  <br />{%  <br />  \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}% @@ -20560,8 +22457,8 @@ links:  <br />    }%  <br />  }%  <br />  \renewcommand*{\Acrfullfmt}[3]{% - - + +  <br />    \glslink[##1]{##2}{%  <br />     \Glsentrylong{##2}##3\space  <br />      (\acronymfont{\glsentryshort{##2}})% @@ -20603,29 +22500,29 @@ links:  <br />     (\MakeTextUppercase{\glsentryshort{##1}})}%  <br />} </div> -<!--l. 10134--><p class="nopar" > -</p><!--l. 10136--><p class="indent" > Now I need to specify that I want to use this new style: - - +<!--l. 11107--><p class="nopar" > +</p><!--l. 11109--><p class="indent" > Now I need to specify that I want to use this new style: + + </p> - <div class="verbatim" id="verbatim-336"> + <div class="verbatim" id="verbatim-335"> \setacronymstyle{custom-fn} </div> -<!--l. 10139--><p class="nopar" > I also need to use a glossary style that suits this acronym style, for example <span +<!--l. 11112--><p class="nopar" > I also need to use a glossary style that suits this acronym style, for example <span class="cmss-10">altlist</span><a - id="dx1-72068"></a>: - - + id="dx1-150069"></a>: + + </p> - <div class="verbatim" id="verbatim-337"> + <div class="verbatim" id="verbatim-336"> \setglossarystyle{altlist} </div> -<!--l. 10144--><p class="nopar" > -</p><!--l. 10146--><p class="indent" > Once the acronym style has been set, I can define my acronyms: - - +<!--l. 11117--><p class="nopar" > +</p><!--l. 11119--><p class="indent" > Once the acronym style has been set, I can define my acronyms: + + </p> - <div class="verbatim" id="verbatim-338"> + <div class="verbatim" id="verbatim-337"> \newacronym[description={set of tags for use in  <br />developing hypertext documents}]{html}{html}{Hyper  <br />Text Markup Language} @@ -20633,97 +22530,95 @@ class="cmss-10">altlist</span><a  <br />layout of a document written in a markup language}]{css}  <br />{css}{Cascading Style Sheet} </div> -<!--l. 10155--><p class="nopar" > -</p><!--l. 10157--><p class="indent" > The sample file <a -href="#x1-11029r11"><span +<!--l. 11128--><p class="nopar" > +</p><!--l. 11130--><p class="indent" > The sample file <a +href="#ex:sample-custom-acronym"><span class="cmtt-10">sample-custom-acronym.tex</span></a> illustrates this example. </p> <div class="center" > -<!--l. 10159--><p class="noindent" > -</p><!--l. 10159--><p class="noindent" >____________________________</p></div> +<!--l. 11132--><p class="noindent" > +</p><!--l. 11132--><p class="noindent" >____________________________</p></div> <a - id="x1-72069r24"></a> -<!--l. 10161--><p class="noindent" ><span + id="ex:font-abbr"></a> +<!--l. 11134--><p class="noindent" ><span class="cmbx-12">Example 24</span><span class="cmbx-12"> (Italic and Upright Abbreviations)</span><a - id="x1-72070"></a> -</p><!--l. 10162--><p class="indent" > Suppose I want to have some abbreviations in italic and some that just use the -surrounding font. Hard-coding this into the ⟨<span + id="x1-150071"></a> +</p><!--l. 11135--><p class="indent" > Suppose I want to have some abbreviations in italic and some that just use the surrounding font. +Hard-coding this into the ⟨<span class="cmti-10">short</span>⟩ argument of <span -class="cmtt-10">\newacronym </span>can cause -complications. -</p><!--l. 10166--><p class="indent" > This example uses <span +class="cmtt-10">\newacronym </span>can cause complications. +</p><!--l. 11139--><p class="indent" > This example uses <span class="cmtt-10">\glsaddstoragekey</span><a - id="dx1-72071"></a> to add an extra field that can be used to store the -formatting declaration (such as <span + id="dx1-150072"></a> to add an extra field that can be used to store the formatting +declaration (such as <span class="cmtt-10">\em</span>). - - + + </p> - <div class="verbatim" id="verbatim-339"> + <div class="verbatim" id="verbatim-338"> \glsaddstoragekey{font}{}{\entryfont} </div> -<!--l. 10170--><p class="nopar" > This defines a new field/key called <span -class="cmtt-10">font</span>, which defaults to nothing if it’s not explicitly set. -This also defines a command called <span +<!--l. 11143--><p class="nopar" > This defines a new field/key called <span +class="cmtt-10">font</span>, which defaults to nothing if it’s not explicitly set. This also defines a +command called <span class="cmtt-10">\entryfont </span>that’s analogous to <span -class="cmtt-10">\glsentrytext</span>. A new -style is then created to format abbreviations that access this field. -</p><!--l. 10176--><p class="indent" > There are two ways to do this. The first is to create a style that doesn’t use <span +class="cmtt-10">\glsentrytext</span>. A new style is then created to format +abbreviations that access this field. +</p><!--l. 11149--><p class="indent" > There are two ways to do this. The first is to create a style that doesn’t use <span class="cmtt-10">\glsgenacfmt</span><a - id="dx1-72072"></a> + id="dx1-150073"></a> but instead provides a modified version that doesn’t use <span class="cmtt-10">\acronymfont{</span>⟨<span class="cmti-10">short</span>⟩<span -class="cmtt-10">} </span>but instead -uses <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">} </span>but instead uses +<span class="obeylines-h"><span class="verb"><span class="cmtt-10">{</span></span></span><span class="cmtt-10">\entryfont</span><span class="obeylines-h"><span class="verb"><span class="cmtt-10">{\glslabel}</span></span></span>⟨<span class="cmti-10">short</span>⟩<span class="obeylines-h"><span class="verb"><span -class="cmtt-10">}</span></span></span>. The full format given by commands such as -<span -class="cmtt-10">\genacrfullformat </span>need to be similarly adjusted. For example: - - +class="cmtt-10">}</span></span></span>. The full format given by commands such as <span +class="cmtt-10">\genacrfullformat </span>need to be +similarly adjusted. For example: + + </p> - <div class="verbatim" id="verbatim-340"> + <div class="verbatim" id="verbatim-339">   \renewcommand*{\genacrfullformat}[2]{%  <br />   \glsentrylong{##1}##2\space  <br />   ({\entryfont{##1}\glsentryshort{##1}})%  <br />  }% </div> -<!--l. 10188--><p class="nopar" > This will deal with commands like <span +<!--l. 11161--><p class="nopar" > This will deal with commands like <span class="cmtt-10">\gls</span><a - id="dx1-72073"></a> but not commands like <span + id="dx1-150074"></a> but not commands like <span class="cmtt-10">\acrshort</span><a - id="dx1-72074"></a> which still use -<span + id="dx1-150075"></a> which still use <span class="cmtt-10">\acronymfont</span><a - id="dx1-72075"></a>. Another approach is to redefine <span -class="cmtt-10">\acronymfont </span>to look up the required font -declaration. Since <span -class="cmtt-10">\acronymfont </span>doesn’t take the entry label as an argument, the following -will only work if <span -class="cmtt-10">\acronymfont </span>is used in a context where the label is provided by -<span + id="dx1-150076"></a>. +Another approach is to redefine <span +class="cmtt-10">\acronymfont </span>to look up the required font declaration. Since <span +class="cmtt-10">\acronymfont</span> +doesn’t take the entry label as an argument, the following will only work if <span +class="cmtt-10">\acronymfont </span>is used in a context +where the label is provided by <span class="cmtt-10">\glslabel</span><a - id="dx1-72076"></a>. This is true in <span + id="dx1-150077"></a>. This is true in <span class="cmtt-10">\gls</span>, <span class="cmtt-10">\acrshort </span>and <span class="cmtt-10">\acrfull</span>. The redefinition is now: - - + + </p> - <div class="verbatim" id="verbatim-341"> + <div class="verbatim" id="verbatim-340"> \renewcommand*{\acronymfont}[1]{{\entryfont{\glslabel}#1}}% </div> -<!--l. 10199--><p class="nopar" > So the new style can be defined as: - - +<!--l. 11172--><p class="nopar" > So the new style can be defined as: + + </p> - <div class="verbatim" id="verbatim-342"> + <div class="verbatim" id="verbatim-341"> \newacronymstyle{long-font-short}  <br />{%  <br />  \GlsUseAcrEntryDispStyle{long-short}% @@ -20750,175 +22645,168 @@ now:  <br />  \renewcommand*{\acronymentry}[1]{{\entryfont{##1}\glsentryshort{##1}}}%  <br />} </div> -<!--l. 10227--><p class="nopar" > Remember the style needs to be set before defining the entries: - - +<!--l. 11200--><p class="nopar" > Remember the style needs to be set before defining the entries: + + </p> - <div class="verbatim" id="verbatim-343"> + <div class="verbatim" id="verbatim-342"> \setacronymstyle{long-font-short} </div> -<!--l. 10231--><p class="nopar" > -</p><!--l. 10233--><p class="indent" > The complete document is contained in the sample file <a -href="#x1-11107r33"><span -class="cmtt-10">sample-font-abbr.tex</span></a>. -</p> +<!--l. 11204--><p class="nopar" > +</p><!--l. 11206--><p class="indent" > The complete document is contained in the sample file <a +href="#ex:sample-font-abbr"><span +class="cmtt-10">sample-font-abbr.tex</span></a>. </p> <div class="center" > -<!--l. 10235--><p class="noindent" > -</p><!--l. 10235--><p class="noindent" >____________________________</p></div> -<!--l. 10237--><p class="indent" > Some writers and publishing houses have started to drop full stops (periods) from upper -case initials but may still retain them for lower case abbreviations, while others -may still use them for both upper and lower case. This can cause complications. -Chapter 12 of <span +<!--l. 11208--><p class="noindent" > +</p><!--l. 11208--><p class="noindent" >____________________________</p></div> +<!--l. 11210--><p class="indent" > Some writers and publishing houses have started to drop full stops (periods) from upper case initials but +may still retain them for lower case abbreviations, while others may still use them for both upper and lower +case. This can cause complications. Chapter 12 of <span class="cmti-10">The </span><span class="TEX"><span class="cmti-10">T</span><span class="E"><span class="cmti-10">E</span></span><span class="cmti-10">X</span></span><span -class="cmti-10">book </span>discusses the spacing between words but, briefly, the default -behaviour of <span class="TEX">T<span -class="E">E</span>X</span> is to assume that an upper case character followed by a full stop -and space is an abbreviation, so the space is the default inter-word space whereas -a lower case character followed by a full stop and space is a word occurring at the -end of a sentence. In the event that this isn’t true, you need to make a manual -adjustment using <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">␣</span></span></span> (back slash space) in place of just a space character for an -inter-word mid-sentence space and use <span class="obeylines-h"><span class="verb"><span +class="cmti-10">book </span>discusses the spacing between words but, +briefly, the default behaviour of <span class="TEX">T<span +class="E">E</span>X</span> is to assume that an upper case character followed by a full stop and +space is an abbreviation, so the space is the default inter-word space whereas a lower case character followed by +a full stop and space is a word occurring at the end of a sentence. In the event that this isn’t true, you +need to make a manual adjustment using <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">␣</span></span></span> (back slash space) in place of just a space character +for an inter-word mid-sentence space and use <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@</span></span></span> before the full stop to indicate the end of the sentence. -</p><!--l. 10252--><p class="indent" > For example: - - +</p><!--l. 11225--><p class="indent" > For example: + + </p> - <div class="verbatim" id="verbatim-344"> + <div class="verbatim" id="verbatim-343"> I was awarded a B.Sc. and a Ph.D. (From the same place.) </div> -<!--l. 10255--><p class="nopar" > is typeset as <spacer type=vertical size=10><span class="obeylines-h"> +<!--l. 11228--><p class="nopar" > is typeset as <spacer type=vertical size=10><span class="obeylines-h"> <br />I was awarded a B.Sc. and a Ph.D. (From the same place.) <br /><spacer type=vertical size=10></span> The spacing is more noticeable with the typewriter font: - - + + </p> - <div class="verbatim" id="verbatim-345"> + <div class="verbatim" id="verbatim-344"> \ttfamily  <br />I was awarded a B.Sc. and a Ph.D. (From the same place.) </div> -<!--l. 10264--><p class="nopar" > is typeset as <spacer type=vertical size=10><span class="obeylines-h"> +<!--l. 11237--><p class="nopar" > is typeset as <spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmtt-10">I was awarded a B.Sc. and a Ph.D. (From the same place.)</span> <br /><spacer type=vertical size=10></span> The lower case letter at the end of “B.Sc.” is confusing <span class="TEX">T<span -class="E">E</span>X</span> into thinking that the full stop -after it marks the end of the sentence. Whereas the upper case letter at the end of “Ph.D.” -has confused <span class="TEX">T<span -class="E">E</span>X</span> into thinking that the following full stop is just part of the abbreviation. -These can be corrected: - - +class="E">E</span>X</span> into thinking that the full stop after it marks the +end of the sentence. Whereas the upper case letter at the end of “Ph.D.” has confused <span class="TEX">T<span +class="E">E</span>X</span> into thinking that +the following full stop is just part of the abbreviation. These can be corrected: + + </p> - <div class="verbatim" id="verbatim-346"> + <div class="verbatim" id="verbatim-345"> I was awarded a B.Sc.\ and a Ph.D\@. (From the same place.) </div> -<!--l. 10276--><p class="nopar" > -</p><!--l. 10278--><p class="indent" > This situation is a bit problematic for <span -class="cmss-10">glossaries</span>. The full stops can form part of -the ⟨<span -class="cmti-10">short</span>⟩ argument of <span +<!--l. 11249--><p class="nopar" > +</p><!--l. 11251--><p class="indent" > This situation is a bit problematic for <span +class="cmss-10">glossaries</span>. The full stops can form part of the ⟨<span +class="cmti-10">short</span>⟩ argument of +<span class="cmtt-10">\newacronym </span>and the <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">B.Sc.\␣</span></span></span> part can be dealt with by -remembering to add <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\␣</span></span></span> (for example, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{bsc}\␣</span></span></span>) but the end of sentence case is -more troublesome as you need to omit the sentence terminating full stop (to avoid -two dots) which can make the source code look a little strange but you also need -to adjust the space factor, which is usually done by inserting <span +class="cmtt-10">B.Sc.\␣</span></span></span> part can be dealt with by remembering to add <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\␣</span></span></span> (for example, +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{bsc}\␣</span></span></span>) but the end of sentence case is more troublesome as you need to omit the sentence +terminating full stop (to avoid two dots) which can make the source code look a little strange +but you also need to adjust the space factor, which is usually done by inserting <span class="cmtt-10">\@ </span>before the full stop. -</p><!--l. 10288--><p class="indent" > The next example shows one way of achieving this. (Note that the supplemental -<a +</p><!--l. 11261--><p class="indent" > The next example shows one way of achieving this. (Note that the supplemental <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package provides a much simpler way of doing this, which you may prefer to -use. See the <a -href="http://www.dickimaw-books.com/gallery/sample-initialisms.shtml" >initialisms example</a>.) +class="cmss-10">glossaries-extra</span></a> +package provides a much simpler way of doing this, which you may prefer to use. See the <a +href="https://www.dickimaw-books.com/gallery/sample-initialisms.shtml" >initialisms +example</a>.) <a - id="x1-72077r25"></a> -</p><!--l. 10294--><p class="noindent" ><span + id="ex:dotabbr"></a> +</p><!--l. 11266--><p class="noindent" ><span class="cmbx-12">Example 25</span><span class="cmbx-12"> (Abbreviations with Full Stops (Periods))</span><a - id="x1-72078"></a> -</p><!--l. 10295--><p class="indent" > As from version 4.16, there’s now a hook (<span + id="x1-150079"></a> +</p><!--l. 11267--><p class="indent" > As from version 4.16, there’s now a hook (<span class="cmtt-10">\glspostlinkhook</span><a - id="dx1-72079"></a>) that’s called at the very -end of the <a + id="dx1-150080"></a>) that’s called at the very end of the +<a href="#sec:gls-like"><span class="cmtt-10">\gls</span>-like</a> and <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands. This can be redefined to check if the -following character is a full stop. The <span +class="cmtt-10">\glstext</span>-like</a> commands. This can be redefined to check if the following character is a full stop. +The <span class="cmss-10">amsgen</span><a - id="dx1-72080"></a> package (which is automatically loaded by + id="dx1-150081"></a> package (which is automatically loaded by <span +class="cmss-10">glossaries</span>) provides an internal command called <span -class="cmss-10">glossaries</span>) provides an internal command called <span -class="cmtt-10">\new@ifnextchar </span>that can be used to -determine if the given character appears next. (For more information see the <span +class="cmtt-10">\new@ifnextchar </span>that can be used to determine if the given character appears next. (For more information see +the <span class="cmss-10">amsgen</span><a - id="dx1-72081"></a> -documentation.) -</p><!--l. 10304--><p class="indent" > It’s possible that I may also want acronyms or contractions in my document, so I need -some way to differentiate between them. Here I’m going to use the same method as in -example <a -href="#x1-39002r4">4<!--tex4ht:ref: ex:addstoragekey --></a> where a new field is defined to indicate the type of abbreviation: - - + id="dx1-150082"></a> documentation.) +</p><!--l. 11276--><p class="indent" > It’s possible that I may also want acronyms or contractions in my document, so I need some way to +differentiate between them. Here I’m going to use the same method as in example <a +href="#ex:addstoragekey">4<!--tex4ht:ref: ex:addstoragekey --></a> where a new field is defined +to indicate the type of abbreviation: + + </p> - <div class="verbatim" id="verbatim-347"> + <div class="verbatim" id="verbatim-346"> \glsaddstoragekey{abbrtype}{word}{\abbrtype}  <br />\newcommand*{\newabbr}[1][]{\newacronym[abbrtype=initials,#1]} </div> -<!--l. 10313--><p class="nopar" > Now I just use <span +<!--l. 11285--><p class="nopar" > Now I just use <span class="cmtt-10">\newacronym</span><a - id="dx1-72082"></a> for the acronyms, for example, - - + id="dx1-150083"></a> for the acronyms, for example, + + </p> - <div class="verbatim" id="verbatim-348"> + <div class="verbatim" id="verbatim-347"> \newacronym{laser}{laser}{light amplification by stimulated  <br />emission of radiation} </div> -<!--l. 10318--><p class="nopar" > and my new command <span +<!--l. 11290--><p class="nopar" > and my new command <span class="cmtt-10">\newabbr </span>for initials, for example, - - + + </p> - <div class="verbatim" id="verbatim-349"> + <div class="verbatim" id="verbatim-348"> \newabbr{eg}{e.g.}{exempli gratia}  <br />\newabbr{ie}{i.e.}{id est}  <br />\newabbr{bsc}{B.Sc.}{Bachelor of Science}  <br />\newabbr{ba}{B.A.}{Bachelor of Arts}  <br />\newabbr{agm}{A.G.M.}{annual general meeting} </div> -<!--l. 10326--><p class="nopar" > Within <span +<!--l. 11298--><p class="nopar" > Within <span class="cmtt-10">\glspostlinkhook </span>the entry’s label can be accessed using <span class="cmtt-10">\glslabel</span><a - id="dx1-72083"></a> and -<span + id="dx1-150084"></a> and <span class="cmtt-10">\ifglsfieldeq</span><a - id="dx1-72084"></a> can be used to determine if the current entry has the new <span -class="cmtt-10">abbrtype </span>field set -to “initials”. If it doesn’t, then nothing needs to happen, but if it does, a check is performed -to see if the next character is a full stop. If it is, this signals the end of a sentence otherwise -it’s mid-sentence. -</p><!--l. 10335--><p class="indent" > Remember that internal commands within the document file (rather than in a class or -package) need to be placed between <span + id="dx1-150085"></a> can be used +to determine if the current entry has the new <span +class="cmtt-10">abbrtype </span>field set to “initials”. If it doesn’t, then nothing needs to +happen, but if it does, a check is performed to see if the next character is a full stop. If it is, this signals the +end of a sentence otherwise it’s mid-sentence. +</p><!--l. 11307--><p class="indent" > Remember that internal commands within the document file (rather than in a class or package) need to be +placed between <span class="cmtt-10">\makeatletter</span><a - id="dx1-72085"></a> and <span + id="dx1-150086"></a> and <span class="cmtt-10">\makeatother</span><a - id="dx1-72086"></a>: - - + id="dx1-150087"></a>: + + </p> - <div class="verbatim" id="verbatim-350"> + <div class="verbatim" id="verbatim-349"> \makeatletter  <br />\renewcommand{\glspostlinkhook}{%  <br /> \ifglsfieldeq{\glslabel}{abbrtype}{initials}% @@ -20927,68 +22815,63 @@ class="cmtt-10">\makeatother</span><a  <br />}  <br />\makeatother </div> -<!--l. 10346--><p class="nopar" > In the event that a full stop is found <span -class="cmtt-10">\doendsentence </span>is performed but it will be followed by -the full stop, which needs to be discarded. Otherwise <span -class="cmtt-10">\doendword </span>will be done but it won’t be -followed by a full stop so there’s nothing to discard. The definitions for these commands -are: - - +<!--l. 11318--><p class="nopar" > In the event that a full stop is found <span +class="cmtt-10">\doendsentence </span>is performed but it will be followed by the full stop, +which needs to be discarded. Otherwise <span +class="cmtt-10">\doendword </span>will be done but it won’t be followed by a full stop so +there’s nothing to discard. The definitions for these commands are: + + </p> - <div class="verbatim" id="verbatim-351"> + <div class="verbatim" id="verbatim-350"> \newcommand{\doendsentence}[1]{\spacefactor=10000{}}  <br />\newcommand{\doendword}{\spacefactor=1000{}} </div> -<!--l. 10355--><p class="nopar" > Now, I can just do <span class="obeylines-h"><span class="verb"><span +<!--l. 11327--><p class="nopar" > Now, I can just do <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{bsc}</span></span></span> mid-sentence and <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{phd}.</span></span></span> at the end of the -sentence. The terminating full stop will be discarded in the latter case, but it won’t be -discarded in, say, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{laser}.</span></span></span> as that doesn’t have the <span -class="cmtt-10">abbrtype </span>field set to -“initials”. -</p><!--l. 10362--><p class="indent" > This also works on first use when the style is set to one of the ⟨<span +class="cmtt-10">\gls{phd}.</span></span></span> at the end of the sentence. The terminating full +stop will be discarded in the latter case, but it won’t be discarded in, say, <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{laser}.</span></span></span> as that doesn’t have +the <span +class="cmtt-10">abbrtype </span>field set to “initials”. +</p><!--l. 11334--><p class="indent" > This also works on first use when the style is set to one of the ⟨<span class="cmti-10">long</span>⟩ (⟨<span -class="cmti-10">short</span>⟩) styles but it -will fail with the ⟨<span +class="cmti-10">short</span>⟩) styles but it will fail with the +⟨<span class="cmti-10">short</span>⟩ (⟨<span -class="cmti-10">long</span>⟩) styles as in this case the terminating full stop shouldn’t be -discarded. Since <span +class="cmti-10">long</span>⟩) styles as in this case the terminating full stop shouldn’t be discarded. Since <span class="cmtt-10">\glspostlinkhook</span><a - id="dx1-72087"></a> is used after the <a -href="#glo:firstuseflag">first use flag</a> has been unset for the -entry, this can’t be fixed by simply checking with <span + id="dx1-150088"></a> is +used after the <a +href="#glo:firstuseflag">first use flag</a> has been unset for the entry, this can’t be fixed by simply checking with +<span class="cmtt-10">\ifglsused</span><a - id="dx1-72088"></a>. One possible solution to this is -to redefine <span + id="dx1-150089"></a>. One possible solution to this is to redefine <span class="cmtt-10">\glslinkpostsetkeys</span><a - id="dx1-72089"></a> to check for the <a -href="#glo:firstuseflag">first use flag</a> and define a macro that can -then be used in <span + id="dx1-150090"></a> to check for the <a +href="#glo:firstuseflag">first use +flag</a> and define a macro that can then be used in <span class="cmtt-10">\glspostlinkhook</span><a - id="dx1-72090"></a>. -</p><!--l. 10372--><p class="indent" > The other thing to consider is what to do with plurals. One possibility is to check for -plural use within <span + id="dx1-150091"></a>. +</p><!--l. 11344--><p class="indent" > The other thing to consider is what to do with plurals. One possibility is to check for plural use +within <span class="cmtt-10">\doendsentence </span>(using <span class="cmtt-10">\glsifplural</span><a - id="dx1-72091"></a>) and put the full stop back if the -plural has been used. -</p><!--l. 10377--><p class="indent" > The complete document is contained in the sample file <a -href="#x1-11031r13"><span -class="cmtt-10">sample-dot-abbr.tex</span></a>. -</p> + id="dx1-150092"></a>) and put the full stop back if the plural has been +used. +</p><!--l. 11349--><p class="indent" > The complete document is contained in the sample file <a +href="#ex:sample-dot-abbr"><span +class="cmtt-10">sample-dot-abbr.tex</span></a>. </p> <div class="center" > -<!--l. 10379--><p class="noindent" > -</p><!--l. 10379--><p class="noindent" >____________________________</p></div> -<!--l. 10381--><p class="noindent" > +<!--l. 11351--><p class="noindent" > +</p><!--l. 11351--><p class="noindent" >____________________________</p></div> +<!--l. 11353--><p class="noindent" > </p> -<!--l. 10381--><p class="noindent" ><a +<!--l. 11353--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">13.2 </span> <a id="sec:disploa"></a>Displaying the List of Acronyms</h3> -<!--l. 10384--><p class="noindent" >The list of acronyms is just like any other type of glossary and can be displayed on its own -using: +<!--l. 11356--><p class="noindent" >The list of acronyms is just like any other type of glossary and can be displayed on its own using: </p><dl class="description"><dt class="description"> <a href="#option1"><span @@ -21000,14 +22883,12 @@ class="description"> <div class="obeylines-v"> <span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-73001"></a><span + id="dx1-151001"></a><span class="cmtt-10">[type=\acronymtype</span><a - id="dx1-73002"></a><span + id="dx1-151002"></a><span class="cmtt-10">]</span> </div> </div> - - </dd><dt class="description"> <span class="cmbx-10">Options</span><span @@ -21021,22 +22902,24 @@ class="cmbx-10">3</span></a><span class="cmbx-10">:</span> </dt><dd class="description"> <div class="alltt"> + + <div class="obeylines-v"> <span class="cmtt-10">\printglossary</span><a - id="dx1-73003"></a><span + id="dx1-151003"></a><span class="cmtt-10">[type=\acronymtype</span><a - id="dx1-73004"></a><span + id="dx1-151004"></a><span class="cmtt-10">]</span> </div> </div> - <!--l. 10397--><p class="noindent" >(If you use the <span + <!--l. 11369--><p class="noindent" >(If you use the <span class="cmss-10">acronym</span><a - id="dx1-73005"></a> package option you can also use </p><div class="alltt"> + id="dx1-151005"></a> package option you can also use </p><div class="alltt"> <div class="obeylines-v"> <span class="cmtt-10">\printacronyms</span><a - id="dx1-73006"></a><span + id="dx1-151006"></a><span class="cmtt-10">[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]</span> @@ -21045,19 +22928,18 @@ class="cmtt-10">]</span> <div class="obeylines-v"> <span class="cmtt-10">\printglossary</span><a - id="dx1-73007"></a><span + id="dx1-151007"></a><span class="cmtt-10">[type=\acronymtype</span><a - id="dx1-73008"></a><span + id="dx1-151008"></a><span class="cmtt-10">,</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]</span> </div> </div> See <a -href="#sec:pkgopts-acronym"><span -class="tcrm-1000">§</span>2.5 </a><a -href="#sec:pkgopts-acronym">Acronym Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>.) +href="#sec:pkgopts-acronym">§2.7 </a><a +href="#sec:pkgopts-acronym">Acronym and Abbreviation Options<!--tex4ht:ref: sec:pkgopts-acronym --></a>.) </dd></dl> -<!--l. 10409--><p class="noindent" >Alternatively the list of acronyms can be displayed with all the other glossaries using: +<!--l. 11381--><p class="noindent" >Alternatively the list of acronyms can be displayed with all the other glossaries using: </p><dl class="description"><dt class="description"> <a href="#option1"><span @@ -21066,7 +22948,7 @@ class="cmbx-10"> 1</span></a><span class="cmbx-10">:</span> </dt><dd class="description"><span class="cmtt-10">\printnoidxglossaries</span><a - id="dx1-73009"></a> + id="dx1-151009"></a> </dd><dt class="description"> <span class="cmbx-10">Options</span><span @@ -21080,42 +22962,36 @@ class="cmbx-10">3</span></a><span class="cmbx-10">:</span> </dt><dd class="description"><span class="cmtt-10">\printglossaries</span><a - id="dx1-73010"></a></dd></dl> -<!--l. 10417--><p class="indent" > However, care must be taken to choose a glossary style that’s appropriate to your acronym -style. Alternatively, you can define your own custom style (see <a -href="#sec:newglossarystyle"><span -class="tcrm-1000">§</span>15.2 </a><a -href="#sec:newglossarystyle">Defining your own -glossary style<!--tex4ht:ref: sec:newglossarystyle --></a> for further details). -</p><!--l. 10422--><p class="noindent" > + id="dx1-151010"></a></dd></dl> +<!--l. 11389--><p class="indent" > However, care must be taken to choose a glossary style that’s appropriate to your acronym style. +Alternatively, you can define your own custom style (see <a +href="#sec:newglossarystyle">§15.2 </a><a +href="#sec:newglossarystyle">Defining your own glossary style<!--tex4ht:ref: sec:newglossarystyle --></a> for further +details). +</p><!--l. 11394--><p class="noindent" > </p> -<!--l. 10422--><p class="noindent" ><a +<!--l. 11394--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">13.3 </span> <a id="sec:oldacronym"></a>Upgrading From the glossary Package</h3> -<!--l. 10425--><p class="noindent" >Users of the obsolete <span +<!--l. 11397--><p class="noindent" >Users of the obsolete <span class="cmss-10">glossary</span><a - id="dx1-74001"></a> package may recall that the syntax used to define new -acronyms has changed with the replacement <span -class="cmss-10">glossaries </span>package. In addition, the -old <span + id="dx1-152001"></a> package may recall that the syntax used to define new acronyms has changed with +the replacement <span +class="cmss-10">glossaries </span>package. In addition, the old <span class="cmss-10">glossary</span><a - id="dx1-74002"></a> package created the command <span + id="dx1-152002"></a> package created the command <span class="cmtt-10">\</span>⟨<span -class="cmti-10">acr-name</span>⟩ when defining the acronym -⟨<span +class="cmti-10">acr-name</span>⟩ when +defining the acronym ⟨<span class="cmti-10">acr-name</span>⟩. - - -</p><!--l. 10431--><p class="indent" > In order to facilitate migrating from the old package to the new one, the <span +</p><!--l. 11403--><p class="indent" > In order to facilitate migrating from the old package to the new one, the <span class="cmss-10">glossaries</span> package<span class="footnote-mark"><a href="#fn1x13" id="fn1x13-bk"><sup class="textsuperscript">13.1</sup></a></span><a - id="x1-74003f1"></a> + id="x1-152003f1"></a> provides the command: -</p><!--l. 10434--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\oldacronym</span><span -class="cmtt-9"> </span></span><a - id="dx1-74004"></a> <span +</p><!--l. 11406--><p class="indent" > <hr><div title="Definition"><a + id="dx1-152004"></a> <span class="cmtt-10">\oldacronym[</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21125,14 +23001,16 @@ class="cmitt-10">long</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">key-val list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10436--><p class="noindent" > + + +</p><!--l. 11408--><p class="noindent" > This uses the same syntax as the <span class="cmss-10">glossary</span><a - id="dx1-74005"></a> package’s method of defining acronyms. It is -equivalent to: <spacer type=vertical size=10><span class="obeylines-h"> + id="dx1-152005"></a> package’s method of defining acronyms. It is equivalent to: +<spacer type=vertical size=10><span class="obeylines-h"> <br /><span class="cmtt-10">\newacronym</span><a - id="dx1-74006"></a><span + id="dx1-152006"></a><span class="cmtt-10">[</span>⟨<span class="cmti-10">key-val list</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21145,112 +23023,110 @@ class="cmtt-10">}</span> <br /><spacer type=vertical size=10></span> In addition, <span class="cmtt-10">\oldacronym</span><a - id="dx1-74007"></a> also defines the commands <span + id="dx1-152007"></a> also defines the commands <span class="cmtt-10">\</span>⟨<span class="cmti-10">label</span>⟩, which is equivalent to <span class="cmtt-10">\gls</span><a - id="dx1-74008"></a> -<span + id="dx1-152008"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>, and <span class="cmtt-10">\</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">*</span>, which is equivalent to <span +class="cmtt-10">*</span>, +which is equivalent to <span class="cmtt-10">\Gls</span><a - id="dx1-74009"></a><span + id="dx1-152009"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>. If ⟨<span class="cmti-10">label</span>⟩ is omitted, ⟨<span -class="cmti-10">abbrv</span>⟩ is used. -Since commands names must consist only of alphabetical characters, ⟨<span -class="cmti-10">label</span>⟩ must also only -consist of alphabetical characters. Note that <span +class="cmti-10">abbrv</span>⟩ is used. Since commands names must consist only +of alphabetical characters, ⟨<span +class="cmti-10">label</span>⟩ must also only consist of alphabetical characters. Note that <span class="cmtt-10">\</span>⟨<span -class="cmti-10">label</span>⟩ doesn’t allow you to use the first optional -argument of <span +class="cmti-10">label</span>⟩ doesn’t allow +you to use the first optional argument of <span class="cmtt-10">\gls</span><a - id="dx1-74010"></a> or <span + id="dx1-152010"></a> or <span class="cmtt-10">\Gls</span><a - id="dx1-74011"></a> — you will need to explicitly use <span + id="dx1-152011"></a> — you will need to explicitly use <span class="cmtt-10">\gls</span><a - id="dx1-74012"></a> or <span + id="dx1-152012"></a> or <span class="cmtt-10">\Gls</span><a - id="dx1-74013"></a> to change the -settings. -</p><!--l. 10453--><p class="indent" > <div class="important" title="Important Note"> Recall that, in general, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> ignores spaces following command names consisting of -alphabetical characters. This is also true for <span + id="dx1-152013"></a> to change +the settings. +</p><!--l. 11425--><p class="indent" > <div class="important" title="Important Note"> Recall that, in general, <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> ignores spaces following command names consisting of alphabetical +characters. This is also true for <span class="cmtt-10">\</span>⟨<span class="cmti-10">label</span>⟩ unless you additionally load the <span class="cmss-10">xspace</span><a - id="dx1-74014"></a> -package, but be aware that there are some issues with using <span + id="dx1-152014"></a> package, but be aware that there +are some issues with using <span class="cmss-10">xspace</span><a - id="dx1-74015"></a>.<span class="footnote-mark"><a + id="dx1-152015"></a>.<span class="footnote-mark"><a href="#fn2x13" id="fn2x13-bk"><sup class="textsuperscript">13.2</sup></a></span></div> -</p><!--l. 10459--><p class="noindent" > +</p><!--l. 11431--><p class="noindent" > <a - id="x1-74016f2"></a> -</p><!--l. 10463--><p class="indent" > The <span + id="x1-152016f2"></a> +</p><!--l. 11436--><p class="indent" > The <span class="cmss-10">glossaries </span>package doesn’t load the <span class="cmss-10">xspace</span><a - id="dx1-74017"></a> package since there are both advantages -and disadvantages to using <span + id="dx1-152017"></a> package since there are both advantages and disadvantages to +using <span class="cmtt-10">\xspace</span><a - id="dx1-74018"></a> in <span + id="dx1-152018"></a> in <span class="cmtt-10">\</span>⟨<span class="cmti-10">label</span>⟩. If you don’t use the <span class="cmss-10">xspace</span><a - id="dx1-74019"></a> package -you need to explicitly force a space using <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\␣</span></span></span> (backslash space) however you can -follow <span + id="dx1-152019"></a> package you need to explicitly force a space +using <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\␣</span></span></span> (backslash space) however you can follow <span class="cmtt-10">\</span>⟨<span -class="cmti-10">label</span>⟩ with additional text in square brackets (the final optional argument -to <span +class="cmti-10">label</span>⟩ with additional text in square brackets +(the final optional argument to <span class="cmtt-10">\gls</span><a - id="dx1-74020"></a>). If you use the <span + id="dx1-152020"></a>). If you use the <span class="cmss-10">xspace</span><a - id="dx1-74021"></a> package you don’t need to escape the spaces but -you can’t use the optional argument to insert text (you will have to explicitly use + id="dx1-152021"></a> package you don’t need to escape +the spaces but you can’t use the optional argument to insert text (you will have to explicitly use <span class="cmtt-10">\gls</span><a - id="dx1-74022"></a>). -</p><!--l. 10474--><p class="indent" > To illustrate this, suppose I define the acronym “abc” as follows: - - + id="dx1-152022"></a>). +</p><!--l. 11447--><p class="indent" > To illustrate this, suppose I define the acronym “abc” as follows: + + </p> - <div class="verbatim" id="verbatim-352"> + <div class="verbatim" id="verbatim-351"> \oldacronym{abc}{example acronym}{} </div> -<!--l. 10478--><p class="nopar" > This will create the command <span +<!--l. 11451--><p class="nopar" > This will create the command <span class="cmtt-10">\abc </span>and its starred version <span class="cmtt-10">\abc*</span>. <a -href="#tab:xspace">Table 13.2</a> illustrates the -effect of <span -class="cmtt-10">\abc </span>(on subsequent use) according to whether or not the <span +href="#tab:xspace">Table 13.2</a> illustrates the effect of <span +class="cmtt-10">\abc </span>(on +subsequent use) according to whether or not the <span class="cmss-10">xspace</span><a - id="dx1-74023"></a> package has been -loaded. As can be seen from the final row in the table, the <span + id="dx1-152023"></a> package has been loaded. As can be seen +from the final row in the table, the <span class="cmss-10">xspace</span><a - id="dx1-74024"></a> package prevents the -optional argument from being recognised. + id="dx1-152024"></a> package prevents the optional argument from being +recognised. </p> <div class="table"> - - -<!--l. 10486--><p class="indent" > <a + + +<!--l. 11459--><p class="indent" > <a id="tab:xspace"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 13.2: </span><span class="content">The effect of using <span class="cmss-10">xspace </span>with <span -class="cmtt-10">\oldacronym</span></span></div><!--tex4ht:label?: x1-740252 --> +class="cmtt-10">\oldacronym</span></span></div><!--tex4ht:label?: x1-1520252 --> <div class="tabular"> <table id="TBL-8" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-8-1g"><col @@ -21301,111 +23177,92 @@ class="cmtt-10"> xyz</span></span></span> </td><td style="white-space:no class="td11"> abc [’s] xyz </td><td style="white-space:nowrap; text-align:left;" id="TBL-8-6-3" class="td11"> abc’s xyz </td></tr></table> </div> - - + + </div><hr class="endfloat" /> </div> - - -<!--l. 10504--><p class="indent" > </div> -</p><!--l. 10504--><p class="noindent" ><a + + +<!--l. 11477--><p class="indent" > </div> +</p><!--l. 11477--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">14. <a id="sec:glsunset"></a>Unsetting and Resetting Entry Flags</h2> -</p><!--l. 10507--><p class="indent" > When using the <a +</p><!--l. 11480--><p class="indent" > When using the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands it is possible that you may want to use the -value given by the <span -class="cmss-10">first</span><a - id="dx1-75001"></a> key, even though you have already <a -href="#glo:firstuse">used</a> the glossary entry. -Conversely, you may want to use the value given by the <span -class="cmss-10">text</span><a - id="dx1-75002"></a> key, even though you -haven’t used the glossary entry. The former can be achieved by one of the following -commands: -</p><!--l. 10513--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsreset</span><span -class="cmtt-9"> </span></span><a - id="dx1-75003"></a> <span +class="cmtt-10">\gls</span>-like</a> commands it is possible that you may want to use the value given by the <span +class="cmtt-10">first</span><a + id="dx1-153001"></a> +key, even though you have already <a +href="#glo:firstuse">used</a> the glossary entry. Conversely, you may want to use the value given by +the <span +class="cmtt-10">text</span><a + id="dx1-153002"></a> key, even though you haven’t used the glossary entry. The former can be achieved by one of the +following commands: +</p><!--l. 11486--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153003"></a> <span class="cmtt-10">\glsreset{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10515--><p class="noindent" > -</p><!--l. 10516--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslocalreset</span><span -class="cmtt-9"> </span></span><a - id="dx1-75004"></a> <span +</p><!--l. 11488--><p class="noindent" > +</p><!--l. 11489--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153004"></a> <span class="cmtt-10">\glslocalreset{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10518--><p class="noindent" > +</p><!--l. 11491--><p class="noindent" > while the latter can be achieved by one of the following commands: -</p><!--l. 10520--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsunset</span><span -class="cmtt-9"> </span></span><a - id="dx1-75005"></a> <span +</p><!--l. 11493--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153005"></a> <span class="cmtt-10">\glsunset{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10522--><p class="noindent" > -</p><!--l. 10523--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslocalunset</span><span -class="cmtt-9"> </span></span><a - id="dx1-75006"></a> <span +</p><!--l. 11495--><p class="noindent" > +</p><!--l. 11496--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153006"></a> <span class="cmtt-10">\glslocalunset{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10525--><p class="noindent" > +</p><!--l. 11498--><p class="noindent" > You can also reset or unset all entries for a given glossary or list of glossaries using: -</p><!--l. 10528--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsresetall</span><span -class="cmtt-9"> </span></span><a - id="dx1-75007"></a> <span +</p><!--l. 11501--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153007"></a> <span class="cmtt-10">\glsresetall[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10530--><p class="noindent" > -</p><!--l. 10531--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslocalresetall</span><span -class="cmtt-9"> </span></span><a - id="dx1-75008"></a> <span +</p><!--l. 11503--><p class="noindent" > +</p><!--l. 11504--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153008"></a> <span class="cmtt-10">\glslocalresetall[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10533--><p class="noindent" > -</p><!--l. 10534--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsunsetall</span><span -class="cmtt-9"> </span></span><a - id="dx1-75009"></a> <span +</p><!--l. 11506--><p class="noindent" > +</p><!--l. 11507--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153009"></a> <span class="cmtt-10">\glsunsetall[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10536--><p class="noindent" > -</p><!--l. 10537--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslocalunsetall</span><span -class="cmtt-9"> </span></span><a - id="dx1-75010"></a> <span +</p><!--l. 11509--><p class="noindent" > +</p><!--l. 11510--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153010"></a> <span class="cmtt-10">\glslocalunsetall[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10539--><p class="noindent" > +</p><!--l. 11512--><p class="noindent" > where ⟨<span -class="cmti-10">glossary list</span>⟩ is a comma-separated list of glossary labels. If omitted, all defined -glossaries are assumed (except for the ignored ones). For example, to reset all entries in the -main glossary and the list of acronyms: - - +class="cmti-10">glossary list</span>⟩ is a comma-separated list of glossary labels. If omitted, all defined glossaries are assumed +(except for the ignored ones). For example, to reset all entries in the main glossary and the list of +acronyms: + + </p> - <div class="verbatim" id="verbatim-353"> + <div class="verbatim" id="verbatim-352"> \glsresetall[main,acronym] </div> -<!--l. 10547--><p class="nopar" > -</p><!--l. 10549--><p class="indent" > You can determine whether an entry’s <a +<!--l. 11520--><p class="nopar" > +</p><!--l. 11522--><p class="indent" > You can determine whether an entry’s <a href="#glo:firstuseflag">first use flag</a> is set using: -</p><!--l. 10550--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsused</span><span -class="cmtt-9"> </span></span><a - id="dx1-75011"></a> <span +</p><!--l. 11523--><p class="indent" > <hr><div title="Definition"><a + id="dx1-153011"></a> <span class="cmtt-10">\ifglsused{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -21413,32 +23270,33 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10552--><p class="noindent" > +</p><!--l. 11525--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the label of the required entry. If the entry has been used, ⟨<span -class="cmti-10">true part</span>⟩ will be -done, otherwise ⟨<span -class="cmti-10">false part</span>⟩ will be done. -</p><!--l. 10557--><p class="indent" > <div class="important" title="Important Note"> Be careful when using <a +class="cmti-10">true part</span>⟩ will be done, otherwise ⟨<span +class="cmti-10">false</span> +<span +class="cmti-10">part</span>⟩ will be done. +</p><!--l. 11530--><p class="indent" > <div class="important" title="Important Note"> Be careful when using <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands within an environment or command -argument that gets processed multiple times as it can cause unwanted side-effects when the -first use displayed text is different from subsequent use. </div> -</p><!--l. 10562--><p class="noindent" > -</p><!--l. 10564--><p class="indent" > For example, the <span +class="cmtt-10">\gls</span>-like</a> commands within an environment or command argument that gets +processed multiple times as it can cause unwanted side-effects when the first use displayed text is different from +subsequent use. </div> +</p><!--l. 11535--><p class="noindent" > +</p><!--l. 11537--><p class="indent" > For example, the <span class="cmss-10">frame</span><a - id="dx1-75012"></a><a - id="dx1-75013"></a> environment in <span + id="dx1-153012"></a><a + id="dx1-153013"></a> environment in <span class="cmss-10">beamer</span><a - id="dx1-75014"></a> processes its argument for each overlay. -This means that the <a -href="#glo:firstuseflag">first use flag</a> will be unset on the first overlay and subsequent overlays -will use the non-first use form. -</p><!--l. 10569--><p class="indent" > Consider the following example: - - + id="dx1-153014"></a> processes its argument for each overlay. This means that the +<a +href="#glo:firstuseflag">first use flag</a> will be unset on the first overlay and subsequent overlays will use the non-first use +form. +</p><!--l. 11542--><p class="indent" > Consider the following example: + + </p> - <div class="verbatim" id="verbatim-354"> + <div class="verbatim" id="verbatim-353"> \documentclass{beamer}  <br />\usepackage{glossaries}  <br />\newacronym{svm}{SVM}{support vector machine} @@ -21452,22 +23310,21 @@ will use the non-first use form.  <br />\end{frame}  <br />\end{document} </div> -<!--l. 10589--><p class="nopar" > -</p><!--l. 10591--><p class="indent" > On the first overlay, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{svm}</span></span></span> produces “support vector machine (SVM)” and then -unsets the <a -href="#glo:firstuseflag">first use flag</a>. When the second overlay is processed, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{svm}</span></span></span> now produces -“SVM”, which is unlikely to be the desired effect. I don’t know anyway around this and I can -only offer two suggestions. -</p><!--l. 10597--><p class="indent" > Firstly, unset all acronyms at the start of the document and explicitly use <span +<!--l. 11562--><p class="nopar" > +</p><!--l. 11564--><p class="indent" > On the first overlay, <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span> produces “support vector machine (SVM)” and then unsets the <a +href="#glo:firstuseflag">first use flag</a>. +When the second overlay is processed, <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span> now produces “SVM”, which is unlikely to be the desired +effect. I don’t know anyway around this and I can only offer two suggestions. +</p><!--l. 11570--><p class="indent" > Firstly, unset all acronyms at the start of the document and explicitly use <span class="cmtt-10">\acrfull</span><a - id="dx1-75015"></a> when -you want the full version to be displayed: - - + id="dx1-153015"></a> when you want the full +version to be displayed: + + </p> - <div class="verbatim" id="verbatim-355"> + <div class="verbatim" id="verbatim-354"> \documentclass{beamer}  <br />\usepackage{glossaries}  <br />\newacronym{svm}{SVM}{support vector machine} @@ -21482,12 +23339,12 @@ you want the full version to be displayed:  <br />\end{frame}  <br />\end{document} </div> -<!--l. 10619--><p class="nopar" > -</p><!--l. 10621--><p class="indent" > Secondly, explicitly reset each acronym on first use: - - +<!--l. 11592--><p class="nopar" > +</p><!--l. 11594--><p class="indent" > Secondly, explicitly reset each acronym on first use: + + </p> - <div class="verbatim" id="verbatim-356"> + <div class="verbatim" id="verbatim-355"> \begin{frame}  <br /> \frametitle{Frame 1}  <br /> \begin{itemize} @@ -21496,121 +23353,121 @@ you want the full version to be displayed:  <br /> \end{itemize}  <br />\end{frame} </div> -<!--l. 10631--><p class="nopar" > These are non-optimal, but the <span +<!--l. 11604--><p class="nopar" > These are non-optimal, but the <span class="cmss-10">beamer</span><a - id="dx1-75016"></a> class is too complex for me to provide -a programmatic solution. Other potentially problematic environments are some -<span + id="dx1-153016"></a> class is too complex for me to provide a programmatic solution. Other +potentially problematic environments are some <span class="cmss-10">tabular</span><a - id="dx1-75017"></a><a - id="dx1-75018"></a>-like environments (but not <span + id="dx1-153017"></a><a + id="dx1-153018"></a>-like environments (but not <span class="cmss-10">tabular</span><a - id="dx1-75019"></a><a - id="dx1-75020"></a> itself) that process the contents in order -to work out the column widths and then reprocess the contents to do the actual + id="dx1-153019"></a><a + id="dx1-153020"></a> itself) that process the +contents in order to work out the column widths and then reprocess the contents to do the actual typesetting. -</p><!--l. 10639--><p class="indent" > The <span +</p><!--l. 11612--><p class="indent" > The <span class="cmss-10">amsmath</span><a - id="dx1-75021"></a> environments, such as <span + id="dx1-153021"></a> environments, such as <span class="cmss-10">align</span><a - id="dx1-75022"></a><a - id="dx1-75023"></a>, also process their contents multiple times, but -the <span -class="cmss-10">glossaries </span>package now checks for this. For <span + id="dx1-153022"></a><a + id="dx1-153023"></a>, also process their contents multiple times, but the <span +class="cmss-10">glossaries</span> +package now checks for this. For <span class="cmss-10">tabularx</span><a - id="dx1-75024"></a>, you need to explicitly patch it by -placing <span -class="cmtt-10">\glspatchtabularx </span>in the preamble (or anywhere before the problematic use of -<span + id="dx1-153024"></a>, you need to explicitly patch it by placing <span +class="cmtt-10">\glspatchtabularx </span>in the +preamble (or anywhere before the problematic use of <span class="cmss-10">tabularx</span>). +</p><!--l. 11618--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> If you need to use commands like <span +class="cmtt-10">\gls </span>in any problematic context that interferes with the <a +href="#glo:firstuseflag">first use flag</a>, +then you can try using the buffering system provided with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. See the “First Use Flag” section of +the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual. </div> +</p><!--l. 11623--><p class="noindent" > </p> -<!--l. 10646--><p class="noindent" ><a +<!--l. 11626--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">14.1 </span> <a - id="sec:enableentrycount"></a>Counting the Number of Times an Entry has been Used (First Use Flag -Unset)</h3> -<!--l. 10649--><p class="noindent" >As from version 4.14, it’s now possible to keep track of how many times an entry is used. -That is, how many times the <a -href="#glo:firstuseflag">first use flag</a> is unset. Note that the supplemental -<a + id="sec:enableentrycount"></a>Counting the Number of Times an Entry has been Used (First Use Flag Unset)</h3> +<!--l. 11629--><p class="noindent" >As from version 4.14, it’s now possible to keep track of how many times an entry is used. That is, +how many times the <a +href="#glo:firstuseflag">first use flag</a> is unset. Note that the supplemental <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> package improves this function and also provides per-unit counting, which isn’t -available with the <span -class="cmss-10">glossaries </span>package. -</p><!--l. 10655--><p class="indent" > <div class="important" title="Important Note"> This function is disabled by default as it adds extra overhead to the document build time -and also switches <span +class="cmss-10">glossaries-extra</span></a> package +improves this function and also provides per-unit counting, which isn’t available with the <span +class="cmss-10">glossaries</span> +package. +</p><!--l. 11635--><p class="indent" > <div class="important" title="Important Note"> This function is disabled by default as it adds extra overhead to the document build time and +also switches <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-76001"></a> (and therefore <span + id="dx1-154001"></a> (and therefore <span class="cmtt-10">\newacronym</span><a - id="dx1-76002"></a>) into a preamble-only -command. </div> -</p><!--l. 10660--><p class="noindent" > -</p><!--l. 10662--><p class="indent" > To enable this function, use -</p><!--l. 10663--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsenableentrycount</span><span -class="cmtt-9"> </span></span><a - id="dx1-76003"></a> <span + id="dx1-154002"></a>) into a preamble-only command. +</div> +</p><!--l. 11640--><p class="noindent" > +</p><!--l. 11642--><p class="indent" > To enable this function, use +</p><!--l. 11643--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154003"></a> <span class="cmtt-10">\glsenableentrycount </span></div><hr> -</p><!--l. 10665--><p class="noindent" > +</p><!--l. 11645--><p class="noindent" > before defining your entries. This adds two extra (internal) fields to entries: <span -class="cmtt-10">currcount </span>and -<span +class="cmtt-10">currcount </span>and <span class="cmtt-10">prevcount</span>. -</p><!--l. 10669--><p class="indent" > The <span +</p><!--l. 11649--><p class="indent" > The <span class="cmtt-10">currcount </span>field keeps track of how many times <span -class="cmtt-10">\glsunset </span>is used within the -document. A local unset (using <span -class="cmtt-10">\glslocalunset</span>) performs a local rather than global -increment to <span -class="cmtt-10">currcount</span>. Remember that not all commands use <span -class="cmtt-10">\glsunset</span>. Only the -<a +class="cmtt-10">\glsunset </span>is used within the document. A local unset +(using <span +class="cmtt-10">\glslocalunset</span>) performs a local rather than global increment to <span +class="cmtt-10">currcount</span>. Remember that +not all commands use <span +class="cmtt-10">\glsunset</span>. Only the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> commands do this. The reset commands <span +class="cmtt-10">\gls</span>-like</a> commands do this. The reset commands +<span class="cmtt-10">\glsreset </span>and <span -class="cmtt-10">\glslocalreset </span>reset this -field back to zero (where <span -class="cmtt-10">\glslocalreset </span>performs a local change). -</p><!--l. 10677--><p class="indent" > The <span +class="cmtt-10">\glslocalreset </span>reset this field back to zero (where <span +class="cmtt-10">\glslocalreset </span>performs a local +change). + + +</p><!--l. 11657--><p class="indent" > The <span class="cmtt-10">prevcount </span>field stores the final value of the <span class="cmtt-10">currcount </span>field <span -class="cmti-10">from the previous run</span>. -This value is read from the <span -class="cmtt-10">.aux </span>file at the beginning of the <span +class="cmti-10">from the previous run</span>. This value is read +from the <span +class="cmtt-10">aux</span><a + id="dx1-154004"></a> file at the beginning of the <span class="cmss-10">document</span><a - id="dx1-76004"></a><a - id="dx1-76005"></a> environment. - - -</p><!--l. 10682--><p class="indent" > You can access these fields using -</p><!--l. 10683--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrycurrcount</span><span -class="cmtt-9"> </span></span><a - id="dx1-76006"></a> <span + id="dx1-154005"></a><a + id="dx1-154006"></a> environment. +</p><!--l. 11662--><p class="indent" > You can access these fields using +</p><!--l. 11663--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154007"></a> <span class="cmtt-10">\glsentrycurrcount{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10685--><p class="noindent" > +</p><!--l. 11665--><p class="noindent" > for the <span class="cmtt-10">currcount </span>field, and -</p><!--l. 10687--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryprevcount</span><span -class="cmtt-9"> </span></span><a - id="dx1-76007"></a> <span +</p><!--l. 11667--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154008"></a> <span class="cmtt-10">\glsentryprevcount{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10689--><p class="noindent" > +</p><!--l. 11669--><p class="noindent" > for the <span -class="cmtt-10">prevcount </span>field. <span -class="cmbx-10">These commands are only defined if you have used</span> -<span -class="cmtt-10">\glsenableentrycount</span><span -class="cmbx-10">.</span> -</p><!--l. 10693--><p class="indent" > For example: - - +class="cmtt-10">prevcount </span>field. +</p><!--l. 11672--><p class="indent" > <div class="important" title="Important Note"> These commands are only defined if you have used <span +class="cmtt-10">\glsenableentrycount</span>. </div> +</p><!--l. 11674--><p class="noindent" > +</p><!--l. 11676--><p class="indent" > For example: + + </p> - <div class="verbatim" id="verbatim-357"> + <div class="verbatim" id="verbatim-356"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\makeglossaries @@ -21623,37 +23480,34 @@ class="cmbx-10">.</span>  <br />Number of times apple has been used: \glsentrycurrcount{apple}.  <br />\end{document} </div> -<!--l. 10711--><p class="nopar" > On the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 11694--><p class="nopar" > On the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsentryprevcount{apple}</span></span></span> produces 0. At the end of the -document, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsentrycurrcount{apple}</span></span></span> produces 4. This is because the only commands -that have incremented the entry count are those that use <span +class="cmtt-10">\glsentryprevcount{apple}</span></span></span> produces 0. At the end of the document, +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsentrycurrcount{apple}</span></span></span> produces 4. This is because the only commands that have incremented the entry +count are those that use <span class="cmtt-10">\glsunset</span>. That is: <span class="cmtt-10">\gls</span>, <span -class="cmtt-10">\glsdisp</span> -and <span -class="cmtt-10">\Gls</span>. The other commands used in the above example, <span +class="cmtt-10">\glsdisp </span>and <span +class="cmtt-10">\Gls</span>. The other commands used in the above +example, <span class="cmtt-10">\glsadd</span>, <span -class="cmtt-10">\glsentrytext </span>and -<span +class="cmtt-10">\glsentrytext </span>and <span class="cmtt-10">\glslink</span>, don’t use <span -class="cmtt-10">\glsunset </span>so they don’t increment the entry count. On the <span -class="cmti-10">next</span> -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="cmtt-10">\glsunset </span>so they don’t increment the +entry count. On the <span +class="cmti-10">next </span><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> run, <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\glsentryprevcount{apple}</span></span></span> now produces 4 as that was the value of the -<span +class="cmtt-10">\glsentryprevcount{apple}</span></span></span> now produces 4 as that was +the value of the <span class="cmtt-10">currcount </span>field for the <span class="cmtt-10">apple </span>entry at the end of the document on the previous run. -</p><!--l. 10724--><p class="indent" > When you enable the entry count using <span -class="cmtt-10">\glsenableentrycount</span>, you also enable the -following commands: -</p><!--l. 10726--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cgls</span><span -class="cmtt-9"> </span></span><a - id="dx1-76008"></a> <span +</p><!--l. 11707--><p class="indent" > When you enable the entry count using <span +class="cmtt-10">\glsenableentrycount</span>, you also enable the following +commands: +</p><!--l. 11709--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154009"></a> <span class="cmtt-10">\cgls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21661,12 +23515,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10728--><p class="noindent" > +</p><!--l. 11711--><p class="noindent" > (no case-change, singular) -</p><!--l. 10730--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cglspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-76009"></a> <span +</p><!--l. 11713--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154010"></a> <span class="cmtt-10">\cglspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21674,12 +23526,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10732--><p class="noindent" > +</p><!--l. 11715--><p class="noindent" > (no case-change, plural) -</p><!--l. 10734--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cGls</span><span -class="cmtt-9"> </span></span><a - id="dx1-76010"></a> <span +</p><!--l. 11717--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154011"></a> <span class="cmtt-10">\cGls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21687,12 +23537,10 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10736--><p class="noindent" > +</p><!--l. 11719--><p class="noindent" > (first letter uppercase, singular), and -</p><!--l. 10738--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cGlspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-76011"></a> <span +</p><!--l. 11721--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154012"></a> <span class="cmtt-10">\cGlspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -21700,31 +23548,30 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 10740--><p class="noindent" > -(first letter uppercase, plural). These all have plus and starred variants like the analogous -<span +</p><!--l. 11723--><p class="noindent" > +(first letter uppercase, plural). These all have plus and starred variants like the analogous <span class="cmtt-10">\gls</span>, <span class="cmtt-10">\glspl</span>, <span -class="cmtt-10">\Gls </span>and <span +class="cmtt-10">\Gls</span> +and <span class="cmtt-10">\Glspl </span>commands. -</p><!--l. 10745--><p class="indent" > If you don’t use <span +</p><!--l. 11728--><p class="indent" > If you don’t use <span class="cmtt-10">\glsenableentrycount</span>, these commands behave like <span class="cmtt-10">\gls</span>, <span class="cmtt-10">\glspl</span>, <span -class="cmtt-10">\Gls</span> -and <span -class="cmtt-10">\Glspl</span>, respectively, only there will be a warning that you haven’t enabled entry -counting. If you have enabled entry counting with <span -class="cmtt-10">\glsenableentrycount </span>then these - - -commands test if <span +class="cmtt-10">\Gls </span>and <span +class="cmtt-10">\Glspl</span>, +respectively, only there will be a warning that you haven’t enabled entry counting. If you have enabled entry +counting with <span +class="cmtt-10">\glsenableentrycount </span>then these commands test if <span class="cmtt-10">\glsentryprevcount{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">} </span>equals 1. If it doesn’t then the analogous <span -class="cmtt-10">\gls</span> -etc will be used. If it does, then the first optional argument will be ignored and +class="cmtt-10">} </span>equals 1. If it +doesn’t then the analogous <span +class="cmtt-10">\gls </span>etc will be used. If it does, then the first optional argument will be ignored and </p><div class="alltt"> + + <div class="obeylines-v"> ⟨<span class="cmitt-10">cs</span><span @@ -21738,22 +23585,20 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}</span> </div> </div> will be performed, where ⟨<span -class="cmti-10">cs format</span>⟩ is a command that takes two arguments. The command -used depends whether you have used <span +class="cmti-10">cs format</span>⟩ is a command that takes two arguments. The command used depends +whether you have used <span class="cmtt-10">\cgls</span>, <span class="cmtt-10">\cglspl</span>, <span class="cmtt-10">\cGls </span>or <span class="cmtt-10">\cGlspl</span>. -<!--l. 10760--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cglsformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-76012"></a> <span +<!--l. 11743--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154013"></a> <span class="cmtt-10">\cglsformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10762--><p class="noindent" > +</p><!--l. 11745--><p class="noindent" > This command is used by <span class="cmtt-10">\cgls </span>and defaults to </p><div class="alltt"> <div class="obeylines-v"> @@ -21773,16 +23618,14 @@ class="cmtt-10">}</span>⟨<span class="cmitt-10">insert</span>⟩ </div> </div> otherwise. -<!--l. 10774--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cglsplformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-76013"></a> <span +<!--l. 11757--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154014"></a> <span class="cmtt-10">\cglsplformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10776--><p class="noindent" > +</p><!--l. 11759--><p class="noindent" > This command is used by <span class="cmtt-10">\cglspl </span>and defaults to </p><div class="alltt"> <div class="obeylines-v"> @@ -21802,20 +23645,16 @@ class="cmtt-10">}</span>⟨<span class="cmitt-10">insert</span>⟩ </div> </div> otherwise. -<!--l. 10788--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cGlsformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-76014"></a> <span +<!--l. 11771--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154015"></a> <span class="cmtt-10">\cGlsformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10790--><p class="noindent" > +</p><!--l. 11773--><p class="noindent" > This command is used by <span class="cmtt-10">\cGls </span>and defaults to </p><div class="alltt"> - - <div class="obeylines-v"> <span class="cmtt-10">\Glsentrylong{</span>⟨<span @@ -21825,6 +23664,8 @@ class="cmitt-10">insert</span>⟩ </div> </div> if the entry given by ⟨<span class="cmti-10">label</span>⟩ has a long form or <div class="alltt"> + + <div class="obeylines-v"> <span class="cmtt-10">\Glsentryfirst{</span>⟨<span @@ -21833,16 +23674,14 @@ class="cmtt-10">}</span>⟨<span class="cmitt-10">insert</span>⟩ </div> </div> otherwise. -<!--l. 10801--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\cGlsplformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-76015"></a> <span +<!--l. 11784--><p class="indent" > <hr><div title="Definition"><a + id="dx1-154016"></a> <span class="cmtt-10">\cGlsplformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10803--><p class="noindent" > +</p><!--l. 11786--><p class="noindent" > This command is used by <span class="cmtt-10">\cGlspl </span>and defaults to </p><div class="alltt"> <div class="obeylines-v"> @@ -21862,37 +23701,36 @@ class="cmtt-10">}</span>⟨<span class="cmitt-10">insert</span>⟩ </div> </div> otherwise. -<!--l. 10814--><p class="indent" > This means that if the previous count for the given entry was 1, the entry won’t be -hyperlinked with the <span -class="cmtt-10">\cgls</span>-like commands and they won’t add a line to the external glossary -file. If you haven’t used any of the other commands that add information to glossary file (such -as <span +<!--l. 11797--><p class="indent" > This means that if the previous count for the given entry was 1, the entry won’t be hyperlinked with the +<span +class="cmtt-10">\cgls</span>-like commands and they won’t add a line to the external glossary file. If you haven’t used any of the +other commands that add information to glossary file (such as <span class="cmtt-10">\glsadd </span>or the <a href="#sec:glstext-like"><span -class="cmtt-10">\glstext</span>-like</a> commands) then the entry won’t appear in the -glossary. -</p><!--l. 10821--><p class="indent" > Remember that since these commands use <span -class="cmtt-10">\glsentryprevcount </span>you need to run -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> twice to ensure they work correctly. The document build order is now (at least): -<span +class="cmtt-10">\glstext</span>-like</a> commands) then +the entry won’t appear in the glossary. +</p><!--l. 11804--><p class="indent" > Remember that since these commands use <span +class="cmtt-10">\glsentryprevcount </span>you need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> twice to ensure +they work correctly. The document build order is now (at least): <span class="cmtt-10">(pdf)latex</span>, <span class="cmtt-10">(pdf)latex</span>, <span -class="cmtt-10">makeglossaries</span>, <span +class="cmtt-10">makeglossaries</span>, +<span class="cmtt-10">(pdf)latex</span>. <a - id="x1-76016r26"></a> -</p><!--l. 10826--><p class="noindent" ><span + id="sec:entrycount"></a> +</p><!--l. 11809--><p class="noindent" ><span class="cmbx-12">Example 26</span><span class="cmbx-12"> (Don’t index entries that are only used once)</span><a - id="x1-76017"></a> -</p><!--l. 10827--><p class="indent" > In this example, the abbreviations that have only been used once (on the previous run) -only have their long form shown with <span + id="x1-154018"></a> +</p><!--l. 11810--><p class="indent" > In this example, the abbreviations that have only been used once (on the previous run) only have their long +form shown with <span class="cmtt-10">\cgls</span>. - - + + </p> - <div class="verbatim" id="verbatim-358"> + <div class="verbatim" id="verbatim-357"> \documentclass{article}  <br />\usepackage[colorlinks]{hyperref}  <br />\usepackage[acronym]{glossaries} @@ -21913,170 +23751,177 @@ class="cmtt-10">\cgls</span>.  <br />\printglossaries  <br />\end{document} </div> -<!--l. 10855--><p class="nopar" > After a complete document build (<span +<!--l. 11838--><p class="nopar" > After a complete document build (<span class="cmtt-10">latex</span>, <span class="cmtt-10">latex</span>, <span class="cmtt-10">makeglossaries</span>, <span -class="cmtt-10">latex</span>) the list of -abbrevaitions only includes the entries HTML, CSS and RDSMS. The entries SQL, -RDBMS and XML only have their long forms displayed and don’t have a hyperlink. -</p> +class="cmtt-10">latex</span>) the list of abbrevaitions only +includes the entries HTML, CSS and RDSMS. The entries SQL, RDBMS and XML only have their long forms +displayed and don’t have a hyperlink. </p> <div class="center" > -<!--l. 10861--><p class="noindent" > -</p><!--l. 10861--><p class="noindent" >____________________________</p></div> -<!--l. 10863--><p class="indent" > Remember that if you don’t like typing <span -class="cmtt-10">\cgls </span>you can create a synonym. For -example - - +<!--l. 11844--><p class="noindent" > +</p><!--l. 11844--><p class="noindent" >____________________________</p></div> +<!--l. 11846--><p class="indent" > Remember that if you don’t like typing <span +class="cmtt-10">\cgls </span>you can create a synonym. For example + + </p> - <div class="verbatim" id="verbatim-359"> + <div class="verbatim" id="verbatim-358"> \let\ac\cgls </div> -<!--l. 10867--><p class="nopar" > - - -</p> -<!--l. 10869--><p class="indent" > </div> -</p><!--l. 10869--><p class="noindent" ><a +<!--l. 11850--><p class="nopar" > +</p><!--l. 11852--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-154019"></a></a> there’s an analogous record counting set of commands. See <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-154020"></a></a> +manuals for further details. </div> +</p><!--l. 11855--><p class="noindent" > + + +</p> +<!--l. 11857--><p class="indent" > </div> +</p><!--l. 11857--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">15. <a id="sec:styles"></a>Glossary Styles</h2> -</p><!--l. 10872--><p class="indent" > Glossaries vary from lists that simply contain a symbol with a terse description to lists of -terms or phrases with lengthy descriptions. Some glossaries may have terms with associated -symbols. Some may have hierarchical entries. There is therefore no single style that fits every -type of glossary. The <span -class="cmss-10">glossaries </span>package comes with a number of pre-defined glossary styles, -described in <a -href="#sec:predefinedstyles"><span -class="tcrm-1000">§</span>15.1 </a><a -href="#sec:predefinedstyles">Predefined Styles<!--tex4ht:ref: sec:predefinedstyles --></a>. You can choose one of these that best suits your type of -glossary or, if none of them suit your document, you can defined your own style (see <a -href="#sec:newglossarystyle"><span -class="tcrm-1000">§</span>15.2 -</a><a +</p><!--l. 11860--><p class="indent" > Glossaries vary from lists that simply contain a symbol with a terse description to lists of terms or phrases +with lengthy descriptions. Some glossaries may have terms with associated symbols. Some may have hierarchical +entries. There is therefore no single style that fits every type of glossary. The <span +class="cmss-10">glossaries </span>package comes with a +number of pre-defined glossary styles, described in <a +href="#sec:predefinedstyles">§15.1 </a><a +href="#sec:predefinedstyles">Predefined Styles<!--tex4ht:ref: sec:predefinedstyles --></a>. You can choose one of these that best +suits your type of glossary or, if none of them suit your document, you can defined your own style (see +<a +href="#sec:newglossarystyle">§15.2 </a><a href="#sec:newglossarystyle">Defining your own glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>). There are some examples of glossary styles available at <a -href="http://www.dickimaw-books.com/gallery/#glossaries" class="url" ><span -class="cmtt-10">http://www.dickimaw-books.com/gallery/#glossaries</span></a>. -</p><!--l. 10885--><p class="indent" > The glossary style can be set using the <span -class="cmss-10">style</span><a - id="dx1-77001"></a> key in the optional argument to -<span +href="https://www.dickimaw-books.com/gallery/#glossaries" ><span +class="cmtt-10">https://www.dickimaw-books.com/gallery/#glossaries</span></a>. +</p><!--l. 11872--><p class="indent" > The glossary style can be set using the <span +class="cmtt-10">style</span><a + id="dx1-155001"></a> key in the optional argument to <span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-77002"></a> (<a + id="dx1-155002"></a> +(<a href="#option1">Option 1</a>) or <span class="cmtt-10">\printglossary</span><a - id="dx1-77003"></a> (Options <a + id="dx1-155003"></a> (Options <a href="#option2">2</a> and <a -href="#option3">3</a>) or using the -command: -</p><!--l. 10888--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\setglossarystyle</span><span -class="cmtt-9"> </span></span><a - id="dx1-77004"></a> <span +href="#option3">3</a>) or using the command: +</p><!--l. 11875--><p class="indent" > <hr><div title="Definition"><a + id="dx1-155004"></a> <span class="cmtt-10">\setglossarystyle{</span>⟨<span class="cmitt-10">style-name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 10890--><p class="noindent" > +</p><!--l. 11877--><p class="noindent" > (before the glossary is displayed). -</p><!--l. 10893--><p class="indent" > Some of the predefined glossary styles may also be set using the <span +</p><!--l. 11880--><p class="indent" > Some of the predefined glossary styles may also be set using the <span class="cmss-10">style</span><a - id="dx1-77005"></a> package option, it -depends if the package in which they are defined is automatically loaded by the <span -class="cmss-10">glossaries</span> -package. -</p><!--l. 10897--><p class="indent" > You can use the lorum ipsum dummy entries provided in the accompanying -<span -class="cmtt-10">example-glossaries-*.tex </span>files (described in <a -href="#sec:lipsum"><span -class="tcrm-1000">§</span>1.3 </a><a -href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a>) to test the -different styles. + id="dx1-155005"></a> package option, it depends if the +package in which they are defined is automatically loaded by the <span +class="cmss-10">glossaries </span>package. +</p><!--l. 11884--><p class="indent" > You can use the lorum ipsum dummy entries provided in the accompanying <span +class="cmtt-10">example-glossaries-*.tex</span> +files (described in <a +href="#sec:lipsum">§1.2 </a><a +href="#sec:lipsum">Dummy Entries for Testing<!--tex4ht:ref: sec:lipsum --></a>) to test the different styles. +</p><!--l. 11889--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <span +class="cmss-10">glossaries-extra-stylemods</span><a + id="dx1-155006"></a> package provided with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> patches the predefined styles. There also +more styles available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. </div> +</p><!--l. 11893--><p class="noindent" > </p> -<!--l. 10902--><p class="noindent" ><a +<!--l. 11895--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">15.1 </span> <a id="sec:predefinedstyles"></a>Predefined Styles</h3> -<!--l. 10905--><p class="noindent" >The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the -package options <span +<!--l. 11898--><p class="noindent" >The predefined styles can accommodate numbered level 0 (main) and level 1 entries. See the package options +<span class="cmss-10">entrycounter</span><a - id="dx1-78001"></a>, <span + id="dx1-156001"></a>, <span class="cmss-10">counterwithin</span><a - id="dx1-78002"></a> and <span + id="dx1-156002"></a> and <span class="cmss-10">subentrycounter</span><a - id="dx1-78003"></a> described in <a -href="#sec:pkgopts-printglos"><span -class="tcrm-1000">§</span>2.3 </a><a -href="#sec:pkgopts-printglos">Glossary -Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a>. There is a summary of available styles in <a -href="#tab:styles">table 15.1</a>. You can view samples of -all the predefined styles at <a -href="http://www.dickimaw-books.com/gallery/glossaries-styles/" class="url" ><span -class="cmtt-10">http://www.dickimaw-books.com/gallery/glossaries-styles/</span></a>. -Note that <a -href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> provides additional styles in the supplementary packages -<span + id="dx1-156003"></a> described in <a +href="#sec:pkgopts-printglos">§2.3 </a><a +href="#sec:pkgopts-printglos">Glossary Appearance Options<!--tex4ht:ref: sec:pkgopts-printglos --></a>. There is a +summary of available styles in <a +href="#tab:styles">table 15.1</a>. You can view samples of all the predefined styles at +<a +href="https://www.dickimaw-books.com/gallery/glossaries-styles/" ><span +class="cmtt-10">https://www.dickimaw-books.com/gallery/glossaries-styles/</span></a>. Note that <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> provides +additional styles in the supplementary packages <span class="cmss-10">glossary-bookindex</span><a - id="dx1-78004"></a> and <span + id="dx1-156004"></a> and <span class="cmss-10">glossary-longnoloc</span><a - id="dx1-78005"></a>. See the <a + id="dx1-156005"></a>. See the <a href="#glo:glossaries-extra"><span -class="cmss-10">glossaries-extra</span></a> manual for further -details. -</p><!--l. 10918--><p class="indent" > <div class="important" title="Important Note"> Note that the group styles (such as <span +class="cmss-10">glossaries-extra</span></a> +manual for further details. +</p><!--l. 11911--><p class="indent" > <div class="important" title="Important Note"> Note that the group styles (such as <span class="cmss-10">listgroup</span><a - id="dx1-78006"></a>) will have unexpected results if used with -the <span -class="cmss-10">sort=def</span><a - id="dx1-78007"></a> or <span -class="cmss-10">sort=use</span><a - id="dx1-78008"></a> options. If you don’t sort your entries alphabetically, it’s -best to set the <span + id="dx1-156006"></a>) will have unexpected results if used with the <span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a + id="dx1-156007"></a> or +<span +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a + id="dx1-156008"></a> options. If you don’t sort your entries alphabetically, it’s best to set the <span class="cmss-10">nogroupskip</span><a - id="dx1-78009"></a> package option to prevent odd vertical gaps appearing. -</div> -</p><!--l. 10924--><p class="noindent" > -</p><!--l. 10926--><p class="indent" > The group title is obtained using <span + id="dx1-156009"></a> package option to +prevent odd vertical gaps appearing. </div> +</p><!--l. 11917--><p class="noindent" > +</p><!--l. 11919--><p class="indent" > The group title is obtained using <span class="cmtt-10">\glsgetgrouptitle{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>, which is described in <a -href="#sec:newglossarystyle"><span -class="tcrm-1000">§</span>15.2 -</a><a -href="#sec:newglossarystyle">Defining your own glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>. +href="#sec:newglossarystyle">§15.2 </a><a +href="#sec:newglossarystyle">Defining your own +glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>. </p> <div class="table"> - - -<!--l. 10929--><p class="indent" > <a + + +<!--l. 11922--><p class="indent" > <a id="tab:styles"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 15.1: </span><span -class="content">Glossary Styles. An asterisk in the style name indicates anything that -matches that doesn’t match any previously listed style (e.g. <span -class="cmtt-10">long3col* </span>matches -<span +class="content">Glossary Styles. An asterisk in the style name indicates anything that matches that doesn’t +match any previously listed style (e.g. <span +class="cmtt-10">long3col* </span>matches <span class="cmss-10">long3col</span><a - id="dx1-78011"></a>, <span + id="dx1-156011"></a>, <span class="cmss-10">long3colheader</span><a - id="dx1-78012"></a>, <span + id="dx1-156012"></a>, <span class="cmss-10">long3colborder</span><a - id="dx1-78013"></a> and <span + id="dx1-156013"></a> and +<span class="cmss-10">long3colheaderborder</span><a - id="dx1-78014"></a>). A maximum level of -0 indicates a flat glossary (sub-entries are displayed in the same way as main entries). -Where the maximum level is given as — there is no limit, but note that <a + id="dx1-156014"></a>). A maximum level of 0 indicates a flat glossary (sub-entries are displayed in the +same way as main entries). Where the maximum level is given as — there is no limit, but note that +<a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-78015"></a></a> -(<a -href="#option2">Option 2</a>) imposes a limit of 2 sub-levels. If the homograph column is checked, then -the name is not displayed for sub-entries. If the symbol column is checked, then the -symbol will be displayed.</span></div><!--tex4ht:label?: x1-780101 --> + id="dx1-156015"></a></a> (<a +href="#option2">Option 2</a>) imposes a limit of 2 sub-levels. If the homograph column is checked, then the +name is not displayed for sub-entries. If the symbol column is checked, then the symbol will be displayed.</span></div><!--tex4ht:label?: x1-1560101 --> <div class="tabular"> <table id="TBL-9" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-9-1g"><col @@ -22231,404 +24076,378 @@ class="td11"> 1 </td><td style="white-space:nowrap; text-ali class="td11"> <span class="pzdr-">✓ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-9-18-4" class="td11"> </td></tr></table></div> - - + + </div><hr class="endfloat" /> </div> -<!--l. 10969--><p class="indent" > The tabular-like styles that allow multi-line descriptions and page lists use the length -<span class="reversemarginpar"><span -class="cmtt-9">\glsdescwidth</span><span -class="cmtt-9"> </span></span><a - id="dx1-78016"></a><span -class="cmtt-10">\glsdescwidth </span>to set the width of the description column and the -length <span class="reversemarginpar"><span -class="cmtt-9">\glspagelistwidth</span><span -class="cmtt-9"> </span></span><a - id="dx1-78017"></a><span -class="cmtt-10">\glspagelistwidth </span>to set the width of the page list -column.<span class="footnote-mark"><a +<!--l. 11962--><p class="indent" > The tabular-like styles that allow multi-line descriptions and page lists use the length +</p><!--l. 11964--><p class="indent" > <hr><div title="Definition"><a + id="dx1-156016"></a> <span +class="cmtt-10">\glsdescwidth </span></div><hr> +</p><!--l. 11966--><p class="noindent" > +to set the width of the description column and the length +</p><!--l. 11968--><p class="indent" > <hr><div title="Definition"><a + id="dx1-156017"></a> <span +class="cmtt-10">\glspagelistwidth </span></div><hr> +</p><!--l. 11970--><p class="noindent" > +to set the width of the page list column.<span class="footnote-mark"><a href="#fn1x15" id="fn1x15-bk"><sup class="textsuperscript">15.1</sup></a></span><a - id="x1-78018f1"></a> + id="x1-156018f1"></a> These will need to be changed using <span -class="cmtt-10">\setlength </span>if the glossary is too wide. Note that the -<span +class="cmtt-10">\setlength </span>if the glossary is too wide. Note that the <span class="cmss-10">long4col</span><a - id="dx1-78022"></a> and <span + id="dx1-156022"></a> and <span class="cmss-10">super4col</span><a - id="dx1-78023"></a> styles (and their header and border variations) don’t use these lengths -as they are designed for single line entries. Instead you should use the analogous -<span + id="dx1-156023"></a> +styles (and their header and border variations) don’t use these lengths as they are designed for single line +entries. Instead you should use the analogous <span class="cmss-10">altlong4col</span><a - id="dx1-78024"></a> and <span + id="dx1-156024"></a> and <span class="cmss-10">altsuper4col</span><a - id="dx1-78025"></a> styles. If you want to explicitly create a line-break within a -multi-line description in a tabular-like style it’s better to use <span + id="dx1-156025"></a> styles. If you want to explicitly create +a line-break within a multi-line description in a tabular-like style it’s better to use <span class="cmtt-10">\newline</span><a - id="dx1-78026"></a> instead of + id="dx1-156026"></a> instead of <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\\</span></span></span>. -</p><!--l. 10987--><p class="indent" > <div class="important" title="Important Note"> Remember that a cell within a tabular-like environment can’t be broken across a page, so -even if a tabular-like style, such as <span +</p><!--l. 11985--><p class="indent" > <div class="important" title="Important Note"> Remember that a cell within a tabular-like environment can’t be broken across a page, so even if a +tabular-like style, such as <span class="cmss-10">long</span><a - id="dx1-78027"></a>, allows multilined descriptions, you’ll probably -encounter page-breaking problems if you have entries with long descriptions. You may want to -consider using the <span + id="dx1-156027"></a>, allows multilined descriptions, you’ll probably encounter page-breaking problems +if you have entries with long descriptions. You may want to consider using the <span class="cmss-10">alttree</span><a - id="dx1-78028"></a> style instead. </div> -</p><!--l. 10993--><p class="noindent" > -</p><!--l. 10995--><p class="indent" > Note that if you use the <span -class="cmss-10">style</span><a - id="dx1-78029"></a> key in the optional argument to <span + id="dx1-156028"></a> style instead. +</div> +</p><!--l. 11991--><p class="noindent" > +</p><!--l. 11993--><p class="indent" > Note that if you use the <span +class="cmtt-10">style</span><a + id="dx1-156029"></a> key in the optional argument to <span class="cmtt-10">\printnoidxglossary</span><a - id="dx1-78030"></a> -(<a -href="#option1">Option 1</a>) or <span + id="dx1-156030"></a> (<a +href="#option1">Option 1</a>) or +<span class="cmtt-10">\printglossary</span><a - id="dx1-78031"></a> (Options <a + id="dx1-156031"></a> (Options <a href="#option2">2</a> and <a -href="#option3">3</a>), it will override any previous style settings -for the given glossary, so if, for example, you do - - +href="#option3">3</a>), it will override any previous style settings for the given glossary, so if, for +example, you do + + </p> - <div class="verbatim" id="verbatim-360"> + <div class="verbatim" id="verbatim-359"> \renewcommand*{\glsgroupskip}{}  <br />\printglossary[style=long] </div> -<!--l. 11003--><p class="nopar" > then the new definition of <span +<!--l. 12001--><p class="nopar" > then the new definition of <span class="cmtt-10">\glsgroupskip</span><a - id="dx1-78032"></a> will not have an affect for this glossary, as -<span -class="cmtt-10">\glsgroupskip </span>is redefined by <span class="obeylines-h"><span class="verb"><span + id="dx1-156032"></a> will not have an affect for this glossary, as <span +class="cmtt-10">\glsgroupskip </span>is +redefined by <span class="obeylines-h"><span class="verb"><span class="cmtt-10">style=long</span></span></span>. Likewise, <span class="cmtt-10">\setglossarystyle</span><a - id="dx1-78033"></a> will also override -any previous style definitions, so, again - - + id="dx1-156033"></a> will also override any previous style definitions, so, +again + + </p> - <div class="verbatim" id="verbatim-361"> + <div class="verbatim" id="verbatim-360"> \renewcommand*{\glsgroupskip}{}  <br />\setglossarystyle{long} </div> -<!--l. 11011--><p class="nopar" > will reset <span -class="cmtt-10">\glsgroupskip </span>back to its default definition for the named glossary style -(<span +<!--l. 12009--><p class="nopar" > will reset <span +class="cmtt-10">\glsgroupskip </span>back to its default definition for the named glossary style (<span class="cmss-10">long</span><a - id="dx1-78034"></a> in this case). If you want to modify the styles, either use <span + id="dx1-156034"></a> in this case). If you +want to modify the styles, either use <span class="cmtt-10">\newglossarystyle</span><a - id="dx1-78035"></a> -(described in the next section) or make the modifications after <span + id="dx1-156035"></a> (described in the next section) or make the +modifications after <span class="cmtt-10">\setglossarystyle</span><a - id="dx1-78036"></a>, -e.g.: - - + id="dx1-156036"></a>, e.g.: + + </p> - <div class="verbatim" id="verbatim-362"> + <div class="verbatim" id="verbatim-361"> \setglossarystyle{long}  <br />\renewcommand*{\glsgroupskip}{} </div> -<!--l. 11020--><p class="nopar" > As from version 3.03, you can now use the package option <span +<!--l. 12018--><p class="nopar" > As from version 3.03, you can now use the package option <span class="cmss-10">nogroupskip</span><a - id="dx1-78037"></a> to suppress the gap -between groups for the default styles instead of redefining <span + id="dx1-156037"></a> to suppress the gap between groups for +the default styles instead of redefining <span class="cmtt-10">\glsgroupskip</span>. -</p><!--l. 11025--><p class="indent" > All the styles except for the three- and four-column styles and the <span +</p><!--l. 12023--><p class="indent" > All the styles except for the three- and four-column styles and the <span class="cmss-10">listdotted</span><a - id="dx1-78038"></a> style use the -command -</p><!--l. 11027--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspostdescription</span><span -class="cmtt-9"> </span></span><a - id="dx1-78039"></a> <span + id="dx1-156038"></a> style use the command +</p><!--l. 12025--><p class="indent" > <hr><div title="Definition"><a + id="dx1-156039"></a> <span class="cmtt-10">\glspostdescription </span></div><hr> -</p><!--l. 11029--><p class="noindent" > -after the description. This simply displays a full stop by default. To eliminate this full -stop (or replace it with something else, say, a comma) you will need to redefine -<span -class="cmtt-10">\glspostdescription </span>before the glossary is displayed. Alternatively, you can suppress it -for a given entry by placing <span +</p><!--l. 12027--><p class="noindent" > +after the description. This simply displays a full stop by default. To eliminate this full stop (or replace it with +something else, say, a comma) you will need to redefine <span +class="cmtt-10">\glspostdescription </span>before the glossary is displayed. +Alternatively, you can suppress it for a given entry by placing <span class="cmtt-10">\nopostdesc</span><a - id="dx1-78040"></a> in the entry’s description. Note that + id="dx1-156040"></a> in the entry’s description. Note that <span class="cmtt-10">\longnewglossaryentry</span><a - id="dx1-78041"></a> puts <span -class="cmtt-10">\nopostdesc </span>at the end of the description. The <span -class="cmss-10">glossaries-extra</span><a - id="dx1-78042"></a> -package provides a starred version that doesn’t. -</p><!--l. 11039--><p class="indent" > As from version 3.03 you can now use the package option <span + id="dx1-156041"></a> puts <span +class="cmtt-10">\nopostdesc </span>at the end of the description. The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides +a starred version that doesn’t. +</p><!--l. 12037--><p class="indent" > As from version 3.03 you can now use the package option <span class="cmss-10">nopostdot</span><a - id="dx1-78043"></a> to suppress this full -stop. This is the better option if you want to use the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-78044"></a> package. The -<span + id="dx1-156042"></a> to suppress this full stop. This is the +better option if you want to use the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package. The <span class="cmss-10">glossaries-extra-stylemods</span><a - id="dx1-78045"></a> package provides some adjustments some of to the predefined styles -listed here, allowing for greater flexibility. See the <span -class="cmss-10">glossaries-extra</span><a - id="dx1-78046"></a> documentation for further -details. + id="dx1-156043"></a> package provides +some adjustments some of to the predefined styles listed here, allowing for greater flexibility. See the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> documentation for further details. </p> -<!--l. 11047--><p class="noindent" ><a +<!--l. 12045--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.1 </span> <a id="sec:liststyles"></a>List Styles</h4> -<!--l. 11050--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12048--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-list</span><a - id="dx1-79001"></a>. Since -they all use the <span + id="dx1-157001"></a>. Since they all use the <span class="cmss-10">description</span><a - id="dx1-79002"></a><a - id="dx1-79003"></a> environment, they are governed by the same parameters -as that environment. These styles all ignore the entry’s symbol. Note that these -styles will automatically be available unless you use the <span + id="dx1-157002"></a><a + id="dx1-157003"></a> +environment, they are governed by the same parameters as that environment. These styles all ignore the entry’s +symbol. Note that these styles will automatically be available unless you use the <span class="cmss-10">nolist</span><a - id="dx1-79004"></a> or <span + id="dx1-157004"></a> or <span class="cmss-10">nostyles</span><a - id="dx1-79005"></a> package + id="dx1-157005"></a> package options. -</p><!--l. 11057--><p class="indent" > <div class="important" title="Important Note"> Note that, except for the <span +</p><!--l. 12055--><p class="indent" > <div class="important" title="Important Note"> Note that, except for the <span class="cmss-10">listdotted</span><a - id="dx1-79006"></a> style, these list styles are incompatible with -<span + id="dx1-157006"></a> style, these list styles are incompatible with <span class="cmss-10">classicthesis</span><a - id="dx1-79007"></a>. They may also be incompatible with other classes or packages that modify the -<span + id="dx1-157007"></a>. They +may also be incompatible with other classes or packages that modify the <span class="cmss-10">description</span><a - id="dx1-79008"></a><a - id="dx1-79009"></a> environment. </div> -</p><!--l. 11062--><p class="noindent" > + id="dx1-157008"></a><a + id="dx1-157009"></a> environment. +</div> +</p><!--l. 12060--><p class="noindent" > </p><dl class="description"><dt class="description"> <span class="cmbx-10">list</span> </dt><dd class="description">The <span class="cmss-10">list</span><a - id="dx1-79010"></a> style uses the <span + id="dx1-157010"></a> style uses the <span class="cmss-10">description</span><a - id="dx1-79011"></a><a - id="dx1-79012"></a> environment. The entry name is placed in the - optional argument of the <span + id="dx1-157011"></a><a + id="dx1-157012"></a> environment. The entry name is placed in the optional argument of + the <span class="cmtt-10">\item</span><a - id="dx1-79013"></a> command (so it will usually appear in bold by - default). The description follows, and then the associated <a + id="dx1-157013"></a> command (so it will usually appear in bold by default). The description follows, and then + the associated <a href="#glo:numberlist">number list<a - id="dx1-79014"></a></a> for that - entry. The symbol is ignored. If the entry has child entries, the description and - number list follows (but not the name) for each child entry. Groups are separated + id="dx1-157014"></a></a> for that entry. The symbol is ignored. If the entry has child entries, the + description and number list follows (but not the name) for each child entry. Groups are separated using <span class="cmtt-10">\indexspace</span><a - id="dx1-79015"></a>. - - - <!--l. 11073--><p class="noindent" >The closest matching non-list style is the <span + id="dx1-157015"></a>. + <!--l. 12071--><p class="noindent" >The closest matching non-list style is the <span class="cmss-10">index</span><a - id="dx1-79016"></a> style. + id="dx1-157016"></a> style. </p></dd><dt class="description"> <span class="cmbx-10">listgroup</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">listgroup</span><a - id="dx1-79017"></a> style is like <span + id="dx1-157017"></a> style is like <span class="cmss-10">list</span><a - id="dx1-79018"></a> but the glossary groups have headings obtained - using <span + id="dx1-157018"></a> but the glossary groups have headings obtained using + <span class="cmtt-10">\glsgetgrouptitle{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>, which is described in <a -href="#sec:newglossarystyle"><span -class="tcrm-1000">§</span>15.2 </a><a -href="#sec:newglossarystyle">Defining your own - glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>. +href="#sec:newglossarystyle">§15.2 </a><a +href="#sec:newglossarystyle">Defining your own glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>. + + </dd><dt class="description"> <span class="cmbx-10">listhypergroup</span> </dt><dd class="description">The <span class="cmss-10">listhypergroup</span><a - id="dx1-79019"></a> style is like <span + id="dx1-157019"></a> style is like <span class="cmss-10">listgroup</span><a - id="dx1-79020"></a> but has a navigation line - at the start of the glossary with links to each group that is present in the - glossary. This requires an additional run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> to ensure the group - information is up to date. In the navigation line, each group is separated + id="dx1-157020"></a> but has a navigation line at the start of the glossary + with links to each group that is present in the glossary. This requires an additional run through + <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> to ensure the group information is up to date. In the navigation line, each group is separated by - <!--l. 11086--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glshypernavsep</span><span -class="cmtt-9"> </span></span><a - id="dx1-79021"></a> <span + <!--l. 12084--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-157021"></a> <span class="cmtt-10">\glshypernavsep </span></div><hr> - </p><!--l. 11088--><p class="noindent" > - which defaults to a vertical bar with a space on either side. For example, to simply have - a space separating each group, do: - - + </p><!--l. 12086--><p class="noindent" > + which defaults to a vertical bar with a space on either side. For example, to simply have a space separating + each group, do: + + </p> - <div class="verbatim" id="verbatim-363"> + <div class="verbatim" id="verbatim-362"> \renewcommand*{\glshypernavsep}{\space} </div> - <!--l. 11093--><p class="nopar" > - </p><!--l. 11095--><p class="noindent" >Note that the hyper-navigation line is now (as from version 1.14) set inside the optional + <!--l. 12091--><p class="nopar" > + </p><!--l. 12093--><p class="noindent" >Note that the hyper-navigation line is now (as from version 1.14) set inside the optional argument to <span class="cmtt-10">\item</span><a - id="dx1-79022"></a> 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 - </p><!--l. 11100--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslistnavigationitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-79023"></a> <span + id="dx1-157022"></a> 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 + </p><!--l. 12098--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-157023"></a> <span class="cmtt-10">\glslistnavigationitem{</span>⟨<span class="cmitt-10">navigation line</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 11102--><p class="noindent" > + </p><!--l. 12100--><p class="noindent" > The default definition is <span class="cmtt-10">\item[</span>⟨<span class="cmti-10">navigation line</span>⟩<span -class="cmtt-10">] </span>but may be redefined independently of - setting the style. For example: - - +class="cmtt-10">] </span>but may be redefined independently of setting the style. + For example: + + </p> - <div class="verbatim" id="verbatim-364"> + <div class="verbatim" id="verbatim-363"> \renewcommand*{\glslistnavigationitem}[1]{\item \textbf{#1}} </div> - <!--l. 11107--><p class="nopar" > - </p><!--l. 11109--><p class="noindent" >You may prefer to use the tree-like styles, such as <span + <!--l. 12105--><p class="nopar" > + </p><!--l. 12107--><p class="noindent" >You may prefer to use the tree-like styles, such as <span class="cmss-10">treehypergroup</span><a - id="dx1-79024"></a> instead. + id="dx1-157024"></a> instead. </p></dd><dt class="description"> <span class="cmbx-10">altlist</span> </dt><dd class="description">The <span class="cmss-10">altlist</span><a - id="dx1-79025"></a> style is like <span + id="dx1-157025"></a> style is like <span class="cmss-10">list</span><a - id="dx1-79026"></a> but the description starts on the line following the name. - (As with the <span + id="dx1-157026"></a> but the description starts on the line following the name. (As with the <span class="cmss-10">list</span><a - id="dx1-79027"></a> style, the symbol is ignored.) Each child entry starts a new - line, but as with the <span + id="dx1-157027"></a> + style, the symbol is ignored.) Each child entry starts a new line, but as with the <span class="cmss-10">list</span><a - id="dx1-79028"></a> style, the name associated with each child entry is - ignored. - <!--l. 11118--><p class="noindent" >The closest matching non-list style is the <span + id="dx1-157028"></a> style, the name + associated with each child entry is ignored. + <!--l. 12116--><p class="noindent" >The closest matching non-list style is the <span class="cmss-10">index</span><a - id="dx1-79029"></a> style with the following adjustment: - - + id="dx1-157029"></a> style with the following adjustment: + + </p> - <div class="verbatim" id="verbatim-365"> + <div class="verbatim" id="verbatim-364"> \renewcommand{\glstreepredesc}{%  <br /> \glstreeitem\parindent\hangindent} </div> - <!--l. 11123--><p class="nopar" > + <!--l. 12121--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">altlistgroup</span> </dt><dd class="description">The <span class="cmss-10">altlistgroup</span><a - id="dx1-79030"></a> style is like <span + id="dx1-157030"></a> style is like <span class="cmss-10">altlist</span><a - id="dx1-79031"></a> but the glossary groups have headings. + id="dx1-157031"></a> but the glossary groups have headings. </dd><dt class="description"> <span class="cmbx-10">altlisthypergroup</span> </dt><dd class="description">The <span class="cmss-10">altlisthypergroup</span><a - id="dx1-79032"></a> style is like <span + id="dx1-157032"></a> style is like <span class="cmss-10">altlistgroup</span><a - id="dx1-79033"></a> but has a set of links to the - glossary groups. The navigation line is the same as that for <span + id="dx1-157033"></a> but has a set of links to the glossary groups. + The navigation line is the same as that for <span class="cmss-10">listhypergroup</span><a - id="dx1-79034"></a>, described - above. + id="dx1-157034"></a>, described above. </dd><dt class="description"> <span class="cmbx-10">listdotted</span> </dt><dd class="description">This style uses the <span class="cmss-10">description</span><a - id="dx1-79035"></a><a - id="dx1-79036"></a> + id="dx1-157035"></a><a + id="dx1-157036"></a> environment.<span class="footnote-mark"><a href="#fn2x15" id="fn2x15-bk"><sup class="textsuperscript">15.2</sup></a></span><a - id="x1-79037f2"></a> + id="x1-157037f2"></a> Each entry starts with <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\item[]</span></span></span>, followed by the name followed by a dotted line, - followed by the description. Note that this style ignores both the <a +class="cmtt-10">\item[]</span></span></span>, followed by the name followed by a dotted line, followed + by the description. Note that this style ignores both the <a href="#glo:numberlist">number list<a - id="dx1-79038"></a></a> and the - symbol. The length - <!--l. 11139--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glslistdottedwidth</span><span -class="cmtt-9"> </span></span><a - id="dx1-79039"></a> <span + id="dx1-157038"></a></a> and the symbol. The + length + <!--l. 12137--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-157039"></a> <span class="cmtt-10">\glslistdottedwidth </span></div><hr> - </p><!--l. 11141--><p class="noindent" > - governs where the description should start. This is a flat style, so child entries are - formatted in the same way as the parent entries. - </p><!--l. 11145--><p class="noindent" >A non-list alternative is to use the <span + </p><!--l. 12139--><p class="noindent" > + governs where the description should start. This is a flat style, so child entries are formatted in the same + way as the parent entries. + </p><!--l. 12143--><p class="noindent" >A non-list alternative is to use the <span class="cmss-10">index</span><a - id="dx1-79040"></a> style with - - + id="dx1-157040"></a> style with + + </p> - <div class="verbatim" id="verbatim-366"> + <div class="verbatim" id="verbatim-365"> \renewcommand{\glstreepredesc}{\dotfill}  <br />\renewcommand{\glstreechildpredesc}{\dotfill} </div> - <!--l. 11150--><p class="nopar" > Note that this doesn’t use <span -class="cmtt-10">\glslistdottedwidth </span>and causes the description - to be flush-right and will display the symbol, if provided. (It also doesn’t - suppress the number list<a - id="dx1-79041"></a>, but that can be achieved with the <span + <!--l. 12148--><p class="nopar" > Note that this doesn’t use <span +class="cmtt-10">\glslistdottedwidth </span>and causes the description to be flush-right and will + display the symbol, if provided. (It also doesn’t suppress the number list<a + id="dx1-157041"></a>, but that can be achieved with + the <span class="cmss-10">nonumberlist</span><a - id="dx1-79042"></a> - option.) + id="dx1-157042"></a> option.) </p></dd><dt class="description"> <span class="cmbx-10">sublistdotted</span> </dt><dd class="description">This is a variation on the <span class="cmss-10">listdotted</span><a - id="dx1-79043"></a> style designed for hierarchical glossaries. - The main entries have just the name displayed. The sub entries are displayed in the - same manner as <span + id="dx1-157043"></a> style designed for hierarchical glossaries. The main entries + have just the name displayed. The sub entries are displayed in the same manner as <span class="cmss-10">listdotted</span><a - id="dx1-79044"></a>. Unlike the <span -class="cmss-10">listdotted</span><a - id="dx1-79045"></a> style, this style is incompatible with + id="dx1-157044"></a>. Unlike the <span +class="cmss-10">listdotted</span><a + id="dx1-157045"></a> style, this style is incompatible with <span class="cmss-10">classicthesis</span><a - id="dx1-79046"></a>.</dd></dl> -<!--l. 11166--><p class="noindent" > + id="dx1-157046"></a>.</dd></dl> +<!--l. 12164--><p class="noindent" > </p> -<!--l. 11166--><p class="noindent" ><a +<!--l. 12164--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.2 </span> <a id="sec:longstyles"></a>Longtable Styles</h4> -<!--l. 11169--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12167--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-long</span><a - id="dx1-80001"></a>. Since they all -use the <span -class="cmss-10">longtable</span><a - id="dx1-80002"></a><a - id="dx1-80003"></a> environment, they are governed by the same parameters as that -environment. Note that these styles will automatically be available unless you use the + id="dx1-158001"></a>. Since they all use the <span +class="cmss-10">longtable</span><a + id="dx1-158002"></a><a + id="dx1-158003"></a> environment, they are governed by the same parameters as that environment. Note that +these styles will automatically be available unless you use the <span class="cmss-10">nolong</span><a - id="dx1-80004"></a> or <span + id="dx1-158004"></a> or <span class="cmss-10">nostyles</span><a - id="dx1-80005"></a> package options. These styles fully justify the description and page -list columns. If you want ragged right formatting instead, use the analogous styles -described in <a -href="#sec:longraggedstyles"><span -class="tcrm-1000">§</span>15.1.3 </a><a -href="#sec:longraggedstyles">Longtable Styles (Ragged Right)<!--tex4ht:ref: sec:longraggedstyles --></a>. If you want to incorporate rules -from the <span + id="dx1-158005"></a> package options. +These styles fully justify the description and page list columns. If you want ragged right formatting +instead, use the analogous styles described in <a +href="#sec:longraggedstyles">§15.1.3 </a><a +href="#sec:longraggedstyles">Longtable Styles (Ragged Right)<!--tex4ht:ref: sec:longraggedstyles --></a>. If you want to +incorporate rules from the <span class="cmss-10">booktabs</span><a - id="dx1-80006"></a> package, try the styles described in <a -href="#sec:longbooktabsstyles"><span -class="tcrm-1000">§</span>15.1.4 </a><a + id="dx1-158006"></a> package, try the styles described in <a +href="#sec:longbooktabsstyles">§15.1.4 </a><a href="#sec:longbooktabsstyles">Longtable Styles (<span class="cmss-10">booktabs</span>)<!--tex4ht:ref: sec:longbooktabsstyles --></a>. @@ -22637,1374 +24456,1289 @@ class="cmss-10">booktabs</span>)<!--tex4ht:ref: sec:longbooktabsstyles --></a>. class="cmbx-10">long</span> </dt><dd class="description">The <span class="cmss-10">long</span><a - id="dx1-80007"></a> style uses the <span + id="dx1-158007"></a> style uses the <span class="cmss-10">longtable</span><a - id="dx1-80008"></a><a - id="dx1-80009"></a> environment (defined by the <span + id="dx1-158008"></a><a + id="dx1-158009"></a> environment (defined by the <span class="cmss-10">longtable</span><a - id="dx1-80010"></a> package). - It has two columns: the first column contains the entry’s name and the second - column contains the description followed by the <a + id="dx1-158010"></a> package). It has two columns: + the first column contains the entry’s name and the second column contains the description followed + by the <a href="#glo:numberlist">number list<a - id="dx1-80011"></a></a>. The entry’s symbol is - ignored. Sub groups are separated with a blank row. The width of the first column - is governed by the widest entry in that column. The width of the second column - is governed by the length <span + id="dx1-158011"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a blank row. The + width of the first column is governed by the widest entry in that column. The width of the second + column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-80012"></a>. Child entries have a similar format to - the parent entries except that their name is suppressed. + id="dx1-158012"></a>. Child entries have a similar format to the parent + entries except that their name is suppressed. </dd><dt class="description"> <span class="cmbx-10">longborder</span> </dt><dd class="description">The <span class="cmss-10">longborder</span><a - id="dx1-80013"></a> style is like <span + id="dx1-158013"></a> style is like <span class="cmss-10">long</span><a - id="dx1-80014"></a> but has horizontal and vertical lines around - it. - - + id="dx1-158014"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">longheader</span> </dt><dd class="description">The <span class="cmss-10">longheader</span><a - id="dx1-80015"></a> style is like <span + id="dx1-158015"></a> style is like <span class="cmss-10">long</span><a - id="dx1-80016"></a> but has a header row. + id="dx1-158016"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">longheaderborder</span> </dt><dd class="description">The <span class="cmss-10">longheaderborder</span><a - id="dx1-80017"></a> style is like <span + id="dx1-158017"></a> style is like <span class="cmss-10">longheader</span><a - id="dx1-80018"></a> but has horizontal - and vertical lines around it. + id="dx1-158018"></a> but has horizontal and vertical lines + around it. + + </dd><dt class="description"> <span class="cmbx-10">long3col</span> </dt><dd class="description">The <span class="cmss-10">long3col</span><a - id="dx1-80019"></a> style is like <span + id="dx1-158019"></a> style is like <span class="cmss-10">long</span><a - id="dx1-80020"></a> but has three columns. The first column contains - the entry’s name, the second column contains the description and the third column - contains the <a + id="dx1-158020"></a> but has three columns. The first column contains the entry’s + name, the second column contains the description and the third column contains the <a href="#glo:numberlist">number list<a - id="dx1-80021"></a></a>. The entry’s symbol is ignored. The width of the first - column is governed by the widest entry in that column, the width of the second - column is governed by the length <span + id="dx1-158021"></a></a>. + The entry’s symbol is ignored. The width of the first column is governed by the widest entry in + that column, the width of the second column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-80022"></a>, and the width of the third - column is governed by the length <span + id="dx1-158022"></a>, and the + width of the third column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-80023"></a>. + id="dx1-158023"></a>. </dd><dt class="description"> <span class="cmbx-10">long3colborder</span> </dt><dd class="description">The <span class="cmss-10">long3colborder</span><a - id="dx1-80024"></a> style is like the <span + id="dx1-158024"></a> style is like the <span class="cmss-10">long3col</span><a - id="dx1-80025"></a> style but has horizontal - and vertical lines around it. + id="dx1-158025"></a> style but has horizontal and vertical lines + around it. </dd><dt class="description"> <span class="cmbx-10">long3colheader</span> </dt><dd class="description">The <span class="cmss-10">long3colheader</span><a - id="dx1-80026"></a> style is like <span + id="dx1-158026"></a> style is like <span class="cmss-10">long3col</span><a - id="dx1-80027"></a> but has a header row. + id="dx1-158027"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">long3colheaderborder</span> </dt><dd class="description">The <span class="cmss-10">long3colheaderborder</span><a - id="dx1-80028"></a> style is like <span + id="dx1-158028"></a> style is like <span class="cmss-10">long3colheader</span><a - id="dx1-80029"></a> but has - horizontal and vertical lines around it. + id="dx1-158029"></a> but has horizontal and + vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">long4col</span> </dt><dd class="description">The <span class="cmss-10">long4col</span><a - id="dx1-80030"></a> style is like <span + id="dx1-158030"></a> style is like <span class="cmss-10">long3col</span><a - id="dx1-80031"></a> but has an additional column in which - the entry’s associated symbol appears. This style is used for brief single line - descriptions. The column widths are governed by the widest entry in the given - column. Use <span + id="dx1-158031"></a> but has an additional column in which the entry’s associated + symbol appears. This style is used for brief single line descriptions. The column widths are governed + by the widest entry in the given column. Use <span class="cmss-10">altlong4col</span><a - id="dx1-80032"></a> for multi-line descriptions. + id="dx1-158032"></a> for multi-line descriptions. </dd><dt class="description"> <span class="cmbx-10">long4colborder</span> </dt><dd class="description">The <span class="cmss-10">long4colborder</span><a - id="dx1-80033"></a> style is like the <span + id="dx1-158033"></a> style is like the <span class="cmss-10">long4col</span><a - id="dx1-80034"></a> style but has horizontal - and vertical lines around it. + id="dx1-158034"></a> style but has horizontal and vertical lines + around it. </dd><dt class="description"> <span class="cmbx-10">long4colheader</span> </dt><dd class="description">The <span class="cmss-10">long4colheader</span><a - id="dx1-80035"></a> style is like <span + id="dx1-158035"></a> style is like <span class="cmss-10">long4col</span><a - id="dx1-80036"></a> but has a header row. + id="dx1-158036"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">long4colheaderborder</span> </dt><dd class="description">The <span class="cmss-10">long4colheaderborder</span><a - id="dx1-80037"></a> style is like <span + id="dx1-158037"></a> style is like <span class="cmss-10">long4colheader</span><a - id="dx1-80038"></a> but has - horizontal and vertical lines around it. + id="dx1-158038"></a> but has horizontal and + vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">altlong4col</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlong4col</span><a - id="dx1-80039"></a> style is like <span + id="dx1-158039"></a> style is like <span class="cmss-10">long4col</span><a - id="dx1-80040"></a> but allows multi-line descriptions - and page lists. The width of the description column is governed by the length - <span + id="dx1-158040"></a> but allows multi-line descriptions and page lists. The + width of the description column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-80041"></a> and the width of the page list column is governed by the length - <span + id="dx1-158041"></a> and the width of the page + list column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-80042"></a>. The widths of the name and symbol columns are governed - by the widest entry in the given column. - - + id="dx1-158042"></a>. The widths of the name and symbol + columns are governed by the widest entry in the given column. </dd><dt class="description"> <span class="cmbx-10">altlong4colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlong4colborder</span><a - id="dx1-80043"></a> style is like the <span + id="dx1-158043"></a> style is like the <span class="cmss-10">long4colborder</span><a - id="dx1-80044"></a> but allows - multi-line descriptions and page lists. + id="dx1-158044"></a> but allows multi-line + descriptions and page lists. </dd><dt class="description"> <span class="cmbx-10">altlong4colheader</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlong4colheader</span><a - id="dx1-80045"></a> style is like <span + id="dx1-158045"></a> style is like <span class="cmss-10">long4colheader</span><a - id="dx1-80046"></a> but allows - multi-line descriptions and page lists. + id="dx1-158046"></a> but allows multi-line descriptions + and page lists. </dd><dt class="description"> <span class="cmbx-10">altlong4colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlong4colheaderborder</span><a - id="dx1-80047"></a> style is like - <span + id="dx1-158047"></a> style is like <span class="cmss-10">long4colheaderborder</span><a - id="dx1-80048"></a> but allows multi-line descriptions and page lists.</dd></dl> -<!--l. 11263--><p class="noindent" > + id="dx1-158048"></a> but allows + multi-line descriptions and page lists.</dd></dl> + + +<!--l. 12261--><p class="noindent" > </p> -<!--l. 11263--><p class="noindent" ><a +<!--l. 12261--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.3 </span> <a id="sec:longraggedstyles"></a>Longtable Styles (Ragged Right)</h4> -<!--l. 11266--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12264--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-longragged</span><a - id="dx1-81001"></a>. These -styles are analogous to those defined in <span + id="dx1-159001"></a>. These styles are analogous +to those defined in <span class="cmss-10">glossary-long</span><a - id="dx1-81002"></a> but the multiline columns are left -justified instead of fully justified. Since these styles all use the <span + id="dx1-159002"></a> but the multiline columns are left justified instead of fully justified. Since these +styles all use the <span class="cmss-10">longtable</span><a - id="dx1-81003"></a><a - id="dx1-81004"></a> environment, they are -governed by the same parameters as that environment. The <span + id="dx1-159003"></a><a + id="dx1-159004"></a> environment, they are governed by the same parameters as that environment. The +<span class="cmss-10">glossary-longragged</span><a - id="dx1-81005"></a> package -additionally requires the <span + id="dx1-159005"></a> package additionally requires the <span class="cmss-10">array</span><a - id="dx1-81006"></a> package. Note that these styles will only be available if you -explicitly load <span + id="dx1-159006"></a> package. Note that these styles will only be available +if you explicitly load <span class="cmss-10">glossary-longragged</span><a - id="dx1-81007"></a>: - - + id="dx1-159007"></a>: + + </p> - <div class="verbatim" id="verbatim-367"> + <div class="verbatim" id="verbatim-366"> \usepackage{glossaries}  <br />\usepackage{glossary-longragged} </div> -<!--l. 11278--><p class="nopar" > Note that you can’t set these styles using the <span +<!--l. 12276--><p class="nopar" > Note that you can’t set these styles using the <span class="cmss-10">style</span><a - id="dx1-81008"></a> package option since the styles aren’t -defined until after the <span -class="cmss-10">glossaries </span>package has been loaded. If you want to incorporate rules -from the <span + id="dx1-159008"></a> package option since the styles aren’t defined until after the +<span +class="cmss-10">glossaries </span>package has been loaded. If you want to incorporate rules from the <span class="cmss-10">booktabs</span><a - id="dx1-81009"></a> package, try the styles described in <a -href="#sec:longbooktabsstyles"><span -class="tcrm-1000">§</span>15.1.4 </a><a -href="#sec:longbooktabsstyles">Longtable Styles -(<span + id="dx1-159009"></a> package, try the styles +described in <a +href="#sec:longbooktabsstyles">§15.1.4 </a><a +href="#sec:longbooktabsstyles">Longtable Styles (<span class="cmss-10">booktabs</span>)<!--tex4ht:ref: sec:longbooktabsstyles --></a>. </p><dl class="description"><dt class="description"> <span class="cmbx-10">longragged</span> </dt><dd class="description">The <span class="cmss-10">longragged</span><a - id="dx1-81010"></a> style has two columns: the first column contains the entry’s - name and the second column contains the (left-justified) description followed by - the <a + id="dx1-159010"></a> style has two columns: the first column contains the entry’s name and the + second column contains the (left-justified) description followed by the <a href="#glo:numberlist">number list<a - id="dx1-81011"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a - blank row. The width of the first column is governed by the widest entry in that - column. The width of the second column is governed by the length <span + id="dx1-159011"></a></a>. The entry’s + symbol is ignored. Sub groups are separated with a blank row. The width of the first column is + governed by the widest entry in that column. The width of the second column is governed by the + length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-81012"></a>. - Child entries have a similar format to the parent entries except that their name - is suppressed. + id="dx1-159012"></a>. Child entries have a similar format to the parent entries except that their + name is suppressed. </dd><dt class="description"> <span class="cmbx-10">longraggedborder</span> </dt><dd class="description">The <span class="cmss-10">longraggedborder</span><a - id="dx1-81013"></a> style is like <span + id="dx1-159013"></a> style is like <span class="cmss-10">longragged</span><a - id="dx1-81014"></a> but has horizontal - and vertical lines around it. + id="dx1-159014"></a> but has horizontal and vertical lines + around it. </dd><dt class="description"> <span class="cmbx-10">longraggedheader</span> </dt><dd class="description">The <span class="cmss-10">longraggedheader</span><a - id="dx1-81015"></a> style is like <span + id="dx1-159015"></a> style is like <span class="cmss-10">longragged</span><a - id="dx1-81016"></a> but has a header row. + id="dx1-159016"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">longraggedheaderborder</span> </dt><dd class="description">The <span class="cmss-10">longraggedheaderborder</span><a - id="dx1-81017"></a> style is like <span + id="dx1-159017"></a> style is like <span class="cmss-10">longraggedheader</span><a - id="dx1-81018"></a> - but has horizontal and vertical lines around it. + id="dx1-159018"></a> but has horizontal + and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">longragged3col</span> </dt><dd class="description">The <span class="cmss-10">longragged3col</span><a - id="dx1-81019"></a> style is like <span + id="dx1-159019"></a> style is like <span class="cmss-10">longragged</span><a - id="dx1-81020"></a> but has three columns. - The first column contains the entry’s name, the second column contains the (left - justified) description and the third column contains the (left justified) <a -href="#glo:numberlist">number - list<a - id="dx1-81021"></a></a>. The entry’s symbol is ignored. The width of the first column is governed by - the widest entry in that column, the width of the second column is governed by - the length <span + id="dx1-159020"></a> but has three columns. The first column + contains the entry’s name, the second column contains the (left justified) description and the third + column contains the (left justified) <a +href="#glo:numberlist">number list<a + id="dx1-159021"></a></a>. The entry’s symbol is ignored. The width of the + first column is governed by the widest entry in that column, the width of the second column is + governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-81022"></a>, and the width of the third column is governed by the + id="dx1-159022"></a>, and the width of the third column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-81023"></a>. + id="dx1-159023"></a>. </dd><dt class="description"> <span class="cmbx-10">longragged3colborder</span> </dt><dd class="description">The <span class="cmss-10">longragged3colborder</span><a - id="dx1-81024"></a> style is like the <span + id="dx1-159024"></a> style is like the <span class="cmss-10">longragged3col</span><a - id="dx1-81025"></a> style - but has horizontal and vertical lines around it. + id="dx1-159025"></a> style but has horizontal + and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">longragged3colheader</span> </dt><dd class="description">The <span class="cmss-10">longragged3colheader</span><a - id="dx1-81026"></a> style is like <span + id="dx1-159026"></a> style is like <span class="cmss-10">longragged3col</span><a - id="dx1-81027"></a> but has - a header row. - - + id="dx1-159027"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">longragged3colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">longragged3colheaderborder</span><a - id="dx1-81028"></a> style is like - <span + id="dx1-159028"></a> style is like <span class="cmss-10">longragged3colheader</span><a - id="dx1-81029"></a> but has horizontal and vertical lines around it. + id="dx1-159029"></a> but + has horizontal and vertical lines around it. + + </dd><dt class="description"> <span class="cmbx-10">altlongragged4col</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlongragged4col</span><a - id="dx1-81030"></a> style is like <span + id="dx1-159030"></a> style is like <span class="cmss-10">longragged3col</span><a - id="dx1-81031"></a> but has an - additional column in which the entry’s associated symbol appears. The width of - the description column is governed by the length <span + id="dx1-159031"></a> but has an additional column in + which the entry’s associated symbol appears. The width of the description column is governed + by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-81032"></a> and the width of - the page list column is governed by the length <span + id="dx1-159032"></a> and the width of the page list column is governed by the length + <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-81033"></a>. The widths - of the name and symbol columns are governed by the widest entry in the given - column. + id="dx1-159033"></a>. The widths of the name and symbol columns are governed by the widest + entry in the given column. </dd><dt class="description"> <span class="cmbx-10">altlongragged4colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlongragged4colborder</span><a - id="dx1-81034"></a> style is like the - <span + id="dx1-159034"></a> style is like the <span class="cmss-10">altlongragged4col</span><a - id="dx1-81035"></a> but has horizontal and vertical lines around it. + id="dx1-159035"></a> but has + horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">altlongragged4colheader</span> </dt><dd class="description">The <span class="cmss-10">altlongragged4colheader</span><a - id="dx1-81036"></a> style is like <span + id="dx1-159036"></a> style is like <span class="cmss-10">altlongragged4col</span><a - id="dx1-81037"></a> - but has a header row. + id="dx1-159037"></a> but has a header + row. </dd><dt class="description"> <span class="cmbx-10">altlongragged4colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altlongragged4colheaderborder</span><a - id="dx1-81038"></a> style is like + id="dx1-159038"></a> style is like <span class="cmss-10">altlongragged4colheader</span><a - id="dx1-81039"></a> but has horizontal and vertical lines around it. + id="dx1-159039"></a> but has horizontal and vertical lines around it. </dd></dl> -<!--l. 11351--><p class="noindent" > +<!--l. 12349--><p class="noindent" > </p> -<!--l. 11351--><p class="noindent" ><a +<!--l. 12349--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.4 </span> <a id="sec:longbooktabsstyles"></a>Longtable Styles (<span class="cmss-10">booktabs</span>)</h4> -<!--l. 11354--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12352--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-longbooktabs</span><a - id="dx1-82001"></a>. -</p><!--l. 11357--><p class="indent" > Since these styles all use the <span + id="dx1-160001"></a>. +</p><!--l. 12355--><p class="indent" > Since these styles all use the <span class="cmss-10">longtable</span><a - id="dx1-82002"></a><a - id="dx1-82003"></a> environment, they are governed by the same -parameters as that environment. The <span + id="dx1-160002"></a><a + id="dx1-160003"></a> environment, they are governed by the same parameters as that +environment. The <span class="cmss-10">glossary-longbooktabs</span><a - id="dx1-82004"></a> package automatically loads the -<span + id="dx1-160004"></a> package automatically loads the <span class="cmss-10">glossary-long</span><a - id="dx1-82005"></a> (<a -href="#sec:longstyles"><span -class="tcrm-1000">§</span>15.1.2 </a><a -href="#sec:longstyles">Longtable Styles<!--tex4ht:ref: sec:longstyles --></a>) and <span + id="dx1-160005"></a> (<a +href="#sec:longstyles">§15.1.2 </a><a +href="#sec:longstyles">Longtable Styles<!--tex4ht:ref: sec:longstyles --></a>) +and <span class="cmss-10">glossary-longragged</span><a - id="dx1-82006"></a> (<a -href="#sec:longraggedstyles"><span -class="tcrm-1000">§</span>15.1.3 </a><a -href="#sec:longraggedstyles">Longtable Styles -(Ragged Right)<!--tex4ht:ref: sec:longraggedstyles --></a>) packages. Note that these styles will only be available if you explicitly load -<span + id="dx1-160006"></a> (<a +href="#sec:longraggedstyles">§15.1.3 </a><a +href="#sec:longraggedstyles">Longtable Styles (Ragged Right)<!--tex4ht:ref: sec:longraggedstyles --></a>) packages. Note that these styles will only be +available if you explicitly load <span class="cmss-10">glossary-longbooktabs</span><a - id="dx1-82007"></a>: - - + id="dx1-160007"></a>: + + </p> - <div class="verbatim" id="verbatim-368"> + <div class="verbatim" id="verbatim-367"> \usepackage{glossaries}  <br />\usepackage{glossary-longbooktabs} </div> -<!--l. 11368--><p class="nopar" > Note that you can’t set these styles using the <span +<!--l. 12366--><p class="nopar" > Note that you can’t set these styles using the <span class="cmss-10">style</span><a - id="dx1-82008"></a> package option since the styles aren’t -defined until after the <span + id="dx1-160008"></a> package option since the styles aren’t defined until after the +<span class="cmss-10">glossaries </span>package has been loaded. -</p><!--l. 11373--><p class="indent" > These styles are similar to the “header” styles in the <span +</p><!--l. 12371--><p class="indent" > These styles are similar to the “header” styles in the <span class="cmss-10">glossary-long</span><a - id="dx1-82009"></a> and <span + id="dx1-160009"></a> and <span class="cmss-10">glossary-ragged</span><a - id="dx1-82010"></a> -packages, but they add the rules provided by the <span + id="dx1-160010"></a> packages, but they add +the rules provided by the <span class="cmss-10">booktabs</span><a - id="dx1-82011"></a> package, <span + id="dx1-160011"></a> package, <span class="cmtt-10">\toprule</span><a - id="dx1-82012"></a>, <span + id="dx1-160012"></a>, <span class="cmtt-10">\midrule</span><a - id="dx1-82013"></a> and -<span + id="dx1-160013"></a> and <span class="cmtt-10">\bottomrule</span><a - id="dx1-82014"></a>. Additionally these styles patch the <span + id="dx1-160014"></a>. Additionally these styles +patch the <span class="cmss-10">longtable</span><a - id="dx1-82015"></a><a - id="dx1-82016"></a> environment to check for instances -of the group skip occurring at a page break. If you don’t want this patch to affect any other -use of <span + id="dx1-160015"></a><a + id="dx1-160016"></a> environment to check for instances of the group skip occurring at a page break. If you don’t +want this patch to affect any other use of <span class="cmss-10">longtable</span><a - id="dx1-82017"></a><a - id="dx1-82018"></a> in your document, you can scope the effect by only setting the style through -the <span -class="cmss-10">style</span><a - id="dx1-82019"></a> key in the optional argument of <span + id="dx1-160017"></a><a + id="dx1-160018"></a> in your document, you can scope the effect by only setting +the style through the <span +class="cmtt-10">style</span><a + id="dx1-160019"></a> key in the optional argument of <span class="cmtt-10">\printglossary</span>. (The <span class="cmss-10">nogroupskip</span><a - id="dx1-82020"></a> package option + id="dx1-160020"></a> package option is checked by these styles.) -</p><!--l. 11386--><p class="indent" > Alternatively, you can restore the original <span +</p><!--l. 12384--><p class="indent" > Alternatively, you can restore the original <span class="cmss-10">longtable</span><a - id="dx1-82021"></a><a - id="dx1-82022"></a> behaviour with: -</p><!--l. 11388--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsrestoreLToutput</span><span -class="cmtt-9"> </span></span><a - id="dx1-82023"></a> <span + id="dx1-160021"></a><a + id="dx1-160022"></a> behaviour with: +</p><!--l. 12386--><p class="indent" > <hr><div title="Definition"><a + id="dx1-160023"></a> <span class="cmtt-10">\glsrestoreLToutput </span></div><hr> -</p><!--l. 11390--><p class="noindent" > +</p><!--l. 12388--><p class="noindent" > For more information about the patch, see the documented code (<span class="cmtt-10">glossaries-code.pdf</span>). </p><dl class="description"><dt class="description"> <span class="cmssbx-10">long-booktabs</span><a - id="dx1-82024"></a> </dt><dd + id="dx1-160024"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">longheader</span><a - id="dx1-82025"></a> style but adds rules above and - below the header (<span + id="dx1-160025"></a> style but adds rules above and below the header + (<span class="cmtt-10">\toprule </span>and <span -class="cmtt-10">\midrule</span>) and inserts a rule at the bottom of - the table (<span +class="cmtt-10">\midrule</span>) and inserts a rule at the bottom of the table (<span class="cmtt-10">\bottomrule</span>). </dd><dt class="description"> <span class="cmssbx-10">long3col-booktabs</span><a - id="dx1-82026"></a> </dt><dd + id="dx1-160026"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">long3colheader</span><a - id="dx1-82027"></a> style but adds rules as - per <span + id="dx1-160027"></a> style but adds rules as per <span class="cmss-10">long-booktabs</span><a - id="dx1-82028"></a>. + id="dx1-160028"></a>. </dd><dt class="description"> <span class="cmssbx-10">long4col-booktabs</span><a - id="dx1-82029"></a> </dt><dd + id="dx1-160029"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">long4colheader</span><a - id="dx1-82030"></a> style but adds rules as - above. + id="dx1-160030"></a> style but adds rules as above. </dd><dt class="description"> <span class="cmssbx-10">altlong4col-booktabs</span><a - id="dx1-82031"></a> </dt><dd + id="dx1-160031"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">altlong4colheader</span><a - id="dx1-82032"></a> style but adds rules - as above. + id="dx1-160032"></a> style but adds rules as above. </dd><dt class="description"> <span class="cmssbx-10">longragged-booktabs</span><a - id="dx1-82033"></a> </dt><dd + id="dx1-160033"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">longraggedheader</span><a - id="dx1-82034"></a> style but adds rules - as above. + id="dx1-160034"></a> style but adds rules as above. </dd><dt class="description"> <span class="cmssbx-10">longragged3col-booktabs</span><a - id="dx1-82035"></a> </dt><dd + id="dx1-160035"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">longragged3colheader</span><a - id="dx1-82036"></a> style but - adds rules as above. - - + id="dx1-160036"></a> style but adds rules as above. </dd><dt class="description"> <span class="cmssbx-10">altlongragged4col-booktabs</span><a - id="dx1-82037"></a> </dt><dd + id="dx1-160037"></a> </dt><dd class="description">This style is similar to the <span class="cmss-10">altlongragged4colheader</span><a - id="dx1-82038"></a> style - but adds rules as above. + id="dx1-160038"></a> style but adds rules as + above. </dd></dl> -<!--l. 11421--><p class="noindent" > + + +<!--l. 12419--><p class="noindent" > </p> -<!--l. 11421--><p class="noindent" ><a +<!--l. 12419--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.5 </span> <a id="sec:superstyles"></a>Supertabular Styles</h4> -<!--l. 11424--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12422--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-super</span><a - id="dx1-83001"></a>. -Since they all use the <span + id="dx1-161001"></a>. Since they all use the +<span class="cmss-10">supertabular</span><a - id="dx1-83002"></a><a - id="dx1-83003"></a> environment, they are governed by the same -parameters as that environment. Note that these styles will automatically be available -unless you use the <span + id="dx1-161002"></a><a + id="dx1-161003"></a> environment, they are governed by the same parameters as that environment. Note that these styles +will automatically be available unless you use the <span class="cmss-10">nosuper</span><a - id="dx1-83004"></a> or <span + id="dx1-161004"></a> or <span class="cmss-10">nostyles</span><a - id="dx1-83005"></a> package options. In general, the <span + id="dx1-161005"></a> package options. In general, +the <span class="cmss-10">longtable</span><a - id="dx1-83006"></a><a - id="dx1-83007"></a> -environment is better, but there are some circumstances where it is better to use + id="dx1-161006"></a><a + id="dx1-161007"></a> environment is better, but there are some circumstances where it is better to use <span class="cmss-10">supertabular</span><a - id="dx1-83008"></a><a - id="dx1-83009"></a>.<span class="footnote-mark"><a + id="dx1-161008"></a><a + id="dx1-161009"></a>.<span class="footnote-mark"><a href="#fn3x15" id="fn3x15-bk"><sup class="textsuperscript">15.3</sup></a></span><a - id="x1-83010f3"></a> -These styles fully justify the description and page list columns. If you want ragged right -formatting instead, use the analogous styles described in <a -href="#sec:superraggedstyles"><span -class="tcrm-1000">§</span>15.1.6 </a><a -href="#sec:superraggedstyles">Supertabular Styles (Ragged -Right)<!--tex4ht:ref: sec:superraggedstyles --></a>. + id="x1-161010f3"></a> +These styles fully justify the description and page list columns. If you want ragged right formatting instead, use +the analogous styles described in <a +href="#sec:superraggedstyles">§15.1.6 </a><a +href="#sec:superraggedstyles">Supertabular Styles (Ragged Right)<!--tex4ht:ref: sec:superraggedstyles --></a>. </p><dl class="description"><dt class="description"> <span class="cmbx-10">super</span> </dt><dd class="description">The <span class="cmss-10">super</span><a - id="dx1-83012"></a> style uses the <span + id="dx1-161012"></a> style uses the <span class="cmss-10">supertabular</span><a - id="dx1-83013"></a><a - id="dx1-83014"></a> environment (defined by the <span + id="dx1-161013"></a><a + id="dx1-161014"></a> environment (defined by the <span class="cmss-10">supertabular</span><a - id="dx1-83015"></a> - package). It has two columns: the first column contains the entry’s name and the - second column contains the description followed by the <a + id="dx1-161015"></a> package). It has two + columns: the first column contains the entry’s name and the second column contains the description + followed by the <a href="#glo:numberlist">number list<a - id="dx1-83016"></a></a>. The entry’s - symbol is ignored. Sub groups are separated with a blank row. The width of the - first column is governed by the widest entry in that column. The width of the - second column is governed by the length <span + id="dx1-161016"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a blank + row. The width of the first column is governed by the widest entry in that column. The width of + the second column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-83017"></a>. Child entries have a - similar format to the parent entries except that their name is suppressed. + id="dx1-161017"></a>. Child entries have a similar format + to the parent entries except that their name is suppressed. </dd><dt class="description"> <span class="cmbx-10">superborder</span> </dt><dd class="description">The <span class="cmss-10">superborder</span><a - id="dx1-83018"></a> style is like <span + id="dx1-161018"></a> style is like <span class="cmss-10">super</span><a - id="dx1-83019"></a> but has horizontal and vertical lines - around it. + id="dx1-161019"></a> but has horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">superheader</span> </dt><dd class="description">The <span class="cmss-10">superheader</span><a - id="dx1-83020"></a> style is like <span + id="dx1-161020"></a> style is like <span class="cmss-10">super</span><a - id="dx1-83021"></a> but has a header row. + id="dx1-161021"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">superheaderborder</span> </dt><dd class="description">The <span class="cmss-10">superheaderborder</span><a - id="dx1-83022"></a> style is like <span + id="dx1-161022"></a> style is like <span class="cmss-10">superheader</span><a - id="dx1-83023"></a> but has horizontal - and vertical lines around it. + id="dx1-161023"></a> but has horizontal and vertical + lines around it. </dd><dt class="description"> <span class="cmbx-10">super3col</span> </dt><dd class="description">The <span class="cmss-10">super3col</span><a - id="dx1-83024"></a> style is like <span + id="dx1-161024"></a> style is like <span class="cmss-10">super</span><a - id="dx1-83025"></a> but has three columns. The first column - contains the entry’s name, the second column contains the description and the - third column contains the <a + id="dx1-161025"></a> but has three columns. The first column contains the entry’s + name, the second column contains the description and the third column contains the <a href="#glo:numberlist">number list<a - id="dx1-83026"></a></a>. The entry’s symbol is ignored. The width - of the first column is governed by the widest entry in that column. The width of - the second column is governed by the length <span + id="dx1-161026"></a></a>. + The entry’s symbol is ignored. The width of the first column is governed by the widest entry in that + column. The width of the second column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-83027"></a>. The width of the - third column is governed by the length <span + id="dx1-161027"></a>. The width of + the third column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-83028"></a>. - - + id="dx1-161028"></a>. </dd><dt class="description"> <span class="cmbx-10">super3colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">super3colborder</span><a - id="dx1-83029"></a> style is like the <span + id="dx1-161029"></a> style is like the <span class="cmss-10">super3col</span><a - id="dx1-83030"></a> style but has - horizontal and vertical lines around it. + id="dx1-161030"></a> style but has horizontal and vertical + lines around it. </dd><dt class="description"> <span class="cmbx-10">super3colheader</span> </dt><dd class="description">The <span class="cmss-10">super3colheader</span><a - id="dx1-83031"></a> style is like <span + id="dx1-161031"></a> style is like <span class="cmss-10">super3col</span><a - id="dx1-83032"></a> but has a header row. + id="dx1-161032"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">super3colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">super3colheaderborder</span><a - id="dx1-83033"></a> style is like the <span + id="dx1-161033"></a> style is like the <span class="cmss-10">super3colheader</span><a - id="dx1-83034"></a> - style but has horizontal and vertical lines around it. + id="dx1-161034"></a> style but has + horizontal and vertical lines around it. + + </dd><dt class="description"> <span class="cmbx-10">super4col</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">super4col</span><a - id="dx1-83035"></a> style is like <span + id="dx1-161035"></a> style is like <span class="cmss-10">super3col</span><a - id="dx1-83036"></a> but has an additional column in which - the entry’s associated symbol appears. This style is designed for entries with brief - single line descriptions. The column widths are governed by the widest entry in - the given column. Use <span + id="dx1-161036"></a> but has an additional column in which the entry’s + associated symbol appears. This style is designed for entries with brief single line descriptions. The + column widths are governed by the widest entry in the given column. Use <span class="cmss-10">altsuper4col</span><a - id="dx1-83037"></a> for multi-line descriptions. + id="dx1-161037"></a> for multi-line + descriptions. </dd><dt class="description"> <span class="cmbx-10">super4colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">super4colborder</span><a - id="dx1-83038"></a> style is like the <span + id="dx1-161038"></a> style is like the <span class="cmss-10">super4col</span><a - id="dx1-83039"></a> style but has - horizontal and vertical lines around it. + id="dx1-161039"></a> style but has horizontal and vertical + lines around it. </dd><dt class="description"> <span class="cmbx-10">super4colheader</span> </dt><dd class="description">The <span class="cmss-10">super4colheader</span><a - id="dx1-83040"></a> style is like <span + id="dx1-161040"></a> style is like <span class="cmss-10">super4col</span><a - id="dx1-83041"></a> but has a header row. + id="dx1-161041"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">super4colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">super4colheaderborder</span><a - id="dx1-83042"></a> style is like the <span + id="dx1-161042"></a> style is like the <span class="cmss-10">super4colheader</span><a - id="dx1-83043"></a> - style but has horizontal and vertical lines around it. + id="dx1-161043"></a> style but has + horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">altsuper4col</span> </dt><dd class="description">The <span class="cmss-10">altsuper4col</span><a - id="dx1-83044"></a> style is like <span + id="dx1-161044"></a> style is like <span class="cmss-10">super4col</span><a - id="dx1-83045"></a> but allows multi-line descriptions - and page lists. The width of the description column is governed by the length - <span + id="dx1-161045"></a> but allows multi-line descriptions and page lists. + The width of the description column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-83046"></a> and the width of the page list column is governed by the length - <span + id="dx1-161046"></a> and the width of + the page list column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-83047"></a>. The width of the name and symbol columns is governed by - the widest entry in the given column. + id="dx1-161047"></a>. The width of the name and + symbol columns is governed by the widest entry in the given column. </dd><dt class="description"> <span class="cmbx-10">altsuper4colborder</span> </dt><dd class="description">The <span class="cmss-10">altsuper4colborder</span><a - id="dx1-83048"></a> style is like the <span + id="dx1-161048"></a> style is like the <span class="cmss-10">super4colborder</span><a - id="dx1-83049"></a> style but - allows multi-line descriptions and page lists. + id="dx1-161049"></a> style but allows multi-line + descriptions and page lists. </dd><dt class="description"> <span class="cmbx-10">altsuper4colheader</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altsuper4colheader</span><a - id="dx1-83050"></a> style is like <span + id="dx1-161050"></a> style is like <span class="cmss-10">super4colheader</span><a - id="dx1-83051"></a> but allows - multi-line descriptions and page lists. + id="dx1-161051"></a> but allows multi-line + descriptions and page lists. </dd><dt class="description"> <span class="cmbx-10">altsuper4colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altsuper4colheaderborder</span><a - id="dx1-83052"></a> style is like - <span + id="dx1-161052"></a> style is like <span class="cmss-10">super4colheaderborder</span><a - id="dx1-83053"></a> but allows multi-line descriptions and page lists.</dd></dl> - - -<!--l. 11520--><p class="noindent" > + id="dx1-161053"></a> but allows + multi-line descriptions and page lists.</dd></dl> +<!--l. 12518--><p class="noindent" > </p> -<!--l. 11520--><p class="noindent" ><a +<!--l. 12518--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.6 </span> <a id="sec:superraggedstyles"></a>Supertabular Styles (Ragged Right)</h4> -<!--l. 11523--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12521--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-superragged</span><a - id="dx1-84001"></a>. These -styles are analogous to those defined in <span + id="dx1-162001"></a>. These styles are +analogous to those defined in <span class="cmss-10">glossary-super</span><a - id="dx1-84002"></a> but the multiline columns are left -justified instead of fully justified. Since these styles all use the <span + id="dx1-162002"></a> but the multiline columns are left justified instead of fully justified. +Since these styles all use the <span class="cmss-10">supertabular</span><a - id="dx1-84003"></a><a - id="dx1-84004"></a> environment, they -are governed by the same parameters as that environment. The <span + id="dx1-162003"></a><a + id="dx1-162004"></a> environment, they are governed by the same parameters as that +environment. The <span class="cmss-10">glossary-superragged</span><a - id="dx1-84005"></a> package -additionally requires the <span + id="dx1-162005"></a> package additionally requires the <span class="cmss-10">array</span><a - id="dx1-84006"></a> package. Note that these styles will only be available if you -explicitly load <span + id="dx1-162006"></a> package. Note that these styles +will only be available if you explicitly load <span class="cmss-10">glossary-superragged</span><a - id="dx1-84007"></a>: - - + id="dx1-162007"></a>: + + </p> - <div class="verbatim" id="verbatim-369"> + <div class="verbatim" id="verbatim-368"> \usepackage{glossaries}  <br />\usepackage{glossary-superragged} </div> -<!--l. 11535--><p class="nopar" > Note that you can’t set these styles using the <span +<!--l. 12533--><p class="nopar" > Note that you can’t set these styles using the <span class="cmss-10">style</span><a - id="dx1-84008"></a> package option since the styles aren’t -defined until after the <span + id="dx1-162008"></a> package option since the styles aren’t defined until after the +<span class="cmss-10">glossaries </span>package has been loaded. </p><dl class="description"><dt class="description"> <span class="cmbx-10">superragged</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">superragged</span><a - id="dx1-84009"></a> style uses the <span + id="dx1-162009"></a> style uses the <span class="cmss-10">supertabular</span><a - id="dx1-84010"></a><a - id="dx1-84011"></a> environment (defined by the - <span + id="dx1-162010"></a><a + id="dx1-162011"></a> environment (defined by the <span class="cmss-10">supertabular</span><a - id="dx1-84012"></a> package). It has two columns: the first column contains the entry’s - name and the second column contains the (left justified) description followed by - the <a + id="dx1-162012"></a> + package). It has two columns: the first column contains the entry’s name and the second column + contains the (left justified) description followed by the <a href="#glo:numberlist">number list<a - id="dx1-84013"></a></a>. The entry’s symbol is ignored. Sub groups are separated with a - blank row. The width of the first column is governed by the widest entry in that - column. The width of the second column is governed by the length <span + id="dx1-162013"></a></a>. The entry’s symbol is ignored. + Sub groups are separated with a blank row. The width of the first column is governed by the widest + entry in that column. The width of the second column is governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-84014"></a>. - Child entries have a similar format to the parent entries except that their name - is suppressed. + id="dx1-162014"></a>. + Child entries have a similar format to the parent entries except that their name is suppressed. </dd><dt class="description"> <span class="cmbx-10">superraggedborder</span> </dt><dd class="description">The <span class="cmss-10">superraggedborder</span><a - id="dx1-84015"></a> style is like <span + id="dx1-162015"></a> style is like <span class="cmss-10">superragged</span><a - id="dx1-84016"></a> but has horizontal - and vertical lines around it. + id="dx1-162016"></a> but has horizontal and vertical + lines around it. </dd><dt class="description"> <span class="cmbx-10">superraggedheader</span> </dt><dd class="description">The <span class="cmss-10">superraggedheader</span><a - id="dx1-84017"></a> style is like <span + id="dx1-162017"></a> style is like <span class="cmss-10">superragged</span><a - id="dx1-84018"></a> but has a header - row. + id="dx1-162018"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">superraggedheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">superraggedheaderborder</span><a - id="dx1-84019"></a> style is like - <span + id="dx1-162019"></a> style is like <span class="cmss-10">superraggedheader</span><a - id="dx1-84020"></a> but has horizontal and vertical lines around it. + id="dx1-162020"></a> but has + horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">superragged3col</span> </dt><dd class="description">The <span class="cmss-10">superragged3col</span><a - id="dx1-84021"></a> style is like <span + id="dx1-162021"></a> style is like <span class="cmss-10">superragged</span><a - id="dx1-84022"></a> but has three columns. - The first column contains the entry’s name, the second column contains the (left - justified) description and the third column contains the (left justified) <a + id="dx1-162022"></a> but has three columns. The first column + contains the entry’s name, the second column contains the (left justified) description and the third + column contains the (left justified) <a href="#glo:numberlist">number list<a - id="dx1-84023"></a></a>. - The entry’s symbol is ignored. The width of the first column is governed by the - widest entry in that column. The width of the second column is governed by the - length <span + id="dx1-162023"></a></a>. The entry’s symbol is ignored. The width of the + first column is governed by the widest entry in that column. The width of the second column is + governed by the length <span class="cmtt-10">\glsdescwidth</span><a - id="dx1-84024"></a>. The width of the third column is governed by the length + id="dx1-162024"></a>. The width of the third column is governed by the length <span class="cmtt-10">\glspagelistwidth</span><a - id="dx1-84025"></a>. + id="dx1-162025"></a>. </dd><dt class="description"> <span class="cmbx-10">superragged3colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">superragged3colborder</span><a - id="dx1-84026"></a> style is like the <span + id="dx1-162026"></a> style is like the <span class="cmss-10">superragged3col</span><a - id="dx1-84027"></a> - style but has horizontal and vertical lines around it. + id="dx1-162027"></a> style but has + horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">superragged3colheader</span> </dt><dd class="description">The <span class="cmss-10">superragged3colheader</span><a - id="dx1-84028"></a> style is like <span + id="dx1-162028"></a> style is like <span class="cmss-10">superragged3col</span><a - id="dx1-84029"></a> but - has a header row. - - + id="dx1-162029"></a> but has a header row. </dd><dt class="description"> <span class="cmbx-10">superragged3colheaderborder</span> </dt><dd -class="description">The - <span +class="description">The <span class="cmss-10">superragged3colheaderborder</span><a - id="dx1-84030"></a> style is like <span -class="cmss-10">superragged3colheader</span><a - id="dx1-84031"></a> but has horizontal - and vertical lines around it. + id="dx1-162030"></a> style is like the above but has + horizontal and vertical lines around it. + + </dd><dt class="description"> <span class="cmbx-10">altsuperragged4col</span> </dt><dd class="description">The <span class="cmss-10">altsuperragged4col</span><a - id="dx1-84032"></a> style is like <span + id="dx1-162031"></a> style is like <span class="cmss-10">superragged3col</span><a - id="dx1-84033"></a> but has an - additional column in which the entry’s associated symbol appears. The column - widths for the name and symbol column are governed by the widest entry in the - given column. + id="dx1-162032"></a> but has an additional column + in which the entry’s associated symbol appears. The column widths for the name and symbol + column are governed by the widest entry in the given column. </dd><dt class="description"> <span class="cmbx-10">altsuperragged4colborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altsuperragged4colborder</span><a - id="dx1-84034"></a> style is like the - <span + id="dx1-162033"></a> style is like the <span class="cmss-10">altsuperragged4col</span><a - id="dx1-84035"></a> style but has horizontal and vertical lines around it. + id="dx1-162034"></a> style but + has horizontal and vertical lines around it. </dd><dt class="description"> <span class="cmbx-10">altsuperragged4colheader</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altsuperragged4colheader</span><a - id="dx1-84036"></a> style is like - <span + id="dx1-162035"></a> style is like <span class="cmss-10">altsuperragged4col</span><a - id="dx1-84037"></a> but has a header row. + id="dx1-162036"></a> but has a + header row. </dd><dt class="description"> <span class="cmbx-10">altsuperragged4colheaderborder</span> </dt><dd -class="description">The <span +class="description">The <span class="cmss-10">altsuperragged4colheaderborder</span><a - id="dx1-84038"></a> style is like - <span -class="cmss-10">altsuperragged4colheader</span><a - id="dx1-84039"></a> but has horizontal and vertical lines around it. + id="dx1-162037"></a> style is like the above but has + horizontal and vertical lines around it. </dd></dl> -<!--l. 11608--><p class="noindent" > +<!--l. 12606--><p class="noindent" > </p> -<!--l. 11608--><p class="noindent" ><a +<!--l. 12606--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.7 </span> <a id="sec:treestyles"></a>Tree-Like Styles</h4> -<!--l. 11611--><p class="noindent" >The styles described in this section are all defined in the package <span +<!--l. 12609--><p class="noindent" >The styles described in this section are all defined in the package <span class="cmss-10">glossary-tree</span><a - id="dx1-85001"></a>. These styles -are designed for hierarchical glossaries but can also be used with glossaries that don’t have -sub-entries. These styles will display the entry’s symbol if it exists. Note that these -styles will automatically be available unless you use the <span + id="dx1-163001"></a>. These styles are designed for +hierarchical glossaries but can also be used with glossaries that don’t have sub-entries. These styles will display +the entry’s symbol if it exists. Note that these styles will automatically be available unless you use the <span class="cmss-10">notree</span><a - id="dx1-85002"></a> or <span + id="dx1-163002"></a> or +<span class="cmss-10">nostyles</span><a - id="dx1-85003"></a> package -options. -</p><!--l. 11619--><p class="indent" > These styles all format the entry name using: -</p><!--l. 11620--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreenamefmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-85004"></a> <span + id="dx1-163003"></a> package options. +</p><!--l. 12617--><p class="indent" > These styles all format the entry name using: +</p><!--l. 12618--><p class="indent" > <hr><div title="Definition"><a + id="dx1-163004"></a> <span class="cmtt-10">\glstreenamefmt{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11622--><p class="noindent" > +</p><!--l. 12620--><p class="noindent" > This defaults to <span class="cmtt-10">\textbf{</span>⟨<span class="cmti-10">name</span>⟩<span class="cmtt-10">}</span>, but note that ⟨<span class="cmti-10">name</span>⟩ includes <span class="cmtt-10">\glsnamefont</span><a - id="dx1-85005"></a> so the -bold setting in <span -class="cmtt-10">\glstreenamefont </span>may be counteracted by another font change in + id="dx1-163005"></a> so the bold setting in <span +class="cmtt-10">\glstreenamefont </span>may be counteracted by another font change in <span class="cmtt-10">\glsnamefont </span>(or in <span -class="cmtt-10">\acronymfont</span>). The tree-like styles that also display the header -use -</p><!--l. 11628--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreegroupheaderfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-85006"></a> <span +class="cmtt-10">\acronymfont</span>). The +tree-like styles that also display the header use +</p><!--l. 12626--><p class="indent" > <hr><div title="Definition"><a + id="dx1-163006"></a> <span class="cmtt-10">\glstreegroupheaderfmt{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11630--><p class="noindent" > +</p><!--l. 12628--><p class="noindent" > to format the heading. This defaults to <span class="cmtt-10">\glstreenamefmt{</span>⟨<span class="cmti-10">text</span>⟩<span -class="cmtt-10">}</span>. The tree-like styles that -display navigation links to the groups (such as <span +class="cmtt-10">}</span>. The tree-like styles that display navigation +links to the groups (such as <span class="cmss-10">indexhypergroup</span><a - id="dx1-85007"></a>), format the navigation line -using -</p><!--l. 11635--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreenavigationfmt</span><span -class="cmtt-9"> </span></span><a - id="dx1-85008"></a> <span + id="dx1-163007"></a>), format the navigation line using +</p><!--l. 12633--><p class="indent" > <hr><div title="Definition"><a + id="dx1-163008"></a> <span class="cmtt-10">\glstreenavigationfmt{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> - - -</p><!--l. 11637--><p class="noindent" > +</p><!--l. 12635--><p class="noindent" > which defaults to <span class="cmtt-10">\glstreenamefmt{</span>⟨<span class="cmti-10">text</span>⟩<span -class="cmtt-10">}</span>. Note that this is different from -<span +class="cmtt-10">}</span>. +</p><!--l. 12638--><p class="indent" > Note that this is different from <span class="cmtt-10">\glslistnavigationitem</span>, provided with the styles such as <span class="cmss-10">listhypergroup</span><a - id="dx1-85009"></a>, as that also -includes <span + id="dx1-163009"></a>, as +that also includes <span class="cmtt-10">\item</span>. -</p><!--l. 11642--><p class="indent" > With the exception of the <span +</p><!--l. 12642--><p class="indent" > With the exception of the <span class="cmss-10">alttree</span><a - id="dx1-85010"></a> style (and those derived from it), the space before the -description for top-level entries is produced with -</p><!--l. 11645--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreepredesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-85011"></a> <span + id="dx1-163010"></a> style (and those derived from it), the space before the description for +top-level entries is produced with +</p><!--l. 12645--><p class="indent" > <hr><div title="Definition"><a + id="dx1-163011"></a> <span class="cmtt-10">\glstreepredesc </span></div><hr> -</p><!--l. 11647--><p class="noindent" > +</p><!--l. 12647--><p class="noindent" > This defaults to <span class="cmtt-10">\space</span>. -</p><!--l. 11650--><p class="indent" > With the exception of the <span + + +</p><!--l. 12650--><p class="indent" > With the exception of the <span class="cmss-10">treenoname</span><a - id="dx1-85012"></a> and <span + id="dx1-163012"></a> and <span class="cmss-10">alttree</span><a - id="dx1-85013"></a> styles (and those derived from them), -the space before the description for child entries is produced with -</p><!--l. 11654--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreechildpredesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-85014"></a> <span + id="dx1-163013"></a> styles (and those derived from them), the space before the +description for child entries is produced with +</p><!--l. 12654--><p class="indent" > <hr><div title="Definition"><a + id="dx1-163014"></a> <span class="cmtt-10">\glstreechildpredesc </span></div><hr> -</p><!--l. 11656--><p class="noindent" > +</p><!--l. 12656--><p class="noindent" > This defaults to <span class="cmtt-10">\space</span>. -</p><!--l. 11659--><p class="indent" > <div class="important" title="Important Note"> Most of these styles are not designed for multi-paragraph descriptions. (The <span +</p><!--l. 12659--><p class="indent" > <div class="important" title="Important Note"> Most of these styles are not designed for multi-paragraph descriptions. (The <span class="cmss-10">tree</span><a - id="dx1-85015"></a> style -isn’t too bad for multi-paragraph top-level entry descriptions, or you can use the <span + id="dx1-163015"></a> style isn’t too bad for +multi-paragraph top-level entry descriptions, or you can use the <span class="cmss-10">index</span><a - id="dx1-85016"></a> style -with the adjustment shown below.) </div> -</p><!--l. 11664--><p class="noindent" > + id="dx1-163016"></a> style with the adjustment shown below.) +</div> +</p><!--l. 12664--><p class="noindent" > </p><dl class="description"><dt class="description"> <span class="cmbx-10">index</span> </dt><dd class="description">The <span class="cmss-10">index</span><a - id="dx1-85017"></a> style is similar to the way indices are usually formatted in that it has - a hierarchical structure up to three levels (the main level plus two sub-levels). The - name is typeset in bold, and if the symbol is present it is set in parentheses after - the name and before the description. Sub-entries are indented and also include - the name, the symbol in brackets (if present) and the description. Groups are - separated using <span + id="dx1-163017"></a> style is similar to the way indices are usually formatted in that it has a hierarchical + structure up to three levels (the main level plus two sub-levels). The name is typeset in bold, and if + the symbol is present it is set in parentheses after the name and before the description. Sub-entries + are indented and also include the name, the symbol in brackets (if present) and the description. + Groups are separated using <span class="cmtt-10">\indexspace</span><a - id="dx1-85018"></a>. - <!--l. 11676--><p class="noindent" >Each main level item is started with - </p><!--l. 11677--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreeitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-85019"></a> <span + id="dx1-163018"></a>. + <!--l. 12676--><p class="noindent" >Each main level item is started with + </p><!--l. 12677--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163019"></a> <span class="cmtt-10">\glstreeitem </span></div><hr> - </p><!--l. 11679--><p class="noindent" > + </p><!--l. 12679--><p class="noindent" > The level 1 entries are started with - </p><!--l. 11681--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreesubitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-85020"></a> <span + </p><!--l. 12681--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163020"></a> <span class="cmtt-10">\glstreesubitem </span></div><hr> - </p><!--l. 11683--><p class="noindent" > - </p><!--l. 11685--><p class="noindent" >The level 2 entries are started with - </p><!--l. 11686--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreesubsubitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-85021"></a> <span + </p><!--l. 12683--><p class="noindent" > + </p><!--l. 12685--><p class="noindent" >The level 2 entries are started with + </p><!--l. 12686--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163021"></a> <span class="cmtt-10">\glstreesubsubitem </span></div><hr> - </p><!--l. 11688--><p class="noindent" > - </p><!--l. 11690--><p class="noindent" >Note that the <span + </p><!--l. 12688--><p class="noindent" > + </p><!--l. 12690--><p class="noindent" >Note that the <span class="cmss-10">index</span><a - id="dx1-85022"></a> style automatically sets - - + id="dx1-163022"></a> style automatically sets + + </p> - <div class="verbatim" id="verbatim-370"> + <div class="verbatim" id="verbatim-369"> \let\item\glstreeitem  <br />\let\subitem\glstreesubitem  <br />\let\subsubitem\glstreesubsubitem </div> - <!--l. 11695--><p class="nopar" > at the start of the glossary for backward compatibility. - </p><!--l. 11698--><p class="noindent" >The <span + <!--l. 12695--><p class="nopar" > at the start of the glossary for backward compatibility. + </p><!--l. 12698--><p class="noindent" >The <span class="cmss-10">index</span><a - id="dx1-85023"></a> style isn’t suitable for multi-paragraph descriptions, but this limitation can be - overcome by redefining the above commands. For example: - - + id="dx1-163023"></a> style isn’t suitable for multi-paragraph descriptions, but this limitation can be overcome by + redefining the above commands. For example: + + </p> - <div class="verbatim" id="verbatim-371"> + <div class="verbatim" id="verbatim-370"> \renewcommand{\glstreeitem}{%  <br /> \parindent0pt\par\hangindent40pt  <br /> \everypar{\parindent50pt\hangindent40pt}} </div> - <!--l. 11705--><p class="nopar" > + <!--l. 12705--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">indexgroup</span> </dt><dd class="description">The <span class="cmss-10">indexgroup</span><a - id="dx1-85024"></a> style is similar to the <span + id="dx1-163024"></a> style is similar to the <span class="cmss-10">index</span><a - id="dx1-85025"></a> style except that each group has a - heading obtained using <span + id="dx1-163025"></a> style except that each group has a heading + obtained using <span class="cmtt-10">\glsgetgrouptitle{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>, which is described in <a -href="#sec:newglossarystyle"><span -class="tcrm-1000">§</span>15.2 </a><a -href="#sec:newglossarystyle">Defining - your own glossary style<!--tex4ht:ref: sec:newglossarystyle --></a>. +href="#sec:newglossarystyle">§15.2 </a><a +href="#sec:newglossarystyle">Defining your own glossary + style<!--tex4ht:ref: sec:newglossarystyle --></a>. </dd><dt class="description"> <span class="cmbx-10">indexhypergroup</span> </dt><dd class="description">The <span class="cmss-10">indexhypergroup</span><a - id="dx1-85026"></a> style is like <span + id="dx1-163026"></a> style is like <span class="cmss-10">indexgroup</span><a - id="dx1-85027"></a> but has a set of links to the - glossary groups. The navigation line is the same as that for <span + id="dx1-163027"></a> but has a set of links to the glossary groups. + The navigation line is the same as that for <span class="cmss-10">listhypergroup</span><a - id="dx1-85028"></a>, described - above, but is formatted using <span + id="dx1-163028"></a>, described above, but is formatted using + <span class="cmtt-10">\glstreenavigationfmt</span>. </dd><dt class="description"> <span class="cmbx-10">tree</span> </dt><dd class="description">The <span class="cmss-10">tree</span><a - id="dx1-85029"></a> style is similar to the <span + id="dx1-163029"></a> style is similar to the <span class="cmss-10">index</span><a - id="dx1-85030"></a> style except that it can have arbitrary levels. (Note - that <a + id="dx1-163030"></a> style except that it can have arbitrary levels. (Note that <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-85031"></a></a> is limited to three levels, so you will need to use <a + id="dx1-163031"></a></a> is + limited to three levels, so you will need to use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-85032"></a></a> if you want - more than three levels.) Each sub-level is indented by <span class="reversemarginpar"><span -class="cmtt-9">\glstreeindent</span><span -class="cmtt-9"> </span></span><a - id="dx1-85033"></a><span -class="cmtt-10">\glstreeindent</span>. - Note that the name, symbol (if present) and description are placed in the same - paragraph block. If you want the name to be apart from the description, use the <span + id="dx1-163032"></a></a> if you want more than three levels.) Each sub-level is + indented by <a + id="dx1-163033"></a><span +class="cmtt-10">\glstreeindent</span>. Note that the name, symbol (if present) and description are placed in the + same paragraph block. If you want the name to be apart from the description, use the <span class="cmss-10">alttree</span><a - id="dx1-85034"></a> - style instead. (See below.) + id="dx1-163034"></a> style instead. + (See below.) </dd><dt class="description"> <span class="cmbx-10">treegroup</span> </dt><dd class="description">The <span class="cmss-10">treegroup</span><a - id="dx1-85035"></a> style is similar to the <span + id="dx1-163035"></a> style is similar to the <span class="cmss-10">tree</span><a - id="dx1-85036"></a> style except that each group has a - heading. + id="dx1-163036"></a> style except that each group has a heading. </dd><dt class="description"> <span class="cmbx-10">treehypergroup</span> </dt><dd class="description">The <span class="cmss-10">treehypergroup</span><a - id="dx1-85037"></a> style is like <span + id="dx1-163037"></a> style is like <span class="cmss-10">treegroup</span><a - id="dx1-85038"></a> but has a set of links to the - glossary groups. The navigation line is the same as that for <span + id="dx1-163038"></a> but has a set of links to the glossary groups. The + navigation line is the same as that for <span class="cmss-10">listhypergroup</span><a - id="dx1-85039"></a>, described - above, but is formatted using <span + id="dx1-163039"></a>, described above, but is formatted using + <span class="cmtt-10">\glstreenavigationfmt</span>. </dd><dt class="description"> <span class="cmbx-10">treenoname</span> </dt><dd class="description">The <span class="cmss-10">treenoname</span><a - id="dx1-85040"></a> style is like the <span + id="dx1-163040"></a> style is like the <span class="cmss-10">tree</span><a - id="dx1-85041"></a> style except that the name for each - sub-entry is ignored. + id="dx1-163041"></a> style except that the name for each sub-entry is + ignored. </dd><dt class="description"> <span class="cmbx-10">treenonamegroup</span> </dt><dd class="description">The <span class="cmss-10">treenonamegroup</span><a - id="dx1-85042"></a> style is similar to the <span + id="dx1-163042"></a> style is similar to the <span class="cmss-10">treenoname</span><a - id="dx1-85043"></a> style except that - each group has a heading. + id="dx1-163043"></a> style except that each group has a + heading. </dd><dt class="description"> <span class="cmbx-10">treenonamehypergroup</span> </dt><dd class="description">The <span class="cmss-10">treenonamehypergroup</span><a - id="dx1-85044"></a> style is like <span + id="dx1-163044"></a> style is like <span class="cmss-10">treenonamegroup</span><a - id="dx1-85045"></a> but has a - set of links to the glossary groups. The navigation line is the same as that for - <span + id="dx1-163045"></a> but has a set of links to the + glossary groups. The navigation line is the same as that for <span class="cmss-10">listhypergroup</span><a - id="dx1-85046"></a>, described above, but is formatted using <span + id="dx1-163046"></a>, described above, but is + formatted using <span class="cmtt-10">\glstreenavigationfmt</span>. - - + + </dd><dt class="description"> <span class="cmbx-10">alttree</span> </dt><dd class="description">The <span class="cmss-10">alttree</span><a - id="dx1-85047"></a> style is similar to the <span + id="dx1-163047"></a> style is similar to the <span class="cmss-10">tree</span><a - id="dx1-85048"></a> style except that the indentation for each level - is determined by the width of the text specified by - <!--l. 11754--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssetwidest</span><span -class="cmtt-9"> </span></span><a - id="dx1-85049"></a> <span + id="dx1-163048"></a> style except that the indentation for each level is determined by + the width of the text specified by + <!--l. 12754--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163049"></a> <span class="cmtt-10">\glssetwidest[</span>⟨<span class="cmitt-10">level</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 11756--><p class="noindent" > + </p><!--l. 12756--><p class="noindent" > The optional argument ⟨<span -class="cmti-10">level</span>⟩ indicates the level, where 0 indicates the top-most level, 1 - indicates the first level sub-entries, etc. If <span -class="cmtt-10">\glssetwidest </span>hasn’t been used for a - given sub-level, the level 0 widest text is used instead. If ⟨<span -class="cmti-10">level</span>⟩ is omitted, 0 is - assumed. - </p><!--l. 11763--><p class="noindent" >As from v4.22, the <span +class="cmti-10">level</span>⟩ indicates the level, where 0 indicates the top-most level, 1 indicates the first + level sub-entries, etc. If <span +class="cmtt-10">\glssetwidest </span>hasn’t been used for a given sub-level, the level 0 widest text is + used instead. If ⟨<span +class="cmti-10">level</span>⟩ is omitted, 0 is assumed. + </p><!--l. 12763--><p class="noindent" >As from v4.22, the <span class="cmss-10">glossary-tree</span><a - id="dx1-85050"></a> package also provides - </p><!--l. 11764--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfindwidesttoplevelname</span><span -class="cmtt-9"> </span></span><a - id="dx1-85051"></a> <span + id="dx1-163050"></a> package also provides + </p><!--l. 12764--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163051"></a> <span class="cmtt-10">\glsfindwidesttoplevelname[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span -class="cmtt-10">]</span> - </div><hr> - </p><!--l. 11766--><p class="noindent" > - This iterates over all parentless entries in the given glossary lists and determines the - widest entry. If the optional argument is omitted, all glossaries are assumed (as per - <span +class="cmtt-10">] </span></div><hr> + </p><!--l. 12766--><p class="noindent" > + This iterates over all parentless entries in the given glossary lists and determines the widest entry. If the + optional argument is omitted, all glossaries are assumed (as per <span class="cmtt-10">\forallglossaries</span>). - </p><!--l. 11771--><p class="noindent" >For example, to have the same name width for all glossaries: - - + </p><!--l. 12771--><p class="noindent" >For example, to have the same name width for all glossaries: + + </p> - <div class="verbatim" id="verbatim-372"> + <div class="verbatim" id="verbatim-371"> \glsfindwidesttoplevelname  <br />\setglossarystyle{alttree}  <br />\printglossaries </div> - <!--l. 11776--><p class="nopar" > Alternatively, to compute the widest entry for each glossary before it’s displayed: - - + <!--l. 12776--><p class="nopar" > Alternatively, to compute the widest entry for each glossary before it’s displayed: + + </p> - <div class="verbatim" id="verbatim-373"> + <div class="verbatim" id="verbatim-372"> \renewcommand{\glossarypreamble}{%  <br />  \glsfindwidesttoplevelname[\currentglossary]}  <br />\setglossarystyle{alttree}  <br />\printglossaries </div> - <!--l. 11784--><p class="nopar" > - </p><!--l. 11786--><p class="noindent" ><div class="important" title="Important Note"> These commands only affects the <span + <!--l. 12784--><p class="nopar" > + </p><!--l. 12786--><p class="noindent" ><div class="important" title="Important Note"> These commands only affects the <span class="cmss-10">alttree</span><a - id="dx1-85052"></a> styles, including those listed below and the - ones in the <span + id="dx1-163052"></a> styles, including those listed below and the ones in the + <span class="cmss-10">glossary-mcols</span><a - id="dx1-85053"></a> package. If you forget to set the widest entry name, the - description will overwrite the name. </div> - </p><!--l. 11791--><p class="noindent" > - </p><!--l. 11793--><p class="noindent" >For each level, the name is placed to the left of the paragraph block containing the - symbol (optional) and the description. If the symbol is present, it is placed in - parentheses before the description. - </p><!--l. 11798--><p class="noindent" >The name is placed inside a left-aligned <span -class="cmtt-10">\makebox</span>. As from v4.19, this can now be - adjusted by redefining - </p><!--l. 11800--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstreenamebox</span><span -class="cmtt-9"> </span></span><a - id="dx1-85054"></a> <span + id="dx1-163053"></a> package. If you forget to set the widest entry name, the description will overwrite the name. + </div> + </p><!--l. 12791--><p class="noindent" > + </p><!--l. 12793--><p class="noindent" >For each level, the name is placed to the left of the paragraph block containing the symbol + (optional) and the description. If the symbol is present, it is placed in parentheses before the + description. + </p><!--l. 12798--><p class="noindent" >The name is placed inside a left-aligned <span +class="cmtt-10">\makebox</span>. As from v4.19, this can now be adjusted by + redefining + </p><!--l. 12800--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-163054"></a> <span class="cmtt-10">\glstreenamebox{</span>⟨<span class="cmitt-10">width</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> - </p><!--l. 11802--><p class="noindent" > + </p><!--l. 12802--><p class="noindent" > where ⟨<span class="cmti-10">width</span>⟩ is the width of the box and ⟨<span -class="cmti-10">text</span>⟩ is the contents of the box. For example, to - make the name right-aligned: - - +class="cmti-10">text</span>⟩ is the contents of the box. For example, to make the name + right-aligned: + + </p> - <div class="verbatim" id="verbatim-374"> + <div class="verbatim" id="verbatim-373"> \renewcommand*{\glstreenamebox}[2]{%  <br />  \makebox[#1][r]{#2}%  <br />} </div> - <!--l. 11809--><p class="nopar" > + <!--l. 12809--><p class="nopar" > </p></dd><dt class="description"> <span class="cmbx-10">alttreegroup</span> </dt><dd class="description">The <span class="cmss-10">alttreegroup</span><a - id="dx1-85055"></a> is like the <span + id="dx1-163055"></a> is like the <span class="cmss-10">alttree</span><a - id="dx1-85056"></a> style except that each group has a - heading. + id="dx1-163056"></a> style except that each group has a heading. </dd><dt class="description"> <span class="cmbx-10">alttreehypergroup</span> </dt><dd class="description">The <span class="cmss-10">alttreehypergroup</span><a - id="dx1-85057"></a> style is like <span + id="dx1-163057"></a> style is like <span class="cmss-10">alttreegroup</span><a - id="dx1-85058"></a> but has a set of links to - the glossary groups. The navigation line is the same as that for <span + id="dx1-163058"></a> but has a set of links to the glossary groups. + The navigation line is the same as that for <span class="cmss-10">listhypergroup</span><a - id="dx1-85059"></a>, described - above. + id="dx1-163059"></a>, described above. </dd></dl> -<!--l. 11821--><p class="noindent" > +<!--l. 12821--><p class="noindent" > </p> -<!--l. 11821--><p class="noindent" ><a +<!--l. 12821--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.8 </span> <a id="sec:mcolstyles"></a>Multicols Style</h4> -<!--l. 11824--><p class="noindent" >The <span +<!--l. 12824--><p class="noindent" >The <span class="cmss-10">glossary-mcols</span><a - id="dx1-86001"></a> package provides tree-like styles that are in the <span + id="dx1-164001"></a> package provides tree-like styles that are in the <span class="cmss-10">multicols</span><a - id="dx1-86002"></a><a - id="dx1-86003"></a> environment -(defined by the <span + id="dx1-164002"></a><a + id="dx1-164003"></a> environment (defined by the <span class="cmss-10">multicol</span><a - id="dx1-86004"></a> package). The style names are as their analogous tree styles (as -defined in <a -href="#sec:treestyles"><span -class="tcrm-1000">§</span>15.1.7 </a><a -href="#sec:treestyles">Tree-Like Styles<!--tex4ht:ref: sec:treestyles --></a>) but are prefixed with “mcol”. For example, the <span + id="dx1-164004"></a> +package). The style names are as their analogous tree styles (as defined in <a +href="#sec:treestyles">§15.1.7 </a><a +href="#sec:treestyles">Tree-Like Styles<!--tex4ht:ref: sec:treestyles --></a>) but are +prefixed with “mcol”. For example, the <span class="cmss-10">mcolindex</span><a - id="dx1-86005"></a> -style is essentially the <span + id="dx1-164005"></a> style is essentially the <span class="cmss-10">index</span><a - id="dx1-86006"></a> style but put in a <span + id="dx1-164006"></a> style but put in a <span class="cmss-10">multicols</span><a - id="dx1-86007"></a><a - id="dx1-86008"></a> environment. For the complete list, see -<a + id="dx1-164007"></a><a + id="dx1-164008"></a> +environment. For the complete list, see <a href="#tab:mcols">table 15.2</a>. The <span class="cmss-10">glossary-tree</span><a - id="dx1-86009"></a> package is automatically loaded by <span -class="cmss-10">glossary-mcols</span><a - id="dx1-86010"></a> (even if the + id="dx1-164009"></a> package is automatically loaded by <span +class="cmss-10">glossary-mcols</span><a + id="dx1-164010"></a> (even if the <span class="cmss-10">notree</span><a - id="dx1-86011"></a> package option is used when loading <span + id="dx1-164011"></a> package option is used when loading <span class="cmss-10">glossaries</span>). The formatting commands <span class="cmtt-10">\glstreenamefmt</span>, <span class="cmtt-10">\glstreegroupheaderfmt </span>and <span -class="cmtt-10">\glstreenavigationfmt </span>are all used by -the corresponding <span +class="cmtt-10">\glstreenavigationfmt </span>are all used by the corresponding +<span class="cmss-10">glossary-mcols</span><a - id="dx1-86012"></a> styles. -</p><!--l. 11839--><p class="indent" > <div class="important" title="Important Note"> Note that <span + id="dx1-164012"></a> styles. +</p><!--l. 12839--><p class="indent" > <div class="important" title="Important Note"> Note that <span class="cmss-10">glossary-mcols</span><a - id="dx1-86013"></a> is not loaded by <span -class="cmss-10">glossaries</span>. If you want to use any of the multicol -styles in that package you need to load it explicitly with <span -class="cmtt-10">\usepackage </span>and set the required -glossary style using <span + id="dx1-164013"></a> is not loaded by <span +class="cmss-10">glossaries</span>. If you want to use any of the multicol styles in that +package you need to load it explicitly with <span +class="cmtt-10">\usepackage </span>and set the required glossary style using +<span class="cmtt-10">\setglossarystyle</span><a - id="dx1-86014"></a>. </div> -</p><!--l. 11844--><p class="noindent" > -</p><!--l. 11846--><p class="indent" > The default number of columns is 2, but can be changed by redefining -</p><!--l. 11847--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsmcols</span><span -class="cmtt-9"> </span></span><a - id="dx1-86015"></a> <span + id="dx1-164014"></a>. </div> +</p><!--l. 12844--><p class="noindent" > +</p><!--l. 12846--><p class="indent" > The default number of columns is 2, but can be changed by redefining +</p><!--l. 12847--><p class="indent" > <hr><div title="Definition"><a + id="dx1-164015"></a> <span class="cmtt-10">\glsmcols </span></div><hr> -</p><!--l. 11849--><p class="noindent" > +</p><!--l. 12849--><p class="noindent" > to the required number. For example, for a three column glossary: - - + + </p> - <div class="verbatim" id="verbatim-375"> + <div class="verbatim" id="verbatim-374"> \usepackage{glossary-mcols}  <br />\renewcommand*{\glsmcols}{3}  <br />\setglossarystyle{mcolindex} </div> -<!--l. 11855--><p class="nopar" > +<!--l. 12855--><p class="nopar" > </p> <div class="table"> - - -<!--l. 11857--><p class="indent" > <a + + +<!--l. 12857--><p class="indent" > <a id="tab:mcols"></a></p><hr class="float" /><div class="float" > - - + + <div class="caption" ><span class="id">Table 15.2: </span><span -class="content">Multicolumn Styles</span></div><!--tex4ht:label?: x1-860162 --> +class="content">Multicolumn Styles</span></div><!--tex4ht:label?: x1-1640162 --> <div class="tabular"> <table id="TBL-10" class="tabular" cellspacing="0" cellpadding="0" ><colgroup id="TBL-10-1g"><col @@ -24013,7 +25747,7 @@ id="TBL-10-2" /></colgroup><tr style="vertical-align:baseline;" id="TBL-10-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-1-1" class="td11"> <span class="cmssbx-10">glossary-mcols</span><a - id="dx1-86017"></a> <span + id="dx1-164017"></a> <span class="cmbx-10">Style </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-10-1-2" class="td11"> <span class="cmbx-10">Analogous Tree Style </span></td> @@ -24021,627 +25755,568 @@ class="cmbx-10">Analogous Tree Style </span></td> style="vertical-align:baseline;" id="TBL-10-2-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-2-1" class="td11"> <span class="cmss-10">mcolindex</span><a - id="dx1-86018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-2-2" + id="dx1-164018"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-2-2" class="td11"> <span class="cmss-10">index</span><a - id="dx1-86019"></a> </td></tr><tr + id="dx1-164019"></a> </td></tr><tr style="vertical-align:baseline;" id="TBL-10-3-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-3-1" class="td11"> <span class="cmss-10">mcolindexgroup</span><a - id="dx1-86020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-3-2" + id="dx1-164020"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-3-2" class="td11"> <span class="cmss-10">indexgroup</span><a - id="dx1-86021"></a></td> + id="dx1-164021"></a></td> </tr><tr style="vertical-align:baseline;" id="TBL-10-4-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-4-1" class="td11"> <span class="cmss-10">mcolindexhypergroup</span><a - id="dx1-86022"></a> or <span + id="dx1-164022"></a> or <span class="cmss-10">mcolindexspannav</span><a - id="dx1-86023"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-4-2" + id="dx1-164023"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-4-2" class="td11"> <span class="cmss-10">indexhypergroup</span><a - id="dx1-86024"></a> </td> + id="dx1-164024"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-5-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-5-1" class="td11"> <span class="cmss-10">mcoltree</span><a - id="dx1-86025"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-5-2" + id="dx1-164025"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-5-2" class="td11"> <span class="cmss-10">tree</span><a - id="dx1-86026"></a> </td></tr><tr + id="dx1-164026"></a> </td></tr><tr style="vertical-align:baseline;" id="TBL-10-6-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-6-1" class="td11"> <span class="cmss-10">mcoltreegroup</span><a - id="dx1-86027"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-6-2" + id="dx1-164027"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-6-2" class="td11"> <span class="cmss-10">treegroup</span><a - id="dx1-86028"></a></td> + id="dx1-164028"></a></td> </tr><tr style="vertical-align:baseline;" id="TBL-10-7-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-7-1" class="td11"> <span class="cmss-10">mcoltreehypergroup</span><a - id="dx1-86029"></a> or <span + id="dx1-164029"></a> or <span class="cmss-10">mcoltreespannav</span><a - id="dx1-86030"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-7-2" + id="dx1-164030"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-7-2" class="td11"> <span class="cmss-10">treehypergroup</span><a - id="dx1-86031"></a> </td> + id="dx1-164031"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-8-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-8-1" class="td11"> <span class="cmss-10">mcoltreenoname</span><a - id="dx1-86032"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-8-2" + id="dx1-164032"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-8-2" class="td11"> <span class="cmss-10">treenoname</span><a - id="dx1-86033"></a> </td> + id="dx1-164033"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-9-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-9-1" class="td11"> <span class="cmss-10">mcoltreenonamegroup</span><a - id="dx1-86034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-9-2" + id="dx1-164034"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-9-2" class="td11"> <span class="cmss-10">treenonamegroup</span><a - id="dx1-86035"></a> </td> + id="dx1-164035"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-10-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-10-1" class="td11"> <span class="cmss-10">mcoltreenonamehypergroup</span><a - id="dx1-86036"></a> or <span + id="dx1-164036"></a> or <span class="cmss-10">mcoltreenonamespannav</span><a - id="dx1-86037"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-10-2" + id="dx1-164037"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-10-2" class="td11"> <span class="cmss-10">treenonamehypergroup</span><a - id="dx1-86038"></a> </td> + id="dx1-164038"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-11-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-11-1" class="td11"> <span class="cmss-10">mcolalttree</span><a - id="dx1-86039"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-11-2" + id="dx1-164039"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-11-2" class="td11"> <span class="cmss-10">alttree</span><a - id="dx1-86040"></a> </td> + id="dx1-164040"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-12-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-12-1" class="td11"> <span class="cmss-10">mcolalttreegroup</span><a - id="dx1-86041"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-12-2" + id="dx1-164041"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-12-2" class="td11"> <span class="cmss-10">alttreegroup</span><a - id="dx1-86042"></a> </td> + id="dx1-164042"></a> </td> </tr><tr style="vertical-align:baseline;" id="TBL-10-13-"><td style="white-space:nowrap; text-align:left;" id="TBL-10-13-1" class="td11"> <span class="cmss-10">mcolalttreehypergroup</span><a - id="dx1-86043"></a> or <span + id="dx1-164043"></a> or <span class="cmss-10">mcolalttreespannav</span><a - id="dx1-86044"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-13-2" + id="dx1-164044"></a> </td><td style="white-space:nowrap; text-align:left;" id="TBL-10-13-2" class="td11"> <span class="cmss-10">alttreehypergroup</span><a - id="dx1-86045"></a> </td></tr></table></div> - - + id="dx1-164045"></a> </td></tr></table></div> + + </div><hr class="endfloat" /> </div> -<!--l. 11882--><p class="indent" > The styles with a navigation line, such as <span +<!--l. 12882--><p class="indent" > The styles with a navigation line, such as <span class="cmss-10">mcoltreehypergroup</span><a - id="dx1-86046"></a>, now have a variant (as from -v4.22) with “hypergroup” replaced with “spannav” in the style name. The original -“hypergroup” styles place the navigation line at the start of the first column. The newer -“spannav” styles put the navigation line in the optional argument of the <span + id="dx1-164046"></a>, now have a variant (as from +v4.22) with “hypergroup” replaced with “spannav” in the style name. The original “hypergroup” +styles place the navigation line at the start of the first column. The newer “spannav” styles put the +navigation line in the optional argument of the <span class="cmss-10">multicols</span><a - id="dx1-86047"></a><a - id="dx1-86048"></a> -environment so that it spans across all the columns. + id="dx1-164047"></a><a + id="dx1-164048"></a> environment so that it spans across all the +columns. </p> -<!--l. 11890--><p class="noindent" ><a +<!--l. 12890--><p class="noindent" ><a href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">15.1.9 </span> <a id="sec:inline"></a>In-Line Style</h4> -<!--l. 11893--><p class="noindent" >This section covers the <span +<!--l. 12893--><p class="noindent" >This section covers the <span class="cmss-10">glossary-inline</span><a - id="dx1-87001"></a> package that supplies the <span + id="dx1-165001"></a> package that supplies the <span class="cmss-10">inline</span><a - id="dx1-87002"></a> style. This is a style that -is designed for in-line use (as opposed to block styles, such as lists or tables). This style -doesn’t display the <a -href="#glo:numberlist">number list<a - id="dx1-87003"></a></a>. -</p><!--l. 11898--><p class="indent" > You will most likely need to redefine <span + id="dx1-165002"></a> style. This is a style that is designed for +in-line use (as opposed to block styles, such as lists or tables). This style doesn’t display the <a +href="#glo:numberlist">number +list<a + id="dx1-165003"></a></a>. +</p><!--l. 12898--><p class="indent" > You will most likely need to redefine <span class="cmtt-10">\glossarysection</span><a - id="dx1-87004"></a> with this style. For example, -suppose you are required to have your glossaries and list of acronyms in a footnote, you can -do: - - + id="dx1-165004"></a> with this style. For example, suppose you are +required to have your glossaries and list of acronyms in a footnote, you can do: + + </p> - <div class="verbatim" id="verbatim-376"> + <div class="verbatim" id="verbatim-375">  \usepackage{glossary-inline}  <br /> \renewcommand*{\glossarysection}[2][]{\textbf{#1}: }  <br /> \setglossarystyle{inline} </div> -<!--l. 11906--><p class="nopar" > -</p><!--l. 11908--><p class="indent" > <div class="important" title="Important Note"> Note that you need to include <span +<!--l. 12906--><p class="nopar" > +</p><!--l. 12908--><p class="indent" > <div class="important" title="Important Note"> Note that you need to include <span class="cmss-10">glossary-inline</span><a - id="dx1-87005"></a> with <span -class="cmtt-10">\usepackage </span>as it’s not automatically -included by the <span + id="dx1-165005"></a> with <span +class="cmtt-10">\usepackage </span>as it’s not automatically included by the +<span class="cmss-10">glossaries </span>package and then set the style using <span class="cmtt-10">\setglossarystyle</span><a - id="dx1-87006"></a>. -</div> -</p><!--l. 11913--><p class="noindent" > -</p><!--l. 11915--><p class="indent" > Where you need to include your glossaries as a footnote you can do: - - + id="dx1-165006"></a>. </div> +</p><!--l. 12913--><p class="noindent" > +</p><!--l. 12915--><p class="indent" > Where you need to include your glossaries as a footnote you can do: + + </p> - <div class="verbatim" id="verbatim-377"> + <div class="verbatim" id="verbatim-376"> \footnote{\printglossaries} </div> -<!--l. 11918--><p class="nopar" > -</p><!--l. 11920--><p class="indent" > The <span +<!--l. 12918--><p class="nopar" > +</p><!--l. 12920--><p class="indent" > The <span class="cmss-10">inline</span><a - id="dx1-87007"></a> style is governed by the following: -</p><!--l. 11921--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlineseparator</span><span -class="cmtt-9"> </span></span><a - id="dx1-87008"></a> <span + id="dx1-165007"></a> style is governed by the following: +</p><!--l. 12921--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165008"></a> <span class="cmtt-10">\glsinlineseparator</span><a - id="dx1-87009"></a> </div><hr> -</p><!--l. 11923--><p class="noindent" > + id="dx1-165009"></a> </div><hr> +</p><!--l. 12923--><p class="noindent" > This defaults to “<span class="cmtt-10">; </span>” and is used between main (i.e. level 0) entries. -</p><!--l. 11926--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlinesubseparator</span><span -class="cmtt-9"> </span></span><a - id="dx1-87010"></a> <span +</p><!--l. 12926--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165010"></a> <span class="cmtt-10">\glsinlinesubseparator</span><a - id="dx1-87011"></a> </div><hr> -</p><!--l. 11928--><p class="noindent" > + id="dx1-165011"></a> </div><hr> +</p><!--l. 12928--><p class="noindent" > This defaults to “<span class="cmtt-10">, </span>” and is used between sub-entries. -</p><!--l. 11931--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlineparentchildseparator</span><span -class="cmtt-9"> </span></span><a - id="dx1-87012"></a> <span +</p><!--l. 12931--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165012"></a> <span class="cmtt-10">\glsinlineparentchildseparator</span><a - id="dx1-87013"></a> </div><hr> -</p><!--l. 11933--><p class="noindent" > + id="dx1-165013"></a> </div><hr> +</p><!--l. 12933--><p class="noindent" > This defaults to “<span class="cmtt-10">: </span>” and is used between a parent main entry and its first sub-entry. -</p><!--l. 11936--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glspostinline</span><span -class="cmtt-9"> </span></span><a - id="dx1-87014"></a> <span +</p><!--l. 12936--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165014"></a> <span class="cmtt-10">\glspostinline</span><a - id="dx1-87015"></a> </div><hr> -</p><!--l. 11938--><p class="noindent" > + id="dx1-165015"></a> </div><hr> +</p><!--l. 12938--><p class="noindent" > This defaults to “<span class="cmtt-10">; </span>” and is used at the end of the glossary. -</p><!--l. 11941--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlinenameformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-87016"></a> <span +</p><!--l. 12941--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165016"></a> <span class="cmtt-10">\glsinlinenameformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11943--><p class="noindent" > +</p><!--l. 12943--><p class="noindent" > This is used to format the entry name and defaults to <span class="cmtt-10">\glstarget{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmti-10">name</span>⟩<span -class="cmtt-10">}</span>, where -⟨<span -class="cmti-10">name</span>⟩ is provided in the form <span +class="cmtt-10">}</span>, where ⟨<span +class="cmti-10">name</span>⟩ is provided in +the form <span class="cmtt-10">\glossentryname{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">} </span>and ⟨<span -class="cmti-10">label</span>⟩ is the entry’s label. For -example, if you want the name to appear in smallcaps: - - +class="cmti-10">label</span>⟩ is the entry’s label. For example, if you want the name to appear in +<a +href="#glo:smallcaps">small caps<a + id="dx1-165017"></a></a>: + + </p> - <div class="verbatim" id="verbatim-378"> + <div class="verbatim" id="verbatim-377"> \renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}} </div> -<!--l. 11951--><p class="nopar" > Sub-entry names are formatted according to -</p><!--l. 11953--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlinesubnameformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-87017"></a> <span +<!--l. 12951--><p class="nopar" > Sub-entry names are formatted according to +</p><!--l. 12953--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165018"></a> <span class="cmtt-10">\glsinlinesubnameformat{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11955--><p class="noindent" > +</p><!--l. 12955--><p class="noindent" > This defaults to <span class="cmtt-10">\glstarget{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span><span class="obeylines-h"><span class="verb"><span class="cmtt-10">{}</span></span></span> so the sub-entry name is ignored. -</p><!--l. 11959--><p class="indent" > If the description has been suppressed (according to <span -class="cmtt-10">\ifglsdescsuppressed</span>) -then -</p><!--l. 11961--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlineemptydescformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-87018"></a> <span +</p><!--l. 12959--><p class="indent" > If the description has been suppressed (according to <span +class="cmtt-10">\ifglsdescsuppressed</span>) then +</p><!--l. 12961--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165019"></a> <span class="cmtt-10">\glsinlineemptydescformat{</span>⟨<span class="cmitt-10">symbol</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">number list</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 11963--><p class="noindent" > -(which defaults to nothing) is used, otherwise the description is formatted according -to -</p><!--l. 11966--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlinedescformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-87019"></a> <span +class="cmtt-10">} </span></div><hr> +</p><!--l. 12963--><p class="noindent" > +(which defaults to nothing) is used, otherwise the description is formatted according to +</p><!--l. 12966--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165020"></a> <span class="cmtt-10">\glsinlinedescformat{</span>⟨<span class="cmitt-10">description</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">symbol</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">number list</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 11969--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 12969--><p class="noindent" > This defaults to just <span class="cmtt-10">\space</span>⟨<span -class="cmti-10">description</span>⟩ so the symbol and location list are ignored. If the -description is missing (according to <span +class="cmti-10">description</span>⟩ so the symbol and location list are ignored. If the description is missing +(according to <span class="cmtt-10">\ifglshasdesc</span>), then <span -class="cmtt-10">\glsinlineemptydescformat </span>is -used instead. -</p><!--l. 11975--><p class="indent" > For example, if you want a colon between the name and the description: - - +class="cmtt-10">\glsinlineemptydescformat </span>is used instead. +</p><!--l. 12975--><p class="indent" > For example, if you want a colon between the name and the description: + + </p> - <div class="verbatim" id="verbatim-379"> + <div class="verbatim" id="verbatim-378"> \renewcommand*{\glsinlinedescformat}[3]{: #1} </div> -<!--l. 11979--><p class="nopar" > -</p><!--l. 11981--><p class="indent" > The sub-entry description is formatted according to: -</p><!--l. 11982--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsinlinesubdescformat</span><span -class="cmtt-9"> </span></span><a - id="dx1-87020"></a> <span +<!--l. 12979--><p class="nopar" > +</p><!--l. 12981--><p class="indent" > The sub-entry description is formatted according to: +</p><!--l. 12982--><p class="indent" > <hr><div title="Definition"><a + id="dx1-165021"></a> <span class="cmtt-10">\glsinlinesubdescformat{</span>⟨<span class="cmitt-10">description</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">symbol</span>⟩<span class="cmtt-10">}{</span>⟨<span -class="cmitt-10">number</span> -<span -class="cmitt-10">list</span>⟩<span +class="cmitt-10">number list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11985--><p class="noindent" > +</p><!--l. 12985--><p class="noindent" > This defaults to just ⟨<span class="cmti-10">description</span>⟩. -</p><!--l. 11988--><p class="noindent" > +</p><!--l. 12988--><p class="noindent" > </p> -<!--l. 11988--><p class="noindent" ><a +<!--l. 12988--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">15.2 </span> <a id="sec:newglossarystyle"></a>Defining your own glossary style</h3> -<!--l. 11991--><p class="noindent" >If the predefined styles don’t fit your requirements, you can define your own style -using: -</p><!--l. 11993--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\newglossarystyle</span><span -class="cmtt-9"> </span></span><a - id="dx1-88001"></a> <span +<!--l. 12991--><p class="noindent" >If the predefined styles don’t fit your requirements, you can define your own style using: +</p><!--l. 12993--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166001"></a> <span class="cmtt-10">\newglossarystyle{</span>⟨<span class="cmitt-10">name</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definitions</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 11995--><p class="noindent" > +</p><!--l. 12995--><p class="noindent" > where ⟨<span class="cmti-10">name</span>⟩ is the name of the new glossary style (to be used in <span -class="cmtt-10">\setglossarystyle</span>). The -second argument ⟨<span +class="cmtt-10">\setglossarystyle</span>). The second argument +⟨<span class="cmti-10">definitions</span>⟩ needs to redefine all of the following: -</p><!--l. 12000--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">theglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-88002"></a><a - id="dx1-88003"></a> <span +</p><!--l. 13000--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166002"></a><a + id="dx1-166003"></a> <span class="cmss-10">theglossary</span><a - id="dx1-88004"></a><a - id="dx1-88005"></a> </div><hr> -</p><!--l. 12002--><p class="noindent" > -This environment defines how the main body of the glossary should be typeset. Note that this -does not include the section heading, the glossary preamble (defined by <span + id="dx1-166004"></a><a + id="dx1-166005"></a> </div><hr> +</p><!--l. 13002--><p class="noindent" > +This environment defines how the main body of the glossary should be typeset. +</p><!--l. 13006--><p class="indent" > Note that this does not include the section heading, the glossary preamble (defined by <span class="cmtt-10">\glossarypreamble</span><a - id="dx1-88006"></a>) + id="dx1-166006"></a>) or the glossary postamble (defined by <span class="cmtt-10">\glossarypostamble</span><a - id="dx1-88007"></a>). For example, the <span + id="dx1-166007"></a>). For example, the <span class="cmss-10">list</span><a - id="dx1-88008"></a> style uses -the <span + id="dx1-166008"></a> style uses the <span class="cmss-10">description</span><a - id="dx1-88009"></a><a - id="dx1-88010"></a> environment, so the <span + id="dx1-166009"></a><a + id="dx1-166010"></a> +environment, so the <span class="cmss-10">theglossary</span><a - id="dx1-88011"></a><a - id="dx1-88012"></a> environment is simply redefined to begin and -end the <span + id="dx1-166011"></a><a + id="dx1-166012"></a> environment is simply redefined to begin and end the <span class="cmss-10">description</span><a - id="dx1-88013"></a><a - id="dx1-88014"></a> environment. -</p><!--l. 12011--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossaryheader</span><span -class="cmtt-9"> </span></span><a - id="dx1-88015"></a> <span + id="dx1-166013"></a><a + id="dx1-166014"></a> +environment. +</p><!--l. 13013--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166015"></a> <span class="cmtt-10">\glossaryheader </span></div><hr> -</p><!--l. 12013--><p class="noindent" > -This macro indicates what to do at the start of the main body of the glossary. Note that this -is not the same as <span +</p><!--l. 13015--><p class="noindent" > +This macro indicates what to do at the start of the main body of the glossary. Note that this is not the same as +<span class="cmtt-10">\glossarypreamble</span><a - id="dx1-88016"></a>, which should not be affected by changes in the -glossary style. The <span + id="dx1-166016"></a>, which should not be affected by changes in the glossary style. The <span class="cmss-10">list</span><a - id="dx1-88017"></a> glossary style redefines <span + id="dx1-166017"></a> glossary style +redefines <span class="cmtt-10">\glossaryheader</span><a - id="dx1-88018"></a> to do nothing, -whereas the <span + id="dx1-166018"></a> to do nothing, whereas the <span class="cmss-10">longheader</span><a - id="dx1-88019"></a> glossary style redefines <span -class="cmtt-10">\glossaryheader </span>to do a header -row. -</p><!--l. 12021--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsgroupheading</span><span -class="cmtt-9"> </span></span><a - id="dx1-88020"></a> <span + id="dx1-166019"></a> glossary style redefines <span +class="cmtt-10">\glossaryheader </span>to +do a header row. +</p><!--l. 13023--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166020"></a> <span class="cmtt-10">\glsgroupheading{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12023--><p class="noindent" > -This macro indicates what to do at the start of each logical block within the main body of -the glossary. If you use <a +</p><!--l. 13025--><p class="noindent" > +This macro indicates what to do at the start of each logical block within the main body of the glossary. If you +use <a href="#glo:makeindex"><span class="cmtt-10">makeindex</span><a - id="dx1-88021"></a></a> the glossary is sub-divided into a maximum of -twenty-eight logical blocks that are determined by the first character of the <span -class="cmss-10">sort</span><a - id="dx1-88022"></a> key (or -<span -class="cmss-10">name</span><a - id="dx1-88023"></a> key if the <span -class="cmss-10">sort</span><a - id="dx1-88024"></a> key is omitted). The sub-divisions are in the following order: -symbols, numbers, A, …, Z. If you use <a + id="dx1-166021"></a></a> the glossary is sub-divided into a maximum of twenty-eight logical blocks that are determined by +the first character of the <span +class="cmtt-10">sort</span><a + id="dx1-166022"></a> key (or <span +class="cmtt-10">name</span><a + id="dx1-166023"></a> key if the <span +class="cmtt-10">sort</span><a + id="dx1-166024"></a> key is omitted). The sub-divisions are in the +following order: symbols, numbers, A, …, Z. If you use <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-88025"></a></a>, the sub-divisions depend on the language + id="dx1-166025"></a></a>, the sub-divisions depend on the language settings. - - -</p><!--l. 12034--><p class="indent" > Note that the argument to <span +</p><!--l. 13036--><p class="indent" > Note that the argument to <span class="cmtt-10">\glsgroupheading </span>is a label <span -class="cmti-10">not </span>the group title. The group -title can be obtained via -</p><!--l. 12037--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsgetgrouptitle</span><span -class="cmtt-9"> </span></span><a - id="dx1-88026"></a> <span +class="cmti-10">not </span>the group title. The group title can be obtained +via +</p><!--l. 13039--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166026"></a> <span class="cmtt-10">\glsgetgrouptitle{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12039--><p class="noindent" > + + +</p><!--l. 13041--><p class="noindent" > This obtains the title as follows: if ⟨<span class="cmti-10">label</span>⟩ consists of a single non-active character or ⟨<span -class="cmti-10">label</span>⟩ is -equal to <span -class="cmtt-10">glssymbols </span>or <span +class="cmti-10">label</span>⟩ is equal to <span +class="cmtt-10">glssymbols</span> +or <span class="cmtt-10">glsnumbers </span>and <span class="cmtt-10">\</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">groupname </span>exists, this is taken to be the title, -otherwise the title is just ⟨<span -class="cmti-10">label</span>⟩. (The “symbols” group has the label <span -class="cmtt-10">glssymbols</span>, so the -command <span +class="cmtt-10">groupname </span>exists, this is taken to be the title, otherwise the title is just ⟨<span +class="cmti-10">label</span>⟩. +(The “symbols” group has the label <span +class="cmtt-10">glssymbols</span>, so the command <span class="cmtt-10">\glssymbolsgroupname</span><a - id="dx1-88027"></a> is used, and the “numbers” group has the label -<span + id="dx1-166027"></a> is used, +and the “numbers” group has the label <span class="cmtt-10">glsnumbers</span>, so the command <span class="cmtt-10">\glsnumbersgrouptitle</span><a - id="dx1-88028"></a> is used.) If you are using <a + id="dx1-166028"></a> is +used.) If you are using <a href="#glo:xindy"><span class="cmtt-10">xindy</span><a - id="dx1-88029"></a></a>, -⟨<span -class="cmti-10">label</span>⟩ may be an active character (for example ø), in which case the title will be set -to just ⟨<span + id="dx1-166029"></a></a>, ⟨<span +class="cmti-10">label</span>⟩ may be an active character (for example ø), in which case the +title will be set to just ⟨<span class="cmti-10">label</span>⟩. You can redefine <span class="cmtt-10">\glsgetgrouptitle </span>if this is unsuitable for your document. -</p><!--l. 12053--><p class="indent" > A navigation hypertarget can be created using -</p><!--l. 12054--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnavhypertarget</span><span -class="cmtt-9"> </span></span><a - id="dx1-88030"></a> <span +</p><!--l. 13055--><p class="indent" > A navigation hypertarget can be created using +</p><!--l. 13056--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166030"></a> <span class="cmtt-10">\glsnavhypertarget{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12056--><p class="noindent" > +</p><!--l. 13058--><p class="noindent" > This typically requires <span class="cmtt-10">\glossaryheader </span>to be redefined to use -</p><!--l. 12058--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsnavigation</span><span -class="cmtt-9"> </span></span><a - id="dx1-88031"></a> <span +</p><!--l. 13060--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166031"></a> <span class="cmtt-10">\glsnavigation </span></div><hr> -</p><!--l. 12060--><p class="noindent" > +</p><!--l. 13062--><p class="noindent" > which displays the navigation line. -</p><!--l. 12063--><p class="indent" > For further details about <span -class="cmtt-10">\glsnavhypertarget</span>, see the documented code -(<span +</p><!--l. 13065--><p class="indent" > For further details about <span +class="cmtt-10">\glsnavhypertarget</span>, see the documented code (<span class="cmtt-10">glossaries-code.pdf</span>). -</p><!--l. 12067--><p class="indent" > Most of the predefined glossary styles redefine <span -class="cmtt-10">\glsgroupheading </span>to simply ignore its -argument. The <span +</p><!--l. 13069--><p class="indent" > Most of the predefined glossary styles redefine <span +class="cmtt-10">\glsgroupheading </span>to simply ignore its argument. The +<span class="cmss-10">listhypergroup</span><a - id="dx1-88032"></a> style redefines <span + id="dx1-166032"></a> style redefines <span class="cmtt-10">\glsgroupheading </span>as follows: - - + + </p> - <div class="verbatim" id="verbatim-380"> + <div class="verbatim" id="verbatim-379"> \renewcommand*{\glsgroupheading}[1]{%  <br />\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} </div> -<!--l. 12073--><p class="nopar" > See also <span -class="cmtt-10">\glsgroupskip </span>below. (Note that command definitions within <span +<!--l. 13075--><p class="nopar" > See also <span +class="cmtt-10">\glsgroupskip </span>below. +</p><!--l. 13078--><p class="indent" > Note that command definitions within <span class="cmtt-10">\newglossarystyle</span><a - id="dx1-88033"></a> -must use <span class="obeylines-h"><span class="verb"><span + id="dx1-166033"></a> must use <span class="obeylines-h"><span class="verb"><span class="cmtt-10">##1</span></span></span> instead of <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">#1</span></span></span> etc.) -</p><!--l. 12077--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsgroupskip</span><span -class="cmtt-9"> </span></span><a - id="dx1-88034"></a> <span +class="cmtt-10">#1</span></span></span> etc. +</p><!--l. 13081--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166034"></a> <span class="cmtt-10">\glsgroupskip </span></div><hr> -</p><!--l. 12079--><p class="noindent" > -This macro determines what to do after one logical group but before the header for the -next logical group. The <span -class="cmss-10">list</span><a - id="dx1-88035"></a> glossary style simply redefines <span -class="cmtt-10">\glsgroupskip </span>to be +</p><!--l. 13083--><p class="noindent" > +This macro determines what to do after one logical group but before the header for the next logical group. The <span +class="cmss-10">list</span><a + id="dx1-166035"></a> glossary style simply redefines <span +class="cmtt-10">\glsgroupskip </span>to be <span class="cmtt-10">\indexspace</span><a - id="dx1-88036"></a>, whereas the tabular-like styles redefine <span -class="cmtt-10">\glsgroupskip </span>to produce a blank -row. -</p><!--l. 12086--><p class="indent" > As from version 3.03, the package option <span + id="dx1-166036"></a>, whereas the tabular-like styles redefine +<span +class="cmtt-10">\glsgroupskip </span>to produce a blank row. +</p><!--l. 13090--><p class="indent" > As from version 3.03, the package option <span class="cmss-10">nogroupskip</span><a - id="dx1-88037"></a> can be used to suppress this default -gap for the predefined styles. -</p><!--l. 12089--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glossentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-88038"></a> <span + id="dx1-166037"></a> can be used to suppress this default gap for the +predefined styles. +</p><!--l. 13093--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166038"></a> <span class="cmtt-10">\glossentry{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">number list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12091--><p class="noindent" > -This macro indicates what to do for each top-level (level 0) glossary entry. The entry label is -given by ⟨<span -class="cmti-10">label</span>⟩ and the associated <a +</p><!--l. 13095--><p class="noindent" > +This macro indicates what to do for each top-level (level 0) glossary entry. The entry label is given by ⟨<span +class="cmti-10">label</span>⟩ and +the associated <a href="#glo:numberlist">number list<a - id="dx1-88039"></a></a> is given by ⟨<span -class="cmti-10">number list</span>⟩. You can redefine -<span + id="dx1-166039"></a></a> is given by ⟨<span +class="cmti-10">number list</span>⟩. You can redefine <span class="cmtt-10">\glossentry</span><a - id="dx1-88040"></a> to use commands like <span + id="dx1-166040"></a> to use commands like +<span class="cmtt-10">\glossentryname</span><a - id="dx1-88041"></a><span + id="dx1-166041"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}</span>, <span class="cmtt-10">\glossentrydesc</span><a - id="dx1-88042"></a><span + id="dx1-166042"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">} </span>and -<span +class="cmtt-10">} </span>and <span class="cmtt-10">\glossentrysymbol</span><a - id="dx1-88043"></a><span + id="dx1-166043"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">} </span>to display the name, description and symbol fields, or -to access other fields, use commands like <span +class="cmtt-10">} </span>to display the name, +description and symbol fields, or to access other fields, use commands like <span class="cmtt-10">\glsentryuseri</span><a - id="dx1-88044"></a><span + id="dx1-166044"></a><span class="cmtt-10">{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}</span>. (See <a -href="#sec:glsnolink"><span -class="tcrm-1000">§</span>9 </a><a -href="#sec:glsnolink">Using -Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> for further details.) You can also use the following +class="cmtt-10">}</span>. +(See <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a> for further details.) You can also use the following commands: -</p><!--l. 12102--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-88045"></a> <span +</p><!--l. 13106--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166045"></a> <span class="cmtt-10">\glsentryitem{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12104--><p class="noindent" > -This macro will increment and display the associated counter for the main (level 0) entries if -the <span +</p><!--l. 13108--><p class="noindent" > +This macro will increment and display the associated counter for the main (level 0) entries if the <span class="cmss-10">entrycounter</span><a - id="dx1-88046"></a> or <span + id="dx1-166046"></a> or +<span class="cmss-10">counterwithin</span><a - id="dx1-88047"></a> package options have been used. This macro is typically -called by <span -class="cmtt-10">\glossentry </span>before <span -class="cmtt-10">\glstarget</span>. The format of the counter is controlled by the -macro -</p><!--l. 12110--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentrycounterlabel</span><span -class="cmtt-9"> </span></span><a - id="dx1-88048"></a> <span + id="dx1-166047"></a> package options have been used. This macro is typically called by <span +class="cmtt-10">\glossentry </span>before +<span +class="cmtt-10">\glstarget</span>. The format of the counter is controlled by the macro +</p><!--l. 13114--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166048"></a> <span class="cmtt-10">\glsentrycounterlabel </span></div><hr> -</p><!--l. 12112--><p class="noindent" > -</p><!--l. 12114--><p class="indent" > Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the -relevant line in the glossary. Your new glossary style must therefore redefine <span -class="cmtt-10">\glossentry </span>to -set the appropriate target. This is done using -</p><!--l. 12119--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glstarget</span><span -class="cmtt-9"> </span></span><a - id="dx1-88049"></a> <span +</p><!--l. 13116--><p class="noindent" > +</p><!--l. 13118--><p class="indent" > Each time you use a glossary entry it creates a hyperlink (if hyperlinks are enabled) to the relevant line in +the glossary. Your new glossary style must therefore redefine <span +class="cmtt-10">\glossentry </span>to set the appropriate target. This is +done using +</p><!--l. 13123--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166049"></a> <span class="cmtt-10">\glstarget{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">text</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12121--><p class="noindent" > +</p><!--l. 13125--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the entry’s label. Note that you don’t need to worry about whether the <span class="cmss-10">hyperref</span><a - id="dx1-88050"></a> -package has been loaded, as <span + id="dx1-166050"></a> package has been +loaded, as <span class="cmtt-10">\glstarget </span>won’t create a target if <span -class="cmtt-10">\hypertarget </span>hasn’t been -defined. -</p><!--l. 12127--><p class="indent" > For example, the <span +class="cmtt-10">\hypertarget </span>hasn’t been defined. +</p><!--l. 13131--><p class="indent" > For example, the <span class="cmss-10">list</span><a - id="dx1-88051"></a> style defines <span + id="dx1-166051"></a> style defines <span class="cmtt-10">\glossentry </span>as follows: - - + + </p> - <div class="verbatim" id="verbatim-381"> + <div class="verbatim" id="verbatim-380">   \renewcommand*{\glossentry}[2]{%  <br />    \item[\glsentryitem{##1}%  <br />          \glstarget{##1}{\glossentryname{##1}}]  <br />       \glossentrydesc{##1}\glspostdescription\space ##2} </div> -<!--l. 12133--><p class="nopar" > -</p><!--l. 12135--><p class="indent" > Note also that ⟨<span +<!--l. 13137--><p class="nopar" > +</p><!--l. 13139--><p class="indent" > Note also that ⟨<span class="cmti-10">number list</span>⟩ will always be of the form -</p><!--l. 12137--><p class="indent" > <hr><div title="Definition"><span +</p><!--l. 13141--><p class="indent" > <hr><div title="Definition"><span class="cmtt-10">\glossaryentrynumbers</span><a - id="dx1-88052"></a><span + id="dx1-166052"></a><span class="cmsy-10">{</span><span class="cmtt-10">\relax</span><br class="newline" /><span class="cmtt-10">\setentrycounter</span><a - id="dx1-88053"></a><span + id="dx1-166053"></a><span class="cmtt-10">[</span>⟨<span class="cmitt-10">Hprefix</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -24652,47 +26327,43 @@ class="cmtt-10">{</span>⟨<span class="cmitt-10">number(s)</span>⟩<span class="cmtt-10">}</span><span class="cmsy-10">} </span></div><hr> -</p><!--l. 12139--><p class="noindent" > +</p><!--l. 13143--><p class="noindent" > where ⟨<span class="cmti-10">number(s)</span>⟩ may contain <span class="cmtt-10">\delimN</span><a - id="dx1-88054"></a> (to delimit individual numbers) and/or <span + id="dx1-166054"></a> (to delimit individual numbers) and/or <span class="cmtt-10">\delimR</span><a - id="dx1-88055"></a> (to -indicate a range of numbers). There may be multiple occurrences of <span + id="dx1-166055"></a> (to indicate a range of +numbers). There may be multiple occurrences of <span class="cmtt-10">\setentrycounter</span><a - id="dx1-88056"></a> -<span + id="dx1-166056"></a><span class="cmtt-10">[</span>⟨<span class="cmti-10">Hprefix</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">counter name</span>⟩<span class="cmtt-10">}</span>⟨<span -class="cmti-10">format cmd</span>⟩<span +class="cmti-10">format cmd</span>⟩ +<span class="cmtt-10">{</span>⟨<span class="cmti-10">number(s)</span>⟩<span -class="cmtt-10">}</span>, but note that the entire number list is -enclosed within the argument of <span +class="cmtt-10">}</span>, but note that the entire number list is enclosed within the argument of <span class="cmtt-10">\glossaryentrynumbers</span><a - id="dx1-88057"></a>. The user can redefine this to -change the way the entire number list is formatted, regardless of the glossary style. + id="dx1-166057"></a>. +The user can redefine this to change the way the entire number list is formatted, regardless of the glossary style. However the most common use of <span class="cmtt-10">\glossaryentrynumbers</span><a - id="dx1-88058"></a> is to provide a means of -suppressing the number list altogether. (In fact, the <span + id="dx1-166058"></a> is to provide a means of suppressing the number list +altogether. (In fact, the <span class="cmss-10">nonumberlist</span><a - id="dx1-88059"></a> option redefines -<span + id="dx1-166059"></a> option redefines <span class="cmtt-10">\glossaryentrynumbers</span><a - id="dx1-88060"></a> to ignore its argument.) Therefore, when you define a new glossary -style, you don’t need to worry about whether the user has specified the <span + id="dx1-166060"></a> to ignore its argument.) +Therefore, when you define a new glossary style, you don’t need to worry about whether the user has specified +the <span class="cmss-10">nonumberlist</span><a - id="dx1-88061"></a> package -option. -</p><!--l. 12156--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\subglossentry</span><span -class="cmtt-9"> </span></span><a - id="dx1-88062"></a> <span + id="dx1-166061"></a> package option. +</p><!--l. 13160--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166062"></a> <span class="cmtt-10">\subglossentry{</span>⟨<span class="cmitt-10">level</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -24700,92 +26371,83 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">number list</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12158--><p class="noindent" > +</p><!--l. 13162--><p class="noindent" > This is used to display sub-entries. The first argument, ⟨<span -class="cmti-10">level</span>⟩, indicates the sub-entry level. -This must be an integer from 1 (first sub-level) onwards. The remaining arguments are -analogous to those for <span +class="cmti-10">level</span>⟩, indicates the sub-entry level. This must be an +integer from 1 (first sub-level) onwards. The remaining arguments are analogous to those for <span class="cmtt-10">\glossentry</span><a - id="dx1-88063"></a> described above. -</p><!--l. 12165--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssubentryitem</span><span -class="cmtt-9"> </span></span><a - id="dx1-88064"></a> <span + id="dx1-166063"></a> +described above. +</p><!--l. 13169--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166064"></a> <span class="cmtt-10">\glssubentryitem{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12167--><p class="noindent" > -This macro will increment and display the associated counter for the level 1 entries if the -<span +</p><!--l. 13171--><p class="noindent" > +This macro will increment and display the associated counter for the level 1 entries if the <span class="cmss-10">subentrycounter</span><a - id="dx1-88065"></a> package option has been used. This macro is typically called by -<span + id="dx1-166065"></a> +package option has been used. This macro is typically called by <span class="cmtt-10">\subglossentry </span>before <span class="cmtt-10">\glstarget</span><a - id="dx1-88066"></a>. The format of the counter is controlled by the -macro -</p><!--l. 12173--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glssubentrycounterlabel</span><span -class="cmtt-9"> </span></span><a - id="dx1-88067"></a> <span + id="dx1-166066"></a>. The +format of the counter is controlled by the macro +</p><!--l. 13177--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166067"></a> <span class="cmtt-10">\glssubentrycounterlabel </span></div><hr> -</p><!--l. 12175--><p class="noindent" > -</p><!--l. 12177--><p class="indent" > Note that <span +</p><!--l. 13179--><p class="noindent" > +</p><!--l. 13181--><p class="indent" > Note that <span class="cmtt-10">\printglossary</span><a - id="dx1-88068"></a> (which <span + id="dx1-166068"></a> (which <span class="cmtt-10">\printglossaries</span><a - id="dx1-88069"></a> calls) sets -</p><!--l. 12179--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\currentglossary</span><span -class="cmtt-9"> </span></span><a - id="dx1-88070"></a> <span + id="dx1-166069"></a> calls) sets +</p><!--l. 13183--><p class="indent" > <hr><div title="Definition"><a + id="dx1-166070"></a> <span class="cmtt-10">\currentglossary </span></div><hr> -</p><!--l. 12181--><p class="noindent" > -to the current glossary label, so it’s possible to create a glossary style that varies according to -the glossary type. -</p><!--l. 12185--><p class="indent" > For further details of these commands, see “Displaying the glossary” in the documented -code (<span +</p><!--l. 13185--><p class="noindent" > +to the current glossary label, so it’s possible to create a glossary style that varies according to the glossary +type. +</p><!--l. 13189--><p class="indent" > For further details of these commands, see “Displaying the glossary” in the documented code +(<span class="cmtt-10">glossaries-code.pdf</span>). - - <a - id="x1-88071r27"></a> -</p><!--l. 12189--><p class="noindent" ><span + id="sec:exnewstyle"></a> +</p><!--l. 13193--><p class="noindent" ><span class="cmbx-12">Example 27</span><span class="cmbx-12"> (Creating a completely new style)</span><a - id="x1-88072"></a> -</p><!--l. 12191--><p class="indent" > If you want a completely new style, you will need to redefine all of the commands and the -environment listed above. -</p><!--l. 12194--><p class="indent" > For example, suppose you want each entry to start with a bullet point. This -means that the glossary should be placed in the <span + id="x1-166072"></a> +</p><!--l. 13195--><p class="indent" > If you want a completely new style, you will need to redefine all of the commands and the environment listed + + +above. +</p><!--l. 13198--><p class="indent" > For example, suppose you want each entry to start with a bullet point. This means that the glossary should +be placed in the <span class="cmss-10">itemize</span><a - id="dx1-88073"></a><a - id="dx1-88074"></a> environment, so <span + id="dx1-166073"></a><a + id="dx1-166074"></a> environment, so <span class="cmss-10">theglossary</span><a - id="dx1-88075"></a><a - id="dx1-88076"></a> -should start and end that environment. Let’s also suppose that you don’t want -anything between the glossary groups (so <span + id="dx1-166075"></a><a + id="dx1-166076"></a> should start and end that environment. Let’s also suppose +that you don’t want anything between the glossary groups (so <span class="cmtt-10">\glsgroupheading</span><a - id="dx1-88077"></a> and <span + id="dx1-166077"></a> and <span class="cmtt-10">\glsgroupskip</span><a - id="dx1-88078"></a> -should do nothing) and suppose you don’t want anything to appear immediately -after <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\begin{theglossary}</span></span></span> (so <span + id="dx1-166078"></a> should +do nothing) and suppose you don’t want anything to appear immediately after <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\begin{theglossary}</span></span></span> (so +<span class="cmtt-10">\glossaryheader</span><a - id="dx1-88079"></a> should do nothing). In addition, -let’s suppose the symbol should appear in brackets after the name, followed by the -description and last of all the <a + id="dx1-166079"></a> should do nothing). In addition, let’s suppose the symbol should appear in brackets +after the name, followed by the description and last of all the <a href="#glo:numberlist">number list<a - id="dx1-88080"></a></a> should appear within square brackets -at the end. Then you can create this new glossary style, called, say, <span + id="dx1-166080"></a></a> should appear within +square brackets at the end. Then you can create this new glossary style, called, say, <span class="cmtt-10">mylist</span>, as follows: - - + + </p> - <div class="verbatim" id="verbatim-382"> + <div class="verbatim" id="verbatim-381">  \newglossarystyle{mylist}{%  <br /> % put the glossary in the itemize environment:  <br /> \renewenvironment{theglossary}% @@ -24808,40 +26470,37 @@ follows:  <br />   \glossentry{##2}{##3}}%  <br /> } </div> -<!--l. 12228--><p class="nopar" > Note that this style creates a flat glossary, where sub-entries are displayed in exactly the -same way as the top level entries. It also hasn’t used <span +<!--l. 13232--><p class="nopar" > Note that this style creates a flat glossary, where sub-entries are displayed in exactly the same way as the top +level entries. It also hasn’t used <span class="cmtt-10">\glsentryitem</span><a - id="dx1-88081"></a> or <span + id="dx1-166081"></a> or <span class="cmtt-10">\glssubentryitem</span><a - id="dx1-88082"></a> so -it won’t be affected by the <span + id="dx1-166082"></a> so it won’t be affected by the +<span class="cmss-10">entrycounter</span><a - id="dx1-88083"></a>, <span + id="dx1-166083"></a>, <span class="cmss-10">counterwithin</span><a - id="dx1-88084"></a> or <span + id="dx1-166084"></a> or <span class="cmss-10">subentrycounter</span><a - id="dx1-88085"></a> package -options. -</p><!--l. 12235--><p class="indent" > Variations: </p> + id="dx1-166085"></a> package options. +</p><!--l. 13239--><p class="indent" > Variations: </p> <ul class="itemize1"> - <li class="itemize">You might want the entry name to be capitalised, in which case use - <span + <li class="itemize">You might want the entry name to be capitalised, in which case use <span class="cmtt-10">\Glossentryname</span><a - id="dx1-88086"></a> instead of <span + id="dx1-166086"></a> instead of + <span class="cmtt-10">\glossentryname</span><a - id="dx1-88087"></a>. + id="dx1-166087"></a>. </li> - <li class="itemize">You might want to check if the symbol hasn’t been set and omit the parentheses if - the symbol is absent. In this case you can use <span + <li class="itemize">You might want to check if the symbol hasn’t been set and omit the parentheses if the symbol is absent. In + this case you can use <span class="cmtt-10">\ifglshassymbol</span><a - id="dx1-88088"></a> (see <a -href="#sec:utilities"><span -class="tcrm-1000">§</span>16 - </a><a + id="dx1-166088"></a> (see <a +href="#sec:utilities">§16 </a><a href="#sec:utilities">Utilities<!--tex4ht:ref: sec:utilities --></a>): - - - <div class="verbatim" id="verbatim-383"> + + + <div class="verbatim" id="verbatim-382">  \renewcommand*{\glossentry}[2]{%  <br /> \item % bullet point  <br /> \glstarget{##1}{\glossentryname{##1}}% the entry name @@ -24854,82 +26513,79 @@ href="#sec:utilities">Utilities<!--tex4ht:ref: sec:utilities --></a>):  <br /> \space [##2]% the number list in square brackets  <br /> }% </div> - <!--l. 12255--><p class="nopar" ></p></li></ul> + <!--l. 13259--><p class="nopar" ></p></li></ul> <div class="center" > -<!--l. 12257--><p class="noindent" > -</p><!--l. 12257--><p class="noindent" >____________________________</p></div> +<!--l. 13261--><p class="noindent" > +</p><!--l. 13261--><p class="noindent" >____________________________</p></div> <a - id="x1-88089r28"></a> -<!--l. 12260--><p class="noindent" ><span + id="sec:exadaptstyle"></a> +<!--l. 13264--><p class="noindent" ><span class="cmbx-12">Example 28</span><span -class="cmbx-12"> (Creating a new glossary style based on an existing</span> +class="cmbx-12"> (Creating a new glossary style based on an existing style)</span><a + id="x1-166090"></a> +</p><!--l. 13266--><p class="indent" > If you want to define a new style that is a slightly modified version of an existing style, you can use <span -class="cmbx-12">style)</span><a - id="x1-88090"></a> -</p><!--l. 12262--><p class="indent" > If you want to define a new style that is a slightly modified version of an existing style, -you can use <span class="cmtt-10">\setglossarystyle</span><a - id="dx1-88091"></a> within the second argument of <span + id="dx1-166091"></a> within the second argument of <span class="cmtt-10">\newglossarystyle</span><a - id="dx1-88092"></a> followed -by whatever alterations you require. For example, suppose you want a style like -the <span + id="dx1-166092"></a> followed by whatever alterations you +require. For example, suppose you want a style like the <span class="cmss-10">list</span><a - id="dx1-88093"></a> style but you don’t want the extra vertical space created by <span + id="dx1-166093"></a> style but you don’t want the extra vertical space +created by <span class="cmtt-10">\indexspace</span><a - id="dx1-88094"></a> -between groups, then you can create a new glossary style called, say, <span + id="dx1-166094"></a> between groups, then you can create a new glossary style called, say, <span class="cmtt-10">mylist </span>as follows: - - + + </p> - <div class="verbatim" id="verbatim-384"> + <div class="verbatim" id="verbatim-383"> \newglossarystyle{mylist}{%  <br />\setglossarystyle{list}% base this style on the list style  <br />\renewcommand{\glsgroupskip}{}% make nothing happen  <br />                              % between groups  <br />} </div> -<!--l. 12276--><p class="nopar" > (In this case, you can actually achieve the same effect using the <span +<!--l. 13280--><p class="nopar" > (In this case, you can actually achieve the same effect using the <span class="cmss-10">list</span><a - id="dx1-88095"></a> style in combination with -the package option <span + id="dx1-166095"></a> style in combination with the package +option <span class="cmss-10">nogroupskip</span><a - id="dx1-88096"></a>.) </p> + id="dx1-166096"></a>.) </p> <div class="center" > -<!--l. 12280--><p class="noindent" > -</p><!--l. 12280--><p class="noindent" >____________________________</p></div> +<!--l. 13284--><p class="noindent" > +</p><!--l. 13284--><p class="noindent" >____________________________</p></div> <a - id="x1-88097r29"></a> -<!--l. 12284--><p class="noindent" ><span + id="sec:exuserstyle"></a> +<!--l. 13288--><p class="noindent" ><span class="cmbx-12">Example 29</span><span class="cmbx-12"> (Example: creating a glossary style that uses the </span><span -class="cmssbx-10x-x-120">user1</span><a - id="dx1-88098"></a><span -class="cmbx-12">,</span> -<span +class="cmtt-12">user1</span><a + id="dx1-166098"></a><span +class="cmbx-12">, </span><span class="cmbx-12">…, </span><span -class="cmssbx-10x-x-120">user6</span><a - id="dx1-88099"></a> <span -class="cmbx-12">keys)</span><a - id="x1-88100"></a> -</p><!--l. 12286--><p class="indent" > Suppose each entry not only has an associated symbol, but also units (stored in <span -class="cmss-10">user1</span><a - id="dx1-88101"></a>) and -dimension (stored in <span -class="cmss-10">user2</span><a - id="dx1-88102"></a>). Then you can define a glossary style that displays each entry in a +class="cmtt-12">user6</span><a + id="dx1-166099"></a> <span +class="cmbx-12">keys)</span><a + id="x1-166100"></a> +</p><!--l. 13290--><p class="indent" > Suppose each entry not only has an associated symbol, but also units (stored in <span +class="cmtt-10">user1</span><a + id="dx1-166101"></a>) and dimension +(stored in <span +class="cmtt-10">user2</span><a + id="dx1-166102"></a>). Then you can define a glossary style that displays each entry in a <span class="cmss-10">longtable</span><a - id="dx1-88103"></a><a - id="dx1-88104"></a> as follows: - - + id="dx1-166103"></a><a + id="dx1-166104"></a> as +follows: + + </p> - <div class="verbatim" id="verbatim-385"> + <div class="verbatim" id="verbatim-384"> \newglossarystyle{long6col}{%  <br /> % put the glossary in a longtable environment:  <br /> \renewenvironment{theglossary}% @@ -24968,37 +26624,40 @@ class="cmss-10">longtable</span><a  <br /> \renewcommand*{\glsgroupskip}{}%  <br />} </div> -<!--l. 12328--><p class="nopar" > </p> +<!--l. 13332--><p class="nopar" > </p> <div class="center" > -<!--l. 12329--><p class="noindent" > -</p><!--l. 12329--><p class="noindent" >____________________________</p></div> - - -<!--l. 12331--><p class="indent" > </div> -</p><!--l. 12331--><p class="noindent" ><a +<!--l. 13333--><p class="noindent" > +</p><!--l. 13333--><p class="noindent" >____________________________</p></div> + + +<!--l. 13335--><p class="indent" > </div> +</p><!--l. 13335--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">16. <a id="sec:utilities"></a>Utilities</h2> -</p><!--l. 12334--><p class="indent" > This section describes some utility commands. Additional commands can be found in the -documented code (glossaries-code.pdf). +</p><!--l. 13338--><p class="indent" > This section describes some utility commands. Additional commands can be found in the documented code +(glossaries-code.pdf). +</p><!--l. 13341--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides extra utility commands. See the “Utilities” section of the +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> manual. </div> +</p><!--l. 13344--><p class="noindent" > </p> -<!--l. 12337--><p class="noindent" ><a +<!--l. 13346--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">16.1 </span> <a id="sec:loops"></a>Loops</h3> -<!--l. 12340--><p class="noindent" ><div class="important" title="Important Note"> Some of the commands described here take a comma-separated list as an argument. As with -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +<!--l. 13349--><p class="noindent" ><div class="important" title="Important Note"> Some of the commands described here take a comma-separated list as an argument. As with <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span>’s <span -class="cmtt-10">\@for </span>command, make sure your list doesn’t have any unwanted spaces in it as -they don’t get stripped. (Discussed in more detail in <a -href="http://www.dickimaw-books.com/latex/admin/html/docsvlist.shtml#spacesinlists" ><span -class="tcrm-1000">§</span>2.7.2 of “<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span -class="E">E</span>X</span></span> for Administrative -Work”</a>.) </div> -</p><!--l. 12347--><p class="noindent" > -</p><!--l. 12349--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\forallglossaries</span><span -class="cmtt-9"> </span></span><a - id="dx1-90001"></a> <span +class="cmtt-10">\@for</span> +command, make sure your list doesn’t have any unwanted spaces in it as they don’t get stripped. (Discussed in +more detail in <a +href="http://www.dickimaw-books.com/latex/admin/html/docsvlist.shtml#spacesinlists" >§2.7.2 of “<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> for Administrative Work”</a>.) </div> +</p><!--l. 13356--><p class="noindent" > +</p><!--l. 13358--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-168001"></a> <span class="cmtt-10">\forallglossaries[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25006,40 +26665,35 @@ class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">body</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12351--><p class="noindent" > +</p><!--l. 13360--><p class="noindent" > This iterates through ⟨<span -class="cmti-10">glossary list</span>⟩, a comma-separated list of glossary labels (as -supplied when the glossary was defined). At each iteration ⟨<span -class="cmti-10">cs</span>⟩ (which must be a control -sequence) is set to the glossary label for the current iteration and ⟨<span -class="cmti-10">body</span>⟩ is performed. If -⟨<span -class="cmti-10">glossary list</span>⟩ is omitted, the default is to iterate over all glossaries (except the ignored -ones). -</p><!--l. 12359--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\forallacronyms</span><span -class="cmtt-9"> </span></span><a - id="dx1-90002"></a> <span +class="cmti-10">glossary list</span>⟩, a comma-separated list of glossary labels (as supplied when the glossary was +defined). At each iteration ⟨<span +class="cmti-10">cs</span>⟩ (which must be a control sequence) is set to the glossary label for the current +iteration and ⟨<span +class="cmti-10">body</span>⟩ is performed. If ⟨<span +class="cmti-10">glossary list</span>⟩ is omitted, the default is to iterate over all glossaries (except the +ignored ones). +</p><!--l. 13368--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-168002"></a> <span class="cmtt-10">\forallacronyms{</span>⟨<span class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">body</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12361--><p class="noindent" > +</p><!--l. 13370--><p class="noindent" > This is like <span -class="cmtt-10">\forallglossaries </span>but only iterates over the lists of acronyms (that have -previously been declared using <span +class="cmtt-10">\forallglossaries </span>but only iterates over the lists of acronyms (that have previously been declared +using <span class="cmtt-10">\DeclareAcronymList</span><a - id="dx1-90003"></a> or the <span + id="dx1-168003"></a> or the <span class="cmss-10">acronymlists</span><a - id="dx1-90004"></a> package option). -This command doesn’t have an optional argument. If you want to explicitly say which lists to -iterate over, just use the optional argument of <span + id="dx1-168004"></a> package option). This command doesn’t have an optional +argument. If you want to explicitly say which lists to iterate over, just use the optional argument of +<span class="cmtt-10">\forallglossaries</span>. -</p><!--l. 12369--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\forglsentries</span><span -class="cmtt-9"> </span></span><a - id="dx1-90005"></a> <span +</p><!--l. 13378--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-168005"></a> <span class="cmtt-10">\forglsentries[</span>⟨<span class="cmitt-10">glossary label</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25047,21 +26701,18 @@ class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">body</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12371--><p class="noindent" > +</p><!--l. 13380--><p class="noindent" > This iterates through all entries in the glossary given by ⟨<span class="cmti-10">glossary label</span>⟩. At each iteration ⟨<span -class="cmti-10">cs</span>⟩ -(which must be a control sequence) is set to the entry label for the current iteration and ⟨<span -class="cmti-10">body</span>⟩ -is performed. If ⟨<span -class="cmti-10">glossary label</span>⟩ is omitted, <span +class="cmti-10">cs</span>⟩ (which must be a +control sequence) is set to the entry label for the current iteration and ⟨<span +class="cmti-10">body</span>⟩ is performed. If ⟨<span +class="cmti-10">glossary label</span>⟩ is +omitted, <span class="cmtt-10">\glsdefaulttype</span><a - id="dx1-90006"></a> (usually the main glossary) is -used. -</p><!--l. 12378--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\forallglsentries</span><span -class="cmtt-9"> </span></span><a - id="dx1-90007"></a> <span + id="dx1-168006"></a> (usually the main glossary) is used. +</p><!--l. 13387--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-168007"></a> <span class="cmtt-10">\forallglsentries[</span>⟨<span class="cmitt-10">glossary list</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25069,113 +26720,98 @@ class="cmitt-10">cs</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">body</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12380--><p class="noindent" > +</p><!--l. 13389--><p class="noindent" > This is like <span class="cmtt-10">\forglsentries </span>but for each glossary in ⟨<span -class="cmti-10">glossary list</span>⟩ (a comma-separated list of -glossary labels). If ⟨<span -class="cmti-10">glossary list</span>⟩ is omitted, the default is the list of all defined glossaries -(except the ignored ones). At each iteration ⟨<span +class="cmti-10">glossary list</span>⟩ (a comma-separated list of glossary labels). If +⟨<span +class="cmti-10">glossary list</span>⟩ is omitted, the default is the list of all defined glossaries (except the ignored ones). At each iteration +⟨<span class="cmti-10">cs</span>⟩ is set to the entry label and ⟨<span -class="cmti-10">body</span>⟩ is -performed. (The current glossary label can be obtained using <span +class="cmti-10">body</span>⟩ is performed. (The current glossary label can be obtained using +<span class="cmtt-10">\glsentrytype{</span>⟨<span class="cmti-10">cs</span>⟩<span -class="cmtt-10">} </span>within -⟨<span +class="cmtt-10">} </span>within ⟨<span class="cmti-10">body</span>⟩.) -</p><!--l. 12389--><p class="noindent" > +</p><!--l. 13398--><p class="noindent" > </p> -<!--l. 12389--><p class="noindent" ><a +<!--l. 13398--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">16.2 </span> <a id="sec:conditionals"></a>Conditionals</h3> -<!--l. 12392--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglossaryexists</span><span -class="cmtt-9"> </span></span><a - id="dx1-91001"></a> <span +<!--l. 13401--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169001"></a> <span class="cmtt-10">\ifglossaryexists</span>⟨<span class="cmitt-10">label</span>⟩⟨<span class="cmitt-10">true part</span>⟩⟨<span class="cmitt-10">false part</span>⟩ </div><hr> - - -</p><!--l. 12395--><p class="noindent" > + + +</p><!--l. 13404--><p class="noindent" > This checks if the glossary given by ⟨<span class="cmti-10">label</span>⟩ exists. If it does ⟨<span -class="cmti-10">true part</span>⟩ is performed, otherwise -⟨<span -class="cmti-10">false part</span>⟩. -</p><!--l. 12399--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsentryexists</span><span -class="cmtt-9"> </span></span><a - id="dx1-91002"></a> <span +class="cmti-10">true part</span>⟩ is performed, otherwise ⟨<span +class="cmti-10">false</span> +<span +class="cmti-10">part</span>⟩. +</p><!--l. 13408--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169002"></a> <span class="cmtt-10">\ifglsentryexists</span>⟨<span class="cmitt-10">label</span>⟩⟨<span class="cmitt-10">true part</span>⟩⟨<span class="cmitt-10">false part</span>⟩ </div><hr> -</p><!--l. 12402--><p class="noindent" > +</p><!--l. 13411--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ exists. If it does ⟨<span -class="cmti-10">true part</span>⟩ is performed, -otherwise ⟨<span -class="cmti-10">false part</span>⟩. (Note that <span -class="cmtt-10">\ifglsentryexists </span>will always be true after the containing -glossary has been displayed via <span +class="cmti-10">true part</span>⟩ is performed, otherwise ⟨<span +class="cmti-10">false part</span>⟩. +(Note that <span +class="cmtt-10">\ifglsentryexists </span>will always be true after the containing glossary has been displayed via +<span class="cmtt-10">\printglossary</span><a - id="dx1-91003"></a> or <span + id="dx1-169003"></a> or <span class="cmtt-10">\printglossaries</span><a - id="dx1-91004"></a> even if the entry is -explicitly defined later in the document. This is because the entry has to be defined -before it can be displayed in the glossary, see <a -href="#sec:techissues"><span -class="tcrm-1000">§</span>4.8.1 </a><a -href="#sec:techissues">Technical Issues<!--tex4ht:ref: sec:techissues --></a> for further -details.) -</p><!--l. 12412--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdoifexists</span><span -class="cmtt-9"> </span></span><a - id="dx1-91005"></a> <span + id="dx1-169004"></a> even if the entry is explicitly defined later in the document. This is +because the entry has to be defined before it can be displayed in the glossary, see <a +href="#sec:techissues">§4.8.1 </a><a +href="#sec:techissues">Technical Issues<!--tex4ht:ref: sec:techissues --></a> for +further details.) +</p><!--l. 13421--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169005"></a> <span class="cmtt-10">\glsdoifexists{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12414--><p class="noindent" > +</p><!--l. 13423--><p class="noindent" > Does ⟨<span class="cmti-10">code</span>⟩ if the entry given by ⟨<span -class="cmti-10">label</span>⟩ exists. If it doesn’t exist, an error is generated. (This -command uses <span +class="cmti-10">label</span>⟩ exists. If it doesn’t exist, an error is generated. (This command uses +<span class="cmtt-10">\ifglsentryexists</span>.) -</p><!--l. 12419--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdoifnoexists</span><span -class="cmtt-9"> </span></span><a - id="dx1-91006"></a> <span +</p><!--l. 13428--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169006"></a> <span class="cmtt-10">\glsdoifnoexists{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12421--><p class="noindent" > +</p><!--l. 13430--><p class="noindent" > Does the reverse of <span class="cmtt-10">\glsdoifexists</span>. (This command uses <span class="cmtt-10">\ifglsentryexists</span>.) -</p><!--l. 12425--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdoifexistsorwarn</span><span -class="cmtt-9"> </span></span><a - id="dx1-91007"></a> <span +</p><!--l. 13434--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169007"></a> <span class="cmtt-10">\glsdoifexistsorwarn{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12427--><p class="noindent" > +</p><!--l. 13436--><p class="noindent" > As <span -class="cmtt-10">\glsdoifexists </span>but issues a warning rather than an error if the entry doesn’t -exist. -</p><!--l. 12431--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdoifexistsordo</span><span -class="cmtt-9"> </span></span><a - id="dx1-91008"></a> <span +class="cmtt-10">\glsdoifexists </span>but issues a warning rather than an error if the entry doesn’t exist. +</p><!--l. 13440--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169008"></a> <span class="cmtt-10">\glsdoifexistsordo{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25183,17 +26819,13 @@ class="cmitt-10">code</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">else code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12433--><p class="noindent" > +</p><!--l. 13442--><p class="noindent" > Does ⟨<span class="cmti-10">code</span>⟩ if the entry given by ⟨<span class="cmti-10">label</span>⟩ exists otherwise generate an error and do ⟨<span -class="cmti-10">else</span> -<span -class="cmti-10">code</span>⟩. -</p><!--l. 12437--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsdoifnoexistsordo</span><span -class="cmtt-9"> </span></span><a - id="dx1-91009"></a> <span +class="cmti-10">else code</span>⟩. +</p><!--l. 13446--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169009"></a> <span class="cmtt-10">\glsdoifnoexistsordo{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25201,58 +26833,47 @@ class="cmitt-10">code</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">else code</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12439--><p class="noindent" > +</p><!--l. 13448--><p class="noindent" > Does ⟨<span class="cmti-10">code</span>⟩ if the entry given by ⟨<span class="cmti-10">label</span>⟩ doesn’t exist otherwise generate an error and do ⟨<span -class="cmti-10">else</span> -<span -class="cmti-10">code</span>⟩. -</p><!--l. 12443--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsused</span><span -class="cmtt-9"> </span></span><a - id="dx1-91010"></a> <span +class="cmti-10">else code</span>⟩. +</p><!--l. 13452--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169010"></a> <span class="cmtt-10">\ifglsused</span>⟨<span class="cmitt-10">label</span>⟩⟨<span class="cmitt-10">true part</span>⟩⟨<span class="cmitt-10">false part</span>⟩ </div><hr> -</p><!--l. 12446--><p class="noindent" > +</p><!--l. 13455--><p class="noindent" > See <a -href="#sec:glsunset"><span -class="tcrm-1000">§</span>14 </a><a +href="#sec:glsunset">§14 </a><a href="#sec:glsunset">Unsetting and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. -</p><!--l. 12449--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshaschildren</span><span -class="cmtt-9"> </span></span><a - id="dx1-91011"></a> <span +</p><!--l. 13458--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169011"></a> <span class="cmtt-10">\ifglshaschildren</span>⟨<span class="cmitt-10">label</span>⟩⟨<span class="cmitt-10">true part</span>⟩⟨<span class="cmitt-10">false part</span>⟩ </div><hr> -</p><!--l. 12452--><p class="noindent" > +</p><!--l. 13461--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ has any sub-entries. If it does, ⟨<span -class="cmti-10">true part</span>⟩ is -performed, otherwise ⟨<span +class="cmti-10">true part</span>⟩ is performed, otherwise +⟨<span class="cmti-10">false part</span>⟩. -</p><!--l. 12457--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasparent</span><span -class="cmtt-9"> </span></span><a - id="dx1-91012"></a> <span +</p><!--l. 13466--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169012"></a> <span class="cmtt-10">\ifglshasparent</span>⟨<span class="cmitt-10">label</span>⟩⟨<span class="cmitt-10">true part</span>⟩⟨<span class="cmitt-10">false part</span>⟩ </div><hr> -</p><!--l. 12460--><p class="noindent" > +</p><!--l. 13469--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ has a parent entry. If it does, ⟨<span -class="cmti-10">true part</span>⟩ is -performed, otherwise ⟨<span +class="cmti-10">true part</span>⟩ is performed, otherwise +⟨<span class="cmti-10">false part</span>⟩. -</p><!--l. 12465--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshassymbol</span><span -class="cmtt-9"> </span></span><a - id="dx1-91013"></a> <span +</p><!--l. 13474--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169013"></a> <span class="cmtt-10">\ifglshassymbol{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25260,18 +26881,16 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12467--><p class="noindent" > +</p><!--l. 13476--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ has had the <span -class="cmss-10">symbol</span><a - id="dx1-91014"></a> field set. If it has, ⟨<span -class="cmti-10">true part</span>⟩ -is performed, otherwise ⟨<span +class="cmtt-10">symbol</span><a + id="dx1-169014"></a> field set. If it has, ⟨<span +class="cmti-10">true part</span>⟩ is performed, +otherwise ⟨<span class="cmti-10">false part</span>⟩. -</p><!--l. 12472--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshaslong</span><span -class="cmtt-9"> </span></span><a - id="dx1-91015"></a> <span +</p><!--l. 13481--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169015"></a> <span class="cmtt-10">\ifglshaslong{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25279,24 +26898,22 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> - - -</p><!--l. 12474--><p class="noindent" > +</p><!--l. 13483--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ has had the <span -class="cmss-10">long</span><a - id="dx1-91016"></a> field set. If it has, ⟨<span -class="cmti-10">true part</span>⟩ is -performed, otherwise ⟨<span -class="cmti-10">false part</span>⟩. This should be true for any entry that has been defined via -<span +class="cmtt-10">long</span><a + id="dx1-169016"></a> field set. If it has, ⟨<span +class="cmti-10">true part</span>⟩ is performed, +otherwise ⟨<span +class="cmti-10">false part</span>⟩. This should be true for any entry that has been defined via <span class="cmtt-10">\newacronym</span><a - id="dx1-91017"></a>. There is no check for the existence of ⟨<span + id="dx1-169017"></a>. There is no +check for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 12481--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasshort</span><span -class="cmtt-9"> </span></span><a - id="dx1-91018"></a> <span + + +</p><!--l. 13490--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169018"></a> <span class="cmtt-10">\ifglshasshort{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25304,22 +26921,20 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12483--><p class="noindent" > +</p><!--l. 13492--><p class="noindent" > This checks if the glossary entry given by ⟨<span class="cmti-10">label</span>⟩ has had the <span -class="cmss-10">short</span><a - id="dx1-91019"></a> field set. If it has, ⟨<span -class="cmti-10">true part</span>⟩ -is performed, otherwise ⟨<span -class="cmti-10">false part</span>⟩. This should be true for any entry that has been defined via -<span +class="cmtt-10">short</span><a + id="dx1-169019"></a> field set. If it has, ⟨<span +class="cmti-10">true part</span>⟩ is performed, +otherwise ⟨<span +class="cmti-10">false part</span>⟩. This should be true for any entry that has been defined via <span class="cmtt-10">\newacronym</span><a - id="dx1-91020"></a>. There is no check for the existence of ⟨<span + id="dx1-169020"></a>. There is no +check for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 12490--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasdesc</span><span -class="cmtt-9"> </span></span><a - id="dx1-91021"></a> <span +</p><!--l. 13499--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169021"></a> <span class="cmtt-10">\ifglshasdesc{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25327,43 +26942,38 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12492--><p class="noindent" > +</p><!--l. 13501--><p class="noindent" > This checks if the <span -class="cmss-10">description</span><a - id="dx1-91022"></a> field is non-empty for the entry given by ⟨<span +class="cmtt-10">description</span><a + id="dx1-169022"></a> field is non-empty for the entry given by ⟨<span class="cmti-10">label</span>⟩. If it has, ⟨<span -class="cmti-10">true part</span>⟩ -is performed, otherwise ⟨<span +class="cmti-10">true part</span>⟩ is performed, +otherwise ⟨<span class="cmti-10">false part</span>⟩. Compare with: -</p><!--l. 12496--><p class="noindent" ><hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsdescsuppressed</span><span -class="cmtt-9"> </span></span><a - id="dx1-91023"></a> <span +</p><!--l. 13505--><p class="noindent" ><hr><div title="Definition"><a + id="dx1-169023"></a> <span class="cmtt-10">\ifglsdescsuppressed{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12498--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13507--><p class="noindent" > This checks if the <span -class="cmss-10">description</span><a - id="dx1-91024"></a> field has been set to just <span +class="cmtt-10">description</span><a + id="dx1-169024"></a> field has been set to just <span class="cmtt-10">\nopostdesc</span><a - id="dx1-91025"></a> for the entry given by -⟨<span + id="dx1-169025"></a> for the entry given by ⟨<span class="cmti-10">label</span>⟩. If it has, ⟨<span -class="cmti-10">true part</span>⟩ is performed, otherwise ⟨<span -class="cmti-10">false part</span>⟩. There is no check for the existence -of ⟨<span +class="cmti-10">true</span> +<span +class="cmti-10">part</span>⟩ is performed, otherwise ⟨<span +class="cmti-10">false part</span>⟩. There is no check for the existence of ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 12504--><p class="noindent" >For all other fields you can use: -</p><!--l. 12505--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasfield</span><span -class="cmtt-9"> </span></span><a - id="dx1-91026"></a> <span +</p><!--l. 13513--><p class="noindent" >For all other fields you can use: +</p><!--l. 13514--><p class="indent" > <hr><div title="Definition"><a + id="dx1-169026"></a> <span class="cmtt-10">\ifglshasfield{</span>⟨<span class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25372,49 +26982,43 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12508--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13517--><p class="noindent" > This tests the value of the field given by ⟨<span class="cmti-10">field</span>⟩ for the entry identified by ⟨<span -class="cmti-10">label</span>⟩. If the value is -empty <span -class="cmti-10">or the default value</span>, then ⟨<span +class="cmti-10">label</span>⟩. If the value is empty <span +class="cmti-10">or the</span> +<span +class="cmti-10">default value</span>, then ⟨<span class="cmti-10">false part</span>⟩ is performed, otherwise ⟨<span -class="cmti-10">true part</span>⟩ is performed. If -the field supplied is unrecognised ⟨<span -class="cmti-10">false part</span>⟩ is performed and a warning is issued. -Unlike the above commands, such as <span -class="cmtt-10">\ifglshasshort</span>, an error occurs if the entry is -undefined. -</p><!--l. 12517--><p class="indent" > As from version 4.23, within ⟨<span +class="cmti-10">true part</span>⟩ is performed. If the field supplied is unrecognised +⟨<span +class="cmti-10">false part</span>⟩ is performed and a warning is issued. Unlike the above commands, such as <span +class="cmtt-10">\ifglshasshort</span>, an error +occurs if the entry is undefined. +</p><!--l. 13526--><p class="indent" > As from version 4.23, within ⟨<span class="cmti-10">true part</span>⟩ you can use -</p><!--l. 12518--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glscurrentfieldvalue</span><span -class="cmtt-9"> </span></span><a - id="dx1-91027"></a> <span +</p><!--l. 13527--><p class="indent" > <hr><div title="Definition"><a + id="dx1-169027"></a> <span class="cmtt-10">\glscurrentfieldvalue </span></div><hr> -</p><!--l. 12520--><p class="noindent" > -to access the field value. This command is initially defined to nothing but has no -relevance outside ⟨<span -class="cmti-10">true part</span>⟩. This saves re-accessing the field if the test is true. For -example: - - +</p><!--l. 13529--><p class="noindent" > +to access the field value. This command is initially defined to nothing but has no relevance outside ⟨<span +class="cmti-10">true part</span>⟩. +This saves re-accessing the field if the test is true. For example: + + </p> - <div class="verbatim" id="verbatim-386"> + <div class="verbatim" id="verbatim-385"> \ifglshasfield{useri}{sample}{, \glscurrentfieldvalue}{} </div> -<!--l. 12527--><p class="nopar" > will insert a comma, space and the field value if the <span -class="cmss-10">user1</span><a - id="dx1-91028"></a> key has been set for the entry -whose label is <span +<!--l. 13536--><p class="nopar" > will insert a comma, space and the field value if the <span +class="cmtt-10">user1</span><a + id="dx1-169028"></a> key has been set for the entry whose label is +<span class="cmtt-10">sample</span>. -</p><!--l. 12532--><p class="indent" > You can test if the value of the field is equal to a given string using: -</p><!--l. 12534--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsfieldeq</span><span -class="cmtt-9"> </span></span><a - id="dx1-91029"></a> <span +</p><!--l. 13541--><p class="indent" > You can test if the value of the field is equal to a given string using: +</p><!--l. 13543--><p class="indent" > <hr><div title="Definition"><a + id="dx1-169029"></a> <span class="cmtt-10">\ifglsfieldeq{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25425,26 +27029,24 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">true</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12536--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13545--><p class="noindent" > In this case the ⟨<span class="cmti-10">field</span>⟩ must be the field name not the key (see <a -href="#tab:fieldmap">table 4.1</a>). If the -field isn’t recognised, an error will occur. This command internally uses <span +href="#tab:fieldmap">table 4.1</a>). If the field isn’t recognised, an error will +occur. This command internally uses <span class="cmss-10">etoolbox</span><a - id="dx1-91030"></a>’s -<span + id="dx1-169030"></a>’s <span class="cmtt-10">\ifcsstring </span>to perform the comparison. <span -class="cmti-10">The string is not expanded during the</span> +class="cmti-10">The string is not</span> <span -class="cmti-10">test.</span> -</p><!--l. 12543--><p class="indent" > The result may vary depending on whether or not expansion is on for the given field -(when the entry was defined). For example: - - +class="cmti-10">expanded during the test.</span> +</p><!--l. 13552--><p class="indent" > The result may vary depending on whether or not expansion is on for the given field (when the entry was +defined). For example: + + </p> - <div class="verbatim" id="verbatim-387"> + <div class="verbatim" id="verbatim-386"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\newcommand*{\foo}{FOO} @@ -25457,25 +27059,25 @@ class="cmti-10">test.</span>  <br />\ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  <br />\end{document} </div> -<!--l. 12562--><p class="nopar" > This will produce “TRUE” in both cases since expansion is on, so <span -class="cmtt-10">\foo </span>was expanded to -“FOO” when <span -class="cmtt-10">sample2 </span>was defined. If the tests are changed to: - - +<!--l. 13571--><p class="nopar" > This will produce “TRUE” in both cases since expansion is on, so <span +class="cmtt-10">\foo </span>was expanded to “FOO” when <span +class="cmtt-10">sample2</span> +was defined. If the tests are changed to: + + </p> - <div class="verbatim" id="verbatim-388"> + <div class="verbatim" id="verbatim-387"> \ifglsfieldeq{sample1}{useri}{\foo}{TRUE}{FALSE}.  <br />\ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}. </div> -<!--l. 12570--><p class="nopar" > then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the -<span -class="cmss-10">user1</span><a - id="dx1-91031"></a> key: - - +<!--l. 13579--><p class="nopar" > then this will produce “FALSE” in both cases. Now suppose expansion is switched off for the <span +class="cmtt-10">user1</span><a + id="dx1-169031"></a> +key: + + </p> - <div class="verbatim" id="verbatim-389"> + <div class="verbatim" id="verbatim-388"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\newcommand*{\foo}{FOO} @@ -25489,14 +27091,14 @@ class="cmss-10">user1</span><a  <br />\ifglsfieldeq{sample2}{useri}{FOO}{TRUE}{FALSE}.  <br />\end{document} </div> -<!--l. 12592--><p class="nopar" > This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and -“FALSE” for the second case (comparing “<span +<!--l. 13601--><p class="nopar" > This now produces “TRUE” for the first case (comparing “FOO” with “FOO”) and “FALSE” for the second +case (comparing “<span class="cmtt-10">\foo</span>” with “FOO”). -</p><!--l. 12597--><p class="indent" > The reverse happens in the following: - - +</p><!--l. 13606--><p class="indent" > The reverse happens in the following: + + </p> - <div class="verbatim" id="verbatim-390"> + <div class="verbatim" id="verbatim-389"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\newcommand*{\foo}{FOO} @@ -25510,17 +27112,14 @@ class="cmtt-10">\foo</span>” with “FOO”).  <br />\ifglsfieldeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  <br />\end{document} </div> -<!--l. 12617--><p class="nopar" > This now produces “FALSE” for the first case (comparing “FOO” with “<span -class="cmtt-10">\foo</span>”) and -“TRUE” for the second case (comparing “<span +<!--l. 13626--><p class="nopar" > This now produces “FALSE” for the first case (comparing “FOO” with “<span +class="cmtt-10">\foo</span>”) and “TRUE” for the second +case (comparing “<span class="cmtt-10">\foo</span>” with “<span class="cmtt-10">\foo</span>”). -</p><!--l. 12622--><p class="indent" > You can test if the value of a field is equal to the replacement text of a command -using: -</p><!--l. 12624--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsfielddefeq</span><span -class="cmtt-9"> </span></span><a - id="dx1-91032"></a> <span +</p><!--l. 13631--><p class="indent" > You can test if the value of a field is equal to the replacement text of a command using: +</p><!--l. 13633--><p class="indent" > <hr><div title="Definition"><a + id="dx1-169032"></a> <span class="cmtt-10">\ifglsfielddefeq{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25531,20 +27130,19 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">true</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12626--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13635--><p class="noindent" > This internally uses <span class="cmss-10">etoolbox</span><a - id="dx1-91033"></a>’s <span -class="cmtt-10">\ifdefstrequal </span>command to perform the comparison. The -argument ⟨<span -class="cmti-10">command</span>⟩ must be a macro. -</p><!--l. 12630--><p class="indent" > For example: - - + id="dx1-169033"></a>’s <span +class="cmtt-10">\ifdefstrequal </span>command to perform the comparison. The argument ⟨<span +class="cmti-10">command</span>⟩ +must be a macro. +</p><!--l. 13639--><p class="indent" > For example: + + </p> - <div class="verbatim" id="verbatim-391"> + <div class="verbatim" id="verbatim-390"> \documentclass{article}  <br />\usepackage{glossaries}  <br />\newcommand*{\foo}{FOO} @@ -25558,46 +27156,41 @@ class="cmti-10">command</span>⟩ must be a macro.  <br />\ifglsfielddefeq{sample2}{useri}{\foo}{TRUE}{FALSE}.  <br />\end{document} </div> -<!--l. 12650--><p class="nopar" > Here, the first case produces “TRUE” since the value of the <span -class="cmtt-10">useri </span>field (“FOO”) is the same -as the replacement text (definition) of <span +<!--l. 13659--><p class="nopar" > Here, the first case produces “TRUE” since the value of the <span +class="cmtt-10">useri </span>field (“FOO”) is the same as the +replacement text (definition) of <span class="cmtt-10">\foo </span>(“FOO”). We have the result “<span -class="cmtt-10">FOO</span>” is equal to -“<span +class="cmtt-10">FOO</span>” is equal to “<span class="cmtt-10">FOO</span>”. -</p><!--l. 12656--><p class="indent" > The second case produces “FALSE” since the value of the <span +</p><!--l. 13665--><p class="indent" > The second case produces “FALSE” since the value of the <span class="cmtt-10">useri </span>field (“<span -class="cmtt-10">\foo</span>”) is not the -same as the replacement text (definition) of <span -class="cmtt-10">\foo </span>(“FOO”). No expansion has been -performed on the value of the <span -class="cmtt-10">useri </span>field. We have the result “<span -class="cmtt-10">\foo</span>” is not equal to -“<span +class="cmtt-10">\foo</span>”) is not the same as the +replacement text (definition) of <span +class="cmtt-10">\foo </span>(“FOO”). No expansion has been performed on the value of the <span +class="cmtt-10">useri</span> +field. We have the result “<span +class="cmtt-10">\foo</span>” is not equal to “<span class="cmtt-10">FOO</span>”. -</p><!--l. 12662--><p class="indent" > If we add: - - +</p><!--l. 13671--><p class="indent" > If we add: + + </p> - <div class="verbatim" id="verbatim-392"> + <div class="verbatim" id="verbatim-391"> \newcommand{\FOO}{\foo}  <br />\ifglsfielddefeq{sample2}{useri}{\FOO}{TRUE}{FALSE}. </div> -<!--l. 12666--><p class="nopar" > we now get “TRUE” since the value of the <span +<!--l. 13675--><p class="nopar" > we now get “TRUE” since the value of the <span class="cmtt-10">useri </span>field (“<span -class="cmtt-10">\foo</span>”) is the same as the -replacement text (definition) of <span +class="cmtt-10">\foo</span>”) is the same as the replacement text (definition) +of <span class="cmtt-10">\FOO </span>(“<span class="cmtt-10">\foo</span>”). We have the result “<span -class="cmtt-10">\foo</span>” is equal to -“<span +class="cmtt-10">\foo</span>” is equal to “<span class="cmtt-10">\foo</span>”. -</p><!--l. 12672--><p class="indent" > There is a similar command that requires the control sequence name (without the leading -backslash) instead of the actual control sequence: -</p><!--l. 12674--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglsfieldcseq</span><span -class="cmtt-9"> </span></span><a - id="dx1-91034"></a> <span +</p><!--l. 13681--><p class="indent" > There is a similar command that requires the control sequence name (without the leading backslash) instead +of the actual control sequence: +</p><!--l. 13683--><p class="indent" > <hr><div title="Definition"><a + id="dx1-169034"></a> <span class="cmtt-10">\ifglsfieldcseq{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25608,24 +27201,46 @@ class="cmtt-10">}{</span>⟨<span class="cmitt-10">true</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12676--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13685--><p class="noindent" > This internally uses <span class="cmss-10">etoolbox</span><a - id="dx1-91035"></a>’s <span + id="dx1-169035"></a>’s <span class="cmtt-10">\ifcsstrequal </span>command instead of <span class="cmtt-10">\ifdefstrequal</span>. -</p><!--l. 12680--><p class="noindent" > +</p><!--l. 13689--><p class="noindent" > </p> -<!--l. 12680--><p class="noindent" ><a +<!--l. 13689--><p class="noindent" ><a href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">16.3 </span> <a id="sec:fetchset"></a>Fetching and Updating the Value of a Field</h3> -<!--l. 12683--><p class="noindent" >You can fetch the value of a given field and store it in a control sequence using: -</p><!--l. 12685--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfieldfetch</span><span -class="cmtt-9"> </span></span><a - id="dx1-92001"></a> <span +<!--l. 13692--><p class="noindent" >In addition to the commands described in <a +href="#sec:glsnolink">§9 </a><a +href="#sec:glsnolink">Using Glossary Terms Without Links<!--tex4ht:ref: sec:glsnolink --></a>, the following may also be +used to fetch field information. +</p><!--l. 13694--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170001"></a> <span +class="cmtt-10">\glsentrytype{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 13696--><p class="noindent" > +Expands to the entry’s glossary type. No existence check is performed. +</p><!--l. 13700--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170002"></a> <span +class="cmtt-10">\glsentryparent{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 13702--><p class="noindent" > +Expands to the label of the entry’s parent. No existence check is performed. +</p><!--l. 13706--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170003"></a> <span +class="cmtt-10">\glsentrysort{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 13708--><p class="noindent" > +Expands to the entry’s sort value. No existence check is performed. +</p><!--l. 13711--><p class="indent" > You can fetch the value of a given field and store it in a control sequence using: +</p><!--l. 13713--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170004"></a> <span class="cmtt-10">\glsfieldfetch{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25633,40 +27248,37 @@ class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">cs</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12687--><p class="noindent" > +</p><!--l. 13715--><p class="noindent" > where ⟨<span class="cmti-10">label</span>⟩ is the label identifying the glossary entry, ⟨<span -class="cmti-10">field</span>⟩ is the field label (see -<a +class="cmti-10">field</span>⟩ is the field label (see <a href="#tab:fieldmap">table 4.1</a>) and ⟨<span -class="cmti-10">cs</span>⟩ is the control sequence in which to store the value. Remember that -⟨<span -class="cmti-10">field</span>⟩ is the internal label and is not necessarily the same as the key used to set -that field in the argument of <span +class="cmti-10">cs</span>⟩ is the control +sequence in which to store the value. Remember that ⟨<span +class="cmti-10">field</span>⟩ is the internal label and is not necessarily the same as +the key used to set that field in the argument of <span class="cmtt-10">\newglossaryentry </span>(or the optional argument of <span class="cmtt-10">\newacronym</span>). -</p><!--l. 12696--><p class="indent" > You can change the value of a given field using one of the following commands. Note that -these commands only change the value of the given field. They have no affect on any related -field. For example, if you change the value of the <span -class="cmss-10">text</span><a - id="dx1-92002"></a> field, it won’t modify the value given by -the <span -class="cmss-10">name</span><a - id="dx1-92003"></a>, <span -class="cmss-10">plural</span><a - id="dx1-92004"></a>, <span -class="cmss-10">first</span><a - id="dx1-92005"></a> or any other related key. -</p><!--l. 12702--><p class="indent" > In all the four related commands below, ⟨<span +</p><!--l. 13724--><p class="indent" > You can change the value of a given field using one of the following commands. Note that these commands +only change the value of the given field. They have no affect on any related field. For example, if you change the +value of the <span +class="cmtt-10">text</span><a + id="dx1-170005"></a> field, it won’t modify the value given by the <span +class="cmtt-10">name</span><a + id="dx1-170006"></a>, <span +class="cmtt-10">plural</span><a + id="dx1-170007"></a>, <span +class="cmtt-10">first</span><a + id="dx1-170008"></a> or any other related +key. +</p><!--l. 13730--><p class="indent" > In all the four related commands below, ⟨<span class="cmti-10">label</span>⟩ and ⟨<span class="cmti-10">field</span>⟩ are as above and ⟨<span -class="cmti-10">definition</span>⟩ is the -new value of the field. -</p><!--l. 12706--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfielddef</span><span -class="cmtt-9"> </span></span><a - id="dx1-92006"></a> <span +class="cmti-10">definition</span>⟩ is the new value of the +field. +</p><!--l. 13734--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170009"></a> <span class="cmtt-10">\glsfielddef{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25674,13 +27286,13 @@ class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definition</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12708--><p class="noindent" > +</p><!--l. 13736--><p class="noindent" > This uses <span class="cmtt-10">\def </span>to change the value of the field (so it will be localised by any grouping). -</p><!--l. 12712--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfieldedef</span><span -class="cmtt-9"> </span></span><a - id="dx1-92007"></a> <span + + +</p><!--l. 13740--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170010"></a> <span class="cmtt-10">\glsfieldedef{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25688,15 +27300,13 @@ class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definition</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12714--><p class="noindent" > +</p><!--l. 13742--><p class="noindent" > This uses <span -class="cmtt-10">\edef </span>to change the value of the field (so it will be localised by any grouping). Any -fragile commands contained in the ⟨<span +class="cmtt-10">\edef </span>to change the value of the field (so it will be localised by any grouping). Any fragile commands +contained in the ⟨<span class="cmti-10">definition</span>⟩ must be protected. -</p><!--l. 12719--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfieldgdef</span><span -class="cmtt-9"> </span></span><a - id="dx1-92008"></a> <span +</p><!--l. 13747--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170011"></a> <span class="cmtt-10">\glsfieldgdef{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25704,15 +27314,11 @@ class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definition</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12721--><p class="noindent" > +</p><!--l. 13749--><p class="noindent" > This uses <span class="cmtt-10">\gdef </span>to change the value of the field. - - -</p><!--l. 12724--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsfieldxdef</span><span -class="cmtt-9"> </span></span><a - id="dx1-92009"></a> <span +</p><!--l. 13752--><p class="indent" > <hr><div title="Definition"><a + id="dx1-170012"></a> <span class="cmtt-10">\glsfieldxdef{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -25720,118 +27326,134 @@ class="cmitt-10">field</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">definition</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12726--><p class="noindent" > +</p><!--l. 13754--><p class="noindent" > This uses <span -class="cmtt-10">\xdef </span>to change the value of the field. Any fragile commands contained in the -⟨<span -class="cmti-10">definition</span>⟩ must be protected. - - -</p> -<!--l. 12731--><p class="indent" > </div> -</p><!--l. 12731--><p class="noindent" ><a +class="cmtt-10">\xdef </span>to change the value of the field. Any fragile commands contained in the ⟨<span +class="cmti-10">definition</span>⟩ must be +protected. + + +</p> +<!--l. 13759--><p class="indent" > </div> +</p><!--l. 13759--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">17. <a id="sec:prefix"></a>Prefixes or Determiners</h2> -</p><!--l. 12733--><p class="indent" > The <span +</p><!--l. 13761--><p class="indent" > The <span class="cmss-10">glossaries-prefix</span><a - id="dx1-93001"></a> package that comes with the <span -class="cmss-10">glossaries </span>package provides additional -keys that can be used as prefixes. For example, if you want to specify determiners (such as -“a”, “an” or “the”). The <span + id="dx1-171001"></a> package that comes with the <span +class="cmss-10">glossaries </span>package provides additional keys that can be +used as prefixes. For example, if you want to specify determiners (such as “a”, “an” or “the”). +The <span class="cmss-10">glossaries-prefix </span>package automatically loads the <span -class="cmss-10">glossaries </span>package -and has the same package options. -</p><!--l. 12741--><p class="indent" > The extra keys for <span +class="cmss-10">glossaries </span>package and has the same package +options. +</p><!--l. 13769--><p class="indent" > The extra keys for <span class="cmtt-10">\newglossaryentry</span><a - id="dx1-93002"></a> are as follows: + id="dx1-171002"></a> are as follows: </p><dl class="description"><dt class="description"> <span -class="cmssbx-10">prefix</span><a - id="dx1-93003"></a> </dt><dd +class="cmtt-10">prefix</span><a + id="dx1-171003"></a> </dt><dd class="description">The prefix associated with the <span -class="cmss-10">text</span><a - id="dx1-93004"></a> key. This defaults to nothing. +class="cmtt-10">text</span><a + id="dx1-171004"></a> key. This defaults to nothing. </dd><dt class="description"> <span -class="cmssbx-10">prefixplural</span><a - id="dx1-93005"></a> </dt><dd +class="cmtt-10">prefixplural</span><a + id="dx1-171005"></a> </dt><dd class="description">The prefix associated with the <span -class="cmss-10">plural</span><a - id="dx1-93006"></a> key. This defaults to nothing. +class="cmtt-10">plural</span><a + id="dx1-171006"></a> key. This defaults to nothing. </dd><dt class="description"> <span -class="cmssbx-10">prefixfirst</span><a - id="dx1-93007"></a> </dt><dd +class="cmtt-10">prefixfirst</span><a + id="dx1-171007"></a> </dt><dd class="description">The prefix associated with the <span -class="cmss-10">first</span><a - id="dx1-93008"></a> key. If omitted, this defaults to the value - of the <span -class="cmss-10">prefix</span><a - id="dx1-93009"></a> key. +class="cmtt-10">first</span><a + id="dx1-171008"></a> key. If omitted, this defaults to the value of the + <span +class="cmtt-10">prefix</span><a + id="dx1-171009"></a> key. </dd><dt class="description"> <span -class="cmssbx-10">prefixfirstplural</span><a - id="dx1-93010"></a> </dt><dd +class="cmtt-10">prefixfirstplural</span><a + id="dx1-171010"></a> </dt><dd class="description">The prefix associated with the <span -class="cmss-10">firstplural</span><a - id="dx1-93011"></a> key. If omitted, this defaults - to the value of the <span -class="cmss-10">prefixplural</span><a - id="dx1-93012"></a> key.</dd></dl> +class="cmtt-10">firstplural</span><a + id="dx1-171011"></a> key. If omitted, this defaults to the + value of the <span +class="cmtt-10">prefixplural</span><a + id="dx1-171012"></a> key.</dd></dl> <a - id="x1-93013r30"></a> -<!--l. 12758--><p class="noindent" ><span + id="ex:determiners"></a> +<!--l. 13786--><p class="noindent" ><span class="cmbx-12">Example 30</span><span class="cmbx-12"> (Defining Determiners)</span><a - id="x1-93014"></a> -</p><!--l. 12759--><p class="indent" > Here’s the start of my example document: - - + id="x1-171014"></a> +</p><!--l. 13787--><p class="indent" > Here’s the start of my example document: + + </p> - <div class="verbatim" id="verbatim-393"> -documentclass{article} + <div class="verbatim" id="verbatim-392"> +\documentclass{article}  <br />\usepackage[colorlinks]{hyperref}  <br />\usepackage[toc,acronym]{glossaries-prefix} </div> -<!--l. 12765--><p class="nopar" > Note that I’ve simply replaced <span +<!--l. 13793--><p class="nopar" > Note that I’ve simply replaced <span class="cmss-10">glossaries </span>from previous sample documents with <span -class="cmss-10">glossaries-prefix</span>. Now for a -sample definition<span class="footnote-mark"><a +class="cmss-10">glossaries-prefix</span>. Now for a sample +definition<span class="footnote-mark"><a href="#fn1x17" id="fn1x17-bk"><sup class="textsuperscript">17.1</sup></a></span><a - id="x1-93015f1"></a>: - - + id="x1-171015f1"></a>: + + </p> - <div class="verbatim" id="verbatim-394"> + <div class="verbatim" id="verbatim-393"> \newglossaryentry{sample}{name={sample},%  <br />  description={an example},%  <br />  prefix={a~},%  <br />  prefixplural={the\space}%  <br />} </div> -<!--l. 12777--><p class="nopar" > Note that I’ve had to explicitly insert a space after the prefix. This allows for the possibility -of prefixes that shouldn’t have a space, such as: - - +<!--l. 13805--><p class="nopar" > Note that I’ve had to explicitly insert a space after the prefix since there’s no designated separator between the +prefix and the term being referenced. This not only means that you can vary between a breaking space and +non-breaking space, but also allows for the possibility of prefixes that shouldn’t have a space, such +as: + + </p> - <div class="verbatim" id="verbatim-395"> + <div class="verbatim" id="verbatim-394"> \newglossaryentry{oeil}{name={oeil},  <br />  plural={yeux},  <br />  description={eye},  <br />  prefix={l'},  <br />  prefixplural={les\space}} </div> -<!--l. 12787--><p class="nopar" > Where a space is required at the end of the prefix, you must use a spacing command, such as +<!--l. 13818--><p class="nopar" > Where a space is required at the end of the prefix, you must use a spacing command, such as <span class="cmtt-10">\space</span>, <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\␣</span></span></span> (backslash space) or <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">~</span></span></span> due to the automatic spacing trimming performed in -⟨<span +class="cmtt-10">~</span></span></span> due to the automatic spacing trimming performed in ⟨<span class="cmti-10">key</span>⟩=⟨<span -class="cmti-10">value</span>⟩ options. -</p><!--l. 12793--><p class="indent" > The prefixes can also be used with acronyms. For example: - - +class="cmti-10">value</span>⟩ +options. +</p><!--l. 13824--><p class="indent" > In the event that you always require a space between the prefix and the term, then you can instead +redefine +</p><!--l. 13826--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171017"></a> <span +class="cmtt-10">\glsprefixsep </span></div><hr> +</p><!--l. 13828--><p class="noindent" > +to do a space. (This command does nothing by default.) For example: + + +</p> + <div class="verbatim" id="verbatim-395"> +\renewcommand{\glsprefixsep}{\space} +</div> +<!--l. 13832--><p class="nopar" > +</p><!--l. 13834--><p class="indent" > The prefixes can also be used with acronyms. For example: + + </p> <div class="verbatim" id="verbatim-396"> \newacronym @@ -25839,31 +27461,27 @@ class="cmti-10">value</span>⟩ options.  <br />   prefix={an\space},prefixfirst={a~}%  <br /> ]{svm}{SVM}{support vector machine} </div> -<!--l. 12799--><p class="nopar" > </p> +<!--l. 13840--><p class="nopar" > </p> <div class="center" > -<!--l. 12800--><p class="noindent" > -</p><!--l. 12800--><p class="noindent" >____________________________</p></div> -<!--l. 12802--><p class="indent" > The <span +<!--l. 13841--><p class="noindent" > +</p><!--l. 13841--><p class="noindent" >____________________________</p></div> +<!--l. 13843--><p class="indent" > The <span class="cmss-10">glossaries-prefix</span><a - id="dx1-93017"></a> package provides convenient commands to use these prefixes with -commands such as <span + id="dx1-171018"></a> package provides convenient commands to use these prefixes with commands such as +<span class="cmtt-10">\gls</span><a - id="dx1-93018"></a>. Note that the prefix is not considered part of the <a + id="dx1-171019"></a>. Note that the prefix is not considered part of the <a href="#glo:linktext">link text<a - id="dx1-93019"></a></a>, so it’s -not included in the hyperlink (where hyperlinks are enabled). The options and any star or -plus modifier are passed on to the <a + id="dx1-171020"></a></a>, so it’s not included in the hyperlink (where +hyperlinks are enabled). The options and any star or plus modifier are passed on to the <a href="#sec:gls-like"><span -class="cmtt-10">\gls</span>-like</a> command. (See <a -href="#sec:glslink"><span -class="tcrm-1000">§</span>6 </a><a -href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for -further details.) -</p><!--l. 12809--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\pgls</span><span -class="cmtt-9"> </span></span><a - id="dx1-93020"></a> <span +class="cmtt-10">\gls</span>-like</a> command. +(See <a +href="#sec:glslink">§6 </a><a +href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details.) +</p><!--l. 13850--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171021"></a> <span class="cmtt-10">\pgls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25871,26 +27489,24 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12811--><p class="noindent" > +</p><!--l. 13852--><p class="noindent" > This is inserts the value of the <span -class="cmss-10">prefix</span><a - id="dx1-93021"></a> key (or <span -class="cmss-10">prefixfirst</span><a - id="dx1-93022"></a> key, on <a +class="cmtt-10">prefix</span><a + id="dx1-171022"></a> key (or <span +class="cmtt-10">prefixfirst</span><a + id="dx1-171023"></a> key, on <a href="#glo:firstuse">first use</a>) in front of <span -class="cmtt-10">\gls</span> -<span -class="cmtt-10">[</span>⟨<span +class="cmtt-10">\gls[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}[</span>⟨<span +class="cmtt-10">}</span> +<span +class="cmtt-10">[</span>⟨<span class="cmti-10">insert</span>⟩<span class="cmtt-10">]</span>. -</p><!--l. 12816--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Pgls</span><span -class="cmtt-9"> </span></span><a - id="dx1-93023"></a> <span +</p><!--l. 13857--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171024"></a> <span class="cmtt-10">\Pgls[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25898,37 +27514,32 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12818--><p class="noindent" > +</p><!--l. 13859--><p class="noindent" > If the <span -class="cmss-10">prefix</span><a - id="dx1-93024"></a> key (or <span -class="cmss-10">prefixfirst</span><a - id="dx1-93025"></a>, on first use) has been set, this displays the value of that -key with the first letter converted to upper case followed by <span +class="cmtt-10">prefix</span><a + id="dx1-171025"></a> key (or <span +class="cmtt-10">prefixfirst</span><a + id="dx1-171026"></a>, on first use) has been set, this displays the value of that key with the first +letter converted to upper case followed by <span class="cmtt-10">\gls[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">[</span>⟨<span +class="cmtt-10">}[</span>⟨<span class="cmti-10">insert</span>⟩<span -class="cmtt-10">]</span>. If that key hasn’t been set, this is equivalent to <span +class="cmtt-10">]</span>. If that key hasn’t been set, this is +equivalent to <span class="cmtt-10">\Gls</span><a - id="dx1-93026"></a><span + id="dx1-171027"></a><span class="cmtt-10">[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">[</span>⟨<span +class="cmtt-10">}[</span>⟨<span class="cmti-10">insert</span>⟩<span class="cmtt-10">]</span>. -</p><!--l. 12826--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\PGLS</span><span -class="cmtt-9"> </span></span><a - id="dx1-93027"></a> <span +</p><!--l. 13867--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171028"></a> <span class="cmtt-10">\PGLS[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25936,16 +27547,14 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12828--><p class="noindent" > +</p><!--l. 13869--><p class="noindent" > As <span class="cmtt-10">\pgls </span>but converts the prefix to upper case and uses <span class="cmtt-10">\GLS</span><a - id="dx1-93028"></a> instead of <span + id="dx1-171029"></a> instead of <span class="cmtt-10">\gls</span>. -</p><!--l. 12832--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\pglspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-93029"></a> <span +</p><!--l. 13873--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171030"></a> <span class="cmtt-10">\pglspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25953,25 +27562,24 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12834--><p class="noindent" > +</p><!--l. 13875--><p class="noindent" > This is inserts the value of the <span -class="cmss-10">prefixplural</span><a - id="dx1-93030"></a> key (or <span -class="cmss-10">prefixfirstplural</span><a - id="dx1-93031"></a> key, on <a -href="#glo:firstuse">first use</a>) in front of +class="cmtt-10">prefixplural</span><a + id="dx1-171031"></a> key (or <span +class="cmtt-10">prefixfirstplural</span><a + id="dx1-171032"></a> key, on <a +href="#glo:firstuse">first use</a>) in front of <span +class="cmtt-10">\glspl</span> <span -class="cmtt-10">\glspl[</span>⟨<span +class="cmtt-10">[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmti-10">insert</span>⟩<span class="cmtt-10">]</span>. -</p><!--l. 12839--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Pglspl</span><span -class="cmtt-9"> </span></span><a - id="dx1-93032"></a> <span +</p><!--l. 13880--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171033"></a> <span class="cmtt-10">\Pglspl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -25979,37 +27587,32 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12841--><p class="noindent" > +</p><!--l. 13882--><p class="noindent" > If the <span -class="cmss-10">prefixplural</span><a - id="dx1-93033"></a> key (or <span -class="cmss-10">prefixfirstplural</span><a - id="dx1-93034"></a>, on first use) has been set, this displays the value of -that key with the first letter converted to upper case followed by <span +class="cmtt-10">prefixplural</span><a + id="dx1-171034"></a> key (or <span +class="cmtt-10">prefixfirstplural</span><a + id="dx1-171035"></a>, on first use) has been set, this displays the value of that key +with the first letter converted to upper case followed by <span class="cmtt-10">\glspl[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">[</span>⟨<span +class="cmtt-10">}[</span>⟨<span class="cmti-10">insert</span>⟩<span -class="cmtt-10">]</span>. If that key hasn’t been set, this is equivalent to <span +class="cmtt-10">]</span>. If that key hasn’t been +set, this is equivalent to <span class="cmtt-10">\Glspl</span><a - id="dx1-93035"></a><span + id="dx1-171036"></a><span class="cmtt-10">[</span>⟨<span class="cmti-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span class="cmti-10">label</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">[</span>⟨<span +class="cmtt-10">}[</span>⟨<span class="cmti-10">insert</span>⟩<span class="cmtt-10">]</span>. -</p><!--l. 12849--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\PGLSpl</span><span -class="cmtt-9"> </span></span><a - id="dx1-93036"></a> <span +</p><!--l. 13890--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171037"></a> <span class="cmtt-10">\PGLSpl[</span>⟨<span class="cmitt-10">options</span>⟩<span class="cmtt-10">]{</span>⟨<span @@ -26017,48 +27620,46 @@ class="cmitt-10">label</span>⟩<span class="cmtt-10">}[</span>⟨<span class="cmitt-10">insert</span>⟩<span class="cmtt-10">] </span></div><hr> -</p><!--l. 12851--><p class="noindent" > +</p><!--l. 13892--><p class="noindent" > As <span class="cmtt-10">\pglspl </span>but converts the prefix to upper case and uses <span class="cmtt-10">\GLSpl</span><a - id="dx1-93037"></a> instead of <span + id="dx1-171038"></a> instead of <span class="cmtt-10">\glspl</span>. - - <a - id="x1-93038r31"></a> -</p><!--l. 12855--><p class="noindent" ><span + id="ex:prefixes"></a> +</p><!--l. 13896--><p class="noindent" ><span class="cmbx-12">Example 31</span><span class="cmbx-12"> (Using Prefixes)</span><a - id="x1-93039"></a> -</p><!--l. 12856--><p class="indent" > Continuing from Example <a -href="#x1-93013r30">30<!--tex4ht:ref: ex:determiners --></a>, now that I’ve defined my entries, I can use them in the text -via the above commands: - - + id="x1-171040"></a> +</p><!--l. 13897--><p class="indent" > Continuing from Example <a +href="#ex:determiners">30<!--tex4ht:ref: ex:determiners --></a>, now that I’ve defined my entries, I can use them in the text via the above + + +commands: + + </p> <div class="verbatim" id="verbatim-397"> First use: \pgls{svm}. Next use: \pgls{svm}.  <br />Singular: \pgls{sample}, \pgls{oeil}.  <br />Plural: \pglspl{sample}, \pglspl{oeil}. </div> -<!--l. 12862--><p class="nopar" > which produces: +<!--l. 13903--><p class="nopar" > which produces: </p><div class="quote"> - <!--l. 12865--><p class="noindent" >First use: a support vector machine (SVM). Next use: an SVM. Singular: - a sample, l’oeil. Plural: the samples, les yeux.</p></div> -<!--l. 12869--><p class="noindent" >For a complete document, see <a -href="#x1-11115r39"><span + <!--l. 13906--><p class="noindent" >First use: a support vector machine (SVM). Next use: an SVM. Singular: a sample, l’oeil. + Plural: the samples, les yeux.</p></div> +<!--l. 13910--><p class="noindent" >For a complete document, see <a +href="#ex:sample-prefix"><span class="cmtt-10">sample-prefix.tex</span></a>. </p> <div class="center" > -<!--l. 12870--><p class="noindent" > -</p><!--l. 12870--><p class="noindent" >____________________________</p></div> -<!--l. 12872--><p class="indent" > This package also provides the commands described below, none of which perform any -check to determine the entry’s existence. -</p><!--l. 12875--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasprefix</span><span -class="cmtt-9"> </span></span><a - id="dx1-93040"></a> <span +<!--l. 13911--><p class="noindent" > +</p><!--l. 13911--><p class="noindent" >____________________________</p></div> +<!--l. 13913--><p class="indent" > This package also provides the commands described below, none of which perform any check to determine +the entry’s existence. +</p><!--l. 13916--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171041"></a> <span class="cmtt-10">\ifglshasprefix{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span @@ -26066,4829 +27667,20309 @@ class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12877--><p class="noindent" > +</p><!--l. 13918--><p class="noindent" > Does ⟨<span class="cmti-10">true part</span>⟩ if the entry identified by ⟨<span class="cmti-10">label</span>⟩ has a non-empty value for the <span -class="cmss-10">prefix</span><a - id="dx1-93041"></a> -key. -</p><!--l. 12881--><p class="indent" > This package also provides the following commands: -</p><!--l. 12882--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasprefixplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93042"></a> <span +class="cmtt-10">prefix</span><a + id="dx1-171042"></a> key. +</p><!--l. 13922--><p class="indent" > This package also provides the following commands: +</p><!--l. 13923--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171043"></a> <span class="cmtt-10">\ifglshasprefixplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12884--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13925--><p class="noindent" > Does ⟨<span class="cmti-10">true part</span>⟩ if the entry identified by ⟨<span class="cmti-10">label</span>⟩ has a non-empty value for the <span -class="cmss-10">prefixplural</span><a - id="dx1-93043"></a> -key. -</p><!--l. 12888--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasprefixfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-93044"></a> <span +class="cmtt-10">prefixplural</span><a + id="dx1-171044"></a> key. +</p><!--l. 13929--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171045"></a> <span class="cmtt-10">\ifglshasprefixfirst{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span -class="cmtt-10">}</span> -</div><hr> -</p><!--l. 12890--><p class="noindent" > +class="cmtt-10">} </span></div><hr> +</p><!--l. 13931--><p class="noindent" > Does ⟨<span class="cmti-10">true part</span>⟩ if the entry identified by ⟨<span class="cmti-10">label</span>⟩ has a non-empty value for the <span -class="cmss-10">prefixfirst</span><a - id="dx1-93045"></a> -key. -</p><!--l. 12894--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\ifglshasprefixfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93046"></a> <span +class="cmtt-10">prefixfirst</span><a + id="dx1-171046"></a> key. +</p><!--l. 13935--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171047"></a> <span class="cmtt-10">\ifglshasprefixfirstplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">}{</span>⟨<span class="cmitt-10">true part</span>⟩<span -class="cmtt-10">}</span> -<span -class="cmtt-10">{</span>⟨<span +class="cmtt-10">}{</span>⟨<span class="cmitt-10">false part</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12896--><p class="noindent" > +</p><!--l. 13937--><p class="noindent" > Does ⟨<span class="cmti-10">true part</span>⟩ if the entry identified by ⟨<span class="cmti-10">label</span>⟩ has a non-empty value for the <span -class="cmss-10">prefixfirstplural</span><a - id="dx1-93047"></a> +class="cmtt-10">prefixfirstplural</span> key. -</p><!--l. 12900--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryprefix</span><span -class="cmtt-9"> </span></span><a - id="dx1-93048"></a> <span +</p><!--l. 13941--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171048"></a> <span class="cmtt-10">\glsentryprefix{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12902--><p class="noindent" > +</p><!--l. 13943--><p class="noindent" > Displays the value of the <span -class="cmss-10">prefix</span><a - id="dx1-93049"></a> key for the entry given by ⟨<span +class="cmtt-10">prefix</span><a + id="dx1-171049"></a> key for the entry given by ⟨<span class="cmti-10">label</span>⟩. -</p><!--l. 12906--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryprefixfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-93050"></a> <span +</p><!--l. 13947--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171050"></a> <span class="cmtt-10">\glsentryprefixfirst{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12908--><p class="noindent" > +</p><!--l. 13949--><p class="noindent" > Displays the value of the <span -class="cmss-10">prefixfirst</span><a - id="dx1-93051"></a> key for the entry given by ⟨<span +class="cmtt-10">prefixfirst</span><a + id="dx1-171051"></a> key for the entry given by ⟨<span class="cmti-10">label</span>⟩. - - -</p><!--l. 12912--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryprefixplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93052"></a> <span +</p><!--l. 13953--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171052"></a> <span class="cmtt-10">\glsentryprefixplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12914--><p class="noindent" > +</p><!--l. 13955--><p class="noindent" > Displays the value of the <span -class="cmss-10">prefixplural</span><a - id="dx1-93053"></a> key for the entry given by ⟨<span -class="cmti-10">label</span>⟩. (No check is performed -to determine if the entry exists.) -</p><!--l. 12919--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\glsentryprefixfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93054"></a> <span +class="cmtt-10">prefixplural</span><a + id="dx1-171053"></a> key for the entry given by ⟨<span +class="cmti-10">label</span>⟩. (No check is performed to determine if +the entry exists.) +</p><!--l. 13960--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171054"></a> <span class="cmtt-10">\glsentryprefixfirstplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12921--><p class="noindent" > + + +</p><!--l. 13962--><p class="noindent" > Displays the value of the <span -class="cmss-10">prefixfirstplural</span><a - id="dx1-93055"></a> key for the entry given by ⟨<span -class="cmti-10">label</span>⟩. (No check is -performed to determine if the entry exists.) -</p><!--l. 12926--><p class="indent" > There are also variants that convert the first letter to upper +class="cmtt-10">prefixfirstplural</span><a + id="dx1-171055"></a> key for the entry given by ⟨<span +class="cmti-10">label</span>⟩. (No check is performed to +determine if the entry exists.) +</p><!--l. 13967--><p class="indent" > There are also variants that convert the first letter to upper case<span class="footnote-mark"><a href="#fn2x17" id="fn2x17-bk"><sup class="textsuperscript">17.2</sup></a></span><a - id="x1-93056f2"></a>: -</p><!--l. 12929--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryprefix</span><span -class="cmtt-9"> </span></span><a - id="dx1-93057"></a> <span + id="x1-171056f2"></a>: +</p><!--l. 13970--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171057"></a> <span class="cmtt-10">\Glsentryprefix{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12931--><p class="noindent" > -</p><!--l. 12932--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryprefixfirst</span><span -class="cmtt-9"> </span></span><a - id="dx1-93058"></a> <span +</p><!--l. 13972--><p class="noindent" > +</p><!--l. 13973--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171058"></a> <span class="cmtt-10">\Glsentryprefixfirst{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12934--><p class="noindent" > -</p><!--l. 12935--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryprefixplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93059"></a> <span +</p><!--l. 13975--><p class="noindent" > +</p><!--l. 13976--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171059"></a> <span class="cmtt-10">\Glsentryprefixplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12937--><p class="noindent" > -</p><!--l. 12939--><p class="indent" > <hr><div title="Definition"><span class="reversemarginpar"><span -class="cmtt-9">\Glsentryprefixfirstplural</span><span -class="cmtt-9"> </span></span><a - id="dx1-93060"></a> <span +</p><!--l. 13978--><p class="noindent" > +</p><!--l. 13980--><p class="indent" > <hr><div title="Definition"><a + id="dx1-171060"></a> <span class="cmtt-10">\Glsentryprefixfirstplural{</span>⟨<span class="cmitt-10">label</span>⟩<span class="cmtt-10">} </span></div><hr> -</p><!--l. 12941--><p class="noindent" > -</p><!--l. 12943--><p class="indent" > <div class="important" title="Important Note"> As with analogous commands such as <span +</p><!--l. 13982--><p class="noindent" > +</p><!--l. 13984--><p class="indent" > <div class="important" title="Important Note"> As with analogous commands such as <span class="cmtt-10">\Glsentrytext</span><a - id="dx1-93061"></a>, these commands aren’t -expandable so can’t be used in PDF bookmarks. </div> -</p><!--l. 12946--><p class="noindent" > + id="dx1-171061"></a>, these commands aren’t expandable so can’t be used +in PDF bookmarks. </div> +</p><!--l. 13987--><p class="noindent" > <a - id="x1-93062r32"></a> -</p><!--l. 12948--><p class="noindent" ><span + id="ex:plist"></a> +</p><!--l. 13989--><p class="noindent" ><span class="cmbx-12">Example 32</span><span class="cmbx-12"> (Adding Determiner to Glossary Style)</span><a - id="x1-93063"></a> -</p><!--l. 12949--><p class="indent" > You can use the above commands to define a new glossary style that uses the determiner. -For example, the following style is a slight modification of the <span + id="x1-171063"></a> +</p><!--l. 13990--><p class="indent" > You can use the above commands to define a new glossary style that uses the determiner. For +example, the following style is a slight modification of the <span class="cmss-10">list</span><a - id="dx1-93064"></a> style that inserts the prefix -before the name: - - + id="dx1-171064"></a> style that inserts the prefix before the +name: + + </p> <div class="verbatim" id="verbatim-398"> \newglossarystyle{plist}{%  <br />  \setglossarystyle{list}%  <br />  \renewcommand*{\glossentry}[2]{%  <br />    \item[\glsentryitem{##1}% - <br />          \Glsentryprefix{##1}% + <br />          \glsentryprefix{##1}% + <br />          \glstarget{##1}{\glossentryname{##1}}] + <br />       \glossentrydesc{##1}\glspostdescription\space ##2}% + <br />} +</div> +<!--l. 14003--><p class="nopar" > If you want to change the prefix separator (<span +class="cmtt-10">\glsprefixsep</span>) then the following is better: + + +</p> + <div class="verbatim" id="verbatim-399"> +\newglossarystyle{plist}{% + <br />  \setglossarystyle{list}% + <br />  \renewcommand*{\glossentry}[2]{% + <br />    \item[\glsentryitem{##1}% + <br />          \ifglshasprefix{##1}{\glsentryprefix{##1}\glsprefixsep}{}%  <br />          \glstarget{##1}{\glossentryname{##1}}]  <br />       \glossentrydesc{##1}\glspostdescription\space ##2}%  <br />} </div> -<!--l. 12962--><p class="nopar" > </p> +<!--l. 14015--><p class="nopar" > The conditional is also useful if you want the style to use an uppercase letter at the start of the entry +item: + + +</p> + <div class="verbatim" id="verbatim-400"> +\newglossarystyle{plist}{% + <br />  \setglossarystyle{list}% + <br />  \renewcommand*{\glossentry}[2]{% + <br />    \item[\glsentryitem{##1}% + <br />          \glstarget{##1}% + <br />          {% + <br />            \ifglshasprefix{##1}% + <br />            {\Glsentryprefix{##1}\glsprefixsep\glossentryname{##1}}% + <br />            {\Glossentryname{##1}}% + <br />          }] + <br />       \glossentrydesc{##1}\glspostdescription\space ##2}% + <br />} +</div> +<!--l. 14031--><p class="nopar" > </p> <div class="center" > -<!--l. 12963--><p class="noindent" > -</p><!--l. 12963--><p class="noindent" >____________________________</p></div> - - -<!--l. 12965--><p class="indent" > </div> -</p><!--l. 12965--><p class="noindent" ><a +<!--l. 14032--><p class="noindent" > +</p><!--l. 14032--><p class="noindent" >____________________________</p></div> + + +<!--l. 14034--><p class="indent" > </div> +</p><!--l. 14034--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">18. <a id="sec:accsupp"></a>Accessibility Support</h2> -</p><!--l. 12967--><p class="indent" > Limited accessibility support is provided by the accompanying <span +</p><!--l. 14036--><p class="indent" > Limited accessibility support is provided by the accompanying <span class="cmss-10">glossaries-accsupp</span><a - id="dx1-94001"></a> package, -but note that this package is experimental and it requires the <span + id="dx1-172001"></a> package, but note that this +package is experimental and it requires the <span class="cmss-10">accsupp</span><a - id="dx1-94002"></a> package which is also -listed as experimental. This package defines additional keys that may be used when defining -glossary entries. The keys are as follows: + id="dx1-172002"></a> package which is also listed as experimental. This package +automatically loads the <span +class="cmss-10">glossaries</span><a + id="dx1-172003"></a> package. Any options are passed to <span +class="cmss-10">glossaries</span><a + id="dx1-172004"></a> (if it hasn’t already been loaded). +For example: + + +</p> + <div class="verbatim" id="verbatim-401"> +\usepackage[acronym]{glossaries-accsupp} +</div> +<!--l. 14044--><p class="nopar" > This will load <span +class="cmss-10">glossaries</span><a + id="dx1-172005"></a> with the <span +class="cmss-10">acronym</span><a + id="dx1-172006"></a> package option as well as loading <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-172007"></a>. +</p><!--l. 14048--><p class="indent" > If you are using the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, you need to load <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> with the <span id="textcolor283"><span +class="cmss-10">accsupp</span></span><a + id="dx1-172008"></a> +package option. For example: + + +</p> + <div class="verbatim" id="verbatim-402"> +\usepackage[abbreviations,accsupp]{glossaries-extra} +</div> +<!--l. 14053--><p class="nopar" > This will load <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (with the <span id="textcolor284"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-172009"></a> option), <span +class="cmss-10">glossaries</span><a + id="dx1-172010"></a> and <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-172011"></a> and make +appropriate patches to integrate the accessibility support with the extension commands. +</p><!--l. 14059--><p class="indent" > The <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-172012"></a> package defines additional keys that may be used when defining glossary entries. The +keys are as follows: </p><dl class="description"><dt class="description"> <span -class="cmssbx-10">access</span><a - id="dx1-94003"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">name</span><a - id="dx1-94004"></a> key. +class="cmtt-10">access</span><a + id="dx1-172013"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">name</span><a + id="dx1-172014"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">textaccess</span><a - id="dx1-94005"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">text</span><a - id="dx1-94006"></a> key. +class="cmtt-10">textaccess</span><a + id="dx1-172015"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">text</span><a + id="dx1-172016"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">firstaccess</span><a - id="dx1-94007"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">first</span><a - id="dx1-94008"></a> key. +class="cmtt-10">firstaccess</span><a + id="dx1-172017"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">first</span><a + id="dx1-172018"></a> + key. </dd><dt class="description"> + + <span -class="cmssbx-10">pluralaccess</span><a - id="dx1-94009"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">plural</span><a - id="dx1-94010"></a> key. +class="cmtt-10">pluralaccess</span><a + id="dx1-172019"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">plural</span><a + id="dx1-172020"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">firstpluralaccess</span><a - id="dx1-94011"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">firstplural</span><a - id="dx1-94012"></a> key. +class="cmtt-10">firstpluralaccess</span><a + id="dx1-172021"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">firstplural</span><a + id="dx1-172022"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">symbolaccess</span><a - id="dx1-94013"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">symbol</span><a - id="dx1-94014"></a> key. +class="cmtt-10">symbolaccess</span><a + id="dx1-172023"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">symbol</span><a + id="dx1-172024"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">symbolpluralaccess</span><a - id="dx1-94015"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">symbolplural</span><a - id="dx1-94016"></a> key. +class="cmtt-10">symbolpluralaccess</span><a + id="dx1-172025"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">symbolplural</span><a + id="dx1-172026"></a> + key. </dd><dt class="description"> + + <span -class="cmssbx-10">descriptionaccess</span><a - id="dx1-94017"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">description</span><a - id="dx1-94018"></a> key. +class="cmtt-10">descriptionaccess</span><a + id="dx1-172027"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">description</span><a + id="dx1-172028"></a> + key. </dd><dt class="description"> <span -class="cmssbx-10">descriptionpluralaccess</span><a - id="dx1-94019"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">descriptionplural</span><a - id="dx1-94020"></a> +class="cmtt-10">descriptionpluralaccess</span><a + id="dx1-172029"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">descriptionplural</span><a + id="dx1-172030"></a> key. </dd><dt class="description"> <span -class="cmssbx-10">longaccess</span><a - id="dx1-94021"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">long</span><a - id="dx1-94022"></a> key (used by <span +class="cmtt-10">longaccess</span><a + id="dx1-172031"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">long</span><a + id="dx1-172032"></a> + key + (used + by + <span class="cmtt-10">\newacronym</span><a - id="dx1-94023"></a>). + id="dx1-172033"></a>). </dd><dt class="description"> <span -class="cmssbx-10">shortaccess</span><a - id="dx1-94024"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">short</span><a - id="dx1-94025"></a> key (used by +class="cmtt-10">shortaccess</span><a + id="dx1-172034"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">short</span><a + id="dx1-172035"></a> + + + key + (used + by <span class="cmtt-10">\newacronym</span><a - id="dx1-94026"></a>). + id="dx1-172036"></a>). </dd><dt class="description"> <span -class="cmssbx-10">longpluralaccess</span><a - id="dx1-94027"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">longplural</span><a - id="dx1-94028"></a> key (used by +class="cmtt-10">longpluralaccess</span><a + id="dx1-172037"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">longplural</span><a + id="dx1-172038"></a> + key + (used + by <span class="cmtt-10">\newacronym</span><a - id="dx1-94029"></a>). + id="dx1-172039"></a>). </dd><dt class="description"> <span -class="cmssbx-10">shortpluralaccess</span><a - id="dx1-94030"></a> </dt><dd -class="description">The replacement text corresponding to the <span -class="cmss-10">shortplural</span><a - id="dx1-94031"></a> key (used by +class="cmtt-10">shortpluralaccess</span><a + id="dx1-172040"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">shortplural</span><a + id="dx1-172041"></a> + key + (used + by <span class="cmtt-10">\newacronym</span><a - id="dx1-94032"></a>). - </dd></dl> -<!--l. 13014--><p class="noindent" >For example: - - -</p> - <div class="verbatim" id="verbatim-399"> + id="dx1-172042"></a>). + </dd><dt class="description"> +<span +class="cmtt-10">user1access</span><a + id="dx1-172043"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user1</span><a + id="dx1-172044"></a> + key. + </dd><dt class="description"> + + +<span +class="cmtt-10">user2access</span><a + id="dx1-172045"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user2</span><a + id="dx1-172046"></a> + key. + </dd><dt class="description"> +<span +class="cmtt-10">user3access</span><a + id="dx1-172047"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user3</span><a + id="dx1-172048"></a> + key. + </dd><dt class="description"> +<span +class="cmtt-10">user4access</span><a + id="dx1-172049"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user4</span><a + id="dx1-172050"></a> + key. + </dd><dt class="description"> +<span +class="cmtt-10">user5access</span><a + id="dx1-172051"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user5</span><a + id="dx1-172052"></a> + key. + </dd><dt class="description"> + + +<span +class="cmtt-10">user6access</span><a + id="dx1-172053"></a> </dt><dd +class="description"> + The + replacement + text + corresponding + to + the + <span +class="cmtt-10">user6</span><a + id="dx1-172054"></a> + key.</dd></dl> +<!--l. 14120--><p class="noindent" >For example: + + +</p> + <div class="verbatim" id="verbatim-403"> \newglossaryentry{tex}{name={\TeX},description={Document  <br />preparation language},access={TeX}} </div> -<!--l. 13018--><p class="nopar" > Now <span class="obeylines-h"><span class="verb"><span -class="cmtt-10">\gls{tex}</span></span></span> will be equivalent to - - +<!--l. 14124--><p class="nopar" > Now the <a +href="#glo:linktext">link text<a + id="dx1-172055"></a></a> produced by <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{tex}</span></span></span> will be: + + </p> - <div class="verbatim" id="verbatim-400"> -\BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} + <div class="verbatim" id="verbatim-404"> +\BeginAccSupp{ActualText={TeX}}\TeX\EndAccSupp{} </div> -<!--l. 13022--><p class="nopar" > The sample file <a -href="#x1-11117r40"><span +<!--l. 14128--><p class="nopar" > The sample file <a +href="#ex:sampleaccsupp"><span class="cmtt-10">sampleaccsupp.tex</span></a> illustrates the <span class="cmss-10">glossaries-accsupp</span><a - id="dx1-94033"></a> package. -</p><!--l. 13026--><p class="indent" > See the documented code (<span -class="cmtt-10">glossaries-code.pdf</span>) for further details. I recommend that -you also read the <span + id="dx1-172056"></a> package. +</p><!--l. 14132--><p class="indent" > If you prefer to use <span +class="cmss-10">accessibility</span><a + id="dx1-172057"></a> or <span +class="cmss-10">tagpdf</span><a + id="dx1-172058"></a> instead of <span class="cmss-10">accsupp</span><a - id="dx1-94034"></a> documentation. - - + id="dx1-172059"></a> then you’ll need to define <span +class="cmtt-10">\gls@accsupp@engine</span> +and <span +class="cmtt-10">\gls@accessibility </span>before loading <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-172060"></a>. See the section “Accessibility Support”in the +documented code for further details. +</p><!--l. 14139--><p class="indent" > The PDF specification identifies three different types of replacement text: + </p><dl class="description"><dt class="description"> +<span +class="cmbx-10">Alt</span> </dt><dd +class="description">Description of some content that’s non-textual (for example, an image). A word break is assumed + after the content. + </dd><dt class="description"> +<span +class="cmbx-10">ActualText</span> </dt><dd +class="description">A character or sequence of characters that replaces textual content (for example, a dropped + capital, a ligature or a symbol). No word break is assumed after the content. + </dd><dt class="description"> +<span +class="cmbx-10">E</span> </dt><dd +class="description">Expansion of an abbreviation to avoid ambiguity (for example, “St” could be short for “saint” or + “street”).</dd></dl> +<!--l. 14151--><p class="indent" > <div class="important" title="Important Note"> Many PDF viewers don’t actually support any type of replacement text. Some may support “ActualText” +but not “Alt” or “E”. <a +href="https://pdfbox.apache.org/" >PDFBox</a>’s “PDFDebugger” tool can be used to inspect the PDF content to make sure +that the replacement text has been correctly set. </div> +</p><!--l. 14157--><p class="noindent" > +</p><!--l. 14159--><p class="indent" > If you define abbreviations with <span +class="cmtt-10">\newacronym</span><a + id="dx1-172061"></a>, the <span +class="cmtt-10">shortaccess</span><a + id="dx1-172062"></a> field will automatically be set +to: +</p><!--l. 14161--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172063"></a> <span +class="cmtt-10">\glsdefaultshortaccess{</span>⟨<span +class="cmitt-10">long</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">short</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 14163--><p class="noindent" > +With the base <span +class="cmss-10">glossaries </span>package this just expands to ⟨<span +class="cmti-10">long</span>⟩. With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> this expands to ⟨<span +class="cmti-10">long</span>⟩ (⟨<span +class="cmti-10">short</span>⟩). +This command must be fully expandable. It expands when the abbreviation is defined. +</p><!--l. 14169--><p class="indent" > As from <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-172064"></a> v4.45, the helper command used to identify the replacement text depends on the +field name. Previous versions just used: +</p><!--l. 14172--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172065"></a> <span +class="cmtt-10">\glsaccsupp{</span>⟨<span +class="cmitt-10">replacement</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 14174--><p class="noindent" > +for all fields. This is defined to use <span +class="cmtt-10">ActualText</span>, which is appropriate for symbols but not for abbreviations. +</p><!--l. 14178--><p class="indent" > As from v4.45, there’s a new helper command: +</p><!--l. 14179--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172066"></a> <span +class="cmtt-10">\glsfieldaccsupp{</span>⟨<span +class="cmitt-10">replacement</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 14181--><p class="noindent" > +This will use <span +class="cmtt-10">\gls</span>⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">accsupp</span><a + id="dx1-172067"></a> if it’s defined otherwise it will just use <span +class="cmtt-10">\glsaccsupp</span>. There are just two of +these field commands for <span +class="cmtt-10">short</span><a + id="dx1-172068"></a> and <span +class="cmtt-10">shortplural</span><a + id="dx1-172069"></a>: +</p><!--l. 14185--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172070"></a> <span +class="cmtt-10">\glsshortaccsupp{</span>⟨<span +class="cmitt-10">replacement</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 14187--><p class="noindent" > +which is like <span +class="cmtt-10">\glsaccsupp </span>but uses <span +class="cmtt-10">E </span>instead of <span +class="cmtt-10">ActualText </span>and +</p><!--l. 14190--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172071"></a> <span +class="cmtt-10">\glsshortplaccsupp{</span>⟨<span +class="cmitt-10">replacement</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">} </span></div><hr> + + +</p><!--l. 14192--><p class="noindent" > +which just does <span +class="cmtt-10">\glsshortaccsupp{</span>⟨<span +class="cmti-10">replacement</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmti-10">content</span>⟩<span +class="cmtt-10">}</span>. Note that ⟨<span +class="cmti-10">field</span>⟩ indicates the <span +class="cmti-10">internal </span>field name +(such as <span +class="cmtt-10">shortpl</span>) not the key name (such as <span +class="cmtt-10">shortplural</span>). See <a +href="#tab:fieldmap">table 4.1</a>. +</p><!--l. 14198--><p class="indent" > Rather than explicitly using <span +class="cmtt-10">\BeginAccSupp</span><a + id="dx1-172072"></a>, these helper commands can use: +</p><!--l. 14200--><p class="indent" > <hr><div title="Definition"><a + id="dx1-172073"></a> <span +class="cmtt-10">\glsaccessibility[</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">]{</span>⟨<span +class="cmitt-10">tag</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">value</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">} </span></div><hr> +</p><!--l. 14202--><p class="noindent" > +where ⟨<span +class="cmti-10">tag</span>⟩ is one of <span +class="cmtt-10">E</span>, <span +class="cmtt-10">Alt </span>or <span +class="cmtt-10">ActualText</span>. The replacement text for ⟨<span +class="cmti-10">content</span>⟩ should be provided in ⟨<span +class="cmti-10">value</span>⟩. This +does: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\BeginAccSupp</span><a + id="dx1-172074"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">tag</span>⟩<span +class="cmtt-10">={</span>⟨<span +class="cmitt-10">value</span>⟩<span +class="cmtt-10">},</span>⟨<span +class="cmitt-10">options</span>⟩<span +class="cmtt-10">}</span>⟨<span +class="cmitt-10">content</span>⟩<span +class="cmtt-10">\EndAccSupp</span><a + id="dx1-172075"></a><span +class="cmtt-10">{}</span> +</div> +</div> but it also provides debugging information if <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">showaccsupp</span><a + id="dx1-172076"></a> is used. If you explicitly use <span +class="cmtt-10">\BeginAccSupp</span> +instead of this command then the debugging support won’t be available. +<!--l. 14214--><p class="indent" > You can define your own custom helper commands for specific fields that require them. For +example: + + </p> -<!--l. 13030--><p class="indent" > </div> -</p><!--l. 13030--><p class="noindent" ><a + <div class="verbatim" id="verbatim-405"> +\newcommand{\glssymbolaccsupp}[2]{% + <br /> \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% + <br />} +</div> +<!--l. 14220--><p class="nopar" > This definition requires the replacement text to be specified with the hexadecimal character code. For +example: + + +</p> + <div class="verbatim" id="verbatim-406"> +\newglossaryentry{int}{name={int},description={integral}, + <br />  symbol={\ensuremath{\int}},symbolaccess={222B} + <br />} +</div> +<!--l. 14227--><p class="nopar" > +</p><!--l. 14229--><p class="indent" > If you are using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, then <span +class="cmtt-10">\glsfieldaccsupp </span>will first test for the existence of +<span id="textcolor285"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-172077"></a> and <span id="textcolor286"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-172078"></a> and then for <span +class="cmtt-10">\gls</span>⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">accsupp</span><a + id="dx1-172079"></a>. For +example: + + +</p> + <div class="verbatim" id="verbatim-407"> +\usepackage{siunitx} + <br />\usepackage[accsupp]{glossaries-extra} + <br />\glsnoexpandfields + <br />\newcommand{\glsxtrsymbolaccsupp}[2]{% + <br /> \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% + <br />} + <br />\newcommand{\glsxtrunitaccsupp}[2]{\glsaccessibility{E}{#1}{#2}} + <br />\newglossaryentry{cm}{name={\si{\centi\metre}}, + <br /> access={centimetre}, + <br /> description={centimetre}, + <br /> category=unit + <br />} + <br />\newglossaryentry{int}{name={\ensuremath{\int}},access={222B}, + <br />  description={integral},category={symbol} + <br />} +</div> +<!--l. 14255--><p class="nopar" > The above uses the <span id="textcolor287"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-172080"></a> form that doesn’t include the field name. Remember that if you +want to supply a command specifically for the <span +class="cmtt-10">name</span><a + id="dx1-172081"></a> field then it won’t be picked up by the <span +class="cmtt-10">text</span><a + id="dx1-172082"></a>, <span +class="cmtt-10">plural</span><a + id="dx1-172083"></a>, +<span +class="cmtt-10">firstplural</span><a + id="dx1-172084"></a> and <span +class="cmtt-10">first</span><a + id="dx1-172085"></a> fields. You’d need to supply them all. For example: + + +</p> + <div class="verbatim" id="verbatim-408"> +\newcommand{\glsnameaccsupp}[2]{% + <br /> \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% + <br />} + <br />\newcommand{\glstextaccsupp}{\glsnameaccsupp} + <br />\newcommand{\glspluralaccsupp}{\glsnameaccsupp} + <br />\newcommand{\glsfirstaccsupp}{\glsnameaccsupp} + <br />\newcommand{\glsfirstplaccsupp}{\glsnameaccsupp} +</div> +<!--l. 14269--><p class="nopar" > +</p><!--l. 14271--><p class="indent" > See the documented code (<span +class="cmtt-10">glossaries-code.pdf</span>) for further details. I recommend that you also read the +<span +class="cmss-10">accsupp</span><a + id="dx1-172086"></a> documentation. See also the <span +class="cmss-10">accessibility</span><a + id="dx1-172087"></a> and <span +class="cmss-10">tagpdf</span><a + id="dx1-172088"></a> packages. + + +</p> +<!--l. 14276--><p class="indent" > </div> +</p><!--l. 14276--><p class="noindent" ><a href="#top">Top</a><div class="chapter"><h2 class="chapterHead">19. <a + id="sec:samples"></a>Sample Documents</h2> +</p><!--l. 14279--><p class="indent" > The <span +class="cmss-10">glossaries </span>package is provided with some sample documents that illustrate the various functions. These +should be located in the <span +class="cmtt-10">samples </span>subdirectory (folder) of the <span +class="cmss-10">glossaries </span>documentation directory. This +location varies according to your operating system and <span class="TEX">T<span +class="E">E</span>X</span> distribution. You can use <span +class="cmtt-10">texdoc</span> +to locate the main glossaries documentation. For example, in a <a +href="http://www.dickimaw-books.com/latex/novices/html/terminal.html" >terminal or command prompt</a>, +type: +</p><!--l. 14287--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />texdoc -l glossaries + <br /></pre><spacer type=vertical size=10> + <br /></span> +This should display a list of all the files in the <span +class="cmss-10">glossaries </span>documentation directory with their full pathnames. +(The GUI version of <span +class="cmtt-10">texdoc </span>may also provide you with the information.) +</p><!--l. 14294--><p class="indent" > If you can’t find the sample files on your computer, they are also available from your nearest CTAN mirror +at <a +href="http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/" class="url" ><span +class="cmtt-10">http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/</span></a>. Each sample file listed below has +a hyperlink to the file’s location on the CTAN mirror. +</p><!--l. 14300--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-173001"></a></a> provide some additional sample files. There are also examples in +the <a +href="https://www.dickimaw-books.com/gallery/" >Dickimaw Books Gallery</a>. +</p><!--l. 14304--><p class="indent" > If you prefer to use UTF-8 aware engines (<span +class="cmtt-10">xelatex </span>or <span +class="cmtt-10">lualatex</span>) remember that you’ll need to switch from +<span +class="cmss-10">fontenc </span>& <span +class="cmss-10">inputenc </span>to <span +class="cmss-10">fontspec </span>where appropriate. +</p><!--l. 14310--><p class="indent" > If you get any errors or unexpected results, check that you have up-to-date versions of all the required +packages. (Search the log file for lines starting with “<span +class="cmtt-10">Package:</span><span +class="cmtt-10"> </span>”.) Where <span +class="cmss-10">hyperref</span><a + id="dx1-173002"></a> is loaded you will get +warnings about non-existent references that look something like: + + +</p> + <div class="verbatim" id="verbatim-409"> +pdfTeX warning (dest): name{glo:aca} has been + <br />referenced but does not exist, replaced by a fixed one +</div> +<!--l. 14317--><p class="nopar" > These warnings may be ignored on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. (The destinations won’t be defined until the glossary +has been created.) +</p> +<!--l. 14321--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.1 </span> <a + id="sec:samplesbasic"></a>Basic</h3> +<a + id="x1-174001r1"></a> +<!--l. 14324--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:minimalgls"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:minimalgls">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/minimalgls.tex" ><span +class="cmtt-10">minimalgls.tex</span></a></h4> +<!--l. 14324--><p class="noindent" >This document is a minimal working example. You can test your installation using this file. To create the +complete document you will need to do the following steps: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-175002x1">Run <span +class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> either by typing + <!--l. 14331--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex minimalgls + <br /></pre><spacer type=vertical size=10> + <br /></span> + in a terminal or by using the relevant button or menu item in your text editor or front-end. This will + create the required associated files but you will not see the glossary in the document. + </p></li> + <li + class="enumerate" id="x1-175004x2">If you have Perl installed, run <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-175005"></a></a> on the document (<a +href="#sec:makeglossaries">§1.4 </a><a +href="#sec:makeglossaries">Generating the Associated Glossary + Files<!--tex4ht:ref: sec:makeglossaries --></a>). This can be done on a terminal by typing: + <!--l. 14340--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries minimalgls + <br /></pre><spacer type=vertical size=10> + <br /></span> + otherwise do: + </p><!--l. 14344--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeglossaries-lite minimalgls + <br /></pre><spacer type=vertical size=10> + <br /></span> + If for some reason you want to call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-175006"></a></a> explicitly, you can do this in a terminal by typing (all on + one line): + + + </p><!--l. 14349--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + See <a +href="#sec:makeindexapp">§1.4.4 </a><a +href="#sec:makeindexapp">Using <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-175007"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span +class="cmtt-10">makeindex</span><a + id="dx1-175008"></a> explicitly. + </p><!--l. 14355--><p class="noindent" >Note that if the file name contains spaces, you will need to use the double-quote character to delimit the + name. + </p></li> + <li + class="enumerate" id="x1-175010x3">Run <span +class="cmtt-10">minimalgls.tex </span>through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> again (as step 1)</li></ol> +<!--l. 14360--><p class="noindent" >You should now have a complete document. The number following each entry in the glossary is the location +number. By default, this is the page number where the entry was referenced. +</p><!--l. 14364--><p class="indent" > The <span +class="cmss-10">acronym</span><a + id="dx1-175011"></a> package option creates a second glossary with the label <span +class="cmtt-10">acronym </span>(which can be referenced with +<span +class="cmtt-10">\acronymtype</span>). If you decide to enable this option then there will be a second set of glossary files that need to +be processed by <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-175012"></a></a>. If you use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-175013"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-175014"></a></a> you don’t need to worry +about it, as those scripts automatically detect which files need to be processed and will run <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-175015"></a></a> (or +<a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-175016"></a></a>) the appropriate number of times. +</p><!--l. 14374--><p class="indent" > If for some reason you don’t want to use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-175017"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-175018"></a></a> and you want the +<span +class="cmss-10">acronym</span><a + id="dx1-175019"></a> package option then the complete build process is: +</p><!--l. 14377--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex minimalgls + <br />makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo + <br />makeindex -s minimalgls.ist -t minimalgls.alg -o minimalgls.acr minimalgls.acn + <br />pdflatex minimalgls + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 14384--><p class="indent" > There are three other files that can be used as <a +href="http://www.dickimaw-books.com/latex/minexample/" >minimal working examples</a>: <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/mwe-gls.tex" ><span +class="cmtt-10">mwe-gls.tex</span></a>, <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/mwe-acr.tex" ><span +class="cmtt-10">mwe-acr.tex</span></a> and +<a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/mwe-acr-desc.tex" ><span +class="cmtt-10">mwe-acr-desc.tex</span></a>. +</p><!--l. 14389--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to try out the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> extension package, you need to replace the package +loading line: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[acronym]{</span><strong><span +class="cmtt-10">glossaries</span></strong><span +class="cmtt-10">}</span> +</div> +</div> with: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[acronym</span><strong><span +class="cmtt-10">,</span><span id="textcolor288"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor289"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> + + +</div> +</div> Note the different default package options. (You may omit the <span +class="cmss-10">acronym</span><a + id="dx1-175020"></a> package option in both cases if +you only want a single glossary.) The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package internally loads the base <span +class="cmss-10">glossaries</span> +package so you don’t need to explicitly load both (in fact, it’s better to let <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> load +<span +class="cmss-10">glossaries</span>). +<!--l. 14406--><p class="indent" > Next, replace: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\setacronymstyle{long-short}</span> +</div> +</div> with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor290"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-175021"></a><span +class="cmtt-10">[</span><strong><span +class="cmtt-10">acronym</span></strong><span +class="cmtt-10">]{long-short}</span> +</div> +</div> The optional argument <span id="textcolor291"><span +class="cmss-10">acronym</span></span><a + id="dx1-175022"></a> identifies the category that this style should be applied to. The <span +class="cmtt-10">\newacronym</span> +command provided by the base <span +class="cmss-10">glossaries </span>package is redefined by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> to use <span id="textcolor292"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-175023"></a> with +the category set to <span id="textcolor293"><span +class="cmss-10">acronym</span></span><a + id="dx1-175024"></a>. +<!--l. 14420--><p class="indent" > If you prefer to replace <span +class="cmtt-10">\newacronym </span>with <span id="textcolor294"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-175025"></a> then the default category is <span id="textcolor295"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-175026"></a> so the +style should instead be: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor296"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-175027"></a><span +class="cmtt-10">[</span><strong><span +class="cmtt-10">abbreviation</span></strong><span +class="cmtt-10">]{long-short}</span> +</div> +</div> This is actually the default category if the optional argument is omitted, so you can simply do: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor297"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-175028"></a><span +class="cmtt-10">{long-short}</span> +</div> +</div> The <span id="textcolor298"><span +class="cmss-10">long-short</span></span><a + id="dx1-175029"></a> style is the default for the <span id="textcolor299"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-175030"></a> category so you can omit this line completely if you +replace <span +class="cmtt-10">\newacronym</span>. (The default style for the <span id="textcolor300"><span +class="cmss-10">acronym</span></span><a + id="dx1-175031"></a> category is <span id="textcolor301"><span +class="cmss-10">short-nolong</span></span><a + id="dx1-175032"></a>, which only shows the short +form on <a +href="#glo:firstuse">first use</a>.) +<!--l. 14437--><p class="indent" > As mentioned earlier, the <span +class="cmss-10">acronym</span><a + id="dx1-175033"></a> package option creates a new glossary with the label <span +class="cmtt-10">acronym</span>. This is +independent of the <span id="textcolor302"><span +class="cmss-10">acronym</span></span><a + id="dx1-175034"></a> category. You can use the <span +class="cmss-10">acronym</span><a + id="dx1-175035"></a> package option with either <span +class="cmtt-10">\newacronym </span>or +<span id="textcolor303"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-175036"></a>. +</p><!--l. 14442--><p class="indent" > You may instead prefer to use the <span id="textcolor304"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-175037"></a> package option, which creates a new glossary with the label +<span +class="cmtt-10">abbreviations</span>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor305"><span +class="cmtt-10">abbreviations</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor306"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor307"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> + + +</div> +</div> This can again be used with either <span +class="cmtt-10">\newacronym </span>or <span id="textcolor308"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-175038"></a>, but the file extensions are different. +This isn’t a problem if you are using <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-175039"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-175040"></a></a>. If you are explicitly calling +<a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-175041"></a></a> (or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-175042"></a></a>) then you need to modify the file extensions. See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for +further details. +<!--l. 14455--><p class="indent" > If you use both the <span +class="cmss-10">acronym</span><a + id="dx1-175043"></a> and <span id="textcolor309"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-175044"></a> package options then <span +class="cmtt-10">\newacronym </span>will default to the <span +class="cmtt-10">acronym</span> +glossary and <span id="textcolor310"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-175045"></a> will default to the <span +class="cmtt-10">abbreviations </span>glossary. +</p><!--l. 14460--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-175046"></a></a></span>If you want to try <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-175047"></a></a>, you first need to convert the document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> as +described above. Then add the <span id="textcolor311"><span +class="cmss-10">record</span></span><a + id="dx1-175048"></a> package option. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor312"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor313"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor314"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next you need to convert the entry definitions into the <span +class="cmtt-10">bib</span><a + id="dx1-175049"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-175050"></a></a>. This can easily be +done with <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-175051"></a></a>. For example: +<!--l. 14470--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only minimalgls.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This will create a file called <strong><span +class="cmtt-10">entries.bib</span></strong>. Next, replace: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\makeglossaries</span> +</div> +</div> with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor315"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-175052"></a><span +class="cmtt-10">[</span><span id="textcolor316"><span +class="cmtt-10">src</span></span><a + id="dx1-175053"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">entries</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Now remove all the entry definitions in the preamble (<span +class="cmtt-10">\longnewglossaryentry</span>, <span +class="cmtt-10">\newglossaryentry </span>and +<span +class="cmtt-10">\newacronym </span>or <span +class="cmtt-10">\newabbreviation</span>). +<!--l. 14485--><p class="indent" > The abbreviation style command must go before <span id="textcolor317"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-175054"></a>. For example (if you are using +<span +class="cmtt-10">\newacronym</span>): </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor318"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-175055"></a><span +class="cmtt-10">[acronym]{long-short}</span> +<br /><span id="textcolor319"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-175056"></a><span +class="cmtt-10">[</span><span id="textcolor320"><span +class="cmtt-10">src</span></span><a + id="dx1-175057"></a><span +class="cmtt-10">=entries]</span> +</div> +</div> Finally, replace: + + + <div class="verbatim" id="verbatim-410"> +\printglossaries +</div> +<!--l. 14495--><p class="nopar" > with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor321"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-175058"></a> +</div> +</div> The document build is now: +<!--l. 14501--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex minimalgls + <br />bib2gls minimalgls + <br />pdflatex minimalgls + <br /></pre><spacer type=vertical size=10> + <br /></span> +<a + id="x1-175059r2"></a> +</p><!--l. 14507--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleDB"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleDB">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleDB.tex" ><span +class="cmtt-10">sampleDB.tex</span></a></h4> +<!--l. 14507--><p class="noindent" >This document illustrates how to load external files containing the glossary definitions. It also illustrates how to +define a new glossary type. This document has the <a +href="#glo:numberlist">number list<a + id="dx1-176001"></a></a> suppressed and uses <a +href="#sec:glsadd"><span +class="cmtt-10">\glsaddall</span><a + id="dx1-176002"></a></a> to add all the +entries to the glossaries without referencing each one explicitly. (Note that it’s more efficient to +use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176003"></a></a> if you have a large number of entries.) To create the document +do: +</p><!--l. 14515--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleDB + <br />makeglossaries sampleDB + <br />pdflatex sampleDB + <br /></pre><spacer type=vertical size=10> + <br /></span> +or +</p><!--l. 14521--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleDB + <br />makeglossaries-lite sampleDB + <br />pdflatex sampleDB + <br /></pre><spacer type=vertical size=10> + <br /></span> +The glossary definitions are stored in the accompanying files <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/database1.tex" ><span +class="cmtt-10">database1.tex</span></a> and <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/database2.tex" ><span +class="cmtt-10">database2.tex</span></a>. +If for some reason you want to call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-176004"></a></a> explicitly you must have a separate call for each +glossary: + + + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-176006x1">Create the main glossary (all on one line): + <!--l. 14532--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + </p></li> + <li + class="enumerate" id="x1-176008x2">Create the secondary glossary (all on one line): + <!--l. 14536--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn + <br /></pre><spacer type=vertical size=10> + <br /></span> + Note that both <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-176009"></a></a> and <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-176010"></a></a> do this all in one call, so they not only make + it easier because you don’t need to supply all the switches and remember all the extensions but they also + call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-176011"></a></a> the appropriate number of times.</p></li></ol> +<!--l. 14545--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176012"></a></a></span>If you want to switch to using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176013"></a></a> with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you can convert <a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/database1.tex" ><span +class="cmtt-10">database1.tex</span></a> and +<a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/database2.tex" ><span +class="cmtt-10">database2.tex</span></a> to <span +class="cmtt-10">bib</span><a + id="dx1-176014"></a> files using <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-176015"></a></a>: +</p><!--l. 14549--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib database1.tex database1.bib + <br />convertgls2bib database2.tex database2.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +The document code then needs to be: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /> +<br /><span +class="cmtt-10">\usepackage[colorlinks,plainpages=false]{hyperref}</span> +<br /><span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor322"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor323"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +<br /> +<br /><strong><span +class="cmtt-10">\newglossary*</span><a + id="dx1-176016"></a></strong><span +class="cmtt-10">{punc}{Punctuation</span><span +class="cmtt-10"> Characters}</span> +<br /> +<br /><span id="textcolor324"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-176017"></a><span +class="cmtt-10">[</span><span id="textcolor325"><span +class="cmtt-10">src</span></span><a + id="dx1-176018"></a><span +class="cmtt-10">={database1},</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor326"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">=all</span></strong><span +class="cmtt-10">,</span><span id="textcolor327"><span +class="cmtt-10">sort</span></span><a + id="dx1-176019"></a><span +class="cmtt-10">=en]</span> +<br /><span id="textcolor328"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-176020"></a><span +class="cmtt-10">[</span><span id="textcolor329"><span +class="cmtt-10">src</span></span><a + id="dx1-176021"></a><span +class="cmtt-10">={database2},</span><strong><span id="textcolor330"><span +class="cmtt-10">type</span></span><span +class="cmtt-10">=punc,</span></strong> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor331"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">=all</span></strong><span +class="cmtt-10">,</span><span id="textcolor332"><span +class="cmtt-10">sort</span></span><a + id="dx1-176022"></a><span +class="cmtt-10">=letter-case]</span> +<br /> +<br /><span +class="cmtt-10">\begin{document}</span> +<br /><span id="textcolor333"><span +class="cmtt-10">\print</span><strong><span +class="cmtt-10">unsrt</span></strong><span +class="cmtt-10">glossaries</span></span> +<br /><span +class="cmtt-10">\end{document}</span> + + +</div> +</div> Note that the <span +class="cmss-10">nonumberlist</span><a + id="dx1-176023"></a> package option has been omitted. It’s not needed because there are no +locations in this amended document (whereas in the original <a +href="#ex:sampleDB"><span +class="cmtt-10">sampleDB.tex</span></a> locations are created with +<span +class="cmtt-10">\glsaddall</span>). The starred <span +class="cmtt-10">\newglossary*</span><a + id="dx1-176024"></a> is used since the <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-176025"></a></a>/<a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-176026"></a></a> extensions are now +irrelevant. +<!--l. 14577--><p class="indent" > Instead of using <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-176027"></a></a> you need to use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176028"></a></a> when you build the document: +</p><!--l. 14579--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleDB + <br />bib2gls sampleDB + <br />pdflatex sampleDB + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note that one <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176029"></a></a> call processes all the indexing (rather than one call per glossary). Unlike <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-176030"></a></a> and +<a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-176031"></a></a>, <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176032"></a></a> processes each resource set in turn, but the resource sets aren’t linked to a specific glossary. +Multiple glossaries may be processed in a single resource set or sub-blocks of a single glossary may be processed +by multiple resource sets. In this example, there happens to be one resource set per glossary because each +glossary requires a different sort method. (A locale-sensitive alphabetical sort for the first and a character code +sort for the second.) +</p><!--l. 14595--><p class="indent" > If you want letter groups, you need to use the <span id="textcolor334"><span +class="cmtt-10">--group</span></span><a + id="dx1-176033"></a> switch: +</p><!--l. 14597--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />bib2gls --group sampleDB + <br /></pre><spacer type=vertical size=10> + <br /></span> +and use an appropriate glossary style. +</p><!--l. 14602--><p class="indent" > See also <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a>, <a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory Guide</a> and the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-176034"></a></a> user +manual. +</p><!--l. 14604--><p class="noindent" > +</p> +<!--l. 14604--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.2 </span> <a + id="sec:sampleacronyms"></a>Acronyms and First Use</h3> +<a + id="x1-177001r3"></a> +<!--l. 14607--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleAcr"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleAcr">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleAcr.tex" ><span +class="cmtt-10">sampleAcr.tex</span></a></h4> +<!--l. 14607--><p class="noindent" >This document has some sample abbreviations. It also adds the glossary to the table of contents, so an extra run +through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required to ensure the document is up to date: +</p><!--l. 14611--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleAcr + <br />makeglossaries sampleAcr + <br />pdflatex sampleAcr + <br />pdflatex sampleAcr + <br /></pre><spacer type=vertical size=10> + + + <br /></span> +(or use <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-178001"></a></a>). +</p><!--l. 14619--><p class="indent" > Note that if the glossary is at the start of the document and spans across multiple pages, then this can cause +the locations to be shifted. In that case, an extra <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-178002"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call are required. In +this particular example, the glossary is at the end of the document so it’s not a problem. It’s also +not a problem for a glossary at the start of the document if the page numbering is reset at the +end of the glossary. For example, if the glossary is at the end of the front matter in a book-style +document. +</p><!--l. 14628--><p class="indent" > This document uses <span +class="cmtt-10">\ifglsused</span><a + id="dx1-178003"></a> to determine whether to use “a” or “an” in: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">…</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> \ifglsused</span><a + id="dx1-178004"></a><span +class="cmtt-10">{svm}{an}{a}</span><span +class="cmtt-10"> \gls{svm}</span><span +class="cmtt-10"> </span><span +class="cmtt-10">…</span> +</div> +</div> This clumsy bit of code can be tidied up with the <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-178005"></a> package. Since that package automatically +loads <span +class="cmss-10">glossaries </span>and passes all its options to the base package it’s possible to do a simple replacement +of: + + + <div class="verbatim" id="verbatim-411"> +\usepackage[style=long,toc]{glossaries} +</div> +<!--l. 14639--><p class="nopar" > with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=long,toc]{</span><strong><span +class="cmtt-10">glossaries-prefix</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The definition of <span +class="cmtt-10">svm </span>now needs an adjustment: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newacronym</span><a + id="dx1-178006"></a><span +class="cmtt-10">[description={statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span> +<br /><span +class="cmtt-10">technique~\protect\cite{svm}},</span> +<br /><strong><span +class="cmtt-10">prefixfirst={a~},prefix={an\space</span><a + id="dx1-178007"></a><span +class="cmtt-10">}</span></strong> +<br /><span +class="cmtt-10">]{svm}{svm}{support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +</div> +</div> The clumsy text can now simply be changed to: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">…</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> \pgls</span><a + id="dx1-178008"></a><span +class="cmtt-10">{svm}</span><span +class="cmtt-10"> </span><span +class="cmtt-10">…</span> +</div> +</div> +<!--l. 14656--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to convert this sample document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you may want the +patched version of the styles provided in <span +class="cmss-10">glossary-long</span><a + id="dx1-178009"></a>, in which case you can also add <span id="textcolor335"><span +class="cmss-10">stylemods</span></span><a + id="dx1-178010"></a>: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor336"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,</span></strong><span +class="cmtt-10">style=long]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> If you want to suppress all the other glossary style packages with <span +class="cmss-10">nostyles</span><a + id="dx1-178011"></a>, then you need to specify exactly +which package (or packages) that you do want: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span +class="cmtt-10">nostyles,</span></strong><span id="textcolor337"><span +class="cmtt-10">stylemods</span><strong><span +class="cmtt-10">=long</span></strong></span><span +class="cmtt-10">,style=long]{glossaries-extra}</span> +</div> +</div> (Now that <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> is being used, there are more available “long” styles in the <span id="textcolor338"><span +class="cmss-10">glossary-longextra</span></span><a + id="dx1-178012"></a> package, +which you may prefer.) + + +<!--l. 14673--><p class="indent" > If you want to use <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-178013"></a>, you can either load it after <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> or (with at least <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +v1.42) you can simply use the <span id="textcolor339"><span +class="cmss-10">prefix</span></span><a + id="dx1-178014"></a> package option. +</p><!--l. 14678--><p class="indent" > Note that the <span +class="cmss-10">toc</span><a + id="dx1-178015"></a> package option has been dropped. This is the default with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, so it doesn’t +need to be specified now. The document build is now shorter: +</p><!--l. 14681--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleAcr + <br />makeglossaries sampleAcr + <br />pdflatex sampleAcr + <br /></pre><spacer type=vertical size=10> + <br /></span> +The third <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call is no longer required to make the table of contents up-to-date. This is because +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> provides boilerplate text on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call when the glossary files are missing. This means +that the glossary header is added to the <span +class="cmtt-10">toc</span><a + id="dx1-178016"></a> file on the first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call, whereas with just the base <span +class="cmss-10">glossaries</span> +package, the header isn’t present until the second <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call. (As with just the base <span +class="cmss-10">glossaries </span>package, if the +glossary occurs at the start of the document without a page reset after it then part of the build process needs +repeating to ensure all referenced page numbers are up-to-date. This problem isn’t specific to the <span +class="cmss-10">glossaries</span><a + id="dx1-178017"></a> +package.) +</p><!--l. 14698--><p class="indent" > The other different default setting is the post-description punctuation. The base package has <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-178018"></a> +as the default. This means that a full stop (period) is automatically inserted after the description in the +glossary. The extension package has <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a + id="dx1-178019"></a> as the default. If you want the original behaviour then you +can use <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-178020"></a> or the shorter synonym <span id="textcolor340"><span +class="cmss-10">postdot</span></span><a + id="dx1-178021"></a>. +</p><!--l. 14706--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has different abbreviation handling that’s far more flexible than that provided +by the base <span +class="cmss-10">glossaries </span>package. The style now needs to be set with <span id="textcolor341"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-178022"></a> instead of +<span +class="cmtt-10">\setacronymstyle</span><a + id="dx1-178023"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor342"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-178024"></a><span +class="cmtt-10">[acronym]{long-short-sc}</span></strong> +<br /><span +class="cmtt-10">\newacronym</span><a + id="dx1-178025"></a><span +class="cmtt-10">{svm}{svm}{support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +</div> +</div> (Note the different style name <span id="textcolor343"><span +class="cmss-10">long-short-sc</span></span><a + id="dx1-178026"></a> instead of <span +class="cmss-10">long-sc-short</span><a + id="dx1-178027"></a> and the optional argument <span id="textcolor344"><span +class="cmss-10">acronym</span></span><a + id="dx1-178028"></a>.) If +you prefer to replace <span +class="cmtt-10">\newacronym</span><a + id="dx1-178029"></a> with <span id="textcolor345"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-178030"></a> then omit the optional argument: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor346"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-178031"></a><span +class="cmtt-10">{long-short-sc}</span> +<br /><span id="textcolor347"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-178032"></a><span +class="cmtt-10">{svm}{svm}{support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +</div> +</div> (The optional argument of <span id="textcolor348"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-178033"></a> is the category to which the style should be +applied. If it’s omitted, <span id="textcolor349"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-178034"></a> is assumed. You can therefore have different styles for different +categories.) +<!--l. 14727--><p class="indent" > Finally, you need to replace <span +class="cmtt-10">\acrshort</span><a + id="dx1-178035"></a>, <span +class="cmtt-10">\acrlong</span><a + id="dx1-178036"></a> and <span +class="cmtt-10">\acrfull</span><a + id="dx1-178037"></a> and their variants with <span id="textcolor350"><span +class="cmtt-10">\glsxtrshort</span></span><a + id="dx1-178038"></a>, +<span id="textcolor351"><span +class="cmtt-10">\glsxtrlong</span></span><a + id="dx1-178039"></a> and <span id="textcolor352"><span +class="cmtt-10">\glsxtrfull</span></span><a + id="dx1-178040"></a> etc. +<a + id="x1-178041r4"></a> + + +</p><!--l. 14731--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleAcrDesc"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleAcrDesc">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleAcrDesc.tex" ><span +class="cmtt-10">sampleAcrDesc.tex</span></a></h4> +<!--l. 14731--><p class="noindent" >This is similar to the previous example, except that the abbreviations have an associated description. As with +the previous example, the glossary is added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is +required: +</p><!--l. 14735--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleAcrDesc + <br />makeglossaries sampleAcrDesc + <br />pdflatex sampleAcrDesc + <br />pdflatex sampleAcrDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +This document uses the <span +class="cmss-10">acronym</span><a + id="dx1-179001"></a> package option, which creates a new glossary used by <span +class="cmtt-10">\newacronym</span>. This +leaves the default <span +class="cmtt-10">main </span>glossary available for general terms. However, in this case there are no general terms so +the <span +class="cmtt-10">main </span>glossary is redundant. The <span +class="cmss-10">nomain</span><a + id="dx1-179002"></a> package option will prevent its creation. Obviously, if you decide to +add some terms with <span +class="cmtt-10">\newglossaryentry </span>you will need to remove the <span +class="cmss-10">nomain</span><a + id="dx1-179003"></a> option as the <span +class="cmtt-10">main </span>glossary will +now be required. +</p><!--l. 14751--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>As with the previous example, if you want to convert this document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> you +need to make a few modifications. The most obvious one is to replace <span +class="cmtt-10">glossaries </span>with <span +class="cmtt-10">glossaries-extra </span>in +the <span +class="cmtt-10">\usepackage </span>argument. Again you can omit <span +class="cmss-10">toc</span><a + id="dx1-179004"></a> as this is the default for <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. As in the previous +example, you may want to use the patched styles. This document uses <span +class="cmss-10">altlist</span><a + id="dx1-179005"></a> which is provided by <span +class="cmss-10">glossary-list</span><a + id="dx1-179006"></a>, so +the style can be patched with <span id="textcolor353"><span +class="cmss-10">stylemods</span></span><a + id="dx1-179007"></a>. </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[acronym,nomain,style=altlist</span><strong><span +class="cmtt-10">,</span><span id="textcolor354"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> You may prefer to replace the <span +class="cmss-10">acronym</span><a + id="dx1-179008"></a> option with <span id="textcolor355"><span +class="cmss-10">abbreviations</span></span><a + id="dx1-179009"></a>, but this will change the file +extensions. If you use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-179010"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-179011"></a></a> you don’t need to worry about +it. +<!--l. 14769--><p class="indent" > Again the style command needs to be changed: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor356"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179012"></a><span +class="cmtt-10">[acronym]{long-short-sc-desc}</span> +</div> +</div> (Note the change in style name <span id="textcolor357"><span +class="cmss-10">long-short-sc-desc</span></span><a + id="dx1-179013"></a> instead of <span +class="cmss-10">long-sc-short-desc</span><a + id="dx1-179014"></a> and the optional argument +<span id="textcolor358"><span +class="cmss-10">acronym</span></span><a + id="dx1-179015"></a>.) +<!--l. 14776--><p class="indent" > As with the previous example, if you prefer to use <span id="textcolor359"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-179016"></a> instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-179017"></a> then you need +to omit the optional argument: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor360"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179018"></a><span +class="cmtt-10">{long-short-sc-desc}</span> + + +</div> +</div> The original document uses: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glsseeitemformat</span><a + id="dx1-179019"></a><span +class="cmtt-10">}[1]{%</span> +<br /><span +class="cmtt-10"> \acronymfont</span><a + id="dx1-179020"></a><span +class="cmtt-10">{\glsentrytext</span><a + id="dx1-179021"></a><span +class="cmtt-10">{#1}}}</span> +</div> +</div> to ensure that the cross-references (from the <span +class="cmtt-10">see</span><a + id="dx1-179022"></a> key) use the acronym font. The new abbreviation styles don’t +use <span +class="cmtt-10">\acronymfont</span><a + id="dx1-179023"></a> so this isn’t appropriate with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. If you’re using at least version 1.42 of +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you don’t need to do anything as it automatically redefines <span +class="cmtt-10">\glsseeitemformat</span><a + id="dx1-179024"></a> to take the +style formatting into account. If you have an earlier version you can redefine this command as follows: +<div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glsseeitemformat</span><a + id="dx1-179025"></a><span +class="cmtt-10">}[1]{%</span> +<br /><span +class="cmtt-10"> \ifglshasshort</span><a + id="dx1-179026"></a><span +class="cmtt-10">{#1}{</span><span id="textcolor361"><span +class="cmtt-10">\glsfmttext</span></span><a + id="dx1-179027"></a><span +class="cmtt-10">{#1}}{</span><span id="textcolor362"><span +class="cmtt-10">\glsfmtname</span></span><a + id="dx1-179028"></a><span +class="cmtt-10">{#1}}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This will just show the short form in the cross-reference. If you prefer the name instead (which includes the +short and long form) you can use: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glsseeitemformat</span><a + id="dx1-179029"></a><span +class="cmtt-10">}[1]{</span><span id="textcolor363"><span +class="cmtt-10">\glsfmtname</span></span><a + id="dx1-179030"></a><span +class="cmtt-10">{#1}}</span> +</div> +</div> +<!--l. 14806--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides two additional cross-referencing keys <span id="textcolor364"><span id="textcolor365"><span +class="cmtt-10">seealso</span></span><a + id="dx1-179031"></a></span> and <span id="textcolor366"><span id="textcolor367"><span +class="cmtt-10">alias</span></span><a + id="dx1-179032"></a></span>, so <span +class="cmtt-10">see</span><a + id="dx1-179033"></a><span +class="cmtt-10">={[see</span> +<span +class="cmtt-10">also]{svm}} </span>can be replaced with a more appropriate key: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newacronym</span><a + id="dx1-179034"></a><span +class="cmtt-10">[description={Statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span> +<br /><span +class="cmtt-10">technique</span><span +class="cmtt-10"> using</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> ``kernel</span><span +class="cmtt-10"> trick''},</span> +<br /><strong><span id="textcolor368"><span id="textcolor369"><span +class="cmtt-10">seealso</span></span><a + id="dx1-179035"></a></span><span +class="cmtt-10">={svm}</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10">]{ksvm}{ksvm}{kernel</span><span +class="cmtt-10"> support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +</div> +</div> +<!--l. 14817--><p class="indent" > Finally, as with the previous example, you need to replace <span +class="cmtt-10">\acrshort</span><a + id="dx1-179036"></a>, <span +class="cmtt-10">\acrlong</span><a + id="dx1-179037"></a> and <span +class="cmtt-10">\acrfull</span><a + id="dx1-179038"></a> etc with +<span id="textcolor370"><span +class="cmtt-10">\glsxtrshort</span></span><a + id="dx1-179039"></a>, <span id="textcolor371"><span +class="cmtt-10">\glsxtrlong</span></span><a + id="dx1-179040"></a> and <span id="textcolor372"><span +class="cmtt-10">\glsxtrfull</span></span><a + id="dx1-179041"></a> etc. +</p><!--l. 14821--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179042"></a></a></span>If you want to convert this document so that it uses <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179043"></a></a>, you first need to convert it to use +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, as above, but remember that you now need the <span id="textcolor373"><span +class="cmss-10">record</span></span><a + id="dx1-179044"></a> option: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[acronym,nomain,style=altlist,</span><strong><span id="textcolor374"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span><span id="textcolor375"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor376"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Now you need to convert the abbreviation definitions to the <span +class="cmtt-10">bib</span><a + id="dx1-179045"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179046"></a></a>. This can be done +with: +<!--l. 14831--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sampleAcrDesc.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +If you retained <span +class="cmtt-10">\newacronym</span><a + id="dx1-179047"></a> from the original example file, then the new <span +class="cmtt-10">entries.bib </span>file will contain entries +defined with <span id="textcolor377"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-179048"></a>. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor378"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-179049"></a><span +class="cmtt-10">{ksvm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span><span +class="cmtt-10"> technique</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> using</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> ``kernel</span><span +class="cmtt-10"> trick''},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor379"><span +class="cmtt-10">seealso</span></span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {svm},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {ksvm},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {kernel</span><span +class="cmtt-10"> support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> If you switched to <span id="textcolor380"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-179050"></a> then the entries will instead be defined with <span id="textcolor381"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-179051"></a>. +<!--l. 14849--><p class="indent" > Next replace <span +class="cmtt-10">\makeglossaries </span>with the resource command, but note that the abbreviation style must be set +first: </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor382"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179052"></a><span +class="cmtt-10">[acronym]{long-short-sc-desc}</span></strong> +<br /><span id="textcolor383"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-179053"></a><span +class="cmtt-10">[</span><span id="textcolor384"><span +class="cmtt-10">src</span></span><a + id="dx1-179054"></a><span +class="cmtt-10">=entries,%</span><span +class="cmtt-10"> terms</span><span +class="cmtt-10"> defined</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> entries.bib</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor385"><span +class="cmtt-10">abbreviation-sort-fallback</span></span><span +class="cmtt-10">=long</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Another possibility is to make <span id="textcolor386"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-179055"></a> behave as though it was actually <span id="textcolor387"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-179056"></a>: <div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor388"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179057"></a><span +class="cmtt-10">{long-short-sc-desc}</span></strong> +<br /><span id="textcolor389"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-179058"></a><span +class="cmtt-10">[</span><span id="textcolor390"><span +class="cmtt-10">src</span></span><a + id="dx1-179059"></a><span +class="cmtt-10">=entries,</span><span id="textcolor391"><span +class="cmtt-10">abbreviation-sort-fallback</span></span><a + id="dx1-179060"></a><span +class="cmtt-10">=long</span><strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> entry-type-aliases={acronym=abbreviation}</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Note that the category is now <span id="textcolor392"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-179061"></a> not <span id="textcolor393"><span +class="cmss-10">acronym</span></span><a + id="dx1-179062"></a> so the optional argument of <span id="textcolor394"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179063"></a> +needs adjusting. +<!--l. 14866--><p class="indent" > If the <span +class="cmtt-10">sort</span><a + id="dx1-179064"></a> field is missing (which should usually be the case), then both <span id="textcolor395"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-179065"></a> and <span id="textcolor396"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-179066"></a> will +fallback on the <span +class="cmtt-10">short</span><a + id="dx1-179067"></a> field (not the <span +class="cmtt-10">name</span><a + id="dx1-179068"></a> field, which is usually set by the style and therefore not visible to +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179069"></a></a>). For some styles, as in this example, it’s more appropriate to sort by the long form so the fallback is + + +changed. (Remember that you will break this fallback mechanism if you explicitly set the sort value.) See the +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179070"></a></a> manual for further details and other examples. +</p><!--l. 14876--><p class="indent" > Remember to delete any <span +class="cmtt-10">\newacronym </span>or <span +class="cmtt-10">\newabbreviation </span>in the <span +class="cmtt-10">tex</span><a + id="dx1-179071"></a> file. Finally replace <span +class="cmtt-10">\printglossary</span> +with <span id="textcolor397"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-179072"></a>. The document build is now: +</p><!--l. 14880--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleAcrDesc + <br />bib2gls sampleAcrDesc + <br />pdflatex sampleAcrDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 14886--><p class="indent" > Note that it’s now much easier to revert back to the descriptionless style used in <a +href="#ex:sampleAcr"><span +class="cmtt-10">sampleAcr.tex</span></a>: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor398"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-179073"></a><span +class="cmtt-10">[acronym]{</span><strong><span +class="cmtt-10">long-short-sc</span></strong><span +class="cmtt-10">}</span> +<br /><span id="textcolor399"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-179074"></a><span +class="cmtt-10">[</span><span id="textcolor400"><span +class="cmtt-10">src</span></span><a + id="dx1-179075"></a><span +class="cmtt-10">=entries</span><strong><span +class="cmtt-10">,</span><span id="textcolor401"><span +class="cmtt-10">ignore-fields</span></span><a + id="dx1-179076"></a><span +class="cmtt-10">=description</span></strong><span +class="cmtt-10">]</span> +</div> +</div> With the other options it would be necessary to delete all the <span +class="cmtt-10">description</span><a + id="dx1-179077"></a> fields from the abbreviation +definitions in order to omit them, but with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179078"></a></a> you can simply instruct <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-179079"></a></a> to ignore the description. +This makes it much easier to have a large database of abbreviations for use across multiple documents that may +or may not require the description. +<a + id="x1-179080r5"></a> +<!--l. 14899--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleDesc"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleDesc">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleDesc.tex" ><span +class="cmtt-10">sampleDesc.tex</span></a></h4> +<!--l. 14899--><p class="noindent" >This is similar to the previous example, except that it defines the abbreviations using <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-180001"></a> +instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-180002"></a>. As with the previous example, the glossary is added to the table of contents, so an +extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required: +</p><!--l. 14904--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleDesc + <br />makeglossaries sampleDesc + <br />pdflatex sampleDesc + <br />pdflatex sampleDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +This sample file demonstrates the use of the <span +class="cmtt-10">first</span><a + id="dx1-180003"></a> and <span +class="cmtt-10">text</span><a + id="dx1-180004"></a> keys but in general it’s better to use <span +class="cmtt-10">\newacronym</span><a + id="dx1-180005"></a> +instead as it’s more flexible. For even greater flexibility use <span id="textcolor402"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-180006"></a> provided by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. For +other variations, such as showing the symbol on <a +href="#glo:firstuse">first use</a>, you may prefer to make use of the post-link category +hook. For examples, see the section “Changing the Formatting” in <a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory +Guide</a>. +<a + id="x1-180007r6"></a> + + +</p><!--l. 14918--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleFnAcrDesc"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleFnAcrDesc">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleFnAcrDesc.tex" ><span +class="cmtt-10">sampleFnAcrDesc.tex</span></a></h4> +<!--l. 14918--><p class="noindent" >This document has some sample abbreviations that use the <span +class="cmss-10">footnote-sc-desc</span><a + id="dx1-181001"></a> acronym style. As with the +previous example, the glossary is added to the table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is +required: +</p><!--l. 14922--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleFnAcrDesc + <br />makeglossaries sampleFnAcrDesc + <br />pdflatex sampleFnAcrDesc + <br />pdflatex sampleFnAcrDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +<br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to convert this sample document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, then you just need to follow +the same steps as for <a +href="#ex:sampleAcr"><span +class="cmtt-10">sampleAcr.tex</span></a> with a slight modification. This time the <span id="textcolor403"><span +class="cmss-10">short-sc-footnote-desc</span></span><a + id="dx1-181002"></a> +abbreviation style is needed: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor404"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-181003"></a><span +class="cmtt-10">[acronym]{short-sc-footnote-desc}</span> +</div> +</div> The command redefinitions (performed with <span +class="cmtt-10">\renewcommand</span>) should now all be deleted as they are no longer +applicable. +<!--l. 14939--><p class="indent" > You may prefer to use the <span id="textcolor405"><span +class="cmss-10">short-sc-postfootnote-desc</span></span><a + id="dx1-181004"></a> style instead. There are subtle differences between the +<span id="textcolor406"><span +class="cmss-10">postfootnote</span></span><a + id="dx1-181005"></a> and <span id="textcolor407"><span +class="cmss-10">footnote</span></span><a + id="dx1-181006"></a> set of styles. Try changing the abbreviation style to <span id="textcolor408"><span +class="cmss-10">short-sc-footnote</span></span><a + id="dx1-181007"></a> and compare the +location of the footnote marker with the two styles. +</p><!--l. 14945--><p class="indent" > This modified sample file now has a shorter build: +</p><!--l. 14946--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleFnAcrDesc + <br />makeglossaries sampleFnAcrDesc + <br />pdflatex sampleFnAcrDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +This is because the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package produces boilerplate text when the glossary file is missing (on the +first <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run) which adds the glossary title to the table of contents (<span +class="cmtt-10">toc</span><a + id="dx1-181008"></a>) file. +<a + id="x1-181009r7"></a> +</p><!--l. 14956--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleCustomAcr"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleCustomAcr">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleCustomAcr.tex" ><span +class="cmtt-10">sampleCustomAcr.tex</span></a></h4> +<!--l. 14956--><p class="noindent" >This document has some sample abbreviations with a custom acronym style. It also adds the glossary to the +table of contents, so an extra run through <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> is required: +</p><!--l. 14959--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleCustomAcr + <br />makeglossaries sampleCustomAcr + + + <br />pdflatex sampleCustomAcr + <br />pdflatex sampleCustomAcr + <br /></pre><spacer type=vertical size=10> + <br /></span> +This is a slight variation on the previous example where the name is in the form ⟨<span +class="cmti-10">long</span>⟩ (⟨<span +class="cmti-10">short</span>⟩) instead of ⟨<span +class="cmti-10">short</span>⟩ +(⟨<span +class="cmti-10">long</span>⟩), and the <span +class="cmtt-10">sort</span><a + id="dx1-182001"></a> key is set to the long form instead of the short form. On <a +href="#glo:firstuse">first use</a>, the footnote text is in +the form ⟨<span +class="cmti-10">long</span>⟩: ⟨<span +class="cmti-10">description</span>⟩ (instead of just the long form). This requires defining a new acronym style that +inherits from the <span +class="cmss-10">footnote-sc-desc</span><a + id="dx1-182002"></a> style. +</p><!--l. 14973--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The conversion to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> starts in much the same way as the previous examples: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[acronym,nomain,</span><strong><span id="textcolor409"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor410"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,</span></strong><span +class="cmtt-10">style=altlist]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The abbreviation styles have associated helper commands that may be redefined to make minor modifications. +These redefinitions should be done before the abbreviations are defined. +<!--l. 14984--><p class="indent" > The <span id="textcolor411"><span +class="cmss-10">short-sc-footnote-desc</span></span><a + id="dx1-182003"></a> abbreviation style is the closest match to the requirement, so replace the +<span +class="cmtt-10">\setacronymstyle </span>command with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor412"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-182004"></a><span +class="cmtt-10">[acronym]{short-sc-footnote-desc}</span> +</div> +</div> Again, you may prefer <span id="textcolor413"><span +class="cmss-10">short-sc-postfootnote-desc</span></span><a + id="dx1-182005"></a>. Both styles use the same helper commands. +<!--l. 14993--><p class="indent" > Next some adjustments need to be made to fit the new requirements. The name needs to be ⟨<span +class="cmti-10">long</span>⟩ (⟨<span +class="cmti-10">short</span>⟩): +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor414"><span +class="cmtt-10">\glsxtrfootnotedescname</span></span><a + id="dx1-182006"></a><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \protect</span><strong><span id="textcolor415"><span +class="cmtt-10">\glslongfont</span></span><a + id="dx1-182007"></a><span +class="cmtt-10">{\the\glslongtok</span><a + id="dx1-182008"></a><span +class="cmtt-10">}</span></strong><span +class="cmtt-10">%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \protect</span><span id="textcolor416"><span +class="cmtt-10">\glsxtrfullsep</span></span><a + id="dx1-182009"></a><span +class="cmtt-10">{\the\glslabeltok</span><a + id="dx1-182010"></a><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \protect</span><span id="textcolor417"><span +class="cmtt-10">\glsxtrparen</span></span><a + id="dx1-182011"></a><span +class="cmtt-10">{\protect</span><strong><span id="textcolor418"><span +class="cmtt-10">\glsabbrvfont</span></span><a + id="dx1-182012"></a><span +class="cmtt-10">{\the\glsshorttok</span><a + id="dx1-182013"></a><span +class="cmtt-10">}</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This command expands when the abbreviations are defined so take care to <span +class="cmtt-10">\protect </span>commands that shouldn’t +be expanded at that point, and make sure that the token registers that store the label, long and short values are +able to expand. Similarly the sort value needs adjusting: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor419"><span +class="cmtt-10">\glsxtrfootnotedescsort</span></span><a + id="dx1-182014"></a><span +class="cmtt-10">}{</span><strong><span +class="cmtt-10">\the\glslongtok</span><a + id="dx1-182015"></a></strong><span +class="cmtt-10">}</span> + + +</div> +</div> The footnote for all the footnote abbreviation styles is produced with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor420"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span><a + id="dx1-182016"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">text</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> where ⟨<span +class="cmti-10">text</span>⟩ is the singular or plural long form, depending on what command was used to reference the +abbreviation (<span +class="cmtt-10">\gls</span>, <span +class="cmtt-10">\glspl </span>etc). This can simply be redefined as: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor421"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span><a + id="dx1-182017"></a><span +class="cmtt-10">}[2]{\footnote</span><a + id="dx1-182018"></a><span +class="cmtt-10">{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> #2:</span><span +class="cmtt-10"> \glsentrydesc</span><a + id="dx1-182019"></a><span +class="cmtt-10">{#1}}}</span> +</div> +</div> This will mimic the result from the original sample document. +<!--l. 15024--><p class="indent" > You may prefer to replace <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">#2</span></span></span> with a reference to a specific field (or fields). For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor422"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span><a + id="dx1-182020"></a><span +class="cmtt-10">}[2]{\footnote</span><a + id="dx1-182021"></a><span +class="cmtt-10">{%</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor423"><span +class="cmtt-10">\Glsfmtlong</span></span><a + id="dx1-182022"></a><span +class="cmtt-10">{#1}</span><span +class="cmtt-10"> (</span><span id="textcolor424"><span +class="cmtt-10">\glsfmtshort</span></span><a + id="dx1-182023"></a><span +class="cmtt-10">{#1}):</span><span +class="cmtt-10"> \glsentrydesc</span><a + id="dx1-182024"></a><span +class="cmtt-10">{#1}.}}</span> +</div> +</div> As with the earlier <a +href="#ex:sampleAcrDesc"><span +class="cmtt-10">sampleAcrDesc.tex</span></a>, you need to remove or change the redefinition of <span +class="cmtt-10">\glsseeitemformat</span><a + id="dx1-182025"></a> +since <span +class="cmtt-10">\acronymfont </span>is no longer appropriate. +<!--l. 15033--><p class="indent" > In the original <span +class="cmtt-10">sampleCustomAcr.tex </span>source code, I started the description with a capital: + + +</p> + <div class="verbatim" id="verbatim-412"> +\newacronym[description={Statistical pattern recognition + <br />technique using the ``kernel trick''}, + <br />see={[see also]{svm}}, + <br />]{ksvm}{ksvm}{kernel support vector machine} +</div> +<!--l. 15040--><p class="nopar" > This leads to a capital letter after the colon in the footnote, which is undesirable, but I would like to +have the description start with a capital in the glossary. The solution to this problem is easy with +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. I start the description with a lowercase letter and set the <span id="textcolor425"><span +class="cmss-10">glossdesc</span></span><a + id="dx1-182026"></a> attribute to <span +class="cmss-10">firstuc</span>: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor426"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-182027"></a><span +class="cmtt-10">{acronym}{glossdesc}{firstuc}</span> +</div> +</div> The abbreviation definitions are modified slightly: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newacronym</span><a + id="dx1-182028"></a><span +class="cmtt-10">[description={</span><strong><span +class="cmtt-10">s</span></strong><span +class="cmtt-10">tatistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span> +<br /><span +class="cmtt-10">technique</span><span +class="cmtt-10"> using</span><span +class="cmtt-10"> the</span><span +class="cmtt-10"> ``kernel</span><span +class="cmtt-10"> trick''},</span> +<br /><strong><span id="textcolor427"><span id="textcolor428"><span +class="cmtt-10">seealso</span></span><a + id="dx1-182029"></a></span><span +class="cmtt-10">={svm}</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10">]{ksvm}{ksvm}{kernel</span><span +class="cmtt-10"> support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +</div> +</div> Note the use of the <span id="textcolor429"><span id="textcolor430"><span +class="cmtt-10">seealso</span></span><a + id="dx1-182030"></a></span> key, which is only available with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. +<!--l. 15060--><p class="indent" > If you prefer to use <span id="textcolor431"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-182031"></a> instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-182032"></a>, then the category needs to be <span id="textcolor432"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-182033"></a> +rather than <span id="textcolor433"><span +class="cmss-10">acronym</span></span><a + id="dx1-182034"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor434"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-182035"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">abbreviation</span></strong><span +class="cmtt-10">}{glossdesc}{firstuc}</span> +</div> +</div> and the style command needs to be adjusted so that it omits the optional argument. For example: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor435"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-182036"></a><span +class="cmtt-10">{short-sc-postfootnote-desc}</span> +</div> +</div> +<a + id="x1-182037r8"></a> + + +<!--l. 15072--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-FnDesc"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-FnDesc">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-FnDesc.tex" ><span +class="cmtt-10">sample-FnDesc.tex</span></a></h4> +<!--l. 15072--><p class="noindent" >This example defines a custom display format that puts the description in a footnote on <a +href="#glo:firstuse">first use</a>. +</p><!--l. 15075--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-FnDesc + <br />makeglossaries sample-FnDesc + <br />pdflatex sample-FnDesc + <br /></pre><spacer type=vertical size=10> + <br /></span> +In order to prevent nested hyperlinks, this document uses the <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-183001"></a> package option (otherwise the +footnote marker hyperlink would be inside the hyperlink around the <a +href="#glo:linktext">link text<a + id="dx1-183002"></a></a> which would result in a nested +hyperlink). +</p><!--l. 15085--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has category post-link hooks that make it easier to adjust the +formatting. The post-link hook is placed after the hyperlink around the <a +href="#glo:linktext">link text<a + id="dx1-183003"></a></a>, so a hyperlink created by +<span +class="cmtt-10">\footnote</span><a + id="dx1-183004"></a> in the post-link hook won’t cause a nested link. This means that the <span +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-183005"></a> option isn’t +required: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor436"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor437"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 15096--><p class="indent" > <div class="important" title="Important Note"> Never use commands like <span +class="cmtt-10">\gls </span>or <span +class="cmtt-10">\glsdesc </span>in the post-link hook as you can end up with infinite recursion. +Use commands that don’t themselves have a post-link hook, such as <span +class="cmtt-10">\glsentrydesc </span>or <span +class="cmtt-10">\glossentrydesc</span>, +instead. </div> +</p><!--l. 15101--><p class="noindent" > +</p><!--l. 15103--><p class="indent" > In the original <span +class="cmtt-10">sample-FnDesc.tex </span>file, the format was adjusted with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glsentryfmt</span><a + id="dx1-183006"></a><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsgenentryfmt</span><a + id="dx1-183007"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \ifglsused</span><a + id="dx1-183008"></a><span +class="cmtt-10">{\glslabel</span><a + id="dx1-183009"></a><span +class="cmtt-10">}{}{\footnote</span><a + id="dx1-183010"></a><span +class="cmtt-10">{\glsentrydesc</span><a + id="dx1-183011"></a><span +class="cmtt-10">{\glslabel</span><a + id="dx1-183012"></a><span +class="cmtt-10">}}}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This can be changed to: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor438"><span +class="cmtt-10">\glsdefpostlink</span></span><a + id="dx1-183013"></a> +<br /><span +class="cmtt-10">{general}%</span><span +class="cmtt-10"> category</span><span +class="cmtt-10"> label</span> +<br /><span +class="cmtt-10">{</span><span id="textcolor439"><span +class="cmtt-10">\glsxtrifwasfirstuse</span></span><a + id="dx1-183014"></a><span +class="cmtt-10">{\footnote</span><a + id="dx1-183015"></a><span +class="cmtt-10">{\glsentrydesc</span><a + id="dx1-183016"></a><span +class="cmtt-10">{\glslabel</span><a + id="dx1-183017"></a><span +class="cmtt-10">}}}{}}</span> + + +</div> +</div> This sets the post-link hook for the <span id="textcolor440"><span +class="cmss-10">general</span></span><a + id="dx1-183018"></a> category (which is the default category for entries defined with +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-183019"></a>). If I added some abbreviations (which have a different category) then this change wouldn’t +apply to them. +<!--l. 15122--><p class="indent" > The first paragraph in the document is: + + +</p> + <div class="verbatim" id="verbatim-413"> +First use: \gls{sample}. +</div> +<!--l. 15125--><p class="nopar" > So the PDF will have the word “sample” (the <a +href="#glo:linktext">link text<a + id="dx1-183020"></a></a> created by <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{sample}</span></span></span>) as a hyperlink to the entry in +the glossary followed by the footnote marker, which is a hyperlink to the footnote. This is then followed by the +sentence terminator. “First use: sample<sup class="textsuperscript"><span +class="cmr-9">1</span></sup>.” +</p><!--l. 15132--><p class="indent" > It would look tidier if the footnote marker could be shifted after the full stop. “First use: sample.<sup class="textsuperscript"><span +class="cmr-9">1</span></sup>” This can +easily be achieved with a minor modification: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor441"><span +class="cmtt-10">\glsdefpostlink</span></span><a + id="dx1-183021"></a> +<br /><span +class="cmtt-10">{general}%</span><span +class="cmtt-10"> category</span><span +class="cmtt-10"> label</span> +<br /><span +class="cmtt-10">{</span><span id="textcolor442"><span +class="cmtt-10">\glsxtrifwasfirstuse</span></span><a + id="dx1-183022"></a> +<br /><span +class="cmtt-10"> {</span><span id="textcolor443"><span +class="cmtt-10">\glsxtrdopostpunc</span></span><a + id="dx1-183023"></a><span +class="cmtt-10">{\footnote</span><a + id="dx1-183024"></a><span +class="cmtt-10">{\glsentrydesc</span><a + id="dx1-183025"></a><span +class="cmtt-10">{\glslabel</span><a + id="dx1-183026"></a><span +class="cmtt-10">}}}}%</span> +<br /><span +class="cmtt-10"> {}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> You may prefer to use <span +class="cmtt-10">\glossentrydesc</span><a + id="dx1-183027"></a> instead of <span +class="cmtt-10">\glsentrydesc</span><a + id="dx1-183028"></a>. This will obey the <span id="textcolor444"><span +class="cmss-10">glossdesc</span></span><a + id="dx1-183029"></a> attribute. If +you append <span +class="cmtt-10">\glspostdescription</span><a + id="dx1-183030"></a>, you can also pick up the <span id="textcolor445"><span +class="cmss-10">postdot</span></span><a + id="dx1-183031"></a> package option. For example: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor446"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-183032"></a><span +class="cmtt-10">{general}{glossdesc}{firstuc}</span> +<br /> +<br /><span id="textcolor447"><span +class="cmtt-10">\glsdefpostlink</span></span><a + id="dx1-183033"></a> +<br /><span +class="cmtt-10">{general}%</span><span +class="cmtt-10"> category</span><span +class="cmtt-10"> label</span> +<br /><span +class="cmtt-10">{</span><span id="textcolor448"><span +class="cmtt-10">\glsxtrifwasfirstuse</span></span><a + id="dx1-183034"></a> +<br /><span +class="cmtt-10"> {</span><span id="textcolor449"><span +class="cmtt-10">\glsxtrdopostpunc</span></span><a + id="dx1-183035"></a><span +class="cmtt-10">{\footnote</span><a + id="dx1-183036"></a><span +class="cmtt-10">{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\glossentrydesc</span><a + id="dx1-183037"></a></strong><span +class="cmtt-10">{\glslabel</span><a + id="dx1-183038"></a><span +class="cmtt-10">}</span><strong><span +class="cmtt-10">\glspostdescription</span><a + id="dx1-183039"></a></strong><span +class="cmtt-10">}}}%</span> +<br /><span +class="cmtt-10"> {}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Alternatively, you could just use <span +class="cmtt-10">\Glsentrydesc</span><a + id="dx1-183040"></a> and explicitly append the full stop. +<a + id="x1-183041r9"></a> +<!--l. 15161--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-custom-acronym"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-custom-acronym">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-custom-acronym.tex" ><span +class="cmtt-10">sample-custom-acronym.tex</span></a></h4> +<!--l. 15162--><p class="noindent" >This document illustrates how to define your own acronym style if the predefined styles don’t suit your +requirements. + + +</p><!--l. 15164--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-custom-acronym + <br />makeglossaries sample-custom-acronym + <br />pdflatex sample-custom-acronym + <br /></pre><spacer type=vertical size=10> + <br /></span> +In this case, a style is defined to show the short form in the text with the long form and description in a +footnote on <a +href="#glo:firstuse">first use</a>. The long form is used for the <span +class="cmtt-10">sort</span><a + id="dx1-184001"></a> value. The short form is displayed in <a +href="#glo:smallcaps">small caps<a + id="dx1-184002"></a></a> in the +main part of the document but in uppercase in the list of acronyms. (So it’s a slight variation of some of the +examples above.) The <span +class="cmtt-10">name</span><a + id="dx1-184003"></a> is set to the long form (starting with an initial capital) followed by the all caps short +form in parentheses. The final requirement is that the inline form should show the long form followed by the +short form in parentheses. +</p><!--l. 15180--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>As with <a +href="#ex:sampleFnAcrDesc"><span +class="cmtt-10">sampleFnAcrDesc.tex</span></a>, the <span id="textcolor450"><span +class="cmss-10">short-sc-footnote-desc</span></span><a + id="dx1-184004"></a> and <span id="textcolor451"><span +class="cmss-10">short-sc-postfootnote-desc</span></span><a + id="dx1-184005"></a> +abbreviation styles produce almost the required effect so one of those can be used as a starting point. +However the final requirement doesn’t fit. It’s now necessary to actually define a custom abbreviation +style, but it can mostly inherit from the <span id="textcolor452"><span +class="cmss-10">short-sc-footnote-desc</span></span><a + id="dx1-184006"></a> or <span id="textcolor453"><span +class="cmss-10">short-sc-postfootnote-desc</span></span><a + id="dx1-184007"></a> style: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor454"><span +class="cmtt-10">\newabbreviationstyle</span></span><a + id="dx1-184008"></a><span +class="cmtt-10">{custom-fn}%</span> +<br /><span +class="cmtt-10">{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor455"><span +class="cmtt-10">\GlsXtrUseAbbrStyleSetup</span></span><a + id="dx1-184009"></a><span +class="cmtt-10">{short-sc-footnote-desc}%</span> +<br /><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10">{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor456"><span +class="cmtt-10">\GlsXtrUseAbbrStyleFmts</span></span><a + id="dx1-184010"></a><span +class="cmtt-10">{short-sc-footnote-desc}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \renewcommand*{</span><span id="textcolor457"><span +class="cmtt-10">\glsxtrinlinefullformat</span></span><a + id="dx1-184011"></a><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor458"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span><a + id="dx1-184012"></a></strong><span +class="cmtt-10">{</span><strong><span id="textcolor459"><span +class="cmtt-10">\glsaccesslong</span></span><a + id="dx1-184013"></a><span +class="cmtt-10">{##1}</span></strong><span +class="cmtt-10">%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor460"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184014"></a><span +class="cmtt-10">##2\fi}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor461"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184015"></a><span +class="cmtt-10">\else##2\fi</span><span id="textcolor462"><span +class="cmtt-10">\glsxtrfullsep</span></span><a + id="dx1-184016"></a><span +class="cmtt-10">{##1}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor463"><span +class="cmtt-10">\glsxtrparen</span></span><a + id="dx1-184017"></a><span +class="cmtt-10">{</span><strong><span id="textcolor464"><span +class="cmtt-10">\glsfirstabbrvscfont</span></span><a + id="dx1-184018"></a><span +class="cmtt-10">{</span><span id="textcolor465"><span +class="cmtt-10">\glsaccessshort</span></span><a + id="dx1-184019"></a><span +class="cmtt-10">{##1}}</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \renewcommand*{</span><span id="textcolor466"><span +class="cmtt-10">\glsxtrinlinefullplformat</span></span><a + id="dx1-184020"></a><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor467"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span><a + id="dx1-184021"></a></strong><span +class="cmtt-10">{</span><strong><span id="textcolor468"><span +class="cmtt-10">\glsaccesslongpl</span></span><a + id="dx1-184022"></a><span +class="cmtt-10">{##1}</span></strong><span +class="cmtt-10">%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor469"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184023"></a><span +class="cmtt-10">##2\fi}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor470"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184024"></a><span +class="cmtt-10">\else##2\fi</span><span id="textcolor471"><span +class="cmtt-10">\glsxtrfullsep</span></span><a + id="dx1-184025"></a><span +class="cmtt-10">{##1}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor472"><span +class="cmtt-10">\glsxtrparen</span></span><a + id="dx1-184026"></a><span +class="cmtt-10">{</span><strong><span id="textcolor473"><span +class="cmtt-10">\glsfirstabbrvscfont</span></span><a + id="dx1-184027"></a><span +class="cmtt-10">{</span><span id="textcolor474"><span +class="cmtt-10">\glsaccessshortpl</span></span><a + id="dx1-184028"></a><span +class="cmtt-10">{##1}}</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \renewcommand*{</span><span id="textcolor475"><span +class="cmtt-10">\Glsxtrinlinefullformat</span></span><a + id="dx1-184029"></a><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor476"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span><a + id="dx1-184030"></a></strong><span +class="cmtt-10">{</span><strong><span id="textcolor477"><span +class="cmtt-10">\Glsaccesslong</span></span><a + id="dx1-184031"></a><span +class="cmtt-10">{##1}</span></strong><span +class="cmtt-10">%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor478"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184032"></a><span +class="cmtt-10">##2\fi}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor479"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184033"></a><span +class="cmtt-10">\else##2\fi</span><span id="textcolor480"><span +class="cmtt-10">\glsxtrfullsep</span></span><a + id="dx1-184034"></a><span +class="cmtt-10">{##1}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor481"><span +class="cmtt-10">\glsxtrparen</span></span><a + id="dx1-184035"></a><span +class="cmtt-10">{</span><strong><span id="textcolor482"><span +class="cmtt-10">\glsfirstabbrvscfont</span></span><a + id="dx1-184036"></a><span +class="cmtt-10">{</span><span id="textcolor483"><span +class="cmtt-10">\glsaccessshort</span></span><a + id="dx1-184037"></a><span +class="cmtt-10">{##1}}</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \renewcommand*{</span><span id="textcolor484"><span +class="cmtt-10">\Glsxtrinlinefullplformat</span></span><a + id="dx1-184038"></a><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor485"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span><a + id="dx1-184039"></a></strong><span +class="cmtt-10">{</span><strong><span id="textcolor486"><span +class="cmtt-10">\Glsaccesslongpl</span></span><a + id="dx1-184040"></a><span +class="cmtt-10">{##1}</span></strong><span +class="cmtt-10">%</span> + + +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor487"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184041"></a><span +class="cmtt-10">##2\fi}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor488"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span><a + id="dx1-184042"></a><span +class="cmtt-10">\else##2\fi</span><span id="textcolor489"><span +class="cmtt-10">\glsxtrfullsep</span></span><a + id="dx1-184043"></a><span +class="cmtt-10">{##1}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor490"><span +class="cmtt-10">\glsxtrparen</span></span><a + id="dx1-184044"></a><span +class="cmtt-10">{</span><strong><span id="textcolor491"><span +class="cmtt-10">\glsfirstabbrvscfont</span></span><a + id="dx1-184045"></a><span +class="cmtt-10">{</span><span id="textcolor492"><span +class="cmtt-10">\glsaccessshortpl</span></span><a + id="dx1-184046"></a><span +class="cmtt-10">{##1}}</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> (See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details.) +<!--l. 15222--><p class="indent" > This new custom style now needs to be set: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor493"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-184047"></a><span +class="cmtt-10">[acronym]{custom-fn}</span> +</div> +</div> Remember that if you decide to use <span id="textcolor494"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-184048"></a> instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-184049"></a> then the category will be +<span id="textcolor495"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-184050"></a> not <span id="textcolor496"><span +class="cmss-10">acronym</span></span><a + id="dx1-184051"></a>: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor497"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-184052"></a><span +class="cmtt-10">{custom-fn}</span> +</div> +</div> This custom style simply adjusts the inline full form. There are other adjustments to be made that apply to the +inherited style. (The alternative is to design a new style from scratch.) The footnote contains the +long form followed by the description. This is the same as the modification to an earlier example: +<div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor498"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span><a + id="dx1-184053"></a><span +class="cmtt-10">}[2]{\footnote</span><a + id="dx1-184054"></a><span +class="cmtt-10">{#2:</span> +<br /><span +class="cmtt-10">\glsentrydesc</span><a + id="dx1-184055"></a><span +class="cmtt-10">{#1}.}}</span> +</div> +</div> As with <a +href="#ex:sampleCustomAcr"><span +class="cmtt-10">sampleCustomAcr.tex</span></a>, if you specifically want the singular long form then you can ignore the second +argument. For example: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor499"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span><a + id="dx1-184056"></a><span +class="cmtt-10">}[2]{\footnote</span><a + id="dx1-184057"></a> +<br /><span +class="cmtt-10"> {</span><span id="textcolor500"><span +class="cmtt-10">\Glsfmtlong</span></span><a + id="dx1-184058"></a><span +class="cmtt-10">{#1}:</span><span +class="cmtt-10"> \glsentrydesc</span><a + id="dx1-184059"></a><span +class="cmtt-10">{#1}.}}</span> +</div> +</div> +<!--l. 15248--><p class="indent" > The <span +class="cmtt-10">name</span><a + id="dx1-184060"></a> now needs to be the long form followed by the short form in parentheses, but note the new +requirement that the short form should now be in all capitals not <a +href="#glo:smallcaps">small caps<a + id="dx1-184061"></a></a> and the long form should start with +a capital letter. </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor501"><span +class="cmtt-10">\glsxtrfootnotedescname</span></span><a + id="dx1-184062"></a><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \protect</span><span id="textcolor502"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span><a + id="dx1-184063"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\makefirstuc</span><a + id="dx1-184064"></a><span +class="cmtt-10">{\the\glslongtok</span><a + id="dx1-184065"></a><span +class="cmtt-10">}}</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> (\protect\MakeTextUppercase</span><a + id="dx1-184066"></a><span +class="cmtt-10">{\the\glsshorttok</span><a + id="dx1-184067"></a><span +class="cmtt-10">})%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The inherited abbreviation style uses the short form as the <span +class="cmtt-10">sort</span><a + id="dx1-184068"></a> value by default. This needs to be changed to +the long form: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{</span><span id="textcolor503"><span +class="cmtt-10">\glsxtrfootnotedescsort</span></span><a + id="dx1-184069"></a><span +class="cmtt-10">}{\the</span><strong><span +class="cmtt-10">\glslongtok</span><a + id="dx1-184070"></a></strong><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 15265--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you want to switch to using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-184071"></a></a>, remember to set the abbreviation style before the +resource command and change the default sort fallback field to <span +class="cmtt-10">long</span><a + id="dx1-184072"></a>, as with <a +href="#ex:sampleAcrDesc"><span +class="cmtt-10">sampleAcrDesc.tex</span></a>. +</div> +</p><!--l. 15270--><p class="noindent" > +<a + id="x1-184073r10"></a> +</p><!--l. 15272--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-dot-abbr"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-dot-abbr">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-dot-abbr.tex" ><span +class="cmtt-10">sample-dot-abbr.tex</span></a></h4> +<!--l. 15272--><p class="noindent" >This document illustrates how to use the base post link hook to adjust the space factor after abbreviations. +</p><!--l. 15274--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-dot-abbr + <br />makeglossaries sampledot-abbrf + <br />pdflatex sample-dot-abbr + <br /></pre><spacer type=vertical size=10> + <br /></span> +This example creates a custom storage key that provides a similar function to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span>’s</a> <span id="textcolor504"><span id="textcolor505"><span +class="cmtt-10">category</span></span><a + id="dx1-185001"></a></span> +key. +</p><!--l. 15282--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This example is much simpler with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. The custom storage key, which is defined +using: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsaddstoragekey</span><a + id="dx1-185002"></a><span +class="cmtt-10">{abbrtype}{word}{\abbrtype}</span> +</div> +</div> can now be removed. +<!--l. 15290--><p class="indent" > The <span id="textcolor506"><span id="textcolor507"><span +class="cmtt-10">category</span></span><a + id="dx1-185003"></a></span> key is set to <span +class="cmtt-10">initials </span>for the initialisms (which are defined with the custom <span +class="cmtt-10">\newacr</span> +command). The abbreviation styles can be set with: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor508"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-185004"></a><span +class="cmtt-10">[acronym]{long-short}</span> +<br /><span id="textcolor509"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-185005"></a><span +class="cmtt-10">[initials]{long-short}</span> +</div> +</div> The <span id="textcolor510"><span +class="cmss-10">discardperiod</span></span><a + id="dx1-185006"></a> attribute will discard any full stop (period) following commands like <span +class="cmtt-10">\gls</span>: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor511"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-185007"></a><span +class="cmtt-10">{initials}{discardperiod}{true}</span> +</div> +</div> (If you want to use the <span id="textcolor512"><span +class="cmss-10">noshortplural</span></span><a + id="dx1-185008"></a> attribute then you will also need to set the <span id="textcolor513"><span +class="cmss-10">pluraldiscardperiod</span></span><a + id="dx1-185009"></a> +attribute.) +<!--l. 15305--><p class="indent" > The <a +href="#glo:firstuse">first use</a> is governed by the <span id="textcolor514"><span +class="cmss-10">retainfirstuseperiod</span></span><a + id="dx1-185010"></a> attribute. If set, the period won’t be discarded if it +follows the <a +href="#glo:firstuse">first use</a> of commands like <span +class="cmtt-10">\gls</span>. This is useful for styles where the <a +href="#glo:firstuse">first use</a> doesn’t end with the +short form. In this case, the <a +href="#glo:firstuse">first use</a> of the <span id="textcolor515"><span +class="cmss-10">long-short</span></span><a + id="dx1-185011"></a> style ends with a closing parenthesis, so the end of +sentence might be clearer if the period is retained: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor516"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-185012"></a><span +class="cmtt-10">{initials}{retainfirstuseperiod}{true}</span> +</div> +</div> +<!--l. 15316--><p class="indent" > The <span id="textcolor517"><span +class="cmss-10">insertdots</span></span><a + id="dx1-185013"></a> attribute can automatically insert dots into the short form with a final space factor +adjustment: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor518"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-185014"></a><span +class="cmtt-10">{initials}{insertdots}{true}</span> +</div> +</div> +<!--l. 15322--><p class="indent" > The custom helper command defined in the example needs to be slightly modified: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{\newabbr}[1][]{%</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor519"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-185015"></a></strong><span +class="cmtt-10">[</span><strong><span id="textcolor520"><span +class="cmtt-10">category</span></span></strong><span +class="cmtt-10">=initials,#1]}</span> +</div> +</div> The definitions need to be slightly modified to work with the <span id="textcolor521"><span +class="cmss-10">insertdots</span></span><a + id="dx1-185016"></a> attribute: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newabbr{eg}{</span><strong><span +class="cmtt-10">eg</span></strong><span +class="cmtt-10">}{eg}</span> +<br /><span +class="cmtt-10">\newabbr{ie}{</span><strong><span +class="cmtt-10">ie</span></strong><span +class="cmtt-10">}{ie}</span> +<br /><span +class="cmtt-10">\newabbr{bsc}{</span><strong><span +class="cmtt-10">B{Sc}</span></strong><span +class="cmtt-10">}{Bachelor</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> Science}</span> +<br /><span +class="cmtt-10">\newabbr{ba}{</span><strong><span +class="cmtt-10">BA</span></strong><span +class="cmtt-10">}{BA}</span> +<br /><span +class="cmtt-10">\newabbr{agm}{</span><strong><span +class="cmtt-10">AGM</span></strong><span +class="cmtt-10">}{AGM}</span> + + +</div> +</div> (This makes it much easier to change your mind if you decide at a later date to omit the dots, especially if you +are storing all your definitions in a file that’s shared across multiple documents, but note the need to group +“Sc”.) +<!--l. 15342--><p class="indent" > The “laser” definition remains unchanged: + + +</p> + <div class="verbatim" id="verbatim-414"> +\newacronym{laser}{laser}{light amplification by stimulated + <br />emission of radiation} +</div> +<!--l. 15346--><p class="nopar" > The remaining code in the preamble must now be removed. (It will interfere with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span>’s</a> category +post-link hooks.) No change is required in the document body. +</p><!--l. 15351--><p class="indent" > See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details about category attributes and post-link +hooks. +<a + id="x1-185017r11"></a> +</p><!--l. 15354--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-font-abbr"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-font-abbr">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-font-abbr.tex" ><span +class="cmtt-10">sample-font-abbr.tex</span></a></h4> +<!--l. 15354--><p class="noindent" >This document illustrates how to have different fonts for abbreviations within the style. The document build +is: +</p><!--l. 15356--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-font-abbr + <br />makeglossaries sample-font-abbr + <br />pdflatex sample-font-abbr + <br /></pre><spacer type=vertical size=10> + <br /></span> +The acronym mechanism provided by the base <span +class="cmss-10">glossaries </span>package isn’t well suited to having a mixture of styles. +This example provides a workaround that involves defining a new storage key with <span +class="cmtt-10">\glsaddstoragekey</span><a + id="dx1-186001"></a> that’s +used to hold the font declaration (such as <span +class="cmtt-10">\em</span>). + + +</p> + <div class="verbatim" id="verbatim-415"> +\glsaddstoragekey{font}{}{\entryfont} +</div> +<!--l. 15368--><p class="nopar" > A new custom acronym style is defined that fetches the font information from this new key so that it can be +applied to the abbreviation. Some helper commands are also provided to define the different types of +abbreviation: + + +</p> + <div class="verbatim" id="verbatim-416"> +\newcommand*{\newitabbr}[1][]{\newacronym[font=\em,#1]} + <br />\newcommand*{\newupabbr}{\newacronym} + <br />\newitabbr{eg}{e.g.}{exempli gratia} + <br />\newupabbr{bsc}{BSc}{Bachelor of Science} +</div> +<!--l. 15379--><p class="nopar" > This makes the <a +href="#glo:firstuse">first use</a> of <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{eg}</span></span></span> appear as “exempli gratia (<span +class="cmti-10">e.g.</span>)” whereas the <a +href="#glo:firstuse">first use</a> of <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{bsc}</span></span></span> is +“Bachelor of Science (BSc)”. +</p><!--l. 15384--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This example document is much simpler with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. First the <span +class="cmtt-10">\usepackage</span> +command needs adjusting: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor522"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor523"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The custom storage key can now be removed and also the custom acronym style. Now replace the +<span +class="cmtt-10">\setacronymstyle</span><a + id="dx1-186002"></a> line with: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor524"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-186003"></a><span +class="cmtt-10">[acronym]{long-short-em}</span> +</div> +</div> and change the definition of the helper commands: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{\newitabbr}{\newacronym</span><a + id="dx1-186004"></a><span +class="cmtt-10">}</span> +<br /><span +class="cmtt-10">\newcommand*{\newupabbr}{</span><strong><span id="textcolor525"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-186005"></a></strong><span +class="cmtt-10">}</span> +</div> +</div> Note that the <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">font=\em,</span></span></span> part has been removed from the definition of the first command and the second +command uses <span id="textcolor526"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-186006"></a> instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-186007"></a>. This means that <span +class="cmtt-10">\newitabbr </span>will default to +<span id="textcolor527"><span id="textcolor528"><span +class="cmtt-10">category</span></span><a + id="dx1-186008"></a></span><span +class="cmtt-10">=acronym </span>and <span +class="cmtt-10">\newupabbr </span>will default to <span id="textcolor529"><span id="textcolor530"><span +class="cmtt-10">category</span></span><a + id="dx1-186009"></a></span><span +class="cmtt-10">=abbreviation</span>. The default style for the +<span id="textcolor531"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-186010"></a> category is <span id="textcolor532"><span +class="cmss-10">long-short</span></span><a + id="dx1-186011"></a>, which is the required style for this example. This just means that +only the <span id="textcolor533"><span +class="cmss-10">acronym</span></span><a + id="dx1-186012"></a> category needs to have the style set (with the above <span id="textcolor534"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-186013"></a> +command). +<!--l. 15412--><p class="indent" > Finally, the <span +class="cmtt-10">\acrshort</span><a + id="dx1-186014"></a>, <span +class="cmtt-10">\acrlong</span><a + id="dx1-186015"></a> and <span +class="cmtt-10">\acrfull </span>commands need to be replaced with <span id="textcolor535"><span +class="cmtt-10">\glsxtrshort</span></span><a + id="dx1-186016"></a>, +<span id="textcolor536"><span +class="cmtt-10">\glsxtrlong</span></span><a + id="dx1-186017"></a> and <span id="textcolor537"><span +class="cmtt-10">\glsxtrfull</span></span><a + id="dx1-186018"></a>. +</p><!--l. 15416--><p class="indent" > You may notice that the spacing after “e.g.” and “i.e.” isn’t correct. This is similar to the <a +href="#ex:sample-dot-abbr"><span +class="cmtt-10">sample-dot-abbr.tex</span></a> +example where the space factor needs adjusting. In this case I’ve inserted the dots manually (rather than relying +on the <span id="textcolor538"><span +class="cmss-10">insertdots</span></span><a + id="dx1-186019"></a> attribute). You can either remove the dots and use <span id="textcolor539"><span +class="cmss-10">insertdots</span></span><a + id="dx1-186020"></a> with <span id="textcolor540"><span +class="cmss-10">discardperiod</span></span><a + id="dx1-186021"></a>: +</p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor541"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-186022"></a><span +class="cmtt-10">{acronym}{insertdots}{true}</span> +<br /><span id="textcolor542"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-186023"></a><span +class="cmtt-10">{acronym}{discardperiod}{true}</span> +<br /> +<br /><span +class="cmtt-10">\newitabbr{eg}{</span><strong><span +class="cmtt-10">eg</span></strong><span +class="cmtt-10">}{exempli</span><span +class="cmtt-10"> gratia}</span> +<br /><span +class="cmtt-10">\newitabbr{ie}{</span><strong><span +class="cmtt-10">ie</span></strong><span +class="cmtt-10">}{id</span><span +class="cmtt-10"> est}</span> +</div> +</div> Or you can manually insert the space factor adjustment and only use the <span id="textcolor543"><span +class="cmss-10">discardperiod</span></span><a + id="dx1-186024"></a> attribute: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor544"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-186025"></a><span +class="cmtt-10">{acronym}{discardperiod}{true}</span> +<br /> +<br /><span +class="cmtt-10">\newitabbr{eg}{e.g.</span><strong><span +class="cmtt-10">\@</span><a + id="dx1-186026"></a></strong><span +class="cmtt-10">}{exempli</span><span +class="cmtt-10"> gratia}</span> +<br /><span +class="cmtt-10">\newitabbr{ie}{i.e.</span><strong><span +class="cmtt-10">\@</span><a + id="dx1-186027"></a></strong><span +class="cmtt-10">}{id</span><span +class="cmtt-10"> est}</span> +</div> +</div> +<!--l. 15438--><p class="indent" > You don’t have to use the <span id="textcolor545"><span +class="cmss-10">acronym</span></span><a + id="dx1-186028"></a> category. You may prefer a different label that fits better semantically. +For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor546"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-186029"></a><span +class="cmtt-10">[</span><strong><span +class="cmtt-10">latinabbr</span></strong><span +class="cmtt-10">]{long-short-em}</span> +<br /><span +class="cmtt-10">\newcommand*{\new</span><strong><span +class="cmtt-10">latin</span></strong><span +class="cmtt-10">abbr}[1][]{</span><span id="textcolor547"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-186030"></a><span +class="cmtt-10">[</span><span id="textcolor548"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">latinabbr</span></strong><span +class="cmtt-10">,#1]}</span> +<br /><span id="textcolor549"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-186031"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">latinabbr</span></strong><span +class="cmtt-10">}{insertdots}{true}</span> +<br /><span id="textcolor550"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-186032"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">latinabbr</span></strong><span +class="cmtt-10">}{discardperiod}{true}</span> +<br /> +<br /><span +class="cmtt-10">\new</span><strong><span +class="cmtt-10">latin</span></strong><span +class="cmtt-10">abbr{eg}{e.g.</span><strong><span +class="cmtt-10">\@</span><a + id="dx1-186033"></a></strong><span +class="cmtt-10">}{exempli</span><span +class="cmtt-10"> gratia}</span> +<br /><span +class="cmtt-10">\new</span><strong><span +class="cmtt-10">latin</span></strong><span +class="cmtt-10">abbr{ie}{i.e.</span><strong><span +class="cmtt-10">\@</span><a + id="dx1-186034"></a></strong><span +class="cmtt-10">}{id</span><span +class="cmtt-10"> est}</span> +</div> +</div> +<!--l. 15450--><p class="noindent" > +</p> +<!--l. 15450--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.3 </span> <a + id="sec:samplecounter"></a>Non-Page Locations</h3> +<a + id="x1-187001r12"></a> +<!--l. 15453--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleEq"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleEq">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleEq.tex" ><span +class="cmtt-10">sampleEq.tex</span></a></h4> + + +<!--l. 15453--><p class="noindent" >This document illustrates how to change the location to something other than the page number. In this case, +the <span +class="cmss-10">equation </span>counter is used since all glossary entries appear inside an <span +class="cmss-10">equation</span><a + id="dx1-188001"></a><a + id="dx1-188002"></a> environment. To create the +document do: +</p><!--l. 15458--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleEq + <br />makeglossaries sampleEq + <br />pdflatex sampleEq + <br /></pre><spacer type=vertical size=10> + <br /></span> +The <span +class="cmss-10">glossaries </span>package provides some location formats, such as <span +class="cmtt-10">\hyperrm</span><a + id="dx1-188003"></a> and <span +class="cmtt-10">\hyperbf</span><a + id="dx1-188004"></a>, that allow the +locations in the <a +href="#glo:numberlist">number list<a + id="dx1-188005"></a></a> to hyperlink to the appropriate place in the document (if <span +class="cmss-10">hyperref</span><a + id="dx1-188006"></a> has +been used). Since it’s not possible to include the hyperlink name in the indexing information with +<a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-188007"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-188008"></a></a>, the <span +class="cmss-10">glossaries </span>package has to reform the name from a prefix and the location +value. +</p><!--l. 15471--><p class="indent" > Unfortunately it’s not always possible to split the link name into a prefix and location. That happens with +the <span +class="cmss-10">equation </span>counter in certain classes, such as the <span +class="cmss-10">report </span>class (which is used in this example). +This means that it’s necessary to redefine <span +class="cmtt-10">\theHequation</span><a + id="dx1-188009"></a> so that it has a format that fits the +requirement: + + +</p> + <div class="verbatim" id="verbatim-417"> +\renewcommand*\theHequation{\theHchapter.\arabic{equation}} +</div> +<!--l. 15478--><p class="nopar" > If you don’t do this, the equation locations in the glossary won’t form valid hyperlinks. +</p><!--l. 15482--><p class="indent" > Each glossary entry represents a mathematical symbol. This means that with Options <a +href="#option1">1</a>–<a +href="#option3">3</a> it’s necessary to +use the <span +class="cmtt-10">sort</span><a + id="dx1-188010"></a> key. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)},</span> +<br /><span +class="cmtt-10">description=Gamma</span><span +class="cmtt-10"> function,</span><strong><span +class="cmtt-10">sort=Gamma</span></strong><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 15490--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-188011"></a></a></span>If you want to switch to using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-188012"></a></a>, the first change you need to make is to switch from +explicitly loading <span +class="cmss-10">glossaries </span>to loading <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> with the <span id="textcolor551"><span +class="cmss-10">record</span></span><a + id="dx1-188013"></a> package option. If <span id="textcolor552"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">only</span></span><a + id="dx1-188014"></a> (or <span id="textcolor553"><span +class="cmss-10">record</span></span><a + id="dx1-188015"></a> +without a value) is used, then the above redefinition of <span +class="cmtt-10">\theHequation </span>is still required. If <span id="textcolor554"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-188016"></a> is used +instead then the redefinition of <span +class="cmtt-10">\theHequation </span>isn’t required. You may also want to use the <span id="textcolor555"><span +class="cmss-10">stylemods</span></span><a + id="dx1-188017"></a> and +<span id="textcolor556"><span +class="cmss-10">postdot</span></span><a + id="dx1-188018"></a> options: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><strong><span id="textcolor557"><span +class="cmtt-10">record=nameref</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor558"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,</span><span id="textcolor559"><span +class="cmtt-10">postdot</span></span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> ucmark,style=long3colheader,counter=equation]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The entries now need to be converted into the <span +class="cmtt-10">bib</span><a + id="dx1-188019"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-188020"></a></a>, which can be done with +<a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-188021"></a></a>: +<!--l. 15506--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sampleEq.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This will create a file called <span +class="cmtt-10">entries.bib </span>that starts: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> Encoding:</span><span +class="cmtt-10"> UTF-8</span> +<br /><span id="textcolor560"><span +class="cmtt-10">@entry</span></span><a + id="dx1-188022"></a><span +class="cmtt-10">{Gamma,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\Gamma(z)}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Gamma</span><span +class="cmtt-10"> function}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> You may prefer to change <span id="textcolor561"><span +class="cmtt-10">@entry</span></span><a + id="dx1-188023"></a> to <span id="textcolor562"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-188024"></a>. (This should be easy to do with your text editor’s search and +replace function.) + + +<!--l. 15521--><p class="indent" > Note that the <span +class="cmtt-10">sort</span><a + id="dx1-188025"></a> key has been omitted. This is because it typically shouldn’t be used. The difference +between using <span id="textcolor563"><span +class="cmtt-10">@entry</span></span><a + id="dx1-188026"></a> and <span id="textcolor564"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-188027"></a> is that with <span id="textcolor565"><span +class="cmtt-10">@entry</span></span><a + id="dx1-188028"></a> the sort value will be obtained from the <span +class="cmtt-10">name</span><a + id="dx1-188029"></a> but with +<span id="textcolor566"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-188030"></a> the sort value will be obtained from the label. If you explicitly use the <span +class="cmtt-10">sort</span><a + id="dx1-188031"></a> key then you will break +this behaviour. (If you try this example out, notice the difference in the ordering if you switch between <span id="textcolor567"><span +class="cmtt-10">@entry</span></span><a + id="dx1-188032"></a> +and <span id="textcolor568"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-188033"></a>. See also <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a>.) +</p><!--l. 15531--><p class="indent" > Next replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor569"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-188034"></a><span +class="cmtt-10">[</span><span id="textcolor570"><span +class="cmtt-10">src</span></span><a + id="dx1-188035"></a><span +class="cmtt-10">=entries]</span></strong> +</div> +</div> If you have used <span id="textcolor571"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-188036"></a> then you can remove the redefinition of <span +class="cmtt-10">\theHequation</span>. Next remove all the +lines defining the glossary entries (since they’re now defined in the <span +class="cmtt-10">bib</span><a + id="dx1-188037"></a> file). +<!--l. 15540--><p class="indent" > Finally, replace <span +class="cmtt-10">\printglossary</span><a + id="dx1-188038"></a> with <span id="textcolor572"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-188039"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor573"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-188040"></a></strong><span +class="cmtt-10">[title={Index</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> Special</span><span +class="cmtt-10"> Functions</span><span +class="cmtt-10"> and</span> +<br /><span +class="cmtt-10">Notations}]</span> +</div> +</div> The rest of the document remains unchanged (unless you want to use <span id="textcolor574"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-188041"></a> as described in the following +example). +<a + id="x1-188042r13"></a> +<!--l. 15548--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleEqPg"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleEqPg">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleEqPg.tex" ><span +class="cmtt-10">sampleEqPg.tex</span></a></h4> +<!--l. 15548--><p class="noindent" >This is similar to the previous example, but the <a +href="#glo:numberlist">number list<a + id="dx1-189001"></a>s</a> are a mixture of page numbers and +equation numbers. This example adds the glossary to the table of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is +required: +</p><!--l. 15552--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleEqPg + <br />makeglossaries sampleEqPg + <br />pdflatex sampleEqPg + <br />pdflatex sampleEqPg + <br /></pre><spacer type=vertical size=10> + <br /></span> +As with the previous example, entries are defined like this: + + +</p> + <div class="verbatim" id="verbatim-418"> +\newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)}, + <br />description=Gamma function,sort=Gamma} +</div> +<!--l. 15562--><p class="nopar" > The <span +class="cmss-10">counter</span><span +class="cmtt-10">=</span><span +class="cmss-10">equation</span><a + id="dx1-189002"></a> package option is used to set the default indexing counter to <span +class="cmss-10">equation</span>. This means that it +has to be changed for indexing outside of any numbered equation. For example: + + +</p> + <div class="verbatim" id="verbatim-419"> +\glslink[format=hyperbf,counter=page]{Gamma}{gamma function} +</div> +<!--l. 15569--><p class="nopar" > I’ve set the <span +class="cmtt-10">format</span><a + id="dx1-189003"></a> to <span +class="cmtt-10">hyperbf</span><a + id="dx1-189004"></a> to indicate that this is a primary reference. (Note that I’m using <span +class="cmtt-10">\hyperbf</span><a + id="dx1-189005"></a> not +<span +class="cmtt-10">\textbf</span><a + id="dx1-189006"></a> in order to include a hyperlink in the location.) +</p><!--l. 15574--><p class="indent" > The <a +href="#glo:linktext">link text<a + id="dx1-189007"></a></a> here is almost identical to the description. The only difference is that the description starts +with a capital. If it started with a lowercase character instead, I could simply use <span +class="cmtt-10">\glsdesc</span><a + id="dx1-189008"></a> instead of +<span +class="cmtt-10">\glslink</span><a + id="dx1-189009"></a>. If I change the entry descriptions so that they all start with a lowercase letter then I would need to +create a custom glossary style that used <span +class="cmtt-10">\Glossentrydesc</span><a + id="dx1-189010"></a> instead of <span +class="cmtt-10">\glossentrydesc</span><a + id="dx1-189011"></a>. +</p><!--l. 15582--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If I switch to using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> I wouldn’t need a new glossary style. Instead I could just +use the <span id="textcolor575"><span +class="cmss-10">glossdesc</span></span><a + id="dx1-189012"></a> attribute to perform the case change. Remember that the first change to make is to replace +<span +class="cmss-10">glossaries </span>with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=long3colheader,</span><strong><span id="textcolor576"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor577"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> counter=equation]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The entries are now all defined so that the description starts with a lowercase letter (except for the descriptions +that start with a proper noun). For example: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-189013"></a><span +class="cmtt-10">{Gamma}{name=\ensuremath{\Gamma(z)},</span> +<br /><span +class="cmtt-10">description=</span><strong><span +class="cmtt-10">g</span></strong><span +class="cmtt-10">amma</span><span +class="cmtt-10"> function,sort=Gamma}</span> +</div> +</div> The <span id="textcolor578"><span +class="cmss-10">glossdesc</span></span><a + id="dx1-189014"></a> attribute needs setting: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor579"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-189015"></a><span +class="cmtt-10">{general}{glossdesc}{firstuc}</span> +</div> +</div> This means that I can now use <span +class="cmtt-10">\glsdesc</span><a + id="dx1-189016"></a> instead of <span +class="cmtt-10">\glslink</span><a + id="dx1-189017"></a>. +<!--l. 15605--><p class="indent" > It’s a bit cumbersome typing <span +class="cmtt-10">[format=hyperbf,counter=page] </span>for each primary reference, but +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> provides a convenient way of having a third modifier for commands like <span +class="cmtt-10">\gls </span>and <span +class="cmtt-10">\glstext</span>. This +needs to be a single punctuation character (but not <span +class="cmtt-10">* </span>or <span +class="cmtt-10">+ </span>which are already in use). For example: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor580"><span +class="cmtt-10">\GlsXtrSetAltModifier</span></span><a + id="dx1-189018"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">!</span></strong><span +class="cmtt-10">}{format=hyperbf,counter=page}</span> + + +</div> +</div> Now <span +class="cmtt-10">\glsdesc</span><a + id="dx1-189019"></a><strong><span +class="cmtt-10">!</span></strong><span +class="cmtt-10">{Gamma} </span>is equivalent to: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsdesc</span><a + id="dx1-189020"></a><span +class="cmtt-10">[format=hyperbf,counter=page]{Gamma}</span> +</div> +</div> So the text at the start of the “Gamma Functions” chapter is now just: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">The</span><span +class="cmtt-10"> \glsdesc</span><a + id="dx1-189021"></a><span +class="cmtt-10">!{Gamma}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> defined</span><span +class="cmtt-10"> as</span> +</div> +</div> which is much more compact. Similar changes can be made for the other instance of <span +class="cmtt-10">\glslink</span><a + id="dx1-189022"></a> where the <a +href="#glo:linktext">link +text<a + id="dx1-189023"></a></a> is just the description: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">The</span><span +class="cmtt-10"> \glsdesc</span><a + id="dx1-189024"></a><span +class="cmtt-10">!{erf}</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> defined</span><span +class="cmtt-10"> as</span> +</div> +</div> +<!--l. 15630--><p class="indent" > There are three other instances of <span +class="cmtt-10">\glslink</span><a + id="dx1-189025"></a>, such as: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glslink</span><a + id="dx1-189026"></a><span +class="cmtt-10">{Gamma}{\Gamma(x+1)}</span> +</div> +</div> If I just use <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{Gamma}</span></span></span> then I would get Γ(<span +class="cmmi-10">z</span>) as the <a +href="#glo:linktext">link text<a + id="dx1-189027"></a></a>. For entries like this that represent functions +with variable parameters it would be more convenient (and help with consistency) if a command was available +to easily replace the parameters. +<!--l. 15640--><p class="indent" > With the base <span +class="cmss-10">glossaries </span>package, one simple solution that works for this example is to save just the function +symbol in the <span +class="cmtt-10">symbol</span><a + id="dx1-189028"></a> field, for example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-189029"></a><span +class="cmtt-10">{Gamma}{name=\ensuremath{\Gamma(z)},</span> +<br /><strong><span +class="cmtt-10">symbol={\ensuremath{\Gamma}},</span></strong> +<br /><span +class="cmtt-10">description=gamma</span><span +class="cmtt-10"> function,sort=Gamma}</span> +</div> +</div> and then use: <div class="alltt"> +<div class="obeylines-v"> +<strong><span +class="cmtt-10">\glssymbol</span><a + id="dx1-189030"></a></strong><span +class="cmtt-10">{Gamma}</span><strong><span +class="cmtt-10">[</span></strong><span +class="cmtt-10">(\Gamma(x+1))</span><strong><span +class="cmtt-10">]</span></strong> +</div> +</div> (which includes the function parameter inside the <a +href="#glo:linktext">link text<a + id="dx1-189031"></a></a>) or just: <div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\glssymbol</span><a + id="dx1-189032"></a><span +class="cmtt-10">{Gamma}(\Gamma(x+1))</span> +</div> +</div> (which has the function parameter after the <a +href="#glo:linktext">link text<a + id="dx1-189033"></a></a>). This is a convenient approach where the extra material +can simply follow the symbol, and it can also be used with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. +<!--l. 15660--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides another possibility. It requires a command that takes a single +argument, for example: + + +</p> + <div class="verbatim" id="verbatim-420"> +\newcommand{\Gammafunction}[1]{\Gamma(#1)} +</div> +<!--l. 15664--><p class="nopar" > The control sequence name (the command name without the leading backslash) is stored in the field identified +by the command <span id="textcolor581"><span +class="cmtt-10">\GlsXtrFmtField</span></span><a + id="dx1-189034"></a> (this should be the internal field name not the key name, see <a +href="#tab:fieldmap">table 4.1</a>). +The default is <span +class="cmtt-10">useri</span><a + id="dx1-189035"></a> which corresponds to the <span +class="cmtt-10">user1</span><a + id="dx1-189036"></a> key. This means that the <span +class="cmtt-10">Gamma </span>entry would need to be +defined with <span +class="cmtt-10">user1=Gammafunction</span>. With this approach, each function entry would need a separate associated +command. +</p><!--l. 15673--><p class="indent" > Another approach is to store the parameterless function in the <span +class="cmtt-10">symbol</span><a + id="dx1-189037"></a> key (as earlier) and have a more +generic command that uses this symbol. This requires the entry label, which can be obtained with <span +class="cmtt-10">\glslabel</span> +within the <a +href="#glo:linktext">link text<a + id="dx1-189038"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{\entryfunc}[1]{\glsentrysymbol</span><a + id="dx1-189039"></a><span +class="cmtt-10">{\glslabel</span><a + id="dx1-189040"></a><span +class="cmtt-10">}(#1)}</span> +</div> +</div> (Obviously, this command can’t be used outside of the <a +href="#glo:linktext">link text<a + id="dx1-189041"></a></a> or post-link hooks since it uses +<span +class="cmtt-10">\glslabel</span><a + id="dx1-189042"></a>.) +<!--l. 15683--><p class="indent" > So the entry now needs the parameterless function in <span +class="cmtt-10">symbol</span><a + id="dx1-189043"></a> and the control sequence name of this generic +command in <span +class="cmtt-10">user1</span><a + id="dx1-189044"></a>. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-189045"></a><span +class="cmtt-10">{Gamma}{name=\ensuremath{\Gamma(z)},</span> +<br /><strong><span +class="cmtt-10">symbol={\ensuremath{\Gamma}},user1=entryfunc,</span></strong> +<br /><span +class="cmtt-10">description=gamma</span><span +class="cmtt-10"> function,sort=Gamma}</span> +</div> +</div> (This doesn’t need to be done for the <span +class="cmtt-10">C </span>and <span +class="cmtt-10">G </span>entries since they’re constants not functions.) +<!--l. 15694--><p class="indent" > You may want to consider providing helper commands to make the functions easier to define. For +example: + + +</p> + <div class="verbatim" id="verbatim-421"> +\newcommand{\func}[2]{#1(#2)} + <br />\newcommand{\entryfunc}[1]{\func{\glsentrysymbol{\glslabel}}{#1}} + <br />\newcommand{\newfunc}[5][]{% + <br /> \newglossaryentry{#2}{name={\ensuremath{\func{#3}{#4}}}, + <br />   symbol={#3}, + <br />   user1={entryfunc}, + <br />   description={#5}, + <br />   sort={#2},#1 + <br /> }% + <br />} +</div> +<!--l. 15707--><p class="nopar" > The entries can now be defined using this custom <span +class="cmtt-10">\newfunc </span>command. For example: + + +</p> + <div class="verbatim" id="verbatim-422"> +\newfunc{Gamma}{\Gamma}{z}{gamma function} + <br />\newfunc[sort=gamma1]{gamma}{\gamma}{\alpha,x}{lower + <br />  incomplete gamma function} + <br />\newfunc[sort=Gamma2]{iGamma}{\Gamma}{\alpha,x}{upper + <br />  incomplete gamma function} +</div> +<!--l. 15716--><p class="nopar" > +</p><!--l. 15718--><p class="indent" > Note that in <span +class="cmtt-10">\newfunc </span>the <span +class="cmtt-10">symbol</span><a + id="dx1-189046"></a> key doesn’t have its value encapsulated with <span +class="cmtt-10">\ensuremath</span><a + id="dx1-189047"></a> so <span +class="cmtt-10">\glssymbol</span> +will need to explicitly be placed in math mode. If you switch to a glossary style that displays the symbol, you +will either need to adjust the definition of <span +class="cmtt-10">\newfunc </span>to use <span +class="cmtt-10">\ensuremath</span><a + id="dx1-189048"></a> in the <span +class="cmtt-10">symbol</span><a + id="dx1-189049"></a> field or you can add the +encapsulation with the <span id="textcolor582"><span +class="cmss-10">glosssymbolfont</span></span><a + id="dx1-189050"></a> attribute. +</p><!--l. 15726--><p class="indent" > Now <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslink{Znu}{Z_\nu}</span></span></span> can simply be replaced with <span +class="cmtt-10">\glssymbol</span><a + id="dx1-189051"></a><span +class="cmtt-10">{Znu} </span>(no parameter is required in +this case). For the other cases, where the parameter is different from that given in the <span +class="cmtt-10">text</span><a + id="dx1-189052"></a> field (which is +obtained from the <span +class="cmtt-10">name</span><a + id="dx1-189053"></a>), you can use <span id="textcolor583"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189054"></a>. For example, <span +class="cmtt-10">\glslink{Gamma}{\Gamma(x+1)} </span>can now be +replaced with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor584"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189055"></a><span +class="cmtt-10">{Gamma}{x+1}</span> +</div> +</div> This effectively works like <span +class="cmtt-10">\glslink </span>but omits the post-link hook. (See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for +further details.) +<!--l. 15738--><p class="indent" > <div class="important" title="Important Note"> Don’t use <span id="textcolor585"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189056"></a> within the argument of another <span id="textcolor586"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189057"></a> command (or inside any other <a +href="#glo:linktext">link +text<a + id="dx1-189058"></a></a>). </div> +</p><!--l. 15741--><p class="noindent" > +</p><!--l. 15743--><p class="indent" > Similarly <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslink{Gamma}{\Gamma(\alpha)}</span></span></span> can now be replaced with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor587"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189059"></a><span +class="cmtt-10">{Gamma}{\alpha}</span> +</div> +</div> Note that it’s still possible to use: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glssymbol</span><a + id="dx1-189060"></a><span +class="cmtt-10">{Gamma}[(\alpha)]</span> +</div> +</div> You may prefer to define a helper command that makes it easier to switch between your preferred method. For +example: + + + <div class="verbatim" id="verbatim-423"> +\newcommand*{\Fn}[3][]{\glssymbol[#1]{#2}[(#3)]} +</div> +<!--l. 15756--><p class="nopar" > or: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{\Fn}[3][]{</span><span id="textcolor588"><span +class="cmtt-10">\glsxtrfmt</span></span><a + id="dx1-189061"></a><span +class="cmtt-10">[#1]{#2}{#3}}</span> +</div> +</div> +<!--l. 15762--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-189062"></a></a></span>If you want to convert this example so that it works with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-189063"></a></a>, first convert it to use +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (as described above), and then follow the instructions from <a +href="#ex:sampleEq"><span +class="cmtt-10">sampleEq.tex</span></a>. The +<a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-189064"></a></a> application recognises <span +class="cmtt-10">\newcommand </span>so it will be able to parse the custom <span +class="cmtt-10">\newfunc</span> +commands. +</p><!--l. 15769--><p class="indent" > Note that <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-189065"></a></a> allows you to separate the locations in the <a +href="#glo:numberlist">number list<a + id="dx1-189066"></a></a> into different groups according to +the counter used for the location. This can be done with the <span id="textcolor589"><span +class="cmtt-10">loc-counters</span></span><a + id="dx1-189067"></a> resource option. It’s also possible to +identify primary formats (such as <span +class="cmtt-10">hyperbf</span><a + id="dx1-189068"></a> used in this example) using the <span id="textcolor590"><span +class="cmtt-10">primary-location-formats</span></span><a + id="dx1-189069"></a> option. +The primary locations can then be given a more prominent position in the <a +href="#glo:numberlist">number list<a + id="dx1-189070"></a></a>. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-189071"></a></a> user +manual for further details. +<a + id="x1-189072r14"></a> +</p><!--l. 15779--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleSec"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleSec">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleSec.tex" ><span +class="cmtt-10">sampleSec.tex</span></a></h4> +<!--l. 15779--><p class="noindent" >This document also illustrates how to change the location to something other than the page number. In this +case, the <span +class="cmtt-10">section </span>counter is used. This example adds the glossary to the table of contents, so an extra +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: +</p><!--l. 15784--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSec + <br />makeglossaries sampleSec + <br />pdflatex sampleSec + <br />pdflatex sampleSec + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note that there are conflicting location formats, which trigger a warning from <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-190001"></a></a>: + + +</p> + <div class="verbatim" id="verbatim-424"> +## Warning (input = sampleSec.glo, line = 6; output = + <br />sampleSec.gls, line = 9): + <br />   -- Conflicting entries: multiple encaps for the same page + <br />under same key. + <br />## Warning (input = sampleSec.glo, line = 2; output = + <br />sampleSec.gls, line = 10): + <br />   -- Conflicting entries: multiple encaps for the same page + <br />under same key. +</div> +<!--l. 15802--><p class="nopar" > This is the result of indexing an entry multiple times for the same +location<span class="footnote-mark"><a +href="#fn1x19" id="fn1x19-bk"><sup class="textsuperscript">19.1</sup></a></span><a + id="x1-190002f1"></a> +with different values of the <span +class="cmtt-10">format</span><a + id="dx1-190004"></a> key. In this case, it’s caused by three references to the <span +class="cmtt-10">ident </span>entry in +section 2.1: + + +</p> + <div class="verbatim" id="verbatim-425"> +\gls[format=hyperit]{ident} + <br />\glspl{ident} % default format=glsnumberformat + <br />\gls*[format=hyperbf]{ident} +</div> +<!--l. 15811--><p class="nopar" > +</p><!--l. 15813--><p class="indent" > If you use the <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-190005"></a></a> Perl script it will detect the warnings in the <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-190006"></a></a> transcript file and +attempt to fix the conflict by removing entries from the <span +class="cmtt-10">glo</span><a + id="dx1-190007"></a> file: + + +</p> + <div class="verbatim" id="verbatim-426"> +Multiple encaps detected. Attempting to remedy. + <br />Reading sampleSec.glo... + <br />Writing sampleSec.glo... + <br />Retrying +</div> +<!--l. 15821--><p class="nopar" > (Range formats have highest precedence. The default <span +class="cmtt-10">glsnumberformat</span><a + id="dx1-190008"></a> has the lowest precedence.) +</p><!--l. 15825--><p class="indent" > If you use <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-190009"></a></a> or call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-190010"></a></a> directly then the problem won’t be fixed and the +glossary will end up with the rather odd <a +href="#glo:numberlist">number list<a + id="dx1-190011"></a></a> for the identity matrix entry consisting of three references +to section 2.1: the first in the default font, followed by bold (<span +class="cmtt-10">hyperbf</span><a + id="dx1-190012"></a>) and then italic (<span +class="cmtt-10">hyperit</span><a + id="dx1-190013"></a>), +which results in 2.1, <span +class="cmbx-10">2.1</span>, <span +class="cmti-10">2.1</span>. If you use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-190014"></a></a> then only the bold entry (<span +class="cmbx-10">2.1</span>) will be +present. +</p><!--l. 15834--><p class="indent" > If you switch to <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-190015"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span +class="cmtt-10">xindy</span></strong><span +class="cmtt-10">,style=altlist,toc,counter=section]{glossaries}</span> +</div> +</div> then the conflict will be resolved using the number format attribute list order of priority. In this case, +<span +class="cmtt-10">glsnumberformat</span><a + id="dx1-190016"></a> has the highest priority. This means that only the upright medium weight entry (2.1) will be +present. The simplest way of altering this is to provide your own custom format. For example: +<div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{</span><strong><span +class="cmtt-10">\primary</span></strong><span +class="cmtt-10">}[1]{\hyperit</span><a + id="dx1-190017"></a><span +class="cmtt-10">{#1}}</span> +<br /><span +class="cmtt-10">\GlsAddXdyAttribute</span><a + id="dx1-190018"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">primary</span></strong><span +class="cmtt-10">}</span> +</div> +</div> and change <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls[format=hyperit]</span></span></span> to <span +class="cmtt-10">\gls[format=</span><strong><span +class="cmtt-10">primary</span></strong><span +class="cmtt-10">] </span>etc. This will give <span +class="cmtt-10">format</span><a + id="dx1-190019"></a><span +class="cmtt-10">=primary</span><a + id="dx1-190020"></a> the highest +priority. (It’s also better practice to provide this kind of semantic command.) +<!--l. 15851--><p class="indent" > With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190021"></a></a>, you can supply rules to deal with location format conflicts, as illustrated below. +</p><!--l. 15854--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190022"></a></a></span>In order to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190023"></a></a>, first replace <span +class="cmss-10">glossaries </span>with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, and add the <span id="textcolor591"><span +class="cmss-10">record</span></span><a + id="dx1-190024"></a> +package option. Remember that <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> has a different set of defaults and you may also want to patch +the predefined base styles. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=altlist,</span><strong><span id="textcolor592"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor593"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">,counter=section]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 15865--><p class="indent" > The entry definitions now need to be converted into <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190025"></a></a> format and saved in a <span +class="cmtt-10">bib</span><a + id="dx1-190026"></a> file (say, +<span +class="cmtt-10">entries.bib</span>). You can use <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-190027"></a></a>: + + +</p><!--l. 15868--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sampleSec.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 15872--><p class="indent" > Next replace <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-190028"></a> with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor594"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-190029"></a><span +class="cmtt-10">[src=entries]</span> +</div> +</div> and remove all the <span +class="cmtt-10">\newglossaryentry </span>commands. +<!--l. 15878--><p class="indent" > Finally, replace <span +class="cmtt-10">\printglossaries</span><a + id="dx1-190030"></a> with <span id="textcolor595"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-190031"></a>. The document build is now: +</p><!--l. 15880--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSec + <br />bib2gls sampleSec + <br />pdflatex sampleSec + <br /></pre><spacer type=vertical size=10> + <br /></span> +As with the original example, there’s still a location format conflict, which <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190032"></a></a> warns about: + + +</p> + <div class="verbatim" id="verbatim-427"> +Warning: Entry location conflict for formats: hyperbf and hyperit + <br />Discarding: {ident}{}{section}{hyperbf}{2.1} + <br />Conflicts with: {ident}{}{section}{hyperit}{2.1} +</div> +<!--l. 15891--><p class="nopar" > This means that it has discarded the bold location and kept the italic one. (As with <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-190033"></a></a>, range +formats have the highest priority and <span +class="cmtt-10">glsnumberformat</span><a + id="dx1-190034"></a> has the lowest.) +</p><!--l. 15896--><p class="indent" > It would be better if the conflict could be merged into a single location that was both bold and italic. To +achieve this, it’s first necessary to define a command that produces this effect: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{\hyperbfit</span><a + id="dx1-190035"></a><span +class="cmtt-10">}[1]{\textbf{\hyperit{#1}}}</span> +</div> +</div> Now <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-190036"></a></a> needs to be invoked with the appropriate mapping with the <span id="textcolor596"><span +class="cmtt-10">--map-format</span></span><a + id="dx1-190037"></a> or <span id="textcolor597"><span +class="cmtt-10">-m</span></span><a + id="dx1-190038"></a> +switch: +<!--l. 15904--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />bib2gls -m ”hyperbf:hyperbfit,hyperit:hyperbfit” sampleSec + <br /></pre><spacer type=vertical size=10> + <br /></span> +If you are using <span +class="cmtt-10">arara</span><a + id="dx1-190039"></a> the directive should be: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> bib2gls:</span><span +class="cmtt-10"> {</span><span +class="cmtt-10"> mapformats:</span><span +class="cmtt-10"> [</span><span +class="cmtt-10"> [hyperbf,</span><span +class="cmtt-10"> hyperbfit],</span> +<br /><span +class="cmtt-10">%</span><span +class="cmtt-10"> arara:</span><span +class="cmtt-10"> --></span><span +class="cmtt-10"> [hyperit,</span><span +class="cmtt-10"> hyperbfit]</span><span +class="cmtt-10"> ]</span><span +class="cmtt-10"> }</span> +</div> +</div> +<!--l. 15913--><p class="indent" > If you try out this example, notice the difference between <span id="textcolor598"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">only</span></span><a + id="dx1-190040"></a> and <span id="textcolor599"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-190041"></a>. If you use the +latter, the locations will now be the section titles rather than the section numbers. If you use the <span +class="cmss-10">nameref </span>setting +you can customize the location by defining the command: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor600"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">counter</span>⟩<span +class="cmtt-10">locfmt</span></span><a + id="dx1-190042"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">location</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">title</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 15922--><p class="indent" > In this case the counter is <span +class="cmss-10">section</span>, so the command should be <span id="textcolor601"><span +class="cmtt-10">\glsxtrsectionlocfmt</span></span><a + id="dx1-190043"></a>. It takes two +arguments: the first is the location and the second is the title. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{</span><span id="textcolor602"><span +class="cmtt-10">\glsxtrsectionlocfmt</span></span><a + id="dx1-190044"></a><span +class="cmtt-10">}[2]{\S</span><a + id="dx1-190045"></a><span +class="cmtt-10">#1</span><span +class="cmtt-10"> #2}</span> + + +</div> +</div> (The only command of this type that is defined by default is the one for the <span +class="cmss-10">equation </span>counter, +<span id="textcolor603"><span +class="cmtt-10">\glsxtrequationlocfmt</span></span><a + id="dx1-190046"></a>.) Make sure that you have at least version 1.42 of <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. +<!--l. 15932--><p class="noindent" > +</p> +<!--l. 15932--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.4 </span> <a + id="sec:samplestype"></a>Multiple Glossaries</h3> +<!--l. 15935--><p class="noindent" >See also <a +href="#ex:sampleSort"><span +class="cmtt-10">sampleSort.tex</span></a> in <a +href="#sec:samplessort">§19.5 </a><a +href="#sec:samplessort">Sorting<!--tex4ht:ref: sec:samplessort --></a>, which has three glossaries. +<a + id="x1-191001r15"></a> +</p><!--l. 15938--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleNtn"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleNtn">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleNtn.tex" ><span +class="cmtt-10">sampleNtn.tex</span></a></h4> +<!--l. 15938--><p class="noindent" >This document illustrates how to create an additional glossary type. This example adds the glossary to the table +of contents, so an extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: +</p><!--l. 15942--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleNtn + <br />makeglossaries sampleNtn + <br />pdflatex sampleNtn + <br />pdflatex sampleNtn + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note that if you want to call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-192001"></a></a> explicitly instead of using the <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-192002"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-192003"></a></a> +scripts then you need to call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-192004"></a></a> twice: + </p><ol class="enumerate1" > + <li + class="enumerate" id="x1-192006x1">Create the main glossary (all on one line): + <!--l. 15953--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + </p></li> + <li + class="enumerate" id="x1-192008x2">Create the secondary glossary (all on one line): + <!--l. 15957--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn + <br /></pre><spacer type=vertical size=10> + <br /></span> + </p></li></ol> +<!--l. 15961--><p class="noindent" >This document creates a new glossary using: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossary</span><a + id="dx1-192009"></a><span +class="cmtt-10">[nlg]{notation}{not}{ntn}{Notation}</span> +</div> +</div> This defines a glossary that can be identified with the label <span +class="cmtt-10">notation </span>with the default title “Notation”. The +other arguments are the file extensions required with Options <a +href="#option2">2</a> and <a +href="#option3">3</a>. For those two options, the <span +class="cmss-10">glossaries</span> +package needs to know the input and output files required by <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-192010"></a></a> or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-192011"></a></a>. +<!--l. 15971--><p class="indent" > (The optional argument is the file extension of the indexing transcript file, which <span +class="cmss-10">glossaries </span>doesn’t need to +know about, but it writes the information to the <span +class="cmtt-10">aux</span><a + id="dx1-192012"></a> file for the benefit of <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-192013"></a></a> and +<a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-192014"></a></a>.) +</p><!--l. 15976--><p class="indent" > If you switch to a different indexing option then these file extensions aren’t required, in which case it’s +simpler to use the starred form: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossary*</span><a + id="dx1-192015"></a><span +class="cmtt-10">{notation}{Notation}</span> +</div> +</div> +<!--l. 15982--><p class="indent" > This example uses a label prefixing system<span class="footnote-mark"><a +href="#fn2x19" id="fn2x19-bk"><sup class="textsuperscript">19.2</sup></a></span><a + id="x1-192016f2"></a> to +differentiate between the different types of entries. For example, the term “set” is defined as: + + +</p> + <div class="verbatim" id="verbatim-428"> +\newglossaryentry{gls:set}{name=set, + <br />description={A collection of distinct objects}} +</div> +<!--l. 15990--><p class="nopar" > and the set notation is defined as: + + +</p> + <div class="verbatim" id="verbatim-429"> +\newglossaryentry{not:set}{type=notation, + <br />name={\ensuremath{\mathcal{S}}}, + <br />description={A \gls{gls:set}},sort={S}} +</div> +<!--l. 15996--><p class="nopar" > Notice that the latter description contains <span +class="cmtt-10">\gls</span>. This means you shouldn’t use <span +class="cmtt-10">\glsdesc</span><a + id="dx1-192018"></a> with this entry +otherwise you will end up with nested links. +</p><!--l. 16001--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a command for use in within field values to prevent +nested <a +href="#glo:linktext">link text<a + id="dx1-192019"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor604"><span +class="cmtt-10">\glsxtrp</span></span><a + id="dx1-192020"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> There are convenient shortcuts for common fields: <span id="textcolor605"><span +class="cmtt-10">\glsps</span></span><a + id="dx1-192021"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">} </span>(for the <span +class="cmtt-10">short</span><a + id="dx1-192022"></a> field) and <span id="textcolor606"><span +class="cmtt-10">\glspt</span></span><a + id="dx1-192023"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}</span> +(for the <span +class="cmtt-10">text</span><a + id="dx1-192024"></a> field). So the set notation definition can be modified: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{not:set}{type=notation,</span> +<br /><span +class="cmtt-10">name={\ensuremath{\mathcal{S}}},</span> +<br /><span +class="cmtt-10">description={A</span><span +class="cmtt-10"> </span><strong><span id="textcolor607"><span +class="cmtt-10">\glspt</span></span><a + id="dx1-192025"></a><span +class="cmtt-10">{gls:set}</span></strong><span +class="cmtt-10">},sort=S}</span> +</div> +</div> This will stop the inner reference from causing interference if you use <span +class="cmtt-10">\glsdesc</span><a + id="dx1-192026"></a>. It will also suppress indexing +within the glossary but will have a hyperlink (if <span +class="cmss-10">hyperref </span>is used). +<!--l. 16020--><p class="indent" > The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a way of defining commands like <span +class="cmtt-10">\gls </span>that automatically insert a +prefix. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor608"><span +class="cmtt-10">\glsxtrnewgls</span></span><a + id="dx1-192027"></a><span +class="cmtt-10">{not:}{\sym}</span> +<br /><span id="textcolor609"><span +class="cmtt-10">\glsxtrnewglslike</span></span><a + id="dx1-192028"></a><span +class="cmtt-10">{gls:}{\term}{\termpl}{\Term}{\Termpl}</span> +</div> +</div> (there’s no point providing commands for plural or case-changing with symbols). Now <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{not:set}</span></span></span> can be +replaced with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\sym{set}</span></span></span> and <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{gls:set}</span></span></span> can be replaced with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\term{set}</span></span></span>. +<!--l. 16031--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192029"></a></a></span>These two commands are primarily provided for the benefit of <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192030"></a></a> as the information is written +to the <span +class="cmtt-10">aux</span><a + id="dx1-192031"></a> file. This allows <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192032"></a></a> to recognise the custom commands if they have been used in the <span +class="cmtt-10">bib</span><a + id="dx1-192033"></a> files. +When combined with <span id="textcolor610"><span +class="cmtt-10">label-prefix</span></span><a + id="dx1-192034"></a> and <span id="textcolor611"><span +class="cmtt-10">ext-prefixes</span></span><a + id="dx1-192035"></a> (see below) this makes it much simpler to change the +prefixes if necessary. +</p><!--l. 16040--><p class="indent" > If you want to convert this document to use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192036"></a></a>, remember that you need the <span id="textcolor612"><span +class="cmss-10">record</span></span><a + id="dx1-192037"></a> or <span id="textcolor613"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-192038"></a> +option. For example: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor614"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span></strong><span id="textcolor615"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor616"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> As with earlier examples, <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-192039"></a></a> can be used to convert the entry definitions into +the required <span +class="cmtt-10">bib</span><a + id="dx1-192040"></a> format. You may prefer to split the entries into separate files according to +type.<span class="footnote-mark"><a +href="#fn3x19" id="fn3x19-bk"><sup class="textsuperscript">19.3</sup></a></span><a + id="x1-192041f3"></a> +This is useful if you want to reuse a large database of entries across multiple documents as it doesn’t lock you +into using a specific glossary. For example: +<!--l. 16053--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --split-on-type --preamble-only sampleNtn.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This will create a file called <span +class="cmtt-10">entries.bib </span>that contains the entries that didn’t have a <span +class="cmtt-10">type</span><a + id="dx1-192043"></a> assigned in the +original file, such as: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor617"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192044"></a><span +class="cmtt-10">{gls:set,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {set},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> distinct</span><span +class="cmtt-10"> objects}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> It will also create a file called <span +class="cmtt-10">notation.bib </span>that contains the entries that had the <span +class="cmtt-10">type</span><a + id="dx1-192045"></a> set to <span +class="cmtt-10">notation </span>in the +original file, such as: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor618"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192046"></a><span +class="cmtt-10">{not:set,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\mathcal{S}}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> </span><span id="textcolor619"><span +class="cmtt-10">\glspt</span></span><a + id="dx1-192047"></a><span +class="cmtt-10">{gls:set}}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Note that the <span +class="cmtt-10">type</span><a + id="dx1-192048"></a> field has been removed. The above entry in the <span +class="cmtt-10">notation.bib </span>file references a term in +the <span +class="cmtt-10">entries.bib </span>file. It’s possible to strip all the prefixes from the <span +class="cmtt-10">bib</span><a + id="dx1-192049"></a> files and get <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192050"></a></a> to +automatically insert them. In which case, this cross-reference needs adjusting to indicate that it’s +referring to an entry in another file. This can be done with one of the special <span id="textcolor620"><span +class="cmtt-10">ext</span>⟨<span +class="cmitt-10">n</span>⟩<span +class="cmtt-10">.</span></span> prefixes: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor621"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192051"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">set</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\mathcal{S}}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> </span><span id="textcolor622"><span +class="cmtt-10">\glspt</span></span><a + id="dx1-192052"></a><span +class="cmtt-10">{</span><strong><span id="textcolor623"><span +class="cmtt-10">ext1.</span></span></strong><span +class="cmtt-10">set}}</span> +<br /><span +class="cmtt-10">}</span> + + +</div> +</div> The corresponding term in the <span +class="cmtt-10">entries.bib </span>file is now: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor624"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192053"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">set</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {set},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> distinct</span><span +class="cmtt-10"> objects}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 16096--><p class="indent" > Now you can replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor625"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-192054"></a><span +class="cmtt-10">[</span><span id="textcolor626"><span +class="cmtt-10">src</span></span><a + id="dx1-192055"></a><span +class="cmtt-10">={entries},</span><strong><span id="textcolor627"><span +class="cmtt-10">label-prefix</span></span><span +class="cmtt-10">={gls:}</span></strong><span +class="cmtt-10">]</span> +<br /><span id="textcolor628"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-192056"></a><span +class="cmtt-10">[</span><span id="textcolor629"><span +class="cmtt-10">src</span></span><a + id="dx1-192057"></a><span +class="cmtt-10">={notation},</span><span id="textcolor630"><span +class="cmtt-10">type</span></span><a + id="dx1-192058"></a><span +class="cmtt-10">=notation,</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor631"><span +class="cmtt-10">label-prefix</span></span><span +class="cmtt-10">={not:},</span><span id="textcolor632"><span +class="cmtt-10">ext-prefixes</span></span><span +class="cmtt-10">={gls:}</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Remove all the <span +class="cmtt-10">\newglossaryentry </span>definitions and replace <span +class="cmtt-10">\printglossaries </span>with <span id="textcolor633"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-192059"></a>. +<!--l. 16105--><p class="indent" > Regardless of how many resource sets the document contains, only one <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192060"></a></a> call is required: +</p><!--l. 16107--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleNtn + <br />bib2gls sampleNtn + <br />pdflatex sampleNtn + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 16113--><p class="indent" > You may notice that the ordering in the notations list has changed from the original. This is because the +<span +class="cmtt-10">sort</span><a + id="dx1-192061"></a> field was automatically removed by <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-192062"></a></a>, so the entries are now sorted according to the <span +class="cmtt-10">name</span><a + id="dx1-192063"></a> +field (since they are defined with <span id="textcolor634"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192064"></a>). You can use your text editor’s search and replace function to replace +all instances of <span id="textcolor635"><span +class="cmtt-10">@entry</span></span><a + id="dx1-192065"></a> with <span id="textcolor636"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-192066"></a> in the <span +class="cmtt-10">notations.bib </span>file so that, for example, the <span +class="cmtt-10">set </span>definition +becomes: </p><div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor637"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-192067"></a></strong><span +class="cmtt-10">{set,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\mathcal{S}}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> </span><span id="textcolor638"><span +class="cmtt-10">\glspt</span></span><a + id="dx1-192068"></a><span +class="cmtt-10">{</span><span id="textcolor639"><span +class="cmtt-10">ext1.</span></span><span +class="cmtt-10">set}}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Now these <span id="textcolor640"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-192069"></a> entries will be sorted according to their label. (The original label in the <span +class="cmtt-10">bib</span><a + id="dx1-192070"></a> file, not the +prefixed label.) This will put them in the same order as the original document. (See the “Examples” +chapter of the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-192071"></a></a> user manual for examples of varying the sorting and also <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: +sorting</a>.) +<a + id="x1-192072r16"></a> + + +<!--l. 16134--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-dual"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-dual">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-dual.tex" ><span +class="cmtt-10">sample-dual.tex</span></a></h4> +<!--l. 16134--><p class="noindent" >This document illustrates how to define an entry that both appears in the list of acronyms and in the main +glossary. To create the document do: +</p><!--l. 16137--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-dual + <br />makeglossaries sample-dual + <br />pdflatex sample-dual + <br /></pre><spacer type=vertical size=10> + <br /></span> +This defines a custom command <span +class="cmtt-10">\newdualentry</span><a + id="dx1-193001"></a> that defines two entries at once (a normal entry and +an abbreviation). It uses <span +class="cmtt-10">\glsadd</span><a + id="dx1-193002"></a> to ensure that if one is used then the other is automatically +indexed: + + +</p> + <div class="verbatim" id="verbatim-430"> +\newcommand*{\newdualentry}[5][]{% + <br />  % main entry: + <br />  \newglossaryentry{main-#2}{name={#4},% + <br />  text={#3\glsadd{#2}},% + <br />  description={#5},% + <br />  #1% additional options for main entry + <br />  }% + <br />  % abbreviation: + <br />  \newacronym{#2}{#3\glsadd{main-#2}}{#4}% + <br />} +</div> +<!--l. 16156--><p class="nopar" > A sample dual entry is defined with this command: + + +</p> + <div class="verbatim" id="verbatim-431"> +\newdualentry{svm}% label + <br />  {SVM}% abbreviation + <br />  {support vector machine}% long form + <br />  {Statistical pattern recognition technique}% description +</div> +<!--l. 16163--><p class="nopar" > This defines an acronym with the label <span +class="cmtt-10">svm </span>that can be referenced with <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{svm}</span></span></span> but it also defines an entry +with the label <span +class="cmtt-10">main-svm</span>. This isn’t used in the document with <span +class="cmtt-10">\gls </span>but it’s automatically added from the +<span +class="cmtt-10">\glsadd{main-svm} </span>in the short form of <span +class="cmtt-10">svm</span>. +</p><!--l. 16171--><p class="indent" > For this trivial document, this kind of dual entry is redundant and unnecessarily leads the +reader down a trail, first to the list of acronyms and from there the reader then has to go to the +main glossary to look up the description. It’s better to simply include the description in the list of +acronyms. +</p><!--l. 16177--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193003"></a></a></span>If you want to switch over to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193004"></a></a>, first change to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor641"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor642"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor643"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,acronym]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next, the definition needs to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-193005"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193006"></a></a>. If you do: +<!--l. 16185--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sample-dual.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +then <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-193007"></a></a> will report the following: + + +</p> + <div class="verbatim" id="verbatim-432"> +Overriding default definition of \newdualentry with custom + <br />definition. (Change \newcommand to \providecommand if you want + <br />\newdualentry[options]{label}{short}{long}{description} + <br />converted to @dualabbreviationentry.) +</div> +<!--l. 16194--><p class="nopar" > This is because <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-193008"></a></a> has its own internal definition of <span +class="cmtt-10">\newdualentry</span>, but if it encounters a +new definition that will override its default. If you want to retain <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-193009"></a>’s</a> definition +(recommended) then just replace <span +class="cmtt-10">\newcommand </span>with <span +class="cmtt-10">\providecommand </span>in the document source and rerun +<a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-193010"></a></a>. +</p><!--l. 16202--><p class="indent" > With <span +class="cmtt-10">\providecommand</span>, the new <span +class="cmtt-10">entries.bib </span>file created by <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-193011"></a></a> contains: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor644"><span +class="cmtt-10">@dualabbreviationentry</span></span><a + id="dx1-193012"></a><span +class="cmtt-10">{svm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {SVM},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span><span +class="cmtt-10"> technique},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> If <span +class="cmtt-10">\newcommand </span>is retained, it will instead contain: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor645"><span +class="cmtt-10">@entry</span></span><a + id="dx1-193013"></a><span +class="cmtt-10">{main-svm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span><span +class="cmtt-10"> technique},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {SVM\glsadd{svm}}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor646"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-193014"></a><span +class="cmtt-10">{svm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {SVM\glsadd{main-svm}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> In the first case, <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193015"></a></a> creates two linked entries using its primary-dual mechanism. In the second case, +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193016"></a></a> creates two entries that simply reference each other. +<!--l. 16228--><p class="indent" > Assuming that your <span +class="cmtt-10">entries.bib </span>file just contains <span id="textcolor647"><span +class="cmtt-10">@dualabbreviationentry</span></span><a + id="dx1-193017"></a>, now replace +<span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\GlsXtrLoadResources[</span><span id="textcolor648"><span +class="cmtt-10">src</span></span><a + id="dx1-193018"></a><span +class="cmtt-10">=entries,%</span><span +class="cmtt-10"> entries.bib</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor649"><span +class="cmtt-10">type</span></span><a + id="dx1-193019"></a><span +class="cmtt-10">=acronym,</span><span id="textcolor650"><span +class="cmtt-10">dual-type</span></span><a + id="dx1-193020"></a><span +class="cmtt-10">=main,</span><span id="textcolor651"><span +class="cmtt-10">dual-prefix</span></span><a + id="dx1-193021"></a><span +class="cmtt-10">={main-}]</span> + + +</div> +</div> +<!--l. 16236--><p class="indent" > Then remove the definition of <span +class="cmtt-10">\newdualentry </span>and the entry definition. Finally, replace <span +class="cmtt-10">\printglossaries</span> +with <span id="textcolor652"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-193022"></a>. The document build is: +</p><!--l. 16240--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-dual + <br />bib2gls sample-dual + <br />pdflatex sample-dual + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 16246--><p class="indent" > If, instead, your <span +class="cmtt-10">entries.bib </span>file contains separate <span id="textcolor653"><span +class="cmtt-10">@entry</span></span><a + id="dx1-193023"></a> and <span id="textcolor654"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-193024"></a>, then you need: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor655"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-193025"></a><span +class="cmtt-10">[acronym]{long-short}</span> +<br /><span id="textcolor656"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-193026"></a><span +class="cmtt-10">[</span><span id="textcolor657"><span +class="cmtt-10">src</span></span><a + id="dx1-193027"></a><span +class="cmtt-10">=entries]</span> +</div> +</div> If you need <a +href="#glo:numberlist">number list<a + id="dx1-193028"></a>s</a>, the document build is now +<!--l. 16253--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-dual + <br />bib2gls sample-dual + <br />pdflatex sample-dual + <br />bib2gls sample-dual + <br />pdflatex sample-dual + <br /></pre><spacer type=vertical size=10> + <br /></span> +and this time <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193029"></a></a> complains about the use of <span +class="cmtt-10">\glsadd</span><a + id="dx1-193030"></a> within the <span +class="cmtt-10">short</span><a + id="dx1-193031"></a> and <span +class="cmtt-10">text</span><a + id="dx1-193032"></a> fields as +this can be problematic. (The extra <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193033"></a></a> and <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> calls are to ensure the <a +href="#glo:numberlist">number list<a + id="dx1-193034"></a></a> is +up to date for the <span +class="cmtt-10">main-svm </span>entry, which can only be indexed with <span +class="cmtt-10">\glsadd </span>after <span +class="cmtt-10">svm </span>has been +defined.) +</p><!--l. 16267--><p class="indent" > Dual entries make much more sense when one entry is for a glossary with the description displayed but +no <a +href="#glo:numberlist">number list<a + id="dx1-193035"></a></a>, and the other is for the index without the description but with a <a +href="#glo:numberlist">number list<a + id="dx1-193036"></a></a>. +This can be created with by replacing <span id="textcolor658"><span +class="cmtt-10">@dualabbreviationentry</span></span><a + id="dx1-193037"></a> with <span id="textcolor659"><span +class="cmtt-10">@dualindexabbreviation</span></span><a + id="dx1-193038"></a>: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor660"><span +class="cmtt-10">@dualindexabbreviation</span></span><a + id="dx1-193039"></a><span +class="cmtt-10">{svm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Statistical</span><span +class="cmtt-10"> pattern</span><span +class="cmtt-10"> recognition</span><span +class="cmtt-10"> technique},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {SVM},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This can be mixed with <span id="textcolor661"><span +class="cmtt-10">@index</span></span><a + id="dx1-193040"></a> terms for example: <div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor662"><span +class="cmtt-10">@index</span></span><a + id="dx1-193041"></a><span +class="cmtt-10">{machlearn,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={machine</span><span +class="cmtt-10"> learning}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The document needs modifying: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /> +<br /><span +class="cmtt-10">\usepackage</span><a + id="dx1-193042"></a><span +class="cmtt-10">[</span><span id="textcolor663"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span><span id="textcolor664"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> nostyles,</span><span id="textcolor665"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">={</span><span id="textcolor666"><span +class="cmtt-10">bookindex</span></span><span +class="cmtt-10">,list},%</span><span +class="cmtt-10"> only</span><span +class="cmtt-10"> want</span><span +class="cmtt-10"> bookindex</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> list</span><span +class="cmtt-10"> styles</span> +<br /><span +class="cmtt-10"> acronym]{glossaries-extra}</span> +<br /> +<br /><span id="textcolor667"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-193043"></a><span +class="cmtt-10">{long-short-desc}</span> +<br /><span id="textcolor668"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-193044"></a><span +class="cmtt-10">[</span><span id="textcolor669"><span +class="cmtt-10">src</span></span><a + id="dx1-193045"></a><span +class="cmtt-10">=entries,%</span><span +class="cmtt-10"> entries.bib</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor670"><span +class="cmtt-10">dual-type</span></span><a + id="dx1-193046"></a><span +class="cmtt-10">=acronym,</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor671"><span +class="cmtt-10">label-prefix</span></span><span +class="cmtt-10">={</span><strong><span +class="cmtt-10">idx.</span></strong><span +class="cmtt-10">},</span><span id="textcolor672"><span +class="cmtt-10">dual-prefix</span></span><a + id="dx1-193047"></a><span +class="cmtt-10">={},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor673"><span +class="cmtt-10">combine-dual-locations</span></span><a + id="dx1-193048"></a><span +class="cmtt-10">={primary}]</span> +<br /> +<br /><span id="textcolor674"><span +class="cmtt-10">\glsxtrnewglslike</span></span><a + id="dx1-193049"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">idx.</span></strong><span +class="cmtt-10">}{</span><strong><span +class="cmtt-10">\idx</span></strong><span +class="cmtt-10">}{\idxpl}{\Idx}{\Idxpl}</span> +<br /> +<br /><span +class="cmtt-10">\begin{document}</span> +<br /><span +class="cmtt-10">\gls{svm}</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\idx</span></strong><span +class="cmtt-10">{machlearn}.</span> +<br /> +<br /><span id="textcolor675"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-193050"></a><span +class="cmtt-10">[type=main,style=altlist]</span> +<br /><span id="textcolor676"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-193051"></a><span +class="cmtt-10">[style=bookindex,title={Index}]</span> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-193052"></a></a> manual for further details. +<a + id="x1-193053r17"></a> +<!--l. 16310--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-langdict"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-langdict">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-langdict.tex" ><span +class="cmtt-10">sample-langdict.tex</span></a></h4> +<!--l. 16310--><p class="noindent" >This document illustrates how to use the glossaries package to create English to French and French to English +dictionaries. To create the document do: +</p><!--l. 16314--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-langdict + <br />makeglossaries sample-langdict + <br />pdflatex sample-langdict + <br /></pre><spacer type=vertical size=10> + + + <br /></span> +This example uses the <span +class="cmss-10">nomain</span><a + id="dx1-194001"></a> package option to prevent the creation of the <span +class="cmtt-10">main </span>glossary. This means that the +document must provide its own glossaries: + + +</p> + <div class="verbatim" id="verbatim-433"> +\newglossary[glg]{english}{gls}{glo}{English to French} + <br />\newglossary[flg]{french}{flx}{flo}{French to English} +</div> +<!--l. 16325--><p class="nopar" > This means that if you want to call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-194002"></a></a> explicitly you need to take these new extensions into +account: +</p><!--l. 16328--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sample-langdict.ist -t sample-langdict.glg -o sample-langdict.gls sample-langdict.glo + <br />makeindex -s sample-langdict.ist -t sample-langdict.flg -o sample-langdict.flx sample-langdict.flo + <br /></pre><spacer type=vertical size=10> + <br /></span> +As with the previous example, this document provides a custom command that defines two related +entries: + + +</p> + <div class="verbatim" id="verbatim-434"> +\newcommand*{\newword}[4]{% + <br />  \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}% + <br />  \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4}, + <br />    description={#2}}% + <br />} +</div> +<!--l. 16340--><p class="nopar" > This has the syntax: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newword{</span>⟨<span +class="cmitt-10">label</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">english</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">determiner</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">french</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> (Note that this trivial example doesn’t take plurals into account.) This custom command will +define two terms with labels <span +class="cmtt-10">en-</span>⟨<span +class="cmitt-10">label</span>⟩ (for the English term) and <span +class="cmtt-10">fr-</span>⟨<span +class="cmitt-10">label</span>⟩ (for the French term). +So + + + <div class="verbatim" id="verbatim-435"> +\newword{cat}{cat}{le}{chat} +</div> +<!--l. 16351--><p class="nopar" > is equivalent to: + + +</p> + <div class="verbatim" id="verbatim-436"> +\newglossaryentry{en-cat}{type=english,name={cat},description={le chat}} + <br />\newglossaryentry{fr-cat}{type=french,name={le chat},sort={chat}, + <br />  description={cat}} +</div> +<!--l. 16357--><p class="nopar" > +</p><!--l. 16359--><p class="indent" > Unlike the previous example (<a +href="#ex:sample-dual"><span +class="cmtt-10">sample-dual.tex</span></a>), there’s no link between these two entries. If the document +only uses <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{en-cat}</span></span></span>, then the <span +class="cmtt-10">en-cat </span>entry will appear in the <span +class="cmtt-10">english </span>glossary but the <span +class="cmtt-10">fr-cat </span>entry won’t +appear in the <span +class="cmtt-10">french </span>one. +</p><!--l. 16365--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-194003"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-194004"></a></a> then you first need to convert the document so that it +uses <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, but include the <span id="textcolor677"><span +class="cmss-10">prefix</span></span><a + id="dx1-194005"></a> option to ensure that <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-194006"></a> is also loaded: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor678"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span><span id="textcolor679"><span +class="cmtt-10">prefix</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor680"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor681"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,nomain]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> You don’t need to worry about file extensions now, so it’s simpler to use the starred form of <span +class="cmtt-10">\newglossary</span>: +<div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossary</span><strong><span +class="cmtt-10">*</span></strong><span +class="cmtt-10">{english}{English</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> French}</span> +<br /><span +class="cmtt-10">\newglossary</span><strong><span +class="cmtt-10">*</span></strong><span +class="cmtt-10">{french}{French</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> English}</span> +</div> +</div> Next the entries need to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-194007"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-194008"></a></a>: +<!--l. 16381--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --only-preamble sample-langdict.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This creates the file <span +class="cmtt-10">entries.bib </span>that contains entries defined like: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor682"><span +class="cmtt-10">@entry</span></span><a + id="dx1-194009"></a><span +class="cmtt-10">{en-cat,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {cat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {le</span><span +class="cmtt-10"> chat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> type</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {english}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor683"><span +class="cmtt-10">@entry</span></span><a + id="dx1-194010"></a><span +class="cmtt-10">{fr-cat,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {le</span><span +class="cmtt-10"> chat},</span> + + +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {cat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {chat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> type</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {french}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> (Note that the <span +class="cmtt-10">sort</span><a + id="dx1-194011"></a> field has been omitted.) +<!--l. 16402--><p class="indent" > This would be more flexible, and much briefer, if these entries were defined using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-194012"></a>’s</a> dual entry +system combined with the <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-194013"></a> package: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor684"><span +class="cmtt-10">@dualentry</span></span><a + id="dx1-194014"></a><span +class="cmtt-10">{cat,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {chat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {cat},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix</span><a + id="dx1-194015"></a><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {le},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural</span><a + id="dx1-194016"></a><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {les}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Similarly for the “chair” entry: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor685"><span +class="cmtt-10">@dualentry</span></span><a + id="dx1-194017"></a><span +class="cmtt-10">{chair,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {chaise},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {chair},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix</span><a + id="dx1-194018"></a><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {la},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural</span><a + id="dx1-194019"></a><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {les}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 16423--><p class="indent" > With <span id="textcolor686"><span +class="cmtt-10">@dualentry</span></span><a + id="dx1-194020"></a>, the English and French terms are now automatically linked from <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-194021"></a>’s</a> point of view. +If only one is referenced in the document, the other will also be added by default. +</p><!--l. 16427--><p class="indent" > Now that the determiner has been moved out of the description, it won’t show in the glossary. However, it’s +possible to include it by providing a command to encapsulate the description (which can also apply the language +change as well). +</p> + <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor687"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-194022"></a><span +class="cmtt-10">[</span><span id="textcolor688"><span +class="cmtt-10">src</span></span><a + id="dx1-194023"></a><span +class="cmtt-10">=entries,%</span><span +class="cmtt-10"> entries.bib</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor689"><span +class="cmtt-10">append-prefix-field</span></span><span +class="cmtt-10">={space},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor690"><span +class="cmtt-10">category</span></span><a + id="dx1-194024"></a><span +class="cmtt-10">={same</span><span +class="cmtt-10"> as</span><span +class="cmtt-10"> type},</span><span id="textcolor691"><span +class="cmtt-10">dual-category</span></span><a + id="dx1-194025"></a><span +class="cmtt-10">={same</span><span +class="cmtt-10"> as</span><span +class="cmtt-10"> type},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor692"><span +class="cmtt-10">label-prefix</span></span><span +class="cmtt-10">={en-},</span><span id="textcolor693"><span +class="cmtt-10">dual-prefix</span></span><a + id="dx1-194026"></a><span +class="cmtt-10">={fr-},</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor694"><span +class="cmtt-10">type</span></span><a + id="dx1-194027"></a><span +class="cmtt-10">=english,</span><span id="textcolor695"><span +class="cmtt-10">dual-type</span></span><a + id="dx1-194028"></a><span +class="cmtt-10">=french,</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor696"><span +class="cmtt-10">sort</span></span><a + id="dx1-194029"></a><span +class="cmtt-10">=en,</span><span id="textcolor697"><span +class="cmtt-10">dual-sort</span></span><a + id="dx1-194030"></a><span +class="cmtt-10">=fr]</span> + + +<br /> +<br /><span +class="cmtt-10">\newcommand{\FrEncap}[1]{%</span> +<br /><span +class="cmtt-10"> \foreignlanguage</span><a + id="dx1-194031"></a><span +class="cmtt-10">{french}{\glsentryprefix</span><a + id="dx1-194032"></a><span +class="cmtt-10">{\glscurrententrylabel</span><a + id="dx1-194033"></a><span +class="cmtt-10">}#1}}</span> +<br /><span +class="cmtt-10">\newcommand{\EnEncap}[1]{\foreignlanguage</span><a + id="dx1-194034"></a><span +class="cmtt-10">{english}{#1}}</span> +<br /> +<br /><span id="textcolor698"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-194035"></a><span +class="cmtt-10">{english}{glossnamefont}{EnEncap}</span> +<br /><span id="textcolor699"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-194036"></a><span +class="cmtt-10">{english}{glossdescfont}{FrEncap}</span> +<br /><span id="textcolor700"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-194037"></a><span +class="cmtt-10">{french}{glossnamefont}{FrEncap}</span> +<br /><span id="textcolor701"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-194038"></a><span +class="cmtt-10">{french}{glossdescfont}{EnEncap}</span> +</div> +</div> +<!--l. 16450--><p class="indent" > Remember to remove <span +class="cmtt-10">\makeglossaries</span>, the definition of <span +class="cmtt-10">\newword </span>and the entry definitions from the +document preamble, and replace <span +class="cmtt-10">\printglossary </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor702"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-194039"></a> +</div> +</div> +<!--l. 16457--><p class="indent" > Other refinements that you might like to make include using <span id="textcolor703"><span +class="cmtt-10">\glsxtrnewglslike</span></span><a + id="dx1-194040"></a> so you don’t have to worry +about the label prefix (“en-” and “fr-”). +<a + id="x1-194041r18"></a> +</p><!--l. 16461--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-index"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-index">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-index.tex" ><span +class="cmtt-10">sample-index.tex</span></a></h4> +<!--l. 16461--><p class="noindent" >This document uses the <span +class="cmss-10">glossaries </span>package to create both a glossary and an index. This requires two +<a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-195001"></a></a> (or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-195002"></a></a>) calls to ensure the document is up to date: +</p><!--l. 16466--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-index + <br />makeglossaries sample-index + <br />pdflatex sample-index + <br />makeglossaries sample-index + <br />pdflatex sample-index + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 16474--><p class="noindent" > +</p> +<!--l. 16474--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.5 </span> <a + id="sec:samplessort"></a>Sorting</h3> +<a + id="x1-196001r19"></a> + + +<!--l. 16477--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:samplePeople"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:samplePeople">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/samplePeople.tex" ><span +class="cmtt-10">samplePeople.tex</span></a></h4> +<!--l. 16477--><p class="noindent" >This document illustrates how you can hook into the standard sort mechanism to adjust the way the sort key is +set. This requires an additional run to ensure the table of contents is up-to-date: +</p><!--l. 16481--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplePeople + <br />makeglossaries samplePeople + <br />pdflatex samplePeople + <br />pdflatex samplePeople + <br /></pre><spacer type=vertical size=10> + <br /></span> +This provides two commands for typesetting a name: + + +</p> + <div class="verbatim" id="verbatim-437"> +\newcommand{\sortname}[2]{#2, #1} + <br />\newcommand{\textname}[2]{#1 #2} +</div> +<!--l. 16491--><p class="nopar" > where the first argument contains the forenames and the second is the surname. The first command is the one +required for sorting the name and the second is the one required for displaying the name in the document. A +synonym is then defined: + + +</p> + <div class="verbatim" id="verbatim-438"> +\let\name\textname +</div> +<!--l. 16498--><p class="nopar" > This command defaults to the display name command (<span +class="cmtt-10">\textname</span>) but is temporarily redefined to the sort +name command (<span +class="cmtt-10">\sortname</span>) within the <span +class="cmtt-10">sort</span><a + id="dx1-197001"></a> field assignment hook: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand{\glsprestandardsort</span><a + id="dx1-197002"></a><span +class="cmtt-10">}[3]{%</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\let\name\sortname</span></strong> +<br /><span +class="cmtt-10"> \edef#1{\expandafter\expandonce\expandafter{#1}}%</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\let\name\textname</span></strong> +<br /><span +class="cmtt-10"> \glsdosanitizesort</span><a + id="dx1-197003"></a> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The people are defined using the custom <span +class="cmtt-10">\name </span>command: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{joebloggs}{name={</span><strong><span +class="cmtt-10">\name</span></strong><span +class="cmtt-10">{Joe}{Bloggs}},</span> +<br /><span +class="cmtt-10"> description={\nopostdesc}}</span> +</div> +</div> Since <span +class="cmtt-10">\name </span>is temporarily changed while the <span +class="cmtt-10">sort</span><a + id="dx1-197004"></a> key is being assigned, the sort value for this entry ends up +as “Bloggs, Joe”, but the name appears in the document as “Joe Bloggs”. +<!--l. 16519--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197005"></a></a></span>If you want to use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197006"></a></a>, you first need to convert the document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> but make +sure you include the <span id="textcolor704"><span +class="cmss-10">record</span></span><a + id="dx1-197007"></a> option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor705"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor706"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,style=listgroup]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next it’s necessary to convert the entry definitions to the <span +class="cmtt-10">bib</span><a + id="dx1-197008"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197009"></a></a>. You can simply +do: +<!--l. 16528--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only samplePeople people.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +which will create a file called <span +class="cmtt-10">people.bib </span>that contains definitions like: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor707"><span +class="cmtt-10">@entry</span></span><a + id="dx1-197010"></a><span +class="cmtt-10">{joebloggs,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\name{Joe}{Bloggs}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\nopostdesc</span><a + id="dx1-197011"></a><span +class="cmtt-10">}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> However, you may prefer to use the <span +class="cmtt-10">--index-conversion </span>(<span +class="cmtt-10">-i</span>) switch: +<!--l. 16541--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib -i --preamble-only samplePeople people.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This will discard the <span +class="cmtt-10">description</span><a + id="dx1-197012"></a> field and use <span id="textcolor708"><span +class="cmtt-10">@index</span></span><a + id="dx1-197013"></a> instead of <span id="textcolor709"><span +class="cmtt-10">@entry</span></span><a + id="dx1-197014"></a> if the <span +class="cmtt-10">description</span><a + id="dx1-197015"></a> is either empty or +simply set to <span +class="cmtt-10">\nopostdesc</span><a + id="dx1-197016"></a> or <span id="textcolor710"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-197017"></a>. The <span +class="cmtt-10">people.bib </span>file now contains definitions like: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor711"><span +class="cmtt-10">@index</span></span><a + id="dx1-197018"></a><span +class="cmtt-10">{joebloggs,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\name{Joe}{Bloggs}}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Regardless of which approach you used to create the <span +class="cmtt-10">bib</span><a + id="dx1-197019"></a> file, you now need to edit it to provide a definition of +the custom <span +class="cmtt-10">\name </span>command for <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197020"></a>’s</a> use: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor712"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-197021"></a><span +class="cmtt-10">{"</span><strong><span +class="cmtt-10">\providecommand</span><a + id="dx1-197022"></a></strong><span +class="cmtt-10">{\name}[2]{#2,</span><span +class="cmtt-10"> #1}"}</span> +</div> +</div> Note the use of <span +class="cmtt-10">\providecommand </span>instead of <span +class="cmtt-10">\newcommand</span>. +<!--l. 16562--><p class="indent" > In the document (<span +class="cmtt-10">samplePeople.tex</span>) you now need to delete <span +class="cmtt-10">\makeglossaries</span>, the definitions of +<span +class="cmtt-10">\sortname</span>, <span +class="cmtt-10">\textname</span>, <span +class="cmtt-10">\name</span>, <span +class="cmtt-10">\glsprestandardsort</span>, and all the entry definitions. Then add the following to +the document preamble: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{\name}[2]{#1</span><span +class="cmtt-10"> #2}</span> +<br /><span id="textcolor713"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-197023"></a><span +class="cmtt-10">[</span><span id="textcolor714"><span +class="cmtt-10">src</span></span><a + id="dx1-197024"></a><span +class="cmtt-10">=people]</span> +</div> +</div> Next, use your text editor’s search and replace function to subsitute all instances of <span +class="cmtt-10">\glsentrytext </span>in the +chapter headings with <span id="textcolor715"><span +class="cmtt-10">\glsfmttext</span></span><a + id="dx1-197025"></a>. For example: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\chapter</span><a + id="dx1-197026"></a><span +class="cmtt-10">{</span><strong><span id="textcolor716"><span +class="cmtt-10">\glsfmttext</span></span><a + id="dx1-197027"></a></strong><span +class="cmtt-10">{joebloggs}}</span> +</div> +</div> Finally, replace <span +class="cmtt-10">\printunsrtglossaries </span>with: <div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor717"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-197028"></a> +</div> +</div> The document build is now: +<!--l. 16581--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplePeople + <br />bib2gls samplePeople + <br />pdflatex samplePeople + <br />pdflatex samplePeople + <br /></pre><spacer type=vertical size=10> + <br /></span> +The third <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call is required to ensure that the PDF bookmarks are up to date, as the entries +aren’t defined until after the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197029"></a></a> run (which is why you have to use <span id="textcolor718"><span +class="cmtt-10">\glsfmttext</span></span><a + id="dx1-197030"></a> instead of +<span +class="cmtt-10">\glsentrytext</span>). +</p><!--l. 16592--><p class="indent" > This again leads to a list sorted by surname. The reason this works is because <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197031"></a></a> only sees the +definition of <span +class="cmtt-10">\name </span>provided in <span id="textcolor719"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-197032"></a>, but the document uses the definition of <span +class="cmtt-10">\name </span>provided before +<span +class="cmtt-10">\GlsXtrLoadResources</span>. The use of <span +class="cmtt-10">\providecommand</span><a + id="dx1-197033"></a> in <span id="textcolor720"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-197034"></a> prevents <span +class="cmtt-10">\name </span>from being redefined +within the document. +</p><!--l. 16599--><p class="indent" > See also the “Examples” chapter of the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-197035"></a></a> user manual, which provides another “people” +example. +<a + id="x1-197036r20"></a> +</p><!--l. 16602--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleSort"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleSort">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleSort.tex" ><span +class="cmtt-10">sampleSort.tex</span></a></h4> +<!--l. 16602--><p class="noindent" >This is another document that illustrates how to hook into the standard sort mechanism. An additional run is +required to ensure the table of contents is up-to-date: +</p><!--l. 16605--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSort + <br />makeglossaries sampleSort + <br />pdflatex sampleSort + <br />pdflatex sampleSort + <br /></pre><spacer type=vertical size=10> + <br /></span> +This document has three glossaries (<span +class="cmtt-10">main</span>, <span +class="cmtt-10">acronym </span>and a custom <span +class="cmtt-10">notation</span>), so if you want to +use <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198001"></a></a> explicitly you will need to have three <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198002"></a></a> calls with the appropriate file +extensions: +</p><!--l. 16615--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSort + <br />makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn + <br />makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo + <br />makeindex -s sampleSort.ist -t sampleSort.nlg -o sampleSort.not sampleSort.ntn + <br />pdflatex sampleSort + + + <br />pdflatex sampleSort + <br /></pre><spacer type=vertical size=10> + <br /></span> +It’s much simpler to just use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-198003"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-198004"></a></a>. +</p><!--l. 16625--><p class="indent" > In this example, the sort hook is adjusted to ensure the list of notation is sorted according to the order of +definition. A new counter is defined to keep track of the entry number: + + +</p> + <div class="verbatim" id="verbatim-439"> +\newcounter{sortcount} +</div> +<!--l. 16630--><p class="nopar" > The sort hook is then redefined to increment this counter and assign the sort key to that numerical +value, but only for the <span +class="cmtt-10">notation </span>glossary. The other two glossaries have their sort keys assigned as +normal: + + +</p> + <div class="verbatim" id="verbatim-440"> +\renewcommand{\glsprestandardsort}[3]{% + <br />  \ifdefstring{#2}{notation}% + <br />  {% + <br />     \stepcounter{sortcount}% + <br />     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% + <br />  }% + <br />  {% + <br />     \glsdosanitizesort + <br />  }% + <br />} +</div> +<!--l. 16646--><p class="nopar" > This means that <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198005"></a></a> will sort the notation in numerical order. +</p><!--l. 16649--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to convert this document to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, a much simpler approach is +available with its hybrid method. First change the package loading line to: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor721"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor722"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,acronym]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Either remove <span +class="cmtt-10">\setacronymstyle </span>and replace all instances of <span +class="cmtt-10">\newacronym </span>with <span id="textcolor723"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-198006"></a> or +replace: + + + <div class="verbatim" id="verbatim-441"> +\setacronymstyle{long-short} +</div> +<!--l. 16660--><p class="nopar" > with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor724"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-198007"></a><span +class="cmtt-10">[acronym]{long-short}</span> +</div> +</div> +<!--l. 16666--><p class="indent" > The custom counter and redefinition of <span +class="cmtt-10">\glsprestandardsort </span>can now be removed. The file extensions for +the custom <span +class="cmtt-10">notation </span>glossary are no longer relevant so the glossary definition can be changed to: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossary</span><strong><span +class="cmtt-10">*</span></strong><span +class="cmtt-10">{notation}{Notation}</span> +</div> +</div> The <span +class="cmtt-10">\makeglossaries</span><a + id="dx1-198008"></a> command now needs to be adjusted to indicate which glossaries need to be processed by +<a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198009"></a></a>: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\makeglossaries</span><strong><span +class="cmtt-10">[main,acronym]</span></strong> +</div> +</div> Finally, <span +class="cmtt-10">\printglossaries</span><a + id="dx1-198010"></a> needs to be replaced with: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printglossary</span> +<br /><span +class="cmtt-10">\printacronyms</span> +<br /><span +class="cmtt-10">\print</span><strong><span +class="cmtt-10">noidx</span></strong><span +class="cmtt-10">glossary[type=notation</span><strong><span +class="cmtt-10">,sort=def</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Note that the <span +class="cmtt-10">notation </span>glossary, which hasn’t been listed in the optional argument of <span +class="cmtt-10">\makeglossaries</span>, must +be displayed with <span +class="cmtt-10">\printnoidxglossary</span><a + id="dx1-198011"></a>. +<!--l. 16687--><p class="indent" > This means that <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198012"></a></a> only needs to process the <span +class="cmtt-10">main </span>and <span +class="cmtt-10">acronym </span>glossaries. No actual sorting is +performed for the <span +class="cmtt-10">notation </span>glossary because, when used with <a + id="dx1-198013"></a><span +class="cmtt-10">sort=def</span>, <span +class="cmtt-10">\printnoidxglossary </span>simply iterates +over the list of entries that have been indexed. +</p><!--l. 16693--><p class="indent" > The document build doesn’t need the third <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call now (since none of the glossaries extend beyond a +page break): +</p><!--l. 16695--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSort + <br />makeglossaries sampleSort + + + <br />pdflatex sampleSort + <br /></pre><spacer type=vertical size=10> + <br /></span> +This time <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-198014"></a></a> will include the message: + + +</p> + <div class="verbatim" id="verbatim-442"> +only processing subset 'main,acronym' +</div> +<!--l. 16703--><p class="nopar" > This means that although <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-198015"></a></a> has noticed the <span +class="cmtt-10">notation </span>glossary, it will be skipped. +</p><!--l. 16707--><p class="indent" > If you are explicitly calling <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-198016"></a></a> then you need to drop the call for the <span +class="cmtt-10">notation </span>glossary: +</p><!--l. 16709--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSort + <br />makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn + <br />makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo + <br />pdflatex sampleSort + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 16716--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-198017"></a></a></span>If you prefer to use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-198018"></a></a>, the package loading line needs to be changed to: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor725"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor726"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor727"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,acronym]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next the entry definitions need to be convert to the <span +class="cmtt-10">bib</span><a + id="dx1-198019"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-198020"></a></a>. +<!--l. 16725--><p class="indent" > For this example, it’s simpler to split the entries into different files according to the glossary type. This can +be done with the <span +class="cmtt-10">--split-on-type </span>or <span +class="cmtt-10">-t </span>switch: +</p><!--l. 16728--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib -t --preamble-only sampleSort.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +This will create three files: + </p><dl class="description"><dt class="description"> +<span +class="cmtt-10">entries.bib</span> </dt><dd +class="description">which contains the entries that were defined with <span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-198021"></a>. For example: + <div class="alltt"> + <div class="obeylines-v"> + <span id="textcolor728"><span +class="cmtt-10">@entry</span></span><a + id="dx1-198022"></a><span +class="cmtt-10">{gls:set,</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> set,</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> A</span><span +class="cmtt-10"> collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> distinct</span><span +class="cmtt-10"> objects</span> + <br /><span +class="cmtt-10">}</span> +</div> + </div> + + + </dd><dt class="description"> +<span +class="cmtt-10">abbreviations.bib</span> </dt><dd +class="description">which contains the entries that were defined with <span +class="cmtt-10">\newacronym</span><a + id="dx1-198023"></a>. For example: + <div class="alltt"> + <div class="obeylines-v"> + <span id="textcolor729"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-198024"></a><span +class="cmtt-10">{zfc,</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {ZFC},</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Zermelo-Fraenkel</span><span +class="cmtt-10"> set</span><span +class="cmtt-10"> theory}</span> + <br /><span +class="cmtt-10">}</span> +</div> + </div> If you changed <span +class="cmtt-10">\newacronym</span><a + id="dx1-198025"></a> to <span id="textcolor730"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-198026"></a> then <span id="textcolor731"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-198027"></a> will be used instead: + <div class="alltt"> + <div class="obeylines-v"> + <span id="textcolor732"><span +class="cmtt-10">@abbreviation</span></span><a + id="dx1-198028"></a><span +class="cmtt-10">{zfc,</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {ZFC},</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Zermelo-Fraenkel</span><span +class="cmtt-10"> set</span><span +class="cmtt-10"> theory}</span> + <br /><span +class="cmtt-10">}</span> +</div> + </div> + </dd><dt class="description"> +<span +class="cmtt-10">notation.bib</span> </dt><dd +class="description">which contains the entries that were defined with <span +class="cmtt-10">type</span><a + id="dx1-198029"></a><span +class="cmtt-10">=notation</span>. For example: + <div class="alltt"> + <div class="obeylines-v"> + <span id="textcolor733"><span +class="cmtt-10">@entry</span></span><a + id="dx1-198030"></a><span +class="cmtt-10">{not:set,</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {</span><span +class="tctt-1000">$</span><span +class="cmtt-10">\mathcal{S}</span><span +class="tctt-1000">$</span><span +class="cmtt-10">},</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> set},</span> + <br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\mathcal{S}}</span> + <br /><span +class="cmtt-10">}</span> +</div> + </div> You may prefer to replace <span id="textcolor734"><span +class="cmtt-10">@entry</span></span><a + id="dx1-198031"></a> with <span id="textcolor735"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-198032"></a> in this file.</dd></dl> +<!--l. 16771--><p class="noindent" ><span +class="cmti-10">After </span>the definition of the <span +class="cmtt-10">notation </span>glossary (<span +class="cmtt-10">\newglossary</span>), add: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> abbreviation</span><span +class="cmtt-10"> style</span><span +class="cmtt-10"> must</span><span +class="cmtt-10"> be</span><span +class="cmtt-10"> set</span><span +class="cmtt-10"> first:</span> +<br /><span id="textcolor736"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-198033"></a><span +class="cmtt-10">[acronym]{long-short}</span> +<br /><span id="textcolor737"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-198034"></a><span +class="cmtt-10">[</span><span id="textcolor738"><span +class="cmtt-10">src</span></span><a + id="dx1-198035"></a><span +class="cmtt-10">={entries,abbreviations}]</span> +<br /><span id="textcolor739"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-198036"></a><span +class="cmtt-10">[</span><span id="textcolor740"><span +class="cmtt-10">src</span></span><a + id="dx1-198037"></a><span +class="cmtt-10">={notation},%</span><span +class="cmtt-10"> notation.bib</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor741"><span +class="cmtt-10">type</span></span><span +class="cmtt-10">=notation</span></strong><span +class="cmtt-10">,</span><span id="textcolor742"><span +class="cmtt-10">sort</span></span><a + id="dx1-198038"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">unsrt</span></strong><span +class="cmtt-10">]</span> +</div> +</div> Delete the remainder of the preamble (<span +class="cmtt-10">\makeglossaries </span>and entry definitions). +<!--l. 16783--><p class="indent" > Finally, replace the lines that display the glossaries with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor743"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-198039"></a> +</div> +</div> The build process is now: +<!--l. 16788--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleSort + <br />bib2gls sampleSort + <br />pdflatex sampleSort + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 16794--><p class="indent" > In this case, I have one resource command that processes two glossaries (<span +class="cmtt-10">main </span>and <span +class="cmtt-10">acronym</span>) at the same +time. The entries in these glossaries are ordered alphabetically. The second resource command processes the +<span +class="cmtt-10">notation </span>glossary but the entries in this glossary aren’t sorted (and so will appear in the order of definition +within the <span +class="cmtt-10">bib</span><a + id="dx1-198040"></a> file). +</p><!--l. 16801--><p class="indent" > See also <a +href="#ex:sampleNtn"><span +class="cmtt-10">sampleNtn.tex</span></a>, <a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a> and the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-198041"></a></a> user manual for more examples. +</p><!--l. 16804--><p class="noindent" > +</p> +<!--l. 16804--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.6 </span> <a + id="sec:samplesparent"></a>Child Entries</h3> +<a + id="x1-199001r21"></a> +<!--l. 16807--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample.tex" ><span +class="cmtt-10">sample.tex</span></a></h4> +<!--l. 16807--><p class="noindent" >This document illustrates some of the basics, including how to create child entries that use the same name as +the parent entry. This example adds the glossary to the table of contents and it also uses <span +class="cmtt-10">\glsrefentry</span><a + id="dx1-200001"></a>, so an +extra <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run is required: +</p><!--l. 16812--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample + <br />makeglossaries sample + <br />pdflatex sample + + + <br />pdflatex sample + <br /></pre><spacer type=vertical size=10> + <br /></span> +You can see the difference between word and letter ordering if you add the package option <span +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a + id="dx1-200002"></a>. (Note +that this will only have an effect if you use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-200003"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-200004"></a></a>. If you use <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-200005"></a></a> +explicitly, you will need to use the <span +class="cmtt-10">-l</span><a + id="dx1-200006"></a> switch to indicate letter ordering.) +</p><!--l. 16825--><p class="indent" > One of the entries has its name encapsulated with a semantic command: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{</span><strong><span +class="cmtt-10">\scriptlang</span></strong><span +class="cmtt-10">}[1]{\textsf{#1}}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{Perl}{name=</span><strong><span +class="cmtt-10">\scriptlang</span></strong><span +class="cmtt-10">{Perl},</span><strong><span +class="cmtt-10">sort=Perl,</span></strong> +<br /><span +class="cmtt-10">description={A</span><span +class="cmtt-10"> scripting</span><span +class="cmtt-10"> language}}</span> +</div> +</div> This means that this entry needs to have the <span +class="cmtt-10">sort</span><a + id="dx1-200007"></a> key set otherwise <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-200008"></a></a> will assign it +to the “symbol” letter group, since it starts with a backslash (which <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-200009"></a></a> simply treats as +punctuation). +<!--l. 16837--><p class="indent" > The homograph entries “glossary” and “bravo” are defined as sub-entries that inherit the name from the +parent entry. The parent entry doesn’t have a description, but with the default <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-200010"></a> setting this will +lead to a spurious dot. This can be removed by adding <span +class="cmtt-10">\nopostdesc</span><a + id="dx1-200011"></a> to the description, which suppresses the +post-description hook for that entry. +</p><!--l. 16844--><p class="indent" > Since the child entries have the same name as the parent, this means that the child entries will have +duplicate sort values unless the default is changed with the <span +class="cmtt-10">sort</span><a + id="dx1-200012"></a> key: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{glossary}{name=glossary,</span> +<br /><span +class="cmtt-10"> description={</span><strong><span +class="cmtt-10">\nopostdesc</span><a + id="dx1-200013"></a></strong><span +class="cmtt-10">},plural={glossaries}}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-200014"></a><span +class="cmtt-10">{glossarycol}{</span> +<br /><span +class="cmtt-10"> description={collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> glosses},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">sort={2},</span></strong> +<br /><span +class="cmtt-10"> parent={glossary}%</span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> </span><span +class="cmitt-10">label</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{glossarylist}{</span> +<br /><span +class="cmtt-10"> description={list</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> technical</span><span +class="cmtt-10"> words},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">sort={1},</span></strong> +<br /><span +class="cmtt-10"> parent={glossary}%</span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> </span><span +class="cmitt-10">label</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> (Remember that the entries are sorted hierarchically.) This will place <span +class="cmtt-10">glossarylist </span>before <span +class="cmtt-10">glossarycol</span>, but +both will come immediately after their parent <span +class="cmtt-10">glossary </span>entry. +<!--l. 16867--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you switch to using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, remember that the default package options are different: +</p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor744"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor745"><span +class="cmtt-10">stylemods</span></span></strong><span +class="cmtt-10">,style=treenonamegroup,order=word,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> subentrycounter]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 16875--><p class="indent" > You may now want to consider replacing <span +class="cmtt-10">\nopostdesc</span><a + id="dx1-200015"></a> in the descriptions with <span id="textcolor746"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-200016"></a> (using +your text editor’s search and replace function). This suppresses the post-description punctuation but not the +category post-description hook. +</p><!--l. 16881--><p class="indent" > You may have noticed that some of the descriptions include the plural form, but it’s not done very +consistently. For example: + + +</p> + <div class="verbatim" id="verbatim-443"> +\newglossaryentry{cow}{name=cow, + <br />  plural=cows,% not required as this is the default + <br />  user1=kine, + <br />  description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult + <br />female of any bovine animal} + <br />} +</div> +<!--l. 16890--><p class="nopar" > which has the parenthetical material at the start of the description with emphasis, + + +</p> + <div class="verbatim" id="verbatim-444"> +\newglossaryentry{bravocry}{ + <br />  description={cry of approval (pl.\ bravos)}, + <br />  sort={1}, + <br />  parent={bravo} + <br />} +</div> +<!--l. 16899--><p class="nopar" > which has the parenthetical material at the end of the description without emphasis even though it’s a regular +plural, + + +</p> + <div class="verbatim" id="verbatim-445"> +\newglossaryentry{bravoruffian}{ + <br />  description={hired ruffian or killer (pl.\ bravoes)}, + <br />  sort={2}, + <br />  plural={bravoes}, + <br />  parent=bravo} +</div> +<!--l. 16908--><p class="nopar" > which has the parenthetical material at the end of the description without emphasis, and + + +</p> + <div class="verbatim" id="verbatim-446"> +\newglossaryentry{glossary}{name=glossary, + <br />  description={\nopostdesc}, + <br />  plural={glossaries}} +</div> +<!--l. 16915--><p class="nopar" > which doesn’t show the plural in the description. +</p><!--l. 16918--><p class="indent" > With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you can remove this parenthetical material and implement it using the category +post-description hook instead. For example, the above definitions become: + + +</p> + <div class="verbatim" id="verbatim-447"> +\newglossaryentry{cow}{name=cow, + <br />  user1=kine, + <br />  description={an adult female of any bovine animal} + <br />} + <br />\newglossaryentry{bravocry}{ + <br />  description={cry of approval}, + <br />  sort={1}, + <br />  parent={bravo} + <br />} + <br />\newglossaryentry{bravoruffian}{ + <br />  description={hired ruffian or killer}, + <br />  sort={2}, + <br />  plural={bravoes}, + <br />  parent=bravo} +</div> +<!--l. 16938--><p class="nopar" > </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{glossary}{name=glossary,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={</span><strong><span id="textcolor747"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-200017"></a></strong><span +class="cmtt-10">},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> plural={glossaries}}</span> +</div> +</div> The post-description hook for the <span id="textcolor748"><span +class="cmss-10">general</span></span><a + id="dx1-200018"></a> category can now be set: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor749"><span +class="cmtt-10">\glsdefpostdesc</span></span><a + id="dx1-200019"></a><span +class="cmtt-10">{general}{%</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> Has</span><span +class="cmti-10"> the</span><span +class="cmti-10"> user1</span><span +class="cmti-10"> key</span><span +class="cmti-10"> been</span><span +class="cmti-10"> set?</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor750"><span +class="cmtt-10">\glsxtrifhasfield</span></span><a + id="dx1-200020"></a><span +class="cmtt-10">{useri}{\glscurrententrylabel</span><a + id="dx1-200021"></a><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\space(\emph{pl.}\</span><span +class="cmtt-10"> \glsentryplural</span><a + id="dx1-200022"></a><span +class="cmtt-10">{\glscurrententrylabel</span><a + id="dx1-200023"></a><span +class="cmtt-10">},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \emph{archaic}</span><span +class="cmtt-10"> \glscurrentfieldvalue</span><a + id="dx1-200024"></a><span +class="cmtt-10">)%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> The</span><span +class="cmti-10"> user1</span><span +class="cmti-10"> key</span><span +class="cmti-10"> hasnflt</span><span +class="cmti-10"> been</span><span +class="cmti-10"> set.</span><span +class="cmti-10"> Is</span><span +class="cmti-10"> the</span><span +class="cmti-10"> plural</span><span +class="cmti-10"> the</span><span +class="cmti-10"> same</span><span +class="cmti-10"> as</span><span +class="cmti-10"> the</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> singular</span><span +class="cmti-10"> form</span><span +class="cmti-10"> with</span><span +class="cmti-10"> the</span><span +class="cmti-10"> plural</span><span +class="cmti-10"> suffix</span><span +class="cmti-10"> appended?</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor751"><span +class="cmtt-10">\GlsXtrIfXpFieldEqXpStr</span></span><a + id="dx1-200025"></a><span +class="cmtt-10">{plural}{\glscurrententrylabel</span><a + id="dx1-200026"></a><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\glsentrytext</span><a + id="dx1-200027"></a><span +class="cmtt-10">{\glscurrententrylabel</span><a + id="dx1-200028"></a><span +class="cmtt-10">}\glspluralsuffix</span><a + id="dx1-200029"></a><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> Sibling</span><span +class="cmti-10"> check</span><span +class="cmti-10"> with</span><span +class="cmti-10"> </span><a +href="#glo:bib2gls"><span +class="cmitt-10">bib2gls</span><a + id="dx1-200030"></a></a><span +class="cmti-10"> (see</span><span +class="cmti-10"> below)</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> + + +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> The</span><span +class="cmti-10"> plural</span><span +class="cmti-10"> isnflt</span><span +class="cmti-10"> the</span><span +class="cmti-10"> default.</span><span +class="cmti-10"> Does</span><span +class="cmti-10"> this</span><span +class="cmti-10"> entry</span><span +class="cmti-10"> have</span><span +class="cmti-10"> a</span><span +class="cmti-10"> parent?</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \ifglshasparent{\glscurrententrylabel}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> This</span><span +class="cmti-10"> entry</span><span +class="cmti-10"> has</span><span +class="cmti-10"> a</span><span +class="cmti-10"> parent.</span> +<br /><span +class="cmti-10">%</span><span +class="cmti-10"> Are</span><span +class="cmti-10"> the</span><span +class="cmti-10"> plurals</span><span +class="cmti-10"> for</span><span +class="cmti-10"> the</span><span +class="cmti-10"> child</span><span +class="cmti-10"> and</span><span +class="cmti-10"> parent</span><span +class="cmti-10"> the</span><span +class="cmti-10"> same?</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor752"><span +class="cmtt-10">\GlsXtrIfXpFieldEqXpStr</span></span><a + id="dx1-200031"></a><span +class="cmtt-10">{plural}{\glscurrententrylabel}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\glsentryplural{\glsentryparent{\glscurrententrylabel}}}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {}%</span><span +class="cmtt-10"> </span><span +class="cmti-10">child</span><span +class="cmti-10"> and</span><span +class="cmti-10"> parent</span><span +class="cmti-10"> plurals</span><span +class="cmti-10"> the</span><span +class="cmti-10"> same</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \space(\emph{pl.}\</span><span +class="cmtt-10"> \glsentryplural{\glscurrententrylabel})%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\space(\emph{pl.}\</span><span +class="cmtt-10"> \glsentryplural</span><a + id="dx1-200032"></a><span +class="cmtt-10">{\glscurrententrylabel</span><a + id="dx1-200033"></a><span +class="cmtt-10">})}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> (If you try this example out, notice the difference for the <span +class="cmtt-10">glossary </span>entry if you use <span +class="cmtt-10">\nopostdesc </span>and then +replace it with <span id="textcolor753"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-200034"></a>.) See the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> user manual for further details and also +<a +href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf" ><span +class="cmss-10">glossaries-extra </span>and <span +class="cmtt-10">bib2gls</span>: An Introductory Guide</a>. +<!--l. 16985--><p class="indent" > The “bravo” homographs are an oddity where the singular form is identical but the plural is different +(“bravos” and “bravoes”). In the original, both descriptions included the plural term. The above modifications +drop the display of the regular “bravos” plural (for the <span +class="cmtt-10">bravocry </span>term) and only show the “bravoes” plural (for +the <span +class="cmtt-10">bravoruffian </span>term). In this particular case it might be useful to show the regular plural in order to +highlight the difference. +</p><!--l. 16994--><p class="indent" > While it’s straightforward to access an entry’s parent label (with <span +class="cmtt-10">\glsentryparent</span><a + id="dx1-200035"></a>) it’s much harder to +access entry’s children or siblings. The <span +class="cmtt-10">\ifglshaschildren</span><a + id="dx1-200036"></a> command has to iterate over all entries to determine +if any have a parent that matches the given label. This is obviously very time-consuming if you have a large +database of entries. It also doesn’t provide a way of determining whether or not the child entries have been +indexed. +</p><!--l. 17002--><p class="indent" > With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200037"></a></a>, it’s possible to save this information with the <span id="textcolor754"><span +class="cmtt-10">save-child-count</span></span><a + id="dx1-200038"></a> and <span id="textcolor755"><span +class="cmtt-10">save-sibling-count</span></span><a + id="dx1-200039"></a>, +which not only save the total but also save the child or sibling labels in an <span +class="cmss-10">etoolbox</span><a + id="dx1-200040"></a> internal list. This makes the +information much faster to access and also only includes the labels of those entries that have actually been +indexed. +</p><!--l. 17009--><p class="indent" > In the above, the comment line: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmti-10">%</span><span +class="cmti-10"> Sibling</span><span +class="cmti-10"> check</span><span +class="cmti-10"> with</span><span +class="cmti-10"> </span><a +href="#glo:bib2gls"><span +class="cmitt-10">bib2gls</span><a + id="dx1-200041"></a></a><span +class="cmti-10"> (see</span><span +class="cmti-10"> below)</span> +</div> +</div> indicates where to put the extra code. If you switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200042"></a></a> and make sure to use <span id="textcolor756"><span +class="cmtt-10">save-sibling-count</span></span><a + id="dx1-200043"></a> +then you can insert the following code in the block above where that comment is: <div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor757"><span +class="cmtt-10">\GlsXtrIfFieldNonZero</span></span><a + id="dx1-200044"></a><span +class="cmtt-10">{siblingcount}{\glscurrententrylabel}%</span> +<br /><span +class="cmtt-10">{%</span><span +class="cmtt-10"> </span><span id="textcolor758"><span +class="cmitt-10">siblingcount</span></span><a + id="dx1-200045"></a><span +class="cmti-10"> field</span><span +class="cmti-10"> value</span><span +class="cmti-10"> non-zero</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor759"><span +class="cmtt-10">\glsxtrfieldforlistloop</span></span><a + id="dx1-200046"></a><span +class="cmtt-10"> %</span><span +class="cmtt-10"> </span><span +class="cmti-10">iterate</span><span +class="cmti-10"> over</span><span +class="cmti-10"> internal</span><span +class="cmti-10"> list</span> +<br /><span +class="cmtt-10"> {\glscurrententrylabel}%</span><span +class="cmtt-10"> </span><span +class="cmti-10">entry</span><span +class="cmti-10"> label</span> +<br /><span +class="cmtt-10"> {siblinglist}%</span><span +class="cmtt-10"> </span><span +class="cmti-10">label</span><span +class="cmti-10"> of</span><span +class="cmti-10"> field</span><span +class="cmti-10"> containing</span><span +class="cmti-10"> list</span> +<br /><span +class="cmtt-10"> {\siblinghandler}%</span><span +class="cmtt-10"> </span><span +class="cmti-10">loop</span><span +class="cmti-10"> handler</span> +<br /><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10">{}%</span><span +class="cmtt-10"> </span><span id="textcolor760"><span +class="cmitt-10">siblingcount</span></span><a + id="dx1-200047"></a><span +class="cmti-10"> field</span><span +class="cmti-10"> value</span><span +class="cmti-10"> 0</span><span +class="cmti-10"> or</span><span +class="cmti-10"> empty</span><span +class="cmti-10"> or</span><span +class="cmti-10"> missing</span> +</div> +</div> This uses a custom handler that’s defined as follows: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{\siblinghandler}[1]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor761"><span +class="cmtt-10">\GlsXtrIfXpFieldEqXpStr</span></span><a + id="dx1-200048"></a><span +class="cmtt-10">*{plural}{\glscurrententrylabel}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {\glsentryplural{#1}}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {}%</span><span +class="cmtt-10"> </span><span +class="cmti-10">current</span><span +class="cmti-10"> entryfls</span><span +class="cmti-10"> plural</span><span +class="cmti-10"> same</span><span +class="cmti-10"> as</span><span +class="cmti-10"> siblingfls</span><span +class="cmti-10"> plural</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \space(\emph{pl.}\</span><span +class="cmtt-10"> \glsentryplural{\glscurrententrylabel})%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \listbreak</span><a + id="dx1-200049"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The <span +class="cmtt-10">\listbreak </span>command is provided by <span +class="cmss-10">etoolbox</span><a + id="dx1-200050"></a> and is used for prematurely exiting a loop. The handler +tests if the sibling’s <span +class="cmtt-10">plural</span><a + id="dx1-200051"></a> field is identical to the current entry’s <span +class="cmtt-10">plural</span><a + id="dx1-200052"></a> field. If they are the +same, it does nothing. If they are different, it displays the current entry’s plural and breaks the +loop. +<!--l. 17045--><p class="indent" > Note that this assumes that the parent entry hasn’t had the plural form explicitly set to “bravoes” instead of +the default “bravos”. In that case, the parent entry would show the plural but the <span +class="cmtt-10">bravoruffian </span>child entry +wouldn’t show the plural (since this case would led to the empty code block identified with the comment “child +and parent plurals the same”). The “bravoes” plural form would instead be shown for the parent, which +wouldn’t look right. +</p><!--l. 17054--><p class="indent" > If you don’t use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200053"></a></a> or if you use it without the <span id="textcolor762"><span +class="cmtt-10">save-sibling-count</span></span><a + id="dx1-200054"></a> resource option then the sibling +information won’t be available. +</p><!--l. 17058--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200055"></a></a></span>In order to switch to using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200056"></a></a>, it’s first necessary to switch to using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (as above). +Remember that the <span id="textcolor763"><span +class="cmss-10">record</span></span><a + id="dx1-200057"></a> option is required: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor764"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span></strong><span id="textcolor765"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor766"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,style=treenonamegroup,</span> +<br /><span +class="cmtt-10">subentrycounter]{glossaries-extra}</span> +</div> +</div> Next the entry definitions need to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-200058"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200059"></a></a>. This can be done with +<a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-200060"></a></a>: <div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">convertgls2bib</span><span +class="cmtt-10"> --preamble-only</span><span +class="cmtt-10"> sample.tex</span><span +class="cmtt-10"> entries.</span> +</div> +</div> The semantic command may be moved to the <span +class="cmtt-10">bib</span><a + id="dx1-200061"></a> file to ensure it’s defined: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor767"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-200062"></a><span +class="cmtt-10">{"\providecommand{\scriptlang}[1]{\textsf{#1}}"}</span> +</div> +</div> +<!--l. 17078--><p class="indent" > The <span +class="cmtt-10">sort</span><a + id="dx1-200063"></a> field typically shouldn’t be set when using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200064"></a></a>, so <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-200065"></a></a> strips it. If the <span +class="cmtt-10">sort</span><a + id="dx1-200066"></a> field +is missing, <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200067"></a></a> will obtain it from the sort fallback for that entry type. In this case, <span id="textcolor768"><span +class="cmtt-10">@entry</span></span><a + id="dx1-200068"></a> has the <span +class="cmtt-10">name</span><a + id="dx1-200069"></a> +field as the sort fallback. If this is also missing then its value is obtained from the parent’s <span +class="cmtt-10">name</span><a + id="dx1-200070"></a> field (see +<a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a> for other examples). +</p><!--l. 17086--><p class="indent" > Therefore the “Perl” entry is simply defined as: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor769"><span +class="cmtt-10">@entry</span></span><a + id="dx1-200071"></a><span +class="cmtt-10">{Perl,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\scriptlang{Perl}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {A</span><span +class="cmtt-10"> scripting</span><span +class="cmtt-10"> language}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This isn’t a problem for <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200072"></a></a>. In this case, the command has been provided in the <span id="textcolor770"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-200073"></a>, but <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200074"></a></a> +strips font information so the sort value becomes <span +class="cmtt-10">Perl</span>. If the definition isn’t placed in <span id="textcolor771"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-200075"></a> then +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200076"></a></a> will simply ignore the command (as <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-200077"></a></a> does) so the sort value will still end up as +<span +class="cmtt-10">Perl</span>. +<!--l. 17100--><p class="indent" > The homograph entries have also had their <span +class="cmtt-10">sort</span><a + id="dx1-200078"></a> fields omitted: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor772"><span +class="cmtt-10">@entry</span></span><a + id="dx1-200079"></a><span +class="cmtt-10">{glossarycol,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {glossary},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {collection</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> glosses}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor773"><span +class="cmtt-10">@entry</span></span><a + id="dx1-200080"></a><span +class="cmtt-10">{glossarylist,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {glossary},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {list</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> technical</span><span +class="cmtt-10"> words}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> + + +<!--l. 17113--><p class="indent" > This means that the sort value for both these child entries is “glossary”. When <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200081"></a></a> encounters identical +sort values it acts according to its <span id="textcolor774"><span +class="cmtt-10">identical-sort-action</span></span><a + id="dx1-200082"></a> setting. The default action is to sort by the label +using a simple string comparison. In this case, it would put <span +class="cmtt-10">glossarycol </span>before <span +class="cmtt-10">glossarylist</span>. In the original +document, the <span +class="cmtt-10">sort</span><a + id="dx1-200083"></a> value was manually chosen to ensure that the entries are ordered according to <a +href="#glo:firstuse">first use</a>. +This ordering can easily be obtained by changing <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200084"></a>’s</a> identical sort action (requires at least <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200085"></a></a> +v2.0): </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor775"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-200086"></a><span +class="cmtt-10">[</span><span id="textcolor776"><span +class="cmtt-10">src</span></span><a + id="dx1-200087"></a><span +class="cmtt-10">={entries},</span><strong><span id="textcolor777"><span +class="cmtt-10">identical-sort-action</span></span><span +class="cmtt-10">=use</span></strong><span +class="cmtt-10">]</span> +</div> +</div> This command should replace <span +class="cmtt-10">\makeglossaries</span>. If you want the sibling information (see earlier), then you +need to remember to add <span id="textcolor778"><span +class="cmtt-10">save-sibling-count</span></span><a + id="dx1-200088"></a> to the list of options. +<!--l. 17130--><p class="indent" > Note that this is a better solution than in the original example. If I edit the document so that <span +class="cmtt-10">glossarycol</span> +is used first, then the ordering will be updated accordingly, but with the original example, the <span +class="cmtt-10">sort</span><a + id="dx1-200089"></a> keys would +need to be manually changed. +</p><!--l. 17135--><p class="indent" > The remainder of the preamble (that is, the definition of <span +class="cmtt-10">\scriptlang </span>and all the entry definitions) should +now be removed. +</p><!--l. 17139--><p class="indent" > Finally, replace <span +class="cmtt-10">\printglossaries </span>with <span id="textcolor779"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-200090"></a>. The document build is now: +</p><!--l. 17141--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample + <br />bib2gls --group sample + <br />pdflatex sample + <br />pdflatex sample + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note use of the <span id="textcolor780"><span +class="cmtt-10">--group</span></span><a + id="dx1-200091"></a> (or <span id="textcolor781"><span +class="cmtt-10">-g</span></span><a + id="dx1-200092"></a>) switch, which is needed to support the <span +class="cmss-10">treenonamegroup</span><a + id="dx1-200093"></a> style. The third +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call is needed because the document contains <span +class="cmtt-10">\glsrefentry</span><a + id="dx1-200094"></a>. +</p><!--l. 17151--><p class="indent" > Note that you can’t use the <span +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a + id="dx1-200095"></a> package option with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-200096"></a></a>. Instead use the <span id="textcolor782"><span +class="cmtt-10">break-at</span></span><span +class="cmtt-10">=none</span><a + id="dx1-200097"></a> +resource option: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor783"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-200098"></a><span +class="cmtt-10">[</span><span id="textcolor784"><span +class="cmtt-10">src</span></span><a + id="dx1-200099"></a><span +class="cmtt-10">={entries},</span><span id="textcolor785"><span +class="cmtt-10">identical-sort-action</span></span><span +class="cmtt-10">=use,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor786"><span +class="cmtt-10">break-at</span></span><span +class="cmtt-10">=none</span></strong> +<br /><span +class="cmtt-10">]</span> +</div> +</div> +<a + id="x1-200100r22"></a> +<!--l. 17160--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-inline"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-inline">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-inline.tex" ><span +class="cmtt-10">sample-inline.tex</span></a></h4> +<!--l. 17160--><p class="noindent" >This document is like <span +class="cmtt-10">sample.tex</span>, above, but uses the <span +class="cmss-10">inline</span><a + id="dx1-201001"></a> glossary style to put the glossary in a footnote. +The document build is: + + +</p><!--l. 17164--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-inline + <br />makeglossaries sample-inline + <br />pdflatex sample-inline + <br />pdflatex sample-inline + <br /></pre><spacer type=vertical size=10> + <br /></span> +If you want to convert this document to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, follow the same procedure as above. If you want to use +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-201002"></a></a> then you don’t need the <span id="textcolor787"><span +class="cmtt-10">--group</span></span><a + id="dx1-201003"></a> switch since no letter groups are required. +<a + id="x1-201004r23"></a> +</p><!--l. 17175--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampletree"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampletree">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampletree.tex" ><span +class="cmtt-10">sampletree.tex</span></a></h4> +<!--l. 17175--><p class="noindent" >This document illustrates a hierarchical glossary structure where child entries have different names to their +corresponding parent entry. To create the document do: +</p><!--l. 17179--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampletree + <br />makeglossaries sampletree + <br />pdflatex sampletree + <br /></pre><spacer type=vertical size=10> + <br /></span> +The document uses the <span +class="cmss-10">alttreehypergroup</span><a + id="dx1-202001"></a> glossary style, which needs to know the widest name for each +hierarchical level. This has been assigned manually in the preamble with <span +class="cmtt-10">\glssetwidest</span><a + id="dx1-202002"></a>: + + +</p> + <div class="verbatim" id="verbatim-448"> +\glssetwidest{Roman letters} % level 0 widest name + <br />\glssetwidest[1]{Sigma}      % level 1 widest name +</div> +<!--l. 17191--><p class="nopar" > (Level 0 is the top-most level. That is, entries that don’t have a parent.) It’s possible to get <span +class="cmss-10">glossaries </span>to +compute the widest top-level entry with <span +class="cmtt-10">\glsfindwidesttoplevelname</span><a + id="dx1-202003"></a> but this will iterate over all top-level +entries, regardless of whether or not they appear in the glossary. If you have a large database of entries, this will +firstly take time and secondly the width may be too large due to an unindexed entry with a big +name. +</p><!--l. 17200--><p class="indent" > This sample document doesn’t require any of the tabular styles so I’ve prevented those packages from being +loaded with <span +class="cmss-10">nolong</span><a + id="dx1-202004"></a> and <span +class="cmss-10">nosuper</span><a + id="dx1-202005"></a>. The reduces the overall package loading. </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=alttreehypergroup,</span><strong><span +class="cmtt-10">nolong,nosuper</span></strong><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{glossaries}</span> +</div> +</div> (This example glossary is actually better suited for one of the topic styles provided with <span id="textcolor788"><span +class="cmss-10">glossary-topic</span></span><a + id="dx1-202006"></a>, see +below.) +<!--l. 17210--><p class="indent" > This is obviously a contrived example since it’s strange to have the symbol names (such as “Sigma”) in the +glossary. The purpose is to demonstrate the <span +class="cmss-10">alttreehypergroup</span><a + id="dx1-202007"></a> with an entry that’s noticeably wider than the +others in the same hierarchical level. A more sensible document would have the symbol in the <span +class="cmtt-10">name</span><a + id="dx1-202008"></a> +key. +</p><!--l. 17217--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, then you can instead use a combination of <span +class="cmss-10">nostyles</span><a + id="dx1-202009"></a> +and <span id="textcolor789"><span +class="cmss-10">stylemods</span></span><a + id="dx1-202010"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=alttreehypergroup,</span><span id="textcolor790"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><strong><span +class="cmtt-10">nostyles,</span> +<br /><span id="textcolor791"><span +class="cmtt-10">stylemods=tree</span></span></strong><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The <span id="textcolor792"><span +class="cmss-10">stylemods</span></span><a + id="dx1-202011"></a> package not only patches the original styles provided by the base <span +class="cmss-10">glossaries </span>package (such +as <span +class="cmss-10">glossary-tree</span><a + id="dx1-202012"></a> used in this example) but also provides extra helper commands. In this case, it +provides additional commands to calculate the widest name. For example, instead of manually +setting the widest entry with <span +class="cmtt-10">\glssetwidest</span><a + id="dx1-202013"></a>, you could add the following before the glossary: +<div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor793"><span +class="cmtt-10">\glsFindWidestUsedTopLevelName</span></span><a + id="dx1-202014"></a> +<br /><span id="textcolor794"><span +class="cmtt-10">\glsFindWidestUsedLevelTwo</span></span><a + id="dx1-202015"></a> + + +</div> +</div> This will only take into account the entries that have actually been used in the document, but it can still be +time-consuming if you have a large number of entries. +<!--l. 17240--><p class="indent" > <div class="important" title="Important Note"> Note that the glossary must be at the end of the document (after all required entries have been used) with +this method. The alternative is to perform the calculation at the end of the document and save the results in the +<span +class="cmtt-10">aux</span><a + id="dx1-202016"></a> file for the next run. </div> +</p><!--l. 17245--><p class="noindent" > +</p><!--l. 17247--><p class="indent" > This example document is using top-level entries for topics without descriptions. This means that the +descriptions simply contain <span +class="cmtt-10">\nopostdesc</span><a + id="dx1-202017"></a> to prevent the post-description punctuation from being automatically +inserted. For example: + + +</p> + <div class="verbatim" id="verbatim-449"> +\newglossaryentry{greekletter}{name={Greek letters}, + <br />text={Greek letter}, + <br />description={\nopostdesc}} +</div> +<!--l. 17255--><p class="nopar" > With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you can convert this to <span id="textcolor795"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-202018"></a> which will prevent the post-description +punctuation without interfering with the category post-description hook. +</p><!--l. 17261--><p class="indent" > In order to distinguish between the child entries, which are symbols, and the parent entries, which are topics, +it’s useful to give these two different types of entries different categories. The topics can use the default <span id="textcolor796"><span +class="cmss-10">general</span></span><a + id="dx1-202019"></a> +category, but the symbol entries can be assigned to a different category. The value of the <span id="textcolor797"><span id="textcolor798"><span +class="cmtt-10">category</span></span><a + id="dx1-202020"></a></span> key must be +a label. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{C}{name={C},</span> +<br /><span +class="cmtt-10">description={Euler's</span><span +class="cmtt-10"> constant},</span> +<br /><strong><span id="textcolor799"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">=symbol,</span></strong> +<br /><span +class="cmtt-10">parent=romanletter}</span> +</div> +</div> +<!--l. 17274--><p class="indent" > There is some redundancy caused by a parenthetical note after the <a +href="#glo:firstuse">first use</a> in some of the symbol entries. +For example: + + +</p> + <div class="verbatim" id="verbatim-450"> +\newglossaryentry{pi}{name={pi}, + <br />text={\ensuremath{\pi}}, + <br />first={\ensuremath{\pi} (lowercase pi)}, + <br />description={Transcendental number}, + <br />parent=greekletter} +</div> +<!--l. 17282--><p class="nopar" > With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> this can be dealt with through the category post-link hook: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor800"><span +class="cmtt-10">\glsdefpostlink</span></span><a + id="dx1-202021"></a><span +class="cmtt-10">{symbol}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor801"><span +class="cmtt-10">\glsxtrifwasfirstuse</span></span><a + id="dx1-202022"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {%</span><span +class="cmtt-10"> first</span><span +class="cmtt-10"> use</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor802"><span +class="cmtt-10">\glsxtrifhasfield</span></span><a + id="dx1-202023"></a><span +class="cmtt-10">{useri}{\glslabel</span><a + id="dx1-202024"></a><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> {</span><span +class="cmtt-10"> (\glscurrentfieldvalue</span><a + id="dx1-202025"></a><span +class="cmtt-10">)}{}%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> {}%</span><span +class="cmtt-10"> not</span><span +class="cmtt-10"> first</span><span +class="cmtt-10"> use</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The parenthetical material is now stored in the <span +class="cmtt-10">user1</span><a + id="dx1-202026"></a> key. For example: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{sigma}{name=Sigma,</span> +<br /><span +class="cmtt-10">text={\ensuremath\Sigma},</span> +<br /><strong><span +class="cmtt-10">user1={uppercase</span><span +class="cmtt-10"> sigma},</span></strong> +<br /><span +class="cmtt-10">description={Used</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> indicate</span><span +class="cmtt-10"> summation},</span> +<br /><span +class="cmtt-10">parent=greekletter}</span> +</div> +</div> The category post-description link is also set to ensure that the symbol is displayed after the description in the +glossary: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor803"><span +class="cmtt-10">\glsdefpostdesc</span></span><a + id="dx1-202027"></a><span +class="cmtt-10">{symbol}{\space</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> (</span><span +class="tctt-1000">$</span><span +class="cmtt-10">\glsentrytext</span><a + id="dx1-202028"></a><span +class="cmtt-10">{\glscurrententrylabel</span><a + id="dx1-202029"></a><span +class="cmtt-10">}</span><span +class="tctt-1000">$</span><span +class="cmtt-10">)}</span> +</div> +</div> These modifications only affect entries with the <span id="textcolor804"><span id="textcolor805"><span +class="cmtt-10">category</span></span><a + id="dx1-202030"></a></span> set to <span id="textcolor806"><span +class="cmss-10">symbol</span></span><a + id="dx1-202031"></a>. +<!--l. 17312--><p class="indent" > With <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, it’s now possible to use the topic styles provided with the <span id="textcolor807"><span +class="cmss-10">glossary-topic</span></span><a + id="dx1-202032"></a> package: +</p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=</span><strong><span id="textcolor808"><span +class="cmtt-10">topic</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor809"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><strong><span +class="cmtt-10">nostyles,</span><span id="textcolor810"><span +class="cmtt-10">stylemods={tree</span><strong><span +class="cmtt-10">,topic</span></strong><span +class="cmtt-10">}</span></span></strong><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The <span id="textcolor811"><span +class="cmss-10">topic</span></span><a + id="dx1-202033"></a> style is designed for this kind of hierarchy where all the top-level entries don’t have descriptions. This +means that the <span +class="cmtt-10">\nopostdot</span><a + id="dx1-202034"></a> and <span id="textcolor812"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-202035"></a> commands aren’t required. The top-level entries can +simply be defined as: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{greekletter}{name={Greek</span><span +class="cmtt-10"> letters},</span> +<br /><span +class="cmtt-10">text={Greek</span><span +class="cmtt-10"> letter},</span><span +class="cmtt-10"> description={}}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{romanletter}{name={Roman</span><span +class="cmtt-10"> letters},</span> +<br /><span +class="cmtt-10">text={Roman</span><span +class="cmtt-10"> letter},</span><span +class="cmtt-10"> description={}}</span> +</div> +</div> I’ve now loaded both the <span +class="cmss-10">glossary-tree</span><a + id="dx1-202036"></a> and <span +class="cmss-10">glossary-topic</span><a + id="dx1-202037"></a> packages (via <span id="textcolor813"><span +class="cmss-10">stylemods</span></span><a + id="dx1-202038"></a><span +class="cmtt-10">={tree,topic}</span>). The +<span +class="cmss-10">glossary-topic</span><a + id="dx1-202039"></a> package can be used without <span +class="cmss-10">glossary-tree</span><a + id="dx1-202040"></a>, in which case it will behave more like the normal <span +class="cmss-10">tree</span><a + id="dx1-202041"></a> +rather than <span +class="cmss-10">alttree</span><a + id="dx1-202042"></a> styles (but with different indentation and no description in the top-level). However, +if you use <span +class="cmtt-10">\glssetwidest</span><a + id="dx1-202043"></a> (provided by <span +class="cmss-10">glossary-tree</span><a + id="dx1-202044"></a>) then the <span id="textcolor814"><span +class="cmss-10">topic</span></span><a + id="dx1-202045"></a> style will behave more like +<span +class="cmss-10">alttree</span><a + id="dx1-202046"></a>. +<!--l. 17340--><p class="indent" > Since there’s no description for the top-level entries, the <span id="textcolor815"><span +class="cmss-10">topic</span></span><a + id="dx1-202047"></a> style ignores the widest name setting for the +top-level, so I can just have the level 1 setting: + + +</p> + <div class="verbatim" id="verbatim-451"> +\glssetwidest[1]{Sigma} +</div> +<!--l. 17345--><p class="nopar" > +</p><!--l. 17347--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202048"></a></a></span>If you want to convert this document so that it uses <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202049"></a></a>, you first need to convert it +to using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, as described above, but remember that you now need the <span id="textcolor816"><span +class="cmss-10">record</span></span><a + id="dx1-202050"></a> option. +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor817"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">,</span></strong><span +class="cmtt-10">style=topic,</span><span id="textcolor818"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,nostyles,</span><span id="textcolor819"><span +class="cmtt-10">stylemods={tree,topic}</span></span><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next convert the entries to the <span +class="cmtt-10">bib</span><a + id="dx1-202051"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202052"></a></a>: +<!--l. 17358--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sampletree.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Now replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor820"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-202053"></a><span +class="cmtt-10">[</span><span id="textcolor821"><span +class="cmtt-10">src</span></span><a + id="dx1-202054"></a><span +class="cmtt-10">=entries,</span><strong><span id="textcolor822"><span +class="cmtt-10">set-widest</span></span></strong><span +class="cmtt-10">]</span> +</div> +</div> I’ve used the <span id="textcolor823"><span +class="cmtt-10">set-widest</span></span><a + id="dx1-202055"></a> option here to get <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202056"></a></a> to compute the widest name. (Obviously, it can only do +this if it can correctly interpret any commands contained in the <span +class="cmtt-10">name</span><a + id="dx1-202057"></a> field.) +<!--l. 17370--><p class="indent" > This means that the <span +class="cmtt-10">\glssetwidest</span><a + id="dx1-202058"></a> commands can now be removed completely. All the <span +class="cmtt-10">\newglossaryentry</span> +commands also need to be removed from the preamble. Finally, <span +class="cmtt-10">\printunsrtglossaries </span>needs to be replaced +with <span id="textcolor824"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-202059"></a>. The document build is now: +</p><!--l. 17374--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampletree + <br />bib2gls sampletree + <br />pdflatex sampletree + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 17380--><p class="indent" > This produces the same result as with just <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-202060"></a></a>. However, there are some +modifications that can be made to the <span +class="cmtt-10">bib</span><a + id="dx1-202061"></a> file to make it neater. +</p><!--l. 17384--><p class="indent" > The top-level entries are defined as: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor825"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202062"></a><span +class="cmtt-10">{greekletter,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Greek</span><span +class="cmtt-10"> letters},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Greek</span><span +class="cmtt-10"> letter}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor826"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202063"></a><span +class="cmtt-10">{romanletter,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Roman</span><span +class="cmtt-10"> letters},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Roman</span><span +class="cmtt-10"> letter}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This is a direct translation from the <span +class="cmtt-10">\newglossaryentry </span>commands (after switching to the <span id="textcolor827"><span +class="cmss-10">topic</span></span><a + id="dx1-202064"></a> style). There’s +a more appropriate entry type: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor828"><span +class="cmtt-10">@indexplural</span></span><a + id="dx1-202065"></a><span +class="cmtt-10">{greekletter,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Greek</span><span +class="cmtt-10"> letter}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor829"><span +class="cmtt-10">@indexplural</span></span><a + id="dx1-202066"></a><span +class="cmtt-10">{romanletter,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Roman</span><span +class="cmtt-10"> letter}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The <span id="textcolor830"><span +class="cmtt-10">@indexplural</span></span><a + id="dx1-202067"></a> entry type doesn’t require the <span +class="cmtt-10">description</span><a + id="dx1-202068"></a> and will set the <span +class="cmtt-10">name</span><a + id="dx1-202069"></a> field to the same as the +<span +class="cmtt-10">plural</span><a + id="dx1-202070"></a> field. Since the <span +class="cmtt-10">plural</span><a + id="dx1-202071"></a> field hasn’t been set it’s obtained by appending “s” to the <span +class="cmtt-10">text</span><a + id="dx1-202072"></a> +field. +<!--l. 17416--><p class="indent" > Now let’s assume that the symbol entries are defined in a more rational manner, with the actual symbol in +the <span +class="cmtt-10">name</span><a + id="dx1-202073"></a> field. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor831"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202074"></a><span +class="cmtt-10">{sigma,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> user1</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {uppercase</span><span +class="cmtt-10"> sigma},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {greekletter},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Used</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> indicate</span><span +class="cmtt-10"> summation},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\Sigma}}</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> category</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {symbol}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor832"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202075"></a><span +class="cmtt-10">{C,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {romanletter},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{C}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Euler's</span><span +class="cmtt-10"> constant},</span> + + +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> category</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {symbol}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The category post-description hook (provided with <span id="textcolor833"><span +class="cmtt-10">\glsdefpostdesc</span></span><a + id="dx1-202076"></a>) should now be removed from the +document. +<!--l. 17438--><p class="indent" > If you make these changes and rebuild the document, you’ll find that the order has changed. Now the <span +class="cmtt-10">sigma</span> +entry is before the <span +class="cmtt-10">pi </span>entry. This is because <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202077"></a></a> is obtaining the sort values from the <span +class="cmtt-10">name</span><a + id="dx1-202078"></a> field, +which is the sort fallback for <span id="textcolor834"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202079"></a>. This means that the sort values end up as Σ and <span +class="cmmi-10">π </span>(<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202080"></a></a> +recognises the commands <span +class="cmtt-10">\Sigma</span><a + id="dx1-202081"></a> and <span +class="cmtt-10">\pi</span><a + id="dx1-202082"></a> and converts them to the Unicode characters 0x1D6F4 and +0x1D70B). +</p><!--l. 17447--><p class="indent" > If you change <span id="textcolor835"><span +class="cmtt-10">@entry</span></span><a + id="dx1-202083"></a> to <span id="textcolor836"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-202084"></a> then you will once again get the order from the original example (<span +class="cmtt-10">pi </span>before +<span +class="cmtt-10">Sigma</span>). This is because the sort fallback for <span id="textcolor837"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-202085"></a> is the label not the <span +class="cmtt-10">name</span><a + id="dx1-202086"></a>. (Remember that the sort +fallback is only used if the <span +class="cmtt-10">sort</span><a + id="dx1-202087"></a> field isn’t set. If you explicitly set the <span +class="cmtt-10">sort</span><a + id="dx1-202088"></a> field then no fallback is required. See +<a +href="https://www.dickimaw-books.com/gallery/index.php?label=bib2gls-sorting" ><span +class="cmtt-10">bib2gls </span>gallery: sorting</a>.) +</p><!--l. 17455--><p class="indent" > You can further tidy the <span +class="cmtt-10">bib</span><a + id="dx1-202089"></a> file by removing the <span id="textcolor838"><span id="textcolor839"><span +class="cmtt-10">category</span></span><a + id="dx1-202090"></a></span> fields. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor840"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-202091"></a><span +class="cmtt-10">{sigma,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> user1</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {uppercase</span><span +class="cmtt-10"> sigma},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> parent</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {greekletter},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Used</span><span +class="cmtt-10"> to</span><span +class="cmtt-10"> indicate</span><span +class="cmtt-10"> summation},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {\ensuremath{\Sigma}}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> You can then assign the <span id="textcolor841"><span id="textcolor842"><span +class="cmtt-10">category</span></span><a + id="dx1-202092"></a></span> in the resource set: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor843"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-202093"></a><span +class="cmtt-10">[</span><span id="textcolor844"><span +class="cmtt-10">src</span></span><a + id="dx1-202094"></a><span +class="cmtt-10">=entries,</span><span id="textcolor845"><span +class="cmtt-10">set-widest</span></span><span +class="cmtt-10">,</span><strong><span id="textcolor846"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">={same</span><span +class="cmtt-10"> as</span><span +class="cmtt-10"> entry}</span></strong><span +class="cmtt-10">]</span> +</div> +</div> This means that all the entries defined with <span id="textcolor847"><span +class="cmtt-10">@symbol</span></span><a + id="dx1-202095"></a> will have the <span id="textcolor848"><span id="textcolor849"><span +class="cmtt-10">category</span></span><a + id="dx1-202096"></a></span> set to <span +class="cmtt-10">symbol </span>and all the entries +defined with <span id="textcolor850"><span +class="cmtt-10">@indexplural</span></span><a + id="dx1-202097"></a> will have the <span id="textcolor851"><span id="textcolor852"><span +class="cmtt-10">category</span></span><a + id="dx1-202098"></a></span> set to <span +class="cmtt-10">indexplural</span>. (Only the <span id="textcolor853"><span +class="cmss-10">symbol</span></span><a + id="dx1-202099"></a> category is significant +in this example.) +<!--l. 17475--><p class="indent" > You can make the <span +class="cmtt-10">bib</span><a + id="dx1-202100"></a> files even more flexible by introducing field and entry aliases with <span id="textcolor854"><span +class="cmtt-10">field-aliases</span></span><a + id="dx1-202101"></a> and +<span id="textcolor855"><span +class="cmtt-10">entry-type-aliases</span></span><a + id="dx1-202102"></a>. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-202103"></a></a> manual for further details. +</p><!--l. 17480--><p class="noindent" > +</p> +<!--l. 17480--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.7 </span> <a + id="sec:samplescrossref"></a>Cross-Referencing</h3> +<a + id="x1-203001r24"></a> + + +<!--l. 17483--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-crossref"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-crossref">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-crossref.tex" ><span +class="cmtt-10">sample-crossref.tex</span></a></h4> +<!--l. 17484--><p class="noindent" >This document illustrates how to cross-reference entries in the glossary. +</p><!--l. 17486--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-crossref + <br />makeglossaries sample-crossref + <br />pdflatex sample-crossref + <br /></pre><spacer type=vertical size=10> + <br /></span> +The document provides a command <span +class="cmtt-10">\alsoname</span><a + id="dx1-204001"></a> to produce some fixed text, which can be changed as +appropriate (usually within a language hook): + + +</p> + <div class="verbatim" id="verbatim-452"> +\providecommand{\alsoname}{see also} +</div> +<!--l. 17495--><p class="nopar" > I’ve used <span +class="cmtt-10">\providecommand </span>as some packages define this command. This is used to create a “see also” +cross-reference with the <span +class="cmtt-10">see</span><a + id="dx1-204002"></a> key: + + +</p> + <div class="verbatim" id="verbatim-453"> +\newglossaryentry{apple}{name=apple,description={firm, round fruit}, + <br />see=[\alsoname]{pear}} + <br />\newglossaryentry{marrow}{name={marrow}, + <br /> description={long vegetable with thin green skin and white flesh}, + <br /> see={[\alsoname]courgette}} +</div> +<!--l. 17506--><p class="nopar" > +</p><!--l. 17508--><p class="indent" > Note that “marrow” is included in the glossary even though it hasn’t been referenced in the text. This is +because the <span +class="cmtt-10">see</span><a + id="dx1-204003"></a> key automatically triggers <span +class="cmtt-10">\glssee</span><a + id="dx1-204004"></a> which indexes the term. This behaviour is intended for +documents where only the terms that are actually required in the document are defined. It’s not +suitable for a large database of terms shared across multiple documents that may or may not be +used in a particular document. In that case, you may want to consider using <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (see +below). +</p><!--l. 17518--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This example is quite simple to convert to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>. If you want the dot after the +description, you need the <span +class="cmss-10">nopostdot</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a + id="dx1-204005"></a> or <span id="textcolor856"><span +class="cmss-10">postdot</span></span><a + id="dx1-204006"></a> package option. You may also want to consider using the +<span id="textcolor857"><span +class="cmss-10">stylemods</span></span><a + id="dx1-204007"></a> option. +</p><!--l. 17524--><p class="indent" > In order to prevent the “marrow” entry from being automatically being added to the glossary as a result of +the cross-reference, you can use <span id="textcolor858"><span +class="cmss-10">autoseeindex</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span></span><a + id="dx1-204008"></a> to prevent the automatic indexing triggered by the <span +class="cmtt-10">see</span><a + id="dx1-204009"></a> key +(or the <span id="textcolor859"><span id="textcolor860"><span +class="cmtt-10">seealso</span></span><a + id="dx1-204010"></a></span> key provided by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>). +</p> + <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor861"><span +class="cmtt-10">autoseeindex</span></span><span +class="cmtt-10">=false</span></strong><span +class="cmtt-10">,</span><span id="textcolor862"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor863"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> The document build is the same, but now the “marrow” and “zucchini” entries aren’t present in the +document. +<!--l. 17536--><p class="indent" > Note that the “fruit” entry is still included even though it hasn’t been used in the document. This is because +it was explicitly indexed with <span +class="cmtt-10">\glssee</span><a + id="dx1-204011"></a> not via the <span +class="cmtt-10">see</span><a + id="dx1-204012"></a> key. +</p><!--l. 17540--><p class="indent" > The entries that contains <span +class="cmtt-10">see=[\alsoname] </span>can be converted to use the <span id="textcolor864"><span id="textcolor865"><span +class="cmtt-10">seealso</span></span><a + id="dx1-204013"></a></span> key: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{apple}{name=apple,description={firm,</span><span +class="cmtt-10"> round</span><span +class="cmtt-10"> fruit},</span> +<br /><strong><span id="textcolor866"><span +class="cmtt-10">seealso</span></span><span +class="cmtt-10">={pear}</span></strong><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{marrow}{name={marrow},</span> +<br /><span +class="cmtt-10"> description={long</span><span +class="cmtt-10"> vegetable</span><span +class="cmtt-10"> with</span><span +class="cmtt-10"> thin</span><span +class="cmtt-10"> green</span><span +class="cmtt-10"> skin</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> white</span><span +class="cmtt-10"> flesh},</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor867"><span +class="cmtt-10">seealso</span></span><span +class="cmtt-10">={courgette}</span></strong><span +class="cmtt-10">}</span> + + +</div> +</div> (The provided <span +class="cmtt-10">\alsoname </span>definition may be removed.) +<!--l. 17552--><p class="indent" > The original example redefines the cross-referencing format to use <a +href="#glo:smallcaps">small caps<a + id="dx1-204014"></a></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand{\glsseeitemformat</span><a + id="dx1-204015"></a><span +class="cmtt-10">}[1]{\textsc{\glsentryname</span><a + id="dx1-204016"></a><span +class="cmtt-10">{#1}}}</span> +</div> +</div> This will still produce the desired effect with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> for this simple example but, as with +<a +href="#ex:sampleAcrDesc"><span +class="cmtt-10">sampleAcrDesc.tex</span></a>, this redefinition isn’t necessary if you have at least <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> v1.42. +<!--l. 17562--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-204017"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-204018"></a></a> then you first need to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, as +described above, but you now need the <span id="textcolor868"><span +class="cmss-10">record</span></span><a + id="dx1-204019"></a> option but no longer need the <span id="textcolor869"><span +class="cmss-10">autoseeindex</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span></span><a + id="dx1-204020"></a> option: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor870"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor871"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor872"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">]{glossaries-extra}</span> +</div> +</div> Next the entry definitions need to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-204021"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-204022"></a></a>. +<!--l. 17572--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib sample-crossref.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +If you have at least v2.0 then <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-204023"></a></a> will absorb the cross-referencing information supplied +by: + + +</p> + <div class="verbatim" id="verbatim-454"> +\glssee{fruit}{pear,apple,banana} +</div> +<!--l. 17579--><p class="nopar" > into the <span +class="cmtt-10">fruit </span>definition: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor873"><span +class="cmtt-10">@entry</span></span><a + id="dx1-204024"></a><span +class="cmtt-10">{fruit,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> see</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {pear,apple,banana},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {fruit},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {sweet,</span><span +class="cmtt-10"> fleshy</span><span +class="cmtt-10"> product</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> plant</span><span +class="cmtt-10"> containing</span><span +class="cmtt-10"> seed}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Now remove <span +class="cmtt-10">\makeglossaries </span>and all the entry definition commands (including <span +class="cmtt-10">\glssee </span>from the preamble) +and add: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor874"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-204025"></a><span +class="cmtt-10">[</span><span id="textcolor875"><span +class="cmtt-10">src</span></span><a + id="dx1-204026"></a><span +class="cmtt-10">=entries.bib]</span> +</div> +</div> Finally, replace <span +class="cmtt-10">\printglossaries </span>with <span id="textcolor876"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-204027"></a>. The document build is now: +<!--l. 17595--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-crossref + <br />bib2gls sample-crossref + <br />pdflatex sample-crossref + <br /></pre><spacer type=vertical size=10> + <br /></span> +The glossary now contains: apple, banana, courgette and pear. Note that it doesn’t contain fruit, zucchini or +marrow. +</p><!--l. 17603--><p class="indent" > Now change the selection criteria: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor877"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-204028"></a><span +class="cmtt-10">[</span><span id="textcolor878"><span +class="cmtt-10">src</span></span><a + id="dx1-204029"></a><span +class="cmtt-10">=entries.bib,</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor879"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">={recorded</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> deps</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> see}</span></strong><span +class="cmtt-10">]</span> +</div> +</div> The glossary now includes fruit, zucchini and marrow. +<!--l. 17610--><p class="indent" > The fruit and zucchini use the <span +class="cmtt-10">see</span><a + id="dx1-204030"></a> key which is a simple redirection for the reader. There’s no <a +href="#glo:numberlist">number list<a + id="dx1-204031"></a></a> +for either of these entries. Whereas marrow uses the <span id="textcolor880"><span id="textcolor881"><span +class="cmtt-10">seealso</span></span><a + id="dx1-204032"></a></span> key, which is typically intended as a +supplement to a <a +href="#glo:numberlist">number list<a + id="dx1-204033"></a></a> but in this case there are no locations as marrow hasn’t been used in the +text. +</p><!--l. 17617--><p class="indent" > With at least v2.0, there’s an alternative: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor882"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-204034"></a><span +class="cmtt-10">[</span><span id="textcolor883"><span +class="cmtt-10">src</span></span><a + id="dx1-204035"></a><span +class="cmtt-10">=entries.bib,</span> +<br /><span +class="cmtt-10"> </span><span id="textcolor884"><span +class="cmtt-10">selection</span></span><a + id="dx1-204036"></a><span +class="cmtt-10">={recorded</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> deps</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> see</span><strong><span +class="cmtt-10"> not</span><span +class="cmtt-10"> also</span></strong><span +class="cmtt-10">}]</span> +</div> +</div> In this case, the glossary includes fruit and zucchini but not marrow. +<!--l. 17625--><p class="noindent" > +</p> +<!--l. 17625--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.8 </span> <a + id="sec:samplescustomkeys"></a>Custom Keys</h3> +<a + id="x1-205001r25"></a> +<!--l. 17628--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-newkeys"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-newkeys">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-newkeys.tex" ><span +class="cmtt-10">sample-newkeys.tex</span></a></h4> +<!--l. 17628--><p class="noindent" >This document illustrates how add custom keys (using <span +class="cmtt-10">\glsaddkey</span><a + id="dx1-206001"></a>). There are two custom keys <span +class="cmtt-10">ed</span>, where the +default value is the <span +class="cmtt-10">text</span><a + id="dx1-206002"></a> field with “ed” appended, and <span +class="cmtt-10">ing</span>, where the default value is the <span +class="cmtt-10">text</span><a + id="dx1-206003"></a> field with “ing” +appended. Since the default value in both cases references the <span +class="cmtt-10">text</span><a + id="dx1-206004"></a> field, the starred version <span +class="cmtt-10">\glsaddkey*</span> +is required to ensure that the default value is expanded on definition if no alternative has been +provided. +</p><!--l. 17637--><p class="indent" > The entries are then defined as follows: + + +</p> + <div class="verbatim" id="verbatim-455"> +\newglossaryentry{jump}{name={jump},description={}} + <br />\newglossaryentry{run}{name={run},% + <br /> ed={ran},% + <br /> ing={running}, + <br /> description={}} + <br />\newglossaryentry{waddle}{name={waddle},% + <br /> ed={waddled},% + <br /> ing={waddling},% + <br /> description={}} +</div> +<!--l. 17650--><p class="nopar" > +</p><!--l. 17652--><p class="indent" > Each custom key is provided a set of commands analogous to <span +class="cmtt-10">\glsentrytext</span>, that allows the key value to +be accessed, and <span +class="cmtt-10">\glstext </span>that allows the key value to be access with indexing and hyperlinking (where +applicable). +</p><!--l. 17657--><p class="indent" > If you find yourself wanting to create a lot of custom keys that produce minor variations of existing keys +(such as different tenses) you may find it simpler to just use <span +class="cmtt-10">\glsdisp</span>. When editing the document source, it’s +usually simpler to read: + + +</p> + <div class="verbatim" id="verbatim-456"> +The dog \glsdisp{jump}{jumped} over the duck. +</div> +<!--l. 17663--><p class="nopar" > than + + +</p> + <div class="verbatim" id="verbatim-457"> +The dog \glsed{jump} over the duck. +</div> +<!--l. 17667--><p class="nopar" > +</p><!--l. 17669--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-206005"></a></a></span>If you want to convert this document to use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-206006"></a></a>, you first need to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, but +remember that you need the <span id="textcolor885"><span +class="cmss-10">record</span></span><a + id="dx1-206007"></a> option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor886"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">]</span><strong><span +class="cmtt-10">glossaries-extra</span></strong> +</div> +</div> Next convert the entry definitions to the <span +class="cmtt-10">bib</span><a + id="dx1-206008"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-206009"></a></a>: +<!--l. 17678--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --index-conversion --preamble-only sample-newkeys.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +The <span +class="cmtt-10">--index-conversion </span>switch requires at least v2.0 and will convert entries without a description (or where +the description is simply <span +class="cmtt-10">\nopostdesc</span><a + id="dx1-206010"></a> or <span id="textcolor887"><span +class="cmtt-10">\glsxtrnopostpunc</span></span><a + id="dx1-206011"></a>) to <span id="textcolor888"><span +class="cmtt-10">@index</span></span><a + id="dx1-206012"></a> instead of <span id="textcolor889"><span +class="cmtt-10">@entry</span></span><a + id="dx1-206013"></a>. This means that +the new <span +class="cmtt-10">entries.bib </span>file will contain: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor890"><span +class="cmtt-10">@index</span></span><a + id="dx1-206014"></a><span +class="cmtt-10">{jump,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {jump}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor891"><span +class="cmtt-10">@index</span></span><a + id="dx1-206015"></a><span +class="cmtt-10">{run,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> ing</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {running},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {run},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> ed</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {ran}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor892"><span +class="cmtt-10">@index</span></span><a + id="dx1-206016"></a><span +class="cmtt-10">{waddle,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> ing</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {waddling},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {waddle},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> ed</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {waddled}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Now replace <span +class="cmtt-10">\makeglossaries </span>with <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor893"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-206017"></a><span +class="cmtt-10">[</span><span id="textcolor894"><span +class="cmtt-10">src</span></span><a + id="dx1-206018"></a><span +class="cmtt-10">=entries]</span> + + +</div> +</div> and delete the <span +class="cmtt-10">\newglossaryentry </span>commands. Finally replace <span +class="cmtt-10">\printglossaries </span>with <span id="textcolor895"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-206019"></a>. +<!--l. 17710--><p class="indent" > The document build is now: +</p><!--l. 17711--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-newkeys + <br />bib2gls sample-newkeys + <br />pdflatex sample-newkeys + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note that there’s no need for the <span +class="cmss-10">nonumberlist</span><a + id="dx1-206020"></a> package option when you don’t use <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-206021"></a>’s</a> <span +class="cmtt-10">--group</span> +switch. +<a + id="x1-206022r26"></a> +</p><!--l. 17720--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-storage-abbr"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-storage-abbr">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-storage-abbr.tex" ><span +class="cmtt-10">sample-storage-abbr.tex</span></a></h4> +<!--l. 17720--><p class="noindent" >This document illustrates how add custom storage keys (using <span +class="cmtt-10">\glsaddstoragekey</span>). The document build +is: +</p><!--l. 17722--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-storage-abbr + <br />makeglossaries sample-storage-abbr + <br />pdflatex sample-storage-abbr + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 17728--><p class="indent" > The custom storage key is called <span +class="cmtt-10">abbrtype </span>which defaults to <span +class="cmtt-10">word </span>if not explicitly set. Its value can be +accessed with the provided custom command <span +class="cmtt-10">\abbrtype</span>. </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsaddstoragekey</span><a + id="dx1-207001"></a><span +class="cmtt-10">{abbrtype}{word}{\abbrtype}</span> +</div> +</div> A custom abbreviation style is then defined that checks the value of this key and makes certain adjustments +depending on whether or not its value is the default <span +class="cmtt-10">word</span>. +<!--l. 17738--><p class="indent" > This essentially forms a very similar function to the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package’s <span id="textcolor896"><span id="textcolor897"><span +class="cmtt-10">category</span></span><a + id="dx1-207002"></a></span> key, which is also +defined as a storage key: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsaddstoragekey{category}{general}{</span><span id="textcolor898"><span +class="cmtt-10">\glscategory</span></span><a + id="dx1-207003"></a><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 17745--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>This document is much simpler with the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\documentclass{article}</span> +<br /><span +class="cmtt-10">\usepackage[</span><span id="textcolor899"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +<br /><span +class="cmtt-10">\makeglossaries</span> +<br /><span id="textcolor900"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-207004"></a><span +class="cmtt-10">[</span><strong><span +class="cmtt-10">acronym</span></strong><span +class="cmtt-10">]{short-long}</span> +<br /><span +class="cmtt-10">\newacronym</span><a + id="dx1-207005"></a><span +class="cmtt-10">{radar}{radar}{radio</span><span +class="cmtt-10"> detecting</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> ranging}</span> +<br /><span +class="cmtt-10">\newacronym</span><a + id="dx1-207006"></a><span +class="cmtt-10">{laser}{laser}{light</span><span +class="cmtt-10"> amplification</span><span +class="cmtt-10"> by</span><span +class="cmtt-10"> stimulated</span> +<br /><span +class="cmtt-10">emission</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> radiation}</span> +<br /><span +class="cmtt-10">\newacronym</span><a + id="dx1-207007"></a><span +class="cmtt-10">{scuba}{scuba}{self-contained</span><span +class="cmtt-10"> underwater</span><span +class="cmtt-10"> breathing</span> +<br /><span +class="cmtt-10">apparatus}</span> +<br /> +<br /><span id="textcolor901"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-207008"></a><span +class="cmtt-10">{dsp}{DSP}{digital</span><span +class="cmtt-10"> signal</span><span +class="cmtt-10"> processing}</span> +<br /><span id="textcolor902"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-207009"></a><span +class="cmtt-10">{atm}{ATM}{automated</span><span +class="cmtt-10"> teller</span><span +class="cmtt-10"> machine}</span> +<br /> +<br /><span +class="cmtt-10">\begin{document}</span> +<br /> +<br /><span +class="cmtt-10">First</span><span +class="cmtt-10"> use:</span><span +class="cmtt-10"> \gls{radar},</span><span +class="cmtt-10"> \gls{laser},</span><span +class="cmtt-10"> \gls{scuba},</span><span +class="cmtt-10"> \gls{dsp},</span> +<br /><span +class="cmtt-10">\gls{atm}.</span> +<br /> +<br /><span +class="cmtt-10">Next</span><span +class="cmtt-10"> use:</span><span +class="cmtt-10"> \gls{radar},</span><span +class="cmtt-10"> \gls{laser},</span><span +class="cmtt-10"> \gls{scuba},</span><span +class="cmtt-10"> \gls{dsp},</span> +<br /><span +class="cmtt-10">\gls{atm}.</span> +<br /> +<br /><span +class="cmtt-10">\printglossaries</span> +<br /><span +class="cmtt-10">\end{document}</span> +</div> +</div> +<a + id="x1-207010r27"></a> +<!--l. 17774--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-storage-abbr-desc"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-storage-abbr-desc">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-storage-abbr-desc.tex" ><span +class="cmtt-10">sample-storage-abbr-desc.tex</span></a></h4> +<!--l. 17774--><p class="noindent" >An extension of the previous example where the user needs to provide a description. +<a + id="x1-208001r28"></a> +</p><!--l. 17777--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-chap-hyperfirst"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-chap-hyperfirst">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-chap-hyperfirst.tex" ><span +class="cmtt-10">sample-chap-hyperfirst.tex</span></a></h4> +<!--l. 17777--><p class="noindent" >This document illustrates how to add a custom key using <span +class="cmtt-10">\glsaddstoragekey </span>and hook into the <a +href="#sec:gls-like"><span +class="cmtt-10">\gls</span>-like</a> and +<a +href="#sec:glstext-like"><span +class="cmtt-10">\glstext</span>-like</a> mechanism used to determine whether or not to hyperlink an entry. The document build +is: +</p><!--l. 17782--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-chap-hyperfirst + + + <br />makeglossaries sample-chap-hyperfirst + <br />pdflatex sample-chap-hyperfirst + <br /></pre><spacer type=vertical size=10> + <br /></span> +This example creates a storage key called <span +class="cmtt-10">chapter </span>used to store the chapter number. </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsaddstoragekey</span><a + id="dx1-209001"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">chapter</span></strong><span +class="cmtt-10">}{0}{</span><strong><span +class="cmtt-10">\glschapnum</span></strong><span +class="cmtt-10">}</span> +</div> +</div> It’s initialised to 0 and the <span +class="cmtt-10">\glslinkpostsetkeys</span><a + id="dx1-209002"></a> hook is used to check this value against the current chapter +number. If the values are the same then the hyperlink is switched off, otherwise the key value is updated unless +the hyperlink has been switched off (through the optional argument of commands like <span +class="cmtt-10">\gls </span>and <span +class="cmtt-10">\glstext</span>). +<div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glslinkpostsetkeys</span><a + id="dx1-209003"></a><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> \edef\currentchap{\arabic{chapter}}%</span> +<br /><span +class="cmtt-10"> \ifnum\currentchap=</span><strong><span +class="cmtt-10">\glschapnum</span></strong><span +class="cmtt-10">{\glslabel}\relax</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \setkeys{glslink}{hyper=false}%</span> +<br /><span +class="cmtt-10"> \else</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsifhyperon</span><a + id="dx1-209004"></a><span +class="cmtt-10">{\glsfieldxdef</span><a + id="dx1-209005"></a><span +class="cmtt-10">{\glslabel}{</span><strong><span +class="cmtt-10">chapter</span></strong><span +class="cmtt-10">}{\currentchap}}{}%</span> +<br /><span +class="cmtt-10"> \fi</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Since this key isn’t intended for use when the entry is being defined, it would be more appropriate to simply +use an internal field that doesn’t have an associated key or helper command, but <span +class="cmtt-10">\glsfieldxdef</span><a + id="dx1-209006"></a> requires the +existence of the field. The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides utility commands designed to work on internal fields +that don’t have an associated key and may not have had a value assigned. +<!--l. 17815--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> you need to change the package loading line: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor903"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The custom storage key (provided with <span +class="cmtt-10">\glsaddstoragekey</span>) can be removed, and the <span +class="cmtt-10">\glslinkpostsetkeys</span><a + id="dx1-209007"></a> +hook can be changed to: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glslinkpostsetkeys</span><a + id="dx1-209008"></a><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> \edef\currentchap{\arabic{chapter}}%</span> +<br /><span +class="cmtt-10"> </span><strong><span id="textcolor904"><span +class="cmtt-10">\GlsXtrIfFieldEqNum</span></span><a + id="dx1-209009"></a><span +class="cmtt-10">*</span></strong><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">chapter</span></strong><span +class="cmtt-10">}{\glslabel}{\currentchap}</span> + + +<br /><span +class="cmtt-10"> {%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \setkeys{glslink}{hyper=false}%</span> +<br /><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10"> {%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsifhyperon</span><a + id="dx1-209010"></a><span +class="cmtt-10">{</span><strong><span id="textcolor905"><span +class="cmtt-10">\xGlsXtrSetField</span></span><a + id="dx1-209011"></a></strong><span +class="cmtt-10">{\glslabel}{</span><strong><span +class="cmtt-10">chapter</span></strong><span +class="cmtt-10">}{\currentchap}}{}%</span> +<br /><span +class="cmtt-10"> }%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> The field name is still called <span +class="cmtt-10">chapter </span>but there’s no longer an associated key or command. +<!--l. 17838--><p class="noindent" > +</p> +<!--l. 17838--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.9 </span> <a + id="sec:samplesxindy"></a>Xindy (Option 3)</h3> +<!--l. 17841--><p class="noindent" >Most of the earlier <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-210001"></a></a> sample files can be adapted to use <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-210002"></a></a> instead by adding the <span +class="cmss-10">xindy</span><a + id="dx1-210003"></a> package +option. Situations that you need to be careful about are when the sort value (obtained from the <span +class="cmtt-10">name</span><a + id="dx1-210004"></a> if the <span +class="cmtt-10">sort</span><a + id="dx1-210005"></a> +key is omitted) contains commands (such as <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">name={\pi}</span></span></span>) or is identical to another value (or is identical after +<a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-210006"></a></a> has stripped all commands and braces). This section describes sample documents that use features which +are unavailable with <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-210007"></a></a>. +<a + id="x1-210008r29"></a> +</p><!--l. 17850--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:samplexdy"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:samplexdy">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/samplexdy.tex" ><span +class="cmtt-10">samplexdy.tex</span></a></h4> +<!--l. 17850--><p class="noindent" >The document uses UTF8 encoding (with the <span +class="cmss-10">inputenc</span><a + id="dx1-211001"></a> package). This is information that needs to be passed to +<a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211002"></a></a>, so the encoding is picked up by <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-211003"></a></a> from the <span +class="cmtt-10">aux</span><a + id="dx1-211004"></a> file. +</p><!--l. 17855--><p class="indent" > By default, this document will create a <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211005"></a></a> style file called <span +class="cmtt-10">samplexdy.xdy</span>, but if you uncomment the +lines + + +</p> + <div class="verbatim" id="verbatim-458"> +\setStyleFile{samplexdy-mc} + <br />\noist + <br />\GlsSetXdyLanguage{} +</div> +<!--l. 17861--><p class="nopar" > it will set the style file to <span +class="cmtt-10">samplexdy-mc.xdy </span>instead. This provides an additional letter group for entries +starting with “Mc” or “Mac”. If you use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-211006"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-211007"></a></a>, you don’t need to supply +any additional information. If you don’t use <span +class="cmtt-10">makeglossaries</span><a + id="dx1-211008"></a>, you will need to specify the required +information. Note that if you set the style file to <span +class="cmtt-10">samplexdy-mc.xdy </span>you must also specify <span +class="cmtt-10">\noist</span><a + id="dx1-211009"></a>, +otherwise the <span +class="cmss-10">glossaries </span>package will overwrite <span +class="cmtt-10">samplexdy-mc.xdy </span>and you will lose the “Mc” letter +group. +</p><!--l. 17874--><p class="indent" > To create the document do: +</p><!--l. 17875--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplexdy + <br />makeglossaries samplexdy + <br />pdflatex samplexdy + <br /></pre><spacer type=vertical size=10> + <br /></span> +If you don’t have Perl installed then you can’t use <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-211010"></a></a>, but you also can’t use <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211011"></a></a>! However, if +for some reason you want to call <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211012"></a></a> explicitly instead of using <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-211013"></a></a> (or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-211014"></a></a>): +</p> + <ul class="itemize1"> + <li class="itemize">if you are using the default style file <span +class="cmtt-10">samplexdy.xdy</span>, then do (no line breaks): + <!--l. 17888--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + </p></li> + <li class="itemize">if you are using <span +class="cmtt-10">samplexdy-mc.xdy</span>, then do (no line breaks): + <!--l. 17893--><p class="noindent" ><spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> + </p></li></ul> +<!--l. 17898--><p class="indent" > This document creates a new command to use with the <span +class="cmtt-10">format</span><a + id="dx1-211015"></a> key in the optional argument of commands +like <span +class="cmtt-10">\gls </span>to format the location in the <a +href="#glo:numberlist">number list<a + id="dx1-211016"></a></a>. The usual type of definition when a hyperlinked location is +required should use one of the <span +class="cmtt-10">\hyper</span>⟨<span +class="cmitt-10">xx</span>⟩<a + id="dx1-211017"></a> commands listed in <a +href="#tab:hyperxx">table 6.1</a>: + + +</p> + <div class="verbatim" id="verbatim-459"> +\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} +</div> +<!--l. 17906--><p class="nopar" > Unfortunately, this definition doesn’t work for this particular document and some adjustments are needed (see +below). As a result of the adjustments, this command doesn’t actually get used by <span class="TEX">T<span +class="E">E</span>X</span>, even though +<span +class="cmtt-10">hyperbfit </span>is used in the <span +class="cmtt-10">format</span><a + id="dx1-211018"></a> key. It does, however, need to be identified as an attribute so that <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211019"></a></a> can +recognise it: + + +</p> + <div class="verbatim" id="verbatim-460"> +\GlsAddXdyAttribute{hyperbfit} +</div> +<!--l. 17915--><p class="nopar" > This will add information to the <span +class="cmtt-10">xdy</span><a + id="dx1-211020"></a> file when it’s created by <span +class="cmtt-10">\makeglossaries</span>. If you prevent the creation of +this file with <span +class="cmtt-10">\noist</span><a + id="dx1-211021"></a> then you will need to add the attribute to your custom <span +class="cmtt-10">xdy</span><a + id="dx1-211022"></a> file (see the provided +<span +class="cmtt-10">samplexdy-mc.xdy </span>file). +</p><!--l. 17922--><p class="indent" > In order to illustrate unusual location formats, this sample document provides a command called +<span +class="cmtt-10">\tallynum{</span>⟨<span +class="cmti-10">n</span>⟩<span +class="cmtt-10">} </span>that represents its numerical argument with a die or dice where the dots add up to +⟨<span +class="cmti-10">n</span>⟩: + + +</p> + <div class="verbatim" id="verbatim-461"> +\newrobustcmd*{\tallynum}[1]{% + <br /> \ifnum\number#1<7 + <br />  $\csname dice\romannumeral#1\endcsname$% + <br /> \else + <br />  $\dicevi$% + <br />  \expandafter\tallynum\expandafter{\numexpr#1-6}% + <br /> \fi + <br />} +</div> +<!--l. 17934--><p class="nopar" > This command needs to be robust to prevent it from being expanded when it’s written to any of the auxiliary +files. The <span +class="cmtt-10">\dicei</span><a + id="dx1-211023"></a>, …, <span +class="cmtt-10">\dicevi </span>commands are provided by the <span +class="cmss-10">stix</span><a + id="dx1-211024"></a> package, so that needs to be +loaded. +</p><!--l. 17940--><p class="indent" > An associated command <span +class="cmtt-10">\tally{</span>⟨<span +class="cmti-10">counter</span>⟩<span +class="cmtt-10">} </span>is defined that formats the value of the named ⟨<span +class="cmti-10">counter</span>⟩ according +to <span +class="cmtt-10">\tallynum</span>: + + +</p> + <div class="verbatim" id="verbatim-462"> +\newcommand*{\tally}[1]{\tallynum{\arabic{#1}}} +</div> +<!--l. 17945--><p class="nopar" > (This shouldn’t be robust as it needs the counter value to expand.) The page numbers are altered to use this +format (by redefining <span +class="cmtt-10">\thepage</span><a + id="dx1-211025"></a>). +</p><!--l. 17949--><p class="indent" > This custom location format also needs to be identified in the <span +class="cmtt-10">xdy</span><a + id="dx1-211026"></a> file so that <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211027"></a></a> can recognise it and +determine how to form ranges if required. + + +</p> + <div class="verbatim" id="verbatim-463"> +\GlsAddXdyLocation{tally}{% tally location format + <br /> :sep "\string\tallynum\space\glsopenbrace" + <br /> "arabic-numbers" + <br /> :sep "\glsclosebrace" + <br />} +</div> +<!--l. 17958--><p class="nopar" > Again this information is written to the <span +class="cmtt-10">xdy</span><a + id="dx1-211028"></a> file by <span +class="cmtt-10">\makeglossaries </span>so if you use <span +class="cmtt-10">\noist </span>then you need to +manually add it to your custom <span +class="cmtt-10">xdy</span><a + id="dx1-211029"></a> file. +</p><!--l. 17963--><p class="indent" > When <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211030"></a></a> creates the associated glossary files, the locations will be written using: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsX</span>⟨<span +class="cmitt-10">counter</span>⟩<span +class="cmtt-10">X</span>⟨<span +class="cmitt-10">format</span>⟩<a + id="dx1-211031"></a><span +class="cmtt-10">{</span>⟨<span +class="cmitt-10">hyper-prefix</span>⟩<span +class="cmtt-10">}{</span>⟨<span +class="cmitt-10">location</span>⟩<span +class="cmtt-10">}</span> +</div> +</div> In this case: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsXpageXglsnumberformat{}{\tallynum{</span>⟨<span +class="cmitt-10">number</span>⟩<span +class="cmtt-10">}}</span> +</div> +</div> or <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\glsXpageXhyperbfit{}{\tallynum{</span>⟨<span +class="cmitt-10">number</span>⟩<span +class="cmtt-10">}}</span> +</div> +</div> This means that although <span +class="cmtt-10">\hyperbf </span>is designed to create hyperlinked locations, the presence of <span +class="cmtt-10">\tallynum</span> +interferes with it. In order to make the hyperlinks work correctly, the definitions of <span +class="cmtt-10">\glsXpageXhyperbfit </span>need +to be redefined in order to grab the number part in order to work out the location’s numeric value. +If the value of <span +class="cmtt-10">\tally </span>is changed so that it expands differently then these modifications won’t +work. +<!--l. 17985--><p class="indent" > Remember that in both cases, the second argument <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">#2</span></span></span> is in the form <span +class="cmtt-10">\tally{</span>⟨<span +class="cmti-10">n</span>⟩<span +class="cmtt-10">}</span>: + + +</p> + <div class="verbatim" id="verbatim-464"> +\renewcommand{\glsXpageXglsnumberformat}[2]{% + <br /> \linkpagenumber#2% + <br />} + <br />\renewcommand{\glsXpageXhyperbfit}[2]{% + <br /> \textbf{\em\linkpagenumber#2}% + <br />} +</div> +<!--l. 17994--><p class="nopar" > These need a command that can grab the actual number and correctly encapsulate it: + + +</p> + <div class="verbatim" id="verbatim-465"> +\newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} +</div> +<!--l. 17999--><p class="nopar" > +</p><!--l. 18001--><p class="indent" > If you want to try out the <span +class="cmtt-10">samplexdy-mc.xdy </span>file, the entries starting with “Mac” or “Mc” will be placed in +their own “Mc” letter group. Ideally it should be possible to do this simply with <span +class="cmtt-10">\GlsAddLetterGroup</span><a + id="dx1-211032"></a> (and not +require a custom <span +class="cmtt-10">xdy</span><a + id="dx1-211033"></a> file) but unfortunately the “M” letter group will have already been defined and take +precedence over “Mc”, which is why a custom file is required and the normal language module must be +suppressed: + + +</p> + <div class="verbatim" id="verbatim-466"> +\setStyleFile{samplexdy-mc} + <br />\noist + <br />\GlsSetXdyLanguage{} +</div> +<!--l. 18013--><p class="nopar" > +</p><!--l. 18015--><p class="indent" > This “Mc” group is suitable for names like “Maclaurin” but not for “Mach”. To prevent this, the <span +class="cmtt-10">sort</span><a + id="dx1-211034"></a> key +for that value is set to lower case: + + +</p> + <div class="verbatim" id="verbatim-467"> +\newglossaryentry{mach}{name={Mach, Ernst}, + <br />first={Ernst Mach},text={Mach}, + <br />sort={mach, Ernst}, + <br />description={Czech/Austrian physicist and philosopher}} +</div> +<!--l. 18023--><p class="nopar" > +</p><!--l. 18025--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211035"></a></a></span>If you want to convert this document so that it uses <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211036"></a></a>, you first need to switch to +<a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> and use the <span id="textcolor906"><span +class="cmss-10">record</span></span><a + id="dx1-211037"></a> package option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor907"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor908"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211038"></a></a>-only commands can now all be removed (attribute <span +class="cmtt-10">\GlsAddXdyAttribute</span>, location +<span +class="cmtt-10">\GlsAddXdyLocation</span>, language <span +class="cmtt-10">\GlsSetXdyLanguage</span>, location encapsulators <span +class="cmtt-10">\glsX</span>⟨<span +class="cmitt-10">counter</span>⟩<span +class="cmtt-10">X</span>⟨<span +class="cmitt-10">format</span>⟩<a + id="dx1-211039"></a> and the +custom helper <span +class="cmtt-10">\linkpagenumber</span>). Also <span +class="cmtt-10">\noist </span>and <span +class="cmtt-10">\setStyleFile </span>aren’t relevant with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211040"></a></a> and so should +be removed. +<!--l. 18040--><p class="indent" > The definitions of <span +class="cmtt-10">\hyperbfit </span>should be retained (as well as <span +class="cmtt-10">\tallynum</span>, <span +class="cmtt-10">\tally </span>and the redefinition of +<span +class="cmtt-10">\thepage</span>). +</p><!--l. 18043--><p class="indent" > The entries all need to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-211041"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211042"></a></a>. +</p><!--l. 18045--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only samplexdy.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Next replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor909"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-211043"></a><span +class="cmtt-10">[</span><span id="textcolor910"><span +class="cmtt-10">src</span></span><a + id="dx1-211044"></a><span +class="cmtt-10">=entries]</span> +</div> +</div> and remove all the entry definitions from the preamble. Use the search and replace function on your text editor +to replace all instances of <span +class="cmtt-10">\glsentryfirst</span><a + id="dx1-211045"></a> with <span id="textcolor911"><span +class="cmtt-10">\glsfmtfirst</span></span><a + id="dx1-211046"></a>, and all instances of <span +class="cmtt-10">\glsentryname</span><a + id="dx1-211047"></a> with +<span id="textcolor912"><span +class="cmtt-10">\glsfmtname</span></span><a + id="dx1-211048"></a>. +<!--l. 18057--><p class="indent" > Finally, replace <span +class="cmtt-10">\printglossaries</span><a + id="dx1-211049"></a> with <span id="textcolor913"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-211050"></a>. The document build is now: +</p><!--l. 18059--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplexdy + <br />bib2gls --group samplexdy + <br />pdflatex samplexdy + <br /></pre><spacer type=vertical size=10> + <br /></span> + + +</p><!--l. 18065--><p class="indent" > This results in a slightly different ordering from the original document (without the “Mc” letter group). In +the original example, “Mach number” was listed before “Mach, Ernest”. The modified document now has +“Mach, Ernest” before “Mach number”. This difference is due to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211051"></a>’s</a> default <span id="textcolor914"><span +class="cmtt-10">break-at</span></span><span +class="cmtt-10">=word</span><a + id="dx1-211052"></a> setting, +which marks word boundaries with the pipe (<span +class="cmtt-10">|</span>) character, so the sort values for <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211053"></a></a> are <span +class="cmtt-10">Mach|Earnest|</span> +and <span +class="cmtt-10">Mach|number|</span>. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211054"></a></a> manual for further details of this option, and also see the +examples chapter of that manual for alternative approaches when creating entries that contain people’s +names. +</p><!--l. 18077--><p class="indent" > If you want the “Mc” letter group, it can be obtained by providing a custom sort rule: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor915"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-211055"></a><span +class="cmtt-10">[</span><span id="textcolor916"><span +class="cmtt-10">src</span></span><a + id="dx1-211056"></a><span +class="cmtt-10">=entries,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor917"><span +class="cmtt-10">sort</span></span><a + id="dx1-211057"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">custom</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor918"><span +class="cmtt-10">sort-rule</span></span></strong><span +class="cmtt-10">={</span><span id="textcolor919"><span +class="cmtt-10">\glsxtrcontrolrules</span></span><a + id="dx1-211058"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> ;</span><span id="textcolor920"><span +class="cmtt-10">\glsxtrspacerules</span></span><a + id="dx1-211059"></a><span +class="cmtt-10">;</span><span id="textcolor921"><span +class="cmtt-10">\glsxtrnonprintablerules</span></span><a + id="dx1-211060"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> ;</span><span id="textcolor922"><span +class="cmtt-10">\glsxtrcombiningdiacriticrules</span></span><a + id="dx1-211061"></a><span +class="cmtt-10">,</span><span id="textcolor923"><span +class="cmtt-10">\glsxtrhyphenrules</span></span><a + id="dx1-211062"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <</span><span id="textcolor924"><span +class="cmtt-10">\glsxtrgeneralpuncrules</span></span><a + id="dx1-211063"></a><span +class="cmtt-10"><</span><span id="textcolor925"><span +class="cmtt-10">\glsxtrdigitrules</span></span><a + id="dx1-211064"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <a,A<b,B<c,C<d,D<e,E<f,F<g,G<h,H<i,I<j,J<k,K<l,L</span><strong><span +class="cmtt-10"><Mc=Mac</span></strong><span +class="cmtt-10"><m,M<o,O</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <p,P<q,Q<r,R<s,S<t,T<u,U<v,V<r,R<s,S<t,T<u,U<v,V<w,W<x,X<y,Y<z,Z</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }</span> +<br /><span +class="cmtt-10">]</span> +</div> +</div> Unfortunately, as with <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-211065"></a></a>, this puts “Mach” into the “Mc” letter group. +<!--l. 18094--><p class="indent" > One way to get around this problem is to define a custom command to help identify genuine “Mc”/“Mac” +prefixes with names that happen to start with “Mac”. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor926"><span +class="cmtt-10">@entry</span></span><a + id="dx1-211066"></a><span +class="cmtt-10">{mcadam,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {</span><strong><span +class="cmtt-10">\Mac{Mc}</span></strong><span +class="cmtt-10">Adam,</span><span +class="cmtt-10"> John</span><span +class="cmtt-10"> Loudon},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Scottish</span><span +class="cmtt-10"> engineer},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {McAdam},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> first</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {John</span><span +class="cmtt-10"> Loudon</span><span +class="cmtt-10"> McAdam}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor927"><span +class="cmtt-10">@entry</span></span><a + id="dx1-211067"></a><span +class="cmtt-10">{maclaurin,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {</span><strong><span +class="cmtt-10">\Mac{Mac}</span></strong><span +class="cmtt-10">laurin,</span><span +class="cmtt-10"> Colin},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> ={Scottish</span><span +class="cmtt-10"> mathematician</span><span +class="cmtt-10"> best</span><span +class="cmtt-10"> known</span><span +class="cmtt-10"> for</span><span +class="cmtt-10"> the</span> +<br /><span +class="cmtt-10">\gls{maclaurinseries}},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Maclaurin},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> first</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Colin</span><span +class="cmtt-10"> Maclaurin}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> but not for “Mach”: <div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor928"><span +class="cmtt-10">@entry</span></span><a + id="dx1-211068"></a><span +class="cmtt-10">{mach,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Mach,</span><span +class="cmtt-10"> Ernst},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Czech/Austrian</span><span +class="cmtt-10"> physicist</span><span +class="cmtt-10"> and</span><span +class="cmtt-10"> philosopher},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> text</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Mach},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> first</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {Ernst</span><span +class="cmtt-10"> Mach}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> With <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span>, this command should simply do its argument: + + + <div class="verbatim" id="verbatim-468"> +\newcommand{\Mac}[1]{#1} +</div> +<!--l. 18125--><p class="nopar" > However, when <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211069"></a></a> works out the <span +class="cmtt-10">sort</span><a + id="dx1-211070"></a> value, it needs to be defined with something unique that won’t +happen to occur at the start of another term. For example: + + +</p> + <div class="verbatim" id="verbatim-469"> +\providecommand{\Mac}[1]{MC} +</div> +<!--l. 18131--><p class="nopar" > (Remember that <span id="textcolor929"><span +class="cmtt-10">break-at</span></span><span +class="cmtt-10">=word</span><a + id="dx1-211071"></a> will strip spaces and punctuation so don’t include them unless you switch to +<span id="textcolor930"><span +class="cmtt-10">break-at</span></span><span +class="cmtt-10">=none</span><a + id="dx1-211072"></a>.) +</p><!--l. 18136--><p class="indent" > So add the first definition of <span +class="cmtt-10">\Mac </span>to the <span +class="cmtt-10">tex</span><a + id="dx1-211073"></a> file and modify <span +class="cmtt-10">entries.bib </span>so that it includes the second +definition: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor931"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-211074"></a><span +class="cmtt-10">{"\providecommand{\Mac}[1]{MC}"}</span> +</div> +</div> Then modify the “Mc”/“Mac” entries as appropriate (see the above “McAdam” and “Maclaurin” +examples). +<!--l. 18144--><p class="indent" > The custom sort rule needs to be modified: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor932"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-211075"></a><span +class="cmtt-10">[</span><span id="textcolor933"><span +class="cmtt-10">src</span></span><a + id="dx1-211076"></a><span +class="cmtt-10">=entries,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span id="textcolor934"><span +class="cmtt-10">write-preamble</span></span><span +class="cmtt-10">=false,</span></strong> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor935"><span +class="cmtt-10">sort</span></span><a + id="dx1-211077"></a><span +class="cmtt-10">=custom,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span id="textcolor936"><span +class="cmtt-10">sort-rule</span></span><a + id="dx1-211078"></a><span +class="cmtt-10">={</span><span id="textcolor937"><span +class="cmtt-10">\glsxtrcontrolrules</span></span><a + id="dx1-211079"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> ;</span><span id="textcolor938"><span +class="cmtt-10">\glsxtrspacerules</span></span><a + id="dx1-211080"></a><span +class="cmtt-10">;</span><span id="textcolor939"><span +class="cmtt-10">\glsxtrnonprintablerules</span></span><a + id="dx1-211081"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> ;</span><span id="textcolor940"><span +class="cmtt-10">\glsxtrcombiningdiacriticrules</span></span><a + id="dx1-211082"></a><span +class="cmtt-10">,</span><span id="textcolor941"><span +class="cmtt-10">\glsxtrhyphenrules</span></span><a + id="dx1-211083"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <</span><span id="textcolor942"><span +class="cmtt-10">\glsxtrgeneralpuncrules</span></span><a + id="dx1-211084"></a><span +class="cmtt-10"><</span><span id="textcolor943"><span +class="cmtt-10">\glsxtrdigitrules</span></span><a + id="dx1-211085"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <a,A<b,B<c,C<d,D<e,E<f,F<g,G<h,H<i,I<j,J<k,K<l,L</span><strong><span +class="cmtt-10"><MC</span></strong><span +class="cmtt-10"><m,M<o,O</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> <p,P<q,Q<r,R<s,S<t,T<u,U<v,V<r,R<s,S<t,T<u,U<v,V<w,W<x,X<y,Y<z,Z</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><span +class="cmtt-10"> }</span> +<br /><span +class="cmtt-10">]</span> +</div> +</div> This will create a “Mc” letter group that only includes the names that start with the custom <span +class="cmtt-10">\Mac</span> +command. +<!--l. 18161--><p class="indent" > Other alternatives include moving <span id="textcolor944"><span +class="cmtt-10">@preamble</span></span><a + id="dx1-211086"></a> into a separate <span +class="cmtt-10">bib</span><a + id="dx1-211087"></a> file, so that you can choose +whether or not to include it. See the “Examples” chapter of the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-211088"></a></a> user manual for further +examples. +<a + id="x1-211089r30"></a> +</p><!--l. 18166--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:samplexdy2"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:samplexdy2">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/samplexdy2.tex" ><span +class="cmtt-10">samplexdy2.tex</span></a></h4> +<!--l. 18166--><p class="noindent" >This document illustrates how to use the <span +class="cmss-10">glossaries </span>package where the location numbers don’t follow a standard +format. This example will only work with <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-212001"></a></a>. To create the document do: + + +</p><!--l. 18170--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplexdy2 + <br />makeglossaries samplexdy2 + <br />pdflatex samplexdy2 + <br /></pre><spacer type=vertical size=10> + <br /></span> +The explicit <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-212002"></a></a> call is: +</p><!--l. 18176--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> +This example uses the <span +class="cmtt-10">section </span>counter with <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-212003"></a></a>: + + +</p> + <div class="verbatim" id="verbatim-470"> +\usepackage[xindy,counter=section]{glossaries} +</div> +<!--l. 18182--><p class="nopar" > The document employs an eccentric section numbering system for illustrative purposes. The section numbers +are prefixed by the chapter number in square brackets: + + +</p> + <div class="verbatim" id="verbatim-471"> +\renewcommand*{\thesection}{[\thechapter]\arabic{section}} +</div> +<!--l. 18188--><p class="nopar" > Parts use Roman numerals: + + +</p> + <div class="verbatim" id="verbatim-472"> +\renewcommand*{\thepart}{\Roman{part}} +</div> +<!--l. 18192--><p class="nopar" > The section hyperlink name includes the part: + + +</p> + <div class="verbatim" id="verbatim-473"> +\renewcommand*{\theHsection}{\thepart.\thesection} +</div> +<!--l. 18196--><p class="nopar" > This custom numbering scheme needs to be identified in the <span +class="cmtt-10">xdy</span><a + id="dx1-212004"></a> file: + + +</p> + <div class="verbatim" id="verbatim-474"> +\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "[" + <br />  "arabic-numbers" :sep "]" "arabic-numbers" + <br />} +</div> +<!--l. 18203--><p class="nopar" > If the part is 0 then <span +class="cmtt-10">\thepart </span>will be empty (there isn’t a zero Roman numeral). An extra case is needed to +catch this: + + +</p> + <div class="verbatim" id="verbatim-475"> +\GlsAddXdyLocation{zero.section}{:sep "[" + <br />  "arabic-numbers" :sep "]" "arabic-numbers" + <br />} +</div> +<!--l. 18210--><p class="nopar" > Note that this will stop xindy giving a warning, but the location hyperlinks will be invalid if no <span +class="cmtt-10">\part </span>is +used. +</p><!--l. 18214--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-212005"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-212006"></a></a>, you first need to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> but remember to use +<span id="textcolor945"><span +class="cmss-10">record</span></span><a + id="dx1-212007"></a> instead of <span +class="cmss-10">xindy</span><a + id="dx1-212008"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor946"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,counter=section]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Next remove the <span +class="cmtt-10">\GlsAddXdyLocation </span>commands and convert the entry definitions to the <span +class="cmtt-10">bib</span><a + id="dx1-212009"></a> format required +by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-212010"></a></a>: +<!--l. 18224--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only samplexdy2.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Now replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor947"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-212011"></a><span +class="cmtt-10">[</span><span id="textcolor948"><span +class="cmtt-10">src</span></span><a + id="dx1-212012"></a><span +class="cmtt-10">=entries]</span> +</div> +</div> and remove the <span +class="cmtt-10">\newglossaryentry </span>commands. Finally, replace <span +class="cmtt-10">\printglossaries </span>with +<span id="textcolor949"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-212013"></a>. +<!--l. 18234--><p class="indent" > The document build is: +</p><!--l. 18235--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex samplexdy2 + <br />bib2gls samplexdy2 + <br />pdflatex samplexdy2 + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 18241--><p class="indent" > With unusual numbering systems, it’s sometimes better to use <span id="textcolor950"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-212014"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor951"><span +class="cmtt-10">record</span></span><span +class="cmtt-10">=nameref</span></strong><span +class="cmtt-10">,counter=section]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> + + +</div> +</div> In this case, the locations will be the actual section headings, rather than the section number. In order to make +the number appear instead you need to define: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand*{</span><span id="textcolor952"><span +class="cmtt-10">\glsxtrsectionlocfmt</span></span><a + id="dx1-212015"></a><span +class="cmtt-10">}[2]{#1}</span> +</div> +</div> (Make sure you have at least v1.42 of <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>.) See also the earlier <a +href="#ex:sampleSec"><span +class="cmtt-10">sampleSec.tex</span></a>. +<a + id="x1-212016r31"></a> +<!--l. 18254--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:samplexdy3"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:samplexdy3">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/samplexdy3.tex" ><span +class="cmtt-10">samplexdy3.tex</span></a></h4> +<!--l. 18254--><p class="noindent" >This document is very similar to <a +href="#ex:samplexdy"><span +class="cmtt-10">samplexdy.tex</span></a> but uses the command <span +class="cmtt-10">\Numberstring </span>from the +<span +class="cmss-10">fmtcount</span><a + id="dx1-213001"></a> package to format the page numbers instead of the <span +class="cmtt-10">\tally </span>command from the earlier +example. +<a + id="x1-213002r32"></a> +</p><!--l. 18259--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleutf8"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleutf8">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleutf8.tex" ><span +class="cmtt-10">sampleutf8.tex</span></a></h4> +<!--l. 18259--><p class="noindent" >This is another example that uses <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-214001"></a></a>. Unlike <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-214002"></a></a>, <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-214003"></a></a> can cope with <a +href="#glo:nonlatinchar">non-Latin character<a + id="dx1-214004"></a>s</a>. This +document uses UTF-8 encoding. To create the document do: +</p><!--l. 18263--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleutf8 + <br />makeglossaries sampleutf8 + <br />pdflatex sampleutf8 + <br /></pre><spacer type=vertical size=10> + <br /></span> +The explicit <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-214005"></a></a> call is (no line breaks): +</p><!--l. 18270--><p class="indent" > +<spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> +<br />xindy +-L +english +-C +utf8 +-I +xindy +-M +sampleutf8 +-t + + +sampleutf8.glg +-o +sampleutf8.gls +sampleutf8.glo +<br /></pre><spacer type=vertical size=10> +<br /></span> +</p><!--l. 18274--><p class="indent" > If you remove the <span +class="cmss-10">xindy</span><a + id="dx1-214006"></a> option from <span +class="cmtt-10">sampleutf8.tex </span>and do: +</p><!--l. 18276--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleutf8 + <br />makeglossaries sampleutf8 + <br />pdflatex sampleutf8 + <br /></pre><spacer type=vertical size=10> + <br /></span> +or +</p><!--l. 18282--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleutf8 + <br />makeglossaries-lite sampleutf8 + <br />pdflatex sampleutf8 + <br /></pre><spacer type=vertical size=10> + <br /></span> +you will see that the entries that start with an <a +href="#glo:exlatinchar">extended Latin character<a + id="dx1-214007"></a></a> now appear in the symbols group, and +the word “manœuvre” is now after “manor” instead of before it. If you want to explicitly call <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-214008"></a></a> (no +line breaks): +</p><!--l. 18291--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 18295--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214009"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214010"></a></a>, you first need to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> but replace <span +class="cmss-10">xindy</span><a + id="dx1-214011"></a> with +<span id="textcolor953"><span +class="cmss-10">record</span></span><a + id="dx1-214012"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor954"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor955"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,</span><span id="textcolor956"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,style=listgroup]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Note that you don’t need the <span +class="cmss-10">nonumberlist</span><a + id="dx1-214013"></a> option with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214014"></a></a>. You can instruct <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214015"></a></a> to +simply not save the <a +href="#glo:numberlist">number list<a + id="dx1-214016"></a>s</a>, but in this case there won’t be any locations as there’s no actual +indexing. +<!--l. 18307--><p class="indent" > The entries need to be converted to the <span +class="cmtt-10">bib</span><a + id="dx1-214017"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214018"></a></a>: +</p><!--l. 18309--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only --texenc UTF-8 --bibenc UTF-8 sampleutf8.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note the first line of the <span +class="cmtt-10">entries.bib </span>file: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">%</span><span +class="cmtt-10"> Encoding:</span><span +class="cmtt-10"> UTF-8</span> +</div> +</div> This is the encoding of the <span +class="cmtt-10">bib</span><a + id="dx1-214019"></a> file. It doesn’t have to match the encoding of the <span +class="cmtt-10">tex</span><a + id="dx1-214020"></a> file, but it’s generally +better to be consistent. When <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214021"></a></a> parses this file, it will look for this encoding line. (If the <span +class="cmtt-10">--texenc </span>and +<span +class="cmtt-10">--bibenc </span>switches aren’t used, <a +href="#glo:convertgls2bib"><span +class="cmtt-10">convertgls2bib</span><a + id="dx1-214022"></a></a> will assume your system’s default encoding. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214023"></a></a> +manual for further details.) +<!--l. 18324--><p class="indent" > Next replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor957"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-214024"></a><span +class="cmtt-10">[</span><span id="textcolor958"><span +class="cmtt-10">src</span></span><a + id="dx1-214025"></a><span +class="cmtt-10">=entries,</span><span id="textcolor959"><span +class="cmtt-10">selection</span></span><a + id="dx1-214026"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">all</span></strong><span +class="cmtt-10">]</span> +</div> +</div> and remove all the <span +class="cmtt-10">\newglossaryentry </span>commands. +<!--l. 18330--><p class="indent" > Iterative commands like <span +class="cmtt-10">\glsaddall</span><a + id="dx1-214027"></a> don’t work with <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214028"></a></a>. Instead, you can select all entries using the +<span id="textcolor960"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">=all</span><a + id="dx1-214029"></a> option. This is actually better than <span +class="cmtt-10">\glsaddall</span>, which enforces the selection of all entries by +indexing each entry. As a result, with <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-214030"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-214031"></a></a> (and <a +href="#option1">Option 1</a>), every entry will have the same +location (which is the location of the <span +class="cmtt-10">\glsaddall </span>command, in this case page 1). With <span id="textcolor961"><span +class="cmtt-10">selection</span></span><span +class="cmtt-10">=all</span><a + id="dx1-214032"></a>, +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214033"></a></a> will automatically selection all entries even if they don’t have any records (indexing information) so in +this case there are no <a +href="#glo:numberlist">number list<a + id="dx1-214034"></a>s</a>. +</p><!--l. 18342--><p class="indent" > Finally, replace <span +class="cmtt-10">\printglossaries </span>with <span id="textcolor962"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-214035"></a>. The build process is now: +</p><!--l. 18344--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sampleutf8 + <br />bib2gls --group sampleutf8 + <br />pdflatex sampleutf8 + <br /></pre><spacer type=vertical size=10> + <br /></span> +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214036"></a></a> picks up the encoding of the <span +class="cmtt-10">tex</span><a + id="dx1-214037"></a> file from the <span +class="cmtt-10">aux</span><a + id="dx1-214038"></a> file: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor963"><span +class="cmtt-10">\glsxtr@texencoding</span></span><a + id="dx1-214039"></a><span +class="cmtt-10">{utf8}</span> +</div> +</div> If you experience any encoding issues, check the <span +class="cmtt-10">aux</span><a + id="dx1-214040"></a> file for this command and check the <span +class="cmtt-10">bib</span><a + id="dx1-214041"></a> file for the +encoding comment line. Also check <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214042"></a>’s</a> <span +class="cmtt-10">glg</span><a + id="dx1-214043"></a> transcript file for encoding messages, which should look +like: + + + <div class="verbatim" id="verbatim-476"> +TeX character encoding: UTF-8 +</div> +<!--l. 18360--><p class="nopar" > +</p><!--l. 18362--><p class="indent" > The document language, if it has been set, is also added to the <span +class="cmtt-10">aux</span><a + id="dx1-214044"></a> file when the <span +class="cmss-10">record</span><a + id="dx1-214045"></a> option is used. In +this case, no language package has been used, so <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-214046"></a></a> will fallback on the system’s default locale. If no sort +method is set, the entries will be sorted according to the document language, if set, or the default +locale. You can specify a specific locale using the <span id="textcolor964"><span +class="cmtt-10">sort</span></span><a + id="dx1-214047"></a> key with a locale tag identifier. For example: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor965"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-214048"></a><span +class="cmtt-10">[</span><span id="textcolor966"><span +class="cmtt-10">src</span></span><a + id="dx1-214049"></a><span +class="cmtt-10">=entries,</span><span id="textcolor967"><span +class="cmtt-10">selection</span></span><a + id="dx1-214050"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">all</span></strong><span +class="cmtt-10">,</span><strong><span id="textcolor968"><span +class="cmtt-10">sort</span></span><span +class="cmtt-10">=de-CH-1996</span></strong><span +class="cmtt-10">]</span> +</div> +</div> (Swiss German new orthography) or: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor969"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-214051"></a><span +class="cmtt-10">[</span><span id="textcolor970"><span +class="cmtt-10">src</span></span><a + id="dx1-214052"></a><span +class="cmtt-10">=entries,</span><span id="textcolor971"><span +class="cmtt-10">selection</span></span><a + id="dx1-214053"></a><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">all</span></strong><span +class="cmtt-10">,</span><strong><span id="textcolor972"><span +class="cmtt-10">sort</span></span><span +class="cmtt-10">=is</span></strong><span +class="cmtt-10">]</span> +</div> +</div> (Icelandic). +<!--l. 18378--><p class="noindent" > +</p> +<!--l. 18378--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.10 </span> <a + id="sec:samplesnoidx"></a>No Indexing Application (Option 1)</h3> +<a + id="x1-215001r33"></a> +<!--l. 18381--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-noidxapp"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-noidxapp">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-noidxapp.tex" ><span +class="cmtt-10">sample-noidxapp.tex</span></a></h4> +<!--l. 18381--><p class="noindent" >This document illustrates how to use the <span +class="cmss-10">glossaries </span>package without an external <a +href="#glo:indexingapp">indexing application</a> +(<a +href="#option1">Option 1</a>). To create the complete document, you need to do: +</p><!--l. 18384--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-noidxapp + <br />pdflatex sample-noidxapp + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note the need to group the accent command that occurs at the start of the <span +class="cmtt-10">name</span><a + id="dx1-216001"></a>: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{elite}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name={</span><strong><span +class="cmtt-10">{\'</span><a + id="dx1-216002"></a><span +class="cmtt-10">e}</span></strong><span +class="cmtt-10">lite},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={select</span><span +class="cmtt-10"> group</span><span +class="cmtt-10"> of</span><span +class="cmtt-10"> people}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> This is necessary to allow the term to work with <span +class="cmtt-10">\Gls</span><a + id="dx1-216003"></a>. Notice also how the <a +href="#glo:numberlist">number list<a + id="dx1-216004"></a>s</a> can’t be compacted +into ranges. For example, the list “1, 2, 3” would be converted to “1–3” with a proper indexing application +(Options <a +href="#option2">2</a> or <a +href="#option3">3</a> or, with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, <a +href="#option4">Option 4</a>). +<!--l. 18402--><p class="indent" > The larger the list of entries, the longer the document build time. This method is very inefficient for large +glossaries. See <a +href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml" >Gallery: glossaries performance</a> for a comparison. +<a + id="x1-216005r34"></a> +</p><!--l. 18406--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-noidxapp-utf8"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-noidxapp-utf8">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-noidxapp-utf8.tex" ><span +class="cmtt-10">sample-noidxapp-utf8.tex</span></a></h4> +<!--l. 18406--><p class="noindent" >As the previous example, except that it uses the <span +class="cmss-10">inputenc</span><a + id="dx1-217001"></a> package. To create the complete document, you need +to do: +</p><!--l. 18409--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-noidxapp-utf8 + <br />pdflatex sample-noidxapp-utf8 + <br /></pre><spacer type=vertical size=10> + <br /></span> +This method is unsuitable for sorting languages with <a +href="#glo:exlatinalph">extended Latin alphabets</a> or <a +href="#glo:nonlatinalph">non-Latin alphabets</a>. Use +Options <a +href="#option3">3</a> or <a +href="#option4">4</a> instead. +</p><!--l. 18416--><p class="noindent" > +</p> +<!--l. 18416--><p class="noindent" ><a +href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">19.11 </span> <a + id="sec:samplesother"></a>Other</h3> +<a + id="x1-218001r35"></a> +<!--l. 18419--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample4col"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample4col">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample4col.tex" ><span +class="cmtt-10">sample4col.tex</span></a></h4> +<!--l. 18419--><p class="noindent" >This document illustrates a four column glossary where the entries have a symbol in addition to the name and +description. To create the complete document, you need to do: +</p><!--l. 18423--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample4col + <br />makeglossaries sample4col + <br />pdflatex sample4col + + + <br /></pre><spacer type=vertical size=10> + <br /></span> +or +</p><!--l. 18429--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample4col + <br />makeglossaries-lite sample4col + <br />pdflatex sample4col + <br /></pre><spacer type=vertical size=10> + <br /></span> +The vertical gap between entries is the gap created at the start of each group. This can be suppressed using the +<span +class="cmss-10">nogroupskip</span><a + id="dx1-219001"></a> package option. (If you switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-219002"></a></a>, simply omit the <span +class="cmtt-10">--group </span>command line +option.) +</p><!--l. 18439--><p class="indent" > This example uses the <span +class="cmss-10">long4colheaderborder</span><a + id="dx1-219003"></a>. This style doesn’t allow multi-line descriptions. You may prefer +to use <span +class="cmss-10">altlong4colheaderborder</span><a + id="dx1-219004"></a> with long descriptions. However, in either case a style that uses <span +class="cmss-10">booktabs</span><a + id="dx1-219005"></a> is +preferable. For example, <span +class="cmss-10">long4col-booktabs</span><a + id="dx1-219006"></a> or <span +class="cmss-10">altlongragged4col-booktabs</span><a + id="dx1-219007"></a>. Note that this requires +<span +class="cmss-10">glossary-longbooktabs</span><a + id="dx1-219008"></a>, which needs to be explicitly loaded. The style can only be set once this package has been +loaded: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage{glossaries}</span> +<br /><span +class="cmtt-10">\usepackage{glossary-longbooktabs}</span> +<br /><span +class="cmtt-10">\setglossarystyle{altlongragged4col-booktabs}</span> +</div> +</div> +<!--l. 18453--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides a more compact way of doing this with the <span id="textcolor973"><span +class="cmss-10">stylemods</span></span><a + id="dx1-219009"></a> +option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=altlongragged4col-booktabs,</span><span id="textcolor974"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">longbooktabs</span></strong><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package provides additional styles, including more “long” styles with the <span id="textcolor975"><span +class="cmss-10">glossary-longextra</span></span><a + id="dx1-219010"></a> +package. For example, the <span id="textcolor976"><span +class="cmss-10">long-name-desc-sym-loc</span></span><a + id="dx1-219011"></a> style: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=</span><strong><span id="textcolor977"><span +class="cmtt-10">long-name-desc-sym-loc</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor978"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">=</span><strong><span +class="cmtt-10">longextra</span></strong><span +class="cmtt-10">]</span> +<br /><span +class="cmtt-10">{glossaries-extra}</span> +</div> +</div> If you use the <span id="textcolor979"><span +class="cmss-10">stylemods</span></span><a + id="dx1-219012"></a> option with an argument, you may prefer to use it with <span +class="cmss-10">nostyles</span><a + id="dx1-219013"></a> to prevent unwanted +styles from being automatically loaded. For example: <div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[style=</span><span id="textcolor980"><span +class="cmtt-10">long-name-desc-sym-loc</span></span><span +class="cmtt-10">,</span><strong><span id="textcolor981"><span +class="cmtt-10">nostyles</span></span><span +class="cmtt-10">,</span></strong><span id="textcolor982"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">=longextra]</span> +<br /><span +class="cmtt-10">{glossaries-extra}</span> +</div> +</div> See also the <a +href="https://www.dickimaw-books.com/gallery/glossaries-styles/" >gallery of predefined styles</a>. +<a + id="x1-219014r36"></a> +<!--l. 18478--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-numberlist"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-numberlist">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-numberlist.tex" ><span +class="cmtt-10">sample-numberlist.tex</span></a></h4> +<!--l. 18478--><p class="noindent" >This document illustrates how to reference the <a +href="#glo:numberlist">number list<a + id="dx1-220001"></a></a> in the document text. This requires an additional +<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run: +</p><!--l. 18481--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-numberlist + <br />makeglossaries sample-numberlist + <br />pdflatex sample-numberlist + <br />pdflatex sample-numberlist + <br /></pre><spacer type=vertical size=10> + <br /></span> +This uses the <span +class="cmss-10">savenumberlist</span><a + id="dx1-220002"></a> package option, which enables <span +class="cmtt-10">\glsentrynumberlist</span><a + id="dx1-220003"></a> and <span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-220004"></a> +(with limitations). The location counter is set to <span +class="cmtt-10">chapter</span>, so the <a +href="#glo:numberlist">number list<a + id="dx1-220005"></a></a> refers to the chapter +numbers. + + +</p> + <div class="verbatim" id="verbatim-477"> +\usepackage[savenumberlist,counter=chapter]{glossaries} +</div> +<!--l. 18494--><p class="nopar" > The <a +href="#glo:numberlist">number list<a + id="dx1-220006"></a></a> can’t be obtained until <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-220007"></a></a> (or <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-220008"></a></a>) has created the glossary file. The <a +href="#glo:numberlist">number list<a + id="dx1-220009"></a></a> is +picked up when this file is input by <span +class="cmtt-10">\printglossary </span>and is then saved in the <span +class="cmtt-10">aux</span><a + id="dx1-220010"></a> file so that it’s available on +the next <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> run. +</p><!--l. 18501--><p class="indent" > This document contains both commands: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">This</span><span +class="cmtt-10"> is</span><span +class="cmtt-10"> a</span><span +class="cmtt-10"> \gls{sample}</span><span +class="cmtt-10"> document.</span><span +class="cmtt-10"> \Glspl{sample}</span> +<br /><span +class="cmtt-10">are</span><span +class="cmtt-10"> discussed</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> chapters~</span><strong><span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-220011"></a></strong><span +class="cmtt-10">{sample}</span> +<br /><span +class="cmtt-10">(or</span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">\glsentrynumberlist</span><a + id="dx1-220012"></a></strong><span +class="cmtt-10">{sample}).</span> +</div> +</div> Without <span +class="cmss-10">hyperref</span><a + id="dx1-220013"></a>, the first list shows as “1–3, 5 & 6” and the second list shows as “1–3, 5, 6”. +<!--l. 18510--><p class="indent" > Note that you can’t use <span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-220014"></a> with <span +class="cmss-10">hyperref</span><a + id="dx1-220015"></a> and Options <a +href="#option2">2</a> or <a +href="#option3">3</a>. If you do, you will get +the warning: + + +</p> + <div class="verbatim" id="verbatim-478"> +Package glossaries Warning: \glsdisplaynumberlist doesn't work with + <br />hyperref. + <br />Using \glsentrynumberlist instead +</div> +<!--l. 18516--><p class="nopar" > Now both lists show as “1–3, 5, 6”. +</p><!--l. 18519--><p class="indent" > If you switch to <a +href="#option1">Option 1</a> (replace <span +class="cmtt-10">\makeglossaries </span>with <span +class="cmtt-10">\makenoidxglossaries </span>and replace +<span +class="cmtt-10">\printglossaries </span>with <span +class="cmtt-10">\printnoidxglossaries</span>), then the document build is simply: +</p><!--l. 18522--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-numberlist + <br />pdflatex sample-numberlist + <br /></pre><spacer type=vertical size=10> + <br /></span> +Now <span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-220016"></a> works with <span +class="cmss-10">hyperref</span><a + id="dx1-220017"></a>, however there are no ranges, so the first list shows as “1, 2, +3, 5, & 6” and the second list shows as “1, 2, 3, 4, 5, 6”. +</p><!--l. 18530--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220018"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220019"></a></a>, you first need to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (at least v1.42) but +remember to include the <span +class="cmss-10">record</span><a + id="dx1-220020"></a> option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor983"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,counter=chapter]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> Note that the <span +class="cmss-10">savenumberlist</span><a + id="dx1-220021"></a> option is no longer required. Next convert the entry to the <span +class="cmtt-10">bib</span><a + id="dx1-220022"></a> format required by +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220023"></a></a>: +<!--l. 18540--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib sample-numberlist.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Replace <span +class="cmtt-10">\makeglossaries </span>with: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor984"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-220024"></a><span +class="cmtt-10">[</span><span id="textcolor985"><span +class="cmtt-10">src</span></span><a + id="dx1-220025"></a><span +class="cmtt-10">=entries.bib]</span> +</div> +</div> and remove the <span +class="cmtt-10">\newglossaryentry </span>command from the document preamble. Finally, replace +<span +class="cmtt-10">\printglossaries </span>with <span id="textcolor986"><span +class="cmtt-10">\printunsrtglossaries</span></span><a + id="dx1-220026"></a>. The build process is now: +<!--l. 18550--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-numberlist + <br />bib2gls sample-numberlist + <br />pdflatex sample-numberlist + <br /></pre><spacer type=vertical size=10> + <br /></span> +Now both ranges and hyperlinks work. The first list shows “1–3, 5, & 6” and the second list shows “1–3, 5, 6”. +You can also use: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span id="textcolor987"><span +class="cmtt-10">\glsxtrfieldformatlist</span></span><a + id="dx1-220027"></a><span +class="cmtt-10">{sample}{loclist}</span> +</div> +</div> which will show the complete list without ranges “1, 2, 3, 5 & 6”. +<!--l. 18564--><p class="indent" > This method works much better than using the <span +class="cmss-10">savenumberlist</span><a + id="dx1-220028"></a> option because <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220029"></a></a> saves the formatted +<a +href="#glo:numberlist">number list<a + id="dx1-220030"></a></a> in the <span id="textcolor988"><span +class="cmtt-10">location</span></span><a + id="dx1-220031"></a> field (which is an internal field provided by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> for the benefit of +<a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220032"></a></a>) and the unformatted <a +href="#glo:numberlist">number list<a + id="dx1-220033"></a></a> in the <span +class="cmtt-10">loclist</span><a + id="dx1-220034"></a> internal field (which is also used by +<a +href="#option1">Option 1</a>). +</p><!--l. 18571--><p class="indent" > With Options <a +href="#option2">2</a> and <a +href="#option3">3</a>, both <a +href="#glo:makeindex"><span +class="cmtt-10">makeindex</span><a + id="dx1-220035"></a></a> and <a +href="#glo:xindy"><span +class="cmtt-10">xindy</span><a + id="dx1-220036"></a></a> simply create a file containing the commands to typeset +the glossary, which is input by <span +class="cmtt-10">\printglossary</span>. This means that it’s quite hard to gather information obtained +by the <a +href="#glo:indexingapp">indexing application</a>. +</p><!--l. 18576--><p class="indent" > <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-220037"></a></a>, on the other hand, doesn’t write a file containing the glossary. It writes a file containing the entry +definitions and uses internal fields to save the indexing information. The glossary is then displayed with +<span id="textcolor989"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-220038"></a>, which simply iterates over all defined entries and fetches the required information from +those internal fields. +</p><!--l. 18583--><p class="indent" > The <span +class="cmtt-10">\glsdisplaynumberlist</span><a + id="dx1-220039"></a> and <span +class="cmtt-10">\glsentrynumberlist</span><a + id="dx1-220040"></a> commands are redefined by <span +class="cmss-10">glossaries-extra-bib2gls</span><a + id="dx1-220041"></a> +to simply access the <span id="textcolor990"><span +class="cmtt-10">location</span></span><a + id="dx1-220042"></a> field. However, if you want a complete list without ranges you can use: +</p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor991"><span +class="cmtt-10">\glsxtrfieldformatlist</span></span><a + id="dx1-220043"></a><span +class="cmtt-10">{sample}{loclist}</span> +</div> +</div> In this example, this produces “1, 2, 3, 5 & 6”. +<!--l. 18592--><p class="indent" > Note the difference if you use the <span id="textcolor992"><span +class="cmss-10">record</span><span +class="cmtt-10">=</span><span +class="cmss-10">nameref</span></span><a + id="dx1-220044"></a> package option instead of just <span id="textcolor993"><span +class="cmss-10">record</span></span><a + id="dx1-220045"></a>. +<a + id="x1-220046r37"></a> +</p><!--l. 18595--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-nomathhyper"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-nomathhyper">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-nomathhyper.tex" ><span +class="cmtt-10">sample-nomathhyper.tex</span></a></h4> +<!--l. 18595--><p class="noindent" >This document illustrates how to selectively enable and disable entry hyperlinks in <span +class="cmtt-10">\glsentryfmt</span><a + id="dx1-221001"></a>. The +document build is: +</p><!--l. 18598--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-nomathhyper + <br />makeglossaries sample-nomathhyper + <br />pdflatex sample-nomathhyper + <br /></pre><spacer type=vertical size=10> + <br /></span> +This disables the hyperlinks for the main glossary with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\GlsDeclareNoHyperList</span><a + id="dx1-221002"></a><span +class="cmtt-10">{main}</span> + + +</div> +</div> and then redefines <span +class="cmtt-10">\glsentryfmt </span>so that it adds a hyperlink if not in maths mode and the hyperlinks haven’t +been forced off (with the <span +class="cmtt-10">hyper</span><a + id="dx1-221003"></a><span +class="cmtt-10">=false </span>key). +<!--l. 18611--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, then you can instead use the hook that comes before +the keys are set. The preamble is much simpler: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\makeglossaries</span> +<br /> +<br /><span +class="cmtt-10">\renewcommand{</span><strong><span id="textcolor994"><span +class="cmtt-10">\glslinkpresetkeys</span></span><a + id="dx1-221004"></a></strong><span +class="cmtt-10">}{%</span> +<br /><span +class="cmtt-10"> \ifmmode</span><span +class="cmtt-10"> \setkeys{glslink}{hyper=false}\fi</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">%</span><span +class="cmtt-10"> entry</span><span +class="cmtt-10"> definition</span> +</div> +</div> +<a + id="x1-221005r38"></a> +<!--l. 18627--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-entryfmt"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-entryfmt">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-entryfmt.tex" ><span +class="cmtt-10">sample-entryfmt.tex</span></a></h4> +<!--l. 18627--><p class="noindent" >This document illustrates how to change the way an entry is displayed in the text. (This is just a test document. +For a real document, I recommend you use the <span +class="cmss-10">siunitx</span><a + id="dx1-222001"></a> package to typeset units.) The document build +is: +</p><!--l. 18631--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-entryfmt + <br />makeglossaries sample-entryfmt + <br />pdflatex sample-entryfmt + <br /></pre><spacer type=vertical size=10> + <br /></span> +This redefines <span +class="cmtt-10">\glsentryfmt</span><a + id="dx1-222002"></a> to add the symbol on <a +href="#glo:firstuse">first use</a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\renewcommand*{\glsentryfmt}{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsgenentryfmt</span><a + id="dx1-222003"></a> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \ifglsused</span><a + id="dx1-222004"></a><span +class="cmtt-10">{\glslabel}{}{\space</span><span +class="cmtt-10"> (</span><strong><span +class="cmtt-10">\glsentrysymbol</span><a + id="dx1-222005"></a></strong><span +class="cmtt-10">{\glslabel})}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Note the use of <span +class="cmtt-10">\glsentrysymbol </span><span +class="cmti-10">not </span><span +class="cmtt-10">\glssymbol </span>(which would result in nested <a +href="#glo:linktext">link text<a + id="dx1-222006"></a></a>). +<!--l. 18647--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to switch to the <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package, you can make use of the category +post-link hook instead: </p><div class="alltt"> + + +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor995"><span +class="cmtt-10">stylemods</span></span><span +class="cmtt-10">,style=tree]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\makeglossaries</span> +<br /> +<br /><span id="textcolor996"><span +class="cmtt-10">\glsdefpostlink</span></span><a + id="dx1-222007"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">unit</span></strong><span +class="cmtt-10">}{</span><span id="textcolor997"><span +class="cmtt-10">\glsxtrpostlinkAddSymbolOnFirstUse</span></span><a + id="dx1-222008"></a><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{distance}{</span> +<br /><span id="textcolor998"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">={</span><strong><span +class="cmtt-10">unit</span></strong><span +class="cmtt-10">},</span> +<br /><span +class="cmtt-10">name=distance,</span> +<br /><span +class="cmtt-10">description={The</span><span +class="cmtt-10"> length</span><span +class="cmtt-10"> between</span><span +class="cmtt-10"> two</span><span +class="cmtt-10"> points},</span> +<br /><span +class="cmtt-10">symbol={km}}</span> +</div> +</div> Note that in this case the symbol is now outside of the hyperlink. +<a + id="x1-222009r39"></a> +<!--l. 18665--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-prefix"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-prefix">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-prefix.tex" ><span +class="cmtt-10">sample-prefix.tex</span></a></h4> +<!--l. 18665--><p class="noindent" >This document illustrates the use of the <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-223001"></a> package. An additional run is required to ensure the +table of contents is up-to-date: +</p><!--l. 18668--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-prefix + <br />makeglossaries sample-prefix + <br />pdflatex sample-prefix + <br />pdflatex sample-prefix + <br /></pre><spacer type=vertical size=10> + <br /></span> +Remember that the default separator between the prefix and <span +class="cmtt-10">\gls </span>(or one of its variants) is empty, so if a space +is required it must be inserted at the end of the prefix. However, the <span +class="cmss-10">xkeyval</span><a + id="dx1-223002"></a> package (which is used to parse the +⟨<span +class="cmti-10">key</span>⟩<span +class="cmtt-10">=</span>⟨<span +class="cmti-10">value</span>⟩ lists) trims leading and trailing space from the values, so an ordinary space character will be lost. +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{sample}{name={sample},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={an</span><span +class="cmtt-10"> example},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix={a</span><strong><span +class="cmtt-10">~</span></strong><span +class="cmtt-10">},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural={the</span><strong><span +class="cmtt-10">\space</span></strong><span +class="cmtt-10">}%</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{oeil}{name={oeil},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> plural={yeux},</span> + + +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={eye},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix={l'},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural={les</span><strong><span +class="cmtt-10">\space</span></strong><span +class="cmtt-10">}}</span> +</div> +</div> +<!--l. 18694--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to convert this example to use <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, then (as from v1.42) you can use +the <span id="textcolor999"><span +class="cmss-10">prefix</span></span><a + id="dx1-223003"></a> option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor1000"><span +class="cmtt-10">prefix</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor1001"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,acronym]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> (Alternatively load <span +class="cmss-10">glossaries-prefix</span><a + id="dx1-223004"></a> after <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>.) The rest of the document is the same as for the base +<span +class="cmss-10">glossaries </span>package, unless you want to switch to using <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223005"></a></a>. +<!--l. 18705--><p class="indent" > <span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;"><a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223006"></a></a></span>If you want to switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223007"></a></a>, first switch to <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> (as above) but make sure you +include the <span id="textcolor1002"><span +class="cmss-10">record</span></span><a + id="dx1-223008"></a> package option: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><strong><span id="textcolor1003"><span +class="cmtt-10">record</span></span></strong><span +class="cmtt-10">,</span><span id="textcolor1004"><span +class="cmtt-10">prefix</span></span><span +class="cmtt-10">,</span><span id="textcolor1005"><span +class="cmtt-10">postdot</span></span><span +class="cmtt-10">,acronym]{glossaries-extra}</span> +</div> +</div> Next convert the entries into the <span +class="cmtt-10">bib</span><a + id="dx1-223009"></a> format required by <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223010"></a></a>: +<!--l. 18714--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />convertgls2bib --preamble-only sample-prefix.tex entries.bib + <br /></pre><spacer type=vertical size=10> + <br /></span> +Replace <span +class="cmtt-10">\makeglossaries </span>with </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1006"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-223011"></a><span +class="cmtt-10">[acronym]{long-short}</span> +<br /><span id="textcolor1007"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-223012"></a><span +class="cmtt-10">[</span><span id="textcolor1008"><span +class="cmtt-10">src</span></span><a + id="dx1-223013"></a><span +class="cmtt-10">=entries]</span> +</div> +</div> remove the entry definitions from the preamble, and replace <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\printglossary[style=plist]</span> +<br /><span +class="cmtt-10">\printacronyms</span> +</div> +</div> with <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1009"><span +class="cmtt-10">\printunsrtglossary</span></span><a + id="dx1-223014"></a><span +class="cmtt-10">[style=plist]</span> +<br /><span id="textcolor1010"><span +class="cmtt-10">\printunsrtacronyms</span></span><a + id="dx1-223015"></a> + + +</div> +</div> The document build is now: +<!--l. 18733--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-prefix + <br />bib2gls sample-prefix + <br />pdflatex sample-prefix + <br /></pre><spacer type=vertical size=10> + <br /></span> +</p><!--l. 18739--><p class="indent" > With <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223016"></a></a> v2.0+, you don’t need to manually insert the spaces at the end of the prefixes. Instead you +can instruct <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223017"></a></a> to insert them. To try this out, remove the trailing <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">~</span></span></span> and <span +class="cmtt-10">\space </span>from the <span +class="cmtt-10">entries.bib</span> +file: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1011"><span +class="cmtt-10">@entry</span></span><a + id="dx1-223018"></a><span +class="cmtt-10">{sample,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {a},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {sample},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {an</span><span +class="cmtt-10"> example},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {the}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor1012"><span +class="cmtt-10">@entry</span></span><a + id="dx1-223019"></a><span +class="cmtt-10">{oeil,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> plural</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {yeux},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {l'},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> name</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {oeil},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {eye},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixplural</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {les}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span id="textcolor1013"><span +class="cmtt-10">@acronym</span></span><a + id="dx1-223020"></a><span +class="cmtt-10">{svm,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefixfirst</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {a},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> prefix</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {an},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> short</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {SVM},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> long</span><span +class="cmtt-10"> =</span><span +class="cmtt-10"> {support</span><span +class="cmtt-10"> vector</span><span +class="cmtt-10"> machine}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Now add the <span id="textcolor1014"><span +class="cmtt-10">append-prefix-field</span></span><span +class="cmtt-10">={space or nbsp}</span><a + id="dx1-223021"></a> resource option: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1015"><span +class="cmtt-10">\GlsXtrLoadResources</span></span><a + id="dx1-223022"></a><span +class="cmtt-10">[</span><span id="textcolor1016"><span +class="cmtt-10">src</span></span><a + id="dx1-223023"></a><span +class="cmtt-10">=entries,</span><strong><span id="textcolor1017"><span +class="cmtt-10">append-prefix-field</span></span><span +class="cmtt-10">={space</span><span +class="cmtt-10"> or</span><span +class="cmtt-10"> nbsp}</span></strong><span +class="cmtt-10">]</span> +</div> +</div> See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-223024"></a></a> manual for further details. +<a + id="x1-223025r40"></a> + + +<!--l. 18773--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sampleaccsupp"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sampleaccsupp">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sampleaccsupp.tex" ><span +class="cmtt-10">sampleaccsupp.tex</span></a></h4> +<!--l. 18773--><p class="noindent" >This document uses the <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224001"></a> package (see <a +href="#sec:accsupp">§18 </a><a +href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>). That package automatically +loads <span +class="cmss-10">glossaries </span>and passes all options to the base package. So you can load both packages at once with +just: + + +</p> + <div class="verbatim" id="verbatim-479"> +\usepackage[acronym]{glossaries-accsupp} +</div> +<!--l. 18779--><p class="nopar" > This provides additional keys that aren’t available with just the base package, which may be used to provide +replacement text. The replacement text is inserted using <span +class="cmss-10">accsupp</span><a + id="dx1-224002"></a>’s <span +class="cmtt-10">\BeginAccSupp</span><a + id="dx1-224003"></a> and <span +class="cmtt-10">\EndAccSupp</span><a + id="dx1-224004"></a> +commands. See the <span +class="cmss-10">accsupp</span><a + id="dx1-224005"></a> package for further details of those commands. +</p><!--l. 18786--><p class="indent" > Note that this example document is provided to demonstrate <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224006"></a> as succinctly as possible. The +resulting document isn’t fully accessible as it’s not tagged. See the <span +class="cmss-10">accessibility</span><a + id="dx1-224007"></a> and <span +class="cmss-10">tagpdf</span><a + id="dx1-224008"></a> packages for further +information about tagging documents. +</p><!--l. 18792--><p class="indent" > It’s not essential to use <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224009"></a>. You can simply insert the replacement text directly into the field +values. For example: + + +</p> + <div class="verbatim" id="verbatim-480"> +\newglossaryentry{Drive}{ + <br /> name={\BeginAccSupp{Actual=Drive}Dr.\EndAccSupp{}}, + <br /> description={Drive} + <br />} + <br />\newglossaryentry{image}{name={sample image}, + <br /> description={an example image}, + <br /> user1={\protect\BeginAccSupp{Alt={a boilerplate image used in + <br />  examples}}\protect\includegraphics + <br />  [height=20pt]{example-image}\protect\EndAccSupp{}} + <br />} +</div> +<!--l. 18805--><p class="nopar" > However, this can cause interference (especially with case-changing). With <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224010"></a> it’s possible to +obtain the field values without the accessibility information if required. (If in the future <span +class="cmtt-10">\includegraphics </span>is +given extra options to provide replacement text then the image example here won’t be necessary. However, the +example can be adapted for images created with <span class="TEX">T<span +class="E">E</span>X</span> code.) +</p><!--l. 18814--><p class="indent" > The acronym style is set using: + + +</p> + <div class="verbatim" id="verbatim-481"> +\setacronymstyle{long-short} +</div> +<!--l. 18817--><p class="nopar" > The first abbreviation is straightforward: + + +</p> + <div class="verbatim" id="verbatim-482"> +\newacronym{eg}{e.g.}{for example} +</div> +<!--l. 18821--><p class="nopar" > The <span +class="cmtt-10">shortaccess</span><a + id="dx1-224011"></a> replacement text is automatically set to the long form. The next abbreviation is awkward as +the long form contains formatting commands which can’t be included in the replacement text. This means that +the <span +class="cmtt-10">shortaccess</span><a + id="dx1-224012"></a> key must be supplied: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newacronym[</span><strong><span +class="cmtt-10">shortaccess</span></strong><span +class="cmtt-10">={TiKZ</span><span +class="cmtt-10"> ist</span><span +class="cmtt-10"> kein</span><span +class="cmtt-10"> Zeichenprogramm}]</span> +<br /><span +class="cmtt-10">{tikz}{Ti\emph{k}Z}{Ti\emph{k}Z</span><span +class="cmtt-10"> ist</span><span +class="cmtt-10"> \emph{kein}</span><span +class="cmtt-10"> Zeichenprogramm}</span> +</div> +</div> In the above two cases, the short form obtained in <span +class="cmtt-10">\gls </span>will use the “E” PDF element. +<!--l. 18833--><p class="indent" > By way of comparison, there are some entries that are technically abbreviations but are defined using +<span +class="cmtt-10">\newglossaryentry</span><a + id="dx1-224013"></a> instead of <span +class="cmtt-10">\newacronym</span><a + id="dx1-224014"></a>. The replacement text is provided in the <span +class="cmtt-10">access</span><a + id="dx1-224015"></a> key: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{Doctor}{name=Dr,description={Doctor},</span><strong><span +class="cmtt-10">access</span></strong><span +class="cmtt-10">={Doctor}}</span> +<br /><span +class="cmtt-10">\newglossaryentry{Drive}{name={Dr.},plural={Drvs},description={Drive},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">access</span></strong><span +class="cmtt-10">={Drive}}</span> +</div> +</div> These will use PDF’s “ActualText” element (not “E”). +<!--l. 18844--><p class="indent" > The next entry is a symbol (the integration symbol <span +class="cmex-10">∫</span> + ). This could be defined simply as: + + +</p> + <div class="verbatim" id="verbatim-483"> +\newglossaryentry{int}{name={int},description={integral}, + <br /> symbol={\ensuremath{\int}}} +</div> +<!--l. 18849--><p class="nopar" > and then referenced in the text like this: + + +</p> + <div class="verbatim" id="verbatim-484"> +Symbol: \gls{int} (\glssymbol{int}). +</div> +<!--l. 18853--><p class="nopar" > This results in the text “Symbol: integral (<span +class="cmex-10">∫</span> + ).” However if you copy and paste this from the PDF you will +find the resulting text is “Symbol: int (R).” This is what’s actually read out by the text-to-speech +system. +</p><!--l. 18859--><p class="indent" > It would be better if the actual text was the Unicode character 0x222B. This would not only assist the +text-to-speech system but also make it easier to copy and paste the text. The simplest method is to identify the +character by its hexadecimal code, but in order to do this the <span +class="cmtt-10">\BeginAccSupp</span><a + id="dx1-224016"></a> command needs to have the +options adjusted. +</p><!--l. 18865--><p class="indent" > In order to determine whether to use “E”, “ActualText” or “Alt” for a particular field, <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224017"></a> will +check if the command <span +class="cmtt-10">\gls</span>⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">accsupp</span><a + id="dx1-224018"></a> exists (where ⟨<span +class="cmti-10">field</span>⟩ is the internal field label, see <a +href="#tab:fieldmap">table 4.1</a>). Only two +of these commands are predefined: <span +class="cmtt-10">\glsshortaccsupp</span><a + id="dx1-224019"></a> and <span +class="cmtt-10">\glsshortplaccsupp</span><a + id="dx1-224020"></a>, which is why the +<span +class="cmtt-10">shortaccess</span><a + id="dx1-224021"></a> field uses “E”. If the given command doesn’t exist then the generic <span +class="cmtt-10">\glsaccsupp</span><a + id="dx1-224022"></a> command is used +instead. +</p><!--l. 18874--><p class="indent" > This means that in order to simply set <span +class="cmtt-10">symbolaccess</span><a + id="dx1-224023"></a> to the hexadecimal character code, I need to provide a +command called <span +class="cmtt-10">\glssymbolaccsupp</span><a + id="dx1-224024"></a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{\gls</span><strong><span +class="cmtt-10">symbol</span></strong><span +class="cmtt-10">accsupp}[2]{%</span> +<br /><span +class="cmtt-10"> \glsaccessibility</span><a + id="dx1-224025"></a><span +class="cmtt-10">[</span><strong><span +class="cmtt-10">method=hex,unicode</span></strong><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">ActualText</span></strong><span +class="cmtt-10">}{#1}{#2}%</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> Now I can adjust the definition of the <span +class="cmtt-10">int </span>entry: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{int}{name={int},description={integral},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> symbol={\ensuremath{\int}},</span><strong><span +class="cmtt-10">symbolaccess={222B}</span></strong> +<br /><span +class="cmtt-10">}</span> +</div> +</div> +<!--l. 18889--><p class="indent" > The final entry has an image stored in the <span +class="cmtt-10">user1</span><a + id="dx1-224026"></a> key. (The image file is provided with the <span +class="cmss-10">mwe</span><a + id="dx1-224027"></a> +package.) This should use “Alt” instead of “ActualText” so I need to define <span +class="cmtt-10">\glsuseriaccsupp</span><a + id="dx1-224028"></a>: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{\gls</span><strong><span +class="cmtt-10">useri</span></strong><span +class="cmtt-10">accsupp}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsaccessibility</span><a + id="dx1-224029"></a><span +class="cmtt-10">{</span><strong><span +class="cmtt-10">Alt</span></strong><span +class="cmtt-10">}{#1}{#2}%</span> +<br /><span +class="cmtt-10">}</span> + + +</div> +</div> The image description is provided in the <span +class="cmtt-10">user1access</span><a + id="dx1-224030"></a> key: <div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newglossaryentry{sampleimage}{name={sample</span><span +class="cmtt-10"> image},</span> +<br /><span +class="cmtt-10"> description={an</span><span +class="cmtt-10"> example</span><span +class="cmtt-10"> image},</span> +<br /><span +class="cmtt-10"> user1={\protect\includegraphics</span><a + id="dx1-224031"></a><span +class="cmtt-10">[height=20pt]{example-image}},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">user1access</span></strong><span +class="cmtt-10">={a</span><span +class="cmtt-10"> boilerplate</span><span +class="cmtt-10"> image</span><span +class="cmtt-10"> used</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> examples}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> (Note the need to protect the fragile <span +class="cmtt-10">\includegraphics</span><a + id="dx1-224032"></a>. The alternative is to use <span +class="cmtt-10">\glsnoexpandfields </span>before +defining the command. See <a +href="#sec:expansion">§4.4 </a><a +href="#sec:expansion">Expansion<!--tex4ht:ref: sec:expansion --></a>.) +<!--l. 18910--><p class="indent" > If you try this example and inspect the +PDF<span class="footnote-mark"><a +href="#fn4x19" id="fn4x19-bk"><sup class="textsuperscript">19.4</sup></a></span><a + id="x1-224033f4"></a> then +you will find content like: + + +</p> + <div class="verbatim" id="verbatim-485"> +/Span << /ActualText (Doctor) >> BDC + <br />  BT + <br />    /F8 9.9626 Tf + <br />    73.102 697.123 Td + <br />    [ (Dr) ] TJ + <br />  ET + <br />EMC +</div> +<!--l. 18923--><p class="nopar" > This shows that “ActualText” was used for <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{Doctor}</span></span></span>. The integral symbol (<span +class="cmex-10">∫</span> + ) created with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glssymbol{int}</span></span></span> is: + + +</p> + <div class="verbatim" id="verbatim-486"> +/Span << /ActualText (\376\377"+) >> BDC + <br />  BT + <br />    /F1 9.9626 Tf + <br />    97.732 650.382 Td + <br />    [ (R) ] TJ + <br />  ET + <br />EMC +</div> +<!--l. 18934--><p class="nopar" > Again, “ActualText” has been used, but the character code has been supplied. The image created with +<span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsuseri{sampleimage}</span></span></span> is: + + +</p> + <div class="verbatim" id="verbatim-487"> +/Span << /Alt (a boilerplate image used in examples) >> BDC + <br />  1 0 0 1 106.588 618.391 cm + <br />  q + <br />    0.08301 0 0 0.08301 0 0 cm + <br />    q + <br />      1 0 0 1 0 0 cm + <br />      /Im1 Do + <br />    Q + <br />  Q + <br />EMC +</div> +<!--l. 18948--><p class="nopar" > This shows that “Alt” has been used. +</p><!--l. 18951--><p class="indent" > The first use of <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{eg}</span></span></span> produces the long form (not reproduced here) followed by the short +form: + + +</p> + <div class="verbatim" id="verbatim-488"> +/Span << /E (for example) >> BDC + <br />  BT + <br />    /F8 9.9626 Tf + <br />    161.687 563.624 Td + <br />    [ (e.g.) ] TJ + <br />  ET + <br />EMC +</div> +<!--l. 18961--><p class="nopar" > The subsequent use also has the “E” element: + + +</p> + <div class="verbatim" id="verbatim-489"> +/Span << /E (for example) >> BDC + <br />  BT + <br />    /F8 9.9626 Tf + <br />    118.543 551.669 Td + <br />    [ (e.g.) ] TJ + <br />  ET + <br />EMC +</div> +<!--l. 18971--><p class="nopar" > Similarly for <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acrshort{eg}</span></span></span>. You can also use the <span +class="cmss-10">debug</span><span +class="cmtt-10">=</span><span +class="cmss-10">showaccsupp</span><a + id="dx1-224034"></a> package option. This will show +the replacement text in the document, but note that this is the content before it’s processed by +<span +class="cmtt-10">\BeginAccSupp</span>. +</p><!--l. 18977--><p class="indent" > If the <span +class="cmtt-10">\setacronymstyle</span><a + id="dx1-224035"></a> command is removed (or commented out) then the result would be different. The +<a +href="#glo:firstuse">first use</a> of <span +class="cmtt-10">\gls </span>uses “E” for the short form but the subsequent use has “ActualText” instead. This is because +without <span +class="cmtt-10">\setacronymstyle</span><a + id="dx1-224036"></a> the original acronym mechanism is used, which is less sophisticated than the newer +acronym mechanism that’s triggered with <span +class="cmtt-10">\setacronymstyle</span><a + id="dx1-224037"></a>. +</p><!--l. 18984--><p class="indent" > <div class="important" title="Important Note"> If you want to convert this example so that it uses <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, make sure you have at least version 1.42 +of the extension package. </div> +</p><!--l. 18988--><p class="noindent" > +</p><!--l. 18990--><p class="indent" > <br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; "><a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a></span>If you want to convert this example so that it uses <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>, you need to replace the +explicit loading of <span +class="cmss-10">glossaries-accsupp</span><a + id="dx1-224038"></a> with an implicit load through the <span id="textcolor1018"><span +class="cmss-10">accsupp</span></span><a + id="dx1-224039"></a> package option: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\usepackage[</span><span id="textcolor1019"><span +class="cmtt-10">abbreviations</span></span><span +class="cmtt-10">,</span><strong><span id="textcolor1020"><span +class="cmtt-10">accsupp</span></span></strong><span +class="cmtt-10">]{</span><strong><span +class="cmtt-10">glossaries-extra</span></strong><span +class="cmtt-10">}</span> +</div> +</div> I’m switching from <span +class="cmtt-10">\newacronym</span><a + id="dx1-224040"></a> to <span id="textcolor1021"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224041"></a>, which means that the default category is <span id="textcolor1022"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-224042"></a> +and also the file extensions are different. If you are using <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-224043"></a></a> or <a +href="#glo:makeglossaries-lite.lua"><span +class="cmtt-10">makeglossaries-lite</span><a + id="dx1-224044"></a></a> you don’t +need to worry about it. However, if you’re not using those helper scripts then you will need to adjust the file +extensions in your document build process. +<!--l. 19005--><p class="indent" > The style command <span +class="cmtt-10">\setacronymstyle{long-short} </span>needs to be replaced with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\setabbreviationstyle</span><a + id="dx1-224045"></a><span +class="cmtt-10">{long-short}</span> +</div> +</div> This is actually the default so you can simply delete the <span +class="cmtt-10">\setacronymstyle </span>line. Substitute the two instances +of <span +class="cmtt-10">\newacronym</span><a + id="dx1-224046"></a> with <span id="textcolor1023"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224047"></a>. For example: <div class="alltt"> +<div class="obeylines-v"> +<strong><span id="textcolor1024"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224048"></a></strong><span +class="cmtt-10">{eg}{e.g.}{for</span><span +class="cmtt-10"> example}</span> + + +</div> +</div> Note that for the <span +class="cmtt-10">tikz </span>entry you can now remove the explicit assignment of <span +class="cmtt-10">shortaccess</span><a + id="dx1-224049"></a> with <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> +v1.42 as it will strip formatting commands like <span +class="cmtt-10">\emph</span>: <div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1025"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224050"></a> +<br /><span +class="cmtt-10"> {tikz}{Ti\emph{k}Z}{Ti\emph{k}Z</span><span +class="cmtt-10"> ist</span><span +class="cmtt-10"> \emph{kein}</span><span +class="cmtt-10"> Zeichenprogramm}</span> +</div> +</div> It’s also necessary to replace <span +class="cmtt-10">\acrshort</span>, <span +class="cmtt-10">\acrlong </span>and <span +class="cmtt-10">\acrfull </span>with <span id="textcolor1026"><span +class="cmtt-10">\glsxtrshort</span></span><a + id="dx1-224051"></a>, <span id="textcolor1027"><span +class="cmtt-10">\glsxtrlong</span></span><a + id="dx1-224052"></a> and +<span id="textcolor1028"><span +class="cmtt-10">\glsxtrfull</span></span><a + id="dx1-224053"></a>. +<!--l. 19026--><p class="indent" > You may notice a slight difference from the original example. The <span +class="cmtt-10">shortaccess</span><a + id="dx1-224054"></a> field now shows ⟨<span +class="cmti-10">long</span>⟩ (⟨<span +class="cmti-10">short</span>⟩) +instead of just ⟨<span +class="cmti-10">long</span>⟩. This is because <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> redefines <span +class="cmtt-10">\glsdefaultshortaccess</span><a + id="dx1-224055"></a> to include the short +form. +</p><!--l. 19031--><p class="indent" > Now that the extension package is being used, there are some other modifications that would tidy up the +code and fix a few issues. +</p><!--l. 19034--><p class="indent" > The “Doctor” and “Drive” entries should really be defined as abbreviations but they shouldn’t be +expanded on first use. The <span id="textcolor1029"><span +class="cmss-10">short-nolong</span></span><a + id="dx1-224056"></a> style can achieve this and it happens to be the default style +for the <span id="textcolor1030"><span +class="cmss-10">acronym</span></span><a + id="dx1-224057"></a> category. This means that you can simply replace the “Doctor” definition with: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newacronym</span><a + id="dx1-224058"></a><span +class="cmtt-10">{Doctor}{Dr}{Doctor}</span> +</div> +</div> The <a +href="#glo:firstuse">first use</a> of <span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls{Doctor}</span></span></span> is just “Dr”. This means that the “E” element will be used instead +of “ActualText”. Now I don’t need to supply the accessibility text as its obtained from the long +form. +<!--l. 19047--><p class="indent" > The “Drive” entry can be similarly defined but it has the awkward terminating full stop. This means that I +had to omit the end of sentence terminator in: + + +</p> + <div class="verbatim" id="verbatim-490"> +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} +</div> +<!--l. 19052--><p class="nopar" > This looks odd when reading the document source and it’s easy to forgot. This is very similar to the situation +in the <a +href="#ex:sample-dot-abbr"><span +class="cmtt-10">sample-dot-abbr.tex</span></a> example. I can again use the <span id="textcolor1031"><span +class="cmss-10">discardperiod</span></span><a + id="dx1-224059"></a> attribute, but I need to assign a +different category so that it doesn’t interfere with the “Doctor” entry. +</p><!--l. 19059--><p class="indent" > The category is simply a label that’s used in the construction of some internal command names. This means +that it must be fully expandable, but I can choose whatever label I like (<span id="textcolor1032"><span +class="cmss-10">general</span></span><a + id="dx1-224060"></a>, <span id="textcolor1033"><span +class="cmss-10">abbreviation</span></span><a + id="dx1-224061"></a>, <span id="textcolor1034"><span +class="cmss-10">acronym</span></span><a + id="dx1-224062"></a>, <span id="textcolor1035"><span +class="cmss-10">index</span></span><a + id="dx1-224063"></a>, +<span id="textcolor1036"><span +class="cmss-10">symbol</span></span><a + id="dx1-224064"></a> and <span id="textcolor1037"><span +class="cmss-10">number</span></span><a + id="dx1-224065"></a> are used by various commands provided by <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a>). +</p><!--l. 19066--><p class="indent" > In this case, I’ve decided to have a category called <span +class="cmtt-10">shortdotted </span>to indicate an abbreviation that ends with a +dot but only the short form is shown on <a +href="#glo:firstuse">first use</a>: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1038"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-224066"></a><span +class="cmtt-10">[shortdotted]{short-nolong-noreg}</span> +<br /><span id="textcolor1039"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-224067"></a><span +class="cmtt-10">{shortdotted}{discardperiod}{true}</span> +<br /><span id="textcolor1040"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224068"></a><span +class="cmtt-10">[category=shortdotted]{Drive}{Dr.\@}{Drive}</span> +</div> +</div> In the <a +href="#ex:sample-dot-abbr"><span +class="cmtt-10">sample-dot-abbr.tex</span></a> example, I also used the <span id="textcolor1041"><span +class="cmss-10">insertdots</span></span><a + id="dx1-224069"></a> attribute to automatically insert the dots and +add the space factor (which is adjusted if <span id="textcolor1042"><span +class="cmss-10">discardperiod</span></span><a + id="dx1-224070"></a> discards a period). In this case I’m inserting the dot +manually so I’ve also added the space factor with <span +class="cmtt-10">\@</span><a + id="dx1-224071"></a> in case the abbreviation is used mid-sentence. For +example: + + + <div class="verbatim" id="verbatim-491"> +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive}. Next sentence. + <br />\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} end of sentence. +</div> +<!--l. 19084--><p class="nopar" > (The spacing is more noticeable if you first switch to a monospaced font with <span +class="cmtt-10">\ttfamily</span>.) +</p><!--l. 19088--><p class="indent" > The “e.g.” abbreviation similarly ends with a dot. It’s not usual to write “for example (e.g.)” in a +document, so it really ought to have the same <span +class="cmtt-10">shortdotted </span>category, but it has a long-short form for illustrative +purposes in this test document. In this case I need to choose another category so that I can apply a different +style. For example: </p><div class="alltt"> +<div class="obeylines-v"> +<span id="textcolor1043"><span +class="cmtt-10">\setabbreviationstyle</span></span><a + id="dx1-224072"></a><span +class="cmtt-10">[longshortdotted]{long-short}</span> +<br /><span id="textcolor1044"><span +class="cmtt-10">\glssetcategoryattribute</span></span><a + id="dx1-224073"></a><span +class="cmtt-10">{longshortdotted}{discardperiod}{true}</span> +<br /><span id="textcolor1045"><span +class="cmtt-10">\newabbreviation</span></span><a + id="dx1-224074"></a><span +class="cmtt-10">[category=longshortdotted]{e.g.}{e.g.\@}{for</span> +<br /><span +class="cmtt-10">example}</span> +</div> +</div> +<!--l. 19101--><p class="indent" > To further illustrate categories, let’s suppose the symbol and image should be in the <span +class="cmtt-10">name</span><a + id="dx1-224075"></a> field instead of the +<span +class="cmtt-10">symbol</span><a + id="dx1-224076"></a> and <span +class="cmtt-10">user1</span><a + id="dx1-224077"></a> fields. Now the <span +class="cmtt-10">\glssymbolaccsupp </span>and <span +class="cmtt-10">\glsuseriaccsupp </span>commands won’t be used. I +can’t deal with both cases if I just provide <span +class="cmtt-10">\glsnameaccsupp</span>. +</p><!--l. 19108--><p class="indent" > I could provide category-field versions, such as <span id="textcolor1046"><span +class="cmtt-10">\glsxtrsymbolnameaccsupp</span></span>, but remember that this only +covers accessing the <span +class="cmtt-10">name</span><a + id="dx1-224078"></a> field, which is typically only done in the glossary. I would also need similar commands +for the <span +class="cmtt-10">first</span><a + id="dx1-224079"></a>, <span +class="cmtt-10">firstplural</span><a + id="dx1-224080"></a>, <span +class="cmtt-10">text</span><a + id="dx1-224081"></a> and <span +class="cmtt-10">plural</span><a + id="dx1-224082"></a> keys. This is quite complicated, but since I don’t need to worry +about any of the other fields it’s simpler to just provide the <span id="textcolor1047"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-224083"></a> version: +</p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newcommand{</span><span id="textcolor1048"><span +class="cmtt-10">\glsxtr</span><strong><span +class="cmtt-10">symbol</span></strong><span +class="cmtt-10">accsupp</span></span><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> \glsaccessibility</span><a + id="dx1-224084"></a><span +class="cmtt-10">[method=hex,unicode]{ActualText}{#1}{#2}%</span> +<br /><span +class="cmtt-10">}</span> +<br /><span +class="cmtt-10">\newcommand{</span><span id="textcolor1049"><span +class="cmtt-10">\glsxtr</span><strong><span +class="cmtt-10">image</span></strong><span +class="cmtt-10">accsupp</span></span><span +class="cmtt-10">}[2]{%</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> \glsaccessibility</span><a + id="dx1-224085"></a><span +class="cmtt-10">{Alt}{#1}{#2}%</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{int}{</span><strong><span id="textcolor1050"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">=symbol</span></strong><span +class="cmtt-10">,</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">name</span></strong><span +class="cmtt-10">={\ensuremath{\int}},</span><strong><span +class="cmtt-10">access</span></strong><span +class="cmtt-10">={222B},</span> +<br /><span +class="cmtt-10"> </span><span +class="cmtt-10"> description={integral}</span> +<br /><span +class="cmtt-10">}</span> +<br /> +<br /><span +class="cmtt-10">\newglossaryentry{sampleimage}{</span><strong><span id="textcolor1051"><span +class="cmtt-10">category</span></span><span +class="cmtt-10">=image</span></strong><span +class="cmtt-10">,</span> + + +<br /><span +class="cmtt-10"> description={an</span><span +class="cmtt-10"> example</span><span +class="cmtt-10"> image},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">name</span></strong><span +class="cmtt-10">={\protect\includegraphics[height=20pt]{example-image}},</span> +<br /><span +class="cmtt-10"> </span><strong><span +class="cmtt-10">access</span></strong><span +class="cmtt-10">={a</span><span +class="cmtt-10"> boilerplate</span><span +class="cmtt-10"> image</span><span +class="cmtt-10"> used</span><span +class="cmtt-10"> in</span><span +class="cmtt-10"> examples}</span> +<br /><span +class="cmtt-10">}</span> +</div> +</div> If it’s necessary to provide support for additional fields, then the category-field command +<span id="textcolor1052"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩⟨<span +class="cmitt-10">field</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-224086"></a> could be used to override the more general category command +<span id="textcolor1053"><span +class="cmtt-10">\glsxtr</span>⟨<span +class="cmitt-10">category</span>⟩<span +class="cmtt-10">accsupp</span></span><a + id="dx1-224087"></a>. +<a + id="x1-224088r41"></a> +<!--l. 19139--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-ignored"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-ignored">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-ignored.tex" ><span +class="cmtt-10">sample-ignored.tex</span></a></h4> +<!--l. 19139--><p class="noindent" >This document defines an ignored glossary for common terms that don’t need a definition. The document build +is: +</p><!--l. 19141--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-ignored + <br />makeglossaries sample-ignored + <br />pdflatex sample-ignored + <br /></pre><spacer type=vertical size=10> + <br /></span> +A new “ignored” glossary is defined with: </p><div class="alltt"> +<div class="obeylines-v"> +<span +class="cmtt-10">\newignoredglossary</span><a + id="dx1-225001"></a><span +class="cmtt-10">{common}</span> +</div> +</div> There are no associated files with an ignored glossary. An entry is defined with this as its glossary +type: + + + <div class="verbatim" id="verbatim-492"> +\newglossaryentry{commonex}{type=common,name={common term}} +</div> +<!--l. 19154--><p class="nopar" > Note that the <span +class="cmtt-10">description</span><a + id="dx1-225002"></a> key isn’t required. This term may be referenced with <span +class="cmtt-10">\gls </span>(which is useful for +consistent formatting) but it won’t be indexed. +<a + id="x1-225003r42"></a> +</p><!--l. 19159--><p class="noindent" > +</p> + <h4 class="likesubsectionHead"><a + id="ex:sample-entrycount"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#ex:sample-entrycount">🔗</a><a +href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/sample-entrycount.tex" ><span +class="cmtt-10">sample-entrycount.tex</span></a></h4> +<!--l. 19159--><p class="noindent" >This document uses <span +class="cmtt-10">\glsenableentrycount</span><a + id="dx1-226001"></a> and <span +class="cmtt-10">\cgls</span><a + id="dx1-226002"></a> (described in <a +href="#sec:enableentrycount">§14.1 </a><a +href="#sec:enableentrycount">Counting the Number of Times an +Entry has been Used (First Use Flag Unset)<!--tex4ht:ref: sec:enableentrycount --></a>) so that acronyms only used once don’t appear in the list of +acronyms. The document build is: +</p><!--l. 19163--><p class="indent" > <spacer type=vertical size=10><pre class="prompt"><span class="obeylines-h"> + <br />pdflatex sample-entrycount + <br />pdflatex sample-entrycount + <br />makeglossaries sample-entrycount + <br />pdflatex sample-entrycount + <br /></pre><spacer type=vertical size=10> + <br /></span> +Note the need to call <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> twice before <a +href="#glo:makeglossaries"><span +class="cmtt-10">makeglossaries</span><a + id="dx1-226003"></a></a>, and then a final <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span +class="E">E</span>X</span></span> call is required at the +end. +</p><!--l. 19172--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> The <a +href="#glo:glossaries-extra"><span +class="cmss-10">glossaries-extra</span></a> package has additions that extend this mechanism and comes with some other sample +files related to entry counting. </div> +</p><!--l. 19175--><p class="noindent" > +</p><!--l. 19177--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you switch to <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-226004"></a></a> you can use record counting instead. See the <a +href="#glo:bib2gls"><span +class="cmtt-10">bib2gls</span><a + id="dx1-226005"></a></a> manual for further details. +</div> +</p><!--l. 19180--><p class="noindent" > + + +</p> +<!--l. 19182--><p class="indent" > </div> +</p><!--l. 19182--><p class="noindent" ><a +href="#top">Top</a><div class="chapter"><h2 class="chapterHead">20. <a id="sec:trouble"></a>Troubleshooting</h2> -</p><!--l. 13033--><p class="indent" > In addition to the sample files listed in <a -href="#sec:samples"><span -class="tcrm-1000">§</span>1.2 </a><a +</p><!--l. 19185--><p class="indent" > In addition to the sample files listed in <a +href="#sec:samples">§19 </a><a href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>, the <span -class="cmss-10">glossaries </span>package -comes with some minimal example files, <span +class="cmss-10">glossaries </span>package comes with some +minimal example files, <span class="cmtt-10">minimalgls.tex</span>, <span class="cmtt-10">mwe-gls.tex</span>, <span -class="cmtt-10">mwe-acr.tex </span>and -<span -class="cmtt-10">mwe-acr-desc.tex</span>, which can be used for testing. These should be located in the <span -class="cmtt-10">samples</span> -subdirectory (folder) of the <span -class="cmss-10">glossaries </span>documentation directory. The location varies according to -your operating system and <span class="TEX">T<span -class="E">E</span>X</span> installation. For example, on my Linux partition it can be found -in <span -class="cmtt-10">/usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/</span>. The <a +class="cmtt-10">mwe-acr.tex </span>and <span +class="cmtt-10">mwe-acr-desc.tex</span>, which can be +used for testing. These should be located in the <span +class="cmtt-10">samples </span>subdirectory (folder) of the <span +class="cmss-10">glossaries </span>documentation +directory. The location varies according to your operating system and <span class="TEX">T<span +class="E">E</span>X</span> installation. For example, on my +Linux partition it can be found in <span +class="cmtt-10">/usr/local/texlive/2014/texmf-dist/doc/latex/glossaries/</span>. The +<a href="#glo:makeglossariesgui"><span class="cmtt-10">makeglossariesgui</span><a - id="dx1-95001"></a></a> -application can also be used to test for various problems. Further information on debugging -<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span + id="dx1-227001"></a></a> application can also be used to test for various problems. Further information on +debugging <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> code is available at <a href="http://www.dickimaw-books.com/latex/minexample/" class="url" ><span class="cmtt-10">http://www.dickimaw-books.com/latex/minexample/</span></a>. -</p><!--l. 13048--><p class="indent" > If you have any problems, please first consult the <a +</p><!--l. 19200--><p class="indent" > If you have any problems, please first consult the <a href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" ><span -class="cmss-10">glossaries </span>FAQ</a>. If that doesn’t -help, try posting your query to somewhere like the <span -class="cmtt-10">comp.text.tex </span>newsgroup, the -<a +class="cmss-10">glossaries </span>FAQ</a>. If that doesn’t help, try posting your query +to somewhere like the <span +class="cmtt-10">comp.text.tex </span>newsgroup, the <a href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span class="E">E</span>X</span></span> Community Forum</a> or <a href="http://tex.stackexchange.com/" ><span class="TEX">T<span -class="E">E</span>X</span> on StackExchange</a>. Bug reports can be submitted via -<a +class="E">E</span>X</span> on StackExchange</a>. +Bug reports can be submitted via <a href="http://www.dickimaw-books.com/bug-report.html" >my package bug report form</a>. - - + + </p> <!--l. 2--><p class="indent" > </div> </p><!--l. 2--><p class="noindent" ><a href="#top">Top</a></p><h2 class="likechapterHead"><a - id="x1-9600019"></a>Index</h2> - <span + id="x1-22800020"></a>Index</h2> + <span class="cmbx-10">Symbols</span> <div class="theindex"><span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\’</span></span></span>  <a +href="glossaries-user.html#dx1-216002" >1</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\@</span></span></span>  <a +href="glossaries-user.html#dx1-186026" >2</a>, <a +href="glossaries-user.html#dx1-186027" >3</a>, <a +href="glossaries-user.html#dx1-186033" >4</a>, <a +href="glossaries-user.html#dx1-186034" >5</a>, <a +href="glossaries-user.html#dx1-224071" >6</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@gls@codepage</span></span></span>  <a -href="glossaries-user.html#dx1-21012" ><span -class="cmti-10">1</span></a> <br /></span> +href="glossaries-user.html#dx1-22020" ><span +class="cmti-10">7</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\@gls@reference</span></span></span>  <a +href="glossaries-user.html#dx1-22023" ><span +class="cmti-10">8</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@glsorder</span></span></span>  <a -href="glossaries-user.html#dx1-21009" ><span -class="cmti-10">2</span></a> <br /></span> +href="glossaries-user.html#dx1-22017" ><span +class="cmti-10">9</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\@glsxtr@altmodifier</span></span></span>  <a +href="glossaries-user.html#dx1-24024" >10</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\@glsxtr@newglslike</span></span></span>  <a +href="glossaries-user.html#dx1-24022" >11</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\@glsxtr@prefixlabellist</span></span></span>  <a +href="glossaries-user.html#dx1-24026" >12</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@istfilename</span></span></span>  <a -href="glossaries-user.html#dx1-21004" ><span -class="cmti-10">3</span></a> <br /></span> +href="glossaries-user.html#dx1-22005" ><span +class="cmti-10">13</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@newglossary</span></span></span>  <a -href="glossaries-user.html#dx1-21003" ><span -class="cmti-10">4</span></a> <br /></span> +href="glossaries-user.html#dx1-22001" ><span +class="cmti-10">14</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\@xdylanguage</span></span></span>  <a -href="glossaries-user.html#dx1-21011" ><span -class="cmti-10">5</span></a> <br /></span> -<p class="theindex"> <span +href="glossaries-user.html#dx1-22019" ><span +class="cmti-10">15</span></a> <br /></span> +<p class="theindex"> <span class="cmbx-10">A</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\AA</span></span></span>  <a +href="glossaries-user.html#dx1-5007" >16</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup>abbreviation styles:<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">footnote</span>  <a +href="glossaries-user.html#dx1-181006" >17</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">long-short</span>  <a +href="glossaries-user.html#dx1-175029" >18</a>, <a +href="glossaries-user.html#dx1-185011" >19</a>, <a +href="glossaries-user.html#dx1-186011" >20</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">long-short-sc</span>  <a +href="glossaries-user.html#dx1-178026" >21</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">long-short-sc-desc</span>  <a +href="glossaries-user.html#dx1-179013" >22</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">postfootnote</span>  <a +href="glossaries-user.html#dx1-181005" >23</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">short-nolong</span>  <a +href="glossaries-user.html#dx1-175032" >24</a>, <a +href="glossaries-user.html#dx1-224056" >25</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">short-sc-footnote</span>  <a +href="glossaries-user.html#dx1-181007" >26</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">short-sc-footnote-desc</span>  <a +href="glossaries-user.html#dx1-181002" >27</a>, <a +href="glossaries-user.html#dx1-182003" >28</a>, <a +href="glossaries-user.html#dx1-184004" >29</a>, <a +href="glossaries-user.html#dx1-184006" >30</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">short-sc-postfootnote-desc</span>  <a +href="glossaries-user.html#dx1-181004" >31</a>, <a +href="glossaries-user.html#dx1-182005" >32</a>, <a +href="glossaries-user.html#dx1-184005" >33</a>, <a +href="glossaries-user.html#dx1-184007" >34</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Ac</span></span></span>  <a +href="glossaries-user.html#dx1-147112" >35</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ac</span></span></span>  <a +href="glossaries-user.html#dx1-147110" >36</a> <br /></span> +<span class="index-item"><span +class="cmss-10">accessibility </span>package  <a +href="glossaries-user.html#dx1-172057" >37</a>, <a +href="glossaries-user.html#dx1-172087" >38</a>, <a +href="glossaries-user.html#dx1-224007" >39</a> <br /></span> <span class="index-item"><span class="cmss-10">accsupp </span>package  <a -href="glossaries-user.html#dx1-94002" >6</a>, <a -href="glossaries-user.html#dx1-94034" >7</a> <br /></span> +href="glossaries-user.html#dx1-172002" >40</a>, <a +href="glossaries-user.html#dx1-172059" >41</a>, <a +href="glossaries-user.html#dx1-172086" >42</a>, <a +href="glossaries-user.html#dx1-224002" >43</a>, <a +href="glossaries-user.html#dx1-224005" >44</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acf</span></span></span>  <a +href="glossaries-user.html#dx1-147104" >45</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acf</span></span></span>  <a +href="glossaries-user.html#dx1-147102" >46</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acfp</span></span></span>  <a +href="glossaries-user.html#dx1-147108" >47</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acfp</span></span></span>  <a +href="glossaries-user.html#dx1-147106" >48</a> <br /></span> + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acl</span></span></span>  <a +href="glossaries-user.html#dx1-147096" >49</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acl</span></span></span>  <a +href="glossaries-user.html#dx1-147094" >50</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Aclp</span></span></span>  <a +href="glossaries-user.html#dx1-147100" >51</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\aclp</span></span></span>  <a +href="glossaries-user.html#dx1-147098" >52</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acp</span></span></span>  <a +href="glossaries-user.html#dx1-147116" >53</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acp</span></span></span>  <a +href="glossaries-user.html#dx1-147114" >54</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRfull</span></span></span>  <a -href="glossaries-user.html#dx1-69080" ><span -class="cmti-10">8</span></a> <br /></span> +href="glossaries-user.html#dx1-147080" ><span +class="cmti-10">55</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrfull</span></span></span>  <a -href="glossaries-user.html#dx1-69079" ><span -class="cmti-10">9</span></a> <br /></span> +href="glossaries-user.html#dx1-147079" ><span +class="cmti-10">56</span></a>, <a +href="glossaries-user.html#dx1-147105" >57</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrfull</span></span></span>  <a -href="glossaries-user.html#dx1-69076" ><span -class="cmti-10">10</span></a> <br /></span> +href="glossaries-user.html#dx1-147076" ><span +class="cmti-10">58</span></a>, <a +href="glossaries-user.html#dx1-147103" >59</a>, <a +href="glossaries-user.html#dx1-149017" >60</a>, <a +href="glossaries-user.html#dx1-149055" >61</a>, <a +href="glossaries-user.html#dx1-149068" >62</a>, <a +href="glossaries-user.html#dx1-150054" >63</a>, <a +href="glossaries-user.html#dx1-153015" >64</a>, <a +href="glossaries-user.html#dx1-178037" >65</a>, <a +href="glossaries-user.html#dx1-179038" >66</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrfullfmt</span></span></span>  <a -href="glossaries-user.html#dx1-69077" ><span -class="cmti-10">11</span></a> <br /></span> +href="glossaries-user.html#dx1-147077" ><span +class="cmti-10">67</span></a>, <a +href="glossaries-user.html#dx1-150018" >68</a>, <a +href="glossaries-user.html#dx1-150055" >69</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrfullformat</span></span></span>  <a -href="glossaries-user.html#dx1-69078" ><span -class="cmti-10">12</span></a> <br /></span> +href="glossaries-user.html#dx1-147078" ><span +class="cmti-10">70</span></a>, <a +href="glossaries-user.html#dx1-147132" >71</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRfullpl</span></span></span>  <a -href="glossaries-user.html#dx1-69083" ><span -class="cmti-10">13</span></a> <br /></span> +href="glossaries-user.html#dx1-147083" ><span +class="cmti-10">72</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrfullpl</span></span></span>  <a -href="glossaries-user.html#dx1-69082" ><span -class="cmti-10">14</span></a> <br /></span> +href="glossaries-user.html#dx1-147082" ><span +class="cmti-10">73</span></a>, <a +href="glossaries-user.html#dx1-147109" >74</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrfullpl</span></span></span>  <a -href="glossaries-user.html#dx1-69081" ><span -class="cmti-10">15</span></a> <br /></span> +href="glossaries-user.html#dx1-147081" ><span +class="cmti-10">75</span></a>, <a +href="glossaries-user.html#dx1-147107" >76</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRlong</span></span></span>  <a -href="glossaries-user.html#dx1-69069" ><span -class="cmti-10">16</span></a> <br /></span> +href="glossaries-user.html#dx1-147069" ><span +class="cmti-10">77</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrlong</span></span></span>  <a -href="glossaries-user.html#dx1-69068" ><span -class="cmti-10">17</span></a> <br /></span> +href="glossaries-user.html#dx1-147068" ><span +class="cmti-10">78</span></a>, <a +href="glossaries-user.html#dx1-147097" >79</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrlong</span></span></span>  <a -href="glossaries-user.html#dx1-69064" ><span -class="cmti-10">18</span></a> <br /></span> +href="glossaries-user.html#dx1-147064" ><span +class="cmti-10">80</span></a>, <a +href="glossaries-user.html#dx1-147095" >81</a>, <a +href="glossaries-user.html#dx1-178036" >82</a>, <a +href="glossaries-user.html#dx1-179037" >83</a>, <a +href="glossaries-user.html#dx1-186015" >84</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRlongpl</span></span></span>  <a -href="glossaries-user.html#dx1-69072" ><span -class="cmti-10">19</span></a> <br /></span> +href="glossaries-user.html#dx1-147072" ><span +class="cmti-10">85</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrlongpl</span></span></span>  <a -href="glossaries-user.html#dx1-69071" ><span -class="cmti-10">20</span></a> <br /></span> +href="glossaries-user.html#dx1-147071" ><span +class="cmti-10">86</span></a>, <a +href="glossaries-user.html#dx1-147101" >87</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrlongpl</span></span></span>  <a -href="glossaries-user.html#dx1-69070" ><span -class="cmti-10">21</span></a> <br /></span> +href="glossaries-user.html#dx1-147070" ><span +class="cmti-10">88</span></a>, <a +href="glossaries-user.html#dx1-147099" >89</a> <br /></span> <span class="index-item">acronym styles:<br /></span> <span class="index-subitem">    <span class="cmtt-10">dua</span>  <a -href="glossaries-user.html#dx1-71018" >22</a>, <a -href="glossaries-user.html#dx1-71052" >23</a>, <a -href="glossaries-user.html#dx1-71056" >24</a>, <a -href="glossaries-user.html#dx1-72021" >25</a> <br /></span> +href="glossaries-user.html#dx1-149019" >90</a>, <a +href="glossaries-user.html#dx1-149053" >91</a>, <a +href="glossaries-user.html#dx1-149057" >92</a>, <a +href="glossaries-user.html#dx1-150021" >93</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">dua-desc</span>  <a -href="glossaries-user.html#dx1-71053" >26</a>, <a -href="glossaries-user.html#dx1-71059" >27</a> <br /></span> +href="glossaries-user.html#dx1-149054" >94</a>, <a +href="glossaries-user.html#dx1-149060" >95</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote</span>  <a -href="glossaries-user.html#dx1-71019" >28</a>, <a -href="glossaries-user.html#dx1-71063" >29</a>, <a -href="glossaries-user.html#dx1-72020" >30</a> <br /></span> +href="glossaries-user.html#dx1-149020" >96</a>, <a +href="glossaries-user.html#dx1-149064" >97</a>, <a +href="glossaries-user.html#dx1-150020" >98</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote-desc</span>  <a -href="glossaries-user.html#dx1-71073" >31</a> <br /></span> +href="glossaries-user.html#dx1-149074" >99</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote-sc</span>  <a -href="glossaries-user.html#dx1-71064" >32</a> <br /></span> +href="glossaries-user.html#dx1-149065" >100</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote-sc-desc</span>  <a -href="glossaries-user.html#dx1-11027" >33</a>, <a -href="glossaries-user.html#dx1-71074" >34</a>, <a -href="glossaries-user.html#dx1-71083" >35</a>, <a -href="glossaries-user.html#dx1-71086" >36</a> <br /></span> +href="glossaries-user.html#dx1-149075" >101</a>, <a +href="glossaries-user.html#dx1-149084" >102</a>, <a +href="glossaries-user.html#dx1-149087" >103</a>, <a +href="glossaries-user.html#dx1-181001" >104</a>, <a +href="glossaries-user.html#dx1-182002" >105</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote-sm</span>  <a -href="glossaries-user.html#dx1-71065" >37</a> <br /></span> +href="glossaries-user.html#dx1-149066" >106</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">footnote-sm-desc</span>  <a -href="glossaries-user.html#dx1-71075" >38</a> <br /></span> +href="glossaries-user.html#dx1-149076" >107</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sc-short</span>  <a -href="glossaries-user.html#dx1-71007" >39</a>, <a -href="glossaries-user.html#dx1-71021" >40</a>, <a -href="glossaries-user.html#dx1-71040" >41</a>, <a -href="glossaries-user.html#dx1-72033" >42</a> <br /></span> - - +href="glossaries-user.html#dx1-149007" >108</a>, <a +href="glossaries-user.html#dx1-149022" >109</a>, <a +href="glossaries-user.html#dx1-149041" >110</a>, <a +href="glossaries-user.html#dx1-150033" >111</a>, <a +href="glossaries-user.html#dx1-178027" >112</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sc-short-desc</span>  <a -href="glossaries-user.html#dx1-71036" >43</a> <br /></span> +href="glossaries-user.html#dx1-149037" >113</a>, <a +href="glossaries-user.html#dx1-179014" >114</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-short</span>  <a -href="glossaries-user.html#dx1-57069" >44</a>, <a -href="glossaries-user.html#dx1-71020" >45</a>, <a -href="glossaries-user.html#dx1-71039" >46</a>, <a -href="glossaries-user.html#dx1-72011" >47</a>, <a -href="glossaries-user.html#dx1-72028" >48</a>, <a -href="glossaries-user.html#dx1-72034" >49</a> <br /></span> +href="glossaries-user.html#dx1-135069" >115</a>, <a +href="glossaries-user.html#dx1-149021" >116</a>, <a +href="glossaries-user.html#dx1-149040" >117</a>, <a +href="glossaries-user.html#dx1-150011" >118</a>, <a +href="glossaries-user.html#dx1-150028" >119</a>, <a +href="glossaries-user.html#dx1-150034" >120</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-short-desc</span>  <a -href="glossaries-user.html#dx1-71035" >50</a>, <a -href="glossaries-user.html#dx1-71051" >51</a>, <a -href="glossaries-user.html#dx1-72030" >52</a> <br /></span> +href="glossaries-user.html#dx1-149036" >121</a>, <a +href="glossaries-user.html#dx1-149052" >122</a>, <a +href="glossaries-user.html#dx1-150030" >123</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sm-short</span>  <a -href="glossaries-user.html#dx1-71011" >53</a>, <a -href="glossaries-user.html#dx1-71022" >54</a>, <a -href="glossaries-user.html#dx1-71041" >55</a> <br /></span> +href="glossaries-user.html#dx1-149012" >124</a>, <a +href="glossaries-user.html#dx1-149023" >125</a>, <a +href="glossaries-user.html#dx1-149042" >126</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sm-short-desc</span>  <a -href="glossaries-user.html#dx1-71037" >56</a> <br /></span> +href="glossaries-user.html#dx1-149038" >127</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sp-short</span>  <a -href="glossaries-user.html#dx1-71023" >57</a>, <a -href="glossaries-user.html#dx1-71027" >58</a>, <a -href="glossaries-user.html#dx1-71042" >59</a> <br /></span> +href="glossaries-user.html#dx1-149024" >128</a>, <a +href="glossaries-user.html#dx1-149028" >129</a>, <a +href="glossaries-user.html#dx1-149043" >130</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-sp-short-desc</span>  <a -href="glossaries-user.html#dx1-71038" >60</a> <br /></span> +href="glossaries-user.html#dx1-149039" >131</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">sc-short-long</span>  <a -href="glossaries-user.html#dx1-71030" >61</a> <br /></span> +href="glossaries-user.html#dx1-149031" >132</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">sc-short-long-desc</span>  <a -href="glossaries-user.html#dx1-71049" >62</a> <br /></span> +href="glossaries-user.html#dx1-149050" >133</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">short-long</span>  <a -href="glossaries-user.html#dx1-71029" >63</a> <br /></span> +href="glossaries-user.html#dx1-149030" >134</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">short-long-desc</span>  <a -href="glossaries-user.html#dx1-71048" >64</a> <br /></span> +href="glossaries-user.html#dx1-149049" >135</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">sm-short-long</span>  <a -href="glossaries-user.html#dx1-71031" >65</a> <br /></span> +href="glossaries-user.html#dx1-149032" >136</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">sm-short-long-desc</span>  <a -href="glossaries-user.html#dx1-71050" >66</a> <br /></span> +href="glossaries-user.html#dx1-149051" >137</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acronymentry</span></span></span>  <a -href="glossaries-user.html#dx1-70010" ><span -class="cmti-10">67</span></a> <br /></span> +href="glossaries-user.html#dx1-148010" ><span +class="cmti-10">138</span></a>, <a +href="glossaries-user.html#dx1-149035" >139</a>, <a +href="glossaries-user.html#dx1-149046" >140</a>, <a +href="glossaries-user.html#dx1-149089" >141</a>, <a +href="glossaries-user.html#dx1-150060" >142</a>, <a +href="glossaries-user.html#dx1-150063" >143</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acronymfont</span></span></span>  <a -href="glossaries-user.html#dx1-71002" ><span -class="cmti-10">68</span></a> <br /></span> +href="glossaries-user.html#dx1-98004" >144</a>, <a +href="glossaries-user.html#dx1-147054" >145</a>, <a +href="glossaries-user.html#dx1-149002" ><span +class="cmti-10">146</span></a>, <a +href="glossaries-user.html#dx1-149005" >147</a>, <a +href="glossaries-user.html#dx1-149015" >148</a>, <a +href="glossaries-user.html#dx1-149026" >149</a>, <a +href="glossaries-user.html#dx1-149091" >150</a>, <a +href="glossaries-user.html#dx1-150014" >151</a>, <a +href="glossaries-user.html#dx1-150076" >152</a>, <a +href="glossaries-user.html#dx1-179020" >153</a>, <a +href="glossaries-user.html#dx1-179023" >154</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acronymname</span></span></span>  <a +href="glossaries-user.html#dx1-14025" >155</a>, <a +href="glossaries-user.html#dx1-147001" >156</a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acronymsort</span></span></span>  <a -href="glossaries-user.html#dx1-70012" ><span -class="cmti-10">69</span></a> <br /></span> +href="glossaries-user.html#dx1-148012" ><span +class="cmti-10">157</span></a>, <a +href="glossaries-user.html#dx1-149034" >158</a>, <a +href="glossaries-user.html#dx1-149047" >159</a>, <a +href="glossaries-user.html#dx1-149088" >160</a>, <a +href="glossaries-user.html#dx1-150057" >161</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acronymtype</span></span></span>  <a -href="glossaries-user.html#dx1-68016" ><span -class="cmti-10">70</span></a> <br /></span> +href="glossaries-user.html#dx1-43007" >162</a>, <a +href="glossaries-user.html#dx1-83002" >163</a>, <a +href="glossaries-user.html#dx1-90006" >164</a>, <a +href="glossaries-user.html#dx1-90014" >165</a>, <a +href="glossaries-user.html#dx1-90019" >166</a>, <a +href="glossaries-user.html#dx1-137005" >167</a>, <a +href="glossaries-user.html#dx1-146018" ><span +class="cmti-10">168</span></a>, <a +href="glossaries-user.html#dx1-147008" >169</a>, <a +href="glossaries-user.html#dx1-151002" >170</a>, <a +href="glossaries-user.html#dx1-151004" >171</a>, <a +href="glossaries-user.html#dx1-151008" >172</a>, <a +href="glossaries-user.html#dx1-90008" >173</a>, <a +href="glossaries-user.html#dx1-122022" >174</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRshort</span></span></span>  <a -href="glossaries-user.html#dx1-69058" ><span -class="cmti-10">71</span></a> <br /></span> +href="glossaries-user.html#dx1-147058" ><span +class="cmti-10">175</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrshort</span></span></span>  <a -href="glossaries-user.html#dx1-69057" ><span -class="cmti-10">72</span></a> <br /></span> +href="glossaries-user.html#dx1-147057" ><span +class="cmti-10">176</span></a>, <a +href="glossaries-user.html#dx1-147089" >177</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrshort</span></span></span>  <a -href="glossaries-user.html#dx1-69052" ><span -class="cmti-10">73</span></a> <br /></span> +href="glossaries-user.html#dx1-147052" ><span +class="cmti-10">178</span></a>, <a +href="glossaries-user.html#dx1-147087" >179</a>, <a +href="glossaries-user.html#dx1-150075" >180</a>, <a +href="glossaries-user.html#dx1-178035" >181</a>, <a +href="glossaries-user.html#dx1-179036" >182</a>, <a +href="glossaries-user.html#dx1-186014" >183</a>, <a +href="glossaries-user.html#dx1-4004" >184</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ACRshortpl</span></span></span>  <a -href="glossaries-user.html#dx1-69061" ><span -class="cmti-10">74</span></a> <br /></span> +href="glossaries-user.html#dx1-147061" ><span +class="cmti-10">185</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Acrshortpl</span></span></span>  <a -href="glossaries-user.html#dx1-69060" ><span -class="cmti-10">75</span></a> <br /></span> +href="glossaries-user.html#dx1-147060" ><span +class="cmti-10">186</span></a>, <a +href="glossaries-user.html#dx1-147093" >187</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\acrshortpl</span></span></span>  <a -href="glossaries-user.html#dx1-69059" ><span -class="cmti-10">76</span></a> <br /></span> +href="glossaries-user.html#dx1-147059" ><span +class="cmti-10">188</span></a>, <a +href="glossaries-user.html#dx1-147091" >189</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acs</span></span></span>  <a +href="glossaries-user.html#dx1-147088" >190</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acs</span></span></span>  <a +href="glossaries-user.html#dx1-147086" >191</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Acsp</span></span></span>  <a +href="glossaries-user.html#dx1-147092" >192</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\acsp</span></span></span>  <a +href="glossaries-user.html#dx1-147090" >193</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\addcontentsline</span></span></span>  <a +href="glossaries-user.html#dx1-40003" >194</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\alsoname</span></span></span>  <a +href="glossaries-user.html#dx1-204001" >195</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\altnewglossary</span></span></span>  <a -href="glossaries-user.html#dx1-68008" ><span -class="cmti-10">77</span></a> <br /></span> +href="glossaries-user.html#dx1-146008" ><span +class="cmti-10">196</span></a> <br /></span> <span class="index-item"><span class="cmss-10">amsgen </span>package  <a -href="glossaries-user.html#dx1-14" >78</a>, <a -href="glossaries-user.html#dx1-15" >79</a>, <a -href="glossaries-user.html#dx1-16" >80</a>, <a -href="glossaries-user.html#dx1-72080" >81</a>, <a -href="glossaries-user.html#dx1-72081" >82</a> <br /></span> +href="glossaries-user.html#dx1-13" >197</a>, <a +href="glossaries-user.html#dx1-14" >198</a>, <a +href="glossaries-user.html#dx1-15" >199</a>, <a +href="glossaries-user.html#dx1-150081" >200</a>, <a +href="glossaries-user.html#dx1-150082" >201</a> <br /></span> <span class="index-item"><span class="cmss-10">amsmath </span>package  <a -href="glossaries-user.html#dx1-55006" >83</a>, <a -href="glossaries-user.html#dx1-75021" >84</a> <br /></span> +href="glossaries-user.html#dx1-133006" >202</a>, <a +href="glossaries-user.html#dx1-153021" >203</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\andname</span></span></span>  <a +href="glossaries-user.html#dx1-139010" >204</a> <br /></span> <span class="index-item"><span class="cmtt-10">arara</span>  <a -href="glossaries-user.html#dx1-4008" >85</a>, <a -href="glossaries-user.html#dx1-7028" >86</a>, <a -href="glossaries-user.html#dx1-16021" >87</a>, <a -href="glossaries-user.html#dx1-16022" >88</a> <br /></span> +href="glossaries-user.html#dx1-4018" >205</a>, <a +href="glossaries-user.html#dx1-7041" >206</a>, <a +href="glossaries-user.html#dx1-9034" >207</a>, <a +href="glossaries-user.html#dx1-11083" >208</a>, <a +href="glossaries-user.html#dx1-16020" >209</a>, <a +href="glossaries-user.html#dx1-16021" >210</a>, <a +href="glossaries-user.html#dx1-22010" >211</a>, <a +href="glossaries-user.html#dx1-24007" >212</a>, <a +href="glossaries-user.html#dx1-190039" >213</a> <br /></span> <span class="index-item"><span class="cmss-10">array </span>package  <a -href="glossaries-user.html#dx1-81006" >89</a>, <a -href="glossaries-user.html#dx1-84006" >90</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-159006" >214</a>, <a +href="glossaries-user.html#dx1-162006" >215</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\AtBeginDocument</span></span></span>  <a +href="glossaries-user.html#dx1-122010" >216</a> <br /></span> +<span class="index-item"><span +class="cmtt-10">atom</span>  <a +href="glossaries-user.html#dx1-37006" >217</a> <br /></span> +<span class="index-item">auto-completion  <a +href="glossaries-user.html#dx1-35002" >218</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">B</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\babel</span></span></span>  <a +href="glossaries-user.html#dx1-79019" >219</a> <br /></span> <span class="index-item"><span class="cmss-10">babel </span>package  <a -href="glossaries-user.html#dx1-7016" >91</a>, <a -href="glossaries-user.html#dx1-13033" >92</a>, <a -href="glossaries-user.html#dx1-13045" >93</a>, <a -href="glossaries-user.html#dx1-13049" >94</a>, <a -href="glossaries-user.html#dx1-14001" >95</a>, <a -href="glossaries-user.html#dx1-14003" >96</a>, <a -href="glossaries-user.html#dx1-14005" >97</a>, <a -href="glossaries-user.html#dx1-14007" >98</a>, <a -href="glossaries-user.html#dx1-14016" >99</a>, <a -href="glossaries-user.html#dx1-14018" >100</a>, <a -href="glossaries-user.html#dx1-14019" >101</a>, <a -href="glossaries-user.html#dx1-14022" >102</a>, <a -href="glossaries-user.html#dx1-14034" >103</a>, <a -href="glossaries-user.html#dx1-14037" >104</a>, <a -href="glossaries-user.html#dx1-14040" >105</a>, <a -href="glossaries-user.html#dx1-14047" >106</a>, <a -href="glossaries-user.html#dx1-23062" >107</a>, <a -href="glossaries-user.html#dx1-23067" >108</a>, <a -href="glossaries-user.html#dx1-23072" >109</a>, <a -href="glossaries-user.html#dx1-23074" >110</a>, <a -href="glossaries-user.html#dx1-23076" >111</a>, <a -href="glossaries-user.html#dx1-23081" >112</a>, <a -href="glossaries-user.html#dx1-23087" >113</a>, <a -href="glossaries-user.html#dx1-34010" >114</a>, <a -href="glossaries-user.html#dx1-44012" >115</a>, <a -href="glossaries-user.html#dx1-47007" >116</a>, <a -href="glossaries-user.html#dx1-68023" >117</a> <br /></span> +href="glossaries-user.html#dx1-7018" >220</a>, <a +href="glossaries-user.html#dx1-13031" >221</a>, <a +href="glossaries-user.html#dx1-13042" >222</a>, <a +href="glossaries-user.html#dx1-13046" >223</a>, <a +href="glossaries-user.html#dx1-14001" >224</a>, <a +href="glossaries-user.html#dx1-14003" >225</a>, <a +href="glossaries-user.html#dx1-14005" >226</a>, <a +href="glossaries-user.html#dx1-14007" >227</a>, <a +href="glossaries-user.html#dx1-14016" >228</a>, <a +href="glossaries-user.html#dx1-14018" >229</a>, <a +href="glossaries-user.html#dx1-14019" >230</a>, <a +href="glossaries-user.html#dx1-14022" >231</a>, <a +href="glossaries-user.html#dx1-14034" >232</a>, <a +href="glossaries-user.html#dx1-14037" >233</a>, <a +href="glossaries-user.html#dx1-14040" >234</a>, <a +href="glossaries-user.html#dx1-14042" >235</a>, <a +href="glossaries-user.html#dx1-14049" >236</a>, <a +href="glossaries-user.html#dx1-32002" >237</a>, <a +href="glossaries-user.html#dx1-32007" >238</a>, <a +href="glossaries-user.html#dx1-32012" >239</a>, <a +href="glossaries-user.html#dx1-32014" >240</a>, <a +href="glossaries-user.html#dx1-32016" >241</a>, <a +href="glossaries-user.html#dx1-32021" >242</a>, <a +href="glossaries-user.html#dx1-32027" >243</a>, <a +href="glossaries-user.html#dx1-32031" >244</a>, <a +href="glossaries-user.html#dx1-112009" >245</a>, <a +href="glossaries-user.html#dx1-122012" >246</a>, <a +href="glossaries-user.html#dx1-125007" >247</a>, <a +href="glossaries-user.html#dx1-146025" >248</a>, <a +href="glossaries-user.html#dx1-192017" >249</a> <br /></span> <span class="index-item"><span class="cmss-10">beamer </span>class  <a -href="glossaries-user.html#dx1-55004" >118</a>, <a -href="glossaries-user.html#dx1-55010" >119</a>, <a -href="glossaries-user.html#dx1-75014" >120</a>, <a -href="glossaries-user.html#dx1-75016" >121</a> <br /></span> +href="glossaries-user.html#dx1-133004" >250</a>, <a +href="glossaries-user.html#dx1-133010" >251</a>, <a +href="glossaries-user.html#dx1-153014" >252</a>, <a +href="glossaries-user.html#dx1-153016" >253</a> <br /></span> <span class="index-item"><span class="cmss-10">beamer </span>package  <a -href="glossaries-user.html#dx1-14046" >122</a> <br /></span> -<span class="index-item"><span +href="glossaries-user.html#dx1-14048" >254</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\BeginAccSupp</span></span></span>  <a +href="glossaries-user.html#dx1-172072" >255</a>, <a +href="glossaries-user.html#dx1-172074" >256</a>, <a +href="glossaries-user.html#dx1-224003" >257</a>, <a +href="glossaries-user.html#dx1-224016" >258</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="cmtt-10">bib2gls</span>  <a -href="glossaries-user.html#dx1-2" >123</a>, <a -href="glossaries-user.html#dx1-18" >124</a>, <a +href="glossaries-user.html#dx1-2" >259</a>, <a href="glossaries-user.html#dx1-3001" ><span -class="cmbx-10">125</span></a>, <a -href="glossaries-user.html#dx1-9001" >126</a>, <a -href="glossaries-user.html#dx1-9002" >127</a>, <a -href="glossaries-user.html#dx1-9008" >128</a>, <a -href="glossaries-user.html#dx1-9009" >129</a>, <a -href="glossaries-user.html#dx1-10003" >130</a>, <a -href="glossaries-user.html#dx1-13004" >131</a>, <a -href="glossaries-user.html#dx1-13009" >132</a>, <a -href="glossaries-user.html#dx1-13012" >133</a>, <a -href="glossaries-user.html#dx1-13022" >134</a>, <a -href="glossaries-user.html#dx1-13026" >135</a>, <a -href="glossaries-user.html#dx1-14051" >136</a>, <a -href="glossaries-user.html#dx1-14055" >137</a>, <a -href="glossaries-user.html#dx1-16011" >138</a>, <a -href="glossaries-user.html#dx1-16013" >139</a>, <a -href="glossaries-user.html#dx1-16015" >140</a>, <a -href="glossaries-user.html#dx1-16018" >141</a>, <a -href="glossaries-user.html#dx1-31001" >142</a>, <a -href="glossaries-user.html#dx1-44009" >143</a>, <a -href="glossaries-user.html#dx1-49013" >144</a>, <a -href="glossaries-user.html#dx1-49015" >145</a>, <a -href="glossaries-user.html#dx1-50008" >146</a>, <a -href="glossaries-user.html#dx1-50009" >147</a>, <a -href="glossaries-user.html#dx1-50018" >148</a>, <a -href="glossaries-user.html#dx1-50019" >149</a>, <a -href="glossaries-user.html#dx1-52016" >150</a>, <a -href="glossaries-user.html#dx1-52017" >151</a>, <a -href="glossaries-user.html#dx1-63042" >152</a>, <a -href="glossaries-user.html#dx1-63043" >153</a> <br /></span> +class="cmbx-10">260</span></a>, <a +href="glossaries-user.html#dx1-3007" >261</a>, <a +href="glossaries-user.html#dx1-3010" >262</a>, <a +href="glossaries-user.html#dx1-3012" >263</a>, <a +href="glossaries-user.html#dx1-9001" >264</a>, <a +href="glossaries-user.html#dx1-9010" >265</a>, <a +href="glossaries-user.html#dx1-9019" >266</a>, <a +href="glossaries-user.html#dx1-9030" >267</a>, <a +href="glossaries-user.html#dx1-9039" >268</a>, <a +href="glossaries-user.html#dx1-9040" >269</a>, <a +href="glossaries-user.html#dx1-10007" >270</a>, <a +href="glossaries-user.html#dx1-11008" >271</a>, <a +href="glossaries-user.html#dx1-11020" >272</a>, <a +href="glossaries-user.html#dx1-11024" >273</a>, <a +href="glossaries-user.html#dx1-11029" >274</a>, <a +href="glossaries-user.html#dx1-11031" >275</a>, <a +href="glossaries-user.html#dx1-11032" >276</a>, <a +href="glossaries-user.html#dx1-11044" >277</a>, <a +href="glossaries-user.html#dx1-11047" >278</a>, <a +href="glossaries-user.html#dx1-11057" >279</a>, <a +href="glossaries-user.html#dx1-11069" >280</a>, <a +href="glossaries-user.html#dx1-11071" >281</a>, <a +href="glossaries-user.html#dx1-11094" >282</a>, <a +href="glossaries-user.html#dx1-12005" >283</a>, <a +href="glossaries-user.html#dx1-13004" >284</a>, <a +href="glossaries-user.html#dx1-13009" >285</a>, <a +href="glossaries-user.html#dx1-13012" >286</a>, <a +href="glossaries-user.html#dx1-13020" >287</a>, <a +href="glossaries-user.html#dx1-13024" >288</a>, <a +href="glossaries-user.html#dx1-14053" >289</a>, <a +href="glossaries-user.html#dx1-14057" >290</a>, <a +href="glossaries-user.html#dx1-16003" >291</a>, <a +href="glossaries-user.html#dx1-16011" >292</a>, <a +href="glossaries-user.html#dx1-16012" >293</a>, <a +href="glossaries-user.html#dx1-16014" >294</a>, <a +href="glossaries-user.html#dx1-16017" >295</a>, <a +href="glossaries-user.html#dx1-16073" >296</a>, <a +href="glossaries-user.html#dx1-16074" >297</a>, <a +href="glossaries-user.html#dx1-16075" >298</a>, <a +href="glossaries-user.html#dx1-21003" >299</a>, <a +href="glossaries-user.html#dx1-24001" >300</a>, <a +href="glossaries-user.html#dx1-24005" >301</a>, <a +href="glossaries-user.html#dx1-24008" >302</a>, <a +href="glossaries-user.html#dx1-24011" >303</a>, <a +href="glossaries-user.html#dx1-24013" >304</a>, <a +href="glossaries-user.html#dx1-24021" >305</a>, <a +href="glossaries-user.html#dx1-31008" >306</a>, <a +href="glossaries-user.html#dx1-31011" >307</a>, <a +href="glossaries-user.html#dx1-35004" >308</a>, <a +href="glossaries-user.html#dx1-35005" >309</a>, <a +href="glossaries-user.html#dx1-45008" >310</a>, <a +href="glossaries-user.html#dx1-59002" >311</a>, <a +href="glossaries-user.html#dx1-63004" >312</a>, <a +href="glossaries-user.html#dx1-67001" >313</a>, <a +href="glossaries-user.html#dx1-67002" >314</a>, <a +href="glossaries-user.html#dx1-67003" >315</a>, <a +href="glossaries-user.html#dx1-67006" >316</a>, <a +href="glossaries-user.html#dx1-70001" >317</a>, <a +href="glossaries-user.html#dx1-71006" >318</a>, <a +href="glossaries-user.html#dx1-74007" >319</a>, <a +href="glossaries-user.html#dx1-109001" >320</a>, <a +href="glossaries-user.html#dx1-112081" >321</a>, <a +href="glossaries-user.html#dx1-112082" >322</a>, <a +href="glossaries-user.html#dx1-112135" >323</a>, <a +href="glossaries-user.html#dx1-112143" >324</a>, <a +href="glossaries-user.html#dx1-112144" >325</a>, <a +href="glossaries-user.html#dx1-122009" >326</a>, <a +href="glossaries-user.html#dx1-127013" >327</a>, <a +href="glossaries-user.html#dx1-127015" >328</a>, <a +href="glossaries-user.html#dx1-128008" >329</a>, <a +href="glossaries-user.html#dx1-128009" >330</a>, <a +href="glossaries-user.html#dx1-128018" >331</a>, <a +href="glossaries-user.html#dx1-128019" >332</a>, <a +href="glossaries-user.html#dx1-130016" >333</a>, <a +href="glossaries-user.html#dx1-130017" >334</a>, <a +href="glossaries-user.html#dx1-137006" >335</a>, <a +href="glossaries-user.html#dx1-137011" >336</a>, <a +href="glossaries-user.html#dx1-137013" >337</a>, <a +href="glossaries-user.html#dx1-137018" >338</a>, <a +href="glossaries-user.html#dx1-137019" >339</a>, <a +href="glossaries-user.html#dx1-141044" >340</a>, <a +href="glossaries-user.html#dx1-141045" >341</a>, <a +href="glossaries-user.html#dx1-146012" >342</a>, <a +href="glossaries-user.html#dx1-154019" >343</a>, <a +href="glossaries-user.html#dx1-154020" >344</a>, <a +href="glossaries-user.html#dx1-173001" >345</a>, <a +href="glossaries-user.html#dx1-175046" >346</a>, <a +href="glossaries-user.html#dx1-175047" >347</a>, <a +href="glossaries-user.html#dx1-175050" >348</a>, <a +href="glossaries-user.html#dx1-176003" >349</a>, <a +href="glossaries-user.html#dx1-176012" >350</a>, <a +href="glossaries-user.html#dx1-176013" >351</a>, <a +href="glossaries-user.html#dx1-176028" >352</a>, <a +href="glossaries-user.html#dx1-176029" >353</a>, <a +href="glossaries-user.html#dx1-176032" >354</a>, <a +href="glossaries-user.html#dx1-176034" >355</a>, <a +href="glossaries-user.html#dx1-179042" >356</a>, <a +href="glossaries-user.html#dx1-179043" >357</a>, <a +href="glossaries-user.html#dx1-179046" >358</a>, <a +href="glossaries-user.html#dx1-179069" >359</a>, <a +href="glossaries-user.html#dx1-179070" >360</a>, <a +href="glossaries-user.html#dx1-179078" >361</a>, <a +href="glossaries-user.html#dx1-179079" >362</a>, <a +href="glossaries-user.html#dx1-184071" >363</a>, <a +href="glossaries-user.html#dx1-188011" >364</a>, <a +href="glossaries-user.html#dx1-188012" >365</a>, <a +href="glossaries-user.html#dx1-188020" >366</a>, <a +href="glossaries-user.html#dx1-189062" >367</a>, <a +href="glossaries-user.html#dx1-189063" >368</a>, <a +href="glossaries-user.html#dx1-189065" >369</a>, <a +href="glossaries-user.html#dx1-189071" >370</a>, <a +href="glossaries-user.html#dx1-190021" >371</a>, <a +href="glossaries-user.html#dx1-190022" >372</a>, <a +href="glossaries-user.html#dx1-190023" >373</a>, <a +href="glossaries-user.html#dx1-190025" >374</a>, <a +href="glossaries-user.html#dx1-190032" >375</a>, <a +href="glossaries-user.html#dx1-190036" >376</a>, <a +href="glossaries-user.html#dx1-192029" >377</a>, <a +href="glossaries-user.html#dx1-192030" >378</a>, <a +href="glossaries-user.html#dx1-192032" >379</a>, <a +href="glossaries-user.html#dx1-192036" >380</a>, <a +href="glossaries-user.html#dx1-192050" >381</a>, <a +href="glossaries-user.html#dx1-192060" >382</a>, <a +href="glossaries-user.html#dx1-192071" >383</a>, <a +href="glossaries-user.html#dx1-193003" >384</a>, <a +href="glossaries-user.html#dx1-193004" >385</a>, <a +href="glossaries-user.html#dx1-193006" >386</a>, <a +href="glossaries-user.html#dx1-193015" >387</a>, <a +href="glossaries-user.html#dx1-193016" >388</a>, <a +href="glossaries-user.html#dx1-193029" >389</a>, <a +href="glossaries-user.html#dx1-193033" >390</a>, <a +href="glossaries-user.html#dx1-193052" >391</a>, <a +href="glossaries-user.html#dx1-194003" >392</a>, <a +href="glossaries-user.html#dx1-194004" >393</a>, <a +href="glossaries-user.html#dx1-194008" >394</a>, <a +href="glossaries-user.html#dx1-194012" >395</a>, <a +href="glossaries-user.html#dx1-194021" >396</a>, <a +href="glossaries-user.html#dx1-197005" >397</a>, <a +href="glossaries-user.html#dx1-197006" >398</a>, <a +href="glossaries-user.html#dx1-197009" >399</a>, <a +href="glossaries-user.html#dx1-197020" >400</a>, <a +href="glossaries-user.html#dx1-197029" >401</a>, <a +href="glossaries-user.html#dx1-197031" >402</a>, <a +href="glossaries-user.html#dx1-197035" >403</a>, <a +href="glossaries-user.html#dx1-198017" >404</a>, <a +href="glossaries-user.html#dx1-198018" >405</a>, <a +href="glossaries-user.html#dx1-198020" >406</a>, <a +href="glossaries-user.html#dx1-198041" >407</a>, <a +href="glossaries-user.html#dx1-200030" >408</a>, <a +href="glossaries-user.html#dx1-200037" >409</a>, <a +href="glossaries-user.html#dx1-200041" >410</a>, <a +href="glossaries-user.html#dx1-200042" >411</a>, <a +href="glossaries-user.html#dx1-200053" >412</a>, <a +href="glossaries-user.html#dx1-200055" >413</a>, <a +href="glossaries-user.html#dx1-200056" >414</a>, <a +href="glossaries-user.html#dx1-200059" >415</a>, <a +href="glossaries-user.html#dx1-200064" >416</a>, <a +href="glossaries-user.html#dx1-200067" >417</a>, <a +href="glossaries-user.html#dx1-200072" >418</a>, <a +href="glossaries-user.html#dx1-200074" >419</a>, <a +href="glossaries-user.html#dx1-200076" >420</a>, <a +href="glossaries-user.html#dx1-200081" >421</a>, <a +href="glossaries-user.html#dx1-200084" >422</a>, <a +href="glossaries-user.html#dx1-200085" >423</a>, <a +href="glossaries-user.html#dx1-200096" >424</a>, <a +href="glossaries-user.html#dx1-201002" >425</a>, <a +href="glossaries-user.html#dx1-202048" >426</a>, <a +href="glossaries-user.html#dx1-202049" >427</a>, <a +href="glossaries-user.html#dx1-202052" >428</a>, <a +href="glossaries-user.html#dx1-202056" >429</a>, <a +href="glossaries-user.html#dx1-202077" >430</a>, <a +href="glossaries-user.html#dx1-202080" >431</a>, <a +href="glossaries-user.html#dx1-202103" >432</a>, <a +href="glossaries-user.html#dx1-204017" >433</a>, <a +href="glossaries-user.html#dx1-204018" >434</a>, <a +href="glossaries-user.html#dx1-204022" >435</a>, <a +href="glossaries-user.html#dx1-206005" >436</a>, <a +href="glossaries-user.html#dx1-206006" >437</a>, <a +href="glossaries-user.html#dx1-206009" >438</a>, <a +href="glossaries-user.html#dx1-206021" >439</a>, <a +href="glossaries-user.html#dx1-211035" >440</a>, <a +href="glossaries-user.html#dx1-211036" >441</a>, <a +href="glossaries-user.html#dx1-211040" >442</a>, <a +href="glossaries-user.html#dx1-211042" >443</a>, <a +href="glossaries-user.html#dx1-211051" >444</a>, <a +href="glossaries-user.html#dx1-211053" >445</a>, <a +href="glossaries-user.html#dx1-211054" >446</a>, <a +href="glossaries-user.html#dx1-211069" >447</a>, <a +href="glossaries-user.html#dx1-211088" >448</a>, <a +href="glossaries-user.html#dx1-212005" >449</a>, <a +href="glossaries-user.html#dx1-212006" >450</a>, <a +href="glossaries-user.html#dx1-212010" >451</a>, <a +href="glossaries-user.html#dx1-214009" >452</a>, <a +href="glossaries-user.html#dx1-214010" >453</a>, <a +href="glossaries-user.html#dx1-214014" >454</a>, <a +href="glossaries-user.html#dx1-214015" >455</a>, <a +href="glossaries-user.html#dx1-214018" >456</a>, <a +href="glossaries-user.html#dx1-214021" >457</a>, <a +href="glossaries-user.html#dx1-214023" >458</a>, <a +href="glossaries-user.html#dx1-214028" >459</a>, <a +href="glossaries-user.html#dx1-214033" >460</a>, <a +href="glossaries-user.html#dx1-214036" >461</a>, <a +href="glossaries-user.html#dx1-214042" >462</a>, <a +href="glossaries-user.html#dx1-214046" >463</a>, <a +href="glossaries-user.html#dx1-219002" >464</a>, <a +href="glossaries-user.html#dx1-220018" >465</a>, <a +href="glossaries-user.html#dx1-220019" >466</a>, <a +href="glossaries-user.html#dx1-220023" >467</a>, <a +href="glossaries-user.html#dx1-220029" >468</a>, <a +href="glossaries-user.html#dx1-220032" >469</a>, <a +href="glossaries-user.html#dx1-220037" >470</a>, <a +href="glossaries-user.html#dx1-223005" >471</a>, <a +href="glossaries-user.html#dx1-223006" >472</a>, <a +href="glossaries-user.html#dx1-223007" >473</a>, <a +href="glossaries-user.html#dx1-223010" >474</a>, <a +href="glossaries-user.html#dx1-223016" >475</a>, <a +href="glossaries-user.html#dx1-223017" >476</a>, <a +href="glossaries-user.html#dx1-223024" >477</a>, <a +href="glossaries-user.html#dx1-226004" >478</a>, <a +href="glossaries-user.html#dx1-226005" >479</a>, <a +href="glossaries-user.html#dx1-192042" >480</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">--group</span>  <a +href="glossaries-user.html#dx1-9033" >481</a>, <a +href="glossaries-user.html#dx1-11082" >482</a>, <a +href="glossaries-user.html#dx1-176033" >483</a>, <a +href="glossaries-user.html#dx1-200091" >484</a>, <a +href="glossaries-user.html#dx1-201003" >485</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">--map-format</span>  <a +href="glossaries-user.html#dx1-190037" >486</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">-g</span>  <a +href="glossaries-user.html#dx1-200092" >487</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">-m</span>  <a +href="glossaries-user.html#dx1-190038" >488</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">bib2gls </span>entry types<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@abbreviation</span>  <a +href="glossaries-user.html#dx1-9008" >489</a>, <a +href="glossaries-user.html#dx1-9014" >490</a>, <a +href="glossaries-user.html#dx1-179051" >491</a>, <a +href="glossaries-user.html#dx1-179056" >492</a>, <a +href="glossaries-user.html#dx1-179066" >493</a>, <a +href="glossaries-user.html#dx1-198027" >494</a>, <a +href="glossaries-user.html#dx1-198028" >495</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@acronym</span>  <a +href="glossaries-user.html#dx1-179048" >496</a>, <a +href="glossaries-user.html#dx1-179049" >497</a>, <a +href="glossaries-user.html#dx1-179055" >498</a>, <a +href="glossaries-user.html#dx1-179065" >499</a>, <a +href="glossaries-user.html#dx1-193014" >500</a>, <a +href="glossaries-user.html#dx1-193024" >501</a>, <a +href="glossaries-user.html#dx1-198024" >502</a>, <a +href="glossaries-user.html#dx1-223020" >503</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@dualabbreviationentry</span>  <a +href="glossaries-user.html#dx1-193012" >504</a>, <a +href="glossaries-user.html#dx1-193017" >505</a>, <a +href="glossaries-user.html#dx1-193037" >506</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@dualentry</span>  <a +href="glossaries-user.html#dx1-194014" >507</a>, <a +href="glossaries-user.html#dx1-194017" >508</a>, <a +href="glossaries-user.html#dx1-194020" >509</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@dualindexabbreviation</span>  <a +href="glossaries-user.html#dx1-193038" >510</a>, <a +href="glossaries-user.html#dx1-193039" >511</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@entry</span>  <a +href="glossaries-user.html#dx1-9006" >512</a>, <a +href="glossaries-user.html#dx1-9012" >513</a>, <a +href="glossaries-user.html#dx1-11017" >514</a>, <a +href="glossaries-user.html#dx1-11018" >515</a>, <a +href="glossaries-user.html#dx1-188022" >516</a>, <a +href="glossaries-user.html#dx1-188023" >517</a>, <a +href="glossaries-user.html#dx1-188026" >518</a>, <a +href="glossaries-user.html#dx1-188028" >519</a>, <a +href="glossaries-user.html#dx1-188032" >520</a>, <a +href="glossaries-user.html#dx1-192044" >521</a>, <a +href="glossaries-user.html#dx1-192046" >522</a>, <a +href="glossaries-user.html#dx1-192051" >523</a>, <a +href="glossaries-user.html#dx1-192053" >524</a>, <a +href="glossaries-user.html#dx1-192064" >525</a>, <a +href="glossaries-user.html#dx1-192065" >526</a>, <a +href="glossaries-user.html#dx1-193013" >527</a>, <a +href="glossaries-user.html#dx1-193023" >528</a>, <a +href="glossaries-user.html#dx1-194009" >529</a>, <a +href="glossaries-user.html#dx1-194010" >530</a>, <a +href="glossaries-user.html#dx1-197010" >531</a>, <a +href="glossaries-user.html#dx1-197014" >532</a>, <a +href="glossaries-user.html#dx1-198022" >533</a>, <a +href="glossaries-user.html#dx1-198030" >534</a>, <a +href="glossaries-user.html#dx1-198031" >535</a>, <a +href="glossaries-user.html#dx1-200068" >536</a>, <a +href="glossaries-user.html#dx1-200071" >537</a>, <a +href="glossaries-user.html#dx1-200079" >538</a>, <a +href="glossaries-user.html#dx1-200080" >539</a>, <a +href="glossaries-user.html#dx1-202062" >540</a>, <a +href="glossaries-user.html#dx1-202063" >541</a>, <a +href="glossaries-user.html#dx1-202074" >542</a>, <a +href="glossaries-user.html#dx1-202075" >543</a>, <a +href="glossaries-user.html#dx1-202079" >544</a>, <a +href="glossaries-user.html#dx1-202083" >545</a>, <a +href="glossaries-user.html#dx1-204024" >546</a>, <a +href="glossaries-user.html#dx1-206013" >547</a>, <a +href="glossaries-user.html#dx1-211066" >548</a>, <a +href="glossaries-user.html#dx1-211067" >549</a>, <a +href="glossaries-user.html#dx1-211068" >550</a>, <a +href="glossaries-user.html#dx1-223018" >551</a>, <a +href="glossaries-user.html#dx1-223019" >552</a> <br /></span> + + +<span class="index-subitem">    <span +class="cmtt-10">@index</span>  <a +href="glossaries-user.html#dx1-11089" >553</a>, <a +href="glossaries-user.html#dx1-11091" >554</a>, <a +href="glossaries-user.html#dx1-11092" >555</a>, <a +href="glossaries-user.html#dx1-193040" >556</a>, <a +href="glossaries-user.html#dx1-193041" >557</a>, <a +href="glossaries-user.html#dx1-197013" >558</a>, <a +href="glossaries-user.html#dx1-197018" >559</a>, <a +href="glossaries-user.html#dx1-206012" >560</a>, <a +href="glossaries-user.html#dx1-206014" >561</a>, <a +href="glossaries-user.html#dx1-206015" >562</a>, <a +href="glossaries-user.html#dx1-206016" >563</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@indexplural</span>  <a +href="glossaries-user.html#dx1-202065" >564</a>, <a +href="glossaries-user.html#dx1-202066" >565</a>, <a +href="glossaries-user.html#dx1-202067" >566</a>, <a +href="glossaries-user.html#dx1-202097" >567</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@preamble</span>  <a +href="glossaries-user.html#dx1-197021" >568</a>, <a +href="glossaries-user.html#dx1-197032" >569</a>, <a +href="glossaries-user.html#dx1-197034" >570</a>, <a +href="glossaries-user.html#dx1-200062" >571</a>, <a +href="glossaries-user.html#dx1-200073" >572</a>, <a +href="glossaries-user.html#dx1-200075" >573</a>, <a +href="glossaries-user.html#dx1-211074" >574</a>, <a +href="glossaries-user.html#dx1-211086" >575</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">@symbol</span>  <a +href="glossaries-user.html#dx1-9007" >576</a>, <a +href="glossaries-user.html#dx1-9013" >577</a>, <a +href="glossaries-user.html#dx1-188024" >578</a>, <a +href="glossaries-user.html#dx1-188027" >579</a>, <a +href="glossaries-user.html#dx1-188030" >580</a>, <a +href="glossaries-user.html#dx1-188033" >581</a>, <a +href="glossaries-user.html#dx1-192066" >582</a>, <a +href="glossaries-user.html#dx1-192067" >583</a>, <a +href="glossaries-user.html#dx1-192069" >584</a>, <a +href="glossaries-user.html#dx1-198032" >585</a>, <a +href="glossaries-user.html#dx1-202084" >586</a>, <a +href="glossaries-user.html#dx1-202085" >587</a>, <a +href="glossaries-user.html#dx1-202091" >588</a>, <a +href="glossaries-user.html#dx1-202095" >589</a> <br /></span> <span class="index-item"><span class="cmss-10">booktabs </span>package  <a -href="glossaries-user.html#dx1-80006" >154</a>, <a -href="glossaries-user.html#dx1-81009" >155</a>, <a -href="glossaries-user.html#dx1-82011" >156</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-158006" >590</a>, <a +href="glossaries-user.html#dx1-159009" >591</a>, <a +href="glossaries-user.html#dx1-160011" >592</a>, <a +href="glossaries-user.html#dx1-219005" >593</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\bottomrule</span></span></span>  <a +href="glossaries-user.html#dx1-160014" >594</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">C</span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup>categories<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">abbreviation</span>  <a +href="glossaries-user.html#dx1-175026" >595</a>, <a +href="glossaries-user.html#dx1-175030" >596</a>, <a +href="glossaries-user.html#dx1-178034" >597</a>, <a +href="glossaries-user.html#dx1-179061" >598</a>, <a +href="glossaries-user.html#dx1-182033" >599</a>, <a +href="glossaries-user.html#dx1-184050" >600</a>, <a +href="glossaries-user.html#dx1-186010" >601</a>, <a +href="glossaries-user.html#dx1-224042" >602</a>, <a +href="glossaries-user.html#dx1-224061" >603</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">acronym</span>  <a +href="glossaries-user.html#dx1-175022" >604</a>, <a +href="glossaries-user.html#dx1-175024" >605</a>, <a +href="glossaries-user.html#dx1-175031" >606</a>, <a +href="glossaries-user.html#dx1-175034" >607</a>, <a +href="glossaries-user.html#dx1-178028" >608</a>, <a +href="glossaries-user.html#dx1-179015" >609</a>, <a +href="glossaries-user.html#dx1-179062" >610</a>, <a +href="glossaries-user.html#dx1-182034" >611</a>, <a +href="glossaries-user.html#dx1-184051" >612</a>, <a +href="glossaries-user.html#dx1-186012" >613</a>, <a +href="glossaries-user.html#dx1-186028" >614</a>, <a +href="glossaries-user.html#dx1-224057" >615</a>, <a +href="glossaries-user.html#dx1-224062" >616</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">general</span>  <a +href="glossaries-user.html#dx1-183018" >617</a>, <a +href="glossaries-user.html#dx1-200018" >618</a>, <a +href="glossaries-user.html#dx1-202019" >619</a>, <a +href="glossaries-user.html#dx1-224060" >620</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">index</span>  <a +href="glossaries-user.html#dx1-224063" >621</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">number</span>  <a +href="glossaries-user.html#dx1-224065" >622</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">symbol</span>  <a +href="glossaries-user.html#dx1-202031" >623</a>, <a +href="glossaries-user.html#dx1-202099" >624</a>, <a +href="glossaries-user.html#dx1-224064" >625</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup>category attributes  <a +href="glossaries-user.html#dx1-147033" >626</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">discardperiod</span>  <a +href="glossaries-user.html#dx1-185006" >627</a>, <a +href="glossaries-user.html#dx1-186021" >628</a>, <a +href="glossaries-user.html#dx1-186024" >629</a>, <a +href="glossaries-user.html#dx1-224059" >630</a>, <a +href="glossaries-user.html#dx1-224070" >631</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">glossdesc</span>  <a +href="glossaries-user.html#dx1-11039" >632</a>, <a +href="glossaries-user.html#dx1-182026" >633</a>, <a +href="glossaries-user.html#dx1-183029" >634</a>, <a +href="glossaries-user.html#dx1-189012" >635</a>, <a +href="glossaries-user.html#dx1-189014" >636</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">glossdescfont</span>  <a +href="glossaries-user.html#dx1-11040" >637</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">glossname</span>  <a +href="glossaries-user.html#dx1-11054" >638</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">glosssymbolfont</span>  <a +href="glossaries-user.html#dx1-189050" >639</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">hyperoutside</span>  <a +href="glossaries-user.html#dx1-29" >640</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">indexonlyfirst</span>  <a +href="glossaries-user.html#dx1-64007" >641</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">insertdots</span>  <a +href="glossaries-user.html#dx1-185013" >642</a>, <a +href="glossaries-user.html#dx1-185016" >643</a>, <a +href="glossaries-user.html#dx1-186019" >644</a>, <a +href="glossaries-user.html#dx1-186020" >645</a>, <a +href="glossaries-user.html#dx1-224069" >646</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">nohyperfirst</span>  <a +href="glossaries-user.html#dx1-34024" >647</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">noshortplural</span>  <a +href="glossaries-user.html#dx1-185008" >648</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">pluraldiscardperiod</span>  <a +href="glossaries-user.html#dx1-185009" >649</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">retainfirstuseperiod</span>  <a +href="glossaries-user.html#dx1-185010" >650</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">textformat</span>  <a +href="glossaries-user.html#dx1-30" >651</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cGls</span></span></span>  <a -href="glossaries-user.html#dx1-76010" ><span -class="cmti-10">157</span></a> <br /></span> +href="glossaries-user.html#dx1-154011" ><span +class="cmti-10">652</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cgls</span></span></span>  <a -href="glossaries-user.html#dx1-76008" ><span -class="cmti-10">158</span></a> <br /></span> +href="glossaries-user.html#dx1-154009" ><span +class="cmti-10">653</span></a>, <a +href="glossaries-user.html#dx1-226002" >654</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cGlsformat</span></span></span>  <a -href="glossaries-user.html#dx1-76014" ><span -class="cmti-10">159</span></a> <br /></span> +href="glossaries-user.html#dx1-154015" ><span +class="cmti-10">655</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cglsformat</span></span></span>  <a -href="glossaries-user.html#dx1-76012" ><span -class="cmti-10">160</span></a> <br /></span> +href="glossaries-user.html#dx1-154013" ><span +class="cmti-10">656</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cGlspl</span></span></span>  <a -href="glossaries-user.html#dx1-76011" ><span -class="cmti-10">161</span></a> <br /></span> +href="glossaries-user.html#dx1-154012" ><span +class="cmti-10">657</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cglspl</span></span></span>  <a -href="glossaries-user.html#dx1-76009" ><span -class="cmti-10">162</span></a> <br /></span> - - +href="glossaries-user.html#dx1-154010" ><span +class="cmti-10">658</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cGlsplformat</span></span></span>  <a -href="glossaries-user.html#dx1-76015" ><span -class="cmti-10">163</span></a> <br /></span> +href="glossaries-user.html#dx1-154016" ><span +class="cmti-10">659</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\cglsplformat</span></span></span>  <a -href="glossaries-user.html#dx1-76013" ><span -class="cmti-10">164</span></a> <br /></span> +href="glossaries-user.html#dx1-154014" ><span +class="cmti-10">660</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\chapter</span></span></span>  <a +href="glossaries-user.html#dx1-141067" >661</a>, <a +href="glossaries-user.html#dx1-197026" >662</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\chapter*</span></span></span>  <a +href="glossaries-user.html#dx1-43012" >663</a>, <a +href="glossaries-user.html#dx1-141065" >664</a> <br /></span> <span class="index-item"><span class="cmss-10">classicthesis </span>package  <a -href="glossaries-user.html#dx1-25027" >165</a>, <a -href="glossaries-user.html#dx1-25045" >166</a>, <a -href="glossaries-user.html#dx1-25050" >167</a>, <a -href="glossaries-user.html#dx1-79007" >168</a>, <a -href="glossaries-user.html#dx1-79046" >169</a> <br /></span> +href="glossaries-user.html#dx1-49002" >665</a>, <a +href="glossaries-user.html#dx1-52004" >666</a>, <a +href="glossaries-user.html#dx1-53003" >667</a>, <a +href="glossaries-user.html#dx1-157007" >668</a>, <a +href="glossaries-user.html#dx1-157046" >669</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">convertgls2bib</span>  <a +href="glossaries-user.html#dx1-3006" ><span +class="cmbx-10">670</span></a>, <a +href="glossaries-user.html#dx1-3011" >671</a>, <a +href="glossaries-user.html#dx1-175051" >672</a>, <a +href="glossaries-user.html#dx1-176015" >673</a>, <a +href="glossaries-user.html#dx1-188021" >674</a>, <a +href="glossaries-user.html#dx1-189064" >675</a>, <a +href="glossaries-user.html#dx1-190027" >676</a>, <a +href="glossaries-user.html#dx1-192039" >677</a>, <a +href="glossaries-user.html#dx1-192062" >678</a>, <a +href="glossaries-user.html#dx1-193007" >679</a>, <a +href="glossaries-user.html#dx1-193008" >680</a>, <a +href="glossaries-user.html#dx1-193009" >681</a>, <a +href="glossaries-user.html#dx1-193010" >682</a>, <a +href="glossaries-user.html#dx1-193011" >683</a>, <a +href="glossaries-user.html#dx1-200060" >684</a>, <a +href="glossaries-user.html#dx1-200065" >685</a>, <a +href="glossaries-user.html#dx1-204023" >686</a>, <a +href="glossaries-user.html#dx1-214022" >687</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\currentglossary</span></span></span>  <a -href="glossaries-user.html#dx1-88070" ><span -class="cmti-10">170</span></a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-166070" ><span +class="cmti-10">688</span></a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">D</span> <span class="index-item"><span class="cmss-10">datatool </span>package  <a -href="glossaries-user.html#dx1-13" >171</a>, <a -href="glossaries-user.html#dx1-63045" >172</a>, <a -href="glossaries-user.html#dx1-63048" >173</a>, <a -href="glossaries-user.html#dx1-63050" >174</a>, <a -href="glossaries-user.html#dx1-63052" >175</a> <br /></span> +href="glossaries-user.html#dx1-12" >689</a>, <a +href="glossaries-user.html#dx1-141047" >690</a>, <a +href="glossaries-user.html#dx1-141050" >691</a>, <a +href="glossaries-user.html#dx1-141052" >692</a>, <a +href="glossaries-user.html#dx1-141054" >693</a> <br /></span> + + <span class="index-item"><span class="cmss-10">datatool-base </span>package  <a -href="glossaries-user.html#dx1-12" >176</a>, <a -href="glossaries-user.html#dx1-13019" >177</a> <br /></span> +href="glossaries-user.html#dx1-11" >694</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\DeclareAcronymList</span></span></span>  <a -href="glossaries-user.html#dx1-27022" ><span -class="cmti-10">178</span></a> <br /></span> +href="glossaries-user.html#dx1-93003" ><span +class="cmti-10">695</span></a>, <a +href="glossaries-user.html#dx1-135011" >696</a>, <a +href="glossaries-user.html#dx1-147016" >697</a>, <a +href="glossaries-user.html#dx1-168003" >698</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\defentryfmt</span></span></span>  <a +href="glossaries-user.html#dx1-147048" >699</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\defglsentry</span></span></span>  <a +href="glossaries-user.html#dx1-3035" >700</a>, <a +href="glossaries-user.html#dx1-134024" >701</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\defglsentryfmt</span></span></span>  <a -href="glossaries-user.html#dx1-57007" ><span -class="cmti-10">179</span></a> <br /></span> +href="glossaries-user.html#dx1-132027" >702</a>, <a +href="glossaries-user.html#dx1-133002" >703</a>, <a +href="glossaries-user.html#dx1-134002" >704</a>, <a +href="glossaries-user.html#dx1-135007" ><span +class="cmti-10">705</span></a>, <a +href="glossaries-user.html#dx1-135009" >706</a>, <a +href="glossaries-user.html#dx1-147017" >707</a>, <a +href="glossaries-user.html#dx1-147018" >708</a>, <a +href="glossaries-user.html#dx1-148004" >709</a>, <a +href="glossaries-user.html#dx1-150002" >710</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\DefineAcronymSynonyms</span></span></span>  <a -href="glossaries-user.html#dx1-27027" ><span -class="cmti-10">180</span></a> <br /></span> +href="glossaries-user.html#dx1-94001" ><span +class="cmti-10">711</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\delimN</span></span></span>  <a +href="glossaries-user.html#dx1-166054" >712</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\delimR</span></span></span>  <a +href="glossaries-user.html#dx1-166055" >713</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\descriptionname</span></span></span>  <a +href="glossaries-user.html#dx1-14028" >714</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dgls</span></span></span>  <a +href="glossaries-user.html#dx1-24025" >715</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dicei</span></span></span>  <a +href="glossaries-user.html#dx1-211023" >716</a> <br /></span> <span class="index-item"><span class="cmss-10">doc </span>package  <a -href="glossaries-user.html#dx1-21" >181</a>, <a -href="glossaries-user.html#dx1-22" >182</a>, <a -href="glossaries-user.html#dx1-26" >183</a>, <a -href="glossaries-user.html#dx1-29044" >184</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-20" >717</a>, <a +href="glossaries-user.html#dx1-21" >718</a>, <a +href="glossaries-user.html#dx1-25" >719</a>, <a +href="glossaries-user.html#dx1-107010" >720</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dtlcompare</span></span></span>  <a +href="glossaries-user.html#dx1-141053" >721</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dtlicompare</span></span></span>  <a +href="glossaries-user.html#dx1-141051" >722</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dtlletterindexcompare</span></span></span>  <a +href="glossaries-user.html#dx1-141049" >723</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\dtlwordindexcompare</span></span></span>  <a +href="glossaries-user.html#dx1-141048" >724</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">E</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\edef</span></span></span>  <a +href="glossaries-user.html#dx1-135014" >725</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\emph</span></span></span>  <a +href="glossaries-user.html#dx1-132047" >726</a> <br /></span> <span class="index-item">encap  <a -href="glossaries-user.html#dx1-50002" >185</a> <br /></span> +href="glossaries-user.html#dx1-128002" >727</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\EndAccSupp</span></span></span>  <a +href="glossaries-user.html#dx1-172075" >728</a>, <a +href="glossaries-user.html#dx1-224004" >729</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ensuremath</span></span></span>  <a +href="glossaries-user.html#dx1-189047" >730</a>, <a +href="glossaries-user.html#dx1-189048" >731</a> <br /></span> <span class="index-item">entry location  <a -href="glossaries-user.html#dx1-3002" ><span -class="cmbx-10">186</span></a> <br /></span> +href="glossaries-user.html#dx1-3013" ><span +class="cmbx-10">732</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\entryname</span></span></span>  <a +href="glossaries-user.html#dx1-14027" >733</a> <br /></span> <span class="index-item">environments:<br /></span> <span class="index-subitem">    <span class="cmtt-10">theglossary</span>  <a -href="glossaries-user.html#dx1-88003" ><span -class="cmti-10">187</span></a> <br /></span> +href="glossaries-user.html#dx1-166003" ><span +class="cmti-10">734</span></a> <br /></span> <span class="index-item"><span class="cmss-10">etoolbox </span>package  <a -href="glossaries-user.html#dx1-8" >188</a>, <a -href="glossaries-user.html#dx1-26043" >189</a>, <a -href="glossaries-user.html#dx1-57018" >190</a>, <a -href="glossaries-user.html#dx1-91030" >191</a>, <a -href="glossaries-user.html#dx1-91033" >192</a>, <a -href="glossaries-user.html#dx1-91035" >193</a> <br /></span> +href="glossaries-user.html#dx1-7" >735</a>, <a +href="glossaries-user.html#dx1-73041" >736</a>, <a +href="glossaries-user.html#dx1-135018" >737</a>, <a +href="glossaries-user.html#dx1-169030" >738</a>, <a +href="glossaries-user.html#dx1-169033" >739</a>, <a +href="glossaries-user.html#dx1-169035" >740</a>, <a +href="glossaries-user.html#dx1-200040" >741</a>, <a +href="glossaries-user.html#dx1-200050" >742</a> <br /></span> <span class="index-item">Extended Latin Alphabet  <a -href="glossaries-user.html#dx1-3003" ><span -class="cmbx-10">194</span></a> <br /></span> +href="glossaries-user.html#dx1-3014" ><span +class="cmbx-10">743</span></a> <br /></span> <span class="index-item">extended Latin character  <a -href="glossaries-user.html#dx1-3005" >195</a>, <a -href="glossaries-user.html#dx1-3006" ><span -class="cmbx-10">196</span></a>, <a -href="glossaries-user.html#dx1-3030" >197</a>, <a -href="glossaries-user.html#dx1-3045" >198</a>, <a -href="glossaries-user.html#dx1-3052" >199</a>, <a -href="glossaries-user.html#dx1-11098" >200</a>, <a -href="glossaries-user.html#dx1-34008" >201</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-3016" >744</a>, <a +href="glossaries-user.html#dx1-3017" ><span +class="cmbx-10">745</span></a>, <a +href="glossaries-user.html#dx1-3041" >746</a>, <a +href="glossaries-user.html#dx1-3057" >747</a>, <a +href="glossaries-user.html#dx1-3068" >748</a>, <a +href="glossaries-user.html#dx1-112007" >749</a>, <a +href="glossaries-user.html#dx1-214007" >750</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">F</span> <span class="index-item">file types<br /></span> <span class="index-subitem">    <span -class="cmtt-10">.alg</span>  <a -href="glossaries-user.html#dx1-16079" >202</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.aux</span>  <a -href="glossaries-user.html#dx1-13024" >203</a>, <a -href="glossaries-user.html#dx1-17002" >204</a>, <a -href="glossaries-user.html#dx1-17018" >205</a>, <a -href="glossaries-user.html#dx1-54008" >206</a>, <a -href="glossaries-user.html#dx1-65004" >207</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.glg</span>  <a -href="glossaries-user.html#dx1-16078" >208</a>, <a -href="glossaries-user.html#dx1-19016" >209</a>, <a -href="glossaries-user.html#dx1-20013" >210</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.glg2</span>  <a -href="glossaries-user.html#dx1-25" >211</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.glo</span>  <a -href="glossaries-user.html#dx1-17019" >212</a>, <a -href="glossaries-user.html#dx1-19018" >213</a>, <a -href="glossaries-user.html#dx1-20015" >214</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.gls</span>  <a -href="glossaries-user.html#dx1-19017" >215</a>, <a -href="glossaries-user.html#dx1-20014" >216</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.glsdefs</span>  <a -href="glossaries-user.html#dx1-44013" >217</a>, <a -href="glossaries-user.html#dx1-47013" >218</a>, <a -href="glossaries-user.html#dx1-47017" >219</a>, <a -href="glossaries-user.html#dx1-47018" >220</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.ist</span>  <a -href="glossaries-user.html#dx1-20005" >221</a>, <a -href="glossaries-user.html#dx1-20007" >222</a>, <a -href="glossaries-user.html#dx1-21006" >223</a>, <a -href="glossaries-user.html#dx1-26061" >224</a>, <a -href="glossaries-user.html#dx1-33003" >225</a>, <a -href="glossaries-user.html#dx1-33012" >226</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.tex</span>  <a -href="glossaries-user.html#dx1-13014" >227</a>, <a -href="glossaries-user.html#dx1-13023" >228</a>, <a -href="glossaries-user.html#dx1-19010" >229</a>, <a -href="glossaries-user.html#dx1-20004" >230</a> <br /></span> -<span class="index-subitem">    <span -class="cmtt-10">.xdy</span>  <a -href="glossaries-user.html#dx1-19012" >231</a>, <a -href="glossaries-user.html#dx1-19013" >232</a>, <a -href="glossaries-user.html#dx1-21008" >233</a>, <a -href="glossaries-user.html#dx1-26070" >234</a>, <a -href="glossaries-user.html#dx1-33005" >235</a>, <a -href="glossaries-user.html#dx1-33009" >236</a>, <a -href="glossaries-user.html#dx1-33014" >237</a>, <a -href="glossaries-user.html#dx1-64005" >238</a> <br /></span> +class="cmtt-10">alg</span>  <a +href="glossaries-user.html#dx1-16082" >751</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">aux</span>  <a +href="glossaries-user.html#dx1-3003" >752</a>, <a +href="glossaries-user.html#dx1-7039" >753</a>, <a +href="glossaries-user.html#dx1-8038" >754</a>, <a +href="glossaries-user.html#dx1-11045" >755</a>, <a +href="glossaries-user.html#dx1-13022" >756</a>, <a +href="glossaries-user.html#dx1-17002" >757</a>, <a +href="glossaries-user.html#dx1-17018" >758</a>, <a +href="glossaries-user.html#dx1-21004" >759</a>, <a +href="glossaries-user.html#dx1-22022" >760</a>, <a +href="glossaries-user.html#dx1-24002" >761</a>, <a +href="glossaries-user.html#dx1-24014" >762</a>, <a +href="glossaries-user.html#dx1-24020" >763</a>, <a +href="glossaries-user.html#dx1-31003" >764</a>, <a +href="glossaries-user.html#dx1-63010" >765</a>, <a +href="glossaries-user.html#dx1-129001" >766</a>, <a +href="glossaries-user.html#dx1-132008" >767</a>, <a +href="glossaries-user.html#dx1-143004" >768</a>, <a +href="glossaries-user.html#dx1-154004" >769</a>, <a +href="glossaries-user.html#dx1-192012" >770</a>, <a +href="glossaries-user.html#dx1-192031" >771</a>, <a +href="glossaries-user.html#dx1-202016" >772</a>, <a +href="glossaries-user.html#dx1-211004" >773</a>, <a +href="glossaries-user.html#dx1-214038" >774</a>, <a +href="glossaries-user.html#dx1-214040" >775</a>, <a +href="glossaries-user.html#dx1-214044" >776</a>, <a +href="glossaries-user.html#dx1-220010" >777</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">bib</span>  <a +href="glossaries-user.html#dx1-3002" >778</a>, <a +href="glossaries-user.html#dx1-3009" >779</a>, <a +href="glossaries-user.html#dx1-5010" >780</a>, <a +href="glossaries-user.html#dx1-9002" >781</a>, <a +href="glossaries-user.html#dx1-9009" >782</a>, <a +href="glossaries-user.html#dx1-9026" >783</a>, <a +href="glossaries-user.html#dx1-11090" >784</a>, <a +href="glossaries-user.html#dx1-12004" >785</a>, <a +href="glossaries-user.html#dx1-13011" >786</a>, <a +href="glossaries-user.html#dx1-24006" >787</a>, <a +href="glossaries-user.html#dx1-35006" >788</a>, <a +href="glossaries-user.html#dx1-67004" >789</a>, <a +href="glossaries-user.html#dx1-67007" >790</a>, <a +href="glossaries-user.html#dx1-112002" >791</a>, <a +href="glossaries-user.html#dx1-137007" >792</a>, <a +href="glossaries-user.html#dx1-175049" >793</a>, <a +href="glossaries-user.html#dx1-176014" >794</a>, <a +href="glossaries-user.html#dx1-179045" >795</a>, <a +href="glossaries-user.html#dx1-188019" >796</a>, <a +href="glossaries-user.html#dx1-188037" >797</a>, <a +href="glossaries-user.html#dx1-190026" >798</a>, <a +href="glossaries-user.html#dx1-192033" >799</a>, <a +href="glossaries-user.html#dx1-192040" >800</a>, <a +href="glossaries-user.html#dx1-192049" >801</a>, <a +href="glossaries-user.html#dx1-192070" >802</a>, <a +href="glossaries-user.html#dx1-193005" >803</a>, <a +href="glossaries-user.html#dx1-194007" >804</a>, <a +href="glossaries-user.html#dx1-197008" >805</a>, <a +href="glossaries-user.html#dx1-197019" >806</a>, <a +href="glossaries-user.html#dx1-198019" >807</a>, <a +href="glossaries-user.html#dx1-198040" >808</a>, <a +href="glossaries-user.html#dx1-200058" >809</a>, <a +href="glossaries-user.html#dx1-200061" >810</a>, <a +href="glossaries-user.html#dx1-202051" >811</a>, <a +href="glossaries-user.html#dx1-202061" >812</a>, <a +href="glossaries-user.html#dx1-202089" >813</a>, <a +href="glossaries-user.html#dx1-202100" >814</a>, <a +href="glossaries-user.html#dx1-204021" >815</a>, <a +href="glossaries-user.html#dx1-206008" >816</a>, <a +href="glossaries-user.html#dx1-211041" >817</a>, <a +href="glossaries-user.html#dx1-211087" >818</a>, <a +href="glossaries-user.html#dx1-212009" >819</a>, <a +href="glossaries-user.html#dx1-214017" >820</a>, <a +href="glossaries-user.html#dx1-214019" >821</a>, <a +href="glossaries-user.html#dx1-214041" >822</a>, <a +href="glossaries-user.html#dx1-220022" >823</a>, <a +href="glossaries-user.html#dx1-223009" >824</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">dict</span>  <a +href="glossaries-user.html#dx1-15004" >825</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">docdefs</span>  <a +href="glossaries-user.html#dx1-31002" >826</a>, <a +href="glossaries-user.html#dx1-37005" >827</a>, <a +href="glossaries-user.html#dx1-37010" >828</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glg</span>  <a +href="glossaries-user.html#dx1-16081" >829</a>, <a +href="glossaries-user.html#dx1-19016" >830</a>, <a +href="glossaries-user.html#dx1-20013" >831</a>, <a +href="glossaries-user.html#dx1-214043" >832</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glg2</span>  <a +href="glossaries-user.html#dx1-24" >833</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glo</span>  <a +href="glossaries-user.html#dx1-7025" >834</a>, <a +href="glossaries-user.html#dx1-8026" >835</a>, <a +href="glossaries-user.html#dx1-17019" >836</a>, <a +href="glossaries-user.html#dx1-19018" >837</a>, <a +href="glossaries-user.html#dx1-20015" >838</a>, <a +href="glossaries-user.html#dx1-84001" >839</a>, <a +href="glossaries-user.html#dx1-190007" >840</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">glo2</span>  <a -href="glossaries-user.html#dx1-24" >239</a> <br /></span> +href="glossaries-user.html#dx1-23" >841</a> <br /></span> + + +<span class="index-subitem">    <span +class="cmtt-10">gls</span>  <a +href="glossaries-user.html#dx1-19017" >842</a>, <a +href="glossaries-user.html#dx1-20014" >843</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">gls2</span>  <a -href="glossaries-user.html#dx1-23" >240</a> <br /></span> +href="glossaries-user.html#dx1-22" >844</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glsdefs</span>  <a +href="glossaries-user.html#dx1-23003" >845</a>, <a +href="glossaries-user.html#dx1-122013" >846</a>, <a +href="glossaries-user.html#dx1-125013" >847</a>, <a +href="glossaries-user.html#dx1-125017" >848</a>, <a +href="glossaries-user.html#dx1-125018" >849</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glslabels</span>  <a +href="glossaries-user.html#dx1-35001" >850</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">glstex</span>  <a +href="glossaries-user.html#dx1-24004" >851</a>, <a +href="glossaries-user.html#dx1-24012" >852</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">ist</span>  <a +href="glossaries-user.html#dx1-7026" >853</a>, <a +href="glossaries-user.html#dx1-20005" >854</a>, <a +href="glossaries-user.html#dx1-20007" >855</a>, <a +href="glossaries-user.html#dx1-22007" >856</a>, <a +href="glossaries-user.html#dx1-75007" >857</a>, <a +href="glossaries-user.html#dx1-111003" >858</a>, <a +href="glossaries-user.html#dx1-111012" >859</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">ldf</span>  <a +href="glossaries-user.html#dx1-15003" >860</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">lua</span>  <a +href="glossaries-user.html#dx1-18005" >861</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">tex</span>  <a +href="glossaries-user.html#dx1-3008" >862</a>, <a +href="glossaries-user.html#dx1-13014" >863</a>, <a +href="glossaries-user.html#dx1-13021" >864</a>, <a +href="glossaries-user.html#dx1-19010" >865</a>, <a +href="glossaries-user.html#dx1-20004" >866</a>, <a +href="glossaries-user.html#dx1-179071" >867</a>, <a +href="glossaries-user.html#dx1-211073" >868</a>, <a +href="glossaries-user.html#dx1-214020" >869</a>, <a +href="glossaries-user.html#dx1-214037" >870</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">toc</span>  <a +href="glossaries-user.html#dx1-178016" >871</a>, <a +href="glossaries-user.html#dx1-181008" >872</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">xdy</span>  <a +href="glossaries-user.html#dx1-8027" >873</a>, <a +href="glossaries-user.html#dx1-19012" >874</a>, <a +href="glossaries-user.html#dx1-19013" >875</a>, <a +href="glossaries-user.html#dx1-22009" >876</a>, <a +href="glossaries-user.html#dx1-76007" >877</a>, <a +href="glossaries-user.html#dx1-111005" >878</a>, <a +href="glossaries-user.html#dx1-111009" >879</a>, <a +href="glossaries-user.html#dx1-111014" >880</a>, <a +href="glossaries-user.html#dx1-142005" >881</a>, <a +href="glossaries-user.html#dx1-211020" >882</a>, <a +href="glossaries-user.html#dx1-211022" >883</a>, <a +href="glossaries-user.html#dx1-211026" >884</a>, <a +href="glossaries-user.html#dx1-211028" >885</a>, <a +href="glossaries-user.html#dx1-211029" >886</a>, <a +href="glossaries-user.html#dx1-211033" >887</a>, <a +href="glossaries-user.html#dx1-212004" >888</a> <br /></span> <span class="index-item">first use  <a -href="glossaries-user.html#dx1-3010" >241</a> <br /></span> +href="glossaries-user.html#dx1-3021" >889</a> <br /></span> <span class="index-subitem">    flag  <a -href="glossaries-user.html#dx1-3018" >242</a> <br /></span> +href="glossaries-user.html#dx1-3029" >890</a> <br /></span> <span class="index-subitem">    text  <a -href="glossaries-user.html#dx1-3019" >243</a> <br /></span> +href="glossaries-user.html#dx1-3030" >891</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\firstacronymfont</span></span></span>  <a -href="glossaries-user.html#dx1-71001" ><span -class="cmti-10">244</span></a> <br /></span> +href="glossaries-user.html#dx1-135064" >892</a>, <a +href="glossaries-user.html#dx1-149001" ><span +class="cmti-10">893</span></a>, <a +href="glossaries-user.html#dx1-149003" >894</a>, <a +href="glossaries-user.html#dx1-149004" >895</a>, <a +href="glossaries-user.html#dx1-149006" >896</a>, <a +href="glossaries-user.html#dx1-149025" >897</a>, <a +href="glossaries-user.html#dx1-149033" >898</a> <br /></span> <span class="index-item"><span class="cmss-10">flowfram </span>package  <a -href="glossaries-user.html#dx1-83011" >245</a> <br /></span> +href="glossaries-user.html#dx1-161011" >899</a> <br /></span> <span class="index-item"><span class="cmss-10">fmtcount </span>package  <a -href="glossaries-user.html#dx1-11090" >246</a>, <a -href="glossaries-user.html#dx1-66047" >247</a>, <a -href="glossaries-user.html#dx1-66049" >248</a>, <a -href="glossaries-user.html#dx1-66050" >249</a> <br /></span> +href="glossaries-user.html#dx1-144050" >900</a>, <a +href="glossaries-user.html#dx1-144052" >901</a>, <a +href="glossaries-user.html#dx1-144053" >902</a>, <a +href="glossaries-user.html#dx1-213001" >903</a> <br /></span> <span class="index-item"><span class="cmss-10">fontspec </span>package  <a -href="glossaries-user.html#dx1-34142" >250</a>, <a -href="glossaries-user.html#dx1-67006" >251</a> <br /></span> - - +href="glossaries-user.html#dx1-112155" >904</a>, <a +href="glossaries-user.html#dx1-145006" >905</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\footnote</span></span></span>  <a +href="glossaries-user.html#dx1-149067" >906</a>, <a +href="glossaries-user.html#dx1-182018" >907</a>, <a +href="glossaries-user.html#dx1-182021" >908</a>, <a +href="glossaries-user.html#dx1-183004" >909</a>, <a +href="glossaries-user.html#dx1-183010" >910</a>, <a +href="glossaries-user.html#dx1-183015" >911</a>, <a +href="glossaries-user.html#dx1-183024" >912</a>, <a +href="glossaries-user.html#dx1-183036" >913</a>, <a +href="glossaries-user.html#dx1-184054" >914</a>, <a +href="glossaries-user.html#dx1-184057" >915</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\forallacronyms</span></span></span>  <a -href="glossaries-user.html#dx1-90002" ><span -class="cmti-10">252</span></a> <br /></span> +href="glossaries-user.html#dx1-168002" ><span +class="cmti-10">916</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\forallglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-90001" ><span -class="cmti-10">253</span></a> <br /></span> +href="glossaries-user.html#dx1-168001" ><span +class="cmti-10">917</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\forallglsentries</span></span></span>  <a -href="glossaries-user.html#dx1-90007" ><span -class="cmti-10">254</span></a> <br /></span> +href="glossaries-user.html#dx1-168007" ><span +class="cmti-10">918</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\foreignlanguage</span></span></span>  <a +href="glossaries-user.html#dx1-194031" >919</a>, <a +href="glossaries-user.html#dx1-194034" >920</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\forglsentries</span></span></span>  <a -href="glossaries-user.html#dx1-90005" ><span -class="cmti-10">255</span></a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-168005" ><span +class="cmti-10">921</span></a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">G</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Genacrfullformat</span></span></span>  <a -href="glossaries-user.html#dx1-57065" ><span -class="cmti-10">256</span></a> <br /></span> +href="glossaries-user.html#dx1-135065" ><span +class="cmti-10">922</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\genacrfullformat</span></span></span>  <a -href="glossaries-user.html#dx1-57059" ><span -class="cmti-10">257</span></a> <br /></span> +href="glossaries-user.html#dx1-135059" ><span +class="cmti-10">923</span></a>, <a +href="glossaries-user.html#dx1-135070" >924</a>, <a +href="glossaries-user.html#dx1-148008" >925</a>, <a +href="glossaries-user.html#dx1-150015" >926</a>, <a +href="glossaries-user.html#dx1-150019" >927</a>, <a +href="glossaries-user.html#dx1-150048" >928</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GenericAcronymFields</span></span></span>  <a -href="glossaries-user.html#dx1-72022" ><span -class="cmti-10">258</span></a> <br /></span> +href="glossaries-user.html#dx1-150022" ><span +class="cmti-10">929</span></a>, <a +href="glossaries-user.html#dx1-150064" >930</a>, <a +href="glossaries-user.html#dx1-150068" >931</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Genplacrfullformat</span></span></span>  <a -href="glossaries-user.html#dx1-57066" ><span -class="cmti-10">259</span></a> <br /></span> +href="glossaries-user.html#dx1-135066" ><span +class="cmti-10">932</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\genplacrfullformat</span></span></span>  <a -href="glossaries-user.html#dx1-57061" ><span -class="cmti-10">260</span></a> <br /></span> +href="glossaries-user.html#dx1-135061" ><span +class="cmti-10">933</span></a>, <a +href="glossaries-user.html#dx1-135071" >934</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glolinkprefix</span></span></span>  <a +href="glossaries-user.html#dx1-132088" >935</a>, <a +href="glossaries-user.html#dx1-141062" >936</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries </span>package  <a -href="glossaries-user.html#dx1-3" >261</a>, <a -href="glossaries-user.html#dx1-12001" >262</a>, <a -href="glossaries-user.html#dx1-14008" >263</a>, <a -href="glossaries-user.html#dx1-29038" >264</a>, <a -href="glossaries-user.html#dx1-29041" >265</a>, <a -href="glossaries-user.html#dx1-44011" >266</a>, <a -href="glossaries-user.html#dx1-51007" >267</a>, <a -href="glossaries-user.html#dx1-51014" >268</a>, <a -href="glossaries-user.html#dx1-54021" >269</a>, <a -href="glossaries-user.html#dx1-54040" >270</a> <br /></span> +href="glossaries-user.html#dx1-12001" >937</a>, <a +href="glossaries-user.html#dx1-14008" >938</a>, <a +href="glossaries-user.html#dx1-32033" >939</a>, <a +href="glossaries-user.html#dx1-80005" >940</a>, <a +href="glossaries-user.html#dx1-107004" >941</a>, <a +href="glossaries-user.html#dx1-107007" >942</a>, <a +href="glossaries-user.html#dx1-122011" >943</a>, <a +href="glossaries-user.html#dx1-129008" >944</a>, <a +href="glossaries-user.html#dx1-129015" >945</a>, <a +href="glossaries-user.html#dx1-132021" >946</a>, <a +href="glossaries-user.html#dx1-132040" >947</a>, <a +href="glossaries-user.html#dx1-137012" >948</a>, <a +href="glossaries-user.html#dx1-172003" >949</a>, <a +href="glossaries-user.html#dx1-172004" >950</a>, <a +href="glossaries-user.html#dx1-172005" >951</a>, <a +href="glossaries-user.html#dx1-172010" >952</a>, <a +href="glossaries-user.html#dx1-178017" >953</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries-accsupp </span>package  <a -href="glossaries-user.html#dx1-11118" >271</a>, <a -href="glossaries-user.html#dx1-34016" >272</a>, <a -href="glossaries-user.html#dx1-94001" >273</a>, <a -href="glossaries-user.html#dx1-94033" >274</a> <br /></span> +href="glossaries-user.html#dx1-30014" >954</a>, <a +href="glossaries-user.html#dx1-102001" >955</a>, <a +href="glossaries-user.html#dx1-112015" >956</a>, <a +href="glossaries-user.html#dx1-172001" >957</a>, <a +href="glossaries-user.html#dx1-172007" >958</a>, <a +href="glossaries-user.html#dx1-172011" >959</a>, <a +href="glossaries-user.html#dx1-172012" >960</a>, <a +href="glossaries-user.html#dx1-172056" >961</a>, <a +href="glossaries-user.html#dx1-172060" >962</a>, <a +href="glossaries-user.html#dx1-172064" >963</a>, <a +href="glossaries-user.html#dx1-224001" >964</a>, <a +href="glossaries-user.html#dx1-224006" >965</a>, <a +href="glossaries-user.html#dx1-224009" >966</a>, <a +href="glossaries-user.html#dx1-224010" >967</a>, <a +href="glossaries-user.html#dx1-224017" >968</a>, <a +href="glossaries-user.html#dx1-224038" >969</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries-babel </span>package  <a -href="glossaries-user.html#dx1-23068" >275</a>, <a -href="glossaries-user.html#dx1-23079" >276</a> <br /></span> +href="glossaries-user.html#dx1-32008" >970</a>, <a +href="glossaries-user.html#dx1-32019" >971</a> <br /></span> <span class="index-item"><span -class="cmss-10">glossaries-extra </span>package  <a -href="glossaries-user.html#dx1-5008" >277</a>, <a -href="glossaries-user.html#dx1-7009" >278</a>, <a -href="glossaries-user.html#dx1-7010" >279</a>, <a -href="glossaries-user.html#dx1-7023" >280</a>, <a -href="glossaries-user.html#dx1-7039" >281</a>, <a -href="glossaries-user.html#dx1-8011" >282</a>, <a -href="glossaries-user.html#dx1-8012" >283</a>, <a -href="glossaries-user.html#dx1-8020" >284</a>, <a -href="glossaries-user.html#dx1-9003" >285</a>, <a -href="glossaries-user.html#dx1-10004" >286</a>, <a -href="glossaries-user.html#dx1-12015" >287</a>, <a -href="glossaries-user.html#dx1-13011" >288</a>, <a -href="glossaries-user.html#dx1-16010" >289</a>, <a -href="glossaries-user.html#dx1-16012" >290</a>, <a -href="glossaries-user.html#dx1-26021" >291</a>, <a -href="glossaries-user.html#dx1-34002" >292</a>, <a -href="glossaries-user.html#dx1-34005" >293</a>, <a -href="glossaries-user.html#dx1-62006" >294</a>, <a -href="glossaries-user.html#dx1-63079" >295</a>, <a -href="glossaries-user.html#dx1-69001" >296</a>, <a -href="glossaries-user.html#dx1-69006" >297</a>, <a -href="glossaries-user.html#dx1-69047" >298</a>, <a -href="glossaries-user.html#dx1-78042" >299</a>, <a -href="glossaries-user.html#dx1-78044" >300</a>, <a -href="glossaries-user.html#dx1-78046" >301</a> <br /></span> +class="cmss-10">glossaries-extra-bib2gls </span>package  <a +href="glossaries-user.html#dx1-220041" >972</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries-extra-stylemods </span>package  <a -href="glossaries-user.html#dx1-78045" >302</a> <br /></span> +href="glossaries-user.html#dx1-60001" >973</a>, <a +href="glossaries-user.html#dx1-155006" >974</a>, <a +href="glossaries-user.html#dx1-156043" >975</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries-polyglossia </span>package  <a -href="glossaries-user.html#dx1-23070" >303</a> <br /></span> +href="glossaries-user.html#dx1-32010" >976</a> <br /></span> <span class="index-item"><span class="cmss-10">glossaries-prefix </span>package  <a -href="glossaries-user.html#dx1-11116" >304</a>, <a -href="glossaries-user.html#dx1-34015" >305</a>, <a -href="glossaries-user.html#dx1-93001" >306</a>, <a -href="glossaries-user.html#dx1-93017" >307</a> <br /></span> +href="glossaries-user.html#dx1-103001" >977</a>, <a +href="glossaries-user.html#dx1-112014" >978</a>, <a +href="glossaries-user.html#dx1-171001" >979</a>, <a +href="glossaries-user.html#dx1-171018" >980</a>, <a +href="glossaries-user.html#dx1-178005" >981</a>, <a +href="glossaries-user.html#dx1-178013" >982</a>, <a +href="glossaries-user.html#dx1-194006" >983</a>, <a +href="glossaries-user.html#dx1-194013" >984</a>, <a +href="glossaries-user.html#dx1-223001" >985</a>, <a +href="glossaries-user.html#dx1-223004" >986</a> <br /></span> <span class="index-item">glossary counters:<br /></span> <span class="index-subitem">    <span class="cmtt-10">glossaryentry</span>  <a -href="glossaries-user.html#dx1-25004" ><span -class="cmti-10">308</span></a> <br /></span> +href="glossaries-user.html#dx1-46003" ><span +class="cmti-10">987</span></a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">glossarysubentry</span>  <a -href="glossaries-user.html#dx1-25022" ><span -class="cmti-10">309</span></a> <br /></span> +href="glossaries-user.html#dx1-48003" ><span +class="cmti-10">988</span></a> <br /></span> <span class="index-item"><span class="cmss-10">glossary </span>package  <a -href="glossaries-user.html#dx1-17" >310</a>, <a -href="glossaries-user.html#dx1-4005" >311</a>, <a -href="glossaries-user.html#dx1-29035" >312</a>, <a -href="glossaries-user.html#dx1-74001" >313</a>, <a -href="glossaries-user.html#dx1-74002" >314</a>, <a -href="glossaries-user.html#dx1-74005" >315</a> <br /></span> +href="glossaries-user.html#dx1-16" >989</a>, <a +href="glossaries-user.html#dx1-107001" >990</a>, <a +href="glossaries-user.html#dx1-152001" >991</a>, <a +href="glossaries-user.html#dx1-152002" >992</a>, <a +href="glossaries-user.html#dx1-152005" >993</a> <br /></span> <span class="index-item">glossary styles:<br /></span> <span class="index-subitem">    <span class="cmtt-10">altlist</span>  <a -href="glossaries-user.html#dx1-71047" >316</a>, <a -href="glossaries-user.html#dx1-71080" >317</a>, <a -href="glossaries-user.html#dx1-72068" >318</a>, <a -href="glossaries-user.html#dx1-79025" >319</a>, <a -href="glossaries-user.html#dx1-79031" >320</a> <br /></span> +href="glossaries-user.html#dx1-149048" >994</a>, <a +href="glossaries-user.html#dx1-149081" >995</a>, <a +href="glossaries-user.html#dx1-150069" >996</a>, <a +href="glossaries-user.html#dx1-157025" >997</a>, <a +href="glossaries-user.html#dx1-157031" >998</a>, <a +href="glossaries-user.html#dx1-179005" >999</a> <br /></span> + + <span class="index-subitem">    <span class="cmtt-10">altlistgroup</span>  <a -href="glossaries-user.html#dx1-79030" >321</a>, <a -href="glossaries-user.html#dx1-79033" >322</a> <br /></span> +href="glossaries-user.html#dx1-157030" >1000</a>, <a +href="glossaries-user.html#dx1-157033" >1001</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlisthypergroup</span>  <a -href="glossaries-user.html#dx1-79032" >323</a> <br /></span> +href="glossaries-user.html#dx1-157032" >1002</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlong4col</span>  <a -href="glossaries-user.html#dx1-78024" >324</a>, <a -href="glossaries-user.html#dx1-80032" >325</a>, <a -href="glossaries-user.html#dx1-80039" >326</a> <br /></span> +href="glossaries-user.html#dx1-156024" >1003</a>, <a +href="glossaries-user.html#dx1-158032" >1004</a>, <a +href="glossaries-user.html#dx1-158039" >1005</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlong4col-booktabs</span>  <a -href="glossaries-user.html#dx1-82031" >327</a> <br /></span> +href="glossaries-user.html#dx1-160031" >1006</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlong4colborder</span>  <a -href="glossaries-user.html#dx1-80043" >328</a> <br /></span> +href="glossaries-user.html#dx1-158043" >1007</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlong4colheader</span>  <a -href="glossaries-user.html#dx1-80045" >329</a>, <a -href="glossaries-user.html#dx1-82032" >330</a> <br /></span> +href="glossaries-user.html#dx1-158045" >1008</a>, <a +href="glossaries-user.html#dx1-160032" >1009</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlong4colheaderborder</span>  <a -href="glossaries-user.html#dx1-80047" >331</a> <br /></span> +href="glossaries-user.html#dx1-158047" >1010</a>, <a +href="glossaries-user.html#dx1-219004" >1011</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlongragged4col</span>  <a -href="glossaries-user.html#dx1-81030" >332</a>, <a -href="glossaries-user.html#dx1-81035" >333</a>, <a -href="glossaries-user.html#dx1-81037" >334</a> <br /></span> +href="glossaries-user.html#dx1-159030" >1012</a>, <a +href="glossaries-user.html#dx1-159035" >1013</a>, <a +href="glossaries-user.html#dx1-159037" >1014</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlongragged4col-booktabs</span>  <a -href="glossaries-user.html#dx1-82037" >335</a> <br /></span> +href="glossaries-user.html#dx1-160037" >1015</a>, <a +href="glossaries-user.html#dx1-219007" >1016</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlongragged4colborder</span>  <a -href="glossaries-user.html#dx1-81034" >336</a> <br /></span> +href="glossaries-user.html#dx1-159034" >1017</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlongragged4colheader</span>  <a -href="glossaries-user.html#dx1-81036" >337</a>, <a -href="glossaries-user.html#dx1-81039" >338</a>, <a -href="glossaries-user.html#dx1-82038" >339</a> <br /></span> +href="glossaries-user.html#dx1-159036" >1018</a>, <a +href="glossaries-user.html#dx1-159039" >1019</a>, <a +href="glossaries-user.html#dx1-160038" >1020</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altlongragged4colheaderborder</span>  <a -href="glossaries-user.html#dx1-81038" >340</a> <br /></span> +href="glossaries-user.html#dx1-159038" >1021</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuper4col</span>  <a -href="glossaries-user.html#dx1-78025" >341</a>, <a -href="glossaries-user.html#dx1-83037" >342</a>, <a -href="glossaries-user.html#dx1-83044" >343</a> <br /></span> +href="glossaries-user.html#dx1-156025" >1022</a>, <a +href="glossaries-user.html#dx1-161037" >1023</a>, <a +href="glossaries-user.html#dx1-161044" >1024</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuper4colborder</span>  <a -href="glossaries-user.html#dx1-83048" >344</a> <br /></span> +href="glossaries-user.html#dx1-161048" >1025</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuper4colheader</span>  <a -href="glossaries-user.html#dx1-83050" >345</a> <br /></span> +href="glossaries-user.html#dx1-161050" >1026</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuper4colheaderborder</span>  <a -href="glossaries-user.html#dx1-83052" >346</a> <br /></span> +href="glossaries-user.html#dx1-161052" >1027</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuperragged4col</span>  <a -href="glossaries-user.html#dx1-84032" >347</a>, <a -href="glossaries-user.html#dx1-84035" >348</a>, <a -href="glossaries-user.html#dx1-84037" >349</a> <br /></span> +href="glossaries-user.html#dx1-162031" >1028</a>, <a +href="glossaries-user.html#dx1-162034" >1029</a>, <a +href="glossaries-user.html#dx1-162036" >1030</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuperragged4colborder</span>  <a -href="glossaries-user.html#dx1-84034" >350</a> <br /></span> +href="glossaries-user.html#dx1-162033" >1031</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuperragged4colheader</span>  <a -href="glossaries-user.html#dx1-84036" >351</a>, <a -href="glossaries-user.html#dx1-84039" >352</a> <br /></span> +href="glossaries-user.html#dx1-162035" >1032</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">altsuperragged4colheaderborder</span>  <a -href="glossaries-user.html#dx1-84038" >353</a> <br /></span> - - +href="glossaries-user.html#dx1-162037" >1033</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">alttree</span>  <a -href="glossaries-user.html#dx1-78028" >354</a>, <a -href="glossaries-user.html#dx1-85010" >355</a>, <a -href="glossaries-user.html#dx1-85013" >356</a>, <a -href="glossaries-user.html#dx1-85034" >357</a>, <a -href="glossaries-user.html#dx1-85047" >358</a>, <a -href="glossaries-user.html#dx1-85052" >359</a>, <a -href="glossaries-user.html#dx1-85056" >360</a>, <a -href="glossaries-user.html#dx1-86040" >361</a> <br /></span> +href="glossaries-user.html#dx1-156028" >1034</a>, <a +href="glossaries-user.html#dx1-163010" >1035</a>, <a +href="glossaries-user.html#dx1-163013" >1036</a>, <a +href="glossaries-user.html#dx1-163034" >1037</a>, <a +href="glossaries-user.html#dx1-163047" >1038</a>, <a +href="glossaries-user.html#dx1-163052" >1039</a>, <a +href="glossaries-user.html#dx1-163056" >1040</a>, <a +href="glossaries-user.html#dx1-164040" >1041</a>, <a +href="glossaries-user.html#dx1-202042" >1042</a>, <a +href="glossaries-user.html#dx1-202046" >1043</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">alttreegroup</span>  <a -href="glossaries-user.html#dx1-85055" >362</a>, <a -href="glossaries-user.html#dx1-85058" >363</a>, <a -href="glossaries-user.html#dx1-86042" >364</a> <br /></span> +href="glossaries-user.html#dx1-163055" >1044</a>, <a +href="glossaries-user.html#dx1-163058" >1045</a>, <a +href="glossaries-user.html#dx1-164042" >1046</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">alttreehypergroup</span>  <a -href="glossaries-user.html#dx1-85057" >365</a>, <a -href="glossaries-user.html#dx1-86045" >366</a> <br /></span> +href="glossaries-user.html#dx1-163057" >1047</a>, <a +href="glossaries-user.html#dx1-164045" >1048</a>, <a +href="glossaries-user.html#dx1-202001" >1049</a>, <a +href="glossaries-user.html#dx1-202007" >1050</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">bookindex</span>  <a +href="glossaries-user.html#dx1-11072" >1051</a>, <a +href="glossaries-user.html#dx1-11084" >1052</a>, <a +href="glossaries-user.html#dx1-11085" >1053</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">index</span>  <a -href="glossaries-user.html#dx1-25051" >367</a>, <a -href="glossaries-user.html#dx1-79016" >368</a>, <a -href="glossaries-user.html#dx1-79029" >369</a>, <a -href="glossaries-user.html#dx1-79040" >370</a>, <a -href="glossaries-user.html#dx1-85016" >371</a>, <a -href="glossaries-user.html#dx1-85017" >372</a>, <a -href="glossaries-user.html#dx1-85022" >373</a>, <a -href="glossaries-user.html#dx1-85023" >374</a>, <a -href="glossaries-user.html#dx1-85025" >375</a>, <a -href="glossaries-user.html#dx1-85030" >376</a>, <a -href="glossaries-user.html#dx1-86006" >377</a>, <a -href="glossaries-user.html#dx1-86019" >378</a> <br /></span> +href="glossaries-user.html#dx1-53004" >1054</a>, <a +href="glossaries-user.html#dx1-157016" >1055</a>, <a +href="glossaries-user.html#dx1-157029" >1056</a>, <a +href="glossaries-user.html#dx1-157040" >1057</a>, <a +href="glossaries-user.html#dx1-163016" >1058</a>, <a +href="glossaries-user.html#dx1-163017" >1059</a>, <a +href="glossaries-user.html#dx1-163022" >1060</a>, <a +href="glossaries-user.html#dx1-163023" >1061</a>, <a +href="glossaries-user.html#dx1-163025" >1062</a>, <a +href="glossaries-user.html#dx1-163030" >1063</a>, <a +href="glossaries-user.html#dx1-164006" >1064</a>, <a +href="glossaries-user.html#dx1-164019" >1065</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">indexgroup</span>  <a -href="glossaries-user.html#dx1-85024" >379</a>, <a -href="glossaries-user.html#dx1-85027" >380</a>, <a -href="glossaries-user.html#dx1-86021" >381</a> <br /></span> +href="glossaries-user.html#dx1-163024" >1066</a>, <a +href="glossaries-user.html#dx1-163027" >1067</a>, <a +href="glossaries-user.html#dx1-164021" >1068</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">indexhypergroup</span>  <a -href="glossaries-user.html#dx1-85007" >382</a>, <a -href="glossaries-user.html#dx1-85026" >383</a>, <a -href="glossaries-user.html#dx1-86024" >384</a> <br /></span> +href="glossaries-user.html#dx1-163007" >1069</a>, <a +href="glossaries-user.html#dx1-163026" >1070</a>, <a +href="glossaries-user.html#dx1-164024" >1071</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">inline</span>  <a -href="glossaries-user.html#dx1-11067" >385</a>, <a -href="glossaries-user.html#dx1-87002" >386</a>, <a -href="glossaries-user.html#dx1-87007" >387</a> <br /></span> +href="glossaries-user.html#dx1-165002" >1072</a>, <a +href="glossaries-user.html#dx1-165007" >1073</a>, <a +href="glossaries-user.html#dx1-201001" >1074</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">list</span>  <a -href="glossaries-user.html#dx1-25044" >388</a>, <a -href="glossaries-user.html#dx1-79010" >389</a>, <a -href="glossaries-user.html#dx1-79018" >390</a>, <a -href="glossaries-user.html#dx1-79026" >391</a>, <a -href="glossaries-user.html#dx1-79027" >392</a>, <a -href="glossaries-user.html#dx1-79028" >393</a>, <a -href="glossaries-user.html#dx1-88008" >394</a>, <a -href="glossaries-user.html#dx1-88017" >395</a>, <a -href="glossaries-user.html#dx1-88035" >396</a>, <a -href="glossaries-user.html#dx1-88051" >397</a>, <a -href="glossaries-user.html#dx1-88093" >398</a>, <a -href="glossaries-user.html#dx1-88095" >399</a>, <a -href="glossaries-user.html#dx1-93064" >400</a> <br /></span> +href="glossaries-user.html#dx1-52003" >1075</a>, <a +href="glossaries-user.html#dx1-157010" >1076</a>, <a +href="glossaries-user.html#dx1-157018" >1077</a>, <a +href="glossaries-user.html#dx1-157026" >1078</a>, <a +href="glossaries-user.html#dx1-157027" >1079</a>, <a +href="glossaries-user.html#dx1-157028" >1080</a>, <a +href="glossaries-user.html#dx1-166008" >1081</a>, <a +href="glossaries-user.html#dx1-166017" >1082</a>, <a +href="glossaries-user.html#dx1-166035" >1083</a>, <a +href="glossaries-user.html#dx1-166051" >1084</a>, <a +href="glossaries-user.html#dx1-166093" >1085</a>, <a +href="glossaries-user.html#dx1-166095" >1086</a>, <a +href="glossaries-user.html#dx1-171064" >1087</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">listdotted</span>  <a -href="glossaries-user.html#dx1-78038" >401</a>, <a -href="glossaries-user.html#dx1-79006" >402</a>, <a -href="glossaries-user.html#dx1-79043" >403</a>, <a -href="glossaries-user.html#dx1-79044" >404</a>, <a -href="glossaries-user.html#dx1-79045" >405</a> <br /></span> +href="glossaries-user.html#dx1-156038" >1088</a>, <a +href="glossaries-user.html#dx1-157006" >1089</a>, <a +href="glossaries-user.html#dx1-157043" >1090</a>, <a +href="glossaries-user.html#dx1-157044" >1091</a>, <a +href="glossaries-user.html#dx1-157045" >1092</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">listgroup</span>  <a -href="glossaries-user.html#dx1-26022" >406</a>, <a -href="glossaries-user.html#dx1-78006" >407</a>, <a -href="glossaries-user.html#dx1-79017" >408</a>, <a -href="glossaries-user.html#dx1-79020" >409</a> <br /></span> +href="glossaries-user.html#dx1-73020" >1093</a>, <a +href="glossaries-user.html#dx1-156006" >1094</a>, <a +href="glossaries-user.html#dx1-157017" >1095</a>, <a +href="glossaries-user.html#dx1-157020" >1096</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">listhypergroup</span>  <a -href="glossaries-user.html#dx1-79019" >410</a>, <a -href="glossaries-user.html#dx1-79034" >411</a>, <a -href="glossaries-user.html#dx1-85009" >412</a>, <a -href="glossaries-user.html#dx1-85028" >413</a>, <a -href="glossaries-user.html#dx1-85039" >414</a>, <a -href="glossaries-user.html#dx1-85046" >415</a>, <a -href="glossaries-user.html#dx1-85059" >416</a>, <a -href="glossaries-user.html#dx1-88032" >417</a> <br /></span> +href="glossaries-user.html#dx1-157019" >1097</a>, <a +href="glossaries-user.html#dx1-157034" >1098</a>, <a +href="glossaries-user.html#dx1-163009" >1099</a>, <a +href="glossaries-user.html#dx1-163028" >1100</a>, <a +href="glossaries-user.html#dx1-163039" >1101</a>, <a +href="glossaries-user.html#dx1-163046" >1102</a>, <a +href="glossaries-user.html#dx1-163059" >1103</a>, <a +href="glossaries-user.html#dx1-166032" >1104</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long</span>  <a -href="glossaries-user.html#dx1-78027" >418</a>, <a -href="glossaries-user.html#dx1-78034" >419</a>, <a -href="glossaries-user.html#dx1-80007" >420</a>, <a -href="glossaries-user.html#dx1-80014" >421</a>, <a -href="glossaries-user.html#dx1-80016" >422</a>, <a -href="glossaries-user.html#dx1-80020" >423</a> <br /></span> +href="glossaries-user.html#dx1-156027" >1105</a>, <a +href="glossaries-user.html#dx1-156034" >1106</a>, <a +href="glossaries-user.html#dx1-158007" >1107</a>, <a +href="glossaries-user.html#dx1-158014" >1108</a>, <a +href="glossaries-user.html#dx1-158016" >1109</a>, <a +href="glossaries-user.html#dx1-158020" >1110</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long-booktabs</span>  <a -href="glossaries-user.html#dx1-82024" >424</a>, <a -href="glossaries-user.html#dx1-82028" >425</a> <br /></span> +href="glossaries-user.html#dx1-160024" >1111</a>, <a +href="glossaries-user.html#dx1-160028" >1112</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">long-name-desc-sym-loc</span>  <a +href="glossaries-user.html#dx1-219011" >1113</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long3col</span>  <a -href="glossaries-user.html#dx1-78011" >426</a>, <a -href="glossaries-user.html#dx1-80019" >427</a>, <a -href="glossaries-user.html#dx1-80025" >428</a>, <a -href="glossaries-user.html#dx1-80027" >429</a>, <a -href="glossaries-user.html#dx1-80031" >430</a> <br /></span> +href="glossaries-user.html#dx1-156011" >1114</a>, <a +href="glossaries-user.html#dx1-158019" >1115</a>, <a +href="glossaries-user.html#dx1-158025" >1116</a>, <a +href="glossaries-user.html#dx1-158027" >1117</a>, <a +href="glossaries-user.html#dx1-158031" >1118</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long3col-booktabs</span>  <a -href="glossaries-user.html#dx1-82026" >431</a> <br /></span> +href="glossaries-user.html#dx1-160026" >1119</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long3colborder</span>  <a -href="glossaries-user.html#dx1-78013" >432</a>, <a -href="glossaries-user.html#dx1-80024" >433</a> <br /></span> +href="glossaries-user.html#dx1-156013" >1120</a>, <a +href="glossaries-user.html#dx1-158024" >1121</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long3colheader</span>  <a -href="glossaries-user.html#dx1-78012" >434</a>, <a -href="glossaries-user.html#dx1-80026" >435</a>, <a -href="glossaries-user.html#dx1-80029" >436</a>, <a -href="glossaries-user.html#dx1-82027" >437</a> <br /></span> +href="glossaries-user.html#dx1-156012" >1122</a>, <a +href="glossaries-user.html#dx1-158026" >1123</a>, <a +href="glossaries-user.html#dx1-158029" >1124</a>, <a +href="glossaries-user.html#dx1-160027" >1125</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long3colheaderborder</span>  <a -href="glossaries-user.html#dx1-78014" >438</a>, <a -href="glossaries-user.html#dx1-80028" >439</a> <br /></span> +href="glossaries-user.html#dx1-156014" >1126</a>, <a +href="glossaries-user.html#dx1-158028" >1127</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long4col</span>  <a -href="glossaries-user.html#dx1-78022" >440</a>, <a -href="glossaries-user.html#dx1-80030" >441</a>, <a -href="glossaries-user.html#dx1-80034" >442</a>, <a -href="glossaries-user.html#dx1-80036" >443</a>, <a -href="glossaries-user.html#dx1-80040" >444</a> <br /></span> +href="glossaries-user.html#dx1-156022" >1128</a>, <a +href="glossaries-user.html#dx1-158030" >1129</a>, <a +href="glossaries-user.html#dx1-158034" >1130</a>, <a +href="glossaries-user.html#dx1-158036" >1131</a>, <a +href="glossaries-user.html#dx1-158040" >1132</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long4col-booktabs</span>  <a -href="glossaries-user.html#dx1-82029" >445</a> <br /></span> +href="glossaries-user.html#dx1-160029" >1133</a>, <a +href="glossaries-user.html#dx1-219006" >1134</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long4colborder</span>  <a -href="glossaries-user.html#dx1-80033" >446</a>, <a -href="glossaries-user.html#dx1-80044" >447</a> <br /></span> +href="glossaries-user.html#dx1-158033" >1135</a>, <a +href="glossaries-user.html#dx1-158044" >1136</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long4colheader</span>  <a -href="glossaries-user.html#dx1-80035" >448</a>, <a -href="glossaries-user.html#dx1-80038" >449</a>, <a -href="glossaries-user.html#dx1-80046" >450</a>, <a -href="glossaries-user.html#dx1-82030" >451</a> <br /></span> +href="glossaries-user.html#dx1-158035" >1137</a>, <a +href="glossaries-user.html#dx1-158038" >1138</a>, <a +href="glossaries-user.html#dx1-158046" >1139</a>, <a +href="glossaries-user.html#dx1-160030" >1140</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">long4colheaderborder</span>  <a -href="glossaries-user.html#dx1-80037" >452</a>, <a -href="glossaries-user.html#dx1-80048" >453</a> <br /></span> +href="glossaries-user.html#dx1-158037" >1141</a>, <a +href="glossaries-user.html#dx1-158048" >1142</a>, <a +href="glossaries-user.html#dx1-219003" >1143</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longborder</span>  <a -href="glossaries-user.html#dx1-80013" >454</a> <br /></span> +href="glossaries-user.html#dx1-158013" >1144</a> <br /></span> + + <span class="index-subitem">    <span class="cmtt-10">longheader</span>  <a -href="glossaries-user.html#dx1-80015" >455</a>, <a -href="glossaries-user.html#dx1-80018" >456</a>, <a -href="glossaries-user.html#dx1-82025" >457</a>, <a -href="glossaries-user.html#dx1-88019" >458</a> <br /></span> +href="glossaries-user.html#dx1-158015" >1145</a>, <a +href="glossaries-user.html#dx1-158018" >1146</a>, <a +href="glossaries-user.html#dx1-160025" >1147</a>, <a +href="glossaries-user.html#dx1-166019" >1148</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longheaderborder</span>  <a -href="glossaries-user.html#dx1-80017" >459</a>, <a -href="glossaries-user.html#dx1-63071" >460</a> <br /></span> +href="glossaries-user.html#dx1-158017" >1149</a>, <a +href="glossaries-user.html#dx1-141081" >1150</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged</span>  <a -href="glossaries-user.html#dx1-81010" >461</a>, <a -href="glossaries-user.html#dx1-81014" >462</a>, <a -href="glossaries-user.html#dx1-81016" >463</a>, <a -href="glossaries-user.html#dx1-81020" >464</a> <br /></span> +href="glossaries-user.html#dx1-159010" >1151</a>, <a +href="glossaries-user.html#dx1-159014" >1152</a>, <a +href="glossaries-user.html#dx1-159016" >1153</a>, <a +href="glossaries-user.html#dx1-159020" >1154</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged-booktabs</span>  <a -href="glossaries-user.html#dx1-82033" >465</a> <br /></span> +href="glossaries-user.html#dx1-160033" >1155</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged3col</span>  <a -href="glossaries-user.html#dx1-81019" >466</a>, <a -href="glossaries-user.html#dx1-81025" >467</a>, <a -href="glossaries-user.html#dx1-81027" >468</a>, <a -href="glossaries-user.html#dx1-81031" >469</a> <br /></span> +href="glossaries-user.html#dx1-159019" >1156</a>, <a +href="glossaries-user.html#dx1-159025" >1157</a>, <a +href="glossaries-user.html#dx1-159027" >1158</a>, <a +href="glossaries-user.html#dx1-159031" >1159</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged3col-booktabs</span>  <a -href="glossaries-user.html#dx1-82035" >470</a> <br /></span> +href="glossaries-user.html#dx1-160035" >1160</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged3colborder</span>  <a -href="glossaries-user.html#dx1-81024" >471</a> <br /></span> +href="glossaries-user.html#dx1-159024" >1161</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged3colheader</span>  <a -href="glossaries-user.html#dx1-81026" >472</a>, <a -href="glossaries-user.html#dx1-81029" >473</a>, <a -href="glossaries-user.html#dx1-82036" >474</a> <br /></span> +href="glossaries-user.html#dx1-159026" >1162</a>, <a +href="glossaries-user.html#dx1-159029" >1163</a>, <a +href="glossaries-user.html#dx1-160036" >1164</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longragged3colheaderborder</span>  <a -href="glossaries-user.html#dx1-81028" >475</a> <br /></span> +href="glossaries-user.html#dx1-159028" >1165</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longraggedborder</span>  <a -href="glossaries-user.html#dx1-81013" >476</a> <br /></span> +href="glossaries-user.html#dx1-159013" >1166</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longraggedheader</span>  <a -href="glossaries-user.html#dx1-81015" >477</a>, <a -href="glossaries-user.html#dx1-81018" >478</a>, <a -href="glossaries-user.html#dx1-82034" >479</a> <br /></span> +href="glossaries-user.html#dx1-159015" >1167</a>, <a +href="glossaries-user.html#dx1-159018" >1168</a>, <a +href="glossaries-user.html#dx1-160034" >1169</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">longraggedheaderborder</span>  <a -href="glossaries-user.html#dx1-81017" >480</a> <br /></span> +href="glossaries-user.html#dx1-159017" >1170</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolalttree</span>  <a -href="glossaries-user.html#dx1-86039" >481</a> <br /></span> +href="glossaries-user.html#dx1-164039" >1171</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolalttreegroup</span>  <a -href="glossaries-user.html#dx1-86041" >482</a> <br /></span> +href="glossaries-user.html#dx1-164041" >1172</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolalttreehypergroup</span>  <a -href="glossaries-user.html#dx1-86043" >483</a> <br /></span> +href="glossaries-user.html#dx1-164043" >1173</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolalttreespannav</span>  <a -href="glossaries-user.html#dx1-86044" >484</a> <br /></span> +href="glossaries-user.html#dx1-164044" >1174</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolindex</span>  <a -href="glossaries-user.html#dx1-86005" >485</a>, <a -href="glossaries-user.html#dx1-86018" >486</a> <br /></span> +href="glossaries-user.html#dx1-164005" >1175</a>, <a +href="glossaries-user.html#dx1-164018" >1176</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolindexgroup</span>  <a -href="glossaries-user.html#dx1-86020" >487</a> <br /></span> +href="glossaries-user.html#dx1-164020" >1177</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolindexhypergroup</span>  <a -href="glossaries-user.html#dx1-86022" >488</a> <br /></span> +href="glossaries-user.html#dx1-164022" >1178</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcolindexspannav</span>  <a -href="glossaries-user.html#dx1-86023" >489</a> <br /></span> +href="glossaries-user.html#dx1-164023" >1179</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltree</span>  <a -href="glossaries-user.html#dx1-86025" >490</a> <br /></span> +href="glossaries-user.html#dx1-164025" >1180</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreegroup</span>  <a -href="glossaries-user.html#dx1-86027" >491</a> <br /></span> - - +href="glossaries-user.html#dx1-164027" >1181</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreehypergroup</span>  <a -href="glossaries-user.html#dx1-86029" >492</a>, <a -href="glossaries-user.html#dx1-86046" >493</a> <br /></span> +href="glossaries-user.html#dx1-164029" >1182</a>, <a +href="glossaries-user.html#dx1-164046" >1183</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreenoname</span>  <a -href="glossaries-user.html#dx1-86032" >494</a> <br /></span> +href="glossaries-user.html#dx1-164032" >1184</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreenonamegroup</span>  <a -href="glossaries-user.html#dx1-86034" >495</a> <br /></span> +href="glossaries-user.html#dx1-164034" >1185</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreenonamehypergroup</span>  <a -href="glossaries-user.html#dx1-86036" >496</a> <br /></span> +href="glossaries-user.html#dx1-164036" >1186</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreenonamespannav</span>  <a -href="glossaries-user.html#dx1-86037" >497</a> <br /></span> +href="glossaries-user.html#dx1-164037" >1187</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">mcoltreespannav</span>  <a -href="glossaries-user.html#dx1-86030" >498</a> <br /></span> +href="glossaries-user.html#dx1-164030" >1188</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super</span>  <a -href="glossaries-user.html#dx1-83012" >499</a>, <a -href="glossaries-user.html#dx1-83019" >500</a>, <a -href="glossaries-user.html#dx1-83021" >501</a>, <a -href="glossaries-user.html#dx1-83025" >502</a> <br /></span> +href="glossaries-user.html#dx1-161012" >1189</a>, <a +href="glossaries-user.html#dx1-161019" >1190</a>, <a +href="glossaries-user.html#dx1-161021" >1191</a>, <a +href="glossaries-user.html#dx1-161025" >1192</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super3col</span>  <a -href="glossaries-user.html#dx1-83024" >503</a>, <a -href="glossaries-user.html#dx1-83030" >504</a>, <a -href="glossaries-user.html#dx1-83032" >505</a>, <a -href="glossaries-user.html#dx1-83036" >506</a> <br /></span> +href="glossaries-user.html#dx1-161024" >1193</a>, <a +href="glossaries-user.html#dx1-161030" >1194</a>, <a +href="glossaries-user.html#dx1-161032" >1195</a>, <a +href="glossaries-user.html#dx1-161036" >1196</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super3colborder</span>  <a -href="glossaries-user.html#dx1-83029" >507</a> <br /></span> +href="glossaries-user.html#dx1-161029" >1197</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super3colheader</span>  <a -href="glossaries-user.html#dx1-83031" >508</a>, <a -href="glossaries-user.html#dx1-83034" >509</a> <br /></span> +href="glossaries-user.html#dx1-161031" >1198</a>, <a +href="glossaries-user.html#dx1-161034" >1199</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super3colheaderborder</span>  <a -href="glossaries-user.html#dx1-83033" >510</a> <br /></span> +href="glossaries-user.html#dx1-161033" >1200</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super4col</span>  <a -href="glossaries-user.html#dx1-78023" >511</a>, <a -href="glossaries-user.html#dx1-83035" >512</a>, <a -href="glossaries-user.html#dx1-83039" >513</a>, <a -href="glossaries-user.html#dx1-83041" >514</a>, <a -href="glossaries-user.html#dx1-83045" >515</a> <br /></span> +href="glossaries-user.html#dx1-156023" >1201</a>, <a +href="glossaries-user.html#dx1-161035" >1202</a>, <a +href="glossaries-user.html#dx1-161039" >1203</a>, <a +href="glossaries-user.html#dx1-161041" >1204</a>, <a +href="glossaries-user.html#dx1-161045" >1205</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super4colborder</span>  <a -href="glossaries-user.html#dx1-83038" >516</a>, <a -href="glossaries-user.html#dx1-83049" >517</a> <br /></span> +href="glossaries-user.html#dx1-161038" >1206</a>, <a +href="glossaries-user.html#dx1-161049" >1207</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super4colheader</span>  <a -href="glossaries-user.html#dx1-83040" >518</a>, <a -href="glossaries-user.html#dx1-83043" >519</a>, <a -href="glossaries-user.html#dx1-83051" >520</a> <br /></span> +href="glossaries-user.html#dx1-161040" >1208</a>, <a +href="glossaries-user.html#dx1-161043" >1209</a>, <a +href="glossaries-user.html#dx1-161051" >1210</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">super4colheaderborder</span>  <a -href="glossaries-user.html#dx1-83042" >521</a>, <a -href="glossaries-user.html#dx1-83053" >522</a> <br /></span> +href="glossaries-user.html#dx1-161042" >1211</a>, <a +href="glossaries-user.html#dx1-161053" >1212</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superborder</span>  <a -href="glossaries-user.html#dx1-83018" >523</a> <br /></span> +href="glossaries-user.html#dx1-161018" >1213</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superheader</span>  <a -href="glossaries-user.html#dx1-83020" >524</a>, <a -href="glossaries-user.html#dx1-83023" >525</a> <br /></span> +href="glossaries-user.html#dx1-161020" >1214</a>, <a +href="glossaries-user.html#dx1-161023" >1215</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superheaderborder</span>  <a -href="glossaries-user.html#dx1-63069" >526</a>, <a -href="glossaries-user.html#dx1-83022" >527</a> <br /></span> +href="glossaries-user.html#dx1-141079" >1216</a>, <a +href="glossaries-user.html#dx1-161022" >1217</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superragged</span>  <a -href="glossaries-user.html#dx1-84009" >528</a>, <a -href="glossaries-user.html#dx1-84016" >529</a>, <a -href="glossaries-user.html#dx1-84018" >530</a>, <a -href="glossaries-user.html#dx1-84022" >531</a> <br /></span> +href="glossaries-user.html#dx1-162009" >1218</a>, <a +href="glossaries-user.html#dx1-162016" >1219</a>, <a +href="glossaries-user.html#dx1-162018" >1220</a>, <a +href="glossaries-user.html#dx1-162022" >1221</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superragged3col</span>  <a -href="glossaries-user.html#dx1-84021" >532</a>, <a -href="glossaries-user.html#dx1-84027" >533</a>, <a -href="glossaries-user.html#dx1-84029" >534</a>, <a -href="glossaries-user.html#dx1-84033" >535</a> <br /></span> +href="glossaries-user.html#dx1-162021" >1222</a>, <a +href="glossaries-user.html#dx1-162027" >1223</a>, <a +href="glossaries-user.html#dx1-162029" >1224</a>, <a +href="glossaries-user.html#dx1-162032" >1225</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superragged3colborder</span>  <a -href="glossaries-user.html#dx1-84026" >536</a> <br /></span> +href="glossaries-user.html#dx1-162026" >1226</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superragged3colheader</span>  <a -href="glossaries-user.html#dx1-84028" >537</a>, <a -href="glossaries-user.html#dx1-84031" >538</a> <br /></span> +href="glossaries-user.html#dx1-162028" >1227</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superragged3colheaderborder</span>  <a -href="glossaries-user.html#dx1-84030" >539</a> <br /></span> +href="glossaries-user.html#dx1-162030" >1228</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superraggedborder</span>  <a -href="glossaries-user.html#dx1-84015" >540</a> <br /></span> +href="glossaries-user.html#dx1-162015" >1229</a> <br /></span> + + <span class="index-subitem">    <span class="cmtt-10">superraggedheader</span>  <a -href="glossaries-user.html#dx1-84017" >541</a>, <a -href="glossaries-user.html#dx1-84020" >542</a> <br /></span> +href="glossaries-user.html#dx1-162017" >1230</a>, <a +href="glossaries-user.html#dx1-162020" >1231</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">superraggedheaderborder</span>  <a -href="glossaries-user.html#dx1-84019" >543</a> <br /></span> +href="glossaries-user.html#dx1-162019" >1232</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">topic</span>  <a +href="glossaries-user.html#dx1-202033" >1233</a>, <a +href="glossaries-user.html#dx1-202045" >1234</a>, <a +href="glossaries-user.html#dx1-202047" >1235</a>, <a +href="glossaries-user.html#dx1-202064" >1236</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">tree</span>  <a -href="glossaries-user.html#dx1-72066" >544</a>, <a -href="glossaries-user.html#dx1-85015" >545</a>, <a -href="glossaries-user.html#dx1-85029" >546</a>, <a -href="glossaries-user.html#dx1-85036" >547</a>, <a -href="glossaries-user.html#dx1-85041" >548</a>, <a -href="glossaries-user.html#dx1-85048" >549</a>, <a -href="glossaries-user.html#dx1-86026" >550</a> <br /></span> +href="glossaries-user.html#dx1-150067" >1237</a>, <a +href="glossaries-user.html#dx1-163015" >1238</a>, <a +href="glossaries-user.html#dx1-163029" >1239</a>, <a +href="glossaries-user.html#dx1-163036" >1240</a>, <a +href="glossaries-user.html#dx1-163041" >1241</a>, <a +href="glossaries-user.html#dx1-163048" >1242</a>, <a +href="glossaries-user.html#dx1-164026" >1243</a>, <a +href="glossaries-user.html#dx1-202041" >1244</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">treegroup</span>  <a -href="glossaries-user.html#dx1-85035" >551</a>, <a -href="glossaries-user.html#dx1-85038" >552</a>, <a -href="glossaries-user.html#dx1-86028" >553</a> <br /></span> +href="glossaries-user.html#dx1-163035" >1245</a>, <a +href="glossaries-user.html#dx1-163038" >1246</a>, <a +href="glossaries-user.html#dx1-164028" >1247</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">treehypergroup</span>  <a -href="glossaries-user.html#dx1-79024" >554</a>, <a -href="glossaries-user.html#dx1-85037" >555</a>, <a -href="glossaries-user.html#dx1-86031" >556</a> <br /></span> +href="glossaries-user.html#dx1-157024" >1248</a>, <a +href="glossaries-user.html#dx1-163037" >1249</a>, <a +href="glossaries-user.html#dx1-164031" >1250</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">treenoname</span>  <a -href="glossaries-user.html#dx1-85012" >557</a>, <a -href="glossaries-user.html#dx1-85040" >558</a>, <a -href="glossaries-user.html#dx1-85043" >559</a>, <a -href="glossaries-user.html#dx1-86033" >560</a> <br /></span> +href="glossaries-user.html#dx1-163012" >1251</a>, <a +href="glossaries-user.html#dx1-163040" >1252</a>, <a +href="glossaries-user.html#dx1-163043" >1253</a>, <a +href="glossaries-user.html#dx1-164033" >1254</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">treenonamegroup</span>  <a -href="glossaries-user.html#dx1-85042" >561</a>, <a -href="glossaries-user.html#dx1-85045" >562</a>, <a -href="glossaries-user.html#dx1-86035" >563</a> <br /></span> +href="glossaries-user.html#dx1-163042" >1255</a>, <a +href="glossaries-user.html#dx1-163045" >1256</a>, <a +href="glossaries-user.html#dx1-164035" >1257</a>, <a +href="glossaries-user.html#dx1-200093" >1258</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">treenonamehypergroup</span>  <a -href="glossaries-user.html#dx1-85044" >564</a>, <a -href="glossaries-user.html#dx1-86038" >565</a> <br /></span> +href="glossaries-user.html#dx1-163044" >1259</a>, <a +href="glossaries-user.html#dx1-164038" >1260</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-bookindex </span>package  <a -href="glossaries-user.html#dx1-78004" >566</a> <br /></span> +href="glossaries-user.html#dx1-11073" >1261</a>, <a +href="glossaries-user.html#dx1-11075" >1262</a>, <a +href="glossaries-user.html#dx1-156004" >1263</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-inline </span>package  <a -href="glossaries-user.html#dx1-87001" >567</a>, <a -href="glossaries-user.html#dx1-87005" >568</a> <br /></span> +href="glossaries-user.html#dx1-165001" >1264</a>, <a +href="glossaries-user.html#dx1-165005" >1265</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-list </span>package  <a -href="glossaries-user.html#dx1-25029" >569</a>, <a -href="glossaries-user.html#dx1-25042" >570</a>, <a -href="glossaries-user.html#dx1-25043" >571</a>, <a -href="glossaries-user.html#dx1-63075" >572</a>, <a -href="glossaries-user.html#dx1-79001" >573</a> <br /></span> +href="glossaries-user.html#dx1-49004" >1266</a>, <a +href="glossaries-user.html#dx1-52001" >1267</a>, <a +href="glossaries-user.html#dx1-52002" >1268</a>, <a +href="glossaries-user.html#dx1-141085" >1269</a>, <a +href="glossaries-user.html#dx1-157001" >1270</a>, <a +href="glossaries-user.html#dx1-179006" >1271</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-long </span>package  <a -href="glossaries-user.html#dx1-25030" >574</a>, <a -href="glossaries-user.html#dx1-25034" >575</a>, <a -href="glossaries-user.html#dx1-25036" >576</a>, <a -href="glossaries-user.html#dx1-63076" >577</a>, <a -href="glossaries-user.html#dx1-80001" >578</a>, <a -href="glossaries-user.html#dx1-81002" >579</a>, <a -href="glossaries-user.html#dx1-82005" >580</a>, <a -href="glossaries-user.html#dx1-82009" >581</a> <br /></span> +href="glossaries-user.html#dx1-49005" >1272</a>, <a +href="glossaries-user.html#dx1-50001" >1273</a>, <a +href="glossaries-user.html#dx1-50003" >1274</a>, <a +href="glossaries-user.html#dx1-141086" >1275</a>, <a +href="glossaries-user.html#dx1-158001" >1276</a>, <a +href="glossaries-user.html#dx1-159002" >1277</a>, <a +href="glossaries-user.html#dx1-160005" >1278</a>, <a +href="glossaries-user.html#dx1-160009" >1279</a>, <a +href="glossaries-user.html#dx1-178009" >1280</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-longbooktabs </span>package  <a -href="glossaries-user.html#dx1-82001" >582</a>, <a -href="glossaries-user.html#dx1-82004" >583</a>, <a -href="glossaries-user.html#dx1-82007" >584</a> <br /></span> +href="glossaries-user.html#dx1-160001" >1281</a>, <a +href="glossaries-user.html#dx1-160004" >1282</a>, <a +href="glossaries-user.html#dx1-160007" >1283</a>, <a +href="glossaries-user.html#dx1-219008" >1284</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">glossary-longextra </span>package  <a +href="glossaries-user.html#dx1-178012" >1285</a>, <a +href="glossaries-user.html#dx1-219010" >1286</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-longnoloc </span>package  <a -href="glossaries-user.html#dx1-78005" >585</a> <br /></span> +href="glossaries-user.html#dx1-156005" >1287</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-longragged </span>package  <a -href="glossaries-user.html#dx1-81001" >586</a>, <a -href="glossaries-user.html#dx1-81005" >587</a>, <a -href="glossaries-user.html#dx1-81007" >588</a>, <a -href="glossaries-user.html#dx1-82006" >589</a> <br /></span> +href="glossaries-user.html#dx1-159001" >1288</a>, <a +href="glossaries-user.html#dx1-159005" >1289</a>, <a +href="glossaries-user.html#dx1-159007" >1290</a>, <a +href="glossaries-user.html#dx1-160006" >1291</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-mcols </span>package  <a -href="glossaries-user.html#dx1-25054" >590</a>, <a -href="glossaries-user.html#dx1-85053" >591</a>, <a -href="glossaries-user.html#dx1-86001" >592</a>, <a -href="glossaries-user.html#dx1-86010" >593</a>, <a -href="glossaries-user.html#dx1-86012" >594</a>, <a -href="glossaries-user.html#dx1-86013" >595</a>, <a -href="glossaries-user.html#dx1-86017" >596</a> <br /></span> +href="glossaries-user.html#dx1-54001" >1292</a>, <a +href="glossaries-user.html#dx1-163053" >1293</a>, <a +href="glossaries-user.html#dx1-164001" >1294</a>, <a +href="glossaries-user.html#dx1-164010" >1295</a>, <a +href="glossaries-user.html#dx1-164012" >1296</a>, <a +href="glossaries-user.html#dx1-164013" >1297</a>, <a +href="glossaries-user.html#dx1-164017" >1298</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-ragged </span>package  <a -href="glossaries-user.html#dx1-82010" >597</a> <br /></span> +href="glossaries-user.html#dx1-160010" >1299</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-super </span>package  <a -href="glossaries-user.html#dx1-25031" >598</a>, <a -href="glossaries-user.html#dx1-25038" >599</a>, <a -href="glossaries-user.html#dx1-25040" >600</a>, <a -href="glossaries-user.html#dx1-63077" >601</a>, <a -href="glossaries-user.html#dx1-83001" >602</a>, <a -href="glossaries-user.html#dx1-84002" >603</a> <br /></span> +href="glossaries-user.html#dx1-49006" >1300</a>, <a +href="glossaries-user.html#dx1-51001" >1301</a>, <a +href="glossaries-user.html#dx1-51003" >1302</a>, <a +href="glossaries-user.html#dx1-141087" >1303</a>, <a +href="glossaries-user.html#dx1-161001" >1304</a>, <a +href="glossaries-user.html#dx1-162002" >1305</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-superragged </span>package  <a -href="glossaries-user.html#dx1-84001" >604</a>, <a -href="glossaries-user.html#dx1-84005" >605</a>, <a -href="glossaries-user.html#dx1-84007" >606</a> <br /></span> +href="glossaries-user.html#dx1-162001" >1306</a>, <a +href="glossaries-user.html#dx1-162005" >1307</a>, <a +href="glossaries-user.html#dx1-162007" >1308</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">glossary-topic </span>package  <a +href="glossaries-user.html#dx1-202006" >1309</a>, <a +href="glossaries-user.html#dx1-202032" >1310</a> <br /></span> +<span class="index-item"><span +class="cmss-10">glossary-topic </span>package  <a +href="glossaries-user.html#dx1-202037" >1311</a>, <a +href="glossaries-user.html#dx1-202039" >1312</a> <br /></span> <span class="index-item"><span class="cmss-10">glossary-tree </span>package  <a -href="glossaries-user.html#dx1-25032" >607</a>, <a -href="glossaries-user.html#dx1-25048" >608</a>, <a -href="glossaries-user.html#dx1-25049" >609</a>, <a -href="glossaries-user.html#dx1-25052" >610</a>, <a -href="glossaries-user.html#dx1-63078" >611</a>, <a -href="glossaries-user.html#dx1-85001" >612</a>, <a -href="glossaries-user.html#dx1-85050" >613</a>, <a -href="glossaries-user.html#dx1-86009" >614</a> <br /></span> +href="glossaries-user.html#dx1-49007" >1313</a>, <a +href="glossaries-user.html#dx1-53001" >1314</a>, <a +href="glossaries-user.html#dx1-53002" >1315</a>, <a +href="glossaries-user.html#dx1-53005" >1316</a>, <a +href="glossaries-user.html#dx1-141088" >1317</a>, <a +href="glossaries-user.html#dx1-163001" >1318</a>, <a +href="glossaries-user.html#dx1-163050" >1319</a>, <a +href="glossaries-user.html#dx1-164009" >1320</a>, <a +href="glossaries-user.html#dx1-202012" >1321</a>, <a +href="glossaries-user.html#dx1-202036" >1322</a>, <a +href="glossaries-user.html#dx1-202040" >1323</a>, <a +href="glossaries-user.html#dx1-202044" >1324</a> <br /></span> <span class="index-item"><span class="cmtt-10">glossaryentry </span>(counter)  <a -href="glossaries-user.html#dx1-25003" ><span -class="cmti-10">615</span></a>, <a -href="glossaries-user.html#dx1-25012" >616</a>, <a -href="glossaries-user.html#dx1-25013" >617</a>, <a -href="glossaries-user.html#dx1-25017" >618</a> <br /></span> +href="glossaries-user.html#dx1-46002" ><span +class="cmti-10">1325</span></a>, <a +href="glossaries-user.html#dx1-47002" >1326</a>, <a +href="glossaries-user.html#dx1-47003" >1327</a>, <a +href="glossaries-user.html#dx1-47007" >1328</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossaryentrynumbers</span></span></span>  <a +href="glossaries-user.html#dx1-166052" >1329</a>, <a +href="glossaries-user.html#dx1-166057" >1330</a>, <a +href="glossaries-user.html#dx1-166058" >1331</a>, <a +href="glossaries-user.html#dx1-166060" >1332</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossaryheader</span></span></span>  <a -href="glossaries-user.html#dx1-88015" ><span -class="cmti-10">619</span></a> <br /></span> - - +href="glossaries-user.html#dx1-166015" ><span +class="cmti-10">1333</span></a>, <a +href="glossaries-user.html#dx1-166018" >1334</a>, <a +href="glossaries-user.html#dx1-166079" >1335</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossaryname</span></span></span>  <a +href="glossaries-user.html#dx1-14024" >1336</a>, <a +href="glossaries-user.html#dx1-32015" >1337</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossarypostamble</span></span></span>  <a -href="glossaries-user.html#dx1-63066" ><span -class="cmti-10">620</span></a> <br /></span> +href="glossaries-user.html#dx1-141076" ><span +class="cmti-10">1338</span></a>, <a +href="glossaries-user.html#dx1-166007" >1339</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossarypreamble</span></span></span>  <a -href="glossaries-user.html#dx1-63064" ><span -class="cmti-10">621</span></a> <br /></span> +href="glossaries-user.html#dx1-47005" >1340</a>, <a +href="glossaries-user.html#dx1-141074" ><span +class="cmti-10">1341</span></a>, <a +href="glossaries-user.html#dx1-166006" >1342</a>, <a +href="glossaries-user.html#dx1-166016" >1343</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossarysection</span></span></span>  <a +href="glossaries-user.html#dx1-165004" >1344</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossarystyle</span></span></span>  <a +href="glossaries-user.html#dx1-141027" >1345</a> <br /></span> <span class="index-item"><span class="cmtt-10">glossarysubentry </span>(counter)  <a -href="glossaries-user.html#dx1-25021" ><span -class="cmti-10">622</span></a> <br /></span> +href="glossaries-user.html#dx1-48002" ><span +class="cmti-10">1346</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossentry</span></span></span>  <a -href="glossaries-user.html#dx1-88038" ><span -class="cmti-10">623</span></a> <br /></span> +href="glossaries-user.html#dx1-166038" ><span +class="cmti-10">1347</span></a>, <a +href="glossaries-user.html#dx1-166040" >1348</a>, <a +href="glossaries-user.html#dx1-166063" >1349</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glossentrydesc</span></span></span>  <a -href="glossaries-user.html#dx1-62029" ><span -class="cmti-10">624</span></a> <br /></span> +href="glossaries-user.html#dx1-140028" ><span +class="cmti-10">1350</span></a>, <a +href="glossaries-user.html#dx1-189010" >1351</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossentrydesc</span></span></span>  <a -href="glossaries-user.html#dx1-62028" ><span -class="cmti-10">625</span></a> <br /></span> +href="glossaries-user.html#dx1-11038" >1352</a>, <a +href="glossaries-user.html#dx1-140027" ><span +class="cmti-10">1353</span></a>, <a +href="glossaries-user.html#dx1-166042" >1354</a>, <a +href="glossaries-user.html#dx1-183027" >1355</a>, <a +href="glossaries-user.html#dx1-183037" >1356</a>, <a +href="glossaries-user.html#dx1-189011" >1357</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glossentryname</span></span></span>  <a -href="glossaries-user.html#dx1-62013" ><span -class="cmti-10">626</span></a> <br /></span> +href="glossaries-user.html#dx1-140012" ><span +class="cmti-10">1358</span></a>, <a +href="glossaries-user.html#dx1-166086" >1359</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossentryname</span></span></span>  <a -href="glossaries-user.html#dx1-62012" ><span -class="cmti-10">627</span></a> <br /></span> +href="glossaries-user.html#dx1-140011" ><span +class="cmti-10">1360</span></a>, <a +href="glossaries-user.html#dx1-166041" >1361</a>, <a +href="glossaries-user.html#dx1-166087" >1362</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glossentrynameother</span></span></span>  <a +href="glossaries-user.html#dx1-11088" >1363</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glossentrysymbol</span></span></span>  <a -href="glossaries-user.html#dx1-62036" ><span -class="cmti-10">628</span></a> <br /></span> +href="glossaries-user.html#dx1-140035" ><span +class="cmti-10">1364</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glossentrysymbol</span></span></span>  <a -href="glossaries-user.html#dx1-62035" ><span -class="cmti-10">629</span></a> <br /></span> +href="glossaries-user.html#dx1-11014" >1365</a>, <a +href="glossaries-user.html#dx1-11042" >1366</a>, <a +href="glossaries-user.html#dx1-11043" >1367</a>, <a +href="glossaries-user.html#dx1-11046" >1368</a>, <a +href="glossaries-user.html#dx1-140034" ><span +class="cmti-10">1369</span></a>, <a +href="glossaries-user.html#dx1-166043" >1370</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLS</span></span></span>  <a -href="glossaries-user.html#dx1-55022" ><span -class="cmti-10">630</span></a> <br /></span> +href="glossaries-user.html#dx1-3024" >1371</a>, <a +href="glossaries-user.html#dx1-112055" >1372</a>, <a +href="glossaries-user.html#dx1-133022" ><span +class="cmti-10">1373</span></a>, <a +href="glossaries-user.html#dx1-171029" >1374</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Gls</span></span></span>  <a -href="glossaries-user.html#dx1-55021" ><span -class="cmti-10">631</span></a> <br /></span> +href="glossaries-user.html#dx1-3023" >1375</a>, <a +href="glossaries-user.html#dx1-13017" >1376</a>, <a +href="glossaries-user.html#dx1-112054" >1377</a>, <a +href="glossaries-user.html#dx1-112152" >1378</a>, <a +href="glossaries-user.html#dx1-133021" ><span +class="cmti-10">1379</span></a>, <a +href="glossaries-user.html#dx1-147046" >1380</a>, <a +href="glossaries-user.html#dx1-147113" >1381</a>, <a +href="glossaries-user.html#dx1-152009" >1382</a>, <a +href="glossaries-user.html#dx1-152011" >1383</a>, <a +href="glossaries-user.html#dx1-152013" >1384</a>, <a +href="glossaries-user.html#dx1-171027" >1385</a>, <a +href="glossaries-user.html#dx1-216003" >1386</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls</span></span></span>  <a -href="glossaries-user.html#dx1-55011" ><span -class="cmti-10">632</span></a> <br /></span> +href="glossaries-user.html#dx1-3022" >1387</a>, <a +href="glossaries-user.html#dx1-3043" >1388</a>, <a +href="glossaries-user.html#dx1-11027" >1389</a>, <a +href="glossaries-user.html#dx1-11068" >1390</a>, <a +href="glossaries-user.html#dx1-34006" >1391</a>, <a +href="glossaries-user.html#dx1-34016" >1392</a>, <a +href="glossaries-user.html#dx1-83001" >1393</a>, <a +href="glossaries-user.html#dx1-84009" >1394</a>, <a +href="glossaries-user.html#dx1-112029" >1395</a>, <a +href="glossaries-user.html#dx1-112032" >1396</a>, <a +href="glossaries-user.html#dx1-112038" >1397</a>, <a +href="glossaries-user.html#dx1-112040" >1398</a>, <a +href="glossaries-user.html#dx1-112053" >1399</a>, <a +href="glossaries-user.html#dx1-133011" ><span +class="cmti-10">1400</span></a>, <a +href="glossaries-user.html#dx1-134020" >1401</a>, <a +href="glossaries-user.html#dx1-134023" >1402</a>, <a +href="glossaries-user.html#dx1-135016" >1403</a>, <a +href="glossaries-user.html#dx1-135039" >1404</a>, <a +href="glossaries-user.html#dx1-135063" >1405</a>, <a +href="glossaries-user.html#dx1-135085" >1406</a>, <a +href="glossaries-user.html#dx1-138005" >1407</a>, <a +href="glossaries-user.html#dx1-144023" >1408</a>, <a +href="glossaries-user.html#dx1-147037" >1409</a>, <a +href="glossaries-user.html#dx1-147111" >1410</a>, <a +href="glossaries-user.html#dx1-150041" >1411</a>, <a +href="glossaries-user.html#dx1-150074" >1412</a>, <a +href="glossaries-user.html#dx1-152008" >1413</a>, <a +href="glossaries-user.html#dx1-152010" >1414</a>, <a +href="glossaries-user.html#dx1-152012" >1415</a>, <a +href="glossaries-user.html#dx1-152020" >1416</a>, <a +href="glossaries-user.html#dx1-152022" >1417</a>, <a +href="glossaries-user.html#dx1-171019" >1418</a>, <a +href="glossaries-user.html#dx1-16069" >1419</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\gls*</span></span></span>  <a +href="glossaries-user.html#dx1-34002" >1420</a> <br /></span> + + +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsabbrvfont</span></span></span>  <a +href="glossaries-user.html#dx1-182012" >1421</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccessibility</span></span></span>  <a +href="glossaries-user.html#dx1-172073" ><span +class="cmti-10">1422</span></a>, <a +href="glossaries-user.html#dx1-224025" >1423</a>, <a +href="glossaries-user.html#dx1-224029" >1424</a>, <a +href="glossaries-user.html#dx1-224084" >1425</a>, <a +href="glossaries-user.html#dx1-224085" >1426</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Glsaccesslong</span></span></span>  <a +href="glossaries-user.html#dx1-184031" >1427</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccesslong</span></span></span>  <a +href="glossaries-user.html#dx1-184013" >1428</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Glsaccesslongpl</span></span></span>  <a +href="glossaries-user.html#dx1-184040" >1429</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccesslongpl</span></span></span>  <a +href="glossaries-user.html#dx1-184022" >1430</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccessshort</span></span></span>  <a +href="glossaries-user.html#dx1-184019" >1431</a>, <a +href="glossaries-user.html#dx1-184037" >1432</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccessshortpl</span></span></span>  <a +href="glossaries-user.html#dx1-184028" >1433</a>, <a +href="glossaries-user.html#dx1-184046" >1434</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-172065" ><span +class="cmti-10">1435</span></a>, <a +href="glossaries-user.html#dx1-224022" >1436</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsacrpluralsuffix</span></span></span>  <a +href="glossaries-user.html#dx1-147032" >1437</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsacspace</span></span></span>  <a -href="glossaries-user.html#dx1-71028" ><span -class="cmti-10">633</span></a> <br /></span> +href="glossaries-user.html#dx1-149029" ><span +class="cmti-10">1438</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsadd</span></span></span>  <a -href="glossaries-user.html#dx1-59001" ><span -class="cmti-10">634</span></a> <br /></span> +href="glossaries-user.html#dx1-11015" >1439</a>, <a +href="glossaries-user.html#dx1-11028" >1440</a>, <a +href="glossaries-user.html#dx1-30015" >1441</a>, <a +href="glossaries-user.html#dx1-64002" >1442</a>, <a +href="glossaries-user.html#dx1-137001" ><span +class="cmti-10">1443</span></a>, <a +href="glossaries-user.html#dx1-193002" >1444</a>, <a +href="glossaries-user.html#dx1-193030" >1445</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsaddall</span></span></span>  <a -href="glossaries-user.html#dx1-59003" ><span -class="cmti-10">635</span></a> <br /></span> +href="glossaries-user.html#dx1-127010" >1446</a>, <a +href="glossaries-user.html#dx1-137003" ><span +class="cmti-10">1447</span></a>, <a +href="glossaries-user.html#dx1-176002" >1448</a>, <a +href="glossaries-user.html#dx1-214027" >1449</a> <br /></span> <span class="index-item"><span class="cmtt-10">\glsaddall </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">types</span>  <a -href="glossaries-user.html#dx1-59004" >636</a> <br /></span> +class="cmtt-10">types</span>  <a +href="glossaries-user.html#dx1-137004" >1450</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsaddallunused</span></span></span>  <a -href="glossaries-user.html#dx1-59008" ><span -class="cmti-10">637</span></a> <br /></span> +href="glossaries-user.html#dx1-137010" ><span +class="cmti-10">1451</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsaddkey</span></span></span>  <a -href="glossaries-user.html#dx1-38001" ><span -class="cmti-10">638</span></a> <br /></span> +href="glossaries-user.html#dx1-112108" >1452</a>, <a +href="glossaries-user.html#dx1-113003" >1453</a>, <a +href="glossaries-user.html#dx1-114001" >1454</a>, <a +href="glossaries-user.html#dx1-116001" ><span +class="cmti-10">1455</span></a>, <a +href="glossaries-user.html#dx1-206001" >1456</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsAddLetterGroup</span></span></span>  <a +href="glossaries-user.html#dx1-211032" >1457</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsaddprotectedpagefmt</span></span></span>  <a -href="glossaries-user.html#dx1-51015" ><span -class="cmti-10">639</span></a> <br /></span> +href="glossaries-user.html#dx1-129016" ><span +class="cmti-10">1458</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsaddstoragekey</span></span></span>  <a -href="glossaries-user.html#dx1-39001" ><span -class="cmti-10">640</span></a> <br /></span> +href="glossaries-user.html#dx1-112109" >1459</a>, <a +href="glossaries-user.html#dx1-117001" ><span +class="cmti-10">1460</span></a>, <a +href="glossaries-user.html#dx1-136028" >1461</a>, <a +href="glossaries-user.html#dx1-150072" >1462</a>, <a +href="glossaries-user.html#dx1-185002" >1463</a>, <a +href="glossaries-user.html#dx1-186001" >1464</a>, <a +href="glossaries-user.html#dx1-207001" >1465</a>, <a +href="glossaries-user.html#dx1-209001" >1466</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsAddXdyAttribute</span></span></span>  <a -href="glossaries-user.html#dx1-66014" ><span -class="cmti-10">641</span></a> <br /></span> +href="glossaries-user.html#dx1-132051" >1467</a>, <a +href="glossaries-user.html#dx1-144015" ><span +class="cmti-10">1468</span></a>, <a +href="glossaries-user.html#dx1-190018" >1469</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsAddXdyCounters</span></span></span>  <a -href="glossaries-user.html#dx1-66009" ><span -class="cmti-10">642</span></a> <br /></span> +href="glossaries-user.html#dx1-144009" ><span +class="cmti-10">1470</span></a>, <a +href="glossaries-user.html#dx1-144043" >1471</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsAddXdyLocation</span></span></span>  <a -href="glossaries-user.html#dx1-66024" ><span -class="cmti-10">643</span></a> <br /></span> +href="glossaries-user.html#dx1-144027" ><span +class="cmti-10">1472</span></a>, <a +href="glossaries-user.html#dx1-144059" >1473</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsautoprefix</span></span></span>  <a -href="glossaries-user.html#dx1-24041" ><span -class="cmti-10">644</span></a> <br /></span> +href="glossaries-user.html#dx1-43006" ><span +class="cmti-10">1474</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsbackslash</span></span></span>  <a -href="glossaries-user.html#dx1-64012" ><span -class="cmti-10">645</span></a> <br /></span> +href="glossaries-user.html#dx1-142012" ><span +class="cmti-10">1475</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glscapscase</span></span></span>  <a -href="glossaries-user.html#dx1-57021" ><span -class="cmti-10">646</span></a> <br /></span> +href="glossaries-user.html#dx1-135021" ><span +class="cmti-10">1476</span></a>, <a +href="glossaries-user.html#dx1-135034" >1477</a>, <a +href="glossaries-user.html#dx1-150006" >1478</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glscategory</span></span></span>  <a +href="glossaries-user.html#dx1-207003" >1479</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsclearpage</span></span></span>  <a -href="glossaries-user.html#dx1-24018" ><span -class="cmti-10">647</span></a> <br /></span> +href="glossaries-user.html#dx1-41008" ><span +class="cmti-10">1480</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsclosebrace</span></span></span>  <a -href="glossaries-user.html#dx1-64008" ><span -class="cmti-10">648</span></a> <br /></span> +href="glossaries-user.html#dx1-142008" ><span +class="cmti-10">1481</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glscurrententrylabel</span></span></span>  <a +href="glossaries-user.html#dx1-194033" >1482</a>, <a +href="glossaries-user.html#dx1-200021" >1483</a>, <a +href="glossaries-user.html#dx1-200023" >1484</a>, <a +href="glossaries-user.html#dx1-200026" >1485</a>, <a +href="glossaries-user.html#dx1-200028" >1486</a>, <a +href="glossaries-user.html#dx1-200033" >1487</a>, <a +href="glossaries-user.html#dx1-202029" >1488</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glscurrentfieldvalue</span></span></span>  <a -href="glossaries-user.html#dx1-91027" ><span -class="cmti-10">649</span></a> <br /></span> +href="glossaries-user.html#dx1-169027" ><span +class="cmti-10">1489</span></a>, <a +href="glossaries-user.html#dx1-200024" >1490</a>, <a +href="glossaries-user.html#dx1-202025" >1491</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glscustomtext</span></span></span>  <a -href="glossaries-user.html#dx1-57015" ><span -class="cmti-10">650</span></a> <br /></span> +href="glossaries-user.html#dx1-135015" ><span +class="cmti-10">1492</span></a>, <a +href="glossaries-user.html#dx1-135036" >1493</a>, <a +href="glossaries-user.html#dx1-147049" >1494</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsDeclareNoHyperList</span></span></span>  <a +href="glossaries-user.html#dx1-83003" >1495</a>, <a +href="glossaries-user.html#dx1-87014" >1496</a>, <a +href="glossaries-user.html#dx1-221002" >1497</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdefaultshortaccess</span></span></span>  <a +href="glossaries-user.html#dx1-172063" ><span +class="cmti-10">1498</span></a>, <a +href="glossaries-user.html#dx1-224055" >1499</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdefaulttype</span></span></span>  <a +href="glossaries-user.html#dx1-122005" >1500</a>, <a +href="glossaries-user.html#dx1-135008" >1501</a>, <a +href="glossaries-user.html#dx1-168006" >1502</a>, <a +href="glossaries-user.html#dx1-90009" >1503</a>, <a +href="glossaries-user.html#dx1-90011" >1504</a>, <a +href="glossaries-user.html#dx1-122023" >1505</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdefpostdesc</span></span></span>  <a +href="glossaries-user.html#dx1-200019" >1506</a>, <a +href="glossaries-user.html#dx1-202027" >1507</a>, <a +href="glossaries-user.html#dx1-202076" >1508</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdefpostlink</span></span></span>  <a +href="glossaries-user.html#dx1-183013" >1509</a>, <a +href="glossaries-user.html#dx1-183021" >1510</a>, <a +href="glossaries-user.html#dx1-183033" >1511</a>, <a +href="glossaries-user.html#dx1-202021" >1512</a>, <a +href="glossaries-user.html#dx1-222007" >1513</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSdesc</span></span></span>  <a -href="glossaries-user.html#dx1-56054" ><span -class="cmti-10">651</span></a> <br /></span> +href="glossaries-user.html#dx1-134054" ><span +class="cmti-10">1514</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsdesc</span></span></span>  <a -href="glossaries-user.html#dx1-56053" ><span -class="cmti-10">652</span></a> <br /></span> +href="glossaries-user.html#dx1-134053" ><span +class="cmti-10">1515</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdesc</span></span></span>  <a -href="glossaries-user.html#dx1-56050" ><span -class="cmti-10">653</span></a> <br /></span> +href="glossaries-user.html#dx1-134050" ><span +class="cmti-10">1516</span></a>, <a +href="glossaries-user.html#dx1-189008" >1517</a>, <a +href="glossaries-user.html#dx1-189016" >1518</a>, <a +href="glossaries-user.html#dx1-189019" >1519</a>, <a +href="glossaries-user.html#dx1-189020" >1520</a>, <a +href="glossaries-user.html#dx1-189021" >1521</a>, <a +href="glossaries-user.html#dx1-189024" >1522</a>, <a +href="glossaries-user.html#dx1-192018" >1523</a>, <a +href="glossaries-user.html#dx1-192026" >1524</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdescwidth</span></span></span>  <a -href="glossaries-user.html#dx1-78016" ><span -class="cmti-10">654</span></a> <br /></span> +href="glossaries-user.html#dx1-156016" ><span +class="cmti-10">1525</span></a>, <a +href="glossaries-user.html#dx1-158012" >1526</a>, <a +href="glossaries-user.html#dx1-158022" >1527</a>, <a +href="glossaries-user.html#dx1-158041" >1528</a>, <a +href="glossaries-user.html#dx1-159012" >1529</a>, <a +href="glossaries-user.html#dx1-159022" >1530</a>, <a +href="glossaries-user.html#dx1-159032" >1531</a>, <a +href="glossaries-user.html#dx1-161017" >1532</a>, <a +href="glossaries-user.html#dx1-161027" >1533</a>, <a +href="glossaries-user.html#dx1-161046" >1534</a>, <a +href="glossaries-user.html#dx1-162014" >1535</a>, <a +href="glossaries-user.html#dx1-162024" >1536</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdisablehyper</span></span></span>  <a -href="glossaries-user.html#dx1-58005" ><span -class="cmti-10">655</span></a> <br /></span> +href="glossaries-user.html#dx1-132038" >1537</a>, <a +href="glossaries-user.html#dx1-135025" >1538</a>, <a +href="glossaries-user.html#dx1-136005" ><span +class="cmti-10">1539</span></a>, <a +href="glossaries-user.html#dx1-136020" >1540</a>, <a +href="glossaries-user.html#dx1-140056" >1541</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdisp</span></span></span>  <a -href="glossaries-user.html#dx1-55056" ><span -class="cmti-10">656</span></a> <br /></span> +href="glossaries-user.html#dx1-3028" >1542</a>, <a +href="glossaries-user.html#dx1-3034" >1543</a>, <a +href="glossaries-user.html#dx1-34007" >1544</a>, <a +href="glossaries-user.html#dx1-112037" >1545</a>, <a +href="glossaries-user.html#dx1-133003" >1546</a>, <a +href="glossaries-user.html#dx1-133056" ><span +class="cmti-10">1547</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdisplay</span></span></span>  <a +href="glossaries-user.html#dx1-112066" >1548</a>, <a +href="glossaries-user.html#dx1-135004" >1549</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsdisplayfirst</span></span></span>  <a +href="glossaries-user.html#dx1-112067" >1550</a>, <a +href="glossaries-user.html#dx1-135003" >1551</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdisplaynumberlist</span></span></span>  <a -href="glossaries-user.html#dx1-62061" ><span -class="cmti-10">657</span></a> <br /></span> +href="glossaries-user.html#dx1-5002" >1552</a>, <a +href="glossaries-user.html#dx1-45004" >1553</a>, <a +href="glossaries-user.html#dx1-140060" ><span +class="cmti-10">1554</span></a>, <a +href="glossaries-user.html#dx1-220004" >1555</a>, <a +href="glossaries-user.html#dx1-220011" >1556</a>, <a +href="glossaries-user.html#dx1-220014" >1557</a>, <a +href="glossaries-user.html#dx1-220016" >1558</a>, <a +href="glossaries-user.html#dx1-220039" >1559</a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdoifexists</span></span></span>  <a -href="glossaries-user.html#dx1-91005" ><span -class="cmti-10">658</span></a> <br /></span> +href="glossaries-user.html#dx1-169005" ><span +class="cmti-10">1560</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdoifexistsordo</span></span></span>  <a -href="glossaries-user.html#dx1-91008" ><span -class="cmti-10">659</span></a> <br /></span> +href="glossaries-user.html#dx1-169008" ><span +class="cmti-10">1561</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdoifexistsorwarn</span></span></span>  <a -href="glossaries-user.html#dx1-91007" ><span -class="cmti-10">660</span></a> <br /></span> +href="glossaries-user.html#dx1-169007" ><span +class="cmti-10">1562</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdoifnoexists</span></span></span>  <a -href="glossaries-user.html#dx1-91006" ><span -class="cmti-10">661</span></a> <br /></span> +href="glossaries-user.html#dx1-169006" ><span +class="cmti-10">1563</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdoifnoexistsordo</span></span></span>  <a -href="glossaries-user.html#dx1-91009" ><span -class="cmti-10">662</span></a> <br /></span> +href="glossaries-user.html#dx1-169009" ><span +class="cmti-10">1564</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsdosanitizesort</span></span></span>  <a -href="glossaries-user.html#dx1-26031" ><span -class="cmti-10">663</span></a> <br /></span> +href="glossaries-user.html#dx1-73029" ><span +class="cmti-10">1565</span></a>, <a +href="glossaries-user.html#dx1-197003" >1566</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsenableentrycount</span></span></span>  <a -href="glossaries-user.html#dx1-76003" ><span -class="cmti-10">664</span></a> <br /></span> - - +href="glossaries-user.html#dx1-154003" ><span +class="cmti-10">1567</span></a>, <a +href="glossaries-user.html#dx1-226001" >1568</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsenablehyper</span></span></span>  <a -href="glossaries-user.html#dx1-58006" ><span -class="cmti-10">665</span></a> <br /></span> +href="glossaries-user.html#dx1-136006" ><span +class="cmti-10">1569</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrycounterlabel</span></span></span>  <a -href="glossaries-user.html#dx1-88048" ><span -class="cmti-10">666</span></a> <br /></span> +href="glossaries-user.html#dx1-166048" ><span +class="cmti-10">1570</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsEntryCounterLabelPrefix</span></span></span>  <a -href="glossaries-user.html#dx1-25006" ><span -class="cmti-10">667</span></a> <br /></span> +href="glossaries-user.html#dx1-46005" ><span +class="cmti-10">1571</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrycurrcount</span></span></span>  <a -href="glossaries-user.html#dx1-76006" ><span -class="cmti-10">668</span></a> <br /></span> +href="glossaries-user.html#dx1-154007" ><span +class="cmti-10">1572</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrydesc</span></span></span>  <a -href="glossaries-user.html#dx1-62027" ><span -class="cmti-10">669</span></a> <br /></span> +href="glossaries-user.html#dx1-11007" >1573</a>, <a +href="glossaries-user.html#dx1-11016" >1574</a>, <a +href="glossaries-user.html#dx1-11037" >1575</a>, <a +href="glossaries-user.html#dx1-140026" ><span +class="cmti-10">1576</span></a>, <a +href="glossaries-user.html#dx1-183040" >1577</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrydesc</span></span></span>  <a -href="glossaries-user.html#dx1-62026" ><span -class="cmti-10">670</span></a> <br /></span> +href="glossaries-user.html#dx1-11036" >1578</a>, <a +href="glossaries-user.html#dx1-140025" ><span +class="cmti-10">1579</span></a>, <a +href="glossaries-user.html#dx1-182019" >1580</a>, <a +href="glossaries-user.html#dx1-182024" >1581</a>, <a +href="glossaries-user.html#dx1-183011" >1582</a>, <a +href="glossaries-user.html#dx1-183016" >1583</a>, <a +href="glossaries-user.html#dx1-183025" >1584</a>, <a +href="glossaries-user.html#dx1-183028" >1585</a>, <a +href="glossaries-user.html#dx1-184055" >1586</a>, <a +href="glossaries-user.html#dx1-184059" >1587</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrydescplural</span></span></span>  <a -href="glossaries-user.html#dx1-62031" ><span -class="cmti-10">671</span></a> <br /></span> +href="glossaries-user.html#dx1-140030" ><span +class="cmti-10">1588</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrydescplural</span></span></span>  <a -href="glossaries-user.html#dx1-62030" ><span -class="cmti-10">672</span></a> <br /></span> +href="glossaries-user.html#dx1-140029" ><span +class="cmti-10">1589</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryfirst</span></span></span>  <a -href="glossaries-user.html#dx1-62021" ><span -class="cmti-10">673</span></a> <br /></span> +href="glossaries-user.html#dx1-140020" ><span +class="cmti-10">1590</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryfirst</span></span></span>  <a -href="glossaries-user.html#dx1-62020" ><span -class="cmti-10">674</span></a> <br /></span> +href="glossaries-user.html#dx1-140019" ><span +class="cmti-10">1591</span></a>, <a +href="glossaries-user.html#dx1-211045" >1592</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-62024" ><span -class="cmti-10">675</span></a> <br /></span> +href="glossaries-user.html#dx1-140023" ><span +class="cmti-10">1593</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-62023" ><span -class="cmti-10">676</span></a> <br /></span> +href="glossaries-user.html#dx1-140022" ><span +class="cmti-10">1594</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryfmt</span></span></span>  <a -href="glossaries-user.html#dx1-57006" ><span -class="cmti-10">677</span></a> <br /></span> +href="glossaries-user.html#dx1-132028" >1595</a>, <a +href="glossaries-user.html#dx1-133001" >1596</a>, <a +href="glossaries-user.html#dx1-134001" >1597</a>, <a +href="glossaries-user.html#dx1-135006" ><span +class="cmti-10">1598</span></a>, <a +href="glossaries-user.html#dx1-135078" >1599</a>, <a +href="glossaries-user.html#dx1-136014" >1600</a>, <a +href="glossaries-user.html#dx1-136021" >1601</a>, <a +href="glossaries-user.html#dx1-136025" >1602</a>, <a +href="glossaries-user.html#dx1-147019" >1603</a>, <a +href="glossaries-user.html#dx1-183006" >1604</a>, <a +href="glossaries-user.html#dx1-221001" >1605</a>, <a +href="glossaries-user.html#dx1-222002" >1606</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryfull</span></span></span>  <a -href="glossaries-user.html#dx1-69129" ><span -class="cmti-10">678</span></a> <br /></span> +href="glossaries-user.html#dx1-147129" ><span +class="cmti-10">1607</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryfull</span></span></span>  <a -href="glossaries-user.html#dx1-69128" ><span -class="cmti-10">679</span></a> <br /></span> +href="glossaries-user.html#dx1-147128" ><span +class="cmti-10">1608</span></a>, <a +href="glossaries-user.html#dx1-149018" >1609</a>, <a +href="glossaries-user.html#dx1-149056" >1610</a>, <a +href="glossaries-user.html#dx1-149069" >1611</a>, <a +href="glossaries-user.html#dx1-150017" >1612</a>, <a +href="glossaries-user.html#dx1-150053" >1613</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryfullpl</span></span></span>  <a -href="glossaries-user.html#dx1-69131" ><span -class="cmti-10">680</span></a> <br /></span> +href="glossaries-user.html#dx1-147131" ><span +class="cmti-10">1614</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryfullpl</span></span></span>  <a -href="glossaries-user.html#dx1-69130" ><span -class="cmti-10">681</span></a> <br /></span> +href="glossaries-user.html#dx1-147130" ><span +class="cmti-10">1615</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryitem</span></span></span>  <a -href="glossaries-user.html#dx1-88045" ><span -class="cmti-10">682</span></a> <br /></span> +href="glossaries-user.html#dx1-166045" ><span +class="cmti-10">1616</span></a>, <a +href="glossaries-user.html#dx1-166081" >1617</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrylong</span></span></span>  <a -href="glossaries-user.html#dx1-69121" ><span -class="cmti-10">683</span></a> <br /></span> +href="glossaries-user.html#dx1-135068" >1618</a>, <a +href="glossaries-user.html#dx1-147121" ><span +class="cmti-10">1619</span></a>, <a +href="glossaries-user.html#dx1-150049" >1620</a>, <a +href="glossaries-user.html#dx1-150061" >1621</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrylong</span></span></span>  <a -href="glossaries-user.html#dx1-69120" ><span -class="cmti-10">684</span></a> <br /></span> +href="glossaries-user.html#dx1-147120" ><span +class="cmti-10">1622</span></a>, <a +href="glossaries-user.html#dx1-150051" >1623</a>, <a +href="glossaries-user.html#dx1-150062" >1624</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrylongpl</span></span></span>  <a -href="glossaries-user.html#dx1-69123" ><span -class="cmti-10">685</span></a> <br /></span> +href="glossaries-user.html#dx1-147123" ><span +class="cmti-10">1625</span></a>, <a +href="glossaries-user.html#dx1-150050" >1626</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrylongpl</span></span></span>  <a -href="glossaries-user.html#dx1-69122" ><span -class="cmti-10">686</span></a> <br /></span> +href="glossaries-user.html#dx1-147122" ><span +class="cmti-10">1627</span></a>, <a +href="glossaries-user.html#dx1-150052" >1628</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryname</span></span></span>  <a -href="glossaries-user.html#dx1-62008" ><span -class="cmti-10">687</span></a> <br /></span> +href="glossaries-user.html#dx1-140007" ><span +class="cmti-10">1629</span></a>, <a +href="glossaries-user.html#dx1-11003" >1630</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryname</span></span></span>  <a -href="glossaries-user.html#dx1-62007" ><span -class="cmti-10">688</span></a> <br /></span> +href="glossaries-user.html#dx1-140006" ><span +class="cmti-10">1631</span></a>, <a +href="glossaries-user.html#dx1-204016" >1632</a>, <a +href="glossaries-user.html#dx1-211047" >1633</a>, <a +href="glossaries-user.html#dx1-11002" >1634</a>, <a +href="glossaries-user.html#dx1-140053" >1635</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrynumberlist</span></span></span>  <a -href="glossaries-user.html#dx1-62060" ><span -class="cmti-10">689</span></a> <br /></span> +href="glossaries-user.html#dx1-45003" >1636</a>, <a +href="glossaries-user.html#dx1-140059" ><span +class="cmti-10">1637</span></a>, <a +href="glossaries-user.html#dx1-220003" >1638</a>, <a +href="glossaries-user.html#dx1-220012" >1639</a>, <a +href="glossaries-user.html#dx1-220040" >1640</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsentryparent</span></span></span>  <a +href="glossaries-user.html#dx1-170002" ><span +class="cmti-10">1641</span></a>, <a +href="glossaries-user.html#dx1-200035" >1642</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryplural</span></span></span>  <a -href="glossaries-user.html#dx1-62018" ><span -class="cmti-10">690</span></a> <br /></span> +href="glossaries-user.html#dx1-140017" ><span +class="cmti-10">1643</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryplural</span></span></span>  <a -href="glossaries-user.html#dx1-62017" ><span -class="cmti-10">691</span></a> <br /></span> +href="glossaries-user.html#dx1-140016" ><span +class="cmti-10">1644</span></a>, <a +href="glossaries-user.html#dx1-200022" >1645</a>, <a +href="glossaries-user.html#dx1-200032" >1646</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryprefix</span></span></span>  <a -href="glossaries-user.html#dx1-93057" ><span -class="cmti-10">692</span></a> <br /></span> +href="glossaries-user.html#dx1-171057" ><span +class="cmti-10">1647</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryprefix</span></span></span>  <a -href="glossaries-user.html#dx1-93048" ><span -class="cmti-10">693</span></a> <br /></span> +href="glossaries-user.html#dx1-171048" ><span +class="cmti-10">1648</span></a>, <a +href="glossaries-user.html#dx1-194032" >1649</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryprefixfirst</span></span></span>  <a -href="glossaries-user.html#dx1-93058" ><span -class="cmti-10">694</span></a> <br /></span> +href="glossaries-user.html#dx1-171058" ><span +class="cmti-10">1650</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryprefixfirst</span></span></span>  <a -href="glossaries-user.html#dx1-93050" ><span -class="cmti-10">695</span></a> <br /></span> +href="glossaries-user.html#dx1-171050" ><span +class="cmti-10">1651</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryprefixfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-93060" ><span -class="cmti-10">696</span></a> <br /></span> +href="glossaries-user.html#dx1-171060" ><span +class="cmti-10">1652</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryprefixfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-93054" ><span -class="cmti-10">697</span></a> <br /></span> +href="glossaries-user.html#dx1-171054" ><span +class="cmti-10">1653</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryprefixplural</span></span></span>  <a -href="glossaries-user.html#dx1-93059" ><span -class="cmti-10">698</span></a> <br /></span> +href="glossaries-user.html#dx1-171059" ><span +class="cmti-10">1654</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryprefixplural</span></span></span>  <a -href="glossaries-user.html#dx1-93052" ><span -class="cmti-10">699</span></a> <br /></span> +href="glossaries-user.html#dx1-171052" ><span +class="cmti-10">1655</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryprevcount</span></span></span>  <a -href="glossaries-user.html#dx1-76007" ><span -class="cmti-10">700</span></a> <br /></span> +href="glossaries-user.html#dx1-154008" ><span +class="cmti-10">1656</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryshort</span></span></span>  <a -href="glossaries-user.html#dx1-69125" ><span -class="cmti-10">701</span></a> <br /></span> +href="glossaries-user.html#dx1-147125" ><span +class="cmti-10">1657</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryshort</span></span></span>  <a -href="glossaries-user.html#dx1-69124" ><span -class="cmti-10">702</span></a> <br /></span> +href="glossaries-user.html#dx1-147124" ><span +class="cmti-10">1658</span></a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryshortpl</span></span></span>  <a -href="glossaries-user.html#dx1-69127" ><span -class="cmti-10">703</span></a> <br /></span> +href="glossaries-user.html#dx1-147127" ><span +class="cmti-10">1659</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryshortpl</span></span></span>  <a -href="glossaries-user.html#dx1-69126" ><span -class="cmti-10">704</span></a> <br /></span> +href="glossaries-user.html#dx1-147126" ><span +class="cmti-10">1660</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsentrysort</span></span></span>  <a +href="glossaries-user.html#dx1-170003" ><span +class="cmti-10">1661</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrysymbol</span></span></span>  <a -href="glossaries-user.html#dx1-62033" ><span -class="cmti-10">705</span></a> <br /></span> +href="glossaries-user.html#dx1-140032" ><span +class="cmti-10">1662</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrysymbol</span></span></span>  <a -href="glossaries-user.html#dx1-62032" ><span -class="cmti-10">706</span></a> <br /></span> +href="glossaries-user.html#dx1-11006" >1663</a>, <a +href="glossaries-user.html#dx1-11041" >1664</a>, <a +href="glossaries-user.html#dx1-135079" >1665</a>, <a +href="glossaries-user.html#dx1-140031" ><span +class="cmti-10">1666</span></a>, <a +href="glossaries-user.html#dx1-189039" >1667</a>, <a +href="glossaries-user.html#dx1-222005" >1668</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrysymbolplural</span></span></span>  <a -href="glossaries-user.html#dx1-62038" ><span -class="cmti-10">707</span></a> <br /></span> +href="glossaries-user.html#dx1-140037" ><span +class="cmti-10">1669</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrysymbolplural</span></span></span>  <a -href="glossaries-user.html#dx1-62037" ><span -class="cmti-10">708</span></a> <br /></span> +href="glossaries-user.html#dx1-140036" ><span +class="cmti-10">1670</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentrytext</span></span></span>  <a -href="glossaries-user.html#dx1-62015" ><span -class="cmti-10">709</span></a> <br /></span> +href="glossaries-user.html#dx1-116005" >1671</a>, <a +href="glossaries-user.html#dx1-132012" >1672</a>, <a +href="glossaries-user.html#dx1-140014" ><span +class="cmti-10">1673</span></a>, <a +href="glossaries-user.html#dx1-147119" >1674</a>, <a +href="glossaries-user.html#dx1-171061" >1675</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrytext</span></span></span>  <a -href="glossaries-user.html#dx1-62014" ><span -class="cmti-10">710</span></a> <br /></span> - - +href="glossaries-user.html#dx1-116004" >1676</a>, <a +href="glossaries-user.html#dx1-132011" >1677</a>, <a +href="glossaries-user.html#dx1-139012" >1678</a>, <a +href="glossaries-user.html#dx1-140013" ><span +class="cmti-10">1679</span></a>, <a +href="glossaries-user.html#dx1-140051" >1680</a>, <a +href="glossaries-user.html#dx1-147118" >1681</a>, <a +href="glossaries-user.html#dx1-179021" >1682</a>, <a +href="glossaries-user.html#dx1-200027" >1683</a>, <a +href="glossaries-user.html#dx1-202028" >1684</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentrytitlecase</span></span></span>  <a -href="glossaries-user.html#dx1-62005" ><span -class="cmti-10">711</span></a> <br /></span> +href="glossaries-user.html#dx1-134012" >1685</a>, <a +href="glossaries-user.html#dx1-140005" ><span +class="cmti-10">1686</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsentrytype</span></span></span>  <a +href="glossaries-user.html#dx1-170001" ><span +class="cmti-10">1687</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuseri</span></span></span>  <a -href="glossaries-user.html#dx1-62040" ><span -class="cmti-10">712</span></a> <br /></span> +href="glossaries-user.html#dx1-140039" ><span +class="cmti-10">1688</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuseri</span></span></span>  <a -href="glossaries-user.html#dx1-62039" ><span -class="cmti-10">713</span></a> <br /></span> +href="glossaries-user.html#dx1-140038" ><span +class="cmti-10">1689</span></a>, <a +href="glossaries-user.html#dx1-166044" >1690</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuserii</span></span></span>  <a -href="glossaries-user.html#dx1-62042" ><span -class="cmti-10">714</span></a> <br /></span> +href="glossaries-user.html#dx1-140041" ><span +class="cmti-10">1691</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuserii</span></span></span>  <a -href="glossaries-user.html#dx1-62041" ><span -class="cmti-10">715</span></a> <br /></span> +href="glossaries-user.html#dx1-140040" ><span +class="cmti-10">1692</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuseriii</span></span></span>  <a -href="glossaries-user.html#dx1-62044" ><span -class="cmti-10">716</span></a> <br /></span> +href="glossaries-user.html#dx1-140043" ><span +class="cmti-10">1693</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuseriii</span></span></span>  <a -href="glossaries-user.html#dx1-62043" ><span -class="cmti-10">717</span></a> <br /></span> +href="glossaries-user.html#dx1-140042" ><span +class="cmti-10">1694</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuseriv</span></span></span>  <a -href="glossaries-user.html#dx1-62046" ><span -class="cmti-10">718</span></a> <br /></span> +href="glossaries-user.html#dx1-140045" ><span +class="cmti-10">1695</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuseriv</span></span></span>  <a -href="glossaries-user.html#dx1-62045" ><span -class="cmti-10">719</span></a> <br /></span> +href="glossaries-user.html#dx1-140044" ><span +class="cmti-10">1696</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuserv</span></span></span>  <a -href="glossaries-user.html#dx1-62048" ><span -class="cmti-10">720</span></a> <br /></span> +href="glossaries-user.html#dx1-140047" ><span +class="cmti-10">1697</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuserv</span></span></span>  <a -href="glossaries-user.html#dx1-62047" ><span -class="cmti-10">721</span></a> <br /></span> +href="glossaries-user.html#dx1-140046" ><span +class="cmti-10">1698</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsentryuservi</span></span></span>  <a -href="glossaries-user.html#dx1-62050" ><span -class="cmti-10">722</span></a> <br /></span> +href="glossaries-user.html#dx1-140049" ><span +class="cmti-10">1699</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsentryuservi</span></span></span>  <a -href="glossaries-user.html#dx1-62049" ><span -class="cmti-10">723</span></a> <br /></span> +href="glossaries-user.html#dx1-140048" ><span +class="cmti-10">1700</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsexpandfields</span></span></span>  <a -href="glossaries-user.html#dx1-40022" ><span -class="cmti-10">724</span></a> <br /></span> +href="glossaries-user.html#dx1-118022" ><span +class="cmti-10">1701</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfieldaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-172066" ><span +class="cmti-10">1702</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfielddef</span></span></span>  <a -href="glossaries-user.html#dx1-92006" ><span -class="cmti-10">725</span></a> <br /></span> +href="glossaries-user.html#dx1-170009" ><span +class="cmti-10">1703</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfieldedef</span></span></span>  <a -href="glossaries-user.html#dx1-92007" ><span -class="cmti-10">726</span></a> <br /></span> +href="glossaries-user.html#dx1-170010" ><span +class="cmti-10">1704</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfieldfetch</span></span></span>  <a -href="glossaries-user.html#dx1-92001" ><span -class="cmti-10">727</span></a> <br /></span> +href="glossaries-user.html#dx1-170004" ><span +class="cmti-10">1705</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfieldgdef</span></span></span>  <a -href="glossaries-user.html#dx1-92008" ><span -class="cmti-10">728</span></a> <br /></span> +href="glossaries-user.html#dx1-170011" ><span +class="cmti-10">1706</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfieldxdef</span></span></span>  <a -href="glossaries-user.html#dx1-92009" ><span -class="cmti-10">729</span></a> <br /></span> +href="glossaries-user.html#dx1-136031" >1707</a>, <a +href="glossaries-user.html#dx1-170012" ><span +class="cmti-10">1708</span></a>, <a +href="glossaries-user.html#dx1-209005" >1709</a>, <a +href="glossaries-user.html#dx1-209006" >1710</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfindwidesttoplevelname</span></span></span>  <a -href="glossaries-user.html#dx1-85051" ><span -class="cmti-10">730</span></a> <br /></span> +href="glossaries-user.html#dx1-163051" ><span +class="cmti-10">1711</span></a>, <a +href="glossaries-user.html#dx1-202003" >1712</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsFindWidestUsedLevelTwo</span></span></span>  <a +href="glossaries-user.html#dx1-202015" >1713</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsFindWidestUsedTopLevelName</span></span></span>  <a +href="glossaries-user.html#dx1-202014" >1714</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSfirst</span></span></span>  <a -href="glossaries-user.html#dx1-56017" ><span -class="cmti-10">731</span></a> <br /></span> +href="glossaries-user.html#dx1-134017" ><span +class="cmti-10">1715</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsfirst</span></span></span>  <a -href="glossaries-user.html#dx1-56016" ><span -class="cmti-10">732</span></a> <br /></span> +href="glossaries-user.html#dx1-134016" ><span +class="cmti-10">1716</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfirst</span></span></span>  <a -href="glossaries-user.html#dx1-56013" ><span -class="cmti-10">733</span></a> <br /></span> +href="glossaries-user.html#dx1-134013" ><span +class="cmti-10">1717</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfirstabbrvscfont</span></span></span>  <a +href="glossaries-user.html#dx1-184018" >1718</a>, <a +href="glossaries-user.html#dx1-184027" >1719</a>, <a +href="glossaries-user.html#dx1-184036" >1720</a>, <a +href="glossaries-user.html#dx1-184045" >1721</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfirstlongfootnotefont</span></span></span>  <a +href="glossaries-user.html#dx1-184012" >1722</a>, <a +href="glossaries-user.html#dx1-184021" >1723</a>, <a +href="glossaries-user.html#dx1-184030" >1724</a>, <a +href="glossaries-user.html#dx1-184039" >1725</a>, <a +href="glossaries-user.html#dx1-184063" >1726</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-56037" ><span -class="cmti-10">734</span></a> <br /></span> +href="glossaries-user.html#dx1-134037" ><span +class="cmti-10">1727</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-56036" ><span -class="cmti-10">735</span></a> <br /></span> +href="glossaries-user.html#dx1-134036" ><span +class="cmti-10">1728</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-56033" ><span -class="cmti-10">736</span></a> <br /></span> +href="glossaries-user.html#dx1-134033" ><span +class="cmti-10">1729</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfmtfirst</span></span></span>  <a +href="glossaries-user.html#dx1-211046" >1730</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Glsfmtlong</span></span></span>  <a +href="glossaries-user.html#dx1-182022" >1731</a>, <a +href="glossaries-user.html#dx1-184058" >1732</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfmtname</span></span></span>  <a +href="glossaries-user.html#dx1-179028" >1733</a>, <a +href="glossaries-user.html#dx1-179030" >1734</a>, <a +href="glossaries-user.html#dx1-211048" >1735</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfmtshort</span></span></span>  <a +href="glossaries-user.html#dx1-182023" >1736</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsfmttext</span></span></span>  <a +href="glossaries-user.html#dx1-179027" >1737</a>, <a +href="glossaries-user.html#dx1-197025" >1738</a>, <a +href="glossaries-user.html#dx1-197027" >1739</a>, <a +href="glossaries-user.html#dx1-197030" >1740</a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsgenacfmt</span></span></span>  <a -href="glossaries-user.html#dx1-57050" ><span -class="cmti-10">737</span></a> <br /></span> +href="glossaries-user.html#dx1-135050" ><span +class="cmti-10">1741</span></a>, <a +href="glossaries-user.html#dx1-135072" >1742</a>, <a +href="glossaries-user.html#dx1-148007" >1743</a>, <a +href="glossaries-user.html#dx1-150003" >1744</a>, <a +href="glossaries-user.html#dx1-150009" >1745</a>, <a +href="glossaries-user.html#dx1-150046" >1746</a>, <a +href="glossaries-user.html#dx1-150073" >1747</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsgenentryfmt</span></span></span>  <a -href="glossaries-user.html#dx1-57044" ><span -class="cmti-10">738</span></a> <br /></span> +href="glossaries-user.html#dx1-135044" ><span +class="cmti-10">1748</span></a>, <a +href="glossaries-user.html#dx1-150010" >1749</a>, <a +href="glossaries-user.html#dx1-150045" >1750</a>, <a +href="glossaries-user.html#dx1-183007" >1751</a>, <a +href="glossaries-user.html#dx1-222003" >1752</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsgetgrouptitle</span></span></span>  <a -href="glossaries-user.html#dx1-88026" ><span -class="cmti-10">739</span></a> <br /></span> +href="glossaries-user.html#dx1-166026" ><span +class="cmti-10">1753</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsglossarymark</span></span></span>  <a -href="glossaries-user.html#dx1-24013" ><span -class="cmti-10">740</span></a>, <a -href="glossaries-user.html#dx1-63061" ><span -class="cmti-10">741</span></a> <br /></span> +href="glossaries-user.html#dx1-41003" ><span +class="cmti-10">1754</span></a>, <a +href="glossaries-user.html#dx1-42004" >1755</a>, <a +href="glossaries-user.html#dx1-141071" ><span +class="cmti-10">1756</span></a>, <a +href="glossaries-user.html#dx1-141072" >1757</a>, <a +href="glossaries-user.html#dx1-141073" >1758</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsgroupheading</span></span></span>  <a -href="glossaries-user.html#dx1-88020" ><span -class="cmti-10">742</span></a> <br /></span> +href="glossaries-user.html#dx1-166020" ><span +class="cmti-10">1759</span></a>, <a +href="glossaries-user.html#dx1-166077" >1760</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsgroupskip</span></span></span>  <a -href="glossaries-user.html#dx1-88034" ><span -class="cmti-10">743</span></a> <br /></span> +href="glossaries-user.html#dx1-156032" >1761</a>, <a +href="glossaries-user.html#dx1-166034" ><span +class="cmti-10">1762</span></a>, <a +href="glossaries-user.html#dx1-166078" >1763</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glshyperlink</span></span></span>  <a -href="glossaries-user.html#dx1-62051" ><span -class="cmti-10">744</span></a> <br /></span> +href="glossaries-user.html#dx1-136022" >1764</a>, <a +href="glossaries-user.html#dx1-140002" >1765</a>, <a +href="glossaries-user.html#dx1-140050" ><span +class="cmti-10">1766</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glshypernavsep</span></span></span>  <a -href="glossaries-user.html#dx1-79021" ><span -class="cmti-10">745</span></a> <br /></span> +href="glossaries-user.html#dx1-157021" ><span +class="cmti-10">1767</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsifhyper</span></span></span>  <a +href="glossaries-user.html#dx1-135027" >1768</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsifhyperon</span></span></span>  <a -href="glossaries-user.html#dx1-57022" ><span -class="cmti-10">746</span></a> <br /></span> +href="glossaries-user.html#dx1-135022" ><span +class="cmti-10">1769</span></a>, <a +href="glossaries-user.html#dx1-209004" >1770</a>, <a +href="glossaries-user.html#dx1-209010" >1771</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsIfListOfAcronyms</span></span></span>  <a -href="glossaries-user.html#dx1-27025" ><span -class="cmti-10">747</span></a> <br /></span> +href="glossaries-user.html#dx1-93006" ><span +class="cmti-10">1772</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsifplural</span></span></span>  <a -href="glossaries-user.html#dx1-57020" ><span -class="cmti-10">748</span></a> <br /></span> +href="glossaries-user.html#dx1-135020" ><span +class="cmti-10">1773</span></a>, <a +href="glossaries-user.html#dx1-135033" >1774</a>, <a +href="glossaries-user.html#dx1-150005" >1775</a>, <a +href="glossaries-user.html#dx1-150092" >1776</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsignore</span></span></span>  <a +href="glossaries-user.html#dx1-128005" >1777</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlinedescformat</span></span></span>  <a -href="glossaries-user.html#dx1-87019" ><span -class="cmti-10">749</span></a> <br /></span> +href="glossaries-user.html#dx1-165020" ><span +class="cmti-10">1778</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlineemptydescformat</span></span></span>  <a -href="glossaries-user.html#dx1-87018" ><span -class="cmti-10">750</span></a> <br /></span> +href="glossaries-user.html#dx1-165019" ><span +class="cmti-10">1779</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlinenameformat</span></span></span>  <a -href="glossaries-user.html#dx1-87016" ><span -class="cmti-10">751</span></a> <br /></span> +href="glossaries-user.html#dx1-165016" ><span +class="cmti-10">1780</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlineparentchildseparator</span></span></span>  <a -href="glossaries-user.html#dx1-87012" ><span -class="cmti-10">752</span></a> <br /></span> +href="glossaries-user.html#dx1-165012" ><span +class="cmti-10">1781</span></a>, <a +href="glossaries-user.html#dx1-165013" >1782</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlineseparator</span></span></span>  <a -href="glossaries-user.html#dx1-87008" ><span -class="cmti-10">753</span></a> <br /></span> +href="glossaries-user.html#dx1-165008" ><span +class="cmti-10">1783</span></a>, <a +href="glossaries-user.html#dx1-165009" >1784</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlinesubdescformat</span></span></span>  <a -href="glossaries-user.html#dx1-87020" ><span -class="cmti-10">754</span></a> <br /></span> +href="glossaries-user.html#dx1-165021" ><span +class="cmti-10">1785</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlinesubnameformat</span></span></span>  <a -href="glossaries-user.html#dx1-87017" ><span -class="cmti-10">755</span></a> <br /></span> +href="glossaries-user.html#dx1-165018" ><span +class="cmti-10">1786</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinlinesubseparator</span></span></span>  <a -href="glossaries-user.html#dx1-87010" ><span -class="cmti-10">756</span></a> <br /></span> +href="glossaries-user.html#dx1-165010" ><span +class="cmti-10">1787</span></a>, <a +href="glossaries-user.html#dx1-165011" >1788</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsinsert</span></span></span>  <a -href="glossaries-user.html#dx1-57019" ><span -class="cmti-10">757</span></a> <br /></span> - - +href="glossaries-user.html#dx1-135019" ><span +class="cmti-10">1789</span></a>, <a +href="glossaries-user.html#dx1-135035" >1790</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslabel</span></span></span>  <a -href="glossaries-user.html#dx1-57012" ><span -class="cmti-10">758</span></a> <br /></span> +href="glossaries-user.html#dx1-34017" >1791</a>, <a +href="glossaries-user.html#dx1-135012" ><span +class="cmti-10">1792</span></a>, <a +href="glossaries-user.html#dx1-135031" >1793</a>, <a +href="glossaries-user.html#dx1-147047" >1794</a>, <a +href="glossaries-user.html#dx1-150077" >1795</a>, <a +href="glossaries-user.html#dx1-150084" >1796</a>, <a +href="glossaries-user.html#dx1-183009" >1797</a>, <a +href="glossaries-user.html#dx1-183012" >1798</a>, <a +href="glossaries-user.html#dx1-183017" >1799</a>, <a +href="glossaries-user.html#dx1-183026" >1800</a>, <a +href="glossaries-user.html#dx1-183038" >1801</a>, <a +href="glossaries-user.html#dx1-189040" >1802</a>, <a +href="glossaries-user.html#dx1-189042" >1803</a>, <a +href="glossaries-user.html#dx1-202024" >1804</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslabeltok</span></span></span>  <a -href="glossaries-user.html#dx1-72024" ><span -class="cmti-10">759</span></a> <br /></span> +href="glossaries-user.html#dx1-150024" ><span +class="cmti-10">1805</span></a>, <a +href="glossaries-user.html#dx1-182010" >1806</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsletentryfield</span></span></span>  <a -href="glossaries-user.html#dx1-62034" ><span -class="cmti-10">760</span></a> <br /></span> +href="glossaries-user.html#dx1-140033" ><span +class="cmti-10">1807</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslink</span></span></span>  <a -href="glossaries-user.html#dx1-56004" ><span -class="cmti-10">761</span></a> <br /></span> +href="glossaries-user.html#dx1-34008" >1808</a>, <a +href="glossaries-user.html#dx1-134003" >1809</a>, <a +href="glossaries-user.html#dx1-134004" ><span +class="cmti-10">1810</span></a>, <a +href="glossaries-user.html#dx1-144007" >1811</a>, <a +href="glossaries-user.html#dx1-150056" >1812</a>, <a +href="glossaries-user.html#dx1-189009" >1813</a>, <a +href="glossaries-user.html#dx1-189017" >1814</a>, <a +href="glossaries-user.html#dx1-189022" >1815</a>, <a +href="glossaries-user.html#dx1-189025" >1816</a>, <a +href="glossaries-user.html#dx1-189026" >1817</a> <br /></span> <span class="index-item"><span class="cmtt-10">\glslink </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">counter</span>  <a -href="glossaries-user.html#dx1-54071" >762</a>, <a -href="glossaries-user.html#dx1-66006" >763</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">format</span>  <a -href="glossaries-user.html#dx1-50004" >764</a>, <a -href="glossaries-user.html#dx1-50011" >765</a>, <a -href="glossaries-user.html#dx1-54041" >766</a>, <a -href="glossaries-user.html#dx1-54050" >767</a>, <a -href="glossaries-user.html#dx1-62068" >768</a>, <a -href="glossaries-user.html#dx1-66010" >769</a>, <a -href="glossaries-user.html#dx1-66015" >770</a>, <a -href="glossaries-user.html#dx1-66016" >771</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">hyper</span>  <a -href="glossaries-user.html#dx1-23110" >772</a>, <a -href="glossaries-user.html#dx1-54030" >773</a>, <a -href="glossaries-user.html#dx1-54036" >774</a>, <a -href="glossaries-user.html#dx1-57023" >775</a>, <a -href="glossaries-user.html#dx1-57029" >776</a>, <a -href="glossaries-user.html#dx1-58003" >777</a>, <a -href="glossaries-user.html#dx1-59002" >778</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">local</span>  <a -href="glossaries-user.html#dx1-54072" >779</a> <br /></span> +class="cmtt-10">counter</span>  <a +href="glossaries-user.html#dx1-132077" >1818</a>, <a +href="glossaries-user.html#dx1-144006" >1819</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">format</span>  <a +href="glossaries-user.html#dx1-128004" >1820</a>, <a +href="glossaries-user.html#dx1-128011" >1821</a>, <a +href="glossaries-user.html#dx1-132041" >1822</a>, <a +href="glossaries-user.html#dx1-132050" >1823</a>, <a +href="glossaries-user.html#dx1-132070" >1824</a>, <a +href="glossaries-user.html#dx1-140067" >1825</a>, <a +href="glossaries-user.html#dx1-144011" >1826</a>, <a +href="glossaries-user.html#dx1-144016" >1827</a>, <a +href="glossaries-user.html#dx1-144018" >1828</a>, <a +href="glossaries-user.html#dx1-189003" >1829</a>, <a +href="glossaries-user.html#dx1-190004" >1830</a>, <a +href="glossaries-user.html#dx1-190019" >1831</a>, <a +href="glossaries-user.html#dx1-211015" >1832</a>, <a +href="glossaries-user.html#dx1-211018" >1833</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">hyper</span>  <a +href="glossaries-user.html#dx1-34013" >1834</a>, <a +href="glossaries-user.html#dx1-132030" >1835</a>, <a +href="glossaries-user.html#dx1-132036" >1836</a>, <a +href="glossaries-user.html#dx1-135023" >1837</a>, <a +href="glossaries-user.html#dx1-135029" >1838</a>, <a +href="glossaries-user.html#dx1-136003" >1839</a>, <a +href="glossaries-user.html#dx1-137002" >1840</a>, <a +href="glossaries-user.html#dx1-221003" >1841</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">hyperoutside</span>  <a +href="glossaries-user.html#dx1-132080" >1842</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">local</span>  <a +href="glossaries-user.html#dx1-132078" >1843</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">noindex</span>  <a +href="glossaries-user.html#dx1-132079" >1844</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">prefix</span>  <a +href="glossaries-user.html#dx1-132087" >1845</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">textformat</span>  <a +href="glossaries-user.html#dx1-132084" >1846</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">theHvalue</span>  <a +href="glossaries-user.html#dx1-132090" >1847</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">thevalue</span>  <a +href="glossaries-user.html#dx1-132089" >1848</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">wrgloss</span>  <a +href="glossaries-user.html#dx1-132082" >1849</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslinkcheckfirsthyperhook</span></span></span>  <a -href="glossaries-user.html#dx1-23112" ><span -class="cmti-10">780</span></a> <br /></span> +href="glossaries-user.html#dx1-34015" ><span +class="cmti-10">1850</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslinkpostsetkeys</span></span></span>  <a -href="glossaries-user.html#dx1-57073" ><span -class="cmti-10">781</span></a> <br /></span> +href="glossaries-user.html#dx1-34023" >1851</a>, <a +href="glossaries-user.html#dx1-135038" >1852</a>, <a +href="glossaries-user.html#dx1-135073" ><span +class="cmti-10">1853</span></a>, <a +href="glossaries-user.html#dx1-136029" >1854</a>, <a +href="glossaries-user.html#dx1-150090" >1855</a>, <a +href="glossaries-user.html#dx1-209002" >1856</a>, <a +href="glossaries-user.html#dx1-209003" >1857</a>, <a +href="glossaries-user.html#dx1-209007" >1858</a>, <a +href="glossaries-user.html#dx1-209008" >1859</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslinkprefix</span></span></span>  <a +href="glossaries-user.html#dx1-141064" >1860</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslinkpresetkeys</span></span></span>  <a +href="glossaries-user.html#dx1-221004" >1861</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslinkvar</span></span></span>  <a -href="glossaries-user.html#dx1-57028" ><span -class="cmti-10">782</span></a> <br /></span> +href="glossaries-user.html#dx1-135028" ><span +class="cmti-10">1862</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslistdottedwidth</span></span></span>  <a -href="glossaries-user.html#dx1-79039" ><span -class="cmti-10">783</span></a> <br /></span> +href="glossaries-user.html#dx1-157039" ><span +class="cmti-10">1863</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslistnavigationitem</span></span></span>  <a -href="glossaries-user.html#dx1-79023" ><span -class="cmti-10">784</span></a> <br /></span> +href="glossaries-user.html#dx1-157023" ><span +class="cmti-10">1864</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslocalreset</span></span></span>  <a -href="glossaries-user.html#dx1-75004" ><span -class="cmti-10">785</span></a> <br /></span> +href="glossaries-user.html#dx1-153004" ><span +class="cmti-10">1865</span></a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslocalresetall</span></span></span>  <a -href="glossaries-user.html#dx1-75008" ><span -class="cmti-10">786</span></a> <br /></span> +href="glossaries-user.html#dx1-153008" ><span +class="cmti-10">1866</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslocalunset</span></span></span>  <a -href="glossaries-user.html#dx1-75006" ><span -class="cmti-10">787</span></a> <br /></span> +href="glossaries-user.html#dx1-153006" ><span +class="cmti-10">1867</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslocalunsetall</span></span></span>  <a -href="glossaries-user.html#dx1-75010" ><span -class="cmti-10">788</span></a> <br /></span> +href="glossaries-user.html#dx1-153010" ><span +class="cmti-10">1868</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glslongfont</span></span></span>  <a +href="glossaries-user.html#dx1-182007" >1869</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glslongtok</span></span></span>  <a -href="glossaries-user.html#dx1-72025" ><span -class="cmti-10">789</span></a> <br /></span> +href="glossaries-user.html#dx1-150025" ><span +class="cmti-10">1870</span></a>, <a +href="glossaries-user.html#dx1-182008" >1871</a>, <a +href="glossaries-user.html#dx1-182015" >1872</a>, <a +href="glossaries-user.html#dx1-184065" >1873</a>, <a +href="glossaries-user.html#dx1-184070" >1874</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsmcols</span></span></span>  <a -href="glossaries-user.html#dx1-86015" ><span -class="cmti-10">790</span></a> <br /></span> +href="glossaries-user.html#dx1-164015" ><span +class="cmti-10">1875</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsmoveentry</span></span></span>  <a -href="glossaries-user.html#dx1-45001" ><span -class="cmti-10">791</span></a> <br /></span> +href="glossaries-user.html#dx1-123001" ><span +class="cmti-10">1876</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSname</span></span></span>  <a -href="glossaries-user.html#dx1-56044" ><span -class="cmti-10">792</span></a> <br /></span> +href="glossaries-user.html#dx1-134044" ><span +class="cmti-10">1877</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsname</span></span></span>  <a -href="glossaries-user.html#dx1-56043" ><span -class="cmti-10">793</span></a> <br /></span> +href="glossaries-user.html#dx1-134043" ><span +class="cmti-10">1878</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsname</span></span></span>  <a -href="glossaries-user.html#dx1-56038" ><span -class="cmti-10">794</span></a> <br /></span> +href="glossaries-user.html#dx1-134038" ><span +class="cmti-10">1879</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnamefont</span></span></span>  <a -href="glossaries-user.html#dx1-63074" ><span -class="cmti-10">795</span></a> <br /></span> +href="glossaries-user.html#dx1-141084" ><span +class="cmti-10">1880</span></a>, <a +href="glossaries-user.html#dx1-149010" >1881</a>, <a +href="glossaries-user.html#dx1-163005" >1882</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnavhypertarget</span></span></span>  <a -href="glossaries-user.html#dx1-88030" ><span -class="cmti-10">796</span></a> <br /></span> +href="glossaries-user.html#dx1-166030" ><span +class="cmti-10">1883</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnavigation</span></span></span>  <a -href="glossaries-user.html#dx1-88031" ><span -class="cmti-10">797</span></a> <br /></span> +href="glossaries-user.html#dx1-166031" ><span +class="cmti-10">1884</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnoexpandfields</span></span></span>  <a -href="glossaries-user.html#dx1-40023" ><span -class="cmti-10">798</span></a> <br /></span> +href="glossaries-user.html#dx1-118023" ><span +class="cmti-10">1885</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnoidxdisplayloc</span></span></span>  <a -href="glossaries-user.html#dx1-52022" ><span -class="cmti-10">799</span></a> <br /></span> +href="glossaries-user.html#dx1-130022" ><span +class="cmti-10">1886</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsnumberformat</span></span></span>  <a +href="glossaries-user.html#dx1-128003" >1887</a>, <a +href="glossaries-user.html#dx1-129025" >1888</a>, <a +href="glossaries-user.html#dx1-144046" >1889</a>, <a +href="glossaries-user.html#dx1-190008" >1890</a>, <a +href="glossaries-user.html#dx1-190016" >1891</a>, <a +href="glossaries-user.html#dx1-190034" >1892</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnumberlistloop</span></span></span>  <a -href="glossaries-user.html#dx1-52019" ><span -class="cmti-10">800</span></a> <br /></span> +href="glossaries-user.html#dx1-130019" ><span +class="cmti-10">1893</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsnumbersgroupname</span></span></span>  <a +href="glossaries-user.html#dx1-14032" >1894</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsnumbersgrouptitle</span></span></span>  <a +href="glossaries-user.html#dx1-166028" >1895</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnumlistlastsep</span></span></span>  <a -href="glossaries-user.html#dx1-62067" ><span -class="cmti-10">801</span></a> <br /></span> +href="glossaries-user.html#dx1-140066" ><span +class="cmti-10">1896</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsnumlistsep</span></span></span>  <a -href="glossaries-user.html#dx1-62066" ><span -class="cmti-10">802</span></a> <br /></span> +href="glossaries-user.html#dx1-140065" ><span +class="cmti-10">1897</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsopenbrace</span></span></span>  <a -href="glossaries-user.html#dx1-64007" ><span -class="cmti-10">803</span></a> <br /></span> +href="glossaries-user.html#dx1-142007" ><span +class="cmti-10">1898</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspagelistwidth</span></span></span>  <a -href="glossaries-user.html#dx1-78017" ><span -class="cmti-10">804</span></a> <br /></span> +href="glossaries-user.html#dx1-156017" ><span +class="cmti-10">1899</span></a>, <a +href="glossaries-user.html#dx1-158023" >1900</a>, <a +href="glossaries-user.html#dx1-158042" >1901</a>, <a +href="glossaries-user.html#dx1-159023" >1902</a>, <a +href="glossaries-user.html#dx1-159033" >1903</a>, <a +href="glossaries-user.html#dx1-161028" >1904</a>, <a +href="glossaries-user.html#dx1-161047" >1905</a>, <a +href="glossaries-user.html#dx1-162025" >1906</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspar</span></span></span>  <a -href="glossaries-user.html#dx1-34023" ><span -class="cmti-10">805</span></a> <br /></span> +href="glossaries-user.html#dx1-112022" ><span +class="cmti-10">1907</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspatchtabularx</span></span></span>  <a -href="glossaries-user.html#dx1-55008" ><span -class="cmti-10">806</span></a> <br /></span> +href="glossaries-user.html#dx1-133008" ><span +class="cmti-10">1908</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspercentchar</span></span></span>  <a -href="glossaries-user.html#dx1-64009" ><span -class="cmti-10">807</span></a> <br /></span> +href="glossaries-user.html#dx1-142009" ><span +class="cmti-10">1909</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSpl</span></span></span>  <a -href="glossaries-user.html#dx1-55049" ><span -class="cmti-10">808</span></a> <br /></span> +href="glossaries-user.html#dx1-3027" >1910</a>, <a +href="glossaries-user.html#dx1-112036" >1911</a>, <a +href="glossaries-user.html#dx1-112070" >1912</a>, <a +href="glossaries-user.html#dx1-133049" ><span +class="cmti-10">1913</span></a>, <a +href="glossaries-user.html#dx1-171038" >1914</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glspl</span></span></span>  <a -href="glossaries-user.html#dx1-55048" ><span -class="cmti-10">809</span></a> <br /></span> +href="glossaries-user.html#dx1-3026" >1915</a>, <a +href="glossaries-user.html#dx1-112035" >1916</a>, <a +href="glossaries-user.html#dx1-112069" >1917</a>, <a +href="glossaries-user.html#dx1-112153" >1918</a>, <a +href="glossaries-user.html#dx1-133048" ><span +class="cmti-10">1919</span></a>, <a +href="glossaries-user.html#dx1-147117" >1920</a>, <a +href="glossaries-user.html#dx1-171036" >1921</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspl</span></span></span>  <a -href="glossaries-user.html#dx1-55047" ><span -class="cmti-10">810</span></a> <br /></span> +href="glossaries-user.html#dx1-3025" >1922</a>, <a +href="glossaries-user.html#dx1-112034" >1923</a>, <a +href="glossaries-user.html#dx1-112042" >1924</a>, <a +href="glossaries-user.html#dx1-112047" >1925</a>, <a +href="glossaries-user.html#dx1-112056" >1926</a>, <a +href="glossaries-user.html#dx1-112058" >1927</a>, <a +href="glossaries-user.html#dx1-112068" >1928</a>, <a +href="glossaries-user.html#dx1-133047" ><span +class="cmti-10">1929</span></a>, <a +href="glossaries-user.html#dx1-134021" >1930</a>, <a +href="glossaries-user.html#dx1-135017" >1931</a>, <a +href="glossaries-user.html#dx1-147115" >1932</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSplural</span></span></span>  <a -href="glossaries-user.html#dx1-56032" ><span -class="cmti-10">811</span></a> <br /></span> +href="glossaries-user.html#dx1-134032" ><span +class="cmti-10">1933</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsplural</span></span></span>  <a -href="glossaries-user.html#dx1-56031" ><span -class="cmti-10">812</span></a> <br /></span> +href="glossaries-user.html#dx1-134031" ><span +class="cmti-10">1934</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsplural</span></span></span>  <a -href="glossaries-user.html#dx1-56028" ><span -class="cmti-10">813</span></a> <br /></span> +href="glossaries-user.html#dx1-134028" ><span +class="cmti-10">1935</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspluralsuffix</span></span></span>  <a -href="glossaries-user.html#dx1-35001" ><span -class="cmti-10">814</span></a> <br /></span> +href="glossaries-user.html#dx1-112043" >1936</a>, <a +href="glossaries-user.html#dx1-112045" >1937</a>, <a +href="glossaries-user.html#dx1-112050" >1938</a>, <a +href="glossaries-user.html#dx1-113001" ><span +class="cmti-10">1939</span></a>, <a +href="glossaries-user.html#dx1-147030" >1940</a>, <a +href="glossaries-user.html#dx1-200029" >1941</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspostdescription</span></span></span>  <a -href="glossaries-user.html#dx1-78039" ><span -class="cmti-10">815</span></a> <br /></span> +href="glossaries-user.html#dx1-156039" ><span +class="cmti-10">1942</span></a>, <a +href="glossaries-user.html#dx1-183030" >1943</a>, <a +href="glossaries-user.html#dx1-183039" >1944</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspostinline</span></span></span>  <a -href="glossaries-user.html#dx1-87014" ><span -class="cmti-10">816</span></a> <br /></span> - - +href="glossaries-user.html#dx1-165014" ><span +class="cmti-10">1945</span></a>, <a +href="glossaries-user.html#dx1-165015" >1946</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glspostlinkhook</span></span></span>  <a -href="glossaries-user.html#dx1-57074" ><span -class="cmti-10">817</span></a> <br /></span> +href="glossaries-user.html#dx1-135037" >1947</a>, <a +href="glossaries-user.html#dx1-135074" ><span +class="cmti-10">1948</span></a>, <a +href="glossaries-user.html#dx1-150080" >1949</a>, <a +href="glossaries-user.html#dx1-150088" >1950</a>, <a +href="glossaries-user.html#dx1-150091" >1951</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsprefixsep</span></span></span>  <a +href="glossaries-user.html#dx1-171017" ><span +class="cmti-10">1952</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsprestandardsort</span></span></span>  <a -href="glossaries-user.html#dx1-26026" ><span -class="cmti-10">818</span></a> <br /></span> +href="glossaries-user.html#dx1-73024" ><span +class="cmti-10">1953</span></a>, <a +href="glossaries-user.html#dx1-112079" >1954</a>, <a +href="glossaries-user.html#dx1-197002" >1955</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsps</span></span></span>  <a +href="glossaries-user.html#dx1-192021" >1956</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glspt</span></span></span>  <a +href="glossaries-user.html#dx1-192023" >1957</a>, <a +href="glossaries-user.html#dx1-192025" >1958</a>, <a +href="glossaries-user.html#dx1-192047" >1959</a>, <a +href="glossaries-user.html#dx1-192052" >1960</a>, <a +href="glossaries-user.html#dx1-192068" >1961</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsquote</span></span></span>  <a -href="glossaries-user.html#dx1-64014" ><span -class="cmti-10">819</span></a> <br /></span> +href="glossaries-user.html#dx1-142014" ><span +class="cmti-10">1962</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsrefentry</span></span></span>  <a -href="glossaries-user.html#dx1-25005" ><span -class="cmti-10">820</span></a> <br /></span> +href="glossaries-user.html#dx1-46004" ><span +class="cmti-10">1963</span></a>, <a +href="glossaries-user.html#dx1-48005" >1964</a>, <a +href="glossaries-user.html#dx1-141035" >1965</a>, <a +href="glossaries-user.html#dx1-141040" >1966</a>, <a +href="glossaries-user.html#dx1-200001" >1967</a>, <a +href="glossaries-user.html#dx1-200094" >1968</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsreset</span></span></span>  <a -href="glossaries-user.html#dx1-75003" ><span -class="cmti-10">821</span></a> <br /></span> +href="glossaries-user.html#dx1-64004" >1969</a>, <a +href="glossaries-user.html#dx1-147038" >1970</a>, <a +href="glossaries-user.html#dx1-153003" ><span +class="cmti-10">1971</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsresetall</span></span></span>  <a -href="glossaries-user.html#dx1-75007" ><span -class="cmti-10">822</span></a> <br /></span> +href="glossaries-user.html#dx1-153007" ><span +class="cmti-10">1972</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsresetentrycounter</span></span></span>  <a -href="glossaries-user.html#dx1-25016" ><span -class="cmti-10">823</span></a> <br /></span> +href="glossaries-user.html#dx1-47006" ><span +class="cmti-10">1973</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsrestoreLToutput</span></span></span>  <a -href="glossaries-user.html#dx1-82023" ><span -class="cmti-10">824</span></a> <br /></span> +href="glossaries-user.html#dx1-160023" ><span +class="cmti-10">1974</span></a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssee</span></span></span>  <a -href="glossaries-user.html#dx1-60017" ><span -class="cmti-10">825</span></a> <br /></span> +href="glossaries-user.html#dx1-56005" >1975</a>, <a +href="glossaries-user.html#dx1-138017" ><span +class="cmti-10">1976</span></a>, <a +href="glossaries-user.html#dx1-138024" >1977</a>, <a +href="glossaries-user.html#dx1-204004" >1978</a>, <a +href="glossaries-user.html#dx1-204011" >1979</a>, <a +href="glossaries-user.html#dx1-4002" >1980</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsseeformat</span></span></span>  <a -href="glossaries-user.html#dx1-61002" ><span -class="cmti-10">826</span></a> <br /></span> +href="glossaries-user.html#dx1-139002" ><span +class="cmti-10">1981</span></a>, <a +href="glossaries-user.html#dx1-139016" >1982</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsseeitemformat</span></span></span>  <a -href="glossaries-user.html#dx1-61011" ><span -class="cmti-10">827</span></a> <br /></span> +href="glossaries-user.html#dx1-139011" ><span +class="cmti-10">1983</span></a>, <a +href="glossaries-user.html#dx1-179019" >1984</a>, <a +href="glossaries-user.html#dx1-179024" >1985</a>, <a +href="glossaries-user.html#dx1-179025" >1986</a>, <a +href="glossaries-user.html#dx1-179029" >1987</a>, <a +href="glossaries-user.html#dx1-182025" >1988</a>, <a +href="glossaries-user.html#dx1-204015" >1989</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsseelastsep</span></span></span>  <a -href="glossaries-user.html#dx1-61009" ><span -class="cmti-10">828</span></a> <br /></span> +href="glossaries-user.html#dx1-139009" ><span +class="cmti-10">1990</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsseelist</span></span></span>  <a +href="glossaries-user.html#dx1-139017" >1991</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsseesep</span></span></span>  <a -href="glossaries-user.html#dx1-61008" ><span -class="cmti-10">829</span></a> <br /></span> +href="glossaries-user.html#dx1-139008" ><span +class="cmti-10">1992</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsSetAlphaCompositor</span></span></span>  <a -href="glossaries-user.html#dx1-33019" ><span -class="cmti-10">830</span></a> <br /></span> +href="glossaries-user.html#dx1-111019" ><span +class="cmti-10">1993</span></a>, <a +href="glossaries-user.html#dx1-144058" >1994</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glssetcategoryattribute</span></span></span>  <a +href="glossaries-user.html#dx1-11055" >1995</a>, <a +href="glossaries-user.html#dx1-11056" >1996</a>, <a +href="glossaries-user.html#dx1-182027" >1997</a>, <a +href="glossaries-user.html#dx1-182035" >1998</a>, <a +href="glossaries-user.html#dx1-183032" >1999</a>, <a +href="glossaries-user.html#dx1-185007" >2000</a>, <a +href="glossaries-user.html#dx1-185012" >2001</a>, <a +href="glossaries-user.html#dx1-185014" >2002</a>, <a +href="glossaries-user.html#dx1-186022" >2003</a>, <a +href="glossaries-user.html#dx1-186023" >2004</a>, <a +href="glossaries-user.html#dx1-186025" >2005</a>, <a +href="glossaries-user.html#dx1-186031" >2006</a>, <a +href="glossaries-user.html#dx1-186032" >2007</a>, <a +href="glossaries-user.html#dx1-189015" >2008</a>, <a +href="glossaries-user.html#dx1-194035" >2009</a>, <a +href="glossaries-user.html#dx1-194036" >2010</a>, <a +href="glossaries-user.html#dx1-194037" >2011</a>, <a +href="glossaries-user.html#dx1-194038" >2012</a>, <a +href="glossaries-user.html#dx1-224067" >2013</a>, <a +href="glossaries-user.html#dx1-224073" >2014</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsSetCompositor</span></span></span>  <a -href="glossaries-user.html#dx1-33018" ><span -class="cmti-10">831</span></a> <br /></span> +href="glossaries-user.html#dx1-111018" ><span +class="cmti-10">2015</span></a>, <a +href="glossaries-user.html#dx1-144056" >2016</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssetexpandfield</span></span></span>  <a -href="glossaries-user.html#dx1-40007" ><span -class="cmti-10">832</span></a> <br /></span> +href="glossaries-user.html#dx1-118007" ><span +class="cmti-10">2017</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssetnoexpandfield</span></span></span>  <a -href="glossaries-user.html#dx1-40008" ><span -class="cmti-10">833</span></a> <br /></span> +href="glossaries-user.html#dx1-118008" ><span +class="cmti-10">2018</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetQuote</span></span></span>  <a -href="glossaries-user.html#dx1-13038" ><span -class="cmti-10">834</span></a> <br /></span> +href="glossaries-user.html#dx1-7017" >2019</a>, <a +href="glossaries-user.html#dx1-13035" ><span +class="cmti-10">2020</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsSetSuffixF</span></span></span>  <a -href="glossaries-user.html#dx1-52009" ><span -class="cmti-10">835</span></a> <br /></span> +href="glossaries-user.html#dx1-130009" ><span +class="cmti-10">2021</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsSetSuffixFF</span></span></span>  <a -href="glossaries-user.html#dx1-52010" ><span -class="cmti-10">836</span></a> <br /></span> +href="glossaries-user.html#dx1-130010" ><span +class="cmti-10">2022</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssetwidest</span></span></span>  <a -href="glossaries-user.html#dx1-85049" ><span -class="cmti-10">837</span></a> <br /></span> +href="glossaries-user.html#dx1-163049" ><span +class="cmti-10">2023</span></a>, <a +href="glossaries-user.html#dx1-202002" >2024</a>, <a +href="glossaries-user.html#dx1-202013" >2025</a>, <a +href="glossaries-user.html#dx1-202043" >2026</a>, <a +href="glossaries-user.html#dx1-202058" >2027</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetWriteIstHook</span></span></span>  <a -href="glossaries-user.html#dx1-53002" ><span -class="cmti-10">838</span></a> <br /></span> +href="glossaries-user.html#dx1-131002" ><span +class="cmti-10">2028</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyCodePage</span></span></span>  <a -href="glossaries-user.html#dx1-65010" ><span -class="cmti-10">839</span></a> <br /></span> +href="glossaries-user.html#dx1-16097" >2029</a>, <a +href="glossaries-user.html#dx1-77003" >2030</a>, <a +href="glossaries-user.html#dx1-143010" ><span +class="cmti-10">2031</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits</span></span></span>  <a -href="glossaries-user.html#dx1-67004" ><span -class="cmti-10">840</span></a> <br /></span> +href="glossaries-user.html#dx1-145004" ><span +class="cmti-10">2032</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyLanguage</span></span></span>  <a -href="glossaries-user.html#dx1-65007" ><span -class="cmti-10">841</span></a> <br /></span> +href="glossaries-user.html#dx1-16095" >2033</a>, <a +href="glossaries-user.html#dx1-77002" >2034</a>, <a +href="glossaries-user.html#dx1-108017" >2035</a>, <a +href="glossaries-user.html#dx1-143007" ><span +class="cmti-10">2036</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyLocationClassOrder</span></span></span>  <a -href="glossaries-user.html#dx1-66058" ><span -class="cmti-10">842</span></a> <br /></span> +href="glossaries-user.html#dx1-144061" ><span +class="cmti-10">2037</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyMinRangeLength</span></span></span>  <a -href="glossaries-user.html#dx1-66063" ><span -class="cmti-10">843</span></a> <br /></span> +href="glossaries-user.html#dx1-130004" >2038</a>, <a +href="glossaries-user.html#dx1-144066" ><span +class="cmti-10">2039</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsSetXdyNumberGroupOrder</span></span></span>  <a -href="glossaries-user.html#dx1-67007" ><span -class="cmti-10">844</span></a> <br /></span> +href="glossaries-user.html#dx1-145007" ><span +class="cmti-10">2040</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsshortaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-172070" ><span +class="cmti-10">2041</span></a>, <a +href="glossaries-user.html#dx1-224019" >2042</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsshortplaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-172071" ><span +class="cmti-10">2043</span></a>, <a +href="glossaries-user.html#dx1-224020" >2044</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsshorttok</span></span></span>  <a -href="glossaries-user.html#dx1-72026" ><span -class="cmti-10">845</span></a> <br /></span> +href="glossaries-user.html#dx1-150026" ><span +class="cmti-10">2045</span></a>, <a +href="glossaries-user.html#dx1-182013" >2046</a>, <a +href="glossaries-user.html#dx1-184067" >2047</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsshowaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-30012" ><span +class="cmti-10">2048</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsshowtarget</span></span></span>  <a -href="glossaries-user.html#dx1-23015" ><span -class="cmti-10">846</span></a> <br /></span> +href="glossaries-user.html#dx1-30008" ><span +class="cmti-10">2049</span></a>, <a +href="glossaries-user.html#dx1-30013" >2050</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsshowtargetfont</span></span></span>  <a +href="glossaries-user.html#dx1-30010" ><span +class="cmti-10">2051</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsshowtargetouter</span></span></span>  <a +href="glossaries-user.html#dx1-30009" ><span +class="cmti-10">2052</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssortnumberfmt</span></span></span>  <a -href="glossaries-user.html#dx1-26017" ><span -class="cmti-10">847</span></a> <br /></span> +href="glossaries-user.html#dx1-73016" ><span +class="cmti-10">2053</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssubentrycounterlabel</span></span></span>  <a -href="glossaries-user.html#dx1-88067" ><span -class="cmti-10">848</span></a> <br /></span> +href="glossaries-user.html#dx1-166067" ><span +class="cmti-10">2054</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssubentryitem</span></span></span>  <a -href="glossaries-user.html#dx1-88064" ><span -class="cmti-10">849</span></a> <br /></span> +href="glossaries-user.html#dx1-166064" ><span +class="cmti-10">2055</span></a>, <a +href="glossaries-user.html#dx1-166082" >2056</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSsymbol</span></span></span>  <a -href="glossaries-user.html#dx1-56049" ><span -class="cmti-10">850</span></a> <br /></span> +href="glossaries-user.html#dx1-134049" ><span +class="cmti-10">2057</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glssymbol</span></span></span>  <a -href="glossaries-user.html#dx1-56048" ><span -class="cmti-10">851</span></a> <br /></span> +href="glossaries-user.html#dx1-134048" ><span +class="cmti-10">2058</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glssymbol</span></span></span>  <a -href="glossaries-user.html#dx1-56045" ><span -class="cmti-10">852</span></a> <br /></span> +href="glossaries-user.html#dx1-134045" ><span +class="cmti-10">2059</span></a>, <a +href="glossaries-user.html#dx1-135080" >2060</a>, <a +href="glossaries-user.html#dx1-189030" >2061</a>, <a +href="glossaries-user.html#dx1-189032" >2062</a>, <a +href="glossaries-user.html#dx1-189051" >2063</a>, <a +href="glossaries-user.html#dx1-189060" >2064</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glssymbolaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-224024" >2065</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glssymbolsgroupname</span></span></span>  <a +href="glossaries-user.html#dx1-14031" >2066</a>, <a +href="glossaries-user.html#dx1-166027" >2067</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstarget</span></span></span>  <a -href="glossaries-user.html#dx1-88049" ><span -class="cmti-10">853</span></a> <br /></span> +href="glossaries-user.html#dx1-166049" ><span +class="cmti-10">2068</span></a>, <a +href="glossaries-user.html#dx1-166066" >2069</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLStext</span></span></span>  <a -href="glossaries-user.html#dx1-56011" ><span -class="cmti-10">854</span></a> <br /></span> +href="glossaries-user.html#dx1-116008" >2070</a>, <a +href="glossaries-user.html#dx1-134011" ><span +class="cmti-10">2071</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glstext</span></span></span>  <a -href="glossaries-user.html#dx1-56010" ><span -class="cmti-10">855</span></a> <br /></span> +href="glossaries-user.html#dx1-116007" >2072</a>, <a +href="glossaries-user.html#dx1-134010" ><span +class="cmti-10">2073</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstext</span></span></span>  <a -href="glossaries-user.html#dx1-56007" ><span -class="cmti-10">856</span></a> <br /></span> +href="glossaries-user.html#dx1-34009" >2074</a>, <a +href="glossaries-user.html#dx1-34022" >2075</a>, <a +href="glossaries-user.html#dx1-116006" >2076</a>, <a +href="glossaries-user.html#dx1-134007" ><span +class="cmti-10">2077</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstextformat</span></span></span>  <a -href="glossaries-user.html#dx1-54025" ><span -class="cmti-10">857</span></a> <br /></span> +href="glossaries-user.html#dx1-132025" ><span +class="cmti-10">2078</span></a>, <a +href="glossaries-user.html#dx1-132081" >2079</a>, <a +href="glossaries-user.html#dx1-132086" >2080</a>, <a +href="glossaries-user.html#dx1-135082" >2081</a>, <a +href="glossaries-user.html#dx1-140001" >2082</a>, <a +href="glossaries-user.html#dx1-147051" >2083</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstextup</span></span></span>  <a -href="glossaries-user.html#dx1-72035" ><span -class="cmti-10">858</span></a> <br /></span> +href="glossaries-user.html#dx1-150035" ><span +class="cmti-10">2084</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstildechar</span></span></span>  <a -href="glossaries-user.html#dx1-64010" ><span -class="cmti-10">859</span></a> <br /></span> +href="glossaries-user.html#dx1-142010" ><span +class="cmti-10">2085</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstocfalse</span></span></span>  <a -href="glossaries-user.html#dx1-24003" ><span -class="cmti-10">860</span></a> <br /></span> +href="glossaries-user.html#dx1-39002" ><span +class="cmti-10">2086</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstoctrue</span></span></span>  <a -href="glossaries-user.html#dx1-24002" ><span -class="cmti-10">861</span></a> <br /></span> +href="glossaries-user.html#dx1-39001" ><span +class="cmti-10">2087</span></a> <br /></span> + + <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreechildpredesc</span></span></span>  <a -href="glossaries-user.html#dx1-85014" ><span -class="cmti-10">862</span></a> <br /></span> - - +href="glossaries-user.html#dx1-163014" ><span +class="cmti-10">2088</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreegroupheaderfmt</span></span></span>  <a -href="glossaries-user.html#dx1-85006" ><span -class="cmti-10">863</span></a> <br /></span> +href="glossaries-user.html#dx1-163006" ><span +class="cmti-10">2089</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreeindent</span></span></span>  <a -href="glossaries-user.html#dx1-85033" ><span -class="cmti-10">864</span></a> <br /></span> +href="glossaries-user.html#dx1-163033" ><span +class="cmti-10">2090</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreeitem</span></span></span>  <a -href="glossaries-user.html#dx1-85019" ><span -class="cmti-10">865</span></a> <br /></span> +href="glossaries-user.html#dx1-163019" ><span +class="cmti-10">2091</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreenamebox</span></span></span>  <a -href="glossaries-user.html#dx1-85054" ><span -class="cmti-10">866</span></a> <br /></span> +href="glossaries-user.html#dx1-163054" ><span +class="cmti-10">2092</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreenamefmt</span></span></span>  <a -href="glossaries-user.html#dx1-85004" ><span -class="cmti-10">867</span></a> <br /></span> +href="glossaries-user.html#dx1-163004" ><span +class="cmti-10">2093</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreenavigationfmt</span></span></span>  <a -href="glossaries-user.html#dx1-85008" ><span -class="cmti-10">868</span></a> <br /></span> +href="glossaries-user.html#dx1-163008" ><span +class="cmti-10">2094</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreepredesc</span></span></span>  <a -href="glossaries-user.html#dx1-85011" ><span -class="cmti-10">869</span></a> <br /></span> +href="glossaries-user.html#dx1-163011" ><span +class="cmti-10">2095</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreesubitem</span></span></span>  <a -href="glossaries-user.html#dx1-85020" ><span -class="cmti-10">870</span></a> <br /></span> +href="glossaries-user.html#dx1-163020" ><span +class="cmti-10">2096</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstreesubsubitem</span></span></span>  <a -href="glossaries-user.html#dx1-85021" ><span -class="cmti-10">871</span></a> <br /></span> +href="glossaries-user.html#dx1-163021" ><span +class="cmti-10">2097</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glstype</span></span></span>  <a -href="glossaries-user.html#dx1-57013" ><span -class="cmti-10">872</span></a> <br /></span> +href="glossaries-user.html#dx1-34018" >2098</a>, <a +href="glossaries-user.html#dx1-135013" ><span +class="cmti-10">2099</span></a>, <a +href="glossaries-user.html#dx1-135032" >2100</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsunset</span></span></span>  <a -href="glossaries-user.html#dx1-75005" ><span -class="cmti-10">873</span></a> <br /></span> +href="glossaries-user.html#dx1-153005" ><span +class="cmti-10">2101</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsunsetall</span></span></span>  <a -href="glossaries-user.html#dx1-75009" ><span -class="cmti-10">874</span></a> <br /></span> +href="glossaries-user.html#dx1-136016" >2102</a>, <a +href="glossaries-user.html#dx1-153009" ><span +class="cmti-10">2103</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsUseAcrEntryDispStyle</span></span></span>  <a -href="glossaries-user.html#dx1-72031" ><span -class="cmti-10">875</span></a> <br /></span> +href="glossaries-user.html#dx1-150031" ><span +class="cmti-10">2104</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GlsUseAcrStyleDefs</span></span></span>  <a -href="glossaries-user.html#dx1-72032" ><span -class="cmti-10">876</span></a> <br /></span> +href="glossaries-user.html#dx1-150032" ><span +class="cmti-10">2105</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuseri</span></span></span>  <a -href="glossaries-user.html#dx1-56059" ><span -class="cmti-10">877</span></a> <br /></span> +href="glossaries-user.html#dx1-134059" ><span +class="cmti-10">2106</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuseri</span></span></span>  <a -href="glossaries-user.html#dx1-56058" ><span -class="cmti-10">878</span></a> <br /></span> +href="glossaries-user.html#dx1-134058" ><span +class="cmti-10">2107</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuseri</span></span></span>  <a -href="glossaries-user.html#dx1-56055" ><span -class="cmti-10">879</span></a> <br /></span> +href="glossaries-user.html#dx1-134055" ><span +class="cmti-10">2108</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsuseriaccsupp</span></span></span>  <a +href="glossaries-user.html#dx1-224028" >2109</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuserii</span></span></span>  <a -href="glossaries-user.html#dx1-56064" ><span -class="cmti-10">880</span></a> <br /></span> +href="glossaries-user.html#dx1-134064" ><span +class="cmti-10">2110</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuserii</span></span></span>  <a -href="glossaries-user.html#dx1-56063" ><span -class="cmti-10">881</span></a> <br /></span> +href="glossaries-user.html#dx1-134063" ><span +class="cmti-10">2111</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuserii</span></span></span>  <a -href="glossaries-user.html#dx1-56060" ><span -class="cmti-10">882</span></a> <br /></span> +href="glossaries-user.html#dx1-134060" ><span +class="cmti-10">2112</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuseriii</span></span></span>  <a -href="glossaries-user.html#dx1-56069" ><span -class="cmti-10">883</span></a> <br /></span> +href="glossaries-user.html#dx1-134069" ><span +class="cmti-10">2113</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuseriii</span></span></span>  <a -href="glossaries-user.html#dx1-56068" ><span -class="cmti-10">884</span></a> <br /></span> +href="glossaries-user.html#dx1-134068" ><span +class="cmti-10">2114</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuseriii</span></span></span>  <a -href="glossaries-user.html#dx1-56065" ><span -class="cmti-10">885</span></a> <br /></span> +href="glossaries-user.html#dx1-134065" ><span +class="cmti-10">2115</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuseriv</span></span></span>  <a -href="glossaries-user.html#dx1-56074" ><span -class="cmti-10">886</span></a> <br /></span> +href="glossaries-user.html#dx1-134074" ><span +class="cmti-10">2116</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuseriv</span></span></span>  <a -href="glossaries-user.html#dx1-56073" ><span -class="cmti-10">887</span></a> <br /></span> +href="glossaries-user.html#dx1-134073" ><span +class="cmti-10">2117</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuseriv</span></span></span>  <a -href="glossaries-user.html#dx1-56070" ><span -class="cmti-10">888</span></a> <br /></span> +href="glossaries-user.html#dx1-134070" ><span +class="cmti-10">2118</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuserv</span></span></span>  <a -href="glossaries-user.html#dx1-56079" ><span -class="cmti-10">889</span></a> <br /></span> +href="glossaries-user.html#dx1-134079" ><span +class="cmti-10">2119</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuserv</span></span></span>  <a -href="glossaries-user.html#dx1-56078" ><span -class="cmti-10">890</span></a> <br /></span> +href="glossaries-user.html#dx1-134078" ><span +class="cmti-10">2120</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuserv</span></span></span>  <a -href="glossaries-user.html#dx1-56075" ><span -class="cmti-10">891</span></a> <br /></span> +href="glossaries-user.html#dx1-134075" ><span +class="cmti-10">2121</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\GLSuservi</span></span></span>  <a -href="glossaries-user.html#dx1-56084" ><span -class="cmti-10">892</span></a> <br /></span> +href="glossaries-user.html#dx1-134084" ><span +class="cmti-10">2122</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Glsuservi</span></span></span>  <a -href="glossaries-user.html#dx1-56083" ><span -class="cmti-10">893</span></a> <br /></span> +href="glossaries-user.html#dx1-134083" ><span +class="cmti-10">2123</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glsuservi</span></span></span>  <a -href="glossaries-user.html#dx1-56080" ><span -class="cmti-10">894</span></a> <br /></span> +href="glossaries-user.html#dx1-134080" ><span +class="cmti-10">2124</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glswrallowprimitivemodsfalse</span></span></span>  <a -href="glossaries-user.html#dx1-51026" ><span -class="cmti-10">895</span></a> <br /></span> +href="glossaries-user.html#dx1-129028" ><span +class="cmti-10">2125</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glswrite</span></span></span>  <a -href="glossaries-user.html#dx1-53003" ><span -class="cmti-10">896</span></a> <br /></span> +href="glossaries-user.html#dx1-131003" ><span +class="cmti-10">2126</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\glswriteentry</span></span></span>  <a -href="glossaries-user.html#dx1-23125" ><span -class="cmti-10">897</span></a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-64005" ><span +class="cmti-10">2127</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@makeglossaries</span></span></span>  <a +href="glossaries-user.html#dx1-22004" >2128</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@record</span></span></span>  <a +href="glossaries-user.html#dx1-24015" >2129</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@record@nameref</span></span></span>  <a +href="glossaries-user.html#dx1-24017" >2130</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@recordsee</span></span></span>  <a +href="glossaries-user.html#dx1-24018" >2131</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@resource</span></span></span>  <a +href="glossaries-user.html#dx1-24003" >2132</a>, <a +href="glossaries-user.html#dx1-24009" >2133</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtr@texencoding</span></span></span>  <a +href="glossaries-user.html#dx1-214039" >2134</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrabbrvfootnote</span></span></span>  <a +href="glossaries-user.html#dx1-182016" >2135</a>, <a +href="glossaries-user.html#dx1-182017" >2136</a>, <a +href="glossaries-user.html#dx1-182020" >2137</a>, <a +href="glossaries-user.html#dx1-184053" >2138</a>, <a +href="glossaries-user.html#dx1-184056" >2139</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrabbrvtype</span></span></span>  <a +href="glossaries-user.html#dx1-90017" >2140</a>, <a +href="glossaries-user.html#dx1-90020" >2141</a>, <a +href="glossaries-user.html#dx1-92001" >2142</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrbookindexname</span></span></span>  <a +href="glossaries-user.html#dx1-11087" >2143</a> <br /></span> + + +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrcombiningdiacriticrules</span></span></span>  <a +href="glossaries-user.html#dx1-211061" >2144</a>, <a +href="glossaries-user.html#dx1-211082" >2145</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrcontrolrules</span></span></span>  <a +href="glossaries-user.html#dx1-211058" >2146</a>, <a +href="glossaries-user.html#dx1-211079" >2147</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrdigitrules</span></span></span>  <a +href="glossaries-user.html#dx1-211064" >2148</a>, <a +href="glossaries-user.html#dx1-211085" >2149</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrdopostpunc</span></span></span>  <a +href="glossaries-user.html#dx1-183023" >2150</a>, <a +href="glossaries-user.html#dx1-183035" >2151</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrequationlocfmt</span></span></span>  <a +href="glossaries-user.html#dx1-190046" >2152</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfieldforlistloop</span></span></span>  <a +href="glossaries-user.html#dx1-200046" >2153</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfieldformatlist</span></span></span>  <a +href="glossaries-user.html#dx1-220027" >2154</a>, <a +href="glossaries-user.html#dx1-220043" >2155</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfmt</span></span></span>  <a +href="glossaries-user.html#dx1-188041" >2156</a>, <a +href="glossaries-user.html#dx1-189054" >2157</a>, <a +href="glossaries-user.html#dx1-189055" >2158</a>, <a +href="glossaries-user.html#dx1-189056" >2159</a>, <a +href="glossaries-user.html#dx1-189057" >2160</a>, <a +href="glossaries-user.html#dx1-189059" >2161</a>, <a +href="glossaries-user.html#dx1-189061" >2162</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrFmtField</span></span></span>  <a +href="glossaries-user.html#dx1-189034" >2163</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfootnotedescname</span></span></span>  <a +href="glossaries-user.html#dx1-182006" >2164</a>, <a +href="glossaries-user.html#dx1-184062" >2165</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfootnotedescsort</span></span></span>  <a +href="glossaries-user.html#dx1-182014" >2166</a>, <a +href="glossaries-user.html#dx1-184069" >2167</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfull</span></span></span>  <a +href="glossaries-user.html#dx1-178040" >2168</a>, <a +href="glossaries-user.html#dx1-179041" >2169</a>, <a +href="glossaries-user.html#dx1-186018" >2170</a>, <a +href="glossaries-user.html#dx1-224053" >2171</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrfullsep</span></span></span>  <a +href="glossaries-user.html#dx1-182009" >2172</a>, <a +href="glossaries-user.html#dx1-184016" >2173</a>, <a +href="glossaries-user.html#dx1-184025" >2174</a>, <a +href="glossaries-user.html#dx1-184034" >2175</a>, <a +href="glossaries-user.html#dx1-184043" >2176</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrgeneralpuncrules</span></span></span>  <a +href="glossaries-user.html#dx1-211063" >2177</a>, <a +href="glossaries-user.html#dx1-211084" >2178</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrglossentry</span></span></span>  <a +href="glossaries-user.html#dx1-11005" >2179</a>, <a +href="glossaries-user.html#dx1-11013" >2180</a>, <a +href="glossaries-user.html#dx1-11033" >2181</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrhyphenrules</span></span></span>  <a +href="glossaries-user.html#dx1-211062" >2182</a>, <a +href="glossaries-user.html#dx1-211083" >2183</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrIfFieldEqNum</span></span></span>  <a +href="glossaries-user.html#dx1-209009" >2184</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrIfFieldNonZero</span></span></span>  <a +href="glossaries-user.html#dx1-200044" >2185</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrifhasfield</span></span></span>  <a +href="glossaries-user.html#dx1-200020" >2186</a>, <a +href="glossaries-user.html#dx1-202023" >2187</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrifwasfirstuse</span></span></span>  <a +href="glossaries-user.html#dx1-183014" >2188</a>, <a +href="glossaries-user.html#dx1-183022" >2189</a>, <a +href="glossaries-user.html#dx1-183034" >2190</a>, <a +href="glossaries-user.html#dx1-202022" >2191</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrIfXpFieldEqXpStr</span></span></span>  <a +href="glossaries-user.html#dx1-200025" >2192</a>, <a +href="glossaries-user.html#dx1-200031" >2193</a>, <a +href="glossaries-user.html#dx1-200048" >2194</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Glsxtrinlinefullformat</span></span></span>  <a +href="glossaries-user.html#dx1-184029" >2195</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrinlinefullformat</span></span></span>  <a +href="glossaries-user.html#dx1-184011" >2196</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Glsxtrinlinefullplformat</span></span></span>  <a +href="glossaries-user.html#dx1-184038" >2197</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrinlinefullplformat</span></span></span>  <a +href="glossaries-user.html#dx1-184020" >2198</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrLoadResources</span></span></span>  <a +href="glossaries-user.html#dx1-9003" >2199</a>, <a +href="glossaries-user.html#dx1-9022" >2200</a>, <a +href="glossaries-user.html#dx1-9023" >2201</a>, <a +href="glossaries-user.html#dx1-11009" >2202</a>, <a +href="glossaries-user.html#dx1-11025" >2203</a>, <a +href="glossaries-user.html#dx1-11076" >2204</a>, <a +href="glossaries-user.html#dx1-71007" >2205</a>, <a +href="glossaries-user.html#dx1-74009" >2206</a>, <a +href="glossaries-user.html#dx1-175052" >2207</a>, <a +href="glossaries-user.html#dx1-175054" >2208</a>, <a +href="glossaries-user.html#dx1-175056" >2209</a>, <a +href="glossaries-user.html#dx1-176017" >2210</a>, <a +href="glossaries-user.html#dx1-176020" >2211</a>, <a +href="glossaries-user.html#dx1-179053" >2212</a>, <a +href="glossaries-user.html#dx1-179058" >2213</a>, <a +href="glossaries-user.html#dx1-179074" >2214</a>, <a +href="glossaries-user.html#dx1-188034" >2215</a>, <a +href="glossaries-user.html#dx1-190029" >2216</a>, <a +href="glossaries-user.html#dx1-192054" >2217</a>, <a +href="glossaries-user.html#dx1-192056" >2218</a>, <a +href="glossaries-user.html#dx1-193026" >2219</a>, <a +href="glossaries-user.html#dx1-193044" >2220</a>, <a +href="glossaries-user.html#dx1-194022" >2221</a>, <a +href="glossaries-user.html#dx1-197023" >2222</a>, <a +href="glossaries-user.html#dx1-198034" >2223</a>, <a +href="glossaries-user.html#dx1-198036" >2224</a>, <a +href="glossaries-user.html#dx1-200086" >2225</a>, <a +href="glossaries-user.html#dx1-200098" >2226</a>, <a +href="glossaries-user.html#dx1-202053" >2227</a>, <a +href="glossaries-user.html#dx1-202093" >2228</a>, <a +href="glossaries-user.html#dx1-204025" >2229</a>, <a +href="glossaries-user.html#dx1-204028" >2230</a>, <a +href="glossaries-user.html#dx1-204034" >2231</a>, <a +href="glossaries-user.html#dx1-206017" >2232</a>, <a +href="glossaries-user.html#dx1-211043" >2233</a>, <a +href="glossaries-user.html#dx1-211055" >2234</a>, <a +href="glossaries-user.html#dx1-211075" >2235</a>, <a +href="glossaries-user.html#dx1-212011" >2236</a>, <a +href="glossaries-user.html#dx1-214024" >2237</a>, <a +href="glossaries-user.html#dx1-214048" >2238</a>, <a +href="glossaries-user.html#dx1-214051" >2239</a>, <a +href="glossaries-user.html#dx1-220024" >2240</a>, <a +href="glossaries-user.html#dx1-223012" >2241</a>, <a +href="glossaries-user.html#dx1-223022" >2242</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">\GlsXtrLoadResources </span>options<br /></span> +<span class="index-subitem">    <span +class="cmtt-10">abbreviation-sort-fallback</span>  <a +href="glossaries-user.html#dx1-179060" >2243</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">append-prefix-field</span>  <a +href="glossaries-user.html#dx1-223021" >2244</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">break-at</span>  <a +href="glossaries-user.html#dx1-74008" >2245</a>, <a +href="glossaries-user.html#dx1-200097" >2246</a>, <a +href="glossaries-user.html#dx1-211052" >2247</a>, <a +href="glossaries-user.html#dx1-211071" >2248</a>, <a +href="glossaries-user.html#dx1-211072" >2249</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">category</span>  <a +href="glossaries-user.html#dx1-194024" >2250</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">combine-dual-locations</span>  <a +href="glossaries-user.html#dx1-193048" >2251</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">dual-category</span>  <a +href="glossaries-user.html#dx1-194025" >2252</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">dual-prefix</span>  <a +href="glossaries-user.html#dx1-193021" >2253</a>, <a +href="glossaries-user.html#dx1-193047" >2254</a>, <a +href="glossaries-user.html#dx1-194026" >2255</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">dual-sort</span>  <a +href="glossaries-user.html#dx1-194030" >2256</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">dual-type</span>  <a +href="glossaries-user.html#dx1-193020" >2257</a>, <a +href="glossaries-user.html#dx1-193046" >2258</a>, <a +href="glossaries-user.html#dx1-194028" >2259</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">entry-type-aliases</span>  <a +href="glossaries-user.html#dx1-202102" >2260</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">ext-prefixes</span>  <a +href="glossaries-user.html#dx1-192035" >2261</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">field-aliases</span>  <a +href="glossaries-user.html#dx1-202101" >2262</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">identical-sort-action</span>  <a +href="glossaries-user.html#dx1-200082" >2263</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">ignore-fields</span>  <a +href="glossaries-user.html#dx1-179076" >2264</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">label-prefix</span>  <a +href="glossaries-user.html#dx1-192034" >2265</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">loc-counters</span>  <a +href="glossaries-user.html#dx1-189067" >2266</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">name-case-change</span>  <a +href="glossaries-user.html#dx1-11062" >2267</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">primary-location-formats</span>  <a +href="glossaries-user.html#dx1-189069" >2268</a> <br /></span> + + +<span class="index-subitem">    <span +class="cmtt-10">replicate-fields</span>  <a +href="glossaries-user.html#dx1-11061" >2269</a>, <a +href="glossaries-user.html#dx1-11079" >2270</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">save-child-count</span>  <a +href="glossaries-user.html#dx1-200038" >2271</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">save-locations</span>  <a +href="glossaries-user.html#dx1-11030" >2272</a>, <a +href="glossaries-user.html#dx1-11070" >2273</a>, <a +href="glossaries-user.html#dx1-45010" >2274</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">save-loclist</span>  <a +href="glossaries-user.html#dx1-45011" >2275</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">save-sibling-count</span>  <a +href="glossaries-user.html#dx1-200039" >2276</a>, <a +href="glossaries-user.html#dx1-200043" >2277</a>, <a +href="glossaries-user.html#dx1-200054" >2278</a>, <a +href="glossaries-user.html#dx1-200088" >2279</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">save-locations</span>  <a +href="glossaries-user.html#dx1-11012" >2280</a>, <a +href="glossaries-user.html#dx1-11060" >2281</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">selection</span>  <a +href="glossaries-user.html#dx1-9029" >2282</a>, <a +href="glossaries-user.html#dx1-204036" >2283</a>, <a +href="glossaries-user.html#dx1-214026" >2284</a>, <a +href="glossaries-user.html#dx1-214029" >2285</a>, <a +href="glossaries-user.html#dx1-214032" >2286</a>, <a +href="glossaries-user.html#dx1-214050" >2287</a>, <a +href="glossaries-user.html#dx1-214053" >2288</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">set-widest</span>  <a +href="glossaries-user.html#dx1-202055" >2289</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">sort</span>  <a +href="glossaries-user.html#dx1-9025" >2290</a>, <a +href="glossaries-user.html#dx1-9028" >2291</a>, <a +href="glossaries-user.html#dx1-11011" >2292</a>, <a +href="glossaries-user.html#dx1-11059" >2293</a>, <a +href="glossaries-user.html#dx1-11078" >2294</a>, <a +href="glossaries-user.html#dx1-176019" >2295</a>, <a +href="glossaries-user.html#dx1-176022" >2296</a>, <a +href="glossaries-user.html#dx1-194029" >2297</a>, <a +href="glossaries-user.html#dx1-198038" >2298</a>, <a +href="glossaries-user.html#dx1-211057" >2299</a>, <a +href="glossaries-user.html#dx1-211077" >2300</a>, <a +href="glossaries-user.html#dx1-214047" >2301</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">sort-rule</span>  <a +href="glossaries-user.html#dx1-211078" >2302</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">src</span>  <a +href="glossaries-user.html#dx1-9004" >2303</a>, <a +href="glossaries-user.html#dx1-9024" >2304</a>, <a +href="glossaries-user.html#dx1-9027" >2305</a>, <a +href="glossaries-user.html#dx1-11010" >2306</a>, <a +href="glossaries-user.html#dx1-11026" >2307</a>, <a +href="glossaries-user.html#dx1-11058" >2308</a>, <a +href="glossaries-user.html#dx1-11077" >2309</a>, <a +href="glossaries-user.html#dx1-175053" >2310</a>, <a +href="glossaries-user.html#dx1-175057" >2311</a>, <a +href="glossaries-user.html#dx1-176018" >2312</a>, <a +href="glossaries-user.html#dx1-176021" >2313</a>, <a +href="glossaries-user.html#dx1-179054" >2314</a>, <a +href="glossaries-user.html#dx1-179059" >2315</a>, <a +href="glossaries-user.html#dx1-179075" >2316</a>, <a +href="glossaries-user.html#dx1-188035" >2317</a>, <a +href="glossaries-user.html#dx1-192055" >2318</a>, <a +href="glossaries-user.html#dx1-192057" >2319</a>, <a +href="glossaries-user.html#dx1-193018" >2320</a>, <a +href="glossaries-user.html#dx1-193027" >2321</a>, <a +href="glossaries-user.html#dx1-193045" >2322</a>, <a +href="glossaries-user.html#dx1-194023" >2323</a>, <a +href="glossaries-user.html#dx1-197024" >2324</a>, <a +href="glossaries-user.html#dx1-198035" >2325</a>, <a +href="glossaries-user.html#dx1-198037" >2326</a>, <a +href="glossaries-user.html#dx1-200087" >2327</a>, <a +href="glossaries-user.html#dx1-200099" >2328</a>, <a +href="glossaries-user.html#dx1-202054" >2329</a>, <a +href="glossaries-user.html#dx1-202094" >2330</a>, <a +href="glossaries-user.html#dx1-204026" >2331</a>, <a +href="glossaries-user.html#dx1-204029" >2332</a>, <a +href="glossaries-user.html#dx1-204035" >2333</a>, <a +href="glossaries-user.html#dx1-206018" >2334</a>, <a +href="glossaries-user.html#dx1-211044" >2335</a>, <a +href="glossaries-user.html#dx1-211056" >2336</a>, <a +href="glossaries-user.html#dx1-211076" >2337</a>, <a +href="glossaries-user.html#dx1-212012" >2338</a>, <a +href="glossaries-user.html#dx1-214025" >2339</a>, <a +href="glossaries-user.html#dx1-214049" >2340</a>, <a +href="glossaries-user.html#dx1-214052" >2341</a>, <a +href="glossaries-user.html#dx1-220025" >2342</a>, <a +href="glossaries-user.html#dx1-223013" >2343</a>, <a +href="glossaries-user.html#dx1-223023" >2344</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">type</span>  <a +href="glossaries-user.html#dx1-192058" >2345</a>, <a +href="glossaries-user.html#dx1-193019" >2346</a>, <a +href="glossaries-user.html#dx1-194027" >2347</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrlong</span></span></span>  <a +href="glossaries-user.html#dx1-178039" >2348</a>, <a +href="glossaries-user.html#dx1-179040" >2349</a>, <a +href="glossaries-user.html#dx1-186017" >2350</a>, <a +href="glossaries-user.html#dx1-224052" >2351</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnewgls</span></span></span>  <a +href="glossaries-user.html#dx1-192027" >2352</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnewglslike</span></span></span>  <a +href="glossaries-user.html#dx1-24019" >2353</a>, <a +href="glossaries-user.html#dx1-192028" >2354</a>, <a +href="glossaries-user.html#dx1-193049" >2355</a>, <a +href="glossaries-user.html#dx1-194040" >2356</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnewnumber</span></span></span>  <a +href="glossaries-user.html#dx1-86005" >2357</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnewsymbol</span></span></span>  <a +href="glossaries-user.html#dx1-4009" >2358</a>, <a +href="glossaries-user.html#dx1-6014" >2359</a>, <a +href="glossaries-user.html#dx1-8016" >2360</a>, <a +href="glossaries-user.html#dx1-85005" >2361</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnonprintablerules</span></span></span>  <a +href="glossaries-user.html#dx1-211060" >2362</a>, <a +href="glossaries-user.html#dx1-211081" >2363</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrnopostpunc</span></span></span>  <a +href="glossaries-user.html#dx1-112024" >2364</a>, <a +href="glossaries-user.html#dx1-197017" >2365</a>, <a +href="glossaries-user.html#dx1-200016" >2366</a>, <a +href="glossaries-user.html#dx1-200017" >2367</a>, <a +href="glossaries-user.html#dx1-200034" >2368</a>, <a +href="glossaries-user.html#dx1-202018" >2369</a>, <a +href="glossaries-user.html#dx1-202035" >2370</a>, <a +href="glossaries-user.html#dx1-206011" >2371</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrp</span></span></span>  <a +href="glossaries-user.html#dx1-192020" >2372</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrparen</span></span></span>  <a +href="glossaries-user.html#dx1-182011" >2373</a>, <a +href="glossaries-user.html#dx1-184017" >2374</a>, <a +href="glossaries-user.html#dx1-184026" >2375</a>, <a +href="glossaries-user.html#dx1-184035" >2376</a>, <a +href="glossaries-user.html#dx1-184044" >2377</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrpostlinkAddSymbolOnFirstUse</span></span></span>  <a +href="glossaries-user.html#dx1-222008" >2378</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrsectionlocfmt</span></span></span>  <a +href="glossaries-user.html#dx1-190043" >2379</a>, <a +href="glossaries-user.html#dx1-190044" >2380</a>, <a +href="glossaries-user.html#dx1-212015" >2381</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrSetAltModifier</span></span></span>  <a +href="glossaries-user.html#dx1-24023" >2382</a>, <a +href="glossaries-user.html#dx1-189018" >2383</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrshort</span></span></span>  <a +href="glossaries-user.html#dx1-178038" >2384</a>, <a +href="glossaries-user.html#dx1-179039" >2385</a>, <a +href="glossaries-user.html#dx1-186016" >2386</a>, <a +href="glossaries-user.html#dx1-224051" >2387</a>, <a +href="glossaries-user.html#dx1-4005" >2388</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\glsxtrspacerules</span></span></span>  <a +href="glossaries-user.html#dx1-211059" >2389</a>, <a +href="glossaries-user.html#dx1-211080" >2390</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrUseAbbrStyleFmts</span></span></span>  <a +href="glossaries-user.html#dx1-184010" >2391</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\GlsXtrUseAbbrStyleSetup</span></span></span>  <a +href="glossaries-user.html#dx1-184009" >2392</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">H</span> <span class="index-item"><span class="cmss-10">html </span>package  <a -href="glossaries-user.html#dx1-58002" >898</a> <br /></span> +href="glossaries-user.html#dx1-136002" >2393</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperbf</span></span></span>  <a +href="glossaries-user.html#dx1-132061" >2394</a>, <a +href="glossaries-user.html#dx1-188004" >2395</a>, <a +href="glossaries-user.html#dx1-189004" >2396</a>, <a +href="glossaries-user.html#dx1-189005" >2397</a>, <a +href="glossaries-user.html#dx1-189068" >2398</a>, <a +href="glossaries-user.html#dx1-190012" >2399</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperbfit</span></span></span>  <a +href="glossaries-user.html#dx1-190035" >2400</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperbsf</span></span></span>  <a +href="glossaries-user.html#dx1-132069" >2401</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperemph</span></span></span>  <a +href="glossaries-user.html#dx1-132067" >2402</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperit</span></span></span>  <a +href="glossaries-user.html#dx1-132063" >2403</a>, <a +href="glossaries-user.html#dx1-190013" >2404</a>, <a +href="glossaries-user.html#dx1-190017" >2405</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperlink</span></span></span>  <a +href="glossaries-user.html#dx1-132068" >2406</a>, <a +href="glossaries-user.html#dx1-136007" >2407</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypermd</span></span></span>  <a +href="glossaries-user.html#dx1-132062" >2408</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperpage</span></span></span>  <a +href="glossaries-user.html#dx1-132053" >2409</a> <br /></span> <span class="index-item"><span class="cmss-10">hyperref </span>package  <a -href="glossaries-user.html#dx1-19" >899</a>, <a -href="glossaries-user.html#dx1-20" >900</a>, <a -href="glossaries-user.html#dx1-27" >901</a>, <a -href="glossaries-user.html#dx1-52012" >902</a>, <a -href="glossaries-user.html#dx1-52020" >903</a>, <a -href="glossaries-user.html#dx1-54010" >904</a>, <a -href="glossaries-user.html#dx1-54013" >905</a>, <a -href="glossaries-user.html#dx1-54016" >906</a>, <a -href="glossaries-user.html#dx1-54018" >907</a>, <a -href="glossaries-user.html#dx1-54039" >908</a>, <a -href="glossaries-user.html#dx1-54054" >909</a>, <a -href="glossaries-user.html#dx1-55055" >910</a>, <a -href="glossaries-user.html#dx1-57024" >911</a>, <a -href="glossaries-user.html#dx1-58001" >912</a>, <a -href="glossaries-user.html#dx1-58009" >913</a>, <a -href="glossaries-user.html#dx1-62003" >914</a>, <a -href="glossaries-user.html#dx1-62004" >915</a>, <a -href="glossaries-user.html#dx1-62058" >916</a>, <a -href="glossaries-user.html#dx1-62069" >917</a>, <a -href="glossaries-user.html#dx1-62070" >918</a>, <a -href="glossaries-user.html#dx1-66031" >919</a>, <a -href="glossaries-user.html#dx1-66041" >920</a>, <a -href="glossaries-user.html#dx1-88050" >921</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-17" >2410</a>, <a +href="glossaries-user.html#dx1-18" >2411</a>, <a +href="glossaries-user.html#dx1-19" >2412</a>, <a +href="glossaries-user.html#dx1-26" >2413</a>, <a +href="glossaries-user.html#dx1-11034" >2414</a>, <a +href="glossaries-user.html#dx1-11049" >2415</a>, <a +href="glossaries-user.html#dx1-70002" >2416</a>, <a +href="glossaries-user.html#dx1-130012" >2417</a>, <a +href="glossaries-user.html#dx1-130020" >2418</a>, <a +href="glossaries-user.html#dx1-132010" >2419</a>, <a +href="glossaries-user.html#dx1-132013" >2420</a>, <a +href="glossaries-user.html#dx1-132016" >2421</a>, <a +href="glossaries-user.html#dx1-132018" >2422</a>, <a +href="glossaries-user.html#dx1-132039" >2423</a>, <a +href="glossaries-user.html#dx1-132054" >2424</a>, <a +href="glossaries-user.html#dx1-133055" >2425</a>, <a +href="glossaries-user.html#dx1-135024" >2426</a>, <a +href="glossaries-user.html#dx1-136001" >2427</a>, <a +href="glossaries-user.html#dx1-136009" >2428</a>, <a +href="glossaries-user.html#dx1-140003" >2429</a>, <a +href="glossaries-user.html#dx1-140004" >2430</a>, <a +href="glossaries-user.html#dx1-140057" >2431</a>, <a +href="glossaries-user.html#dx1-140068" >2432</a>, <a +href="glossaries-user.html#dx1-140069" >2433</a>, <a +href="glossaries-user.html#dx1-144034" >2434</a>, <a +href="glossaries-user.html#dx1-144044" >2435</a>, <a +href="glossaries-user.html#dx1-166050" >2436</a>, <a +href="glossaries-user.html#dx1-173002" >2437</a>, <a +href="glossaries-user.html#dx1-188006" >2438</a>, <a +href="glossaries-user.html#dx1-220013" >2439</a>, <a +href="glossaries-user.html#dx1-220015" >2440</a>, <a +href="glossaries-user.html#dx1-220017" >2441</a>, <a +href="glossaries-user.html#dx1-31010" >2442</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperrm</span></span></span>  <a +href="glossaries-user.html#dx1-132058" >2443</a>, <a +href="glossaries-user.html#dx1-144013" >2444</a>, <a +href="glossaries-user.html#dx1-188003" >2445</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypersc</span></span></span>  <a +href="glossaries-user.html#dx1-132066" >2446</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypersf</span></span></span>  <a +href="glossaries-user.html#dx1-132059" >2447</a> <br /></span> + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypersl</span></span></span>  <a +href="glossaries-user.html#dx1-132064" >2448</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypertarget</span></span></span>  <a +href="glossaries-user.html#dx1-136008" >2449</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hypertt</span></span></span>  <a +href="glossaries-user.html#dx1-132060" >2450</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\hyperup</span></span></span>  <a +href="glossaries-user.html#dx1-132065" >2451</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">I</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglossaryexists</span></span></span>  <a -href="glossaries-user.html#dx1-91001" ><span -class="cmti-10">922</span></a> <br /></span> +href="glossaries-user.html#dx1-169001" ><span +class="cmti-10">2452</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsdescsuppressed</span></span></span>  <a -href="glossaries-user.html#dx1-91023" ><span -class="cmti-10">923</span></a> <br /></span> +href="glossaries-user.html#dx1-169023" ><span +class="cmti-10">2453</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsentryexists</span></span></span>  <a -href="glossaries-user.html#dx1-91002" ><span -class="cmti-10">924</span></a> <br /></span> - - +href="glossaries-user.html#dx1-169002" ><span +class="cmti-10">2454</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsfieldcseq</span></span></span>  <a -href="glossaries-user.html#dx1-91034" ><span -class="cmti-10">925</span></a> <br /></span> +href="glossaries-user.html#dx1-169034" ><span +class="cmti-10">2455</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsfielddefeq</span></span></span>  <a -href="glossaries-user.html#dx1-91032" ><span -class="cmti-10">926</span></a> <br /></span> +href="glossaries-user.html#dx1-169032" ><span +class="cmti-10">2456</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsfieldeq</span></span></span>  <a -href="glossaries-user.html#dx1-91029" ><span -class="cmti-10">927</span></a> <br /></span> +href="glossaries-user.html#dx1-150085" >2457</a>, <a +href="glossaries-user.html#dx1-169029" ><span +class="cmti-10">2458</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshaschildren</span></span></span>  <a -href="glossaries-user.html#dx1-91011" ><span -class="cmti-10">928</span></a> <br /></span> +href="glossaries-user.html#dx1-169011" ><span +class="cmti-10">2459</span></a>, <a +href="glossaries-user.html#dx1-200036" >2460</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasdesc</span></span></span>  <a -href="glossaries-user.html#dx1-91021" ><span -class="cmti-10">929</span></a> <br /></span> +href="glossaries-user.html#dx1-169021" ><span +class="cmti-10">2461</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasfield</span></span></span>  <a -href="glossaries-user.html#dx1-91026" ><span -class="cmti-10">930</span></a> <br /></span> +href="glossaries-user.html#dx1-169026" ><span +class="cmti-10">2462</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshaslong</span></span></span>  <a -href="glossaries-user.html#dx1-91015" ><span -class="cmti-10">931</span></a> <br /></span> +href="glossaries-user.html#dx1-34021" >2463</a>, <a +href="glossaries-user.html#dx1-117009" >2464</a>, <a +href="glossaries-user.html#dx1-117010" >2465</a>, <a +href="glossaries-user.html#dx1-150013" >2466</a>, <a +href="glossaries-user.html#dx1-169015" ><span +class="cmti-10">2467</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasparent</span></span></span>  <a -href="glossaries-user.html#dx1-91012" ><span -class="cmti-10">932</span></a> <br /></span> +href="glossaries-user.html#dx1-169012" ><span +class="cmti-10">2468</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasprefix</span></span></span>  <a -href="glossaries-user.html#dx1-93040" ><span -class="cmti-10">933</span></a> <br /></span> +href="glossaries-user.html#dx1-171041" ><span +class="cmti-10">2469</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasprefixfirst</span></span></span>  <a -href="glossaries-user.html#dx1-93044" ><span -class="cmti-10">934</span></a> <br /></span> +href="glossaries-user.html#dx1-171045" ><span +class="cmti-10">2470</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasprefixfirstplural</span></span></span>  <a -href="glossaries-user.html#dx1-93046" ><span -class="cmti-10">935</span></a> <br /></span> +href="glossaries-user.html#dx1-171047" ><span +class="cmti-10">2471</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasprefixplural</span></span></span>  <a -href="glossaries-user.html#dx1-93042" ><span -class="cmti-10">936</span></a> <br /></span> +href="glossaries-user.html#dx1-171043" ><span +class="cmti-10">2472</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshasshort</span></span></span>  <a -href="glossaries-user.html#dx1-91018" ><span -class="cmti-10">937</span></a> <br /></span> +href="glossaries-user.html#dx1-150012" >2473</a>, <a +href="glossaries-user.html#dx1-169018" ><span +class="cmti-10">2474</span></a>, <a +href="glossaries-user.html#dx1-179026" >2475</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglshassymbol</span></span></span>  <a -href="glossaries-user.html#dx1-91013" ><span -class="cmti-10">938</span></a> <br /></span> +href="glossaries-user.html#dx1-11052" >2476</a>, <a +href="glossaries-user.html#dx1-166088" >2477</a>, <a +href="glossaries-user.html#dx1-169013" ><span +class="cmti-10">2478</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsucmark</span></span></span>  <a -href="glossaries-user.html#dx1-24030" ><span -class="cmti-10">939</span></a> <br /></span> +href="glossaries-user.html#dx1-42011" >2479</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifglsused</span></span></span>  <a -href="glossaries-user.html#dx1-75011" ><span -class="cmti-10">940</span></a>, <a -href="glossaries-user.html#dx1-91010" ><span -class="cmti-10">941</span></a> <br /></span> +href="glossaries-user.html#dx1-34019" >2480</a>, <a +href="glossaries-user.html#dx1-135030" >2481</a>, <a +href="glossaries-user.html#dx1-150004" >2482</a>, <a +href="glossaries-user.html#dx1-150089" >2483</a>, <a +href="glossaries-user.html#dx1-153011" ><span +class="cmti-10">2484</span></a>, <a +href="glossaries-user.html#dx1-169010" ><span +class="cmti-10">2485</span></a>, <a +href="glossaries-user.html#dx1-178003" >2486</a>, <a +href="glossaries-user.html#dx1-178004" >2487</a>, <a +href="glossaries-user.html#dx1-183008" >2488</a>, <a +href="glossaries-user.html#dx1-222004" >2489</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\ifglsxtrinsertinside</span></span></span>  <a +href="glossaries-user.html#dx1-184014" >2490</a>, <a +href="glossaries-user.html#dx1-184015" >2491</a>, <a +href="glossaries-user.html#dx1-184023" >2492</a>, <a +href="glossaries-user.html#dx1-184024" >2493</a>, <a +href="glossaries-user.html#dx1-184032" >2494</a>, <a +href="glossaries-user.html#dx1-184033" >2495</a>, <a +href="glossaries-user.html#dx1-184041" >2496</a>, <a +href="glossaries-user.html#dx1-184042" >2497</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\ifignoredglossary</span></span></span>  <a -href="glossaries-user.html#dx1-68012" ><span -class="cmti-10">942</span></a> <br /></span> +href="glossaries-user.html#dx1-146014" ><span +class="cmti-10">2498</span></a> <br /></span> <span class="index-item"><span class="cmss-10">imakeidx </span>package  <a -href="glossaries-user.html#dx1-29024" >943</a> <br /></span> +href="glossaries-user.html#dx1-87011" >2499</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\include</span></span></span>  <a +href="glossaries-user.html#dx1-122008" >2500</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\includegraphics</span></span></span>  <a +href="glossaries-user.html#dx1-224031" >2501</a>, <a +href="glossaries-user.html#dx1-224032" >2502</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\index</span></span></span>  <a +href="glossaries-user.html#dx1-87008" >2503</a>, <a +href="glossaries-user.html#dx1-132043" >2504</a>, <a +href="glossaries-user.html#dx1-132044" >2505</a>, <a +href="glossaries-user.html#dx1-132045" >2506</a> <br /></span> <span class="index-item"><span class="cmss-10">index </span>package  <a -href="glossaries-user.html#dx1-29023" >944</a> <br /></span> +href="glossaries-user.html#dx1-87010" >2507</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\indexname</span></span></span>  <a +href="glossaries-user.html#dx1-146027" >2508</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\indexspace</span></span></span>  <a +href="glossaries-user.html#dx1-157015" >2509</a>, <a +href="glossaries-user.html#dx1-163018" >2510</a>, <a +href="glossaries-user.html#dx1-166036" >2511</a>, <a +href="glossaries-user.html#dx1-166094" >2512</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\input</span></span></span>  <a +href="glossaries-user.html#dx1-12002" >2513</a>, <a +href="glossaries-user.html#dx1-122007" >2514</a> <br /></span> <span class="index-item"><span class="cmss-10">inputenc </span>package  <a -href="glossaries-user.html#dx1-11016" >945</a>, <a -href="glossaries-user.html#dx1-11074" >946</a>, <a -href="glossaries-user.html#dx1-13015" >947</a>, <a -href="glossaries-user.html#dx1-34083" >948</a>, <a -href="glossaries-user.html#dx1-34141" >949</a>, <a -href="glossaries-user.html#dx1-65008" >950</a>, <a -href="glossaries-user.html#dx1-67005" >951</a> <br /></span> +href="glossaries-user.html#dx1-13015" >2515</a>, <a +href="glossaries-user.html#dx1-112086" >2516</a>, <a +href="glossaries-user.html#dx1-112154" >2517</a>, <a +href="glossaries-user.html#dx1-143008" >2518</a>, <a +href="glossaries-user.html#dx1-145005" >2519</a>, <a +href="glossaries-user.html#dx1-211001" >2520</a>, <a +href="glossaries-user.html#dx1-217001" >2521</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\inputencodingname</span></span></span>  <a +href="glossaries-user.html#dx1-143009" >2522</a> <br /></span> <span class="index-item">internal fields:<br /></span> -<span class="index-subitem">    <span -class="cmss-10">location</span>  <a -href="glossaries-user.html#dx1-5010" >952</a> <br /></span> -</p><p class="theindex"> <span +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">location</span>  <a +href="glossaries-user.html#dx1-5009" >2523</a>, <a +href="glossaries-user.html#dx1-220031" >2524</a>, <a +href="glossaries-user.html#dx1-220042" >2525</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">loclist</span>  <a +href="glossaries-user.html#dx1-220034" >2526</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">siblingcount</span>  <a +href="glossaries-user.html#dx1-200045" >2527</a>, <a +href="glossaries-user.html#dx1-200047" >2528</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">useri</span>  <a +href="glossaries-user.html#dx1-189035" >2529</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\item</span></span></span>  <a +href="glossaries-user.html#dx1-157013" >2530</a>, <a +href="glossaries-user.html#dx1-157022" >2531</a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">J</span> + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\jobname</span></span></span>  <a +href="glossaries-user.html#dx1-111011" >2532</a>, <a +href="glossaries-user.html#dx1-111013" >2533</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">L</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\label</span></span></span>  <a +href="glossaries-user.html#dx1-43005" >2534</a> <br /></span> <span class="index-item"><span class="cmtt-10">latex</span>  <a -href="glossaries-user.html#dx1-29" >953</a>, <a -href="glossaries-user.html#dx1-54020" >954</a> <br /></span> +href="glossaries-user.html#dx1-28" >2535</a>, <a +href="glossaries-user.html#dx1-132020" >2536</a> <br /></span> <span class="index-item"><span class="cmtt-10">latexmk</span>  <a -href="glossaries-user.html#dx1-16020" >955</a>, <a -href="glossaries-user.html#dx1-16023" >956</a>, <a -href="glossaries-user.html#dx1-16029" >957</a> <br /></span> +href="glossaries-user.html#dx1-16019" >2537</a>, <a +href="glossaries-user.html#dx1-16022" >2538</a>, <a +href="glossaries-user.html#dx1-16028" >2539</a> <br /></span> <span class="index-item">Latin alphabet  <a -href="glossaries-user.html#dx1-3027" ><span -class="cmbx-10">958</span></a>, <a -href="glossaries-user.html#dx1-7002" >959</a>, <a -href="glossaries-user.html#dx1-13006" >960</a> <br /></span> +href="glossaries-user.html#dx1-3038" ><span +class="cmbx-10">2540</span></a>, <a +href="glossaries-user.html#dx1-7006" >2541</a>, <a +href="glossaries-user.html#dx1-13006" >2542</a> <br /></span> <span class="index-item">Latin character  <a -href="glossaries-user.html#dx1-3004" >961</a>, <a -href="glossaries-user.html#dx1-3007" >962</a>, <a -href="glossaries-user.html#dx1-3008" >963</a>, <a -href="glossaries-user.html#dx1-3028" >964</a>, <a -href="glossaries-user.html#dx1-3029" ><span -class="cmbx-10">965</span></a>, <a -href="glossaries-user.html#dx1-3046" >966</a>, <a -href="glossaries-user.html#dx1-68006" >967</a> <br /></span> +href="glossaries-user.html#dx1-3015" >2543</a>, <a +href="glossaries-user.html#dx1-3018" >2544</a>, <a +href="glossaries-user.html#dx1-3019" >2545</a>, <a +href="glossaries-user.html#dx1-3039" >2546</a>, <a +href="glossaries-user.html#dx1-3040" ><span +class="cmbx-10">2547</span></a>, <a +href="glossaries-user.html#dx1-3058" >2548</a>, <a +href="glossaries-user.html#dx1-146006" >2549</a> <br /></span> <span class="index-item">link text  <a -href="glossaries-user.html#dx1-3031" ><span -class="cmbx-10">968</span></a>, <a -href="glossaries-user.html#dx1-54003" >969</a>, <a -href="glossaries-user.html#dx1-54015" >970</a>, <a -href="glossaries-user.html#dx1-54017" >971</a>, <a -href="glossaries-user.html#dx1-54023" >972</a>, <a -href="glossaries-user.html#dx1-54024" >973</a>, <a -href="glossaries-user.html#dx1-54026" >974</a>, <a -href="glossaries-user.html#dx1-54073" >975</a>, <a -href="glossaries-user.html#dx1-54074" >976</a>, <a -href="glossaries-user.html#dx1-55012" >977</a>, <a -href="glossaries-user.html#dx1-55018" >978</a>, <a -href="glossaries-user.html#dx1-55024" >979</a>, <a -href="glossaries-user.html#dx1-55025" >980</a>, <a -href="glossaries-user.html#dx1-55027" >981</a>, <a -href="glossaries-user.html#dx1-55028" >982</a>, <a -href="glossaries-user.html#dx1-55032" >983</a>, <a -href="glossaries-user.html#dx1-55033" >984</a>, <a -href="glossaries-user.html#dx1-55035" >985</a>, <a -href="glossaries-user.html#dx1-55036" >986</a>, <a -href="glossaries-user.html#dx1-55037" >987</a>, <a -href="glossaries-user.html#dx1-55038" >988</a>, <a -href="glossaries-user.html#dx1-55039" >989</a>, <a -href="glossaries-user.html#dx1-55040" >990</a>, <a -href="glossaries-user.html#dx1-55044" >991</a>, <a -href="glossaries-user.html#dx1-55045" >992</a>, <a -href="glossaries-user.html#dx1-56005" >993</a>, <a -href="glossaries-user.html#dx1-56006" >994</a>, <a -href="glossaries-user.html#dx1-56009" >995</a>, <a -href="glossaries-user.html#dx1-56015" >996</a>, <a -href="glossaries-user.html#dx1-56022" >997</a>, <a -href="glossaries-user.html#dx1-56027" >998</a>, <a -href="glossaries-user.html#dx1-56030" >999</a>, <a -href="glossaries-user.html#dx1-56035" >1000</a>, <a -href="glossaries-user.html#dx1-56040" >1001</a>, <a -href="glossaries-user.html#dx1-56047" >1002</a>, <a -href="glossaries-user.html#dx1-56052" >1003</a>, <a -href="glossaries-user.html#dx1-56057" >1004</a>, <a -href="glossaries-user.html#dx1-56062" >1005</a>, <a -href="glossaries-user.html#dx1-56067" >1006</a>, <a -href="glossaries-user.html#dx1-56072" >1007</a>, <a -href="glossaries-user.html#dx1-56077" >1008</a>, <a -href="glossaries-user.html#dx1-56082" >1009</a>, <a -href="glossaries-user.html#dx1-57001" >1010</a>, <a -href="glossaries-user.html#dx1-57081" >1011</a>, <a -href="glossaries-user.html#dx1-69050" >1012</a>, <a -href="glossaries-user.html#dx1-69053" >1013</a>, <a -href="glossaries-user.html#dx1-69065" >1014</a>, <a -href="glossaries-user.html#dx1-69075" >1015</a>, <a -href="glossaries-user.html#dx1-93019" >1016</a> <br /></span> +href="glossaries-user.html#dx1-3042" ><span +class="cmbx-10">2550</span></a>, <a +href="glossaries-user.html#dx1-11035" >2551</a>, <a +href="glossaries-user.html#dx1-11067" >2552</a>, <a +href="glossaries-user.html#dx1-132003" >2553</a>, <a +href="glossaries-user.html#dx1-132015" >2554</a>, <a +href="glossaries-user.html#dx1-132017" >2555</a>, <a +href="glossaries-user.html#dx1-132023" >2556</a>, <a +href="glossaries-user.html#dx1-132024" >2557</a>, <a +href="glossaries-user.html#dx1-132026" >2558</a>, <a +href="glossaries-user.html#dx1-132083" >2559</a>, <a +href="glossaries-user.html#dx1-132085" >2560</a>, <a +href="glossaries-user.html#dx1-132091" >2561</a>, <a +href="glossaries-user.html#dx1-132092" >2562</a>, <a +href="glossaries-user.html#dx1-133012" >2563</a>, <a +href="glossaries-user.html#dx1-133018" >2564</a>, <a +href="glossaries-user.html#dx1-133024" >2565</a>, <a +href="glossaries-user.html#dx1-133025" >2566</a>, <a +href="glossaries-user.html#dx1-133027" >2567</a>, <a +href="glossaries-user.html#dx1-133028" >2568</a>, <a +href="glossaries-user.html#dx1-133032" >2569</a>, <a +href="glossaries-user.html#dx1-133033" >2570</a>, <a +href="glossaries-user.html#dx1-133035" >2571</a>, <a +href="glossaries-user.html#dx1-133036" >2572</a>, <a +href="glossaries-user.html#dx1-133037" >2573</a>, <a +href="glossaries-user.html#dx1-133038" >2574</a>, <a +href="glossaries-user.html#dx1-133039" >2575</a>, <a +href="glossaries-user.html#dx1-133040" >2576</a>, <a +href="glossaries-user.html#dx1-133044" >2577</a>, <a +href="glossaries-user.html#dx1-133045" >2578</a>, <a +href="glossaries-user.html#dx1-134005" >2579</a>, <a +href="glossaries-user.html#dx1-134006" >2580</a>, <a +href="glossaries-user.html#dx1-134009" >2581</a>, <a +href="glossaries-user.html#dx1-134015" >2582</a>, <a +href="glossaries-user.html#dx1-134022" >2583</a>, <a +href="glossaries-user.html#dx1-134027" >2584</a>, <a +href="glossaries-user.html#dx1-134030" >2585</a>, <a +href="glossaries-user.html#dx1-134035" >2586</a>, <a +href="glossaries-user.html#dx1-134040" >2587</a>, <a +href="glossaries-user.html#dx1-134047" >2588</a>, <a +href="glossaries-user.html#dx1-134052" >2589</a>, <a +href="glossaries-user.html#dx1-134057" >2590</a>, <a +href="glossaries-user.html#dx1-134062" >2591</a>, <a +href="glossaries-user.html#dx1-134067" >2592</a>, <a +href="glossaries-user.html#dx1-134072" >2593</a>, <a +href="glossaries-user.html#dx1-134077" >2594</a>, <a +href="glossaries-user.html#dx1-134082" >2595</a>, <a +href="glossaries-user.html#dx1-135001" >2596</a>, <a +href="glossaries-user.html#dx1-135081" >2597</a>, <a +href="glossaries-user.html#dx1-147050" >2598</a>, <a +href="glossaries-user.html#dx1-147053" >2599</a>, <a +href="glossaries-user.html#dx1-147065" >2600</a>, <a +href="glossaries-user.html#dx1-147075" >2601</a>, <a +href="glossaries-user.html#dx1-171020" >2602</a>, <a +href="glossaries-user.html#dx1-172055" >2603</a>, <a +href="glossaries-user.html#dx1-183002" >2604</a>, <a +href="glossaries-user.html#dx1-183003" >2605</a>, <a +href="glossaries-user.html#dx1-183020" >2606</a>, <a +href="glossaries-user.html#dx1-189007" >2607</a>, <a +href="glossaries-user.html#dx1-189023" >2608</a>, <a +href="glossaries-user.html#dx1-189027" >2609</a>, <a +href="glossaries-user.html#dx1-189031" >2610</a>, <a +href="glossaries-user.html#dx1-189033" >2611</a>, <a +href="glossaries-user.html#dx1-189038" >2612</a>, <a +href="glossaries-user.html#dx1-189041" >2613</a>, <a +href="glossaries-user.html#dx1-189058" >2614</a>, <a +href="glossaries-user.html#dx1-192019" >2615</a>, <a +href="glossaries-user.html#dx1-222006" >2616</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\listbreak</span></span></span>  <a +href="glossaries-user.html#dx1-200049" >2617</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\loadglsentries</span></span></span>  <a -href="glossaries-user.html#dx1-44001" ><span -class="cmti-10">1017</span></a> <br /></span> +href="glossaries-user.html#dx1-6003" >2618</a>, <a +href="glossaries-user.html#dx1-7003" >2619</a>, <a +href="glossaries-user.html#dx1-8003" >2620</a>, <a +href="glossaries-user.html#dx1-10003" >2621</a>, <a +href="glossaries-user.html#dx1-11004" >2622</a>, <a +href="glossaries-user.html#dx1-11019" >2623</a>, <a +href="glossaries-user.html#dx1-12003" >2624</a>, <a +href="glossaries-user.html#dx1-122001" ><span +class="cmti-10">2625</span></a>, <a +href="glossaries-user.html#dx1-147039" >2626</a> <br /></span> <span class="index-item">location list  <span class="cmti-10">see </span><a -href="glossaries-user.html#dx1-49004" >number list</a> <br /></span> +href="glossaries-user.html#dx1-127004" >number list</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\longnewglossaryentry</span></span></span>  <a -href="glossaries-user.html#dx1-34004" ><span -class="cmti-10">1019</span></a> <br /></span> +href="glossaries-user.html#dx1-112004" ><span +class="cmti-10">2628</span></a>, <a +href="glossaries-user.html#dx1-116003" >2629</a>, <a +href="glossaries-user.html#dx1-122003" >2630</a>, <a +href="glossaries-user.html#dx1-156041" >2631</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\longprovideglossaryentry</span></span></span>  <a -href="glossaries-user.html#dx1-34007" ><span -class="cmti-10">1020</span></a> <br /></span> +href="glossaries-user.html#dx1-112006" ><span +class="cmti-10">2632</span></a> <br /></span> <span class="index-item"><span class="cmss-10">longtable </span>package  <a -href="glossaries-user.html#dx1-25035" >1021</a>, <a -href="glossaries-user.html#dx1-80010" >1022</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-50002" >2633</a>, <a +href="glossaries-user.html#dx1-158010" >2634</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">M</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makeatletter</span></span></span>  <a +href="glossaries-user.html#dx1-150086" >2635</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makeatother</span></span></span>  <a +href="glossaries-user.html#dx1-150087" >2636</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\makefirstuc</span></span></span>  <a +href="glossaries-user.html#dx1-133023" >2637</a>, <a +href="glossaries-user.html#dx1-135067" >2638</a>, <a +href="glossaries-user.html#dx1-184064" >2639</a>, <a +href="glossaries-user.html#dx1-42009" >2640</a> <br /></span> <span class="index-item"><span class="cmtt-10">makeglossaries</span>  <a -href="glossaries-user.html#dx1-3033" ><span -class="cmbx-10">1023</span></a>, <a -href="glossaries-user.html#dx1-3037" >1024</a>, <a -href="glossaries-user.html#dx1-7032" >1025</a>, <a -href="glossaries-user.html#dx1-8026" >1026</a>, <a -href="glossaries-user.html#dx1-8029" >1027</a>, <a -href="glossaries-user.html#dx1-8030" >1028</a>, <a -href="glossaries-user.html#dx1-8033" >1029</a>, <a -href="glossaries-user.html#dx1-8035" >1030</a>, <a -href="glossaries-user.html#dx1-11008" >1031</a>, <a -href="glossaries-user.html#dx1-11040" >1032</a>, <a -href="glossaries-user.html#dx1-11051" >1033</a>, <a -href="glossaries-user.html#dx1-11062" >1034</a>, <a -href="glossaries-user.html#dx1-11075" >1035</a>, <a -href="glossaries-user.html#dx1-11077" >1036</a>, <a -href="glossaries-user.html#dx1-11079" >1037</a>, <a -href="glossaries-user.html#dx1-11081" >1038</a>, <a -href="glossaries-user.html#dx1-11084" >1039</a>, <a -href="glossaries-user.html#dx1-11101" >1040</a>, <a -href="glossaries-user.html#dx1-13025" >1041</a>, <a -href="glossaries-user.html#dx1-13028" >1042</a>, <a -href="glossaries-user.html#dx1-13042" >1043</a>, <a -href="glossaries-user.html#dx1-16003" >1044</a>, <a -href="glossaries-user.html#dx1-16024" >1045</a>, <a -href="glossaries-user.html#dx1-16030" >1046</a>, <a -href="glossaries-user.html#dx1-16032" >1047</a>, <a -href="glossaries-user.html#dx1-16035" >1048</a>, <a -href="glossaries-user.html#dx1-16038" >1049</a>, <a -href="glossaries-user.html#dx1-16044" >1050</a>, <a -href="glossaries-user.html#dx1-16047" >1051</a>, <a -href="glossaries-user.html#dx1-16051" >1052</a>, <a -href="glossaries-user.html#dx1-16053" >1053</a>, <a -href="glossaries-user.html#dx1-16056" >1054</a>, <a -href="glossaries-user.html#dx1-16058" >1055</a>, <a -href="glossaries-user.html#dx1-16062" >1056</a>, <a -href="glossaries-user.html#dx1-16065" >1057</a>, <a -href="glossaries-user.html#dx1-16070" >1058</a>, <a -href="glossaries-user.html#dx1-16073" >1059</a>, <a -href="glossaries-user.html#dx1-16075" >1060</a>, <a -href="glossaries-user.html#dx1-17001" >1061</a>, <a -href="glossaries-user.html#dx1-17005" >1062</a>, <a -href="glossaries-user.html#dx1-17006" >1063</a>, <a -href="glossaries-user.html#dx1-17007" >1064</a>, <a -href="glossaries-user.html#dx1-17009" >1065</a>, <a -href="glossaries-user.html#dx1-17012" >1066</a>, <a -href="glossaries-user.html#dx1-17013" >1067</a>, <a -href="glossaries-user.html#dx1-17016" >1068</a>, <a -href="glossaries-user.html#dx1-17020" >1069</a>, <a -href="glossaries-user.html#dx1-17027" >1070</a>, <a -href="glossaries-user.html#dx1-17031" >1071</a>, <a -href="glossaries-user.html#dx1-17034" >1072</a>, <a -href="glossaries-user.html#dx1-17035" >1073</a>, <a -href="glossaries-user.html#dx1-17037" >1074</a>, <a -href="glossaries-user.html#dx1-18001" >1075</a>, <a -href="glossaries-user.html#dx1-18003" >1076</a>, <a -href="glossaries-user.html#dx1-18006" >1077</a>, <a -href="glossaries-user.html#dx1-18007" >1078</a>, <a -href="glossaries-user.html#dx1-19005" >1079</a>, <a -href="glossaries-user.html#dx1-19021" >1080</a>, <a -href="glossaries-user.html#dx1-19023" >1081</a>, <a -href="glossaries-user.html#dx1-19025" >1082</a>, <a -href="glossaries-user.html#dx1-20018" >1083</a>, <a -href="glossaries-user.html#dx1-20020" >1084</a>, <a -href="glossaries-user.html#dx1-20022" >1085</a>, <a -href="glossaries-user.html#dx1-23033" >1086</a>, <a -href="glossaries-user.html#dx1-25007" >1087</a>, <a -href="glossaries-user.html#dx1-26051" >1088</a>, <a -href="glossaries-user.html#dx1-26056" >1089</a>, <a -href="glossaries-user.html#dx1-26058" >1090</a>, <a -href="glossaries-user.html#dx1-26065" >1091</a>, <a -href="glossaries-user.html#dx1-26067" >1092</a>, <a -href="glossaries-user.html#dx1-26097" >1093</a>, <a -href="glossaries-user.html#dx1-50016" >1094</a>, <a -href="glossaries-user.html#dx1-60006" >1095</a>, <a -href="glossaries-user.html#dx1-62063" >1096</a>, <a -href="glossaries-user.html#dx1-63005" >1097</a>, <a -href="glossaries-user.html#dx1-65003" >1098</a>, <a -href="glossaries-user.html#dx1-65005" >1099</a>, <a -href="glossaries-user.html#dx1-65013" >1100</a>, <a -href="glossaries-user.html#dx1-65015" >1101</a>, <a -href="glossaries-user.html#dx1-68005" >1102</a>, <a -href="glossaries-user.html#dx1-16046" >1103</a> <br /></span> +href="glossaries-user.html#dx1-3044" ><span +class="cmbx-10">2641</span></a>, <a +href="glossaries-user.html#dx1-3048" >2642</a>, <a +href="glossaries-user.html#dx1-3052" >2643</a>, <a +href="glossaries-user.html#dx1-7036" >2644</a>, <a +href="glossaries-user.html#dx1-7037" >2645</a>, <a +href="glossaries-user.html#dx1-7045" >2646</a>, <a +href="glossaries-user.html#dx1-8037" >2647</a>, <a +href="glossaries-user.html#dx1-8044" >2648</a>, <a +href="glossaries-user.html#dx1-8045" >2649</a>, <a +href="glossaries-user.html#dx1-8048" >2650</a>, <a +href="glossaries-user.html#dx1-8050" >2651</a>, <a +href="glossaries-user.html#dx1-13023" >2652</a>, <a +href="glossaries-user.html#dx1-13026" >2653</a>, <a +href="glossaries-user.html#dx1-13039" >2654</a>, <a +href="glossaries-user.html#dx1-16004" >2655</a>, <a +href="glossaries-user.html#dx1-16023" >2656</a>, <a +href="glossaries-user.html#dx1-16029" >2657</a>, <a +href="glossaries-user.html#dx1-16031" >2658</a>, <a +href="glossaries-user.html#dx1-16034" >2659</a>, <a +href="glossaries-user.html#dx1-16037" >2660</a>, <a +href="glossaries-user.html#dx1-16043" >2661</a>, <a +href="glossaries-user.html#dx1-16046" >2662</a>, <a +href="glossaries-user.html#dx1-16051" >2663</a>, <a +href="glossaries-user.html#dx1-16053" >2664</a>, <a +href="glossaries-user.html#dx1-16056" >2665</a>, <a +href="glossaries-user.html#dx1-16058" >2666</a>, <a +href="glossaries-user.html#dx1-16062" >2667</a>, <a +href="glossaries-user.html#dx1-16065" >2668</a>, <a +href="glossaries-user.html#dx1-16070" >2669</a>, <a +href="glossaries-user.html#dx1-16076" >2670</a>, <a +href="glossaries-user.html#dx1-16078" >2671</a>, <a +href="glossaries-user.html#dx1-17001" >2672</a>, <a +href="glossaries-user.html#dx1-17005" >2673</a>, <a +href="glossaries-user.html#dx1-17006" >2674</a>, <a +href="glossaries-user.html#dx1-17007" >2675</a>, <a +href="glossaries-user.html#dx1-17009" >2676</a>, <a +href="glossaries-user.html#dx1-17012" >2677</a>, <a +href="glossaries-user.html#dx1-17013" >2678</a>, <a +href="glossaries-user.html#dx1-17016" >2679</a>, <a +href="glossaries-user.html#dx1-17020" >2680</a>, <a +href="glossaries-user.html#dx1-17027" >2681</a>, <a +href="glossaries-user.html#dx1-17031" >2682</a>, <a +href="glossaries-user.html#dx1-17034" >2683</a>, <a +href="glossaries-user.html#dx1-18001" >2684</a>, <a +href="glossaries-user.html#dx1-18003" >2685</a>, <a +href="glossaries-user.html#dx1-18007" >2686</a>, <a +href="glossaries-user.html#dx1-18008" >2687</a>, <a +href="glossaries-user.html#dx1-19005" >2688</a>, <a +href="glossaries-user.html#dx1-19021" >2689</a>, <a +href="glossaries-user.html#dx1-19023" >2690</a>, <a +href="glossaries-user.html#dx1-19025" >2691</a>, <a +href="glossaries-user.html#dx1-20018" >2692</a>, <a +href="glossaries-user.html#dx1-20020" >2693</a>, <a +href="glossaries-user.html#dx1-20022" >2694</a>, <a +href="glossaries-user.html#dx1-22011" >2695</a>, <a +href="glossaries-user.html#dx1-22016" >2696</a>, <a +href="glossaries-user.html#dx1-46006" >2697</a>, <a +href="glossaries-user.html#dx1-74004" >2698</a>, <a +href="glossaries-user.html#dx1-75002" >2699</a>, <a +href="glossaries-user.html#dx1-75004" >2700</a>, <a +href="glossaries-user.html#dx1-76002" >2701</a>, <a +href="glossaries-user.html#dx1-76004" >2702</a>, <a +href="glossaries-user.html#dx1-79020" >2703</a>, <a +href="glossaries-user.html#dx1-84008" >2704</a>, <a +href="glossaries-user.html#dx1-128016" >2705</a>, <a +href="glossaries-user.html#dx1-138006" >2706</a>, <a +href="glossaries-user.html#dx1-140062" >2707</a>, <a +href="glossaries-user.html#dx1-141005" >2708</a>, <a +href="glossaries-user.html#dx1-143003" >2709</a>, <a +href="glossaries-user.html#dx1-143005" >2710</a>, <a +href="glossaries-user.html#dx1-143013" >2711</a>, <a +href="glossaries-user.html#dx1-143015" >2712</a>, <a +href="glossaries-user.html#dx1-146005" >2713</a>, <a +href="glossaries-user.html#dx1-175005" >2714</a>, <a +href="glossaries-user.html#dx1-175013" >2715</a>, <a +href="glossaries-user.html#dx1-175017" >2716</a>, <a +href="glossaries-user.html#dx1-175039" >2717</a>, <a +href="glossaries-user.html#dx1-176009" >2718</a>, <a +href="glossaries-user.html#dx1-176027" >2719</a>, <a +href="glossaries-user.html#dx1-178002" >2720</a>, <a +href="glossaries-user.html#dx1-179010" >2721</a>, <a +href="glossaries-user.html#dx1-190005" >2722</a>, <a +href="glossaries-user.html#dx1-190014" >2723</a>, <a +href="glossaries-user.html#dx1-190033" >2724</a>, <a +href="glossaries-user.html#dx1-192002" >2725</a>, <a +href="glossaries-user.html#dx1-192013" >2726</a>, <a +href="glossaries-user.html#dx1-195001" >2727</a>, <a +href="glossaries-user.html#dx1-198003" >2728</a>, <a +href="glossaries-user.html#dx1-198014" >2729</a>, <a +href="glossaries-user.html#dx1-198015" >2730</a>, <a +href="glossaries-user.html#dx1-200003" >2731</a>, <a +href="glossaries-user.html#dx1-202060" >2732</a>, <a +href="glossaries-user.html#dx1-211003" >2733</a>, <a +href="glossaries-user.html#dx1-211006" >2734</a>, <a +href="glossaries-user.html#dx1-211008" >2735</a>, <a +href="glossaries-user.html#dx1-211010" >2736</a>, <a +href="glossaries-user.html#dx1-211013" >2737</a>, <a +href="glossaries-user.html#dx1-224043" >2738</a>, <a +href="glossaries-user.html#dx1-226003" >2739</a>, <a +href="glossaries-user.html#dx1-16045" >2740</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-d</span>  <a -href="glossaries-user.html#dx1-18004" >1104</a> <br /></span> +href="glossaries-user.html#dx1-18004" >2741</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-k</span>  <a -href="glossaries-user.html#dx1-17015" >1105</a> <br /></span> +href="glossaries-user.html#dx1-17015" >2742</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-m</span>  <a -href="glossaries-user.html#dx1-17023" >1106</a> <br /></span> +href="glossaries-user.html#dx1-17023" >2743</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-Q</span>  <a -href="glossaries-user.html#dx1-17014" >1107</a> <br /></span> +href="glossaries-user.html#dx1-17014" >2744</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-q</span>  <a -href="glossaries-user.html#dx1-17017" >1108</a> <br /></span> +href="glossaries-user.html#dx1-17017" >2745</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-x</span>  <a -href="glossaries-user.html#dx1-17025" >1109</a> <br /></span> - - +href="glossaries-user.html#dx1-17025" >2746</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\makeglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-33001" ><span -class="cmti-10">1110</span></a> <br /></span> +href="glossaries-user.html#dx1-7001" >2747</a>, <a +href="glossaries-user.html#dx1-7004" >2748</a>, <a +href="glossaries-user.html#dx1-8001" >2749</a>, <a +href="glossaries-user.html#dx1-8004" >2750</a>, <a +href="glossaries-user.html#dx1-13036" >2751</a>, <a +href="glossaries-user.html#dx1-16026" >2752</a>, <a +href="glossaries-user.html#dx1-27001" >2753</a>, <a +href="glossaries-user.html#dx1-30016" >2754</a>, <a +href="glossaries-user.html#dx1-30017" >2755</a>, <a +href="glossaries-user.html#dx1-62003" >2756</a>, <a +href="glossaries-user.html#dx1-79008" >2757</a>, <a +href="glossaries-user.html#dx1-80001" >2758</a>, <a +href="glossaries-user.html#dx1-80003" >2759</a>, <a +href="glossaries-user.html#dx1-80006" >2760</a>, <a +href="glossaries-user.html#dx1-81002" >2761</a>, <a +href="glossaries-user.html#dx1-111001" ><span +class="cmti-10">2762</span></a>, <a +href="glossaries-user.html#dx1-112121" >2763</a>, <a +href="glossaries-user.html#dx1-130005" >2764</a>, <a +href="glossaries-user.html#dx1-130014" >2765</a>, <a +href="glossaries-user.html#dx1-132007" >2766</a>, <a +href="glossaries-user.html#dx1-138001" >2767</a>, <a +href="glossaries-user.html#dx1-141003" >2768</a>, <a +href="glossaries-user.html#dx1-141017" >2769</a>, <a +href="glossaries-user.html#dx1-144008" >2770</a>, <a +href="glossaries-user.html#dx1-144025" >2771</a>, <a +href="glossaries-user.html#dx1-144026" >2772</a>, <a +href="glossaries-user.html#dx1-144030" >2773</a>, <a +href="glossaries-user.html#dx1-144031" >2774</a>, <a +href="glossaries-user.html#dx1-144063" >2775</a>, <a +href="glossaries-user.html#dx1-144064" >2776</a>, <a +href="glossaries-user.html#dx1-144069" >2777</a>, <a +href="glossaries-user.html#dx1-144070" >2778</a>, <a +href="glossaries-user.html#dx1-145009" >2779</a>, <a +href="glossaries-user.html#dx1-145010" >2780</a>, <a +href="glossaries-user.html#dx1-146024" >2781</a>, <a +href="glossaries-user.html#dx1-190028" >2782</a>, <a +href="glossaries-user.html#dx1-198008" >2783</a> <br /></span> <span class="index-item"><span class="cmtt-10">makeglossaries-lite</span>  <a -href="glossaries-user.html#dx1-3038" ><span -class="cmbx-10">1111</span></a>, <a -href="glossaries-user.html#dx1-7033" >1112</a>, <a -href="glossaries-user.html#dx1-11020" >1113</a>, <a -href="glossaries-user.html#dx1-11041" >1114</a>, <a -href="glossaries-user.html#dx1-11052" >1115</a>, <a -href="glossaries-user.html#dx1-11063" >1116</a>, <a -href="glossaries-user.html#dx1-11078" >1117</a>, <a -href="glossaries-user.html#dx1-11085" >1118</a>, <a -href="glossaries-user.html#dx1-11102" >1119</a>, <a -href="glossaries-user.html#dx1-16050" >1120</a>, <a -href="glossaries-user.html#dx1-16052" >1121</a>, <a -href="glossaries-user.html#dx1-16057" >1122</a>, <a -href="glossaries-user.html#dx1-16059" >1123</a>, <a -href="glossaries-user.html#dx1-18002" >1124</a>, <a -href="glossaries-user.html#dx1-18005" >1125</a>, <a -href="glossaries-user.html#dx1-18008" >1126</a>, <a -href="glossaries-user.html#dx1-63006" >1127</a> <br /></span> +href="glossaries-user.html#dx1-3049" ><span +class="cmbx-10">2784</span></a>, <a +href="glossaries-user.html#dx1-7038" >2785</a>, <a +href="glossaries-user.html#dx1-7046" >2786</a>, <a +href="glossaries-user.html#dx1-8040" >2787</a>, <a +href="glossaries-user.html#dx1-16050" >2788</a>, <a +href="glossaries-user.html#dx1-16052" >2789</a>, <a +href="glossaries-user.html#dx1-16057" >2790</a>, <a +href="glossaries-user.html#dx1-16059" >2791</a>, <a +href="glossaries-user.html#dx1-18002" >2792</a>, <a +href="glossaries-user.html#dx1-18006" >2793</a>, <a +href="glossaries-user.html#dx1-18009" >2794</a>, <a +href="glossaries-user.html#dx1-141006" >2795</a>, <a +href="glossaries-user.html#dx1-175014" >2796</a>, <a +href="glossaries-user.html#dx1-175018" >2797</a>, <a +href="glossaries-user.html#dx1-175040" >2798</a>, <a +href="glossaries-user.html#dx1-176010" >2799</a>, <a +href="glossaries-user.html#dx1-178001" >2800</a>, <a +href="glossaries-user.html#dx1-179011" >2801</a>, <a +href="glossaries-user.html#dx1-190009" >2802</a>, <a +href="glossaries-user.html#dx1-192003" >2803</a>, <a +href="glossaries-user.html#dx1-192014" >2804</a>, <a +href="glossaries-user.html#dx1-195002" >2805</a>, <a +href="glossaries-user.html#dx1-198004" >2806</a>, <a +href="glossaries-user.html#dx1-200004" >2807</a>, <a +href="glossaries-user.html#dx1-211007" >2808</a>, <a +href="glossaries-user.html#dx1-211014" >2809</a>, <a +href="glossaries-user.html#dx1-224044" >2810</a> <br /></span> <span class="index-item"><span class="cmtt-10">makeglossariesgui</span>  <a -href="glossaries-user.html#dx1-3036" ><span -class="cmbx-10">1128</span></a>, <a -href="glossaries-user.html#dx1-16055" >1129</a>, <a -href="glossaries-user.html#dx1-95001" >1130</a> <br /></span> +href="glossaries-user.html#dx1-3047" ><span +class="cmbx-10">2811</span></a>, <a +href="glossaries-user.html#dx1-16055" >2812</a>, <a +href="glossaries-user.html#dx1-227001" >2813</a> <br /></span> <span class="index-item"><span class="cmss-10">makeidx </span>package  <a -href="glossaries-user.html#dx1-29022" >1131</a> <br /></span> +href="glossaries-user.html#dx1-87009" >2814</a> <br /></span> <span class="index-item"><span class="cmtt-10">makeindex</span>  <a -href="glossaries-user.html#dx1-3025" >1132</a>, <a -href="glossaries-user.html#dx1-3035" >1133</a>, <a -href="glossaries-user.html#dx1-3040" >1134</a>, <a -href="glossaries-user.html#dx1-3041" ><span -class="cmbx-10">1135</span></a>, <a -href="glossaries-user.html#dx1-7001" >1136</a>, <a -href="glossaries-user.html#dx1-7003" >1137</a>, <a -href="glossaries-user.html#dx1-7004" >1138</a>, <a -href="glossaries-user.html#dx1-7005" >1139</a>, <a -href="glossaries-user.html#dx1-7008" >1140</a>, <a -href="glossaries-user.html#dx1-7013" >1141</a>, <a -href="glossaries-user.html#dx1-7026" >1142</a>, <a -href="glossaries-user.html#dx1-7027" >1143</a>, <a -href="glossaries-user.html#dx1-7030" >1144</a>, <a -href="glossaries-user.html#dx1-7031" >1145</a>, <a -href="glossaries-user.html#dx1-11009" >1146</a>, <a -href="glossaries-user.html#dx1-11010" >1147</a>, <a -href="glossaries-user.html#dx1-11011" >1148</a>, <a -href="glossaries-user.html#dx1-11035" >1149</a>, <a -href="glossaries-user.html#dx1-11042" >1150</a>, <a -href="glossaries-user.html#dx1-11050" >1151</a>, <a -href="glossaries-user.html#dx1-11053" >1152</a>, <a -href="glossaries-user.html#dx1-11064" >1153</a>, <a -href="glossaries-user.html#dx1-11073" >1154</a>, <a -href="glossaries-user.html#dx1-11093" >1155</a>, <a -href="glossaries-user.html#dx1-11099" >1156</a>, <a -href="glossaries-user.html#dx1-13002" >1157</a>, <a -href="glossaries-user.html#dx1-13005" >1158</a>, <a -href="glossaries-user.html#dx1-13035" >1159</a>, <a -href="glossaries-user.html#dx1-13037" >1160</a>, <a -href="glossaries-user.html#dx1-13040" >1161</a>, <a -href="glossaries-user.html#dx1-13044" >1162</a>, <a -href="glossaries-user.html#dx1-13046" >1163</a>, <a -href="glossaries-user.html#dx1-13051" >1164</a>, <a -href="glossaries-user.html#dx1-14052" >1165</a>, <a -href="glossaries-user.html#dx1-16004" >1166</a>, <a -href="glossaries-user.html#dx1-16007" >1167</a>, <a -href="glossaries-user.html#dx1-16009" >1168</a>, <a -href="glossaries-user.html#dx1-16016" >1169</a>, <a -href="glossaries-user.html#dx1-16025" >1170</a>, <a -href="glossaries-user.html#dx1-16033" >1171</a>, <a -href="glossaries-user.html#dx1-16036" >1172</a>, <a -href="glossaries-user.html#dx1-16039" >1173</a>, <a -href="glossaries-user.html#dx1-16041" >1174</a>, <a -href="glossaries-user.html#dx1-16043" >1175</a>, <a -href="glossaries-user.html#dx1-16048" >1176</a>, <a -href="glossaries-user.html#dx1-16054" >1177</a>, <a -href="glossaries-user.html#dx1-16060" >1178</a>, <a -href="glossaries-user.html#dx1-16063" >1179</a>, <a -href="glossaries-user.html#dx1-16066" >1180</a>, <a -href="glossaries-user.html#dx1-16071" >1181</a>, <a -href="glossaries-user.html#dx1-16077" >1182</a>, <a -href="glossaries-user.html#dx1-16082" >1183</a>, <a -href="glossaries-user.html#dx1-16083" >1184</a>, <a -href="glossaries-user.html#dx1-17004" >1185</a>, <a -href="glossaries-user.html#dx1-17010" >1186</a>, <a -href="glossaries-user.html#dx1-17021" >1187</a>, <a -href="glossaries-user.html#dx1-17024" >1188</a>, <a -href="glossaries-user.html#dx1-17028" >1189</a>, <a -href="glossaries-user.html#dx1-17029" >1190</a>, <a -href="glossaries-user.html#dx1-17030" >1191</a>, <a -href="glossaries-user.html#x1-200001.5.4" >1192</a>, <a -href="glossaries-user.html#dx1-20001" >1193</a>, <a -href="glossaries-user.html#dx1-20003" >1194</a>, <a -href="glossaries-user.html#dx1-20006" >1195</a>, <a -href="glossaries-user.html#dx1-20010" >1196</a>, <a -href="glossaries-user.html#dx1-20012" >1197</a>, <a -href="glossaries-user.html#dx1-20019" >1198</a>, <a -href="glossaries-user.html#dx1-20021" >1199</a>, <a -href="glossaries-user.html#dx1-21002" >1200</a>, <a -href="glossaries-user.html#dx1-21005" >1201</a>, <a -href="glossaries-user.html#dx1-21013" >1202</a>, <a -href="glossaries-user.html#dx1-23044" >1203</a>, <a -href="glossaries-user.html#dx1-23046" >1204</a>, <a -href="glossaries-user.html#dx1-23055" >1205</a>, <a -href="glossaries-user.html#dx1-23058" >1206</a>, <a -href="glossaries-user.html#dx1-25008" >1207</a>, <a -href="glossaries-user.html#dx1-25061" >1208</a>, <a -href="glossaries-user.html#dx1-25064" >1209</a>, <a -href="glossaries-user.html#dx1-26029" >1210</a>, <a -href="glossaries-user.html#dx1-26055" >1211</a>, <a -href="glossaries-user.html#dx1-26057" >1212</a>, <a -href="glossaries-user.html#dx1-26059" >1213</a>, <a -href="glossaries-user.html#dx1-26069" >1214</a>, <a -href="glossaries-user.html#dx1-26079" >1215</a>, <a -href="glossaries-user.html#dx1-26083" >1216</a>, <a -href="glossaries-user.html#dx1-26089" >1217</a>, <a -href="glossaries-user.html#dx1-26092" >1218</a>, <a -href="glossaries-user.html#dx1-33002" >1219</a>, <a -href="glossaries-user.html#dx1-33007" >1220</a>, <a -href="glossaries-user.html#dx1-41003" >1221</a>, <a -href="glossaries-user.html#dx1-49006" >1222</a>, <a -href="glossaries-user.html#dx1-50014" >1223</a>, <a -href="glossaries-user.html#dx1-50017" >1224</a>, <a -href="glossaries-user.html#dx1-51002" >1225</a>, <a -href="glossaries-user.html#dx1-51004" >1226</a>, <a -href="glossaries-user.html#dx1-51005" >1227</a>, <a -href="glossaries-user.html#dx1-51016" >1228</a>, <a -href="glossaries-user.html#dx1-51018" >1229</a>, <a -href="glossaries-user.html#dx1-51021" >1230</a>, <a -href="glossaries-user.html#dx1-52001" >1231</a>, <a -href="glossaries-user.html#dx1-52007" >1232</a>, <a -href="glossaries-user.html#dx1-53004" >1233</a>, <a -href="glossaries-user.html#dx1-53006" >1234</a>, <a -href="glossaries-user.html#dx1-54005" >1235</a>, <a -href="glossaries-user.html#dx1-54042" >1236</a>, <a -href="glossaries-user.html#dx1-54049" >1237</a>, <a -href="glossaries-user.html#dx1-62064" >1238</a>, <a -href="glossaries-user.html#dx1-63007" >1239</a>, <a -href="glossaries-user.html#dx1-63009" >1240</a>, <a -href="glossaries-user.html#dx1-68003" >1241</a>, <a -href="glossaries-user.html#dx1-78015" >1242</a>, <a -href="glossaries-user.html#dx1-85031" >1243</a>, <a -href="glossaries-user.html#dx1-88021" >1244</a>, <a -href="glossaries-user.html#dx1-61004" >1245</a> <br /></span> +href="glossaries-user.html#dx1-3004" >2815</a>, <a +href="glossaries-user.html#dx1-3036" >2816</a>, <a +href="glossaries-user.html#dx1-3046" >2817</a>, <a +href="glossaries-user.html#dx1-3051" >2818</a>, <a +href="glossaries-user.html#dx1-3053" ><span +class="cmbx-10">2819</span></a>, <a +href="glossaries-user.html#dx1-7005" >2820</a>, <a +href="glossaries-user.html#dx1-7007" >2821</a>, <a +href="glossaries-user.html#dx1-7008" >2822</a>, <a +href="glossaries-user.html#dx1-7009" >2823</a>, <a +href="glossaries-user.html#dx1-7012" >2824</a>, <a +href="glossaries-user.html#dx1-7015" >2825</a>, <a +href="glossaries-user.html#dx1-7030" >2826</a>, <a +href="glossaries-user.html#dx1-7032" >2827</a>, <a +href="glossaries-user.html#dx1-7033" >2828</a>, <a +href="glossaries-user.html#dx1-7034" >2829</a>, <a +href="glossaries-user.html#dx1-7035" >2830</a>, <a +href="glossaries-user.html#dx1-7040" >2831</a>, <a +href="glossaries-user.html#dx1-7043" >2832</a>, <a +href="glossaries-user.html#dx1-7044" >2833</a>, <a +href="glossaries-user.html#dx1-8056" >2834</a>, <a +href="glossaries-user.html#dx1-13002" >2835</a>, <a +href="glossaries-user.html#dx1-13005" >2836</a>, <a +href="glossaries-user.html#dx1-13032" >2837</a>, <a +href="glossaries-user.html#dx1-13034" >2838</a>, <a +href="glossaries-user.html#dx1-13037" >2839</a>, <a +href="glossaries-user.html#dx1-13041" >2840</a>, <a +href="glossaries-user.html#dx1-13043" >2841</a>, <a +href="glossaries-user.html#dx1-13048" >2842</a>, <a +href="glossaries-user.html#dx1-14054" >2843</a>, <a +href="glossaries-user.html#dx1-16005" >2844</a>, <a +href="glossaries-user.html#dx1-16008" >2845</a>, <a +href="glossaries-user.html#dx1-16010" >2846</a>, <a +href="glossaries-user.html#dx1-16015" >2847</a>, <a +href="glossaries-user.html#dx1-16024" >2848</a>, <a +href="glossaries-user.html#dx1-16032" >2849</a>, <a +href="glossaries-user.html#dx1-16035" >2850</a>, <a +href="glossaries-user.html#dx1-16038" >2851</a>, <a +href="glossaries-user.html#dx1-16040" >2852</a>, <a +href="glossaries-user.html#dx1-16042" >2853</a>, <a +href="glossaries-user.html#dx1-16047" >2854</a>, <a +href="glossaries-user.html#dx1-16054" >2855</a>, <a +href="glossaries-user.html#dx1-16060" >2856</a>, <a +href="glossaries-user.html#dx1-16063" >2857</a>, <a +href="glossaries-user.html#dx1-16066" >2858</a>, <a +href="glossaries-user.html#dx1-16071" >2859</a>, <a +href="glossaries-user.html#dx1-16080" >2860</a>, <a +href="glossaries-user.html#dx1-16085" >2861</a>, <a +href="glossaries-user.html#dx1-16086" >2862</a>, <a +href="glossaries-user.html#dx1-17004" >2863</a>, <a +href="glossaries-user.html#dx1-17010" >2864</a>, <a +href="glossaries-user.html#dx1-17021" >2865</a>, <a +href="glossaries-user.html#dx1-17024" >2866</a>, <a +href="glossaries-user.html#dx1-17028" >2867</a>, <a +href="glossaries-user.html#dx1-17029" >2868</a>, <a +href="glossaries-user.html#dx1-17030" >2869</a>, <a +href="glossaries-user.html#x1-200001.4.4" >2870</a>, <a +href="glossaries-user.html#dx1-20001" >2871</a>, <a +href="glossaries-user.html#dx1-20003" >2872</a>, <a +href="glossaries-user.html#dx1-20006" >2873</a>, <a +href="glossaries-user.html#dx1-20010" >2874</a>, <a +href="glossaries-user.html#dx1-20012" >2875</a>, <a +href="glossaries-user.html#dx1-20019" >2876</a>, <a +href="glossaries-user.html#dx1-20021" >2877</a>, <a +href="glossaries-user.html#dx1-21002" >2878</a>, <a +href="glossaries-user.html#dx1-22002" >2879</a>, <a +href="glossaries-user.html#dx1-22006" >2880</a>, <a +href="glossaries-user.html#dx1-22012" >2881</a>, <a +href="glossaries-user.html#dx1-22014" >2882</a>, <a +href="glossaries-user.html#dx1-22021" >2883</a>, <a +href="glossaries-user.html#dx1-31013" >2884</a>, <a +href="glossaries-user.html#dx1-31016" >2885</a>, <a +href="glossaries-user.html#dx1-46007" >2886</a>, <a +href="glossaries-user.html#dx1-55002" >2887</a>, <a +href="glossaries-user.html#dx1-55005" >2888</a>, <a +href="glossaries-user.html#dx1-63005" >2889</a>, <a +href="glossaries-user.html#dx1-63007" >2890</a>, <a +href="glossaries-user.html#dx1-67008" >2891</a>, <a +href="glossaries-user.html#dx1-73027" >2892</a>, <a +href="glossaries-user.html#dx1-75001" >2893</a>, <a +href="glossaries-user.html#dx1-75003" >2894</a>, <a +href="glossaries-user.html#dx1-75005" >2895</a>, <a +href="glossaries-user.html#dx1-76006" >2896</a>, <a +href="glossaries-user.html#dx1-79002" >2897</a>, <a +href="glossaries-user.html#dx1-79006" >2898</a>, <a +href="glossaries-user.html#dx1-79012" >2899</a>, <a +href="glossaries-user.html#dx1-79015" >2900</a>, <a +href="glossaries-user.html#dx1-111002" >2901</a>, <a +href="glossaries-user.html#dx1-111007" >2902</a>, <a +href="glossaries-user.html#dx1-119003" >2903</a>, <a +href="glossaries-user.html#dx1-127006" >2904</a>, <a +href="glossaries-user.html#dx1-128014" >2905</a>, <a +href="glossaries-user.html#dx1-128017" >2906</a>, <a +href="glossaries-user.html#dx1-129003" >2907</a>, <a +href="glossaries-user.html#dx1-129005" >2908</a>, <a +href="glossaries-user.html#dx1-129006" >2909</a>, <a +href="glossaries-user.html#dx1-129017" >2910</a>, <a +href="glossaries-user.html#dx1-129019" >2911</a>, <a +href="glossaries-user.html#dx1-129023" >2912</a>, <a +href="glossaries-user.html#dx1-130001" >2913</a>, <a +href="glossaries-user.html#dx1-130007" >2914</a>, <a +href="glossaries-user.html#dx1-131004" >2915</a>, <a +href="glossaries-user.html#dx1-131006" >2916</a>, <a +href="glossaries-user.html#dx1-132005" >2917</a>, <a +href="glossaries-user.html#dx1-132042" >2918</a>, <a +href="glossaries-user.html#dx1-132049" >2919</a>, <a +href="glossaries-user.html#dx1-132055" >2920</a>, <a +href="glossaries-user.html#dx1-140063" >2921</a>, <a +href="glossaries-user.html#dx1-141007" >2922</a>, <a +href="glossaries-user.html#dx1-141011" >2923</a>, <a +href="glossaries-user.html#dx1-146003" >2924</a>, <a +href="glossaries-user.html#dx1-156015" >2925</a>, <a +href="glossaries-user.html#dx1-163031" >2926</a>, <a +href="glossaries-user.html#dx1-166021" >2927</a>, <a +href="glossaries-user.html#dx1-175006" >2928</a>, <a +href="glossaries-user.html#dx1-175007" >2929</a>, <a +href="glossaries-user.html#dx1-175008" >2930</a>, <a +href="glossaries-user.html#dx1-175012" >2931</a>, <a +href="glossaries-user.html#dx1-175015" >2932</a>, <a +href="glossaries-user.html#dx1-175041" >2933</a>, <a +href="glossaries-user.html#dx1-176004" >2934</a>, <a +href="glossaries-user.html#dx1-176011" >2935</a>, <a +href="glossaries-user.html#dx1-176025" >2936</a>, <a +href="glossaries-user.html#dx1-176030" >2937</a>, <a +href="glossaries-user.html#dx1-188007" >2938</a>, <a +href="glossaries-user.html#dx1-190001" >2939</a>, <a +href="glossaries-user.html#dx1-190006" >2940</a>, <a +href="glossaries-user.html#dx1-190010" >2941</a>, <a +href="glossaries-user.html#dx1-192001" >2942</a>, <a +href="glossaries-user.html#dx1-192004" >2943</a>, <a +href="glossaries-user.html#dx1-192010" >2944</a>, <a +href="glossaries-user.html#dx1-194002" >2945</a>, <a +href="glossaries-user.html#dx1-198001" >2946</a>, <a +href="glossaries-user.html#dx1-198002" >2947</a>, <a +href="glossaries-user.html#dx1-198005" >2948</a>, <a +href="glossaries-user.html#dx1-198009" >2949</a>, <a +href="glossaries-user.html#dx1-198012" >2950</a>, <a +href="glossaries-user.html#dx1-198016" >2951</a>, <a +href="glossaries-user.html#dx1-200005" >2952</a>, <a +href="glossaries-user.html#dx1-200008" >2953</a>, <a +href="glossaries-user.html#dx1-200009" >2954</a>, <a +href="glossaries-user.html#dx1-210001" >2955</a>, <a +href="glossaries-user.html#dx1-210007" >2956</a>, <a +href="glossaries-user.html#dx1-214002" >2957</a>, <a +href="glossaries-user.html#dx1-214008" >2958</a>, <a +href="glossaries-user.html#dx1-214030" >2959</a>, <a +href="glossaries-user.html#dx1-220007" >2960</a>, <a +href="glossaries-user.html#dx1-220035" >2961</a>, <a +href="glossaries-user.html#dx1-139004" >2962</a>, <a +href="glossaries-user.html#dx1-190003" >2963</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-g</span>  <a -href="glossaries-user.html#dx1-7014" >1246</a>, <a -href="glossaries-user.html#dx1-13036" >1247</a>, <a -href="glossaries-user.html#dx1-13043" >1248</a> <br /></span> +href="glossaries-user.html#dx1-7016" >2964</a>, <a +href="glossaries-user.html#dx1-13033" >2965</a>, <a +href="glossaries-user.html#dx1-13040" >2966</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-l</span>  <a -href="glossaries-user.html#dx1-7029" >1249</a>, <a -href="glossaries-user.html#dx1-7035" >1250</a>, <a -href="glossaries-user.html#dx1-11065" >1251</a>, <a -href="glossaries-user.html#dx1-16086" >1252</a>, <a -href="glossaries-user.html#dx1-20009" >1253</a> <br /></span> +href="glossaries-user.html#dx1-7042" >2967</a>, <a +href="glossaries-user.html#dx1-7048" >2968</a>, <a +href="glossaries-user.html#dx1-16089" >2969</a>, <a +href="glossaries-user.html#dx1-20009" >2970</a>, <a +href="glossaries-user.html#dx1-200006" >2971</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\makenoidxglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-32001" ><span -class="cmti-10">1254</span></a> <br /></span> +href="glossaries-user.html#dx1-6001" >2972</a>, <a +href="glossaries-user.html#dx1-6004" >2973</a>, <a +href="glossaries-user.html#dx1-63002" >2974</a>, <a +href="glossaries-user.html#dx1-80002" >2975</a>, <a +href="glossaries-user.html#dx1-80004" >2976</a>, <a +href="glossaries-user.html#dx1-80007" >2977</a>, <a +href="glossaries-user.html#dx1-81003" >2978</a>, <a +href="glossaries-user.html#dx1-110001" ><span +class="cmti-10">2979</span></a>, <a +href="glossaries-user.html#dx1-138002" >2980</a>, <a +href="glossaries-user.html#dx1-141001" >2981</a>, <a +href="glossaries-user.html#dx1-141015" >2982</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\MakeTextUppercase</span></span></span>  <a +href="glossaries-user.html#dx1-42005" >2983</a>, <a +href="glossaries-user.html#dx1-184066" >2984</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\markboth</span></span></span>  <a +href="glossaries-user.html#dx1-41006" >2985</a> <br /></span> + + <span class="index-item"><span class="cmss-10">memoir </span>class  <a -href="glossaries-user.html#dx1-24021" >1255</a>, <a -href="glossaries-user.html#dx1-24031" >1256</a>, <a -href="glossaries-user.html#dx1-24033" >1257</a>, <a -href="glossaries-user.html#dx1-24015" >1258</a> <br /></span> +href="glossaries-user.html#dx1-42002" >2986</a>, <a +href="glossaries-user.html#dx1-42012" >2987</a>, <a +href="glossaries-user.html#dx1-42014" >2988</a>, <a +href="glossaries-user.html#dx1-41005" >2989</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\memUChead</span></span></span>  <a +href="glossaries-user.html#dx1-42015" >2990</a> <br /></span> <span class="index-item"><span class="cmss-10">mfirstuc </span>package  <a -href="glossaries-user.html#dx1-7" >1259</a>, <a -href="glossaries-user.html#dx1-13018" >1260</a>, <a -href="glossaries-user.html#dx1-13020" >1261</a>, <a -href="glossaries-user.html#dx1-34143" >1262</a>, <a -href="glossaries-user.html#dx1-55029" >1263</a>, <a -href="glossaries-user.html#dx1-55031" >1264</a>, <a -href="glossaries-user.html#dx1-55034" >1265</a>, <a -href="glossaries-user.html#dx1-55046" >1266</a> <br /></span> +href="glossaries-user.html#dx1-6" >2991</a>, <a +href="glossaries-user.html#dx1-13018" >2992</a>, <a +href="glossaries-user.html#dx1-112156" >2993</a>, <a +href="glossaries-user.html#dx1-133029" >2994</a>, <a +href="glossaries-user.html#dx1-133031" >2995</a>, <a +href="glossaries-user.html#dx1-133034" >2996</a>, <a +href="glossaries-user.html#dx1-133046" >2997</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\mfirstucMakeUppercase</span></span></span>  <a +href="glossaries-user.html#dx1-42007" >2998</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\midrule</span></span></span>  <a +href="glossaries-user.html#dx1-160013" >2999</a> <br /></span> <span class="index-item"><span class="cmss-10">multicol </span>package  <a -href="glossaries-user.html#dx1-86004" >1267</a> <br /></span> +href="glossaries-user.html#dx1-164004" >3000</a> <br /></span> <span class="index-item"><span class="cmss-10">mwe </span>package  <a -href="glossaries-user.html#dx1-12008" >1268</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-12010" >3001</a>, <a +href="glossaries-user.html#dx1-224027" >3002</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">N</span> <span class="index-item"><span class="cmss-10">nameref </span>package  <a -href="glossaries-user.html#dx1-24049" >1269</a> <br /></span> +href="glossaries-user.html#dx1-43014" >3003</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newabbreviation</span></span></span>  <a +href="glossaries-user.html#dx1-4008" >3004</a>, <a +href="glossaries-user.html#dx1-12012" >3005</a>, <a +href="glossaries-user.html#dx1-12016" >3006</a>, <a +href="glossaries-user.html#dx1-12020" >3007</a>, <a +href="glossaries-user.html#dx1-90022" >3008</a>, <a +href="glossaries-user.html#dx1-112138" >3009</a>, <a +href="glossaries-user.html#dx1-175023" >3010</a>, <a +href="glossaries-user.html#dx1-175025" >3011</a>, <a +href="glossaries-user.html#dx1-175036" >3012</a>, <a +href="glossaries-user.html#dx1-175038" >3013</a>, <a +href="glossaries-user.html#dx1-175045" >3014</a>, <a +href="glossaries-user.html#dx1-178030" >3015</a>, <a +href="glossaries-user.html#dx1-178032" >3016</a>, <a +href="glossaries-user.html#dx1-179016" >3017</a>, <a +href="glossaries-user.html#dx1-179050" >3018</a>, <a +href="glossaries-user.html#dx1-180006" >3019</a>, <a +href="glossaries-user.html#dx1-182031" >3020</a>, <a +href="glossaries-user.html#dx1-184048" >3021</a>, <a +href="glossaries-user.html#dx1-185015" >3022</a>, <a +href="glossaries-user.html#dx1-186005" >3023</a>, <a +href="glossaries-user.html#dx1-186006" >3024</a>, <a +href="glossaries-user.html#dx1-186030" >3025</a>, <a +href="glossaries-user.html#dx1-198006" >3026</a>, <a +href="glossaries-user.html#dx1-198026" >3027</a>, <a +href="glossaries-user.html#dx1-207008" >3028</a>, <a +href="glossaries-user.html#dx1-207009" >3029</a>, <a +href="glossaries-user.html#dx1-224041" >3030</a>, <a +href="glossaries-user.html#dx1-224047" >3031</a>, <a +href="glossaries-user.html#dx1-224048" >3032</a>, <a +href="glossaries-user.html#dx1-224050" >3033</a>, <a +href="glossaries-user.html#dx1-224068" >3034</a>, <a +href="glossaries-user.html#dx1-224074" >3035</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newabbreviationstyle</span></span></span>  <a +href="glossaries-user.html#dx1-184008" >3036</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newacronym</span></span></span>  <a -href="glossaries-user.html#dx1-69007" ><span -class="cmti-10">1270</span></a> <br /></span> +href="glossaries-user.html#dx1-12011" >3037</a>, <a +href="glossaries-user.html#dx1-12015" >3038</a>, <a +href="glossaries-user.html#dx1-12019" >3039</a>, <a +href="glossaries-user.html#dx1-90013" >3040</a>, <a +href="glossaries-user.html#dx1-90021" >3041</a>, <a +href="glossaries-user.html#dx1-96001" >3042</a>, <a +href="glossaries-user.html#dx1-97001" >3043</a>, <a +href="glossaries-user.html#dx1-98001" >3044</a>, <a +href="glossaries-user.html#dx1-99001" >3045</a>, <a +href="glossaries-user.html#dx1-100001" >3046</a>, <a +href="glossaries-user.html#dx1-112101" >3047</a>, <a +href="glossaries-user.html#dx1-112137" >3048</a>, <a +href="glossaries-user.html#dx1-117004" >3049</a>, <a +href="glossaries-user.html#dx1-122018" >3050</a>, <a +href="glossaries-user.html#dx1-124002" >3051</a>, <a +href="glossaries-user.html#dx1-132002" >3052</a>, <a +href="glossaries-user.html#dx1-133016" >3053</a>, <a +href="glossaries-user.html#dx1-135049" >3054</a>, <a +href="glossaries-user.html#dx1-138013" >3055</a>, <a +href="glossaries-user.html#dx1-147006" ><span +class="cmti-10">3056</span></a>, <a +href="glossaries-user.html#dx1-147035" >3057</a>, <a +href="glossaries-user.html#dx1-147040" >3058</a>, <a +href="glossaries-user.html#dx1-147056" >3059</a>, <a +href="glossaries-user.html#dx1-147063" >3060</a>, <a +href="glossaries-user.html#dx1-147067" >3061</a>, <a +href="glossaries-user.html#dx1-147074" >3062</a>, <a +href="glossaries-user.html#dx1-149045" >3063</a>, <a +href="glossaries-user.html#dx1-149063" >3064</a>, <a +href="glossaries-user.html#dx1-149077" >3065</a>, <a +href="glossaries-user.html#dx1-150007" >3066</a>, <a +href="glossaries-user.html#dx1-150023" >3067</a>, <a +href="glossaries-user.html#dx1-150083" >3068</a>, <a +href="glossaries-user.html#dx1-152006" >3069</a>, <a +href="glossaries-user.html#dx1-154002" >3070</a>, <a +href="glossaries-user.html#dx1-169017" >3071</a>, <a +href="glossaries-user.html#dx1-169020" >3072</a>, <a +href="glossaries-user.html#dx1-172033" >3073</a>, <a +href="glossaries-user.html#dx1-172036" >3074</a>, <a +href="glossaries-user.html#dx1-172039" >3075</a>, <a +href="glossaries-user.html#dx1-172042" >3076</a>, <a +href="glossaries-user.html#dx1-172061" >3077</a>, <a +href="glossaries-user.html#dx1-178006" >3078</a>, <a +href="glossaries-user.html#dx1-178025" >3079</a>, <a +href="glossaries-user.html#dx1-178029" >3080</a>, <a +href="glossaries-user.html#dx1-179017" >3081</a>, <a +href="glossaries-user.html#dx1-179034" >3082</a>, <a +href="glossaries-user.html#dx1-179047" >3083</a>, <a +href="glossaries-user.html#dx1-180002" >3084</a>, <a +href="glossaries-user.html#dx1-180005" >3085</a>, <a +href="glossaries-user.html#dx1-182028" >3086</a>, <a +href="glossaries-user.html#dx1-182032" >3087</a>, <a +href="glossaries-user.html#dx1-184049" >3088</a>, <a +href="glossaries-user.html#dx1-186004" >3089</a>, <a +href="glossaries-user.html#dx1-186007" >3090</a>, <a +href="glossaries-user.html#dx1-198023" >3091</a>, <a +href="glossaries-user.html#dx1-198025" >3092</a>, <a +href="glossaries-user.html#dx1-207005" >3093</a>, <a +href="glossaries-user.html#dx1-207006" >3094</a>, <a +href="glossaries-user.html#dx1-207007" >3095</a>, <a +href="glossaries-user.html#dx1-224014" >3096</a>, <a +href="glossaries-user.html#dx1-224040" >3097</a>, <a +href="glossaries-user.html#dx1-224046" >3098</a>, <a +href="glossaries-user.html#dx1-224058" >3099</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newacronymstyle</span></span></span>  <a -href="glossaries-user.html#dx1-72001" ><span -class="cmti-10">1271</span></a> <br /></span> +href="glossaries-user.html#dx1-150001" ><span +class="cmti-10">3100</span></a>, <a +href="glossaries-user.html#dx1-150044" >3101</a>, <a +href="glossaries-user.html#dx1-150047" >3102</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newdualentry</span></span></span>  <a +href="glossaries-user.html#dx1-137017" >3103</a>, <a +href="glossaries-user.html#dx1-193001" >3104</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newglossary</span></span></span>  <a -href="glossaries-user.html#dx1-68001" ><span -class="cmti-10">1272</span></a> <br /></span> +href="glossaries-user.html#dx1-19020" >3105</a>, <a +href="glossaries-user.html#dx1-20017" >3106</a>, <a +href="glossaries-user.html#dx1-84007" >3107</a>, <a +href="glossaries-user.html#dx1-144005" >3108</a>, <a +href="glossaries-user.html#dx1-144042" >3109</a>, <a +href="glossaries-user.html#dx1-146001" ><span +class="cmti-10">3110</span></a>, <a +href="glossaries-user.html#dx1-192009" >3111</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newglossary*</span></span></span>  <a -href="glossaries-user.html#dx1-68007" ><span -class="cmti-10">1273</span></a> <br /></span> +href="glossaries-user.html#dx1-146007" ><span +class="cmti-10">3112</span></a>, <a +href="glossaries-user.html#dx1-176016" >3113</a>, <a +href="glossaries-user.html#dx1-176024" >3114</a>, <a +href="glossaries-user.html#dx1-192015" >3115</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newglossaryentry</span></span></span>  <a -href="glossaries-user.html#dx1-34003" ><span -class="cmti-10">1274</span></a> <br /></span> +href="glossaries-user.html#dx1-3033" >3116</a>, <a +href="glossaries-user.html#dx1-5003" >3117</a>, <a +href="glossaries-user.html#dx1-6012" >3118</a>, <a +href="glossaries-user.html#dx1-56004" >3119</a>, <a +href="glossaries-user.html#dx1-73007" >3120</a>, <a +href="glossaries-user.html#dx1-73033" >3121</a>, <a +href="glossaries-user.html#dx1-87002" >3122</a>, <a +href="glossaries-user.html#dx1-112001" >3123</a>, <a +href="glossaries-user.html#dx1-112003" ><span +class="cmti-10">3124</span></a>, <a +href="glossaries-user.html#dx1-112122" >3125</a>, <a +href="glossaries-user.html#dx1-116002" >3126</a>, <a +href="glossaries-user.html#dx1-122002" >3127</a>, <a +href="glossaries-user.html#dx1-122006" >3128</a>, <a +href="glossaries-user.html#dx1-122031" >3129</a>, <a +href="glossaries-user.html#dx1-124001" >3130</a>, <a +href="glossaries-user.html#dx1-132001" >3131</a>, <a +href="glossaries-user.html#dx1-133015" >3132</a>, <a +href="glossaries-user.html#dx1-133052" >3133</a>, <a +href="glossaries-user.html#dx1-147007" >3134</a>, <a +href="glossaries-user.html#dx1-147014" >3135</a>, <a +href="glossaries-user.html#dx1-147020" >3136</a>, <a +href="glossaries-user.html#dx1-147036" >3137</a>, <a +href="glossaries-user.html#dx1-150008" >3138</a>, <a +href="glossaries-user.html#dx1-154001" >3139</a>, <a +href="glossaries-user.html#dx1-171002" >3140</a>, <a +href="glossaries-user.html#dx1-180001" >3141</a>, <a +href="glossaries-user.html#dx1-183019" >3142</a>, <a +href="glossaries-user.html#dx1-189013" >3143</a>, <a +href="glossaries-user.html#dx1-189029" >3144</a>, <a +href="glossaries-user.html#dx1-189045" >3145</a>, <a +href="glossaries-user.html#dx1-198021" >3146</a>, <a +href="glossaries-user.html#dx1-200014" >3147</a>, <a +href="glossaries-user.html#dx1-224013" >3148</a> <br /></span> <span class="index-item"><span class="cmtt-10">\newglossaryentry </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">access</span>  <a -href="glossaries-user.html#dx1-94003" >1275</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">description</span>  <a -href="glossaries-user.html#dx1-12009" >1276</a>, <a -href="glossaries-user.html#dx1-34011" >1277</a>, <a -href="glossaries-user.html#dx1-34014" >1278</a>, <a -href="glossaries-user.html#dx1-34021" >1279</a>, <a -href="glossaries-user.html#dx1-34027" >1280</a>, <a -href="glossaries-user.html#dx1-34137" >1281</a>, <a -href="glossaries-user.html#dx1-39008" >1282</a>, <a -href="glossaries-user.html#dx1-40002" >1283</a>, <a -href="glossaries-user.html#dx1-40012" >1284</a>, <a -href="glossaries-user.html#dx1-56051" >1285</a>, <a -href="glossaries-user.html#dx1-69022" >1286</a>, <a -href="glossaries-user.html#dx1-71026" >1287</a>, <a -href="glossaries-user.html#dx1-71043" >1288</a>, <a -href="glossaries-user.html#dx1-71071" >1289</a>, <a -href="glossaries-user.html#dx1-72029" >1290</a>, <a -href="glossaries-user.html#dx1-91022" >1291</a>, <a -href="glossaries-user.html#dx1-91024" >1292</a>, <a -href="glossaries-user.html#dx1-94018" >1293</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">descriptionaccess</span>  <a -href="glossaries-user.html#dx1-94017" >1294</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">descriptionplural</span>  <a -href="glossaries-user.html#dx1-34026" >1295</a>, <a -href="glossaries-user.html#dx1-40003" >1296</a>, <a -href="glossaries-user.html#dx1-40013" >1297</a>, <a -href="glossaries-user.html#dx1-94020" >1298</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">descriptionpluralaccess</span>  <a -href="glossaries-user.html#dx1-94019" >1299</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">entrycounter</span>  <a -href="glossaries-user.html#dx1-63035" >1300</a>, <a -href="glossaries-user.html#dx1-63037" >1301</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">first</span>  <a -href="glossaries-user.html#dx1-3020" >1302</a>, <a -href="glossaries-user.html#dx1-34031" >1303</a>, <a -href="glossaries-user.html#dx1-34049" >1304</a>, <a -href="glossaries-user.html#dx1-34051" >1305</a>, <a -href="glossaries-user.html#dx1-34052" >1306</a>, <a -href="glossaries-user.html#dx1-34060" >1307</a>, <a -href="glossaries-user.html#dx1-34063" >1308</a>, <a -href="glossaries-user.html#dx1-34133" >1309</a>, <a -href="glossaries-user.html#dx1-54032" >1310</a>, <a -href="glossaries-user.html#dx1-55014" >1311</a>, <a -href="glossaries-user.html#dx1-56014" >1312</a>, <a -href="glossaries-user.html#dx1-56018" >1313</a>, <a -href="glossaries-user.html#dx1-56042" >1314</a>, <a -href="glossaries-user.html#dx1-57040" >1315</a>, <a -href="glossaries-user.html#dx1-57045" >1316</a>, <a -href="glossaries-user.html#dx1-57057" >1317</a>, <a -href="glossaries-user.html#dx1-57060" >1318</a>, <a -href="glossaries-user.html#dx1-62011" >1319</a>, <a -href="glossaries-user.html#dx1-62022" >1320</a>, <a -href="glossaries-user.html#dx1-69044" >1321</a>, <a -href="glossaries-user.html#dx1-70002" >1322</a>, <a -href="glossaries-user.html#dx1-75001" >1323</a>, <a -href="glossaries-user.html#dx1-92005" >1324</a>, <a -href="glossaries-user.html#dx1-93008" >1325</a>, <a -href="glossaries-user.html#dx1-94008" >1326</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">firstaccess</span>  <a -href="glossaries-user.html#dx1-94007" >1327</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">firstplural</span>  <a -href="glossaries-user.html#dx1-3021" >1328</a>, <a -href="glossaries-user.html#dx1-34039" >1329</a>, <a -href="glossaries-user.html#dx1-34046" >1330</a>, <a -href="glossaries-user.html#dx1-34057" >1331</a>, <a -href="glossaries-user.html#dx1-34059" >1332</a>, <a -href="glossaries-user.html#dx1-34062" >1333</a>, <a -href="glossaries-user.html#dx1-35005" >1334</a>, <a -href="glossaries-user.html#dx1-40011" >1335</a>, <a -href="glossaries-user.html#dx1-55051" >1336</a>, <a -href="glossaries-user.html#dx1-56019" >1337</a>, <a -href="glossaries-user.html#dx1-56034" >1338</a>, <a -href="glossaries-user.html#dx1-57048" >1339</a>, <a -href="glossaries-user.html#dx1-57058" >1340</a>, <a -href="glossaries-user.html#dx1-57062" >1341</a>, <a -href="glossaries-user.html#dx1-62025" >1342</a>, <a -href="glossaries-user.html#dx1-69029" >1343</a>, <a -href="glossaries-user.html#dx1-93011" >1344</a>, <a -href="glossaries-user.html#dx1-94012" >1345</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">firstpluralaccess</span>  <a -href="glossaries-user.html#dx1-94011" >1346</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">format</span>  <a -href="glossaries-user.html#dx1-54068" >1347</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">long</span>  <a -href="glossaries-user.html#dx1-23117" >1348</a>, <a -href="glossaries-user.html#dx1-34128" >1349</a>, <a -href="glossaries-user.html#dx1-34135" >1350</a>, <a -href="glossaries-user.html#dx1-39005" >1351</a>, <a -href="glossaries-user.html#dx1-54034" >1352</a>, <a -href="glossaries-user.html#dx1-55019" >1353</a>, <a -href="glossaries-user.html#dx1-57042" >1354</a>, <a -href="glossaries-user.html#dx1-57051" >1355</a>, <a -href="glossaries-user.html#dx1-69011" >1356</a>, <a -href="glossaries-user.html#dx1-69066" >1357</a>, <a -href="glossaries-user.html#dx1-70005" >1358</a>, <a -href="glossaries-user.html#dx1-91016" >1359</a>, <a -href="glossaries-user.html#dx1-94022" >1360</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">longaccess</span>  <a -href="glossaries-user.html#dx1-94021" >1361</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">longplural</span>  <a -href="glossaries-user.html#dx1-15007" >1362</a>, <a -href="glossaries-user.html#dx1-34129" >1363</a>, <a -href="glossaries-user.html#dx1-40020" >1364</a>, <a -href="glossaries-user.html#dx1-55053" >1365</a>, <a -href="glossaries-user.html#dx1-57053" >1366</a>, <a -href="glossaries-user.html#dx1-69012" >1367</a>, <a -href="glossaries-user.html#dx1-69024" >1368</a>, <a -href="glossaries-user.html#dx1-69025" >1369</a>, <a -href="glossaries-user.html#dx1-69030" >1370</a>, <a -href="glossaries-user.html#dx1-69073" >1371</a>, <a -href="glossaries-user.html#dx1-94028" >1372</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">longpluralaccess</span>  <a -href="glossaries-user.html#dx1-94027" >1373</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">name</span>  <a -href="glossaries-user.html#dx1-12006" >1374</a>, <a -href="glossaries-user.html#dx1-12011" >1375</a>, <a -href="glossaries-user.html#dx1-12012" >1376</a>, <a -href="glossaries-user.html#dx1-16002" >1377</a>, <a -href="glossaries-user.html#dx1-26009" >1378</a>, <a -href="glossaries-user.html#dx1-26028" >1379</a>, <a -href="glossaries-user.html#dx1-26046" >1380</a>, <a -href="glossaries-user.html#dx1-34012" >1381</a>, <a -href="glossaries-user.html#dx1-34017" >1382</a>, <a -href="glossaries-user.html#dx1-34019" >1383</a>, <a -href="glossaries-user.html#dx1-34030" >1384</a>, <a -href="glossaries-user.html#dx1-34073" >1385</a>, <a -href="glossaries-user.html#dx1-34077" >1386</a>, <a -href="glossaries-user.html#dx1-34080" >1387</a>, <a -href="glossaries-user.html#dx1-34086" >1388</a>, <a -href="glossaries-user.html#dx1-34088" >1389</a>, <a -href="glossaries-user.html#dx1-34094" >1390</a>, <a -href="glossaries-user.html#dx1-40001" >1391</a>, <a -href="glossaries-user.html#dx1-43001" >1392</a>, <a -href="glossaries-user.html#dx1-55042" >1393</a>, <a -href="glossaries-user.html#dx1-55043" >1394</a>, <a -href="glossaries-user.html#dx1-56039" >1395</a>, <a -href="glossaries-user.html#dx1-62009" >1396</a>, <a -href="glossaries-user.html#dx1-70009" >1397</a>, <a -href="glossaries-user.html#dx1-71057" >1398</a>, <a -href="glossaries-user.html#dx1-71060" >1399</a>, <a -href="glossaries-user.html#dx1-71070" >1400</a>, <a -href="glossaries-user.html#dx1-71077" >1401</a>, <a -href="glossaries-user.html#dx1-71079" >1402</a>, <a -href="glossaries-user.html#dx1-71084" >1403</a>, <a -href="glossaries-user.html#dx1-72065" >1404</a>, <a -href="glossaries-user.html#dx1-88023" >1405</a>, <a -href="glossaries-user.html#dx1-92003" >1406</a>, <a -href="glossaries-user.html#dx1-94004" >1407</a>, <a -href="glossaries-user.html#dx1-61014" >1408</a>, <a -href="glossaries-user.html#dx1-62055" >1409</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">nonumberlist</span>  <a -href="glossaries-user.html#dx1-34107" >1410</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">parent</span>  <a -href="glossaries-user.html#dx1-34013" >1411</a>, <a -href="glossaries-user.html#dx1-34018" >1412</a>, <a -href="glossaries-user.html#dx1-34025" >1413</a>, <a -href="glossaries-user.html#dx1-42001" >1414</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">plural</span>  <a -href="glossaries-user.html#dx1-15006" >1415</a>, <a -href="glossaries-user.html#dx1-34041" >1416</a>, <a -href="glossaries-user.html#dx1-34048" >1417</a>, <a -href="glossaries-user.html#dx1-34061" >1418</a>, <a -href="glossaries-user.html#dx1-35002" >1419</a>, <a -href="glossaries-user.html#dx1-35004" >1420</a>, <a -href="glossaries-user.html#dx1-43008" >1421</a>, <a -href="glossaries-user.html#dx1-55050" >1422</a>, <a -href="glossaries-user.html#dx1-56026" >1423</a>, <a -href="glossaries-user.html#dx1-56029" >1424</a>, <a -href="glossaries-user.html#dx1-57047" >1425</a>, <a -href="glossaries-user.html#dx1-57056" >1426</a>, <a -href="glossaries-user.html#dx1-62019" >1427</a>, <a -href="glossaries-user.html#dx1-69028" >1428</a>, <a -href="glossaries-user.html#dx1-92004" >1429</a>, <a -href="glossaries-user.html#dx1-93006" >1430</a>, <a -href="glossaries-user.html#dx1-94010" >1431</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">pluralaccess</span>  <a -href="glossaries-user.html#dx1-94009" >1432</a> <br /></span> +class="cmtt-10">access</span>  <a +href="glossaries-user.html#dx1-172013" >3149</a>, <a +href="glossaries-user.html#dx1-224015" >3150</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">alias</span>  <a +href="glossaries-user.html#dx1-11093" >3151</a>, <a +href="glossaries-user.html#dx1-12027" >3152</a>, <a +href="glossaries-user.html#dx1-112134" >3153</a>, <a +href="glossaries-user.html#dx1-179032" >3154</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">category</span>  <a +href="glossaries-user.html#dx1-12013" >3155</a>, <a +href="glossaries-user.html#dx1-12017" >3156</a>, <a +href="glossaries-user.html#dx1-12021" >3157</a>, <a +href="glossaries-user.html#dx1-112136" >3158</a>, <a +href="glossaries-user.html#dx1-185001" >3159</a>, <a +href="glossaries-user.html#dx1-185003" >3160</a>, <a +href="glossaries-user.html#dx1-186008" >3161</a>, <a +href="glossaries-user.html#dx1-186009" >3162</a>, <a +href="glossaries-user.html#dx1-202020" >3163</a>, <a +href="glossaries-user.html#dx1-202030" >3164</a>, <a +href="glossaries-user.html#dx1-202090" >3165</a>, <a +href="glossaries-user.html#dx1-202092" >3166</a>, <a +href="glossaries-user.html#dx1-202096" >3167</a>, <a +href="glossaries-user.html#dx1-202098" >3168</a>, <a +href="glossaries-user.html#dx1-207002" >3169</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">description</span>  <a +href="glossaries-user.html#dx1-12014" >3170</a>, <a +href="glossaries-user.html#dx1-112010" >3171</a>, <a +href="glossaries-user.html#dx1-112013" >3172</a>, <a +href="glossaries-user.html#dx1-112020" >3173</a>, <a +href="glossaries-user.html#dx1-112027" >3174</a>, <a +href="glossaries-user.html#dx1-112150" >3175</a>, <a +href="glossaries-user.html#dx1-117008" >3176</a>, <a +href="glossaries-user.html#dx1-118002" >3177</a>, <a +href="glossaries-user.html#dx1-118012" >3178</a>, <a +href="glossaries-user.html#dx1-134051" >3179</a>, <a +href="glossaries-user.html#dx1-147021" >3180</a>, <a +href="glossaries-user.html#dx1-149027" >3181</a>, <a +href="glossaries-user.html#dx1-149044" >3182</a>, <a +href="glossaries-user.html#dx1-149072" >3183</a>, <a +href="glossaries-user.html#dx1-150029" >3184</a>, <a +href="glossaries-user.html#dx1-169022" >3185</a>, <a +href="glossaries-user.html#dx1-169024" >3186</a>, <a +href="glossaries-user.html#dx1-172028" >3187</a>, <a +href="glossaries-user.html#dx1-179077" >3188</a>, <a +href="glossaries-user.html#dx1-197012" >3189</a>, <a +href="glossaries-user.html#dx1-197015" >3190</a>, <a +href="glossaries-user.html#dx1-202068" >3191</a>, <a +href="glossaries-user.html#dx1-225002" >3192</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">descriptionaccess</span>  <a +href="glossaries-user.html#dx1-172027" >3193</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">descriptionplural</span>  <a +href="glossaries-user.html#dx1-112026" >3194</a>, <a +href="glossaries-user.html#dx1-118003" >3195</a>, <a +href="glossaries-user.html#dx1-118013" >3196</a>, <a +href="glossaries-user.html#dx1-172030" >3197</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">descriptionpluralaccess</span>  <a +href="glossaries-user.html#dx1-172029" >3198</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">entrycounter</span>  <a +href="glossaries-user.html#dx1-141037" >3199</a>, <a +href="glossaries-user.html#dx1-141039" >3200</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">first</span>  <a +href="glossaries-user.html#dx1-3031" >3201</a>, <a +href="glossaries-user.html#dx1-112031" >3202</a>, <a +href="glossaries-user.html#dx1-112049" >3203</a>, <a +href="glossaries-user.html#dx1-112051" >3204</a>, <a +href="glossaries-user.html#dx1-112052" >3205</a>, <a +href="glossaries-user.html#dx1-112060" >3206</a>, <a +href="glossaries-user.html#dx1-112063" >3207</a>, <a +href="glossaries-user.html#dx1-112146" >3208</a>, <a +href="glossaries-user.html#dx1-132032" >3209</a>, <a +href="glossaries-user.html#dx1-133014" >3210</a>, <a +href="glossaries-user.html#dx1-134014" >3211</a>, <a +href="glossaries-user.html#dx1-134018" >3212</a>, <a +href="glossaries-user.html#dx1-134042" >3213</a>, <a +href="glossaries-user.html#dx1-135040" >3214</a>, <a +href="glossaries-user.html#dx1-135045" >3215</a>, <a +href="glossaries-user.html#dx1-135057" >3216</a>, <a +href="glossaries-user.html#dx1-135060" >3217</a>, <a +href="glossaries-user.html#dx1-140010" >3218</a>, <a +href="glossaries-user.html#dx1-140021" >3219</a>, <a +href="glossaries-user.html#dx1-147045" >3220</a>, <a +href="glossaries-user.html#dx1-148002" >3221</a>, <a +href="glossaries-user.html#dx1-153001" >3222</a>, <a +href="glossaries-user.html#dx1-170008" >3223</a>, <a +href="glossaries-user.html#dx1-171008" >3224</a>, <a +href="glossaries-user.html#dx1-172018" >3225</a>, <a +href="glossaries-user.html#dx1-172085" >3226</a>, <a +href="glossaries-user.html#dx1-180003" >3227</a>, <a +href="glossaries-user.html#dx1-224079" >3228</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">firstaccess</span>  <a +href="glossaries-user.html#dx1-172017" >3229</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">firstplural</span>  <a +href="glossaries-user.html#dx1-3032" >3230</a>, <a +href="glossaries-user.html#dx1-112039" >3231</a>, <a +href="glossaries-user.html#dx1-112046" >3232</a>, <a +href="glossaries-user.html#dx1-112057" >3233</a>, <a +href="glossaries-user.html#dx1-112059" >3234</a>, <a +href="glossaries-user.html#dx1-112062" >3235</a>, <a +href="glossaries-user.html#dx1-113005" >3236</a>, <a +href="glossaries-user.html#dx1-118011" >3237</a>, <a +href="glossaries-user.html#dx1-133051" >3238</a>, <a +href="glossaries-user.html#dx1-134019" >3239</a>, <a +href="glossaries-user.html#dx1-134034" >3240</a>, <a +href="glossaries-user.html#dx1-135048" >3241</a>, <a +href="glossaries-user.html#dx1-135058" >3242</a>, <a +href="glossaries-user.html#dx1-135062" >3243</a>, <a +href="glossaries-user.html#dx1-140024" >3244</a>, <a +href="glossaries-user.html#dx1-147028" >3245</a>, <a +href="glossaries-user.html#dx1-171011" >3246</a>, <a +href="glossaries-user.html#dx1-172022" >3247</a>, <a +href="glossaries-user.html#dx1-172084" >3248</a>, <a +href="glossaries-user.html#dx1-224080" >3249</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">firstpluralaccess</span>  <a +href="glossaries-user.html#dx1-172021" >3250</a> <br /></span> <span class="index-subitem">    <span -class="cmss-10">prefix</span>  <a -href="glossaries-user.html#dx1-93003" >1433</a>, <a -href="glossaries-user.html#dx1-93009" >1434</a>, <a -href="glossaries-user.html#dx1-93021" >1435</a>, <a -href="glossaries-user.html#dx1-93024" >1436</a>, <a -href="glossaries-user.html#dx1-93041" >1437</a>, <a -href="glossaries-user.html#dx1-93049" >1438</a>, <a -href="glossaries-user.html#dx1-93016" >1439</a> <br /></span> - - -<span class="index-subitem">    <span -class="cmss-10">prefixfirst</span>  <a -href="glossaries-user.html#dx1-93007" >1440</a>, <a -href="glossaries-user.html#dx1-93022" >1441</a>, <a -href="glossaries-user.html#dx1-93025" >1442</a>, <a -href="glossaries-user.html#dx1-93045" >1443</a>, <a -href="glossaries-user.html#dx1-93051" >1444</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">prefixfirstplural</span>  <a -href="glossaries-user.html#dx1-93010" >1445</a>, <a -href="glossaries-user.html#dx1-93031" >1446</a>, <a -href="glossaries-user.html#dx1-93034" >1447</a>, <a -href="glossaries-user.html#dx1-93047" >1448</a>, <a -href="glossaries-user.html#dx1-93055" >1449</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">prefixplural</span>  <a -href="glossaries-user.html#dx1-93005" >1450</a>, <a -href="glossaries-user.html#dx1-93012" >1451</a>, <a -href="glossaries-user.html#dx1-93030" >1452</a>, <a -href="glossaries-user.html#dx1-93033" >1453</a>, <a -href="glossaries-user.html#dx1-93043" >1454</a>, <a -href="glossaries-user.html#dx1-93053" >1455</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">see</span>  <a -href="glossaries-user.html#dx1-23018" >1456</a>, <a -href="glossaries-user.html#dx1-23022" >1457</a>, <a -href="glossaries-user.html#dx1-23023" >1458</a>, <a -href="glossaries-user.html#dx1-25071" >1459</a>, <a -href="glossaries-user.html#dx1-25075" >1460</a>, <a -href="glossaries-user.html#dx1-34112" >1461</a>, <a -href="glossaries-user.html#dx1-34113" >1462</a>, <a -href="glossaries-user.html#dx1-34120" >1463</a>, <a -href="glossaries-user.html#dx1-34124" >1464</a>, <a -href="glossaries-user.html#dx1-34125" >1465</a>, <a -href="glossaries-user.html#dx1-34126" >1466</a>, <a -href="glossaries-user.html#dx1-47016" >1467</a>, <a -href="glossaries-user.html#dx1-60009" >1468</a>, <a -href="glossaries-user.html#dx1-60010" >1469</a>, <a -href="glossaries-user.html#dx1-60012" >1470</a>, <a -href="glossaries-user.html#dx1-60023" >1471</a>, <a -href="glossaries-user.html#dx1-61001" >1472</a>, <a -href="glossaries-user.html#dx1-4003" >1473</a>, <a -href="glossaries-user.html#dx1-61007" >1474</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">short</span>  <a -href="glossaries-user.html#dx1-34130" >1475</a>, <a -href="glossaries-user.html#dx1-34134" >1476</a>, <a -href="glossaries-user.html#dx1-54033" >1477</a>, <a -href="glossaries-user.html#dx1-55020" >1478</a>, <a -href="glossaries-user.html#dx1-57043" >1479</a>, <a -href="glossaries-user.html#dx1-57052" >1480</a>, <a -href="glossaries-user.html#dx1-69013" >1481</a>, <a -href="glossaries-user.html#dx1-69055" >1482</a>, <a -href="glossaries-user.html#dx1-70006" >1483</a>, <a -href="glossaries-user.html#dx1-91019" >1484</a>, <a -href="glossaries-user.html#dx1-94025" >1485</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">shortaccess</span>  <a -href="glossaries-user.html#dx1-94024" >1486</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">shortplural</span>  <a -href="glossaries-user.html#dx1-15008" >1487</a>, <a -href="glossaries-user.html#dx1-34131" >1488</a>, <a -href="glossaries-user.html#dx1-40021" >1489</a>, <a -href="glossaries-user.html#dx1-55054" >1490</a>, <a -href="glossaries-user.html#dx1-57054" >1491</a>, <a -href="glossaries-user.html#dx1-69014" >1492</a>, <a -href="glossaries-user.html#dx1-69023" >1493</a>, <a -href="glossaries-user.html#dx1-69026" >1494</a>, <a -href="glossaries-user.html#dx1-69032" >1495</a>, <a -href="glossaries-user.html#dx1-69034" >1496</a>, <a -href="glossaries-user.html#dx1-69062" >1497</a>, <a -href="glossaries-user.html#dx1-94031" >1498</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">shortpluralaccess</span>  <a -href="glossaries-user.html#dx1-94030" >1499</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">sort</span>  <a -href="glossaries-user.html#dx1-3050" >1500</a>, <a -href="glossaries-user.html#dx1-6007" >1501</a>, <a -href="glossaries-user.html#dx1-8010" >1502</a>, <a -href="glossaries-user.html#dx1-13048" >1503</a>, <a -href="glossaries-user.html#dx1-16001" >1504</a>, <a -href="glossaries-user.html#dx1-26007" >1505</a>, <a -href="glossaries-user.html#dx1-26010" >1506</a>, <a -href="glossaries-user.html#dx1-26012" >1507</a>, <a -href="glossaries-user.html#dx1-26014" >1508</a>, <a -href="glossaries-user.html#dx1-26027" >1509</a>, <a -href="glossaries-user.html#dx1-34020" >1510</a>, <a -href="glossaries-user.html#dx1-34072" >1511</a>, <a -href="glossaries-user.html#dx1-34076" >1512</a>, <a -href="glossaries-user.html#dx1-34078" >1513</a>, <a -href="glossaries-user.html#dx1-34081" >1514</a>, <a -href="glossaries-user.html#dx1-34085" >1515</a>, <a -href="glossaries-user.html#dx1-34091" >1516</a>, <a -href="glossaries-user.html#dx1-34093" >1517</a>, <a -href="glossaries-user.html#dx1-34095" >1518</a>, <a -href="glossaries-user.html#dx1-34144" >1519</a>, <a -href="glossaries-user.html#dx1-40006" >1520</a>, <a -href="glossaries-user.html#dx1-40010" >1521</a>, <a -href="glossaries-user.html#dx1-43004" >1522</a>, <a -href="glossaries-user.html#dx1-47010" >1523</a>, <a -href="glossaries-user.html#dx1-55030" >1524</a>, <a -href="glossaries-user.html#dx1-63054" >1525</a>, <a -href="glossaries-user.html#dx1-70011" >1526</a>, <a -href="glossaries-user.html#dx1-71058" >1527</a>, <a -href="glossaries-user.html#dx1-71061" >1528</a>, <a -href="glossaries-user.html#dx1-71069" >1529</a>, <a -href="glossaries-user.html#dx1-71078" >1530</a>, <a -href="glossaries-user.html#dx1-71085" >1531</a>, <a -href="glossaries-user.html#dx1-88022" >1532</a>, <a -href="glossaries-user.html#dx1-88024" >1533</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">subentrycounter</span>  <a -href="glossaries-user.html#dx1-63036" >1534</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">symbol</span>  <a -href="glossaries-user.html#dx1-12004" >1535</a>, <a -href="glossaries-user.html#dx1-12005" >1536</a>, <a -href="glossaries-user.html#dx1-34064" >1537</a>, <a -href="glossaries-user.html#dx1-34071" >1538</a>, <a -href="glossaries-user.html#dx1-34136" >1539</a>, <a -href="glossaries-user.html#dx1-40004" >1540</a>, <a -href="glossaries-user.html#dx1-54035" >1541</a>, <a -href="glossaries-user.html#dx1-56046" >1542</a>, <a -href="glossaries-user.html#dx1-57077" >1543</a>, <a -href="glossaries-user.html#dx1-57086" >1544</a>, <a -href="glossaries-user.html#dx1-72064" >1545</a>, <a -href="glossaries-user.html#dx1-91014" >1546</a>, <a -href="glossaries-user.html#dx1-94014" >1547</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">symbolaccess</span>  <a -href="glossaries-user.html#dx1-94013" >1548</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">symbolplural</span>  <a -href="glossaries-user.html#dx1-34065" >1549</a>, <a -href="glossaries-user.html#dx1-40005" >1550</a>, <a -href="glossaries-user.html#dx1-94016" >1551</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">symbolpluralaccess</span>  <a -href="glossaries-user.html#dx1-94015" >1552</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">text</span>  <a -href="glossaries-user.html#dx1-34028" >1553</a>, <a -href="glossaries-user.html#dx1-34033" >1554</a>, <a -href="glossaries-user.html#dx1-34044" >1555</a>, <a -href="glossaries-user.html#dx1-34132" >1556</a>, <a -href="glossaries-user.html#dx1-54031" >1557</a>, <a -href="glossaries-user.html#dx1-55013" >1558</a>, <a -href="glossaries-user.html#dx1-55041" >1559</a>, <a -href="glossaries-user.html#dx1-56008" >1560</a>, <a -href="glossaries-user.html#dx1-56025" >1561</a>, <a -href="glossaries-user.html#dx1-56041" >1562</a>, <a -href="glossaries-user.html#dx1-57041" >1563</a>, <a -href="glossaries-user.html#dx1-57046" >1564</a>, <a -href="glossaries-user.html#dx1-57055" >1565</a>, <a -href="glossaries-user.html#dx1-62010" >1566</a>, <a -href="glossaries-user.html#dx1-62016" >1567</a>, <a -href="glossaries-user.html#dx1-69043" >1568</a>, <a -href="glossaries-user.html#dx1-70003" >1569</a>, <a -href="glossaries-user.html#dx1-75002" >1570</a>, <a -href="glossaries-user.html#dx1-92002" >1571</a>, <a -href="glossaries-user.html#dx1-93004" >1572</a>, <a -href="glossaries-user.html#dx1-94006" >1573</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">textaccess</span>  <a -href="glossaries-user.html#dx1-94005" >1574</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">type</span>  <a -href="glossaries-user.html#dx1-34097" >1575</a>, <a -href="glossaries-user.html#dx1-44004" >1576</a>, <a -href="glossaries-user.html#dx1-69010" >1577</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user1</span>  <a -href="glossaries-user.html#dx1-12007" >1578</a>, <a -href="glossaries-user.html#dx1-12010" >1579</a>, <a -href="glossaries-user.html#dx1-12013" >1580</a>, <a -href="glossaries-user.html#dx1-12014" >1581</a>, <a -href="glossaries-user.html#dx1-34099" >1582</a>, <a -href="glossaries-user.html#dx1-40014" >1583</a>, <a -href="glossaries-user.html#dx1-56056" >1584</a>, <a -href="glossaries-user.html#dx1-88098" >1585</a>, <a -href="glossaries-user.html#dx1-88101" >1586</a>, <a -href="glossaries-user.html#dx1-91028" >1587</a>, <a -href="glossaries-user.html#dx1-91031" >1588</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user2</span>  <a -href="glossaries-user.html#dx1-34101" >1589</a>, <a -href="glossaries-user.html#dx1-40015" >1590</a>, <a -href="glossaries-user.html#dx1-56061" >1591</a>, <a -href="glossaries-user.html#dx1-88102" >1592</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user3</span>  <a -href="glossaries-user.html#dx1-34102" >1593</a>, <a -href="glossaries-user.html#dx1-40016" >1594</a>, <a -href="glossaries-user.html#dx1-56066" >1595</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user4</span>  <a -href="glossaries-user.html#dx1-34103" >1596</a>, <a -href="glossaries-user.html#dx1-40017" >1597</a>, <a -href="glossaries-user.html#dx1-56071" >1598</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user5</span>  <a -href="glossaries-user.html#dx1-34104" >1599</a>, <a -href="glossaries-user.html#dx1-40018" >1600</a>, <a -href="glossaries-user.html#dx1-56076" >1601</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">user6</span>  <a -href="glossaries-user.html#dx1-34100" >1602</a>, <a -href="glossaries-user.html#dx1-40019" >1603</a>, <a -href="glossaries-user.html#dx1-56081" >1604</a>, <a -href="glossaries-user.html#dx1-88099" >1605</a> <br /></span> +class="cmtt-10">long</span>  <a +href="glossaries-user.html#dx1-34020" >3251</a>, <a +href="glossaries-user.html#dx1-112139" >3252</a>, <a +href="glossaries-user.html#dx1-112148" >3253</a>, <a +href="glossaries-user.html#dx1-117005" >3254</a>, <a +href="glossaries-user.html#dx1-132034" >3255</a>, <a +href="glossaries-user.html#dx1-133019" >3256</a>, <a +href="glossaries-user.html#dx1-135042" >3257</a>, <a +href="glossaries-user.html#dx1-135051" >3258</a>, <a +href="glossaries-user.html#dx1-147010" >3259</a>, <a +href="glossaries-user.html#dx1-147066" >3260</a>, <a +href="glossaries-user.html#dx1-148005" >3261</a>, <a +href="glossaries-user.html#dx1-169016" >3262</a>, <a +href="glossaries-user.html#dx1-172032" >3263</a>, <a +href="glossaries-user.html#dx1-184072" >3264</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">longaccess</span>  <a +href="glossaries-user.html#dx1-172031" >3265</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">longplural</span>  <a +href="glossaries-user.html#dx1-15009" >3266</a>, <a +href="glossaries-user.html#dx1-112140" >3267</a>, <a +href="glossaries-user.html#dx1-118020" >3268</a>, <a +href="glossaries-user.html#dx1-133053" >3269</a>, <a +href="glossaries-user.html#dx1-135053" >3270</a>, <a +href="glossaries-user.html#dx1-147011" >3271</a>, <a +href="glossaries-user.html#dx1-147023" >3272</a>, <a +href="glossaries-user.html#dx1-147024" >3273</a>, <a +href="glossaries-user.html#dx1-147029" >3274</a>, <a +href="glossaries-user.html#dx1-147073" >3275</a>, <a +href="glossaries-user.html#dx1-172038" >3276</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">longpluralaccess</span>  <a +href="glossaries-user.html#dx1-172037" >3277</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">name</span>  <a +href="glossaries-user.html#dx1-6016" >3278</a>, <a +href="glossaries-user.html#dx1-8018" >3279</a>, <a +href="glossaries-user.html#dx1-9015" >3280</a>, <a +href="glossaries-user.html#dx1-11053" >3281</a>, <a +href="glossaries-user.html#dx1-11063" >3282</a>, <a +href="glossaries-user.html#dx1-11065" >3283</a>, <a +href="glossaries-user.html#dx1-12008" >3284</a>, <a +href="glossaries-user.html#dx1-12022" >3285</a>, <a +href="glossaries-user.html#dx1-12023" >3286</a>, <a +href="glossaries-user.html#dx1-16002" >3287</a>, <a +href="glossaries-user.html#dx1-73008" >3288</a>, <a +href="glossaries-user.html#dx1-73026" >3289</a>, <a +href="glossaries-user.html#dx1-73044" >3290</a>, <a +href="glossaries-user.html#dx1-112011" >3291</a>, <a +href="glossaries-user.html#dx1-112016" >3292</a>, <a +href="glossaries-user.html#dx1-112018" >3293</a>, <a +href="glossaries-user.html#dx1-112030" >3294</a>, <a +href="glossaries-user.html#dx1-112073" >3295</a>, <a +href="glossaries-user.html#dx1-112077" >3296</a>, <a +href="glossaries-user.html#dx1-112083" >3297</a>, <a +href="glossaries-user.html#dx1-112089" >3298</a>, <a +href="glossaries-user.html#dx1-112091" >3299</a>, <a +href="glossaries-user.html#dx1-112097" >3300</a>, <a +href="glossaries-user.html#dx1-118001" >3301</a>, <a +href="glossaries-user.html#dx1-121001" >3302</a>, <a +href="glossaries-user.html#dx1-133042" >3303</a>, <a +href="glossaries-user.html#dx1-133043" >3304</a>, <a +href="glossaries-user.html#dx1-134039" >3305</a>, <a +href="glossaries-user.html#dx1-140008" >3306</a>, <a +href="glossaries-user.html#dx1-148009" >3307</a>, <a +href="glossaries-user.html#dx1-149058" >3308</a>, <a +href="glossaries-user.html#dx1-149061" >3309</a>, <a +href="glossaries-user.html#dx1-149071" >3310</a>, <a +href="glossaries-user.html#dx1-149078" >3311</a>, <a +href="glossaries-user.html#dx1-149080" >3312</a>, <a +href="glossaries-user.html#dx1-149085" >3313</a>, <a +href="glossaries-user.html#dx1-150066" >3314</a>, <a +href="glossaries-user.html#dx1-166023" >3315</a>, <a +href="glossaries-user.html#dx1-170006" >3316</a>, <a +href="glossaries-user.html#dx1-172014" >3317</a>, <a +href="glossaries-user.html#dx1-172081" >3318</a>, <a +href="glossaries-user.html#dx1-179068" >3319</a>, <a +href="glossaries-user.html#dx1-184003" >3320</a>, <a +href="glossaries-user.html#dx1-184060" >3321</a>, <a +href="glossaries-user.html#dx1-188029" >3322</a>, <a +href="glossaries-user.html#dx1-189053" >3323</a>, <a +href="glossaries-user.html#dx1-192063" >3324</a>, <a +href="glossaries-user.html#dx1-200069" >3325</a>, <a +href="glossaries-user.html#dx1-200070" >3326</a>, <a +href="glossaries-user.html#dx1-202008" >3327</a>, <a +href="glossaries-user.html#dx1-202057" >3328</a>, <a +href="glossaries-user.html#dx1-202069" >3329</a>, <a +href="glossaries-user.html#dx1-202073" >3330</a>, <a +href="glossaries-user.html#dx1-202078" >3331</a>, <a +href="glossaries-user.html#dx1-202086" >3332</a>, <a +href="glossaries-user.html#dx1-210004" >3333</a>, <a +href="glossaries-user.html#dx1-216001" >3334</a>, <a +href="glossaries-user.html#dx1-224075" >3335</a>, <a +href="glossaries-user.html#dx1-224078" >3336</a>, <a +href="glossaries-user.html#dx1-139014" >3337</a>, <a +href="glossaries-user.html#dx1-140054" >3338</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">nonumberlist</span>  <a +href="glossaries-user.html#dx1-112110" >3339</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">parent</span>  <a +href="glossaries-user.html#dx1-112012" >3340</a>, <a +href="glossaries-user.html#dx1-112017" >3341</a>, <a +href="glossaries-user.html#dx1-112025" >3342</a>, <a +href="glossaries-user.html#dx1-120001" >3343</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">plural</span>  <a +href="glossaries-user.html#dx1-15008" >3344</a>, <a +href="glossaries-user.html#dx1-112041" >3345</a>, <a +href="glossaries-user.html#dx1-112048" >3346</a>, <a +href="glossaries-user.html#dx1-112061" >3347</a>, <a +href="glossaries-user.html#dx1-113002" >3348</a>, <a +href="glossaries-user.html#dx1-113004" >3349</a>, <a +href="glossaries-user.html#dx1-121008" >3350</a>, <a +href="glossaries-user.html#dx1-133050" >3351</a>, <a +href="glossaries-user.html#dx1-134026" >3352</a>, <a +href="glossaries-user.html#dx1-134029" >3353</a>, <a +href="glossaries-user.html#dx1-135047" >3354</a>, <a +href="glossaries-user.html#dx1-135056" >3355</a>, <a +href="glossaries-user.html#dx1-140018" >3356</a>, <a +href="glossaries-user.html#dx1-147027" >3357</a>, <a +href="glossaries-user.html#dx1-170007" >3358</a>, <a +href="glossaries-user.html#dx1-171006" >3359</a>, <a +href="glossaries-user.html#dx1-172020" >3360</a>, <a +href="glossaries-user.html#dx1-172083" >3361</a>, <a +href="glossaries-user.html#dx1-200051" >3362</a>, <a +href="glossaries-user.html#dx1-200052" >3363</a>, <a +href="glossaries-user.html#dx1-202070" >3364</a>, <a +href="glossaries-user.html#dx1-202071" >3365</a>, <a +href="glossaries-user.html#dx1-224082" >3366</a> <br /></span> + + +<span class="index-subitem">    <span +class="cmtt-10">pluralaccess</span>  <a +href="glossaries-user.html#dx1-172019" >3367</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">prefix</span>  <a +href="glossaries-user.html#dx1-171003" >3368</a>, <a +href="glossaries-user.html#dx1-171009" >3369</a>, <a +href="glossaries-user.html#dx1-171022" >3370</a>, <a +href="glossaries-user.html#dx1-171025" >3371</a>, <a +href="glossaries-user.html#dx1-171042" >3372</a>, <a +href="glossaries-user.html#dx1-171049" >3373</a>, <a +href="glossaries-user.html#dx1-194015" >3374</a>, <a +href="glossaries-user.html#dx1-194018" >3375</a>, <a +href="glossaries-user.html#dx1-171016" >3376</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">prefixfirst</span>  <a +href="glossaries-user.html#dx1-171007" >3377</a>, <a +href="glossaries-user.html#dx1-171023" >3378</a>, <a +href="glossaries-user.html#dx1-171026" >3379</a>, <a +href="glossaries-user.html#dx1-171046" >3380</a>, <a +href="glossaries-user.html#dx1-171051" >3381</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">prefixfirstplural</span>  <a +href="glossaries-user.html#dx1-171010" >3382</a>, <a +href="glossaries-user.html#dx1-171032" >3383</a>, <a +href="glossaries-user.html#dx1-171035" >3384</a>, <a +href="glossaries-user.html#dx1-171055" >3385</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">prefixplural</span>  <a +href="glossaries-user.html#dx1-171005" >3386</a>, <a +href="glossaries-user.html#dx1-171012" >3387</a>, <a +href="glossaries-user.html#dx1-171031" >3388</a>, <a +href="glossaries-user.html#dx1-171034" >3389</a>, <a +href="glossaries-user.html#dx1-171044" >3390</a>, <a +href="glossaries-user.html#dx1-171053" >3391</a>, <a +href="glossaries-user.html#dx1-194016" >3392</a>, <a +href="glossaries-user.html#dx1-194019" >3393</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">see</span>  <a +href="glossaries-user.html#dx1-12026" >3394</a>, <a +href="glossaries-user.html#dx1-30018" >3395</a>, <a +href="glossaries-user.html#dx1-56003" >3396</a>, <a +href="glossaries-user.html#dx1-56007" >3397</a>, <a +href="glossaries-user.html#dx1-62001" >3398</a>, <a +href="glossaries-user.html#dx1-62002" >3399</a>, <a +href="glossaries-user.html#dx1-66001" >3400</a>, <a +href="glossaries-user.html#dx1-112115" >3401</a>, <a +href="glossaries-user.html#dx1-112116" >3402</a>, <a +href="glossaries-user.html#dx1-112123" >3403</a>, <a +href="glossaries-user.html#dx1-112127" >3404</a>, <a +href="glossaries-user.html#dx1-112128" >3405</a>, <a +href="glossaries-user.html#dx1-112129" >3406</a>, <a +href="glossaries-user.html#dx1-112131" >3407</a>, <a +href="glossaries-user.html#dx1-125016" >3408</a>, <a +href="glossaries-user.html#dx1-138009" >3409</a>, <a +href="glossaries-user.html#dx1-138010" >3410</a>, <a +href="glossaries-user.html#dx1-138012" >3411</a>, <a +href="glossaries-user.html#dx1-138023" >3412</a>, <a +href="glossaries-user.html#dx1-139001" >3413</a>, <a +href="glossaries-user.html#dx1-179022" >3414</a>, <a +href="glossaries-user.html#dx1-179033" >3415</a>, <a +href="glossaries-user.html#dx1-204002" >3416</a>, <a +href="glossaries-user.html#dx1-204003" >3417</a>, <a +href="glossaries-user.html#dx1-204009" >3418</a>, <a +href="glossaries-user.html#dx1-204012" >3419</a>, <a +href="glossaries-user.html#dx1-204030" >3420</a>, <a +href="glossaries-user.html#dx1-4003" >3421</a>, <a +href="glossaries-user.html#dx1-139007" >3422</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">seealso</span>  <a +href="glossaries-user.html#dx1-12028" >3423</a>, <a +href="glossaries-user.html#dx1-66002" >3424</a>, <a +href="glossaries-user.html#dx1-112130" >3425</a>, <a +href="glossaries-user.html#dx1-179031" >3426</a>, <a +href="glossaries-user.html#dx1-179035" >3427</a>, <a +href="glossaries-user.html#dx1-182029" >3428</a>, <a +href="glossaries-user.html#dx1-182030" >3429</a>, <a +href="glossaries-user.html#dx1-204010" >3430</a>, <a +href="glossaries-user.html#dx1-204013" >3431</a>, <a +href="glossaries-user.html#dx1-204032" >3432</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">short</span>  <a +href="glossaries-user.html#dx1-9016" >3433</a>, <a +href="glossaries-user.html#dx1-112141" >3434</a>, <a +href="glossaries-user.html#dx1-112147" >3435</a>, <a +href="glossaries-user.html#dx1-132033" >3436</a>, <a +href="glossaries-user.html#dx1-133020" >3437</a>, <a +href="glossaries-user.html#dx1-135043" >3438</a>, <a +href="glossaries-user.html#dx1-135052" >3439</a>, <a +href="glossaries-user.html#dx1-147012" >3440</a>, <a +href="glossaries-user.html#dx1-147055" >3441</a>, <a +href="glossaries-user.html#dx1-148006" >3442</a>, <a +href="glossaries-user.html#dx1-169019" >3443</a>, <a +href="glossaries-user.html#dx1-172035" >3444</a>, <a +href="glossaries-user.html#dx1-172068" >3445</a>, <a +href="glossaries-user.html#dx1-179067" >3446</a>, <a +href="glossaries-user.html#dx1-192022" >3447</a>, <a +href="glossaries-user.html#dx1-193031" >3448</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">shortaccess</span>  <a +href="glossaries-user.html#dx1-172034" >3449</a>, <a +href="glossaries-user.html#dx1-172062" >3450</a>, <a +href="glossaries-user.html#dx1-224011" >3451</a>, <a +href="glossaries-user.html#dx1-224012" >3452</a>, <a +href="glossaries-user.html#dx1-224021" >3453</a>, <a +href="glossaries-user.html#dx1-224049" >3454</a>, <a +href="glossaries-user.html#dx1-224054" >3455</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">shortplural</span>  <a +href="glossaries-user.html#dx1-15010" >3456</a>, <a +href="glossaries-user.html#dx1-112142" >3457</a>, <a +href="glossaries-user.html#dx1-118021" >3458</a>, <a +href="glossaries-user.html#dx1-133054" >3459</a>, <a +href="glossaries-user.html#dx1-135054" >3460</a>, <a +href="glossaries-user.html#dx1-147013" >3461</a>, <a +href="glossaries-user.html#dx1-147022" >3462</a>, <a +href="glossaries-user.html#dx1-147025" >3463</a>, <a +href="glossaries-user.html#dx1-147031" >3464</a>, <a +href="glossaries-user.html#dx1-147034" >3465</a>, <a +href="glossaries-user.html#dx1-147062" >3466</a>, <a +href="glossaries-user.html#dx1-172041" >3467</a>, <a +href="glossaries-user.html#dx1-172069" >3468</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">shortpluralaccess</span>  <a +href="glossaries-user.html#dx1-172040" >3469</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">sort</span>  <a +href="glossaries-user.html#dx1-3062" >3470</a>, <a +href="glossaries-user.html#dx1-6011" >3471</a>, <a +href="glossaries-user.html#dx1-6015" >3472</a>, <a +href="glossaries-user.html#dx1-8014" >3473</a>, <a +href="glossaries-user.html#dx1-8017" >3474</a>, <a +href="glossaries-user.html#dx1-9011" >3475</a>, <a +href="glossaries-user.html#dx1-9017" >3476</a>, <a +href="glossaries-user.html#dx1-13045" >3477</a>, <a +href="glossaries-user.html#dx1-16001" >3478</a>, <a +href="glossaries-user.html#dx1-73006" >3479</a>, <a +href="glossaries-user.html#dx1-73009" >3480</a>, <a +href="glossaries-user.html#dx1-73011" >3481</a>, <a +href="glossaries-user.html#dx1-73013" >3482</a>, <a +href="glossaries-user.html#dx1-73025" >3483</a>, <a +href="glossaries-user.html#dx1-112019" >3484</a>, <a +href="glossaries-user.html#dx1-112072" >3485</a>, <a +href="glossaries-user.html#dx1-112076" >3486</a>, <a +href="glossaries-user.html#dx1-112078" >3487</a>, <a +href="glossaries-user.html#dx1-112080" >3488</a>, <a +href="glossaries-user.html#dx1-112084" >3489</a>, <a +href="glossaries-user.html#dx1-112088" >3490</a>, <a +href="glossaries-user.html#dx1-112094" >3491</a>, <a +href="glossaries-user.html#dx1-112096" >3492</a>, <a +href="glossaries-user.html#dx1-112098" >3493</a>, <a +href="glossaries-user.html#dx1-112157" >3494</a>, <a +href="glossaries-user.html#dx1-118006" >3495</a>, <a +href="glossaries-user.html#dx1-118010" >3496</a>, <a +href="glossaries-user.html#dx1-121004" >3497</a>, <a +href="glossaries-user.html#dx1-125010" >3498</a>, <a +href="glossaries-user.html#dx1-133030" >3499</a>, <a +href="glossaries-user.html#dx1-141056" >3500</a>, <a +href="glossaries-user.html#dx1-148011" >3501</a>, <a +href="glossaries-user.html#dx1-149059" >3502</a>, <a +href="glossaries-user.html#dx1-149062" >3503</a>, <a +href="glossaries-user.html#dx1-149070" >3504</a>, <a +href="glossaries-user.html#dx1-149079" >3505</a>, <a +href="glossaries-user.html#dx1-149086" >3506</a>, <a +href="glossaries-user.html#dx1-166022" >3507</a>, <a +href="glossaries-user.html#dx1-166024" >3508</a>, <a +href="glossaries-user.html#dx1-179064" >3509</a>, <a +href="glossaries-user.html#dx1-182001" >3510</a>, <a +href="glossaries-user.html#dx1-184001" >3511</a>, <a +href="glossaries-user.html#dx1-184068" >3512</a>, <a +href="glossaries-user.html#dx1-188010" >3513</a>, <a +href="glossaries-user.html#dx1-188025" >3514</a>, <a +href="glossaries-user.html#dx1-188031" >3515</a>, <a +href="glossaries-user.html#dx1-192061" >3516</a>, <a +href="glossaries-user.html#dx1-194011" >3517</a>, <a +href="glossaries-user.html#dx1-197001" >3518</a>, <a +href="glossaries-user.html#dx1-197004" >3519</a>, <a +href="glossaries-user.html#dx1-200007" >3520</a>, <a +href="glossaries-user.html#dx1-200012" >3521</a>, <a +href="glossaries-user.html#dx1-200063" >3522</a>, <a +href="glossaries-user.html#dx1-200066" >3523</a>, <a +href="glossaries-user.html#dx1-200078" >3524</a>, <a +href="glossaries-user.html#dx1-200083" >3525</a>, <a +href="glossaries-user.html#dx1-200089" >3526</a>, <a +href="glossaries-user.html#dx1-202087" >3527</a>, <a +href="glossaries-user.html#dx1-202088" >3528</a>, <a +href="glossaries-user.html#dx1-210005" >3529</a>, <a +href="glossaries-user.html#dx1-211034" >3530</a>, <a +href="glossaries-user.html#dx1-211070" >3531</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">subentrycounter</span>  <a +href="glossaries-user.html#dx1-141038" >3532</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">symbol</span>  <a +href="glossaries-user.html#dx1-11051" >3533</a>, <a +href="glossaries-user.html#dx1-12006" >3534</a>, <a +href="glossaries-user.html#dx1-12007" >3535</a>, <a +href="glossaries-user.html#dx1-112064" >3536</a>, <a +href="glossaries-user.html#dx1-112071" >3537</a>, <a +href="glossaries-user.html#dx1-112149" >3538</a>, <a +href="glossaries-user.html#dx1-118004" >3539</a>, <a +href="glossaries-user.html#dx1-132035" >3540</a>, <a +href="glossaries-user.html#dx1-134046" >3541</a>, <a +href="glossaries-user.html#dx1-135077" >3542</a>, <a +href="glossaries-user.html#dx1-135086" >3543</a>, <a +href="glossaries-user.html#dx1-150065" >3544</a>, <a +href="glossaries-user.html#dx1-169014" >3545</a>, <a +href="glossaries-user.html#dx1-172024" >3546</a>, <a +href="glossaries-user.html#dx1-189028" >3547</a>, <a +href="glossaries-user.html#dx1-189037" >3548</a>, <a +href="glossaries-user.html#dx1-189043" >3549</a>, <a +href="glossaries-user.html#dx1-189046" >3550</a>, <a +href="glossaries-user.html#dx1-189049" >3551</a>, <a +href="glossaries-user.html#dx1-224076" >3552</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">symbolaccess</span>  <a +href="glossaries-user.html#dx1-172023" >3553</a>, <a +href="glossaries-user.html#dx1-224023" >3554</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">symbolplural</span>  <a +href="glossaries-user.html#dx1-112065" >3555</a>, <a +href="glossaries-user.html#dx1-118005" >3556</a>, <a +href="glossaries-user.html#dx1-172026" >3557</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">symbolpluralaccess</span>  <a +href="glossaries-user.html#dx1-172025" >3558</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">text</span>  <a +href="glossaries-user.html#dx1-11064" >3559</a>, <a +href="glossaries-user.html#dx1-11066" >3560</a>, <a +href="glossaries-user.html#dx1-11086" >3561</a>, <a +href="glossaries-user.html#dx1-112028" >3562</a>, <a +href="glossaries-user.html#dx1-112033" >3563</a>, <a +href="glossaries-user.html#dx1-112044" >3564</a>, <a +href="glossaries-user.html#dx1-112145" >3565</a>, <a +href="glossaries-user.html#dx1-132031" >3566</a>, <a +href="glossaries-user.html#dx1-133013" >3567</a>, <a +href="glossaries-user.html#dx1-133041" >3568</a>, <a +href="glossaries-user.html#dx1-134008" >3569</a>, <a +href="glossaries-user.html#dx1-134025" >3570</a>, <a +href="glossaries-user.html#dx1-134041" >3571</a>, <a +href="glossaries-user.html#dx1-135041" >3572</a>, <a +href="glossaries-user.html#dx1-135046" >3573</a>, <a +href="glossaries-user.html#dx1-135055" >3574</a>, <a +href="glossaries-user.html#dx1-140009" >3575</a>, <a +href="glossaries-user.html#dx1-140015" >3576</a>, <a +href="glossaries-user.html#dx1-147044" >3577</a>, <a +href="glossaries-user.html#dx1-148003" >3578</a>, <a +href="glossaries-user.html#dx1-153002" >3579</a>, <a +href="glossaries-user.html#dx1-170005" >3580</a>, <a +href="glossaries-user.html#dx1-171004" >3581</a>, <a +href="glossaries-user.html#dx1-172016" >3582</a>, <a +href="glossaries-user.html#dx1-172082" >3583</a>, <a +href="glossaries-user.html#dx1-180004" >3584</a>, <a +href="glossaries-user.html#dx1-189052" >3585</a>, <a +href="glossaries-user.html#dx1-192024" >3586</a>, <a +href="glossaries-user.html#dx1-193032" >3587</a>, <a +href="glossaries-user.html#dx1-202072" >3588</a>, <a +href="glossaries-user.html#dx1-206002" >3589</a>, <a +href="glossaries-user.html#dx1-206003" >3590</a>, <a +href="glossaries-user.html#dx1-206004" >3591</a>, <a +href="glossaries-user.html#dx1-224081" >3592</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">textaccess</span>  <a +href="glossaries-user.html#dx1-172015" >3593</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">type</span>  <a +href="glossaries-user.html#dx1-7031" >3594</a>, <a +href="glossaries-user.html#dx1-8034" >3595</a>, <a +href="glossaries-user.html#dx1-112100" >3596</a>, <a +href="glossaries-user.html#dx1-122004" >3597</a>, <a +href="glossaries-user.html#dx1-147009" >3598</a>, <a +href="glossaries-user.html#dx1-192043" >3599</a>, <a +href="glossaries-user.html#dx1-192045" >3600</a>, <a +href="glossaries-user.html#dx1-192048" >3601</a>, <a +href="glossaries-user.html#dx1-198029" >3602</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user1</span>  <a +href="glossaries-user.html#dx1-12009" >3603</a>, <a +href="glossaries-user.html#dx1-12018" >3604</a>, <a +href="glossaries-user.html#dx1-12024" >3605</a>, <a +href="glossaries-user.html#dx1-12025" >3606</a>, <a +href="glossaries-user.html#dx1-112102" >3607</a>, <a +href="glossaries-user.html#dx1-118014" >3608</a>, <a +href="glossaries-user.html#dx1-134056" >3609</a>, <a +href="glossaries-user.html#dx1-166098" >3610</a>, <a +href="glossaries-user.html#dx1-166101" >3611</a>, <a +href="glossaries-user.html#dx1-169028" >3612</a>, <a +href="glossaries-user.html#dx1-169031" >3613</a>, <a +href="glossaries-user.html#dx1-172044" >3614</a>, <a +href="glossaries-user.html#dx1-189036" >3615</a>, <a +href="glossaries-user.html#dx1-189044" >3616</a>, <a +href="glossaries-user.html#dx1-202026" >3617</a>, <a +href="glossaries-user.html#dx1-224026" >3618</a>, <a +href="glossaries-user.html#dx1-224077" >3619</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user1access</span>  <a +href="glossaries-user.html#dx1-172043" >3620</a>, <a +href="glossaries-user.html#dx1-224030" >3621</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user2</span>  <a +href="glossaries-user.html#dx1-112104" >3622</a>, <a +href="glossaries-user.html#dx1-118015" >3623</a>, <a +href="glossaries-user.html#dx1-134061" >3624</a>, <a +href="glossaries-user.html#dx1-166102" >3625</a>, <a +href="glossaries-user.html#dx1-172046" >3626</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user2access</span>  <a +href="glossaries-user.html#dx1-172045" >3627</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user3</span>  <a +href="glossaries-user.html#dx1-112105" >3628</a>, <a +href="glossaries-user.html#dx1-118016" >3629</a>, <a +href="glossaries-user.html#dx1-134066" >3630</a>, <a +href="glossaries-user.html#dx1-172048" >3631</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user3access</span>  <a +href="glossaries-user.html#dx1-172047" >3632</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user4</span>  <a +href="glossaries-user.html#dx1-112106" >3633</a>, <a +href="glossaries-user.html#dx1-118017" >3634</a>, <a +href="glossaries-user.html#dx1-134071" >3635</a>, <a +href="glossaries-user.html#dx1-172050" >3636</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user4access</span>  <a +href="glossaries-user.html#dx1-172049" >3637</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user5</span>  <a +href="glossaries-user.html#dx1-112107" >3638</a>, <a +href="glossaries-user.html#dx1-118018" >3639</a>, <a +href="glossaries-user.html#dx1-134076" >3640</a>, <a +href="glossaries-user.html#dx1-172052" >3641</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user5access</span>  <a +href="glossaries-user.html#dx1-172051" >3642</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user6</span>  <a +href="glossaries-user.html#dx1-112103" >3643</a>, <a +href="glossaries-user.html#dx1-118019" >3644</a>, <a +href="glossaries-user.html#dx1-134081" >3645</a>, <a +href="glossaries-user.html#dx1-166099" >3646</a>, <a +href="glossaries-user.html#dx1-172054" >3647</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">user6access</span>  <a +href="glossaries-user.html#dx1-172053" >3648</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newglossarystyle</span></span></span>  <a -href="glossaries-user.html#dx1-88001" ><span -class="cmti-10">1606</span></a> <br /></span> +href="glossaries-user.html#dx1-156035" >3649</a>, <a +href="glossaries-user.html#dx1-166001" ><span +class="cmti-10">3650</span></a>, <a +href="glossaries-user.html#dx1-166033" >3651</a>, <a +href="glossaries-user.html#dx1-166092" >3652</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newignoredglossary</span></span></span>  <a -href="glossaries-user.html#dx1-68010" ><span -class="cmti-10">1607</span></a> <br /></span> +href="glossaries-user.html#dx1-34012" >3653</a>, <a +href="glossaries-user.html#dx1-123003" >3654</a>, <a +href="glossaries-user.html#dx1-141020" >3655</a>, <a +href="glossaries-user.html#dx1-146010" ><span +class="cmti-10">3656</span></a>, <a +href="glossaries-user.html#dx1-225001" >3657</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\newline</span></span></span>  <a +href="glossaries-user.html#dx1-112023" >3658</a>, <a +href="glossaries-user.html#dx1-156026" >3659</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\newterm</span></span></span>  <a -href="glossaries-user.html#dx1-29014" ><span -class="cmti-10">1608</span></a> <br /></span> +href="glossaries-user.html#dx1-87001" ><span +class="cmti-10">3660</span></a>, <a +href="glossaries-user.html#dx1-138014" >3661</a> <br /></span> <span class="index-item"><span class="cmss-10">ngerman </span>package  <a -href="glossaries-user.html#dx1-13031" >1609</a>, <a -href="glossaries-user.html#dx1-13041" >1610</a>, <a -href="glossaries-user.html#dx1-13050" >1611</a>, <a -href="glossaries-user.html#dx1-64013" >1612</a> <br /></span> +href="glossaries-user.html#dx1-13029" >3662</a>, <a +href="glossaries-user.html#dx1-13038" >3663</a>, <a +href="glossaries-user.html#dx1-13047" >3664</a>, <a +href="glossaries-user.html#dx1-142013" >3665</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\nohyperpage</span></span></span>  <a +href="glossaries-user.html#dx1-130013" >3666</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\noist</span></span></span>  <a -href="glossaries-user.html#dx1-33008" ><span -class="cmti-10">1613</span></a> <br /></span> +href="glossaries-user.html#dx1-111008" ><span +class="cmti-10">3667</span></a>, <a +href="glossaries-user.html#dx1-130006" >3668</a>, <a +href="glossaries-user.html#dx1-130015" >3669</a>, <a +href="glossaries-user.html#dx1-142017" >3670</a>, <a +href="glossaries-user.html#dx1-143012" >3671</a>, <a +href="glossaries-user.html#dx1-144024" >3672</a>, <a +href="glossaries-user.html#dx1-144029" >3673</a>, <a +href="glossaries-user.html#dx1-144062" >3674</a>, <a +href="glossaries-user.html#dx1-144068" >3675</a>, <a +href="glossaries-user.html#dx1-145008" >3676</a>, <a +href="glossaries-user.html#dx1-211009" >3677</a>, <a +href="glossaries-user.html#dx1-211021" >3678</a> <br /></span> <span class="index-item">Non-Latin Alphabet  <a -href="glossaries-user.html#dx1-3042" ><span -class="cmbx-10">1614</span></a> <br /></span> +href="glossaries-user.html#dx1-3054" ><span +class="cmbx-10">3679</span></a> <br /></span> <span class="index-item">non-Latin character  <a -href="glossaries-user.html#dx1-3009" >1615</a>, <a -href="glossaries-user.html#dx1-3043" >1616</a>, <a -href="glossaries-user.html#dx1-3044" ><span -class="cmbx-10">1617</span></a>, <a -href="glossaries-user.html#dx1-11095" >1618</a>, <a -href="glossaries-user.html#dx1-13013" >1619</a>, <a -href="glossaries-user.html#dx1-13016" >1620</a>, <a -href="glossaries-user.html#dx1-14053" >1621</a>, <a -href="glossaries-user.html#dx1-15009" >1622</a>, <a -href="glossaries-user.html#dx1-34009" >1623</a>, <a -href="glossaries-user.html#dx1-34138" >1624</a>, <a -href="glossaries-user.html#dx1-34146" >1625</a> <br /></span> +href="glossaries-user.html#dx1-3020" >3680</a>, <a +href="glossaries-user.html#dx1-3055" >3681</a>, <a +href="glossaries-user.html#dx1-3056" ><span +class="cmbx-10">3682</span></a>, <a +href="glossaries-user.html#dx1-13013" >3683</a>, <a +href="glossaries-user.html#dx1-13016" >3684</a>, <a +href="glossaries-user.html#dx1-14055" >3685</a>, <a +href="glossaries-user.html#dx1-15011" >3686</a>, <a +href="glossaries-user.html#dx1-112008" >3687</a>, <a +href="glossaries-user.html#dx1-112151" >3688</a>, <a +href="glossaries-user.html#dx1-112159" >3689</a>, <a +href="glossaries-user.html#dx1-214004" >3690</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\nopostdesc</span></span></span>  <a -href="glossaries-user.html#dx1-34022" ><span -class="cmti-10">1626</span></a> <br /></span> +href="glossaries-user.html#dx1-87003" >3691</a>, <a +href="glossaries-user.html#dx1-112021" ><span +class="cmti-10">3692</span></a>, <a +href="glossaries-user.html#dx1-120004" >3693</a>, <a +href="glossaries-user.html#dx1-121002" >3694</a>, <a +href="glossaries-user.html#dx1-156040" >3695</a>, <a +href="glossaries-user.html#dx1-169025" >3696</a>, <a +href="glossaries-user.html#dx1-197011" >3697</a>, <a +href="glossaries-user.html#dx1-197016" >3698</a>, <a +href="glossaries-user.html#dx1-200011" >3699</a>, <a +href="glossaries-user.html#dx1-200013" >3700</a>, <a +href="glossaries-user.html#dx1-200015" >3701</a>, <a +href="glossaries-user.html#dx1-202017" >3702</a>, <a +href="glossaries-user.html#dx1-206010" >3703</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\nopostdot</span></span></span>  <a +href="glossaries-user.html#dx1-202034" >3704</a> <br /></span> + + +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\null</span></span></span>  <a +href="glossaries-user.html#dx1-141009" >3705</a>, <a +href="glossaries-user.html#dx1-141010" >3706</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\number</span></span></span>  <a +href="glossaries-user.html#dx1-129027" >3707</a> <br /></span> <span class="index-item">number list  <a -href="glossaries-user.html#dx1-3047" ><span -class="cmbx-10">1627</span></a>, <a -href="glossaries-user.html#dx1-6010" >1628</a>, <a -href="glossaries-user.html#dx1-7007" >1629</a>, <a -href="glossaries-user.html#dx1-9007" >1630</a>, <a -href="glossaries-user.html#dx1-10002" >1631</a>, <a -href="glossaries-user.html#dx1-11033" >1632</a>, <a -href="glossaries-user.html#dx1-11047" >1633</a>, <a -href="glossaries-user.html#dx1-11109" >1634</a>, <a -href="glossaries-user.html#dx1-16006" >1635</a>, <a -href="glossaries-user.html#dx1-16074" >1636</a>, <a -href="glossaries-user.html#dx1-23052" >1637</a>, <a -href="glossaries-user.html#dx1-23128" >1638</a>, <a -href="glossaries-user.html#dx1-25060" >1639</a>, <a -href="glossaries-user.html#dx1-25063" >1640</a>, <a -href="glossaries-user.html#dx1-25066" >1641</a>, <a -href="glossaries-user.html#dx1-25067" >1642</a>, <a -href="glossaries-user.html#dx1-25069" >1643</a>, <a -href="glossaries-user.html#dx1-25079" >1644</a>, <a -href="glossaries-user.html#dx1-33016" >1645</a>, <a -href="glossaries-user.html#dx1-33020" >1646</a>, <a -href="glossaries-user.html#dx1-33021" >1647</a>, <a -href="glossaries-user.html#dx1-34108" >1648</a>, <a -href="glossaries-user.html#dx1-34110" >1649</a>, <a -href="glossaries-user.html#dx1-34114" >1650</a>, <a -href="glossaries-user.html#dx1-34115" >1651</a>, <a -href="glossaries-user.html#dx1-41002" >1652</a>, <a -href="glossaries-user.html#dx1-43003" >1653</a>, <a -href="glossaries-user.html#dx1-49001" >1654</a>, <a -href="glossaries-user.html#dx1-49005" >1655</a>, <a -href="glossaries-user.html#dx1-49011" >1656</a>, <a -href="glossaries-user.html#dx1-49012" >1657</a>, <a -href="glossaries-user.html#dx1-49014" >1658</a>, <a -href="glossaries-user.html#dx1-50001" >1659</a>, <a -href="glossaries-user.html#dx1-50006" >1660</a>, <a -href="glossaries-user.html#dx1-50007" >1661</a>, <a -href="glossaries-user.html#dx1-50010" >1662</a>, <a -href="glossaries-user.html#dx1-50015" >1663</a>, <a -href="glossaries-user.html#dx1-51017" >1664</a>, <a -href="glossaries-user.html#dx1-52018" >1665</a>, <a -href="glossaries-user.html#dx1-52021" >1666</a>, <a -href="glossaries-user.html#dx1-54004" >1667</a>, <a -href="glossaries-user.html#dx1-54009" >1668</a>, <a -href="glossaries-user.html#dx1-59006" >1669</a>, <a -href="glossaries-user.html#dx1-60019" >1670</a>, <a -href="glossaries-user.html#dx1-60020" >1671</a>, <a -href="glossaries-user.html#dx1-60021" >1672</a>, <a -href="glossaries-user.html#dx1-60025" >1673</a>, <a -href="glossaries-user.html#dx1-62062" >1674</a>, <a -href="glossaries-user.html#dx1-63011" >1675</a>, <a -href="glossaries-user.html#dx1-66002" >1676</a>, <a -href="glossaries-user.html#dx1-66051" >1677</a>, <a -href="glossaries-user.html#dx1-66062" >1678</a>, <a -href="glossaries-user.html#dx1-68002" >1679</a>, <a -href="glossaries-user.html#dx1-79014" >1680</a>, <a -href="glossaries-user.html#dx1-79038" >1681</a>, <a -href="glossaries-user.html#dx1-79041" >1682</a>, <a -href="glossaries-user.html#dx1-80011" >1683</a>, <a -href="glossaries-user.html#dx1-80021" >1684</a>, <a -href="glossaries-user.html#dx1-81011" >1685</a>, <a -href="glossaries-user.html#dx1-81021" >1686</a>, <a -href="glossaries-user.html#dx1-83016" >1687</a>, <a -href="glossaries-user.html#dx1-83026" >1688</a>, <a -href="glossaries-user.html#dx1-84013" >1689</a>, <a -href="glossaries-user.html#dx1-84023" >1690</a>, <a -href="glossaries-user.html#dx1-87003" >1691</a>, <a -href="glossaries-user.html#dx1-88039" >1692</a>, <a -href="glossaries-user.html#dx1-88080" >1693</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-3059" ><span +class="cmbx-10">3708</span></a>, <a +href="glossaries-user.html#dx1-6019" >3709</a>, <a +href="glossaries-user.html#dx1-7011" >3710</a>, <a +href="glossaries-user.html#dx1-9038" >3711</a>, <a +href="glossaries-user.html#dx1-10006" >3712</a>, <a +href="glossaries-user.html#dx1-16007" >3713</a>, <a +href="glossaries-user.html#dx1-16077" >3714</a>, <a +href="glossaries-user.html#dx1-31006" >3715</a>, <a +href="glossaries-user.html#dx1-45001" >3716</a>, <a +href="glossaries-user.html#dx1-45009" >3717</a>, <a +href="glossaries-user.html#dx1-55001" >3718</a>, <a +href="glossaries-user.html#dx1-55004" >3719</a>, <a +href="glossaries-user.html#dx1-55007" >3720</a>, <a +href="glossaries-user.html#dx1-55008" >3721</a>, <a +href="glossaries-user.html#dx1-56001" >3722</a>, <a +href="glossaries-user.html#dx1-57002" >3723</a>, <a +href="glossaries-user.html#dx1-67005" >3724</a>, <a +href="glossaries-user.html#dx1-111016" >3725</a>, <a +href="glossaries-user.html#dx1-111020" >3726</a>, <a +href="glossaries-user.html#dx1-111021" >3727</a>, <a +href="glossaries-user.html#dx1-112111" >3728</a>, <a +href="glossaries-user.html#dx1-112113" >3729</a>, <a +href="glossaries-user.html#dx1-112117" >3730</a>, <a +href="glossaries-user.html#dx1-112118" >3731</a>, <a +href="glossaries-user.html#dx1-119002" >3732</a>, <a +href="glossaries-user.html#dx1-121003" >3733</a>, <a +href="glossaries-user.html#dx1-127001" >3734</a>, <a +href="glossaries-user.html#dx1-127005" >3735</a>, <a +href="glossaries-user.html#dx1-127011" >3736</a>, <a +href="glossaries-user.html#dx1-127012" >3737</a>, <a +href="glossaries-user.html#dx1-127014" >3738</a>, <a +href="glossaries-user.html#dx1-128001" >3739</a>, <a +href="glossaries-user.html#dx1-128006" >3740</a>, <a +href="glossaries-user.html#dx1-128007" >3741</a>, <a +href="glossaries-user.html#dx1-128010" >3742</a>, <a +href="glossaries-user.html#dx1-128015" >3743</a>, <a +href="glossaries-user.html#dx1-129018" >3744</a>, <a +href="glossaries-user.html#dx1-130018" >3745</a>, <a +href="glossaries-user.html#dx1-130021" >3746</a>, <a +href="glossaries-user.html#dx1-132004" >3747</a>, <a +href="glossaries-user.html#dx1-132009" >3748</a>, <a +href="glossaries-user.html#dx1-137008" >3749</a>, <a +href="glossaries-user.html#dx1-138019" >3750</a>, <a +href="glossaries-user.html#dx1-138020" >3751</a>, <a +href="glossaries-user.html#dx1-138021" >3752</a>, <a +href="glossaries-user.html#dx1-138025" >3753</a>, <a +href="glossaries-user.html#dx1-140061" >3754</a>, <a +href="glossaries-user.html#dx1-141013" >3755</a>, <a +href="glossaries-user.html#dx1-144002" >3756</a>, <a +href="glossaries-user.html#dx1-144054" >3757</a>, <a +href="glossaries-user.html#dx1-144065" >3758</a>, <a +href="glossaries-user.html#dx1-146002" >3759</a>, <a +href="glossaries-user.html#dx1-157014" >3760</a>, <a +href="glossaries-user.html#dx1-157038" >3761</a>, <a +href="glossaries-user.html#dx1-157041" >3762</a>, <a +href="glossaries-user.html#dx1-158011" >3763</a>, <a +href="glossaries-user.html#dx1-158021" >3764</a>, <a +href="glossaries-user.html#dx1-159011" >3765</a>, <a +href="glossaries-user.html#dx1-159021" >3766</a>, <a +href="glossaries-user.html#dx1-161016" >3767</a>, <a +href="glossaries-user.html#dx1-161026" >3768</a>, <a +href="glossaries-user.html#dx1-162013" >3769</a>, <a +href="glossaries-user.html#dx1-162023" >3770</a>, <a +href="glossaries-user.html#dx1-165003" >3771</a>, <a +href="glossaries-user.html#dx1-166039" >3772</a>, <a +href="glossaries-user.html#dx1-166080" >3773</a>, <a +href="glossaries-user.html#dx1-176001" >3774</a>, <a +href="glossaries-user.html#dx1-188005" >3775</a>, <a +href="glossaries-user.html#dx1-189001" >3776</a>, <a +href="glossaries-user.html#dx1-189066" >3777</a>, <a +href="glossaries-user.html#dx1-189070" >3778</a>, <a +href="glossaries-user.html#dx1-190011" >3779</a>, <a +href="glossaries-user.html#dx1-193028" >3780</a>, <a +href="glossaries-user.html#dx1-193034" >3781</a>, <a +href="glossaries-user.html#dx1-193035" >3782</a>, <a +href="glossaries-user.html#dx1-193036" >3783</a>, <a +href="glossaries-user.html#dx1-204031" >3784</a>, <a +href="glossaries-user.html#dx1-204033" >3785</a>, <a +href="glossaries-user.html#dx1-211016" >3786</a>, <a +href="glossaries-user.html#dx1-214016" >3787</a>, <a +href="glossaries-user.html#dx1-214034" >3788</a>, <a +href="glossaries-user.html#dx1-216004" >3789</a>, <a +href="glossaries-user.html#dx1-220001" >3790</a>, <a +href="glossaries-user.html#dx1-220005" >3791</a>, <a +href="glossaries-user.html#dx1-220006" >3792</a>, <a +href="glossaries-user.html#dx1-220009" >3793</a>, <a +href="glossaries-user.html#dx1-220030" >3794</a>, <a +href="glossaries-user.html#dx1-220033" >3795</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\numberline</span></span></span>  <a +href="glossaries-user.html#dx1-40002" >3796</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">O</span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\oldacronym</span></span></span>  <a -href="glossaries-user.html#dx1-74004" ><span -class="cmti-10">1694</span></a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-152004" ><span +class="cmti-10">3797</span></a>, <a +href="glossaries-user.html#dx1-152007" >3798</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">P</span> <span class="index-item">package options:<br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">abbreviations</span>  <a +href="glossaries-user.html#dx1-4011" >3799</a>, <a +href="glossaries-user.html#dx1-90016" >3800</a>, <a +href="glossaries-user.html#x1-920002.7" >3801</a>, <a +href="glossaries-user.html#dx1-147005" >3802</a>, <a +href="glossaries-user.html#dx1-172009" >3803</a>, <a +href="glossaries-user.html#dx1-175037" >3804</a>, <a +href="glossaries-user.html#dx1-175044" >3805</a>, <a +href="glossaries-user.html#dx1-179009" >3806</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">accsupp</span>  <a +href="glossaries-user.html#x1-1020002.8" >3807</a>, <a +href="glossaries-user.html#dx1-172008" >3808</a>, <a +href="glossaries-user.html#dx1-224039" >3809</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">acronym</span>  <a -href="glossaries-user.html#dx1-14026" >1695</a>, <a -href="glossaries-user.html#dx1-19015" >1696</a>, <a -href="glossaries-user.html#dx1-19019" >1697</a>, <a -href="glossaries-user.html#dx1-20011" >1698</a>, <a -href="glossaries-user.html#dx1-20016" >1699</a>, <a -href="glossaries-user.html#dx1-22001" >1700</a>, <a -href="glossaries-user.html#dx1-22003" >1701</a>, <a -href="glossaries-user.html#dx1-23027" >1702</a>, <a -href="glossaries-user.html#dx1-24043" >1703</a>, <a -href="glossaries-user.html#dx1-24044" >1704</a>, <a -href="glossaries-user.html#dx1-27001" >1705</a>, <a -href="glossaries-user.html#dx1-27006" >1706</a>, <a -href="glossaries-user.html#dx1-27021" >1707</a>, <a -href="glossaries-user.html#dx1-30015" >1708</a>, <a -href="glossaries-user.html#dx1-44019" >1709</a>, <a -href="glossaries-user.html#dx1-44020" >1710</a>, <a -href="glossaries-user.html#dx1-44025" >1711</a>, <a -href="glossaries-user.html#dx1-59011" >1712</a>, <a -href="glossaries-user.html#dx1-68014" >1713</a>, <a -href="glossaries-user.html#dx1-68015" >1714</a>, <a -href="glossaries-user.html#dx1-68017" >1715</a>, <a -href="glossaries-user.html#dx1-73005" >1716</a>, <a -href="glossaries-user.html#dx1-27011" >1717</a>, <a -href="glossaries-user.html#dx1-44024" >1718</a> <br /></span> +href="glossaries-user.html#dx1-14026" >3810</a>, <a +href="glossaries-user.html#dx1-19015" >3811</a>, <a +href="glossaries-user.html#dx1-19019" >3812</a>, <a +href="glossaries-user.html#dx1-20011" >3813</a>, <a +href="glossaries-user.html#dx1-20016" >3814</a>, <a +href="glossaries-user.html#dx1-25001" >3815</a>, <a +href="glossaries-user.html#dx1-25003" >3816</a>, <a +href="glossaries-user.html#dx1-43008" >3817</a>, <a +href="glossaries-user.html#dx1-43009" >3818</a>, <a +href="glossaries-user.html#dx1-84002" >3819</a>, <a +href="glossaries-user.html#x1-900002.7" >3820</a>, <a +href="glossaries-user.html#dx1-90005" >3821</a>, <a +href="glossaries-user.html#dx1-90018" >3822</a>, <a +href="glossaries-user.html#dx1-90023" >3823</a>, <a +href="glossaries-user.html#dx1-93002" >3824</a>, <a +href="glossaries-user.html#dx1-108015" >3825</a>, <a +href="glossaries-user.html#dx1-122019" >3826</a>, <a +href="glossaries-user.html#dx1-122020" >3827</a>, <a +href="glossaries-user.html#dx1-122025" >3828</a>, <a +href="glossaries-user.html#dx1-137016" >3829</a>, <a +href="glossaries-user.html#dx1-146016" >3830</a>, <a +href="glossaries-user.html#dx1-146017" >3831</a>, <a +href="glossaries-user.html#dx1-146019" >3832</a>, <a +href="glossaries-user.html#dx1-151005" >3833</a>, <a +href="glossaries-user.html#dx1-172006" >3834</a>, <a +href="glossaries-user.html#dx1-175011" >3835</a>, <a +href="glossaries-user.html#dx1-175019" >3836</a>, <a +href="glossaries-user.html#dx1-175020" >3837</a>, <a +href="glossaries-user.html#dx1-175033" >3838</a>, <a +href="glossaries-user.html#dx1-175035" >3839</a>, <a +href="glossaries-user.html#dx1-175043" >3840</a>, <a +href="glossaries-user.html#dx1-179001" >3841</a>, <a +href="glossaries-user.html#dx1-179008" >3842</a>, <a +href="glossaries-user.html#dx1-90010" >3843</a>, <a +href="glossaries-user.html#dx1-122024" >3844</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-22002" >1719</a>, <a -href="glossaries-user.html#dx1-27018" >1720</a> <br /></span> - - +href="glossaries-user.html#dx1-25002" >3845</a>, <a +href="glossaries-user.html#dx1-91001" >3846</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">acronymlists</span>  <a -href="glossaries-user.html#dx1-27019" >1721</a>, <a -href="glossaries-user.html#dx1-27020" >1722</a>, <a -href="glossaries-user.html#dx1-27023" >1723</a>, <a -href="glossaries-user.html#dx1-57010" >1724</a>, <a -href="glossaries-user.html#dx1-68018" >1725</a>, <a -href="glossaries-user.html#dx1-69016" >1726</a>, <a -href="glossaries-user.html#dx1-90004" >1727</a> <br /></span> +href="glossaries-user.html#x1-930002.7" >3847</a>, <a +href="glossaries-user.html#dx1-93001" >3848</a>, <a +href="glossaries-user.html#dx1-93004" >3849</a>, <a +href="glossaries-user.html#dx1-135010" >3850</a>, <a +href="glossaries-user.html#dx1-146020" >3851</a>, <a +href="glossaries-user.html#dx1-147015" >3852</a>, <a +href="glossaries-user.html#dx1-168004" >3853</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">acronyms</span>  <a -href="glossaries-user.html#dx1-23028" >1728</a>, <a -href="glossaries-user.html#dx1-27017" >1729</a> <br /></span> +href="glossaries-user.html#dx1-84003" >3854</a>, <a +href="glossaries-user.html#dx1-90024" >3855</a>, <a +href="glossaries-user.html#x1-910002.7" >3856</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">automake</span>  <a -href="glossaries-user.html#dx1-7006" >1730</a>, <a -href="glossaries-user.html#dx1-16005" >1731</a>, <a -href="glossaries-user.html#dx1-26077" >1732</a>, <a -href="glossaries-user.html#dx1-26091" >1733</a> <br /></span> +href="glossaries-user.html#dx1-7010" >3857</a>, <a +href="glossaries-user.html#dx1-16006" >3858</a>, <a +href="glossaries-user.html#x1-790002.5" >3859</a>, <a +href="glossaries-user.html#dx1-79014" >3860</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-26098" >1734</a> <br /></span> +href="glossaries-user.html#dx1-79021" >3861</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">immediate</span>  <a -href="glossaries-user.html#dx1-26082" >1735</a>, <a -href="glossaries-user.html#dx1-26087" >1736</a>, <a -href="glossaries-user.html#dx1-26088" >1737</a> <br /></span> +href="glossaries-user.html#dx1-79005" >3862</a>, <a +href="glossaries-user.html#dx1-79010" >3863</a>, <a +href="glossaries-user.html#dx1-79011" >3864</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-26078" >1738</a>, <a -href="glossaries-user.html#dx1-26086" >1739</a> <br /></span> +href="glossaries-user.html#dx1-79001" >3865</a>, <a +href="glossaries-user.html#dx1-79009" >3866</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">autoseeindex</span>  <a +href="glossaries-user.html#x1-660002.4" >3867</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">false</span>  <a +href="glossaries-user.html#dx1-204008" >3868</a>, <a +href="glossaries-user.html#dx1-204020" >3869</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">compatible-2.07</span>  <a -href="glossaries-user.html#dx1-29032" >1740</a>, <a -href="glossaries-user.html#dx1-30012" >1741</a>, <a -href="glossaries-user.html#dx1-33010" >1742</a> <br /></span> +href="glossaries-user.html#x1-1050002.8" >3870</a>, <a +href="glossaries-user.html#dx1-108012" >3871</a>, <a +href="glossaries-user.html#dx1-111010" >3872</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">compatible-3.07</span>  <a -href="glossaries-user.html#dx1-27004" >1743</a>, <a -href="glossaries-user.html#dx1-29033" >1744</a>, <a -href="glossaries-user.html#dx1-57005" >1745</a> <br /></span> +href="glossaries-user.html#dx1-90003" >3873</a>, <a +href="glossaries-user.html#x1-1060002.8" >3874</a>, <a +href="glossaries-user.html#dx1-135005" >3875</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">counter</span>  <a -href="glossaries-user.html#dx1-25077" >1746</a>, <a -href="glossaries-user.html#dx1-33017" >1747</a>, <a -href="glossaries-user.html#dx1-49003" >1748</a>, <a -href="glossaries-user.html#dx1-66004" >1749</a>, <a -href="glossaries-user.html#dx1-66038" >1750</a> <br /></span> +href="glossaries-user.html#x1-570002.3" >3876</a>, <a +href="glossaries-user.html#dx1-111017" >3877</a>, <a +href="glossaries-user.html#dx1-127003" >3878</a>, <a +href="glossaries-user.html#dx1-144004" >3879</a>, <a +href="glossaries-user.html#dx1-144041" >3880</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">equation</span>  <a +href="glossaries-user.html#dx1-189002" >3881</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">page</span>  <a -href="glossaries-user.html#dx1-25078" >1751</a> <br /></span> +href="glossaries-user.html#dx1-57001" >3882</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">counterwithin</span>  <a -href="glossaries-user.html#dx1-25010" >1752</a>, <a -href="glossaries-user.html#dx1-25014" >1753</a>, <a -href="glossaries-user.html#dx1-78002" >1754</a>, <a -href="glossaries-user.html#dx1-88047" >1755</a>, <a -href="glossaries-user.html#dx1-88084" >1756</a> <br /></span> +href="glossaries-user.html#x1-470002.3" >3883</a>, <a +href="glossaries-user.html#dx1-47004" >3884</a>, <a +href="glossaries-user.html#dx1-156002" >3885</a>, <a +href="glossaries-user.html#dx1-166047" >3886</a>, <a +href="glossaries-user.html#dx1-166084" >3887</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">debug</span>  <a -href="glossaries-user.html#dx1-23008" >1757</a>, <a -href="glossaries-user.html#dx1-23019" >1758</a>, <a -href="glossaries-user.html#dx1-23020" >1759</a> <br /></span> +href="glossaries-user.html#dx1-27002" >3888</a>, <a +href="glossaries-user.html#x1-300002.1" >3889</a>, <a +href="glossaries-user.html#dx1-30019" >3890</a>, <a +href="glossaries-user.html#dx1-30020" >3891</a> <br /></span> +<span class="index-subsubitem">        <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">all</span>  <a +href="glossaries-user.html#dx1-30004" >3892</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23009" >1760</a> <br /></span> +href="glossaries-user.html#dx1-30001" >3893</a>, <a +href="glossaries-user.html#dx1-30005" >3894</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">showaccsupp</span>  <a +href="glossaries-user.html#dx1-30011" >3895</a>, <a +href="glossaries-user.html#dx1-172076" >3896</a>, <a +href="glossaries-user.html#dx1-224034" >3897</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">showtargets</span>  <a -href="glossaries-user.html#dx1-23004" >1761</a>, <a -href="glossaries-user.html#dx1-23012" >1762</a>, <a -href="glossaries-user.html#dx1-23014" >1763</a> <br /></span> +href="glossaries-user.html#dx1-30007" >3898</a> <br /></span> +<span class="index-subsubitem">        <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">showwrgloss</span>  <a +href="glossaries-user.html#dx1-30003" >3899</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-23003" >1764</a>, <a -href="glossaries-user.html#dx1-23010" >1765</a>, <a -href="glossaries-user.html#dx1-23011" >1766</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">description</span>  <a -href="glossaries-user.html#dx1-28002" >1767</a>, <a -href="glossaries-user.html#dx1-28014" >1768</a>, <a -href="glossaries-user.html#dx1-28015" >1769</a>, <a -href="glossaries-user.html#dx1-28022" >1770</a>, <a -href="glossaries-user.html#dx1-28023" >1771</a>, <a -href="glossaries-user.html#dx1-28029" >1772</a>, <a -href="glossaries-user.html#dx1-28031" >1773</a>, <a -href="glossaries-user.html#dx1-28033" >1774</a>, <a -href="glossaries-user.html#dx1-28036" >1775</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">dua</span>  <a -href="glossaries-user.html#dx1-28011" >1776</a>, <a -href="glossaries-user.html#dx1-28034" >1777</a> <br /></span> +href="glossaries-user.html#dx1-30002" >3900</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">description </span>(deprecated)  <a +href="glossaries-user.html#x1-960002.7.1" >3901</a>, <a +href="glossaries-user.html#dx1-97002" >3902</a>, <a +href="glossaries-user.html#dx1-97003" >3903</a>, <a +href="glossaries-user.html#dx1-98005" >3904</a>, <a +href="glossaries-user.html#dx1-98006" >3905</a>, <a +href="glossaries-user.html#dx1-99004" >3906</a>, <a +href="glossaries-user.html#dx1-99006" >3907</a>, <a +href="glossaries-user.html#dx1-99008" >3908</a>, <a +href="glossaries-user.html#dx1-100002" >3909</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">disablemakegloss</span>  <a +href="glossaries-user.html#x1-800002.5" >3910</a>, <a +href="glossaries-user.html#dx1-81001" >3911</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">docdef</span>  <a +href="glossaries-user.html#x1-370002.1" >3912</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">atom</span>  <a +href="glossaries-user.html#dx1-23002" >3913</a>, <a +href="glossaries-user.html#dx1-35003" >3914</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">false</span>  <a +href="glossaries-user.html#dx1-5013" >3915</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">restricted</span>  <a +href="glossaries-user.html#dx1-5012" >3916</a>, <a +href="glossaries-user.html#dx1-5014" >3917</a>, <a +href="glossaries-user.html#dx1-23004" >3918</a>, <a +href="glossaries-user.html#dx1-31004" >3919</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">true</span>  <a +href="glossaries-user.html#dx1-5011" >3920</a>, <a +href="glossaries-user.html#dx1-37007" >3921</a> <br /></span> + + +<span class="index-subitem">    <span +class="cmss-10">dua </span>(deprecated)  <a +href="glossaries-user.html#dx1-96009" >3922</a>, <a +href="glossaries-user.html#x1-1000002.7.1" >3923</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">entrycounter</span>  <a -href="glossaries-user.html#dx1-25001" >1778</a>, <a -href="glossaries-user.html#dx1-25023" >1779</a>, <a -href="glossaries-user.html#dx1-78001" >1780</a>, <a -href="glossaries-user.html#dx1-88046" >1781</a>, <a -href="glossaries-user.html#dx1-88083" >1782</a> <br /></span> +href="glossaries-user.html#x1-460002.3" >3924</a>, <a +href="glossaries-user.html#dx1-48004" >3925</a>, <a +href="glossaries-user.html#dx1-156001" >3926</a>, <a +href="glossaries-user.html#dx1-166046" >3927</a>, <a +href="glossaries-user.html#dx1-166083" >3928</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-25002" >1783</a> <br /></span> +href="glossaries-user.html#dx1-46001" >3929</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-25011" >1784</a> <br /></span> +href="glossaries-user.html#dx1-47001" >3930</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">equations</span>  <a +href="glossaries-user.html#x1-680002.4" >3931</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">esclocations</span>  <a -href="glossaries-user.html#dx1-23040" >1785</a> <br /></span> +href="glossaries-user.html#x1-630002.4" >3932</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23043" >1786</a>, <a -href="glossaries-user.html#dx1-23048" >1787</a>, <a -href="glossaries-user.html#dx1-51001" >1788</a> <br /></span> +href="glossaries-user.html#dx1-63003" >3933</a>, <a +href="glossaries-user.html#dx1-63009" >3934</a>, <a +href="glossaries-user.html#dx1-129002" >3935</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-23041" >1789</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">footnote</span>  <a -href="glossaries-user.html#dx1-28006" >1790</a>, <a -href="glossaries-user.html#dx1-28007" >1791</a>, <a -href="glossaries-user.html#dx1-28009" >1792</a>, <a -href="glossaries-user.html#dx1-28016" >1793</a>, <a -href="glossaries-user.html#dx1-28024" >1794</a>, <a -href="glossaries-user.html#dx1-28025" >1795</a> <br /></span> +href="glossaries-user.html#dx1-63001" >3936</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">floats</span>  <a +href="glossaries-user.html#x1-690002.4" >3937</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">footnote </span>(deprecated)  <a +href="glossaries-user.html#dx1-96004" >3938</a>, <a +href="glossaries-user.html#dx1-96005" >3939</a>, <a +href="glossaries-user.html#dx1-96007" >3940</a>, <a +href="glossaries-user.html#dx1-97004" >3941</a>, <a +href="glossaries-user.html#dx1-98007" >3942</a>, <a +href="glossaries-user.html#x1-990002.7.1" >3943</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">hyperfirst</span>  <a -href="glossaries-user.html#dx1-23097" >1796</a>, <a -href="glossaries-user.html#dx1-23107" >1797</a>, <a -href="glossaries-user.html#dx1-58015" >1798</a>, <a -href="glossaries-user.html#dx1-58017" >1799</a> <br /></span> +href="glossaries-user.html#x1-340002.1" >3944</a>, <a +href="glossaries-user.html#dx1-34010" >3945</a>, <a +href="glossaries-user.html#dx1-136015" >3946</a>, <a +href="glossaries-user.html#dx1-136017" >3947</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23111" >1800</a>, <a -href="glossaries-user.html#dx1-54037" >1801</a>, <a -href="glossaries-user.html#dx1-58010" >1802</a>, <a -href="glossaries-user.html#dx1-58013" >1803</a>, <a -href="glossaries-user.html#dx1-71072" >1804</a> <br /></span> +href="glossaries-user.html#dx1-34014" >3948</a>, <a +href="glossaries-user.html#dx1-132037" >3949</a>, <a +href="glossaries-user.html#dx1-136010" >3950</a>, <a +href="glossaries-user.html#dx1-136013" >3951</a>, <a +href="glossaries-user.html#dx1-149073" >3952</a>, <a +href="glossaries-user.html#dx1-183001" >3953</a>, <a +href="glossaries-user.html#dx1-183005" >3954</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-23098" >1805</a>, <a -href="glossaries-user.html#dx1-23102" >1806</a> <br /></span> +href="glossaries-user.html#dx1-34001" >3955</a>, <a +href="glossaries-user.html#dx1-34005" >3956</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">index</span>  <a -href="glossaries-user.html#dx1-23031" >1807</a>, <a -href="glossaries-user.html#dx1-29013" >1808</a>, <a -href="glossaries-user.html#dx1-29025" >1809</a>, <a -href="glossaries-user.html#dx1-29028" >1810</a>, <a -href="glossaries-user.html#dx1-29030" >1811</a>, <a -href="glossaries-user.html#dx1-29031" >1812</a>, <a -href="glossaries-user.html#dx1-68021" >1813</a> <br /></span> +href="glossaries-user.html#dx1-84006" >3957</a>, <a +href="glossaries-user.html#x1-870002.6" >3958</a>, <a +href="glossaries-user.html#dx1-87012" >3959</a>, <a +href="glossaries-user.html#dx1-87015" >3960</a>, <a +href="glossaries-user.html#dx1-88001" >3961</a>, <a +href="glossaries-user.html#dx1-88002" >3962</a>, <a +href="glossaries-user.html#dx1-146023" >3963</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">indexcounter</span>  <a +href="glossaries-user.html#x1-700002.4" >3964</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">indexcrossrefs</span>  <a +href="glossaries-user.html#x1-650002.4" >3965</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">indexonlyfirst</span>  <a -href="glossaries-user.html#dx1-23121" >1814</a>, <a -href="glossaries-user.html#dx1-23126" >1815</a>, <a -href="glossaries-user.html#dx1-49009" >1816</a> <br /></span> +href="glossaries-user.html#x1-640002.4" >3966</a>, <a +href="glossaries-user.html#dx1-64006" >3967</a>, <a +href="glossaries-user.html#dx1-64008" >3968</a>, <a +href="glossaries-user.html#dx1-127009" >3969</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23122" >1817</a> <br /></span> +href="glossaries-user.html#dx1-64001" >3970</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">kernelglossredefs</span>  <a -href="glossaries-user.html#dx1-29034" >1818</a> <br /></span> +href="glossaries-user.html#x1-1070002.8" >3971</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-29036" >1819</a> <br /></span> +href="glossaries-user.html#dx1-107002" >3972</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">makeindex</span>  <a -href="glossaries-user.html#dx1-22004" >1820</a>, <a -href="glossaries-user.html#dx1-26054" >1821</a>, <a -href="glossaries-user.html#dx1-30005" >1822</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">ngerman</span>  <a -href="glossaries-user.html#dx1-13034" >1823</a> <br /></span> +href="glossaries-user.html#dx1-25004" >3973</a>, <a +href="glossaries-user.html#x1-750002.5" >3974</a>, <a +href="glossaries-user.html#dx1-108005" >3975</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">noglossaryindex</span>  <a -href="glossaries-user.html#dx1-29029" >1824</a> <br /></span> +href="glossaries-user.html#x1-880002.6" >3976</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nogroupskip</span>  <a -href="glossaries-user.html#dx1-11018" >1825</a>, <a -href="glossaries-user.html#dx1-25082" >1826</a>, <a -href="glossaries-user.html#dx1-63044" >1827</a>, <a -href="glossaries-user.html#dx1-78009" >1828</a>, <a -href="glossaries-user.html#dx1-78037" >1829</a>, <a -href="glossaries-user.html#dx1-82020" >1830</a>, <a -href="glossaries-user.html#dx1-88037" >1831</a>, <a -href="glossaries-user.html#dx1-88096" >1832</a> <br /></span> +href="glossaries-user.html#x1-590002.3" >3977</a>, <a +href="glossaries-user.html#dx1-141046" >3978</a>, <a +href="glossaries-user.html#dx1-156009" >3979</a>, <a +href="glossaries-user.html#dx1-156037" >3980</a>, <a +href="glossaries-user.html#dx1-160020" >3981</a>, <a +href="glossaries-user.html#dx1-166037" >3982</a>, <a +href="glossaries-user.html#dx1-166096" >3983</a>, <a +href="glossaries-user.html#dx1-219001" >3984</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-25083" >1833</a> <br /></span> +href="glossaries-user.html#dx1-59001" >3985</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">nohyperfirst</span>  <a +href="glossaries-user.html#dx1-34025" >3986</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nohypertypes</span>  <a -href="glossaries-user.html#dx1-23093" >1834</a>, <a -href="glossaries-user.html#dx1-23100" >1835</a>, <a -href="glossaries-user.html#dx1-23101" >1836</a>, <a -href="glossaries-user.html#dx1-23108" >1837</a>, <a -href="glossaries-user.html#dx1-54022" >1838</a>, <a -href="glossaries-user.html#dx1-54029" >1839</a>, <a -href="glossaries-user.html#dx1-57026" >1840</a>, <a -href="glossaries-user.html#dx1-58004" >1841</a>, <a -href="glossaries-user.html#dx1-68011" >1842</a> <br /></span> +href="glossaries-user.html#dx1-34003" >3987</a>, <a +href="glossaries-user.html#dx1-34004" >3988</a>, <a +href="glossaries-user.html#dx1-34011" >3989</a>, <a +href="glossaries-user.html#x1-830002.6" >3990</a>, <a +href="glossaries-user.html#dx1-132022" >3991</a>, <a +href="glossaries-user.html#dx1-132029" >3992</a>, <a +href="glossaries-user.html#dx1-135026" >3993</a>, <a +href="glossaries-user.html#dx1-136004" >3994</a>, <a +href="glossaries-user.html#dx1-146011" >3995</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">index</span>  <a -href="glossaries-user.html#dx1-29026" >1843</a> <br /></span> +href="glossaries-user.html#dx1-87013" >3996</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nolangwarn</span>  <a -href="glossaries-user.html#dx1-4" >1844</a>, <a -href="glossaries-user.html#dx1-23005" >1845</a> <br /></span> +href="glossaries-user.html#dx1-3" >3997</a>, <a +href="glossaries-user.html#x1-280002.1" >3998</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nolist</span>  <a -href="glossaries-user.html#dx1-25041" >1846</a>, <a -href="glossaries-user.html#dx1-30008" >1847</a>, <a -href="glossaries-user.html#dx1-79004" >1848</a> <br /></span> +href="glossaries-user.html#x1-520002.3" >3999</a>, <a +href="glossaries-user.html#dx1-108008" >4000</a>, <a +href="glossaries-user.html#dx1-157004" >4001</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nolong</span>  <a -href="glossaries-user.html#dx1-25033" >1849</a>, <a -href="glossaries-user.html#dx1-30006" >1850</a>, <a -href="glossaries-user.html#dx1-80004" >1851</a>, <a -href="glossaries-user.html#dx1-78019" >1852</a> <br /></span> +href="glossaries-user.html#x1-500002.3" >4002</a>, <a +href="glossaries-user.html#dx1-108006" >4003</a>, <a +href="glossaries-user.html#dx1-158004" >4004</a>, <a +href="glossaries-user.html#dx1-202004" >4005</a>, <a +href="glossaries-user.html#dx1-156019" >4006</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nomain</span>  <a -href="glossaries-user.html#dx1-23026" >1853</a>, <a -href="glossaries-user.html#dx1-27016" >1854</a>, <a -href="glossaries-user.html#dx1-29005" >1855</a>, <a -href="glossaries-user.html#dx1-29011" >1856</a>, <a -href="glossaries-user.html#dx1-29020" >1857</a>, <a -href="glossaries-user.html#dx1-29037" >1858</a>, <a -href="glossaries-user.html#dx1-30011" >1859</a>, <a -href="glossaries-user.html#dx1-68013" >1860</a>, <a -href="glossaries-user.html#dx1-27013" >1861</a> <br /></span> +href="glossaries-user.html#x1-840002.6" >4007</a>, <a +href="glossaries-user.html#dx1-85004" >4008</a>, <a +href="glossaries-user.html#dx1-86004" >4009</a>, <a +href="glossaries-user.html#dx1-87007" >4010</a>, <a +href="glossaries-user.html#dx1-90015" >4011</a>, <a +href="glossaries-user.html#dx1-107003" >4012</a>, <a +href="glossaries-user.html#dx1-108011" >4013</a>, <a +href="glossaries-user.html#dx1-146015" >4014</a>, <a +href="glossaries-user.html#dx1-179002" >4015</a>, <a +href="glossaries-user.html#dx1-179003" >4016</a>, <a +href="glossaries-user.html#dx1-194001" >4017</a>, <a +href="glossaries-user.html#dx1-90012" >4018</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">nomissingglstext</span>  <a +href="glossaries-user.html#x1-1040002.8" >4019</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nonumberlist</span>  <a -href="glossaries-user.html#dx1-3048" >1862</a>, <a -href="glossaries-user.html#dx1-25059" >1863</a>, <a -href="glossaries-user.html#dx1-25070" >1864</a>, <a -href="glossaries-user.html#dx1-34109" >1865</a>, <a -href="glossaries-user.html#dx1-49002" >1866</a>, <a -href="glossaries-user.html#dx1-49008" >1867</a>, <a -href="glossaries-user.html#dx1-59007" >1868</a>, <a -href="glossaries-user.html#dx1-79042" >1869</a>, <a -href="glossaries-user.html#dx1-88059" >1870</a>, <a -href="glossaries-user.html#dx1-88061" >1871</a> <br /></span> +href="glossaries-user.html#dx1-3060" >4020</a>, <a +href="glossaries-user.html#x1-550002.3" >4021</a>, <a +href="glossaries-user.html#dx1-56002" >4022</a>, <a +href="glossaries-user.html#dx1-112112" >4023</a>, <a +href="glossaries-user.html#dx1-127002" >4024</a>, <a +href="glossaries-user.html#dx1-127008" >4025</a>, <a +href="glossaries-user.html#dx1-137009" >4026</a>, <a +href="glossaries-user.html#dx1-157042" >4027</a>, <a +href="glossaries-user.html#dx1-166059" >4028</a>, <a +href="glossaries-user.html#dx1-166061" >4029</a>, <a +href="glossaries-user.html#dx1-176023" >4030</a>, <a +href="glossaries-user.html#dx1-206020" >4031</a>, <a +href="glossaries-user.html#dx1-214013" >4032</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nopostdot</span>  <a -href="glossaries-user.html#dx1-25080" >1872</a>, <a -href="glossaries-user.html#dx1-78043" >1873</a> <br /></span> +href="glossaries-user.html#x1-580002.3" >4033</a>, <a +href="glossaries-user.html#dx1-156042" >4034</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-25081" >1874</a> <br /></span> - - +href="glossaries-user.html#dx1-58003" >4035</a>, <a +href="glossaries-user.html#dx1-58006" >4036</a>, <a +href="glossaries-user.html#dx1-178018" >4037</a>, <a +href="glossaries-user.html#dx1-178020" >4038</a>, <a +href="glossaries-user.html#dx1-200010" >4039</a>, <a +href="glossaries-user.html#dx1-204005" >4040</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">true</span>  <a +href="glossaries-user.html#dx1-58001" >4041</a>, <a +href="glossaries-user.html#dx1-58002" >4042</a>, <a +href="glossaries-user.html#dx1-58004" >4043</a>, <a +href="glossaries-user.html#dx1-178019" >4044</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">noredefwarn</span>  <a -href="glossaries-user.html#dx1-23006" >1875</a> <br /></span> +href="glossaries-user.html#x1-290002.1" >4045</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nostyles</span>  <a -href="glossaries-user.html#dx1-25053" >1876</a>, <a -href="glossaries-user.html#dx1-30010" >1877</a>, <a -href="glossaries-user.html#dx1-79005" >1878</a>, <a -href="glossaries-user.html#dx1-80005" >1879</a>, <a -href="glossaries-user.html#dx1-83005" >1880</a>, <a -href="glossaries-user.html#dx1-85003" >1881</a>, <a -href="glossaries-user.html#dx1-78021" >1882</a> <br /></span> +href="glossaries-user.html#dx1-11021" >4046</a>, <a +href="glossaries-user.html#dx1-11074" >4047</a>, <a +href="glossaries-user.html#x1-540002.3" >4048</a>, <a +href="glossaries-user.html#dx1-108010" >4049</a>, <a +href="glossaries-user.html#dx1-157005" >4050</a>, <a +href="glossaries-user.html#dx1-158005" >4051</a>, <a +href="glossaries-user.html#dx1-161005" >4052</a>, <a +href="glossaries-user.html#dx1-163003" >4053</a>, <a +href="glossaries-user.html#dx1-178011" >4054</a>, <a +href="glossaries-user.html#dx1-202009" >4055</a>, <a +href="glossaries-user.html#dx1-219013" >4056</a>, <a +href="glossaries-user.html#dx1-156021" >4057</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nosuper</span>  <a -href="glossaries-user.html#dx1-25037" >1883</a>, <a -href="glossaries-user.html#dx1-30007" >1884</a>, <a -href="glossaries-user.html#dx1-83004" >1885</a>, <a -href="glossaries-user.html#dx1-78020" >1886</a> <br /></span> +href="glossaries-user.html#x1-510002.3" >4058</a>, <a +href="glossaries-user.html#dx1-108007" >4059</a>, <a +href="glossaries-user.html#dx1-161004" >4060</a>, <a +href="glossaries-user.html#dx1-202005" >4061</a>, <a +href="glossaries-user.html#dx1-156020" >4062</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">notranslate</span>  <a -href="glossaries-user.html#dx1-14010" >1887</a>, <a -href="glossaries-user.html#dx1-23091" >1888</a>, <a -href="glossaries-user.html#dx1-30014" >1889</a> <br /></span> +href="glossaries-user.html#dx1-14010" >4063</a>, <a +href="glossaries-user.html#x1-330002.1" >4064</a>, <a +href="glossaries-user.html#dx1-108014" >4065</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">notree</span>  <a -href="glossaries-user.html#dx1-25047" >1890</a>, <a -href="glossaries-user.html#dx1-30009" >1891</a>, <a -href="glossaries-user.html#dx1-85002" >1892</a>, <a -href="glossaries-user.html#dx1-86011" >1893</a> <br /></span> +href="glossaries-user.html#x1-530002.3" >4066</a>, <a +href="glossaries-user.html#dx1-108009" >4067</a>, <a +href="glossaries-user.html#dx1-163002" >4068</a>, <a +href="glossaries-user.html#dx1-164011" >4069</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">nowarn</span>  <a -href="glossaries-user.html#dx1-23001" >1894</a>, <a -href="glossaries-user.html#dx1-23007" >1895</a>, <a -href="glossaries-user.html#dx1-23013" >1896</a> <br /></span> +href="glossaries-user.html#x1-270002.1" >4070</a>, <a +href="glossaries-user.html#dx1-29001" >4071</a>, <a +href="glossaries-user.html#dx1-30006" >4072</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">numberedsection</span>  <a -href="glossaries-user.html#dx1-24035" >1897</a>, <a -href="glossaries-user.html#dx1-24036" >1898</a>, <a -href="glossaries-user.html#dx1-63027" >1899</a>, <a -href="glossaries-user.html#dx1-63028" >1900</a>, <a -href="glossaries-user.html#dx1-63060" >1901</a> <br /></span> +href="glossaries-user.html#dx1-41001" >4073</a>, <a +href="glossaries-user.html#x1-430002.2" >4074</a>, <a +href="glossaries-user.html#dx1-43001" >4075</a>, <a +href="glossaries-user.html#dx1-141029" >4076</a>, <a +href="glossaries-user.html#dx1-141030" >4077</a>, <a +href="glossaries-user.html#dx1-141070" >4078</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">autolabel</span>  <a -href="glossaries-user.html#dx1-24039" >1902</a>, <a -href="glossaries-user.html#dx1-24046" >1903</a> <br /></span> +href="glossaries-user.html#dx1-43004" >4079</a>, <a +href="glossaries-user.html#dx1-43011" >4080</a>, <a +href="glossaries-user.html#dx1-141058" >4081</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-24037" >1904</a> <br /></span> +href="glossaries-user.html#dx1-43002" >4082</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">nameref</span>  <a -href="glossaries-user.html#dx1-24045" >1905</a> <br /></span> +href="glossaries-user.html#dx1-43010" >4083</a> <br /></span> + + <span class="index-subsubitem">        <span class="cmss-10">nolabel</span>  <a -href="glossaries-user.html#dx1-24038" >1906</a> <br /></span> +href="glossaries-user.html#dx1-43003" >4084</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">numberline</span>  <a -href="glossaries-user.html#dx1-24004" >1907</a>, <a -href="glossaries-user.html#dx1-24010" >1908</a> <br /></span> +href="glossaries-user.html#x1-400002.2" >4085</a>, <a +href="glossaries-user.html#dx1-40006" >4086</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">numbers</span>  <a -href="glossaries-user.html#dx1-23030" >1909</a>, <a -href="glossaries-user.html#dx1-29007" >1910</a>, <a -href="glossaries-user.html#dx1-68020" >1911</a> <br /></span> +href="glossaries-user.html#dx1-84005" >4087</a>, <a +href="glossaries-user.html#x1-860002.6" >4088</a>, <a +href="glossaries-user.html#dx1-146022" >4089</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">order</span>  <a -href="glossaries-user.html#dx1-26047" >1912</a>, <a -href="glossaries-user.html#dx1-26050" >1913</a>, <a -href="glossaries-user.html#dx1-63040" >1914</a> <br /></span> +href="glossaries-user.html#dx1-71002" >4090</a>, <a +href="glossaries-user.html#x1-740002.5" >4091</a>, <a +href="glossaries-user.html#dx1-74003" >4092</a>, <a +href="glossaries-user.html#dx1-141042" >4093</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">letter</span>  <a -href="glossaries-user.html#dx1-7034" >1915</a>, <a -href="glossaries-user.html#dx1-8034" >1916</a>, <a -href="glossaries-user.html#dx1-11061" >1917</a>, <a -href="glossaries-user.html#dx1-16085" >1918</a>, <a -href="glossaries-user.html#dx1-26049" >1919</a> <br /></span> +href="glossaries-user.html#dx1-7047" >4094</a>, <a +href="glossaries-user.html#dx1-8049" >4095</a>, <a +href="glossaries-user.html#dx1-16088" >4096</a>, <a +href="glossaries-user.html#dx1-74002" >4097</a>, <a +href="glossaries-user.html#dx1-200002" >4098</a>, <a +href="glossaries-user.html#dx1-200095" >4099</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">word</span>  <a -href="glossaries-user.html#dx1-11060" >1920</a>, <a -href="glossaries-user.html#dx1-16088" >1921</a>, <a -href="glossaries-user.html#dx1-26048" >1922</a> <br /></span> +href="glossaries-user.html#dx1-16091" >4100</a>, <a +href="glossaries-user.html#dx1-74001" >4101</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">postdot</span>  <a +href="glossaries-user.html#dx1-4012" >4102</a>, <a +href="glossaries-user.html#dx1-58005" >4103</a>, <a +href="glossaries-user.html#dx1-178021" >4104</a>, <a +href="glossaries-user.html#dx1-183031" >4105</a>, <a +href="glossaries-user.html#dx1-188018" >4106</a>, <a +href="glossaries-user.html#dx1-204006" >4107</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">postpunc</span>  <a +href="glossaries-user.html#dx1-58007" >4108</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">prefix</span>  <a +href="glossaries-user.html#x1-1030002.8" >4109</a>, <a +href="glossaries-user.html#dx1-178014" >4110</a>, <a +href="glossaries-user.html#dx1-194005" >4111</a>, <a +href="glossaries-user.html#dx1-223003" >4112</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">record</span>  <a +href="glossaries-user.html#dx1-9018" >4113</a>, <a +href="glossaries-user.html#dx1-11023" >4114</a>, <a +href="glossaries-user.html#dx1-13010" >4115</a>, <a +href="glossaries-user.html#dx1-45005" >4116</a>, <a +href="glossaries-user.html#x1-670002.4" >4117</a>, <a +href="glossaries-user.html#dx1-175048" >4118</a>, <a +href="glossaries-user.html#dx1-179044" >4119</a>, <a +href="glossaries-user.html#dx1-188013" >4120</a>, <a +href="glossaries-user.html#dx1-188015" >4121</a>, <a +href="glossaries-user.html#dx1-190024" >4122</a>, <a +href="glossaries-user.html#dx1-192037" >4123</a>, <a +href="glossaries-user.html#dx1-197007" >4124</a>, <a +href="glossaries-user.html#dx1-200057" >4125</a>, <a +href="glossaries-user.html#dx1-202050" >4126</a>, <a +href="glossaries-user.html#dx1-204019" >4127</a>, <a +href="glossaries-user.html#dx1-206007" >4128</a>, <a +href="glossaries-user.html#dx1-211037" >4129</a>, <a +href="glossaries-user.html#dx1-212007" >4130</a>, <a +href="glossaries-user.html#dx1-214012" >4131</a>, <a +href="glossaries-user.html#dx1-220045" >4132</a>, <a +href="glossaries-user.html#dx1-223008" >4133</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">alsoindex</span>  <a +href="glossaries-user.html#dx1-9021" >4134</a>, <a +href="glossaries-user.html#dx1-24010" >4135</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">nameref</span>  <a +href="glossaries-user.html#dx1-9020" >4136</a>, <a +href="glossaries-user.html#dx1-24016" >4137</a>, <a +href="glossaries-user.html#dx1-45007" >4138</a>, <a +href="glossaries-user.html#dx1-71005" >4139</a>, <a +href="glossaries-user.html#dx1-81005" >4140</a>, <a +href="glossaries-user.html#dx1-188016" >4141</a>, <a +href="glossaries-user.html#dx1-188036" >4142</a>, <a +href="glossaries-user.html#dx1-190041" >4143</a>, <a +href="glossaries-user.html#dx1-192038" >4144</a>, <a +href="glossaries-user.html#dx1-212014" >4145</a>, <a +href="glossaries-user.html#dx1-220044" >4146</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">only</span>  <a +href="glossaries-user.html#dx1-5016" >4147</a>, <a +href="glossaries-user.html#dx1-45006" >4148</a>, <a +href="glossaries-user.html#dx1-71004" >4149</a>, <a +href="glossaries-user.html#dx1-81004" >4150</a>, <a +href="glossaries-user.html#dx1-188014" >4151</a>, <a +href="glossaries-user.html#dx1-190040" >4152</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">record</span>  <a -href="glossaries-user.html#dx1-13010" >1923</a> <br /></span> +href="glossaries-user.html#dx1-214045" >4153</a>, <a +href="glossaries-user.html#dx1-220020" >4154</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">restoremakegloss</span>  <a +href="glossaries-user.html#x1-810002.5" >4155</a>, <a +href="glossaries-user.html#dx1-81006" >4156</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">sanitizesort</span>  <a -href="glossaries-user.html#dx1-5006" >1924</a>, <a -href="glossaries-user.html#dx1-23035" >1925</a>, <a -href="glossaries-user.html#dx1-26033" >1926</a> <br /></span> +href="glossaries-user.html#dx1-5006" >4157</a>, <a +href="glossaries-user.html#x1-720002.5" >4158</a>, <a +href="glossaries-user.html#dx1-73031" >4159</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-6001" >1927</a>, <a -href="glossaries-user.html#dx1-6002" >1928</a>, <a -href="glossaries-user.html#dx1-23037" >1929</a>, <a -href="glossaries-user.html#dx1-23039" >1930</a>, <a -href="glossaries-user.html#dx1-26034" >1931</a>, <a -href="glossaries-user.html#dx1-34089" >1932</a> <br /></span> +href="glossaries-user.html#dx1-6005" >4160</a>, <a +href="glossaries-user.html#dx1-6006" >4161</a>, <a +href="glossaries-user.html#dx1-72002" >4162</a>, <a +href="glossaries-user.html#dx1-72004" >4163</a>, <a +href="glossaries-user.html#dx1-73032" >4164</a>, <a +href="glossaries-user.html#dx1-112092" >4165</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-6003" >1933</a>, <a -href="glossaries-user.html#dx1-6004" >1934</a>, <a -href="glossaries-user.html#dx1-23038" >1935</a>, <a -href="glossaries-user.html#dx1-34082" >1936</a>, <a -href="glossaries-user.html#dx1-34084" >1937</a>, <a -href="glossaries-user.html#dx1-34087" >1938</a>, <a -href="glossaries-user.html#dx1-34096" >1939</a>, <a -href="glossaries-user.html#dx1-34148" >1940</a>, <a -href="glossaries-user.html#dx1-63053" >1941</a> <br /></span> +href="glossaries-user.html#dx1-6007" >4166</a>, <a +href="glossaries-user.html#dx1-6008" >4167</a>, <a +href="glossaries-user.html#dx1-72003" >4168</a>, <a +href="glossaries-user.html#dx1-112085" >4169</a>, <a +href="glossaries-user.html#dx1-112087" >4170</a>, <a +href="glossaries-user.html#dx1-112090" >4171</a>, <a +href="glossaries-user.html#dx1-112099" >4172</a>, <a +href="glossaries-user.html#dx1-112161" >4173</a>, <a +href="glossaries-user.html#dx1-141055" >4174</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">savenumberlist</span>  <a -href="glossaries-user.html#dx1-23127" >1942</a>, <a -href="glossaries-user.html#dx1-62059" >1943</a> <br /></span> +href="glossaries-user.html#x1-450002.3" >4175</a>, <a +href="glossaries-user.html#dx1-140058" >4176</a>, <a +href="glossaries-user.html#dx1-220002" >4177</a>, <a +href="glossaries-user.html#dx1-220021" >4178</a>, <a +href="glossaries-user.html#dx1-220028" >4179</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23129" >1944</a> <br /></span> +href="glossaries-user.html#dx1-45002" >4180</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">savewrites</span>  <a -href="glossaries-user.html#dx1-23049" >1945</a>, <a -href="glossaries-user.html#dx1-23051" >1946</a>, <a -href="glossaries-user.html#dx1-23057" >1947</a> <br /></span> +href="glossaries-user.html#x1-310002.1" >4181</a>, <a +href="glossaries-user.html#dx1-31005" >4182</a>, <a +href="glossaries-user.html#dx1-31015" >4183</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-23050" >1948</a> <br /></span> +href="glossaries-user.html#dx1-31001" >4184</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">section</span>  <a -href="glossaries-user.html#dx1-24011" >1949</a>, <a -href="glossaries-user.html#dx1-63058" >1950</a> <br /></span> +href="glossaries-user.html#x1-410002.2" >4185</a>, <a +href="glossaries-user.html#dx1-141068" >4186</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">seeautonumberlist</span>  <a -href="glossaries-user.html#dx1-25068" >1951</a>, <a -href="glossaries-user.html#dx1-25074" >1952</a>, <a -href="glossaries-user.html#dx1-34117" >1953</a>, <a -href="glossaries-user.html#dx1-60026" >1954</a> <br /></span> +href="glossaries-user.html#x1-560002.3" >4187</a>, <a +href="glossaries-user.html#dx1-56006" >4188</a>, <a +href="glossaries-user.html#dx1-112120" >4189</a>, <a +href="glossaries-user.html#dx1-138026" >4190</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">seenoindex</span>  <a -href="glossaries-user.html#dx1-23021" >1955</a>, <a -href="glossaries-user.html#dx1-34123" >1956</a> <br /></span> +href="glossaries-user.html#x1-620002.4" >4191</a>, <a +href="glossaries-user.html#dx1-112126" >4192</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">ignore</span>  <a -href="glossaries-user.html#dx1-23025" >1957</a> <br /></span> +href="glossaries-user.html#dx1-62005" >4193</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">warn</span>  <a -href="glossaries-user.html#dx1-23024" >1958</a> <br /></span> +href="glossaries-user.html#dx1-62004" >4194</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">shortcuts</span>  <a -href="glossaries-user.html#dx1-27026" >1959</a>, <a -href="glossaries-user.html#dx1-69084" >1960</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">smallcaps</span>  <a -href="glossaries-user.html#dx1-28004" >1961</a>, <a -href="glossaries-user.html#dx1-28008" >1962</a>, <a -href="glossaries-user.html#dx1-28012" >1963</a>, <a -href="glossaries-user.html#dx1-28027" >1964</a>, <a -href="glossaries-user.html#dx1-28030" >1965</a>, <a -href="glossaries-user.html#dx1-30018" >1966</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">smaller</span>  <a -href="glossaries-user.html#dx1-28005" >1967</a>, <a -href="glossaries-user.html#dx1-28010" >1968</a>, <a -href="glossaries-user.html#dx1-28017" >1969</a>, <a -href="glossaries-user.html#dx1-28028" >1970</a>, <a -href="glossaries-user.html#dx1-28032" >1971</a> <br /></span> +href="glossaries-user.html#x1-940002.7" >4195</a>, <a +href="glossaries-user.html#dx1-147084" >4196</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">smallcaps </span>(deprecated)  <a +href="glossaries-user.html#dx1-96002" >4197</a>, <a +href="glossaries-user.html#dx1-96006" >4198</a>, <a +href="glossaries-user.html#x1-970002.7.1" >4199</a>, <a +href="glossaries-user.html#dx1-99002" >4200</a>, <a +href="glossaries-user.html#dx1-99005" >4201</a>, <a +href="glossaries-user.html#dx1-108018" >4202</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">smaller </span>(deprecated)  <a +href="glossaries-user.html#dx1-96003" >4203</a>, <a +href="glossaries-user.html#dx1-96008" >4204</a>, <a +href="glossaries-user.html#x1-980002.7.1" >4205</a>, <a +href="glossaries-user.html#dx1-99003" >4206</a>, <a +href="glossaries-user.html#dx1-99007" >4207</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">sort</span>  <a -href="glossaries-user.html#dx1-26001" >1972</a> <br /></span> +href="glossaries-user.html#dx1-71001" >4208</a>, <a +href="glossaries-user.html#x1-730002.5" >4209</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">def</span>  <a -href="glossaries-user.html#dx1-6006" >1973</a>, <a -href="glossaries-user.html#dx1-6008" >1974</a>, <a -href="glossaries-user.html#dx1-26004" >1975</a>, <a -href="glossaries-user.html#dx1-26011" >1976</a>, <a -href="glossaries-user.html#dx1-26015" >1977</a>, <a -href="glossaries-user.html#dx1-26018" >1978</a>, <a -href="glossaries-user.html#dx1-26024" >1979</a>, <a -href="glossaries-user.html#dx1-26036" >1980</a>, <a -href="glossaries-user.html#dx1-34074" >1981</a>, <a -href="glossaries-user.html#dx1-43006" >1982</a>, <a -href="glossaries-user.html#dx1-78007" >1983</a> <br /></span> +href="glossaries-user.html#dx1-6010" >4210</a>, <a +href="glossaries-user.html#dx1-6017" >4211</a>, <a +href="glossaries-user.html#dx1-73003" >4212</a>, <a +href="glossaries-user.html#dx1-73010" >4213</a>, <a +href="glossaries-user.html#dx1-73014" >4214</a>, <a +href="glossaries-user.html#dx1-73017" >4215</a>, <a +href="glossaries-user.html#dx1-73022" >4216</a>, <a +href="glossaries-user.html#dx1-73034" >4217</a>, <a +href="glossaries-user.html#dx1-112074" >4218</a>, <a +href="glossaries-user.html#dx1-121006" >4219</a>, <a +href="glossaries-user.html#dx1-156007" >4220</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">none</span>  <a -href="glossaries-user.html#dx1-5009" >1984</a>, <a -href="glossaries-user.html#dx1-5011" >1985</a>, <a -href="glossaries-user.html#dx1-10001" >1986</a>, <a -href="glossaries-user.html#dx1-26020" >1987</a> <br /></span> +href="glossaries-user.html#dx1-5008" >4221</a>, <a +href="glossaries-user.html#dx1-5015" >4222</a>, <a +href="glossaries-user.html#dx1-10002" >4223</a>, <a +href="glossaries-user.html#dx1-11022" >4224</a>, <a +href="glossaries-user.html#dx1-71003" >4225</a>, <a +href="glossaries-user.html#dx1-73019" >4226</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">standard</span>  <a -href="glossaries-user.html#dx1-26006" >1988</a>, <a -href="glossaries-user.html#dx1-26025" >1989</a>, <a -href="glossaries-user.html#dx1-26042" >1990</a> <br /></span> +href="glossaries-user.html#dx1-73005" >4227</a>, <a +href="glossaries-user.html#dx1-73023" >4228</a>, <a +href="glossaries-user.html#dx1-73040" >4229</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">use</span>  <a -href="glossaries-user.html#dx1-6005" >1991</a>, <a -href="glossaries-user.html#dx1-6009" >1992</a>, <a -href="glossaries-user.html#dx1-26005" >1993</a>, <a -href="glossaries-user.html#dx1-26013" >1994</a>, <a -href="glossaries-user.html#dx1-26016" >1995</a>, <a -href="glossaries-user.html#dx1-26019" >1996</a>, <a -href="glossaries-user.html#dx1-26023" >1997</a>, <a -href="glossaries-user.html#dx1-26037" >1998</a>, <a -href="glossaries-user.html#dx1-34075" >1999</a>, <a -href="glossaries-user.html#dx1-43005" >2000</a>, <a -href="glossaries-user.html#dx1-78008" >2001</a> <br /></span> +href="glossaries-user.html#dx1-6009" >4230</a>, <a +href="glossaries-user.html#dx1-6018" >4231</a>, <a +href="glossaries-user.html#dx1-73004" >4232</a>, <a +href="glossaries-user.html#dx1-73012" >4233</a>, <a +href="glossaries-user.html#dx1-73015" >4234</a>, <a +href="glossaries-user.html#dx1-73018" >4235</a>, <a +href="glossaries-user.html#dx1-73021" >4236</a>, <a +href="glossaries-user.html#dx1-73035" >4237</a>, <a +href="glossaries-user.html#dx1-112075" >4238</a>, <a +href="glossaries-user.html#dx1-121005" >4239</a>, <a +href="glossaries-user.html#dx1-156008" >4240</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">style</span>  <a -href="glossaries-user.html#dx1-25025" >2002</a>, <a -href="glossaries-user.html#dx1-25046" >2003</a>, <a -href="glossaries-user.html#dx1-25055" >2004</a>, <a -href="glossaries-user.html#dx1-63024" >2005</a>, <a -href="glossaries-user.html#dx1-77005" >2006</a>, <a -href="glossaries-user.html#dx1-81008" >2007</a>, <a -href="glossaries-user.html#dx1-82008" >2008</a>, <a -href="glossaries-user.html#dx1-84008" >2009</a> <br /></span> +href="glossaries-user.html#x1-490002.3" >4241</a>, <a +href="glossaries-user.html#dx1-52005" >4242</a>, <a +href="glossaries-user.html#dx1-54002" >4243</a>, <a +href="glossaries-user.html#dx1-141026" >4244</a>, <a +href="glossaries-user.html#dx1-155005" >4245</a>, <a +href="glossaries-user.html#dx1-159008" >4246</a>, <a +href="glossaries-user.html#dx1-160008" >4247</a>, <a +href="glossaries-user.html#dx1-162008" >4248</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">index</span>  <a -href="glossaries-user.html#dx1-25028" >2010</a> <br /></span> +href="glossaries-user.html#dx1-49003" >4249</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">list</span>  <a -href="glossaries-user.html#dx1-25026" >2011</a> <br /></span> +href="glossaries-user.html#dx1-49001" >4250</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">stylemods</span>  <a +href="glossaries-user.html#dx1-4013" >4251</a>, <a +href="glossaries-user.html#dx1-4014" >4252</a>, <a +href="glossaries-user.html#x1-600002.3" >4253</a>, <a +href="glossaries-user.html#dx1-178010" >4254</a>, <a +href="glossaries-user.html#dx1-179007" >4255</a>, <a +href="glossaries-user.html#dx1-188017" >4256</a>, <a +href="glossaries-user.html#dx1-202010" >4257</a>, <a +href="glossaries-user.html#dx1-202011" >4258</a>, <a +href="glossaries-user.html#dx1-202038" >4259</a>, <a +href="glossaries-user.html#dx1-204007" >4260</a>, <a +href="glossaries-user.html#dx1-219009" >4261</a>, <a +href="glossaries-user.html#dx1-219012" >4262</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">subentrycounter</span>  <a -href="glossaries-user.html#dx1-25019" >2012</a>, <a -href="glossaries-user.html#dx1-41001" >2013</a>, <a -href="glossaries-user.html#dx1-43007" >2014</a>, <a -href="glossaries-user.html#dx1-78003" >2015</a>, <a -href="glossaries-user.html#dx1-88065" >2016</a>, <a -href="glossaries-user.html#dx1-88085" >2017</a> <br /></span> +href="glossaries-user.html#x1-480002.3" >4263</a>, <a +href="glossaries-user.html#dx1-119001" >4264</a>, <a +href="glossaries-user.html#dx1-121007" >4265</a>, <a +href="glossaries-user.html#dx1-156003" >4266</a>, <a +href="glossaries-user.html#dx1-166065" >4267</a>, <a +href="glossaries-user.html#dx1-166085" >4268</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-25020" >2018</a> <br /></span> +href="glossaries-user.html#dx1-48001" >4269</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">symbols</span>  <a -href="glossaries-user.html#dx1-23029" >2019</a>, <a -href="glossaries-user.html#dx1-29001" >2020</a>, <a -href="glossaries-user.html#dx1-68019" >2021</a> <br /></span> +href="glossaries-user.html#dx1-4015" >4270</a>, <a +href="glossaries-user.html#dx1-6013" >4271</a>, <a +href="glossaries-user.html#dx1-7027" >4272</a>, <a +href="glossaries-user.html#dx1-8015" >4273</a>, <a +href="glossaries-user.html#dx1-8028" >4274</a>, <a +href="glossaries-user.html#dx1-84004" >4275</a>, <a +href="glossaries-user.html#x1-850002.6" >4276</a>, <a +href="glossaries-user.html#dx1-146021" >4277</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">toc</span>  <a -href="glossaries-user.html#dx1-7038" >2022</a>, <a -href="glossaries-user.html#dx1-24001" >2023</a>, <a -href="glossaries-user.html#dx1-24005" >2024</a>, <a -href="glossaries-user.html#dx1-24008" >2025</a>, <a -href="glossaries-user.html#dx1-24009" >2026</a>, <a -href="glossaries-user.html#dx1-63021" >2027</a> <br /></span> +href="glossaries-user.html#dx1-7051" >4278</a>, <a +href="glossaries-user.html#x1-390002.2" >4279</a>, <a +href="glossaries-user.html#dx1-40004" >4280</a>, <a +href="glossaries-user.html#dx1-40005" >4281</a>, <a +href="glossaries-user.html#dx1-141023" >4282</a>, <a +href="glossaries-user.html#dx1-178015" >4283</a>, <a +href="glossaries-user.html#dx1-179004" >4284</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">false</span>  <a +href="glossaries-user.html#dx1-39003" >4285</a> <br /></span> +<span class="index-subsubitem">        <span +class="cmss-10">true</span>  <a +href="glossaries-user.html#dx1-39004" >4286</a>, <a +href="glossaries-user.html#dx1-40001" >4287</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">translate</span>  <a -href="glossaries-user.html#dx1-23060" >2028</a>, <a -href="glossaries-user.html#dx1-23083" >2029</a>, <a -href="glossaries-user.html#dx1-23085" >2030</a>, <a -href="glossaries-user.html#dx1-30013" >2031</a> <br /></span> +href="glossaries-user.html#x1-320002.1" >4288</a>, <a +href="glossaries-user.html#dx1-32023" >4289</a>, <a +href="glossaries-user.html#dx1-32025" >4290</a>, <a +href="glossaries-user.html#dx1-108013" >4291</a> <br /></span> + + <span class="index-subsubitem">        <span class="cmss-10">babel</span>  <a -href="glossaries-user.html#dx1-14012" >2032</a>, <a -href="glossaries-user.html#dx1-14017" >2033</a>, <a -href="glossaries-user.html#dx1-14041" >2034</a>, <a -href="glossaries-user.html#dx1-14049" >2035</a>, <a -href="glossaries-user.html#dx1-23077" >2036</a>, <a -href="glossaries-user.html#dx1-23080" >2037</a> <br /></span> - - +href="glossaries-user.html#dx1-14012" >4292</a>, <a +href="glossaries-user.html#dx1-14017" >4293</a>, <a +href="glossaries-user.html#dx1-14039" >4294</a>, <a +href="glossaries-user.html#dx1-14043" >4295</a>, <a +href="glossaries-user.html#dx1-14051" >4296</a>, <a +href="glossaries-user.html#dx1-32017" >4297</a>, <a +href="glossaries-user.html#dx1-32020" >4298</a>, <a +href="glossaries-user.html#dx1-32032" >4299</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-14011" >2038</a>, <a -href="glossaries-user.html#dx1-23071" >2039</a>, <a -href="glossaries-user.html#dx1-23090" >2040</a>, <a -href="glossaries-user.html#dx1-23092" >2041</a> <br /></span> +href="glossaries-user.html#dx1-14011" >4300</a>, <a +href="glossaries-user.html#dx1-32011" >4301</a>, <a +href="glossaries-user.html#dx1-32030" >4302</a>, <a +href="glossaries-user.html#dx1-33001" >4303</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-23061" >2042</a>, <a -href="glossaries-user.html#dx1-23082" >2043</a>, <a -href="glossaries-user.html#dx1-23084" >2044</a>, <a -href="glossaries-user.html#dx1-23086" >2045</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">ucfirst</span>  <a -href="glossaries-user.html#dx1-24032" >2046</a> <br /></span> +href="glossaries-user.html#dx1-32001" >4304</a>, <a +href="glossaries-user.html#dx1-32022" >4305</a>, <a +href="glossaries-user.html#dx1-32024" >4306</a>, <a +href="glossaries-user.html#dx1-32026" >4307</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">ucmark</span>  <a -href="glossaries-user.html#dx1-24017" >2047</a>, <a -href="glossaries-user.html#dx1-24019" >2048</a> <br /></span> +href="glossaries-user.html#dx1-41007" >4308</a>, <a +href="glossaries-user.html#x1-420002.2" >4309</a>, <a +href="glossaries-user.html#dx1-42013" >4310</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">false</span>  <a -href="glossaries-user.html#dx1-24020" >2049</a> <br /></span> +href="glossaries-user.html#dx1-42001" >4311</a> <br /></span> <span class="index-subsubitem">        <span class="cmss-10">true</span>  <a -href="glossaries-user.html#dx1-24022" >2050</a> <br /></span> +href="glossaries-user.html#dx1-42003" >4312</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmss-10">undefaction</span>  <a +href="glossaries-user.html#x1-360002.1" >4313</a> <br /></span> +<span class="index-subitem">    <span +class="cmss-10">writeglslabels</span>  <a +href="glossaries-user.html#dx1-23001" >4314</a>, <a +href="glossaries-user.html#x1-350002.1" >4315</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">xindy</span>  <a -href="glossaries-user.html#dx1-8015" >2051</a>, <a -href="glossaries-user.html#dx1-11097" >2052</a>, <a -href="glossaries-user.html#dx1-13008" >2053</a>, <a -href="glossaries-user.html#dx1-16089" >2054</a>, <a -href="glossaries-user.html#dx1-19003" >2055</a>, <a -href="glossaries-user.html#dx1-20002" >2056</a>, <a -href="glossaries-user.html#dx1-26062" >2057</a>, <a -href="glossaries-user.html#dx1-26063" >2058</a>, <a -href="glossaries-user.html#dx1-26073" >2059</a>, <a -href="glossaries-user.html#dx1-30002" >2060</a>, <a -href="glossaries-user.html#dx1-30016" >2061</a>, <a -href="glossaries-user.html#dx1-64002" >2062</a>, <a -href="glossaries-user.html#dx1-66001" >2063</a>, <a -href="glossaries-user.html#dx1-67001" >2064</a> <br /></span> +href="glossaries-user.html#dx1-8021" >4316</a>, <a +href="glossaries-user.html#dx1-13008" >4317</a>, <a +href="glossaries-user.html#dx1-16092" >4318</a>, <a +href="glossaries-user.html#dx1-19003" >4319</a>, <a +href="glossaries-user.html#dx1-20002" >4320</a>, <a +href="glossaries-user.html#dx1-75008" >4321</a>, <a +href="glossaries-user.html#x1-760002.5" >4322</a>, <a +href="glossaries-user.html#dx1-77001" >4323</a>, <a +href="glossaries-user.html#dx1-108002" >4324</a>, <a +href="glossaries-user.html#dx1-108016" >4325</a>, <a +href="glossaries-user.html#dx1-142002" >4326</a>, <a +href="glossaries-user.html#dx1-144001" >4327</a>, <a +href="glossaries-user.html#dx1-145001" >4328</a>, <a +href="glossaries-user.html#dx1-210003" >4329</a>, <a +href="glossaries-user.html#dx1-212008" >4330</a>, <a +href="glossaries-user.html#dx1-214006" >4331</a>, <a +href="glossaries-user.html#dx1-214011" >4332</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">xindygloss</span>  <a -href="glossaries-user.html#dx1-26072" >2065</a>, <a -href="glossaries-user.html#dx1-30003" >2066</a> <br /></span> +href="glossaries-user.html#x1-770002.5" >4333</a>, <a +href="glossaries-user.html#dx1-108003" >4334</a> <br /></span> <span class="index-subitem">    <span class="cmss-10">xindynoglsnumbers</span>  <a -href="glossaries-user.html#dx1-26076" >2067</a>, <a -href="glossaries-user.html#dx1-30004" >2068</a> <br /></span> +href="glossaries-user.html#x1-780002.5" >4335</a>, <a +href="glossaries-user.html#dx1-108004" >4336</a> <br /></span> <span class="index-item"><span class="cmtt-10">page </span>(counter)  <a -href="glossaries-user.html#dx1-66036" >2069</a>, <a -href="glossaries-user.html#dx1-66042" >2070</a> <br /></span> +href="glossaries-user.html#dx1-144039" >4337</a>, <a +href="glossaries-user.html#dx1-144045" >4338</a> <br /></span> <span class="index-item">page type precedence  <a -href="glossaries-user.html#dx1-53005" >2071</a> <br /></span> +href="glossaries-user.html#dx1-131005" >4339</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\pagelistname</span></span></span>  <a +href="glossaries-user.html#dx1-14030" >4340</a> <br /></span> <span class="index-item"><span class="cmtt-10">pdflatex</span>  <a -href="glossaries-user.html#dx1-28" >2072</a>, <a -href="glossaries-user.html#dx1-54019" >2073</a> <br /></span> +href="glossaries-user.html#dx1-27" >4341</a>, <a +href="glossaries-user.html#dx1-132019" >4342</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\PGLS</span></span></span>  <a -href="glossaries-user.html#dx1-93027" ><span -class="cmti-10">2074</span></a> <br /></span> +href="glossaries-user.html#dx1-171028" ><span +class="cmti-10">4343</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Pgls</span></span></span>  <a -href="glossaries-user.html#dx1-93023" ><span -class="cmti-10">2075</span></a> <br /></span> +href="glossaries-user.html#dx1-171024" ><span +class="cmti-10">4344</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\pgls</span></span></span>  <a -href="glossaries-user.html#dx1-93020" ><span -class="cmti-10">2076</span></a> <br /></span> +href="glossaries-user.html#dx1-171021" ><span +class="cmti-10">4345</span></a>, <a +href="glossaries-user.html#dx1-178008" >4346</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\PGLSpl</span></span></span>  <a -href="glossaries-user.html#dx1-93036" ><span -class="cmti-10">2077</span></a> <br /></span> +href="glossaries-user.html#dx1-171037" ><span +class="cmti-10">4347</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\Pglspl</span></span></span>  <a -href="glossaries-user.html#dx1-93032" ><span -class="cmti-10">2078</span></a> <br /></span> +href="glossaries-user.html#dx1-171033" ><span +class="cmti-10">4348</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\pglspl</span></span></span>  <a -href="glossaries-user.html#dx1-93029" ><span -class="cmti-10">2079</span></a> <br /></span> -<span class="index-item"><span -class="cmtt-10">pod2man</span>  <a -href="glossaries-user.html#dx1-17036" >2080</a> <br /></span> +href="glossaries-user.html#dx1-171030" ><span +class="cmti-10">4349</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\pi</span></span></span>  <a +href="glossaries-user.html#dx1-202082" >4350</a> <br /></span> <span class="index-item"><span class="cmss-10">polyglossia </span>package  <a -href="glossaries-user.html#dx1-14002" >2081</a>, <a -href="glossaries-user.html#dx1-14004" >2082</a>, <a -href="glossaries-user.html#dx1-14006" >2083</a>, <a -href="glossaries-user.html#dx1-14039" >2084</a>, <a -href="glossaries-user.html#dx1-23069" >2085</a>, <a -href="glossaries-user.html#dx1-23073" >2086</a>, <a -href="glossaries-user.html#dx1-23088" >2087</a> <br /></span> +href="glossaries-user.html#dx1-14002" >4351</a>, <a +href="glossaries-user.html#dx1-14004" >4352</a>, <a +href="glossaries-user.html#dx1-14006" >4353</a>, <a +href="glossaries-user.html#dx1-14041" >4354</a>, <a +href="glossaries-user.html#dx1-32009" >4355</a>, <a +href="glossaries-user.html#dx1-32013" >4356</a>, <a +href="glossaries-user.html#dx1-32028" >4357</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\primary</span></span></span>  <a +href="glossaries-user.html#dx1-190020" >4358</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printacronyms</span></span></span>  <a -href="glossaries-user.html#dx1-27002" ><span -class="cmti-10">2088</span></a> <br /></span> +href="glossaries-user.html#dx1-90001" ><span +class="cmti-10">4359</span></a>, <a +href="glossaries-user.html#dx1-147004" >4360</a>, <a +href="glossaries-user.html#dx1-151006" >4361</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-63003" ><span -class="cmti-10">2089</span></a> <br /></span> +href="glossaries-user.html#dx1-123002" >4362</a>, <a +href="glossaries-user.html#dx1-141004" ><span +class="cmti-10">4363</span></a>, <a +href="glossaries-user.html#dx1-146009" >4364</a>, <a +href="glossaries-user.html#dx1-151010" >4365</a>, <a +href="glossaries-user.html#dx1-166069" >4366</a>, <a +href="glossaries-user.html#dx1-169004" >4367</a>, <a +href="glossaries-user.html#dx1-190030" >4368</a>, <a +href="glossaries-user.html#dx1-198010" >4369</a>, <a +href="glossaries-user.html#dx1-211049" >4370</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printglossary</span></span></span>  <a -href="glossaries-user.html#dx1-63014" ><span -class="cmti-10">2090</span></a> <br /></span> +href="glossaries-user.html#dx1-7002" >4371</a>, <a +href="glossaries-user.html#dx1-8002" >4372</a>, <a +href="glossaries-user.html#dx1-54005" >4373</a>, <a +href="glossaries-user.html#dx1-85002" >4374</a>, <a +href="glossaries-user.html#dx1-86002" >4375</a>, <a +href="glossaries-user.html#dx1-87005" >4376</a>, <a +href="glossaries-user.html#dx1-90002" >4377</a>, <a +href="glossaries-user.html#dx1-141016" ><span +class="cmti-10">4378</span></a>, <a +href="glossaries-user.html#dx1-147003" >4379</a>, <a +href="glossaries-user.html#dx1-151003" >4380</a>, <a +href="glossaries-user.html#dx1-151007" >4381</a>, <a +href="glossaries-user.html#dx1-155003" >4382</a>, <a +href="glossaries-user.html#dx1-156031" >4383</a>, <a +href="glossaries-user.html#dx1-166068" >4384</a>, <a +href="glossaries-user.html#dx1-169003" >4385</a>, <a +href="glossaries-user.html#dx1-188038" >4386</a> <br /></span> <span class="index-item"><span class="cmtt-10">\printglossary </span>options<br /></span> <span class="index-subitem">    <span -class="cmss-10">entrycounter</span>  <a -href="glossaries-user.html#dx1-63032" >2091</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">nogroupskip</span>  <a -href="glossaries-user.html#dx1-63030" >2092</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">nonumberlist</span>  <a -href="glossaries-user.html#dx1-63029" >2093</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">nopostdot</span>  <a -href="glossaries-user.html#dx1-63031" >2094</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">numberedsection</span>  <a -href="glossaries-user.html#dx1-63026" >2095</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">style</span>  <a -href="glossaries-user.html#dx1-25057" >2096</a>, <a -href="glossaries-user.html#dx1-63023" >2097</a>, <a -href="glossaries-user.html#dx1-77001" >2098</a>, <a -href="glossaries-user.html#dx1-78029" >2099</a>, <a -href="glossaries-user.html#dx1-82019" >2100</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">subentrycounter</span>  <a -href="glossaries-user.html#dx1-63034" >2101</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">title</span>  <a -href="glossaries-user.html#dx1-5" >2102</a>, <a -href="glossaries-user.html#dx1-14043" >2103</a>, <a -href="glossaries-user.html#dx1-63019" >2104</a>, <a -href="glossaries-user.html#dx1-63022" >2105</a>, <a -href="glossaries-user.html#dx1-69003" >2106</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">toctitle</span>  <a -href="glossaries-user.html#dx1-63020" >2107</a> <br /></span> -<span class="index-subitem">    <span -class="cmss-10">type</span>  <a -href="glossaries-user.html#dx1-63016" >2108</a>, <a -href="glossaries-user.html#dx1-63017" >2109</a> <br /></span> +class="cmtt-10">entrycounter</span>  <a +href="glossaries-user.html#dx1-141034" >4387</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">label</span>  <a +href="glossaries-user.html#dx1-141057" >4388</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">nogroupskip</span>  <a +href="glossaries-user.html#dx1-141032" >4389</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">nonumberlist</span>  <a +href="glossaries-user.html#dx1-141031" >4390</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">nopostdot</span>  <a +href="glossaries-user.html#dx1-141033" >4391</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">numberedsection</span>  <a +href="glossaries-user.html#dx1-141028" >4392</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">prefix</span>  <a +href="glossaries-user.html#dx1-141061" >4393</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">style</span>  <a +href="glossaries-user.html#dx1-54004" >4394</a>, <a +href="glossaries-user.html#dx1-141025" >4395</a>, <a +href="glossaries-user.html#dx1-155001" >4396</a>, <a +href="glossaries-user.html#dx1-156029" >4397</a>, <a +href="glossaries-user.html#dx1-160019" >4398</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">subentrycounter</span>  <a +href="glossaries-user.html#dx1-141036" >4399</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">target</span>  <a +href="glossaries-user.html#dx1-11081" >4400</a>, <a +href="glossaries-user.html#dx1-141059" >4401</a> <br /></span> +<span class="index-subitem">    <sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span +class="cmtt-10">targetnameprefix</span>  <a +href="glossaries-user.html#dx1-141063" >4402</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">title</span>  <a +href="glossaries-user.html#dx1-4" >4403</a>, <a +href="glossaries-user.html#dx1-14045" >4404</a>, <a +href="glossaries-user.html#dx1-141021" >4405</a>, <a +href="glossaries-user.html#dx1-141024" >4406</a>, <a +href="glossaries-user.html#dx1-147002" >4407</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">toctitle</span>  <a +href="glossaries-user.html#dx1-141022" >4408</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">type</span>  <a +href="glossaries-user.html#dx1-141018" >4409</a>, <a +href="glossaries-user.html#dx1-141019" >4410</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printindex</span></span></span>  <a -href="glossaries-user.html#dx1-29017" ><span -class="cmti-10">2110</span></a> <br /></span> +href="glossaries-user.html#dx1-87004" ><span +class="cmti-10">4411</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printnoidxglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-63001" ><span -class="cmti-10">2111</span></a> <br /></span> +href="glossaries-user.html#dx1-141002" ><span +class="cmti-10">4412</span></a>, <a +href="glossaries-user.html#dx1-151009" >4413</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printnoidxglossary</span></span></span>  <a -href="glossaries-user.html#dx1-63012" ><span -class="cmti-10">2112</span></a> <br /></span> +href="glossaries-user.html#dx1-6002" >4414</a>, <a +href="glossaries-user.html#dx1-73002" >4415</a>, <a +href="glossaries-user.html#dx1-73039" >4416</a>, <a +href="glossaries-user.html#dx1-74006" >4417</a>, <a +href="glossaries-user.html#dx1-85003" >4418</a>, <a +href="glossaries-user.html#dx1-86003" >4419</a>, <a +href="glossaries-user.html#dx1-87006" >4420</a>, <a +href="glossaries-user.html#dx1-90004" >4421</a>, <a +href="glossaries-user.html#dx1-141014" ><span +class="cmti-10">4422</span></a>, <a +href="glossaries-user.html#dx1-151001" >4423</a>, <a +href="glossaries-user.html#dx1-155002" >4424</a>, <a +href="glossaries-user.html#dx1-156030" >4425</a>, <a +href="glossaries-user.html#dx1-198011" >4426</a> <br /></span> <span class="index-item"><span class="cmtt-10">\printnoidxglossary </span>options<br /></span> + + <span class="index-subitem">    <span -class="cmss-10">sort</span>  <a -href="glossaries-user.html#dx1-26002" >2113</a>, <a -href="glossaries-user.html#dx1-26040" >2114</a>, <a -href="glossaries-user.html#dx1-26052" >2115</a>, <a -href="glossaries-user.html#dx1-63039" >2116</a> <br /></span> +class="cmtt-10">sort</span>  <a +href="glossaries-user.html#dx1-73001" >4427</a>, <a +href="glossaries-user.html#dx1-73038" >4428</a>, <a +href="glossaries-user.html#dx1-74005" >4429</a>, <a +href="glossaries-user.html#dx1-141041" >4430</a>, <a +href="glossaries-user.html#dx1-198013" >4431</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printnumbers</span></span></span>  <a -href="glossaries-user.html#dx1-29008" ><span -class="cmti-10">2117</span></a> <br /></span> +href="glossaries-user.html#dx1-86001" ><span +class="cmti-10">4432</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\printsymbols</span></span></span>  <a -href="glossaries-user.html#dx1-29002" ><span -class="cmti-10">2118</span></a> <br /></span> +href="glossaries-user.html#dx1-85001" ><span +class="cmti-10">4433</span></a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\printunsrtacronyms</span></span></span>  <a +href="glossaries-user.html#dx1-223015" >4434</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\printunsrtglossaries</span></span></span>  <a +href="glossaries-user.html#dx1-4010" >4435</a>, <a +href="glossaries-user.html#dx1-9032" >4436</a>, <a +href="glossaries-user.html#dx1-10005" >4437</a>, <a +href="glossaries-user.html#dx1-175058" >4438</a>, <a +href="glossaries-user.html#dx1-190031" >4439</a>, <a +href="glossaries-user.html#dx1-192059" >4440</a>, <a +href="glossaries-user.html#dx1-193022" >4441</a>, <a +href="glossaries-user.html#dx1-197028" >4442</a>, <a +href="glossaries-user.html#dx1-198039" >4443</a>, <a +href="glossaries-user.html#dx1-200090" >4444</a>, <a +href="glossaries-user.html#dx1-202059" >4445</a>, <a +href="glossaries-user.html#dx1-204027" >4446</a>, <a +href="glossaries-user.html#dx1-206019" >4447</a>, <a +href="glossaries-user.html#dx1-211050" >4448</a>, <a +href="glossaries-user.html#dx1-212013" >4449</a>, <a +href="glossaries-user.html#dx1-214035" >4450</a>, <a +href="glossaries-user.html#dx1-220026" >4451</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\printunsrtglossary</span></span></span>  <a +href="glossaries-user.html#dx1-9005" >4452</a>, <a +href="glossaries-user.html#dx1-9031" >4453</a>, <a +href="glossaries-user.html#dx1-10001" >4454</a>, <a +href="glossaries-user.html#dx1-10004" >4455</a>, <a +href="glossaries-user.html#dx1-11080" >4456</a>, <a +href="glossaries-user.html#dx1-141060" >4457</a>, <a +href="glossaries-user.html#dx1-179072" >4458</a>, <a +href="glossaries-user.html#dx1-188039" >4459</a>, <a +href="glossaries-user.html#dx1-188040" >4460</a>, <a +href="glossaries-user.html#dx1-193050" >4461</a>, <a +href="glossaries-user.html#dx1-193051" >4462</a>, <a +href="glossaries-user.html#dx1-194039" >4463</a>, <a +href="glossaries-user.html#dx1-220038" >4464</a>, <a +href="glossaries-user.html#dx1-223014" >4465</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\providecommand</span></span></span>  <a +href="glossaries-user.html#dx1-197022" >4466</a>, <a +href="glossaries-user.html#dx1-197033" >4467</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\provideglossaryentry</span></span></span>  <a -href="glossaries-user.html#dx1-34006" ><span -class="cmti-10">2119</span></a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-112005" ><span +class="cmti-10">4468</span></a>, <a +href="glossaries-user.html#dx1-122030" >4469</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\provideignoredglossary</span></span></span>  <a +href="glossaries-user.html#dx1-146013" >4470</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">R</span> <span class="index-item"><span class="cmss-10">relsize </span>package  <a -href="glossaries-user.html#dx1-28019" >2120</a>, <a -href="glossaries-user.html#dx1-71015" >2121</a> <br /></span> - - -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-3065" >4471</a>, <a +href="glossaries-user.html#dx1-98002" >4472</a>, <a +href="glossaries-user.html#dx1-149016" >4473</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Roman</span></span></span>  <a +href="glossaries-user.html#dx1-144035" >4474</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">S</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\S</span></span></span>  <a +href="glossaries-user.html#dx1-190045" >4475</a> <br /></span> <span class="index-item">sanitize  <a -href="glossaries-user.html#dx1-3049" ><span -class="cmbx-10">2122</span></a>, <a -href="glossaries-user.html#dx1-23036" >2123</a>, <a -href="glossaries-user.html#dx1-26032" >2124</a>, <a -href="glossaries-user.html#dx1-61015" >2125</a>, <a -href="glossaries-user.html#dx1-62056" >2126</a> <br /></span> +href="glossaries-user.html#dx1-3061" ><span +class="cmbx-10">4476</span></a>, <a +href="glossaries-user.html#dx1-72001" >4477</a>, <a +href="glossaries-user.html#dx1-73030" >4478</a>, <a +href="glossaries-user.html#dx1-139015" >4479</a>, <a +href="glossaries-user.html#dx1-140055" >4480</a> <br /></span> <span class="index-item"><span class="cmss-10">scrwfile </span>package  <a -href="glossaries-user.html#dx1-23053" >2127</a> <br /></span> +href="glossaries-user.html#dx1-31007" >4481</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\section*</span></span></span>  <a +href="glossaries-user.html#dx1-43013" >4482</a>, <a +href="glossaries-user.html#dx1-141066" >4483</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\seealsoname</span></span></span>  <a +href="glossaries-user.html#dx1-112132" >4484</a>, <a +href="glossaries-user.html#dx1-112133" >4485</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\seename</span></span></span>  <a +href="glossaries-user.html#dx1-138011" >4486</a>, <a +href="glossaries-user.html#dx1-138018" >4487</a>, <a +href="glossaries-user.html#dx1-139006" >4488</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\setabbreviationstyle</span></span></span>  <a +href="glossaries-user.html#dx1-4007" >4489</a>, <a +href="glossaries-user.html#dx1-175021" >4490</a>, <a +href="glossaries-user.html#dx1-175027" >4491</a>, <a +href="glossaries-user.html#dx1-175028" >4492</a>, <a +href="glossaries-user.html#dx1-175055" >4493</a>, <a +href="glossaries-user.html#dx1-178022" >4494</a>, <a +href="glossaries-user.html#dx1-178024" >4495</a>, <a +href="glossaries-user.html#dx1-178031" >4496</a>, <a +href="glossaries-user.html#dx1-178033" >4497</a>, <a +href="glossaries-user.html#dx1-179012" >4498</a>, <a +href="glossaries-user.html#dx1-179018" >4499</a>, <a +href="glossaries-user.html#dx1-179052" >4500</a>, <a +href="glossaries-user.html#dx1-179057" >4501</a>, <a +href="glossaries-user.html#dx1-179063" >4502</a>, <a +href="glossaries-user.html#dx1-179073" >4503</a>, <a +href="glossaries-user.html#dx1-181003" >4504</a>, <a +href="glossaries-user.html#dx1-182004" >4505</a>, <a +href="glossaries-user.html#dx1-182036" >4506</a>, <a +href="glossaries-user.html#dx1-184047" >4507</a>, <a +href="glossaries-user.html#dx1-184052" >4508</a>, <a +href="glossaries-user.html#dx1-185004" >4509</a>, <a +href="glossaries-user.html#dx1-185005" >4510</a>, <a +href="glossaries-user.html#dx1-186003" >4511</a>, <a +href="glossaries-user.html#dx1-186013" >4512</a>, <a +href="glossaries-user.html#dx1-186029" >4513</a>, <a +href="glossaries-user.html#dx1-193025" >4514</a>, <a +href="glossaries-user.html#dx1-193043" >4515</a>, <a +href="glossaries-user.html#dx1-198007" >4516</a>, <a +href="glossaries-user.html#dx1-198033" >4517</a>, <a +href="glossaries-user.html#dx1-207004" >4518</a>, <a +href="glossaries-user.html#dx1-223011" >4519</a>, <a +href="glossaries-user.html#dx1-224066" >4520</a>, <a +href="glossaries-user.html#dx1-224072" >4521</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\setabbreviationstyle</span></span></span>  <a +href="glossaries-user.html#dx1-224045" >4522</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\SetAcronymLists</span></span></span>  <a -href="glossaries-user.html#dx1-27024" ><span -class="cmti-10">2128</span></a> <br /></span> +href="glossaries-user.html#dx1-93005" ><span +class="cmti-10">4523</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setacronymstyle</span></span></span>  <a -href="glossaries-user.html#dx1-70001" ><span -class="cmti-10">2129</span></a> <br /></span> +href="glossaries-user.html#dx1-95001" >4524</a>, <a +href="glossaries-user.html#dx1-133017" >4525</a>, <a +href="glossaries-user.html#dx1-147026" >4526</a>, <a +href="glossaries-user.html#dx1-148001" ><span +class="cmti-10">4527</span></a>, <a +href="glossaries-user.html#dx1-150016" >4528</a>, <a +href="glossaries-user.html#dx1-178023" >4529</a>, <a +href="glossaries-user.html#dx1-186002" >4530</a>, <a +href="glossaries-user.html#dx1-224035" >4531</a>, <a +href="glossaries-user.html#dx1-224036" >4532</a>, <a +href="glossaries-user.html#dx1-224037" >4533</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\setentrycounter</span></span></span>  <a +href="glossaries-user.html#dx1-166053" >4534</a>, <a +href="glossaries-user.html#dx1-166056" >4535</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setglossarypreamble</span></span></span>  <a -href="glossaries-user.html#dx1-63065" ><span -class="cmti-10">2130</span></a> <br /></span> +href="glossaries-user.html#dx1-47008" >4536</a>, <a +href="glossaries-user.html#dx1-141075" ><span +class="cmti-10">4537</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setglossarysection</span></span></span>  <a -href="glossaries-user.html#dx1-24012" ><span -class="cmti-10">2131</span></a> <br /></span> +href="glossaries-user.html#dx1-41002" ><span +class="cmti-10">4538</span></a>, <a +href="glossaries-user.html#dx1-141069" >4539</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setglossarystyle</span></span></span>  <a -href="glossaries-user.html#dx1-77004" ><span -class="cmti-10">2132</span></a> <br /></span> +href="glossaries-user.html#dx1-54003" >4540</a>, <a +href="glossaries-user.html#dx1-155004" ><span +class="cmti-10">4541</span></a>, <a +href="glossaries-user.html#dx1-156033" >4542</a>, <a +href="glossaries-user.html#dx1-156036" >4543</a>, <a +href="glossaries-user.html#dx1-164014" >4544</a>, <a +href="glossaries-user.html#dx1-165006" >4545</a>, <a +href="glossaries-user.html#dx1-166091" >4546</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setStyleFile</span></span></span>  <a -href="glossaries-user.html#dx1-33015" ><span -class="cmti-10">2133</span></a> <br /></span> +href="glossaries-user.html#dx1-19014" >4547</a>, <a +href="glossaries-user.html#dx1-20008" >4548</a>, <a +href="glossaries-user.html#dx1-111015" ><span +class="cmti-10">4549</span></a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\setupglossaries</span></span></span>  <a -href="glossaries-user.html#dx1-30001" ><span -class="cmti-10">2134</span></a> <br /></span> +href="glossaries-user.html#dx1-108001" ><span +class="cmti-10">4550</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\Sigma</span></span></span>  <a +href="glossaries-user.html#dx1-202081" >4551</a> <br /></span> +<span class="index-item"><span +class="cmss-10">siunitx </span>package  <a +href="glossaries-user.html#dx1-4006" >4552</a>, <a +href="glossaries-user.html#dx1-222001" >4553</a> <br /></span> +<span class="index-item">small caps  <a +href="glossaries-user.html#dx1-3063" ><span +class="cmbx-10">4554</span></a>, <a +href="glossaries-user.html#dx1-147043" >4555</a>, <a +href="glossaries-user.html#dx1-149009" >4556</a>, <a +href="glossaries-user.html#dx1-149090" >4557</a>, <a +href="glossaries-user.html#dx1-149092" >4558</a>, <a +href="glossaries-user.html#dx1-150059" >4559</a>, <a +href="glossaries-user.html#dx1-165017" >4560</a>, <a +href="glossaries-user.html#dx1-184002" >4561</a>, <a +href="glossaries-user.html#dx1-184061" >4562</a>, <a +href="glossaries-user.html#dx1-204014" >4563</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\space</span></span></span>  <a +href="glossaries-user.html#dx1-178007" >4564</a> <br /></span> <span class="index-item"><span class="cmss-10">stix </span>package  <a -href="glossaries-user.html#dx1-66035" >2135</a> <br /></span> +href="glossaries-user.html#dx1-144038" >4565</a>, <a +href="glossaries-user.html#dx1-211024" >4566</a> <br /></span> <span class="index-item"><span class="obeylines-h"><span class="verb"><span class="cmtt-10">\subglossentry</span></span></span>  <a -href="glossaries-user.html#dx1-88062" ><span -class="cmti-10">2136</span></a> <br /></span> +href="glossaries-user.html#dx1-166062" ><span +class="cmti-10">4567</span></a> <br /></span> <span class="index-item"><span class="cmss-10">supertabular </span>package  <a -href="glossaries-user.html#dx1-25039" >2137</a>, <a -href="glossaries-user.html#dx1-83015" >2138</a>, <a -href="glossaries-user.html#dx1-84012" >2139</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-51002" >4568</a>, <a +href="glossaries-user.html#dx1-161015" >4569</a>, <a +href="glossaries-user.html#dx1-162012" >4570</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\symbolname</span></span></span>  <a +href="glossaries-user.html#dx1-14029" >4571</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">T</span> <span class="index-item"><span class="cmss-10">tabularx </span>package  <a -href="glossaries-user.html#dx1-55005" >2140</a>, <a -href="glossaries-user.html#dx1-55007" >2141</a>, <a -href="glossaries-user.html#dx1-55009" >2142</a>, <a -href="glossaries-user.html#dx1-75024" >2143</a> <br /></span> +href="glossaries-user.html#dx1-133005" >4572</a>, <a +href="glossaries-user.html#dx1-133007" >4573</a>, <a +href="glossaries-user.html#dx1-133009" >4574</a>, <a +href="glossaries-user.html#dx1-153024" >4575</a> <br /></span> + + +<span class="index-item"><span +class="cmss-10">tagpdf </span>package  <a +href="glossaries-user.html#dx1-172058" >4576</a>, <a +href="glossaries-user.html#dx1-172088" >4577</a>, <a +href="glossaries-user.html#dx1-224008" >4578</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\texorpdfstring</span></span></span>  <a +href="glossaries-user.html#dx1-11050" >4579</a>, <a +href="glossaries-user.html#dx1-132014" >4580</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textbf</span></span></span>  <a +href="glossaries-user.html#dx1-132046" >4581</a>, <a +href="glossaries-user.html#dx1-189006" >4582</a> <br /></span> <span class="index-item"><span class="cmss-10">textcase </span>package  <a -href="glossaries-user.html#dx1-10" >2144</a>, <a -href="glossaries-user.html#dx1-24027" >2145</a>, <a -href="glossaries-user.html#dx1-24029" >2146</a> <br /></span> +href="glossaries-user.html#dx1-9" >4583</a>, <a +href="glossaries-user.html#dx1-42008" >4584</a>, <a +href="glossaries-user.html#dx1-42010" >4585</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textrm</span></span></span>  <a +href="glossaries-user.html#dx1-144012" >4586</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textsc</span></span></span>  <a +href="glossaries-user.html#dx1-3064" >4587</a>, <a +href="glossaries-user.html#dx1-149008" >4588</a>, <a +href="glossaries-user.html#dx1-149011" >4589</a>, <a +href="glossaries-user.html#dx1-150036" >4590</a>, <a +href="glossaries-user.html#dx1-150042" >4591</a>, <a +href="glossaries-user.html#dx1-150043" >4592</a>, <a +href="glossaries-user.html#dx1-150058" >4593</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textsmaller</span></span></span>  <a +href="glossaries-user.html#dx1-3066" >4594</a>, <a +href="glossaries-user.html#dx1-98003" >4595</a>, <a +href="glossaries-user.html#dx1-149013" >4596</a>, <a +href="glossaries-user.html#dx1-149014" >4597</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textulc</span></span></span>  <a +href="glossaries-user.html#dx1-150037" >4598</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\textup</span></span></span>  <a +href="glossaries-user.html#dx1-150038" >4599</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\the</span></span></span>  <a +href="glossaries-user.html#dx1-129026" >4600</a>, <a +href="glossaries-user.html#dx1-150027" >4601</a> <br /></span> <span class="index-item"><span class="cmtt-10">theglossary </span>(environment)  <a -href="glossaries-user.html#dx1-88002" ><span -class="cmti-10">2147</span></a> <br /></span> +href="glossaries-user.html#dx1-166002" ><span +class="cmti-10">4602</span></a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\theHequation</span></span></span>  <a +href="glossaries-user.html#dx1-188009" >4603</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\thepage</span></span></span>  <a +href="glossaries-user.html#dx1-144051" >4604</a>, <a +href="glossaries-user.html#dx1-211025" >4605</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\toprule</span></span></span>  <a +href="glossaries-user.html#dx1-160012" >4606</a> <br /></span> <span class="index-item"><span class="cmss-10">tracklang </span>package  <a -href="glossaries-user.html#dx1-6" >2148</a>, <a -href="glossaries-user.html#dx1-15001" >2149</a>, <a -href="glossaries-user.html#dx1-15002" >2150</a> <br /></span> +href="glossaries-user.html#dx1-5" >4607</a>, <a +href="glossaries-user.html#dx1-15001" >4608</a>, <a +href="glossaries-user.html#dx1-15002" >4609</a> <br /></span> <span class="index-item"><span class="cmss-10">translator </span>package  <a -href="glossaries-user.html#dx1-14009" >2151</a>, <a -href="glossaries-user.html#dx1-14013" >2152</a>, <a -href="glossaries-user.html#dx1-14014" >2153</a>, <a -href="glossaries-user.html#dx1-14015" >2154</a>, <a -href="glossaries-user.html#dx1-14020" >2155</a>, <a -href="glossaries-user.html#dx1-14021" >2156</a>, <a -href="glossaries-user.html#dx1-14033" >2157</a>, <a -href="glossaries-user.html#dx1-14035" >2158</a>, <a -href="glossaries-user.html#dx1-14036" >2159</a>, <a -href="glossaries-user.html#dx1-14038" >2160</a>, <a -href="glossaries-user.html#dx1-14042" >2161</a>, <a -href="glossaries-user.html#dx1-14044" >2162</a>, <a -href="glossaries-user.html#dx1-14045" >2163</a>, <a -href="glossaries-user.html#dx1-14048" >2164</a>, <a -href="glossaries-user.html#dx1-15003" >2165</a>, <a -href="glossaries-user.html#dx1-15004" >2166</a>, <a -href="glossaries-user.html#dx1-15005" >2167</a>, <a -href="glossaries-user.html#dx1-15010" >2168</a>, <a -href="glossaries-user.html#dx1-23063" >2169</a>, <a -href="glossaries-user.html#dx1-23064" >2170</a>, <a -href="glossaries-user.html#dx1-23065" >2171</a>, <a -href="glossaries-user.html#dx1-23066" >2172</a>, <a -href="glossaries-user.html#dx1-23078" >2173</a>, <a -href="glossaries-user.html#dx1-23089" >2174</a>, <a -href="glossaries-user.html#dx1-68024" >2175</a> <br /></span> -</p><p class="theindex"> <span +href="glossaries-user.html#dx1-14009" >4610</a>, <a +href="glossaries-user.html#dx1-14013" >4611</a>, <a +href="glossaries-user.html#dx1-14014" >4612</a>, <a +href="glossaries-user.html#dx1-14015" >4613</a>, <a +href="glossaries-user.html#dx1-14020" >4614</a>, <a +href="glossaries-user.html#dx1-14021" >4615</a>, <a +href="glossaries-user.html#dx1-14033" >4616</a>, <a +href="glossaries-user.html#dx1-14035" >4617</a>, <a +href="glossaries-user.html#dx1-14036" >4618</a>, <a +href="glossaries-user.html#dx1-14038" >4619</a>, <a +href="glossaries-user.html#dx1-14044" >4620</a>, <a +href="glossaries-user.html#dx1-14046" >4621</a>, <a +href="glossaries-user.html#dx1-14047" >4622</a>, <a +href="glossaries-user.html#dx1-14050" >4623</a>, <a +href="glossaries-user.html#dx1-15005" >4624</a>, <a +href="glossaries-user.html#dx1-15006" >4625</a>, <a +href="glossaries-user.html#dx1-15007" >4626</a>, <a +href="glossaries-user.html#dx1-15012" >4627</a>, <a +href="glossaries-user.html#dx1-32003" >4628</a>, <a +href="glossaries-user.html#dx1-32004" >4629</a>, <a +href="glossaries-user.html#dx1-32005" >4630</a>, <a +href="glossaries-user.html#dx1-32006" >4631</a>, <a +href="glossaries-user.html#dx1-32018" >4632</a>, <a +href="glossaries-user.html#dx1-32029" >4633</a>, <a +href="glossaries-user.html#dx1-146026" >4634</a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">U</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\usepackage</span></span></span>  <a +href="glossaries-user.html#dx1-193042" >4635</a> <br /></span> +</p><p class="theindex"> <span +class="cmbx-10">W</span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\write18</span></span></span>  <a +href="glossaries-user.html#dx1-31012" >4636</a>, <a +href="glossaries-user.html#dx1-79004" >4637</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\writeist</span></span></span>  <a +href="glossaries-user.html#dx1-131001" >4638</a> <br /></span> +</p><p class="theindex"> <span class="cmbx-10">X</span> <span class="index-item"><span class="cmss-10">xfor </span>package  <a -href="glossaries-user.html#dx1-11" >2176</a> <br /></span> +href="glossaries-user.html#dx1-10" >4639</a> <br /></span> +<span class="index-item"><sup class="textsuperscript"><span +class="tcrm-0900">†</span></sup><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\xGlsXtrSetField</span></span></span>  <a +href="glossaries-user.html#dx1-209011" >4640</a> <br /></span> <span class="index-item"><span class="cmtt-10">xindy</span>  <a -href="glossaries-user.html#dx1-3026" >2177</a>, <a -href="glossaries-user.html#dx1-3034" >2178</a>, <a -href="glossaries-user.html#dx1-3039" >2179</a>, <a -href="glossaries-user.html#dx1-3053" ><span -class="cmbx-10">2180</span></a>, <a -href="glossaries-user.html#dx1-4006" >2181</a>, <a -href="glossaries-user.html#dx1-4007" >2182</a>, <a -href="glossaries-user.html#dx1-8001" >2183</a>, <a -href="glossaries-user.html#dx1-8002" >2184</a>, <a -href="glossaries-user.html#dx1-8003" >2185</a>, <a -href="glossaries-user.html#dx1-8004" >2186</a>, <a -href="glossaries-user.html#dx1-8005" >2187</a>, <a -href="glossaries-user.html#dx1-8006" >2188</a>, <a -href="glossaries-user.html#dx1-8007" >2189</a>, <a -href="glossaries-user.html#dx1-8008" >2190</a>, <a -href="glossaries-user.html#dx1-8009" >2191</a>, <a -href="glossaries-user.html#dx1-8023" >2192</a>, <a -href="glossaries-user.html#dx1-8027" >2193</a>, <a -href="glossaries-user.html#dx1-8028" >2194</a>, <a -href="glossaries-user.html#dx1-8031" >2195</a>, <a -href="glossaries-user.html#dx1-8032" >2196</a>, <a -href="glossaries-user.html#dx1-8036" >2197</a>, <a -href="glossaries-user.html#dx1-8037" >2198</a>, <a -href="glossaries-user.html#dx1-8038" >2199</a>, <a -href="glossaries-user.html#dx1-9004" >2200</a>, <a -href="glossaries-user.html#dx1-11072" >2201</a>, <a -href="glossaries-user.html#dx1-11076" >2202</a>, <a -href="glossaries-user.html#dx1-11082" >2203</a>, <a -href="glossaries-user.html#dx1-11083" >2204</a>, <a -href="glossaries-user.html#dx1-11087" >2205</a>, <a -href="glossaries-user.html#dx1-11088" >2206</a>, <a -href="glossaries-user.html#dx1-11092" >2207</a>, <a -href="glossaries-user.html#dx1-11094" >2208</a>, <a -href="glossaries-user.html#dx1-11096" >2209</a>, <a -href="glossaries-user.html#dx1-13001" >2210</a>, <a -href="glossaries-user.html#dx1-13003" >2211</a>, <a -href="glossaries-user.html#dx1-13007" >2212</a>, <a -href="glossaries-user.html#dx1-13021" >2213</a>, <a -href="glossaries-user.html#dx1-13027" >2214</a>, <a -href="glossaries-user.html#dx1-13030" >2215</a>, <a -href="glossaries-user.html#dx1-13047" >2216</a>, <a -href="glossaries-user.html#dx1-14050" >2217</a>, <a -href="glossaries-user.html#dx1-14054" >2218</a>, <a -href="glossaries-user.html#dx1-16008" >2219</a>, <a -href="glossaries-user.html#dx1-16014" >2220</a>, <a -href="glossaries-user.html#dx1-16017" >2221</a>, <a -href="glossaries-user.html#dx1-16019" >2222</a>, <a -href="glossaries-user.html#dx1-16026" >2223</a>, <a -href="glossaries-user.html#dx1-16028" >2224</a>, <a -href="glossaries-user.html#dx1-16031" >2225</a>, <a -href="glossaries-user.html#dx1-16034" >2226</a>, <a -href="glossaries-user.html#dx1-16037" >2227</a>, <a -href="glossaries-user.html#dx1-16040" >2228</a>, <a -href="glossaries-user.html#dx1-16042" >2229</a>, <a -href="glossaries-user.html#dx1-16049" >2230</a>, <a -href="glossaries-user.html#dx1-16061" >2231</a>, <a -href="glossaries-user.html#dx1-16064" >2232</a>, <a -href="glossaries-user.html#dx1-16067" >2233</a>, <a -href="glossaries-user.html#dx1-16072" >2234</a>, <a -href="glossaries-user.html#dx1-16076" >2235</a>, <a -href="glossaries-user.html#dx1-16081" >2236</a>, <a -href="glossaries-user.html#dx1-16084" >2237</a>, <a -href="glossaries-user.html#dx1-17003" >2238</a>, <a -href="glossaries-user.html#dx1-17011" >2239</a>, <a -href="glossaries-user.html#dx1-17022" >2240</a>, <a -href="glossaries-user.html#dx1-17026" >2241</a>, <a -href="glossaries-user.html#dx1-17032" >2242</a>, <a -href="glossaries-user.html#dx1-17033" >2243</a>, <a -href="glossaries-user.html#x1-190001.5.3" >2244</a>, <a -href="glossaries-user.html#dx1-19001" >2245</a>, <a -href="glossaries-user.html#dx1-19002" >2246</a>, <a -href="glossaries-user.html#dx1-19004" >2247</a>, <a -href="glossaries-user.html#dx1-19006" >2248</a>, <a -href="glossaries-user.html#dx1-19009" >2249</a>, <a -href="glossaries-user.html#dx1-19011" >2250</a>, <a -href="glossaries-user.html#dx1-19022" >2251</a>, <a -href="glossaries-user.html#dx1-19024" >2252</a>, <a -href="glossaries-user.html#dx1-21001" >2253</a>, <a -href="glossaries-user.html#dx1-21007" >2254</a>, <a -href="glossaries-user.html#dx1-21010" >2255</a>, <a -href="glossaries-user.html#dx1-23045" >2256</a>, <a -href="glossaries-user.html#dx1-23047" >2257</a>, <a -href="glossaries-user.html#dx1-23056" >2258</a>, <a -href="glossaries-user.html#dx1-23059" >2259</a>, <a -href="glossaries-user.html#dx1-25009" >2260</a>, <a -href="glossaries-user.html#dx1-25062" >2261</a>, <a -href="glossaries-user.html#dx1-25065" >2262</a>, <a -href="glossaries-user.html#dx1-26030" >2263</a>, <a -href="glossaries-user.html#dx1-26060" >2264</a>, <a -href="glossaries-user.html#dx1-26064" >2265</a>, <a -href="glossaries-user.html#dx1-26066" >2266</a>, <a -href="glossaries-user.html#dx1-26068" >2267</a>, <a -href="glossaries-user.html#dx1-26071" >2268</a>, <a -href="glossaries-user.html#dx1-26080" >2269</a>, <a -href="glossaries-user.html#dx1-26084" >2270</a>, <a -href="glossaries-user.html#dx1-26090" >2271</a>, <a -href="glossaries-user.html#dx1-26093" >2272</a>, <a -href="glossaries-user.html#dx1-26094" >2273</a>, <a -href="glossaries-user.html#dx1-26095" >2274</a>, <a -href="glossaries-user.html#dx1-33004" >2275</a>, <a -href="glossaries-user.html#dx1-33006" >2276</a>, <a -href="glossaries-user.html#dx1-34090" >2277</a>, <a -href="glossaries-user.html#dx1-34092" >2278</a>, <a -href="glossaries-user.html#dx1-34145" >2279</a>, <a -href="glossaries-user.html#dx1-49007" >2280</a>, <a -href="glossaries-user.html#dx1-50012" >2281</a>, <a -href="glossaries-user.html#dx1-50013" >2282</a>, <a -href="glossaries-user.html#dx1-51003" >2283</a>, <a -href="glossaries-user.html#dx1-51006" >2284</a>, <a -href="glossaries-user.html#dx1-51012" >2285</a>, <a -href="glossaries-user.html#dx1-51013" >2286</a>, <a -href="glossaries-user.html#dx1-51019" >2287</a>, <a -href="glossaries-user.html#dx1-51020" >2288</a>, <a -href="glossaries-user.html#dx1-51022" >2289</a>, <a -href="glossaries-user.html#dx1-52002" >2290</a>, <a -href="glossaries-user.html#dx1-52003" >2291</a>, <a -href="glossaries-user.html#dx1-52008" >2292</a>, <a -href="glossaries-user.html#dx1-52011" >2293</a>, <a -href="glossaries-user.html#dx1-53007" >2294</a>, <a -href="glossaries-user.html#dx1-54006" >2295</a>, <a -href="glossaries-user.html#dx1-54048" >2296</a>, <a -href="glossaries-user.html#dx1-54052" >2297</a>, <a -href="glossaries-user.html#dx1-54070" >2298</a>, <a -href="glossaries-user.html#dx1-62065" >2299</a>, <a -href="glossaries-user.html#dx1-63008" >2300</a>, <a -href="glossaries-user.html#dx1-63010" >2301</a>, <a -href="glossaries-user.html#dx1-63041" >2302</a>, <a -href="glossaries-user.html#dx1-64001" >2303</a>, <a -href="glossaries-user.html#dx1-64003" >2304</a>, <a -href="glossaries-user.html#dx1-64004" >2305</a>, <a -href="glossaries-user.html#dx1-64006" >2306</a>, <a -href="glossaries-user.html#dx1-64011" >2307</a>, <a -href="glossaries-user.html#dx1-64015" >2308</a>, <a -href="glossaries-user.html#dx1-64016" >2309</a>, <a -href="glossaries-user.html#dx1-64018" >2310</a>, <a -href="glossaries-user.html#dx1-64019" >2311</a>, <a -href="glossaries-user.html#dx1-64020" >2312</a>, <a -href="glossaries-user.html#dx1-64021" >2313</a>, <a -href="glossaries-user.html#dx1-65001" >2314</a>, <a -href="glossaries-user.html#dx1-65002" >2315</a>, <a -href="glossaries-user.html#dx1-65006" >2316</a>, <a -href="glossaries-user.html#dx1-65011" >2317</a>, <a -href="glossaries-user.html#dx1-65014" >2318</a>, <a -href="glossaries-user.html#dx1-66003" >2319</a>, <a -href="glossaries-user.html#dx1-66013" >2320</a>, <a -href="glossaries-user.html#dx1-66019" >2321</a>, <a -href="glossaries-user.html#dx1-66025" >2322</a>, <a -href="glossaries-user.html#dx1-66037" >2323</a>, <a -href="glossaries-user.html#dx1-66044" >2324</a>, <a -href="glossaries-user.html#dx1-66064" >2325</a>, <a -href="glossaries-user.html#dx1-67002" >2326</a>, <a -href="glossaries-user.html#dx1-67003" >2327</a>, <a -href="glossaries-user.html#dx1-68004" >2328</a>, <a -href="glossaries-user.html#dx1-85032" >2329</a>, <a -href="glossaries-user.html#dx1-88025" >2330</a>, <a -href="glossaries-user.html#dx1-88029" >2331</a>, <a -href="glossaries-user.html#dx1-9006" >2332</a> <br /></span> +href="glossaries-user.html#dx1-3005" >4641</a>, <a +href="glossaries-user.html#dx1-3037" >4642</a>, <a +href="glossaries-user.html#dx1-3045" >4643</a>, <a +href="glossaries-user.html#dx1-3050" >4644</a>, <a +href="glossaries-user.html#dx1-3069" ><span +class="cmbx-10">4645</span></a>, <a +href="glossaries-user.html#dx1-4016" >4646</a>, <a +href="glossaries-user.html#dx1-4017" >4647</a>, <a +href="glossaries-user.html#dx1-8005" >4648</a>, <a +href="glossaries-user.html#dx1-8006" >4649</a>, <a +href="glossaries-user.html#dx1-8007" >4650</a>, <a +href="glossaries-user.html#dx1-8008" >4651</a>, <a +href="glossaries-user.html#dx1-8009" >4652</a>, <a +href="glossaries-user.html#dx1-8010" >4653</a>, <a +href="glossaries-user.html#dx1-8011" >4654</a>, <a +href="glossaries-user.html#dx1-8012" >4655</a>, <a +href="glossaries-user.html#dx1-8013" >4656</a>, <a +href="glossaries-user.html#dx1-8031" >4657</a>, <a +href="glossaries-user.html#dx1-8035" >4658</a>, <a +href="glossaries-user.html#dx1-8036" >4659</a>, <a +href="glossaries-user.html#dx1-8039" >4660</a>, <a +href="glossaries-user.html#dx1-8041" >4661</a>, <a +href="glossaries-user.html#dx1-8042" >4662</a>, <a +href="glossaries-user.html#dx1-8043" >4663</a>, <a +href="glossaries-user.html#dx1-8046" >4664</a>, <a +href="glossaries-user.html#dx1-8047" >4665</a>, <a +href="glossaries-user.html#dx1-8051" >4666</a>, <a +href="glossaries-user.html#dx1-8052" >4667</a>, <a +href="glossaries-user.html#dx1-8053" >4668</a>, <a +href="glossaries-user.html#dx1-9035" >4669</a>, <a +href="glossaries-user.html#dx1-13001" >4670</a>, <a +href="glossaries-user.html#dx1-13003" >4671</a>, <a +href="glossaries-user.html#dx1-13007" >4672</a>, <a +href="glossaries-user.html#dx1-13019" >4673</a>, <a +href="glossaries-user.html#dx1-13025" >4674</a>, <a +href="glossaries-user.html#dx1-13028" >4675</a>, <a +href="glossaries-user.html#dx1-13044" >4676</a>, <a +href="glossaries-user.html#dx1-14052" >4677</a>, <a +href="glossaries-user.html#dx1-14056" >4678</a>, <a +href="glossaries-user.html#dx1-16009" >4679</a>, <a +href="glossaries-user.html#dx1-16013" >4680</a>, <a +href="glossaries-user.html#dx1-16016" >4681</a>, <a +href="glossaries-user.html#dx1-16018" >4682</a>, <a +href="glossaries-user.html#dx1-16025" >4683</a>, <a +href="glossaries-user.html#dx1-16027" >4684</a>, <a +href="glossaries-user.html#dx1-16030" >4685</a>, <a +href="glossaries-user.html#dx1-16033" >4686</a>, <a +href="glossaries-user.html#dx1-16036" >4687</a>, <a +href="glossaries-user.html#dx1-16039" >4688</a>, <a +href="glossaries-user.html#dx1-16041" >4689</a>, <a +href="glossaries-user.html#dx1-16048" >4690</a>, <a +href="glossaries-user.html#dx1-16061" >4691</a>, <a +href="glossaries-user.html#dx1-16064" >4692</a>, <a +href="glossaries-user.html#dx1-16067" >4693</a>, <a +href="glossaries-user.html#dx1-16072" >4694</a>, <a +href="glossaries-user.html#dx1-16079" >4695</a>, <a +href="glossaries-user.html#dx1-16084" >4696</a>, <a +href="glossaries-user.html#dx1-16087" >4697</a>, <a +href="glossaries-user.html#dx1-17003" >4698</a>, <a +href="glossaries-user.html#dx1-17011" >4699</a>, <a +href="glossaries-user.html#dx1-17022" >4700</a>, <a +href="glossaries-user.html#dx1-17026" >4701</a>, <a +href="glossaries-user.html#dx1-17032" >4702</a>, <a +href="glossaries-user.html#dx1-17033" >4703</a>, <a +href="glossaries-user.html#x1-190001.4.3" >4704</a>, <a +href="glossaries-user.html#dx1-19001" >4705</a>, <a +href="glossaries-user.html#dx1-19002" >4706</a>, <a +href="glossaries-user.html#dx1-19004" >4707</a>, <a +href="glossaries-user.html#dx1-19006" >4708</a>, <a +href="glossaries-user.html#dx1-19009" >4709</a>, <a +href="glossaries-user.html#dx1-19011" >4710</a>, <a +href="glossaries-user.html#dx1-19022" >4711</a>, <a +href="glossaries-user.html#dx1-19024" >4712</a>, <a +href="glossaries-user.html#dx1-21001" >4713</a>, <a +href="glossaries-user.html#dx1-22003" >4714</a>, <a +href="glossaries-user.html#dx1-22008" >4715</a>, <a +href="glossaries-user.html#dx1-22013" >4716</a>, <a +href="glossaries-user.html#dx1-22015" >4717</a>, <a +href="glossaries-user.html#dx1-22018" >4718</a>, <a +href="glossaries-user.html#dx1-31014" >4719</a>, <a +href="glossaries-user.html#dx1-31017" >4720</a>, <a +href="glossaries-user.html#dx1-46008" >4721</a>, <a +href="glossaries-user.html#dx1-55003" >4722</a>, <a +href="glossaries-user.html#dx1-55006" >4723</a>, <a +href="glossaries-user.html#dx1-63006" >4724</a>, <a +href="glossaries-user.html#dx1-63008" >4725</a>, <a +href="glossaries-user.html#dx1-67009" >4726</a>, <a +href="glossaries-user.html#dx1-73028" >4727</a>, <a +href="glossaries-user.html#dx1-75006" >4728</a>, <a +href="glossaries-user.html#dx1-76001" >4729</a>, <a +href="glossaries-user.html#dx1-76003" >4730</a>, <a +href="glossaries-user.html#dx1-76005" >4731</a>, <a +href="glossaries-user.html#dx1-76008" >4732</a>, <a +href="glossaries-user.html#dx1-79003" >4733</a>, <a +href="glossaries-user.html#dx1-79007" >4734</a>, <a +href="glossaries-user.html#dx1-79013" >4735</a>, <a +href="glossaries-user.html#dx1-79016" >4736</a>, <a +href="glossaries-user.html#dx1-79017" >4737</a>, <a +href="glossaries-user.html#dx1-79018" >4738</a>, <a +href="glossaries-user.html#dx1-111004" >4739</a>, <a +href="glossaries-user.html#dx1-111006" >4740</a>, <a +href="glossaries-user.html#dx1-112093" >4741</a>, <a +href="glossaries-user.html#dx1-112095" >4742</a>, <a +href="glossaries-user.html#dx1-112158" >4743</a>, <a +href="glossaries-user.html#dx1-127007" >4744</a>, <a +href="glossaries-user.html#dx1-128012" >4745</a>, <a +href="glossaries-user.html#dx1-128013" >4746</a>, <a +href="glossaries-user.html#dx1-129004" >4747</a>, <a +href="glossaries-user.html#dx1-129007" >4748</a>, <a +href="glossaries-user.html#dx1-129013" >4749</a>, <a +href="glossaries-user.html#dx1-129014" >4750</a>, <a +href="glossaries-user.html#dx1-129020" >4751</a>, <a +href="glossaries-user.html#dx1-129021" >4752</a>, <a +href="glossaries-user.html#dx1-129024" >4753</a>, <a +href="glossaries-user.html#dx1-130002" >4754</a>, <a +href="glossaries-user.html#dx1-130003" >4755</a>, <a +href="glossaries-user.html#dx1-130008" >4756</a>, <a +href="glossaries-user.html#dx1-130011" >4757</a>, <a +href="glossaries-user.html#dx1-131007" >4758</a>, <a +href="glossaries-user.html#dx1-132006" >4759</a>, <a +href="glossaries-user.html#dx1-132048" >4760</a>, <a +href="glossaries-user.html#dx1-132052" >4761</a>, <a +href="glossaries-user.html#dx1-132056" >4762</a>, <a +href="glossaries-user.html#dx1-132075" >4763</a>, <a +href="glossaries-user.html#dx1-140064" >4764</a>, <a +href="glossaries-user.html#dx1-141008" >4765</a>, <a +href="glossaries-user.html#dx1-141012" >4766</a>, <a +href="glossaries-user.html#dx1-141043" >4767</a>, <a +href="glossaries-user.html#dx1-142001" >4768</a>, <a +href="glossaries-user.html#dx1-142003" >4769</a>, <a +href="glossaries-user.html#dx1-142004" >4770</a>, <a +href="glossaries-user.html#dx1-142006" >4771</a>, <a +href="glossaries-user.html#dx1-142011" >4772</a>, <a +href="glossaries-user.html#dx1-142015" >4773</a>, <a +href="glossaries-user.html#dx1-142016" >4774</a>, <a +href="glossaries-user.html#dx1-142018" >4775</a>, <a +href="glossaries-user.html#dx1-142019" >4776</a>, <a +href="glossaries-user.html#dx1-142020" >4777</a>, <a +href="glossaries-user.html#dx1-142021" >4778</a>, <a +href="glossaries-user.html#dx1-143001" >4779</a>, <a +href="glossaries-user.html#dx1-143002" >4780</a>, <a +href="glossaries-user.html#dx1-143006" >4781</a>, <a +href="glossaries-user.html#dx1-143011" >4782</a>, <a +href="glossaries-user.html#dx1-143014" >4783</a>, <a +href="glossaries-user.html#dx1-144003" >4784</a>, <a +href="glossaries-user.html#dx1-144014" >4785</a>, <a +href="glossaries-user.html#dx1-144021" >4786</a>, <a +href="glossaries-user.html#dx1-144028" >4787</a>, <a +href="glossaries-user.html#dx1-144040" >4788</a>, <a +href="glossaries-user.html#dx1-144047" >4789</a>, <a +href="glossaries-user.html#dx1-144067" >4790</a>, <a +href="glossaries-user.html#dx1-145002" >4791</a>, <a +href="glossaries-user.html#dx1-145003" >4792</a>, <a +href="glossaries-user.html#dx1-146004" >4793</a>, <a +href="glossaries-user.html#dx1-163032" >4794</a>, <a +href="glossaries-user.html#dx1-166025" >4795</a>, <a +href="glossaries-user.html#dx1-166029" >4796</a>, <a +href="glossaries-user.html#dx1-175016" >4797</a>, <a +href="glossaries-user.html#dx1-175042" >4798</a>, <a +href="glossaries-user.html#dx1-176026" >4799</a>, <a +href="glossaries-user.html#dx1-176031" >4800</a>, <a +href="glossaries-user.html#dx1-188008" >4801</a>, <a +href="glossaries-user.html#dx1-190015" >4802</a>, <a +href="glossaries-user.html#dx1-192011" >4803</a>, <a +href="glossaries-user.html#dx1-200077" >4804</a>, <a +href="glossaries-user.html#dx1-210002" >4805</a>, <a +href="glossaries-user.html#dx1-210006" >4806</a>, <a +href="glossaries-user.html#dx1-211002" >4807</a>, <a +href="glossaries-user.html#dx1-211005" >4808</a>, <a +href="glossaries-user.html#dx1-211011" >4809</a>, <a +href="glossaries-user.html#dx1-211012" >4810</a>, <a +href="glossaries-user.html#dx1-211019" >4811</a>, <a +href="glossaries-user.html#dx1-211027" >4812</a>, <a +href="glossaries-user.html#dx1-211030" >4813</a>, <a +href="glossaries-user.html#dx1-211038" >4814</a>, <a +href="glossaries-user.html#dx1-211065" >4815</a>, <a +href="glossaries-user.html#dx1-212001" >4816</a>, <a +href="glossaries-user.html#dx1-212002" >4817</a>, <a +href="glossaries-user.html#dx1-212003" >4818</a>, <a +href="glossaries-user.html#dx1-214001" >4819</a>, <a +href="glossaries-user.html#dx1-214003" >4820</a>, <a +href="glossaries-user.html#dx1-214005" >4821</a>, <a +href="glossaries-user.html#dx1-214031" >4822</a>, <a +href="glossaries-user.html#dx1-220008" >4823</a>, <a +href="glossaries-user.html#dx1-220036" >4824</a>, <a +href="glossaries-user.html#dx1-9037" >4825</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-C</span>  <a -href="glossaries-user.html#dx1-8025" >2333</a>, <a -href="glossaries-user.html#dx1-13029" >2334</a>, <a -href="glossaries-user.html#dx1-16091" >2335</a>, <a -href="glossaries-user.html#dx1-16095" >2336</a>, <a -href="glossaries-user.html#dx1-65017" >2337</a> <br /></span> +href="glossaries-user.html#dx1-8033" >4826</a>, <a +href="glossaries-user.html#dx1-13027" >4827</a>, <a +href="glossaries-user.html#dx1-16094" >4828</a>, <a +href="glossaries-user.html#dx1-16098" >4829</a>, <a +href="glossaries-user.html#dx1-143017" >4830</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-I</span>  <a -href="glossaries-user.html#dx1-19007" >2338</a>, <a -href="glossaries-user.html#dx1-19008" >2339</a> <br /></span> +href="glossaries-user.html#dx1-19007" >4831</a>, <a +href="glossaries-user.html#dx1-19008" >4832</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-L</span>  <a -href="glossaries-user.html#dx1-8024" >2340</a>, <a -href="glossaries-user.html#dx1-16090" >2341</a>, <a -href="glossaries-user.html#dx1-16093" >2342</a>, <a -href="glossaries-user.html#dx1-65016" >2343</a> <br /></span> +href="glossaries-user.html#dx1-8032" >4833</a>, <a +href="glossaries-user.html#dx1-16093" >4834</a>, <a +href="glossaries-user.html#dx1-16096" >4835</a>, <a +href="glossaries-user.html#dx1-143016" >4836</a> <br /></span> <span class="index-subitem">    <span class="cmtt-10">-M</span>  <a -href="glossaries-user.html#dx1-16087" >2344</a> <br /></span> +href="glossaries-user.html#dx1-16090" >4837</a> <br /></span> +<span class="index-item">xindy attributes  <a +href="glossaries-user.html#dx1-16049" >4838</a>, <a +href="glossaries-user.html#dx1-132076" >4839</a>, <a +href="glossaries-user.html#dx1-144010" >4840</a>, <a +href="glossaries-user.html#dx1-144017" >4841</a>, <a +href="glossaries-user.html#dx1-144022" >4842</a> <br /></span> +<span class="index-subitem">    <span +class="cmtt-10">:locref</span>  <a +href="glossaries-user.html#dx1-129022" >4843</a> <br /></span> <span class="index-item"><span class="cmss-10">xkeyval </span>package  <a -href="glossaries-user.html#dx1-9" >2345</a>, <a -href="glossaries-user.html#dx1-11005" >2346</a>, <a -href="glossaries-user.html#dx1-58030" >2347</a> <br /></span> +href="glossaries-user.html#dx1-8" >4844</a>, <a +href="glossaries-user.html#dx1-136030" >4845</a>, <a +href="glossaries-user.html#dx1-223002" >4846</a> <br /></span> +<span class="index-item"><span class="obeylines-h"><span class="verb"><span +class="cmtt-10">\xspace</span></span></span>  <a +href="glossaries-user.html#dx1-152018" >4847</a> <br /></span> <span class="index-item"><span class="cmss-10">xspace </span>package  <a -href="glossaries-user.html#dx1-74014" >2348</a>, <a -href="glossaries-user.html#dx1-74015" >2349</a>, <a -href="glossaries-user.html#dx1-74017" >2350</a>, <a -href="glossaries-user.html#dx1-74019" >2351</a>, <a -href="glossaries-user.html#dx1-74021" >2352</a>, <a -href="glossaries-user.html#dx1-74023" >2353</a>, <a -href="glossaries-user.html#dx1-74024" >2354</a> <br /></span> +href="glossaries-user.html#dx1-152014" >4848</a>, <a +href="glossaries-user.html#dx1-152015" >4849</a>, <a +href="glossaries-user.html#dx1-152017" >4850</a>, <a +href="glossaries-user.html#dx1-152019" >4851</a>, <a +href="glossaries-user.html#dx1-152021" >4852</a>, <a +href="glossaries-user.html#dx1-152023" >4853</a>, <a +href="glossaries-user.html#dx1-152024" >4854</a> <br /></span> </p></div> - - - <div class="footnotes"><!--l. 641--><p class="indent" > <span class="footnote-mark"><a + + + <div class="footnotes"><!--l. 871--><p class="indent" > <span class="footnote-mark"><a href="#fn1x1-bk" id="fn1x1"><sup class="textsuperscript">1.1</sup></a></span><span -class="cmr-8">That is, if the term has been referenced using any of the commands described in </span><a -href="#sec:glslink"><span -class="tcrm-0800">§</span><span +class="cmr-8">That is, if the entry has been referenced using any of the commands described in </span><a +href="#sec:glslink">§<span class="cmr-8">6 </span></a><a href="#sec:glslink"><span -class="cmr-8">Links to Glossary</span> -<span -class="cmr-8">Entries</span><!--tex4ht:ref: sec:glslink --></a> <span +class="cmr-8">Links to Glossary Entries</span><!--tex4ht:ref: sec:glslink --></a> <span class="cmr-8">and </span><a -href="#sec:glsadd"><span -class="tcrm-0800">§</span><span +href="#sec:glsadd">§<span class="cmr-8">7 </span></a><a href="#sec:glsadd"><span -class="cmr-8">Adding an Entry to the Glossary Without Generating Text</span><!--tex4ht:ref: sec:glsadd --></a> <span +class="cmr-8">Adding</span> +<span +class="cmr-8">an Entry to the Glossary Without Generating Text</span><!--tex4ht:ref: sec:glsadd --></a> <span class="cmr-8">or via </span><span class="cmtt-8">\glssee</span><a id="dx1-4002"></a> <span class="cmr-8">(or the </span><span -class="cmss-8">see</span><a +class="cmtt-8">see</span><a id="dx1-4003"></a> <span -class="cmr-8">key) or</span> -<span -class="cmr-8">commands such as </span><span +class="cmr-8">key) or commands such as </span><span class="cmtt-8">\acrshort</span><a - id="dx1-4004"></a><span + id="dx1-4004"></a> <span +class="cmr-8">or</span> +<span id="textcolor3"><span +class="cmtt-8">\glsxtrshort</span></span><a + id="dx1-4005"></a><span class="cmr-8">.</span></p> -<!--l. 1253--><p class="indent" > <span class="footnote-mark"><a +<!--l. 1734--><p class="indent" > <span class="footnote-mark"><a href="#fn2x1-bk" id="fn2x1"><sup class="textsuperscript">1.2</sup></a></span><span class="cmr-8">Except for Klingon, which is supported by </span><a href="#glo:xindy"><span class="cmtt-8">xindy</span><a - id="dx1-9006"></a></a><span + id="dx1-9037"></a></a><span class="cmr-8">, but not by the CLDR.</span></p> -<!--l. 1362--><p class="indent" > <span class="footnote-mark"><a +<!--l. 1828--><p class="indent" > <span class="footnote-mark"><a href="#fn3x1-bk" id="fn3x1"><sup class="textsuperscript">1.3</sup></a></span><span -class="cmr-8">Note that although I’ve written </span><span -class="cmtt-8">latex </span><span -class="cmr-8">in this section, it’s better to use </span><span -class="cmtt-8">pdflatex</span><span -class="cmr-8">, where possible, for</span> -<span -class="cmr-8">the reasons given </span><a -href="#pdflatexnote"><span -class="cmr-8">earlier</span></a><span -class="cmr-8">.</span></p> -<!--l. 2076--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">You can just use the base </span><span +class="cmss-8">glossaries </span><span +class="cmr-8">package for the first case, but it’s less convenient. You’d have to manually insert the</span> +<span +class="cmr-8">entry target before the sectioning command and use </span><span +class="cmtt-8">\glsentryname</span><a + id="dx1-11002"></a><span +class="cmtt-8">{</span>⟨<span +class="cmti-8">label</span>⟩<span +class="cmtt-8">} </span><span +class="cmr-8">or </span><span +class="cmtt-8">\Glsentryname</span><a + id="dx1-11003"></a><span +class="cmtt-8">{</span>⟨<span +class="cmti-8">label</span>⟩<span +class="cmtt-8">} </span><span +class="cmr-8">to display the entry</span> +<span +class="cmr-8">name.</span></p><!--l. 1999--><p class="indent" > <span class="footnote-mark"><a href="#fn4x1-bk" id="fn4x1"><sup class="textsuperscript">1.4</sup></a></span><span +class="cmtt-8">\glossentrysymbol </span><span +class="cmr-8">is defined by the base </span><span +class="cmss-8">glossaries </span><span +class="cmr-8">package but is redefined by </span><a +href="#glo:glossaries-extra"><span +class="cmss-8">glossaries-extra</span></a><span +class="cmr-8">.</span></p> +<!--l. 2395--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x1-bk" id="fn5x1"><sup class="textsuperscript">1.5</sup></a></span><span class="cmr-8">deprecated, use </span><span class="cmss-8">babel </span><span class="cmr-8">instead</span></p> -<!--l. 2639--><p class="noindent" ><span class="footnote-mark"><a -href="#fn5x1-bk" id="fn5x1"><sup class="textsuperscript">1.5</sup></a></span><span +<!--l. 2967--><p class="noindent" ><span class="footnote-mark"><a +href="#fn6x1-bk" id="fn6x1"><sup class="textsuperscript">1.6</sup></a></span><span class="cmr-8">Added to version </span><a href="#glo:makeglossaries"><span class="cmtt-8">makeglossaries</span><a - id="dx1-16046"></a></a> <span + id="dx1-16045"></a></a> <span class="cmr-8">2.18.</span></p> -<!--l. 2683--><p class="indent" > <span class="footnote-mark"><a -href="#fn6x1-bk" id="fn6x1"><sup class="textsuperscript">1.6</sup></a></span><span +<!--l. 3011--><p class="indent" > <span class="footnote-mark"><a +href="#fn7x1-bk" id="fn7x1"><sup class="textsuperscript">1.7</sup></a></span><span class="cmr-8">As from v3.01 </span><span class="cmtt-8">\gls</span><a id="dx1-16069"></a> <span class="cmr-8">is no longer fragile and doesn’t need protecting.</span></p> -<!--l. 2785--><p class="indent" > <span class="footnote-mark"><a -href="#fn7x1-bk" id="fn7x1"><sup class="textsuperscript">1.7</sup></a></span><span +<!--l. 3114--><p class="indent" > <span class="footnote-mark"><a +href="#fn8x1-bk" id="fn8x1"><sup class="textsuperscript">1.8</sup></a></span><span class="cmr-8">The batch file </span><span class="cmtt-8">makeglossaries.bat </span><span class="cmr-8">has been removed since the </span><span class="TEX"><span @@ -30896,243 +47977,273 @@ class="cmr-8">T</span><span class="E"><span class="cmr-8">E</span></span><span class="cmr-8">X</span></span><span -class="cmr-8"> distributions for Windows</span> +class="cmr-8"> distributions for Windows provide</span> <span -class="cmr-8">provide </span><span class="cmtt-8">makeglossaries.exe</span><span class="cmr-8">.</span></p> -<!--l. 3445--><p class="noindent" ><span class="footnote-mark"><a +<!--l. 3675--><p class="indent" > <span class="footnote-mark"><a href="#fn1x2-bk" id="fn1x2"><sup class="textsuperscript">2.1</sup></a></span><span -class="cmr-8">bug fix in v4.16 has corrected the code to ensure this.</span></p> -<!--l. 3541--><p class="noindent" ><span class="footnote-mark"><a +class="cmr-8">These figures don’t include standard files and registers provided by the kernel or </span><span +class="cmss-8">hyperref</span><a + id="dx1-31010"></a><span +class="cmr-8">, such as </span><span +class="cmtt-8">aux </span><span +class="cmr-8">and</span> +<span +class="cmtt-8">out</span><span +class="cmr-8">.</span></p><!--l. 3923--><p class="indent" > <span class="footnote-mark"><a href="#fn2x2-bk" id="fn2x2"><sup class="textsuperscript">2.2</sup></a></span><span class="cmr-8">unless </span><span class="cmss-8">memoir</span><a - id="dx1-24015"></a> <span + id="dx1-41005"></a> <span class="cmr-8">is loaded, which case it uses </span><span class="cmtt-8">\markboth</span><a - id="dx1-24016"></a></p> -<!--l. 3571--><p class="noindent" ><span class="footnote-mark"><a + id="dx1-41006"></a></p> +<!--l. 3954--><p class="indent" > <span class="footnote-mark"><a href="#fn3x2-bk" id="fn3x2"><sup class="textsuperscript">2.3</sup></a></span><span class="cmr-8">Actually it uses </span><span class="cmtt-8">\mfirstucMakeUppercase</span><a - id="dx1-24026"></a> <span + id="dx1-42007"></a> <span class="cmr-8">which is set to </span><span class="cmss-8">textcase</span><a - id="dx1-24027"></a><span + id="dx1-42008"></a><span class="cmr-8">’s </span><span class="cmtt-8">\MakeTextUppercase </span><span class="cmr-8">by the </span><span -class="cmss-8">glossaries</span> +class="cmss-8">glossaries </span><span +class="cmr-8">package. This</span> <span -class="cmr-8">package. This makes it consistent with </span><span +class="cmr-8">makes it consistent with </span><span class="cmtt-8">\makefirstuc</span><a - id="dx1-24028"></a><span + id="dx1-42009"></a><span class="cmr-8">. (The </span><span class="cmss-8">textcase</span><a - id="dx1-24029"></a> <span -class="cmr-8">package is automatically loaded by</span> -<span + id="dx1-42010"></a> <span +class="cmr-8">package is automatically loaded by </span><span class="cmss-8">glossaries</span><span class="cmr-8">.)</span></p> -<!--l. 4175--><p class="noindent" ><span class="footnote-mark"><a +<!--l. 4310--><p class="indent" > <span class="footnote-mark"><a href="#fn4x2-bk" id="fn4x2"><sup class="textsuperscript">2.4</sup></a></span><span +class="cmr-8">bug fix in v4.16 has corrected the code to ensure this.</span></p> +<!--l. 5012--><p class="indent" > <span class="footnote-mark"><a +href="#fn5x2-bk" id="fn5x2"><sup class="textsuperscript">2.5</sup></a></span><span class="cmr-8">Actually it sets </span><span class="cmtt-8">\acronymtype</span><a - id="dx1-27009"></a> <span + id="dx1-90008"></a> <span class="cmr-8">to </span><span class="cmtt-8">\glsdefaulttype</span><a - id="dx1-27010"></a> <span + id="dx1-90009"></a> <span class="cmr-8">if the </span><span class="cmss-8">acronym</span><a - id="dx1-27011"></a> <span -class="cmr-8">package option is not used, but</span> -<span + id="dx1-90010"></a> <span +class="cmr-8">package option is not used, but </span><span class="cmtt-8">\glsdefaulttype</span><a - id="dx1-27012"></a> <span -class="cmr-8">usually has the value </span><span + id="dx1-90011"></a> <span +class="cmr-8">usually</span> +<span +class="cmr-8">has the value </span><span class="cmtt-8">main </span><span class="cmr-8">unless the </span><span class="cmss-8">nomain</span><a - id="dx1-27013"></a> <span + id="dx1-90012"></a> <span class="cmr-8">option has been used.</span></p> -<!--l. 5751--><p class="indent" > <span class="footnote-mark"><a +<!--l. 6559--><p class="indent" > <span class="footnote-mark"><a href="#fn1x4-bk" id="fn1x4"><sup class="textsuperscript">4.1</sup></a></span><span class="cmr-8">This is because </span><span class="cmtt-8">\acronymtype</span><a - id="dx1-44022"></a> <span + id="dx1-122022"></a> <span class="cmr-8">is set to </span><span class="cmtt-8">\glsdefaulttype</span><a - id="dx1-44023"></a> <span + id="dx1-122023"></a> <span class="cmr-8">if the </span><span class="cmss-8">acronym</span><a - id="dx1-44024"></a> <span -class="cmr-8">package option is not</span> -<span -class="cmr-8">used.</span></p> -<!--l. 6626--><p class="noindent" ><span class="footnote-mark"><a + id="dx1-122024"></a> <span +class="cmr-8">package option is not used.</span></p> +<!--l. 7440--><p class="noindent" ><span class="footnote-mark"><a href="#fn1x6-bk" id="fn1x6"><sup class="textsuperscript">6.1</sup></a></span><span class="cmr-8">See also “Displaying the glossary” in the documented code, </span><span class="cmtt-8">glossaries-code.pdf</span><span class="cmr-8">.</span></p> -<!--l. 6738--><p class="noindent" ><span class="footnote-mark"><a +<!--l. 7591--><p class="noindent" ><span class="footnote-mark"><a href="#fn2x6-bk" id="fn2x6"><sup class="textsuperscript">6.2</sup></a></span><span class="cmr-8">I’ve used </span><span class="cmtt-8">\MakeUppercase </span><span class="cmr-8">in all the examples for clarity, but it will actually use </span><span class="cmtt-8">\mfirstucMakeUppercase</span><span class="cmr-8">.</span></p> -<!--l. 7181--><p class="indent" > <span class="footnote-mark"><a +<!--l. 8040--><p class="indent" > <span class="footnote-mark"><a href="#fn3x6-bk" id="fn3x6"><sup class="textsuperscript">6.3</sup></a></span><span class="cmtt-8">\glsdisplayfirst</span><a - id="dx1-57003"></a> <span + id="dx1-135003"></a> <span class="cmr-8">and </span><span class="cmtt-8">\glsdisplay</span><a - id="dx1-57004"></a> <span -class="cmr-8">are now deprecated. Backwards compatibility should be preserved</span> + id="dx1-135004"></a> <span +class="cmr-8">are now deprecated. Backwards compatibility should be preserved but you may need to</span> <span -class="cmr-8">but you may need to use the </span><span +class="cmr-8">use the </span><span class="cmss-8">compatible-3.07</span><a - id="dx1-57005"></a> <span + id="dx1-135005"></a> <span class="cmr-8">option</span></p> -<!--l. 7816--><p class="indent" > <span class="footnote-mark"><a +<!--l. 8727--><p class="indent" > <span class="footnote-mark"><a href="#fn1x8-bk" id="fn1x8"><sup class="textsuperscript">8.1</sup></a></span><a href="#glo:makeindex"><span class="cmtt-8">makeindex</span><a - id="dx1-61004"></a></a> <span -class="cmr-8">will always assign a location number, even if it’s not needed, so it needs to be</span> -<span -class="cmr-8">discarded.</span></p><!--l. 7821--><p class="indent" > <span class="footnote-mark"><a + id="dx1-139004"></a></a> <span +class="cmr-8">will always assign a location number, even if it’s not needed, so it needs to be discarded.</span></p> +<!--l. 8732--><p class="indent" > <span class="footnote-mark"><a href="#fn2x8-bk" id="fn2x8"><sup class="textsuperscript">8.2</sup></a></span><span class="cmr-8">If you redefine </span><span class="cmtt-8">\glsseeformat</span><span class="cmr-8">, keep the default value of the optional argument as </span><span class="cmtt-8">\seename</span><a - id="dx1-61006"></a> <span -class="cmr-8">as</span> -<span -class="cmr-8">both </span><span -class="cmss-8">see</span><a - id="dx1-61007"></a> <span + id="dx1-139006"></a> <span +class="cmr-8">as both </span><span +class="cmtt-8">see</span><a + id="dx1-139007"></a> <span class="cmr-8">and </span><span -class="cmtt-8">\glssee </span><span +class="cmtt-8">\glssee</span> +<span class="cmr-8">explicitly write </span><span class="cmtt-8">[\seename] </span><span -class="cmr-8">in the output file if no optional argument is</span> -<span -class="cmr-8">given.</span></p> -<!--l. 7846--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">in the output file if no optional argument is given.</span></p> +<!--l. 8757--><p class="indent" > <span class="footnote-mark"><a href="#fn3x8-bk" id="fn3x8"><sup class="textsuperscript">8.3</sup></a></span><span class="cmr-8">In versions before 3.0, </span><span class="cmtt-8">\glsentryname </span><span class="cmr-8">was used, but this could cause problems when the </span><span -class="cmss-8">name</span><a - id="dx1-61014"></a> <span +class="cmtt-8">name</span><a + id="dx1-139014"></a> <span class="cmr-8">key was</span> <a href="#glo:sanitize"><span class="cmr-8">sanitized</span><a - id="dx1-61015"></a></a><span -class="cmr-8">.</span></p><!--l. 8138--><p class="indent" > <span class="footnote-mark"><a + id="dx1-139015"></a></a><span +class="cmr-8">.</span></p><!--l. 9054--><p class="indent" > <span class="footnote-mark"><a href="#fn1x9-bk" id="fn1x9"><sup class="textsuperscript">9.1</sup></a></span><span class="cmr-8">versions before 3.0 used </span><span class="cmtt-8">\glsentryname</span><a - id="dx1-62054"></a> <span + id="dx1-140053"></a> <span class="cmr-8">as the default, but this could cause problems when </span><span -class="cmss-8">name</span><a - id="dx1-62055"></a> <span -class="cmr-8">had</span> -<span -class="cmr-8">been </span><a +class="cmtt-8">name</span><a + id="dx1-140054"></a> <span +class="cmr-8">had been</span> +<a href="#glo:sanitize"><span class="cmr-8">sanitized</span><a - id="dx1-62056"></a></a><span -class="cmr-8">.</span></p><!--l. 8392--><p class="indent" > <span class="footnote-mark"><a + id="dx1-140055"></a></a><span +class="cmr-8">.</span></p><!--l. 9353--><p class="indent" > <span class="footnote-mark"><a href="#fn1x10-bk" id="fn1x10"><sup class="textsuperscript">10.1</sup></a></span><span class="cmr-8">you can’t use the </span><span class="cmss-8">longheaderborder</span><a - id="dx1-63071"></a> <span + id="dx1-141081"></a> <span class="cmr-8">style for this example as you can’t use the </span><span class="cmss-8">longtable</span><a - id="dx1-63072"></a><a - id="dx1-63073"></a> <span -class="cmr-8">environment in</span> + id="dx1-141082"></a><a + id="dx1-141083"></a> <span +class="cmr-8">environment in two column</span> <span -class="cmr-8">two column mode.</span></p><!--l. 8874--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">mode.</span></p><!--l. 9835--><p class="indent" > <span class="footnote-mark"><a href="#fn1x11-bk" id="fn1x11"><sup class="textsuperscript">11.1</sup></a></span><span class="cmr-8">see </span><span class="cmtt-8">\glsSetCompositor</span><a - id="dx1-66053"></a> <span + id="dx1-144056"></a> <span class="cmr-8">described in </span><a -href="#sec:setup"><span -class="tcrm-0800">§</span><span +href="#sec:setup">§<span class="cmr-8">3 </span></a><a href="#sec:setup"><span class="cmr-8">Setting Up</span><!--tex4ht:ref: sec:setup --></a></p> -<!--l. 8879--><p class="indent" > <span class="footnote-mark"><a +<!--l. 9840--><p class="indent" > <span class="footnote-mark"><a href="#fn2x11-bk" id="fn2x11"><sup class="textsuperscript">11.2</sup></a></span><span class="cmr-8">see </span><span class="cmtt-8">\glsSetAlphaCompositor</span><a - id="dx1-66055"></a> <span + id="dx1-144058"></a> <span class="cmr-8">described in </span><a -href="#sec:setup"><span -class="tcrm-0800">§</span><span +href="#sec:setup">§<span class="cmr-8">3 </span></a><a href="#sec:setup"><span class="cmr-8">Setting Up</span><!--tex4ht:ref: sec:setup --></a></p> -<!--l. 8883--><p class="indent" > <span class="footnote-mark"><a +<!--l. 9844--><p class="indent" > <span class="footnote-mark"><a href="#fn3x11-bk" id="fn3x11"><sup class="textsuperscript">11.3</sup></a></span><span class="cmr-8">With </span><a href="#glo:glossaries-extra"><span class="cmss-8">glossaries-extra</span></a> <span class="cmtt-8">seealso </span><span class="cmr-8">is appended to the end of the list.</span></p> -<!--l. 10432--><p class="indent" > <span class="footnote-mark"><a +<!--l. 11404--><p class="indent" > <span class="footnote-mark"><a href="#fn1x13-bk" id="fn1x13"><sup class="textsuperscript">13.1</sup></a></span><span -class="cmr-8">as from version 1.18</span></p><!--l. 10461--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">as from version 1.18</span></p><!--l. 11434--><p class="indent" > <span class="footnote-mark"><a href="#fn2x13-bk" id="fn2x13"><sup class="textsuperscript">13.2</sup></a></span><span -class="cmr-8">See David Carlisle’sexplanation in </span><a -href="http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace" class="url" ><span -class="cmtt-8">http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace</span></a></p> -<!--l. 10976--><p class="indent" > <span class="footnote-mark"><a +class="cmr-8">See David Carlisle’s explanation in </span><a +href="http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace" ><span +class="cmr-8">Drawbacks of xspace</span></a></p> +<!--l. 11974--><p class="indent" > <span class="footnote-mark"><a href="#fn1x15-bk" id="fn1x15"><sup class="textsuperscript">15.1</sup></a></span><span class="cmr-8">These lengths will not be available if you use both the </span><span class="cmss-8">nolong</span><a - id="dx1-78019"></a> <span + id="dx1-156019"></a> <span class="cmr-8">and </span><span class="cmss-8">nosuper</span><a - id="dx1-78020"></a> <span -class="cmr-8">package options or if you</span> -<span -class="cmr-8">use the </span><span + id="dx1-156020"></a> <span +class="cmr-8">package options or if you use the </span><span class="cmss-8">nostyles</span><a - id="dx1-78021"></a> <span -class="cmr-8">package option unless you explicitly load the relevant package.</span></p> -<!--l. 11135--><p class="noindent" ><span class="footnote-mark"><a + id="dx1-156021"></a> <span +class="cmr-8">package</span> +<span +class="cmr-8">option unless you explicitly load the relevant package.</span></p> +<!--l. 12133--><p class="noindent" ><span class="footnote-mark"><a href="#fn2x15-bk" id="fn2x15"><sup class="textsuperscript">15.2</sup></a></span><span class="cmr-8">This style was supplied by Axel</span><span class="cmr-8"> Menzel.</span></p> -<!--l. 11432--><p class="indent" > <span class="footnote-mark"><a +<!--l. 12430--><p class="indent" > <span class="footnote-mark"><a href="#fn3x15-bk" id="fn3x15"><sup class="textsuperscript">15.3</sup></a></span><span class="cmr-8">e.g.</span><span class="cmr-8"> with the </span><span class="cmss-8">flowfram</span><a - id="dx1-83011"></a> <span + id="dx1-161011"></a> <span class="cmr-8">package.</span></p> -<!--l. 12770--><p class="indent" > <span class="footnote-mark"><a +<!--l. 13798--><p class="indent" > <span class="footnote-mark"><a href="#fn1x17-bk" id="fn1x17"><sup class="textsuperscript">17.1</sup></a></span><span -class="cmr-8">Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the</span> +class="cmr-8">Single letter words, such as “a” and “I” should typically not appear at the end of a line, hence the non-breakable space after</span> <span -class="cmr-8">non-breakable space after “a” in the </span><span -class="cmss-8">prefix</span><a - id="dx1-93016"></a> <span +class="cmr-8">“a” in the </span><span +class="cmtt-8">prefix</span><a + id="dx1-171016"></a> <span class="cmr-8">field.</span></p> -<!--l. 12928--><p class="indent" > <span class="footnote-mark"><a +<!--l. 13969--><p class="indent" > <span class="footnote-mark"><a href="#fn2x17-bk" id="fn2x17"><sup class="textsuperscript">17.2</sup></a></span><span -class="cmr-8">The earlier caveats about initial non-Latin characters apply.</span></p> </div> +class="cmr-8">The earlier caveats about initial non-Latin characters apply.</span></p> +<!--l. 15805--><p class="indent" > <span class="footnote-mark"><a +href="#fn1x19-bk" id="fn1x19"><sup class="textsuperscript">19.1</sup></a></span><a +href="#glo:makeindex"><span +class="cmtt-8">makeindex</span><a + id="dx1-190003"></a></a> <span +class="cmr-8">assumes that the location is a page number</span></p> +<!--l. 15984--><p class="indent" > <span class="footnote-mark"><a +href="#fn2x19-bk" id="fn2x19"><sup class="textsuperscript">19.2</sup></a></span><span +class="cmr-8">If you use </span><span +class="cmss-8">babel</span><a + id="dx1-192017"></a> <span +class="cmr-8">with a language that makes the colon character </span><span +class="cmtt-8">: </span><span +class="cmr-8">active you will need to change the prefix.</span></p> +<!--l. 16049--><p class="indent" > <span class="footnote-mark"><a +href="#fn3x19-bk" id="fn3x19"><sup class="textsuperscript">19.3</sup></a></span><span +class="cmr-8">Requires at least </span><a +href="#glo:bib2gls"><span +class="cmtt-8">bib2gls</span><a + id="dx1-192042"></a></a> <span +class="cmr-8">v2.0.</span></p> +<!--l. 18913--><p class="indent" > <span class="footnote-mark"><a +href="#fn4x19-bk" id="fn4x19"><sup class="textsuperscript">19.4</sup></a></span><span +class="cmr-8">You can either uncompress the PDF file and view it in a text editor or you can use a tool such as the PDFDebugger</span> +<span +class="cmr-8">provided with </span><a +href="https://pdfbox.apache.org/" ><span +class="cmr-8">PDFBox</span></a><span +class="cmr-8">.</span></p> </div> </body></html> - + diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf Binary files differindex 76f4e9569b3..91dcdb20a87 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex index 41dc516ee7a..a8465c911f2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex @@ -1,12 +1,13 @@ -\documentclass[report,inlinetitle,widecs]{nlctdoc} +\documentclass[report,inlinetitle,noprint,wbprompt,x11names]{nlctdoc} -\usepackage[inner=0.5in,includemp]{geometry} +\usepackage[inner=0.25in,outer=0.5in,includemp]{geometry} \usepackage{array} \usepackage{alltt} \usepackage{pifont} \usepackage{textcomp} \usepackage{amssymb} +\usepackage{accsupp} \ifpdf \usepackage{lmodern} \usepackage{mathpazo} @@ -17,10 +18,12 @@ \newcommand{\grimace}{{\fontencoding {U}\fontfamily{futs}\selectfont \char77}} \providecommand{\XeLaTeX}{XeLaTeX} \providecommand{\XeTeX}{XeTeX} + \providecommand{\LuaLaTeX}{LuaLaTeX} \fi \usepackage[colorlinks, bookmarks, linkcolor=blue, + urlcolor=Magenta4, hyperindex=false, pdfauthor={Nicola L.C. Talbot}, pdftitle={User Manual for glossaries.sty}, @@ -58,31 +61,157 @@ \end{ttfamily} } -\ifpdf -\else +\renewcommand{\nlctdocmainencap}{} + +\makeglossaries + +\renewcommand{\importantfmt}{} +\renewcommand{\importantsymbolfont}[1]{\textcolor{red}{\bfseries\Huge#1}} + +\newcommand*{\xtrfont}[1]{\textcolor{teal}{#1}} + +\newcommand*{\codecomment}[1]{\emph{\rmfamily\color{gray}#1}} + +\makeatletter +\@nlctdoc@if@usingtexht +{ % Need an extra line break in the html version % (Don't have time to fiddle with cfg files!) \renewcommand*{\glossentry}[2]{% \item[\glsentryitem{#1}\glstarget{#1}{\glossentryname{#1}}]\mbox{}\newline \glossentrydesc{#1}\glspostdescription\space #2\newline}% -\fi + \newcommand*{\htmldoc}[2]{\href{#2.html}{\qt{#1}}} + \newcommand{\glsxtrnote}{\HCode{<br/><span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em; ">}\gls{glossaries-extra}\HCode{</span>}} + \newcommand{\bibglsnote}{\HCode{<span style="float: left; font-size: small; border: solid 2px green; margin-right: 1em;">}\gls{bib2gls}\HCode{</span>}} + \newenvironment{xtr}% + {\par + \HCode{<div title="glossaries-extra.sty" style="border: solid 2pt green;">}}% + {\HCode{</div>}\par\noindent} + \newenvironment{bib2gls}% + {\par + \HCode{<div title="bib2gls" style="border: solid 2pt green;">}}% + {\HCode{</div>}\par\noindent} + + \newcommand{\commandpromptnote}{} + \newcommand{\maincommandpromptnote}{} + \newenvironment{important*}{\begin{important}\importantpar}{\end{important}} + \renewcommand{\S}{\HCode{&\#167;}} + \newcommand{\strong}[1]{\HCode{<strong>}#1\HCode{</strong>}} + \newcommand*{\linkanchor}[1]{\HCode{<a title="anchor" style="font-size: x-small; text-decoration: none;" href="\##1">&\#128279;</a>}} +} +{ + \externaldocument{glossaries-code} + \renewcommand{\idxmarker}{\textsuperscript{\xtrfont{\textdagger}}} + \newcommand*{\htmldoc}[2]{\qt{#1}} + \newcommand{\glsxtrnote}{% + \leavevmode\marginpar{\glslink{glossaries-extra}{\xtrfont{\footnotesize\styfmt{glossaries-extra.sty}}}}% + } + \newcommand{\bibglsnote}{% + \leavevmode\marginpar{{\footnotesize\glslink{bib2gls}{\xtrfont{\appfmt{bib2gls}}}}}% + } + \newenvironment{xtr}[1][\glsxtrnote]% + {% + \def\xtrmarginnote{#1}% + \setlength{\fboxrule}{4pt}% + \setlength\defwidth{\linewidth}% + \addtolength\defwidth{-2\fboxsep}% + \addtolength\defwidth{-2\fboxrule}% + \begin{lrbox}{\defsbox}% + \begin{minipage}[t]{\defwidth}% + \setlength\parindent{1em}% + \noindent\ignorespaces + }% + {% + \end{minipage}% + \end{lrbox}% + \par\vskip10pt\noindent + \xtrmarginnote + \fcolorbox{teal}{white}{\usebox{\defsbox}}\par\vskip10pt + \noindent\ignorespacesafterend + } + \newenvironment{bib2gls}{\begin{xtr}[\bibglsnote]}{\end{xtr}} + \newcommand{\commandpromptnote}{The \texttt{\bfseries\$} symbol in the instructions + indicates the command prompt. It should be omitted when copying the text. } + \newcommand{\maincommandpromptnote}{The command prompt is indicated with + \texttt{\bfseries\$} in this documentation. Don't type that character when + copying examples. } + + \def\verbatim@font{\MacroFont} + + \newenvironment{important*}% + {% + \renewcommand{\importantsymbolfont}[1]{\textcolor{red}{\bfseries\huge##1}}% + \begin{important}\importantpar[-2][-1ex]% + }% + {\end{important}} + \newcommand{\strong}{\textbf} + \newcommand{\linkanchor}[1]{} +} +\renewcommand*{\@isty}[1]{\index{#1 package=\styfmt{#1} + package|hyperpage}} +\renewcommand*{\s@isty}[1]{\index{#1 package=\doidxmarker\styfmt{#1} + package|hyperpage}} +\renewcommand*{\@icls}[1]{\index{#1 class=\clsfmt{#1} + class|hyperpage}} +\renewcommand*{\s@icls}[1]{\index{#1 class=\doidxmarker\clsfmt{#1} + class|hyperpage}} -\makeglossaries +\renewrobustcmd*{\iterm}[1]{\index{#1|hyperpage}} +\makeatother \renewcommand*{\main}[1]{\hyperpage{#1}} \newcommand*{\htextbf}[1]{\textbf{\hyperpage{#1}}} \newcommand*{\itermdef}[1]{\index{#1|htextbf}} \newcommand{\itempar}[1]{\item[{#1}]\mbox{}\par} +\newcommand{\Index}[1]{#1\index{#1|hyperpage}} + +\newcommand{\xtrpkgoptdef}[1]{\hypertarget{pkgopt:#1}{\pkgopt*{#1}}} \newcommand{\pkgoptdef}[1]{\hypertarget{pkgopt:#1}{\pkgopt{#1}}} +\newcommand{\deppkgoptdef}[1]{\hypertarget{pkgopt:#1}{\deprecatedpkgopt{#1}}} + +\newcommand{\pkgoptsec}[2][]{% + \pdfbookmark[2]{#2}{pkgopt.#2} + \ifstrempty{#1}% + {\subsection*{\protect\pkgoptdef{#2}}}% + {\subsection*{\protect\pkgoptdef{#2}\pkgoptfmt{=\protect\marg{#1}}}}% +} + +\newcommand{\deppkgoptsec}[2][]{% + \pdfbookmark[2]{#2}{pkgopt.#2} + \ifstrempty{#1}% + {\subsection*{\protect\deppkgoptdef{#2}}}% + {\subsection*{\protect\deppkgoptdef{#2}\pkgoptfmt{=\marg{#1}}}}% +} + +\newcommand{\xtrpkgoptsec}[2][]{% + \pdfbookmark[2]{#2 (glossaries-extra.sty)}{pkgopt.#2} + \ifstrempty{#1}% + {\subsection*{\protect\xtrfont{\protect\xtrpkgoptdef{#2} (glossaries-extra.sty)}}}% + {\subsection*{\protect\xtrfont{\protect\xtrpkgoptdef{#2}\pkgoptfmt{=\protect\marg{#1}} + (glossaries-extra.sty)}}}% +} \newcommand{\glslike}{\hyperref[sec:gls-like]{\cs{gls}-like}} \newcommand{\glstextlike}{\hyperref[sec:glstext-like]{\cs{glstext}-like}} +\newcommand{\gallery}[2]{\href{https://www.dickimaw-books.com/gallery/#1}{#2}} +\newcommand{\galleryurl}[1]{\gallery{#1}{\nolinkurl{https://www.dickimaw-books.com/gallery/#1}}} +\newcommand{\gallerytopic}[1]{\galleryurl{\##1}} + +\newcommand*{\bibglsgallery}[2][\gallerytitle]{% + \def\gallerytitle{#2}% + \gallery{index.php?label=bib2gls-#2}{\appfmt{bib2gls} gallery: \gallerytitle}} + +\newcommand*{\bibglsbegin}{% + \href{http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf}{\styfmt{glossaries-extra} and \appfmt{bib2gls}: An Introductory Guide}} + \IndexPrologue{\chapter*{\indexname} \addcontentsline{toc}{chapter}{\indexname}% - \markboth{\indexname}{\indexname}} + \markboth{\indexname}{\indexname} + \par\idxmarker Requires \gls{glossaries-extra}. +} \longnewglossaryentry{indexingapp}% { @@ -110,7 +239,7 @@ interface. That is, an application that doesn't have any windows, buttons or menus and can be run in \href{http://www.dickimaw-books.com/latex/novices/html/terminal.html}{a command - prompt or terminal}. + prompt or terminal}. \maincommandpromptnote } \longnewglossaryentry{xindy}{% @@ -120,27 +249,44 @@ }% {% A flexible \gls{indexingapp} with multilingual - support written in Perl. + support written in Perl. See \opt3. } \newglossaryentry{makeindex}{% name={\appfmt{makeindex}\index{makeindex=\appfmt{makeindex}|htextbf}},% sort={makeindex},% text={\appfmt{makeindex}\iapp{makeindex}},% -description={An \gls{indexingapp}.} +description={An \gls{indexingapp}. See \opt2.} } \newglossaryentry{bib2gls}{% -name={\appfmt{bib2gls}\index{bib2gls=\appfmt{bib2gls}|htextbf}},% +name={\appfmt{bib2gls}\index{bib2gls=\doidxmarker\appfmt{bib2gls}|htextbf}},% sort={bib2gls},% -text={\appfmt{bib2gls}\iapp{bib2gls}},% +text={\appfmt{bib2gls}\iapp*{bib2gls}},% description={An \gls{indexingapp} that combines two functions in -one: (1) fetches entry definition from a \texttt{.bib} file -based on information provided in the \texttt{.aux} file (similar +one: (1) fetches entry definition from a \filetype{bib} file +based on information provided in the \filetype{aux} file (similar to \appfmt{bibtex}); (2) hierarchically sorts and collates location -lists (similar to \appfmt{makeindex} and \appfmt{xindy}). -This application is designed for use with \styfmt{glossaries-extra} -and can't be used with just the base \styfmt{glossaries} package.} +lists (similar to \gls{makeindex} and \gls{xindy}). +This application is designed for use with \gls{glossaries-extra} +and can't be used with just the base \styfmt{glossaries} package. +See \opt4.} +} + +\newglossaryentry{convertgls2bib}{% +name={\appfmt{convertgls2bib}\index{convertgls2bib=\doidxmarker\appfmt{convertgls2bib}|htextbf}},% +sort={convertgls2bib},% +text={\appfmt{convertgls2bib}\iapp*{convertgls2bib}},% +description={An application provided with \gls{bib2gls} that +converts \filetype{tex} files containing entry definitions to +\filetype{bib} files suitable for use with \gls{bib2gls}. +This application is designed for files that just contain entry +definitions, but it can work on a complete document file. +However, there will be a lot of \qt{undefined command} warnings as +\gls{convertgls2bib} only has a limited set of known commands. You +can limit it so that it only parses the preamble with the +\texttt{-{}-preamble-only} switch (requires at least \gls{bib2gls} +v2.0).} } \newglossaryentry{makeglossaries}{% @@ -162,7 +308,7 @@ text={\appfmt{makeglossaries-lite}\iapp{makeglossaries-lite}},% description={A custom designed Lua script interface to \gls{xindy} and \gls{makeindex} provided with the \styfmt{glossaries} package. This is a cut-down alternative to the Perl -\appfmt{makeglossaries} script. If you have Perl installed, use the +\gls{makeglossaries} script. If you have Perl installed, use the Perl script instead. This script is actually distributed with the file name \texttt{makeglossaries-lite.lua}, but \TeX~Live (on Unix-like systems) creates a symbolic link @@ -215,6 +361,26 @@ description={The text produced by commands such as \ics{gls}. It may or may not be a hyperlink to the glossary.} } +\newglossaryentry{smallcaps}{% + name={Small caps\itermdef{small caps}}, + sort={small caps}, + text={small caps\iterm{small caps}}, + description={Small capitals. The \LaTeX\ kernel provides + \ics{textsc}\marg{text} to produce small capitals. This uses a + font where lowercase letters have a small capital design. + Uppercase letters have the standard height and there's no + noticeable difference with uppercase characters in corresponding non-small caps fonts. + This means that for a small caps appearance, you need to use lowercase letters in the + \meta{text} argument. The \isty{relsize} package provides + \ics{textsmaller}\marg{text} which simulates small caps by reducing the size + of the font, so in this case the contents of \meta{text} should be + uppercase (otherwise the effect is simply smaller lowercase + letters). Some fonts don't support small caps combined with bold or slanted + properties. In this case, there will be a font substitution + warning and one of the properties (such as small caps or slanted) will be + dropped.} +} + \let\glsd\glsuseri \let\glsation\glsuserii @@ -288,7 +454,7 @@ user2={sanitization\protect\iterm{sanitize}}% sort={extended Latin character}, description={A character that's created by combining \glspl{latinchar} to form ligatures (e.g.\ \ae) or by applying diacritical marks - to a~\gls*{latinchar} or characters (e.g.\ \'a or \o). + to a~\gls*{latinchar} or characters (e.g.\ \'a). See also \gls{nonlatinchar}.} } @@ -345,9 +511,6 @@ user2={sanitization\protect\iterm{sanitize}}% \styfmt{glossaries-extra} package installed.} } -\ifpdf -\externaldocument{glossaries-code} -\fi \doxitem{Option}{option}{package options} \doxitem{GlsKey}{key}{glossary keys} @@ -372,17 +535,18 @@ user2={sanitization\protect\iterm{sanitize}}% \newcommand*{\fnsym}[1]{\textsuperscript{\fnsymmark{% \ifcase#1\or \textasteriskcentered \or \textdagger \or \textdaggerdbl \or \textsection - \or $\lozenge$ \or \textparagraph + \or $\lozenge$\or \textparagraph \or \#\or {\fontfamily{cmr}\selectfont\textreferencemark}% \or \@nlctdoc@if@usingtexht{\HCode{&\#x2051;}}{\shortstack{*\\[-1.5ex]*}}% - \or $\star$ + \or $\star$% \or \ding{94}% \else \number#1 \fi }}}% -\newcommand*{\optionlabel}[1]{% - \@glstarget{option#1}{Option~#1}} +\newrobustcmd*{\optionlabel}[1]{\@glstarget{option#1}{Option~#1}} + +\newcommand*{\plabel}[2][]{\linkanchor{#2}\protected@edef\@currentlabelname{#1}\label{#2}} \makeatother \newcounter{option} @@ -390,7 +554,7 @@ user2={sanitization\protect\iterm{sanitize}}% \def\opttitle{\appfmt{#2}}% \refstepcounter{option}% \pdfbookmark[2]{Option~\theoption\space (#2)}{option\theoption}% - \subsection*{\protect\optionlabel{\theoption} (#1)}% + \subsection*{\linkanchor{option\theoption}\optionlabel{\theoption} (#1)}% } \newcommand*{\opt}[1]{\hyperlink{option#1}{Option~#1}} @@ -398,7 +562,9 @@ user2={sanitization\protect\iterm{sanitize}}% or~\hyperlink{option#2}{#2}} \newcommand*{\optsand}[2]{Options~\hyperlink{option#1}{#1} and~\hyperlink{option#2}{#2}} +\newcommand*{\optsto}[2]{Options~\hyperlink{option#1}{#1}--\hyperlink{option#2}{#2}} +\renewcommand*{\idxmarkedfont}{\xtrfont} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\ifirstuseflag}{\iterm{first use>flag}} @@ -419,42 +585,97 @@ and~\hyperlink{option#2}{#2}} \newcommand*{\mkglsopt}[1]{\texttt{-#1}\index{makeglossaries=\appfmt{makeglossaries}>#1=\texttt{-#1}|hyperpage}} +\newcommand*{\bibglsopt}[1]{\xtrfont{\texttt{-{}#1}}\index{bib2gls=\doidxmarker\appfmt{bib2gls}>#1=\texttt{-{}#1}|hyperpage}} +\newcommand*{\bibglslongopt}[1]{\bibglsopt{-#1}} + +\renewcommand{\csoptfmt}{\texttt} + \newcommand*{\igloskey}[2][newglossaryentry]{\icsopt{#1}{#2}} \newcommand*{\gloskey}[2][newglossaryentry]{\csopt{#1}{#2}} -\newcommand*{\optfmt}[1]{\textsf{#1}} -\newcommand*{\field}[1]{\optfmt{#1}\index{internal fields:>#1=\protect\optfmt{#1}|main}} + +\newcommand*{\ixtrgloskey}[2][newglossaryentry]{\icsopt*{#1}{#2}} +\newcommand*{\xtrgloskey}[2][newglossaryentry]{\xtrfont{\csopt*{#1}{#2}}} + +\newcommand*{\printglosskey}[2][]{\icsopt{printglossary}{#2}% + \ifstrempty{#1}{\csoptfmt{#2}}{\csoptfmt{#2=#1}}% +} + +\newcommand*{\printnoidxglosskey}[2][]{\icsopt{printnoidxglossary}{#2}% + \ifstrempty{#1}{\csoptfmt{#2}}{\csoptfmt{#2=#1}}% +} + +\newcommand*{\xtrprintglosskey}[2][]{\icsopt*{printglossary}{#2}% + \xtrfont{\ifstrempty{#1}{\csoptfmt{#2}}{\csoptfmt{#2=#1}}}% +} + +\newcommand*{\iresourceopt}[1]{\icsopt+{GlsXtrLoadResources}{#1}} +\newcommand*{\resourceopt}[2][]{% + \xtrfont{\csoptfmt{#2}}\ifstrempty{#1}{}{\csoptfmt{\dequals#1}}% + \icsopt+{GlsXtrLoadResources}{#2}% +} + +\newcommand*{\atentry}[1]{\xtrfont{\texttt{@#1}}% + \index{bib2gls entry types=\doidxmarker\appfmt{bib2gls} entry types>#1=\texttt{@#1}|hyperpage}} + +\newcommand*{\xtrcs}[1]{\xtrfont{\cs{#1}}} + +\newcommand*{\field}[1]{\csoptfmt{#1}\index{internal fields:>#1=\protect\csoptfmt{#1}|main}} +\newcommand*{\xtrfield}[1]{\xtrfont{\csoptfmt{#1}}\index{internal fields:>#1=\doidxmarker\protect\csoptfmt{#1}|main}} \newcommand*{\glostyle}[1]{\textsf{#1}\index{glossary styles:>#1={\protect\ttfamily#1}|main}} +\newcommand*{\xtrglostyle}[1]{\xtrfont{\textsf{#1}}\index{glossary styles:>#1=\doidxmarker{\protect\ttfamily#1}|main}} + \newcommand*{\acrstyle}[1]{\textsf{#1}\index{acronym styles:>#1={\protect\ttfamily#1}|main}} +\newcommand*{\abbrstyle}[1]{\xtrfont{\textsf{#1}}\index{abbreviation styles:=\doidxmarker abbreviation styles:>#1={\protect\ttfamily#1}|main}} +\newcommand*{\cat}[1]{\xtrfont{\textsf{#1}}\index{categories=\doidxmarker categories>#1={\protect\ttfamily#1}|main}} + +\makeatletter +\@nlctdoc@if@usingtexht +{ + \newcommand*{\icatattrs}[1][]{\index{category attributes=\doidxmarker category attributes#1|main}} + \newcommand*{\ixindyattrs}[1][]{\index{xindy attributes=xindy attributes#1|main}} + \index{attributes|see{category attributes or xindy attributes}} +} +{ +\newcommand{\icatattrs}[1][]{\index{category attributes=\protect\doidxmarker\protect\glsdohypertarget{catattr}{category attributes}:#1|main}} + +\newcommand*{\ixindyattrs}[1][]{\index{xindy attributes=\protect\glsdohypertarget{xindyattr}{xindy attributes}#1|main}} + +\index{attributes|see{\protect\hyperlink{catattr}{category attributes} (\styfmt{glossaries-extra}) or \protect\hyperlink{xindyattr}{xindy attributes}\protect\hfill}} +} + +\makeatletter + +\newcommand*{\optfmt}[1]{\textsf{#1}} +\newcommand*{\attr}[1]{\xtrfont{\optfmt{#1}}\icatattrs[>#1=\optfmt{#1}]{}} +\newcommand*{\xindyattr}[1]{\texttt{#1}\ixindyattrs[>#1=\texttt{#1}]{}} + +\newrobustcmd{\mirrorsamplefile}[1]{% + \href{http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples/#1}{\nolinkurl{#1}}% +} \newcounter{sample} \newcommand{\exitem}[2][sample]{% - \item[\texttt{#1#2.tex}]% - \refstepcounter{sample}\label{ex:#1#2}} - -\newenvironment{samplelist}% -{\begin{description}}% -{\end{description}} + \par + \pdfbookmark[2]{#1#2.tex}{exfile.#1#2}% + \refstepcounter{sample}% + \subsection*{\plabel[#1#2.tex]{ex:#1#2}\mirrorsamplefile{#1#2.tex}}% +} \newcommand*{\samplefile}[2][sample]{% \hyperref[ex:#1#2]{\texttt{#1#2.tex}}} -\ifpdf - \newcommand*{\htmldoc}[2]{\qt{#1}} -\else - \newcommand*{\htmldoc}[2]{\href{#2.html}{\qt{#1}}} -\fi \begin{document} \MakeShortVerb{"} \DeleteShortVerb{\|} - \title{User Manual for glossaries.sty v4.44} + \title{User Manual for glossaries.sty v4.45} \author{Nicola L.C. Talbot\\% - \url{http://www.dickimaw-books.com/}} + \href{http://www.dickimaw-books.com/contact}{\nolinkurl{dickimaw-books.com/contact}}} - \date{2019-12-06} + \date{2020-02-13} \maketitle \begin{abstract} @@ -462,16 +683,19 @@ The \styfmt{glossaries} package provides a means to define terms or abbreviations or symbols that can be referenced within your document. Sorted lists with collated \glslink{entrylocation}{locations} can be generated either using \TeX\ or using a supplementary \gls{indexingapp}. +Sample documents are provided with the \styfmt{glossaries} package. +These are listed in \sectionref{sec:samples}. +\end{abstract} +\begin{xtr} Additional features not provided here may be available through the extension package \gls{glossaries-extra} which, if required, needs to be installed separately. New features will be added to \gls*{glossaries-extra}. Versions of the \styfmt{glossaries} -package after v4.21 will mostly be just bug fixes. Note that -\gls{glossaries-extra} provides an extra indexing option -(\gls{bib2gls}) which isn't available with just the base -\sty{glossaries} package. -\end{abstract} +package after v4.21 will mostly be just bug fixes or minor +maintenance. Note that \gls{glossaries-extra} provides an extra indexing option +(\gls{bib2gls}) which isn't available with just the base \styfmt{glossaries} package. +\end{xtr} If you require multilingual support you must also separately install the relevant language module. Each language module is distributed @@ -545,35 +769,32 @@ package. \item[\url{glossaries-code.pdf}] Advanced users wishing to know more about the inner workings of all the packages provided in the \styfmt{glossaries} bundle should read -\qt{Documented Code for glossaries v4.44}. +\qt{Documented Code for glossaries v4.45}. \item[INSTALL] Installation instructions. \item[CHANGES] Change log. -\item[README] Package summary. +\item[README.md] Package summary. \end{description} Related resources: \begin{itemize} -\item \styfmt{glossaries-extra} and \gls{bib2gls}: An Introductory -Guide. (\href{http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf}{\texttt{bib2gls-begin.pdf}}). - +\item \bibglsbegin. \item \href{http://www.dickimaw-books.com/faqs/glossariesfaq.html}{\styfmt{glossaries} FAQ} -\item \href{http://www.dickimaw-books.com/gallery/#glossaries}{\styfmt{glossaries} -gallery} +\item \gallerytopic{glossaries}{\styfmt{glossaries} gallery} \item -\href{http://www.dickimaw-books.com/gallery/glossaries-styles/}{a -summary of all glossary styles provided by \styfmt{glossaries}} +\gallery{glossaries-styles/}{a summary of all glossary styles provided by \styfmt{glossaries} and +\gls*{glossaries-extra}} \item -\href{http://www.dickimaw-books.com/gallery/glossaries-performance.shtml}{\styfmt{glossaries} +\gallery{glossaries-performance.shtml}{\styfmt{glossaries} performance} (comparing document build times for the different -options provided by \styfmt{glossaries} and \styfmt{glossaries-extra}). +options provided by \styfmt{glossaries} and \gls{glossaries-extra}). \item \href{http://www.dickimaw-books.com/latex/thesis/}{Using LaTeX to Write a PhD Thesis} (chapter 6). @@ -587,12 +808,13 @@ options provided by \styfmt{glossaries} and \styfmt{glossaries-extra}). \item \href{http://ctan.org/pkg/bib2gls}{\appfmt{bib2gls}} \end{itemize} -\begin{important} +\begin{important*} If you use \sty{hyperref} and \styfmt{glossaries}, you must load -\sty{hyperref} \emph{first}. Similarly the \sty{doc} package must +\sty{hyperref} \emph{first} (although \sty{hyperref} should be +loaded after most other packages). Similarly the \sty{doc} package must also be loaded before \styfmt{glossaries}. (If \sty{doc} is loaded, the file extensions for the default main glossary are changed to -\filetype{gls2}, \filetype{glo2} and \filetype{.glg2} to avoid +\filetype{gls2}, \filetype{glo2} and \filetype{glg2} to avoid conflict with \sty{doc}'s changes glossary.)\hypertarget{pdflatexnote}{}% @@ -603,10 +825,15 @@ encounter problems where you have long hyperlinks or hyperlinks in subscripts or superscripts. This is an issue with the DVI format not with \styfmt{glossaries}. If you really need to use the DVI format and have a problem with hyperlinks in maths mode, I recommend you use -\gls{glossaries-extra} with the \texttt{hyperoutside} and -\texttt{textformat} attributes set to appropriate values +\gls{glossaries-extra} with the \attr{hyperoutside} and +\attr{textformat} attributes set to appropriate values for problematic entries. -\end{important} +\end{important*} + +\strong{The \styfmt{glossaries} package replaces the \styfmt{glossary} +package which is now obsolete.} Please see the document +\qtdocref{Upgrading from the glossary package to the glossaries +package}{glossary2glossaries} for assistance in upgrading. \clearpage \pdfbookmark[0]{Contents}{contents} @@ -628,64 +855,154 @@ for problematic entries. The \styfmt{glossaries} package is provided to assist generating lists of terms, symbols or abbreviations. (For convenience, these -lists are all referred to as glossaries in this manual.) +lists are all referred to as glossaries in this manual. The terms, +symbols and abbreviations are collectively referred to as entries.) The package has a certain amount of flexibility, allowing the user to customize the format of the glossary and define multiple glossaries. It also supports glossary styles that -include symbols (in addition to a name and description) for glossary -entries. There is provision for loading a database of glossary -terms. Only those terms indexed\footnote{That is, if the term has been +include an associated symbol (in addition to a name and description) +for each glossary entry. + +There is provision for loading a database of glossary entries. Only +those entries indexed\footnote{That is, if the entry has been referenced using any of the commands described in \sectionref{sec:glslink} and \sectionref{sec:glsadd} or via \ics{glssee} (or the \gloskey{see} key) or commands such as -\ics{acrshort}.}\ in the document will be added to the glossary. +\ics{acrshort} or \ics*{glsxtrshort}.}\ in the document will be displayed in the glossary. +(Unless you use \opt5, which doesn't use any indexing but will +instead list all defined entries in order of definition.) -The \styfmt{glossaries-extra} package, which is distributed as a -separated bundle, extends the capabilities of -the \styfmt{glossaries} package. The simplest document can be -created with \styfmt{glossaries-extra} (which internally loads the -\styfmt{glossaries} package): +It's not necessary to actually have a glossary in the document. You may be +interested in using this package just as means to consistently +format certain types of terms, such as abbreviations, or you may +prefer to have descriptions scattered about the document and be able +to easily link to the relevant description (\opt6). + +The simplest document is one without a glossary: \begin{verbatim} \documentclass{article} - \usepackage[ - sort=none,% no sorting or indexing required - abbreviations,% create list of abbreviations - symbols,% create list of symbols - postdot % append a full stop after the descriptions -]{glossaries-extra} + sort=none % no sorting or indexing required +] +{glossaries} -\newglossaryentry % provided by glossaries.sty +\newglossaryentry {cafe}% label {% definition: name={caf\'e}, description={small restaurant selling refreshments} } -\newabbreviation % provided by glossaries-extra.sty +\setacronymstyle{long-short} + +\newacronym {html}% label {HTML}% short form {hypertext markup language}% long form -\glsxtrnewsymbol % provided by glossaries-extra.sty 'symbols' option - [description={Archimedes' constant}]% options +\newglossaryentry {pi}% label - {\ensuremath{\pi}}% symbol + {% definition: + name={\ensuremath{\pi}}, + description={Archimedes' Constant} + } + +\newglossaryentry + {distance}% label + {% definition: + name={distance}, + description={the length between two points}, + symbol={m} + } \begin{document} First use: \gls{cafe}, \gls{html}, \gls{pi}. Next use: \gls{cafe}, \gls{html}, \gls{pi}. -\printunsrtglossaries % list all defined entries +\Gls{distance} (\glsentrydesc{distance}) is measured in +\glssymbol{distance}. \end{document} \end{verbatim} +(This is a trivial example. For a real document I recommend you use +\sty{siunitx} for units.) -\textbf{The \styfmt{glossaries} package replaces the \sty{glossary} -package which is now obsolete.} Please see the document -\qtdocref{Upgrading from the glossary package to the glossaries -package}{glossary2glossaries} for assistance in upgrading. +\glsxtrnote +The \gls{glossaries-extra} package, which is distributed as a +separate bundle, extends the capabilities of +the \styfmt{glossaries} package. The simplest document with a glossary can be +created with \gls{glossaries-extra} (which internally loads the +\styfmt{glossaries} package): +\begin{verbatim} +\documentclass{article} +\end{verbatim} +\begin{alltt} +\cs{usepackage}[ + sort=none,% no sorting or indexing required + \xtrfont{abbreviations},% create list of abbreviations + symbols,% create list of symbols + \xtrfont{postdot}, % append a full stop after the descriptions + \xtrfont{stylemods},style=index % set the default glossary style +]\mgroup{glossaries-extra} +\end{alltt} +\begin{verbatim} +\newglossaryentry % provided by glossaries.sty + {cafe}% label + {% definition: + name={caf\'e}, + description={small restaurant selling refreshments} + } +\end{verbatim} +\begin{alltt} +\% provided by glossaries-extra.sty: +\ics*{setabbreviationstyle}\mgroup{long-short} + +\ics*{newabbreviation} \% provided by glossaries-extra.sty + \mgroup{html}\% label + \mgroup{HTML}\% short form + \mgroup{hypertext markup language}\% long form + +\% provided by glossaries-extra.sty 'symbols' option: +\ics*{glsxtrnewsymbol} + [description=\mgroup{Archimedes' constant}]\% options + \mgroup{pi}\% label + \mgroup{\cs{ensuremath}\mgroup{\cs{pi}}}\% symbol +\end{alltt} +\begin{verbatim} +\newglossaryentry % provided by glossaries.sty + {distance}% label + {% definition: + name={distance}, + description={the length between two points}, + symbol={m} + } -One of the strengths of this package is its flexibility, however +\begin{document} +First use: \gls{cafe}, \gls{html}, \gls{pi}. +Next use: \gls{cafe}, \gls{html}, \gls{pi}. + +\Gls{distance} is measured in \glssymbol{distance}. +\end{verbatim} +\begin{alltt} +\ics*{printunsrtglossaries} \% list all defined entries +\cs{end}\mgroup{document} +\end{alltt} +Note the difference in the way the abbreviation (HTML) and symbol +(\ensuremath{\pi}) are defined in the two above examples. The +\pkgopt*{abbreviations}, \pkgopt*{postdot} and \pkgopt*{stylemods} +options are specific to \gls{glossaries-extra}. Other options are +passed to the base \styfmt{glossaries} package. + +\begin{xtr} +In this document, commands and options displayed in teal, such as +\xtrcs{newabbreviation} and \pkgopt*{stylemods}, are only available with +the \gls{glossaries-extra} package. There are also some commands and options (such +as \cs{makeglossaries} and \pkgopt{symbols}) that are provided by the +base \styfmt{glossaries} package but are redefined by the +\gls{glossaries-extra} package. See the \gls{glossaries-extra} user +manual for further details of those commands. +\end{xtr} + +One of the strengths of the \styfmt{glossaries} package is its flexibility, however the drawback of this is the necessity of having a large manual that covers all the various settings. If you are daunted by the size of the manual, try starting off with the much shorter @@ -694,8 +1011,9 @@ size of the manual, try starting off with the much shorter \begin{important} There's a~common misconception that you have to have Perl installed in order to use the \styfmt{glossaries} package. Perl is \emph{not} -a~requirement but it does increase the available options, -particularly if you use an \gls{exlatinalph} or a~\gls{nonlatinalph}. +a~requirement (as demonstrated by the above examples) but it does +increase the available options, particularly if you use an \gls{exlatinalph} +or a~\gls{nonlatinalph}. \end{important} This document uses the \styfmt{glossaries} package. For example, @@ -710,6 +1028,11 @@ which means they can be run directly from a command prompt or terminal, or can be integrated into some text editors, or you can use a build tool such as \app{arara} to run them. +Neither of the above two examples require an \gls{indexingapp}. The +first is just using the \styfmt{glossaries} package for consistent +formatting, and there is no list. The second has lists but they are +unsorted (see \opt5). + The remainder of this introductory section covers the following: \begin{itemize} \item \sectionref{sec:indexingoptions} lists the available indexing @@ -740,11 +1063,17 @@ you can reference these within your document (like \cs{cite} or you have referenced in your document (the glossary). This last part, displaying the glossary, is the part that most new users find difficult. There are three options available with the base -\styfmt{glossaries} package and two further options with the -extension package \gls{glossaries-extra}. -An overview of these options is given in -\tableref{tab:options}. +\styfmt{glossaries} package (\optsto13). The \gls{glossaries-extra} extension +package provides two extra options for lists (\optsand45) as well as an option for +standalone descriptions within the document body (\opt6). + +An overview of \optsto15 is given in \tableref{tab:options}. +\opt6 is omitted from the table as it doesn't produce a list. For a +more detailed comparison of the various methods, see the +\gallery{glossaries-performance.shtml}{\styfmt{glossaries} +performance page}. +\begin{important} If you are developing a class or package that loads \styfmt{glossaries}, I recommend that you don't force the user into a particular indexing method by adding an unconditional \cs{makeglossaries} @@ -753,10 +1082,14 @@ particular indexing method, it means that they're unable to use any commands that must come before \cs{makeglossaries} (such as \cs{newglossary}) and they can't switch off the indexing whilst working on a draft document. +\end{important} -For a comparison of the various methods when used with large entry -sets or when used with symbols such as \cs{alpha}, see the -\href{http://www.dickimaw-books.com/gallery/glossaries-performance.shtml}{\styfmt{glossaries} performance page}. +Strictly speaking, \optsand56 aren't actually indexing options as no +indexing is performed. In the case of \opt5, all defined entries are +listed in order of definition. In the case of \opt6, the entry +hypertargets and descriptions are manually inserted at appropriate +points in the document. These two options are included here for +completeness and for comparison with the actual indexing options. \begin{table}[htbp] \caption{Glossary Options: Pros and Cons} @@ -819,27 +1152,49 @@ sets or when used with symbols such as \cs{alpha}, see the \fnsym{1} Strips standard \LaTeX\ accents (that is, accents generated by core \LaTeX\ commands) so, for example, \ics{AA} is treated the same as A.\par - \fnsym{2} Only with the hybrid method provided with \sty{glossaries-extra}.\par + \fnsym{2} Only with the hybrid method provided with \gls{glossaries-extra}.\par \fnsym{3} Provided \pkgopt[none]{sort} is used.\par \fnsym{4} Entries with the same sort value are merged.\par \fnsym{5} Requires some setting up.\par \fnsym{6} The locations must be set explicitly -through the custom \field{location} field provided by +through the custom \xtrfield{location} field provided by \styfmt{glossaries-extra}.\par \fnsym{7} Unlimited but unreliable.\par - \fnsym{8} Entries are defined in \texttt{.bib} + \fnsym{8} Entries are defined in \filetype{bib} format. \cs{newglossaryentry} should not be used explicitly.\par - \fnsym{9} Provided \pkgoptfmt{docdefs=true} or -\pkgoptfmt{docdefs=restricted} but not recommended.\par - \fnsym{10} Provided \pkgoptfmt{docdefs=false} or -\pkgoptfmt{docdefs=restricted}.\par - \fnsym{11} Irrelevant with \pkgopt[none]{sort}. (The \optfmt{record=only} + \fnsym{9} Provided \pkgopt+{true}{docdef} or + \pkgopt+{restricted}{docdef} but not recommended.\par + \fnsym{10} Provided \pkgopt+{false}{docdef} or + \pkgopt+{restricted}{docdef}.\par + \fnsym{11} Irrelevant with \pkgopt[none]{sort}. (The \pkgopt+{only}{record} option automatically switches this on.) \par \end{table} \optionsec[\TeX]{TeX} +Example Document: +\begin{verbatim} +\documentclass{article} +\usepackage{glossaries} +\end{verbatim} +\begin{alltt} +\strong{\ics{makenoidxglossaries}} \% use TeX to sort +\end{alltt} +\begin{verbatim} +\newglossaryentry{sample}{name={sample}, + description={an example}} +\begin{document} +\gls{sample}. +\end{verbatim} +\begin{alltt} +\strong{\ics{printnoidxglossary}} +\cs{end}\mgroup{document} +\end{alltt} +You can place all your entry definitions in a separate file +and load it in the preamble with \ics{loadglsentries} (\emph{after} +\ics{makenoidxglossaries}). + This option doesn't require an external \gls{indexingapp} but, with the default alphabetic sorting, it's very slow with severe limitations. If you want a sorted list, it doesn't work well for @@ -856,15 +1211,20 @@ such as \cs{alpha} or \cs{si}, then you must use (\pkgopt[use]{sort} or \pkgopt[def]{sort}) in the package options or explicitly set the \gloskey{sort} key when you define the relevant entries. For example: -\begin{verbatim} -\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, - sort={alpha},description={...}} -\end{verbatim} +\begin{alltt} +\ics{newglossaryentry}\mgroup{alpha}\mgroup{name=\mgroup{\cs{ensuremath}\mgroup{\cs{alpha}}}, + \strong{sort=\mgroup{alpha}},description=\mgroup{...}} +\end{alltt} +\begin{xtr} +The \gls{glossaries-extra} package has a modified \pkgopt{symbols} +package option that provides \ics*{glsxtrnewsymbol}, which automatically sets the +\gloskey{sort} key to the entry label (instead of the \gloskey{name}). +\end{xtr} This option works best with the \pkgopt[def]{sort} or \pkgopt[use]{sort} setting. For any other setting, be prepared for a long document build time, -especially if you have a lot of entries defined. \textbf{This +especially if you have a lot of entries defined. \strong{This option is intended as a last resort for alphabetical sorting.} This option allows a mixture of sort methods. (For example, sorting by word order for one glossary and order of use for another.) @@ -896,20 +1256,29 @@ not form ranges in the \glspl{numberlist}. If you really can't use an the \qt{typeset} or \qt{build} or \qt{PDF\LaTeX} button in your editor. \end{enumerate} -Complete example: +\optionsec{makeindex} + +Example document: \begin{verbatim} \documentclass{article} \usepackage{glossaries} -\makenoidxglossaries % use TeX to sort -\newglossaryentry{sample}{name={sample}, - description={an example}} +\end{verbatim} +\begin{alltt} +\strong{\ics{makeglossaries}} \% open glossary files +\end{alltt} +\begin{verbatim} +\newglossaryentry{sample}{name={sample}, + description={an example}} \begin{document} \gls{sample}. -\printnoidxglossary -\end{document} \end{verbatim} - -\optionsec{makeindex} +\begin{alltt} +\strong{\ics{printglossary}} +\cs{end}\mgroup{document} +\end{alltt} +You can place all your entry definitions in a separate file +and load it in the preamble with \ics{loadglsentries} (\emph{after} +\ics{makeglossaries}). This option uses a~\gls{cli} application called \gls{makeindex} to sort the entries. This application comes with all modern \TeX\ distributions, @@ -924,12 +1293,11 @@ to typeset the glossary. Then \cs{printglossary} reads this file in on the next run. This option works best if you want to sort entries according to the -English alphabet and you don't want to install Perl (or Java or -you don't want to use \gls{glossaries-extra}). This method can -also work with the restricted shell escape since \gls{makeindex} -is considered a trusted application. (So you should be able to -use the \pkgopt{automake} package option provided the shell -escape hasn't been completely disabled.) +English alphabet and you don't want to install Perl or Java. This +method can also work with the restricted shell escape since +\gls{makeindex} is considered a trusted application. (So you should +be able to use the \pkgopt{automake} package option provided the +shell escape hasn't been completely disabled.) This method can form ranges in the \gls{numberlist} but only accepts limited number formats: \cs{arabic}, \cs{roman}, @@ -941,10 +1309,15 @@ word\slash letter ordering or order of use or order of definition. If you need word ordering for one glossary and letter ordering for another you'll have to explicitly call \gls{makeindex} for each glossary type. -(The \sty{glossaries-extra} package allows a hybrid mix of + +\begin{xtr} +The \gls{glossaries-extra} package allows a hybrid mix of \optsand12 to provide word\slash letter ordering with \opt2 and order -of use\slash definition with \opt1. See the \sty{glossaries-extra} -documentation for further details.) +of use\slash definition with \opt1. See the \gls{glossaries-extra} +documentation for further details. See also the +\gls{glossaries-extra} alternative to \samplefile{Sort} in +\sectionref{sec:samplessort}. +\end{xtr} \begin{enumerate} \item If you want to use \gls{makeindex}['s] \mkidxopt{g} option @@ -977,74 +1350,109 @@ to your preamble (before you start \end{verbatim} \item Run \LaTeX\ on your document. This creates files with the - extensions \texttt{.glo} and \texttt{.ist} (for example, if your + extensions \filetype{glo} and \filetype{ist} (for example, if your \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have two extra files called \texttt{myDoc.glo} and \texttt{myDoc.ist}). If you look at your document at this point, you won't see the glossary as it hasn't been created yet. (If you use - \sty{glossaries-extra} you'll see the section heading and some + \gls{glossaries-extra} you'll see the section heading and some boilerplate text.) - \item Run \gls{makeindex} with the \texttt{.glo} file as the + If you have used package options such as \pkgopt{symbols} there + will also be other sets of files corresponding to the extra + glossaries that were created by those options. + + \item\plabel{makeindex.run} Run \gls{makeindex} with the \texttt{.glo} file as the input file and the \texttt{.ist} file as the style so that it creates an output file with the extension \texttt{.gls}. If you have access to a terminal or a command prompt (for example, the MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command: -\begin{verbatim} +\begin{prompt} makeindex -s myDoc.ist -o myDoc.gls myDoc.glo -\end{verbatim} +\end{prompt} (Replace \texttt{myDoc} with the base name of your \LaTeX\ - document file. Avoid spaces in the file name if possible.) If you don't know - how to use the command prompt, then you can probably access + document file. Avoid spaces in the file name if possible. + The \textbf{\ttfamily\$} symbol indicates the command prompt and should be omitted.) + +\begin{important} +The file extensions vary according to the glossary \gloskey{type}. +See \sectionref{sec:makeindexapp} for further details. +\gls{makeindex} must be called for each set of files. +\end{important} + + If you don't know how to use the command prompt, then you can probably access \gls{makeindex} via your text editor, but each editor has a - different method of doing this, so I~can't give a~general - description. You will have to check your editor's manual. The - simplest approach is to use \app{arara} and add the following + different method of doing this. See \href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating +makeglossaries or makeglossaries-lite or bib2gls into the document +build} for some examples. + + Alternatively, run \gls{makeindex} indirectly via the +\gls{makeglossaries} script: +\begin{prompt} +makeglossaries myDoc +\end{prompt} + Note that the file extension isn't supplied in this case. + (Replace \gls{makeglossaries} with \gls{makeglossaries-lite.lua} if + you don't have Perl installed.) + This will pick up all the file extensions from the + \filetype{aux} file and run \gls{makeindex} the appropriate number + of times with all the necessary switches. + + The simplest approach is to use \app{arara} and add the following comment lines to the start of your document: \begin{alltt} -\% arara:\ pdflatex -\% arara:\ makeglossaries -\% arara:\ pdflatex +\% arara: pdflatex +\% arara: makeglossaries +\% arara: pdflatex \end{alltt} - (Replace \texttt{makeglossaries} with - \texttt{makeglossaries-lite} if you don't have Perl installed.) + (Replace \texttt{makeglossaries} with \texttt{makeglossarieslite} in the + second line above if you don't have Perl installed. Note that + there's no hyphen in this case.) The default sort is word order (\qt{sea lion} comes before \qt{seal}). If you want letter ordering you need to add the \mkidxopt{l} switch: -\begin{verbatim} +\begin{prompt} makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo -\end{verbatim} +\end{prompt} (See \sectionref{sec:makeindexapp} for further details on using \gls*{makeindex} explicitly.) If you use \gls{makeglossaries} or \gls{makeglossaries-lite.lua} then use the \pkgopt[letter]{order} package option and the \mkidxopt{l} option will be added automatically. - \item Once you have successfully completed the previous step, - you can now run \LaTeX\ on your document again. You'll need to - repeat the process if you have used the \pkgopt{toc} option - (unless you're using \sty{glossaries-extra}) to ensure the - section heading is added to the table of contents. You'll also - need to repeat the process if you have any cross-references - which can't be indexed until the glossary file has been created. + \item\plabel{makeindex.relatex} Once you have successfully completed the previous step, + you can now run \LaTeX\ on your document again. \end{enumerate} +You'll need to repeat the last step if you have used the +\pkgopt{toc} option (unless you're using \gls{glossaries-extra}) to +ensure the section heading is added to the table of contents. +You'll also need to repeat steps~\ref{makeindex.run} and~\ref{makeindex.relatex} +if you have any cross-references which can't be indexed until the glossary file has +been created. -Complete example: +\optionsec{xindy} + +Example document: +\begin{alltt} +\cs{documentclass}\mgroup{article} +\cs{usepackage}[\strong{xindy}]\mgroup{glossaries} +\strong{\ics{makeglossaries}} \% open glossary files +\end{alltt} \begin{verbatim} -\documentclass{article} -\usepackage{glossaries} -\makeglossaries % open glossary files \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} \gls{sample}. -\printglossary -\end{document} \end{verbatim} - -\optionsec{xindy} +\begin{alltt} +\strong{\ics{printglossary}} +\cs{end}\mgroup{document} +\end{alltt} +You can place all your entry definitions in a separate file +and load it in the preamble with \ics{loadglsentries} (\emph{after} +\ics{makeglossaries}). This option uses a~\gls{cli} application called \gls{xindy} to sort the entries. This application is more flexible than @@ -1076,17 +1484,25 @@ some problems with certain sort values: \end{itemize} In these problematic cases, you must set the \gloskey{sort} field explicitly. For example: -\begin{verbatim} -\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, - sort={alpha},description={...}} -\end{verbatim} +\begin{alltt} +\cs{newglossaryentry}\mgroup{alpha}\mgroup{name=\mgroup{\cs{ensuremath}\mgroup{\cs{alpha}}}, + \strong{sort=\mgroup{alpha},}description=\mgroup{...}} +\end{alltt} +\begin{xtr} +The \gls{glossaries-extra} package has a modified \pkgopt{symbols} +package option that provides \ics*{glsxtrnewsymbol}, which automatically sets the +\gloskey{sort} key to the entry label (instead of the \gloskey{name}). +\end{xtr} All glossaries must be sorted according to the same method (word/letter ordering, order of use, or order of definition). -(The \sty{glossaries-extra} package allows a hybrid mix of + +\begin{xtr} +The \gls{glossaries-extra} package allows a hybrid mix of \optsand13 to provide word\slash letter ordering with \opt3 and order -of use\slash definition with \opt1. See the \sty{glossaries-extra} -documentation for further details.) +of use\slash definition with \opt1. See the \gls{glossaries-extra} +documentation for further details. +\end{xtr} \begin{enumerate} \item Add the \pkgopt{xindy} option to the \styfmt{glossaries} @@ -1099,7 +1515,8 @@ package option list: \begin{verbatim} \usepackage[xindy={glsnumbers=false}]{glossaries} \end{verbatim} - or use either \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} or + or use either \cs{GlsSetXdyFirstLetterAfterDigits}\marg{letter} (to indicate the +first letter group to follow the digits) or \cs{GlsSetXdyNumberGroupOrder}\marg{spec} to indicate where the number group should be placed (see \sectionref{sec:xindy}). @@ -1107,14 +1524,18 @@ package option list: defining your entries, as described in \sectionref{sec:newglosentry}). \item Run \LaTeX\ on your document. This creates files with the - extensions \texttt{.glo} and \texttt{.xdy} (for example, if your + extensions \filetype{glo} and \filetype{xdy} (for example, if your \LaTeX\ document is called \texttt{myDoc.tex}, then you'll have two extra files called \texttt{myDoc.glo} and \texttt{myDoc.xdy}). If you look at your document at this point, you won't see the glossary as it hasn't been created yet. (If you're using the - extension package \sty{glossaries-extra}, you'll see the section + \gls{glossaries-extra} extension package, you'll see the section header and some boilerplate text.) + If you have used package options such as \pkgopt{symbols} there + will also be other sets of files corresponding to the extra + glossaries that were created by those options. + \item Run \gls{xindy} with the \texttt{.glo} file as the input file and the \texttt{.xdy} file as a~module so that it creates an output file with the extension \texttt{.gls}. You @@ -1123,19 +1544,31 @@ package option list: MSDOS command prompt for Windows users or the bash console for Unix-like users) then you need to run the command (all on one line): -\begin{verbatim} -xindy -L english -C utf8 -I xindy -M myDoc --t myDoc.glg -o myDoc.gls myDoc.glo -\end{verbatim} +\begin{prompt} +xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo +\end{prompt} (Replace \texttt{myDoc} with the base name of your \LaTeX\ document file. Avoid spaces in the file name. If necessary, also replace \texttt{english} with the name of your language and \texttt{utf8} with your input encoding, for example, \xdyopt{L}\texttt{ german }\xdyopt{C}\texttt{ din5007-utf8}.) - Note that it's much simpler to use \gls{makeglossaries} instead: -\begin{verbatim} + +\begin{important} +The file extensions vary according to the glossary \gloskey{type}. +See \sectionref{sec:xindyapp} for further details. +\gls{xindy} must be called for each set of files. +\end{important} + + It's much simpler to use \gls{makeglossaries} instead: +\begin{prompt} makeglossaries myDoc -\end{verbatim} +\end{prompt} + Note that the file extension isn't supplied in this case. + This will pick up all the file extensions from the + \filetype{aux} file and run \gls{xindy} the appropriate number + of times with all the necessary switches. + + There's no benefit in using \gls{makeglossaries-lite.lua} with \gls{xindy}. (Remember that \gls{xindy} is a Perl script so if you can use \gls{xindy} then you can also use \gls{makeglossaries}, and if you don't want to use \gls{makeglossaries} because you don't @@ -1143,14 +1576,16 @@ makeglossaries myDoc If you don't know how to use the command prompt, then you can probably access \gls{xindy} or \gls{makeglossaries} via your text editor, - but each editor has a different method of doing this, so I~can't give - a~general description. You will have to check your editor's manual. Again, - a convenient method is to use \appfmt{arara} and add the follow comment + but each editor has a different method of doing this. See \href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating +makeglossaries or makeglossaries-lite or bib2gls into the document +build} for some examples. + + Again, a convenient method is to use \appfmt{arara} and add the follow comment lines to the start of your document: \begin{alltt} -\% arara:\ pdflatex -\% arara:\ makeglossaries -\% arara:\ pdflatex +\% arara: pdflatex +\% arara: makeglossaries +\% arara: pdflatex \end{alltt} The default sort is word order (\qt{sea lion} comes before \qt{seal}). @@ -1166,139 +1601,193 @@ makeglossaries myDoc \gls*{xindy} explicitly. \item Once you have successfully completed the previous step, - you can now run \LaTeX\ on your document again. As with the - previous option, you may need to repeat the process to ensure - the table of contents and cross-references are resolved. + you can now run \LaTeX\ on your document again. As with + \gls{makeindex} (\opt2), you may need to repeat the previous + step and this step to ensure the table of contents and cross-references are resolved. \end{enumerate} -Complete example: -\begin{verbatim} -\documentclass{article} -\usepackage[xindy]{glossaries} -\makeglossaries % open glossary files -\newglossaryentry{sample}{name={sample}, - description={an example}} -\begin{document} -\gls{sample}. -\printglossary -\end{document} -\end{verbatim} - \optionsec{bib2gls} -This option is only available with the extension package -\gls{glossaries-extra}. This method uses \gls{bib2gls} to both -fetch entry definitions from \texttt{.bib} files and to -hierarchically sort and collate. +\glsxtrnote +This option is only available with the \gls{glossaries-extra} extension package. +This method uses \gls{bib2gls} to both fetch entry definitions from +\filetype{bib} files and to hierarchically sort and collate. -All entries must be provided in one or more \texttt{.bib} files. -(See the \gls{bib2gls} user manual for the required format.) The -\sty{glossaries-extra} package needs to be loaded with the -\pkgoptfmt{record} package option -\begin{verbatim} -\usepackage[record]{glossaries-extra} -\end{verbatim} +Example document: +\begin{alltt} +\cs{documentclass}\mgroup{article} +\cs{usepackage}[\xtrfont{record=nameref}]\mgroup{glossaries-extra} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{entries}] +\cs{begin}\mgroup{document} +\cs{gls}\mgroup{sample}, \cs{gls}\mgroup{alpha}, \cs{gls}\mgroup{html}. +\ics*{printunsrtglossary} +\cs{end}\mgroup{document} +\end{alltt} +where the file \texttt{entries.bib} contains: +\begin{alltt} +\atentry{entry}\mgroup{sample, + name=\mgroup{sample}, + description=\mgroup{an example} +} +\atentry{symbol}\mgroup{alpha, + name=\mgroup{\cs{ensuremath}\mgroup{\cs{alpha}}}, + description=\mgroup{...} +} +\atentry{abbreviation}\mgroup{html, + short=\mgroup{HTML}, + long=\mgroup{hypertext markup language} +} +\end{alltt} + +All entries must be provided in one or more \filetype{bib} files. +See the \gls{bib2gls} user manual for the required format. + +\begin{important} +Note that the \gloskey{sort} key should not be used. Each entry type +(\atentry{entry}, \atentry{symbol}, \atentry{abbreviation}) has a +particular field that's used for the sort value by default +(\gloskey{name}, the label, \gloskey{short}). You will break this +mechanism if you explicitly use the \gloskey{sort} key. See +\bibglsgallery{sorting} for examples. +\end{important} + +The \gls{glossaries-extra} package needs to be loaded with the +\pkgopt*{record} package option: +\begin{alltt} +\cs{usepackage}[\xtrfont{record}]\mgroup{glossaries-extra} +\end{alltt} or (equivalently) -\begin{verbatim} -\usepackage[record=only]{glossaries-extra} -\end{verbatim} +\begin{alltt} +\cs{usepackage}[\xtrfont{record=only}]\mgroup{glossaries-extra} +\end{alltt} +or (with at least \gls{glossaries-extra} v1.37 and \gls{bib2gls} v1.8): +\begin{alltt} +\cs{usepackage}[\xtrfont{record=nameref}]\mgroup{glossaries-extra} +\end{alltt} +The \pkgopt+{nameref}{record} option is the best method. + (It's possible to use a hybrid of this method and \optsor23 with -\pkgoptfmt{record=alsoindex} but in general there is little need +\pkgopt+{alsoindex}{record} but in general there is little need for this and it complicates the build process.) -Each resource set is loaded with \cs{GlsXtrLoadResources}\oarg{options}. +Each resource set is loaded with \ics*{GlsXtrLoadResources}\oarg{options}. For example: -\begin{verbatim} -\GlsXtrLoadResources -[% definitions in entries1.bib and entries2.bib: - src={entries1,entries2}, - sort={de-CH-1996}% sort according to this locale +\begin{alltt} +\ics*{GlsXtrLoadResources} +[\% definitions in entries1.bib and entries2.bib: + \resourceopt{src}=\mgroup{entries1,entries2}, + \resourceopt{sort}=\mgroup{de-CH-1996}\% sort according to this locale ] -\end{verbatim} -You can have multiple resource commands. - -The glossary is displayed using -\begin{verbatim} -\printunsrtglossary -\end{verbatim} +\end{alltt} +The \filetype{bib} files are identified as a comma-separated list in the +value of the \resourceopt{src} key. The \resourceopt{sort} option +identifies the sorting method. This may be a locale identifier for +alphabetic sorting, but there are other sort methods available, such +as character code or numeric. One resource set may cover multiple +glossaries or one glossary may be split across multiple resource +sets, forming logical sub-blocks. + +If you want to ensure that all entries are selected, even if +they haven't been referenced in the document, then add the option +\resourceopt[all]{selection}. (There are also ways of filtering the +selection or you can even have a random selection by shuffling and +truncating the list. See the \gls{bib2gls} user manual for further details.) + +The glossary is displayed using: +\begin{alltt} +\ics*{printunsrtglossary} +\end{alltt} Alternatively all glossaries can be displayed using the iterative command: -\begin{verbatim} -\printunsrtglossaries -\end{verbatim} -The document is build using: -\begin{verbatim} +\begin{alltt} +\ics*{printunsrtglossaries} +\end{alltt} +The document is built using: +\begin{prompt} pdflatex myDoc bib2gls myDoc pdflatex myDoc -\end{verbatim} -If letter groups are required, you need the \verb|--group| switch: -\begin{verbatim} -bib2gls --group myDoc -\end{verbatim} +\end{prompt} +If letter groups are required, you need the \bibglslongopt{group} switch: +\begin{prompt} +bib2gls -{}-group myDoc +\end{prompt} +or with \app{arara}: +\begin{alltt} +\% arara: bib2gls: \mgroup{ group: on } +\end{alltt} +(You will also need an appropriate glossary style.) + Unlike \optsand23, this method doesn't create a file containing the typeset glossary but simply determines which entries are needed for the document, their associated locations and (if required) their associated letter group. This option allows -a mixture of sort methods. (For example, sorting by word order +a mixture of sort methods. For example, sorting by word order for one glossary and order of use for another or even sorting one block of the glossary differently to another block in the -same glossary.) +same glossary. See \bibglsgallery{sorting}. + +This method supports Unicode and uses the Common Locale Data +Repository, which provides more extensive language support than +\gls{xindy}.\footnote{Except for Klingon, which is supported by +\gls{xindy}, but not by the CLDR.}\ The locations in the +\gls{numberlist} may be in any format. If \gls{bib2gls} can deduce a +numerical value it will attempt to form ranges otherwise it will +simply list the locations. + +See \bibglsbegin\ or the \gls{bib2gls} user manual for further +details of this method, and +also \href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating +makeglossaries or makeglossaries-lite or bib2gls into the document +build}. -This method supports Unicode and (with at least Java~8) uses -the Common Locale Data Repository, which provides more extensive -language support than \gls{xindy}.\footnote{Except for Klingon, -which is supported by \gls{xindy}, but not by the -CLDR.}\ The locations in the -\gls{numberlist} may be in any format. If \gls{bib2gls} can -deduce a numerical value it will attempt to form ranges otherwise -it will simply list the locations. +\optionsec[no sorting]{no sorting} -Complete example: +\glsxtrnote +This option is only available with the extension package +\gls{glossaries-extra}. No \gls{indexingapp} is required. + +Example document: \begin{verbatim} \documentclass{article} -\usepackage[record]{glossaries-extra} -\GlsXtrLoadResources[src={entries}] +\usepackage[sort=none]{glossaries-extra} +\newglossaryentry{sample}{name={sample}, + description={an example}} +\newglossaryentry{alpha}{name={\ensuremath{\alpha}}, + description={...}} \begin{document} \gls{sample}. -\printunsrtglossary -\end{document} -\end{verbatim} -where \texttt{entries.bib} contains -\begin{verbatim} -@entry{sample, - name={sample}, - description={an example} -} \end{verbatim} -See the \gls{bib2gls} user manual for further details. - -\optionsec[no sorting]{no sorting} +\begin{alltt} +\ics*{printunsrtglossary} +\cs{end}\mgroup{document} +\end{alltt} -This option is only available with the extension package -\gls{glossaries-extra}. No \gls{indexingapp} is required. This -method is best used with the package option \pkgopt[none]{sort}. -\begin{verbatim} -\usepackage[sort=none]{glossaries-extra} -\end{verbatim} -There's no \qt{activation} command (such as \cs{makeglossaries} +This method is best used with the package option \pkgopt[none]{sort} +(as shown above). There's no \qt{activation} command (such as \cs{makeglossaries} for \optsand23). All entries must be defined before the glossary is displayed (preferably in the preamble) in the required order, and child entries must be defined immediately after their parent entry -if they must be kept together in the glossary - -The glossary is displayed using -\begin{verbatim} -\printunsrtglossary -\end{verbatim} +if they must be kept together in the glossary. (Some glossary styles +indent entries that have a parent but it's the \gls{indexingapp} +that ensures the child entries are listed immediately after the +parent. If you're opting to use this manual approach then it's your +responsibility to define the entries in the correct order.) You can +place all your entry definitions in a separate file +and load it in the preamble with \ics{loadglsentries}. + +The glossary is displayed using: +\begin{alltt} +\ics*{printunsrtglossary} +\end{alltt} Alternatively all glossaries can be displayed using the iterative command: -\begin{verbatim} -\printunsrtglossaries -\end{verbatim} +\begin{alltt} +\ics*{printunsrtglossaries} +\end{alltt} This will display \emph{all} defined entries, regardless of whether or not they have been used in the document. The \glspl{numberlist} have to be set explicitly otherwise they won't @@ -1307,601 +1796,347 @@ glossary as \opt4. This is because \gls{bib2gls} takes advantage of this method by defining the wanted entries in the required order and setting the locations (and letter group information, if required). -This just requires a single \LaTeX\ call -\begin{verbatim} +Therefore, the above example document has a glossary containing the +entries: sample and $\alpha$ (in that order). Note that +the \texttt{alpha} entry has been included even though it wasn't +referenced in the document. + +This just requires a single \LaTeX\ call: +\begin{prompt} pdflatex myDoc -\end{verbatim} +\end{prompt} unless the glossary needs to appear in the table of contents, in which case -a second run is required. -\begin{verbatim} +a second run is required: +\begin{prompt} pdflatex myDoc pdflatex myDoc -\end{verbatim} +\end{prompt} (Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all the other options above.) -Complete example: -\begin{verbatim} -\documentclass{article} -\usepackage[sort=none]{glossaries-extra} -\newglossaryentry{sample}{name={sample}, - description={an example}} -\begin{document} -\gls{sample}. -\printunsrtglossary -\end{document} -\end{verbatim} -See the \sty{glossaries-extra} documentation for -further details. - -\section{Sample Documents} -\label{sec:samples} +See the \gls{glossaries-extra} documentation for further details of this method. -The \styfmt{glossaries} package is provided with some sample -documents that illustrate the various functions. These should -be located in the \texttt{samples} subdirectory (folder) of the -\styfmt{glossaries} documentation directory. This location varies -according to your operating system and \TeX\ distribution. You -can use \texttt{texdoc} to locate the main glossaries documentation. -For example, in a -\href{http://www.dickimaw-books.com/latex/novices/html/terminal.html}{terminal or command prompt}, type: -\begin{prompt} -texdoc -l glossaries -\end{prompt} -This should display a list of all the files in the glossaries -documentation directory with their full pathnames. (The GUI version -of \texttt{texdoc} may also provide you with the information.) +\optionsec[standalone]{standalone} -If you can't find the sample files on your computer, they are also available -from your nearest CTAN mirror at -\url{http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/}. +\glsxtrnote +This option is only available with the \gls{glossaries-extra} +extension package.\footnote{You can just use the base +\styfmt{glossaries} package for the first case, but it's less +convenient. You'd have to manually insert the entry target before +the sectioning command and use \ics{glsentryname}\marg{label} or +\ics{Glsentryname}\marg{label} to display the entry name.} Instead +of creating a list, this has standalone definitions throughout the +document. The entry name may or may not be in a section heading. -The sample documents are listed below\footnote{Note that although I've written -\texttt{latex} in this section, it's better to use \texttt{pdflatex}, where -possible, for the reasons given \hyperlink{pdflatexnote}{earlier}.} -If you prefer to use UTF-8 aware engines (\texttt{xelatex} or -\texttt{lualatex}) remember that you'll need to switch from -\styfmt{fontenc} \& \styfmt{inputenc} to \styfmt{fontspec} where -appropriate. The \gls{glossaries-extra} package provides some -additional sample files. - -\begin{samplelist} -\exitem[minimal]{gls} This document is a -minimal working example. You can test your installation using this -file. To create the complete document you will need to do the -following steps: - \begin{enumerate} - \item Run \texttt{minimalgls.tex} through \LaTeX\ either by - typing -\begin{prompt} -latex minimalgls -\end{prompt} - in a terminal or by using the relevant button or menu item in - your text editor or front-end. This will create the required - associated files but you will not see the glossary. If you use - PDF\LaTeX\ you will also get warnings about non-existent - references that look something like: +You can either define entries in the document preamble (or in an external file loaded with +\ics{loadglsentries}), as with \opt5, for example: \begin{verbatim} -pdfTeX warning (dest): name{glo:aca} has been -referenced but does not exist, -replaced by a fixed one -\end{verbatim} - These warnings may be ignored on the first run. - - If you get a \verb"Missing \begin{document}" error, then - it's most likely that your version of \sty{xkeyval} is - out of date. Check the log file for a warning of that nature. - If this is the case, you will need to update the \styfmt{xkeyval} - package. - - \item If you have Perl installed, run \gls{makeglossaries} on the document (\sectionref{sec:makeglossaries}). This can - be done on a terminal by typing -\begin{prompt} -makeglossaries minimalgls -\end{prompt} - otherwise do -\begin{prompt} -makeglossaries-lite minimalgls -\end{prompt} - If for some reason you want to call \gls{makeindex} explicitly, you can do this - in a terminal by typing (all on one line): -\begin{prompt} -makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo -\end{prompt} - (See \sectionref{sec:makeindexapp} for further details on using - \gls*{makeindex} explicitly.) - - Note that if the file name contains spaces, you will need to use - the double-quote character to delimit the name. - - \item Run \texttt{minimalgls.tex} through \LaTeX\ again (as step~1) - \end{enumerate} -You should now have a complete document. The number following -each entry in the glossary is the location number. By default, this -is the page number where the entry was referenced. - -There are three other files that can be used as a -\href{http://www.dickimaw-books.com/latex/minexample/}{minimal working -example}: \texttt{mwe-gls.tex}, \texttt{mwe-acr.tex} and -\texttt{mwe-acr-desc.tex}. - -\exitem{-noidxapp} This document illustrates how to use the -\styfmt{glossaries} package without an external \gls{indexingapp} (\opt1). -To create the complete document, you need to do: -\begin{prompt} -latex sample-noidxapp -latex sample-noidxapp -\end{prompt} - -\exitem{-noidxapp-utf8} As the previous example, except that it uses -the \sty{inputenc} package. -To create the complete document, you need to do: -\begin{prompt} -latex sample-noidxapp-utf8 -latex sample-noidxapp-utf8 -\end{prompt} +\documentclass{article} -\exitem{4col} This document illustrates -a four column glossary where the entries have a symbol in addition -to the name and description. To create the complete document, you -need to do: -\begin{prompt} -latex sample4col -makeglossaries sample4col -latex sample4col -\end{prompt} -or -\begin{prompt} -latex sample4col -makeglossaries-lite sample4col -latex sample4col -\end{prompt} -The vertical gap between entries is the -gap created at the start of each group. This can be suppressed -using the \pkgopt{nogroupskip} package option. +\usepackage[colorlinks]{hyperref} +\usepackage[sort=none, + nostyles% <- no glossary styles are required + ]{glossaries-extra} -\exitem{Acr} This document has some -sample abbreviations. It also adds the glossary to the table of contents, -so an extra run through \LaTeX\ is required to ensure the document -is up to date: -\begin{prompt} -latex sampleAcr -makeglossaries sampleAcr -latex sampleAcr -latex sampleAcr -\end{prompt} -(or use \gls{makeglossaries-lite.lua}). +\newglossaryentry{set}{name={set}, + description={a collection of any kind of objects}, + symbol={\ensuremath{\mathcal{S}}} +} -\exitem{AcrDesc} This is similar to -the previous example, except that the abbreviations have an associated -description. As with the previous example, the glossary is added to -the table of contents, so an extra run through \LaTeX\ is required: -\begin{prompt} -latex sampleAcrDesc -makeglossaries sampleAcrDesc -latex sampleAcrDesc -latex sampleAcrDesc -\end{prompt} +\newglossaryentry{function}{name={function}, + description={a rule that assigns every element in the + domain \gls{set} to an element in the range \gls{set}}, + symbol={\ensuremath{f(x)}} +} +\end{verbatim} +\begin{alltt} +\cs{newcommand}*\mgroup{\cs{termdef}}[1]\mgroup{\% + \cs{section}\mgroup{\ics*{glsxtrglossentry}\mgroup{\#1} \ics{glsentrysymbol}\mgroup{\#1}}\% + \cs{begin}\mgroup{quote}\cs{em}\ics{Glsentrydesc}\mgroup{\#1}.\cs{end}\mgroup{quote}\% +} +\end{alltt} +\begin{verbatim} +\begin{document} +\tableofcontents -\exitem{Desc} This is similar to the -previous example, except that it defines the abbreviations using -\ics{newglossaryentry} instead of \ics{newacronym}. As with the -previous example, the glossary is added to the table of contents, so -an extra run through \LaTeX\ is required: -\begin{prompt} -latex sampleDesc -makeglossaries sampleDesc -latex sampleDesc -latex sampleDesc -\end{prompt} +\section{Introduction} +Sample document about \glspl{function} and \glspl{set}. -\exitem{CustomAcr} This document has some sample abbreviations with a -custom acronym style. It also adds the glossary to the table of -contents, so an extra run through \LaTeX\ is required: -\begin{prompt} -latex sampleCustomAcr -makeglossaries sampleCustomAcr -latex sampleCustomAcr -latex sampleCustomAcr -\end{prompt} +\termdef{set} -\exitem{FnAcrDesc} This is similar to \samplefile{AcrDesc}, except that it -uses the \acrstyle{footnote-sc-desc} style. As with the previous example, -the glossary is added to the table of contents, so an extra run through -\LaTeX\ is required: -\begin{prompt} -latex sampleFnAcrDesc -makeglossaries sampleFnAcrDesc -latex sampleFnAcrDesc -latex sampleFnAcrDesc -\end{prompt} +More detailed information about \glspl{set} with examples. -\exitem{-FnDesc} This example -defines a custom display format that puts the description in a -footnote on first use. -\begin{prompt} -latex sample-FnDesc -makeglossaries sample-FnDesc -latex sample-FnDesc -\end{prompt} +\termdef{function} -\exitem{-custom-acronym} -This document illustrates how to define your own acronym style if -the predefined styles don't suit your requirements. -\begin{prompt} -latex sample-custom-acronym -makeglossaries sample-custom-acronym -latex sample-custom-acronym -\end{prompt} +More detailed information about \glspl{function} with examples. -\exitem{-crossref} -This document illustrates how to cross-reference entries in the -glossary. -\begin{prompt} -latex sample-crossref -makeglossaries sample-crossref -latex sample-crossref -\end{prompt} - -\exitem{-dot-abbr} This document illustrates how to use the -post link hook to adjust the space factor after abbreviations. -\begin{prompt} -latex sample-dot-abbr -makeglossaries sampledot-abbrf -latex sample-dot-abbr -\end{prompt} - -\exitem{DB} This document illustrates how -to load external files containing the glossary definitions. It also -illustrates how to define a new glossary type. This document has the -\gls{numberlist} suppressed and uses \ics{glsaddall} to add all -the entries to the glossaries without referencing each one -explicitly. To create the document do: -\begin{prompt} -latex sampleDB -makeglossaries sampleDB -latex sampleDB -\end{prompt} -or -\begin{prompt} -latex sampleDB -makeglossaries-lite sampleDB -latex sampleDB -\end{prompt} -The glossary definitions are stored in the accompanying files -\texttt{database1.tex} and \texttt{database2.tex}. If for some -reason you want to call \gls{makeindex} explicitly you must -have a separate call for each glossary: -\begin{enumerate} -\item Create the main glossary (all on one line): -\begin{prompt}\raggedright -makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo -\end{prompt} -\item Create the secondary glossary (all on one line): -\begin{prompt}\raggedright -makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn -\end{prompt} -Note that both \gls{makeglossaries} and \gls{makeglossaries-lite.lua} do -this all in one call, so they not only make it easier because you -don't need to supply all the switches and remember all the -extensions but they also call \gls{makeindex} the appropriate number of times. -\end{enumerate} - -\exitem{Eq} This document illustrates how -to change the location to something other than the page number. In -this case, the \texttt{equation} counter is used since all glossary -entries appear inside an \env{equation} environment. To create -the document do: -\begin{prompt} -latex sampleEq -makeglossaries sampleEq -latex sampleEq -\end{prompt} +\end{document} +\end{verbatim} +Or you can use \gls{bib2gls} if you want to manage a large +database of terms. For example (requires \gls{glossaries-extra} v1.42, see below): +\begin{alltt} +\cs{documentclass}\mgroup{article} -\exitem{EqPg} This is similar to the -previous example, but the \glspl{numberlist} are a -mixture of page numbers and equation numbers. This example adds the -glossary to the table of contents, so an extra \LaTeX\ run is -required: -\begin{prompt} -latex sampleEqPg -makeglossaries sampleEqPg -latex sampleEqPg -latex sampleEqPg -\end{prompt} +\cs{usepackage}[colorlinks]\mgroup{hyperref} +\cs{usepackage}[\xtrfont{record}, + nostyles\% <- no glossary styles are required + ]\mgroup{glossaries-extra} -\exitem{Sec} This document also -illustrates how to change the location to something other than the -page number. In this case, the \texttt{section} counter is used. -This example adds the glossary to the table of contents, so an extra -\LaTeX\ run is required: -\begin{prompt} -latex sampleSec -makeglossaries sampleSec -latex sampleSec -latex sampleSec -\end{prompt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=terms,\resourceopt{sort}=none,\resourceopt{save-locations}=false] -\exitem{Ntn} This document illustrates -how to create an additional glossary type. This example adds the -glossary to the table of contents, so an extra \LaTeX\ run is -required: -\begin{prompt} -latex sampleNtn -makeglossaries sampleNtn -latex sampleNtn -latex sampleNtn -\end{prompt} -Note that if you want to call \gls{makeindex} explicitly instead of -using \gls{makeglossaries} or \gls{makeglossaries-lite.lua} then you -need to call \gls{makeindex} twice: -\begin{enumerate} -\item Create the main glossary (all on one line): -\begin{prompt}\raggedright -makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo -\end{prompt} -\item Create the secondary glossary (all on one line): -\begin{prompt}\raggedright -makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn -\end{prompt} -\end{enumerate} +\cs{newcommand}*\mgroup{\cs{termdef}}[1]\mgroup{\% + \cs{section}\mgroup{\ics*{glsxtrglossentry}\mgroup{\#1} \strong{\ics{glossentrysymbol}}\mgroup{\#1}}\% + \ics{glsadd}\mgroup{\#1}\% <- index this entry + \cs{begin}\mgroup{quote}\cs{em}\ics{Glsentrydesc}\mgroup{\#1}.\cs{end}\mgroup{quote}\% +} +\end{alltt} +\begin{verbatim} +\begin{document} +\tableofcontents -\exitem{} This document illustrates some of -the basics, including how to create child entries that use the same -name as the parent entry. This example adds the glossary to the -table of contents and it also uses \ics{glsrefentry}, so an extra \LaTeX\ -run is required: -\begin{prompt} -latex sample -makeglossaries sample -latex sample -latex sample -\end{prompt} -You can see the difference between word and letter ordering if you -substitute \pkgopt[word]{order} with \pkgopt[letter]{order}. (Note -that this will only have an effect if you use -\gls{makeglossaries} or \gls{makeglossaries-lite.lua}. -If you use \gls{makeindex} explicitly, you will need to use the -\mkidxopt{l} switch to indicate letter ordering.) +\section{Introduction} +Sample document about \glspl{function} and \glspl{set}. -\exitem{-inline} This document is -like \texttt{sample.tex}, above, but uses the \glostyle{inline} -glossary style to put the glossary in a footnote. +\termdef{set} -\exitem{tree} This document illustrates -a hierarchical glossary structure where child entries have different -names to their corresponding parent entry. To create the document -do: -\begin{prompt} -latex sampletree -makeglossaries sampletree -latex sampletree -\end{prompt} +More detailed information about \glspl{set} with examples. -\exitem{-dual} This document -illustrates how to define an entry that both appears in the list of -acronyms and in the main glossary. To create the document do: -\begin{prompt} -latex sample-dual -makeglossaries sample-dual -latex sample-dual -\end{prompt} +\termdef{function} -\exitem{-langdict} This document -illustrates how to use the glossaries package to create English -to French and French to English dictionaries. To create the document -do: -\begin{prompt} -latex sample-langdict -makeglossaries sample-langdict -latex sample-langdict -\end{prompt} +More detailed information about \glspl{function} with examples. -\exitem{xdy} This document illustrates -how to use the \styfmt{glossaries} package with \gls{xindy} instead -of \gls{makeindex}. The document uses UTF8 encoding (with the -\sty{inputenc} package). The encoding is picked up by -\gls{makeglossaries}. By default, this document will create a -\gls{xindy} style file called \texttt{samplexdy.xdy}, but if you -uncomment the lines -\begin{verbatim} -\setStyleFile{samplexdy-mc} -\noist -\GlsSetXdyLanguage{} +\end{document} \end{verbatim} -it will set the style file to \texttt{samplexdy-mc.xdy} instead. -This provides an additional letter group for entries starting with -\qt{Mc} or \qt{Mac}. If you use \gls{makeglossaries} or -\gls{makeglossaries-lite.lua}, you don't -need to supply any additional information. If you don't use -\gls*{makeglossaries}, you will need to specify the required -information. Note that if you set the style file to -\texttt{samplexdy-mc.xdy} you must also specify \ics{noist}, -otherwise the \styfmt{glossaries} package will overwrite -\texttt{samplexdy-mc.xdy} and you will lose the \qt{Mc} letter -group. - -To create the document do: -\begin{prompt} -latex samplexdy -makeglossaries samplexdy -latex samplexdy -\end{prompt} -If you don't have Perl installed then you can't use -\gls{makeglossaries}, but you also can't use \gls{xindy}! -However, if for some reason you want to call -\gls{xindy} explicitly instead of using \gls{makeglossaries} (or -\gls{makeglossaries-lite.lua}): -\begin{itemize} -\item if you are using the default style file \texttt{samplexdy.xdy}, then -do (no line breaks): -\begin{prompt}\raggedright -xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo -\end{prompt} -\item if you are using \texttt{samplexdy-mc.xdy}, then do -(no line breaks): -\begin{prompt}\raggedright -xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo -\end{prompt} -\end{itemize} - -\exitem{xdy2} This document illustrates -how to use the \styfmt{glossaries} package where the location -numbers don't follow a standard format. This example will only work -with \gls{xindy}. To create the document do: -\begin{prompt} -pdflatex samplexdy2 -makeglossaries samplexdy2 -pdflatex samplexdy2 -\end{prompt} -The explicit \gls{xindy} call is: -\begin{prompt}\raggedright -xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo -\end{prompt} -See \sectionref{sec:xindyloc} for further details. - -\exitem{xdy3} This document is like \samplefile{xdy} but uses the -command \cs{Numberstring} from the \sty{fmtcount} package to -format the page numbers. - -\exitem{utf8} This is another example -that uses \gls{xindy}. Unlike \gls{makeindex}, -\gls{xindy} can cope with \glspl{nonlatinchar}. This -document uses UTF8 encoding. To create the document do: +Where the file \texttt{terms.bib} contains: +\begin{alltt} +\atentry{entry}\mgroup{set, + name=\mgroup{set}, + description=\mgroup{a collection of any kind of objects}, + symbol=\mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}} +} +\atentry{entry}\mgroup{function, + name=\mgroup{function}, + description=\mgroup{a rule that assigns every element in the domain + \cs{gls}\mgroup{set} to an element in the range \cs{gls}\mgroup{set}}, + symbol=\mgroup{\cs{ensuremath}\mgroup{f(x)}} +} +\end{alltt} +The advantage in this approach (with \ics{loadglsentries} or +\gls{bib2gls}) is that you can use an existing database of +entries shared across multiple documents, ensuring consistent +notation for all of them. + +In both cases, there's no need to load all the glossary styles +packages, as they're not required, so I've used the +\pkgopt{nostyles} package option to prevent them from being loaded. + +In the first case, you need the \pkgopt[none]{sort} package option +(as in \opt5) and then define the terms in the preamble. No external tool is +required. Just run \LaTeX\ as normal. (Twice to ensure that the +table of contents is up to date.) \begin{prompt} -latex sampleutf8 -makeglossaries sampleutf8 -latex sampleutf8 -\end{prompt} -The explicit \gls{xindy} call is -(no line breaks): -\begin{prompt}\raggedright -xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +pdflatex myDoc +pdflatex myDoc \end{prompt} -If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} -and do: -\begin{prompt} -latex sampleutf8 -makeglossaries sampleutf8 -latex sampleutf8 -\end{prompt} -or -\begin{prompt} -latex sampleutf8 -makeglossaries-lite sampleutf8 -latex sampleutf8 -\end{prompt} -you will see that the entries that start with an \gls{exlatinchar} -now appear in the symbols group, and the word \qt{man\oe uvre} is now -after \qt{manor} instead of before it. If you want to explicitly -call \gls{makeindex} (no line breaks): -\begin{prompt}\raggedright -makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo -\end{prompt} +In the second case, you need the \pkgopt*{record} package +option (as in \opt4) since \gls{bib2gls} is needed to select the +required entries, but you don't need a sorted list: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{terms},\strong{\xtrfont{sort}=none}] +\end{alltt} +This will ensure that any entries indexed in the document (through +commands like \ics{gls} or \ics{glsadd}) will be selected by +\gls{bib2gls}, but it will skip the sorting step. +(The chances are you probably also won't need location lists either. +If so, you can add the option \resourceopt[false]{save-locations}.) -\exitem{-index} This document uses -the \styfmt{glossaries} package to create both a glossary and an -index. This requires two \gls{makeglossaries} (or -\gls{makeglossaries-lite.lua}) calls to ensure the -document is up to date: +Remember that for this second case you need to run \gls{bib2gls} as per \opt4: \begin{prompt} -latex sample-index -makeglossaries sample-index -latex sample-index -makeglossaries sample-index -latex sample-index +pdflatex myDoc +bib2gls myDoc +pdflatex myDoc +pdflatex myDoc \end{prompt} -\exitem{-newkeys} This document illustrates how add custom keys -(using \cs{glsaddkey}). - -\exitem{-storage-abbr} This document illustrates how add custom -storage keys (using \cs{glsaddstoragekey}). - -\exitem{-storage-abbr-desc} An extension of the previous example -where the user needs to provide a~description. +For both cases (with or without \gls{bib2gls}), instead of listing +all the entries using \xtrcs{printunsrtglossary}, you use +\ics*{glsxtrglossentry}\marg{label} where you want the name (and +anchor with \sty{hyperref}) to appear in the document. This will +allow the \gls{linktext} created by commands like \cs{gls} to link +to that point in the document. The description can simply be +displayed with \ics{glsentrydesc}\marg{label} or +\ics{Glsentrydesc}\marg{label}, as in the above examples. In both +examples, I've defined a custom command \cs{termdef} to simplify the +code and ensure consistency. Extra styling, such as placing the +description in a coloured frame, can be added to this custom +definition as required. + +(Instead of using \cs{glsentrydesc} or \cs{Glsentrydesc}, you can use +\ics{glossentrydesc}\marg{label}, which will obey attributes such as +\attr{glossdesc} and \attr{glossdescfont}. See the \gls{glossaries-extra} +manual for further details.) -\exitem{-chap-hyperfirst} This document illustrates how to add -a~custom key using \cs{glsaddstoragekey} and hook into the \glslike\ -and \glstextlike\ mechanism used to determine whether or not to -hyperlink an entry. +The symbol (if required) can be displayed with either +\ics{glsentrysymbol}\marg{label} or \ics{glossentrysymbol}\marg{label}. +In the first example, I've used \cs{glsentrysymbol}. In the +second I've used \ics{glossentrysymbol}. The latter is +necessary with \gls{bib2gls} if the symbol needs to go in a +section title as the entries aren't defined on the first \LaTeX\ run. + +In normal document text, \cs{glsentrysymbol} will silently do nothing +if the entry hasn't been defined, but when used in a section heading +it will expand to an undefined internal command when written to the +\filetype{aux} file, which triggers an error. + +The \ics{glossentrysymbol} command performs an existence check, +which triggers a warning if the entry is undefined. (All entries +will be undefined before the first \gls{bib2gls} call.) You need at +least \gls{glossaries-extra} v1.42 to use this command in a section +title.\footnote{\cs{glossentrysymbol} is defined by the base +\styfmt{glossaries} package but is redefined by +\gls{glossaries-extra}.} If \sty{hyperref} has been loaded, this +will use \ics{texorpdfstring} to allow a simple expansion for the +PDF bookmarks (see the \gls{glossaries-extra} user manual for +further details). -\exitem{-font-abbr} This document illustrates how to different fonts -for abbreviations within the style. +If you want to test if the \gloskey{symbol} field has been set, you +need to use \ics{ifglshassymbol} outside of the section title. For +example: +\begin{alltt} +\cs{ifglshassymbol}\mgroup{\#1}\% +\mgroup{\cs{section}\mgroup{\xtrcs{glsxtrglossentry}\mgroup{\#1} \cs{glossentrysymbol}\mgroup{\#1}}} +\mgroup{\cs{section}\mgroup{\xtrcs{glsxtrglossentry}\mgroup{\#1}}} +\end{alltt} -\exitem{-numberlist} This document illustrates how to reference the -\gls{numberlist} in the document text. This requires an additional -\LaTeX\ run: -\begin{prompt} -latex sample-numberlist -makeglossaries sample-numberlist -latex sample-numberlist -latex sample-numberlist -\end{prompt} +In both of the above examples, the section titles start with a lowercase +character (because the \gloskey{name} value is all lowercase in +entry definitions). You can apply automatic case-change with the +\attr{glossname} attribute. For example: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{general}\mgroup{glossname}\mgroup{firstuc} +\end{alltt} +or (for title-case) +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{general}\mgroup{glossname}\mgroup{title} +\end{alltt} +However, this won't apply the case-change in the table of contents +or bookmarks. -\exitem{People} This document illustrates how you can hook into the -standard sort mechanism to adjust the way the sort key is set. This -requires an additional run to ensure the table of contents is -up-to-date: -\begin{prompt} -latex samplePeople -makeglossaries samplePeople -latex samplePeople -latex samplePeople -\end{prompt} +In the second example, you can instead use \gls{bib2gls} to apply a +case-change: +\begin{alltt} +\cs{GlsXtrLoadResources}[\resourceopt{src}=terms, + \resourceopt{sort}=none,\resourceopt{save-locations}=false\strong{, + \resourceopt{replicate-fields}=\mgroup{name=text}, + \xtrfont{name-case-change}=firstuc} +] +\end{alltt} +(Or \resourceopt[title]{name-case-change} for title-case.) +This copies the \gloskey{name} value to the \gloskey{text} field and +then applies a case-change to the \gloskey{name} field (leaving the +\gloskey{text} field unchanged). The name in the section titles now +starts with a capital but the \gls{linktext} produced by commands like +\ics{gls} is still lowercase. + +In the first example (without \gls{bib2gls}) you need to do this +manually. For example: +\begin{alltt} +\cs{newglossaryentry}\mgroup{set}\mgroup{name=\mgroup{\strong{S}et},\strong{text=\mgroup{set}}, + description=\mgroup{a collection of any kind of objects}, + symbol=\mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}} +} +\end{alltt} -\exitem{Sort} This is another document that illustrates how to hook -into the standard sort mechanism. An additional run is required to -ensure the table of contents is up-to-date: +Note that if you use the default \resourceopt[true]{save-locations} +with \gls{bib2gls}, it's possible to combine \optsand46 to have both standalone +definitions and an index. Now I do need a glossary style. In this +case I'm going to use \xtrglostyle{bookindex}, which is provided in +the \sty{glossary-bookindex} package (bundled with +\gls{glossaries-extra}). I don't need any of the other style +packages, so I can still keep the \pkgopt{nostyles} option and just +load \sty{glossary-bookindex}: +\begin{alltt} +\cs{usepackage}[\xtrfont{record=nameref},\% <- using bib2gls + nostyles,\% <- don't load default style packages + \xtrfont{stylemods=bookindex},\% <- load glossary-bookindex.sty + style=\xtrfont{bookindex}\% <- set the default style to 'bookindex' +]\mgroup{glossaries-extra} +\end{alltt} +I also need to sort the entries, so the resource command is now: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=terms,\% definitions in terms.bib + \resourceopt{sort}=en-GB,\% sort by this locale + \resourceopt{replicate-fields}=\mgroup{name=text}, + \xtrfont{name-case-change}=\mgroup{firstuc} +] +\end{alltt} +At the end of the document, I can add the glossary: +\begin{alltt} +\ics*{printunsrtglossary}[title=Index,target=false] +\end{alltt} +Note that I've had to switch off the hypertargets with +\xtrprintglosskey[false]{target} (otherwise there would be duplicate +targets). If you want letter group headings you need to use the +\bibglslongopt{group} switch: \begin{prompt} -latex sampleSort -makeglossaries sampleSort -latex sampleSort -latex sampleSort +bib2gls -{}-group myDoc \end{prompt} +or if you are using \app{arara}: +\begin{alltt} +\% arara: bib2gls: \mgroup{ group: on } +\end{alltt} -\exitem{-nomathhyper} This document illustrates how to selectively -enable and disable entry hyperlinks in \ics{glsentryfmt}. - -\exitem{-entryfmt} This document illustrates how to change the -way an entry is displayed in the text. - -\exitem{-prefix} This document illustrates the use of the -\sty{glossaries-prefix} package. An additional run is required to -ensure the table of contents is up-to-date: -\begin{prompt} -latex sample-prefix -makeglossaries sample-prefix -latex sample-prefix -latex sample-prefix -\end{prompt} +The \xtrglostyle{bookindex} style doesn't show the +description, so only the name and location is displayed. Remember +that the name has had a case-conversion so it now starts with an +initial capital. If you feel this is inappropriate for the index, +you can adjust the \xtrglostyle{bookindex} style so that it uses +the \gloskey{text} field instead. For example: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrbookindexname}}[1]\mgroup{\% + \ics*{glossentrynameother}\mgroup{\#1}\mgroup{text}} +\end{alltt} +See the \gls{glossaries-extra} user manual for further details about +this style. -\exitem{accsupp} This document -uses the experimental \sty{glossaries-accsupp} package. The -symbol is set to the replacement text. Note that some PDF -viewers don't use the accessibility support. Information -about the \styfmt{glossaries-accsupp} package can be found in -\sectionref{sec:accsupp}. +Note that on the first \LaTeX\ run none of the entries will be +defined. Once they are defined, the page numbers may shift due to +the increased amount of document text. You may therefore need to +repeat the document build to ensure the page numbers are correct. -\exitem{-ignored} This document defines an ignored glossary for -common terms that don't need a definition. +If there are extra terms that need to be included in the index that +don't have a description, you can define them with \atentry{index} +in the \filetype{bib} file. For example: +\begin{alltt} +\atentry{index}\mgroup{element} +\atentry{index}\mgroup{member,\xtrgloskey{alias}=\mgroup{element}} +\end{alltt} +They can be used in the document as usual: +\begin{verbatim} +The objects that make up a set are the \glspl{element} +or \glspl{member}. +\end{verbatim} +See \bibglsbegin\ or the \gls{bib2gls} user manual for further +details. -\exitem{-entrycount} This document uses \ics{glsenableentrycount} -and \ics{cgls} (described in \sectionref{sec:enableentrycount}) -so that acronyms only used once don't appear in the list of -acronyms. -\end{samplelist} +The \styfmt{glossaries} package comes with a number of sample +documents that illustrate the various functions. These are listed in +\sectionref{sec:samples}. \section{Dummy Entries for Testing} \label{sec:lipsum} -In addition to the sample files described above, \sty{glossaries} also provides -some files containing lorum ipsum dummy entries. These are provided -for testing purposes and are on \TeX's path (in -\texttt{tex\slash latex\slash glossaries\slash test-entries}) so they can be included -via \ics{input} or \ics{loadglsentries}. The files are as follows: +In addition to the sample files described above, \sty{glossaries} +also provides some files containing lorum ipsum dummy entries. These +are provided for testing purposes and are on \TeX's path (in +\texttt{tex\slash latex\slash glossaries\slash test-entries}) so +they can be included via \ics{input} or \ics{loadglsentries}. The +\gls{glossaries-extra} package provides \filetype{bib} versions of +all these files for use with \gls{bib2gls}. The files are as +follows: + \begin{description} \item[example-glossaries-brief.tex] These entries all have brief descriptions. For example: @@ -1920,7 +2155,15 @@ mauris.}} \end{verbatim} \item[example-glossaries-multipar.tex] These entries all have -multi-paragraph descriptions. +multi-paragraph descriptions. For example: +\begin{verbatim} +\longnewglossaryentry{loremi-ii}{name={lorem 1--2}}% +{% +Lorem ipsum ... + +Nam dui ligula... +} +\end{verbatim} \item[example-glossaries-symbols.tex] These entries all use the \gloskey{symbol} key. For example: @@ -1943,6 +2186,17 @@ description={Quisque ullamcorper placerat ipsum.}} \gloskey{user1} key to store the name of an image file. (The images are provided by the \sty{mwe} package and should be on \TeX's path.) One entry doesn't have an associated image to help test for a~missing key. +The descriptions are long to allow for tests with the text wrapping +around the image. For example: +\begin{verbatim} +\longnewglossaryentry{sedfeugiat}{name={sed feugiat}, +user1={example-image}}% +{% +Cum sociis natoque... + +Etiam... +} +\end{verbatim} \item[example-glossaries-acronym.tex] These entries are all abbreviations. For example: @@ -1950,8 +2204,20 @@ abbreviations. For example: \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum dolor} \end{verbatim} +\begin{xtr} +If you use the \gls{glossaries-extra} extension package, then +\ics{newacronym} is redefined to use \ics*{newabbreviation} +with the \xtrgloskey{category} key set to \texttt{acronym} (rather +than the default \texttt{abbreviation}). This means that you need to +set the abbreviation style for the \texttt{acronym} category. For +example: +\begin{verbatim} +\setabbreviationstyle[acronym]{long-short} +\end{verbatim} +\end{xtr} -\item[example-glossaries-acronym-desc.tex] These entries are all +\item[example-glossaries-acronym-desc.tex] This file contains +entries that are all abbreviations that use the \gloskey{description} key. For example: \begin{verbatim} @@ -1959,6 +2225,17 @@ For example: description={fringilla a, euismod sodales, sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} \end{verbatim} +\begin{xtr} +If you use the \gls{glossaries-extra} extension package, then +\ics{newacronym} is redefined to use \ics*{newabbreviation} +with the \xtrgloskey{category} key set to \texttt{acronym} (rather +than the default \texttt{abbreviation}). This means that you need to +set the abbreviation style for the \texttt{acronym} category. For +example: +\begin{verbatim} +\setabbreviationstyle[acronym]{long-short-desc} +\end{verbatim} +\end{xtr} \item[example-glossaries-acronyms-lang.tex] These entries are all abbreviations, where some of them have a~translation supplied in the @@ -1968,6 +2245,17 @@ For example: \newacronym[type=\glsdefaulttype,user1={love itself}] {li}{LI}{lorem ipsum} \end{verbatim} +\begin{xtr} +If you use the \gls{glossaries-extra} extension package, then +\ics{newacronym} is redefined to use \ics*{newabbreviation} +with the \xtrgloskey{category} key set to \texttt{acronym} (rather +than the default \texttt{abbreviation}). This means that you need to +set the abbreviation style for the \texttt{acronym} category. For +example: +\begin{verbatim} +\setabbreviationstyle[acronym]{long-short-user} +\end{verbatim} +\end{xtr} \item[example-glossaries-parent.tex] These are hierarchical entries where the child entries use the \gloskey{name} key. @@ -1986,6 +2274,9 @@ For example: \begin{verbatim} \newglossaryentry{scelerisque}{name={scelerisque}, description={at}} + +\newglossaryentry{vestibulum}{parent={scelerisque}, + description={eu, nulla}} \end{verbatim} \item[example-glossaries-cite.tex] These entries use the @@ -2010,22 +2301,52 @@ For example: \end{verbatim} \end{description} -The sample file \texttt{glossary-lipsum-examples.tex} in the +The sample file \mirrorsamplefile{glossary-lipsum-examples.tex} in the \texttt{doc\slash latex\slash glossaries\slash samples} directory -uses all these files. See also -\url{http://www.dickimaw-books.com/gallery/#glossaries}. -The \sty{glossaries-extra} package provides additional test files. +uses all these files. See also \gallerytopic{glossaries}. + +\glsxtrnote +The \gls{glossaries-extra} package provides the additional test +file: +\begin{description} +\item[example-glossaries-xr.tex] These entries use the \gloskey{see} +key provided by the base \styfmt{glossaries} package and also the +\xtrgloskey{alias} and \xtrgloskey{seealso} keys that require +\gls{glossaries-extra}. For example: +\begin{verbatim} +\newglossaryentry{alias-lorem}{name={alias-lorem}, + description={ipsum},alias={lorem}} + +\newglossaryentry{amet}{name={amet},description={consectetuer}, + see={dolor}} + +\newglossaryentry{arcu}{name={arcu},description={libero}, + seealso={placerat,vitae,curabitur}} +\end{verbatim} +\end{description} \section{Multi-Lingual Support} \label{sec:languages} +\begin{important} +The \styfmt{glossaries} package uses the \styfmt{tracklang} package +to determine the document languages. Unfortunately, because there +isn't a standard language identification framework provided with +\LaTeX, \styfmt{tracklang} isn't always able to detect the selected +languages either as a result of using an unknown interface or where +the interface doesn't provide a way of detecting the language. +See +\href{https://www.dickimaw-books.com/latex/tracklang/}{Localisation +with \texttt{tracklang.tex}} for further details. +\end{important} + As from version 1.17, the \styfmt{glossaries} package can be used with \gls{xindy} as well as \gls{makeindex}. If you are writing in a language that uses an \gls{exlatinalph} or \gls{nonlatinalph} it's best to use \opt3 (\gls*{xindy}) or \opt4 (\gls{bib2gls}) as \gls*{makeindex} (\opt2) is hard-coded for the non-extended -\gls{latinalph} and \opt1 can performed limited ASCII comparisons. +\gls{latinalph} and \opt1 can only perform limited ASCII comparisons. This means that with \optsor34 you are not restricted to the A, \ldots, Z letter groups. If you want to use \gls*{xindy}, remember @@ -2038,13 +2359,13 @@ to use the \pkgopt{xindy} package option. For example: \usepackage[xindy]{glossaries} \end{verbatim} If you want to use \gls*{bib2gls}, you need to use the -\pkgopt{record} option with \sty{glossaries-extra} and supply the -definitions in \texttt{.bib} files. (See the \gls{bib2gls} user +\pkgopt*{record} option with \gls{glossaries-extra} and supply the +definitions in \filetype{bib} files. (See the \gls{bib2gls} user manual for further details.) \begin{important} Note that although a~\gls{nonlatinchar}, such as \'e, looks like a plain -character in your \filetype{.tex} file, with standard \LaTeX\ it's actually a~macro and can therefore +character in your \filetype{tex} file, with standard \LaTeX\ it's actually a~macro and can therefore cause expansion problems. You may need to switch off the field expansions with \cs{glsnoexpandfields}. This issue doesn't occur with \XeLaTeX\ or Lua\LaTeX. @@ -2055,17 +2376,15 @@ character at the start of an entry name, you must place it in a group, or it will cause a problem for commands that convert the first letter to upper case (e.g.\ \ics{Gls}). For example: \begin{alltt} -\verb|\newglossaryentry}{elite}{name={{|\'e\verb|}lite},| -description=\verb|{select group or class}}| +\cs{newglossaryentry}\mgroup{elite}\mgroup{name=\mgroup{\mgroup{\'e}lite}, +description=\mgroup{select group or class}} \end{alltt} -(With newer versions of \sty{mfirstuc} and \sty{datatool-base} you -may be able to omit this grouping.) For further details, see the \qt{UTF-8} section in the \sty{mfirstuc} user manual. If you are using \gls{xindy} or \gls{bib2gls}, the application needs -to know the encoding of the \filetype{.tex} file. This information -is added to the \filetype{.aux} file and can be picked up by +to know the encoding of the \filetype{tex} file. This information +is added to the \filetype{aux} file and can be picked up by \gls{makeglossaries} and \gls{bib2gls}. If you use \gls{xindy} explicitly instead of via \gls*{makeglossaries}, you may need to specify the encoding using the \xdyopt{C} @@ -2073,7 +2392,8 @@ option. Read the \gls*{xindy} manual for further details of this option. As from v4.24, if you are writing in German (for example, using the \sty{ngerman} -package\footnote{deprecated, use \styfmt{babel} instead} or \sty{babel} with the \pkgopt{ngerman} package option), +package\footnote{deprecated, use \styfmt{babel} instead} or +\sty{babel} with the \pkgoptfmt{ngerman} package option), and you want to use \gls{makeindex}['s] \mkidxopt{g} option, you'll need to change \gls{makeindex}['s] quote character using: \begin{definition}[\DescribeMacro\GlsSetQuote] @@ -2126,8 +2446,8 @@ in entry definitions. For example: \end{verbatim} The \sty{ngerman} package has the shorthands on in the preamble, so -they can be used if \cs{GlsSetQuote} has changed the \gls{makeindex} -quote character. Example: +they can be used in definitions if \cs{GlsSetQuote} has been used to +change the \gls{makeindex} quote character. Example: \begin{verbatim} \documentclass{article} @@ -2156,7 +2476,7 @@ The fixed names are produced using the commands listed in package such as \sty{babel} or \sty{polyglossia} that uses caption hooks, you can just redefine these commands as appropriate. If you are using \sty{babel} or \sty{polyglossia}, you need to use their -caption hooks to change the defaults. See \urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing +caption hooks to change the defaults. See \href{https://texfaq.org/FAQ-latexwords}{changing the words babel uses} or read the \sty{babel} or \sty{polyglossia} documentation. If you have loaded \sty{babel}, then \sty{glossaries} will attempt to load \sty{translator}, unless you have used the @@ -2239,7 +2559,9 @@ Examples of use: \usepackage{babel} \usepackage[translate=babel]{glossaries} \end{verbatim} -(\sty{translator} isn't loaded). +(\sty{translator} isn't loaded). The \gls{glossaries-extra} package +has \pkgopt[babel]{translate} as the default if \sty{babel} has been +loaded. \item Using \sty{polyglossia}: \begin{verbatim} @@ -2254,7 +2576,7 @@ Examples of use: Due to the varied nature of glossaries, it's likely that the predefined translations may not be appropriate. If you are using the \sty{babel} package and the \styfmt{glossaries} package option \pkgopt[babel]{translate}, you need to be familiar with the advice given in -\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing +\href{https://texfaq.org/FAQ-latexwords}{changing the words babel uses}. If you are using the \sty{translator} package, then you can provide your own dictionary with the necessary modifications (using \cs{deftranslation}) and load it using @@ -2326,8 +2648,8 @@ to create a new language module, you should first read the \sty{tracklang} documentation. To create a new language module, you need to at least create two -files: \texttt{glossaries-}\meta{lang}\texttt{.ldf} and -\texttt{glossaries-dictionary-}\meta{Lang}\texttt{.dict} where +files called: \texttt{glossaries\dhyphen}\meta{lang}\texttt{.}\filetype{ldf} and +\texttt{glossaries-dictionary-}\meta{Lang}\texttt{.}\filetype{dict} where \meta{lang} is the root language name (for example, \texttt{english}) and \meta{Lang} is the language name used by \sty{translator} (for example, \texttt{English}). @@ -2348,7 +2670,7 @@ Here's an example of \texttt{glossaries-dictionary-English.dict}: You can use this as a template for your dictionary file. Change \texttt{English} to the \sty{translator} name for your language (so that it matches the file name -\texttt{glossaries-dictionary-}\meta{Lang}\texttt{.dict}) +\texttt{glossaries\dhyphen dictionary\dhyphen }\meta{Lang}\texttt{.dict}) and, for each \cs{providetranslation}, change the second argument to the appropriate translation. @@ -2419,21 +2741,22 @@ definition of \cs{glossariescaptions}\meta{lang}, replace the English text (such as \qt{Glossaries}) with the appropriate translation. +\importantpar \label{pluralsuffix}% -\textbf{Note:} the suffixes used to generate the plural forms when -the plural hasn't been specified are given by -\cs{glspluralsuffix} (for general entries) and -\cs{glsupacrpluralsuffix} for acronyms where the suffix needs to be -set using \cs{glstextup} to counteract the effects of \cs{textsc} -and \cs{glsacrpluralsuffix} for other acronym styles. There's no -guarantee when these commands will be expanded. They may be expanded -on definition or they may be expanded on use, depending on the -\styfmt{glossaries} configuration. +The suffixes used to generate the plural forms when the plural +hasn't been specified are given by \cs{glspluralsuffix} (for general +entries). For abbreviations defined with \cs{newacronym}, +\cs{glsupacrpluralsuffix} is used for acronyms where the suffix +needs to be set using \cs{glstextup} to counteract the effects of +\cs{textsc} and \cs{glsacrpluralsuffix} for other acronym styles. +There's no guarantee when these commands will be expanded. They may +be expanded on definition or they may be expanded on use, depending +on the \styfmt{glossaries} configuration. \begin{important} Therefore these plural suffix command definitions aren't included in the caption mechanism as that's typically not switched on -until the start of the document. \textbf{This means that the suffix in +until the start of the document. \strong{This means that the suffix in effect will be for the last loaded language that redefined these commands.} It's best to initialise these commands to the most common suffix required in your document and use the \gloskey{plural}, @@ -2517,8 +2840,9 @@ The \texttt{glossaries-irish.ldf} file provides this as follows: your root language label and \texttt{Irish} with the \sty{translator} dictionary label.) -There are now two extra files: \texttt{glossaries-irish-noenc.ldf} -and \texttt{glossaries-irish-utf8.ldf}. +There are now two extra files: \nolinkurl{glossaries-irish-noenc.ldf} +(no encoding information) +and \nolinkurl{glossaries-irish-utf8.ldf} (UTF-8). These both define \cs{glossariescaptionsirish} but the \texttt{*-noenc.ldf} uses \LaTeX\ accent commands: @@ -2560,14 +2884,18 @@ the appropriate UTF-8 characters. This section is only applicable if you have chosen \optsor23. You can ignore this section if you have chosen any of the other options. If you want to alphabetically sort your entries always remember to use the -\gloskey{sort} key if the \gloskey{name} contains any \LaTeX\ commands. +\gloskey{sort} key if the \gloskey{name} contains any \LaTeX\ +commands (except if you're using \gls{bib2gls}). \end{important} If this section seriously confuses you, and you can't work out how to run external tools like \gls{makeglossaries} or \gls{makeindex}, you can try using the \pkgopt{automake} package option, described in \sectionref{sec:pkgopts-sort}, but you will need \TeX's shell escape -enabled. +enabled. See also +\href{https://www.dickimaw-books.com/latex/buildglossaries/}{Incorporating +makeglossaries or makeglossaries-lite or bib2gls into the document +build}. In order to generate a sorted glossary with compact \glspl{numberlist}, it is necessary to use an external @@ -2575,14 +2903,14 @@ In order to generate a sorted glossary with compact \opt1, which uses \TeX\ to do the sorting or \opt5, which doesn't perform any sorting). It is this application that creates the file containing the code required to typeset the -glossary. \textbf{If this step is omitted, the glossaries will not +glossary. \strong{If this step is omitted, the glossaries will not appear in your document.} The two \glspl*{indexingapp} that are most commonly used with \LaTeX\ are \gls{makeindex} and \gls{xindy}. As from version 1.17, the \styfmt{glossaries} package can be used with either of these applications. Previous versions were designed to be -used with \gls*{makeindex} only. With the \sty{glossaries-extra} package, you +used with \gls*{makeindex} only. With the \gls{glossaries-extra} package, you can also use \gls{bib2gls} as the indexing application. (See -the \sty{glossaries-extra} and \gls{bib2gls} user manuals for +the \gls{glossaries-extra} and \gls{bib2gls} user manuals for further details.) Note that \gls*{xindy} and \gls*{bib2gls} have much better multi-lingual support than \gls*{makeindex}, so \gls*{xindy} or \gls*{bib2gls} are recommended if you're not writing in English. @@ -2639,8 +2967,8 @@ file and see if you can work it out from the \gls*{makeindex} or problem.\footnote{Added to version \gls{makeglossaries} 2.18.} This correction is only provided by \gls{makeglossaries} when \gls{makeindex} is used since \gls{xindy} uses the order of the -attributes list to determine which format should take precedence. -(See \cs{GlsAddXdyAttribute} in \sectionref{sec:xindyloc}.) +\ixindyattrs attributes list to determine which format should take precedence. +(see \sectionref{sec:xindyloc}.) \end{itemize} @@ -2697,16 +3025,17 @@ of \gls{makeglossaries}, \gls{makeindex} or \gls{xindy}. For example, if the document is called \texttt{myDoc.tex}, then you must do: \begin{prompt} -latex myDoc +pdflatex myDoc makeglossaries myDoc -latex myDoc +pdflatex myDoc makeglossaries myDoc -latex myDoc +pdflatex myDoc \end{prompt} -(Note that if you use \gls{glossaries-extra}, this will be done -automatically for you if the \pkgoptfmt{indexcrossrefs} feature is -enabled. See the \gls*{glossaries-extra} user guide for further -details.) +(In the case of \opt4, \gls{bib2gls} will scan the description for +instances of commands like \cs{gls} to ensure they are selected but +an extra \gls{bib2gls} call is required to ensure the locations are +included, if locations lists are required. See the +and \gls{bib2gls} manual for further details.) Likewise, an additional \gls{makeglossaries} and \LaTeX\ run may be required if the document pages shift with re-runs. For @@ -2729,7 +3058,7 @@ makeglossaries or makeglossaries-lite or bib2gls into the document build}. If any problems occur, remember to check the transcript files -(e.g.\ \filetype{.glg} or \filetype{.alg}) for messages. +(e.g.\ \filetype{glg} or \filetype{alg}) for messages. \begin{table}[htbp] \caption[Commands and package options that have no effect when @@ -2758,16 +3087,16 @@ use \xdyopt{C} \meta{code} \label{sec:makeglossariesapp} The \gls{makeglossaries} script picks up the relevant information -from the auxiliary (\filetype{.aux}) file and will either call +from the auxiliary (\filetype{aux}) file and will either call \gls{xindy} or \gls{makeindex}, depending on the supplied information. Therefore, you only need to pass the document's name without the extension to \gls*{makeglossaries}. For example, if your document is called \texttt{myDoc.tex}, type the following in your terminal: \begin{prompt} -latex myDoc +pdflatex myDoc makeglossaries myDoc -latex myDoc +pdflatex myDoc \end{prompt} You may need to explicitly load \gls{makeglossaries} into Perl: \begin{prompt} @@ -2798,8 +3127,8 @@ that doesn't support this form of redirection, then you can use the the fallback method without attempting the redirection. Without this redirection, the \mkglsopt{q} (quiet) switch doesn't work as well. -You can specify in which directory the \filetype{.aux}, -\filetype{.glo} etc files are located using the \texttt{-d} switch. +You can specify in which directory the \filetype{aux}, +\filetype{glo} etc files are located using the \texttt{-d} switch. For example: \begin{prompt} pdflatex -output-directory myTmpDir myDoc @@ -2836,17 +3165,12 @@ attempt to correct the problem by removing duplicate locations and retrying. There's no similar check for \gls{xindy} as \gls*{xindy} won't produce any warning and will simply discard duplicates. -The \gls{makeglossaries} script contains POD (Plain Old -Documentation). If you want, you can create a man page for -\gls*{makeglossaries} using \app{pod2man} and move the -resulting file onto the man path. Alternatively do -\texttt{makeglossaries -{}-help} for a list of all options or -\texttt{makeglossaries -{}-version} for the version number. +For a complete list of options do \texttt{makeglossaries -{}-help}. \begin{important} When upgrading the \styfmt{glossaries} package, make sure you also upgrade your version of \gls{makeglossaries}. The current version is -4.44. +4.45. \end{important} \subsection{Using the makeglossaries-lite Lua Script} @@ -2865,7 +3189,7 @@ here. (In particular the \mkglsopt{d} option.) \begin{important} Note that \TeX~Live on Unix-like systems creates a symbolic link called \texttt{makeglossaries-lite} (without the -\texttt{.lua} extension) to the actual +\filetype{lua} extension) to the actual \texttt{makeglossaries-lite.lua} script, so you may not need to supply the extension. \end{important} @@ -2881,9 +3205,9 @@ or makeglossaries-lite myDoc \end{prompt} -\emph{Some} of the options available with \gls{makeglossaries} are -also available with \gls{makeglossaries-lite.lua}. For a complete list of -available options, do +\emph{Some} of the options available with the Perl +\gls{makeglossaries} script are also available with the Lua \gls{makeglossaries-lite.lua} +script. For a complete list of available options, do \begin{prompt} makeglossaries-lite.lua -{}-help \end{prompt} @@ -2918,9 +3242,9 @@ xindy -L \meta{language} -C \meta{encoding} -I xindy -M \meta{style} -t \meta{ba \end{prompt} where \meta{language} is the required language name, \meta{encoding} is the encoding, \meta{base} is the name of the document without the -\filetype{.tex} extension and \meta{style} is the name of the -\gls{xindy} style file without the \filetype{.xdy} extension. -The default name for this style file is \meta{base}\filetype{.xdy} +\filetype{tex} extension and \meta{style} is the name of the +\gls{xindy} style file without the \filetype{xdy} extension. +The default name for this style file is \meta{base}\filetype{xdy} but can be changed via \ics{setStyleFile}\marg{style}. You may need to specify the full path name depending on the current working directory. If any of the file names contain spaces, you must delimit @@ -2936,8 +3260,8 @@ xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo Note that this just creates the main glossary. You need to do the same for each of the other glossaries (including the list of acronyms if you have used the \pkgopt{acronym} -package option), substituting \filetype{.glg}, \filetype{.gls} -and \filetype{.glo} with the relevant extensions. For example, +package option), substituting \filetype{glg}, \filetype{gls} +and \filetype{glo} with the relevant extensions. For example, if you have used the \pkgopt{acronym} package option, then you would need to do: \begin{prompt} @@ -2971,9 +3295,9 @@ your terminal: makeindex -s \meta{style}.ist -t \meta{base}.glg -o \meta{base}.gls \meta{base}.glo \end{prompt} where \meta{base} is the name of your document without the -\filetype{.tex} extension and \meta{style}\filetype{.ist} is the +\filetype{tex} extension and \meta{style}\filetype{ist} is the name of the \gls{makeindex} style file. By default, this is -\meta{base}\filetype{.ist}, but may be changed via +\meta{base}\filetype{ist}, but may be changed via \ics{setStyleFile}\marg{style}. Note that there are other options, such as \mkidxopt{l} (letter ordering). See the \gls*{makeindex} manual for further details. @@ -2987,7 +3311,7 @@ Note that this only creates the main glossary. If you have additional glossaries (for example, if you have used the \pkgopt{acronym} package option) then you must call \gls{makeindex} for each glossary, substituting -\filetype{.glg}, \filetype{.gls} and \filetype{.glo} with the +\filetype{glg}, \filetype{gls} and \filetype{glo} with the relevant extensions. For example, if you have used the \pkgopt{acronym} package option, then you need to type the following in your terminal: @@ -3008,18 +3332,19 @@ you use \gls*{makeindex} explicitly instead of using \gls{makeglossaries}. These are listed in \tableref{tab:makeglossariesCmds}. - -\subsection{Note to Front-End and Script Developers} +\section{Note to Front-End and Script Developers} \label{sec:notedev} -The information needed to determine whether to use \gls{xindy} -or \gls{makeindex} and the information needed to call those -applications is stored in the auxiliary file. This information can -be gathered by a front-end, editor or script to make the glossaries -where appropriate. This section describes how the information is -stored in the auxiliary file. +The information needed to determine whether to use \gls{xindy}, +\gls{makeindex} or \gls{bib2gls} is stored in the \filetype{aux} +file. This information can be gathered by a front-end, editor or +script to make the glossaries where appropriate. This section +describes how the information is stored in the auxiliary file. -The file extensions used by each defined glossary are given by +\subsection{MakeIndex and Xindy} +\label{sec:notedev.makeindex.xindy} + +The file extensions used by each defined (but not ignored) glossary are given by \begin{definition}[\DescribeMacro{\@newglossary}] \cs{@newglossary}\marg{label}\marg{log}\marg{out-ext}\marg{in-ext} \end{definition} @@ -3029,24 +3354,45 @@ where \meta{in-ext} is the extension of the extension of the \emph{\gls*{indexingapp}['s]} output file (the input file from the \styfmt{glossaries} package's point of view) and \meta{log} is the extension of the \gls*{indexingapp}['s] transcript -file. The label for the glossary is also given for information -purposes only, but is not required by the \glspl*{indexingapp}. For +file. The label for the glossary is also given. This isn't required +with \gls{makeindex}, but with \gls{xindy} it's needed to pick up +the associated language and encoding (see below). For example, the information for the default main glossary is written as: \begin{verbatim} \@newglossary{main}{glg}{gls}{glo} \end{verbatim} +If \gls{glossaries-extra}['s] hybrid method has been used (with +\cs{makeglossaries}\oarg{sub-list}), then the sub-list +of glossaries that need to be processed will be identified with: +\begin{alltt} +\ics*{glsxtr@makeglossaries}\marg{list} +\end{alltt} The \gls{indexingapp}['s] style file is specified by \begin{definition}[\DescribeMacro{\@istfilename}] \cs{@istfilename}\marg{filename} \end{definition} The file extension indicates whether to use \gls{makeindex} -(\filetype{.ist}) or \gls{xindy} (\filetype{.xdy}). Note that +(\filetype{ist}) or \gls{xindy} (\filetype{xdy}). Note that the glossary information is formatted differently depending on which \gls*{indexingapp} is supposed to be used, so it's important to call the correct one. +For example, with \app{arara} you can easily determine whether to run \gls{makeglossaries}: +\begin{alltt} +\% arara: makeglossaries if found("aux", "@istfilename") +\end{alltt} +It's more complicated if you want to explicitly run \gls{makeindex} +or \gls{xindy} + +\begin{important} +Note that if you choose to explicitly call \gls{makeindex} or +\gls{xindy} then the user will miss out on the diagnostic +information and the encap-clash fix that \gls{makeglossaries} also +provides. +\end{important} + Word or letter ordering is specified by: \begin{definition}[\DescribeMacro{\@glsorder}] \cs{@glsorder}\marg{order} @@ -3064,15 +3410,76 @@ the root language (e.g.\ \texttt{english}) and \meta{code} is the encoding (e.g.\ \texttt{utf8}). These commands are omitted if \gls{makeindex} should be used. -If \opt1 has been used, the \texttt{.aux} file will contain -\begin{definition} +If \opt1 has been used, the \filetype{aux} file will contain +\begin{definition}[\DescribeMacro\@gls@reference] \cs{@gls@reference}\marg{type}\marg{label}\marg{location} \end{definition} -for every time an entry has been referenced. If \opt4 has been -used, the \texttt{.aux} file will contain one or more instances of -\begin{definition} -\cs{glsxtr@resource}\marg{options}\marg{basename} -\end{definition} +for every time an entry has been referenced. + +\subsection{Entry Labels} +\label{sec:notedev.labels} + +If you need to gather labels for auto-completion, the +\pkgopt{writeglslabels} package option will create a file containing +the labels of all defined entries (regardless of whether or not the +entry has been used in the document). The \gls{glossaries-extra} +package also provides \pkgopt+{atom}{docdef}, which will create the +\filetype{glsdefs} file but will act like \pkgopt+{restricted}{docdef}. + +\subsection{Bib2Gls} +\label{sec:notedev.bib2gls} + +\bibglsnote +If \opt4 has been used, the \filetype{aux} file will contain one or more instances of +\begin{alltt} +\ics*{glsxtr@resource}\marg{options}\marg{basename} +\end{alltt} +where \meta{basename} is the basename of the \filetype{glstex} file +that needs to be created by \gls{bib2gls}. If \texttt{src\dequals\marg{bib +list}} isn't present in \meta{options} then \meta{basename} also +indicates the name of the associated \filetype{bib} file. + +For example, with \app{arara} you can easily determine whether or +not to run \gls{bib2gls}: +\begin{alltt} +\% arara: bib2gls if found("aux", "glsxtr@resource") +\end{alltt} +(It gets more complicated if both \ics*{glsxtr@resource} and +\cs{@istfilename} are present as that indicates the hybrid +\pkgopt+{alsoindex}{record} option.) + +Remember that with \gls{bib2gls}, the entries will never be defined +on the first \LaTeX\ call (because their definitions are contained +in the \filetype{glstex} file created by \gls{bib2gls}). You can +also pick up labels from the records in \filetype{aux} file, which +will be in the form: +\begin{alltt} +\ics*{glsxtr@record}\marg{label}\marg{h-prefix}\marg{counter}\marg{format}\marg{loc} +\end{alltt} +or (with \pkgopt+{nameref}{record}) +\begin{alltt} +\ics*{glsxtr@record@nameref}\marg{label}\marg{href prefix}\marg{counter}\marg{format}\marg{location}\marg{title}\marg{href anchor}\marg{href value} +\end{alltt} +or (with \cs{glssee}) +\begin{alltt} +\ics*{glsxtr@recordsee}\marg{label}\marg{xr list} +\end{alltt} +You can also pick up the commands defined with +\ics*{glsxtrnewglslike}, which are added to the \filetype{aux} file +for \gls{bib2gls}['s] benefit: +\begin{alltt} +\ics*{@glsxtr@newglslike}\marg{label-prefix}\marg{cs} +\end{alltt} +If \ics*{GlsXtrSetAltModifier} is used, then the modifier is +identified with: +\begin{alltt} +\ics*{@glsxtr@altmodifier}\marg{character} +\end{alltt} +Label prefixes (for the \ics*{dgls} set of commands) are identified +with: +\begin{alltt} +\ics*{@glsxtr@prefixlabellist}\marg{list} +\end{alltt} \chapter{Package Options} \label{sec:pkgopts} @@ -3080,8 +3487,15 @@ used, the \texttt{.aux} file will contain one or more instances of This section describes the available \styfmt{glossaries} package options. You may omit the \texttt{=true} for boolean options. (For example, \pkgopt{acronym} is equivalent to \pkgopt[true]{acronym}). + +\begin{xtr} The \gls{glossaries-extra} package has additional options described -in the \gls*{glossaries-extra} manual. +in the \gls*{glossaries-extra} manual. The extension package also +has some different default settings to the base package. Those that +are available at the time of writing are included here. Future +versions of \gls{glossaries-extra} may have additional package +options or new values for existing settings that aren't listed here. +\end{xtr} \begin{important} Note that \meta{key}=\meta{value} package options can't be passed via the @@ -3095,63 +3509,90 @@ package. Options that aren't \meta{key}=\meta{value} (such as \section{General Options} \label{sec:pkgopts-general} -\begin{description} -\item[\pkgoptdef{nowarn}] This suppresses all warnings generated by +\pkgoptsec{nowarn} This suppresses all warnings generated by the \styfmt{glossaries} package. Don't use this option if you're new to using \styfmt{glossaries} as the warnings are designed to help detect common mistakes (such as forgetting to use \ics{makeglossaries}). -Note that the \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} will override this option. +Note that if you use \pkgopt{debug} with any value other than +\pkgoptfmt{false} it will override this option. -\item[\pkgoptdef{nolangwarn}] This suppresses the warning generated by +\pkgoptsec{nolangwarn} This suppresses the warning generated by a missing language module. -\item[\pkgoptdef{noredefwarn}] If you load \styfmt{glossaries} with +\pkgoptsec{noredefwarn} If you load \styfmt{glossaries} with a~class or another package that already defines glossary related commands, by default \styfmt{glossaries} will warn you that it's redefining those commands. If you are aware of the consequences of using \styfmt{glossaries} with that class or package and you don't want to be warned about it, use this option to suppress those warnings. Other warnings will still be issued unless you use the -\pkgopt{nowarn} option described above. - -\item[\pkgoptdef{debug}] Introduced in version 4.24. -The default setting is \pkgopt[false]{debug}. -This was a boolean option but as from v4.32 it now accepts the -values: \pkgoptfmt{false}, \pkgoptfmt{true} and -\pkgoptfmt{showtargets}. If no value is given, \pkgopt[true]{debug} is assumed. -Both \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} -switch on the debug mode (and will automatically -cancel the \pkgopt{nowarn} option). The \pkgopt[showtargets]{debug} -option will additionally use +\pkgopt{nowarn} option described above. (This option is +automatically switched on by \gls{glossaries-extra}.) + +\pkgoptsec[value]{debug} Introduced in version 4.24. The default +setting is \pkgopt[false]{debug}. The following values are +available: \pkgoptfmt{false}, \pkgoptfmt{true}, +\pkgoptfmt{showtargets} (v4.32+) and \pkgoptfmt{showaccsupp} +(v4.45+). If no value is given, \pkgopt[true]{debug} is assumed. + +\begin{xtr} +The \gls{glossaries-extra} package provides extra values +\pkgoptval*{showwrgloss}{debug}, that may be used to show where +the indexing is occurring, and \pkgoptval*{all}{debug}, which +switches on all debugging options. See the \gls{glossaries-extra} +manual for further details. +\end{xtr} + +All values other than \pkgopt[false]{debug} switch on the debug mode +(and will automatically cancel the \pkgopt{nowarn} option). The +\pkgopt[showtargets]{debug} option will additionally use: \begin{definition}[\DescribeMacro\glsshowtarget] \cs{glsshowtarget}\marg{target name} \end{definition} -to show the hypertarget or hyperlink name in the margin when +to show the hypertarget or hyperlink name when \cs{glsdohypertarget} is used by commands like \cs{glstarget} and when \cs{glsdohyperlink} is used by commands like \cs{gls}. -This puts the information in the margin using \ics{marginpar} unless -math mode or inner mode are detected, in which case it puts the -information in line enclosed by square brackets. The -\gls{glossaries-extra} package provides an additional setting that -may be used to show where the indexing is occurring. See the -\gls{glossaries-extra} manual for further details. +In math mode or inner mode, this puts the target name in square +brackets just before the link or anchor. In outer mode it uses: +\begin{definition}[\DescribeMacro\glsshowtargetouter] +\cs{glsshowtargetouter}\marg{label} +\end{definition} +which by default places the target name in the margin. The font is +given by: +\begin{definition}[\DescribeMacro\glsshowtargetfont] +\cs{glsshowtargetfont} +\end{definition} +The default definition is \verb|\ttfamily\small|. This command is +included in the definition of \cs{glsshowtargetouter}, so if you +want to redefine that command remember to include the font. For +example: +\begin{verbatim} +\renewcommand*{\glsshowtargetouter}[1]{% + {\glsshowtargetfont [#1]}} +\end{verbatim} + +Similarly, the \pkgopt[showaccsupp]{debug} will add the +accessibility support information using: +\begin{definition}[\DescribeMacro\glsshowaccsupp] +\cs{glsshowaccsupp}\marg{options}\marg{tag}\marg{replacement text} +\end{definition} +This internally uses \ics{glsshowtarget}. This option is provided +for use with \sty{glossaries-accsupp}. The purpose of the debug mode can be demonstrated with the following example document: -\begin{verbatim} -\documentclass{article} -\usepackage{glossaries} -\newglossaryentry{sample1}{name={sample1}, - description={example}} -\newglossaryentry{sample2}{name={sample2}, - description={example}} -\glsadd{sample2} -\makeglossaries -\begin{document} -\gls{sample1}. -\printglossaries -\end{document} -\end{verbatim} +\begin{alltt} +\cs{documentclass}\mgroup{article} +\cs{usepackage}\mgroup{glossaries} +\cs{newglossaryentry}\mgroup{sample1}\mgroup{name=\mgroup{sample1},description=\mgroup{example}} +\cs{newglossaryentry}\mgroup{sample2}\mgroup{name=\mgroup{sample2},description=\mgroup{example}} +\strong{\ics{glsadd}}\mgroup{sample2}\% <- does nothing here +\strong{\ics{makeglossaries}} +\cs{begin}\mgroup{document} +\cs{gls}\mgroup{sample1}. +\cs{printglossaries} +\cs{end}\mgroup{document} +\end{alltt} In this case, only the \texttt{sample1} entry has been indexed, even though \verb|\glsadd{sample2}| appears in the source code. This is because \verb|\glsadd{sample2}| has been used before the @@ -3159,19 +3600,23 @@ associated file is opened by \ics{makeglossaries}. Since the file isn't open yet, the information can't be written to it, which is why the \texttt{sample2} entry doesn't appear in the glossary. +Without \cs{makeglossaries} the indexing is suppressed with \optsand23 but, other +than that, commands like \cs{gls} behave as usual. + This situation doesn't cause any errors or warnings as it's perfectly legitimate for a user to want to use \styfmt{glossaries} to format the entries (e.g.\ abbreviation expansion) but not display -any lists of terms, abbreviations, symbols etc. -Without \cs{makeglossaries} the indexing is suppressed but, other -than that, commands like \cs{gls} behave as usual. It's also -possible that the user may want to temporarily comment out +any lists of terms, abbreviations, symbols etc (or the user may +prefer to use the unsorted \optsor56). +It's also possible that the user may want to temporarily comment out \cs{makeglossaries} in order to suppress the indexing while working -on a draft version to speed compilation. Therefore -\cs{makeglossaries} can't be used to enable \cs{newglossaryentry} -and \cs{glsadd}. They must be enabled by default. (It does, however, -enable the \gloskey{see} key as that's a more common problem. See -below.) +on a draft version to speed compilation, or the user may +prefer to use \optsor14 for indexing, which don't use \cs{makeglossaries}. + +Therefore \cs{makeglossaries} can't be used to enable +\cs{newglossaryentry} and commands like \cs{gls} and \cs{glsadd}. +These commands must be enabled by default. (It does, however, enable +the \gloskey{see} key as that's a more common problem. See below.) The debug mode, enabled with the \pkgopt{debug} option, \begin{verbatim} @@ -3191,99 +3636,28 @@ glossary but you're sure you used commands like \cs{glsadd} or \cs{glsaddall}, try switching on the \pkgopt{debug} option and see if any information has been written to the log file. -\item[\pkgoptdef{seenoindex}] Introduced in version 4.24, this option -may take one of three values: \pkgoptfmt{error}, \pkgoptfmt{warn} or -\pkgoptfmt{ignore}. The \gloskey{see} key automatically indexes the -cross-referenced entry using \cs{glsadd}. This means that it suffers -from the same problem as the above. If used before the relevant -glossary file has been opened, the indexing can't be performed. -Since this is easy to miss, the \styfmt{glossaries} package by -default issues an error message if the \gloskey{see} key is used -before \cs{makeglossaries}. This option allows you to change the -error into just a warning (\pkgopt[warn]{seenoindex}) or -ignore it (\pkgopt[ignore]{seenoindex}) if, for example, you want -to temporarily comment out \cs{makeglossaries} to speed up the -compilation of a draft document by omitting the indexing. - -\item[\pkgoptdef{nomain}] This suppresses the creation of the main -glossary and associated \texttt{.glo} file, if unrequired. Note that -if you use this option, you must create another glossary in which to -put all your entries (either via the \pkgopt{acronym} (or -\pkgopt{acronyms}) package option described in -\sectionref{sec:pkgopts-acronym} or via the \pkgopt{symbols}, -\pkgopt{numbers} or \pkgopt{index} options described in -\sectionref{sec:pkgopts-other} or via \ics{newglossary} described in -\sectionref{sec:newglossary}). - -\begin{important} -If you don't use the main glossary and you don't use this option, -\gls{makeglossaries} will produce a warning. -\end{important} -\begin{alltt} -Warning: File '\emph{filename}.glo' is empty. -Have you used any entries defined in glossary -'main'? -Remember to use package option 'nomain' if -you don't want to use the main glossary. -\end{alltt} -If you did actually want to use the main glossary and you see this -warning, check that you have referenced the entries in that glossary -via commands such as \ics{gls}. - -\item[\pkgoptdef{sanitizesort}] This is a boolean option that -determines whether or not to \gls{sanitize} the sort value when -writing to the external glossary file. For example, suppose you -define an entry as follows: -\begin{verbatim} -\newglossaryentry{hash}{name={\#},sort={#}, - description={hash symbol}} -\end{verbatim} -The sort value (\verb|#|) must be sanitized before writing it to the -glossary file, otherwise \LaTeX\ will try to interpret it as a -parameter reference. If, on the other hand, you want the sort value -expanded, you need to switch off the sanitization. For example, -suppose you do: -\begin{verbatim} -\newcommand{\mysortvalue}{AAA} -\newglossaryentry{sample}{% - name={sample}, - sort={\mysortvalue}, - description={an example}} -\end{verbatim} -and you actually want \cs{mysortvalue} expanded, so that the entry -is sorted according to \texttt{AAA}, then use the package option -\pkgopt[false]{sanitizesort}. - -The default for \optsand23 is \pkgopt[true]{sanitizesort}, and the -default for \opt1 is \pkgopt[false]{sanitizesort}. - -\item[\pkgoptdef{esclocations}] This is a boolean option. (The default -is \pkgopt[true]{esclocations}, but \ics{makenoidxglossaries} -changes it to \pkgopt[false]{esclocations}.) Both \gls{makeindex} and \gls{xindy} -are fussy about the location formats (\gls{makeindex} more so than -\gls{xindy}) so the \styfmt{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 \pkgopt[false]{esclocations} to avoid the complex escaping -of location values. (See \ifpdf section~\ref*{sec:wrgloss}\fi \qt{Writing information to associated files} in the documented -code for further details.) - -\item[\pkgoptdef{savewrites}] This is a boolean option to minimise the +\pkgoptsec[boolean]{savewrites} This is a boolean option to minimise the number of write registers used by the \styfmt{glossaries} package. -(Default is \pkgopt[false]{savewrites}.) 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 \pkgopt{savewrites} 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. +The default is \pkgopt[false]{savewrites}. With \optsand23, one +write register is required per (non-ignored) glossary and one for +the style file. + +With all options except \optsand14, another write register is +required if the \filetype{docdefs} file is needed to save document +definitions. With both \optsand14, no write registers are required +(document definitions aren't permitted and indexing information is +written to the \filetype{aux} file). If you really need document +definitions but you want to minimise the number of write registers +then consider using \pkgopt+{restricted}{docdef} with +\gls{glossaries-extra}. + +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 \pkgopt{savewrites} 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. \begin{important} This option can significantly slow document compilation and may @@ -3293,11 +3667,17 @@ output routine. As an alternative, you can use the \sty{scrwfile} package (part of the KOMA-Script bundle) and not use this option. \end{important} -You can also reduce the number of write registers by using -\optsor14 or by ensuring you define all your glossary entries in the -preamble. - -\begin{important} +By way of comparison, \nolinkurl{sample-multi2.tex} +provided with \gls{bib2gls} has a total of 15 glossaries. With +\optsor23, this would require 46 associated files and 16 +write registers.\footnote{These figures don't include standard files +and registers provided by the kernel or \sty{hyperref}, such as +\filetypefmt{aux} and \filetypefmt{out}.} With +\gls{bib2gls}, no write registers are required and there are only 10 +associated files for that particular document (9 resource files and +1 transcript file). + +\importantpar[-2][-1ex] If you want to use \TeX's \ics{write18} mechanism to call \gls{makeindex} or \gls{xindy} from your document and use \pkgopt{savewrites}, you must create the external files with @@ -3310,13 +3690,14 @@ document to avoid rewriting the files. For example: -t \jobname.glg -o \jobname.gls \jobname} \let\glswritefiles\relax \end{verbatim} -\end{important} + +\noindent In general, this package option is best avoided. -\item[\pkgoptdef{translate}] This can take the following values: +\pkgoptsec[value]{translate} This can take the following values: \begin{description} - \item[{\pkgopt[true]{translate}}] If \sty{babel} has been loaded + \item[{\pkgoptval{true}{translate}}] If \sty{babel} has been loaded and the \sty{translator} package is installed, \sty{translator} will be loaded and the translations will be provided by the \sty{translator} package interface. You can modify the @@ -3328,12 +3709,12 @@ In general, this package option is best avoided. \sty{polyglossia} has been loaded, \sty{glossaries-polyglossia} will be loaded. - \item[{\pkgopt[false]{translate}}] Don't provide translations, even + \item[{\pkgoptval{false}{translate}}] Don't provide translations, even if \sty{babel} or \sty{polyglossia} has been loaded. (Note that \sty{babel} provides the command \ics{glossaryname} so that will still be translated if you have loaded \sty{babel}.) - \item[{\pkgopt[babel]{translate}}] Don't load the \sty{translator} + \item[{\pkgoptval{babel}{translate}}] Don't load the \sty{translator} package. Instead load \sty{glossaries-babel}. \begin{important} @@ -3351,32 +3732,19 @@ specified, \pkgopt[true]{translate} is assumed if \sty{babel}, \sty{polyglossia} or \sty{translator} have been loaded. Otherwise \pkgopt[false]{translate} is assumed. +\begin{xtr} +With \gls{glossaries-extra}, if \sty{babel} is detected then +\pkgopt[babel]{translate} is automatically passed to the base +\sty{glossaries} package. +\end{xtr} + See \sectionref{sec:fixednames} for further details. -\item[\pkgoptdef{notranslate}] This is equivalent to +\pkgoptsec{notranslate} This is equivalent to \pkgopt[false]{translate} and may be passed via the document class options. -\item[\pkgoptdef{nohypertypes}] Use this option if you have multiple -glossaries and you want to suppress the entry hyperlinks for a -particular glossary or glossaries. The value of this option should -be a comma-separated list of glossary types where \ics{gls} etc -shouldn't have hyperlinks by default. Make sure you enclose the -value in braces if it contains any commas. Example: -\begin{verbatim} -\usepackage[acronym,nohypertypes={acronym,notation}] - {glossaries} -\newglossary[nlg]{notation}{not}{ntn}{Notation} -\end{verbatim} -The values must be fully expanded, so \textbf{don't} try -\texttt{nohypertypes\discretionary{}{}{}=\ics{acronymtype}}. You may also use -\begin{definition} -\ics{GlsDeclareNoHyperList}\marg{list} -\end{definition} -instead or additionally. -See \sectionref{sec:glslink} for further details. - -\item[\pkgoptdef{hyperfirst}] This is a boolean option that specifies +\pkgoptsec[boolean]{hyperfirst} This is a boolean option that specifies whether each term has a hyperlink on \firstuse. The default is \pkgopt[true]{hyperfirst} (terms on \gls{firstuse} have a hyperlink, unless explicitly suppressed using starred versions of commands @@ -3435,63 +3803,67 @@ Note that this hook isn't used by the commands that don't check the \ics{glslinkpostsetkeys}, which is used by both the \glslike\ and \glstextlike\ commands.) -\item[\pkgoptdef{indexonlyfirst}] This is a boolean option that specifies -whether to only add information to the external glossary file on -\gls{firstuse}. The default is \pkgopt[false]{indexonlyfirst}, -which will add a line to the file every time one of the -\glslike\ or \glstextlike\ commands are used. Note that \ics{glsadd} -will always add information to the external glossary -file\footnote{bug fix in v4.16 has corrected the code to ensure -this.}\ (since that's the purpose of that command). +The \gls{glossaries-extra} package provides a method of disabling +the \gls{firstuse} hyperlink according to the entry's associated +category. For example, if you only to switch off the \gls{firstuse} +hyperlink for abbreviations and acronyms then you simply need to set +the \attr{nohyperfirst} attribute for the \texttt{abbreviation} +and \texttt{acronym} categories. (Instead of using the +\pkgopt{nohyperfirst} package option.) See the +\gls{glossaries-extra} manual for further details. -You can customise this by redefining -\begin{definition}[\DescribeMacro\glswriteentry] -\cs{glswriteentry}\marg{label}\marg{wr-code} -\end{definition} -where \meta{label} is the entry's label and \meta{wr-code} is the -code that writes the entry's information to the external file. -The default definition of \cs{glswriteentry} is: -\begin{verbatim} -\newcommand*{\glswriteentry}[2]{% - \ifglsindexonlyfirst - \ifglsused{#1}{}{#2}% - \else - #2% - \fi -} -\end{verbatim} -This checks the \pkgopt{indexonlyfirst} package option (using -\cs{ifglsindexonlyfirst}) and does \meta{wr-code} if this is -\pkgoptfmt{false} otherwise it only does \meta{wr-code} of the entry -hasn't been used. +\pkgoptsec{writeglslabels} This is a valueless option that +will create a file called \cs{jobname}\texttt{.}\filetype{glslabels} at the end +of the document. This file simply contains a list of all defined +entry labels (including those in any ignored glossaries). It's +provided for the benefit of text editors that need to know labels +for \Index{auto-completion}. (See also \gls{glossaries-extra}['s] +\pkgopt+{atom}{docdef} package option.) -For example, suppose you only want to index the first use for -entries in the \texttt{acronym} glossary and not in the -\texttt{main} (or any other) glossary: -\begin{verbatim} -\renewcommand*{\glswriteentry}[2]{% - \ifthenelse{\equal{\glsentrytype{#1}}{acronym}} - {\ifglsused{#1}{}{#2}}% - {#2}% -} -\end{verbatim} -Here I've used \cs{ifthenelse} to ensure the arguments of -\cs{equal} are fully expanded before the comparison is made. +\begin{bib2gls} +Note that with \gls{bib2gls} the file will only contain the entries +that \gls{bib2gls} has selected from the \filetype{bib} files. +\end{bib2gls} -\item[\pkgoptdef{savenumberlist}] This is a boolean option that -specifies whether or not to gather and store the \gls{numberlist} -for each entry. The default is \pkgopt[false]{savenumberlist}. (See -\ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} in -\sectionref{sec:glsnolink}.) This is always true if you -use \opt1. +\xtrpkgoptsec[value]{undefaction} + +The value may be one of: +\begin{description} + \item[\pkgoptfmt{error}] generate an error if a referenced entry is + undefined (default, and only available setting with just + \styfmt{glossaries}); + \item[\pkgoptfmt{warn}] only warn if a referenced entry is + undefined (automatically activated with \opt4). +\end{description} +\xtrpkgoptsec[value]{docdef} + +This option governs the use of \cs{newglossaryentry}. Available +values: +\begin{description} +\item[\pkgoptfmt{false}] \cs{newglossaryentry} is not permitted in +the \env{document} environment (default with \gls{glossaries-extra} +and for \opt1 with just the base \styfmt{glossaries} package); + +\item[\pkgoptfmt{restricted}] \cs{newglossaryentry} is only permitted in +the \env{document} environment if it occurs before +\cs{printglossary} (not available for some indexing options); + +\item[\pkgoptfmt{atom}] as \pkgoptfmt{restricted} but creates the +\filetype{docdefs} file for use by \app{atom} (without the +limitations of \pkgopt+{true}{docdef}); + +\item[\pkgoptfmt{true}] \cs{newglossaryentry} is permitted in the +\env{document} environment where it would normally be permitted by +the base \styfmt{glossaries} package. This will create the +\filetype{docdefs} file if \cs{newglossaryentry} is found in the +\env{document} environment. \end{description} \section{Sectioning, Headings and TOC Options} \label{sec:pkgopts-sec} -\begin{description} -\item[\pkgoptdef{toc}] Add the glossaries to the table of contents. +\pkgoptsec[boolean]{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 \begin{definition}[\DescribeMacro{\glstoctrue}] @@ -3501,8 +3873,12 @@ and \begin{definition}[\DescribeMacro{\glstocfalse}] \cs{glstocfalse} \end{definition} +The default value is \pkgopt[false]{toc} for the base +\styfmt{glossaries} package and \pkgopt[true]{toc} for +\gls{glossaries-extra}. -\item[\pkgoptdef{numberline}] When used with \pkgopt{toc}, this will +\pkgoptsec[boolean]{numberline} When used with the above +\pkgopt[true]{toc} option, this will add \ics{numberline}\verb|{}| in the final argument of \ics{addcontentsline}. This will align the table of contents entry with the numbered section titles. Note that this option has no @@ -3510,16 +3886,22 @@ effect if the \pkgopt{toc} option is omitted. If \pkgopt{toc} is used without \pkgopt{numberline}, the title will be aligned with the section numbers rather than the section titles. -\item[\pkgoptdef{section}] This is a \meta{key}=\meta{value} option. Its -value should be the name of a sectional unit (e.g.\ chapter). -This will make the glossaries appear in the named sectional unit, -otherwise each glossary will appear in a chapter, if chapters -exist, otherwise in a section. Unnumbered sectional units will be used -by default. Example: +\pkgoptsec[value]{section} + +This option indicates the sectional unit to use for the glossary. +The value should be the control sequence \emph{name} without the +leading backslash or following star (e.g.\ just \texttt{chapter} +not \cs{chapter} or \texttt{chapter*}). + +The default behaviour is for the glossary heading to use +\cs{chapter}, if that command exists, or \cs{section} otherwise. The +starred or unstarred form is determined by the \pkgopt{numberedsection} option. + +Example: \begin{verbatim} \usepackage[section=subsection]{glossaries} \end{verbatim} -You can omit the value if you want to use sections, i.e.\ +You can omit the value if you want to use \cs{section}, i.e.\ \begin{verbatim} \usepackage[section]{glossaries} \end{verbatim} @@ -3559,10 +3941,11 @@ be fixed by redefining \DescribeMacro\glsclearpage\cs{glsclearpage}: \renewcommand*{\glsclearpage}{\clearpage} \end{verbatim} -\item[\pkgoptdef{ucmark}] This is a boolean option (default: +\pkgoptsec[boolean]{ucmark} This is a boolean option. The default is \pkgopt[false]{ucmark}, unless \cls{memoir} has been loaded, in -which case it defaults to \pkgopt[true]{ucmark}). If -set, \ics{glsglossarymark} uses +which case the default is \pkgopt[true]{ucmark}. + +If set, \ics{glsglossarymark} uses \ics{MakeTextUppercase}\footnote{Actually it uses \ics{mfirstucMakeUppercase} which is set to \sty{textcase}'s \cs{MakeTextUppercase} by the @@ -3570,8 +3953,8 @@ by the \ics{makefirstuc}. (The \sty{textcase} package is automatically loaded by \styfmt{glossaries}.)}. You can test whether this option has been set or not using -\begin{definition}[\DescribeMacro\ifglsucmark] -\cs{ifglsucmark} \meta{true part}\cs{else} \meta{false part}\cs{fi} +\begin{definition} +\ics{ifglsucmark} \meta{true part}\cs{else} \meta{false part}\cs{fi} \end{definition} For example: \begin{verbatim} @@ -3582,10 +3965,10 @@ For example: \markright{#1}% \fi} \end{verbatim} -If \cls{memoir} has been loaded and \pkgopt{ucfirst} is set, then +If \cls{memoir} has been loaded and \pkgopt{ucmark} is set, then \cls{memoir}'s \ics{memUChead} is used. -\item[\pkgoptdef{numberedsection}] +\pkgoptsec[value]{numberedsection} The glossaries are placed in unnumbered sectional units by default, but this can be changed using \pkgopt{numberedsection}. This option can take one of the following values: @@ -3658,13 +4041,26 @@ associated with the \texttt{main} glossary. As above, you can redefine \cs{glsautoprefix} to provide a prefix for the label. \end{itemize} -\end{description} - \section{Glossary Appearance Options} \label{sec:pkgopts-printglos} -\begin{description} -\item[\pkgoptdef{entrycounter}] This is a boolean option. (Default +\pkgoptsec[boolean]{savenumberlist} This is a boolean option that +specifies whether or not to gather and store the \gls{numberlist} +for each entry. The default is \pkgopt[false]{savenumberlist}. (See +\ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} in +\sectionref{sec:glsnolink}.) This is always true if you +use \opt1. + +\begin{bib2gls} +If you use the \pkgopt*{record} option (with either no value or +\pkgopt+{only}{record} or \pkgopt+{nameref}{record}) then this +package option has no effect. With \gls{bib2gls}, the +\glspl{numberlist} are automatically saved with the default +\resourceopt[true]{save-locations} and +\resourceopt[true]{save-loclist} resource settings. +\end{bib2gls} + +\pkgoptsec[boolean]{entrycounter} This is a boolean option. (Default is \pkgopt[false]{entrycounter}.) If set, each main (level~0) glossary entry will be numbered when using the standard glossary styles. This option creates the counter @@ -3690,7 +4086,7 @@ creating the glossary files using \gls{makeglossaries}, up-to-date. \end{important} -\item[\pkgoptdef{counterwithin}] This is a \meta{key}=\meta{value} +\pkgoptsec[value]{counterwithin} This is a \meta{key}=\meta{value} option where \meta{value} is the name of a counter. If used, this option will automatically set \pkgopt[true]{entrycounter} and the \ctr{glossaryentry} counter will be reset every time \meta{value} is @@ -3705,7 +4101,7 @@ counter used in the glossary's sectioning command. \end{important} If you want the counter reset at the start of each glossary, you can -redefine \ics{glossarypreamble} to use +modify the glossary preamble (\ics{glossarypreamble}) to use \begin{definition}[\DescribeMacro{\glsresetentrycounter}] \cs{glsresetentrycounter} \end{definition} @@ -3728,7 +4124,7 @@ glossary preamble, as required. For example: } \end{verbatim} -\item[\pkgoptdef{subentrycounter}] This is a boolean option. (Default +\pkgoptsec[boolean]{subentrycounter} This is a boolean option. (Default is \pkgopt[false]{subentrycounter}.) If set, each level~1 glossary entry will be numbered when using the standard glossary styles. This option creates the counter @@ -3739,7 +4135,7 @@ reference the number within the document using \ics{glsrefentry}\marg{label} where \meta{label} is the label associated with the sub-entry. -\item[\pkgoptdef{style}] This is a \meta{key}=\meta{value} option. +\pkgoptsec[value]{style} This is a \meta{key}=\meta{value} option. (Default is \pkgopt[list]{style}, unless \sty{classicthesis} has been loaded, in which case the default is \pkgopt[index]{style}.) Its value should be the name of the glossary style to use. This key may only be used for styles @@ -3751,7 +4147,7 @@ set the style using \end{definition} (See \sectionref{sec:styles} for further details.) -\item[\pkgoptdef{nolong}] This prevents the \styfmt{glossaries} package +\pkgoptsec{nolong} This prevents the \styfmt{glossaries} package from automatically loading \sty{glossary-long} (which means that the \sty{longtable} package also won't be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if @@ -3759,7 +4155,7 @@ you use this option, you won't be able to use any of the glossary styles defined in the \styfmt{glossary-long} package (unless you explicitly load \sty{glossary-long}). -\item[\pkgoptdef{nosuper}] This prevents the \styfmt{glossaries} package +\pkgoptsec{nosuper} This prevents the \styfmt{glossaries} package from automatically loading \sty{glossary-super} (which means that the \sty{supertabular} package also won't be loaded). This reduces overhead by not defining unwanted styles and commands. Note that if @@ -3767,7 +4163,7 @@ you use this option, you won't be able to use any of the glossary styles defined in the \styfmt{glossary-super} package (unless you explicitly load \sty{glossary-super}). -\item[\pkgoptdef{nolist}] This prevents the \styfmt{glossaries} package +\pkgoptsec{nolist} This prevents the \styfmt{glossaries} package from automatically loading \sty{glossary-list}. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won't be able to use any of the @@ -3778,7 +4174,7 @@ Note that since the default style is \glostyle{list} (unless also need to use the \pkgopt{style} option to set the style to something else. -\item[\pkgoptdef{notree}] This prevents the \styfmt{glossaries} package +\pkgoptsec{notree} This prevents the \styfmt{glossaries} package from automatically loading \sty{glossary-tree}. This reduces overhead by not defining unwanted styles. Note that if you use this option, you won't be able to use any of the @@ -3787,7 +4183,7 @@ glossary styles defined in the \styfmt{glossary-tree} package \sty{classicthesis} has been loaded, the default style is \glostyle{index}, which is provided by \sty{glossary-tree}. -\item[\pkgoptdef{nostyles}] This prevents all the predefined styles +\pkgoptsec{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 \sty{glossary-mcols}). Also if you use this option, you can't use the \pkgopt{style} package option. @@ -3800,7 +4196,7 @@ Instead you must either use \ics{setglossarystyle}\marg{style} or the \setglossarystyle{mcoltree} \end{verbatim} -\item[\pkgoptdef{nonumberlist}] This option will suppress the +\pkgoptsec{nonumberlist} This option will suppress the associated \glspl{numberlist} in the glossaries (see also \sectionref{sec:numberlists}). Note that if you use \optsor23 (\gls{makeindex} or \gls{xindy}) then the locations must still be @@ -3811,7 +4207,7 @@ indexed. Remember that \gls{numberlist} includes any cross-references, so suppressing the \gls{numberlist} will also hide the cross-references (see below). -\item[\pkgoptdef{seeautonumberlist}] If you suppress the +\pkgoptsec{seeautonumberlist} If you suppress the \glspl{numberlist} with \pkgopt{nonumberlist}, described above, this will also suppress any cross-referencing information supplied by the \gloskey{see} key in \ics{newglossaryentry} or \ics{glssee}. If you @@ -3820,30 +4216,252 @@ automatically implement \gloskey{nonumberlist=false} for that entry. (Note this doesn't affect \cs{glssee}.) For further details see \sectionref{sec:crossref}. -\item[\pkgoptdef{counter}] This is a \meta{key}=\meta{value} option. +\pkgoptsec[value]{counter} This is a \meta{key}=\meta{value} option. (Default is \pkgopt[page]{counter}.) The value should be the name of the default counter to use in the \glspl{numberlist} (see \sectionref{sec:numberlists}). -\item[\pkgoptdef{nopostdot}] This is a boolean option. If no value is -specified, \texttt{true} is assumed. When set to \texttt{true}, this -option suppresses the default post description dot used by some of -the predefined styles. The default setting is -\pkgopt[false]{nopostdot}. - -\item[\pkgoptdef{nogroupskip}] This is a boolean option. If no value is -specified, \texttt{true} is assumed. When set to \texttt{true}, this -option suppresses the default vertical gap between groups used by +\pkgoptsec[boolean]{nopostdot} This is a boolean option. If no value is +specified, \pkgoptval{true}{nopostdot} is assumed. When set to +\pkgoptval{true}{nopostdot}, this option suppresses the default post +description dot used by some of the predefined styles. + +The default setting is \pkgopt[false]{nopostdot} for the base +\styfmt{glossaries} package and \pkgopt[true]{nopostdot} for +\gls{glossaries-extra}. + +\begin{xtr} +The \gls{glossaries-extra} package provides \pkgopt*{postdot}, which +is equivalent to \pkgopt[false]{nopostdot}, and also +\pkgopt*{postpunc}, which allows you to choose a different +punctuation character. +\end{xtr} + +\pkgoptsec[boolean]{nogroupskip} This is a boolean option. If no value is +specified, \pkgoptfmt{true} is assumed. When set to \pkgoptfmt{true}, this +option suppresses the default vertical gap between letter groups used by some of the predefined styles. The default setting is \pkgopt[false]{nogroupskip}. +\begin{bib2gls} +If you are using \gls{bib2gls} without the \texttt{-{}-group} (or +\texttt{-g}) switch then you don't need to use +\pkgoptfmt{nogroupskip\dequals true} as there won't be any letter +groups. +\end{bib2gls} + +\xtrpkgoptsec[list]{stylemods} + +Load the \sty{glossaries-extra-stylemods} package and patch the +predefined styles. The \meta{list} argument is optional. If present, +this will also load \styfmt{glossary-\meta{element}.sty} for each +\meta{element} in the comma-separated \meta{list}. + +\section{Indexing Options} +\label{sec:pkgopts-indexing} + +\pkgoptsec[value]{seenoindex} Introduced in version 4.24, this option +may take one of three values: \pkgoptfmt{error}, \pkgoptfmt{warn} or +\pkgoptfmt{ignore}. The \gloskey{see} key automatically indexes the +cross-referenced entry using \cs{glsadd}. This means that if this +key is used in an entry definition before the relevant +glossary file has been opened, the indexing can't be performed. +Since this is easy to miss, the \styfmt{glossaries} package by +default issues an error message if the \gloskey{see} key is used +before \ics{makeglossaries}. This option allows you to change the +error into just a warning (\pkgopt[warn]{seenoindex}) or +ignore it (\pkgopt[ignore]{seenoindex}) if, for example, you want +to temporarily comment out \cs{makeglossaries} to speed up the +compilation of a draft document by omitting the indexing. + +\pkgoptsec[boolean]{esclocations} This is a boolean option. The +default is \pkgopt[true]{esclocations}, which is needed for +\optsand23. With \opt1 \ics{makenoidxglossaries} changes it to +\pkgopt[false]{esclocations}. With \opt4 (\gls{bib2gls}), this +setting is ignored. + +Both \gls{makeindex} and \gls{xindy} are fussy about the location +formats (\gls{makeindex} more so than \gls{xindy}) so the +\styfmt{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 \pkgopt[false]{esclocations} to avoid the complex escaping of +location values. (See \ifpdf section~\ref*{sec:wrgloss} \fi +\qt{Writing information to associated files} in the documented code +for further details.) + +This isn't an issue for \optsor14 as the locations are written to +the \filetype{aux} file so no syntax conversion is required. + +\pkgoptsec[boolean]{indexonlyfirst} This is a boolean option that specifies +whether to only add information to the external glossary file on +\gls{firstuse}. The default is \pkgopt[false]{indexonlyfirst}, +which will add a line to the file every time one of the +\glslike\ or \glstextlike\ commands are used. Note that \ics{glsadd} +will always add information to the external glossary +file\footnote{bug fix in v4.16 has corrected the code to ensure +this.}\ (since that's the purpose of that command). + +\begin{important} +Resetting the \gls{firstuseflag} with commands like +\ics{glsreset} after an entry has been indexed will cause that entry to be +indexed multiple times if it's used again after the reset. +Likewise unsetting the \gls{firstuseflag} before an entry has been +indexed will prevent it from being indexed (unless specifically +indexed with \cs{glsadd}). +\end{important} + +You can customise this by redefining +\begin{definition}[\DescribeMacro\glswriteentry] +\cs{glswriteentry}\marg{label}\marg{wr-code} +\end{definition} +where \meta{label} is the entry's label and \meta{wr-code} is the +code that writes the entry's information to the external file. +The default definition of \cs{glswriteentry} is: +\begin{verbatim} +\newcommand*{\glswriteentry}[2]{% + \ifglsindexonlyfirst + \ifglsused{#1}{}{#2}% + \else + #2% + \fi +} +\end{verbatim} +This checks the \pkgopt{indexonlyfirst} package option (using +\cs{ifglsindexonlyfirst}) and does \meta{wr-code} if this is +\pkgoptfmt{false} otherwise it only does \meta{wr-code} of the entry +hasn't been used. + +For example, suppose you only want to index the first use for +entries in the \texttt{acronym} glossary and not in the +\texttt{main} (or any other) glossary: +\begin{verbatim} +\renewcommand*{\glswriteentry}[2]{% + \ifthenelse{\equal{\glsentrytype{#1}}{acronym}} + {\ifglsused{#1}{}{#2}}% + {#2}% +} +\end{verbatim} +Here I've used \cs{ifthenelse} to ensure the arguments of +\cs{equal} are fully expanded before the comparison is made. + +With the \gls{glossaries-extra} package it's possible to only index +\gls{firstuse} for particular categories. For example, if you only +want this enabled for abbreviations and acronyms then you can set +the \attr{indexonlyfirst} attribute for the \texttt{abbreviation} +and \texttt{acronym} categories. (Instead of using the +\pkgopt{indexonlyfirst} package option.) See the +\gls{glossaries-extra} manual for further details. + +\xtrpkgoptsec[boolean]{indexcrossrefs} + +If \pkgoptfmt{true}, this will automatically index any +cross-referenced entries that haven't been marked as used at the end +of the document. Increases document build time. See +\gls{glossaries-extra} manual for further details. + +\xtrpkgoptsec[boolean]{autoseeindex} + +If \pkgoptfmt{true}, makes the \gloskey{see} and +\xtrgloskey{seealso} keys automatically index the cross-reference +when the entry is defined (default, and the only option with just +the base \styfmt{glossaries} package). + +\xtrpkgoptsec[value]{record} + +If not \pkgoptfmt{off}, this option indicates that \gls{bib2gls} +is required. If the value is omitted, \pkgoptfmt{only} is assumed. Permitted values: +\begin{description} +\item[\pkgoptfmt{off}] \gls{bib2gls} isn't being used; + +\item[\pkgoptfmt{only}] \gls{bib2gls} is being used to fetch entries +from a \filetype{bib} file, to sort the entries and collate the +\glspl{numberlist}, where the location information is the same as +for \optsto13; + +\item[\pkgoptfmt{nameref}] like \pkgoptfmt{only} but provides extra +information that allows the associated title to be used instead of +the location number; + +\item[\pkgoptfmt{alsoindex}] a hybrid approach where \gls{bib2gls} +is begin used to fetch entries from a \filetype{bib} file but +\gls{makeindex} or \gls{xindy} are used for the indexing. This +requires a more complicated document build and isn't recommended. \end{description} +See \gls{glossaries-extra} manual for further details. + +\xtrpkgoptsec[boolean]{equations} + +If \pkgoptfmt{true}, this option will cause the default location +counter to automatically switch to \texttt{equation} when inside a +numbered equation environment. + +\xtrpkgoptsec[boolean]{floats} + +If \pkgoptfmt{true}, this option will cause the default location +counter to automatically switch to the corresponding counter when inside a +float. (Remember that with floats it's the \cs{caption} command that +increments the counter so the location will be incorrect if an entry +is indexed within the float before the caption.) + +\xtrpkgoptsec{indexcounter} + +This valueless option is primarily intended for use with +\gls{bib2gls} and \sty{hyperref} allowing the page location +hyperlink to the relevant point in the page (rather than the top of +the page). Unexpected results will occur with other indexing +methods. See \gls{glossaries-extra} manual for further details. \section{Sorting Options} \label{sec:pkgopts-sort} -\begin{description} -\item[\pkgoptdef{sort}] If you use \optsor23, this package option is +This section is mostly for \optsand23. Only the \pkgopt{sort} and +\pkgopt{order} options are applicable for \opt1. + +\begin{xtr} +With \optsto46, only \pkgopt[none]{sort} is applicable (and this is +automatically implemented by \pkgopt+{only}{record} and +\pkgopt+{nameref}{record}). With \gls{bib2gls}, the sort method +is provided in the optional argument of \ics*{GlsXtrLoadResources} +not with the \pkgoptfmt{sort} package option. There's no sorting +with \optsand56. +\end{xtr} + +\pkgoptsec[boolean]{sanitizesort} This is a boolean option that +determines whether or not to \gls{sanitize} the sort value when +writing to the external glossary file. For example, suppose you +define an entry as follows: +\begin{verbatim} +\newglossaryentry{hash}{name={\#},sort={#}, + description={hash symbol}} +\end{verbatim} +The sort value (\verb|#|) must be sanitized before writing it to the +glossary file, otherwise \LaTeX\ will try to interpret it as a +parameter reference. If, on the other hand, you want the sort value +expanded, you need to switch off the sanitization. For example, +suppose you do: +\begin{verbatim} +\newcommand{\mysortvalue}{AAA} +\newglossaryentry{sample}{% + name={sample}, + sort={\mysortvalue}, + description={an example}} +\end{verbatim} +and you actually want \cs{mysortvalue} expanded, so that the entry +is sorted according to \texttt{AAA}, then use the package option +\pkgopt[false]{sanitizesort}. + +The default for \optsand23 is \pkgopt[true]{sanitizesort}, and the +default for \opt1 is \pkgopt[false]{sanitizesort}. + +\pkgoptsec[value]{sort} If you use \optsor23, this package option is the only way of specifying how to sort the glossaries. Only \opt1 allows you to specify sort methods for individual glossaries via the \gloskey[printnoidxglossary]{sort} key in the optional @@ -3884,11 +4502,13 @@ and is only for documents that don't use \cs{makeglossaries} (\optsor23) or \cs{makenoidxglossaries} (\opt1). 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 +number of entries. + +This option can't be used with \cs{printglossary} or \cs{printnoidxglossary} (or the iterative versions \cs{printglossaries} or \cs{printnoidxglossaries}). It may be used with -\sty{glossaries-extra}'s \cs{printunsrtglossary} (\opt5). +\gls{glossaries-extra}'s \cs{printunsrtglossary} (\opt5). \end{itemize} Note that the group styles (such as \glostyle{listgroup}) are incompatible with the \pkgopt[use]{sort} and \pkgopt[def]{sort} @@ -3930,8 +4550,8 @@ I want the \texttt{main} and \texttt{acronym} glossaries to be sorted alphabetically, but the \texttt{notation} type should be sorted in order of definition. -For \opt1, I~just need to set the \gloskey[printnoidxglossary]{sort} key in -the optional argument of \ics{printnoidxglossary}: +For \opt1, the \gloskey[printnoidxglossary]{sort} option can be +used in \ics{printnoidxglossary}: \begin{verbatim} \printnoidxglossary[sort=word] \printnoidxglossary[type=acronym,sort=word] @@ -4021,12 +4641,12 @@ Now the entries can be defined: For a complete document, see the sample file \samplefile{People}. \end{example} -\item[\pkgoptdef{order}] This may take two values: +\pkgoptsec[value]{order} This may take two values: \pkgoptval{word}{order} or \pkgoptval{letter}{order}. The default is word ordering. \begin{important} -Note that the \pkgopt{order} option has no effect if you don't use +Note that with \optsand23, the \pkgopt{order} option has no effect if you don't use \gls{makeglossaries}. \end{important} @@ -4042,24 +4662,29 @@ Alternatively, you can specify the order for individual glossaries: \printnoidxglossary[type=acronym,sort=letter] \end{verbatim} -\item[\pkgoptdef{makeindex}] (\opt2) The glossary information and +\begin{bib2gls} +With \gls{bib2gls}, use the \resourceopt{break-at} option +in \ics*{GlsXtrLoadResources} instead of \pkgoptfmt{order}. +\end{bib2gls} + +\pkgoptsec{makeindex} (\opt2) The glossary information and indexing style file will be written in \gls{makeindex} format. If you use \gls{makeglossaries}, it will automatically detect that it needs to call \gls*{makeindex}. If you don't use \gls*{makeglossaries}, you need to remember to use \gls*{makeindex} not \gls{xindy}. The indexing style file will been given -a~\filetype{.ist} extension. +a~\filetype{ist} extension. You may omit this package option if you are using \opt2 as this is the default. It's available in case you need to override the effect of an earlier occurrence of \pkgopt{xindy} in the package option list. -\item[\pkgoptdef{xindy}] (\opt3) The glossary information and indexing style +\pkgoptsec{xindy} (\opt3) The glossary information and indexing style file will be written in \gls{xindy} format. If you use \gls{makeglossaries}, it will automatically detect that it needs to call \gls*{xindy}. If you don't use \gls*{makeglossaries}, you need to remember to use \gls*{xindy} not \gls{makeindex}. The indexing style -file will been given a \filetype{.xdy} extension. +file will been given a \filetype{xdy} extension. This package option may additionally have a value that is a \meta{key}=\meta{value} comma-separated list to override the @@ -4079,17 +4704,17 @@ language, codepage and number group settings are unchanged. See \sectionref{sec:xindy} for further details on using \gls{xindy} with the \styfmt{glossaries} package. -\item[\pkgoptdef{xindygloss}] (\opt3) This is equivalent to +\pkgoptsec{xindygloss} (\opt3) This is equivalent to \verb|xindy={}| (that is, the \pkgopt{xindy} option without any value supplied) and may be used as a document class option. The language and code page can be set via \ics{GlsSetXdyLanguage} and \ics{GlsSetXdyCodePage} (see \sectionref{sec:langenc}.) -\item[\pkgoptdef{xindynoglsnumbers}] (\opt3) This is equivalent to +\pkgoptsec{xindynoglsnumbers} (\opt3) This is equivalent to \verb|xindy={glsnumbers=false}| and may be used as a document class option. -\item[\pkgoptdef{automake}] This is option was introduced to +\pkgoptsec[value]{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: \texttt{false} (default), \texttt{true} or \texttt{immediate}. If no option is supplied, \texttt{immediate} @@ -4139,13 +4764,225 @@ those who can't work out how to incorporate the \gls*{indexingapp} into their document build. The default value for this option is \pkgopt[false]{automake}. -\end{description} +\pkgoptsec{disablemakegloss} This valueless option +indicates that \ics{makeglossaries} and \ics{makenoidxglossaries} +should be disabled. This option is provided in the event that you +have to use a class or package that disregards the advice in +\sectionref{sec:indexingoptions} and automatically performs +\ics{makeglossaries} or \ics{makenoidxglossaries} but you don't want +this. (For example, you want to use a different indexing method or +you want to disable indexing while working on a draft +document.) + +This option may be passed in the standard document class option list +or passed using \cs{PassOptionsToPackage} before \sty{glossaries} is +loaded. Note that this does nothing if +\ics{makeglossaries} or \ics{makenoidxglossaries} has already +been used whilst enabled. + +\pkgoptsec{restoremakegloss} Cancels the effect of +\pkgopt{disablemakegloss}. This option may be used in +\cs{setupglossaries}. It issues a warning if \ics{makeglossaries} or +\ics{makenoidxglossaries} has already been used whilst enabled. +For example, suppose the class \clsfmt{customclass.cls} +automatically loads \styfmt{glossaries} and does \cs{makeglossaries} +but you need an extra glossary, which has to be defined before +\cs{makeglossaries}, then you can do: +\begin{verbatim} +\documentclass[disablemakegloss]{customclass} +\newglossary*{functions}{Functions} +\setupglossaries{restoremakegloss} +\makeglossaries +\end{verbatim} +or +\begin{verbatim} +\PassOptionsToPackage{disablemakegloss}{glossaries} +\documentclass{customclass} +\newglossary*{functions}{Functions} +\setupglossaries{restoremakegloss} +\makeglossaries +\end{verbatim} + +Note that restoring these commands doesn't necessarily mean that they can be +used. It just means that their normal behaviour given the current +settings will apply. For example, if you use the \pkgopt+{only}{record} +or \pkgopt+{nameref}{record} options with \gls{glossaries-extra} +then you can't use \cs{makeglossaries} or \cs{makenoidxglossaries} +regardless of \pkgopt{restoremakegloss}. + +\section{Glossary Type Options} +\label{sec:pkgopts-type} + +\pkgoptsec[list]{nohypertypes} Use this option if you have multiple +glossaries and you want to suppress the entry hyperlinks for a +particular glossary or glossaries. The value of this option should +be a comma-separated list of glossary types where \ics{gls} etc +shouldn't have hyperlinks by default. Make sure you enclose the +value in braces if it contains any commas. Example: +\begin{verbatim} +\usepackage[acronym,nohypertypes={acronym,notation}] + {glossaries} +\newglossary[nlg]{notation}{not}{ntn}{Notation} +\end{verbatim} +The values must be fully expanded, so \strong{don't} try +\texttt{nohypertypes\discretionary{}{}{}=\ics{acronymtype}}. You may also use +\begin{definition} +\ics{GlsDeclareNoHyperList}\marg{list} +\end{definition} +instead or additionally. +See \sectionref{sec:glslink} for further details. + +\pkgoptsec{nomain} This suppresses the creation of the main +glossary and associated \filetype{glo} file, if unrequired. Note that +if you use this option, you must create another glossary in which to +put all your entries (either via the \pkgopt{acronym} (or +\pkgopt{acronyms}) package option described in +\sectionref{sec:pkgopts-acronym} or via the \pkgopt{symbols}, +\pkgopt{numbers} or \pkgopt{index} options described in +\sectionref{sec:pkgopts-other} or via \ics{newglossary} described in +\sectionref{sec:newglossary}). -\section{Acronym Options} +\begin{important} +If you don't use the main glossary and you don't use this option, +\gls{makeglossaries} will produce a warning. +\end{important} +\begin{alltt} +Warning: File '\emph{filename}.glo' is empty. +Have you used any entries defined in glossary +'main'? +Remember to use package option 'nomain' if +you don't want to use the main glossary. +\end{alltt} +If you did actually want to use the main glossary and you see this +warning, check that you have referenced the entries in that glossary +via commands such as \ics{gls}. + +\pkgoptsec{symbols} This valueless option defines a new glossary type with +the label \texttt{symbols} via +\begin{verbatim} +\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} +\end{verbatim} +It also defines +\begin{definition}[\DescribeMacro\printsymbols] +\cs{printsymbols}\oarg{options} +\end{definition} +which is a synonym for +\begin{alltt} +\ics{printglossary}[type=symbols,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=symbols,\meta{options}] +\end{alltt} +to display the list of symbols. + +\begin{important} +Remember to use the \pkgopt{nomain} package option if you're only +interested in using this \texttt{symbols} glossary and don't intend +to use the \texttt{main} glossary. +\end{important} + +\begin{xtr} +The \gls{glossaries-extra} package has a slightly modified +version of this option which additionally provides \ics*{glsxtrnewsymbol} +as a convenient shortcut method for defining symbols. See the +\gls{glossaries-extra} manual for further details. +\end{xtr} + +\pkgoptsec{numbers} This valueless option defines a new glossary type with +the label \texttt{numbers} via +\begin{verbatim} +\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} +\end{verbatim} +It also defines +\begin{definition}[\DescribeMacro\printnumbers] +\cs{printnumbers}\oarg{options} +\end{definition} +which is a synonym for +\begin{alltt} +\ics{printglossary}[type=numbers,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=numbers,\meta{options}] +\end{alltt} +to display the list of numbers. + +\begin{important} +Remember to use the \pkgopt{nomain} package option if you're only +interested in using this \texttt{numbers} glossary and don't intend +to use the \texttt{main} glossary. +\end{important} + +\begin{xtr} +The \gls{glossaries-extra} package has a slightly modified +version of this option which additionally provides \ics*{glsxtrnewnumber} +as a convenient shortcut method for defining numbers. See the +\gls{glossaries-extra} manual for further details. +\end{xtr} + +\pkgoptsec{index} This valueless option defines a new glossary type with +the label \texttt{index} via +\begin{verbatim} +\newglossary[ilg]{index}{ind}{idx}{\indexname}% +\end{verbatim} +It also defines +\begin{definition}[\DescribeMacro\newterm] +\cs{newterm}\oarg{options}\marg{term} +\end{definition} +which is a synonym for +\begin{alltt} +\ics{newglossaryentry}\marg{term}[type=index,name=\marg{term},% +description=\ics{nopostdesc},\meta{options}] +\end{alltt} +and +\begin{definition}[\DescribeMacro\printindex] +\cs{printindex}\oarg{options} +\end{definition} +which is a synonym for +\begin{alltt} +\ics{printglossary}[type=index,\meta{options}] +\end{alltt} + +If you use \opt1, you need to use: +\begin{alltt} +\ics{printnoidxglossary}[type=index,\meta{options}] +\end{alltt} +to display this glossary. + +\begin{important} +Remember to use the \pkgopt{nomain} package option if you're only +interested in using this \texttt{index} glossary and don't intend to +use the \texttt{main} glossary. Note that you +can't mix this option with \ics{index}. Either use +\styfmt{glossaries} for the indexing or use a~custom indexing +package, such as \sty{makeidx}, \sty{index} or \sty{imakeidx}. +(You can, of course, load one of those packages and +load \styfmt{glossaries} without the \pkgopt{index} package option.) +\end{important} + +Since the index isn't designed for terms with descriptions, you +might also want to disable the hyperlinks for this glossary using +the package option \pkgopt[index]{nohypertypes} or the command +\begin{display} +\ics{GlsDeclareNoHyperList}\verb|{index}| +\end{display} + +The example file \samplefile{-index} illustrates the use of the +\pkgopt{index} package option. + +\pkgoptsec{noglossaryindex} This valueless option switches off \pkgopt{index} +if \pkgopt{index} has been passed implicitly (for example, +through global document options). This option can't be used +in \cs{setupglossaries}. + + +\section{Acronym and Abbreviation Options} \label{sec:pkgopts-acronym} -\begin{description} -\item[\pkgoptdef{acronym}] This creates a new glossary with the +\pkgoptsec[boolean]{acronym} If true, this creates a new glossary with the label \texttt{acronym}. This is equivalent to: \begin{verbatim} \newglossary[alg]{acronym}{acr}{acn}{\acronymname} @@ -4183,11 +5020,36 @@ interested in using this \texttt{acronym} glossary. (That is, you don't intend to use the \texttt{main} glossary.) \end{important} -\item[\pkgoptdef{acronyms}] This is equivalent to +\begin{xtr} +The \gls{glossaries-extra} extension package comes with an analogous +\pkgopt*{abbreviations} option, which creates a new glossary with +the label \texttt{abbreviations} and sets the command +\ics*{glsxtrabbrvtype} to this. If the \pkgopt{acronym} option hasn't +also been used, then \ics{acronymtype} will be set to +\ics*{glsxtrabbrvtype}. This enables both \ics{newacronym} and +\ics*{newabbreviation} to use the same glossary. + +Make sure you have at least v1.42 of \gls{glossaries-extra} if you +use the \pkgopt{acronym} (or \pkgopt{acronyms}) package option with +the extension package to avoid a bug that interferes with the +abbreviation style. +\end{xtr} + +\pkgoptsec{acronyms} This is equivalent to \pkgopt[true]{acronym} and may be used in the document class option list. -\item[\pkgoptdef{acronymlists}] By default, only the \cs{acronymtype} +\xtrpkgoptsec{abbreviations} + +This valueless option creates a new glossary type using: +\begin{verbatim} +\newglossary[glg-abr]{abbreviations}{gls-abr}{glo-abr}{\abbreviationsname} +\end{verbatim} +The label can be accessed with \ics*{glsxtrabbrvtype}, which is +analogous to \cs{acronymtype}. See \gls{glossaries-extra} manual for +further details. + +\pkgoptsec[value]{acronymlists} By default, only the \cs{acronymtype} glossary is considered to be a list of acronyms. If you have other lists of acronyms, you can specify them as a comma-separated list in the value of \pkgopt{acronymlists}. For example, if you use the @@ -4222,13 +5084,21 @@ of acronyms using: \cs{glsIfListOfAcronyms}\marg{label}\marg{true part}\marg{false part} \end{definition} -\item[\pkgoptdef{shortcuts}] This option provides shortcut commands +\begin{xtr} +This option is incompatible with \gls{glossaries-extra}['s] +abbreviation mechanism. +\end{xtr} + +\pkgoptsec{shortcuts} This option provides shortcut commands for acronyms. See \sectionref{sec:acronyms} for further details. Alternatively you can use: \begin{definition}[\DescribeMacro\DefineAcronymSynonyms] \cs{DefineAcronymSynonyms} \end{definition} -\end{description} + +\begin{xtr} +The \gls{glossaries-extra} package provides additional shortcuts. +\end{xtr} \subsection{Deprecated Acronym Style Options} \label{sec:pkgopts-old-acronym} @@ -4237,54 +5107,53 @@ The package options listed in this section are now deprecated but are kept for backward-compatibility. Use \ics{setacronymstyle} instead. See \sectionref{sec:acronyms} for further details. -\begin{description} -\item[\pkgoptdef{description}] This option changes the definition of +\deppkgoptsec{description} This option changes the definition of \ics{newacronym} to allow a description. This option may be replaced by \begin{verbatim} \setacronymstyle{long-short-desc} \end{verbatim} -or (with \pkgopt{smallcaps}) +or (with \deprecatedpkgopt{smallcaps}) \begin{verbatim} \setacronymstyle{long-sc-short-desc} \end{verbatim} -or (with \pkgopt{smaller}) +or (with \deprecatedpkgopt{smaller}) \begin{verbatim} \setacronymstyle{long-sm-short-desc} \end{verbatim} -or (with \pkgopt{footnote}) +or (with \deprecatedpkgopt{footnote}) \begin{verbatim} \setacronymstyle{footnote-desc} \end{verbatim} -or (with \pkgopt{footnote} and \pkgopt{smallcaps}) +or (with \deprecatedpkgopt{footnote} and \deprecatedpkgopt{smallcaps}) \begin{verbatim} \setacronymstyle{footnote-sc-desc} \end{verbatim} -or (with \pkgopt{footnote} and \pkgopt{smaller}) +or (with \deprecatedpkgopt{footnote} and \deprecatedpkgopt{smaller}) \begin{verbatim} \setacronymstyle{footnote-sm-desc} \end{verbatim} -or (with \pkgopt{dua}) +or (with \deprecatedpkgopt{dua}) \begin{verbatim} \setacronymstyle{dua-desc} \end{verbatim} -\item[\pkgoptdef{smallcaps}] This option changes the definition of +\deppkgoptsec{smallcaps} This option changes the definition of \ics{newacronym} and the way that acronyms are displayed. This option may be replaced by: \begin{verbatim} \setacronymstyle{long-sc-short} \end{verbatim} -or (with \pkgopt{description}) +or (with \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{long-sc-short-desc} \end{verbatim} -or (with \pkgopt{description} and \pkgopt{footnote}) +or (with \deprecatedpkgopt{description} and \deprecatedpkgopt{footnote}) \begin{verbatim} \setacronymstyle{footnote-sc-desc} \end{verbatim} -\item[\pkgoptdef{smaller}] This option changes the definition of +\deppkgoptsec{smaller} This option changes the definition of \ics{newacronym} and the way that acronyms are displayed. \begin{important} If you use this option, you will need to include the \sty{relsize} @@ -4295,186 +5164,79 @@ This option may be replaced by: \begin{verbatim} \setacronymstyle{long-sm-short} \end{verbatim} -or (with \pkgopt{description}) +or (with \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{long-sm-short-desc} \end{verbatim} -or (with \pkgopt{description} and \pkgopt{footnote}) +or (with \deprecatedpkgopt{description} and \deprecatedpkgopt{footnote}) \begin{verbatim} \setacronymstyle{footnote-sm-desc} \end{verbatim} -\item[\pkgoptdef{footnote}] This option changes the definition of +\deppkgoptsec{footnote} This option changes the definition of \ics{newacronym} and the way that acronyms are displayed. This option may be replaced by: \begin{verbatim} \setacronymstyle{footnote} \end{verbatim} -or (with \pkgopt{smallcaps}) +or (with \deprecatedpkgopt{smallcaps}) \begin{verbatim} \setacronymstyle{footnote-sc} \end{verbatim} -or (with \pkgopt{smaller}) +or (with \deprecatedpkgopt{smaller}) \begin{verbatim} \setacronymstyle{footnote-sm} \end{verbatim} -or (with \pkgopt{description}) +or (with \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{footnote-desc} \end{verbatim} -or (with \pkgopt{smallcaps} and \pkgopt{description}) +or (with \deprecatedpkgopt{smallcaps} and \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{footnote-sc-desc} \end{verbatim} -or (with \pkgopt{smaller} and \pkgopt{description}) +or (with \deprecatedpkgopt{smaller} and \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{footnote-sm-desc} \end{verbatim} - -\item[\pkgoptdef{dua}] This option changes the definition of +\deppkgoptsec{dua} This option changes the definition of \ics{newacronym} so that acronyms are always expanded. This option may be replaced by: \begin{verbatim} \setacronymstyle{dua} \end{verbatim} -or (with \pkgopt{description}) +or (with \deprecatedpkgopt{description}) \begin{verbatim} \setacronymstyle{dua-desc} \end{verbatim} -\end{description} - \section{Other Options} \label{sec:pkgopts-other} Other available options that don't fit any of the above categories -are: -\begin{description} -\item[\pkgoptdef{symbols}] This option defines a new glossary type with -the label \texttt{symbols} via -\begin{verbatim} -\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname} -\end{verbatim} -It also defines -\begin{definition}[\DescribeMacro\printsymbols] -\cs{printsymbols}\oarg{options} -\end{definition} -which is a synonym for -\begin{alltt} -\ics{printglossary}[type=symbols,\meta{options}] -\end{alltt} +are described below. -If you use \opt1, you need to use: -\begin{alltt} -\ics{printnoidxglossary}[type=symbols,\meta{options}] -\end{alltt} -to display the list of symbols. - -\begin{important} -Remember to use the \pkgopt{nomain} package option if you're only -interested in using this \texttt{symbols} glossary and don't intend -to use the \texttt{main} glossary. -\end{important} - -The \styfmt{glossaries-extra} package has a slightly modified -version of this option which additionally provides \ics{glsxtrnewsymbol} -as a convenient shortcut method for defining symbols. See the -\styfmt{glossaries-extra} manual for further details. - -\item[\pkgoptdef{numbers}] This option defines a new glossary type with -the label \texttt{numbers} via -\begin{verbatim} -\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname} -\end{verbatim} -It also defines -\begin{definition}[\DescribeMacro\printnumbers] -\cs{printnumbers}\oarg{options} -\end{definition} -which is a synonym for -\begin{alltt} -\ics{printglossary}[type=numbers,\meta{options}] -\end{alltt} - -If you use \opt1, you need to use: -\begin{alltt} -\ics{printnoidxglossary}[type=numbers,\meta{options}] -\end{alltt} -to display the list of numbers. - -\begin{important} -Remember to use the \pkgopt{nomain} package option if you're only -interested in using this \texttt{numbers} glossary and don't intend -to use the \texttt{main} glossary. -\end{important} - -The \styfmt{glossaries-extra} package has a slightly modified -version of this option which additionally provides \ics{glsxtrnewnumber} -as a convenient shortcut method for defining numbers. See the -\styfmt{glossaries-extra} manual for further details. - -\item[\pkgoptdef{index}] This option defines a new glossary type with -the label \texttt{index} via -\begin{verbatim} -\newglossary[ilg]{index}{ind}{idx}{\indexname}% -\end{verbatim} -It also defines -\begin{definition}[\DescribeMacro\newterm] -\cs{newterm}\oarg{options}\marg{term} -\end{definition} -which is a synonym for -\begin{alltt} -\ics{newglossaryentry}\marg{term}[type=index,name=\marg{term},% -description=\ics{nopostdesc},\meta{options}] -\end{alltt} -and -\begin{definition}[\DescribeMacro\printindex] -\cs{printindex}\oarg{options} -\end{definition} -which is a synonym for -\begin{alltt} -\ics{printglossary}[type=index,\meta{options}] -\end{alltt} +\xtrpkgoptsec{accsupp} -If you use \opt1, you need to use: -\begin{alltt} -\ics{printnoidxglossary}[type=index,\meta{options}] -\end{alltt} -to display this glossary. +Load the \sty{glossaries-accsupp} package. -\begin{important} -Remember to use the \pkgopt{nomain} package option if you're only -interested in using this \texttt{index} glossary and don't intend to -use the \texttt{main} glossary. Note that you -can't mix this option with \ics{index}. Either use -\styfmt{glossaries} for the indexing or use a~custom indexing -package, such as \sty{makeidx}, \sty{index} or \sty{imakeidx}. -(You can, of course, load one of those packages and -load \styfmt{glossaries} without the \pkgopt{index} package option.) -\end{important} +\xtrpkgoptsec{prefix} -Since the index isn't designed for terms with descriptions, you -might also want to disable the hyperlinks for this glossary using -the package option \pkgopt[index]{nohypertypes} or the command -\begin{display} -\ics{GlsDeclareNoHyperList}\verb|{index}| -\end{display} +Load the \sty{glossaries-prefix} package. -The example file \samplefile{-index} illustrates the use of the -\pkgopt{index} package option. +\xtrpkgoptsec[boolean]{nomissingglstext} -\item[\pkgoptdef{noglossaryindex}] This option switches off \pkgopt{index} -if \pkgopt{index} has been passed implicitly (for example, -through global document options). This option can't be used -in \cs{setupglossaries}. +This option may be used to suppress the boilerplate text generated +by \cs{printglossary} if the glossary file is missing. -\item[\pkgoptdef{compatible-2.07}] Compatibility mode for old documents +\pkgoptsec[boolean]{compatible-2.07} Compatibility mode for old documents created using version 2.07 or below. -\item[\pkgoptdef{compatible-3.07}] Compatibility mode for old documents +\pkgoptsec[boolean]{compatible-3.07} Compatibility mode for old documents created using version 3.07 or below. -\item[\pkgoptdef{kernelglossredefs}] As a legacy from the precursor +\pkgoptsec[value]{kernelglossredefs} As a legacy from the precursor \sty{glossary} package, the standard glossary commands provided by the \LaTeX\ kernel (\cs{makeglossary} and \cs{glossary}) are redefined in terms of the \styfmt{glossaries} package's commands. @@ -4503,7 +5265,7 @@ This option may take one of three values: \pkgoptfmt{true} previous definitions) or \pkgoptfmt{nowarn} (redefine without warnings, not recommended). -Note that the only glossary-related commands provided by the \LaTeX\ +The only glossary-related commands provided by the \LaTeX\ kernel are \cs{makeglossary} and \cs{glossary}. Other packages or classes may provide additional glossary-related commands or environments that conflict with \styfmt{glossaries} (such as @@ -4517,8 +5279,6 @@ In general, if possible, it's best to stick with just one package that provides a glossary mechanism. (The \styfmt{glossaries} package does check for the \sty{doc} package and patches \cs{PrintChanges}.) -\end{description} - \section{Setting Options After the Package is Loaded} \label{sec:setupglossaries} @@ -4527,7 +5287,7 @@ Some of the options described above may also be set after the \begin{definition}[\DescribeMacro{\setupglossaries}] \cs{setupglossaries}\marg{key-val list} \end{definition} -The following package options \textbf{can't} be used in +The following package options \strong{can't} be used in \cs{setupglossaries}: \pkgopt{xindy}, \pkgopt{xindygloss}, \pkgopt{xindynoglsnumbers}, \pkgopt{makeindex}, \pkgopt{nolong}, \pkgopt{nosuper}, \pkgopt{nolist}, @@ -4542,7 +5302,7 @@ using commands like \ics{GlsSetXdyLanguage} (see If you need to use this command, use it as soon as possible after loading \styfmt{glossaries} otherwise you might end up using it too late for the change to take effect. For example, -if you try changing the acronym styles (such as \pkgopt{smallcaps}) +if you try changing the acronym styles (such as \deprecatedpkgopt{smallcaps}) after you have started defining your acronyms, you are likely to get unexpected results. If you try changing the sort option after you have started to define entries, you may get unexpected results. @@ -4566,7 +5326,7 @@ The command \end{definition} must be placed in the preamble. This sets up the internal commands required to make \opt1 work. -\textbf{If you omit \cs{makenoidxglossaries} none of +\strong{If you omit \cs{makenoidxglossaries} none of the glossaries will be displayed.} \section[Options 2 and 3]{\ifpdf\optsand23\else Options 2 and 3\fi} @@ -4577,22 +5337,26 @@ The command \cs{makeglossaries} \end{definition} must be placed in the preamble in order to create the customised -\gls{makeindex} (\filetype{.ist}) or \gls{xindy} (\filetype{.xdy}) +\gls{makeindex} (\filetype{ist}) or \gls{xindy} (\filetype{xdy}) style file (for \optsor23, respectively) and to ensure that glossary entries are written to the appropriate output files. -\textbf{If you omit \cs{makeglossaries} none of +\strong{If you omit \cs{makeglossaries} none of the glossary files will be created.} -\begin{important} +\begin{xtr} +If you are using \gls{glossaries-extra}, \cs{makeglossaries} has an +optional argument that allows you to have a hybrid of \optsor12 or +\optsor13. See \gls{glossaries-extra} manual for further details. +\end{xtr} + +\importantpar Note that some of the commands provided by the \styfmt{glossaries} package must not be used after \cs{makeglossaries} as they are required when creating the customised style file. If you attempt to use those commands after \cs{makeglossaries} you will generate an error. - Similarly, there are some commands that must not be used before \cs{makeglossaries}. -\end{important} You can suppress the creation of the customised \gls{xindy} or \gls{makeindex} style file using @@ -4601,14 +5365,14 @@ or \gls{makeindex} style file using \end{definition} That this command must not be used after \cs{makeglossaries}. \begin{important} -Note that if you have a custom \filetype{.xdy} file created when using +Note that if you have a custom \filetype{xdy} file created when using \styfmt{glossaries} version 2.07 or below, you will need to use the \pkgopt{compatible-2.07} package option with it. \end{important} The default name for the customised style file is given by -\ics{jobname}\filetype{.ist} (\opt2) or -\ics{jobname}\filetype{.xdy} (\opt3). This name may be +\ics{jobname}\filetype{ist} (\opt2) or +\ics{jobname}\filetype{xdy} (\opt3). This name may be changed using: \begin{definition}[\DescribeMacro{\setStyleFile}] \cs{setStyleFile}\marg{name} @@ -4662,8 +5426,8 @@ definitions that avoids some of the issues discussed in \begin{important} \opt1 enforces the preamble-only restriction on \ics{newglossaryentry}. \opt4 requires that definitions are provided -in \texttt{.bib} format. \opt5 requires either preamble-only -definitions or the use of the \sty{glossaries-extra} package option +in \filetype{bib} format. \opt5 requires either preamble-only +definitions or the use of the \gls{glossaries-extra} package option \optfmt{docdef=restricted}. \end{important} @@ -4682,8 +5446,7 @@ New glossary entries are defined using the command: This is a short command, so values in \meta{key-val list} can't contain any paragraph breaks. Take care to enclose values containing any commas (\texttt{,}) or equal signs (\texttt{=}) 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. +from the key=value list parser. If you have a long description that needs to span multiple paragraphs, use @@ -4694,10 +5457,9 @@ list}\marg{long description} instead. Note that this command may only be used in the preamble. Be careful of unwanted spaces. \cs{longnewglossaryentry} will remove trailing spaces in the description (via \cs{unskip}) -but won't remove leading spaces (otherwise it would interfere with -commands like \cs{Glsentrydesc}). This command also appends +but won't remove leading spaces. This command also appends \cs{nopostdesc} to the end of the description, which suppresses the -post-description hook. The \sty{glossaries-extra} package provides +post-description hook. The \gls{glossaries-extra} package provides a starred version of \cs{longnewglossaryentry} that doesn't append either \cs{unskip} or \cs{nopostdesc}. @@ -4714,7 +5476,7 @@ list}\marg{long description} (These are both preamble-only commands.) For all the above commands, the first argument, \meta{label}, must be -a~unique label with which to identify this entry. \textbf{This can't contain +a~unique label with which to identify this entry. \strong{This can't contain any non-expandable commands or active characters.} The reason for this restriction is that the label is used to construct internal commands that store the associated information (similarly to commands @@ -4759,15 +5521,15 @@ alphabetically, otherwise the entries can't be sorted correctly. \end{important} \item[{\gloskey{description}}] A brief description of this term (to -appear in the glossary). Within this value, you can use +appear in the glossary). Within this value, you can use: \begin{definition}[\DescribeMacro{\nopostdesc}] \cs{nopostdesc} \end{definition} to suppress the description terminator for this entry. For example, if this entry is a parent entry that doesn't require a description, you -can do \verb|description={\nopostdesc}|. If you want a paragraph -break in the description use +can do \texttt{description\dequals\mgroup{\cs{nopostdesc}}}. If you want a paragraph +break in the description use: \begin{definition}[\DescribeMacro{\glspar}] \cs{glspar} \end{definition} @@ -4777,6 +5539,11 @@ descriptions. If you are using one of the tabular-like glossary styles that permit multi-line descriptions, use \ics{newline} not \verb"\\" if you want to force a line break. +\begin{xtr} +With \gls{glossaries-extra}, use \ics*{glsxtrnopostpunc} instead of +\cs{nopostdesc} to suppress the post-description punctuation. +\end{xtr} + \item[{\gloskey{parent}}] The label of the parent entry. Note that the parent entry must be defined before its sub-entries. See \sectionref{sec:subentries} for further details. @@ -4812,7 +5579,8 @@ that if you use \ics{gls}, \ics{Gls}, \ics{GLS}, \cs{glsdisp} before using \ics{glspl}, the \gloskey{firstplural} value won't be used with \ics{glspl}. -\textbf{Note:} prior to version 1.13, the default value of +\importantpar +Note: prior to version 1.13, the default value of \gloskey{firstplural} was always taken by appending \qt{s} to the \gloskey{first} key, which meant that you had to specify both \gloskey{plural} and \gloskey{firstplural}, even if you hadn't @@ -4836,6 +5604,14 @@ general, it's best to use the \gloskey{sort} key if the You can also override the \gloskey{sort} key by redefining \ics{glsprestandardsort} (see \sectionref{sec:pkgopts-sort}). +\begin{bib2gls} +The \gloskey{sort} key shouldn't be used with \gls{bib2gls}. It has +a system of fallbacks that allow different types of entries to +obtain the sort value from the most relevant field. See the +\gls{bib2gls} manual for further details and see also +\bibglsgallery{sorting}. +\end{bib2gls} + \opt1 by default strips the \glslink{latexexlatinchar}{standard \LaTeX\ accents} (that is, accents generated by core \LaTeX\ commands) from the \gloskey{name} key when it sets the \gloskey{sort} key. So with @@ -4868,27 +5644,27 @@ sort value starts with a symbol. Similarly if you use the \sty{inputenc} package: \begin{alltt} -\verb|\newglossaryentry{elite}{%| - name=\verb|{{|\'e\verb|}|lite\verb|}|, - description=\verb|{select group of people}| -\verb|}| +\cs{newglossaryentry}\mgroup{elite}\mgroup{\% + name=\mgroup{\mgroup{\'e}lite}, + description=\mgroup{select group of people} +} \end{alltt} This is equivalent to \begin{alltt} -\verb|\newglossaryentry{elite}{%| - name=\verb|{{|\'e\verb|}|lite\verb|}|, - description=\verb|{select group of people}|, +\cs{newglossaryentry}\mgroup{elite}\mgroup{\% + name=i\mgroup{\mgroup{\'e}lite}, + description=\mgroup{select group of people}, sort=elite -\verb|}| +} \end{alltt} Unless you use the package option \pkgopt[true]{sanitizesort}, in which case it's equivalent to: \begin{alltt} -\verb|\newglossaryentry{elite}{%| - name=\verb|{{|\'e\verb|}|lite\verb|}|, - description=\verb|{select group of people}|, +\cs{newglossaryentry}\mgroup{elite}\mgroup{\% + name=\mgroup{\mgroup{\'e}lite}, + description=\mgroup{select group of people}, sort=\'elite -\verb|}| +} \end{alltt} Again, this will place the entry before the \qt{A} group. @@ -4901,7 +5677,7 @@ will set it to the expansion of the \gloskey{name} key (if Take care with \gls{xindy} (\opt3): if you have entries with the same \gloskey{sort} value they will be treated as the same entry. If you use \gls{xindy} and aren't using the \texttt{def} -or \texttt{use} sort methods, \textbf{always} use the \gloskey{sort} +or \texttt{use} sort methods, \strong{always} use the \gloskey{sort} key for entries where the name just consists of a control sequence (for example \texttt{name=\{\cs{alpha}\}}). @@ -4936,7 +5712,7 @@ glossary}, but will not automatically add the cross-referenced entry. The referenced entry should be supplied as the value to this key. If you want to override the \qt{see} tag, you can supply the new tag in square brackets before the label. For example -\verb|see=[see also]{anotherlabel}|. \textbf{Note that if you have +\verb|see=[see also]{anotherlabel}|. \strong{Note that if you have suppressed the \gls{numberlist}, the cross-referencing information won't appear in the glossary, as it forms part of the \gls*{numberlist}.} You can override this for individual @@ -4966,12 +5742,44 @@ provides a \texttt{seealso} and \texttt{alias} key. If you want to avoid the automatic indexing triggered by the \gloskey{see} key, consider using \opt4. +\item[{\xtrgloskey{seealso}}] +This key is only available with \gls{glossaries-extra} and is +similar to \gloskey{see} but it doesn't allow for the optional tag. +The \gls{glossaries-extra} package provides \ics*{seealsoname} and +\texttt{seealso=\marg{list}} is essentially like +\texttt{see=[\ics*{seealsoname}]\meta{list}} (\optsand34 may treat +these differently). + +\item[{\xtrgloskey{alias}}] +This key is only available with \gls{glossaries-extra} and is +another form of cross-referencing. An entry can be aliased to +another entry with \texttt{alias=\marg{label}}. This behaves like +\texttt{see=\marg{label}} but also alters the behaviour of commands +like \cs{gls} so that they index the entry given by \meta{label} +instead of the original entry. More variations with the key are +available with \gls{bib2gls}. + +\item[\xtrgloskey{category}] +This key is only available with \gls{glossaries-extra} and is used +to assign a category to the entry. The value should be a label that +can be used to identify the category. See +\gls{glossaries-extra} manual for further details. + \end{description} The following keys are reserved for \ics{newacronym} (see -\sectionref{sec:acronyms}): \gloskey{long}, \gloskey{longplural}, +\sectionref{sec:acronyms}) and also for \ics*{newabbreviation} (see the +\gls{glossaries-extra} manual): \gloskey{long}, \gloskey{longplural}, \gloskey{short} and \gloskey{shortplural}. +\begin{bib2gls} +There are also special internal field names used by \gls{bib2gls}. +See the \gls{bib2gls} manual for further details. +\end{bib2gls} + +The supplementary packages \styfmt{glossaries-prefix} (\sectionref{sec:prefix}) and +\styfmt{glossaries-accsupp} (\sectionref{sec:accsupp}) provide additional keys. + \begin{important} Avoid using any of the \glslike\ or \glstextlike\ commands within the \gloskey{text}, \gloskey{first}, \gloskey{short} or @@ -4998,8 +5806,8 @@ description={select group or class}} Note that the same applies if you are using the \sty{inputenc} package: \begin{alltt} -\verb|\newglossaryentry{elite}{name={{|\'e\verb|}lite},| -description=\verb|{select group or class}}| +\cs{newglossaryentry}\mgroup{elite}\mgroup{name=\mgroup{\mgroup{\'e}lite}, +description=\mgroup{select group or class}} \end{alltt} (This doesn't apply for \XeLaTeX\ documents using the \sty{fontspec} package. For further details, see the \qt{UTF-8} section in the @@ -5702,7 +6510,7 @@ automatically at the start of the document, add the \cs{AtBeginDocument} command \emph{before} you load the \sty{glossaries} package (and \sty{babel}, if you are also loading that) to avoid the creation of the -\filetype{.glsdefs} file and any associated problems that are caused +\filetype{glsdefs} file and any associated problems that are caused by defining commands in the \env{document} environment. (See \sectionref{sec:docdefs}.) \end{important} @@ -5731,8 +6539,8 @@ the entry \texttt{perl} will be added to the main glossary, since it explicitly sets the type to \texttt{main}. \end{example} -\textbf{Note:} if you use \ics{newacronym} (see -\sectionref{sec:acronyms}) the type is set as +\importantpar +Note: if you use \ics{newacronym} (see \sectionref{sec:acronyms}) the type is set as \verb|type=\acronymtype| unless you explicitly override it. For example, if my file \texttt{myacronyms.tex} contains: \begin{verbatim} @@ -5875,7 +6683,7 @@ To overcome the first two problems, as from version 4.0 the \styfmt{glossaries} package modifies the definition of \cs{newglossaryentry} at the beginning of the \env{document} environment so that the definitions are written to an external file -(\cs{jobname}\filetype{.glsdefs}) which is then read in at the start +(\cs{jobname}\filetype{glsdefs}) which is then read in at the start of the document on the next run. The entry will then only be defined in the \env{document} environment if it doesn't already exist. This means that the entry can now be looked up in the glossary, even if @@ -5886,12 +6694,12 @@ definition, you need a second run to see the effect of your modification; this method requires an extra \cs{newwrite}, which may exceed \TeX's maximum allocation; unexpected expansion issues could occur; the \gloskey{see} key isn't stored, which means it can't be -added to the \filetype{.glsdefs} file when it's created at the end of the +added to the \filetype{glsdefs} file when it's created at the end of the document (and therefore won't be present on subsequent runs). The \gls{glossaries-extra} package provides a setting (but only for \optsand23) that allows \cs{newglossaryentry} to occur in the -document environment but doesn't create the \filetype{.glsdefs} +document environment but doesn't create the \filetype{glsdefs} file. This circumvents some problems but it means that you can't display any of the glossaries before all the entries have been defined (so it's all right if all the glossaries are at the end of @@ -6035,7 +6843,7 @@ range encaps. (See the \gls{bib2gls} manual for further details.) Neither \opt1 nor \opt4 care about the location syntax as long as it's valid \LaTeX\ code (and doesn't contain fragile commands). In both cases, the indexing is performed by writing a line to the -\texttt{.aux} file. The write operation is deferred to avoid the +\filetype{aux} file. The write operation is deferred to avoid the problems associated with \TeX's asynchronous output routine. (See, for example, \href{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=oddpage}{Finding @@ -6167,7 +6975,10 @@ this provided the inner command is expandable.) If the inner macro (as given by \verb|\|\meta{internal cs name}) contains non-expandable commands then you may need to redefine \cs{gls}\meta{internal cs name}\texttt{page} after using -\cs{glsaddprotectedpagefmt}\marg{internal cs name}. This command doesn't take any arguments +\begin{alltt} +\cs{glsaddprotectedpagefmt}\marg{internal cs name} +\end{alltt} +This command doesn't take any arguments as \emph{the location is assumed to be given by \cs{c@page}} because that's the only occasion this command should be used. For example, suppose now my page counter format uses small caps Roman numerals: @@ -6208,7 +7019,7 @@ combined with will now have lowercase Roman numerals in the location list (see \sectionref{sec:xindyloc} for further details on that command). Take care of the backslashes. The location (which ends up in -the ":locref" attribute) needs \verb|\\| but the location class +the \xindyattr{:locref} attribute) needs \verb|\\| but the location class (identified with \cs{GlsAddXdyLocation}) just has a single backslash. Note that this example will cause problems if your locations should be hyperlinks. @@ -6375,7 +7186,7 @@ information}. For example, if you are using \app{makeindex}: \write\glswrite{line_max 80}% } \end{verbatim} -This changes the page type precedence\index{page type precedence} and the maximum line length +This changes the page type precedence\index{page type precedence|main} and the maximum line length used by \app{makeindex}. Remember that if you switch to \app{xindy}, this will no longer be @@ -6400,7 +7211,7 @@ the page number. For further information on number lists, see post-processed by \gls{makeindex} or \gls{xindy} unless you have chosen \optsor14. If you don't use \ics{makeglossaries} these external files won't be created. (\optsand14 write the information to the -\filetype{.aux} file.) +\filetype{aux} file.) Note that repeated use of these commands for the same entry can cause the \gls{numberlist} to become quite long, which may not be @@ -6587,7 +7398,10 @@ If you are using hyperlinks and you want to change the font of the hyperlinked location, don't use \ics{hyperpage} (provided by the \sty{hyperref} package) as the locations may not refer to a page number. Instead, the \styfmt{glossaries} package provides number -formats listed in \tableref{tab:hyperxx}. +formats listed in \tableref{tab:hyperxx}. These commands are +designed to work with the particular location formats created by +\gls{makeindex} and \gls{xindy} and shouldn't be used in other +contexts. \begin{table}[htbp] \caption{Predefined Hyperlinked Location Formats} @@ -6620,11 +7434,21 @@ sans-serif font, you can define a command called, say, \begin{verbatim} \newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}} \end{verbatim} -and then use \texttt{hyperbsf} as the value for the \gloskey{format} +and then use \texttt{hyperbsf} as the value for the \gloskey[glslink]{format} key.\footnote{See also \ifpdf section~\ref*{sec:code:printglos} \fi \qt{Displaying the glossary} in the documented code, -\texttt{glossaries-code.pdf}.} Remember that if you use \gls{xindy}, you -will need to add this to the list of location attributes: +\texttt{glossaries-code.pdf}.} + +\begin{important} +When defining a custom location format command that uses one of the +\csmeta{hyper}{xx}{} commands, make sure that the argument of +\csmeta{hyper}{xx}{} is just the location. Any formatting must be +outside of \csmeta{hyper}{xx}{} (as in the above \cs{hyperbfsf} +example). +\end{important} + +Remember that if you use \gls{xindy}, you +will need to add this to the list of location \ixindyattrs attributes: \begin{verbatim} \GlsAddXdyAttribute{hyperbsf} \end{verbatim} @@ -6639,10 +7463,40 @@ entry's \gls{firstuseflag}. If \texttt{local=true}, the change to the \gls*{firstuseflag} will be localised to the current scope. The default is \texttt{local=false}. +\item[{\xtrgloskey[glslink]{noindex}}] This is a boolean key that +suppresses the indexing. Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{hyperoutside}}] This is a boolean key that +determines whether to put the hyperlink outside of \ics{glstextformat}. +Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{wrgloss}}] This key determines +whether to index before (\texttt{wrgloss\dequals before}) or after +(\texttt{wrgloss\dequals after}) the \gls{linktext}. +Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{textformat}}] This key identifies the +name of the control sequence to encapsulate the \gls{linktext} +instead of the default \ics{glstextformat}. +Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{prefix}}] This key locally redefines +\ics{glolinkprefix} to the given value. +Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{thevalue}}] This key explicitly sets the +location. +Only available with \gls{glossaries-extra}. + +\item[{\xtrgloskey[glslink]{theHvalue}}] This key explicitly sets the +hyperlink location. +Only available with \gls{glossaries-extra}. + \end{description} \begin{important} -The \gls{linktext} isn't scoped by default. Any unscoped +The \gls{linktext} isn't scoped by default with just the base +\styfmt{glossaries} package. Any unscoped declarations in the \gls{linktext} may affect subsequent text. \end{important} @@ -6655,7 +7509,6 @@ to determine the text to be displayed. As described above, these commands all have a star-variant (\texttt{hyper=false}) and a plus-variant (\texttt{hyper=true}) and have an optional first argument that is a \meta{key}=\meta{value} list. - These commands use \ics{glsentryfmt} or the equivalent definition provided by \ics{defglsentryfmt} to determine the automatically generated text and its format (see \sectionref{sec:glsdisplay}). @@ -6826,7 +7679,7 @@ Now the \gls{linktext} will be set to: \glsentrytext{\MakeUppercase sample} two \end{verbatim} This will generate an error because there's no entry with the label -given by \verb|\MakeUppercase sample|. The best solution here is to +\qt{\texttt{\cs{MakeUppercase} sample}}. The best solution here is to write the term out in the \gloskey{text} field and use the command in the \gloskey{name} field. If you don't use \cs{glsname} anywhere in your document, you can use \cs{gls} in the \gloskey{name} field: @@ -7175,6 +8028,12 @@ There are also analogous uppercasing commands: \section{Changing the format of the link text} \label{sec:glsdisplay} +\begin{xtr} +The \gls{glossaries-extra} package provides ways of altering the +format according to the category. See the \gls{glossaries-extra} +manual for further details. +\end{xtr} + The default format of the \gls{linktext} for the \glslike\ commands is governed by\footnote{\ics{glsdisplayfirst} and \ics{glsdisplay} are now deprecated. Backwards compatibility should be preserved but @@ -7259,7 +8118,11 @@ is in a glossary type that's had the hyperlinks switched off (using \pkgopt{nohypertypes}) or because it's the \firstuse\ and the hyperlinks have been suppressed on first use. -Note that \ics{glsifhyper} is now deprecated. +\begin{important} +The \cs{glsifhyperon} command should be used instead of +\ics{glsifhyper}, which is now deprecated (and no longer documented). +\end{important} + If you want to know if the command used to reference this entry was used with the star or plus variant, you can use: \begin{definition}[\DescribeMacro\glslinkvar] @@ -7277,7 +8140,7 @@ Note that you can also use commands such as \ics{ifglsused} within the definition of \cs{glsentryfmt} (see \sectionref{sec:glsunset}). The commands \ics{glslabel}, \ics{glstype}, \ics{glsifplural}, -\ics{glscapscase}, \ics{glscustomtext} and \ics{glsinsert} are +\ics{glscapscase}, \ics{glsinsert} and \ics{glscustomtext} are typically updated at the start of the \glslike\ and \glstextlike\ commands so they can usually be accessed in the hook user commands, such as \ics{glspostlinkhook} and \ics{glslinkpostsetkeys}. @@ -7303,7 +8166,7 @@ This uses the above commands to display just the \gloskey{first}, \gloskey{text}, \gloskey{plural} or \gloskey{firstplural} keys (or the custom text) with the insert text appended. -Alternatively, if want to change the entry format for abbreviations +Alternatively, if you want to change the entry format for abbreviations (defined via \ics{newacronym}) you can use: \begin{definition}[\DescribeMacro{\glsgenacfmt}] \cs{glsgenacfmt} @@ -7618,7 +8481,7 @@ To add all entries that have been defined, use: The optional argument is the same as for \cs{glsadd}, except there is also a key \gloskey[glsaddall]{types} which can be used to specify which glossaries to use. This should be a -comma separated list. For example, if you only want to add +comma-separated list. For example, if you only want to add all the entries belonging to the list of acronyms (specified by the glossary type \ics{acronymtype}) and a list of notation (specified by the glossary type \texttt{notation}) then you can @@ -7626,6 +8489,9 @@ do: \begin{verbatim} \glsaddall[types={\acronymtype,notation}] \end{verbatim} +If you are using \gls{bib2gls} with \gls{glossaries-extra}, you +can't use \cs{glsaddall}. Instead use the \optfmt{selection=all} +resource option to select all entries in the given \filetype{bib} files. \begin{important} Note that \cs{glsadd} and \cs{glsaddall} add the current location to @@ -7641,15 +8507,54 @@ that have already been used: \begin{definition}[\DescribeMacro\glsaddallunused] \cs{glsaddallunused}\oarg{list} \end{definition} -This command uses \cs{glsadd}\texttt{[format=@gobble]} which will +This command uses \cs{glsadd}\texttt{[format=glsignore]} which will ignore this location in the number list. The optional argument \meta{list} is a comma-separated list of glossary types. If omitted, it defaults to the list of all defined glossaries. +\begin{important} If you want to use \cs{glsaddallunused}, it's best to place the command at the end of the document to ensure that all the commands you intend to use have already been used. Otherwise you could end up with a spurious comma or dash in the location list. +\end{important} + +With \gls{glossaries-extra} and \gls{bib2gls}, \texttt{glsignore} +indicates an \qt{ignored location} which influences selection but +isn't added to the location list. In this case, if you use +\optfmt{selection=all} then only those entries that have been +explicitly indexed in the document will have location lists. The +other entries that were selected as a result of +\optfmt{selection=all} won't have location lists. + +Base \sty{glossaries} package only: +\begin{verbatim} +\documentclass{article} +\usepackage{glossaries} +\makeglossaries +\newglossaryentry{cat}{name={cat},description={feline}} +\newglossaryentry{dog}{name={dog},description={canine}} +\begin{document} +\gls{cat}. +\printglossaries +\glsaddallunused % <- make sure dog is also listed +\end{document} +\end{verbatim} +Corresponding \gls{glossaries-extra} and \gls{bib2gls} document code: +\begin{verbatim} +\documentclass{article} +\usepackage[record]{glossaries-extra} +\GlsXtrLoadResources[src={entries},selection=all] +\begin{document} +\gls{cat}. +\printunsrtglossaries +\end{document} +\end{verbatim} +With the file \texttt{entries.bib}: +\begin{verbatim} +@entry{cat,name={cat},description={feline}} +@entry{dog,name={dog},description={canine}} +\end{verbatim} \begin{example}{Dual Entries}{ex:dual} The example file \samplefile{-dual} makes use of \cs{glsadd} to @@ -7684,6 +8589,12 @@ You can then define a new dual entry: \end{verbatim} Now you can reference the acronym with \verb|\gls{svm}| or you can reference the entry in the main glossary with \verb|\gls{main-svm}|. + +Note that with \gls{bib2gls}, there are special dual entry types +that implement this behaviour. That is, if an entry is referenced +then its corresponding dual entry will automatically be selected as +well. So there is less need for \cs{glsadd} with \gls{bib2gls}. +(Although it can still be useful, as shown in \opt6.) \end{example} \chapter{Cross-Referencing Entries} @@ -7712,13 +8623,13 @@ description={firm, round fruit. See also \gls{pear}}} Note that with this method, if you don't use the cross-referenced term in the main part of the document, you will need two runs of \gls{makeglossaries}: -\begin{verbatim} -latex filename +\begin{prompt} +pdflatex filename makeglossaries filename -latex filename +pdflatex filename makeglossaries filename -latex filename -\end{verbatim} +pdflatex filename +\end{prompt} \item As described in \sectionref{sec:newglosentry}, you can use the \gloskey{see} key when you define the entry. For example: @@ -7893,7 +8804,8 @@ For example: \glsentrytitlecase{sample}{desc} \end{verbatim} (If you want title-casing in your glossary style, you might want to -investigate the \sty{glossaries-extra} package.) +investigate the \gls{glossaries-extra} package.) This command will +trigger an error if the entry is undefined. Note that this command has the same limitations as \cs{makefirstuc} which is used by commands like \cs{Gls} and \cs{Glsentryname} to upper-case @@ -7999,7 +8911,9 @@ existence of \meta{label}. \cs{Glsentrydesc}\marg{label} \end{definition} These commands display the description for the glossary entry given -by \meta{label}. \cs{Glsentrydesc} makes the first letter upper case. +by \meta{label}. + +\cs{Glsentrydesc} makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of \meta{label}. @@ -8038,7 +8952,9 @@ existence of \meta{label}. \cs{Glsentrysymbol}\marg{label} \end{definition} These commands display the symbol for the glossary entry given by -\meta{label}. \cs{Glsentrysymbol} makes the first letter upper case. +\meta{label}. + +\cs{Glsentrysymbol} makes the first letter upper case. The first form is expandable (unless the value of that key contains unexpandable commands). The second form is not expandable. Neither checks for the existence of \meta{label}. @@ -8131,7 +9047,7 @@ the existence of \meta{label}. \cs{glshyperlink}\oarg{link text}\marg{label} \end{definition} This command provides a hyperlink to the glossary entry given by -\meta{label} \textbf{but does not add any information to the +\meta{label} \strong{but does not add any information to the glossary file}. The link text is given by \ics{glsentrytext}\marg{label} by default\footnote{versions before 3.0 used \ics{glsentryname} as the default, but this could cause @@ -8193,32 +9109,47 @@ glossary} in the documented code (\texttt{glossaries-code.pdf}). All defined glossaries may be displayed using: \begin{description} -\itempar{\opt1:} -\begin{definition}[\DescribeMacro{\printnoidxglossaries}] +\item[\opt1:] +(Must be used with \ics{makenoidxglossaries} in the preamble.) +\begin{definition}[\DescribeMacro\printnoidxglossaries] \cs{printnoidxglossaries} \end{definition} -(Must be used with \ics{makenoidxglossaries} in the preamble.) -\itempar{\optsand23:} -\begin{definition}[\DescribeMacro{\printglossaries}] +\item[\optsand23:] +(Must be used with \ics{makeglossaries} in the preamble.) +\begin{definition}[\DescribeMacro\printglossaries] \cs{printglossaries} \end{definition} -(Must be used with \ics{makeglossaries} in the preamble.) \end{description} These commands will display all the glossaries in the order in which -they were defined. Note that, in the case of \optsand23, no -glossaries will appear until you have either used the Perl script -\gls{makeglossaries} or Lua script \gls{makeglossaries-lite.lua} or -have directly used \gls{makeindex} or \gls{xindy} (as described in -\sectionref{sec:makeglossaries}). (While the external files are -missing, these commands will just do \cs{null} for each missing -glossary to assist dictionary style documents that just use -\cs{glsaddall} without inserting any text. If you use -\gls{glossaries-extra}, it will insert a heading and boilerplate text when the +they were defined. + +Note that, in the case of \optsand23, no glossaries will appear +until you have either used the Perl script \gls{makeglossaries} or +Lua script \gls{makeglossaries-lite.lua} or have directly used +\gls{makeindex} or \gls{xindy} (as described in +\sectionref{sec:makeglossaries}). + +\begin{important} +While the external files are missing, \cs{printglossary} will just do +\ics{null} for each missing glossary to assist dictionary style +documents that just use \cs{glsaddall} without inserting any text. +This use of \ics{null} ensures that all indexing information is +written before the final page is shipped out. Once the external +files are present \cs{null} will no longer be used. This can cause a +spurious blank page on the first \LaTeX\ run before the glossary +files have been created. Once these files are present, \cs{null} +will no longer be used and so shouldn't cause interference for the +final document. +\end{important} + +\begin{xtr} +If you use \gls{glossaries-extra}, it will insert a heading and boilerplate text when the external files are missing. The extension package also provides \cs{printunsrtglossaries} as an alternative. See the -\gls{glossaries-extra} manual for further details.) +\gls{glossaries-extra} manual for further details. +\end{xtr} If the glossary still does not appear after you re-\LaTeX\ your document, check the \gls*{makeindex}\slash\gls*{xindy} log files to @@ -8337,6 +9268,36 @@ If you don't get an error with \texttt{sort=use} and options, then you probably need to use the \pkgopt[true]{sanitizesort} package option or make sure none of the entries have fragile commands in their \gloskey{sort} field. + +\item[{\xtrprintglosskey[\marg{label}]{label}}] +This key is only available with \gls{glossaries-extra} and labels +the glossary with \cs{label}\marg{label}. This is an alternative to +the package option \pkgopt[autolabel]{numberedsection} + +\item[\xtrprintglosskey{target}] This is a boolean key only +available with \gls{glossaries-extra}, which can be used to switch +off the automatic hypertarget for each entry. (This refers to the +target used by commands like \cs{gls} and \cs{glslink}.) + +This option is useful with \ics*{printunsrtglossary} as it allows +the same list (of sub-list) of entries to be displayed multiple +times without causing duplicate hypertarget names. + +\item[{\xtrprintglosskey[\marg{prefix}]{prefix}}] +This key is only available with \gls{glossaries-extra} and provides +another way of avoiding duplicate hypertarget names is to use a +different prefix for those names. This locally redefines +\ics{glolinkprefix} but note this will also affect the target for any entry +referenced within the glossary with commands like \cs{gls}, +\cs{glslink} or \cs{glshypertarget}. + +\item[{\xtrprintglosskey[\marg{prefix}]{targetnameprefix}}] +This key is only available with \gls{glossaries-extra}. +This is similar to the \pkgoptfmt{prefix} option, but it alters the prefix of +the hypertarget anchors without changing \ics{glslinkprefix} (so it +won't change the hyperlinks for any entries referenced in the +glossary). + \end{description} By default, the glossary is started either by \ics{chapter*} or by @@ -8423,7 +9384,7 @@ bold. If you want to change the font for the description, or if you only want to change the name font for some types of entries but not others, you might want to consider using the -\sty{glossaries-extra} package. +\gls{glossaries-extra} package. \begin{example}{Changing the Font Used to Display Entry Names in the Glossary}{ex:glsnamefont} @@ -8449,7 +9410,7 @@ This ensures that the glossary information is written in \gls{indexingapp}, and \sectionref{sec:locationsyntax} covers the issues involved in the location syntax. This section covers the commands provided by the \styfmt{glossaries} package that allow you -to adjust the \gls{xindy} style file (\filetype{.xdy}) and +to adjust the \gls{xindy} style file (\filetype{xdy}) and parameters. To assist writing information to the \gls{xindy} style @@ -8509,7 +9470,7 @@ and encoding used (unless you have written your own custom \gls*{xindy} style file that defines the relevant alphabet and sort rules). If you use \gls{makeglossaries}, this information is obtained from the document's auxiliary -(\filetype{.aux}) file. The \gls{makeglossaries} script attempts to +(\filetype{aux}) file. The \gls{makeglossaries} script attempts to find the root language given your document settings, but in the event that it gets it wrong or if \gls*{xindy} doesn't support that language, then you can specify the required language using: @@ -8575,7 +9536,7 @@ counter in the \gloskey[glslink]{counter} key for commands like \end{definition} where \meta{counter list} is a comma-separated list of counter names. -The most likely attributes used in the \gloskey[glslink]{format} +The most likely \ixindyattrs attributes used in the \gloskey[glslink]{format} key (\locfmt{textrm}, \locfmt{hyperrm} etc) are automatically added to the \gls{xindy} style file, but if you want to use another attribute, you need to add it using: @@ -8587,7 +9548,7 @@ the \gloskey[glslink]{format} key. Take care if you have multiple instances of the same location with different formats. The duplicate locations will be discarded -according to the order in which the attributes are listed. Consider +according to the order in which the \ixindyattrs attributes are listed. Consider defining semantic commands to use for primary references. For example: \begin{verbatim} @@ -8609,7 +9570,7 @@ command that will do this: \newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} \end{verbatim} but with \gls{xindy}, I also need to add this as an allowed -attribute: +\ixindyattrs attribute: \begin{verbatim} \GlsAddXdyAttribute{hyperbfit} \end{verbatim} @@ -9052,6 +10013,13 @@ glossary type will automatically be added to the the entries in an ignored glossary. (The sample file \samplefile{-entryfmt} defines an ignored glossary.) +\begin{xtr} +The \gls{glossaries-extra} package provides a starred version of +this command that allows hyperlinks (since ignored glossaries can be +useful with \gls{bib2gls}). There is also an analogous +\ics*{provideignoredglossary} command. +\end{xtr} + You can test if a glossary is an ignored one using: \begin{definition}[\DescribeMacro\ifignoredglossary] \cs{ifignoredglossary}\marg{name}\marg{true}\marg{false} @@ -9111,9 +10079,11 @@ change LaTeX’s \qt{fixed names}}. \chapter{Acronyms and Other Abbreviations} \label{sec:acronyms} -The \sty{glossaries-extra} package provides superior +\begin{xtr} +The \gls{glossaries-extra} package provides superior abbreviation handling. You may want to consider using that package instead of the commands described here. +\end{xtr} \begin{important} Note that although this chapter uses the term \qt{acronym}, you can also @@ -9124,8 +10094,8 @@ should be \qt{Abbreviations} rather than \qt{Acronyms}) then you can change the title either by redefining \ics{acronymname} (see \sectionref{sec:languages}) or by using the \gloskey[printglossary]{title} in the optional argument of \ics{printglossary} (or -\ics{printacronym}). Alternatively consider using the -\sty{glossaries-extra} package's \pkgoptfmt{abbreviations} +\ics{printacronyms}). Alternatively consider using the +\gls{glossaries-extra} package's \pkgopt*{abbreviations} option instead. \end{important} @@ -9192,7 +10162,7 @@ changed by the associated language files, but they can't be added to the usual caption hooks as there's no guarantee when they'll be expanded (as \hyperref[pluralsuffix]{discussed earlier}). A different approach is used by \styfmt{glossaries-extra}, which has -category attributes to determine whether or not to append a suffix +\icatattrs category attributes to determine whether or not to append a suffix when forming the default value of \gloskey{shortplural}. Since \ics{newacronym} uses \ics{newglossaryentry}, you can use @@ -9215,7 +10185,7 @@ The following defines the abbreviation IDN: \end{verbatim} \verb|\gls{idn}| will produce \qt{identification number (IDN)} on \firstuse\ and \qt{IDN} on subsequent uses. If you want to use one -of the smallcaps acronym styles, described in +of the \gls{smallcaps} acronym styles, described in \sectionref{sec:setacronymstyle}, you need to use lower case characters for the shortened form: \begin{verbatim} @@ -9246,7 +10216,7 @@ you may be tempted to do: \begin{verbatim} \newacronym{shtml}{S\gls{html}}{\gls{ssi} enabled \gls{html}} \end{verbatim} -\textbf{Don't!} This will break the case-changing commands, such +\strong{Don't!} This will break the case-changing commands, such as \ics{Gls}, it will cause inconsistencies on \firstuse, and, if hyperlinks are enabled, will cause nested hyperlinks. It will also confuse the commands used by the entry formatting (such as @@ -9267,7 +10237,7 @@ or \end{verbatim} Similarly for the \glstextlike\ commands. -Other approaches are available with \sty{glossaries-extra}. +Other approaches are available with \gls{glossaries-extra}. See the section \qt{Nested Links} in the \styfmt{glossaries-extra} user manual. @@ -9357,8 +10327,8 @@ This is a shortcut for which by default does \begin{alltt} \cs{acrfullformat} - \{\cs{acrlong}\oarg{options}\marg{label}\marg{insert}\} - \{\cs{acrshort}\oarg{options}\marg{label}\} + \mgroup{\cs{acrlong}\oarg{options}\marg{label}\marg{insert}} + \mgroup{\cs{acrshort}\oarg{options}\marg{label}} \end{alltt} where \begin{definition}[\DescribeMacro\acrfullformat] @@ -9515,7 +10485,7 @@ using the \gls{glossaries-extra} package, which has better abbreviation management. \end{important} -Note that unlike the default behaviour of \cs{newacronym}, the +Unlike the default behaviour of \cs{newacronym}, the styles used via \cs{setacronymstyle} don't use the \gloskey{first} or \gloskey{text} keys, but instead they use \ics{defglsentryfmt} to set a~custom format that uses the \gloskey{long} and \gloskey{short} @@ -9568,7 +10538,7 @@ in lower case. \ifpdf Remember that \verb|\textsc{abc}| produces \hypertarget{boldsc}{}% \begin{important}% -Some fonts don't support bold smallcaps, so you may need to redefine +Some fonts don't support bold \gls{smallcaps}, so you may need to redefine \ics{glsnamefont} (see \sectionref{sec:printglossary}) to switch to medium weight if you are using a glossary style that displays entry names in bold and you have chosen an acronym style that uses @@ -9737,14 +10707,17 @@ and then redefine \ics{acronymsort} and \ics{acronymentry}: (I've used \cs{space} for extra clarity, but you can just use an actual space instead.) -Since the default Computer Modern fonts don't support bold -smallcaps, I'm also going to redefine \ics{acronymfont} so that it -always switches to medium weight to ensure the smallcaps setting is -used: +Note that the default Computer Modern fonts don't support bold +\gls{smallcaps}, so another font is required. For example: +\begin{verbatim} +\usepackage[T1]{fontenc} +\end{verbatim} +The alternative is to redefine \ics{acronymfont} so that it +always switches to medium weight to ensure the \gls{smallcaps} setting is +used. For example: \begin{verbatim} \renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}} \end{verbatim} -This isn't necessary if you use a font that supports bold smallcaps. The sample file \samplefile{FnAcrDesc} illustrates this example. @@ -10006,7 +10979,7 @@ change the above to: \end{verbatim} The acronym font needs to be set to \ics{textsc} and the plural suffix adjusted so that the \qt{s} suffix in the plural short form -doesn't get converted to smallcaps: +doesn't get converted to \gls{smallcaps}: \begin{verbatim} \renewcommand*{\acronymfont}[1]{\textsc{##1}}% \renewcommand*{\acrpluralsuffix}{\glstextup{\glspluralsuffix}}% @@ -10288,8 +11261,7 @@ before the full stop. The next example shows one way of achieving this. (Note that the supplemental \gls{glossaries-extra} package provides a much simpler way of doing this, which you may prefer to use. See the -\href{http://www.dickimaw-books.com/gallery/sample-initialisms.shtml}{initialisms -example}.) +\gallery{sample-initialisms.shtml}{initialisms example}.) \begin{example}{Abbreviations with Full Stops (Periods)}{ex:dotabbr} As from version 4.16, there's now a hook (\ics{glspostlinkhook}) @@ -10458,7 +11430,8 @@ names consisting of alphabetical characters. This is also true for using \sty{xspace}.\footnotemark \end{important} \footnotetext{See David Carlisle's explanation in -\url{http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace}} +\href{http://tex.stackexchange.com/questions/86565/drawbacks-of-xspace}{Drawbacks +of xspace}} The \styfmt{glossaries} package doesn't load the \sty{xspace} package since there are both advantages and disadvantages to using @@ -10642,6 +11615,13 @@ checks for this. For \sty{tabularx}, you need to explicitly patch it by placing \cs{glspatchtabularx} in the preamble (or anywhere before the problematic use of \envfmt{tabularx}). +\begin{xtr} +If you need to use commands like \cs{gls} in any problematic context +that interferes with the \gls{firstuseflag}, then you can try using +the buffering system provided with \gls{glossaries-extra}. See the +\qt{First Use Flag} section of the \gls{glossaries-extra} manual. +\end{xtr} + \section{Counting the Number of Times an Entry has been Used (First Use Flag Unset)} \label{sec:enableentrycount} @@ -10676,7 +11656,7 @@ to zero (where \cs{glslocalreset} performs a~local change). The \texttt{prevcount} field stores the final value of the \texttt{currcount} field \emph{from the previous run}. This value is -read from the \texttt{.aux} file at the beginning of the +read from the \filetype{aux} file at the beginning of the \env{document} environment. You can access these fields using @@ -10687,8 +11667,11 @@ for the \texttt{currcount} field, and \begin{definition}[\DescribeMacro\glsentryprevcount] \cs{glsentryprevcount}\marg{label} \end{definition} -for the \texttt{prevcount} field. \textbf{These commands are -only defined if you have used \cs{glsenableentrycount}.} +for the \texttt{prevcount} field. + +\begin{important} +These commands are only defined if you have used \cs{glsenableentrycount}. +\end{important} For example: \begin{verbatim} @@ -10866,6 +11849,11 @@ synonym. For example \let\ac\cgls \end{verbatim} +\begin{bib2gls} +With \gls{bib2gls} there's an analogous record counting set of +commands. See \gls{glossaries-extra} and \gls{bib2gls} manuals for further details. +\end{bib2gls} + \chapter{Glossary Styles} \label{sec:styles} @@ -10879,8 +11867,7 @@ with a number of pre-defined glossary styles, described in best suits your type of glossary or, if none of them suit your document, you can defined your own style (see \sectionref{sec:newglossarystyle}). There are some examples -of glossary styles available at -\url{http://www.dickimaw-books.com/gallery/#glossaries}. +of glossary styles available at \gallerytopic{glossaries}. The glossary style can be set using the \gloskey[printglossary]{style} key in the optional argument to \ics{printnoidxglossary} (\opt1) or \ics{printglossary} @@ -10896,9 +11883,15 @@ is automatically loaded by the \styfmt{glossaries} package. You can use the lorum ipsum dummy entries provided in the accompanying -\texttt{example-glossaries-*.tex} files (described in +\texttt{example\dhyphen glossaries\dhyphen *.tex} files (described in \sectionref{sec:lipsum}) to test the different styles. +\begin{xtr} +The \sty{glossaries-extra-stylemods} package provided with +\gls{glossaries-extra} patches the predefined styles. There also +more styles available with \gls{glossaries-extra}. +\end{xtr} + \section{Predefined Styles} \label{sec:predefinedstyles} @@ -10909,7 +11902,7 @@ package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and \sectionref{sec:pkgopts-printglos}. There is a summary of available styles in \tableref{tab:styles}. You can view samples of all the predefined styles at -\url{http://www.dickimaw-books.com/gallery/glossaries-styles/}. +\galleryurl{glossaries-styles/}. Note that \gls{glossaries-extra} provides additional styles in the supplementary packages \sty{glossary-bookindex} and \sty{glossary-longnoloc}. See the \gls{glossaries-extra} manual for @@ -10967,10 +11960,15 @@ be displayed.} \end{table} The tabular-like styles that allow multi-line descriptions and page -lists use the length \DescribeMacro{\glsdescwidth}\cs{glsdescwidth} +lists use the length +\begin{definition}[\DescribeMacro{\glsdescwidth}] +\cs{glsdescwidth} +\end{definition} to set the width of the description column and the length -\DescribeMacro{\glspagelistwidth}\cs{glspagelistwidth} to set the -width of the page list column.\footnote{These lengths will not be +\begin{definition}[\DescribeMacro{\glspagelistwidth}] +\cs{glspagelistwidth} +\end{definition} +to set the width of the page list column.\footnote{These lengths will not be available if you use both the \pkgopt{nolong} and \pkgopt{nosuper} package options or if you use the \pkgopt{nostyles} package option unless you explicitly load the relevant package.} @@ -11033,15 +12031,15 @@ a comma) you will need to redefine \cs{glspostdescription} before the glossary is displayed. Alternatively, you can suppress it for a given entry by placing \ics{nopostdesc} in the entry's description. Note that \ics{longnewglossaryentry} puts \cs{nopostdesc} at the end -of the description. The \sty{glossaries-extra} package provides a +of the description. The \gls{glossaries-extra} package provides a starred version that doesn't. As from version 3.03 you can now use the package option \pkgopt{nopostdot} to suppress this full stop. This is the better -option if you want to use the \sty{glossaries-extra} package. +option if you want to use the \gls{glossaries-extra} package. The \sty{glossaries-extra-stylemods} package provides some adjustments some of to the predefined styles listed here, allowing -for greater flexibility. See the \sty{glossaries-extra} +for greater flexibility. See the \gls{glossaries-extra} documentation for further details. \subsection{List Styles} @@ -11580,7 +12578,7 @@ style is like \glostyle{superragged3col} but has a header row. \item[superragged3colheaderborder] The \glostyle{superragged3colheaderborder} style is like -\glostyle{superragged3colheader} but has horizontal and vertical +the above but has horizontal and vertical lines around it. \item[altsuperragged4col] The \glostyle{altsuperragged4col} style is @@ -11600,7 +12598,7 @@ lines around it. \item[altsuperragged4colheaderborder] The \glostyle{altsuperragged4colheaderborder} style is like -\glostyle{altsuperragged4colheader} but has horizontal and vertical +the above but has horizontal and vertical lines around it. \end{description} @@ -11635,7 +12633,9 @@ the navigation line using \begin{definition}[\DescribeMacro\glstreenavigationfmt] \cs{glstreenavigationfmt}\marg{text} \end{definition} -which defaults to \cs{glstreenamefmt}\marg{text}. Note that this is +which defaults to \cs{glstreenamefmt}\marg{text}. + +Note that this is different from \cs{glslistnavigationitem}, provided with the styles such as \glostyle{listhypergroup}, as that also includes \cs{item}. @@ -11945,7 +12945,7 @@ This is used to format the entry name and defaults to \cs{glstarget}\marg{label}\marg{name}, where \meta{name} is provided in the form \cs{glossentryname}\marg{label} and \meta{label} is the entry's label. For example, if you want the name to appear in -smallcaps: +\gls{smallcaps}: \begin{verbatim} \renewcommand*{\glsinlinenameformat}[2]{\glstarget{#1}{\textsc{#2}}} \end{verbatim} @@ -12001,7 +13001,9 @@ needs to redefine all of the following: \env{theglossary} \end{definition} This environment defines how the main body of the glossary should -be typeset. Note that this does not include the section heading, +be typeset. + +Note that this does not include the section heading, the glossary preamble (defined by \ics{glossarypreamble}) or the glossary postamble (defined by \ics{glossarypostamble}). For example, the \glostyle{list} style uses the \env{description} environment, @@ -12071,8 +13073,10 @@ redefines \cs{glsgroupheading} as follows: \renewcommand*{\glsgroupheading}[1]{% \item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]} \end{verbatim} -See also \cs{glsgroupskip} below. (Note that command definitions within -\ics{newglossarystyle} must use \verb|##1| instead of \verb|#1| etc.) +See also \cs{glsgroupskip} below. + +Note that command definitions within +\ics{newglossarystyle} must use \verb|##1| instead of \verb|#1| etc. \begin{definition}[\DescribeMacro{\glsgroupskip}] \cs{glsgroupskip} @@ -12334,6 +13338,11 @@ that displays each entry in a \env{longtable} as follows: This section describes some utility commands. Additional commands can be found in the documented code (glossaries-code.pdf). +\begin{xtr} +The \gls{glossaries-extra} package provides extra utility commands. +See the \qt{Utilities} section of the \gls{glossaries-extra} manual. +\end{xtr} + \section{Loops} \label{sec:loops} @@ -12680,6 +13689,25 @@ instead of \cs{ifdefstrequal}. \section{Fetching and Updating the Value of a Field} \label{sec:fetchset} +In addition to the commands described in \sectionref{sec:glsnolink}, +the following may also be used to fetch field information. +\begin{definition}[\DescribeMacro\glsentrytype] +\cs{glsentrytype}\marg{label} +\end{definition} +Expands to the entry's glossary type. No existence check is +performed. + +\begin{definition}[\DescribeMacro\glsentryparent] +\cs{glsentryparent}\marg{label} +\end{definition} +Expands to the label of the entry's parent. No existence check is +performed. + +\begin{definition}[\DescribeMacro\glsentrysort] +\cs{glsentrysort}\marg{label} +\end{definition} +Expands to the entry's sort value. No existence check is performed. + You can fetch the value of a given field and store it in a control sequence using: \begin{definition}[\DescribeMacro\glsfieldfetch] @@ -12758,7 +13786,7 @@ the \gloskey{prefixplural} key. \begin{example}{Defining Determiners}{ex:determiners} Here's the start of my example document: \begin{verbatim} -documentclass{article} +\documentclass{article} \usepackage[colorlinks]{hyperref} \usepackage[toc,acronym]{glossaries-prefix} @@ -12775,8 +13803,11 @@ non-breakable space after \qt{a} in the \gloskey{prefix} field.}: prefixplural={the\space}% } \end{verbatim} -Note that I've had to explicitly insert a~space after the prefix. -This allows for the possibility of prefixes that shouldn't have a~space, +Note that I've had to explicitly insert a~space after the prefix +since there's no designated separator between the prefix and the +term being referenced. This not only means that you can vary between +a breaking space and non-breaking space, but also +allows for the possibility of prefixes that shouldn't have a~space, such as: \begin{verbatim} \newglossaryentry{oeil}{name={oeil}, @@ -12790,6 +13821,16 @@ a~spacing command, such as \cs{space}, \verb*|\ | (backslash space) or \verb|~| due to the automatic spacing trimming performed in \meta{key}=\meta{value} options. +In the event that you always require a space between the prefix and +the term, then you can instead redefine +\begin{definition}[\DescribeMacro\glsprefixsep] +\cs{glsprefixsep} +\end{definition} +to do a space. (This command does nothing by default.) For example: +\begin{verbatim} +\renewcommand{\glsprefixsep}{\space} +\end{verbatim} + The prefixes can also be used with acronyms. For example: \begin{verbatim} \newacronym @@ -12895,7 +13936,7 @@ non-empty value for the \gloskey{prefixfirst} key. \cs{ifglshasprefixfirstplural}\marg{label}\marg{true part}\marg{false part} \end{definition} Does \meta{true part} if the entry identified by \meta{label} has a -non-empty value for the \gloskey{prefixfirstplural} key. +non-empty value for the \csoptfmt{prefix\-first\-plural} key. \begin{definition}[\DescribeMacro\glsentryprefix] \cs{glsentryprefix}\marg{label} @@ -12955,11 +13996,39 @@ before the name: \setglossarystyle{list}% \renewcommand*{\glossentry}[2]{% \item[\glsentryitem{##1}% - \Glsentryprefix{##1}% + \glsentryprefix{##1}% + \glstarget{##1}{\glossentryname{##1}}] + \glossentrydesc{##1}\glspostdescription\space ##2}% +} +\end{verbatim} +If you want to change the prefix separator (\cs{glsprefixsep}) then +the following is better: +\begin{verbatim} +\newglossarystyle{plist}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \ifglshasprefix{##1}{\glsentryprefix{##1}\glsprefixsep}{}% \glstarget{##1}{\glossentryname{##1}}] \glossentrydesc{##1}\glspostdescription\space ##2}% } \end{verbatim} +The conditional is also useful if you want the style to use an +uppercase letter at the start of the entry item: +\begin{verbatim} +\newglossarystyle{plist}{% + \setglossarystyle{list}% + \renewcommand*{\glossentry}[2]{% + \item[\glsentryitem{##1}% + \glstarget{##1}% + {% + \ifglshasprefix{##1}% + {\Glsentryprefix{##1}\glsprefixsep\glossentryname{##1}}% + {\Glossentryname{##1}}% + }] + \glossentrydesc{##1}\glspostdescription\space ##2}% +} +\end{verbatim} \end{example} \chapter{Accessibility Support}\label{sec:accsupp} @@ -12967,10 +14036,30 @@ before the name: Limited accessibility support is provided by the accompanying \sty{glossaries-accsupp} package, but note that this package is experimental and it requires the \sty{accsupp} package -which is also listed as experimental. This package defines +which is also listed as experimental. This package automatically +loads the \sty{glossaries} package. Any options are passed to +\sty{glossaries} (if it hasn't already been loaded). For example: +\begin{verbatim} +\usepackage[acronym]{glossaries-accsupp} +\end{verbatim} +This will load \sty{glossaries} with the \pkgopt{acronym} package +option as well as loading \sty{glossaries-accsupp}. + +If you are using the \gls{glossaries-extra} extension package, you +need to load \gls{glossaries-extra} with the \pkgopt*{accsupp} +package option. For example: +\begin{verbatim} +\usepackage[abbreviations,accsupp]{glossaries-extra} +\end{verbatim} +This will load \gls{glossaries-extra} (with the +\pkgopt*{abbreviations} option), \sty{glossaries} and +\sty{glossaries-accsupp} and make appropriate patches to integrate +the accessibility support with the extension commands. + +The \sty{glossaries-accsupp} package defines additional keys that may be used when defining glossary entries. The keys are as follows: -\begin{description} +\begin{description}\raggedright \item[{\gloskey{access}}] The replacement text corresponding to the \gloskey{name} key. @@ -13010,22 +14099,5085 @@ the \gloskey{longplural} key (used by \ics{newacronym}). \item[{\gloskey{shortpluralaccess}}] The replacement text corresponding to the \gloskey{shortplural} key (used by \ics{newacronym}). +\item[{\gloskey{user1access}}] The replacement text corresponding to +the \gloskey{user1} key. + +\item[{\gloskey{user2access}}] The replacement text corresponding to +the \gloskey{user2} key. + +\item[{\gloskey{user3access}}] The replacement text corresponding to +the \gloskey{user3} key. + +\item[{\gloskey{user4access}}] The replacement text corresponding to +the \gloskey{user4} key. + +\item[{\gloskey{user5access}}] The replacement text corresponding to +the \gloskey{user5} key. + +\item[{\gloskey{user6access}}] The replacement text corresponding to +the \gloskey{user6} key. \end{description} For example: \begin{verbatim} \newglossaryentry{tex}{name={\TeX},description={Document preparation language},access={TeX}} \end{verbatim} -Now \verb|\gls{tex}| will be equivalent to +Now the \gls{linktext} produced by \verb|\gls{tex}| will be: \begin{verbatim} -\BeginAccSupp{ActualText=TeX}\TeX\EndAccSupp{} +\BeginAccSupp{ActualText={TeX}}\TeX\EndAccSupp{} \end{verbatim} The sample file \samplefile{accsupp} illustrates the \sty{glossaries-accsupp} package. +If you prefer to use \sty{accessibility} or \sty{tagpdf} instead of +\sty{accsupp} then you'll need to define \cs{gls@accsupp@engine} and +\cs{gls@accessibility} before loading \sty{glossaries-accsupp}. See +\ifpdf section~\ref*{sec:code:accsupp} \else the section +\qt{Accessibility Support}\fi in the documented code for further +details. + +The PDF specification identifies three different types of +replacement text: +\begin{description} +\item[Alt] Description of some content that's non-textual (for +example, an image). A word break is assumed after the content. +\item[ActualText] A character or sequence of characters that +replaces textual content (for example, a dropped capital, a +ligature or a symbol). No word break is assumed after the content. +\item[E] Expansion of an abbreviation to avoid ambiguity (for +example, \qt{St} could be short for \qt{saint} or \qt{street}). +\end{description} + +\begin{important} +Many PDF viewers don't actually support any type of replacement text. Some may +support \qt{ActualText} but not \qt{Alt} or \qt{E}. +\href{https://pdfbox.apache.org/}{PDFBox}'s \qt{PDFDebugger} tool +can be used to inspect the PDF content to make sure that the +replacement text has been correctly set. +\end{important} + +If you define abbreviations with \ics{newacronym}, the +\gloskey{shortaccess} field will automatically be set to: +\begin{definition}[\DescribeMacro\glsdefaultshortaccess] +\cs{glsdefaultshortaccess}\marg{long}\marg{short} +\end{definition} +With the base \styfmt{glossaries} package this just expands to +\meta{long}. With \gls{glossaries-extra} this expands to \meta{long} +(\meta{short}). This command must be fully expandable. It expands +when the abbreviation is defined. + +As from \sty{glossaries-accsupp} v4.45, the helper command used to +identify the replacement text depends on the field name. Previous +versions just used: +\begin{definition}[\DescribeMacro\glsaccsupp] +\cs{glsaccsupp}\marg{replacement}\marg{content} +\end{definition} +for all fields. This is defined to use \texttt{ActualText}, which is +appropriate for symbols but not for abbreviations. + +As from v4.45, there's a new helper command: +\begin{definition}[\DescribeMacro\glsfieldaccsupp] +\cs{glsfieldaccsupp}\marg{replacement}\marg{content}\marg{field}\marg{label} +\end{definition} +This will use \csmeta{gls}{field}{accsupp} if it's defined otherwise +it will just use \cs{glsaccsupp}. There are just two of these field +commands for \gloskey{short} and \gloskey{shortplural}: +\begin{definition}[\DescribeMacro\glsshortaccsupp] +\cs{glsshortaccsupp}\marg{replacement}\marg{content} +\end{definition} +which is like \cs{glsaccsupp} but uses \texttt{E} instead of +\texttt{ActualText} and +\begin{definition}[\DescribeMacro\glsshortplaccsupp] +\cs{glsshortplaccsupp}\marg{replacement}\marg{content} +\end{definition} +which just does \cs{glsshortaccsupp}\marg{replacement}\marg{content}. +Note that \meta{field} indicates the \emph{internal} field name +(such as \texttt{shortpl}) not the key name (such as +\texttt{shortplural}). See \tableref{tab:fieldmap}. + +Rather than explicitly using \ics{BeginAccSupp}, these helper +commands can use: +\begin{definition}[\DescribeMacro\glsaccessibility] +\cs{glsaccessibility}\oarg{options}\marg{tag}\marg{value}\marg{content} +\end{definition} +where \meta{tag} is one of \texttt{E}, \texttt{Alt} or +\texttt{ActualText}. The replacement text for \meta{content} should be provided in +\meta{value}. +This does: +\begin{alltt} +\ics{BeginAccSupp}\mgroup{\meta{tag}=\marg{value},\meta{options}}\meta{content}\ics{EndAccSupp}\mgroup{} +\end{alltt} +but it also provides debugging information if \pkgopt[showaccsupp]{debug} is used. +If you explicitly use \cs{BeginAccSupp} instead of this command then +the debugging support won't be available. + +You can define your own custom helper commands for specific fields +that require them. For example: +\begin{verbatim} +\newcommand{\glssymbolaccsupp}[2]{% + \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% +} +\end{verbatim} +This definition requires the replacement text to be specified with +the hexadecimal character code. For example: +\begin{verbatim} +\newglossaryentry{int}{name={int},description={integral}, + symbol={\ensuremath{\int}},symbolaccess={222B} +} +\end{verbatim} + +If you are using \gls{glossaries-extra}, then \cs{glsfieldaccsupp} +will first test for the existence of +\csmetameta*{glsxtr}{category}{}{field}{accsupp} +and \csmeta*{glsxtr}{category}{accsupp} and then for +\csmeta{gls}{field}{accsupp}. For example: +\begin{verbatim} +\usepackage{siunitx} +\usepackage[accsupp]{glossaries-extra} + +\glsnoexpandfields + +\newcommand{\glsxtrsymbolaccsupp}[2]{% + \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% +} + +\newcommand{\glsxtrunitaccsupp}[2]{\glsaccessibility{E}{#1}{#2}} + +\newglossaryentry{cm}{name={\si{\centi\metre}}, + access={centimetre}, + description={centimetre}, + category=unit +} + +\newglossaryentry{int}{name={\ensuremath{\int}},access={222B}, + description={integral},category={symbol} +} +\end{verbatim} +The above uses the \csmeta*{glsxtr}{category}{accsupp} form that +doesn't include the field name. Remember that if you want to supply +a command specifically for the \gloskey{name} field then it won't be +picked up by the \gloskey{text}, \gloskey{plural}, \gloskey{firstplural} and +\gloskey{first} fields. You'd need to supply them all. For example: +\begin{verbatim} +\newcommand{\glsnameaccsupp}[2]{% + \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% +} +\newcommand{\glstextaccsupp}{\glsnameaccsupp} +\newcommand{\glspluralaccsupp}{\glsnameaccsupp} +\newcommand{\glsfirstaccsupp}{\glsnameaccsupp} +\newcommand{\glsfirstplaccsupp}{\glsnameaccsupp} +\end{verbatim} + See \ifpdf section~\ref*{sec:code:accsupp} in \fi the documented code (\texttt{glossaries-code.pdf}) for further details. I~recommend -that you also read the \sty{accsupp} documentation. +that you also read the \sty{accsupp} documentation. See also the +\sty{accessibility} and \sty{tagpdf} packages. + +\chapter{Sample Documents} +\label{sec:samples} + +The \styfmt{glossaries} package is provided with some sample +documents that illustrate the various functions. These should +be located in the \texttt{samples} subdirectory (folder) of the +\styfmt{glossaries} documentation directory. This location varies +according to your operating system and \TeX\ distribution. You +can use \texttt{texdoc} to locate the main glossaries documentation. +For example, in a +\href{http://www.dickimaw-books.com/latex/novices/html/terminal.html}{terminal or command prompt}, type: +\begin{prompt} +texdoc -l glossaries +\end{prompt} +This should display a list of all the files in the \styfmt{glossaries} +documentation directory with their full pathnames. (The GUI version +of \texttt{texdoc} may also provide you with the information.) + +If you can't find the sample files on your computer, they are also available +from your nearest CTAN mirror at +\url{http://mirror.ctan.org/macros/latex/contrib/glossaries/samples/}. +Each sample file listed below has a hyperlink to the file's location on +the CTAN mirror. + +The \gls{glossaries-extra} package and \gls{bib2gls} +provide some additional sample files. There are also examples in the +\gallery{}{Dickimaw Books Gallery}. + +If you prefer to use UTF-8 aware engines (\texttt{xelatex} or +\texttt{lualatex}) remember that you'll need to switch from +\styfmt{fontenc} \& \styfmt{inputenc} to \styfmt{fontspec} where +appropriate. + +\commandpromptnote +If you get any errors or unexpected results, check that you have up-to-date versions of +all the required packages. (Search the log file for lines starting +with \qt{\texttt{Package:\ }}.) Where \sty{hyperref} is loaded you will +get warnings about non-existent references that look something like: +\begin{verbatim} +pdfTeX warning (dest): name{glo:aca} has been +referenced but does not exist, replaced by a fixed one +\end{verbatim} +These warnings may be ignored on the first \LaTeX\ run. (The +destinations won't be defined until the glossary has been created.) + +\section{Basic} +\label{sec:samplesbasic} + +\exitem[minimal]{gls} This document is a +minimal working example. You can test your installation using this +file. To create the complete document you will need to do the +following steps: + \begin{enumerate} + \item Run \texttt{minimalgls.tex} through \LaTeX\ either by + typing +\begin{prompt} +pdflatex minimalgls +\end{prompt} + in a terminal or by using the relevant button or menu item in + your text editor or front-end. This will create the required + associated files but you will not see the glossary in the document. + + \item If you have Perl installed, run \gls{makeglossaries} on the document (\sectionref{sec:makeglossaries}). This can + be done on a terminal by typing: +\begin{prompt} +makeglossaries minimalgls +\end{prompt} + otherwise do: +\begin{prompt} +makeglossaries-lite minimalgls +\end{prompt} + If for some reason you want to call \gls{makeindex} explicitly, you can do this + in a terminal by typing (all on one line): +\begin{prompt} +makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo +\end{prompt} + See \sectionref{sec:makeindexapp} for further details on using + \gls*{makeindex} explicitly. + + Note that if the file name contains spaces, you will need to use + the double-quote character to delimit the name. + + \item Run \texttt{minimalgls.tex} through \LaTeX\ again (as step~1) + \end{enumerate} +You should now have a complete document. The number following +each entry in the glossary is the location number. By default, this +is the page number where the entry was referenced. + +The \pkgopt{acronym} package option creates a second glossary with +the label \texttt{acronym} (which can be referenced with +\cs{acronymtype}). If you decide to enable this option then there +will be a second set of glossary files that need to be processed by +\gls{makeindex}. If you use \gls{makeglossaries} or +\gls{makeglossaries-lite.lua} you don't need to worry about it, as +those scripts automatically detect which files need to be processed +and will run \gls{makeindex} (or \gls{xindy}) the appropriate number +of times. + +If for some reason you don't want to use \gls{makeglossaries} or +\gls{makeglossaries-lite.lua} and you want the \pkgopt{acronym} +package option then the complete build process is: +\begin{prompt} +pdflatex minimalgls +makeindex -s minimalgls.ist -t minimalgls.glg -o minimalgls.gls minimalgls.glo +makeindex -s minimalgls.ist -t minimalgls.alg -o minimalgls.acr minimalgls.acn +pdflatex minimalgls +\end{prompt} + +There are three other files that can be used as +\href{http://www.dickimaw-books.com/latex/minexample/}{minimal working +examples}: \mirrorsamplefile{mwe-gls.tex}, \mirrorsamplefile{mwe-acr.tex} and +\mirrorsamplefile{mwe-acr-desc.tex}. + +\glsxtrnote +If you want to try out the \gls{glossaries-extra} extension package, +you need to replace the package loading line: +\begin{alltt} +\cs{usepackage}[acronym]\mgroup{\strong{glossaries}} +\end{alltt} +with: +\begin{alltt} +\cs{usepackage}[acronym\strong{,\xtrfont{postdot},\xtrfont{stylemods}}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Note the different default package options. (You may omit the +\pkgopt{acronym} package option in both cases if you only want a +single glossary.) The \gls{glossaries-extra} package internally +loads the base \styfmt{glossaries} package so you don't need to +explicitly load both (in fact, it's better to let +\gls{glossaries-extra} load \styfmt{glossaries}). + +Next, replace: +\begin{alltt} +\cs{setacronymstyle}\mgroup{long-short} +\end{alltt} +with: +\begin{alltt} +\ics*{setabbreviationstyle}[\strong{acronym}]\mgroup{long-short} +\end{alltt} +The optional argument \cat{acronym} identifies the category that +this style should be applied to. The \cs{newacronym} command +provided by the base \styfmt{glossaries} package is redefined by +\gls{glossaries-extra} to use \ics*{newabbreviation} with the category +set to \cat{acronym}. + +If you prefer to replace \cs{newacronym} with \ics*{newabbreviation} +then the default category is \cat{abbreviation} so the style should +instead be: +\begin{alltt} +\ics*{setabbreviationstyle}[\strong{abbreviation}]\mgroup{long-short} +\end{alltt} +This is actually the default category if the optional argument is +omitted, so you can simply do: +\begin{alltt} +\ics*{setabbreviationstyle}\mgroup{long-short} +\end{alltt} +The \abbrstyle{long-short} style is the default for the +\cat{abbreviation} category so you can omit this line completely if +you replace \cs{newacronym}. (The default style for the +\cat{acronym} category is \abbrstyle{short-nolong}, which only shows +the short form on \gls{firstuse}.) + +As mentioned earlier, the \pkgopt{acronym} package option creates a +new glossary with the label \texttt{acronym}. This is independent of +the \cat{acronym} category. You can use the \pkgopt{acronym} +package option with either \cs{newacronym} or \ics*{newabbreviation}. + +You may instead prefer to use the \pkgopt*{abbreviations} package +option, which creates a new glossary with the label \texttt{abbreviations}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{abbreviations}},\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +This can again be used with either \cs{newacronym} or +\ics*{newabbreviation}, but the file extensions are different. This +isn't a problem if you are using \gls{makeglossaries} or +\gls{makeglossaries-lite.lua}. If you are explicitly calling +\gls{makeindex} (or \gls{xindy}) then you need to modify the file +extensions. +See the \gls{glossaries-extra} user manual for further details. + +If you use both the \pkgopt{acronym} and \pkgopt*{abbreviations} +package options then \cs{newacronym} will default to the +\texttt{acronym} glossary and \ics*{newabbreviation} will default to +the \texttt{abbreviations} glossary. + +\bibglsnote +If you want to try \gls{bib2gls}, you first need to convert the +document to use \gls{glossaries-extra} as described above. Then add +the \pkgopt*{record} package option. For example: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next you need to convert the entry definitions into the +\filetype{bib} format required by \gls{bib2gls}. This can easily be +done with \gls{convertgls2bib}. For example: +\begin{prompt} +convertgls2bib -{}-preamble-only minimalgls.tex entries.bib +\end{prompt} +This will create a file called \strong{\nolinkurl{entries.bib}}. Next, replace: +\begin{alltt} +\cs{makeglossaries} +\end{alltt} +with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\strong{entries}] +\end{alltt} +Now remove all the entry definitions in the preamble +(\cs{longnewglossaryentry}, \cs{newglossaryentry} and \cs{newacronym} +or \cs{newabbreviation}). + +The abbreviation style command +must go before \ics*{GlsXtrLoadResources}. For example (if you are +using \cs{newacronym}): +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +Finally, replace: +\begin{verbatim} +\printglossaries +\end{verbatim} +with: +\begin{alltt} +\ics*{printunsrtglossaries} +\end{alltt} +The document build is now: +\begin{prompt} +pdflatex minimalgls +bib2gls minimalgls +pdflatex minimalgls +\end{prompt} + +\exitem{DB} This document illustrates how +to load external files containing the glossary definitions. It also +illustrates how to define a new glossary type. This document has the +\gls{numberlist} suppressed and uses \hyperref[sec:glsadd]{\ics{glsaddall}} to add all +the entries to the glossaries without referencing each one +explicitly. (Note that it's more efficient to use +\gls{glossaries-extra} and \gls{bib2gls} if you have a large number +of entries.) To create the document do: +\begin{prompt} +pdflatex sampleDB +makeglossaries sampleDB +pdflatex sampleDB +\end{prompt} +or +\begin{prompt} +pdflatex sampleDB +makeglossaries-lite sampleDB +pdflatex sampleDB +\end{prompt} +The glossary definitions are stored in the accompanying files +\mirrorsamplefile{database1.tex} and \mirrorsamplefile{database2.tex}. If for some +reason you want to call \gls{makeindex} explicitly you must +have a separate call for each glossary: +\begin{enumerate} +\item Create the main glossary (all on one line): +\begin{prompt} +makeindex -s sampleDB.ist -t sampleDB.glg -o sampleDB.gls sampleDB.glo +\end{prompt} +\item Create the secondary glossary (all on one line): +\begin{prompt} +makeindex -s sampleDB.ist -t sampleDB.nlg -o sampleDB.not sampleDB.ntn +\end{prompt} +Note that both \gls{makeglossaries} and \gls{makeglossaries-lite.lua} do +this all in one call, so they not only make it easier because you +don't need to supply all the switches and remember all the +extensions but they also call \gls{makeindex} the appropriate number of times. +\end{enumerate} + +\bibglsnote +If you want to switch to using \gls{bib2gls} with \gls{glossaries-extra}, you can convert +\mirrorsamplefile{database1.tex} and \mirrorsamplefile{database2.tex} to \filetype{bib} +files using \gls{convertgls2bib}: +\begin{prompt} +convertgls2bib database1.tex database1.bib +convertgls2bib database2.tex database2.bib +\end{prompt} +The document code then needs to be: +\begin{alltt} +\cs{documentclass}\mgroup{article} + +\cs{usepackage}[colorlinks,plainpages=false]\mgroup{hyperref} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot}]\mgroup{\strong{glossaries-extra}} + +\strong{\ics{newglossary*}}\mgroup{punc}\mgroup{Punctuation Characters} + +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{database1}, + \strong{\xtrfont{selection}=all},\resourceopt{sort}=en] +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{database2},\strong{\xtrfont{type}=punc,} + \strong{\xtrfont{selection}=all},\resourceopt{sort}=letter-case] + +\cs{begin}\mgroup{document} +\xtrfont{\cs{print\strong{unsrt}glossaries}} +\cs{end}\mgroup{document} +\end{alltt} +Note that the \pkgopt{nonumberlist} package option has been omitted. +It's not needed because there are no locations in this amended +document (whereas in the original \samplefile{DB} locations are +created with \cs{glsaddall}). The starred \ics{newglossary*} is used +since the \gls{makeindex}/\gls{xindy} extensions are now irrelevant. + +Instead of using \gls{makeglossaries} you need to use \gls{bib2gls} +when you build the document: +\begin{prompt} +pdflatex sampleDB +bib2gls sampleDB +pdflatex sampleDB +\end{prompt} +Note that one \gls{bib2gls} call processes all the indexing (rather +than one call per glossary). Unlike \gls{makeindex} and \gls{xindy}, +\gls{bib2gls} processes each resource set in turn, but the resource +sets aren't linked to a specific glossary. Multiple glossaries may +be processed in a single resource set or sub-blocks of a single +glossary may be processed by multiple resource sets. In this +example, there happens to be one resource set per glossary because +each glossary requires a different sort method. (A locale-sensitive +alphabetical sort for the first and a character code sort for the +second.) + +If you want letter groups, you need to use the \bibglslongopt{group} +switch: +\begin{prompt} +bib2gls -{}-group sampleDB +\end{prompt} +and use an appropriate glossary style. + +See also \bibglsgallery{sorting}, \bibglsbegin\ and the \gls{bib2gls} user manual. + +\section{Acronyms and First Use} +\label{sec:sampleacronyms} + +\exitem{Acr} This document has some +sample abbreviations. It also adds the glossary to the table of contents, +so an extra run through \LaTeX\ is required to ensure the document +is up to date: +\begin{prompt} +pdflatex sampleAcr +makeglossaries sampleAcr +pdflatex sampleAcr +pdflatex sampleAcr +\end{prompt} +(or use \gls{makeglossaries-lite.lua}). + +Note that if the glossary is at the start of the document +and spans across multiple pages, then this can cause the locations +to be shifted. In that case, an extra \gls{makeglossaries} and +\LaTeX\ call are required. In this particular example, the glossary +is at the end of the document so it's not a problem. It's also not a +problem for a glossary at the start of the document if the page +numbering is reset at the end of the glossary. For example, if the +glossary is at the end of the front matter in a book-style document. + +This document uses \ics{ifglsused} to determine whether to use +\qt{a} or \qt{an} in: +\begin{alltt} +\ldots\ is \ics{ifglsused}\mgroup{svm}\mgroup{an}\mgroup{a} \cs{gls}\mgroup{svm} \ldots +\end{alltt} +This clumsy bit of code can be tidied up with the +\sty{glossaries-prefix} package. Since that package automatically +loads \styfmt{glossaries} and passes all its options to the base +package it's possible to do a simple replacement of: +\begin{verbatim} +\usepackage[style=long,toc]{glossaries} +\end{verbatim} +with: +\begin{alltt} +\cs{usepackage}[style=long,toc]\mgroup{\strong{glossaries-prefix}} +\end{alltt} +The definition of \texttt{svm} now needs an adjustment: +\begin{alltt} +\ics{newacronym}[description=\mgroup{statistical pattern recognition +technique\string~\cs{protect}\cs{cite}\mgroup{svm}}, +\strong{prefixfirst=\mgroup{a\string~},prefix=\mgroup{an\ics{space}}} +]\mgroup{svm}\mgroup{svm}\mgroup{support vector machine} +\end{alltt} +The clumsy text can now simply be changed to: +\begin{alltt} +\ldots\ is \ics{pgls}\mgroup{svm} \ldots +\end{alltt} + +\glsxtrnote +If you want to convert this sample document to use \gls{glossaries-extra}, +you may want the patched version of the styles provided in \sty{glossary-long}, +in which case you can also add \pkgopt*{stylemods}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{stylemods},}style=long]\mgroup{\strong{glossaries-extra}} +\end{alltt} +If you want to suppress all the other glossary style packages with +\pkgopt{nostyles}, then you need to specify exactly which package +(or packages) that you do want: +\begin{alltt} +\cs{usepackage}[\strong{nostyles,}\xtrfont{stylemods\strong{=long}},style=long]\mgroup{glossaries-extra} +\end{alltt} +(Now that \gls{glossaries-extra} is being used, there are more +available \qt{long} styles in the \sty*{glossary-longextra} package, +which you may prefer.) + +If you want to use \sty{glossaries-prefix}, you can either load it +after \gls{glossaries-extra} or (with at least +\gls{glossaries-extra} v1.42) you can simply use the +\pkgopt*{prefix} package option. + +Note that the \pkgopt{toc} package option has been dropped. This is +the default with \gls{glossaries-extra}, so it doesn't need to be +specified now. The document build is now shorter: +\begin{prompt} +pdflatex sampleAcr +makeglossaries sampleAcr +pdflatex sampleAcr +\end{prompt} +The third \LaTeX\ call is no longer required to make the table of +contents up-to-date. This is because \gls{glossaries-extra} provides +boilerplate text on the first \LaTeX\ call when the glossary files +are missing. This means that the glossary header is added to the +\filetype{toc} file on the first \LaTeX\ call, whereas with just the +base \styfmt{glossaries} package, the header isn't present until the +second \LaTeX\ call. (As with just the base \styfmt{glossaries} +package, if the glossary occurs at the start of the document without +a page reset after it then part of the build process needs repeating +to ensure all referenced page numbers are up-to-date. This problem isn't +specific to the \sty{glossaries} package.) + +The other different default setting is the post-description +punctuation. The base package has \pkgopt[false]{nopostdot} as the +default. This means that a full stop (period) is automatically +inserted after the description in the glossary. The extension +package has \pkgopt[true]{nopostdot} as the default. If you want the +original behaviour then you can use \pkgopt[false]{nopostdot} or the +shorter synonym \pkgopt*{postdot}. + +The \gls{glossaries-extra} package has different +abbreviation handling that's far more flexible than that provided by +the base \styfmt{glossaries} package. The style now needs to be set with +\ics*{setabbreviationstyle} instead of \ics{setacronymstyle}: +\begin{alltt} +\strong{\ics*{setabbreviationstyle}[acronym]\mgroup{long-short-sc}} +\ics{newacronym}\mgroup{svm}\mgroup{svm}\mgroup{support vector machine} +\end{alltt} +(Note the different style name \abbrstyle{long-short-sc} instead of +\acrstyle{long-sc-short} and the optional argument \cat{acronym}.) If you +prefer to replace \ics{newacronym} with \ics*{newabbreviation} then +omit the optional argument: +\begin{alltt} +\ics*{setabbreviationstyle}\mgroup{long-short-sc} +\ics*{newabbreviation}\mgroup{svm}\mgroup{svm}\mgroup{support vector machine} +\end{alltt} +(The optional argument of \ics*{setabbreviationstyle} is the +category to which the style should be applied. If it's omitted, +\cat{abbreviation} is assumed. You can therefore have different +styles for different categories.) + +Finally, you need to replace \ics{acrshort}, \ics{acrlong} and +\ics{acrfull} and their variants with \ics*{glsxtrshort}, \ics*{glsxtrlong} and +\ics*{glsxtrfull} etc. + +\exitem{AcrDesc} This is similar to +the previous example, except that the abbreviations have an associated +description. As with the previous example, the glossary is added to +the table of contents, so an extra run through \LaTeX\ is required: +\begin{prompt} +pdflatex sampleAcrDesc +makeglossaries sampleAcrDesc +pdflatex sampleAcrDesc +pdflatex sampleAcrDesc +\end{prompt} +This document uses the \pkgopt{acronym} package option, which +creates a new glossary used by \cs{newacronym}. This leaves the +default \texttt{main} glossary available for general terms. However, +in this case there are no general terms so the \texttt{main} +glossary is redundant. The \pkgopt{nomain} package option will +prevent its creation. Obviously, if you decide to add some terms +with \cs{newglossaryentry} you will need to remove the +\pkgopt{nomain} option as the \texttt{main} glossary will now be +required. + +\glsxtrnote +As with the previous example, if you want to convert this document +to use \gls{glossaries-extra} you need to make a few modifications. +The most obvious one is to replace \texttt{glossaries} with +\texttt{glossaries-extra} in the \cs{usepackage} argument. Again you +can omit \pkgopt{toc} as this is the default for +\gls{glossaries-extra}. As in the previous example, you may want to +use the patched styles. This document uses \glostyle{altlist} which +is provided by \sty{glossary-list}, so the style can be patched with +\pkgopt*{stylemods}. +\begin{alltt} +\cs{usepackage}[acronym,nomain,style=altlist\strong{,\xtrfont{stylemods}}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +You may prefer to replace the \pkgopt{acronym} option with +\pkgopt*{abbreviations}, but this will change the file extensions. +If you use \gls{makeglossaries} or \gls{makeglossaries-lite.lua} you +don't need to worry about it. + +Again the style command needs to be changed: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short-sc-desc} +\end{alltt} +(Note the change in style name \abbrstyle{long-short-sc-desc} +instead of \acrstyle{long-sc-short-desc} and the optional argument \cat{acronym}.) + +As with the previous example, if +you prefer to use \ics*{newabbreviation} instead of \ics{newacronym} +then you need to omit the optional argument: +\begin{alltt} +\ics*{setabbreviationstyle}\mgroup{long-short-sc-desc} +\end{alltt} +The original document uses: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glsseeitemformat}}[1]\mgroup{\% + \ics{acronymfont}\mgroup{\ics{glsentrytext}\mgroup{\#1}}} +\end{alltt} +to ensure that the cross-references (from the \gloskey{see} key) use +the acronym font. The new abbreviation styles don't +use \ics{acronymfont} so this isn't appropriate with +\gls{glossaries-extra}. If you're using at least version 1.42 of +\gls{glossaries-extra}, you don't need to do anything as it +automatically redefines \ics{glsseeitemformat} to take the style +formatting into account. If you have an earlier version you can +redefine this command as follows: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glsseeitemformat}}[1]\mgroup{\% + \ics{ifglshasshort}\mgroup{\#1}\mgroup{\ics*{glsfmttext}\mgroup{\#1}}\mgroup{\ics*{glsfmtname}\mgroup{\#1}}\% +} +\end{alltt} +This will just show the short form in the cross-reference. If you +prefer the name instead (which includes the short and long form) you can use: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glsseeitemformat}}[1]\mgroup{\ics*{glsfmtname}\mgroup{\#1}} +\end{alltt} + +The \gls{glossaries-extra} package provides two additional +cross-referencing keys \xtrgloskey{seealso} and \xtrgloskey{alias}, +so \texttt{\gloskey{see}=\mgroup{[see also]\mgroup{svm}}} +can be replaced with a more appropriate key: +\begin{alltt} +\ics{newacronym}[description=\mgroup{Statistical pattern recognition +technique using the ``kernel trick''}, +\strong{\xtrgloskey{seealso}=\mgroup{svm}}, +]\mgroup{ksvm}\mgroup{ksvm}\mgroup{kernel support vector machine} +\end{alltt} + +Finally, as with the previous example, you need to replace +\ics{acrshort}, \ics{acrlong} and \ics{acrfull} etc with +\ics*{glsxtrshort}, \ics*{glsxtrlong} and \ics*{glsxtrfull} etc. + +\bibglsnote +If you want to convert this document so that it uses \gls{bib2gls}, +you first need to convert it to use \gls{glossaries-extra}, as above, +but remember that you now need the \pkgopt*{record} option: +\begin{alltt} +\cs{usepackage}[acronym,nomain,style=altlist,\strong{\xtrfont{record},\xtrfont{postdot},\xtrfont{stylemods}}] +\mgroup{\strong{glossaries-extra}} +\end{alltt} +Now you need to convert the abbreviation definitions to the \filetype{bib} +format required by \gls{bib2gls}. This can be done with: +\begin{prompt} +convertgls2bib -{}-preamble-only sampleAcrDesc.tex entries.bib +\end{prompt} +If you retained \ics{newacronym} from the original example file, +then the new \nolinkurl{entries.bib} file will contain entries +defined with \atentry{acronym}. For example: +\begin{alltt} +\atentry{acronym}\mgroup{ksvm, + description = \mgroup{Statistical pattern recognition technique + using the ``kernel trick''}, + \xtrfont{seealso} = \mgroup{svm}, + short = \mgroup{ksvm}, + long = \mgroup{kernel support vector machine} +} +\end{alltt} +If you switched to \ics*{newabbreviation} then the entries will +instead be defined with \atentry{abbreviation}. + +Next replace \cs{makeglossaries} with the resource command, but note +that the abbreviation style must be set first: +\begin{alltt} +\strong{\ics*{setabbreviationstyle}[acronym]\mgroup{long-short-sc-desc}} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\% terms defined in entries.bib + \strong{\xtrfont{abbreviation-sort-fallback}=long}] +\end{alltt} +Another possibility is to make \atentry{acronym} behave as though it +was actually \atentry{abbreviation}: +\begin{alltt} +\strong{\ics*{setabbreviationstyle}\mgroup{long-short-sc-desc}} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\resourceopt{abbreviation-sort-fallback}=long\strong{, + entry-type-aliases=\mgroup{acronym=abbreviation}}] +\end{alltt} +Note that the category is now \cat{abbreviation} not \cat{acronym} so the optional +argument of \ics*{setabbreviationstyle} needs adjusting. + +If the \gloskey{sort} field is missing (which should usually be the +case), then both \atentry{acronym} and \atentry{abbreviation} will +fallback on the \gloskey{short} field (not the \gloskey{name} field, +which is usually set by the style and therefore not visible to +\gls{bib2gls}). For some styles, as in this example, it's more +appropriate to sort by the long form so the fallback is changed. +(Remember that you will break this fallback mechanism if you +explicitly set the sort value.) See the \gls{bib2gls} manual for +further details and other examples. + +Remember to delete any \cs{newacronym} or \cs{newabbreviation} in +the \filetype{tex} file. +Finally replace \cs{printglossary} with \ics*{printunsrtglossary}. +The document build is now: +\begin{prompt} +pdflatex sampleAcrDesc +bib2gls sampleAcrDesc +pdflatex sampleAcrDesc +\end{prompt} + +Note that it's now much easier to revert back to the descriptionless +style used in \samplefile{Acr}: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{\strong{long-short-sc}} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries\strong{,\resourceopt{ignore-fields}=description}] +\end{alltt} +With the other options it would be necessary to delete all the +\gloskey{description} fields from the abbreviation definitions in +order to omit them, but with \gls{bib2gls} you can simply instruct +\gls{bib2gls} to ignore the description. This makes it much easier +to have a large database of abbreviations for use across multiple +documents that may or may not require the description. + +\exitem{Desc} This is similar to the +previous example, except that it defines the abbreviations using +\ics{newglossaryentry} instead of \ics{newacronym}. As with the +previous example, the glossary is added to the table of contents, so +an extra run through \LaTeX\ is required: +\begin{prompt} +pdflatex sampleDesc +makeglossaries sampleDesc +pdflatex sampleDesc +pdflatex sampleDesc +\end{prompt} +This sample file demonstrates the use of the \gloskey{first} and +\gloskey{text} keys but in general it's better to use +\ics{newacronym} instead as it's more flexible. For even greater +flexibility use \ics*{newabbreviation} provided by \gls{glossaries-extra}. +For other variations, such as showing the symbol on \gls{firstuse}, +you may prefer to make use of the post-link category hook. For +examples, see the section \qt{Changing the Formatting} in \bibglsbegin. + +\exitem{FnAcrDesc} This document has some sample abbreviations that +use the \acrstyle{footnote-sc-desc} acronym style. As with the previous example, +the glossary is added to the table of contents, so an extra run through +\LaTeX\ is required: +\begin{prompt} +pdflatex sampleFnAcrDesc +makeglossaries sampleFnAcrDesc +pdflatex sampleFnAcrDesc +pdflatex sampleFnAcrDesc +\end{prompt} +\glsxtrnote +If you want to convert this sample document to use +\gls{glossaries-extra}, then you just need to follow the same steps +as for \samplefile{Acr} with a slight modification. This time the +\abbrstyle{short-sc-footnote-desc} abbreviation style is needed: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{short-sc-footnote-desc} +\end{alltt} +The command redefinitions (performed with \cs{renewcommand}) should +now all be deleted as they are no longer applicable. + +You may prefer to use the \abbrstyle{short-sc-postfootnote-desc} +style instead. There are subtle differences between the \abbrstyle{postfootnote} and +\abbrstyle{footnote} set of styles. Try changing the abbreviation style to +\abbrstyle{short-sc-footnote} and compare the location of the footnote marker +with the two styles. + +This modified sample file now has a shorter build: +\begin{prompt} +pdflatex sampleFnAcrDesc +makeglossaries sampleFnAcrDesc +pdflatex sampleFnAcrDesc +\end{prompt} +This is because the \gls{glossaries-extra} package produces +boilerplate text when the glossary file is missing (on the first +\LaTeX\ run) which adds the glossary title to the table of contents +(\filetype{toc}) file. + +\exitem{CustomAcr} This document has some sample abbreviations with a +custom acronym style. It also adds the glossary to the table of +contents, so an extra run through \LaTeX\ is required: +\begin{prompt} +pdflatex sampleCustomAcr +makeglossaries sampleCustomAcr +pdflatex sampleCustomAcr +pdflatex sampleCustomAcr +\end{prompt} +This is a slight variation on the previous example where the name is +in the form \meta{long} (\meta{short}) instead of \meta{short} +(\meta{long}), and the \gloskey{sort} key is set to the long form +instead of the short form. On \gls{firstuse}, the footnote text is +in the form \meta{long}: \meta{description} (instead of just the +long form). This requires defining a new acronym +style that inherits from the \acrstyle{footnote-sc-desc} style. + +\glsxtrnote +The conversion to \gls{glossaries-extra} starts in much the same way +as the previous examples: +\begin{alltt} +\cs{usepackage}[acronym,nomain,\strong{\xtrfont{postdot},\xtrfont{stylemods},}style=altlist] +\mgroup{\strong{glossaries-extra}} +\end{alltt} +The abbreviation styles have associated helper commands that may be +redefined to make minor modifications. These redefinitions should be +done before the abbreviations are defined. + +The \abbrstyle{short-sc-footnote-desc} abbreviation style is the closest match +to the requirement, so replace the \cs{setacronymstyle} command +with: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{short-sc-footnote-desc} +\end{alltt} +Again, you may prefer \abbrstyle{short-sc-postfootnote-desc}. Both +styles use the same helper commands. + +Next some adjustments need to be made to fit the new requirements. +The name needs to be \meta{long} (\meta{short}): +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrfootnotedescname}}\mgroup{\% + \cs{protect}\strong{\ics*{glslongfont}\mgroup{\cs{the}\ics{glslongtok}}}\% + \cs{protect}\ics*{glsxtrfullsep}\mgroup{\cs{the}\ics{glslabeltok}}\% + \cs{protect}\ics*{glsxtrparen}\mgroup{\cs{protect}\strong{\ics*{glsabbrvfont}\mgroup{\cs{the}\ics{glsshorttok}}}}\% +} +\end{alltt} +This command expands when the abbreviations are defined so take care +to \cs{protect} commands that shouldn't be expanded at that point, +and make sure that the token registers that store the label, long +and short values are able to expand. Similarly the sort value needs +adjusting: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrfootnotedescsort}}\mgroup{\strong{\cs{the}\ics{glslongtok}}} +\end{alltt} +The footnote for all the footnote abbreviation styles is produced +with: +\begin{alltt} +\ics*{glsxtrabbrvfootnote}\marg{label}\marg{text} +\end{alltt} +where \meta{text} is the singular or plural long form, depending on +what command was used to reference the abbreviation (\cs{gls}, +\cs{glspl} etc). This can simply be redefined as: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrabbrvfootnote}}[2]\mgroup{\ics{footnote}\mgroup{\% + \#2: \ics{glsentrydesc}\mgroup{\#1}}} +\end{alltt} +This will mimic the result from the original sample document. + +You may prefer to replace \verb|#2| with a reference to a +specific field (or fields). For example: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrabbrvfootnote}}[2]\mgroup{\ics{footnote}\mgroup{\% + \ics*{Glsfmtlong}\mgroup{\#1} (\ics*{glsfmtshort}\mgroup{\#1}): \ics{glsentrydesc}\mgroup{\#1}.}} +\end{alltt} +As with the earlier \samplefile{AcrDesc}, you need to remove or change the redefinition of +\ics{glsseeitemformat} since \cs{acronymfont} is no longer appropriate. + +In the original \texttt{sampleCustomAcr.tex} source code, I started +the description with a capital: +\begin{verbatim} +\newacronym[description={Statistical pattern recognition +technique using the ``kernel trick''}, +see={[see also]{svm}}, +]{ksvm}{ksvm}{kernel support vector machine} +\end{verbatim} +This leads to a capital letter after the colon in the footnote, +which is undesirable, but I would like to have the description start +with a capital in the glossary. The solution to this problem is +easy with \gls{glossaries-extra}. I start the description with a +lowercase letter and set the \attr{glossdesc} attribute to +\optfmt{firstuc}: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{acronym}\mgroup{glossdesc}\mgroup{firstuc} +\end{alltt} +The abbreviation definitions are modified slightly: +\begin{alltt} +\ics{newacronym}[description=\mgroup{\strong{s}tatistical pattern recognition +technique using the ``kernel trick''}, +\strong{\xtrgloskey{seealso}=\mgroup{svm}}, +]\mgroup{ksvm}\mgroup{ksvm}\mgroup{kernel support vector machine} +\end{alltt} +Note the use of the \xtrgloskey{seealso} key, which is only +available with \gls{glossaries-extra}. + +If you prefer to use \ics*{newabbreviation} instead of +\ics{newacronym}, then the category needs to be +\cat{abbreviation} rather than \cat{acronym}: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{\strong{abbreviation}}\mgroup{glossdesc}\mgroup{firstuc} +\end{alltt} +and the style command needs to be adjusted so that it omits the +optional argument. For example: +\begin{alltt} +\ics*{setabbreviationstyle}\mgroup{short-sc-postfootnote-desc} +\end{alltt} + +\exitem{-FnDesc} This example +defines a custom display format that puts the description in a +footnote on \gls{firstuse}. +\begin{prompt} +pdflatex sample-FnDesc +makeglossaries sample-FnDesc +pdflatex sample-FnDesc +\end{prompt} +In order to prevent nested hyperlinks, this document uses the +\pkgopt[false]{hyperfirst} package option (otherwise the footnote +marker hyperlink would be inside the hyperlink around the +\gls{linktext} which would result in a nested hyperlink). + +\glsxtrnote +The \gls{glossaries-extra} package has category post-link hooks that +make it easier to adjust the formatting. The post-link hook is +placed after the hyperlink around the \gls{linktext}, so a hyperlink +created by \ics{footnote} in the post-link hook won't cause a nested +link. This means that the \pkgopt[false]{hyperfirst} option isn't +required: +\begin{alltt} +\cs{usepackage}[\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{\strong{glossaries-extra}} +\end{alltt} + +\begin{important} +Never use commands like \cs{gls} or \cs{glsdesc} in the post-link +hook as you can end up with infinite recursion. Use commands that +don't themselves have a post-link hook, such as \cs{glsentrydesc} or +\cs{glossentrydesc}, instead. +\end{important} + +In the original \texttt{sample-FnDesc.tex} file, the format was +adjusted with: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glsentryfmt}}\mgroup{\% + \ics{glsgenentryfmt} + \ics{ifglsused}\mgroup{\ics{glslabel}}\mgroup{}\mgroup{\ics{footnote}\mgroup{\ics{glsentrydesc}\mgroup{\ics{glslabel}}}}% +} +\end{alltt} +This can be changed to: +\begin{alltt} +\ics*{glsdefpostlink} +\mgroup{general}\% category label +\mgroup{\ics*{glsxtrifwasfirstuse}\mgroup{\ics{footnote}\mgroup{\ics{glsentrydesc}\mgroup{\ics{glslabel}}}}\mgroup{}} +\end{alltt} +This sets the post-link hook for the \cat{general} category +(which is the default category for entries defined with \ics{newglossaryentry}). If I +added some abbreviations (which have a different category) then this +change wouldn't apply to them. + +The first paragraph in the document is: +\begin{verbatim} +First use: \gls{sample}. +\end{verbatim} +So the PDF will have the word \qt{sample} (the \gls{linktext} +created by \verb|\gls{sample}|) as a hyperlink to the entry in the +glossary followed by the footnote marker, which is a hyperlink to +the footnote. This is then followed by the sentence terminator. +\qt{First use: sample\textsuperscript{1}.} + +It would look tidier if the footnote marker could be shifted after +the full stop. \qt{First use: sample.\textsuperscript{1}} +This can easily be achieved with a minor modification: +\begin{alltt} +\ics*{glsdefpostlink} +\mgroup{general}\% category label +\mgroup{\ics*{glsxtrifwasfirstuse} + \mgroup{\ics*{glsxtrdopostpunc}\mgroup{\ics{footnote}\mgroup{\ics{glsentrydesc}\mgroup{\ics{glslabel}}}}}\% + \mgroup{}\% +} +\end{alltt} +You may prefer to use \ics{glossentrydesc} instead of +\ics{glsentrydesc}. This will obey the \attr{glossdesc} attribute. +If you append \ics{glspostdescription}, you can also pick up the +\pkgopt*{postdot} package option. For example: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{general}\mgroup{glossdesc}\mgroup{firstuc} + +\ics*{glsdefpostlink} +\mgroup{general}\% category label +\mgroup{\ics*{glsxtrifwasfirstuse} + \mgroup{\ics*{glsxtrdopostpunc}\mgroup{\ics{footnote}\mgroup{\% + \strong{\ics{glossentrydesc}}\mgroup{\ics{glslabel}}\strong{\ics{glspostdescription}}}}}\% + \mgroup{}\% +} +\end{alltt} +Alternatively, you could just use \ics{Glsentrydesc} and explicitly +append the full stop. + +\exitem{-custom-acronym} +This document illustrates how to define your own acronym style if +the predefined styles don't suit your requirements. +\begin{prompt} +pdflatex sample-custom-acronym +makeglossaries sample-custom-acronym +pdflatex sample-custom-acronym +\end{prompt} +In this case, a style is defined to show the short form in the text +with the long form and description in a footnote on \gls{firstuse}. +The long form is used for the \gloskey{sort} value. +The short form is displayed in \gls{smallcaps} in the main part of the +document but in uppercase in the list of acronyms. (So it's a slight +variation of some of the examples above.) The \gloskey{name} is set +to the long form (starting with an initial capital) followed by the +all caps short form in parentheses. The final requirement is that +the inline form should show the long form followed by the short form +in parentheses. + +\glsxtrnote +As with \samplefile{FnAcrDesc}, the \abbrstyle{short-sc-footnote-desc} +and \abbrstyle{short-sc-postfootnote-desc} abbreviation styles produce +almost the required effect so one of those can be used as a starting point. +However the final requirement doesn't fit. It's now necessary to actually define a custom +abbreviation style, but it can mostly inherit from the +\abbrstyle{short-sc-footnote-desc} or \abbrstyle{short-sc-postfootnote-desc} style: +\begin{alltt} +\ics*{newabbreviationstyle}\mgroup{custom-fn}\% +\mgroup{\% + \ics*{GlsXtrUseAbbrStyleSetup}\mgroup{short-sc-footnote-desc}\% +}\% +\mgroup{\% + \ics*{GlsXtrUseAbbrStyleFmts}\mgroup{short-sc-footnote-desc}\% + \cs{renewcommand}*\mgroup{\ics*{glsxtrinlinefullformat}}[2]\mgroup{\% + \strong{\ics*{glsfirstlongfootnotefont}}\mgroup{\strong{\ics*{glsaccesslong}\mgroup{\#\#1}}\% + \ics*{ifglsxtrinsertinside}\#\#2\cs{fi}}\% + \ics*{ifglsxtrinsertinside}\cs{else}\#\#2\cs{fi}\ics*{glsxtrfullsep}\mgroup{\#\#1}\% + \ics*{glsxtrparen}\mgroup{\strong{\ics*{glsfirstabbrvscfont}\mgroup{\ics*{glsaccessshort}\mgroup{\#\#1}}}}\% + }\% + \cs{renewcommand}*\mgroup{\ics*{glsxtrinlinefullplformat}}[2]\mgroup{\% + \strong{\ics*{glsfirstlongfootnotefont}}\mgroup{\strong{\ics*{glsaccesslongpl}\mgroup{\#\#1}}\% + \ics*{ifglsxtrinsertinside}\#\#2\cs{fi}}% + \ics*{ifglsxtrinsertinside}\cs{else}\#\#2\cs{fi}\ics*{glsxtrfullsep}\mgroup{\#\#1}\% + \ics*{glsxtrparen}\mgroup{\strong{\ics*{glsfirstabbrvscfont}\mgroup{\ics*{glsaccessshortpl}\mgroup{\#\#1}}}}\% + }% + \cs{renewcommand}*\mgroup{\ics*{Glsxtrinlinefullformat}}[2]\mgroup{\% + \strong{\ics*{glsfirstlongfootnotefont}}\mgroup{\strong{\ics*{Glsaccesslong}\mgroup{\#\#1}}\% + \ics*{ifglsxtrinsertinside}\#\#2\cs{fi}}\% + \ics*{ifglsxtrinsertinside}\cs{else}\#\#2\cs{fi}\ics*{glsxtrfullsep}\mgroup{\#\#1}\% + \ics*{glsxtrparen}\mgroup{\strong{\ics*{glsfirstabbrvscfont}\mgroup{\ics*{glsaccessshort}\mgroup{\#\#1}}}}\% + }\% + \cs{renewcommand}*\mgroup{\ics*{Glsxtrinlinefullplformat}}[2]\mgroup{\% + \strong{\ics*{glsfirstlongfootnotefont}}\mgroup{\strong{\ics*{Glsaccesslongpl}\mgroup{\#\#1}}\% + \ics*{ifglsxtrinsertinside}\#\#2\cs{fi}}\% + \ics*{ifglsxtrinsertinside}\cs{else}\#\#2\cs{fi}\ics*{glsxtrfullsep}\mgroup{\#\#1}\% + \ics*{glsxtrparen}\mgroup{\strong{\ics*{glsfirstabbrvscfont}\mgroup{\ics*{glsaccessshortpl}\mgroup{\#\#1}}}}\% + }\% +} +\end{alltt} +(See the \gls{glossaries-extra} user manual for further details.) + +This new custom style now needs to be set: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{custom-fn} +\end{alltt} +Remember that if you decide to use \ics*{newabbreviation} instead +of \ics{newacronym} then the category will be \cat{abbreviation} not \cat{acronym}: +\begin{alltt} +\ics*{setabbreviationstyle}\mgroup{custom-fn} +\end{alltt} +This custom style simply adjusts the inline full form. There are other +adjustments to be made that apply to the inherited style. (The alternative is to +design a new style from scratch.) The footnote contains the long form followed by the +description. This is the same as the modification to an earlier +example: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrabbrvfootnote}}[2]\mgroup{\ics{footnote}\mgroup{\#2: +\ics{glsentrydesc}\mgroup{\#1}.}} +\end{alltt} +As with \samplefile{CustomAcr}, if you specifically +want the singular long form then you can ignore the second argument. +For example: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrabbrvfootnote}}[2]\mgroup{\ics{footnote} + \mgroup{\ics*{Glsfmtlong}\mgroup{\#1}: \ics{glsentrydesc}\mgroup{\#1}.}} +\end{alltt} + +The \gloskey{name} now needs to be the long form followed by the +short form in parentheses, but note the new requirement that the +short form should now be in all capitals not \gls{smallcaps} and the +long form should start with a capital letter. +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrfootnotedescname}}\mgroup{\% + \cs{protect}\ics*{glsfirstlongfootnotefont} + \mgroup{\ics{makefirstuc}\mgroup{\cs{the}\ics{glslongtok}}} + (\cs{protect}\ics{MakeTextUppercase}\mgroup{\cs{the}\ics{glsshorttok}})\% +} +\end{alltt} +The inherited abbreviation style uses the short form as the +\gloskey{sort} value by default. This needs to be changed to the long form: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics*{glsxtrfootnotedescsort}}\mgroup{\cs{the}\strong{\ics{glslongtok}}} +\end{alltt} + +\begin{bib2gls} +If you want to switch to using \gls{bib2gls}, remember to set the +abbreviation style before the resource command and change the +default sort fallback field to \gloskey{long}, as with +\samplefile{AcrDesc}. +\end{bib2gls} + +\exitem{-dot-abbr} This document illustrates how to use the base +post link hook to adjust the space factor after abbreviations. +\begin{prompt} +pdflatex sample-dot-abbr +makeglossaries sampledot-abbrf +pdflatex sample-dot-abbr +\end{prompt} +This example creates a custom storage key that provides a similar +function to \gls{glossaries-extra}['s] \xtrgloskey{category} key. + +\glsxtrnote +This example is much simpler with \gls{glossaries-extra}. The custom +storage key, which is defined using: +\begin{alltt} +\ics{glsaddstoragekey}\mgroup{abbrtype}\mgroup{word}\mgroup{\cs{abbrtype}} +\end{alltt} +can now be removed. + +The \xtrgloskey{category} key is set to \texttt{initials} for +the initialisms (which are defined with the custom \cs{newacr} +command). The abbreviation styles can be set with: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\ics*{setabbreviationstyle}[initials]\mgroup{long-short} +\end{alltt} +The \attr{discardperiod} attribute will discard any full stop +(period) following commands like \cs{gls}: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{initials}\mgroup{discardperiod}\mgroup{true} +\end{alltt} +(If you want to use the \attr{noshortplural} attribute then you will +also need to set the \attr{pluraldiscardperiod} attribute.) + +The \gls{firstuse} is governed by the \attr{retainfirstuseperiod} +attribute. If set, the period won't be discarded if it follows the +\gls{firstuse} of commands like \cs{gls}. This is useful for styles +where the \gls{firstuse} doesn't end with the short form. In this +case, the \gls{firstuse} of the \abbrstyle{long-short} style ends +with a closing parenthesis, so the end of sentence might be clearer +if the period is retained: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{initials}\mgroup{retainfirstuseperiod}\mgroup{true} +\end{alltt} + +The \attr{insertdots} attribute can automatically insert dots into +the short form with a final space factor adjustment: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{initials}\mgroup{insertdots}\mgroup{true} +\end{alltt} + +The custom helper command defined in the example needs to be +slightly modified: +\begin{alltt} +\cs{newcommand}*\mgroup{\cs{newabbr}}[1][]\mgroup{\% + \strong{\ics*{newabbreviation}}[\strong{\xtrfont{category}}=initials,\#1]} +\end{alltt} +The definitions need to be slightly modified to work with the +\attr{insertdots} attribute: +\begin{alltt} +\cs{newabbr}\mgroup{eg}\mgroup{\strong{eg}}\mgroup{eg} +\cs{newabbr}\mgroup{ie}\mgroup{\strong{ie}}\mgroup{ie} +\cs{newabbr}\mgroup{bsc}\mgroup{\strong{B\mgroup{Sc}}}\mgroup{Bachelor of Science} +\cs{newabbr}\mgroup{ba}\mgroup{\strong{BA}}\mgroup{BA} +\cs{newabbr}\mgroup{agm}\mgroup{\strong{AGM}}\mgroup{AGM} +\end{alltt} +(This makes it much easier to change your mind if you decide at a +later date to omit the dots, especially if you are storing all your +definitions in a file that's shared across multiple documents, but +note the need to group \qt{Sc}.) + +The \qt{laser} definition remains unchanged: +\begin{verbatim} +\newacronym{laser}{laser}{light amplification by stimulated +emission of radiation} +\end{verbatim} +The remaining code in the preamble must now be removed. (It will +interfere with \gls{glossaries-extra}['s] category post-link hooks.) +No change is required in the document body. + +See the \gls{glossaries-extra} user manual for further details about +category attributes and post-link hooks. + +\exitem{-font-abbr} This document illustrates how to have different fonts +for abbreviations within the style. The document build is: +\begin{prompt} +pdflatex sample-font-abbr +makeglossaries sample-font-abbr +pdflatex sample-font-abbr +\end{prompt} +The acronym mechanism provided by the base \styfmt{glossaries} +package isn't well suited to having a mixture of styles. This +example provides a workaround that involves defining a new storage +key with \ics{glsaddstoragekey} that's used to hold the font +declaration (such as \cs{em}). +\begin{verbatim} +\glsaddstoragekey{font}{}{\entryfont} +\end{verbatim} +A new custom acronym style is defined that fetches the font +information from this new key so that it can be applied to the +abbreviation. Some helper commands are also provided to define the +different types of abbreviation: +\begin{verbatim} +\newcommand*{\newitabbr}[1][]{\newacronym[font=\em,#1]} +\newcommand*{\newupabbr}{\newacronym} + +\newitabbr{eg}{e.g.}{exempli gratia} +\newupabbr{bsc}{BSc}{Bachelor of Science} +\end{verbatim} +This makes the \gls{firstuse} of \verb|\gls{eg}| appear as \qt{exempli +gratia (\emph{e.g.})} whereas the \gls{firstuse} of \verb|\gls{bsc}| +is \qt{Bachelor of Science (BSc)}. + +\glsxtrnote +This example document is much simpler with \gls{glossaries-extra}. +First the \cs{usepackage} command needs adjusting: +\begin{alltt} +\cs{usepackage}[\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The custom storage key can now be removed and also the custom +acronym style. Now replace the \ics{setacronymstyle} line with: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short-em} +\end{alltt} +and change the definition of the helper commands: +\begin{alltt} +\cs{newcommand}*\mgroup{\cs{newitabbr}}\mgroup{\ics{newacronym}} +\cs{newcommand}*\mgroup{\cs{newupabbr}}\mgroup{\strong{\ics*{newabbreviation}}} +\end{alltt} +Note that the \verb|font=\em,| part has been removed from the +definition of the first command and the second command uses +\ics*{newabbreviation} instead of \ics{newacronym}. This means that +\cs{newitabbr} will default to +\xtrgloskey{category}\csoptfmt{=acronym} and \cs{newupabbr} will +default to \xtrgloskey{category}\csoptfmt{=abbreviation}. The +default style for the \cat{abbreviation} category is +\abbrstyle{long-short}, which is the required style for this +example. This just means that only the \cat{acronym} category needs +to have the style set (with the above \ics*{setabbreviationstyle} +command). + +Finally, the \ics{acrshort}, \ics{acrlong} and \cs{acrfull} commands +need to be replaced with \ics*{glsxtrshort}, \ics*{glsxtrlong} and +\ics*{glsxtrfull}. + +You may notice that the spacing after \qt{e.g\@.} and \qt{i.e\@.} +isn't correct. This is similar to the \samplefile{-dot-abbr} example +where the space factor needs adjusting. In this case I've inserted +the dots manually (rather than relying on the \attr{insertdots} +attribute). You can either remove the dots and use \attr{insertdots} +with \attr{discardperiod}: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{acronym}\mgroup{insertdots}\mgroup{true} +\ics*{glssetcategoryattribute}\mgroup{acronym}\mgroup{discardperiod}\mgroup{true} + +\cs{newitabbr}\mgroup{eg}\mgroup{\strong{eg}}\mgroup{exempli gratia} +\cs{newitabbr}\mgroup{ie}\mgroup{\strong{ie}}\mgroup{id est} +\end{alltt} +Or you can manually insert the space factor adjustment and only use +the \attr{discardperiod} attribute: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{acronym}\mgroup{discardperiod}\mgroup{true} + +\cs{newitabbr}\mgroup{eg}\mgroup{e.g.\strong{\ics{@}}}\mgroup{exempli gratia} +\cs{newitabbr}\mgroup{ie}\mgroup{i.e.\strong{\ics{@}}}\mgroup{id est} +\end{alltt} + +You don't have to use the \cat{acronym} category. You may prefer a +different label that fits better semantically. For example: +\begin{alltt} +\ics*{setabbreviationstyle}[\strong{latinabbr}]\mgroup{long-short-em} +\cs{newcommand}*\mgroup{\cs{new\strong{latin}abbr}}[1][]\mgroup{\ics*{newabbreviation}[\xtrfont{category}=\strong{latinabbr},\#1]} +\ics*{glssetcategoryattribute}\mgroup{\strong{latinabbr}}\mgroup{insertdots}\mgroup{true} +\ics*{glssetcategoryattribute}\mgroup{\strong{latinabbr}}\mgroup{discardperiod}\mgroup{true} + +\cs{new\strong{latin}abbr}\mgroup{eg}\mgroup{e.g.\strong{\ics{@}}}\mgroup{exempli gratia} +\cs{new\strong{latin}abbr}\mgroup{ie}\mgroup{i.e.\strong{\ics{@}}}\mgroup{id est} +\end{alltt} + +\section{Non-Page Locations} +\label{sec:samplecounter} + +\exitem{Eq} This document illustrates how +to change the location to something other than the page number. In +this case, the \ctrfmt{equation} counter is used since all glossary +entries appear inside an \env{equation} environment. To create +the document do: +\begin{prompt} +pdflatex sampleEq +makeglossaries sampleEq +pdflatex sampleEq +\end{prompt} +The \styfmt{glossaries} package provides some location formats, such +as \ics{hyperrm} and \ics{hyperbf}, that allow the locations in the \gls{numberlist} +to hyperlink to the appropriate place in the document (if +\sty{hyperref} has been used). Since it's not possible to include +the hyperlink name in the indexing information with \gls{makeindex} +and \gls{xindy}, the \styfmt{glossaries} package has to reform the +name from a prefix and the location value. + +Unfortunately it's not always possible to split the link name into a +prefix and location. That happens with the \ctrfmt{equation} +counter in certain classes, such as the \clsfmt{report} class (which +is used in this example). This means that it's necessary to redefine +\ics{theHequation} so that it has a format that fits the requirement: +\begin{verbatim} +\renewcommand*\theHequation{\theHchapter.\arabic{equation}} +\end{verbatim} +If you don't do this, the equation locations in the glossary won't +form valid hyperlinks. + +Each glossary entry represents a mathematical symbol. This means +that with \optsto13 it's necessary to use the \gloskey{sort} key. +For example: +\begin{alltt} +\cs{newglossaryentry}\mgroup{Gamma}\mgroup{name=\cs{ensuremath}\mgroup{\cs{Gamma}(z)}, +description=Gamma function,\strong{sort=Gamma}} +\end{alltt} + +\bibglsnote +If you want to switch to using \gls{bib2gls}, the first change you +need to make is to switch from explicitly loading +\styfmt{glossaries} to loading \gls{glossaries-extra} with the +\pkgopt*{record} package option. If \pkgopt+{only}{record} (or +\pkgopt*{record} without a value) is used, then the above +redefinition of \cs{theHequation} is still required. If +\pkgopt+{nameref}{record} is used instead then the redefinition of +\cs{theHequation} isn't required. You may also want to use the +\pkgopt*{stylemods} and \pkgopt*{postdot} options: +\begin{alltt} +\cs{usepackage}[\strong{\strong{\xtrfont{record=nameref}},\xtrfont{stylemods},\xtrfont{postdot}}, + ucmark,style=long3colheader,counter=equation]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The entries now need to be converted into the \filetype{bib} format required +by \gls{bib2gls}, which can be done with \gls{convertgls2bib}: +\begin{prompt} +convertgls2bib -{}-preamble-only sampleEq.tex entries.bib +\end{prompt} +This will create a file called \nolinkurl{entries.bib} that starts: +\begin{alltt} +\% Encoding: UTF-8 +\atentry{entry}\mgroup{Gamma, + name = \mgroup{\cs{ensuremath}\mgroup{\cs{Gamma}(z)}}, + description = \mgroup{Gamma function} +} +\end{alltt} +You may prefer to change \atentry{entry} to \atentry{symbol}. (This +should be easy to do with your text editor's search and replace +function.) + +Note that the \gloskey{sort} key has been omitted. This is because +it typically shouldn't be used. The difference between using +\atentry{entry} and \atentry{symbol} is that with \atentry{entry} +the sort value will be obtained from the \gloskey{name} but with +\atentry{symbol} the sort value will be obtained from the label. +If you explicitly use the \gloskey{sort} key then you will break +this behaviour. (If you try this example out, notice the difference +in the ordering if you switch between \atentry{entry} and +\atentry{symbol}. See also \bibglsgallery{sorting}.) + +Next replace \cs{makeglossaries} with: +\begin{alltt} +\strong{\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries]} +\end{alltt} +If you have used \pkgopt+{nameref}{record} then you can remove the +redefinition of \cs{theHequation}. Next remove all the lines +defining the glossary entries (since they're now defined in the +\filetype{bib} file). + +Finally, replace \ics{printglossary} with \ics*{printunsrtglossary}: +\begin{alltt} +\strong{\ics*{printunsrtglossary}}[title=\mgroup{Index of Special Functions and +Notations}] +\end{alltt} +The rest of the document remains unchanged (unless you want to use +\ics*{glsxtrfmt} as described in the following example). + +\exitem{EqPg} This is similar to the previous example, but the \glspl{numberlist} are a +mixture of page numbers and equation numbers. This example adds the +glossary to the table of contents, so an extra \LaTeX\ run is +required: +\begin{prompt} +pdflatex sampleEqPg +makeglossaries sampleEqPg +pdflatex sampleEqPg +pdflatex sampleEqPg +\end{prompt} +As with the previous example, entries are defined like this: +\begin{verbatim} +\newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)}, +description=Gamma function,sort=Gamma} +\end{verbatim} +The \pkgopt[equation]{counter} package option is used to set the +default indexing counter to \ctrfmt{equation}. This means that it +has to be changed for indexing outside of any numbered equation. For +example: +\begin{verbatim} +\glslink[format=hyperbf,counter=page]{Gamma}{gamma function} +\end{verbatim} +I've set the \gloskey[glslink]{format} to \locfmt{hyperbf} to indicate that +this is a primary reference. (Note that I'm using \ics{hyperbf} not +\ics{textbf} in order to include a hyperlink in the location.) + +The \gls{linktext} here is almost identical to the +description. The only difference is that the description starts with +a capital. If it started with a lowercase character instead, I could +simply use \ics{glsdesc} instead of \ics{glslink}. If I change the +entry descriptions so that they all start with a lowercase letter +then I would need to create a custom glossary style that used +\ics{Glossentrydesc} instead of \ics{glossentrydesc}. + +\glsxtrnote +If I switch to using \gls{glossaries-extra} I wouldn't need a new +glossary style. Instead I could just use the \attr{glossdesc} +attribute to perform the case change. Remember that the first change +to make is to replace \styfmt{glossaries} with +\gls{glossaries-extra}: +\begin{alltt} +\cs{usepackage}[style=long3colheader,\strong{\xtrfont{postdot},\xtrfont{stylemods}}, + counter=equation]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The entries are now all defined so that the description starts with +a lowercase letter (except for the descriptions that start with a +proper noun). For example: +\begin{alltt} +\ics{newglossaryentry}\mgroup{Gamma}\mgroup{name=\cs{ensuremath}\mgroup{\cs{Gamma}(z)}, +description=\strong{g}amma function,sort=Gamma} +\end{alltt} +The \attr{glossdesc} attribute needs setting: +\begin{alltt} +\ics*{glssetcategoryattribute}\mgroup{general}\mgroup{glossdesc}\mgroup{firstuc} +\end{alltt} +This means that I can now use \ics{glsdesc} instead of \ics{glslink}. + +It's a bit cumbersome typing \texttt{[format=hyperbf,counter=page]} +for each primary reference, but \gls{glossaries-extra} provides a +convenient way of having a third modifier for commands like \cs{gls} +and \cs{glstext}. This needs to be a single punctuation character +(but not \texttt{*} or \texttt{+} which are already in use). For +example: +\begin{alltt} +\ics*{GlsXtrSetAltModifier}\mgroup{\strong{!}}\mgroup{format=hyperbf,counter=page} +\end{alltt} +Now \texttt{\ics{glsdesc}\strong{!}\mgroup{Gamma}} is equivalent to: +\begin{alltt} +\ics{glsdesc}[format=hyperbf,counter=page]\mgroup{Gamma} +\end{alltt} +So the text at the start of the \qt{Gamma Functions} chapter is now +just: +\begin{alltt} +The \ics{glsdesc}!\mgroup{Gamma} is defined as +\end{alltt} +which is much more compact. Similar changes can be made for the +other instance of \ics{glslink} where the \gls{linktext} is just +the description: +\begin{alltt} +The \ics{glsdesc}!\mgroup{erf} is defined as +\end{alltt} + +There are three other instances of \ics{glslink}, such as: +\begin{alltt} +\ics{glslink}\mgroup{Gamma}\mgroup{\cs{Gamma}(x+1)} +\end{alltt} +If I just use \verb|\gls{Gamma}| then I would get $\Gamma(z)$ as the +\gls{linktext}. For entries like this that represent functions with +variable parameters it would be more convenient (and help with +consistency) if a command was available to easily replace the +parameters. + +With the base \styfmt{glossaries} package, one simple solution that +works for this example is to save just the function symbol in the +\gloskey{symbol} field, for example: +\begin{alltt} +\ics{newglossaryentry}\mgroup{Gamma}\mgroup{name=\cs{ensuremath}\mgroup{\cs{Gamma}(z)}, +\strong{symbol=\mgroup{\cs{ensuremath}\mgroup{\cs{Gamma}}},} +description=gamma function,sort=Gamma} +\end{alltt} +and then use: +\begin{alltt} +\strong{\ics{glssymbol}}\mgroup{Gamma}\strong[(\cs{Gamma}(x+1))\strong] +\end{alltt} +(which includes the function parameter inside the \gls{linktext}) or just: +\begin{alltt} +\ics{glssymbol}\mgroup{Gamma}(\cs{Gamma}(x+1)) +\end{alltt} +(which has the function parameter after the \gls{linktext}). +This is a convenient approach where the extra material can simply +follow the symbol, and it can also be used with \gls{glossaries-extra}. + +The \gls{glossaries-extra} package provides another possibility. It +requires a command that takes a single argument, for example: +\begin{verbatim} +\newcommand{\Gammafunction}[1]{\Gamma(#1)} +\end{verbatim} +The control sequence name (the command name without the leading +backslash) is stored in the field identified by the command \ics*{GlsXtrFmtField} +(this should be the internal field name not the key name, see \tableref{tab:fieldmap}). The +default is \field{useri} which corresponds to the \gloskey{user1} +key. This means that the \texttt{Gamma} entry would need to be +defined with \texttt{user1=Gammafunction}. With this approach, each +function entry would need a separate associated command. + +Another approach is to store the parameterless function in the +\gloskey{symbol} key (as earlier) and have a more generic command that uses this +symbol. This requires the entry label, which can be obtained with +\cs{glslabel} within the \gls{linktext}: +\begin{alltt} +\cs{newcommand}\mgroup{\cs{entryfunc}}[1]\mgroup{\ics{glsentrysymbol}\mgroup{\ics{glslabel}}(\#1)} +\end{alltt} +(Obviously, this command can't be used outside of the \gls{linktext} +or post-link hooks since it uses \ics{glslabel}.) + +So the entry now needs the parameterless function in +\gloskey{symbol} and the control sequence name of this generic +command in \gloskey{user1}. For example: +\begin{alltt} +\ics{newglossaryentry}\mgroup{Gamma}\mgroup{name=\cs{ensuremath}\mgroup{\cs{Gamma}(z)}, +\strong{symbol=\mgroup{\cs{ensuremath}\mgroup{\cs{Gamma}}},user1=entryfunc,} +description=gamma function,sort=Gamma} +\end{alltt} +(This doesn't need to be done for the \texttt{C} and \texttt{G} +entries since they're constants not functions.) + +You may want to consider providing helper commands to make the +functions easier to define. For example: +\begin{verbatim} +\newcommand{\func}[2]{#1(#2)} +\newcommand{\entryfunc}[1]{\func{\glsentrysymbol{\glslabel}}{#1}} +\newcommand{\newfunc}[5][]{% + \newglossaryentry{#2}{name={\ensuremath{\func{#3}{#4}}}, + symbol={#3}, + user1={entryfunc}, + description={#5}, + sort={#2},#1 + }% +} +\end{verbatim} +The entries can now be defined using this custom \cs{newfunc} +command. For example: +\begin{verbatim} +\newfunc{Gamma}{\Gamma}{z}{gamma function} +\newfunc[sort=gamma1]{gamma}{\gamma}{\alpha,x}{lower + incomplete gamma function} +\newfunc[sort=Gamma2]{iGamma}{\Gamma}{\alpha,x}{upper + incomplete gamma function} +\end{verbatim} + +Note that in \cs{newfunc} the \gloskey{symbol} key doesn't have its value +encapsulated with \ics{ensuremath} so \cs{glssymbol} will need to explicitly be +placed in math mode. If you switch to a glossary style that displays +the symbol, you will either need to adjust the definition of +\cs{newfunc} to use \ics{ensuremath} in the \gloskey{symbol} field +or you can add the encapsulation with the \attr{glosssymbolfont} +attribute. + +Now \verb|\glslink{Znu}{Z_\nu}| can simply be replaced with +\texttt{\ics{glssymbol}\mgroup{Znu}} (no parameter is required in +this case). For the other cases, where the parameter is different +from that given in the \gloskey{text} field (which is obtained from +the \gloskey{name}), you can use \ics*{glsxtrfmt}. For example, +\texttt{\cs{glslink}\mgroup{Gamma}\mgroup{\cs{Gamma}(x+1)}} can now be replaced with: +\begin{alltt} +\ics*{glsxtrfmt}\mgroup{Gamma}\mgroup{x+1} +\end{alltt} +This effectively works like \cs{glslink} but omits the post-link hook. +(See the \gls{glossaries-extra} user manual for further details.) + +\begin{important} +Don't use \ics*{glsxtrfmt} within the argument of another \ics*{glsxtrfmt} command +(or inside any other \gls{linktext}). +\end{important} + +Similarly \verb|\glslink{Gamma}{\Gamma(\alpha)}| +can now be replaced with: +\begin{alltt} +\ics*{glsxtrfmt}\mgroup{Gamma}\mgroup{\cs{alpha}} +\end{alltt} +Note that it's still possible to use: +\begin{alltt} +\ics{glssymbol}\mgroup{Gamma}[(\cs{alpha})] +\end{alltt} +You may prefer to define a helper command that makes it easier to +switch between your preferred method. For example: +\begin{verbatim} +\newcommand*{\Fn}[3][]{\glssymbol[#1]{#2}[(#3)]} +\end{verbatim} +or: +\begin{alltt} +\cs{newcommand}*\mgroup{\cs{Fn}}[3][]\mgroup{\ics*{glsxtrfmt}[\#1]\mgroup{\#2}\mgroup{\#3}} +\end{alltt} + +\bibglsnote +If you want to convert this example so that it works with \gls{bib2gls}, first +convert it to use \gls{glossaries-extra} (as described above), and +then follow the instructions from \samplefile{Eq}. The +\gls{convertgls2bib} application recognises \cs{newcommand} so it +will be able to parse the custom \cs{newfunc} commands. + +Note that \gls{bib2gls} allows you to separate the locations in the \gls{numberlist} +into different groups according to the counter used for the +location. This can be done with the \resourceopt{loc-counters} +resource option. It's also possible to identify primary formats +(such as \locfmt{hyperbf} used in this example) using the +\resourceopt{primary-location-formats} option. The primary locations +can then be given a more prominent position in the +\gls{numberlist}. See the \gls{bib2gls} user manual for further +details. + +\exitem{Sec} This document also +illustrates how to change the location to something other than the +page number. In this case, the \texttt{section} counter is used. +This example adds the glossary to the table of contents, so an extra +\LaTeX\ run is required: +\begin{prompt} +pdflatex sampleSec +makeglossaries sampleSec +pdflatex sampleSec +pdflatex sampleSec +\end{prompt} +Note that there are conflicting location formats, which trigger a +warning from \gls{makeindex}: +\begin{verbatim} +## Warning (input = sampleSec.glo, line = 6; output = +sampleSec.gls, line = 9): + -- Conflicting entries: multiple encaps for the same page +under same key. + +## Warning (input = sampleSec.glo, line = 2; output = +sampleSec.gls, line = 10): + -- Conflicting entries: multiple encaps for the same page +under same key. +\end{verbatim} +This is the result of indexing an entry multiple times for the same +location\footnote{\gls{makeindex} assumes that the location is a +page number} with different values of the \gloskey[glslink]{format} key. In this case, +it's caused by three references to the \texttt{ident} entry in section~2.1: +\begin{verbatim} +\gls[format=hyperit]{ident} +\glspl{ident} % default format=glsnumberformat +\gls*[format=hyperbf]{ident} +\end{verbatim} + +If you use the \gls{makeglossaries} Perl script it will detect the warnings in the +\gls{makeindex} transcript file and attempt to fix the conflict by +removing entries from the \filetype{glo} file: +\begin{verbatim} +Multiple encaps detected. Attempting to remedy. +Reading sampleSec.glo... +Writing sampleSec.glo... +Retrying +\end{verbatim} +(Range formats have highest precedence. The default \locfmt{glsnumberformat} +has the lowest precedence.) + +If you use \gls{makeglossaries-lite.lua} or call +\gls{makeindex} directly then the problem won't be fixed and the +glossary will end up with the rather odd \gls{numberlist} for the +identity matrix entry consisting of three references to section 2.1: +the first in the default font, followed by bold (\locfmt{hyperbf}) +and then italic (\locfmt{hyperit}), which results in 2.1, +\textbf{2.1}, \textit{2.1}. If you use \gls{makeglossaries} then +only the bold entry (\textbf{2.1}) will be present. + +If you switch to \gls{xindy}: +\begin{alltt} +\cs{usepackage}[\strong{xindy},style=altlist,toc,counter=section]\mgroup{glossaries} +\end{alltt} +then the conflict will be resolved using the number format attribute +list order of priority. In this case, \locfmt{glsnumberformat} has +the highest priority. This means that only the upright medium weight entry +(2.1) will be present. The simplest way of altering this is to +provide your own custom format. For example: +\begin{alltt} +\cs{newcommand}*\mgroup{\strong{\cs{primary}}}[1]\mgroup{\ics{hyperit}\mgroup{\#1}} +\ics{GlsAddXdyAttribute}\mgroup{\strong{primary}} +\end{alltt} +and change \verb|\gls[format=hyperit]| to \texttt{\cs{gls}[format=\strong{primary}]} etc. +This will give \csoptfmt{\gloskey[glslink]{format}=\locfmt{primary}} the highest priority. +(It's also better practice to provide this kind of semantic command.) + +With \gls{bib2gls}, you can supply rules to deal with location format +conflicts, as illustrated below. + +\bibglsnote +In order to switch to \gls{bib2gls}, first replace +\styfmt{glossaries} with \gls{glossaries-extra}, and add the \pkgopt*{record} +package option. Remember that \gls{glossaries-extra} has a different +set of defaults and you may also want to patch the predefined base styles. +For example: +\begin{alltt} +\cs{usepackage}[style=altlist,\strong{\xtrfont{postdot},\xtrfont{stylemods}},counter=section] +\mgroup{\strong{glossaries-extra}} +\end{alltt} + +The entry definitions now need to be converted into \gls{bib2gls} +format and saved in a \filetype{bib} file (say, \texttt{entries.bib}). You can use +\gls{convertgls2bib}: +\begin{prompt} +convertgls2bib -{}-preamble-only sampleSec.tex entries.bib +\end{prompt} + +Next replace \ics{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[src=entries] +\end{alltt} +and remove all the \cs{newglossaryentry} commands. + +Finally, replace \ics{printglossaries} with \ics*{printunsrtglossaries}. +The document build is now: +\begin{prompt} +pdflatex sampleSec +bib2gls sampleSec +pdflatex sampleSec +\end{prompt} +As with the original example, there's still a location format +conflict, which \gls{bib2gls} warns about: +\begin{verbatim} +Warning: Entry location conflict for formats: hyperbf and hyperit +Discarding: {ident}{}{section}{hyperbf}{2.1} +Conflicts with: {ident}{}{section}{hyperit}{2.1} +\end{verbatim} +This means that it has discarded the bold location and kept the +italic one. (As with \gls{makeglossaries}, range formats have the +highest priority and \locfmt{glsnumberformat} has the lowest.) + +It would be better if the conflict could be merged into +a single location that was both bold and italic. To achieve this, +it's first necessary to define a command that produces this effect: +\begin{alltt} +\cs{newcommand}*\mgroup{\ics{hyperbfit}}[1]\mgroup{\cs{textbf}\mgroup{\cs{hyperit}\mgroup{\#1}}} +\end{alltt} +Now \gls{bib2gls} needs to be invoked with the appropriate mapping +with the \bibglslongopt{map-format} or \bibglsopt{m} switch: +\begin{prompt} +bib2gls -m \glsquote{hyperbf:hyperbfit,hyperit:hyperbfit} sampleSec +\end{prompt} +If you are using \app{arara} the directive should be: +\begin{alltt} +\% arara: bib2gls: \mgroup{ mapformats: [ [hyperbf, hyperbfit], +\% arara: -{}-> [hyperit, hyperbfit] ] } +\end{alltt} + +If you try out this example, notice the difference between +\pkgopt+{only}{record} and \pkgopt+{nameref}{record}. If you use the +latter, the locations will now be the section titles rather than the +section numbers. If you use the \optfmt{nameref} setting you can customize the +location by defining the command: +\begin{alltt} +\csmeta*{glsxtr}{counter}{locfmt}\marg{location}\marg{title} +\end{alltt} + +In this case the counter is \ctrfmt{section}, so the command should be +\ics*{glsxtrsectionlocfmt}. It takes two arguments: the first is the +location and the second is the title. For example: +\begin{alltt} +\cs{newcommand}*\mgroup{\ics*{glsxtrsectionlocfmt}}[2]\mgroup{\ics{S}\#1 \#2} +\end{alltt} +(The only command of this type that is defined by default is the one +for the \ctrfmt{equation} counter, \ics*{glsxtrequationlocfmt}.) Make sure +that you have at least version 1.42 of \gls{glossaries-extra}. + +\section{Multiple Glossaries} +\label{sec:samplestype} + +See also \samplefile{Sort} in \sectionref{sec:samplessort}, which +has three glossaries. + +\exitem{Ntn} This document illustrates +how to create an additional glossary type. This example adds the +glossary to the table of contents, so an extra \LaTeX\ run is +required: +\begin{prompt} +pdflatex sampleNtn +makeglossaries sampleNtn +pdflatex sampleNtn +pdflatex sampleNtn +\end{prompt} +Note that if you want to call \gls{makeindex} explicitly instead of +using the \gls{makeglossaries} or \gls{makeglossaries-lite.lua} +scripts then you need to call \gls{makeindex} twice: +\begin{enumerate} +\item Create the main glossary (all on one line): +\begin{prompt} +makeindex -s sampleNtn.ist -t sampleNtn.glg -o sampleNtn.gls sampleNtn.glo +\end{prompt} +\item Create the secondary glossary (all on one line): +\begin{prompt} +makeindex -s sampleNtn.ist -t sampleNtn.nlg -o sampleNtn.not sampleNtn.ntn +\end{prompt} +\end{enumerate} +This document creates a new glossary using: +\begin{alltt} +\ics{newglossary}[nlg]\mgroup{notation}\mgroup{not}\mgroup{ntn}\mgroup{Notation} +\end{alltt} +This defines a glossary that can be identified with the label +\texttt{notation} with the default title \qt{Notation}. The other +arguments are the file extensions required with \optsand23. For those +two options, the \styfmt{glossaries} package needs to know the input +and output files required by \gls{makeindex} or \gls{xindy}. + +(The optional argument is the file extension of the indexing transcript +file, which \styfmt{glossaries} doesn't need to know about, but it +writes the information to the \filetype{aux} file for the benefit of +\gls{makeglossaries} and \gls{makeglossaries-lite.lua}.) + +If you switch to a different indexing option then these file extensions +aren't required, in which case it's simpler to use the starred form: +\begin{alltt} +\ics{newglossary*}\mgroup{notation}\mgroup{Notation} +\end{alltt} + +This example uses a label prefixing system\footnote{If you use +\sty{babel} with a language that makes the colon character +\texttt{:} active you will need to change the prefix.}\ to differentiate +between the different types of entries. For example, the term +\qt{set} is defined as: +\begin{verbatim} +\newglossaryentry{gls:set}{name=set, +description={A collection of distinct objects}} +\end{verbatim} +and the set notation is defined as: +\begin{verbatim} +\newglossaryentry{not:set}{type=notation, +name={\ensuremath{\mathcal{S}}}, +description={A \gls{gls:set}},sort={S}} +\end{verbatim} +Notice that the latter description contains \cs{gls}. This means +you shouldn't use \ics{glsdesc} with this entry otherwise you will +end up with nested links. + +\glsxtrnote +The \gls{glossaries-extra} package provides a command for use in +within field values to prevent nested \gls{linktext}: +\begin{alltt} +\ics*{glsxtrp}\marg{field}\marg{label} +\end{alltt} +There are convenient shortcuts for common fields: +\texttt{\ics*{glsps}\marg{label}} (for the \gloskey{short} field) and +\texttt{\ics*{glspt}\marg{label}} (for the \gloskey{text} +field). So the set notation definition can be modified: +\begin{alltt} +\cs{newglossaryentry}\mgroup{not:set}\mgroup{type=notation, +name=\mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}}, +description=\mgroup{A \strong{\ics*{glspt}\mgroup{gls:set}}},sort={S}} +\end{alltt} +This will stop the inner reference from causing interference if you use \ics{glsdesc}. +It will also suppress indexing within the glossary but will have a +hyperlink (if \styfmt{hyperref} is used). + +The \gls{glossaries-extra} package provides a way of defining +commands like \cs{gls} that automatically insert a prefix. For +example: +\begin{alltt} +\ics*{glsxtrnewgls}\mgroup{not:}\mgroup{\cs{sym}} +\ics*{glsxtrnewglslike}\mgroup{gls:}\mgroup{\cs{term}}\mgroup{\cs{termpl}}\mgroup{\cs{Term}}\mgroup{\cs{Termpl}} +\end{alltt} +(there's no point providing commands for plural or case-changing with +symbols). Now \verb|\gls{not:set}| can be replaced with \verb|\sym{set}| and +\verb|\gls{gls:set}| can be replaced with \verb|\term{set}|. + +\bibglsnote +These two commands are primarily provided for the benefit of \gls{bib2gls} as +the information is written to the \filetype{aux} file. This allows +\gls{bib2gls} to recognise the custom commands if they have been +used in the \filetype{bib} files. When combined with +\resourceopt{label-prefix} and \resourceopt{ext-prefixes} (see +below) this makes it much simpler to change the prefixes if +necessary. + +If you want to convert this document to use \gls{bib2gls}, remember +that you need the \pkgopt*{record} or \pkgopt+{nameref}{record} +option. For example: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record},}\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{glossaries-extra} +\end{alltt} +As with earlier examples, \gls{convertgls2bib} can be used to +convert the entry definitions into the required \filetype{bib} format. +You may prefer to split the entries into separate files according to +type.\footnote{Requires at least \gls{bib2gls} v2.0.} This is useful +if you want to reuse a large database of +entries across multiple documents as it doesn't lock you into using +a specific glossary. For example: +\begin{prompt} +convertgls2bib -{}-split-on-type -{}-preamble-only sampleNtn.tex entries.bib +\end{prompt} +This will create a file called \nolinkurl{entries.bib} that contains +the entries that didn't have a \gloskey{type} assigned in the original +file, such as: +\begin{alltt} +\atentry{entry}\mgroup{gls:set, + name = \mgroup{set}, + description = \mgroup{A collection of distinct objects} +} +\end{alltt} +It will also create a file called \nolinkurl{notation.bib} that +contains the entries that had the \gloskey{type} set to +\texttt{notation} in the original file, such as: +\begin{alltt} +\atentry{entry}\mgroup{not:set, + name = \mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}}, + description = \mgroup{A \ics*{glspt}\mgroup{gls:set}} +} +\end{alltt} +Note that the \gloskey{type} field has been removed. The above entry +in the \nolinkurl{notation.bib} file references a term in the +\nolinkurl{entries.bib} file. It's possible to strip all the +prefixes from the \filetype{bib} files and get \gls{bib2gls} to +automatically insert them. In which case, this cross-reference needs +adjusting to indicate that it's referring to an entry in another +file. This can be done with one of the special +\xtrfont{\texttt{ext\meta{n}.}}\ prefixes: +\begin{alltt} +\atentry{entry}\mgroup{\strong{set}, + name = \mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}}, + description = \mgroup{A \ics*{glspt}\mgroup{\strong{\xtrfont{ext1.}}set}} +} +\end{alltt} +The corresponding term in the \nolinkurl{entries.bib} file is now: +\begin{alltt} +\atentry{entry}\mgroup{\strong{set}, + name = \mgroup{set}, + description = \mgroup{A collection of distinct objects} +} +\end{alltt} + +Now you can replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{entries},\strong{\xtrfont{label-prefix}=\mgroup{gls:}}] +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{notation},\resourceopt{type}=notation, + \strong{\xtrfont{label-prefix}=\mgroup{not:},\xtrfont{ext-prefixes}=\mgroup{gls:}}] +\end{alltt} +Remove all the \cs{newglossaryentry} definitions and replace \cs{printglossaries} with +\ics*{printunsrtglossaries}. + +Regardless of how many resource sets the document contains, only one +\gls{bib2gls} call is required: +\begin{prompt} +pdflatex sampleNtn +bib2gls sampleNtn +pdflatex sampleNtn +\end{prompt} + +You may notice that the ordering in the notations list has changed +from the original. This is because the \gloskey{sort} field was +automatically removed by \gls{convertgls2bib}, so the entries are +now sorted according to the \gloskey{name} field (since they are +defined with \atentry{entry}). You can use your text editor's search +and replace function to replace all instances of \atentry{entry} +with \atentry{symbol} in the \nolinkurl{notations.bib} file so that, +for example, the \texttt{set} definition becomes: +\begin{alltt} +\strong{\atentry{symbol}}\mgroup{set, + name = \mgroup{\cs{ensuremath}\mgroup{\cs{mathcal}\mgroup{S}}}, + description = \mgroup{A \ics*{glspt}\mgroup{\xtrfont{ext1.}set}} +} +\end{alltt} +Now these \atentry{symbol} entries will be sorted according to their +label. (The original label in the \filetype{bib} file, not the +prefixed label.) This will put them in the same order as the original +document. (See the \qt{Examples} chapter of +the \gls{bib2gls} user manual for examples of varying the sorting +and also \bibglsgallery{sorting}.) + +\exitem{-dual} This document +illustrates how to define an entry that both appears in the list of +acronyms and in the main glossary. To create the document do: +\begin{prompt} +pdflatex sample-dual +makeglossaries sample-dual +pdflatex sample-dual +\end{prompt} +This defines a custom command \ics{newdualentry} that defines two entries at once (a +normal entry and an abbreviation). It uses \ics{glsadd} to ensure +that if one is used then the other is automatically indexed: +\begin{verbatim} +\newcommand*{\newdualentry}[5][]{% + % main entry: + \newglossaryentry{main-#2}{name={#4},% + text={#3\glsadd{#2}},% + description={#5},% + #1% additional options for main entry + }% + % abbreviation: + \newacronym{#2}{#3\glsadd{main-#2}}{#4}% +} +\end{verbatim} +A sample dual entry is defined with this command: +\begin{verbatim} +\newdualentry{svm}% label + {SVM}% abbreviation + {support vector machine}% long form + {Statistical pattern recognition technique}% description +\end{verbatim} +This defines an acronym with the label \texttt{svm} that can be +referenced with \verb|\gls{svm}| but it also defines an entry with +the label \texttt{main-svm}. This isn't used in the document with +\cs{gls} but it's automatically added from the +\texttt{\cs{glsadd}\mgroup{main-svm}} in the short form of +\texttt{svm}. + +For this trivial document, this kind of dual entry is redundant and +unnecessarily leads the reader down a trail, first to the list of +acronyms and from there the reader then has to go to the main +glossary to look up the description. It's better to simply include +the description in the list of acronyms. + +\bibglsnote +If you want to switch over to \gls{bib2gls}, first change to +\gls{glossaries-extra}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot},\xtrfont{stylemods},acronym]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next, the definition needs to be converted to the \filetype{bib} +format required by \gls{bib2gls}. If you do: +\begin{prompt} +convertgls2bib -{}-preamble-only sample-dual.tex entries.bib +\end{prompt} +then \gls{convertgls2bib} will report the following: +\begin{verbatim} +Overriding default definition of \newdualentry with custom +definition. (Change \newcommand to \providecommand if you want +\newdualentry[options]{label}{short}{long}{description} +converted to @dualabbreviationentry.) +\end{verbatim} +This is because \gls{convertgls2bib} has its own internal definition +of \cs{newdualentry}, but if it encounters a new definition that +will override its default. If you want to retain +\gls{convertgls2bib}['s] definition (recommended) then just replace +\cs{newcommand} with \cs{providecommand} in the document source and +rerun \gls{convertgls2bib}. + +With \cs{providecommand}, the new \nolinkurl{entries.bib} file +created by \gls{convertgls2bib} contains: +\begin{alltt} +\atentry{dualabbreviationentry}\mgroup{svm, + short = \mgroup{SVM}, + description = \mgroup{Statistical pattern recognition technique}, + long = \mgroup{support vector machine} +} +\end{alltt} +If \cs{newcommand} is retained, it will instead contain: +\begin{alltt} +\atentry{entry}\mgroup{main-svm, + name = \mgroup{support vector machine}, + description = \mgroup{Statistical pattern recognition technique}, + text = \mgroup{SVM\cs{glsadd}\mgroup{svm}} +} + +\atentry{acronym}\mgroup{svm, + short = \mgroup{SVM\cs{glsadd}\mgroup{main-svm}}, + long = \mgroup{support vector machine} +} +\end{alltt} +In the first case, \gls{bib2gls} creates two linked entries using +its primary-dual mechanism. In the second case, \gls{bib2gls} +creates two entries that simply reference each other. + +Assuming that your \nolinkurl{entries.bib} file just contains +\atentry{dualabbreviationentry}, +now replace \cs{makeglossaries} with: +\begin{alltt} +\cs{GlsXtrLoadResources}[\resourceopt{src}=entries,\% entries.bib + \resourceopt{type}=acronym,\resourceopt{dual-type}=main,\resourceopt{dual-prefix}=\mgroup{main-}] +\end{alltt} + +Then remove the definition of \cs{newdualentry} and the entry +definition. Finally, replace \cs{printglossaries} with +\ics*{printunsrtglossaries}. +The document build is: +\begin{prompt} +pdflatex sample-dual +bib2gls sample-dual +pdflatex sample-dual +\end{prompt} + +If, instead, your \nolinkurl{entries.bib} file contains separate +\atentry{entry} and \atentry{acronym}, then you need: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +If you need \glspl{numberlist}, the document build is now +\begin{prompt} +pdflatex sample-dual +bib2gls sample-dual +pdflatex sample-dual +bib2gls sample-dual +pdflatex sample-dual +\end{prompt} +and this time \gls{bib2gls} complains about the use of \ics{glsadd} +within the \gloskey{short} and \gloskey{text} fields as this can be +problematic. (The extra \gls{bib2gls} and \LaTeX\ calls are +to ensure the \gls{numberlist} is up to date for the +\texttt{main-svm} entry, which can only be indexed with \cs{glsadd} +after \texttt{svm} has been defined.) + +Dual entries make much more sense when one entry is for a glossary +with the description displayed but no \gls{numberlist}, and the +other is for the index without the description but with a +\gls{numberlist}. This can be created with by replacing +\atentry{dualabbreviationentry} with \atentry{dualindexabbreviation}: +\begin{alltt} +\atentry{dualindexabbreviation}\mgroup{svm, + description = \mgroup{Statistical pattern recognition technique}, + short = \mgroup{SVM}, + long = \mgroup{support vector machine} +} +\end{alltt} +This can be mixed with \atentry{index} terms for example: +\begin{alltt} +\atentry{index}\mgroup{machlearn, + name=\mgroup{machine learning} +} +\end{alltt} +The document needs modifying: +\begin{alltt} +\cs{documentclass}\mgroup{article} + +\ics{usepackage}[\xtrfont{record},\xtrfont{postdot}, + nostyles,\xtrfont{stylemods}=\mgroup{\xtrfont{bookindex},list},\% only want bookindex and list styles + acronym]\mgroup{glossaries-extra} + +\ics*{setabbreviationstyle}\mgroup{long-short-desc} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\% entries.bib + \resourceopt{dual-type}=acronym, + \xtrfont{label-prefix}=\mgroup{\strong{idx.}},\resourceopt{dual-prefix}=\mgroup{}, + \resourceopt{combine-dual-locations}=\mgroup{primary}] + +\ics*{glsxtrnewglslike}\mgroup{\strong{idx.}}\mgroup{\strong{\cs{idx}}}\mgroup{\cs{idxpl}}\mgroup{\cs{Idx}}\mgroup{\cs{Idxpl}} + +\cs{begin}\mgroup{document} +\cs{gls}\mgroup{svm} and \strong{\cs{idx}}\mgroup{machlearn}. + +\ics*{printunsrtglossary}[type=\acronymtype,style=altlist] +\ics*{printunsrtglossary}[style=bookindex,title=\mgroup{Index}] +\cs{end}\mgroup{document} +\end{alltt} +See the \gls{bib2gls} manual for further details. + +\exitem{-langdict} This document +illustrates how to use the glossaries package to create English +to French and French to English dictionaries. To create the document +do: +\begin{prompt} +pdflatex sample-langdict +makeglossaries sample-langdict +pdflatex sample-langdict +\end{prompt} +This example uses the \pkgopt{nomain} package option to prevent the +creation of the \texttt{main} glossary. This means that the document +must provide its own glossaries: +\begin{verbatim} +\newglossary[glg]{english}{gls}{glo}{English to French} +\newglossary[flg]{french}{flx}{flo}{French to English} +\end{verbatim} +This means that if you want to call \gls{makeindex} explicitly +you need to take these new extensions into account: +\begin{prompt} +makeindex -s sample-langdict.ist -t sample-langdict.glg -o sample-langdict.gls sample-langdict.glo +makeindex -s sample-langdict.ist -t sample-langdict.flg -o sample-langdict.flx sample-langdict.flo +\end{prompt} +As with the previous example, this document provides a custom +command that defines two related entries: +\begin{verbatim} +\newcommand*{\newword}[4]{% + \newglossaryentry{en-#1}{type=english,name={#2},description={#3 #4}}% + \newglossaryentry{fr-#1}{type=french,name={#3 #4},text={#4},sort={#4}, + description={#2}}% +} +\end{verbatim} +This has the syntax: +\begin{alltt} +\cs{newword}\marg{label}\marg{english}\marg{determiner}\marg{french} +\end{alltt} +(Note that this trivial example doesn't take plurals into account.) +This custom command will define two terms with labels \texttt{en-\meta{label}} (for +the English term) and \texttt{fr-\meta{label}} (for the French term). +So +\begin{verbatim} +\newword{cat}{cat}{le}{chat} +\end{verbatim} +is equivalent to: +\begin{verbatim} +\newglossaryentry{en-cat}{type=english,name={cat},description={le chat}} +\newglossaryentry{fr-cat}{type=french,name={le chat},sort={chat}, + description={cat}} +\end{verbatim} + +Unlike the previous example (\samplefile{-dual}), there's no link +between these two entries. If the document only uses +\verb|\gls{en-cat}|, then the \texttt{en-cat} entry will appear in the +\texttt{english} glossary but the \texttt{fr-cat} entry won't +appear in the \texttt{french} one. + +\bibglsnote +If you want to switch to \gls{bib2gls} then you first need to +convert the document so that it uses \gls{glossaries-extra}, but +include the \pkgopt*{prefix} option to ensure that +\sty{glossaries-prefix} is also loaded: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record},\xtrfont{prefix}},\xtrfont{postdot},\xtrfont{stylemods},nomain]\mgroup{\strong{glossaries-extra}} +\end{alltt} +You don't need to worry about file extensions now, so it's simpler +to use the starred form of \cs{newglossary}: +\begin{alltt} +\cs{newglossary}\strong{*}\mgroup{english}\mgroup{English to French} +\cs{newglossary}\strong{*}\mgroup{french}\mgroup{French to English} +\end{alltt} +Next the entries need to be converted to the \filetype{bib} format +required by \gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-only-preamble sample-langdict.tex entries.bib +\end{prompt} +This creates the file \nolinkurl{entries.bib} that contains entries +defined like: +\begin{alltt} +\atentry{entry}\mgroup{en-cat, + name = \mgroup{cat}, + description = \mgroup{le chat}, + type = \mgroup{english} +} + +\atentry{entry}\mgroup{fr-cat, + name = \mgroup{le chat}, + description = \mgroup{cat}, + text = \mgroup{chat}, + type = \mgroup{french} +} +\end{alltt} +(Note that the \gloskey{sort} field has been omitted.) + +This would be more flexible, and much briefer, if these entries were +defined using \gls{bib2gls}['s] dual entry system combined with the +\sty{glossaries-prefix} package: +\begin{alltt} +\atentry{dualentry}\mgroup{cat, + name = \mgroup{chat}, + description = \mgroup{cat}, + \gloskey{prefix} = \mgroup{le}, + \gloskey{prefixplural} = \mgroup{les} +} +\end{alltt} +Similarly for the \qt{chair} entry: +\begin{alltt} +\atentry{dualentry}\mgroup{chair, + name = \mgroup{chaise}, + description = \mgroup{chair}, + \gloskey{prefix} = \mgroup{la}, + \gloskey{prefixplural} = \mgroup{les} +} +\end{alltt} + +With \atentry{dualentry}, the English and French terms are now +automatically linked from \gls{bib2gls}['s] point of view. If only one +is referenced in the document, the other will also be added by default. + +Now that the determiner has been moved out of the description, it +won't show in the glossary. However, it's possible to include it by +providing a command to encapsulate the description (which can also +apply the language change as well). + +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\% entries.bib + \xtrfont{append-prefix-field}=\mgroup{space}, + \resourceopt{category}=\mgroup{same as type},\resourceopt{dual-category}=\mgroup{same as type}, + \xtrfont{label-prefix}=\mgroup{en-},\resourceopt{dual-prefix}=\mgroup{fr-}, + \resourceopt{type}=english,\resourceopt{dual-type}=french, + \resourceopt{sort}=en,\resourceopt{dual-sort}=fr] + +\cs{newcommand}\mgroup{\cs{FrEncap}}[1]\mgroup{\% + \ics{foreignlanguage}\mgroup{french}\mgroup{\ics{glsentryprefix}\mgroup{\ics{glscurrententrylabel}}\#1}} +\cs{newcommand}\mgroup{\cs{EnEncap}}[1]\mgroup{\ics{foreignlanguage}\mgroup{english}\mgroup{\#1}} + +\ics*{glssetcategoryattribute}\mgroup{english}\mgroup{glossnamefont}\mgroup{EnEncap} +\ics*{glssetcategoryattribute}\mgroup{english}\mgroup{glossdescfont}\mgroup{FrEncap} +\ics*{glssetcategoryattribute}\mgroup{french}\mgroup{glossnamefont}\mgroup{FrEncap} +\ics*{glssetcategoryattribute}\mgroup{french}\mgroup{glossdescfont}\mgroup{EnEncap} +\end{alltt} + +Remember to remove \cs{makeglossaries}, the definition of \cs{newword} and +the entry definitions from the document preamble, and +replace \cs{printglossary} with: +\begin{alltt} +\ics*{printunsrtglossary} +\end{alltt} + +Other refinements that you might like to make include using +\ics*{glsxtrnewglslike} so you don't have to worry about the label +prefix (\qt{en-} and \qt{fr-}). + +\exitem{-index} This document uses +the \styfmt{glossaries} package to create both a glossary and an +index. This requires two \gls{makeglossaries} (or +\gls{makeglossaries-lite.lua}) calls to ensure the +document is up to date: +\begin{prompt} +pdflatex sample-index +makeglossaries sample-index +pdflatex sample-index +makeglossaries sample-index +pdflatex sample-index +\end{prompt} + +\section{Sorting} +\label{sec:samplessort} + +\exitem{People} This document illustrates how you can hook into the +standard sort mechanism to adjust the way the sort key is set. This +requires an additional run to ensure the table of contents is +up-to-date: +\begin{prompt} +pdflatex samplePeople +makeglossaries samplePeople +pdflatex samplePeople +pdflatex samplePeople +\end{prompt} +This provides two commands for typesetting a name: +\begin{verbatim} +\newcommand{\sortname}[2]{#2, #1} +\newcommand{\textname}[2]{#1 #2} +\end{verbatim} +where the first argument contains the forenames and the second is the +surname. The first command is the one required for sorting the name +and the second is the one required for displaying the name in the +document. A synonym is then defined: +\begin{verbatim} +\let\name\textname +\end{verbatim} +This command defaults to the display name command (\cs{textname}) +but is temporarily redefined to the sort name command (\cs{sortname}) +within the \gloskey{sort} field assignment hook: +\begin{alltt} +\cs{renewcommand}\mgroup{\ics{glsprestandardsort}}[3]\mgroup{\% + \strong{\cs{let}\cs{name}\cs{sortname}} + \cs{edef}\#1\mgroup{\cs{expandafter}\cs{expandonce}\cs{expandafter}\mgroup{#1}}\% + \strong{\cs{let}\cs{name}\cs{textname}} + \ics{glsdosanitizesort} +} +\end{alltt} +The people are defined using the custom \cs{name} command: +\begin{alltt} +\cs{newglossaryentry}\mgroup{joebloggs}\mgroup{name=\mgroup{\strong{\cs{name}}\mgroup{Joe}\mgroup{Bloggs}}, + description=\mgroup{\cs{nopostdesc}}} +\end{alltt} +Since \cs{name} is temporarily changed while the \gloskey{sort} key +is being assigned, the sort value for this entry ends up as +\qt{Bloggs, Joe}, but the name appears in the document as \qt{Joe Bloggs}. + +\bibglsnote +If you want to use \gls{bib2gls}, you first need to convert the +document to use \gls{glossaries-extra} but make sure you include the +\pkgopt*{record} option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{stylemods},style=listgroup]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next it's necessary to convert the entry definitions to the +\filetype{bib} format required by \gls{bib2gls}. You can simply do: +\begin{prompt} +convertgls2bib -{}-preamble-only samplePeople people.bib +\end{prompt} +which will create a file called \nolinkurl{people.bib} that contains +definitions like: +\begin{alltt} +\atentry{entry}\mgroup{joebloggs, + name = \mgroup{\cs{name}\mgroup{Joe}\mgroup{Bloggs}}, + description = \mgroup{\ics{nopostdesc}} +} +\end{alltt} +However, you may prefer to use the \texttt{-{}-index-conversion} +(\texttt{-i}) switch: +\begin{prompt} +convertgls2bib -i -{}-preamble-only samplePeople people.bib +\end{prompt} +This will discard the \gloskey{description} field and use +\atentry{index} instead of \atentry{entry} if the +\gloskey{description} is either empty or simply set to \ics{nopostdesc} or +\ics*{glsxtrnopostpunc}. The \nolinkurl{people.bib} file now +contains definitions like: +\begin{alltt} +\atentry{index}\mgroup{joebloggs, + name = \mgroup{\cs{name}\mgroup{Joe}\mgroup{Bloggs}} +} +\end{alltt} +Regardless of which approach you used to create the \filetype{bib} +file, you now need to edit it to provide a definition of the custom +\cs{name} command for \gls{bib2gls}['s] use: +\begin{alltt} +\atentry{preamble}\mgroup{"\strong{\ics{providecommand}}\mgroup{\cs{name}}[2]\mgroup{\#2, \#1}"} +\end{alltt} +Note the use of \cs{providecommand} instead of \cs{newcommand}. + +In the document (\nolinkurl{samplePeople.tex}) you now need to +delete \cs{makeglossaries}, the definitions of \cs{sortname}, +\cs{textname}, \cs{name}, \cs{glsprestandardsort}, and all the entry +definitions. Then add the following to the document preamble: +\begin{alltt} +\cs{newcommand}\mgroup{\cs{name}}[2]\mgroup{\#1 \#2} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=people] +\end{alltt} +Next, use your text editor's search and replace function to +subsitute all instances of \cs{glsentrytext} in the chapter +headings with \ics*{glsfmttext}. For example: +\begin{alltt} +\ics{chapter}\mgroup{\strong{\ics*{glsfmttext}}\mgroup{joebloggs}} +\end{alltt} +Finally, replace \cs{printunsrtglossaries} with: +\begin{alltt} +\ics*{printunsrtglossaries} +\end{alltt} +The document build is now: +\begin{prompt} +pdflatex samplePeople +bib2gls samplePeople +pdflatex samplePeople +pdflatex samplePeople +\end{prompt} +The third \LaTeX\ call is required to ensure that the PDF bookmarks +are up to date, as the entries aren't defined until after the +\gls{bib2gls} run (which is why you have to use \ics*{glsfmttext} +instead of \cs{glsentrytext}). + +This again leads to a list sorted by surname. The reason this works +is because \gls{bib2gls} only sees the definition of \cs{name} +provided in \atentry{preamble}, but the document uses the definition +of \cs{name} provided before \cs{GlsXtrLoadResources}. The use of +\ics{providecommand} in \atentry{preamble} prevents \cs{name} from +being redefined within the document. + +See also the \qt{Examples} chapter of the \gls{bib2gls} user manual, +which provides another \qt{people} example. + +\exitem{Sort} This is another document that illustrates how to hook +into the standard sort mechanism. An additional run is required to +ensure the table of contents is up-to-date: +\begin{prompt} +pdflatex sampleSort +makeglossaries sampleSort +pdflatex sampleSort +pdflatex sampleSort +\end{prompt} +This document has three glossaries (\texttt{main}, \texttt{acronym} +and a custom \texttt{notation}), so if you want to use +\gls{makeindex} explicitly you will need to have three +\gls{makeindex} calls with the appropriate file extensions: +\begin{prompt} +pdflatex sampleSort +makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn +makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo +makeindex -s sampleSort.ist -t sampleSort.nlg -o sampleSort.not sampleSort.ntn +pdflatex sampleSort +pdflatex sampleSort +\end{prompt} +It's much simpler to just use \gls{makeglossaries} or \gls{makeglossaries-lite.lua}. + +In this example, the sort hook is adjusted to ensure the list of +notation is sorted according to the order of definition. A new +counter is defined to keep track of the entry number: +\begin{verbatim} +\newcounter{sortcount} +\end{verbatim} +The sort hook is then redefined to increment this counter and assign +the sort key to that numerical value, but only for the +\texttt{notation} glossary. The other two glossaries have their sort +keys assigned as normal: +\begin{verbatim} +\renewcommand{\glsprestandardsort}[3]{% + \ifdefstring{#2}{notation}% + {% + \stepcounter{sortcount}% + \edef#1{\glssortnumberfmt{\arabic{sortcount}}}% + }% + {% + \glsdosanitizesort + }% +} +\end{verbatim} +This means that \gls{makeindex} will sort the notation in numerical order. + +\glsxtrnote +If you want to convert this document to use \gls{glossaries-extra}, +a much simpler approach is available with its hybrid method. First +change the package loading line to: +\begin{alltt} +\cs{usepackage}[\xtrfont{postdot},\xtrfont{stylemods},acronym]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Either remove \cs{setacronymstyle} and replace all instances of +\cs{newacronym} with \ics*{newabbreviation} or replace: +\begin{verbatim} +\setacronymstyle{long-short} +\end{verbatim} +with: +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\end{alltt} + +The custom counter and redefinition of \cs{glsprestandardsort} can now +be removed. The file extensions for the custom \texttt{notation} +glossary are no longer relevant so the glossary definition can be +changed to: +\begin{alltt} +\cs{newglossary\strong{*}}\mgroup{notation}\mgroup{Notation} +\end{alltt} +The \ics{makeglossaries} command now needs to be adjusted to +indicate which glossaries need to be processed by \gls{makeindex}: +\begin{alltt} +\cs{makeglossaries}\strong{[main,acronym]} +\end{alltt} +Finally, \ics{printglossaries} needs to be replaced with: +\begin{alltt} +\cs{printglossary} +\cs{printacronyms} +\cs{print\strong{noidx}glossary}[type=notation\strong{,sort=def}] +\end{alltt} +Note that the \texttt{notation} glossary, which hasn't been listed in the optional +argument of \cs{makeglossaries}, must be displayed with \ics{printnoidxglossary}. + +This means that \gls{makeindex} only needs to process the +\texttt{main} and \texttt{acronym} glossaries. No actual sorting is +performed for the \texttt{notation} glossary because, when used with +\printnoidxglosskey[def]{sort}, \cs{printnoidxglossary} simply +iterates over the list of entries that have been indexed. + +The document build doesn't need the third \LaTeX\ call now (since +none of the glossaries extend beyond a page break): +\begin{prompt} +pdflatex sampleSort +makeglossaries sampleSort +pdflatex sampleSort +\end{prompt} +This time \gls{makeglossaries} will include the message: +\begin{verbatim} +only processing subset 'main,acronym' +\end{verbatim} +This means that although \gls{makeglossaries} has noticed the \texttt{notation} glossary, +it will be skipped. + +If you are explicitly calling \gls{makeindex} then you need to drop the call +for the \texttt{notation} glossary: +\begin{prompt} +pdflatex sampleSort +makeindex -s sampleSort.ist -t sampleSort.alg -o sampleSort.acr sampleSort.acn +makeindex -s sampleSort.ist -t sampleSort.glg -o sampleSort.gls sampleSort.glo +pdflatex sampleSort +\end{prompt} + +\bibglsnote +If you prefer to use \gls{bib2gls}, the package loading line needs +to be changed to: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot},\xtrfont{stylemods},acronym]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next the entry definitions need to be convert to the \filetype{bib} +format required by \gls{bib2gls}. + +For this example, it's simpler to split the entries into different files according +to the glossary type. This can be done with the +\texttt{-{}-split-on-type} or \texttt{-t} switch: +\begin{prompt} +convertgls2bib -t -{}-preamble-only sampleSort.tex entries.bib +\end{prompt} +This will create three files: +\begin{description} +\item[\nolinkurl{entries.bib}] which contains the entries that were +defined with \ics{newglossaryentry}. For example: +\begin{alltt} +\atentry{entry}\mgroup{gls:set, + name = {set}, + description = {A collection of distinct objects} +} +\end{alltt} + +\item[\nolinkurl{abbreviations.bib}] which contains the entries that +were defined with \ics{newacronym}. For example: +\begin{alltt} +\atentry{acronym}\mgroup{zfc, + short = \mgroup{ZFC}, + long = \mgroup{Zermelo-Fraenkel set theory} +} +\end{alltt} +If you changed \ics{newacronym} to \ics*{newabbreviation} then +\atentry{abbreviation} will be used instead: +\begin{alltt} +\atentry{abbreviation}\mgroup{zfc, + short = \mgroup{ZFC}, + long = \mgroup{Zermelo-Fraenkel set theory} +} +\end{alltt} + +\item[\nolinkurl{notation.bib}] which contains the entries that were +defined with \texttt{\gloskey{type}=notation}. For example: +\begin{alltt} +\atentry{entry}\mgroup{not:set, + name = \mgroup{\$\cs{mathcal}\mgroup{S}\$}, + description = \mgroup{A set}, + text = \mgroup{\cs{mathcal}\mgroup{S}} +} +\end{alltt} +You may prefer to replace \atentry{entry} with \atentry{symbol} +in this file. +\end{description} +\emph{After} the definition of the \texttt{notation} glossary +(\cs{newglossary}), add: +\begin{alltt} +\% abbreviation style must be set first: +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{entries,abbreviations}] +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{notation},\% notation.bib + \strong{\xtrfont{type}=notation},\resourceopt{sort}=\strong{unsrt}] +\end{alltt} +Delete the remainder of the preamble (\cs{makeglossaries} and entry +definitions). + +Finally, replace the lines that display the glossaries with: +\begin{alltt} +\ics*{printunsrtglossaries} +\end{alltt} +The build process is now: +\begin{prompt} +pdflatex sampleSort +bib2gls sampleSort +pdflatex sampleSort +\end{prompt} + +In this case, I have one resource command that processes two +glossaries (\texttt{main} and \texttt{acronym}) at the same time. +The entries in these glossaries are ordered alphabetically. +The second resource command processes the \texttt{notation} glossary but +the entries in this glossary aren't sorted (and so will appear in +the order of definition within the \filetype{bib} file). + +See also \samplefile{Ntn}, \bibglsgallery{sorting} and the \gls{bib2gls} user manual +for more examples. + +\section{Child Entries} +\label{sec:samplesparent} + +\exitem{} This document illustrates some of +the basics, including how to create child entries that use the same +name as the parent entry. This example adds the glossary to the +table of contents and it also uses \ics{glsrefentry}, so an extra \LaTeX\ +run is required: +\begin{prompt} +pdflatex sample +makeglossaries sample +pdflatex sample +pdflatex sample +\end{prompt} +You can see the difference between word and letter ordering if you +add the package option \pkgopt[letter]{order}. (Note +that this will only have an effect if you use +\gls{makeglossaries} or \gls{makeglossaries-lite.lua}. +If you use \gls{makeindex} explicitly, you will need to use the +\mkidxopt{l} switch to indicate letter ordering.) + +One of the entries has its name encapsulated with a semantic command: +\begin{alltt} +\cs{newcommand}\mgroup{\strong{\cs{scriptlang}}}[1]\mgroup{\cs{textsf}\mgroup{\#1}} + +\cs{newglossaryentry}\mgroup{Perl}\mgroup{name=\strong{\cs{scriptlang}}\mgroup{Perl},\strong{sort=Perl,} +description=\mgroup{A scripting language}} +\end{alltt} +This means that this entry needs to have the \gloskey{sort} key set +otherwise \gls{makeindex} will assign it to the \qt{symbol} letter +group, since it starts with a backslash (which \gls{makeindex} +simply treats as punctuation). + +The homograph entries \qt{glossary} and \qt{bravo} are defined as +sub-entries that inherit the name from the parent entry. The parent +entry doesn't have a description, but with the default +\pkgopt[false]{nopostdot} setting this will lead to a spurious dot. +This can be removed by adding \ics{nopostdesc} to the description, +which suppresses the post-description hook for that entry. + +Since the child entries have the same name as the parent, this means +that the child entries will have duplicate sort values unless the +default is changed with the \gloskey{sort} key: +\begin{alltt} +\cs{newglossaryentry}\mgroup{glossary}\mgroup{name=glossary, + description=\mgroup{\strong{\ics{nopostdesc}}},plural=\mgroup{glossaries}} + +\ics{newglossaryentry}\mgroup{glossarycol}\mgroup{ + description=\mgroup{collection of glosses}, + \strong{sort=\mgroup{2},} + parent=\mgroup{glossary}\% parent \emph{label} +} + +\cs{newglossaryentry}\mgroup{glossarylist}\mgroup{ + description=\mgroup{list of technical words}, + \strong{sort=\mgroup{1},} + parent=\mgroup{glossary}\% parent \emph{label} +} +\end{alltt} +(Remember that the entries are sorted hierarchically.) This will +place \texttt{glossarylist} before \texttt{glossarycol}, but both +will come immediately after their parent \texttt{glossary} entry. + +\glsxtrnote +If you switch to using \gls{glossaries-extra}, remember that the +default package options are different: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{postdot},\xtrfont{stylemods}},style=treenonamegroup,order=word, + subentrycounter]\mgroup{\strong{glossaries-extra}} +\end{alltt} + +You may now want to consider replacing \ics{nopostdesc} in the +descriptions with \ics*{glsxtrnopostpunc} (using your +text editor's search and replace function). This suppresses the +post-description punctuation but not the category post-description +hook. + +You may have noticed that some of the descriptions include the +plural form, but it's not done very consistently. For example: +\begin{verbatim} +\newglossaryentry{cow}{name=cow, + plural=cows,% not required as this is the default + user1=kine, + description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult +female of any bovine animal} +} +\end{verbatim} +which has the parenthetical material at the start of the +description with emphasis, +\begin{verbatim} +\newglossaryentry{bravocry}{ + description={cry of approval (pl.\ bravos)}, + sort={1}, + parent={bravo} +} +\end{verbatim} +which has the parenthetical material at the end of the +description without emphasis even though it's a regular plural, +\begin{verbatim} +\newglossaryentry{bravoruffian}{ + description={hired ruffian or killer (pl.\ bravoes)}, + sort={2}, + plural={bravoes}, + parent=bravo} +\end{verbatim} +which has the parenthetical material at the end of the +description without emphasis, and +\begin{verbatim} +\newglossaryentry{glossary}{name=glossary, + description={\nopostdesc}, + plural={glossaries}} +\end{verbatim} +which doesn't show the plural in the description. + +With \gls{glossaries-extra}, you can remove this parenthetical +material and implement it using the category post-description hook instead. +For example, the above definitions become: +\begin{verbatim} +\newglossaryentry{cow}{name=cow, + user1=kine, + description={an adult female of any bovine animal} +} + +\newglossaryentry{bravocry}{ + description={cry of approval}, + sort={1}, + parent={bravo} +} + +\newglossaryentry{bravoruffian}{ + description={hired ruffian or killer}, + sort={2}, + plural={bravoes}, + parent=bravo} +\end{verbatim} +\begin{alltt} +\cs{newglossaryentry}\mgroup{glossary}\mgroup{name=glossary, + description=\mgroup{\strong{\ics*{glsxtrnopostpunc}}}, + plural=\mgroup{glossaries}} +\end{alltt} +The post-description hook for the \cat{general} category can now be +set: +\begin{alltt} +\ics*{glsdefpostdesc}\mgroup{general}\mgroup{\% +\codecomment{\% Has the user1 key been set?} + \ics*{glsxtrifhasfield}\mgroup{useri}\mgroup{\ics{glscurrententrylabel}}\% + \mgroup{\cs{space}(\cs{emph}\mgroup{pl.}\cs{ }\ics{glsentryplural}\mgroup{\ics{glscurrententrylabel}}, + \cs{emph}\mgroup{archaic} \ics{glscurrentfieldvalue})\% + }\% + \mgroup{\% +\codecomment{\% The user1 key hasn't been set. Is the plural the same as the +\% singular form with the plural suffix appended?} + \ics*{GlsXtrIfXpFieldEqXpStr}\mgroup{plural}\mgroup{\ics{glscurrententrylabel}}\% + \mgroup{\ics{glsentrytext}\mgroup{\ics{glscurrententrylabel}}\ics{glspluralsuffix}}\% + \mgroup{\% +\codecomment{\% Sibling check with \gls{bib2gls} (see below)} + }\% + \mgroup{\% +\codecomment{\% The plural isn't the default. Does this entry have a parent?} + \cs{ifglshasparent}\mgroup{\cs{glscurrententrylabel}}% + \mgroup{\% +\codecomment{\% This entry has a parent. +\% Are the plurals for the child and parent the same?} + \ics*{GlsXtrIfXpFieldEqXpStr}\mgroup{plural}\mgroup{\cs{glscurrententrylabel}}\% + \mgroup{\cs{glsentryplural}\mgroup{\cs{glsentryparent}\mgroup{\cs{glscurrententrylabel}}}}\% + \mgroup{}\% \codecomment{child and parent plurals the same} + \mgroup{\% + \cs{space}(\cs{emph}\mgroup{pl.}\cs{ }\cs{glsentryplural}\mgroup{\cs{glscurrententrylabel}})\% + }\% + }% + \mgroup{\cs{space}(\cs{emph}\mgroup{pl.}\cs{ }\ics{glsentryplural}\mgroup{\ics{glscurrententrylabel}})}\% + }\% + }\% +} +\end{alltt} +(If you try this example out, notice the difference for the +\texttt{glossary} entry if you use \cs{nopostdesc} and then +replace it with \ics*{glsxtrnopostpunc}.) +See the \gls{glossaries-extra} user manual for further details and +also \bibglsbegin. + +The \qt{bravo} homographs are an oddity where the singular form is +identical but the plural is different (\qt{bravos} and +\qt{bravoes}). In the original, both descriptions included the +plural term. The above modifications drop the display of the regular +\qt{bravos} plural (for the \texttt{bravocry} term) and only show +the \qt{bravoes} plural (for the \texttt{bravoruffian} term). In this +particular case it might be useful to show the regular plural in +order to highlight the difference. + +While it's straightforward to access an entry's parent label (with +\ics{glsentryparent}) it's much harder to access entry's children or +siblings. The \ics{ifglshaschildren} command has to iterate over all +entries to determine if any have a parent that matches the given +label. This is obviously very time-consuming if you have a large +database of entries. It also doesn't provide a way of determining +whether or not the child entries have been indexed. + +With \gls{bib2gls}, it's possible to save this information with the +\resourceopt{save-child-count} and \resourceopt{save-sibling-count}, +which not only save the total but also save the child or sibling +labels in an \sty{etoolbox} internal list. This makes the +information much faster to access and also only includes the labels of +those entries that have actually been indexed. + +In the above, the comment line: +\begin{alltt} +\codecomment{\% Sibling check with \gls{bib2gls} (see below)} +\end{alltt} +indicates where to put the extra code. If you switch to +\gls{bib2gls} and make sure to use \resourceopt{save-sibling-count} +then you can insert the following code in the block above where that +comment is: +\begin{alltt} +\ics*{GlsXtrIfFieldNonZero}\mgroup{siblingcount}\mgroup{\cs{glscurrententrylabel}}\% +\mgroup{\% \codecomment{\xtrfield{siblingcount} field value non-zero} + \ics*{glsxtrfieldforlistloop} \% \codecomment{iterate over internal list} + \mgroup{\cs{glscurrententrylabel}}\% \codecomment{entry label} + \mgroup{siblinglist}\% \codecomment{label of field containing list} + \mgroup{\cs{siblinghandler}}\% \codecomment{loop handler} +}\% +\mgroup{}\% \codecomment{\xtrfield{siblingcount} field value 0 or empty or missing} +\end{alltt} +This uses a custom handler that's defined as follows: +\begin{alltt} +\cs{newcommand}\mgroup{\cs{siblinghandler}}[1]\mgroup{\% + \ics*{GlsXtrIfXpFieldEqXpStr}*\mgroup{plural}\mgroup{\cs{glscurrententrylabel}}\% + \mgroup{\cs{glsentryplural}\mgroup{\#1}}\% + \mgroup{}\% \codecomment{current entry's plural same as sibling's plural} + \mgroup{\% + \cs{space}(\cs{emph}\mgroup{pl.}\cs{ }\cs{glsentryplural}\mgroup{\cs{glscurrententrylabel}})\% + \ics{listbreak} + }% +} +\end{alltt} +The \cs{listbreak} command is provided by \sty{etoolbox} and is used +for prematurely exiting a loop. The handler tests if the sibling's +\gloskey{plural} field is identical to the current entry's \gloskey{plural} +field. If they are the same, it does nothing. If they are different, +it displays the current entry's plural and breaks the loop. + +Note that this assumes that the parent entry hasn't had the plural +form explicitly set to \qt{bravoes} instead of the default +\qt{bravos}. In that case, the parent entry would show the plural +but the \texttt{bravoruffian} child entry wouldn't show the plural (since +this case would led to the empty code block identified with the +comment \qt{child and parent plurals the same}). The \qt{bravoes} +plural form would instead be shown for the parent, which wouldn't +look right. + +If you don't use \gls{bib2gls} or if you use it without the +\resourceopt{save-sibling-count} resource option then the sibling +information won't be available. + +\bibglsnote +In order to switch to using \gls{bib2gls}, it's first necessary to +switch to using \gls{glossaries-extra} (as above). Remember that the +\pkgopt*{record} option is required: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record},}\xtrfont{postdot},\xtrfont{stylemods},style=treenonamegroup, +subentrycounter]\mgroup{glossaries-extra} +\end{alltt} +Next the entry definitions need to be converted to the +\filetype{bib} format required by \gls{bib2gls}. This can be done +with \gls{convertgls2bib}: +\begin{alltt} +convertgls2bib -{}-preamble-only sample.tex entries. +\end{alltt} +The semantic command may be moved to the \filetype{bib} file to +ensure it's defined: +\begin{alltt} +\atentry{preamble}\mgroup{"\cs{providecommand}\mgroup{\cs{scriptlang}}[1]\mgroup{\cs{textsf}\mgroup{\#1}}"} +\end{alltt} + +The \gloskey{sort} field typically shouldn't be set when using +\gls{bib2gls}, so \gls{convertgls2bib} strips it. +If the \gloskey{sort} field is missing, \gls{bib2gls} will obtain it +from the sort fallback for that entry type. In this case, +\atentry{entry} has the \gloskey{name} field as the sort fallback. +If this is also missing then its value is obtained from the parent's +\gloskey{name} field (see \bibglsgallery{sorting} for other examples). + +Therefore the \qt{Perl} entry is simply defined as: +\begin{alltt} +\atentry{entry}\mgroup{Perl, + name = \mgroup{\cs{scriptlang}\mgroup{Perl}}, + description = \mgroup{A scripting language} +} +\end{alltt} +This isn't a problem for \gls{bib2gls}. In this case, the command +has been provided in the \atentry{preamble}, but \gls{bib2gls} +strips font information so the sort value becomes \texttt{Perl}. +If the definition isn't placed in \atentry{preamble} then +\gls{bib2gls} will simply ignore the command (as \gls{xindy} does) +so the sort value will still end up as \texttt{Perl}. + +The homograph entries have also had their \gloskey{sort} fields omitted: +\begin{alltt} +\atentry{entry}\mgroup{glossarycol, + parent = \mgroup{glossary}, + description = \mgroup{collection of glosses} +} + +\atentry{entry}\mgroup{glossarylist, + parent = \mgroup{glossary}, + description = \mgroup{list of technical words} +} +\end{alltt} + +This means that the sort value for both these child entries is +\qt{glossary}. When \gls{bib2gls} encounters identical sort values +it acts according to its \resourceopt{identical-sort-action} setting. +The default action is to sort by the label using a simple string +comparison. In this case, it would put \texttt{glossarycol} before +\texttt{glossarylist}. In the original document, the \gloskey{sort} +value was manually chosen to ensure that the entries are ordered +according to \gls{firstuse}. This ordering can easily be obtained +by changing \gls{bib2gls}['s] identical sort action (requires at +least \gls{bib2gls} v2.0): +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{entries},\strong{\xtrfont{identical-sort-action}=use}] +\end{alltt} +This command should replace \cs{makeglossaries}. If you want the +sibling information (see earlier), then you need to remember to add +\resourceopt{save-sibling-count} to the list of options. + +Note that this is a better solution than in the original example. If +I edit the document so that \texttt{glossarycol} is used first, then +the ordering will be updated accordingly, but with the original +example, the \gloskey{sort} keys would need to be manually changed. + +The remainder of the preamble (that is, the definition of +\cs{scriptlang} and all the entry definitions) should now be +removed. + +Finally, replace \cs{printglossaries} with \ics*{printunsrtglossaries}. +The document build is now: +\begin{prompt} +pdflatex sample +bib2gls -{}-group sample +pdflatex sample +pdflatex sample +\end{prompt} +Note use of the \bibglslongopt{group} (or \bibglsopt{g}) switch, which is needed +to support the \glostyle{treenonamegroup} style. The third \LaTeX\ +call is needed because the document contains \ics{glsrefentry}. + +Note that you can't use the \pkgopt[letter]{order} package option +with \gls{bib2gls}. Instead use the \resourceopt[none]{break-at} +resource option: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=\mgroup{entries},\xtrfont{identical-sort-action}=use, + \strong{\xtrfont{break-at}=none} +] +\end{alltt} + +\exitem{-inline} This document is +like \texttt{sample.tex}, above, but uses the \glostyle{inline} +glossary style to put the glossary in a footnote. The document build +is: +\begin{prompt} +pdflatex sample-inline +makeglossaries sample-inline +pdflatex sample-inline +pdflatex sample-inline +\end{prompt} +If you want to convert this document to \gls{glossaries-extra}, +follow the same procedure as above. If you want to use \gls{bib2gls} +then you don't need the \bibglslongopt{group} switch since no letter +groups are required. + +\exitem{tree} This document illustrates +a hierarchical glossary structure where child entries have different +names to their corresponding parent entry. To create the document +do: +\begin{prompt} +pdflatex sampletree +makeglossaries sampletree +pdflatex sampletree +\end{prompt} +The document uses the \glostyle{alttreehypergroup} glossary style, +which needs to know the widest name for each hierarchical level. +This has been assigned manually in the preamble with +\ics{glssetwidest}: +\begin{verbatim} +\glssetwidest{Roman letters} % level 0 widest name +\glssetwidest[1]{Sigma} % level 1 widest name +\end{verbatim} +(Level~0 is the top-most level. That is, entries that don't have a +parent.) It's possible to get \styfmt{glossaries} to compute the +widest top-level entry with \ics{glsfindwidesttoplevelname} but this +will iterate over all top-level entries, regardless of whether or +not they appear in the glossary. If you have a large database of +entries, this will firstly take time and secondly the width may be +too large due to an unindexed entry with a big name. + +This sample document doesn't require any of the tabular styles so I've +prevented those packages from being loaded with \pkgopt{nolong} and +\pkgopt{nosuper}. The reduces the overall package loading. +\begin{alltt} +\cs{usepackage}[style=alttreehypergroup,\strong{nolong,nosuper}] +\mgroup{glossaries} +\end{alltt} +(This example glossary is actually better suited for one of the +topic styles provided with \sty*{glossary-topic}, see below.) + +This is obviously a contrived example since it's strange to have the +symbol names (such as \qt{Sigma}) in the glossary. The purpose is to +demonstrate the \glostyle{alttreehypergroup} with an entry that's +noticeably wider than the others in the same hierarchical level. A +more sensible document would have the symbol in the \gloskey{name} +key. + +\glsxtrnote +If you want to switch to \gls{glossaries-extra}, then you can +instead use a combination of \pkgopt{nostyles} and +\pkgopt*{stylemods}: +\begin{alltt} +\cs{usepackage}[style=alttreehypergroup,\xtrfont{postdot},\strong{nostyles, +\xtrfont{stylemods=tree}}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The \pkgopt*{stylemods} package not only patches the original styles +provided by the base \styfmt{glossaries} package (such as +\sty{glossary-tree} used in this example) but also provides extra +helper commands. In this case, it provides additional commands to +calculate the widest name. For example, instead of manually setting +the widest entry with \ics{glssetwidest}, you could add the +following before the glossary: +\begin{alltt} +\ics*{glsFindWidestUsedTopLevelName} +\ics*{glsFindWidestUsedLevelTwo} +\end{alltt} +This will only take into account the entries that have actually been +used in the document, but it can still be time-consuming if you have +a large number of entries. + +\begin{important} +Note that the glossary must be at the end of the document (after all +required entries have been used) with this method. The alternative +is to perform the calculation at the end of the document and save +the results in the \filetype{aux} file for the next run. +\end{important} + +This example document is using top-level entries for topics without +descriptions. This means that the descriptions simply contain +\ics{nopostdesc} to prevent the post-description punctuation from +being automatically inserted. For example: +\begin{verbatim} +\newglossaryentry{greekletter}{name={Greek letters}, +text={Greek letter}, +description={\nopostdesc}} +\end{verbatim} +With \gls{glossaries-extra}, you can convert this to +\ics*{glsxtrnopostpunc} which will prevent the post-description +punctuation without interfering with the category post-description +hook. + +In order to distinguish between the child entries, which are +symbols, and the parent entries, which are topics, it's useful to +give these two different types of entries different categories. The +topics can use the default \cat{general} category, but the symbol +entries can be assigned to a different category. The value of the +\xtrgloskey{category} key must be a label. For example: +\begin{alltt} +\cs{newglossaryentry}\mgroup{C}\mgroup{name=\mgroup{C}, +description=\mgroup{Euler's constant}, +\strong{\xtrfont{category}=symbol,} +parent=romanletter} +\end{alltt} + +There is some redundancy caused by a parenthetical note after the \gls{firstuse} in some +of the symbol entries. For example: +\begin{verbatim} +\newglossaryentry{pi}{name={pi}, +text={\ensuremath{\pi}}, +first={\ensuremath{\pi} (lowercase pi)}, +description={Transcendental number}, +parent=greekletter} +\end{verbatim} +With \gls{glossaries-extra} this can be dealt with through the category post-link hook: +\begin{alltt} +\ics*{glsdefpostlink}\mgroup{symbol}\mgroup{\% + \ics*{glsxtrifwasfirstuse} + \mgroup{\% first use + \ics*{glsxtrifhasfield}\mgroup{useri}\mgroup{\ics{glslabel}}\% + \mgroup{ (\ics{glscurrentfieldvalue})}\mgroup{}\% + }\% + \mgroup{}\% not first use +} +\end{alltt} +The parenthetical material is now stored in the \gloskey{user1} key. +For example: +\begin{alltt} +\cs{newglossaryentry}\mgroup{sigma}\mgroup{name={Sigma}, +text=\mgroup{\cs{ensuremath}{\cs{Sigma}}}, +\strong{user1=\mgroup{uppercase sigma},} +description=\mgroup{Used to indicate summation}, +parent=greekletter} +\end{alltt} +The category post-description link is also set to ensure that the symbol is +displayed after the description in the glossary: +\begin{alltt} +\ics*{glsdefpostdesc}\mgroup{symbol}\mgroup{\cs{space} + (\$\ics{glsentrytext}\mgroup{\ics{glscurrententrylabel}}\$)} +\end{alltt} +These modifications only affect entries with the +\xtrgloskey{category} set to \cat{symbol}. + +With \gls{glossaries-extra}, it's now possible to use the topic +styles provided with the \sty*{glossary-topic} package: +\begin{alltt} +\cs{usepackage}[style=\strong{\xtrfont{topic}},\xtrfont{postdot},\strong{nostyles,\xtrfont{stylemods=\mgroup{tree\strong{,topic}}}}] +\mgroup{\strong{glossaries-extra}} +\end{alltt} +The \xtrglostyle{topic} style is designed for this kind of hierarchy +where all the top-level entries don't have descriptions. This means +that the \ics{nopostdot} and \ics*{glsxtrnopostpunc} commands aren't +required. The top-level entries can simply be defined as: +\begin{alltt} +\cs{newglossaryentry}\mgroup{greekletter}\mgroup{name=\mgroup{Greek letters}, +text=\mgroup{Greek letter}, description=\mgroup{}} + +\cs{newglossaryentry}\mgroup{romanletter}\mgroup{name=\mgroup{Roman letters}, +text=\mgroup{Roman letter}, description=\mgroup{}} +\end{alltt} +I've now loaded both the \sty{glossary-tree} and +\sty{glossary-topic} packages +(via \pkgopt*{stylemods}\optfmt{\dequals\mgroup{tree\dcomma topic}}). The +\sty{glossary-topic} package can be used without +\sty{glossary-tree}, in which case it will behave more like the +normal \glostyle{tree} rather than \glostyle{alttree} styles (but +with different indentation and no description in the top-level). +However, if you use \ics{glssetwidest} (provided by +\sty{glossary-tree}) then the \xtrglostyle{topic} style will behave +more like \glostyle{alttree}. + +Since there's no description for the top-level entries, the +\xtrglostyle{topic} style ignores the widest name setting for the +top-level, so I can just have the level~1 setting: +\begin{verbatim} +\glssetwidest[1]{Sigma} +\end{verbatim} + +\bibglsnote +If you want to convert this document so that it uses \gls{bib2gls}, +you first need to convert it to using \gls{glossaries-extra}, as +described above, but remember that you now need the \pkgopt*{record} +option. +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record},}style=topic,\xtrfont{postdot},nostyles,\xtrfont{stylemods=\mgroup{tree,topic}}] +\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next convert the entries to the \filetype{bib} format required by +\gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-preamble-only sampletree.tex entries.bib +\end{prompt} +Now replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\strong{\xtrfont{set-widest}}] +\end{alltt} +I've used the \resourceopt{set-widest} option here to get +\gls{bib2gls} to compute the widest name. (Obviously, it can only do +this if it can correctly interpret any commands contained in the +\gloskey{name} field.) + +This means that the \ics{glssetwidest} commands can now be removed +completely. All the \cs{newglossaryentry} commands also need to be removed from +the preamble. Finally, \cs{printunsrtglossaries} needs to be +replaced with \ics*{printunsrtglossaries}. The document build is now: +\begin{prompt} +pdflatex sampletree +bib2gls sampletree +pdflatex sampletree +\end{prompt} + +This produces the same result as with just \gls{glossaries-extra} +and \gls{makeglossaries}. However, there are some modifications that +can be made to the \filetype{bib} file to make it neater. + +The top-level entries are defined as: +\begin{alltt} +\atentry{entry}\mgroup{greekletter, + name = \mgroup{Greek letters}, + description = \mgroup{}, + text = \mgroup{Greek letter} +} + +\atentry{entry}\mgroup{romanletter, + name = \mgroup{Roman letters}, + description = \mgroup{}, + text = \mgroup{Roman letter} +} +\end{alltt} +This is a direct translation from the \cs{newglossaryentry} commands +(after switching to the \xtrglostyle{topic} style). There's a more +appropriate entry type: +\begin{alltt} +\atentry{indexplural}\mgroup{greekletter, + text = \mgroup{Greek letter} +} + +\atentry{indexplural}\mgroup{romanletter, + text = \mgroup{Roman letter} +} +\end{alltt} +The \atentry{indexplural} entry type doesn't require the +\gloskey{description} and will set the \gloskey{name} field to the +same as the \gloskey{plural} field. Since the \gloskey{plural} field +hasn't been set it's obtained by appending \qt{s} to the +\gloskey{text} field. + +Now let's assume that the symbol entries are defined in a more +rational manner, with the actual symbol in the \gloskey{name} field. +For example: +\begin{alltt} +\atentry{entry}\mgroup{sigma, + user1 = \mgroup{uppercase sigma}, + parent = \mgroup{greekletter}, + description = \mgroup{Used to indicate summation}, + \strong{name = \mgroup{\cs{ensuremath}\mgroup{\cs{Sigma}}}}, + category = \mgroup{symbol} +} + +\atentry{entry}\mgroup{C, + parent = \mgroup{romanletter}, + name = \mgroup{\cs{ensuremath}\mgroup{C}}, + description = \mgroup{Euler's constant}, + category = \mgroup{symbol} +} +\end{alltt} +The category post-description hook (provided with +\ics*{glsdefpostdesc}) should now be removed from the document. + +If you make these changes and rebuild the document, you'll find that +the order has changed. Now the \texttt{sigma} entry is before the +\texttt{pi} entry. This is because \gls{bib2gls} is obtaining the +sort values from the \gloskey{name} field, which is the sort +fallback for \atentry{entry}. This means that the sort values end up +as $\Sigma$ and $\pi$ (\gls{bib2gls} recognises the commands +\ics{Sigma} and \ics{pi} and converts them to the Unicode characters +0x1D6F4 and 0x1D70B). + +If you change \atentry{entry} to \atentry{symbol} then you will once +again get the order from the original example (\texttt{pi} before +\texttt{Sigma}). This is because the sort fallback for +\atentry{symbol} is the label not the \gloskey{name}. (Remember that +the sort fallback is only used if the \gloskey{sort} field isn't +set. If you explicitly set the \gloskey{sort} field then no fallback +is required. See \bibglsgallery{sorting}.) + +You can further tidy the \filetype{bib} file by removing the +\xtrgloskey{category} fields. For example: +\begin{alltt} +\atentry{symbol}\mgroup{sigma, + user1 = \mgroup{uppercase sigma}, + parent = \mgroup{greekletter}, + description = \mgroup{Used to indicate summation}, + name = \mgroup{\cs{ensuremath}\mgroup{\cs{Sigma}}} +} +\end{alltt} +You can then assign the \xtrgloskey{category} in the resource set: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\xtrfont{set-widest},\strong{\xtrfont{category}=\mgroup{same as entry}}] +\end{alltt} +This means that all the entries defined with \atentry{symbol} will +have the \xtrgloskey{category} set to \texttt{symbol} and all the +entries defined with \atentry{indexplural} will have the +\xtrgloskey{category} set to \texttt{indexplural}. (Only the +\cat{symbol} category is significant in this example.) + +You can make the \filetype{bib} files even more flexible by +introducing field and entry aliases with \resourceopt{field-aliases} +and \resourceopt{entry-type-aliases}. See the \gls{bib2gls} manual +for further details. + +\section{Cross-Referencing} +\label{sec:samplescrossref} + +\exitem{-crossref} +This document illustrates how to cross-reference entries in the +glossary. +\begin{prompt} +pdflatex sample-crossref +makeglossaries sample-crossref +pdflatex sample-crossref +\end{prompt} +The document provides a command \ics{alsoname} to produce some fixed text, which can be +changed as appropriate (usually within a language hook): +\begin{verbatim} +\providecommand{\alsoname}{see also} +\end{verbatim} +I've used \cs{providecommand} as some packages define this command. +This is used to create a \qt{see also} cross-reference with the +\gloskey{see} key: +\begin{verbatim} +\newglossaryentry{apple}{name=apple,description={firm, round fruit}, +see=[\alsoname]{pear}} + +\newglossaryentry{marrow}{name={marrow}, + description={long vegetable with thin green skin and white flesh}, + see={[\alsoname]courgette}} +\end{verbatim} + +Note that \qt{marrow} is included in the glossary even though it +hasn't been referenced in the text. This is because the +\gloskey{see} key automatically triggers \ics{glssee} which indexes +the term. This behaviour is intended for documents where only the +terms that are actually required in the document are defined. It's +not suitable for a large database of terms shared across multiple +documents that may or may not be used in a particular document. In +that case, you may want to consider using \gls{glossaries-extra} +(see below). + +\glsxtrnote +This example is quite simple to convert to \gls{glossaries-extra}. +If you want the dot after the description, you need the +\pkgopt[false]{nopostdot} or \pkgopt*{postdot} package option. You +may also want to consider using the \pkgopt*{stylemods} option. + +In order to prevent the \qt{marrow} entry from being automatically +being added to the glossary as a result of the cross-reference, you +can use \pkgopt+{false}{autoseeindex} to prevent the automatic +indexing triggered by the \gloskey{see} key (or the +\xtrgloskey{seealso} key provided by \gls{glossaries-extra}). + +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{autoseeindex}=false},\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{glossaries-extra} +\end{alltt} +The document build is the same, but now the \qt{marrow} and +\qt{zucchini} entries aren't present in the document. + +Note that the \qt{fruit} entry is still included even though it +hasn't been used in the document. This is because it was explicitly +indexed with \ics{glssee} not via the \gloskey{see} key. + +The entries that contains \texttt{see=[\cs{alsoname}]} +can be converted to use the \xtrgloskey{seealso} key: +\begin{alltt} +\cs{newglossaryentry}\mgroup{apple}\mgroup{name=apple,description=\mgroup{firm, round fruit}, +\strong{\xtrfont{seealso}=\mgroup{pear}}} + +\cs{newglossaryentry}\mgroup{marrow}\mgroup{name=\mgroup{marrow}, + description=\mgroup{long vegetable with thin green skin and white flesh}, + \strong{\xtrfont{seealso}=\mgroup{courgette}}} +\end{alltt} +(The provided \cs{alsoname} definition may be removed.) + +The original example redefines the cross-referencing format to use +\gls{smallcaps}: +\begin{alltt} +\cs{renewcommand}\mgroup{\ics{glsseeitemformat}}[1]\mgroup{\cs{textsc}\mgroup{\ics{glsentryname}\mgroup{\#1}}} +\end{alltt} +This will still produce the desired effect with \gls{glossaries-extra} for +this simple example but, as with \samplefile{AcrDesc}, +this redefinition isn't necessary if you have at least +\gls{glossaries-extra} v1.42. + +\bibglsnote +If you want to switch to \gls{bib2gls} then you first need to switch +to \gls{glossaries-extra}, as described above, but you now need the +\pkgopt*{record} option but no longer need the +\pkgopt+{false}{autoseeindex} option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot},\xtrfont{stylemods}]\mgroup{glossaries-extra} +\end{alltt} +Next the entry definitions need to be converted to the +\filetype{bib} format required by \gls{bib2gls}. +\begin{prompt} +convertgls2bib sample-crossref.tex entries.bib +\end{prompt} +If you have at least v2.0 then \gls{convertgls2bib} will absorb the +cross-referencing information supplied by: +\begin{verbatim} +\glssee{fruit}{pear,apple,banana} +\end{verbatim} +into the \texttt{fruit} definition: +\begin{alltt} +\atentry{entry}\mgroup{fruit, + see = \mgroup{pear,apple,banana}, + name = \mgroup{fruit}, + description = \mgroup{sweet, fleshy product of plant containing seed} +} +\end{alltt} +Now remove \cs{makeglossaries} and all the entry definition commands +(including \cs{glssee} from the preamble) and add: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries.bib] +\end{alltt} +Finally, replace \cs{printglossaries} with +\ics*{printunsrtglossaries}. The document build is now: +\begin{prompt} +pdflatex sample-crossref +bib2gls sample-crossref +pdflatex sample-crossref +\end{prompt} +The glossary now contains: apple, banana, courgette and pear. Note +that it doesn't contain fruit, zucchini or marrow. + +Now change the selection criteria: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries.bib, + \strong{\xtrfont{selection}=\mgroup{recorded and deps and see}}] +\end{alltt} +The glossary now includes fruit, zucchini and marrow. + +The fruit and zucchini use the \gloskey{see} key which is a simple +redirection for the reader. There's no \gls{numberlist} for either +of these entries. Whereas marrow uses the \xtrgloskey{seealso} key, +which is typically intended as a supplement to a \gls{numberlist} +but in this case there are no locations as marrow hasn't been used +in the text. + +With at least v2.0, there's an alternative: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries.bib, + \resourceopt{selection}=\mgroup{recorded and deps and see\strong{ not also}}] +\end{alltt} +In this case, the glossary includes fruit and zucchini but not marrow. + + +\section{Custom Keys} +\label{sec:samplescustomkeys} + +\exitem{-newkeys} This document illustrates how add custom keys +(using \ics{glsaddkey}). There are two custom keys \texttt{ed}, where +the default value is the \gloskey{text} field with \qt{ed} appended, +and \texttt{ing}, where the default value is the \gloskey{text} +field with \qt{ing} appended. Since the default value in both cases +references the \gloskey{text} field, the starred version +\cs{glsaddkey*} is required to ensure that the default value is expanded on +definition if no alternative has been provided. + +The entries are then defined as follows: +\begin{verbatim} +\newglossaryentry{jump}{name={jump},description={}} + +\newglossaryentry{run}{name={run},% + ed={ran},% + ing={running}, + description={}} + +\newglossaryentry{waddle}{name={waddle},% + ed={waddled},% + ing={waddling},% + description={}} +\end{verbatim} + +Each custom key is provided a set of commands analogous to +\cs{glsentrytext}, that allows the key value to be accessed, and +\cs{glstext} that allows the key value to be access with indexing +and hyperlinking (where applicable). + +If you find yourself wanting to create a lot of custom keys that +produce minor variations of existing keys (such as different tenses) +you may find it simpler to just use \cs{glsdisp}. When editing the +document source, it's usually simpler to read: +\begin{verbatim} +The dog \glsdisp{jump}{jumped} over the duck. +\end{verbatim} +than +\begin{verbatim} +The dog \glsed{jump} over the duck. +\end{verbatim} + +\bibglsnote +If you want to convert this document to use \gls{bib2gls}, you first +need to switch to \gls{glossaries-extra}, but remember that you need +the \pkgopt*{record} option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}}]{\strong{glossaries-extra}} +\end{alltt} +Next convert the entry definitions to the \filetype{bib} format +required by \gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-index-conversion -{}-preamble-only sample-newkeys.tex entries.bib +\end{prompt} +The \texttt{-{}-index-conversion} switch requires at least v2.0 and +will convert entries without a description (or where the description +is simply \ics{nopostdesc} or \ics*{glsxtrnopostpunc}) to +\atentry{index} instead of \atentry{entry}. This means that the +new \nolinkurl{entries.bib} file will contain: +\begin{alltt} +\atentry{index}\mgroup{jump, + name = \mgroup{jump} +} + +\atentry{index}\mgroup{run, + ing = \mgroup{running}, + name = \mgroup{run}, + ed = \mgroup{ran} +} + +\atentry{index}\mgroup{waddle, + ing = \mgroup{waddling}, + name = \mgroup{waddle}, + ed = \mgroup{waddled} +} +\end{alltt} +Now replace \cs{makeglossaries} with +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +and delete the \cs{newglossaryentry} commands. Finally replace +\cs{printglossaries} with \ics*{printunsrtglossaries}. + +The document build is now: +\begin{prompt} +pdflatex sample-newkeys +bib2gls sample-newkeys +pdflatex sample-newkeys +\end{prompt} +Note that there's no need for the \pkgopt{nonumberlist} package +option when you don't use \gls{bib2gls}['s] \texttt{-{}-group} +switch. + +\exitem{-storage-abbr} This document illustrates how add custom +storage keys (using \cs{glsaddstoragekey}). The document build is: +\begin{prompt} +pdflatex sample-storage-abbr +makeglossaries sample-storage-abbr +pdflatex sample-storage-abbr +\end{prompt} + +The custom storage key is called \texttt{abbrtype} which defaults +to \texttt{word} if not explicitly set. Its value can be accessed +with the provided custom command \cs{abbrtype}. +\begin{alltt} +\ics{glsaddstoragekey}\mgroup{abbrtype}\mgroup{word}\mgroup{\cs{abbrtype}} +\end{alltt} +A custom abbreviation style is then defined that checks the value of +this key and makes certain adjustments depending on whether or not +its value is the default \texttt{word}. + +This essentially forms a very similar function to the +\gls{glossaries-extra} package's \xtrgloskey{category} key, which is +also defined as a storage key: +\begin{alltt} +\cs{glsaddstoragekey}\mgroup{category}\mgroup{general}\mgroup{\ics*{glscategory}} +\end{alltt} + +\glsxtrnote +This document is much simpler with the \gls{glossaries-extra} +package: +\begin{alltt} +\cs{documentclass}\mgroup{article} +\cs{usepackage}[\xtrfont{postdot}]\mgroup{\strong{glossaries-extra}} +\cs{makeglossaries} +\ics*{setabbreviationstyle}[\strong{acronym}]\mgroup{short-long} +\ics{newacronym}\mgroup{radar}\mgroup{radar}\mgroup{radio detecting and ranging} +\ics{newacronym}\mgroup{laser}\mgroup{laser}\mgroup{light amplification by stimulated +emission of radiation} +\ics{newacronym}\mgroup{scuba}\mgroup{scuba}\mgroup{self-contained underwater breathing +apparatus} + +\ics*{newabbreviation}\mgroup{dsp}\mgroup{DSP}\mgroup{digital signal processing} +\ics*{newabbreviation}\mgroup{atm}\mgroup{ATM}\mgroup{automated teller machine} + +\cs{begin}\mgroup{document} + +First use: \cs{gls}\mgroup{radar}, \cs{gls}\mgroup{laser}, \cs{gls}\mgroup{scuba}, \cs{gls}\mgroup{dsp}, +\cs{gls}\mgroup{atm}. + +Next use: \cs{gls}\mgroup{radar}, \cs{gls}\mgroup{laser}, \cs{gls}\mgroup{scuba}, \cs{gls}\mgroup{dsp}, +\cs{gls}\mgroup{atm}. + +\cs{printglossaries} +\cs{end}\mgroup{document} +\end{alltt} + +\exitem{-storage-abbr-desc} An extension of the previous example +where the user needs to provide a~description. + +\exitem{-chap-hyperfirst} This document illustrates how to add +a~custom key using \cs{glsaddstoragekey} and hook into the \glslike\ +and \glstextlike\ mechanism used to determine whether or not to +hyperlink an entry. +The document build is: +\begin{prompt} +pdflatex sample-chap-hyperfirst +makeglossaries sample-chap-hyperfirst +pdflatex sample-chap-hyperfirst +\end{prompt} +This example creates a storage key called \texttt{chapter} used to store the chapter +number. +\begin{alltt} +\ics{glsaddstoragekey}\mgroup{\strong{chapter}}\mgroup{0}\mgroup{\strong{\cs{glschapnum}}} +\end{alltt} +It's initialised to 0 and the \ics{glslinkpostsetkeys} hook is used +to check this value against the current chapter number. If the +values are the same then the hyperlink is switched off, otherwise +the key value is updated unless the hyperlink has been switched off +(through the optional argument of commands like \cs{gls} and \cs{glstext}). +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glslinkpostsetkeys}}\mgroup{\% + \cs{edef}\cs{currentchap}\mgroup{\cs{arabic}\mgroup{chapter}}\% + \cs{ifnum}\cs{currentchap}=\strong{\cs{glschapnum}}\mgroup{\cs{glslabel}}\cs{relax} + \cs{setkeys}\mgroup{glslink}\mgroup{hyper=false}\% + \cs{else} + \ics{glsifhyperon}\mgroup{\ics{glsfieldxdef}\mgroup{\cs{glslabel}}\mgroup{\strong{chapter}}\mgroup{\cs{currentchap}}}\mgroup{}\% + \cs{fi} +} +\end{alltt} +Since this key isn't intended for use when the entry is being +defined, it would be more appropriate to simply use an internal +field that doesn't have an associated key or helper command, but +\ics{glsfieldxdef} requires the existence of the field. The +\gls{glossaries-extra} package provides utility commands designed to +work on internal fields that don't have an associated key and may +not have had a value assigned. + +\glsxtrnote +If you want to switch to \gls{glossaries-extra} you need to change +the package loading line: +\begin{alltt} +\cs{usepackage}[\xtrfont{postdot}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The custom storage key (provided with \cs{glsaddstoragekey}) can be +removed, and the \ics{glslinkpostsetkeys} hook can be changed to: +\begin{alltt} +\cs{renewcommand}*\mgroup{\ics{glslinkpostsetkeys}}\mgroup{\% + \cs{edef}\cs{currentchap}\mgroup{\cs{arabic}\mgroup{chapter}}\% + \strong{\ics*{GlsXtrIfFieldEqNum}*}\mgroup{\strong{chapter}}\mgroup{\cs{glslabel}}\mgroup{\cs{currentchap}} + \mgroup{\% + \cs{setkeys}\mgroup{glslink}\mgroup{hyper=false}\% + }\% + \mgroup{% + \ics{glsifhyperon}\mgroup{\strong{\ics*{xGlsXtrSetField}}\mgroup{\cs{glslabel}}\mgroup{\strong{chapter}}\mgroup{\cs{currentchap}}}\mgroup{}\% + }% +} +\end{alltt} +The field name is still called \texttt{chapter} but there's no +longer an associated key or command. + +\section{Xindy (Option 3)} +\label{sec:samplesxindy} + +Most of the earlier \gls{makeindex} sample files can be adapted to +use \gls{xindy} instead by adding the \pkgopt{xindy} package option. +Situations that you need to be careful about are when the sort value +(obtained from the \gloskey{name} if the \gloskey{sort} key is +omitted) contains commands (such as \verb|name={\pi}|) or is identical +to another value (or is identical after \gls{xindy} has stripped all +commands and braces). This section describes sample documents that +use features which are unavailable with \gls{makeindex}. + +\exitem{xdy} The document uses UTF8 encoding (with the +\sty{inputenc} package). This is information that needs to be passed +to \gls{xindy}, so the encoding is picked up by \gls{makeglossaries} +from the \filetype{aux} file. + +By default, this document will create a \gls{xindy} style file called +\nolinkurl{samplexdy.xdy}, but if you uncomment the lines +\begin{verbatim} +\setStyleFile{samplexdy-mc} +\noist +\GlsSetXdyLanguage{} +\end{verbatim} +it will set the style file to \texttt{samplexdy-mc.xdy} instead. +This provides an additional letter group for entries starting with +\qt{Mc} or \qt{Mac}. If you use \gls{makeglossaries} or +\gls{makeglossaries-lite.lua}, you don't +need to supply any additional information. If you don't use +\gls*{makeglossaries}, you will need to specify the required +information. Note that if you set the style file to +\nolinkurl{samplexdy-mc.xdy} you must also specify \ics{noist}, +otherwise the \styfmt{glossaries} package will overwrite +\nolinkurl{samplexdy-mc.xdy} and you will lose the \qt{Mc} letter +group. + +To create the document do: +\begin{prompt} +pdflatex samplexdy +makeglossaries samplexdy +pdflatex samplexdy +\end{prompt} +If you don't have Perl installed then you can't use +\gls{makeglossaries}, but you also can't use \gls{xindy}! +However, if for some reason you want to call +\gls{xindy} explicitly instead of using \gls{makeglossaries} (or +\gls{makeglossaries-lite.lua}): +\begin{itemize} +\item if you are using the default style file \nolinkurl{samplexdy.xdy}, then +do (no line breaks): +\begin{prompt} +xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo +\end{prompt} +\item if you are using \nolinkurl{samplexdy-mc.xdy}, then do +(no line breaks): +\begin{prompt} +xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo +\end{prompt} +\end{itemize} + +This document creates a new command to use with the +\gloskey[glslink]{format} key in the optional argument of commands +like \cs{gls} to format the location in the \gls{numberlist}. +The usual type of definition when a hyperlinked location is required +should use one of the \csmeta{hyper}{xx}{} commands listed in +\tableref{tab:hyperxx}: +\begin{verbatim} +\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}} +\end{verbatim} +Unfortunately, this definition doesn't work for this particular +document and some adjustments are needed (see below). As a result of +the adjustments, this command doesn't actually get used by \TeX, +even though \texttt{hyperbfit} is used in the +\gloskey[glslink]{format} key. It does, however, need to be +identified as an attribute so that \gls{xindy} can recognise it: +\begin{verbatim} +\GlsAddXdyAttribute{hyperbfit} +\end{verbatim} +This will add information to the \filetype{xdy} file when it's +created by \cs{makeglossaries}. If you prevent the creation of this +file with \ics{noist} then you will need to add the attribute to +your custom \filetype{xdy} file (see the provided +\nolinkurl{samplexdy-mc.xdy} file). + +In order to illustrate unusual location formats, this sample +document provides a command called \cs{tallynum}\marg{n} that represents its +numerical argument with a die or dice where the dots add up to \meta{n}: +\begin{verbatim} +\newrobustcmd*{\tallynum}[1]{% + \ifnum\number#1<7 + $\csname dice\romannumeral#1\endcsname$% + \else + $\dicevi$% + \expandafter\tallynum\expandafter{\numexpr#1-6}% + \fi +} +\end{verbatim} +This command needs to be robust to prevent it from being expanded +when it's written to any of the auxiliary files. The \ics{dicei}, +\ldots, \cs{dicevi} commands are provided by the \sty{stix} +package, so that needs to be loaded. + +An associated command \cs{tally}\marg{counter} is defined that +formats the value of the named \meta{counter} according to +\cs{tallynum}: +\begin{verbatim} +\newcommand*{\tally}[1]{\tallynum{\arabic{#1}}} +\end{verbatim} +(This shouldn't be robust as it needs the counter value to expand.) +The page numbers are altered to use this format (by redefining \ics{thepage}). + +This custom location format also needs to be identified in the +\filetype{xdy} file so that \gls{xindy} can recognise it and +determine how to form ranges if required. +\begin{verbatim} +\GlsAddXdyLocation{tally}{% tally location format + :sep "\string\tallynum\space\glsopenbrace" + "arabic-numbers" + :sep "\glsclosebrace" +} +\end{verbatim} +Again this information is written to the \filetype{xdy} file by +\cs{makeglossaries} so if you use \cs{noist} then you need to +manually add it to your custom \filetype{xdy} file. + +When \gls{xindy} creates the associated glossary files, the +locations will be written using: +\begin{alltt} +\csmetameta{glsX}{counter}{X}{format}{}\marg{hyper-prefix}\marg{location} +\end{alltt} +In this case: +\begin{alltt} +\cs{glsXpageXglsnumberformat}\mgroup{}\mgroup{\cs{tallynum}\marg{number}} +\end{alltt} +or +\begin{alltt} +\cs{glsXpageXhyperbfit}\mgroup{}\mgroup{\cs{tallynum}\marg{number}} +\end{alltt} +This means that although \cs{hyperbf} is designed to create +hyperlinked locations, the presence of \cs{tallynum} interferes with +it. +In order to make the hyperlinks work correctly, the definitions of +\cs{glsXpageXhyperbfit} need to be redefined in order to grab the +number part in order to work out the location's numeric value. If +the value of \cs{tally} is changed so that it expands differently +then these modifications won't work. + +Remember that in both cases, the second argument \verb|#2| is in the +form \cs{tally}\marg{n}: +\begin{verbatim} +\renewcommand{\glsXpageXglsnumberformat}[2]{% + \linkpagenumber#2% +} +\renewcommand{\glsXpageXhyperbfit}[2]{% + \textbf{\em\linkpagenumber#2}% +} +\end{verbatim} +These need a command that can grab the actual number and correctly encapsulate +it: +\begin{verbatim} +\newcommand{\linkpagenumber}[2]{\hyperlink{page.#2}{#1{#2}}} +\end{verbatim} + +If you want to try out the \nolinkurl{samplexdy-mc.xdy} file, the +entries starting with \qt{Mac} or \qt{Mc} will be placed in their +own \qt{Mc} letter group. Ideally it should be possible to do this +simply with \ics{GlsAddLetterGroup} (and not require a custom +\filetype{xdy} file) but unfortunately the \qt{M} letter +group will have already been defined and take precedence over +\qt{Mc}, which is why a custom file is required and the normal +language module must be suppressed: +\begin{verbatim} +\setStyleFile{samplexdy-mc} +\noist +\GlsSetXdyLanguage{} +\end{verbatim} + +This \qt{Mc} group is suitable for names like +\qt{Maclaurin} but not for \qt{Mach}. To prevent this, the +\gloskey{sort} key for that value is set to lower case: +\begin{verbatim} +\newglossaryentry{mach}{name={Mach, Ernst}, +first={Ernst Mach},text={Mach}, +sort={mach, Ernst}, +description={Czech/Austrian physicist and philosopher}} +\end{verbatim} + +\bibglsnote +If you want to convert this document so that it uses \gls{bib2gls}, +you first need to switch to \gls{glossaries-extra} and use the +\pkgopt*{record} package option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +The \gls{xindy}-only commands can now all be removed +(attribute \cs{GlsAddXdyAttribute}, location \cs{GlsAddXdyLocation}, +language \cs{GlsSetXdyLanguage}, location encapsulators +\csmetameta{glsX}{counter}{X}{format}{} +and the custom helper \cs{linkpagenumber}). +Also \cs{noist} and \cs{setStyleFile} aren't relevant with +\gls{bib2gls} and so should be removed. + +The definitions of \cs{hyperbfit} should be retained (as well as +\cs{tallynum}, \cs{tally} and the redefinition of \cs{thepage}). + +The entries all need to be converted to the \filetype{bib} format +required by \gls{bib2gls}. +\begin{prompt} +convertgls2bib -{}-preamble-only samplexdy.tex entries.bib +\end{prompt} +Next replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +and remove all the entry definitions from the preamble. Use the +search and replace function on your text editor to replace all +instances of \ics{glsentryfirst} with \ics*{glsfmtfirst}, and all +instances of \ics{glsentryname} with \ics*{glsfmtname}. + +Finally, replace \ics{printglossaries} with \ics*{printunsrtglossaries}. +The document build is now: +\begin{prompt} +pdflatex samplexdy +bib2gls -{}-group samplexdy +pdflatex samplexdy +\end{prompt} + +This results in a slightly different ordering from the original +document (without the \qt{Mc} letter group). In the original +example, \qt{Mach number} was listed before \qt{Mach, Ernest}. The +modified document now has \qt{Mach, Ernest} before \qt{Mach number}. +This difference is due to \gls{bib2gls}['s] default +\resourceopt[word]{break-at} setting, which marks word boundaries +with the pipe (\texttt{|}) character, so the sort values for +\gls{bib2gls} are \texttt{Mach|Earnest|} and \texttt{Mach|number|}. +See the \gls{bib2gls} manual for further details of this option, and +also see the examples chapter of that manual for alternative +approaches when creating entries that contain people's names. + +If you want the \qt{Mc} letter group, it can be obtained by +providing a custom sort rule: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries, + \resourceopt{sort}=\strong{custom}, + \strong{\xtrfont{sort-rule}}=\mgroup{\ics*{glsxtrcontrolrules} + ;\ics*{glsxtrspacerules};\ics*{glsxtrnonprintablerules} + ;\ics*{glsxtrcombiningdiacriticrules},\ics*{glsxtrhyphenrules} + <\ics*{glsxtrgeneralpuncrules}<\ics*{glsxtrdigitrules} + <a,A<b,B<c,C<d,D<e,E<f,F<g,G<h,H<i,I<j,J<k,K<l,L\strong{<Mc=Mac}<m,M<o,O + <p,P<q,Q<r,R<s,S<t,T<u,U<v,V<r,R<s,S<t,T<u,U<v,V<w,W<x,X<y,Y<z,Z + } +] +\end{alltt} +Unfortunately, as with \gls{xindy}, this puts \qt{Mach} into the +\qt{Mc} letter group. + +One way to get around this problem is to define a custom command to +help identify genuine \qt{Mc}/\qt{Mac} prefixes with names that +happen to start with \qt{Mac}. For example: +\begin{alltt} +\atentry{entry}\mgroup{mcadam, + name = \mgroup{\strong{\cs{Mac}\mgroup{Mc}}Adam, John Loudon}, + description = \mgroup{Scottish engineer}, + text = \mgroup{McAdam}, + first = \mgroup{John Loudon McAdam} +} + +\atentry{entry}\mgroup{maclaurin, + name = \mgroup{\strong{\cs{Mac}\mgroup{Mac}}laurin, Colin}, + description =\mgroup{Scottish mathematician best known for the +\cs{gls}\mgroup{maclaurinseries}}, + text = \mgroup{Maclaurin}, + first = \mgroup{Colin Maclaurin} +} +\end{alltt} +but not for \qt{Mach}: +\begin{alltt} +\atentry{entry}\mgroup{mach, + name = \mgroup{Mach, Ernst}, + description = \mgroup{Czech/Austrian physicist and philosopher}, + text = \mgroup{Mach}, + first = \mgroup{Ernst Mach} +} +\end{alltt} +With \LaTeX, this command should simply do its argument: +\begin{verbatim} +\newcommand{\Mac}[1]{#1} +\end{verbatim} +However, when \gls{bib2gls} works out the \gloskey{sort} value, it +needs to be defined with something unique that won't happen to occur +at the start of another term. For example: +\begin{verbatim} +\providecommand{\Mac}[1]{MC} +\end{verbatim} +(Remember that \resourceopt[word]{break-at} will strip spaces +and punctuation so don't include them unless you switch to +\resourceopt[none]{break-at}.) + +So add the first definition of \cs{Mac} to the \filetype{tex} file and modify +\nolinkurl{entries.bib} so that it includes the second definition: +\begin{alltt} +\atentry{preamble}\mgroup{"\cs{providecommand}\mgroup{\cs{Mac}}[1]\mgroup{MC}"} +\end{alltt} +Then modify the \qt{Mc}/\qt{Mac} entries as appropriate (see the +above \qt{McAdam} and \qt{Maclaurin} examples). + +The custom sort rule needs to be modified: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries, + \strong{\xtrfont{write-preamble}=false,} + \resourceopt{sort}=custom, + \resourceopt{sort-rule}=\mgroup{\ics*{glsxtrcontrolrules} + ;\ics*{glsxtrspacerules};\ics*{glsxtrnonprintablerules} + ;\ics*{glsxtrcombiningdiacriticrules},\ics*{glsxtrhyphenrules} + <\ics*{glsxtrgeneralpuncrules}<\ics*{glsxtrdigitrules} + <a,A<b,B<c,C<d,D<e,E<f,F<g,G<h,H<i,I<j,J<k,K<l,L\strong{<MC}<m,M<o,O + <p,P<q,Q<r,R<s,S<t,T<u,U<v,V<r,R<s,S<t,T<u,U<v,V<w,W<x,X<y,Y<z,Z + } +] +\end{alltt} +This will create a \qt{Mc} letter group that only includes the names +that start with the custom \cs{Mac} command. + +Other alternatives include moving \atentry{preamble} into a separate +\filetype{bib} file, so that you can choose whether or not to +include it. See the \qt{Examples} chapter of the \gls{bib2gls} user +manual for further examples. + +\exitem{xdy2} This document illustrates +how to use the \styfmt{glossaries} package where the location +numbers don't follow a standard format. This example will only work +with \gls{xindy}. To create the document do: +\begin{prompt} +pdflatex samplexdy2 +makeglossaries samplexdy2 +pdflatex samplexdy2 +\end{prompt} +The explicit \gls{xindy} call is: +\begin{prompt} +xindy -L english -C utf8 -I xindy -M samplexdy2 -t samplexdy2.glg -o samplexdy2.gls samplexdy2.glo +\end{prompt} +This example uses the \texttt{section} counter with \gls{xindy}: +\begin{verbatim} +\usepackage[xindy,counter=section]{glossaries} +\end{verbatim} +The document employs an eccentric section numbering system for +illustrative purposes. The section numbers are prefixed by the +chapter number in square brackets: +\begin{verbatim} +\renewcommand*{\thesection}{[\thechapter]\arabic{section}} +\end{verbatim} +Parts use Roman numerals: +\begin{verbatim} +\renewcommand*{\thepart}{\Roman{part}} +\end{verbatim} +The section hyperlink name includes the part: +\begin{verbatim} +\renewcommand*{\theHsection}{\thepart.\thesection} +\end{verbatim} +This custom numbering scheme needs to be identified in the +\filetype{xdy} file: +\begin{verbatim} +\GlsAddXdyLocation["roman-numbers-uppercase"]{section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} +\end{verbatim} +If the part is 0 then \cs{thepart} will be empty (there isn't a zero +Roman numeral). An extra case is needed to catch this: +\begin{verbatim} +\GlsAddXdyLocation{zero.section}{:sep "[" + "arabic-numbers" :sep "]" "arabic-numbers" +} +\end{verbatim} +Note that this will stop xindy giving a warning, but the location +hyperlinks will be invalid if no \cs{part} is used. + +\bibglsnote +If you want to switch to \gls{bib2gls}, you first need to switch to +\gls{glossaries-extra} but remember to use \pkgopt*{record} instead +of \pkgopt{xindy}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},counter=section]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Next remove the \cs{GlsAddXdyLocation} commands and convert the +entry definitions to the \filetype{bib} format required by +\gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-preamble-only samplexdy2.tex entries.bib +\end{prompt} +Now replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +and remove the \cs{newglossaryentry} commands. +Finally, replace \cs{printglossaries} with \ics*{printunsrtglossaries}. + +The document build is: +\begin{prompt} +pdflatex samplexdy2 +bib2gls samplexdy2 +pdflatex samplexdy2 +\end{prompt} + +With unusual numbering systems, it's sometimes better to use \pkgopt+{nameref}{record}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}=nameref},counter=section]\mgroup{\strong{glossaries-extra}} +\end{alltt} +In this case, the locations will be the actual section headings, +rather than the section number. In order to make the number appear +instead you need to define: +\begin{alltt} +\cs{newcommand}*\mgroup{\ics*{glsxtrsectionlocfmt}}[2]\mgroup{\#1} +\end{alltt} +(Make sure you have at least v1.42 of \gls{glossaries-extra}.) See +also the earlier \samplefile{Sec}. + +\exitem{xdy3} This document is very similar to +\samplefile{xdy} but uses the command \cs{Numberstring} from the +\sty{fmtcount} package to format the page numbers instead of the +\cs{tally} command from the earlier example. + +\exitem{utf8} This is another example +that uses \gls{xindy}. Unlike \gls{makeindex}, +\gls{xindy} can cope with \glspl{nonlatinchar}. This +document uses UTF-8 encoding. To create the document do: +\begin{prompt} +pdflatex sampleutf8 +makeglossaries sampleutf8 +pdflatex sampleutf8 +\end{prompt} +The explicit \gls{xindy} call is +(no line breaks): +\begin{prompt}\raggedright +xindy -L english -C utf8 -I xindy -M sampleutf8 -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +\end{prompt} + +If you remove the \pkgopt{xindy} option from \texttt{sampleutf8.tex} +and do: +\begin{prompt} +pdflatex sampleutf8 +makeglossaries sampleutf8 +pdflatex sampleutf8 +\end{prompt} +or +\begin{prompt} +pdflatex sampleutf8 +makeglossaries-lite sampleutf8 +pdflatex sampleutf8 +\end{prompt} +you will see that the entries that start with an \gls{exlatinchar} +now appear in the symbols group, and the word \qt{man\oe uvre} is now +after \qt{manor} instead of before it. If you want to explicitly +call \gls{makeindex} (no line breaks): +\begin{prompt} +makeindex -s sampleutf8.ist -t sampleutf8.glg -o sampleutf8.gls sampleutf8.glo +\end{prompt} + +\bibglsnote +If you want to switch to \gls{bib2gls}, you first need to switch to +\gls{glossaries-extra} but replace \pkgopt{xindy} with +\pkgopt*{record}: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{postdot},\xtrfont{stylemods},style=listgroup]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Note that you don't need the \pkgopt{nonumberlist} option with +\gls{bib2gls}. You can instruct \gls{bib2gls} to simply not save the +\glspl{numberlist}, but in this case there won't be any locations as +there's no actual indexing. + +The entries need to be converted to the \filetype{bib} format +required by \gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-preamble-only -{}-texenc UTF-8 -{}-bibenc UTF-8 sampleutf8.tex entries.bib +\end{prompt} +Note the first line of the \nolinkurl{entries.bib} file: +\begin{alltt} +\% Encoding: UTF-8 +\end{alltt} +This is the encoding of the \filetype{bib} file. It doesn't have to +match the encoding of the \filetype{tex} file, but it's generally +better to be consistent. When \gls{bib2gls} parses this file, it +will look for this encoding line. +(If the \texttt{-{}-texenc} and \texttt{-{}-bibenc} switches aren't +used, \gls{convertgls2bib} will assume your system's default +encoding. See the \gls{bib2gls} manual for further details.) + +Next replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\resourceopt{selection}=\strong{all}] +\end{alltt} +and remove all the \cs{newglossaryentry} commands. + +Iterative commands like \ics{glsaddall} don't work with +\gls{bib2gls}. Instead, you can select all entries using the +\resourceopt[all]{selection} option. +This is actually better than \cs{glsaddall}, which enforces +the selection of all entries by indexing each entry. As a result, +with \gls{makeindex} and \gls{xindy} (and \opt1), every entry will +have the same location (which is the location of the \cs{glsaddall} +command, in this case page~1). With \resourceopt[all]{selection}, +\gls{bib2gls} will automatically selection all entries even if they +don't have any records (indexing information) so in this case there +are no \glspl{numberlist}. + +Finally, replace \cs{printglossaries} with +\ics*{printunsrtglossaries}. The build process is now: +\begin{prompt} +pdflatex sampleutf8 +bib2gls -{}-group sampleutf8 +pdflatex sampleutf8 +\end{prompt} +\gls{bib2gls} picks up the encoding of the \filetype{tex} file from +the \filetype{aux} file: +\begin{alltt} +\ics*{glsxtr@texencoding}\mgroup{utf8} +\end{alltt} +If you experience any encoding issues, check the \filetype{aux} file for +this command and check the \filetype{bib} file for the encoding +comment line. Also check \gls{bib2gls}['s] \filetype{glg} transcript file +for encoding messages, which should look like: +\begin{verbatim} +TeX character encoding: UTF-8 +\end{verbatim} + +The document language, if it has been set, is also added to the \filetype{aux} file when +the \pkgopt{record} option is used. In this case, no language +package has been used, so \gls{bib2gls} will fallback on the system's default +locale. If no sort method is set, the entries will be sorted +according to the document language, if set, or the default locale. +You can specify a specific locale using the \resourceopt{sort} key +with a locale tag identifier. For example: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\resourceopt{selection}=\strong{all},\strong{\xtrfont{sort}=de-CH-1996}] +\end{alltt} +(Swiss German new orthography) or: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\resourceopt{selection}=\strong{all},\strong{\xtrfont{sort}=is}] +\end{alltt} +(Icelandic). + +\section{No Indexing Application (Option 1)} +\label{sec:samplesnoidx} + +\exitem{-noidxapp} This document illustrates how to use the +\styfmt{glossaries} package without an external \gls{indexingapp} (\opt1). +To create the complete document, you need to do: +\begin{prompt} +pdflatex sample-noidxapp +pdflatex sample-noidxapp +\end{prompt} +Note the need to group the accent command that occurs at the start +of the \gloskey{name}: +\begin{alltt} +\cs{newglossaryentry}\mgroup{elite}\mgroup{\% + name=\mgroup{\strong{\mgroup{\ics{'}e}}lite}, + description=\mgroup{select group of people} +} +\end{alltt} +This is necessary to allow the term to work with \ics{Gls}. +Notice also how the \glspl{numberlist} can't be compacted into +ranges. For example, the list \qt{1, 2, 3} would be converted to +\qt{1--3} with a proper indexing application (\optsor23 or, with +\gls{glossaries-extra}, \opt4). + +The larger the list of entries, the longer the document build time. +This method is very inefficient for large glossaries. See +\gallery{glossaries-performance.shtml}{Gallery: glossaries performance} for a comparison. + +\exitem{-noidxapp-utf8} As the previous example, except that it uses +the \sty{inputenc} package. +To create the complete document, you need to do: +\begin{prompt} +pdflatex sample-noidxapp-utf8 +pdflatex sample-noidxapp-utf8 +\end{prompt} +This method is unsuitable for sorting languages with +\glspl{exlatinalph} or \glspl{nonlatinalph}. Use \optsor34 instead. + +\section{Other} +\label{sec:samplesother} + +\exitem{4col} This document illustrates +a four column glossary where the entries have a symbol in addition +to the name and description. To create the complete document, you +need to do: +\begin{prompt} +pdflatex sample4col +makeglossaries sample4col +pdflatex sample4col +\end{prompt} +or +\begin{prompt} +pdflatex sample4col +makeglossaries-lite sample4col +pdflatex sample4col +\end{prompt} +The vertical gap between entries is the +gap created at the start of each group. This can be suppressed +using the \pkgopt{nogroupskip} package option. (If you switch to +\gls{bib2gls}, simply omit the \texttt{-{}-group} command line option.) + +This example uses the \glostyle{long4colheaderborder}. This style +doesn't allow multi-line descriptions. You may prefer to use +\glostyle{altlong4colheaderborder} with long descriptions. However, +in either case a style that uses \sty{booktabs} is preferable. For +example, \glostyle{long4col-booktabs} or +\glostyle{altlongragged4col-booktabs}. Note that this requires +\sty{glossary-longbooktabs}, which needs to be explicitly loaded. +The style can only be set once this package has been loaded: +\begin{alltt} +\cs{usepackage}\mgroup{glossaries} +\cs{usepackage}\mgroup{glossary-longbooktabs} +\cs{setglossarystyle}\mgroup{altlongragged4col-booktabs} +\end{alltt} + +\glsxtrnote +The \gls{glossaries-extra} package provides a more compact way of +doing this with the \pkgopt*{stylemods} option: +\begin{alltt} +\cs{usepackage}[style=altlongragged4col-booktabs,\xtrfont{stylemods}=\strong{longbooktabs}] +\mgroup{\strong{glossaries-extra}} +\end{alltt} +The \gls{glossaries-extra} package provides additional styles, +including more \qt{long} styles with the \sty*{glossary-longextra} +package. For example, the \xtrglostyle{long-name-desc-sym-loc} +style: +\begin{alltt} +\cs{usepackage}[style=\strong{\xtrfont{long-name-desc-sym-loc}},\xtrfont{stylemods}=\strong{longextra}] +\mgroup{glossaries-extra} +\end{alltt} +If you use the \pkgopt*{stylemods} option with an argument, you may +prefer to use it with \pkgopt{nostyles} to prevent unwanted styles +from being automatically loaded. For example: +\begin{alltt} +\cs{usepackage}[style=\xtrfont{long-name-desc-sym-loc},\strong{\xtrfont{nostyles},}\xtrfont{stylemods}=longextra] +\mgroup{glossaries-extra} +\end{alltt} +See also the +\gallery{glossaries-styles/}{gallery of predefined styles}. + +\exitem{-numberlist} This document illustrates how to reference the +\gls{numberlist} in the document text. This requires an additional +\LaTeX\ run: +\begin{prompt} +pdflatex sample-numberlist +makeglossaries sample-numberlist +pdflatex sample-numberlist +pdflatex sample-numberlist +\end{prompt} +This uses the \pkgopt{savenumberlist} package option, which enables +\ics{glsentrynumberlist} and \ics{glsdisplaynumberlist} +(with limitations). The location counter is set to +\texttt{chapter}, so the \gls{numberlist} refers to the chapter +numbers. +\begin{verbatim} +\usepackage[savenumberlist,counter=chapter]{glossaries} +\end{verbatim} +The \gls{numberlist} can't be obtained until \gls{makeindex} (or +\gls{xindy}) has created the glossary file. The \gls{numberlist} is +picked up when this file is input by \cs{printglossary} and is then +saved in the \filetype{aux} file so that it's available on the next +\LaTeX\ run. + +This document contains both commands: +\begin{alltt} +This is a \cs{gls}\mgroup{sample} document. \cs{Glspl}\mgroup{sample} +are discussed in chapters~\strong{\ics{glsdisplaynumberlist}}\mgroup{sample} +(or \strong{\ics{glsentrynumberlist}}\mgroup{sample}). +\end{alltt} +Without \sty{hyperref}, the first list shows as \qt{1--3, 5 \& 6} +and the second list shows as \qt{1--3, 5, 6}. + +Note that you can't use \ics{glsdisplaynumberlist} with +\sty{hyperref} and \optsor23. If you do, you will get the warning: +\begin{verbatim} +Package glossaries Warning: \glsdisplaynumberlist doesn't work with +hyperref. +Using \glsentrynumberlist instead +\end{verbatim} +Now both lists show as \qt{1--3, 5, 6}. + +If you switch to \opt1 (replace \cs{makeglossaries} with +\cs{makenoidxglossaries} and replace \cs{printglossaries} with +\cs{printnoidxglossaries}), then the document build is simply: +\begin{prompt} +pdflatex sample-numberlist +pdflatex sample-numberlist +\end{prompt} +Now \ics{glsdisplaynumberlist} works with \sty{hyperref}, +however there are no ranges, so the first list shows as \qt{1, +2, 3, 5, \& 6} and the second list shows as \qt{1, 2, 3, 4, 5, 6}. + +\bibglsnote +If you want to switch to \gls{bib2gls}, you first need to switch to +\gls{glossaries-extra} (at least v1.42) but remember to include the \pkgopt{record} +option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},counter=chapter]\mgroup{\strong{glossaries-extra}} +\end{alltt} +Note that the \pkgopt{savenumberlist} option is no longer required. +Next convert the entry to the \filetype{bib} format required by +\gls{bib2gls}: +\begin{prompt} +convertgls2bib sample-numberlist.tex entries.bib +\end{prompt} +Replace \cs{makeglossaries} with: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries.bib] +\end{alltt} +and remove the \cs{newglossaryentry} command from the document +preamble. Finally, replace \cs{printglossaries} with +\ics*{printunsrtglossaries}. The build process is now: +\begin{prompt} +pdflatex sample-numberlist +bib2gls sample-numberlist +pdflatex sample-numberlist +\end{prompt} +Now both ranges and hyperlinks work. The first list shows \qt{1--3, +5, \& 6} and the second list shows \qt{1--3, 5, 6}. You can also +use: +\begin{alltt} +\ics*{glsxtrfieldformatlist}\mgroup{sample}\mgroup{loclist} +\end{alltt} +which will show the complete list without ranges \qt{1, 2, 3, 5 \& +6}. + +This method works much better than using the \pkgopt{savenumberlist} +option because \gls{bib2gls} saves the formatted \gls{numberlist} in the +\xtrfield{location} field (which is an internal field provided by +\gls{glossaries-extra} for the benefit of \gls{bib2gls}) and the +unformatted \gls{numberlist} in the \field{loclist} internal field (which is +also used by \opt1). + +With \optsand23, both \gls{makeindex} and \gls{xindy} simply create a +file containing the commands to typeset the glossary, which is input +by \cs{printglossary}. This means that it's quite hard to gather +information obtained by the \gls{indexingapp}. + +\gls{bib2gls}, on the other hand, doesn't write a file containing +the glossary. It writes a file containing the entry definitions and +uses internal fields to save the indexing information. The glossary is +then displayed with \ics*{printunsrtglossary}, which simply iterates +over all defined entries and fetches the required information from +those internal fields. + +The \ics{glsdisplaynumberlist} and \ics{glsentrynumberlist} commands +are redefined by \sty{glossaries-extra-bib2gls} to simply access the +\xtrfield{location} field. +However, if you want a complete list without ranges you can use: +\begin{alltt} +\ics*{glsxtrfieldformatlist}\mgroup{sample}\mgroup{loclist} +\end{alltt} +In this example, this produces \qt{1, 2, 3, 5 \& 6}. + +Note the difference if you use the \pkgopt+{nameref}{record} package +option instead of just \pkgopt*{record}. + +\exitem{-nomathhyper} This document illustrates how to selectively +enable and disable entry hyperlinks in \ics{glsentryfmt}. The +document build is: +\begin{prompt} +pdflatex sample-nomathhyper +makeglossaries sample-nomathhyper +pdflatex sample-nomathhyper +\end{prompt} +This disables the hyperlinks for the main glossary with: +\begin{alltt} +\ics{GlsDeclareNoHyperList}\mgroup{main} +\end{alltt} +and then redefines \cs{glsentryfmt} so that it adds a hyperlink if +not in maths mode and the hyperlinks haven't been forced off (with +the \texttt{\gloskey[glslink]{hyper}\dequals false} key). + +\glsxtrnote +If you want to switch to \gls{glossaries-extra}, then you can +instead use the hook that comes before the keys are set. The +preamble is much simpler: +\begin{alltt} +\cs{usepackage}\mgroup{\strong{glossaries-extra}} + +\cs{makeglossaries} + +\cs{renewcommand}\mgroup{\strong{\ics*{glslinkpresetkeys}}}\mgroup{\% + \cs{ifmmode} \cs{setkeys}\mgroup{glslink}\mgroup{hyper=false}\cs{fi} +} + +\% entry definition +\end{alltt} + +\exitem{-entryfmt} This document illustrates how to change the +way an entry is displayed in the text. (This is just a test +document. For a real document, I recommend you use the \sty{siunitx} +package to typeset units.) The document build is: +\begin{prompt} +pdflatex sample-entryfmt +makeglossaries sample-entryfmt +pdflatex sample-entryfmt +\end{prompt} +This redefines \ics{glsentryfmt} to add the symbol on +\gls{firstuse}: +\begin{alltt} +\cs{renewcommand}*\mgroup{\cs{glsentryfmt}}\mgroup{\% + \ics{glsgenentryfmt} + \ics{ifglsused}\mgroup{\cs{glslabel}}\mgroup{}\mgroup{\cs{space} (\strong{\ics{glsentrysymbol}}\mgroup{\cs{glslabel}})}\% +} +\end{alltt} +Note the use of \cs{glsentrysymbol} \emph{not} \cs{glssymbol} (which +would result in nested \gls{linktext}). + +\glsxtrnote +If you want to switch to the \gls{glossaries-extra} package, you can +make use of the category post-link hook instead: +\begin{alltt} +\cs{usepackage}[\xtrfont{stylemods},style=tree]\mgroup{\strong{glossaries-extra}} + +\cs{makeglossaries} + +\ics*{glsdefpostlink}\mgroup{\strong{unit}}\mgroup{\ics*{glsxtrpostlinkAddSymbolOnFirstUse}} + +\cs{newglossaryentry}\mgroup{distance}\mgroup{ +\xtrfont{category}=\mgroup{\strong{unit}}, +name=distance, +description=\mgroup{The length between two points}, +symbol=\mgroup{km}} +\end{alltt} +Note that in this case the symbol is now outside of the hyperlink. + +\exitem{-prefix} This document illustrates the use of the +\sty{glossaries-prefix} package. An additional run is required to +ensure the table of contents is up-to-date: +\begin{prompt} +pdflatex sample-prefix +makeglossaries sample-prefix +pdflatex sample-prefix +pdflatex sample-prefix +\end{prompt} +Remember that the default separator between the prefix and \cs{gls} +(or one of its variants) is empty, so if a space is required it must +be inserted at the end of the prefix. However, the \sty{xkeyval} +package (which is used to parse the \meta{key}\dequals\meta{value} +lists) trims leading and trailing space from the values, so an +ordinary space character will be lost. +\begin{alltt} +\cs{newglossaryentry}\mgroup{sample}\mgroup{name=\mgroup{sample}, + description=\mgroup{an example}, + prefix=\mgroup{a\strong{~}}, + prefixplural=\mgroup{the\strong{\cs{space}}}% +} + +\cs{newglossaryentry}\mgroup{oeil}\mgroup{name=\mgroup{oeil}, + plural=\mgroup{yeux}, + description=\mgroup{eye}, + prefix=\mgroup{l'}, + prefixplural=\mgroup{les\strong{\cs{space}}}} +\end{alltt} + +\glsxtrnote +If you want to convert this example to use \gls{glossaries-extra}, +then (as from v1.42) you can use the \pkgopt*{prefix} option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{prefix}},\xtrfont{postdot},acronym]\mgroup{\strong{glossaries-extra}} +\end{alltt} +(Alternatively load \sty{glossaries-prefix} after +\gls{glossaries-extra}.) The rest of the document is the same as for +the base \styfmt{glossaries} package, unless you want to switch to +using \gls{bib2gls}. + +\bibglsnote +If you want to switch to \gls{bib2gls}, first switch to +\gls{glossaries-extra} (as above) but make sure you include the +\pkgopt*{record} package option: +\begin{alltt} +\cs{usepackage}[\strong{\xtrfont{record}},\xtrfont{prefix},\xtrfont{postdot},acronym]\mgroup{glossaries-extra} +\end{alltt} +Next convert the entries into the \filetype{bib} format required by +\gls{bib2gls}: +\begin{prompt} +convertgls2bib -{}-preamble-only sample-prefix.tex entries.bib +\end{prompt} +Replace \cs{makeglossaries} with +\begin{alltt} +\ics*{setabbreviationstyle}[acronym]\mgroup{long-short} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries] +\end{alltt} +remove the entry definitions from the preamble, and replace +\begin{alltt} +\cs{printglossary}[style=plist] +\cs{printacronyms} +\end{alltt} +with +\begin{alltt} +\ics*{printunsrtglossary}[style=plist] +\ics*{printunsrtacronyms} +\end{alltt} +The document build is now: +\begin{prompt} +pdflatex sample-prefix +bib2gls sample-prefix +pdflatex sample-prefix +\end{prompt} + +With \gls{bib2gls} v2.0+, you don't need to manually insert the spaces at +the end of the prefixes. Instead you can instruct \gls{bib2gls} to +insert them. To try this out, remove the trailing \verb|~| and +\cs{space} from the \nolinkurl{entries.bib} file: +\begin{alltt} +\atentry{entry}\mgroup{sample, + prefix = \mgroup{a}, + name = \mgroup{sample}, + description = \mgroup{an example}, + prefixplural = \mgroup{the} +} + +\atentry{entry}\mgroup{oeil, + plural = \mgroup{yeux}, + prefix = \mgroup{l'}, + name = \mgroup{oeil}, + description = \mgroup{eye}, + prefixplural = \mgroup{les} +} + +\atentry{acronym}\mgroup{svm, + prefixfirst = \mgroup{a}, + prefix = \mgroup{an}, + short = \mgroup{SVM}, + long = \mgroup{support vector machine} +} +\end{alltt} +Now add the \resourceopt[\mgroup{space or nbsp}]{append-prefix-field} +resource option: +\begin{alltt} +\ics*{GlsXtrLoadResources}[\resourceopt{src}=entries,\strong{\xtrfont{append-prefix-field}=\mgroup{space or nbsp}}] +\end{alltt} +See the \gls{bib2gls} manual for further details. + +\exitem{accsupp} This document uses the \sty{glossaries-accsupp} package +(see \sectionref{sec:accsupp}). That package automatically loads +\styfmt{glossaries} and passes all options to the base package. So +you can load both packages at once with just: +\begin{verbatim} +\usepackage[acronym]{glossaries-accsupp} +\end{verbatim} +This provides additional keys that aren't available with just the +base package, which may be used to provide replacement text. The +replacement text is inserted using \sty{accsupp}'s +\ics{BeginAccSupp} and \ics{EndAccSupp} commands. See the +\sty{accsupp} package for further details of those commands. + +Note that this example document is provided to demonstrate +\sty{glossaries-accsupp} as succinctly as possible. The resulting +document isn't fully accessible as it's not tagged. See the +\sty{accessibility} and \sty{tagpdf} packages for further +information about tagging documents. + +It's not essential to use \sty{glossaries-accsupp}. You can simply insert the replacement +text directly into the field values. For example: +\begin{verbatim} +\newglossaryentry{Drive}{ + name={\BeginAccSupp{Actual=Drive}Dr.\EndAccSupp{}}, + description={Drive} +} +\newglossaryentry{image}{name={sample image}, + description={an example image}, + user1={\protect\BeginAccSupp{Alt={a boilerplate image used in + examples}}\protect\includegraphics + [height=20pt]{example-image}\protect\EndAccSupp{}} +} +\end{verbatim} +However, this can cause interference (especially with +case-changing). With \sty{glossaries-accsupp} it's possible to +obtain the field values without the accessibility information if +required. (If in the future \cs{includegraphics} is given extra +options to provide replacement text then the image example here +won't be necessary. However, the example can be adapted for images +created with \TeX\ code.) + +The acronym style is set using: +\begin{verbatim} +\setacronymstyle{long-short} +\end{verbatim} +The first abbreviation is straightforward: +\begin{verbatim} +\newacronym{eg}{e.g.}{for example} +\end{verbatim} +The \gloskey{shortaccess} replacement text is automatically set to +the long form. The next abbreviation is awkward as the long form contains +formatting commands which can't be included in the replacement text. +This means that the \gloskey{shortaccess} key must be supplied: +\begin{alltt} +\cs{newacronym}[\strong{shortaccess}=\mgroup{TiKZ ist kein Zeichenprogramm}] +\mgroup{tikz}\mgroup{Ti\cs{emph}\mgroup{k}Z}\mgroup{Ti\cs{emph}\mgroup{k}Z ist \cs{emph}\mgroup{kein} Zeichenprogramm} +\end{alltt} +In the above two cases, the short form obtained in \cs{gls} will use +the \qt{E} PDF element. + +By way of comparison, there are some entries that are technically +abbreviations but are defined using \ics{newglossaryentry} instead +of \ics{newacronym}. The replacement text is provided in the +\gloskey{access} key: +\begin{alltt} +\cs{newglossaryentry}\mgroup{Doctor}\mgroup{name=Dr,description=\mgroup{Doctor},\strong{access}=\mgroup{Doctor}} +\cs{newglossaryentry}\mgroup{Drive}\mgroup{name=\mgroup{Dr.},plural=\mgroup{Drvs},description=\mgroup{Drive}, + \strong{access}=\mgroup{Drive}} +\end{alltt} +These will use PDF's \qt{ActualText} element (not \qt{E}). + +The next entry is a symbol (the integration symbol $\int$). This +could be defined simply as: +\begin{verbatim} +\newglossaryentry{int}{name={int},description={integral}, + symbol={\ensuremath{\int}}} +\end{verbatim} +and then referenced in the text like this: +\begin{verbatim} +Symbol: \gls{int} (\glssymbol{int}). +\end{verbatim} +This results in the text \qt{Symbol: integral ($\int$).} However if you +copy and paste this from the PDF you will find the resulting text is +\qt{Symbol: int (R).} This is what's actually read out by the +text-to-speech system. + +It would be better if the actual text was the Unicode character +0x222B. This would not only assist the text-to-speech system but +also make it easier to copy and paste the text. The simplest method +is to identify the character by its hexadecimal code, but in order +to do this the \ics{BeginAccSupp} command needs to have the options adjusted. + +In order to determine whether to use \qt{E}, \qt{ActualText} or +\qt{Alt} for a particular field, \sty{glossaries-accsupp} will check +if the command \csmeta{gls}{field}{accsupp} exists (where +\meta{field} is the internal field label, see \tableref{tab:fieldmap}). Only two of +these commands are predefined: \ics{glsshortaccsupp} and +\ics{glsshortplaccsupp}, which is why the \gloskey{shortaccess} +field uses \qt{E}. If the given command doesn't exist then the +generic \ics{glsaccsupp} command is used instead. + +This means that in order to simply set \gloskey{symbolaccess} to the +hexadecimal character code, I need to provide a command called +\ics{glssymbolaccsupp}: +\begin{alltt} +\cs{newcommand}\mgroup{\cs{gls\strong{symbol}accsupp}}[2]\mgroup{\% + \ics{glsaccessibility}[\strong{method=hex,unicode}]\mgroup{\strong{ActualText}}\mgroup{\#1}\mgroup{\#2}\% +} +\end{alltt} +Now I can adjust the definition of the \texttt{int} entry: +\begin{alltt} +\cs{newglossaryentry}\mgroup{int}\mgroup{name=\mgroup{int},description=\mgroup{integral}, + symbol=\mgroup{\cs{ensuremath}\mgroup{\cs{int}}},\strong{symbolaccess=\mgroup{222B}} +} +\end{alltt} + +The final entry has an image stored in the \gloskey{user1} key. (The +image file is provided with the \sty{mwe} package.) This should use +\qt{Alt} instead of \qt{ActualText} so I need to define +\ics{glsuseriaccsupp}: +\begin{alltt} +\cs{newcommand}\mgroup{\cs{gls\strong{useri}accsupp}}[2]\mgroup{\% + \ics{glsaccessibility}\mgroup{\strong{Alt}}\mgroup{\#1}\mgroup{\#2}\% +} +\end{alltt} +The image description is provided in the \gloskey{user1access} key: +\begin{alltt} +\cs{newglossaryentry}\mgroup{sampleimage}\mgroup{name=\mgroup{sample image}, + description=\mgroup{an example image}, + user1=\mgroup{\cs{protect}\ics{includegraphics}[height=20pt]\mgroup{example-image}}, + \strong{user1access}=\mgroup{a boilerplate image used in examples} +} +\end{alltt} +(Note the need to protect the fragile \ics{includegraphics}. The alternative is +to use \cs{glsnoexpandfields} before defining the command. See +\sectionref{sec:expansion}.) + +If you try this example and inspect the PDF\footnote{You can either +uncompress the PDF file and view it in a text editor or you can use +a tool such as the PDFDebugger provided with +\href{https://pdfbox.apache.org/}{PDFBox}.}\ then you will find +content like: +\begin{verbatim} +/Span << /ActualText (Doctor) >> BDC + BT + /F8 9.9626 Tf + 73.102 697.123 Td + [ (Dr) ] TJ + ET +EMC +\end{verbatim} +This shows that \qt{ActualText} was used for \verb|\gls{Doctor}|. +The integral symbol ($\int$) created with \verb|\glssymbol{int}| is: +\begin{verbatim} +/Span << /ActualText (\376\377"+) >> BDC + BT + /F1 9.9626 Tf + 97.732 650.382 Td + [ (R) ] TJ + ET +EMC +\end{verbatim} +Again, \qt{ActualText} has been used, but the character code has +been supplied. The image created with \verb|\glsuseri{sampleimage}| is: +\begin{verbatim} +/Span << /Alt (a boilerplate image used in examples) >> BDC + 1 0 0 1 106.588 618.391 cm + q + 0.08301 0 0 0.08301 0 0 cm + q + 1 0 0 1 0 0 cm + /Im1 Do + Q + Q +EMC +\end{verbatim} +This shows that \qt{Alt} has been used. + +The first use of \verb|\gls{eg}| produces the long form (not +reproduced here) followed by the short form: +\begin{verbatim} +/Span << /E (for example) >> BDC + BT + /F8 9.9626 Tf + 161.687 563.624 Td + [ (e.g.) ] TJ + ET +EMC +\end{verbatim} +The subsequent use also has the \qt{E} element: +\begin{verbatim} +/Span << /E (for example) >> BDC + BT + /F8 9.9626 Tf + 118.543 551.669 Td + [ (e.g.) ] TJ + ET +EMC +\end{verbatim} +Similarly for \verb|\acrshort{eg}|. You can also use the +\pkgopt[showaccsupp]{debug} package option. This will show the +replacement text in the document, but note that this is the content before +it's processed by \cs{BeginAccSupp}. + +If the \ics{setacronymstyle} command is removed (or commented out) +then the result would be different. The \gls{firstuse} of \cs{gls} uses \qt{E} for +the short form but the subsequent use has \qt{ActualText} instead. +This is because without \ics{setacronymstyle} the original acronym +mechanism is used, which is less sophisticated than the newer +acronym mechanism that's triggered with \ics{setacronymstyle}. + +\begin{important} +If you want to convert this example so that it uses +\gls{glossaries-extra}, make sure you have at least version 1.42 of +the extension package. +\end{important} + +\glsxtrnote +If you want to convert this example so that it uses +\gls{glossaries-extra}, you need to replace the explicit loading of +\sty{glossaries-accsupp} with an implicit load through the +\pkgopt*{accsupp} package option: +\begin{alltt} +\cs{usepackage}[\xtrfont{abbreviations},\strong{\xtrfont{accsupp}}]\mgroup{\strong{glossaries-extra}} +\end{alltt} +I'm switching from \ics{newacronym} to \ics*{newabbreviation}, which +means that the default category is \cat{abbreviation} and also the +file extensions are different. If you are using \gls{makeglossaries} +or \gls{makeglossaries-lite.lua} you don't need to worry about it. +However, if you're not using those helper scripts then you will need +to adjust the file extensions in your document build process. + +The style command \texttt{\cs{setacronymstyle}\mgroup{long-short}} needs +to be replaced with: +\begin{alltt} +\ics{setabbreviationstyle}\mgroup{long-short} +\end{alltt} +This is actually the default so you can simply delete the +\cs{setacronymstyle} line. Substitute the two instances of +\ics{newacronym} with \ics*{newabbreviation}. For example: +\begin{alltt} +\strong{\ics*{newabbreviation}}\mgroup{eg}\mgroup{e.g.}\mgroup{for example} +\end{alltt} +Note that for the \texttt{tikz} entry you can now remove the explicit assignment of +\gloskey{shortaccess} with \gls{glossaries-extra} v1.42 as it will +strip formatting commands like \cs{emph}: +\begin{alltt} +\ics*{newabbreviation} + \mgroup{tikz}\mgroup{Ti\cs{emph}\mgroup{k}Z}\mgroup{Ti\cs{emph}\mgroup{k}Z ist \cs{emph}\mgroup{kein} Zeichenprogramm} +\end{alltt} +It's also necessary to replace \cs{acrshort}, \cs{acrlong} and \cs{acrfull} with +\ics*{glsxtrshort}, \ics*{glsxtrlong} and \ics*{glsxtrfull}. + +You may notice a slight difference from the original example. The +\gloskey{shortaccess} field now shows \meta{long} (\meta{short}) +instead of just \meta{long}. This is because \gls{glossaries-extra} +redefines \ics{glsdefaultshortaccess} to include the short form. + +Now that the extension package is being used, there are some other +modifications that would tidy up the code and fix a few issues. + +The \qt{Doctor} and \qt{Drive} entries should really be defined as +abbreviations but they shouldn't be expanded on first use. The +\abbrstyle{short-nolong} style can achieve this and it happens to be +the default style for the \cat{acronym} category. This means that +you can simply replace the \qt{Doctor} definition with: +\begin{alltt} +\ics{newacronym}\mgroup{Doctor}\mgroup{Dr}\mgroup{Doctor} +\end{alltt} +The \gls{firstuse} of \verb|\gls{Doctor}| is just \qt{Dr}. This +means that the \qt{E} element will be used instead of \qt{ActualText}. +Now I don't need to supply the accessibility text as its obtained +from the long form. + +The \qt{Drive} entry can be similarly defined but it has the awkward +terminating full stop. This means that I had to omit the end of +sentence terminator in: +\begin{verbatim} +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} +\end{verbatim} +This looks odd when reading the document source and it's easy to +forgot. This is very similar to the situation in the +\samplefile{-dot-abbr} example. I can again use the +\attr{discardperiod} attribute, but I need to assign a different +category so that it doesn't interfere with the \qt{Doctor} entry. + +The category is simply a label that's used in the construction of +some internal command names. This means that it must be fully +expandable, but I can choose whatever label I like (\cat{general}, +\cat{abbreviation}, \cat{acronym}, \cat{index}, \cat{symbol} and +\cat{number} are used by various commands provided by +\gls{glossaries-extra}). + +In this case, I've decided to have a category called \texttt{shortdotted} +to indicate an abbreviation that ends with a +dot but only the short form is shown on \gls{firstuse}: +\begin{alltt} +\ics*{setabbreviationstyle}[shortdotted]\mgroup{short-nolong-noreg} +\ics*{glssetcategoryattribute}\mgroup{shortdotted}\mgroup{discardperiod}\mgroup{true} +\ics*{newabbreviation}[category=shortdotted]\mgroup{Drive}\mgroup{Dr.\cs{@}}\mgroup{Drive} +\end{alltt} +In the \samplefile{-dot-abbr} example, I also used the +\attr{insertdots} attribute to automatically insert the dots and add +the space factor (which is adjusted if \attr{discardperiod} discards +a period). In this case I'm inserting the dot manually so I've also +added the space factor with \ics{@} in case the abbreviation is used +mid-sentence. For example: +\begin{verbatim} +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive}. Next sentence. + +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} end of sentence. +\end{verbatim} +(The spacing is more noticeable if you first switch to a monospaced +font with \cs{ttfamily}.) + +The \qt{e.g.}\ abbreviation similarly ends with a dot. It's not +usual to write \qt{for example (e.g.)}\ in a document, so it really +ought to have the same \texttt{shortdotted} category, but it has a +long-short form for illustrative purposes in this test document. In +this case I need to choose another category so that I can apply a +different style. For example: +\begin{alltt} +\ics*{setabbreviationstyle}[longshortdotted]\mgroup{long-short} +\ics*{glssetcategoryattribute}\mgroup{longshortdotted}\mgroup{discardperiod}\mgroup{true} +\ics*{newabbreviation}[category=longshortdotted]\mgroup{e.g.}\mgroup{e.g.\cs{@}}\mgroup{for +example} +\end{alltt} + +To further illustrate categories, let's suppose the symbol and image +should be in the \gloskey{name} field instead of the +\gloskey{symbol} and \gloskey{user1} fields. Now the +\cs{glssymbolaccsupp} and \cs{glsuseriaccsupp} commands won't be +used. I can't deal with both cases if I just provide +\cs{glsnameaccsupp}. + +I could provide category-field versions, such as +\xtrfont{\cs{glsxtrsymbolnameaccsupp}}, but remember that this only covers +accessing the \gloskey{name} field, which is typically only done in +the glossary. I would also need similar commands for the +\gloskey{first}, \gloskey{firstplural}, \gloskey{text} and +\gloskey{plural} keys. This is quite complicated, but since I don't +need to worry about any of the other fields it's simpler to just +provide the \csmeta*{glsxtr}{category}{accsupp} version: +\begin{alltt} +\cs{newcommand}\mgroup{\xtrfont{\cs{glsxtr\strong{symbol}accsupp}}}[2]\mgroup{\% + \ics{glsaccessibility}[method=hex,unicode]\mgroup{ActualText}\mgroup{\#1}\mgroup{#2}\% +} +\cs{newcommand}\mgroup{\xtrfont{\cs{glsxtr\strong{image}accsupp}}}[2]\mgroup{\% + \ics{glsaccessibility}\mgroup{Alt}\mgroup{\#1}\mgroup{\#2}\% +} + +\cs{newglossaryentry}\mgroup{int}\mgroup{\strong{\xtrfont{category}=symbol}, + \strong{name}=\mgroup{\cs{ensuremath}\mgroup{\cs{int}}},\strong{access}=\mgroup{222B}, + description=\mgroup{integral} +} + +\cs{newglossaryentry}\mgroup{sampleimage}\mgroup{\strong{\xtrfont{category}=image}, + description=\mgroup{an example image}, + \strong{name}=\mgroup{\cs{protect}\cs{includegraphics}[height=20pt]\mgroup{example-image}}, + \strong{access}=\mgroup{a boilerplate image used in examples} +} +\end{alltt} +If it's necessary to provide support for additional fields, then the +category-field command \csmetameta*{glsxtr}{category}{}{field}{accsupp} could be used to +override the more general category command \csmeta*{glsxtr}{category}{accsupp}. + +\exitem{-ignored} This document defines an ignored glossary for +common terms that don't need a definition. The document build is: +\begin{prompt} +pdflatex sample-ignored +makeglossaries sample-ignored +pdflatex sample-ignored +\end{prompt} +A new \qt{ignored} glossary is defined with: +\begin{alltt} +\ics{newignoredglossary}\mgroup{common} +\end{alltt} +There are no associated files with an ignored glossary. An entry is defined with +this as its glossary type: +\begin{verbatim} +\newglossaryentry{commonex}{type=common,name={common term}} +\end{verbatim} +Note that the \gloskey{description} key isn't required. This term +may be referenced with \cs{gls} (which is useful for consistent +formatting) but it won't be indexed. + +\exitem{-entrycount} This document uses \ics{glsenableentrycount} +and \ics{cgls} (described in \sectionref{sec:enableentrycount}) +so that acronyms only used once don't appear in the list of +acronyms. The document build is: +\begin{prompt} +pdflatex sample-entrycount +pdflatex sample-entrycount +makeglossaries sample-entrycount +pdflatex sample-entrycount +\end{prompt} +Note the need to call \LaTeX\ twice before \gls{makeglossaries}, and +then a final \LaTeX\ call is required at the end. + +\begin{xtr} +The \gls{glossaries-extra} package has additions that extend this +mechanism and comes with some other sample files related to entry counting. +\end{xtr} + +\begin{bib2gls} +If you switch to \gls{bib2gls} you can use record counting instead. +See the \gls{bib2gls} manual for further details. +\end{bib2gls} \chapter{Troubleshooting} \label{sec:trouble} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html index a3835bfd2ec..d9d639897ed 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html @@ -48,10 +48,11 @@ .cmss-8{ font-family: sans-serif;} .cmss-8{ font-family: sans-serif;} .small-caps{font-variant: small-caps; } -p.noindent { text-indent: 0em } -td p.noindent { text-indent: 0em; margin-top:0em; } -p.nopar { text-indent: 0em; } -p.indent{ text-indent: 1.5em } +p{margin-top:0;margin-bottom:0} +p.indent{text-indent:0;} +p + p{margin-top:1em;} +p + div, p + pre {margin-top:1em;} +div + p, pre + p {margin-top:1em;} @media print {div.crosslinks {visibility:hidden;}} a img { border-top: 0; border-left: 0; border-right: 0; } center { margin-top:1em; margin-bottom:1em; } @@ -74,7 +75,7 @@ div.obeylines-v p { margin-top:0; margin-bottom:0; } td.displaylines {text-align:center; white-space:nowrap;} .centerline {text-align:center;} .rightline {text-align:right;} -div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; } .fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } div.fbox {display:table} div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } @@ -197,6 +198,7 @@ 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} +.warningsymbol { color: red; font-weight: bold;} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} span#textcolor1{color:#00FF00} @@ -261,7 +263,7 @@ span#textcolor40{color:#00FF00} > <!--l. 55--><p class="noindent" > </p><!--l. 55--><p class="noindent" ><span -class="cmr-17">The glossaries package v4.44: a guide for</span> +class="cmr-17">The glossaries package v4.45: a guide for</span> <span class="cmr-17">beginners</span> </p> @@ -274,7 +276,7 @@ class="td11"> <span class="cmr-12">Nicola L.C. Talbot </span></td></tr></table> </div> <!--l. 55--><p class="noindent" ><span -class="cmr-12">2019-12-06</span></p></div> +class="cmr-12">2020-02-13</span></p></div> <div class="abstract" > @@ -670,7 +672,9 @@ them all in the document, so “turnip” appears in the glossary even t <span class="obeylines-h"><span class="verb"><span class="cmtt-10">\gls{turnip}</span></span></span> (or similar) in the document. </p><!--l. 339--><p class="indent" > The <span -class="cmss-10">sort=none</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">none</span><a id="dx1-2016"></a> option isn’t essential in this case (there’s no other sort option available for this document), but it prevents the automatic construction of the sort value and so slightly improves the document build time. @@ -1740,7 +1744,7 @@ package. These are also available with the extension package <span class="cmss-10">glossaries-extra</span> along with a fourth option. These four options are listed below in a little more detail. <a -href="#x1-50011">Table 1</a> summarises the main advantages and disadvantages. +href="#tab:optionsp+c">Table 1</a> summarises the main advantages and disadvantages. (There’s a more detailed summary in the main <span class="cmss-10">glossaries </span>user manual.) See also <a @@ -1752,7 +1756,7 @@ build</a>. <!--l. 925--><p class="indent" > <a - id="x1-50011"></a></p><hr class="float" /><div class="float" + id="tab:optionsp+c"></a></p><hr class="float" /><div class="float" > @@ -1956,9 +1960,13 @@ class="cmtt-10">sort </span>value must be supplied) unless you have the package option <span class="cmss-10">sanitizesort</span><a id="dx1-5003"></a> or <span -class="cmss-10">sort=def</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a id="dx1-5004"></a> or <span -class="cmss-10">sort=use</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a id="dx1-5005"></a>. </p><ol class="enumerate1" > <li @@ -2111,12 +2119,18 @@ class="cmtt-10">\printglossaries </span></div><hr> command doesn’t have any arguments. </p><!--l. 1064--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified with one of the package options: <span -class="cmss-10">sort=standard</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">standard</span><a id="dx1-5026"></a> (default), <span -class="cmss-10">sort=use</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a id="dx1-5027"></a> or <span -class="cmss-10">sort=def</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a id="dx1-5028"></a>. </div> </p><!--l. 1069--><p class="noindent" > </p></li> @@ -2197,7 +2211,9 @@ class="cmss-10">automake</span><a <!--l. 1112--><p class="nopar" > </p><!--l. 1114--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want letter ordering you need to add the <span -class="cmss-10">order=letter</span><a +class="cmss-10">order</span><span +class="cmtt-10">=</span><span +class="cmss-10">letter</span><a id="dx1-5039"></a> package option @@ -2324,12 +2340,18 @@ class="cmtt-10">\printglossaries </span></div><hr> </p><!--l. 1190--><p class="noindent" > </p><!--l. 1192--><p class="noindent" ><div class="important" title="Important Note"> All glossaries are sorted using the same method which may be identified with one of the package options: <span -class="cmss-10">sort=standard</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">standard</span><a id="dx1-5057"></a> (default), <span -class="cmss-10">sort=use</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">use</span><a id="dx1-5058"></a> or <span -class="cmss-10">sort=def</span><a +class="cmss-10">sort</span><span +class="cmtt-10">=</span><span +class="cmss-10">def</span><a id="dx1-5059"></a>. </div> </p><!--l. 1197--><p class="noindent" > </p></li> @@ -2708,7 +2730,9 @@ class="description">By default, the accent command will be stripped so the sort will be <span class="cmtt-10">elite</span>. This will put the entry in the “E” letter group. However if you use the <span -class="cmss-10">sanitizesort=true</span><a +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a id="dx1-5094"></a> package option, the sort value will be interpreted as the sequence of characters: <span class="obeylines-h"><span class="verb"><span class="cmtt-10">{</span></span></span> <span class="obeylines-h"><span class="verb"><span @@ -2850,7 +2874,9 @@ class="cmbx-10">:</span> </dt><dd class="description">By default the sort value will be interpreted as <span class="cmtt-10">elite </span>so the entry will be put in the “E” letter group. If you use the <span -class="cmss-10">sanitizesort=true</span><a +class="cmss-10">sanitizesort</span><span +class="cmtt-10">=</span><span +class="cmss-10">true</span><a id="dx1-5106"></a> package option, the sort value will be interpreted as <span class="cmtt-10">é</span><span @@ -3720,7 +3746,9 @@ glossary, then do: <!--l. 1953--><p class="nopar" > </p><!--l. 1955--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want hyperlinks for subsequence references then use the <span -class="cmss-10">hyperfirst=false</span><a +class="cmss-10">hyperfirst</span><span +class="cmtt-10">=</span><span +class="cmss-10">false</span><a id="dx1-8010"></a> package option: diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf Binary files differindex b541ca9147d..bfdff9d737b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex b/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex index 03ab7be4ab1..e0793626a8b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex +++ b/Master/texmf-dist/doc/latex/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.44: +\title{The glossaries package v4.45: a guide for beginners} \author{Nicola L.C. Talbot} -\date{2019-12-06} +\date{2020-02-13} \ifpdf \externaldocument{glossaries-user} diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html index 38391e1d5a5..e733386eb1b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html @@ -55,10 +55,11 @@ .cmtt-9{font-family: monospace;} .cmtt-9{font-family: monospace;} .cmti-8{font-size:80%; font-style: italic;} -p.noindent { text-indent: 0em } -td p.noindent { text-indent: 0em; margin-top:0em; } -p.nopar { text-indent: 0em; } -p.indent{ text-indent: 1.5em } +p{margin-top:0;margin-bottom:0} +p.indent{text-indent:0;} +p + p{margin-top:1em;} +p + div, p + pre {margin-top:1em;} +div + p, pre + p {margin-top:1em;} @media print {div.crosslinks {visibility:hidden;}} a img { border-top: 0; border-left: 0; border-right: 0; } center { margin-top:1em; margin-bottom:1em; } @@ -81,7 +82,7 @@ div.obeylines-v p { margin-top:0; margin-bottom:0; } td.displaylines {text-align:center; white-space:nowrap;} .centerline {text-align:center;} .rightline {text-align:right;} -div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; } +div.verbatim {font-family: monospace,monospace; white-space: nowrap; text-align:left; clear:both; } .fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } div.fbox {display:table} div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; } @@ -166,6 +167,7 @@ div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; } .quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; } .abstract p {margin-left:5%; margin-right:5%;} div.abstract {width:100%;} +.warningsymbol { color: red; font-weight: bold;} div.important { border : solid red; } div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;} /* end css.sty */ @@ -203,7 +205,7 @@ class="td11"><span class="cmr-12">Nicola L.C. Talbot</span></td></tr></table> </div> <!--l. 52--><p class="noindent" ><span -class="cmr-12">2019-12-06</span></p></div> +class="cmr-12">2020-02-13</span></p></div> <div class="abstract" > @@ -1725,7 +1727,7 @@ href="glossary2glossaries.html#dx1-17001" >2</a> <br /></span> class="cmbx-10">G</span> <span class="index-item"><span class="cmss-10">glossaries-extra </span>package  <a -href="glossary2glossaries.html#dx1-17007" >3</a> <br /></span> +href="glossary2glossaries.html#dx1-17007" ><span class="underline">3</span></a> <br /></span> <span class="index-item"><span class="cmtt-10">\gls </span>options<br /></span> <span class="index-subitem">    <span diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf Binary files differindex c3e3b4f5049..9662f4df4df 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex index 9dc84920912..11a8aaeff43 100644 --- a/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex +++ b/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex @@ -34,7 +34,7 @@ \title{Upgrading from the glossary package to the glossaries package} \author{Nicola L.C. Talbot} -\date{2019-12-06} +\date{2020-02-13} \newenvironment{oldway}{% \begin{labelledbox}{\styfmt{glossary}}\ttfamily\obeylines diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf Binary files differindex 76744ff2dab..6d29420797d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf Binary files differindex e81068446ac..778390fb7de 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex index 816007fd2e1..3116ad36a18 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.tex @@ -1,5 +1,8 @@ % This file is public domain. % +% For further details about this file, see +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#minimalgls +% % 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 @@ -19,6 +22,12 @@ % 1. latex minimalgls % 2. makeglossaries minimalgls (note no extension) % 3. latex minimalgls +% +% Alternatively: +% 1. latex minimalgls +% 2. makeglossaries-lite 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. @@ -28,6 +37,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +% (Alternatively replace "makeglossaries" with "makeglossaries-lite") % If you require multilingual support you must also install % the appropriate glossaries language module. The language @@ -37,8 +48,9 @@ \listfiles \usepackage[colorlinks]{hyperref} -%\usepackage{glossaries} % abbreviation will go in main glossary - \usepackage[acronym]{glossaries} % make a separate list of acronyms +\usepackage[ + % acronym % make a separate list of acronyms +]{glossaries} \makeglossaries @@ -59,8 +71,7 @@ description={a sample entry}} % These are specified in the optional argument. % Remove the optional argument to revert to the default % plurals. -\newacronym[\glsshortpluralkey=cas,\glslongpluralkey=contrived -acronyms]{aca}{aca}{a contrived acronym} +\newacronym[shortplural=cas,longplural=contrived acronyms]{aca}{aca}{a contrived acronym} % Keep all definitions in the preamble! diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf Binary files differindex 06ebb2b46c9..d87c391ba6d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.tex index be64f5cafa9..19611cf7635 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.tex @@ -3,6 +3,9 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%See also +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#minimalgls \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf Binary files differindex 02f3e50e863..74bfe9d3d0a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.tex index d7dd581f601..cc16301f688 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.tex @@ -3,6 +3,9 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%See also +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#minimalgls \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf Binary files differindex 14208cc5da8..1102d17ddae 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.tex b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.tex index 59dacdd4d10..a2e34dee72e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.tex @@ -3,6 +3,9 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%See also +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#minimalgls \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf Binary files differindex 0ac18e640f1..1d60e8b3aa4 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.tex index 746eb7b858c..2cd18560f35 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleFnDesc \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf Binary files differindex 891ae8db658..c8f7619280a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.tex index 619519e6857..eeb04c6faa5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-chap-hyperfirst \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf Binary files differindex 7033120a7bc..470d21abeb6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex index 4843b4d1b1c..3a26233f66b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-crossref \documentclass{article} \usepackage[colorlinks]{hyperref} @@ -10,6 +12,8 @@ \makeglossaries +\providecommand{\alsoname}{see also} + \renewcommand{\glsseeitemformat}[1]{\textsc{\glsentryname{#1}}} \newglossaryentry{pear}{name=pear, @@ -17,7 +21,7 @@ description={an oddly shaped fruit}} \newglossaryentry{apple}{name=apple, description={firm, round fruit}, -see=[see also]{pear}} +see=[\alsoname]{pear}} \newglossaryentry{banana}{name=banana, description={a yellow fruit with an even odder shape than @@ -26,10 +30,23 @@ a \gls{pear}}} \newglossaryentry{fruit}{name=fruit, description={sweet, fleshy product of plant containing seed}} +% An alternative to using the 'see' key: \glssee{fruit}{pear,apple,banana} +\newglossaryentry{courgette}{name={courgette}, + description={type of long, green summer squash}} + +% The 'see' key automatically triggers \glssee so this entry will be +% included even though it's not referenced in the document. +\newglossaryentry{marrow}{name={marrow}, + description={long vegetable with thin green skin and white flesh}, + see={[\alsoname]courgette}} + +\newglossaryentry{zucchini}{name={zucchini},description={\nopostdesc}, + see={courgette}} + \begin{document} -\gls{pear}, \gls{apple} and \gls{banana}. +\gls{pear}, \gls{apple}, \gls{banana} and \gls{courgette}. \printglossaries diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf Binary files differindex 37de7552bb7..dff41fe7d05 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex index 74ea7606656..b148363a25f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-custom-acronym \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf Binary files differindex 4722172d2cc..5aa9bd92add 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.tex index 3fd3cf7cbad..cf8f9c44ae2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-dot-abbr \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf Binary files differindex 44eb610a1c3..89b2c1bd14c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex index 4a1fc9a9539..03406d1e569 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.tex @@ -3,10 +3,14 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-dual \documentclass{article} \usepackage[acronym]{glossaries} +\makeglossaries + % \newdualentry[main options]{label}{short}{long}{description} \newcommand*{\newdualentry}[5][]{% @@ -25,8 +29,6 @@ {support vector machine}% long form {Statistical pattern recognition technique}% description -\makeglossaries - \begin{document} \gls{svm}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf Binary files differindex c7e9ec1a23a..ad043608c77 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.tex index 0a37f54974f..56ca18d492e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.tex @@ -4,6 +4,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-entrycount \documentclass{article} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf Binary files differindex 869b9204a51..352558f6fde 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.tex index d3bcfe36594..3018244964b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-entryfmt \documentclass{article} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf Binary files differindex 046347b87e2..f681c18f326 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.tex index 43b744f8f1b..9d20843f28b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-font-abbr \documentclass{article} \usepackage{glossaries} @@ -40,7 +42,7 @@ \setacronymstyle{long-font-short} \newcommand*{\newitabbr}[1][]{\newacronym[font=\em,#1]} -\newcommand*{\newupabbr}[1][]{\newacronym[#1]} +\newcommand*{\newupabbr}{\newacronym} \newitabbr{eg}{e.g.}{exempli gratia} \newitabbr{ie}{i.e.}{id est} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf Binary files differindex 2344c44f545..50c9524d6e8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.tex index f552aff44a9..32a30ef0030 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-ignored \documentclass{article} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf Binary files differindex 5baa6494f98..5ec92b819c5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.tex index 9842bacc2f7..899ea649fdf 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.tex @@ -5,6 +5,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-index \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf Binary files differindex df6e6f65565..c0c3acfae11 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex index e6a6e94c877..cfe2a383ce0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.tex @@ -4,6 +4,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-inline \documentclass[a4paper]{report} \usepackage[plainpages=false,colorlinks]{hyperref} @@ -17,7 +19,9 @@ \makeglossaries -\newglossaryentry{Perl}{name=\texttt{Perl}, +\newcommand{\scriptlang}[1]{\textsf{#1}} + +\newglossaryentry{Perl}{name=\scriptlang{Perl}, sort=Perl, % need a sort key because name contains a command description=A scripting language} @@ -59,6 +63,7 @@ writing. Beginning on new, usually indented, line}} % this isn't necessary, as this form (appending an s) is % the default plural=cows, +user1=kine, % description: description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult female of any bovine animal}} @@ -123,9 +128,16 @@ must be used, e.g.\ in the description of \gls{pagelist}. Plurals are assumed to have the letter s appended, but if this is not the case, as in \glspl{mtrx}, then you need to specify the plural when you define the entry. If a term may have multiple -plurals (for example \glspl{cow}/\glslink{cow}{kine}) then -define the entry with the plural form most likely to be used and -explicitly specify the alternative form using \verb|\glslink|. +plurals (for example \glspl{cow}/\glsuseri{cow}) then +define the entry with the plural form most likely to be used. +The alternative can simply be referenced with \verb|\glslink| +(e.g.\ \glslink{cow}{kine}) +or \verb|\glsdisp| (e.g.\ \glsdisp{cow}{kine}). +Another option is to save the alternative plural in another key. In +this case, the ``user1'' key has been used, but a custom key can be +defined instead. + + \Glspl{seal} and \glspl{sealion} have regular plural forms. \Gls{bravo} is a homograph, but the plural forms are spelt diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf Binary files differindex 585c4a96ea7..0e47ca4e2ed 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex index c5bf52fc7d8..a15b19980ae 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.tex @@ -7,6 +7,8 @@ % This file also requires the glossaries-english % and glossaries-french language modules. These must % be installed in addition to installing the glossaries package. +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-langdict \documentclass[english,french]{article} \usepackage[utf8]{inputenc} @@ -29,14 +31,14 @@ } \newword{cat}{cat}{le}{chat} -\newword{mat}{mat}{la}{natte} +\newword{chair}{chair}{la}{chaise} \begin{document} \selectlanguage{english} -The \gls{en-cat} sat on the \gls{en-mat}. +The \gls{en-cat} sat on the \gls{en-chair}. \selectlanguage{french} -Le \gls{fr-cat} s'est repos\'e sur la \gls{fr-mat}. +Le \gls{fr-cat} s'est repos\'e sur la \gls{fr-chair}. \selectlanguage{english} \printglossary[type=english] diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf Binary files differindex b9d3912b1b1..9f1760b8d55 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.tex index ee93bcb22e0..41d75c33a13 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-newkeys \documentclass{article} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf Binary files differindex d94e24a152d..da250c769a1 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex index 78d4f400a1b..cec83e1d986 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex @@ -2,6 +2,8 @@ % If you want to use arara, you need the following directives: % arara: pdflatex % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-noidxapp-utf8 \documentclass{report} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf Binary files differindex ed705c0fe40..cc8e5870398 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex index 29f3655587b..d675c795fc5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex @@ -2,6 +2,8 @@ % If you want to use arara, you need the following directives: % arara: pdflatex % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-noidxapp \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf Binary files differindex 0954a5014cc..f7b1087f4c0 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.tex index 7ac3f82e8f9..21c797c3a4c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-nomathhyper \documentclass{report} \usepackage[colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf Binary files differindex 9e46a428b64..c139c1728ce 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex index 5c26c64b5a1..01ed70f872e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.tex @@ -4,20 +4,25 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-numberlist \documentclass{report} -\usepackage[colorlinks]{hyperref} +%\usepackage[colorlinks]{hyperref} \usepackage[savenumberlist,counter=chapter]{glossaries} \makeglossaries +%\makenoidxglossaries % option 1 ("noidx") + \newglossaryentry{sample}{name=sample,description=an example} \begin{document} \chapter{Introduction} -This is a \glsentryname{sample} document. \Glsentryplural{sample} -are discussed in chapters~\glsdisplaynumberlist{sample}. +This is a \gls{sample} document. \Glspl{sample} +are discussed in chapters~\glsdisplaynumberlist{sample} +(or \glsentrynumberlist{sample}). \chapter{Sample Documents} @@ -36,5 +41,10 @@ A chapter about something else. Here's some more information about \glspl{sample}. +\chapter{And Another Sample Chapter} + +Here's another \glspl{sample}. + \printglossaries +%\printnoidxglossaries % option 1 ("noidx") \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf Binary files differindex 881252f4583..4abf0d0d215 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.tex index 40372cbad7b..535a6519f46 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.tex @@ -4,6 +4,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-prefix \documentclass{article} @@ -26,15 +28,23 @@ \newacronym [% - prefix={an\space},prefixfirst={a~}% + prefix={an\space},% + prefixfirst={a~}% ]{svm}{SVM}{support vector machine} +\newglossaryentry{noprefix}{name={no prefix},plural={no prefixes}, + description={entry without prefix}} + \newglossarystyle{plist}{% \setglossarystyle{list}% \renewcommand*{\glossentry}[2]{% \item[\glsentryitem{##1}% - \Glsentryprefix{##1}% - \glstarget{##1}{\glossentryname{##1}}] + \glstarget{##1}% + {% + \ifglshasprefix{##1}% + {\Glsentryprefix{##1}\glsprefixsep\glossentryname{##1}}% + {\Glossentryname{##1}}% + }] \glossentrydesc{##1}\glspostdescription\space ##2}% } @@ -44,30 +54,34 @@ \section{Sample} -First use: \pgls{sample}, \pgls{svm}, \pgls{oeil}. Next use: \pgls{sample}, \pgls{svm}, \pgls{oeil}. +First use: \pgls{sample}, \pgls{svm}, \pgls{oeil}, \pgls{noprefix}. Next use: +\pgls{sample}, \pgls{svm}, \pgls{oeil}, \pgls{noprefix}. Reset. \glsresetall -First use: \pglspl{sample}, \pglspl{svm}, \pglspl{oeil}. Next use: -\pglspl{sample}, \pglspl{svm}, \pglspl{oeil}. +First use: \pglspl{sample}, \pglspl{svm}, \pglspl{oeil}, \pglspl{noprefix}. Next use: +\pglspl{sample}, \pglspl{svm}, \pglspl{oeil}, \pglspl{noprefix}. Reset. \glsresetall -First use: \Pgls{sample}, \Pgls{svm}. Next use: \Pgls{sample}, \Pgls{svm}. +First use: \Pgls{sample}, \Pgls{svm}, \Pgls{oeil}, \Pgls{noprefix}. Next use: +\Pgls{sample}, \Pgls{svm}, \Pgls{oeil}, \Pgls{noprefix}. Reset. \glsresetall -First use: \Pglspl{sample}, \Pglspl{svm}. Next use: \Pglspl{sample}, \Pglspl{svm}. +First use: \Pglspl{sample}, \Pglspl{svm}, \Pglspl{oeil}, \Pglspl{noprefix}. Next use: +\Pglspl{sample}, \Pglspl{svm}, \Pglspl{oeil}, \Pglspl{noprefix}. Reset. \glsresetall -First use: \PGLS{sample}, \PGLS{svm}. Next use: \PGLS{sample}, \PGLS{svm}. +First use: \PGLS{sample}, \PGLS{svm}, \PGLS{oeil}, \PGLS{noprefix}. Next use: +\PGLS{sample}, \PGLS{svm}, \PGLS{oeil}, \PGLS{noprefix}. Reset. \glsresetall -First use: \PGLSpl{sample}, \PGLSpl{svm}. Next use: \PGLSpl{sample}, \PGLSpl{svm}. +First use: \PGLSpl{sample}, \PGLSpl{svm}, \PGLSpl{oeil}, \PGLSpl{noprefix}. Next use: +\PGLSpl{sample}, \PGLSpl{svm}, \PGLSpl{oeil}, \PGLSpl{noprefix}. \printglossary[style=plist] - \printacronyms \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf Binary files differindex c2aef74cdec..ba749704a6e 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.tex index e1afeae6226..a5d6ed7d7f8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-si \documentclass{article} \usepackage{siunitx} \usepackage[style=long4col]{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf Binary files differindex 3b517bf24fe..340ff6f9f16 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.tex index 39fcb8c8dd4..9ff45423406 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-storage-abbr-desc \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf Binary files differindex d8115a22dad..bc995c55f42 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.tex index fbde7ef10b2..6b6ed6bd046 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample-storage-abbr \documentclass{article} \usepackage{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf Binary files differindex 2bf39bd56e7..3d4e2a49ae6 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex index eca14645854..6b9e19069b3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample.tex @@ -4,16 +4,20 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample \documentclass[a4paper]{report} \usepackage[plainpages=false,colorlinks]{hyperref} -\usepackage[toc,style=treenoname,order=word,subentrycounter]{glossaries} +\usepackage[toc,style=treenonamegroup,subentrycounter]{glossaries} \makeglossaries -\newglossaryentry{Perl}{name=\texttt{Perl}, +\newcommand{\scriptlang}[1]{\textsf{#1}} + +\newglossaryentry{Perl}{name=\scriptlang{Perl}, sort=Perl, % need a sort key because name contains a command -description=A scripting language} +description={A scripting language}} \newglossaryentry{glossary}{name=glossary, description={\nopostdesc}, @@ -53,12 +57,15 @@ distinct section of a piece of writing. Beginning on new, usually indented, line} % entry with two types of plural. Set the plural form to the -% form most likely to be used. If you want to use a different -% plural, you will need to explicity specify it in \glslink +% form most likely to be used. The alternative plural is stored in +% the 'user1' key. Another option is to define your own custom +% storage key for alternative plurals. \newglossaryentry{cow}{name=cow, % this isn't necessary, as this form (appending an s) is % the default plural=cows, +% alternative plural: +user1=kine, % description: description={(\emph{pl.}\ cows, \emph{archaic} kine) an adult female of any bovine animal}} @@ -66,12 +73,11 @@ female of any bovine animal}} \newglossaryentry{bravo}{name={bravo}, description={\nopostdesc}} -\newglossaryentry{bravo1}{description={cry of approval (pl.\ bravos)}, +\newglossaryentry{bravocry}{description={cry of approval (pl.\ bravos)}, sort={1}, -plural={bravos}, parent=bravo} -\newglossaryentry{bravo2}{description={hired ruffian or killer (pl.\ bravoes)}, +\newglossaryentry{bravoruffian}{description={hired ruffian or killer (pl.\ bravoes)}, sort={2}, plural={bravoes}, parent=bravo} @@ -112,11 +118,12 @@ uncommented line breaks or attempts to pretty-print the \LaTeX\ code} \chapter{Introduction} \pagenumbering{arabic} -A \gls{glossarylist} (definition~\glsrefentry{glossarylist}) is a -very useful addition to any technical document, although a -\gls{glossarycol} (definition~\glsrefentry{glossarycol}) can also -simply be a collection of glosses, which is another thing entirely. -Some documents have multiple \glspl{glossarylist}. +A \gls{glossarylist} (definition~\glsrefentry{glossarylist}, plural +\glspl{glossarylist}) is a very useful addition to any technical +document, although a \gls{glossarycol} +(definition~\glsrefentry{glossarycol}, plural \glspl{glossarycol}) +can also simply be a collection of glosses, which is another thing +entirely. Some documents have multiple \glspl{glossarylist}. Once you have run your document through \LaTeX, you will then need to run the \texttt{.glo} file through \texttt{makeindex} (default) @@ -136,21 +143,25 @@ Be careful about \glspl{spuriousspace} appearing in your code. \chapter{Plurals and Paragraphs} -Plurals are assumed to have the letter s appended, but if this is +Plurals are assumed to have the letter ``s'' appended, but if this is not the case, as in \glspl{mtrx}, then you need to specify the plural when you define the entry. If a term may have multiple -plurals (for example \glspl{cow}/\glslink{cow}{kine}) then -define the entry with the plural form most likely to be used and -explicitly specify the alternative form using \verb|\glslink| +plurals (for example \glspl{cow}/\glsuseri{cow}) then +define the entry with the plural form most likely to be used. +The alternative can simply be referenced with \verb|\glslink| (e.g.\ \glslink{cow}{kine}) or \verb|\glsdisp| (e.g.\ \glsdisp{cow}{kine}). +Another option is to save the alternative plural in another key. In +this case, the ``user1'' key has been used, but a custom key can be +defined instead. + \Glspl{seal} and \glspl{sealion} have regular plural forms. \Gls{bravo} is a homograph, but the plural forms are spelt -differently. The plural of \gls{bravo1}, a cry of approval -(definition~\glsrefentry{bravo1}), is \glspl{bravo1}, whereas the -plural of \gls{bravo2}, a hired ruffian or killer -(definition~\glsrefentry{bravo2}), is \glspl{bravo2}. +differently. The plural of \gls{bravocry}, a cry of approval +(definition~\glsrefentry{bravocry}), is \glspl{bravocry}, whereas the +plural of \gls{bravoruffian}, a hired ruffian or killer +(definition~\glsrefentry{bravoruffian}), is \glspl{bravoruffian}. \Glspl{par} can cause a problem in commands, so care is needed when having a paragraph break in a \gls{glossarylist} entry. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf Binary files differindex a9e88dfadf7..ee58db42821 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex index 19789541231..71e8c442cc2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.tex @@ -3,8 +3,12 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample4col \documentclass[a4paper]{article} +% Other 4 column styles are available. The ones that use +% booktabs.sty are recommended over the "headerborder" styles \usepackage[style=long4colheaderborder]{glossaries} \makeglossaries diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf Binary files differindex cef9f80d86d..8a80268474d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex index 572b95d6eaa..905aa943f37 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.tex @@ -4,6 +4,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleAcr \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} @@ -39,6 +41,9 @@ This is the entry in uppercase: \GLS{svm}. \chapter{Kernel Support Vector Machines} +% Instead of using the clumsy \ifglsused, you might find it simpler +% to use glossaries-prefix.sty + The \gls{ksvm} is \ifglsused{svm}{an}{a} \gls{svm} that uses the so called ``kernel trick''. Plural: \glspl{ksvm}. Resetting acronyms. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf Binary files differindex 96222c6f12f..65899e6a7b7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex index e2170feb16c..03490057a27 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.tex @@ -4,8 +4,11 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleAcrDesc \documentclass[a4paper]{report} +\usepackage[T1]{fontenc}% need support for bold smallcaps \usepackage[colorlinks,plainpages=false]{hyperref} \usepackage[acronym,% create 'acronym' glossary type % The package option "nomain" is used here to suppress the @@ -24,19 +27,14 @@ % Change the "see" items so that they use \acronymfont: \renewcommand*{\glsseeitemformat}[1]{\acronymfont{\glsentrytext{#1}}} -% Not using a font that supports bold smallcaps so change the way -% the name is formatted in the glossary: - -\renewcommand*{\glsnamefont}[1]{\textmd{#1}} - \newacronym[description={Statistical pattern recognition -technique~\protect\cite{svm}}, % acronym's description +technique~\protect\cite{svm}} % acronym's description ]{svm}{svm}{support vector machine} \newacronym [description={Statistical pattern recognition technique using the ``kernel trick''},% acronym's description - see={[see also]{svm}}, + see={[see also]{svm}} ] {ksvm}{ksvm}{kernel support vector machine} @@ -58,6 +56,9 @@ This is the entry in uppercase: \GLS{svm}. \chapter{Kernel Support Vector Machines} +% Instead of using the clumsy \ifglsused, you might find it simpler +% to use glossaries-prefix.sty + The \gls{ksvm} is \ifglsused{svm}{an}{a} \gls{svm} that uses the so called ``kernel trick''. This is the entry's description without a link: \glsentrydesc{ksvm}. diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf Binary files differindex a7d8af989ae..22f1bb19901 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.tex index eda408e02c1..5af8cdb747c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.tex @@ -4,8 +4,11 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleCustomAcr \documentclass[a4paper]{report} +\usepackage[T1]{fontenc}% need support for bold smallcaps \usepackage[colorlinks,plainpages=false]{hyperref} \usepackage[acronym,% create 'acronym' glossary type % The package option "nomain" is used here to suppress the @@ -56,10 +59,6 @@ % Set the name (as displayed in the glossary) to long (short) \renewcommand*{\acronymentry}[1]{% \glsentrylong{##1} (\acronymfont{\glsentryshort{##1}})}% -% Since bold small caps isn't supported with this document's -% fonts, adjust \acronymfont so that it switches to medium -% small caps: - \renewcommand{\acronymfont}[1]{\textmd{\scshape ##1}}% } % Now use this new style: diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf Binary files differindex 9a06139e72e..4bceb441f4b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex index 522ca63562f..6c9ccb97dd3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.tex @@ -3,17 +3,19 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleDB \documentclass{article} \usepackage[colorlinks,plainpages=false]{hyperref} \usepackage[nonumberlist]{glossaries} -\newglossary[nlg]{symbols}{not}{ntn}{Symbols} +\newglossary[nlg]{punc}{not}{ntn}{Punctuation Characters} \makeglossaries \loadglsentries{database1} -\loadglsentries[symbols]{database2} +\loadglsentries[punc]{database2} \begin{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf Binary files differindex 9eb6db48149..d6ec5a570d8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex index bcf7e4444e2..fe881e387c9 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.tex @@ -7,6 +7,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleDesc \documentclass[a4paper]{report} \usepackage[colorlinks,plainpages=false]{hyperref} @@ -17,6 +19,11 @@ \makeglossaries +% This sample file demonstrates the use of the first and text keys +% but in general it's better to use \newacronym (as in +% sampleAcrDesc.tex) instead as it's more flexible. For even greater +% flexibility use \newabbreviation provided by glossaries-extra.sty + \newglossaryentry{svm}{ % how the entry name should appear in the glossary name={Support vector machine (SVM)}, diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf Binary files differindex ebcb74a2967..576b164ffed 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex index 403930a97e9..aea88cb456f 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.tex @@ -3,6 +3,8 @@ % arara: pdflatex % arara: makeglossaries % arara: pdflatex +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleEq \documentclass[a4paper,12pt]{report} \usepackage{amsmath} @@ -27,6 +29,9 @@ \renewcommand{\descriptionname}{Function Name} \renewcommand{\pagelistname}{Number of Formula} +% Change the width of the number list column: +\setlength{\glspagelistwidth}{0.75\textwidth} + % define glossary entries \newglossaryentry{Gamma}{name=\ensuremath{\Gamma(z)}, @@ -34,11 +39,11 @@ description=Gamma function, sort=Gamma} \newglossaryentry{gamma}{name={\ensuremath{\gamma(\alpha,x)}}, -description=Incomplete gamma function, +description=Lower incomplete gamma function, sort=gamma1} \newglossaryentry{iGamma}{name={\ensuremath{\Gamma(\alpha,x)}}, -description=Incomplete gamma function, +description=Upper incomplete gamma function, sort=Gamma2} \newglossaryentry{psi}{name=\ensuremath{\psi(x)}, @@ -115,7 +120,7 @@ option. \verb|\ensuremath| is only required here if using hyperlinks. \begin{equation} -\glslink{Gamma}{\ensuremath{\Gamma(x+1)}} = x\Gamma(x) +\glslink{Gamma}{\Gamma(x+1)} = x\Gamma(x) \end{equation} \begin{equation} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf Binary files differindex 1285f4cc16b..fc9ad3deaae 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex index 6061bb72d92..fde88006337 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.tex @@ -21,6 +21,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleEgPg \documentclass[a4paper,12pt]{report} \usepackage{amsmath} @@ -67,10 +69,10 @@ numbers in bold indicate page numbers where the main definition occurs.\par} description=Gamma function,sort=Gamma} \newglossaryentry{gamma}{name=\ensuremath{\gamma(\alpha,x)}, -description=Incomplete gamma function,sort=gamma} +description=Lower incomplete gamma function,sort=gamma1} \newglossaryentry{iGamma}{name=\ensuremath{\Gamma(\alpha,x)}, -description=Incomplete gamma function,sort=Gamma} +description=Upper incomplete gamma function,sort=Gamma2} \newglossaryentry{psi}{name=\ensuremath{\psi(x)}, description=Psi function,sort=psi} @@ -81,7 +83,7 @@ description=Error function,sort=erf} \newglossaryentry{erfc}{name=\ensuremath{\erfc(x)}, description=Complementary error function,sort=erfc} -\newglossaryentry{beta}{name=\ensuremath{B(x,y)}, +\newglossaryentry{B}{name=\ensuremath{B(x,y)}, description=Beta function,sort=B} \newglossaryentry{Bx}{name=\ensuremath{B_x(p,q)}, @@ -98,22 +100,22 @@ sort=Un} \newglossaryentry{Hn}{name=\ensuremath{H_n(x)}, description=Hermite polynomials,sort=Hn} -\newglossaryentry{Lna}{name=\ensuremath{L_n^\alpha(x)}, +\newglossaryentry{Ln}{name=\ensuremath{L_n^\alpha(x)}, description=Laguerre polynomials,sort=Lna} \newglossaryentry{Znu}{name=\ensuremath{Z_\nu(z)}, description=Bessel functions,sort=Z} -\newglossaryentry{Pagz}{name=\ensuremath{\Phi(\alpha,\gamma;z)}, +\newglossaryentry{Phi}{name=\ensuremath{\Phi(\alpha,\gamma;z)}, description=confluent hypergeometric function,sort=Pagz} -\newglossaryentry{kv}{name=\ensuremath{k_\nu(x)}, +\newglossaryentry{knu}{name=\ensuremath{k_\nu(x)}, description=Bateman's function,sort=kv} \newglossaryentry{Dp}{name=\ensuremath{D_p(z)}, description=Parabolic cylinder functions,sort=Dp} -\newglossaryentry{Fpk}{name=\ensuremath{F(\phi,k)}, +\newglossaryentry{F}{name=\ensuremath{F(\phi,k)}, description=Elliptical integral of the first kind,sort=Fpk} \newglossaryentry{C}{name=\ensuremath{C}, @@ -163,7 +165,7 @@ defined as \end{equation} \begin{equation} -\glslink{Gamma}{\ensuremath{\Gamma(x+1)}} = x\Gamma(x) +\glslink{Gamma}{\Gamma(x+1)} = x\Gamma(x) \end{equation} \begin{equation} @@ -177,7 +179,7 @@ defined as \newpage \begin{equation} -\glslink{Gamma}{\ensuremath{\Gamma(\alpha)}} = +\glslink{Gamma}{\Gamma(\alpha)} = \Gamma(\alpha, x) + \gamma(\alpha, x) \end{equation} @@ -199,15 +201,15 @@ The \glslink[format=hyperbf,counter=page]{erf}{error function} is defined as: \chapter{Beta Function} \begin{equation} -\gls{beta} = 2\int_0^1 t^{x-1}(1-t^2)^{y-1}\,dt +\gls{B} = 2\int_0^1 t^{x-1}(1-t^2)^{y-1}\,dt \end{equation} Alternatively: \begin{equation} -\gls{beta} = 2\int_0^{\frac\pi2}\sin^{2x-1}\phi\cos^{2y-1}\phi\,d\phi +\gls{B} = 2\int_0^{\frac\pi2}\sin^{2x-1}\phi\cos^{2y-1}\phi\,d\phi \end{equation} \begin{equation} -\gls{beta} = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)} = B(y,x) +\gls{B} = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)} = B(y,x) \end{equation} \begin{equation} @@ -233,7 +235,7 @@ Alternatively: \chapter{Laguerre polynomials} \begin{equation} -\gls{Lna} = \frac{1}{n!}e^x x^{-\alpha} +\gls{Ln} = \frac{1}{n!}e^x x^{-\alpha} \frac{d^n}{dx^n}(e^{-x}x^{n+\alpha}) \end{equation} @@ -250,7 +252,7 @@ Bessel functions $Z_\nu(z)$ are solutions of \chapter{Confluent hypergeometric function} \begin{equation} -\gls{Pagz} = 1 + \frac{\alpha}{\gamma}\,\frac{z}{1!} +\gls{Phi} = 1 + \frac{\alpha}{\gamma}\,\frac{z}{1!} + \frac{\alpha(\alpha+1)}{\gamma(\gamma+1)}\,\frac{z^2}{2!} +\frac{\alpha(\alpha+1)(\alpha+2)} {\gamma(\gamma+1)(\gamma+2)} @@ -259,7 +261,7 @@ Bessel functions $Z_\nu(z)$ are solutions of \end{equation} \begin{equation} -\gls{kv} = \frac{2}{\pi}\int_0^{\pi/2} +\gls{knu} = \frac{2}{\pi}\int_0^{\pi/2} \cos(x \tan\theta - \nu\theta)\,d\theta \end{equation} @@ -278,7 +280,7 @@ Bessel functions $Z_\nu(z)$ are solutions of \chapter{Elliptical Integral of the First Kind} \begin{equation} -\gls{Fpk} = \int_0^\phi +\gls{F} = \int_0^\phi \frac{d\alpha}{\sqrt{1-k^2\sin^2\alpha}} \end{equation} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf Binary files differindex e6545084538..f7fff7a0800 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.tex index 0f3d868166d..6df02d687e7 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.tex @@ -4,8 +4,11 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleFnAcrDesc \documentclass[a4paper]{report} +\usepackage[T1]{fontenc}% need support for bold smallcaps \usepackage[colorlinks,plainpages=false]{hyperref} \usepackage[acronym,% create 'acronym' glossary type % The package option "nomain" is used here to suppress the @@ -26,10 +29,6 @@ \renewcommand*{\acronymentry}[1]{% \acronymfont{\glsentryshort{#1}}\space (\glsentrylong{#1})} -% Not using a font that supports bold smallcaps so ensure -% the acronym is always in medium weight. -\renewcommand*{\acronymfont}[1]{\textmd{\scshape #1}} - % Change the "see" items so that they use \acronymfont: \renewcommand*{\glsseeitemformat}[1]{\acronymfont{\glsentrytext{#1}}} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf Binary files differindex 3db806aea93..149c40c7965 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex index 9b3841cc33d..23ddfcd4090 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.tex @@ -4,6 +4,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleNtn \documentclass{report} % If you want to add babel to this document, you may have to @@ -12,7 +14,7 @@ \usepackage[plainpages=false,colorlinks]{hyperref} \usepackage{html} -\usepackage[toc,xindy]{glossaries} +\usepackage[toc]{glossaries} % Define a new glossary type called notation \newglossary[nlg]{notation}{not}{ntn}{Notation} @@ -22,22 +24,22 @@ % Notation definitions \newglossaryentry{not:set}{type=notation, % glossary type -name={$\mathcal{S}$}, -description={A set}, +name={\ensuremath{\mathcal{S}}}, +description={A \gls{gls:set}}, sort={S}} \newglossaryentry{not:U}{type=notation, -name={$\mathcal{U}$}, -description={The universal set}, +name={\ensuremath{\mathcal{U}}}, +description={The universal \gls{gls:set}}, sort=U} \newglossaryentry{not:card}{type=notation, -name={$|\mathcal{S}|$}, -description={cardinality of $\mathcal{S}$}, +name={\ensuremath{\mid\mathcal{S}\mid}}, +description={The \gls{gls:card} of $\mathcal{S}$}, sort=cardinality} \newglossaryentry{not:fact}{type=notation, -name={$!$}, +name={\ensuremath{!}}, description={factorial}, sort=factorial} @@ -61,8 +63,7 @@ description={The number of elements in the specified set}} This is a sample document illustrating the use of the \textsf{glossaries} package. In this example, a new glossary type called \texttt{notation} is defined, so that the document can have a -separate glossary of terms and index of notation. The index of notation -doesn't have associated numbers. +separate glossary of terms and index of notation. \end{abstract} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf Binary files differindex bdd7bb5d2a5..cbc7beaed03 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.tex index 4182dcabc18..b192bca6b2d 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.tex @@ -5,6 +5,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#samplePeople \documentclass{report} \usepackage[colorlinks]{hyperref} @@ -16,7 +18,7 @@ \newcommand{\textname}[2]{#1 #2} % Syntax: \name{first name}{surname} - \let\name\textname +\let\name\textname \renewcommand{\glsprestandardsort}[3]{% \let\name\sortname diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf Binary files differindex 219ec0f5353..710ab4ab77b 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex index 975c51076da..112775bfe9a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.tex @@ -4,6 +4,10 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +% Note that you will get a different result if you use +% makeglossaries-lite or explicitly use makeindex for this example. See +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleSec \documentclass{report} \usepackage[plainpages=false,colorlinks]{hyperref} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf Binary files differindex d771b7d591f..5e60c52d169 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.tex index 960dc22f0f0..e55ff77cd03 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.tex @@ -4,6 +4,8 @@ % arara: makeglossaries % arara: pdflatex: { synctex: on } % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleSort \documentclass{report} % If you want to add babel to this document, you may have to @@ -44,8 +46,8 @@ text={\emptyset}, description={The empty set}} \newglossaryentry{not:card}{type=notation, -name={$|\mathcal{S}|$}, -text={|\mathcal{S}|}, +name={$\mid\mathcal{S}\mid$}, +text={\mid\mathcal{S}\mid}, description={cardinality of $\mathcal{S}$}} % Main glossary definitions @@ -58,6 +60,8 @@ description={The number of elements in the specified set}} % Acronym definitions +\setacronymstyle{long-short} + \newacronym{zfc}{ZFC}{Zermelo-Fraenkel set theory} \newacronym{ad}{AD}{axiom of determinacy} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf Binary files differindex 185bfcd745e..b16f7690060 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex index ad1eb7bef16..26708ca37c3 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.tex @@ -3,42 +3,84 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleaccsupp +% +% Note that this document isn't fully accessible as it's not tagged. +% See the accessibility or tagpdf packages for examples of how to tag the document. \documentclass[a4paper]{article} -\usepackage[margin=0.5in]{geometry} -\usepackage{booktabs} +\usepackage[includemp,marginpar=1.5in,textwidth=5in]{geometry} +\usepackage{graphicx} +% use debug=showaccsupp to show replacement text in the margin \usepackage[acronym]{glossaries-accsupp} \makeglossaries -\newglossaryentry{dr}{name=Dr,description={Doctor},access={Doctor}} +\setacronymstyle{long-short} -\newacronym[shortaccess=S V M]{svm}{svm}{support vector machine} +% These will use 'ActualText' rather than 'E' because the +% abbreviation is in the 'name' field. +\newglossaryentry{Doctor}{name=Dr,description={Doctor},access={Doctor}} +\newglossaryentry{Drive}{name={Dr.},description={Drive},access={Drive}, + plural={Drvs}} + +% These will use 'E' \newacronym{eg}{e.g.}{for example} -\newcommand*{\samplerow}[1]{% - \gls{#1} & \gls{#1} & \acrshort{#1} & \acrlong{#1}\\ - \glsreset{#1}\Gls{#1} & \Gls{#1} & \Acrshort{#1} & \Acrlong{#1}\\ - \glsreset{#1}\GLS{#1} & \GLS{#1} & \ACRshort{#1} & \ACRlong{#1}\\ +\newacronym[shortaccess={TiKZ ist kein Zeichenprogramm}] +{tikz}{Ti\emph{k}Z}{Ti\emph{k}Z ist \emph{kein} Zeichenprogramm} + + +% The symbol key needs to use 'ActualText' but the replacement text +% needs to be supplied as the hexadecimal character code. + +\newcommand{\glssymbolaccsupp}[2]{% + \glsaccessibility[method=hex,unicode]{ActualText}{#1}{#2}% +} + +\newglossaryentry{int}{name={int},description={integral}, + symbol={\ensuremath{\int}},symbolaccess={222B} +} + +% The user1 key needs to use 'Alt': +\newcommand{\glsuseriaccsupp}[2]{% + \glsaccessibility{Alt}{#1}{#2}% +} + +\newglossaryentry{sampleimage}{name={sample image}, + description={an example image}, +% \protect is needed unless \glsnoexpandfields has been used + user1={\protect\includegraphics[height=20pt]{example-image}}, + user1access={a boilerplate image used in examples} } \begin{document} -\begin{center} -\begin{tabular}{lllll} -\toprule -\bfseries First & \bfseries Next & \bfseries Short & \bfseries Long -\\\midrule -\samplerow{dr} -\midrule -\samplerow{eg} -\midrule -\samplerow{svm} -\bottomrule -\end{tabular} -\end{center} +\section{General Terms} + +Testing general terms that are really abbreviations. + +\gls{Doctor} Smith lives at 2, Blueberry \gls{Drive} + +\section{Symbols and Images} + +Symbol: \glssymbol{int} (\gls{int}). + +Image: \glsuseri{sampleimage} (\gls{sampleimage}). + +\section{Abbreviations} + +First use: \gls{eg}, \gls{tikz}. + +Next use: \gls{eg}, \gls{tikz}. + +Short: \acrshort{eg}, \acrshort{tikz}. + +Long: \acrlong{eg}, \acrlong{tikz}. +Full: \acrfull{eg}, \acrfull{tikz}. \printglossaries \end{document} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf Binary files differindex 15a119ffc26..ea045bb0813 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex index 38fb336de7b..b261887d15c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleacronyms \documentclass{article} \usepackage[acronym,acronymlists={main,acronym2}]{glossaries} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf Binary files differindex 1d1e1dcc2e4..f884d9fd893 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex index 43c21518e46..dc8554504c8 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampletree \documentclass{report} \usepackage[colorlinks]{hyperref} @@ -13,6 +15,9 @@ \glssetwidest{Roman letters} % level 0 widest name \glssetwidest[1]{Sigma} % level 1 widest name +\setglossarypreamble{This is a contrived example to demonstrate the +alttreehypergroup style.} + \makeglossaries \newglossaryentry{greekletter}{name={Greek letters}, @@ -22,14 +27,12 @@ description={\nopostdesc}} \newglossaryentry{sigma}{name={Sigma}, text={\ensuremath{\Sigma}}, first={\ensuremath{\Sigma} (uppercase sigma)}, -symbol={\ensuremath{\Sigma}}, description={Used to indicate summation}, parent=greekletter} \newglossaryentry{pi}{name={pi}, text={\ensuremath{\pi}}, first={\ensuremath{\pi} (lowercase pi)}, -symbol={\ensuremath{\pi}}, description={Transcendental number}, parent=greekletter} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf Binary files differindex 93e155d97f5..155441d4fea 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex index 94deb79ef92..82f59420d71 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.tex @@ -3,6 +3,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sampleutf8 \documentclass{article} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf Binary files differindex 8db6ac5ddfb..69261d7c8b2 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex index 2effb0da1b9..08d407027e5 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex @@ -22,6 +22,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#sample \documentclass{article} \usepackage[utf8]{inputenc} @@ -45,7 +47,7 @@ % package for the dice commands): % \tallynum{n} displays a die or dice where the dots add up to n -\newrobustcmd{\tallynum}[1]{% +\newrobustcmd*{\tallynum}[1]{% \ifnum\number#1<7 $\csname dice\romannumeral#1\endcsname$% \else @@ -59,7 +61,7 @@ % a very specific format. (See the glossaries user manual for more % details.) -\newcommand{\tally}[1]{\tallynum{\arabic{page}}} +\newcommand*{\tally}[1]{\tallynum{\arabic{#1}}} % Now redefine \thepage % (\texorpdfstring is used in case the page number ends up in a PDF diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf Binary files differindex de19ce8acb5..854bf4e3c2c 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex index 6225fb4d9fb..867fe717fdf 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.tex @@ -13,6 +13,8 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#samplexdy2 \documentclass{report} \usepackage[utf8]{inputenc} diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf Binary files differindex b715c047b40..290f85b163a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf diff --git a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex index 8a28f1c3f91..0ef2694fd4a 100644 --- a/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex +++ b/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex @@ -22,7 +22,9 @@ % arara: pdflatex: { synctex: on } % arara: makeglossaries % arara: pdflatex: { synctex: on } - \documentclass{article} +% +%http://mirrors.ctan.org/macros/latex/contrib/glossaries/glossaries-user.html#samplexdy3 +\documentclass{article} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 index e94ad592dad..f411574cb1c 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 +++ b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES-LITE 1" -.TH MAKEGLOSSARIES-LITE 1 "2019-12-06" "perl v5.30.1" "makeglossaries-lite Lua Script" +.TH MAKEGLOSSARIES-LITE 1 "2020-02-14" "perl v5.30.1" "makeglossaries-lite Lua Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf Binary files differindex a6dbffa5ba5..8f8fa7a39c8 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries.1 b/Master/texmf-dist/doc/man/man1/makeglossaries.1 index c6f103fe49d..188483d548f 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries.1 +++ b/Master/texmf-dist/doc/man/man1/makeglossaries.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "MAKEGLOSSARIES 1" -.TH MAKEGLOSSARIES 1 "2019-12-06" "perl v5.30.1" "makeglossaries Perl Script" +.TH MAKEGLOSSARIES 1 "2020-02-14" "perl v5.30.1" "makeglossaries Perl Script" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf b/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf Binary files differindex abb300271c4..70f4473efb7 100644 --- a/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries b/Master/texmf-dist/scripts/glossaries/makeglossaries index d42214c5fff..fe1e1248d9b 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries @@ -2,7 +2,7 @@ # File : makeglossaries # Author : Nicola Talbot -# Version : 4.44 +# Version : 4.45 # Description: simple Perl script that calls makeindex or xindy. # Intended for use with "glossaries.sty" (saves having to remember # all the various switches) @@ -31,7 +31,7 @@ # glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl. # Also makeglossaries and makeglossaries-lite.lua. -my $version="4.44 (2019-12-06)"; +my $version="4.45 (2020-01-18)"; # History: # v4.43: @@ -1140,7 +1140,8 @@ sub makeindex{ # This is a subroutine in case of possible extension. # For example, what happens in the event of 'textbf' and 'emph'? # Should one override the other or be combined? Combining is harder -# as it would need a corresponding LaTeX command. +# as it would need a corresponding LaTeX command. (bib2gls deals +# with this better through its --map-formats switcn.) # 2.21 check for range encap moved earlier sub encap_overrides{ diff --git a/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua b/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua index 22b1c75147a..5e2272ff094 100755 --- a/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua +++ b/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua @@ -36,6 +36,8 @@ Also makeglossaries and makeglossaries-lite.lua. History: + * 4.45: + - no change. * 4.44: - no change. * 4.41: @@ -66,7 +68,7 @@ - changed first line from lua to texlua --]] -thisversion = "4.44 (2019-12-06)" +thisversion = "4.45 (2020-01-18)" quiet = false dryrun = false diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 37f589e208e..bd6811d3207 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -1,11 +1,11 @@ %\iffalse % glossaries.dtx generated using makedtx version 1.2 (c) Nicola Talbot % Command line args: -% -codetitle "Main Package Code" -% -doc "glossaries-manual.tex" % -section "chapter" -% -setambles ".*\.perl=>\nopreamble\nopostamble" -% -setambles ".*\.tex=>\nopreamble\nopostamble" +% -macrocode ".*\.perl" +% -macrocode ".*\.tex" +% -doc "glossaries-manual.tex" +% -codetitle "Main Package Code" % -author "Nicola Talbot" % -src "glossaries\.sty\Z=>glossaries.sty" % -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty" @@ -17,12 +17,12 @@ % -src "(glossaries-polyglossia)\.(sty)\Z=>\1.\2" % -src "(example-glossaries-.*\.tex)\Z=>\1" % -src "(.*\.perl)\Z=>\1" -% -macrocode ".*\.perl" -% -macrocode ".*\.tex" % -comment ".*\.perl" % -comment ".*\.tex" +% -setambles ".*\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" % glossaries -% Created on 2019/12/6 14:57 +% Created on 2020/2/14 0:32 %\fi %\iffalse %<*package> @@ -45,7 +45,7 @@ %\fi % \iffalse % Doc-Source file to use with LaTeX2e -% Copyright (C) 2019 Nicola Talbot, all rights reserved. +% Copyright (C) 2020 Nicola Talbot, all rights reserved. % \fi % \iffalse %<*driver> @@ -68,7 +68,7 @@ glossaries.dtx pdfauthor={Nicola L.C. Talbot}, pdftitle={glossaries.sty: LaTeX2e Package to Assist Generating Glossaries}, pdfkeywords={LaTeX,package,glossary,acronyms}]{hyperref} -\usepackage[toc]{glossaries} +\usepackage{glossaries-extra} \RecordChanges \setlength\IndexMin{100pt} @@ -136,7 +136,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{19669} +\CheckSum{20333} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -163,12 +163,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\fi %\MakeShortVerb{"} % -% \title{Documented Code For glossaries v4.44} +% \title{Documented Code For glossaries v4.45} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2019-12-06} +% \date{2020-02-13} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -184,7 +184,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.44: +%For the main user guide, read \qt{glossaries.sty v4.45: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -199,7 +199,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % %\item[CHANGES] Change log. % -%\item[README] Package summary. +%\item[README.md] Package summary. % %\end{description} % @@ -239,7 +239,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} %\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle} % Required packages: @@ -339,13 +339,15 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %\changes{4.24}{2016-05-27}{new} % Switch on debug mode. This will also cancel the \pkgopt{nowarn} % option. This is now a choice key. +%\changes{4.45}{2020-02-13}{added debug=showaccsupp} %\changes{4.41}{2018-07-23}{changed \cs{val} and \cs{nr} to %\cs{gls@debug@val} and \cs{gls@debug@nr}} % \begin{macrocode} \newif\if@gls@debug \define@choicekey{glossaries.sty}{debug}[\gls@debug@val\gls@debug@nr]% - {true,false,showtargets}[true]{% + {true,false,showtargets,showaccsupp}[true]{% \ifcase\gls@debug@nr\relax + % debug=true \@gls@debugtrue \renewcommand*{\GlossariesWarning}[1]{% \PackageWarning{glossaries}{##1}% @@ -356,10 +358,24 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \let\@glsshowtarget\@gobble \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% \or + % debug=false \@gls@debugfalse \let\@glsshowtarget\@gobble + \let\@glsshowaccsupp\@gobblethree \PackageInfo{glossaries}{debug mode OFF}% \or + % debug=showtargets + \@gls@debugtrue + \renewcommand*{\GlossariesWarning}[1]{% + \PackageWarning{glossaries}{##1}% + }% + \renewcommand*{\GlossariesWarningNoLine}[1]{% + \PackageWarningNoLine{glossaries}{##1}% + }% + \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% + \renewcommand{\@glsshowtarget}{\@@glsshowtarget}% + \or + % debug=showaccsupp \@gls@debugtrue \renewcommand*{\GlossariesWarning}[1]{% \PackageWarning{glossaries}{##1}% @@ -368,7 +384,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \PackageWarningNoLine{glossaries}{##1}% }% \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% - \renewcommand{\@glsshowtarget}{\glsshowtarget}% + \renewcommand{\@glsshowaccsupp}{\glsshowaccsupp}% \fi } % \end{macrocode} @@ -381,17 +397,44 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % \begin{macrocode} \newcommand*{\glsshowtarget}[1]{% \ifmmode - \nfss@text{\ttfamily\small [#1]}% + \nfss@text{\glsshowtargetfont [#1]}% \else \ifinner - \texttt{\small [#1]}% +% \end{macrocode} +% Grouping no longer required as new \cs{@@glsshowtarget} adds +% scoping but retained here in case any existing documents are using +% \cs{glsshowtarget} elsewhere. +% \begin{macrocode} + {\glsshowtargetfont [#1]}% \else - \marginpar{\texttt{\small #1}}% + \glsshowtargetouter{#1}% \fi \fi } % \end{macrocode} %\end{macro} +%\begin{macro}{\glsshowtargetouter} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsshowtargetouter}[1]{% + \glsshowtargetsymbol\marginpar{\glsshowtargetsymbol\glsshowtargetfont #1}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsshowtargetsymbol} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsshowtargetsymbol}{{\tiny$\triangleright$}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsshowtargetfont} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsshowtargetfont}{\ttfamily\footnotesize} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\@glsshowtarget} %\changes{4.32}{2017-08-24}{new} %\pkgopt[showtargets]{debug} will redefine this. @@ -400,6 +443,42 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % \end{macrocode} %\end{macro} % +%\begin{macro}{\@@glsshowtarget} +%\changes{4.45}{2020-02-13}{new} +%Need to detokenize the label in the event that it contains awkward +%characters like underscores. +% \begin{macrocode} +\newrobustcmd*{\@@glsshowtarget}[1]{% + \begingroup + \protected@edef\@gls@tmp{#1}% + \@onelevel@sanitize\@gls@tmp + \expandafter\glsshowtarget\expandafter{\@gls@tmp}% + \endgroup +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsshowaccsupp} +%\changes{4.45}{2020-02-13}{new} +%\pkgopt[showaccsupp]{debug} will redefine this. +% \begin{macrocode} +\newcommand*{\@glsshowaccsupp}[3]{} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsshowaccsupp} +%\changes{4.45}{2020-02-13}{new} +%Just use \cs{@@glsshowtarget} since it basically needs to do the +%same thing. +% \begin{macrocode} +\newrobustcmd*{\glsshowaccsupp}[3]{% + \ifstrempty{#1}% + {\@@glsshowtarget{/#2 (#3)}}% + {\@@glsshowtarget{/#2 (#3) [#1]}}% +} +% \end{macrocode} +%\end{macro} +% %Determine what to do if the \gloskey{see} key is used before %\cs{makeglossaries}. The default is to produce an error. %\begin{macro}{\@gls@see@noindex} @@ -1289,7 +1368,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \begin{macrocode} \@gls@declareoption{acronyms}{% \glsacronymtrue - \renewcommand{\@gls@do@acronymsdef}{% +% \end{macrocode} +%\changes{4.45}{2020-02-13}{changed \cs{renewcommand} to \cs{def}} +% \begin{macrocode} + \def\@gls@do@acronymsdef{% \DeclareAcronymList{acronym}% \newglossary[alg]{acronym}{acr}{acn}{\acronymname}% \renewcommand*{\acronymtype}{acronym}% @@ -1353,9 +1435,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \begin{macrocode} \newcommand{\@gls@islistofacronyms}[4]{% \def\gls@islistofacronyms##1,#1,##2\end@gls@islistofacronyms{% - \def\@before{##1}\def\@after{##2}}% + \def\@gls@before{##1}\def\@gls@after{##2}}% \gls@islistofacronyms,#2,#1,\@nil\end@gls@islistofacronyms - \ifx\@after\@nnil + \ifx\@gls@after\@nnil % \end{macrocode} % Not found % \begin{macrocode} @@ -2243,6 +2325,100 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{option} % +%\begin{macro}{\@domakeglossaries} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\providecommand{\@domakeglossaries}[1]{#1} +% \end{macrocode} +%\end{macro} +% +%\begin{option}{disablemakegloss} +%\changes{4.45}{2020-02-13}{new} +%Provide a way of disabling \cs{makeglossaries}. For example, if a +%class or package explicitly uses \cs{makeglossaries}. This is a +%valueless option to allow it to be passed through the document +%class option list. +% \begin{macrocode} +\@gls@declareoption{disablemakegloss}{% + \ifdefequal\makeglossaries\@no@makeglossaries + {% + \GlossariesWarning{Option `disablemakegloss' has no effect + (\string\makenoidxglossaries\space has already been used)}% + }% + {% + \ifdefequal\@makeglossary\@gobble + {% + \GlossariesWarning{Option `disablemakegloss' has no effect + (\string\makeglossaries\space has already been used)}% + }% + {% + \renewcommand{\@domakeglossaries}[1]{% + \PackageInfo{glossaries}{\string\makeglossaries\space and + \string\makenoidxglossaries\space have been disabled}% + }% + }% + }% +} +% \end{macrocode} +%\end{option} +%\begin{option}{restoremakegloss} +%\changes{4.45}{2020-02-13}{new} +%Cancel the effect of \pkgopt{disablemakegloss}. +% \begin{macrocode} +\@gls@declareoption{restoremakegloss}{% + \ifdefequal\makeglossaries\@no@makeglossaries + {% + \GlossariesWarning{Option `restoremakegloss' has no effect + (\string\makenoidxglossaries\space has already been used)}% + }% + {% + \ifdefequal\@makeglossary\@gobble + {% + \GlossariesWarning{Option `restoremakegloss' has no effect + (\string\makeglossaries\space has already been used)}% + }% + {% + \PackageInfo{glossaries}{\string\makeglossaries\space and + \string\makenoidxglossaries\space have been restored}% + \let\@domakeglossaries\@firstofone + }% + }% +} +% \end{macrocode} +%\end{option} +% +%\begin{macro}{\@do@write@glslabels} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\@do@write@glslabels}{% + \AtEndDocument{\@@do@write@glslabels}% + \let\@do@write@glslabels\relax +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@@do@write@glslabels} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\@@do@write@glslabels}{% + \newwrite\@gls@labelsfile + \immediate\openout\@gls@labelsfile=\jobname.glslabels + \forallglsentries[\@glo@types,\@ignored@glossaries]{\@glsentry}% + {\ifdefempty{\@glsentry}{}{\immediate\write\@gls@labelsfile{\@glsentry}}}% + \immediate\closeout\@gls@labelsfile +} +% \end{macrocode} +%\end{macro} +% +%\begin{option}{writeglslabels} +%\changes{4.45}{2020-02-13}{new} +%This option will write all entry labels (including those in ignored +%glossaries) to the file \cs{jobname}\texttt{.glslabels}. This file +%may be used by text editors for label auto-completion. +% \begin{macrocode} +\@gls@declareoption{writeglslabels}{\@do@write@glslabels} +% \end{macrocode} +%\end{option} %\begin{macro}{\ifglsautomake} %\changes{4.42}{2019-01-06}{now defined explicitly instead of through %boolean key} @@ -4292,11 +4468,18 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\end{macro} % %\begin{macro}{\ifglshaschildren} -% \cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} +%\begin{definition} +%\cs{ifglshaschildren}\marg{label}\marg{true part}\marg{false part} +%\end{definition} +%This is inefficient as it has to search through all entries to find +%out which ones have the given entry as its parent. It's much easier +%to use \app{bib2gls} and get it to store the list of children that +%have been indexed (which is likely to be more useful). %\changes{3.02}{2012-05-21}{new} %\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +%\changes{4.45}{2020-02-13}{made robust} % \begin{macrocode} -\newcommand{\ifglshaschildren}[3]{% +\newrobustcmd{\ifglshaschildren}[3]{% \glsdoifexists{#1}% {% \def\do@glshaschildren{#3}% @@ -4376,8 +4559,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} %\changes{4.03}{2014-01-20}{replaced \cs{ifcsempty} with %\cs{ifdefempty} and replaced \cs{ifx} with \cs{ifdefequal}} +%\changes{4.45}{2020-02-13}{made robust} % \begin{macrocode} -\newcommand*{\ifglshassymbol}[3]{% +\newrobustcmd*{\ifglshassymbol}[3]{% \letcs{\@glo@symbol}{glo@\glsdetoklabel{#1}@symbol}% \ifdefempty\@glo@symbol {#3}% @@ -4394,8 +4578,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\cs{ifglshaslong}\marg{label}\marg{true part}\marg{false part} %\changes{3.11a}{2013-10-15}{new} %\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +%\changes{4.45}{2020-02-13}{made robust} % \begin{macrocode} -\newcommand*{\ifglshaslong}[3]{% +\newrobustcmd*{\ifglshaslong}[3]{% \letcs{\@glo@long}{glo@\glsdetoklabel{#1}@long}% \ifdefempty\@glo@long {#3}% @@ -4412,8 +4597,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\cs{ifglshasshort}\marg{label}\marg{true part}\marg{false part} %\changes{3.11a}{2013-10-15}{new} %\changes{4.03}{2014-01-20}{added \cs{glsdetoklabel}} +%\changes{4.45}{2020-02-13}{made robust} % \begin{macrocode} -\newcommand*{\ifglshasshort}[3]{% +\newrobustcmd*{\ifglshasshort}[3]{% \letcs{\@glo@short}{glo@\glsdetoklabel{#1}@short}% \ifdefempty\@glo@short {#3}% @@ -4432,8 +4618,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\cs{ifglshasfield}\marg{field}\marg{label}\marg{true part}\marg{false %part} %\end{definition} +%\changes{4.45}{2020-02-13}{made robust} % \begin{macrocode} -\newcommand*{\ifglshasfield}[4]{% +\newrobustcmd*{\ifglshasfield}[4]{% \glsdoifexists{#2}% {% \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@#1}% @@ -11467,6 +11654,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% \ifglshaslong{#1}% {% \letcs\@glo@text{glo@\glsdetoklabel{#1}@name}% +% \end{macrocode} +%\cs{@gls@getbody} is defined by \sty{mfirstuc} (which used to be +%part of \styfmt{glossaries}). +% \begin{macrocode} \expandafter\@gls@getbody\@glo@text{}\@nil \expandafter\ifx\@gls@body\glsentrylong\relax \expandafter\Glsentrylong\@gls@rest @@ -11487,7 +11678,17 @@ false,nolabel,autolabel,nameref}[nolabel]{% \@glo@text }% \else - \xmakefirstuc{\@glo@text}% +% \end{macrocode} +%\changes{4.45}{2020-02-13}{added check for \cs{glsshortaccessdisplay}} +% \begin{macrocode} + \expandafter\ifx\@gls@body\glsshortaccessdisplay\relax + {% + \let\glsentryshort\Glsentryshort + \@glo@text + }% + \else + \xmakefirstuc{\@glo@text}% + \fi \fi \fi \fi @@ -11650,10 +11851,14 @@ false,nolabel,autolabel,nameref}[nolabel]{% % %\begin{macro}{\glsentrytitlecase} %\changes{4.22}{2016-04-19}{new} +%\changes{4.45}{2020-02-13}{added existence check} % \begin{macrocode} \newrobustcmd*{\@glsentrytitlecase}[2]{% - \glsfieldfetch{#1}{#2}{\@gls@value}% - \xcapitalisewords{\@gls@value}% + \glsdoifexists{#1}% + {% + \glsfieldfetch{#1}{#2}{\@gls@value}% + \xcapitalisewords{\@gls@value}% + }% } \ifdef\texorpdfstring { @@ -11689,6 +11894,16 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsentryparent} +%Expands to the label of the entry's parent. +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryparent}[1]{% + \@gls@entry@field{#1}{parent}% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glsentryuseri} % Get the first user key (as specified by the % \gloskey{user1} when the entry was defined). The argument @@ -12879,11 +13094,11 @@ false,nolabel,autolabel,nameref}[nolabel]{% % style file). % % Note that you can't use \cs{@makeglossary} for only some of the -% defined glossaries. You either need to have a \cs{makeglossary} -% for all glossaries or none (otherwise you will end up with a -% situation where \TeX\ is trying to write to a non-existant -% file). The relevant glossary must be -% defined prior to using \cs{@makeglossary}. +% defined glossaries (with just the base \styfmt{glossaries} package). You either need +% to have a \cs{makeglossaries} for all glossaries or none (otherwise +% you will end up with a situation where \TeX\ is trying to write to a non-existant +% file). The relevant glossary must be defined prior to using \cs{@makeglossary}. +% \sty{glossaries-extra} allows for a hybrid approach. %\begin{macro}{\@makeglossary} % \begin{macrocode} \newcommand*{\@makeglossary}[1]{% @@ -13084,6 +13299,8 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\begin{macro}{\makeglossaries} % \begin{macrocode} \newcommand*{\makeglossaries}{% + \@domakeglossaries + {% % \end{macrocode} %If automake=immediate setting is on, use the shell escape now. % \begin{macrocode} @@ -13142,8 +13359,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% % implements \cs{makeglossaries} or has been restored to its original % definition (in which case it shouldn't be changed). %\changes{4.41}{2018-07-23}{removed redefinition of \cs{makeglossary}} +%\changes{4.45}{2020-02-13}{let \cs{@makeglossary} to \cs{@gobble} +%instead of \cs{relax}} % \begin{macrocode} - \let\@makeglossary\relax + \let\@makeglossary\@gobble \let\makeglossaries\relax % \end{macrocode} % Disable all commands that have no effect after \cs{makeglossaries} @@ -13207,6 +13426,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % Check the sort setting: % \begin{macrocode} \@glo@check@sortallowed\makeglossaries + }% } % \end{macrocode} %\changes{4.02}{2013-13-05}{made preamble only} @@ -13236,6 +13456,8 @@ false,nolabel,autolabel,nameref}[nolabel]{% % needed for \cs{printnoidxglossary} % \begin{macrocode} \newcommand*{\makenoidxglossaries}{% + \@domakeglossaries + {% % \end{macrocode} % Redefine empty glossary warning: % \begin{macrocode} @@ -13405,6 +13627,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % Check sort option allowed. % \begin{macrocode} \@glo@check@sortallowed\makenoidxglossaries + }% } % \end{macrocode} % Preamble-only command: @@ -14176,8 +14399,9 @@ you %\cs{glssee}\marg{label}\marg{cross-ref list} %\changes{1.17}{2008-12-26}{new} %\changes{3.08a}{2013-09-28}{made robust} +%\changes{4.45}{2020-02-13}{switched to \cs{newrobustcmd}} % \begin{macrocode} -\DeclareRobustCommand*{\glssee}[3][\seename]{% +\newrobustcmd*{\glssee}[3][\seename]{% \@do@seeglossary{#2}{[#1]{#3}}} \newcommand*{\@glssee}[3][\seename]{% \glssee[#1]{#3}{#2}} @@ -14190,16 +14414,18 @@ you % The first argument specifies what tag to use (e.g.\ ``see''), % the second argument is a comma-separated list of labels. % The final argument (the location) is ignored. +%\changes{4.45}{2020-02-13}{switched to \cs{newrobustcmd}} % \begin{macrocode} -\DeclareRobustCommand*{\glsseeformat}[3][\seename]{% +\newrobustcmd*{\glsseeformat}[3][\seename]{% \emph{#1} \glsseelist{#2}} % \end{macrocode} %\end{macro} %\begin{macro}{\glsseelist} %\cs{glsseelist}\marg{list} formats list of entry labels. %\changes{3.08a}{2013-09-28}{made robust} +%\changes{4.45}{2020-02-13}{switched to \cs{newrobustcmd}} % \begin{macrocode} -\DeclareRobustCommand*{\glsseelist}[1]{% +\newrobustcmd*{\glsseelist}[1]{% % \end{macrocode} % If there is only one item in the list, set the last separator % to do nothing. @@ -14257,8 +14483,9 @@ you %\changes{3.0}{2011-04-02}{hyperlink uses \cs{glsseeitemformat} instead %of \cs{glsentryname}} %\changes{3.08a}{2013-09-28}{made robust} +%\changes{4.45}{2020-02-13}{switched to \cs{newrobustcmd}} % \begin{macrocode} -\DeclareRobustCommand*{\glsseeitem}[1]{\glshyperlink[\glsseeitemformat{#1}]{#1}} +\newrobustcmd*{\glsseeitem}[1]{\glshyperlink[\glsseeitemformat{#1}]{#1}} % \end{macrocode} %\end{macro} %\begin{macro}{\glsseeitemformat} @@ -19187,7 +19414,7 @@ you % \cs{gls}\marg{label}} on subsequent use. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Pass all options to \sty{glossaries}: % \begin{macrocode} @@ -19250,55 +19477,64 @@ you % % Define commands to access these fields: %\begin{macro}{\glsentryprefixfirst} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} -\newcommand*{\glsentryprefixfirst}[1]{\csuse{glo@#1@prefixfirst}} +\newcommand*{\glsentryprefixfirst}[1]{\csuse{glo@\glsdetoklabel{#1}@prefixfirst}} % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryprefixfirstplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} -\newcommand*{\glsentryprefixfirstplural}[1]{\csuse{glo@#1@prefixfirstplural}} +\newcommand*{\glsentryprefixfirstplural}[1]{% + \csuse{glo@\glsdetoklabel{#1}@prefixfirstplural}} % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryprefix} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} -\newcommand*{\glsentryprefix}[1]{\csuse{glo@#1@prefix}} +\newcommand*{\glsentryprefix}[1]{\csuse{glo@\glsdetoklabel{#1}@prefix}} % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryprefixplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} -\newcommand*{\glsentryprefixplural}[1]{\csuse{glo@#1@prefixplural}} +\newcommand*{\glsentryprefixplural}[1]{\csuse{glo@\glsdetoklabel{#1}@prefixplural}} % \end{macrocode} %\end{macro} % % Now for the initial upper case variants: %\begin{macro}{\Glsentryprefixfirst} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newrobustcmd*{\Glsentryprefixfirst}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixfirst\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixfirst\endcsname}% \xmakefirstuc\@glo@text } % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryprefixfirstplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newrobustcmd*{\Glsentryprefixfirstplural}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixfirstplural\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixfirstplural\endcsname}% \xmakefirstuc\@glo@text } % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryprefix} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newrobustcmd*{\Glsentryprefix}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefix\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefix\endcsname}% \xmakefirstuc\@glo@text } % \end{macrocode} %\end{macro} %\begin{macro}{\Glsentryprefixplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newrobustcmd*{\Glsentryprefixplural}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixplural\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixplural\endcsname}% \xmakefirstuc\@glo@text } % \end{macrocode} @@ -19306,36 +19542,40 @@ you % % Define commands to determine if the prefix keys have been set: %\begin{macro}{\ifglshasprefix} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasprefix}[3]{% - \ifcsempty{glo@#1@prefix}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefix}% {#3}% {#2}% } % \end{macrocode} %\end{macro} %\begin{macro}{\ifglshasprefixplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasprefixplural}[3]{% - \ifcsempty{glo@#1@prefixplural}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixplural}% {#3}% {#2}% } % \end{macrocode} %\end{macro} %\begin{macro}{\ifglshasprefixfirst} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasprefixfirst}[3]{% - \ifcsempty{glo@#1@prefixfirst}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixfirst}% {#3}% {#2}% } % \end{macrocode} %\end{macro} %\begin{macro}{\ifglshasprefixfirstplural} +%\changes{4.45}{2020-02-13}{added \cs{glsdetoklabel}} % \begin{macrocode} \newcommand*{\ifglshasprefixfirstplural}[3]{% - \ifcsempty{glo@#1@prefixfirstplural}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixfirstplural}% {#3}% {#2}% } @@ -19356,6 +19596,14 @@ you % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsprefixsep} +%\changes{4.45}{2020-02-13}{new} +%Separator between prefix and term. Does nothing by default. +% \begin{macrocode} +\newcommand{\glsprefixsep}{} +% \end{macrocode} +%\end{macro} +% % Define commands that insert the prefix before commands like \ics{gls}: %\begin{macro}{\pgls} %\changes{4.08}{2014-07-30}{changed to use \cs{@gls@hyp@opt}} @@ -19384,10 +19632,10 @@ you {% \ifglsused{#2}% {% - \glsentryprefix{#2}% + \ifglshasprefix{#2}{\glsentryprefix{#2}\glsprefixsep}{}% }% {% - \glsentryprefixfirst{#2}% + \ifglshasprefixfirst{#2}{\glsentryprefixfirst{#2}\glsprefixsep}{}% }% \@gls@{#1}{#2}[#3]% }% @@ -19423,10 +19671,11 @@ you {% \ifglsused{#2}% {% - \glsentryprefixplural{#2}% + \ifglshasprefixplural{#2}{\glsentryprefixplural{#2}\glsprefixsep}{}% }% {% - \glsentryprefixfirstplural{#2}% + \ifglshasprefixfirstplural{#2}% + {\glsentryprefixfirstplural{#2}\glsprefixsep}{}% }% \@glspl@{#1}{#2}[#3]% }% @@ -19465,6 +19714,7 @@ you \ifglshasprefix{#2}% {% \Glsentryprefix{#2}% + \glsprefixsep \@gls@{#1}{#2}[#3]% }% {\@Gls@{#1}{#2}[#3]}% @@ -19473,6 +19723,7 @@ you \ifglshasprefixfirst{#2}% {% \Glsentryprefixfirst{#2}% + \glsprefixsep \@gls@{#1}{#2}[#3]% }% {\@Gls@{#1}{#2}[#3]}% @@ -19513,6 +19764,7 @@ you \ifglshasprefixplural{#2}% {% \Glsentryprefixplural{#2}% + \glsprefixsep \@glspl@{#1}{#2}[#3]% }% {\@Glspl@{#1}{#2}[#3]}% @@ -19521,6 +19773,7 @@ you \ifglshasprefixfirstplural{#2}% {% \Glsentryprefixfirstplural{#2}% + \glsprefixsep \@glspl@{#1}{#2}[#3]% }% {\@Glspl@{#1}{#2}[#3]}% @@ -19558,10 +19811,12 @@ you {% \ifglsused{#2}% {% - \mfirstucMakeUppercase{\glsentryprefix{#2}}% + \ifglshasprefix{#2}% + {\mfirstucMakeUppercase{\glsentryprefix{#2}\glsprefixsep}}{}% }% {% - \mfirstucMakeUppercase{\glsentryprefixfirst{#2}}% + \ifglshasprefixfirst{#2}% + {\mfirstucMakeUppercase{\glsentryprefixfirst{#2}\glsprefixsep}}{}% }% \@GLS@{#1}{#2}[#3]% }% @@ -19597,10 +19852,12 @@ you {% \ifglsused{#2}% {% - \mfirstucMakeUppercase{\glsentryprefixplural{#2}}% + \ifglshasprefixplural{#2}% + {\mfirstucMakeUppercase{\glsentryprefixplural{#2}\glsprefixsep}}{}% }% {% - \mfirstucMakeUppercase{\glsentryprefixfirstplural{#2}}% + \ifglshasprefixfirstplural{#2}% + {\mfirstucMakeUppercase{\glsentryprefixfirstplural{#2}\glsprefixsep}}{}% }% \@GLSpl@{#1}{#2}[#3]% }% @@ -19622,7 +19879,7 @@ you %\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} -\ProvidesPackage{glossary-hypernav}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % % The commands defined in this package are provided to @@ -19632,8 +19889,9 @@ you % set \cs{@glo@type} to the label of the current % glossary. This is used to create a unique hypertarget in % the event of multiple glossaries. -%\\[10pt] -% \cs{glsnavhyperlink}\oarg{type}\marg{label}\marg{text}\\[10pt] +%\begin{definition} +% \cs{glsnavhyperlink}\oarg{type}\marg{label}\marg{text} +%\end{definition} % This command makes \meta{text} a hyperlink to the glossary group % whose label is given by \meta{label} for the glossary given % by \meta{type}. @@ -19655,14 +19913,16 @@ you \newcommand*{\glsnavhyperlinkname}[2]{glsn:#1@#2} % \end{macrocode} %\end{macro} -%\vskip5pt -% \cs{glsnavhypertarget}\oarg{type}\marg{label}\marg{text}\\[10pt] +% +%\begin{macro}{\glsnavhypertarget} +%\begin{definition} +% \cs{glsnavhypertarget}\oarg{type}\marg{label}\marg{text} +%\end{definition} % This command makes \meta{text} a hypertarget for the glossary group % whose label is given by \meta{label} in the glossary given % by \meta{type}. If \meta{type} is omitted, \cs{@glo@type} is % used which is set by \ics{printglossary} to the current % glossary label. -%\begin{macro}{\glsnavhypertarget} %\changes{1.14}{2008-06-17}{added write to aux file} %\changes{1.15}{2008-08-15}{added check if rerun required} %\changes{1.17}{2008-12-26}{replaced \cs{hypertarget} to @@ -19815,7 +20075,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/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-inline}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % %\begin{style}{inline} @@ -20006,7 +20266,7 @@ you % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-list}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} %\begin{macro}{\indexspace} %\changes{4.13}{2015-02-03}{new} @@ -20288,7 +20548,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/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-long}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} @@ -20785,7 +21045,7 @@ you % \url{http://tex.stackexchange.com/a/56890} % % \begin{macrocode} -\ProvidesPackage{glossary-longbooktabs}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Requires \sty{booktabs} package: % \begin{macrocode} @@ -21126,7 +21386,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/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-longragged}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -21559,7 +21819,7 @@ you %use the \sty{multicol} package. These use the tree-like glossary %styles in a multicol environment. % \begin{macrocode} -\ProvidesPackage{glossary-mcols}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-mcols}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -21996,7 +22256,7 @@ you % The glossary styles defined in the \isty{glossary-super} package % use the \env{supertabular} environment. % \begin{macrocode} -\ProvidesPackage{glossary-super}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-super}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} @@ -22528,7 +22788,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/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-superragged}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -22968,7 +23228,7 @@ you % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-tree}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % %\begin{macro}{\indexspace} @@ -23689,7 +23949,7 @@ you % hyperlinks may not work properly. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} %\begin{macro}{\GlsAddXdyAttribute} % Adds an attribute in old format. @@ -24050,7 +24310,7 @@ you %\section{glossaries-compatible-307} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % % Compatibility macros for predefined glossary styles: @@ -24858,7 +25118,7 @@ you % \end{macrocode} % Package version number now in line with main glossaries package number. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2019/12/06 v4.44 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2020/02/13 v4.45 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -24936,8 +25196,54 @@ you % Required packages: % \begin{macrocode} \RequirePackage{glossaries} -\RequirePackage{accsupp} % \end{macrocode} +% +%\begin{macro}{\gls@accsupp@engine} +%\changes{4.45}{2020-02-13}{new} +%There's currently only support for \sty{accsupp}, but if you +%define \cs{gls@accsupp@engine} before loading +%\sty{glossaries-accsupp}, you can prevent \sty{accsupp} from being +%loaded. Redefining this command after \sty{glossaries-accsupp} has loaded +%obviously won't do anything (and so is an internal command to +%deter casual use). If it is defined to something other than +%"accsupp" then \cs{gls@accessibility} will need to be defined to +%something appropriate. +% \begin{macrocode} +\providecommand{\gls@accsupp@engine}{accsupp} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\gls@accessibility} +%\changes{4.45}{2020-02-13}{new} +%\begin{definition} +%\cs{gls@accessibility}\marg{options}\marg{PDF element}\marg{value}\marg{content} +%\end{definition} +% \begin{macrocode} +\providecommand{\gls@accessibility}[4]{#4} +\ifdefstring\gls@accsupp@engine{accsupp} +{ + \RequirePackage{accsupp} + \renewcommand{\gls@accessibility}[4]{% + \BeginAccSupp{#1,#2={#3}}#4\EndAccSupp{}% + } +} +{} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsaccessibility} +%\changes{4.45}{2020-02-13}{new} +%\begin{definition} +%\cs{glsaccessibility}\oarg{options}\marg{PDF element}\marg{value}\marg{content} +%\end{definition} +%User-level command that includes debug info if required. +% \begin{macrocode} +\newcommand{\glsaccessibility}[4][]{% + \@glsshowaccsupp{#1}{#2}{#3}% + \gls@accessibility{#1}{#2}{#3}{#4}% +} +% \end{macrocode} +%\end{macro} % %\section{Defining Replacement Text} % The version 0.1 stored the replacement text in the @@ -25050,10 +25356,69 @@ you } % \end{macrocode} %\end{key} -% There are no equivalent keys for the \gloskey{user1}\ldots -%\gloskey{user6} keys. The replacement text would have to be +%There are now also keys that correspond to the user keys: +%\begin{key}{user1access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user1} key: +% \begin{macrocode} +\define@key{glossentry}{user1access}{% + \def\@glo@useriaccess{#1}% +} +% \end{macrocode} +%\end{key} +%\begin{key}{user2access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user2} key: +% \begin{macrocode} +\define@key{glossentry}{user2access}{% + \def\@glo@useriiaccess{#1}% +} +% \end{macrocode} +%\end{key} +% +%\begin{key}{user3access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user3} key: +% \begin{macrocode} +\define@key{glossentry}{user3access}{% + \def\@glo@useriiiaccess{#1}% +} +% \end{macrocode} +%\end{key} +% +%\begin{key}{user4access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user4} key: +% \begin{macrocode} +\define@key{glossentry}{user4access}{% + \def\@glo@userivaccess{#1}% +} +% \end{macrocode} +%\end{key} +% +%\begin{key}{user5access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user5} key: +% \begin{macrocode} +\define@key{glossentry}{user5access}{% + \def\@glo@uservaccess{#1}% +} +% \end{macrocode} +%\end{key} +% +%\begin{key}{user6access} +%\changes{4.45}{2020-02-13}{new} +% The replacement text corresponding to the \gloskey{user6} key: +% \begin{macrocode} +\define@key{glossentry}{user6access}{% + \def\@glo@userviaccess{#1}% +} +% \end{macrocode} +%\end{key} +% +% For any custom keys, the replacement text would have to be % explicitly put in the value, e.g., -% "user1={\glsaccsupp{inches}{in}}". +% "user1={\glsshortaccsupp{inches}{in}}". % % Append these new keys to \cs{@gls@keymap}: % \begin{macrocode} @@ -25070,7 +25435,13 @@ you {shortaccess}{shortaccess},% {shortpluralaccess}{shortpluralaccess},% {longaccess}{longaccess},% - {longpluralaccess}{longpluralaccess}% + {longpluralaccess}{longpluralaccess},% + {user1access}{useriaccess},% + {user2access}{useriiaccess},% + {user3access}{useriiiaccess},% + {user4access}{userivaccess},% + {user5access}{uservaccess},% + {user6access}{userviaccess}% } % \end{macrocode} % @@ -25081,14 +25452,18 @@ you % \end{macrocode} %\end{macro} % -% Add to the start hook (the \gloskey{access} key is initialised to +% Previously, the \gloskey{access} key was initialised to % the value of the \gloskey{symbol} key at the start for backwards -% compatibility): +% compatibility. This causes a problem for situations where the +% replacement text is provided for \gloskey{symbol} but not for +% \gloskey{name} so this behaviour has been removed. +%\changes{4.45}{2020-02-13}{removed backward compatibility use of +%symbol key} % \begin{macrocode} \let\@gls@oldnewglossaryentryprehook\@newglossaryentryprehook \renewcommand*{\@newglossaryentryprehook}{% \@gls@oldnewglossaryentryprehook - \def\@glo@access{\@glo@symbol}% + \def\@glo@access{\relax}% % \end{macrocode} % Initialise the other keys: % \begin{macrocode} @@ -25104,6 +25479,12 @@ you \def\@glo@shortpluralaccess{\@glo@shortaccess}% \def\@glo@longaccess{\relax}% \def\@glo@longpluralaccess{\@glo@longaccess}% + \def\@glo@useriaccess{\relax}% + \def\@glo@useriiaccess{\relax}% + \def\@glo@useriiiaccess{\relax}% + \def\@glo@userivaccess{\relax}% + \def\@glo@uservaccess{\relax}% + \def\@glo@userviaccess{\relax}% } % \end{macrocode} % Add to the end hook: @@ -25153,6 +25534,24 @@ you \expandafter \protected@xdef\csname glo@\@glo@label @longpluralaccess\endcsname{% \@glo@longpluralaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriaccess\endcsname{% + \@glo@useriaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriiaccess\endcsname{% + \@glo@useriiaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriiiaccess\endcsname{% + \@glo@useriiiaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @userivaccess\endcsname{% + \@glo@userivaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @uservaccess\endcsname{% + \@glo@uservaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @userviaccess\endcsname{% + \@glo@userviaccess}% } % \end{macrocode} % @@ -25198,11 +25597,12 @@ you % \end{macrocode} %\end{macro} %\begin{macro}{\glsentryfirstpluralaccess} +%\changes{4.45}{2020-02-13}{switched to using \cs{@gls@entry@field}} % Get the value of the \gloskey{firstpluralaccess} key for the entry with % the given label: % \begin{macrocode} \newcommand*{\glsentryfirstpluralaccess}[1]{% - \csname glo@#1@firstpluralaccess\endcsname + \@gls@entry@field{#1}{firstpluralaccess}% } % \end{macrocode} %\end{macro} @@ -25240,9 +25640,10 @@ you % Get the value of the \gloskey{descriptionpluralaccess} key for the entry with % the given label: %\changes{4.03}{2014-01-20}{switched to using \cs{@gls@entry@field}} +%\changes{4.45}{2020-02-13}{corrected field reference} % \begin{macrocode} \newcommand*{\glsentrydescpluralaccess}[1]{% - \@gls@entry@field{#1}{descaccess}% + \@gls@entry@field{#1}{descpluralaccess}% } % \end{macrocode} %\end{macro} @@ -25288,18 +25689,163 @@ you % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsentryuseriaccess} +% Get the value of the \gloskey{user1access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuseriaccess}[1]{% + \@gls@entry@field{#1}{useriaccess}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentryuseriiaccess} +% Get the value of the \gloskey{user2access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuseriiaccess}[1]{% + \@gls@entry@field{#1}{useriiaccess}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentryuseriiiaccess} +% Get the value of the \gloskey{user3access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuseriiiaccess}[1]{% + \@gls@entry@field{#1}{useriiiaccess}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentryuserivaccess} +% Get the value of the \gloskey{user4access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuserivaccess}[1]{% + \@gls@entry@field{#1}{userivaccess}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentryuservaccess} +% Get the value of the \gloskey{user5access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuservaccess}[1]{% + \@gls@entry@field{#1}{uservaccess}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsentryuserviaccess} +% Get the value of the \gloskey{user6access} key for the entry with +% the given label: +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\glsentryuserviaccess}[1]{% + \@gls@entry@field{#1}{userviaccess}% +} +% \end{macrocode} +%\end{macro} +% +%There are three types of replacement text: +%\begin{description} +%\item[Alt] Description of some content that's non-textual (for +%example, an image). A word break is assumed after the content. +%\item[ActualText] A character or sequence of characters that +%replaces textual content (for example, a dropped capital, a +%ligature or a symbol). No word break is assumed after the content. +%\item[E] Expansion of an abbreviation to avoid ambiguity (for +%example, ``St'' could be short for ``saint'' or ``street''). +%\end{description} +%Therefore, rather than having one command for all fields, it's +%better to have a command dependent on the field type. For example, +%the \gloskey{short} and \gloskey{shortpl} keys would require "E", +%the \gloskey{symbol} key would require "ActualText", and a field +%that contains an image would require "Alt". +% +%\begin{macro}{\glsfieldaccsupp} +%\begin{definition} +%\cs{glsfieldaccsupp}\marg{replacement}\marg{content}\marg{field}\marg{label} +%\end{definition} +%\changes{4.45}{2020-02-13}{new} +%Test if there's a command called \cs{gls\meta{field}accsupp}. If +%there is then use that otherwise use \cs{glsaccsupp}. The first +%argument should be the internal field label (not the key). The +%final argument is the entry label. If \sty{glossaries-extra} has +%been loaded, this first checks for +%\cs{glsxtr\meta{category}\meta{field}accsupp} and \cs{glsxtr\meta{category}accsupp}. +% \begin{macrocode} +\newcommand{\glsfieldaccsupp}[4]{% + \ifdef\glscategory + {% + \ifcsdef{glsxtr\glscategory{#4}#3accsupp}% + {\csname glsxtr\glscategory{#4}#3accsupp\endcsname{#1}{#2}}% + {% + \ifcsdef{glsxtr\glscategory{#4}accsupp}% + {\csname glsxtr\glscategory{#4}accsupp\endcsname{#1}{#2}}% + {% + \ifcsdef{gls#3accsupp}% + {\csname gls#3accsupp\endcsname{#1}{#2}}% + {\glsaccsupp{#1}{#2}}% + }% + }% + }% + {% + \ifcsdef{gls#3accsupp}% + {\csname gls#3accsupp\endcsname{#1}{#2}}% + {\glsaccsupp{#1}{#2}}% + }% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\xglsfieldaccsupp} +%\begin{definition} +%\cs{xglsfieldaccsupp}\marg{replacement}\marg{content}\marg{field}\marg{label} +%\end{definition} +%\changes{4.45}{2020-02-13}{new} +%As \cs{glsfieldaccsupp} but fully expand replacement text. +% \begin{macrocode} +\newcommand{\xglsfieldaccsupp}[1]{% + \protected@edef\@gls@replacementtext{#1}% + \expandafter\glsfieldaccsupp\expandafter{\@gls@replacementtext}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsshortaccsupp} +%\changes{4.45}{2020-02-13}{new} +%\begin{definition} +%\cs{glsshortaccsupp}\marg{replacement text}\marg{text} +%\end{definition} +% \begin{macrocode} +\newcommand*{\glsshortaccsupp}[2]{\glsaccessibility{E}{#1}{#2}} +% \end{macrocode} +%\end{macro} +%\begin{macro}{\glsshortplaccsupp} +%\changes{4.45}{2020-02-13}{new} +%\begin{definition} +%\cs{glsshortplaccsupp}\marg{replacement text}\marg{text} +%\end{definition} +% \begin{macrocode} +\newcommand*{\glsshortplaccsupp}{\glsshortaccsupp} +% \end{macrocode} +%\end{macro} %\begin{macro}{\glsaccsupp} %\changes{4.38}{2018-05-10}{added braces around actual text argument} %\begin{definition} %\cs{glsaccsupp}\marg{replacement text}\marg{text} %\end{definition} -% This can be redefined to use "E" or "Alt" instead of -% "ActualText". (I don't have the software to test the "E" or -% "Alt" options.) % \begin{macrocode} -\newcommand*{\glsaccsupp}[2]{% - \BeginAccSupp{ActualText={#1}}#2\EndAccSupp{}% -} +\newcommand*{\glsaccsupp}[2]{\glsaccessibility{ActualText}{#1}{#2}} % \end{macrocode} %\end{macro} %\begin{macro}{\xglsaccsupp} @@ -25314,6 +25860,7 @@ you % %\begin{macro}{\@gls@access@display} %\changes{4.03}{2014-01-20}{new} +%Deprecated. Use \cs{@gls@fieldaccess@display} instead. % \begin{macrocode} \newcommand*{\@gls@access@display}[2]{% \protected@edef\@glo@access{#2}% @@ -25326,121 +25873,249 @@ you % \end{macrocode} %\end{macro} % +%\begin{macro}{\@gls@fieldaccess@display} +%\begin{definition} +%\cs{@gls@fieldaccess@display}\marg{label}\marg{field}\marg{content}\marg{replacement} +%\end{definition} +%\changes{4.45}{2020-02-13}{new} +% \begin{macrocode} +\newcommand*{\@gls@fieldaccess@display}[4]{% + \protected@edef\@glo@access{#4}% + \ifdefequal\@glo@access\@gls@noaccess + {#3}% + {\expandafter\glsfieldaccsupp\expandafter{\@glo@access}{#3}{#2}{#1}}% +} +% \end{macrocode} +%\end{macro} +% %\begin{macro}{\glsnameaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % Displays the first argument with the accessibility text for % the entry with the label given by the second argument (if set). % \begin{macrocode} -\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryaccess{#2}}% +\newrobustcmd*{\glsnameaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@access}% + {#1}% + {\@gls@fieldaccess@display{#2}{name}{#1}{\glsentryaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glstextaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{textaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glstextaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrytextaccess{#2}}% +\newrobustcmd*{\glstextaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@textaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{text}{#1}{\glsentrytextaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glspluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{pluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glspluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrypluralaccess{#2}}% +\newrobustcmd*{\glspluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@pluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{plural}{#1}{\glsentrypluralaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsfirstaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{firstaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsfirstaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryfirstaccess{#2}}% +\newrobustcmd*{\glsfirstaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@firstaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{first}{#1}{\glsentryfirstaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsfirstpluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{firstpluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsfirstpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryfirstpluralaccess{#2}}% +\newrobustcmd*{\glsfirstpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@firstpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{firstpl}{#1}{\glsentryfirstpluralaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glssymbolaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{symbolaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glssymbolaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrysymbolaccess{#2}}% +\newrobustcmd*{\glssymbolaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@symbolaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{symbol}{#1}{\glsentrysymbolaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glssymbolpluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{symbolpluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glssymbolpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrysymbolpluralaccess{#2}}% +\newrobustcmd*{\glssymbolpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@symbolpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{symbolplural}{#1}{\glsentrysymbolpluralaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsdescriptionaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{descriptionaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsdescriptionaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrydescaccess{#2}}% +\newrobustcmd*{\glsdescriptionaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@descaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{desc}{#1}{\glsentrydescaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsdescriptionpluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{descriptionpluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsdescriptionpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrydescpluralaccess{#2}}% +\newrobustcmd*{\glsdescriptionpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@descpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{descplural}{#1}{\glsentrydescpluralaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glsshortaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{shortaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsshortaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryshortaccess{#2}}% +\newrobustcmd*{\glsshortaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@shortaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{short}{#1}{\glsentryshortaccess{#2}}}% } % \end{macrocode} %\end{macro} % %\begin{macro}{\glsshortpluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{shortpluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glsshortpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryshortpluralaccess{#2}}% +\newrobustcmd*{\glsshortpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@shortpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{shortpl}{#1}{\glsentryshortpluralaccess{#2}}}% } % \end{macrocode} %\end{macro} %\begin{macro}{\glslongaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{longaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glslongaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrylongaccess{#2}}% +\newrobustcmd*{\glslongaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@longaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{long}{#1}{\glsentrylongaccess{#2}}}% } % \end{macrocode} %\end{macro} % %\begin{macro}{\glslongpluralaccessdisplay} +%\changes{4.45}{2020-02-13}{added check for existence} % As above but for the \gloskey{longpluralaccess} replacement text. % \begin{macrocode} -\DeclareRobustCommand*{\glslongpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrylongpluralaccess{#2}}% +\newrobustcmd*{\glslongpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@longpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{longpl}{#1}{\glsentrylongpluralaccess{#2}}}% } % \end{macrocode} %\end{macro} % +%\begin{macro}{\glsuseriaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user1access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuseriaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useri}{#1}{\glsentryuseriaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsuseriiaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user2access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuseriiaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriiaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{userii}{#1}{\glsentryuseriiaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsuseriiiaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user3access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuseriiiaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriiiaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useriii}{#1}{\glsentryuseriiiaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsuserivaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user4access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuserivaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@userivaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useriv}{#1}{\glsentryuserivaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsuservaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user5access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuservaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@uservaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{userv}{#1}{\glsentryuservaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glsuserviaccessdisplay} +%\changes{4.45}{2020-02-13}{new} +% As above but for the \gloskey{user6access} replacement text. +% \begin{macrocode} +\newrobustcmd*{\glsuserviaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@userviaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{uservi}{#1}{\glsentryuserviaccess{#2}}}% +} +% \end{macrocode} +%\end{macro} +% +%\changes{4.25}{??}{changed \cs{DeclareRobustCommand} to +%\cs{newrobustcmd} and changed \cs{@ifundefined} to \cs{ifcsundef}} %\begin{macro}{\glsaccessdisplay} % Gets the replacement text corresponding to the named key given % by the first argument and calls the appropriate command % defined above. % \begin{macrocode} -\DeclareRobustCommand*{\glsaccessdisplay}[3]{% - \@ifundefined{gls#1accessdisplay}% +\newrobustcmd*{\glsaccessdisplay}[3]{% + \ifcsundef{gls#1accessdisplay}% {% \PackageError{glossaries-accsupp}{No accessibility support for key `#1'}{}% @@ -26244,6 +26919,441 @@ you % \end{macrocode} %\end{macro} % +%\begin{macro}{\@glstext@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glstextaccessdisplay{\glsentrytext{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glstext@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glstextaccessdisplay{\Glsentrytext{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLStext@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLStext@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glstextaccessdisplay{\mfirstucMakeUppercase{\glsentrytext{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsfirst@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstaccessdisplay{\glsentryfirst{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsfirst@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstaccessdisplay{\Glsentryfirst{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSfirst@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsfirstaccessdisplay{\mfirstucMakeUppercase{\glsentryfirst{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glspluralaccessdisplay{\glsentryplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glspluralaccessdisplay{\Glsentryplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glspluralaccessdisplay{\mfirstucMakeUppercase{\glsentryplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsfirstplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstpluralaccessdisplay{\glsentryfirstplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsfirstplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstpluralaccessdisplay{\Glsentryfirstplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSfirstplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsfirstpluralaccessdisplay{\mfirstucMakeUppercase{\glsentryfirstplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsname@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsnameaccessdisplay{\glsentryname{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsname@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsnameaccessdisplay{\Glsentryname{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSname@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSname@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsnameaccessdisplay{\mfirstucMakeUppercase{\glsentryname{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsdesc@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionaccessdisplay{\glsentrydesc{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsdesc@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionaccessdisplay{\Glsentrydesc{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSdesc@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsdescriptionaccessdisplay{\mfirstucMakeUppercase{\glsentrydesc{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsdescplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionpluralaccessdisplay{\glsentrydescplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsdescplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionpluralaccessdisplay{\Glsentrydescplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSdescplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsdescriptionpluralaccessdisplay{\mfirstucMakeUppercase{\glsentrydescplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glssymbol@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolaccessdisplay{\glsentrysymbol{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glssymbol@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolaccessdisplay{\Glsentrysymbol{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSsymbol@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSsymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glssymbolaccessdisplay{\mfirstucMakeUppercase{\glsentrysymbol{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glssymbolplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolpluralaccessdisplay{\glsentrysymbolplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glssymbolplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolpluralaccessdisplay{\Glsentrysymbolplural{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSsymbolplural@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSsymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glssymbolpluralaccessdisplay{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuseri@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriaccessdisplay{\glsentryuseri{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuseri@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriaccessdisplay{\Glsentryuseri{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuseri@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriaccessdisplay{\mfirstucMakeUppercase{\glsentryuseri{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuserii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiaccessdisplay{\glsentryuserii{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuserii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiaccessdisplay{\Glsentryuserii{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuserii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriiaccessdisplay{\mfirstucMakeUppercase{\glsentryuserii{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuseriii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiiaccessdisplay{\glsentryuseriii{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuseriii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiiaccessdisplay{\Glsentryuseriii{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuseriii@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriiiaccessdisplay{\mfirstucMakeUppercase{\glsentryuseriii{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuseriv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserivaccessdisplay{\glsentryuseriv{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuseriv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserivaccessdisplay{\Glsentryuseriv{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuseriv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuserivaccessdisplay{\mfirstucMakeUppercase{\glsentryuseriv{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuserv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuservaccessdisplay{\glsentryuserv{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuserv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuservaccessdisplay{\Glsentryuserv{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuserv@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuservaccessdisplay{\mfirstucMakeUppercase{\glsentryuserv{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@glsuservi@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@glsuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserviaccessdisplay{\glsentryuservi{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@Glsuservi@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserviaccessdisplay{\Glsentryuservi{#2}}{#2}#3}% +} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\@GLSuservi@} +%\changes{4.45}{2020-02-13}{added accessibility support} +% \begin{macrocode} +\def\@GLSuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuserviaccessdisplay{\mfirstucMakeUppercase{\glsentryuservi{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +% \end{macrocode} +%\end{macro} +% %\section{Displaying the Glossary} %\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossaryentryfield}} %\changes{3.08a}{2013-09-28}{removed definition of \cs{@glossarysubentryfield}} @@ -26906,11 +28016,24 @@ you % \end{macrocode} %\end{acrstyle} % +%\begin{macro}{\glsdefaultshortaccess} +%\changes{4.45}{2020-02-13}{new} +%\begin{definition} +%\cs{glsdefaultshortaccess}\marg{long}\marg{short} +%\end{definition} +%Default \gloskey{shortaccess} value. +% \begin{macrocode} +\newcommand*{\glsdefaultshortaccess}[2]{#1} +% \end{macrocode} +%\end{macro} +% % Use \cs{newacronymhook} to modify the key list to set % the access text to the long version by default. % \begin{macrocode} \renewcommand*{\newacronymhook}{% - \edef\@gls@keylist{shortaccess=\the\glslongtok,% + \edef\@gls@keylist{% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% + shortpluralaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% \the\glskeylisttok}% \expandafter\glskeylisttok\expandafter{\@gls@keylist}% } @@ -26931,7 +28054,7 @@ you sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% descriptionplural={\the\glslongtok\noexpand\acrpluralsuffix},% @@ -26981,7 +28104,7 @@ you text={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% access={\noexpand\@glo@textaccess},% @@ -27025,7 +28148,7 @@ you sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% first={\the\glslongtok},% @@ -27113,7 +28236,7 @@ you sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% text={\noexpand\@glo@short},% @@ -27301,7 +28424,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-babel}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -27345,7 +28468,7 @@ you % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2020/02/13 v4.45 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -27386,8 +28509,10 @@ you %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test acronym entries with descriptions. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test acronym entries with descriptions. +%COMMENT \newacronym[type=\glsdefaulttype,description={fringilla a, euismod sodales, sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} @@ -27427,8 +28552,10 @@ turpis}]{atu}{ATU}{aliquam tincidunt urna} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test acronym entries +%<<COMMENT +% This file is part of the glossaries bundle +% These are test acronym entries +%COMMENT \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum dolor} @@ -27529,9 +28656,11 @@ turpis}]{atu}{ATU}{aliquam tincidunt urna} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test acronym entries where some are provided with - % "translations", which are stored in the user1 key. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test acronym entries where some are provided with +% "translations", which are stored in the user1 key. +%COMMENT \newacronym[type=\glsdefaulttype,user1={love itself}]{li}{LI}{lorem ipsum} @@ -27560,8 +28689,10 @@ risus ut urna} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with brief descriptions. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with brief descriptions. +%COMMENT \newglossaryentry{lorem}{name={lorem},description={ipsum}} @@ -27682,9 +28813,11 @@ risus ut urna} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with child entries that don't have - % a name supplied. (The name is the same as the parent name.) +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with child entries that don't have +% a name supplied. (The name is the same as the parent name.) +%COMMENT \newglossaryentry{scelerisque}{name={scelerisque},description={at}} @@ -27788,10 +28921,12 @@ parturient montes}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with citation labels stored in - % the user1 field. (The citations are defined in the xampl.bib file - % that should be available on modern TeX distributions.) +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with citation labels stored in +% the user1 field. (The citations are defined in the xampl.bib file +% that should be available on modern TeX distributions.) +%COMMENT \newglossaryentry{fusce}{name={fusce}, description={suscipit cursus sem},user1={article-minimal}} @@ -27883,10 +29018,12 @@ description={lacus}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with multi-paragraph descriptions - % that have an associated image file (stored in user1). - % The referenced image files are provided by the mwe package. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with multi-paragraph descriptions +% that have an associated image file (stored in user1). +% The referenced image files are provided by the mwe package. +%COMMENT \longnewglossaryentry{sedfeugiat}{name={sed feugiat},user1={example-image}}% {% @@ -28182,8 +29319,10 @@ aliquet. Pellentesque aliquet sodales urna. %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with long descriptions. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with long descriptions. +%COMMENT \newglossaryentry{loremipsum}{name={lorem ipsum}, description={dolor sit amet, consectetuer adipiscing elit. Ut purus @@ -28262,8 +29401,10 @@ bibendum quam in tellus.}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with multi-paragraph descriptions. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with multi-paragraph descriptions. +%COMMENT \longnewglossaryentry{loremi-ii}{name={lorem 1--2}}% {% @@ -28406,8 +29547,10 @@ tortor, vel consectetuer odio sem sed wisi.% %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with child entries. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with child entries. +%COMMENT \newglossaryentry{sedmattis}{name={sed mattis},description={erat sit amet}} @@ -28479,8 +29622,10 @@ description={elit, molestie non}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with associated symbols. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with associated symbols. +%COMMENT \newglossaryentry{sym.alpha}{sort={alpha},name={\ensuremath{\alpha}}, description={Quisque ullamcorper placerat ipsum.}} @@ -28569,8 +29714,10 @@ description={Mauris tempor ligula sed lacus.}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with associated symbols. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with associated symbols. +%COMMENT \newglossaryentry{alpha}{name={alpha},symbol={\ensuremath{\alpha}}, description={Quisque ullamcorper placerat ipsum.}} @@ -28659,9 +29806,11 @@ description={Mauris tempor ligula sed lacus.}} %\fi %\iffalse % \begin{macrocode} - % This file is part of the glossaries bundle - % These are test glossary entries with URLs stored in - % the user1 field. +%<<COMMENT +% This file is part of the glossaries bundle +% These are test glossary entries with URLs stored in +% the user1 field. +%COMMENT \newglossaryentry{aenean-url}{name={aenean}, description={adipiscing auctor est}, diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.ins b/Master/texmf-dist/source/latex/glossaries/glossaries.ins index 6539fc80467..ced7110daa1 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.ins +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.ins @@ -1,10 +1,10 @@ -% glossaries.ins generated using makedtx version 1.2 2019/12/6 14:57 +% glossaries.ins generated using makedtx version 1.2 2020/2/14 0:32 \input docstrip \preamble glossaries.dtx - Copyright 2019 Nicola Talbot + Copyright 2020 Nicola Talbot This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty index dcb1dbb87a2..03bc229b1fe 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-babel.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-babel}[2020/02/13 v4.45 (NLCT)] \RequirePackage{tracklang} \let\glsifusetranslator\@secondoftwo \AnyTrackedLanguages diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty index 78b30697fb1..614165f88e3 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-compatible-207.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2020/02/13 v4.45 (NLCT)] \ifglsxindy \renewcommand*\GlsAddXdyAttribute[1]{% \edef\@xdyattributes{\@xdyattributes ^^J \string"#1\string"}% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty index cd148858c76..e3d5d786eaa 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-compatible-307.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2020/02/13 v4.45 (NLCT)] \newcommand{\compatglossarystyle}[2]{% \ifcsundef{@glscompstyle@#1}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty index 2551d4d0748..a04ea1775da 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-polyglossia.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2020/02/13 v4.45 (NLCT)] \RequirePackage{tracklang} \let\glsifusetranslator\@secondoftwo \AnyTrackedLanguages diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty index ee25f03bc4a..dbac71c219e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-prefix.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2020/02/13 v4.45 (NLCT)] \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}} \ProcessOptions \RequirePackage{glossaries} @@ -69,43 +69,44 @@ {\csname glo@\@glo@label @prefixplural\endcsname}{\@glo@label}% {prefixfirstplural}{\@glo@entryprefixfirstplural}% } -\newcommand*{\glsentryprefixfirst}[1]{\csuse{glo@#1@prefixfirst}} -\newcommand*{\glsentryprefixfirstplural}[1]{\csuse{glo@#1@prefixfirstplural}} -\newcommand*{\glsentryprefix}[1]{\csuse{glo@#1@prefix}} -\newcommand*{\glsentryprefixplural}[1]{\csuse{glo@#1@prefixplural}} +\newcommand*{\glsentryprefixfirst}[1]{\csuse{glo@\glsdetoklabel{#1}@prefixfirst}} +\newcommand*{\glsentryprefixfirstplural}[1]{% + \csuse{glo@\glsdetoklabel{#1}@prefixfirstplural}} +\newcommand*{\glsentryprefix}[1]{\csuse{glo@\glsdetoklabel{#1}@prefix}} +\newcommand*{\glsentryprefixplural}[1]{\csuse{glo@\glsdetoklabel{#1}@prefixplural}} \newrobustcmd*{\Glsentryprefixfirst}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixfirst\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixfirst\endcsname}% \xmakefirstuc\@glo@text } \newrobustcmd*{\Glsentryprefixfirstplural}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixfirstplural\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixfirstplural\endcsname}% \xmakefirstuc\@glo@text } \newrobustcmd*{\Glsentryprefix}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefix\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefix\endcsname}% \xmakefirstuc\@glo@text } \newrobustcmd*{\Glsentryprefixplural}[1]{% - \protected@edef\@glo@text{\csname glo@#1@prefixplural\endcsname}% + \protected@edef\@glo@text{\csname glo@\glsdetoklabel{#1}@prefixplural\endcsname}% \xmakefirstuc\@glo@text } \newcommand*{\ifglshasprefix}[3]{% - \ifcsempty{glo@#1@prefix}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefix}% {#3}% {#2}% } \newcommand*{\ifglshasprefixplural}[3]{% - \ifcsempty{glo@#1@prefixplural}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixplural}% {#3}% {#2}% } \newcommand*{\ifglshasprefixfirst}[3]{% - \ifcsempty{glo@#1@prefixfirst}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixfirst}% {#3}% {#2}% } \newcommand*{\ifglshasprefixfirstplural}[3]{% - \ifcsempty{glo@#1@prefixfirstplural}% + \ifcsempty{glo@\glsdetoklabel{#1}@prefixfirstplural}% {#3}% {#2}% } @@ -114,6 +115,7 @@ {\@glsxtr@record{#1}{#2}{glslink}}% {}% } +\newcommand{\glsprefixsep}{} \newrobustcmd{\pgls}{\@gls@hyp@opt\@pgls} \newcommand*{\@pgls}[2][]{% \new@ifnextchar[% @@ -126,10 +128,10 @@ {% \ifglsused{#2}% {% - \glsentryprefix{#2}% + \ifglshasprefix{#2}{\glsentryprefix{#2}\glsprefixsep}{}% }% {% - \glsentryprefixfirst{#2}% + \ifglshasprefixfirst{#2}{\glsentryprefixfirst{#2}\glsprefixsep}{}% }% \@gls@{#1}{#2}[#3]% }% @@ -146,10 +148,11 @@ {% \ifglsused{#2}% {% - \glsentryprefixplural{#2}% + \ifglshasprefixplural{#2}{\glsentryprefixplural{#2}\glsprefixsep}{}% }% {% - \glsentryprefixfirstplural{#2}% + \ifglshasprefixfirstplural{#2}% + {\glsentryprefixfirstplural{#2}\glsprefixsep}{}% }% \@glspl@{#1}{#2}[#3]% }% @@ -169,6 +172,7 @@ \ifglshasprefix{#2}% {% \Glsentryprefix{#2}% + \glsprefixsep \@gls@{#1}{#2}[#3]% }% {\@Gls@{#1}{#2}[#3]}% @@ -177,6 +181,7 @@ \ifglshasprefixfirst{#2}% {% \Glsentryprefixfirst{#2}% + \glsprefixsep \@gls@{#1}{#2}[#3]% }% {\@Gls@{#1}{#2}[#3]}% @@ -198,6 +203,7 @@ \ifglshasprefixplural{#2}% {% \Glsentryprefixplural{#2}% + \glsprefixsep \@glspl@{#1}{#2}[#3]% }% {\@Glspl@{#1}{#2}[#3]}% @@ -206,6 +212,7 @@ \ifglshasprefixfirstplural{#2}% {% \Glsentryprefixfirstplural{#2}% + \glsprefixsep \@glspl@{#1}{#2}[#3]% }% {\@Glspl@{#1}{#2}[#3]}% @@ -224,10 +231,12 @@ {% \ifglsused{#2}% {% - \mfirstucMakeUppercase{\glsentryprefix{#2}}% + \ifglshasprefix{#2}% + {\mfirstucMakeUppercase{\glsentryprefix{#2}\glsprefixsep}}{}% }% {% - \mfirstucMakeUppercase{\glsentryprefixfirst{#2}}% + \ifglshasprefixfirst{#2}% + {\mfirstucMakeUppercase{\glsentryprefixfirst{#2}\glsprefixsep}}{}% }% \@GLS@{#1}{#2}[#3]% }% @@ -244,10 +253,12 @@ {% \ifglsused{#2}% {% - \mfirstucMakeUppercase{\glsentryprefixplural{#2}}% + \ifglshasprefixplural{#2}% + {\mfirstucMakeUppercase{\glsentryprefixplural{#2}\glsprefixsep}}{}% }% {% - \mfirstucMakeUppercase{\glsentryprefixfirstplural{#2}}% + \ifglshasprefixfirstplural{#2}% + {\mfirstucMakeUppercase{\glsentryprefixfirstplural{#2}\glsprefixsep}}{}% }% \@GLSpl@{#1}{#2}[#3]% }% diff --git a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty index c5500251e64..a4ac2be7ca5 100644 --- a/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty +++ b/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossaries}[2020/02/13 v4.45 (NLCT)] \RequirePackage{ifthen} \RequirePackage{xkeyval}[2006/11/18] \RequirePackage{mfirstuc} @@ -71,8 +71,9 @@ \fi \newif\if@gls@debug \define@choicekey{glossaries.sty}{debug}[\gls@debug@val\gls@debug@nr]% - {true,false,showtargets}[true]{% + {true,false,showtargets,showaccsupp}[true]{% \ifcase\gls@debug@nr\relax + % debug=true \@gls@debugtrue \renewcommand*{\GlossariesWarning}[1]{% \PackageWarning{glossaries}{##1}% @@ -83,10 +84,13 @@ \let\@glsshowtarget\@gobble \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% \or + % debug=false \@gls@debugfalse \let\@glsshowtarget\@gobble + \let\@glsshowaccsupp\@gobblethree \PackageInfo{glossaries}{debug mode OFF}% \or + % debug=showtargets \@gls@debugtrue \renewcommand*{\GlossariesWarning}[1]{% \PackageWarning{glossaries}{##1}% @@ -95,21 +99,49 @@ \PackageWarningNoLine{glossaries}{##1}% }% \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% - \renewcommand{\@glsshowtarget}{\glsshowtarget}% + \renewcommand{\@glsshowtarget}{\@@glsshowtarget}% + \or + % debug=showaccsupp + \@gls@debugtrue + \renewcommand*{\GlossariesWarning}[1]{% + \PackageWarning{glossaries}{##1}% + }% + \renewcommand*{\GlossariesWarningNoLine}[1]{% + \PackageWarningNoLine{glossaries}{##1}% + }% + \PackageInfo{glossaries}{debug mode ON (nowarn option disabled)}% + \renewcommand{\@glsshowaccsupp}{\glsshowaccsupp}% \fi } \newcommand*{\glsshowtarget}[1]{% \ifmmode - \nfss@text{\ttfamily\small [#1]}% + \nfss@text{\glsshowtargetfont [#1]}% \else \ifinner - \texttt{\small [#1]}% + {\glsshowtargetfont [#1]}% \else - \marginpar{\texttt{\small #1}}% + \glsshowtargetouter{#1}% \fi \fi } +\newcommand*{\glsshowtargetouter}[1]{% + \glsshowtargetsymbol\marginpar{\glsshowtargetsymbol\glsshowtargetfont #1}} +\newcommand*{\glsshowtargetsymbol}{{\tiny$\triangleright$}} +\newcommand*{\glsshowtargetfont}{\ttfamily\footnotesize} \newcommand*{\@glsshowtarget}[1]{} +\newrobustcmd*{\@@glsshowtarget}[1]{% + \begingroup + \protected@edef\@gls@tmp{#1}% + \@onelevel@sanitize\@gls@tmp + \expandafter\glsshowtarget\expandafter{\@gls@tmp}% + \endgroup +} +\newcommand*{\@glsshowaccsupp}[3]{} +\newrobustcmd*{\glsshowaccsupp}[3]{% + \ifstrempty{#1}% + {\@@glsshowtarget{/#2 (#3)}}% + {\@@glsshowtarget{/#2 (#3) [#1]}}% +} \newcommand*{\@gls@see@noindex}{% \PackageError{glossaries}% {`\gls@xr@key' key may only be used after \string\makeglossaries\space @@ -409,7 +441,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \newcommand*{\@gls@do@acronymsdef}{} \@gls@declareoption{acronyms}{% \glsacronymtrue - \renewcommand{\@gls@do@acronymsdef}{% + \def\@gls@do@acronymsdef{% \DeclareAcronymList{acronym}% \newglossary[alg]{acronym}{acr}{acn}{\acronymname}% \renewcommand*{\acronymtype}{acronym}% @@ -436,9 +468,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% } \newcommand{\@gls@islistofacronyms}[4]{% \def\gls@islistofacronyms##1,#1,##2\end@gls@islistofacronyms{% - \def\@before{##1}\def\@after{##2}}% + \def\@gls@before{##1}\def\@gls@after{##2}}% \gls@islistofacronyms,#2,#1,\@nil\end@gls@islistofacronyms - \ifx\@after\@nnil + \ifx\@gls@after\@nnil #4% \else #3% @@ -826,6 +858,58 @@ false,nolabel,autolabel,nameref}[nolabel]{% \glsxindytrue \gls@xindy@glsnumbersfalse } +\providecommand{\@domakeglossaries}[1]{#1} +\@gls@declareoption{disablemakegloss}{% + \ifdefequal\makeglossaries\@no@makeglossaries + {% + \GlossariesWarning{Option `disablemakegloss' has no effect + (\string\makenoidxglossaries\space has already been used)}% + }% + {% + \ifdefequal\@makeglossary\@gobble + {% + \GlossariesWarning{Option `disablemakegloss' has no effect + (\string\makeglossaries\space has already been used)}% + }% + {% + \renewcommand{\@domakeglossaries}[1]{% + \PackageInfo{glossaries}{\string\makeglossaries\space and + \string\makenoidxglossaries\space have been disabled}% + }% + }% + }% +} +\@gls@declareoption{restoremakegloss}{% + \ifdefequal\makeglossaries\@no@makeglossaries + {% + \GlossariesWarning{Option `restoremakegloss' has no effect + (\string\makenoidxglossaries\space has already been used)}% + }% + {% + \ifdefequal\@makeglossary\@gobble + {% + \GlossariesWarning{Option `restoremakegloss' has no effect + (\string\makeglossaries\space has already been used)}% + }% + {% + \PackageInfo{glossaries}{\string\makeglossaries\space and + \string\makenoidxglossaries\space have been restored}% + \let\@domakeglossaries\@firstofone + }% + }% +} +\newcommand*{\@do@write@glslabels}{% + \AtEndDocument{\@@do@write@glslabels}% + \let\@do@write@glslabels\relax +} +\newcommand*{\@@do@write@glslabels}{% + \newwrite\@gls@labelsfile + \immediate\openout\@gls@labelsfile=\jobname.glslabels + \forallglsentries[\@glo@types,\@ignored@glossaries]{\@glsentry}% + {\ifdefempty{\@glsentry}{}{\immediate\write\@gls@labelsfile{\@glsentry}}}% + \immediate\closeout\@gls@labelsfile +} +\@gls@declareoption{writeglslabels}{\@do@write@glslabels} \newif\ifglsautomake \newcommand{\gls@automake@nr}{1} \define@choicekey{glossaries.sty}{automake}% @@ -1671,7 +1755,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% }% {#2}% } -\newcommand{\ifglshaschildren}[3]{% +\newrobustcmd{\ifglshaschildren}[3]{% \glsdoifexists{#1}% {% \def\do@glshaschildren{#3}% @@ -1707,7 +1791,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {#2}% {#3}% } -\newcommand*{\ifglshassymbol}[3]{% +\newrobustcmd*{\ifglshassymbol}[3]{% \letcs{\@glo@symbol}{glo@\glsdetoklabel{#1}@symbol}% \ifdefempty\@glo@symbol {#3}% @@ -1717,7 +1801,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {#2}% }% } -\newcommand*{\ifglshaslong}[3]{% +\newrobustcmd*{\ifglshaslong}[3]{% \letcs{\@glo@long}{glo@\glsdetoklabel{#1}@long}% \ifdefempty\@glo@long {#3}% @@ -1727,7 +1811,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {#2}% }% } -\newcommand*{\ifglshasshort}[3]{% +\newrobustcmd*{\ifglshasshort}[3]{% \letcs{\@glo@short}{glo@\glsdetoklabel{#1}@short}% \ifdefempty\@glo@short {#3}% @@ -1737,7 +1821,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% {#2}% }% } -\newcommand*{\ifglshasfield}[4]{% +\newrobustcmd*{\ifglshasfield}[4]{% \glsdoifexists{#2}% {% \letcs{\@glo@thisvalue}{glo@\glsdetoklabel{#2}@#1}% @@ -4560,7 +4644,14 @@ false,nolabel,autolabel,nameref}[nolabel]{% \@glo@text }% \else - \xmakefirstuc{\@glo@text}% + \expandafter\ifx\@gls@body\glsshortaccessdisplay\relax + {% + \let\glsentryshort\Glsentryshort + \@glo@text + }% + \else + \xmakefirstuc{\@glo@text}% + \fi \fi \fi \fi @@ -4614,8 +4705,11 @@ false,nolabel,autolabel,nameref}[nolabel]{% \@Gls@entry@field{#1}{firstpl}% } \newrobustcmd*{\@glsentrytitlecase}[2]{% - \glsfieldfetch{#1}{#2}{\@gls@value}% - \xcapitalisewords{\@gls@value}% + \glsdoifexists{#1}% + {% + \glsfieldfetch{#1}{#2}{\@gls@value}% + \xcapitalisewords{\@gls@value}% + }% } \ifdef\texorpdfstring { @@ -4632,6 +4726,9 @@ false,nolabel,autolabel,nameref}[nolabel]{% \newcommand*{\glsentrysort}[1]{% \@gls@entry@field{#1}{sort}% } +\newcommand*{\glsentryparent}[1]{% + \@gls@entry@field{#1}{parent}% +} \newcommand*{\glsentryuseri}[1]{% \@gls@entry@field{#1}{useri}% } @@ -5334,6 +5431,8 @@ false,nolabel,autolabel,nameref}[nolabel]{% \fi } \newcommand*{\makeglossaries}{% + \@domakeglossaries + {% \@gls@@automake@immediate \ifundef{\glswrite}{\newwrite\glswrite}{}% \protected@write\@auxout{}{\string\providecommand\string\@glsorder[1]{}} @@ -5357,7 +5456,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% must be created before \string\makeglossaries}{You need to move \string\makeglossaries\space after all your \string\newglossary\space commands}}% - \let\@makeglossary\relax + \let\@makeglossary\@gobble \let\makeglossaries\relax \@disable@onlypremakeg \let\gls@checkseeallowed\relax @@ -5393,6 +5492,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% }% \fi \@glo@check@sortallowed\makeglossaries + }% } \@onlypreamble{\makeglossaries} \AtEndDocument{% @@ -5400,6 +5500,8 @@ false,nolabel,autolabel,nameref}[nolabel]{% \warn@noprintglossary } \newcommand*{\makenoidxglossaries}{% + \@domakeglossaries + {% \renewcommand{\@gls@noref@warn}[1]{% \GlossariesWarning{Empty glossary for \string\printnoidxglossary[type={##1}]. @@ -5509,6 +5611,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \let\@@gls@nosanitizesort\@@gls@noidx@nosanitizesort \@gls@noidx@setsanitizesort \@glo@check@sortallowed\makenoidxglossaries + }% } \@onlypreamble{\makenoidxglossaries} \newcommand*{\glsnumberlistloop}[2]{% @@ -5792,13 +5895,13 @@ you \def\@@gls@fixbraces#1[#2]#3\@end@fixbraces{% \def#1{[#2]{#3}}% } -\DeclareRobustCommand*{\glssee}[3][\seename]{% +\newrobustcmd*{\glssee}[3][\seename]{% \@do@seeglossary{#2}{[#1]{#3}}} \newcommand*{\@glssee}[3][\seename]{% \glssee[#1]{#3}{#2}} -\DeclareRobustCommand*{\glsseeformat}[3][\seename]{% +\newrobustcmd*{\glsseeformat}[3][\seename]{% \emph{#1} \glsseelist{#2}} -\DeclareRobustCommand*{\glsseelist}[1]{% +\newrobustcmd*{\glsseelist}[1]{% \let\@gls@dolast\relax \let\@gls@donext\relax \@for\@gls@thislabel:=#1\do{% @@ -5814,7 +5917,7 @@ you } \newcommand*{\glsseelastsep}{\space\andname\space} \newcommand*{\glsseesep}{, } -\DeclareRobustCommand*{\glsseeitem}[1]{\glshyperlink[\glsseeitemformat{#1}]{#1}} +\newrobustcmd*{\glsseeitem}[1]{\glshyperlink[\glsseeitemformat{#1}]{#1}} \newcommand*{\glsseeitemformat}[1]{\glsentrytext{#1}} \newcommand*{\gls@save@numberlist}[1]{% \ifglssavenumberlist diff --git a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty index 4765f418963..5ccf51872c1 100644 --- a/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty +++ b/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossaries-accsupp.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -39,7 +39,7 @@ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-accsupp}[2019/12/06 v4.44 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2020/02/13 v4.45 (NLCT) Experimental glossaries accessibility] \DeclareOption*{\PassOptionsToPackage{\CurrentOption}{glossaries}} \ProcessOptions @@ -82,7 +82,20 @@ \@do@subglossentry } \RequirePackage{glossaries} -\RequirePackage{accsupp} +\providecommand{\gls@accsupp@engine}{accsupp} +\providecommand{\gls@accessibility}[4]{#4} +\ifdefstring\gls@accsupp@engine{accsupp} +{ + \RequirePackage{accsupp} + \renewcommand{\gls@accessibility}[4]{% + \BeginAccSupp{#1,#2={#3}}#4\EndAccSupp{}% + } +} +{} +\newcommand{\glsaccessibility}[4][]{% + \@glsshowaccsupp{#1}{#2}{#3}% + \gls@accessibility{#1}{#2}{#3}{#4}% +} \define@key{glossentry}{access}{% \def\@glo@access{#1}% } @@ -122,6 +135,24 @@ \define@key{glossentry}{longpluralaccess}{% \def\@glo@longpluralaccess{#1}% } +\define@key{glossentry}{user1access}{% + \def\@glo@useriaccess{#1}% +} +\define@key{glossentry}{user2access}{% + \def\@glo@useriiaccess{#1}% +} +\define@key{glossentry}{user3access}{% + \def\@glo@useriiiaccess{#1}% +} +\define@key{glossentry}{user4access}{% + \def\@glo@userivaccess{#1}% +} +\define@key{glossentry}{user5access}{% + \def\@glo@uservaccess{#1}% +} +\define@key{glossentry}{user6access}{% + \def\@glo@userviaccess{#1}% +} \appto\@gls@keymap{,% {access}{access},% {textaccess}{textaccess},% @@ -135,13 +166,19 @@ {shortaccess}{shortaccess},% {shortpluralaccess}{shortpluralaccess},% {longaccess}{longaccess},% - {longpluralaccess}{longpluralaccess}% + {longpluralaccess}{longpluralaccess},% + {user1access}{useriaccess},% + {user2access}{useriiaccess},% + {user3access}{useriiiaccess},% + {user4access}{userivaccess},% + {user5access}{uservaccess},% + {user6access}{userviaccess}% } \def\@gls@noaccess{\relax} \let\@gls@oldnewglossaryentryprehook\@newglossaryentryprehook \renewcommand*{\@newglossaryentryprehook}{% \@gls@oldnewglossaryentryprehook - \def\@glo@access{\@glo@symbol}% + \def\@glo@access{\relax}% \def\@glo@textaccess{\@glo@access}% \def\@glo@firstaccess{\@glo@access}% \def\@glo@pluralaccess{\@glo@textaccess}% @@ -154,6 +191,12 @@ \def\@glo@shortpluralaccess{\@glo@shortaccess}% \def\@glo@longaccess{\relax}% \def\@glo@longpluralaccess{\@glo@longaccess}% + \def\@glo@useriaccess{\relax}% + \def\@glo@useriiaccess{\relax}% + \def\@glo@useriiiaccess{\relax}% + \def\@glo@userivaccess{\relax}% + \def\@glo@uservaccess{\relax}% + \def\@glo@userviaccess{\relax}% } \let\@gls@oldnewglossaryentryposthook\@newglossaryentryposthook \renewcommand*{\@newglossaryentryposthook}{% @@ -197,6 +240,24 @@ \expandafter \protected@xdef\csname glo@\@glo@label @longpluralaccess\endcsname{% \@glo@longpluralaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriaccess\endcsname{% + \@glo@useriaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriiaccess\endcsname{% + \@glo@useriiaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @useriiiaccess\endcsname{% + \@glo@useriiiaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @userivaccess\endcsname{% + \@glo@userivaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @uservaccess\endcsname{% + \@glo@uservaccess}% + \expandafter + \protected@xdef\csname glo@\@glo@label @userviaccess\endcsname{% + \@glo@userviaccess}% } \newcommand*{\glsentryaccess}[1]{% \@gls@entry@field{#1}{access}% @@ -211,7 +272,7 @@ \@gls@entry@field{#1}{pluralaccess}% } \newcommand*{\glsentryfirstpluralaccess}[1]{% - \csname glo@#1@firstpluralaccess\endcsname + \@gls@entry@field{#1}{firstpluralaccess}% } \newcommand*{\glsentrysymbolaccess}[1]{% \@gls@entry@field{#1}{symbolaccess}% @@ -223,7 +284,7 @@ \@gls@entry@field{#1}{descaccess}% } \newcommand*{\glsentrydescpluralaccess}[1]{% - \@gls@entry@field{#1}{descaccess}% + \@gls@entry@field{#1}{descpluralaccess}% } \newcommand*{\glsentryshortaccess}[1]{% \@gls@entry@field{#1}{shortaccess}% @@ -237,9 +298,52 @@ \newcommand*{\glsentrylongpluralaccess}[1]{% \@gls@entry@field{#1}{longpluralaccess}% } -\newcommand*{\glsaccsupp}[2]{% - \BeginAccSupp{ActualText={#1}}#2\EndAccSupp{}% +\newcommand*{\glsentryuseriaccess}[1]{% + \@gls@entry@field{#1}{useriaccess}% +} +\newcommand*{\glsentryuseriiaccess}[1]{% + \@gls@entry@field{#1}{useriiaccess}% +} +\newcommand*{\glsentryuseriiiaccess}[1]{% + \@gls@entry@field{#1}{useriiiaccess}% } +\newcommand*{\glsentryuserivaccess}[1]{% + \@gls@entry@field{#1}{userivaccess}% +} +\newcommand*{\glsentryuservaccess}[1]{% + \@gls@entry@field{#1}{uservaccess}% +} +\newcommand*{\glsentryuserviaccess}[1]{% + \@gls@entry@field{#1}{userviaccess}% +} +\newcommand{\glsfieldaccsupp}[4]{% + \ifdef\glscategory + {% + \ifcsdef{glsxtr\glscategory{#4}#3accsupp}% + {\csname glsxtr\glscategory{#4}#3accsupp\endcsname{#1}{#2}}% + {% + \ifcsdef{glsxtr\glscategory{#4}accsupp}% + {\csname glsxtr\glscategory{#4}accsupp\endcsname{#1}{#2}}% + {% + \ifcsdef{gls#3accsupp}% + {\csname gls#3accsupp\endcsname{#1}{#2}}% + {\glsaccsupp{#1}{#2}}% + }% + }% + }% + {% + \ifcsdef{gls#3accsupp}% + {\csname gls#3accsupp\endcsname{#1}{#2}}% + {\glsaccsupp{#1}{#2}}% + }% +} +\newcommand{\xglsfieldaccsupp}[1]{% + \protected@edef\@gls@replacementtext{#1}% + \expandafter\glsfieldaccsupp\expandafter{\@gls@replacementtext}% +} +\newcommand*{\glsshortaccsupp}[2]{\glsaccessibility{E}{#1}{#2}} +\newcommand*{\glsshortplaccsupp}{\glsshortaccsupp} +\newcommand*{\glsaccsupp}[2]{\glsaccessibility{ActualText}{#1}{#2}} \newcommand*{\xglsaccsupp}[2]{% \protected@edef\@gls@replacementtext{#1}% \expandafter\glsaccsupp\expandafter{\@gls@replacementtext}{#2}% @@ -252,47 +356,109 @@ \xglsaccsupp{\@glo@access}{#1}% \fi } -\DeclareRobustCommand*{\glsnameaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryaccess{#2}}% -} -\DeclareRobustCommand*{\glstextaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrytextaccess{#2}}% -} -\DeclareRobustCommand*{\glspluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrypluralaccess{#2}}% -} -\DeclareRobustCommand*{\glsfirstaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryfirstaccess{#2}}% -} -\DeclareRobustCommand*{\glsfirstpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryfirstpluralaccess{#2}}% -} -\DeclareRobustCommand*{\glssymbolaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrysymbolaccess{#2}}% -} -\DeclareRobustCommand*{\glssymbolpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrysymbolpluralaccess{#2}}% -} -\DeclareRobustCommand*{\glsdescriptionaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrydescaccess{#2}}% -} -\DeclareRobustCommand*{\glsdescriptionpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrydescpluralaccess{#2}}% -} -\DeclareRobustCommand*{\glsshortaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryshortaccess{#2}}% -} -\DeclareRobustCommand*{\glsshortpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentryshortpluralaccess{#2}}% -} -\DeclareRobustCommand*{\glslongaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrylongaccess{#2}}% -} -\DeclareRobustCommand*{\glslongpluralaccessdisplay}[2]{% - \@gls@access@display{#1}{\glsentrylongpluralaccess{#2}}% -} -\DeclareRobustCommand*{\glsaccessdisplay}[3]{% - \@ifundefined{gls#1accessdisplay}% +\newcommand*{\@gls@fieldaccess@display}[4]{% + \protected@edef\@glo@access{#4}% + \ifdefequal\@glo@access\@gls@noaccess + {#3}% + {\expandafter\glsfieldaccsupp\expandafter{\@glo@access}{#3}{#2}{#1}}% +} +\newrobustcmd*{\glsnameaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@access}% + {#1}% + {\@gls@fieldaccess@display{#2}{name}{#1}{\glsentryaccess{#2}}}% +} +\newrobustcmd*{\glstextaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@textaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{text}{#1}{\glsentrytextaccess{#2}}}% +} +\newrobustcmd*{\glspluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@pluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{plural}{#1}{\glsentrypluralaccess{#2}}}% +} +\newrobustcmd*{\glsfirstaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@firstaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{first}{#1}{\glsentryfirstaccess{#2}}}% +} +\newrobustcmd*{\glsfirstpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@firstpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{firstpl}{#1}{\glsentryfirstpluralaccess{#2}}}% +} +\newrobustcmd*{\glssymbolaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@symbolaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{symbol}{#1}{\glsentrysymbolaccess{#2}}}% +} +\newrobustcmd*{\glssymbolpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@symbolpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{symbolplural}{#1}{\glsentrysymbolpluralaccess{#2}}}% +} +\newrobustcmd*{\glsdescriptionaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@descaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{desc}{#1}{\glsentrydescaccess{#2}}}% +} +\newrobustcmd*{\glsdescriptionpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@descpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{descplural}{#1}{\glsentrydescpluralaccess{#2}}}% +} +\newrobustcmd*{\glsshortaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@shortaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{short}{#1}{\glsentryshortaccess{#2}}}% +} +\newrobustcmd*{\glsshortpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@shortpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{shortpl}{#1}{\glsentryshortpluralaccess{#2}}}% +} +\newrobustcmd*{\glslongaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@longaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{long}{#1}{\glsentrylongaccess{#2}}}% +} +\newrobustcmd*{\glslongpluralaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@longpluralaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{longpl}{#1}{\glsentrylongpluralaccess{#2}}}% +} +\newrobustcmd*{\glsuseriaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useri}{#1}{\glsentryuseriaccess{#2}}}% +} +\newrobustcmd*{\glsuseriiaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriiaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{userii}{#1}{\glsentryuseriiaccess{#2}}}% +} +\newrobustcmd*{\glsuseriiiaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@useriiiaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useriii}{#1}{\glsentryuseriiiaccess{#2}}}% +} +\newrobustcmd*{\glsuserivaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@userivaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{useriv}{#1}{\glsentryuserivaccess{#2}}}% +} +\newrobustcmd*{\glsuservaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@uservaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{userv}{#1}{\glsentryuservaccess{#2}}}% +} +\newrobustcmd*{\glsuserviaccessdisplay}[2]{% + \ifcsundef{glo@\glsdetoklabel{#2}@userviaccess}% + {#1}% + {\@gls@fieldaccess@display{#2}{uservi}{#1}{\glsentryuserviaccess{#2}}}% +} +\newrobustcmd*{\glsaccessdisplay}[3]{% + \ifcsundef{gls#1accessdisplay}% {% \PackageError{glossaries-accsupp}{No accessibility support for key `#1'}{}% @@ -739,6 +905,171 @@ }% \glspostlinkhook } +\def\@glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glstextaccessdisplay{\glsentrytext{#2}}{#2}#3}% +} +\def\@Glstext@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glstextaccessdisplay{\Glsentrytext{#2}}{#2}#3}% +} +\def\@GLStext@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glstextaccessdisplay{\mfirstucMakeUppercase{\glsentrytext{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstaccessdisplay{\glsentryfirst{#2}}{#2}#3}% +} +\def\@Glsfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstaccessdisplay{\Glsentryfirst{#2}}{#2}#3}% +} +\def\@GLSfirst@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsfirstaccessdisplay{\mfirstucMakeUppercase{\glsentryfirst{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glspluralaccessdisplay{\glsentryplural{#2}}{#2}#3}% +} +\def\@Glsplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glspluralaccessdisplay{\Glsentryplural{#2}}{#2}#3}% +} +\def\@GLSplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glspluralaccessdisplay{\mfirstucMakeUppercase{\glsentryplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstpluralaccessdisplay{\glsentryfirstplural{#2}}{#2}#3}% +} +\def\@glsfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsfirstpluralaccessdisplay{\Glsentryfirstplural{#2}}{#2}#3}% +} +\def\@GLSfirstplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsfirstpluralaccessdisplay{\mfirstucMakeUppercase{\glsentryfirstplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsnameaccessdisplay{\glsentryname{#2}}{#2}#3}% +} +\def\@Glsname@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsnameaccessdisplay{\Glsentryname{#2}}{#2}#3}% +} +\def\@GLSname@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsnameaccessdisplay{\mfirstucMakeUppercase{\glsentryname{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionaccessdisplay{\glsentrydesc{#2}}{#2}#3}% +} +\def\@Glsdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionaccessdisplay{\Glsentrydesc{#2}}{#2}#3}% +} +\def\@GLSdesc@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsdescriptionaccessdisplay{\mfirstucMakeUppercase{\glsentrydesc{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionpluralaccessdisplay{\glsentrydescplural{#2}}{#2}#3}% +} +\def\@Glsdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsdescriptionpluralaccessdisplay{\Glsentrydescplural{#2}}{#2}#3}% +} +\def\@GLSdescplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsdescriptionpluralaccessdisplay{\mfirstucMakeUppercase{\glsentrydescplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolaccessdisplay{\glsentrysymbol{#2}}{#2}#3}% +} +\def\@Glssymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolaccessdisplay{\Glsentrysymbol{#2}}{#2}#3}% +} +\def\@GLSsymbol@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glssymbolaccessdisplay{\mfirstucMakeUppercase{\glsentrysymbol{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolpluralaccessdisplay{\glsentrysymbolplural{#2}}{#2}#3}% +} +\def\@Glssymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glssymbolpluralaccessdisplay{\Glsentrysymbolplural{#2}}{#2}#3}% +} +\def\@GLSsymbolplural@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glssymbolpluralaccessdisplay{\mfirstucMakeUppercase{\glsentrysymbolplural{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriaccessdisplay{\glsentryuseri{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriaccessdisplay{\Glsentryuseri{#2}}{#2}#3}% +} +\def\@GLSuseri@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriaccessdisplay{\mfirstucMakeUppercase{\glsentryuseri{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiaccessdisplay{\glsentryuserii{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiaccessdisplay{\Glsentryuserii{#2}}{#2}#3}% +} +\def\@GLSuserii@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriiaccessdisplay{\mfirstucMakeUppercase{\glsentryuserii{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiiaccessdisplay{\glsentryuseriii{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuseriiiaccessdisplay{\Glsentryuseriii{#2}}{#2}#3}% +} +\def\@GLSuseriii@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuseriiiaccessdisplay{\mfirstucMakeUppercase{\glsentryuseriii{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserivaccessdisplay{\glsentryuseriv{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserivaccessdisplay{\Glsentryuseriv{#2}}{#2}#3}% +} +\def\@GLSuseriv@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuserivaccessdisplay{\mfirstucMakeUppercase{\glsentryuseriv{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuservaccessdisplay{\glsentryuserv{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuservaccessdisplay{\Glsentryuserv{#2}}{#2}#3}% +} +\def\@GLSuserv@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuservaccessdisplay{\mfirstucMakeUppercase{\glsentryuserv{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} +\def\@glsuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserviaccessdisplay{\glsentryuservi{#2}}{#2}#3}% +} +\def\@Glsuser@i#1#2[#3]{% + \@gls@field@link{#1}{#2}{\glsuserviaccessdisplay{\Glsentryuservi{#2}}{#2}#3}% +} +\def\@GLSuservi@#1#2[#3]{% + \@gls@field@link{#1}{#2}% + {\glsuserviaccessdisplay{\mfirstucMakeUppercase{\glsentryuservi{#2}}}{#2}% + \mfirstucMakeUppercase{#3}}% +} \renewcommand*{\glossentryname}[1]{% \glsdoifexists{#1}% {% @@ -1172,8 +1503,11 @@ \glslongaccessdisplay{\glsentrylong{##1}}{##1}\space (\glsshortaccessdisplay{\acronymfont{\glsentryshort{##1}}}{##1})}% } +\newcommand*{\glsdefaultshortaccess}[2]{#1} \renewcommand*{\newacronymhook}{% - \edef\@gls@keylist{shortaccess=\the\glslongtok,% + \edef\@gls@keylist{% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% + shortpluralaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% \the\glskeylisttok}% \expandafter\glskeylisttok\expandafter{\@gls@keylist}% } @@ -1190,7 +1524,7 @@ sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% descriptionplural={\the\glslongtok\noexpand\acrpluralsuffix},% @@ -1236,7 +1570,7 @@ text={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% access={\noexpand\@glo@textaccess},% @@ -1276,7 +1610,7 @@ sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% first={\the\glslongtok},% @@ -1356,7 +1690,7 @@ sort={\the\glsshorttok},% short={\the\glsshorttok},% shortplural={\the\glsshorttok\noexpand\acrpluralsuffix},% - shortaccess={\the\glslongtok},% + shortaccess={\glsdefaultshortaccess{\the\glslongtok}{\the\glsshorttok}},% long={\the\glslongtok},% longplural={\the\glslongtok\noexpand\acrpluralsuffix},% text={\noexpand\@glo@short},% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty index 89fadde0732..aebdb238d1d 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-hypernav.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-hypernav}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2020/02/13 v4.45 (NLCT)] \newcommand*{\glsnavhyperlink}[3][\@glo@type]{% \edef\gls@grplabel{#2}\protected@edef\@gls@grptitle{#3}% \@glslink{\glsnavhyperlinkname{#1}{#2}}{#3}} diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty index 92a00f2d214..badcd235eff 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-inline.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-inline}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-inline}[2020/02/13 v4.45 (NLCT)] \newglossarystyle{inline}{% \renewenvironment{theglossary}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty index 42eb9f641c6..65fe13e9f5b 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-list.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-list}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-list}[2020/02/13 v4.45 (NLCT)] \providecommand{\indexspace}{% \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax } diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty index fd4b63f1313..ede9200f62a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-long.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-long}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-long}[2020/02/13 v4.45 (NLCT)] \RequirePackage{longtable} \@ifundefined{glsdescwidth}{% \newlength\glsdescwidth diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty index aa12eea602c..80f718310e9 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-longbooktabs.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-longbooktabs}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2020/02/13 v4.45 (NLCT)] \RequirePackage{booktabs} \RequirePackage{glossary-long} \RequirePackage{glossary-longragged} diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty index b0c317d530a..93100064b96 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-longragged.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-longragged}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-longragged}[2020/02/13 v4.45 (NLCT)] \RequirePackage{array} \RequirePackage{longtable} \@ifundefined{glsdescwidth}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty index 5de174d6f11..06e10d3d89c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-mcols.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-mcols}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-mcols}[2020/02/13 v4.45 (NLCT)] \RequirePackage{multicol} \RequirePackage{glossary-tree} \providecommand{\indexspace}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty index 2344cc084a9..41c9c4760b3 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-super.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-super}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-super}[2020/02/13 v4.45 (NLCT)] \RequirePackage{supertabular} \@ifundefined{glsdescwidth}{% \newlength\glsdescwidth diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty index 6388faf843b..885c2fb102f 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-superragged.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-superragged}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-superragged}[2020/02/13 v4.45 (NLCT)] \RequirePackage{array} \RequirePackage{supertabular} \@ifundefined{glsdescwidth}{% diff --git a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty index 5f27ad4dbf4..c07c54dc1f4 100644 --- a/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty +++ b/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty @@ -7,7 +7,7 @@ %% glossaries.dtx (with options: `glossary-tree.sty,package') %% %% glossaries.dtx -%% Copyright 2019 Nicola Talbot +%% Copyright 2020 Nicola Talbot %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3 @@ -38,7 +38,7 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} -\ProvidesPackage{glossary-tree}[2019/12/06 v4.44 (NLCT)] +\ProvidesPackage{glossary-tree}[2020/02/13 v4.45 (NLCT)] \providecommand{\indexspace}{% \par \vskip 10\p@ \@plus 5\p@ \@minus 3\p@ \relax } diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym-desc.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym-desc.tex index 4370863f6d4..67e553ca360 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym-desc.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym-desc.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test acronym entries with descriptions. +% This file is part of the glossaries bundle +% These are test acronym entries with descriptions. \newacronym[type=\glsdefaulttype,description={fringilla a, euismod sodales, sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym.tex index 331c07fa623..8d5b6c5fba9 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronym.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test acronym entries +% This file is part of the glossaries bundle +% These are test acronym entries \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum dolor} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronyms-lang.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronyms-lang.tex index 9b3192ebbf5..fd787a0ae8c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronyms-lang.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-acronyms-lang.tex @@ -1,6 +1,6 @@ - % This file is part of the glossaries bundle - % These are test acronym entries where some are provided with - % "translations", which are stored in the user1 key. +% This file is part of the glossaries bundle +% These are test acronym entries where some are provided with +% "translations", which are stored in the user1 key. \newacronym[type=\glsdefaulttype,user1={love itself}]{li}{LI}{lorem ipsum} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-brief.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-brief.tex index 892d3edd30d..fbf2d47059e 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-brief.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-brief.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with brief descriptions. +% This file is part of the glossaries bundle +% These are test glossary entries with brief descriptions. \newglossaryentry{lorem}{name={lorem},description={ipsum}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-childnoname.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-childnoname.tex index 53a9885d368..8c30c3e8832 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-childnoname.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-childnoname.tex @@ -1,6 +1,6 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with child entries that don't have - % a name supplied. (The name is the same as the parent name.) +% This file is part of the glossaries bundle +% These are test glossary entries with child entries that don't have +% a name supplied. (The name is the same as the parent name.) \newglossaryentry{scelerisque}{name={scelerisque},description={at}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-cite.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-cite.tex index f41e5d8cb30..be14677d049 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-cite.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-cite.tex @@ -1,7 +1,7 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with citation labels stored in - % the user1 field. (The citations are defined in the xampl.bib file - % that should be available on modern TeX distributions.) +% This file is part of the glossaries bundle +% These are test glossary entries with citation labels stored in +% the user1 field. (The citations are defined in the xampl.bib file +% that should be available on modern TeX distributions.) \newglossaryentry{fusce}{name={fusce}, description={suscipit cursus sem},user1={article-minimal}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-images.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-images.tex index 865f835e331..c7fc6d676e6 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-images.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-images.tex @@ -1,7 +1,7 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with multi-paragraph descriptions - % that have an associated image file (stored in user1). - % The referenced image files are provided by the mwe package. +% This file is part of the glossaries bundle +% These are test glossary entries with multi-paragraph descriptions +% that have an associated image file (stored in user1). +% The referenced image files are provided by the mwe package. \longnewglossaryentry{sedfeugiat}{name={sed feugiat},user1={example-image}}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-long.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-long.tex index 8be8e2cd6b8..98472be2bb9 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-long.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-long.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with long descriptions. +% This file is part of the glossaries bundle +% These are test glossary entries with long descriptions. \newglossaryentry{loremipsum}{name={lorem ipsum}, description={dolor sit amet, consectetuer adipiscing elit. Ut purus diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-multipar.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-multipar.tex index f80aabaa4e0..9c4f1e2774a 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-multipar.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-multipar.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with multi-paragraph descriptions. +% This file is part of the glossaries bundle +% These are test glossary entries with multi-paragraph descriptions. \longnewglossaryentry{loremi-ii}{name={lorem 1--2}}% {% diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-parent.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-parent.tex index b87b5b06609..aa72064842c 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-parent.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-parent.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with child entries. +% This file is part of the glossaries bundle +% These are test glossary entries with child entries. \newglossaryentry{sedmattis}{name={sed mattis},description={erat sit amet}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbolnames.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbolnames.tex index f7265bc609c..81f6219f6a6 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbolnames.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbolnames.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with associated symbols. +% This file is part of the glossaries bundle +% These are test glossary entries with associated symbols. \newglossaryentry{sym.alpha}{sort={alpha},name={\ensuremath{\alpha}}, description={Quisque ullamcorper placerat ipsum.}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbols.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbols.tex index 321f63dd578..da8999b5645 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbols.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-symbols.tex @@ -1,5 +1,5 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with associated symbols. +% This file is part of the glossaries bundle +% These are test glossary entries with associated symbols. \newglossaryentry{alpha}{name={alpha},symbol={\ensuremath{\alpha}}, description={Quisque ullamcorper placerat ipsum.}} diff --git a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-url.tex b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-url.tex index ee82b7d2f7b..2181cedb598 100644 --- a/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-url.tex +++ b/Master/texmf-dist/tex/latex/glossaries/test-entries/example-glossaries-url.tex @@ -1,6 +1,6 @@ - % This file is part of the glossaries bundle - % These are test glossary entries with URLs stored in - % the user1 field. +% This file is part of the glossaries bundle +% These are test glossary entries with URLs stored in +% the user1 field. \newglossaryentry{aenean-url}{name={aenean}, description={adipiscing auctor est}, |