texlive[64741] trunk: glossaries (17oct22)
commits+karl at tug.org
commits+karl at tug.org
Tue Oct 18 22:52:45 CEST 2022
Revision: 64741
http://tug.org/svn/texlive?view=revision&revision=64741
Author: karl
Date: 2022-10-18 22:52:44 +0200 (Tue, 18 Oct 2022)
Log Message:
-----------
glossaries (17oct22)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES
trunk/Master/texmf-dist/doc/latex/glossaries/README.md
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.html
trunk/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossariesbegin.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.html
trunk/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossary2glossaries.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/glossary-lipsum-examples.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/minimalgls.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr-desc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/mwe-acr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/mwe-gls.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-FnDesc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-chap-hyperfirst.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-crossref.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-custom-acronym.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-dot-abbr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-dual.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-entrycount.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-entryfmt.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-font-abbr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-ignored.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-index.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-inline.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-langdict.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-newkeys.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp-utf8.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-noidxapp.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-nomathhyper.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-numberlist.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-prefix.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-si.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr-desc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample-storage-abbr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sample4col.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleAcrDesc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleCustomAcr.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleDB.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleDesc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleEq.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleEqPg.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleFnAcrDesc.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleNtn.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplePeople.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleSec.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleSort.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleaccsupp.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleacronyms.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampletree.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/sampleutf8.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy.tex
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy2.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/samples/samplexdy3.tex
trunk/Master/texmf-dist/doc/man/man1/makeglossaries-lite.1
trunk/Master/texmf-dist/doc/man/man1/makeglossaries-lite.man1.pdf
trunk/Master/texmf-dist/doc/man/man1/makeglossaries.1
trunk/Master/texmf-dist/doc/man/man1/makeglossaries.man1.pdf
trunk/Master/texmf-dist/scripts/glossaries/makeglossaries
trunk/Master/texmf-dist/scripts/glossaries/makeglossaries-lite.lua
trunk/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
trunk/Master/texmf-dist/source/latex/glossaries/glossaries.ins
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-babel.sty
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-207.sty
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-compatible-307.sty
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-polyglossia.sty
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-prefix.sty
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries.sty
trunk/Master/texmf-dist/tex/latex/glossaries/expl/glossaries-accsupp.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-hypernav.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-inline.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-long.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longbooktabs.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-longragged.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-mcols.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-super.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-superragged.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-tree.sty
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/glossaries/DEPENDS.txt
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.tex
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png
trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.tex
trunk/Master/texmf-dist/scripts/glossaries/glossaries.l2h
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-accsupp-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-accsupp-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-babel-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-babel-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-compatible-207-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-compatible-207-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-compatible-307-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-compatible-307-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-polyglossia-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-polyglossia-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-prefix-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossaries-prefix-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-hypernav-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-hypernav-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-inline-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-inline-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-list-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-list-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-long-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-long-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-longbooktabs-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-longbooktabs-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-longragged-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-longragged-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-mcols-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-mcols-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-super-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-super-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-superragged-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-superragged-2021-11-01.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-tree-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/rollback/glossary-tree-2021-11-01.sty
Removed Paths:
-------------
trunk/Master/texmf-dist/scripts/glossaries/glossaries.perl
trunk/Master/texmf-dist/tex/latex/glossaries/base/glossaries-2020-03-19.sty
trunk/Master/texmf-dist/tex/latex/glossaries/styles/glossary-list-2020-03-19.sty
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries 2022-10-18 20:52:44 UTC (rev 64741)
@@ -2,13 +2,13 @@
# File : makeglossaries
# Author : Nicola Talbot
-# Version : 4.49
+# Version : 4.50
# Description: simple Perl script that calls makeindex or xindy.
# Intended for use with "glossaries.sty" (saves having to remember
# all the various switches)
# This file is distributed as part of the glossaries LaTeX package.
-# Copyright 2019 Nicola L.C. Talbot
+# Copyright 2007-2022 Nicola L.C. Talbot
# This work may be distributed and/or modified under the
# conditions of the LaTeX Project Public License, either version 1.3
# of this license or any later version.
@@ -28,12 +28,18 @@
# glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty,
# glossary-tree.sty, glossaries-compatible-207.sty,
# glossaries-compatible-307.sty, glossaries-accsupp.sty,
-# glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl.
+# glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.l2h.
# Also makeglossaries and makeglossaries-lite.lua.
-my $version="4.49 (2021-11-01)";
+my $version="4.50 (2022-10-14)";
# History:
+# v4.50:
+# * Added -e (don't fix encap clashes)
+# * Add check for glsignore with encap clashes
+# * Don't fix encap clash if counter or prefix different
+# * Added check for illegal page
+# * Added brazil, brazilian, canadian and canadien mappings
# v4.48-4.49:
# * No change. (Version number updated in line with glossaries.sty)
# v4.47:
@@ -142,9 +148,10 @@
use warnings;
# v2.05 added $opt_d
# v2.08 added $opt_x and $opt_m
+# v4.50 added $opt_e
use vars qw($opt_q $opt_t $opt_o $opt_s $opt_p $opt_g $opt_c $opt_r
$opt_l $opt_i $opt_L $opt_n $opt_C $opt_d $opt_x $opt_m $opt_Q
- $opt_k);
+ $opt_k $opt_e);
$Getopt::Std::STANDARD_HELP_VERSION = 1;
@@ -153,7 +160,7 @@
# .tex file)
# v1.5 added -n (print the command that would be issued but
# don't actually run the command)
-getopts('s:o:t:p:L:C:ilqQkrcgnd:x:m:');
+getopts('s:o:t:p:L:C:ilqQkrcgnd:x:m:e');
unless ($#ARGV == 0)
{
@@ -169,7 +176,11 @@
(
'american' => 'english',
'austrian' => 'german',
+ 'brazil' => 'portuguese',# v4.50
+ 'brazilian' => 'portuguese',# v4.50
'british' => 'english',
+ 'canadian' => 'english',# v4.50
+ 'canadien' => 'french',# v4.50
'francais' => 'french',
'frenchb' => 'french',
'germanb' => 'german',
@@ -242,10 +253,11 @@
"\nRemember to use package option 'nomain' if you don't\n".
"want to use the main glossary.",
#v2.21: fixed spelling of \GlsAddXdyLocation
+#v4.50: added reference to esclocations
'badlocation' =>
"You may have forgotten to add a location \n"
. "class with \\GlsAddXdyLocation or you may have \n"
- . "the format incorrect.\n",
+ . "the format incorrect or you may need \nthe package option esclocations=true.\n",
'comp207' => "You may need to add 'compatible-2.07' package option.",
'noxdyfile' => "Style file not found. (Have you used \\noist by mistake?)"
);
@@ -363,6 +375,8 @@
my $xindyapp = ($opt_x ? $opt_x :'xindy');
my $makeindexapp = ($opt_m ? $opt_m :'makeindex');
+my $fixencapclash = ($opt_e ? 0 : 1);
+
# v2.11 check for backslash character if on Windows
if ($^O=~/Win/)
{
@@ -386,6 +400,8 @@
if ($opt_i)
{
+# This option is of limited use as the basename must be supplied to
+# makeglossaries
$mkidxopts .= " -i";
}
@@ -545,7 +561,7 @@
else
{
&makeindex("$name.$ext",$outfile,$transcript,$istfile,
- $mkidxopts,$opt_q, $opt_n, $makeindexapp, 1);
+ $mkidxopts,$opt_q, $opt_n, $makeindexapp, $fixencapclash);
}
@@ -672,7 +688,7 @@
else
{
&makeindex($inputfile,$outfile,$transcript,
- $istfile,$mkidxopts,$opt_q,$opt_n, $makeindexapp, 1);
+ $istfile,$mkidxopts,$opt_q,$opt_n, $makeindexapp, $fixencapclash);
}
}
}
@@ -952,7 +968,16 @@
}
}
- if ($log=~/\(0 entries accepted,/
+ my $accepted = 1;
+ my $rejected = 0;
+
+ if ($log=~/\((\d+) entries accepted, (\d+) rejected\)/)
+ {
+ $accepted = $1;
+ $rejected = $2;
+ }
+
+ if ($accepted == 0 or $rejected > 0
or ( ($log=~/(\d+) warnings?/ and $1 gt 0))
or $log=~/not found/)
{
@@ -972,8 +997,9 @@
$errno = $xdynotist;
last;
}
- elsif (/## Warning \(.*\):\s*$/)
+ elsif (/## Warning \(.*\):\s*$/ or /^!! Input index error/)
{
+ # v4.50: added check for Input index error
$warnings .= $_ . <TRANS>;
}
}
@@ -1023,7 +1049,7 @@
"\nPossible cause of problem:\n\n". $diagnostic . "\n\n":
"\n"
),
- "Check '$trans' for details\n";
+ "Exit status: $errno. Check '$trans' for details\n";
}
# 2.18: added check and repair for multiple encaps
@@ -1031,14 +1057,96 @@
{
warn $warnings unless $quiet;
- if ($repairencaps and $warnings=~/multiple encaps/)
+ my $multiencaps = $repairencaps and ($warnings=~/multiple encaps/);
+
+ # 4.50: added check for illegal page and cs in page
+
+ my $illegalpage = ($warnings=~/Illegal [A-Za-z]+ (number|digit)/);
+
+ # 'Illegal space within numerals in second argument'
+ # and 'No closing delimiter for second argument' most likely
+ # mean that a command has ended up in the location
+
+ my $csinlocation = ($warnings=~/(Illegal space|No closing delimiter).* second argument/);
+
+ # 4.50: added check for illegal page number
+ if ($multiencaps or $illegalpage or $csinlocation)
{
unless ($quiet)
{
- print "Multiple encaps detected. Attempting to remedy.\n";
+ my $msg = '';
+
+ if ($multiencaps)
+ {
+ $msg = "multiple encaps";
+ }
+
+ if ($illegalpage)
+ {
+ if ($msg)
+ {
+ $msg .= ', ';
+ }
+
+ $msg .= "illegal page number";
+ }
+
+ if ($csinlocation)
+ {
+ if ($msg)
+ {
+ $msg .= ', ';
+ }
+
+ $msg .= "potential LaTeX commands in location";
+ }
+
+ print "Encap/location issue: $msg detected. Attempting to remedy.\n";
+
print "Reading $in...\n";
}
+ my $page_invalid_regex = '[^a-zA-Z0-9\.]';
+ my $pagecomp = '.';
+ my $regexpagecomp = '\.';
+
+ if ($illegalpage)
+ {
+ # get the page compositor from the .ist file
+ if (open INFD, $ist)
+ {
+ while (<INFD>)
+ {
+ if (/page_compositor "(.)"/)
+ {
+ $pagecomp = $1;
+ last;
+ }
+ }
+
+ close INFD;
+ }
+ else
+ {
+ warn "Can't open '$ist' $!\n";
+ }
+
+ if ($pagecomp eq '.' or $pagecomp eq '-'
+ or $pagecomp eq '\\'or $pagecomp eq ']')
+ {
+ $regexpagecomp = "\\$pagecomp";
+ }
+ else
+ {
+ $regexpagecomp = $pagecomp;
+ }
+
+ if ($pagecomp ne '.')
+ {
+ $page_invalid_regex = "[^a-zA-Z0-9$regexpagecomp]";
+ }
+ }
+
# if $in can't be opened at this point something wrong
# has occurred (otherwise how did makeindex manage to open
# it?)
@@ -1049,67 +1157,187 @@
while (<INFD>)
{
- if (/\\glossaryentry\{(.*)\|([^\|]*)\}\{(.*?)\}/)
+ # The encap usually starts with setentrycounter but may have
+ # ( or ) to indicate the start or end of a range.
+ # The encap will be glsseeformat for cross-references.
+ # \glossentry and \subglossentry may be preceded by
+ # \glsnonextpages or \glsnextpages
+
+ if (/\\glossaryentry\{(.*(?:\\glossentry|\\subglossentry\{\d+\}))\{([^\|]*)\}\|([^\|]*)\}\{(.*)\}$/)
{
my %entry =
(
- 'entry' => $1,
- 'encap' => $2,
- 'location' => $3
+ 'entry' => "$1\{$2\}",
+ 'label' => $2,
+ 'encap' => $3,
+ 'location' => $4,
+ 'counter'=>'',
+ 'prefix'=>''
);
- my $add = 1;
+ # Find the page counter (not available with
+ # cross-references)
+ if ($entry{'encap'}=~/setentrycounter\[(.*)\]\{([a-zA-Z0-9]+)\}"\\/)
+ {
+ $entry{'prefix'} = $1;
+ $entry{'counter'} = $2;
+ }
- for (my $idx = 0; $idx <= $#entries; $idx++)
+ # First move any commands out of the location.
+ if ($csinlocation)
{
- my $existing = $entries[$idx];
+ my $loc = $entry{'location'};
+ my $encap = $entry{'encap'};
- if ($entry{'entry'} eq $existing->{'entry'}
- and $entry{'location'} eq $existing->{'location'}
- and $entry{'encap'} ne $existing->{'encap'})
+ # This is only designed for locations in the form
+ # \cs{num} but allow for \protect\cs
+ if ($loc=~m/^(?:\\protect *)?\\([A-Za-z\@]+) *\{(.*)\}$/)
{
- $add = 0 if ($add == 1);
+ my $cs = $1;
+ $loc = $2;
- # Range encaps should take precedence.
+ # Normal glossary indexing will have the encap
+ # start with setentrycounter[prefix]{counter}
+ # This won't match a cross-reference (see) but
+ # that has its location always set to Z.
- if ($entry{'encap'}=~/^[\(\)]/)
+ if ($encap=~/^(setentrycounter\[.*\]\{.*\}"\\)(.*)$/)
{
- $add = 2;
+ $entry{'encap'} = "$1glslocationcstoencap\{$2\}\{$cs\}";
- if ($existing->{'encap'}=~/^[\(\)]/)
+ unless ($quiet)
{
- # too complicated, keep both
-
- last;
+ print "Invalid location '$entry{location}' detected for entry '$entry{label}'. Replaced with '$loc'\n";
}
- else
- {
- # remove existing
+ }
+ elsif (not $quiet)
+ {
+ warn "Invalid location '$entry{location}' detected for entry '$entry{label}' has unexpected encap '$encap'. Location replaced with '$loc'\n";
+ }
- splice @entries, $idx, 1;
+ $entry{'location'} = $loc;
+ }
+ }
- $idx--;
- }
+ if ($illegalpage)
+ {
+ my $loc = $entry{'location'};
+
+ if ($loc=~s/($page_invalid_regex)+/$pagecomp/g)
+ {
+ unless ($quiet)
+ {
+ print "Invalid location '$entry{location}' detected for entry '$entry{label}'. Replaced with '$loc'\n";
}
- elsif ($existing->{'encap'}=~/^[\(\)]/)
+
+ }
+
+ if ($loc=~s/^($regexpagecomp)+//)
+ {
+ unless ($quiet)
{
- if ($entry{'encap'}=~/^[\(\)]/)
- {
- # too complicated, keep both
+ print "Invalid location '$entry{location}' (starts with page compositor) detected for entry '$entry{label}'. Replaced with '$loc'\n";
+ }
+ }
- $add = 1;
- last;
- }
- # (otherwise drop new entry)
+ if ($loc=~s/($regexpagecomp)+$//)
+ {
+ unless ($quiet)
+ {
+ print "Invalid location '$entry{location}' (ends with page compositor) detected for entry '$entry{label}'. Replaced with '$loc'\n";
}
- elsif (&encap_overrides($entry{'encap'},
- $existing->{'encap'}))
+ }
+
+ if ($loc eq '')
+ {
+ unless ($quiet)
{
- $entries[$idx] = \%entry;
+ print "Invalid empty location detected for entry '$entry{label}'. Replaced with 0 (encap: glsignore).\n";
}
- }
+
+ $loc = '0';
+ $entry{'encap'} = 'glsignore';
+ }
+
+ $entry{'location'} = $loc;
}
+ my $add = 1;
+
+ if ($multiencaps)
+ {
+ for (my $idx = 0; $idx <= $#entries; $idx++)
+ {
+ my $existing = $entries[$idx];
+
+ #v4.50: added check for prefix and counter
+ # Since the encap includes the prefix and
+ # counter information, the same location and
+ # format for different counters or prefixes
+ # will be considered an encap clash by
+ # makeindex, but shouldn't be merged.
+
+ if ($entry{'entry'} eq $existing->{'entry'}
+ and $entry{'location'} eq $existing->{'location'}
+ and $entry{'prefix'} eq $existing->{'prefix'}
+ and $entry{'counter'} eq $existing->{'counter'}
+ and $entry{'encap'} ne $existing->{'encap'})
+ {
+ unless ($quiet)
+ {
+ if ($entry{'counter'} eq '' and $entry{'location'} eq 'Z')
+ {
+ print "Encap clash for entry '$entry{label}' possibly caused by multiple cross-reference instances\n";
+ }
+ else
+ {
+ print "Encap clash detected for entry '$entry{label}', counter: '$entry{counter}', location: '$entry{location}'. Encap '$entry{encap}' clashes with '$existing->{'encap'}'\n";
+ }
+ }
+
+ $add = 0 if ($add == 1);
+
+ # Range encaps should take precedence.
+
+ if ($entry{'encap'}=~/^[\(\)]/)
+ {
+ $add = 2;
+
+ if ($existing->{'encap'}=~/^[\(\)]/)
+ {
+ # too complicated, keep both
+
+ last;
+ }
+ else
+ {
+ # remove existing
+
+ splice @entries, $idx, 1;
+
+ $idx--;
+ }
+ }
+ elsif ($existing->{'encap'}=~/^[\(\)]/)
+ {
+ if ($entry{'encap'}=~/^[\(\)]/)
+ {
+ # too complicated, keep both
+
+ $add = 1;
+ last;
+ }
+ # (otherwise drop new entry)
+ }
+ elsif (&encap_overrides($entry{'encap'},
+ $existing->{'encap'}))
+ {
+ $entries[$idx] = \%entry;
+ }
+ }
+ }
+ }
+
push @entries, \%entry if $add > 0;
}
else
@@ -1156,10 +1384,20 @@
# 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
+# 4.50 add check for glsignore
sub encap_overrides{
my ($newencap, $existing) = @_;
+ if ($newencap=~/\\glsignore\s*$/)
+ {
+ return 0;
+ }
+ elsif ($existing=~/\\glsignore\s*$/)
+ {
+ return 1;
+ }
+
($existing=~/\\glsnumberformat\s*$/ or $newencap!~/\\glsnumberformat\s*$/ )
}
@@ -1189,58 +1427,114 @@
}
# most languages work with xindy's default codepage, but
- # some don't, so if the codepage isn't specific, check
+ # some don't, so if the codepage isn't specified, check
# the known cases that will generate an error
# and supply a default. (For all other cases, it's up to the
# user to supply a codepage.)
+ #
+ # Now that glossaries.sty v4.50 will default to 'utf8' if
+ # \inputencodingname hasn't been defined or is empty, this also
+ # needs to check 'utf8'.
# v2.01 changed 'if ($codepage eq "")' to 'unless ($codepage)'
- unless ($codepage)
+# v4.50 changed to conditional to include encoding without modifiers
+
+ if ($codepage eq '' or $codepage=~/^utf8|latin\d+|cp\d+$/)
{
if ($language eq 'dutch')
{
- $codepage = "ij-as-ij";
+ if ($codepage eq '')
+ {
+ $codepage = "ij-as-ij";
+ }
+ else
+ {
+ $codepage = "ij-as-ij-$codepage";
+ }
}
elsif ($language eq 'german')
{
- $codepage = "din5007";
+ if ($codepage eq '')
+ {
+ $codepage = "din5007";
+ }
+ else
+ {
+ $codepage = "din5007-$codepage";
+ }
}
elsif ($language eq 'gypsy')
{
- $codepage = "northrussian";
+ if ($codepage eq '')
+ {
+ $codepage = "northrussian";
+ }
+ else
+ {
+ $codepage = "northrussian-$codepage";
+ }
}
- elsif ($language eq 'hausa')
+ elsif ($language eq 'hausa' and $codepage eq '')
{
- $codepage = "utf";
+ $codepage = "utf8";
}
- elsif ($language eq 'klingon')
+ elsif ($language eq 'klingon' and $codepage eq '')
{
- $codepage = "utf";
+ $codepage = "utf8";
}
- elsif ($language eq 'latin')
+ elsif ($language eq 'latin' and $codepage eq '')
{
- $codepage = "utf";
+ $codepage = "utf8";
}
elsif ($language eq 'mongolian')
{
- $codepage = "cyrillic";
+ if ($codepage eq '')
+ {
+ $codepage = "cyrillic";
+ }
+ else
+ {
+ $codepage = "cyrillic-$codepage";
+ }
}
elsif ($language eq 'slovak')
{
- $codepage = "small";
+ if ($codepage eq '')
+ {
+ $codepage = "small";
+ }
+ else
+ {
+ $codepage = "small-$codepage";
+ }
}
elsif ($language eq 'spanish')
{
- $codepage = "modern";
+ if ($codepage eq '')
+ {
+ $codepage = "modern";
+ }
+ else
+ {
+ $codepage = "modern-$codepage";
+ }
}
elsif ($language eq 'vietnamese')
{
- $codepage = "utf";
+ if ($codepage eq '')
+ {
+ $codepage = "utf8";
+ }
+ else
+ {
+ $codepage = "utf8-$codepage";
+ }
}
}
elsif ($language eq 'german' and $codepage!~/(din5007|duden|braille)/)
{
#v2.16 added check for german din/duden
+#v4.50 now redundant? may be removed in the next version
$codepage = "din5007-$codepage";
}
@@ -1535,6 +1829,7 @@
print "(See makeindex documentation for further details on these ";
print "options.)\n\n";
print "-c\t\tCompress intermediate blanks.\n";
+ print "-e\t\tDon't attempt to fix multiple encaps.\n";
print "-g\t\tEmploy German word ordering.\n";
print "-p <num>\tSet the starting page number to be <num>.\n";
print "-r\t\tDisable implicit page range formation.\n";
@@ -1567,7 +1862,7 @@
B<makeglossaries> [B<-o> I<file>] [B<-q>] [B<-Q>] [B<-k>] [B<-n>]
[B<-s> I<file>] [B<-t> I<file>] [B<-L> I<language>] [B<-c>] [B<-g>] [B<-l>]
[B<-p> I<num>] [B<-r>] [B<-d> I<aux dir>] [B<-m> I<file>] [B<-x> I<file>]
-[B<--version>] [B<--help>] I<basename>
+[B<-e>] [B<--version>] [B<--help>] I<basename>
=head1 DESCRIPTION
@@ -1584,39 +1879,28 @@
=over 4
-=item B<-q>
+=item B<-e>
-Quiet mode. Reduces chatter to standard output.
+Don't attempt to repair multiple encaps or illegal page number (B<makeindex> only).
-=item B<-Q>
+=item B<-c>
-Silences warning about being unable to fork.
+Compress intermediate blanks (B<makeindex> only).
-=item B<-k>
+=item B<-d> I<aux dir>
-Don't try forking with piped redirection. (Lessens the
-effect of -q)
+Specify the directory the .aux, .glo etc files are located.
+Defaults to the parent directory of the base file I<filename>.
-=item B<-n>
+=item B<-g>
-Print the commands that would normally be executed but don't run them.
+Employ German word ordering (B<makeindex> only).
-=item B<-o> I<file>
+=item B<-k>
-Use I<file> as the output file. (Only suitable for documents
-containing a single glossary, otherwise each glossary will be
-overridden.)
+Don't try forking with piped redirection. (Lessens the
+effect of -q)
-=item B<-s> I<file>
-
-Use I<file> as the style file. Note that if you use this option,
-you need to know whether B<makeindex> or B<xindy> will be called, as
-they have different style files.
-
-=item B<-t> I<file>
-
-Use I<file> as the transcript file.
-
=item B<-l>
Letter ordering.
@@ -1626,31 +1910,46 @@
This option only has an effect if B<xindy> is called. Sets the
language. See B<xindy> documentation for further details.
-=item B<-c>
+=item B<-m> I<file>
-Compress intermediate blanks (B<makeindex> only).
+Specify the full path name for B<makeindex> to I<file> in the
+event that B<makeindex> isn't on the operating system's path.
-=item B<-g>
+=item B<-n>
-Employ German word ordering (B<makeindex> only).
+Print the commands that would normally be executed but don't run them.
+=item B<-o> I<file>
+
+Use I<file> as the output file. (Only suitable for documents
+containing a single glossary, otherwise each glossary will be
+overridden.)
+
=item B<-p> I<num>
Sets the starting page number to be I<num> (B<makeindex> only).
+=item B<-q>
+
+Quiet mode. Reduces chatter to standard output.
+
+=item B<-Q>
+
+Silences warning about being unable to fork.
+
=item B<-r>
-Disable implicit page range formation (B<makeindex> only).
+=item B<-s> I<file>
-=item B<-d> I<aux dir>
+Use I<file> as the style file. Note that if you use this option,
+you need to know whether B<makeindex> or B<xindy> will be called, as
+they have different style files.
-Specify the directory the .aux, .glo etc files are located.
-Defaults to the parent directory of the base file I<filename>.
+=item B<-t> I<file>
-=item B<-m> I<file>
+Use I<file> as the transcript file.
-Specify the full path name for B<makeindex> to I<file> in the
-event that B<makeindex> isn't on the operating system's path.
+Disable implicit page range formation (B<makeindex> only).
=item B<-x> I<file>
Modified: trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Build/source/texk/texlive/linked_scripts/glossaries/makeglossaries-lite.lua 2022-10-18 20:52:44 UTC (rev 64741)
@@ -14,7 +14,7 @@
use the Perl makeglossaries script.
This file is distributed as part of the glossaries LaTeX package.
- Copyright 2019 Nicola L.C. Talbot
+ Copyright 2015-2022 Nicola L.C. Talbot
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or any later version.
@@ -32,11 +32,11 @@
glossary-mcols.sty, glossary-super.sty, glossary-superragged.sty,
glossary-tree.sty, glossaries-compatible-207.sty,
glossaries-compatible-307.sty, glossaries-accsupp.sty,
- glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.perl.
+ glossaries-babel.sty, glossaries-polyglossia.sty, glossaries.l2h.
Also makeglossaries and makeglossaries-lite.lua.
History:
- * 4.48 - 4.49:
+ * 4.48 - 4.50:
- no change.
* 4.47:
- Added hybrid instructions if record option detected but not \makeglossaries
@@ -70,7 +70,7 @@
- changed first line from lua to texlua
--]]
-thisversion = "4.49 (2021-11-01)"
+thisversion = "4.50 (2022-10-14)"
quiet = false
dryrun = false
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/CHANGES 2022-10-18 20:52:44 UTC (rev 64741)
@@ -1,5 +1,148 @@
glossaries change log:
+v4.50 (2022-10-14):
+
+ * glossaries.sty:
+
+ - Case-changing support now tries to detect the new mfirstuc.sty v2.08
+ commands. If available:
+
+ - exclusions, blockers and mappings will be established for \makefirstuc.
+
+ - \mfirstucMakeUppercase won't be redefined (since it will now be using
+ \text_uppercase:n instead of \MakeUppercase)
+
+ - textcase.sty (which is now deprecated) won't be loaded. All
+ the functionality of textcase is now pre-provided with
+ recent LaTeX kernels.
+
+ If an older version of mfirstuc is present, textcase will be
+ loaded and the old limitations of \makefirstuc will still apply
+ (most notably, the requirement to group any leading UTF-8 character).
+
+ For the best support, ensure you have mfirstuc v2.08 and
+ glossaries-extra v1.49 when they become available.
+
+ - new command \glssentencecase used for sentence-casing. Default
+ definition uses \makefirstuc but may be redefined to use
+ \MFUsentencecase if preferred.
+
+ - \glsentrytitlecase, \Glsentryname etc now expand to sentence case
+ in PDF bookmarks
+
+ - new package option mfirstuc implements expanded/unexpanded options
+ provided by mfirstuc v2.08+
+
+ - new commands \glslowercase and \glsuppercase
+
+ - The default setting for esclocations and \ifglswrallowprimitivemods
+ is now false. If a document requiring xindy has locations that expand to
+ robust commands you may need to switch these on or see the
+ "Problematic Locations" section of the user manual.
+
+ - new commands used by \glshypernumber:
+
+ \glswrglosslocationtarget
+ \glswrglossdisableanchorcmds
+
+ - added \glswrglossdisablelocationcmds to disable commands when
+ writing locations to the glossary file.
+
+ - \glsaddprotectedpagefmt now only has an effect with
+ esclocations=true
+
+ - automake package option has new options:
+
+ automake=makegloss -> use makeglossaries
+ automake=lite -> use makeglossaries-lite
+ automake=delayed -> formerly automake=true
+
+ automake=true is now a deprecated synonym of automake=delayed
+
+ If the value isn't specified the default is now
+ automake=immediate instead of automake=true since the immediate
+ setting is more reliable.
+
+ Note that neither makeglossaries nor makeglossaries-lite are on
+ the list of trusted applications, so the unrestricted shell escape
+ will be required with these options.
+
+ - if the automake package option is used with LuaLaTeX, the
+ shellesc package will automatically be loaded. Note that if you
+ specify automake in \setupglossaries, you'll need to explicitly
+ load shellesc
+
+ - Bug fix #196: xindy codepage now defaults to utf8 if
+ \inputencodingname isn't defined
+
+ - Bug fix #189: setting mathrel category gives ordinary spacing instead of mathrel spacing
+ https://www.dickimaw-books.com/bugtracker.php?key=194
+
+ This bug fix has introduced a new command \glsencapwrcontent
+ which adds grouping around the indexing whatsit. If this
+ grouping causes a problem redefine it without the grouping:
+
+ \renewcommand*{\glsencapwrcontent}[1]{#1}
+
+ - Bug fix #195: Conflict if xtab is loaded
+ https://www.dickimaw-books.com/bugtracker.php?key=195
+
+ If xtab has been loaded, nosuper is automatically implemented
+
+ - Bug fix #191: local \gls option not localised
+ https://www.dickimaw-books.com/bugtracker.php?key=191
+
+ - Bug fix: \GlsAddXdyCounters causes duplicate attribute
+ definitions in the .xdy file
+
+ - Bug fix: \newacronym longplural using incorrect plural suffix
+ (\acrpluralsuffix instead of \glspluralsuffix)
+
+ - Bug fix: removed inappropriate \acronymfont from around long form
+ of dua-desc style
+
+ - Added \glsshowtargetinner and \glsdoshowtarget (debug=target)
+
+ - Added package option languages
+
+ - Corrected kernelredefs choice internal commands
+
+ - Added check for \nofiles
+
+ - Entry counting now has associated conditional \ifglsresetcurrcount
+ which determines whether or not to set the counter back to 0
+ when the first use flag is reset. (This has also been added to
+ glossaries-extra v1.49.) The default is false, which is a change
+ in behaviour to previous versions.
+
+ - added sort=clear option
+
+ - added \glsindexingsetting
+
+ - added \ifglsfieldvoid
+
+ - added \glsnoidxprenumberlist (fixed nonumberlist key with
+ "noidx" indexing)
+
+ - compatibility options compatible-3.07 and compatible-2.07 are no
+ longer available. Use rollback for backward-compatibility.
+
+ - deprecated acronym style package options
+ 'description', 'footnote', 'smaller', 'smallcaps', 'dua'
+ no longer available. Use rollback for backward-compatibiliy.
+
+ * glossary-inline.sty:
+
+ - added \glsinlineifhaschildren
+
+ * makeglossaries:
+
+ - added -e switch (don't attempt to repair multiple encaps)
+
+ - added check for \glsignore when repairing multiple encaps
+
+ - added check and repair for illegal page number/digit messages
+
v4.49 (2021-11-01):
* glossary-list.sty:
@@ -1075,7 +1218,7 @@
- Added \par to end of theglossary environment for index style.
(http://www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=38)
-v3.07:
+v3.07 (2013-07-05):
* glossaries.sty
@@ -1329,7 +1472,7 @@
* added more diagnostics to give more helpful messages than
those supplied by xindy or makeindex.
-v2.07:
+v2.07 (2010-07-10):
* Fixed bug that ignored format key in \glsadd
Added: trunk/Master/texmf-dist/doc/latex/glossaries/DEPENDS.txt
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/DEPENDS.txt (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/DEPENDS.txt 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,8 @@
+amsmath
+datatool
+etoolbox
+ifthen
+mfirstuc
+tracklang
+xfor
+xkeyval
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/DEPENDS.txt
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/README.md 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/README.md 2022-10-18 20:52:44 UTC (rev 64741)
@@ -1,4 +1,4 @@
-# glossaries v4.49 (2021-11-01)
+# glossaries v4.50 (2022-10-14)
Author: Nicola Talbot ([contact](http://www.dickimaw-books.com/contact))
@@ -8,7 +8,7 @@
See http://www.ctan.org/license/lppl1.3
for the details of that license.
-Copyright 2007-2021 Nicola Talbot
+Copyright 2007-2022 Nicola Talbot
## DESCRIPTION
@@ -117,12 +117,3 @@
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.
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-code.pdf
===================================================================
(Binary files differ)
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,43 @@
+% This file is embedded in glossaries-user.pdf
+% Example 1 Simple document with no glossary
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[
+ sort=none % no sorting or indexing required
+ ] {glossaries}
+
+\newglossaryentry
+{cafe}% label
+ {% definition:
+ name={café},
+ description={small restaurant selling refreshments}
+}
+
+\setacronymstyle{long-short} \newacronym
+{html}% label
+ {HTML}% short form
+ {hypertext markup language}% long form
+
+
+\newglossaryentry
+{pi}% label
+ {% definition:
+ name={\ensuremath{\pi}},
+ description={Archimedes' Constant}
+}
+
+% This is a trivial example. For a real document I recommend you use siunitx for units
+ \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}.
+
+\Gls{distance} (\glsentrydesc{distance}) is measured in \glssymbol{distance}.
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example001.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,41 @@
+% This file is embedded in glossaries-user.pdf
+% Example 2 Simple document with unsorted glossaries
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\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
+ stylemods,style=index % set the default glossary style
+ ]{glossaries-extra}
+
+\newglossaryentry % glossaries.sty
+{cafe}% label
+ {% definition:
+ name={café},
+ description={small restaurant selling refreshments}
+}
+
+\setabbreviationstyle{long-short}% glossaries-extra.sty
+\newabbreviation % glossaries-extra.sty
+{html}% label
+ {HTML}% short form
+ {hypertext markup language}% long form
+ % requires glossaries-extra.sty 'symbols' option
+ \glsxtrnewsymbol [description={Archimedes' constant}]% options
+ {pi}% label
+ {\ensuremath{\pi}}% symbol
+ % This is a trivial example. For a real document I recommend you use siunitx for units
+ \newglossaryentry % glossaries.sty
+{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}.
+
+\Gls{distance} is measured in \glssymbol{distance}.
+\printunsrtglossaries % list all defined entries
+
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example002.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,29 @@
+% This file is embedded in glossaries-user.pdf
+% Example 3 Simple document that uses TeX\ to sort entries
+% arara: pdflatex
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[style=indexgroup]{glossaries}
+\makenoidxglossaries % use TeX to sort
+ \newglossaryentry{parrot}{name={parrot},
+ description={a brightly coloured tropical bird}}
+\newglossaryentry{duck}{name={duck},
+ description={a waterbird}}
+\newglossaryentry{puffin}{name={puffin},
+ description={a seabird with a brightly coloured bill}}
+\newglossaryentry{penguin}{name={penguin},
+ description={a flightless black and white seabird}}
+% a symbol:
+ \newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ sort={alpha},description={a variable}}
+% an acronym:
+ \setacronymstyle{short-long}
+ \newacronym{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+\begin{document}
+\Gls{puffin}, \gls{duck} and \gls{parrot}.
+\gls{arpanet} and \gls{alpha}.
+Next use: \gls{arpanet}.
+\printnoidxglossary
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example003.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,30 @@
+% This file is embedded in glossaries-user.pdf
+% Example 4 Simple document that uses makeindex to sort entries
+% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[style=indexgroup]{glossaries}
+\makeglossaries % open \dglspl {indexingfile}
+ \newglossaryentry{parrot}{name={parrot},
+ description={a brightly coloured tropical bird}}
+\newglossaryentry{duck}{name={duck},
+ description={a waterbird}}
+\newglossaryentry{puffin}{name={puffin},
+ description={a seabird with a brightly coloured bill}}
+\newglossaryentry{penguin}{name={penguin},
+ description={a flightless black and white seabird}}
+% a symbol:
+ \newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ sort={alpha},description={a variable}}
+% an acronym:
+ \setacronymstyle{short-long}
+ \newacronym{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+\begin{document}
+\Gls{puffin}, \gls{duck} and \gls{parrot}.
+\gls{arpanet} and \gls{alpha}.
+Next use: \gls{arpanet}.
+\printglossary
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example004.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,30 @@
+% This file is embedded in glossaries-user.pdf
+% Example 5 Simple document that uses xindy to sort entries
+% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[xindy,style=indexgroup]{glossaries}
+\makeglossaries % open \dglspl {indexingfile}
+ \newglossaryentry{parrot}{name={parrot},
+ description={a brightly coloured tropical bird}}
+\newglossaryentry{duck}{name={duck},
+ description={a waterbird}}
+\newglossaryentry{puffin}{name={puffin},
+ description={a seabird with a brightly coloured bill}}
+\newglossaryentry{penguin}{name={penguin},
+ description={a flightless black and white seabird}}
+% a symbol:
+ \newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ sort={alpha},description={a variable}}
+% an acronym:
+ \setacronymstyle{short-long}
+ \newacronym{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+\begin{document}
+\Gls{puffin}, \gls{duck} and \gls{parrot}.
+\gls{arpanet} and \gls{alpha}.
+Next use: \gls{arpanet}.
+\printglossary
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example005.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,44 @@
+% This file is embedded in glossaries-user.pdf
+% Example 6 Simple document that uses bib2gls to sort entries
+% arara: pdflatex
+% arara: bib2gls
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\begin{filecontents*}{sample-entries.bib}
+ at entry{parrot,
+ name={parrot},
+ description={a brightly coloured tropical bird}
+}
+ at entry{duck,
+ name={duck},
+ description={a waterbird}
+}
+ at entry{puffin,
+ name={puffin},
+ description={a seabird with a brightly coloured bill}
+}
+ at entry{penguin,
+ name={penguin},
+ description={a flightless black and white seabird}
+}
+ at symbol{alpha,
+ name={\ensuremath{\alpha}},
+ description={a variable}
+}
+ at abbreviation{arpanet,
+ short={ARPANET},
+ long={Advanced Research Projects Agency Network}
+}
+\end{filecontents*}
+\usepackage[record,style=indexgroup]{glossaries-extra}
+\setabbreviationstyle{short-long}
+\GlsXtrLoadResources[src={sample-entries}]% data in sample-entries.bib
+
+\begin{document}
+\Gls{puffin}, \gls{duck} and \gls{parrot}.
+\gls{arpanet} and \gls{alpha}.
+Next use: \gls{arpanet}.
+\printunsrtglossary
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example006.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,28 @@
+% This file is embedded in glossaries-user.pdf
+% Example 7 Simple document with an unsorted list of all defined entries
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[style=indexgroup]{glossaries-extra}
+\newglossaryentry{parrot}{name={parrot},
+ description={a brightly coloured tropical bird}}
+\newglossaryentry{duck}{name={duck},
+ description={a waterbird}}
+\newglossaryentry{puffin}{name={puffin},
+ description={a seabird with a brightly coloured bill}}
+\newglossaryentry{penguin}{name={penguin},
+ description={a flightless black and white seabird}}
+% a symbol:
+ \newglossaryentry{alpha}{name={\ensuremath{\alpha}},
+ sort={alpha},description={a variable}}
+% an abbreviation:
+ \setabbreviationstyle{short-long}
+\newabbreviation{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+\begin{document}
+\Gls{puffin}, \gls{duck} and \gls{parrot}.
+\gls{arpanet} and \gls{alpha}.
+Next use: \gls{arpanet}.
+% entries are listed in order of definition
+ \printunsrtglossary
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example007.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,39 @@
+% This file is embedded in glossaries-user.pdf
+% Example 8 Simple document with standalone entries
+% arara: pdflatex
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[colorlinks]{hyperref}
+\usepackage[sort=none,
+ nostyles% <- no glossary styles are required
+ ]{glossaries-extra}
+
+\newglossaryentry{set}{name={set},
+ description={a collection of any kind of objects},
+ symbol={\ensuremath{\mathcal{S}}}
+}
+
+\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)}} }
+\newcommand*{\termdef}[1]{%
+ \section{\glsxtrglossentry{#1} \glsentrysymbol{#1}}%
+ \begin{quote}\em\Glsentrydesc{#1}.\end{quote}%
+}
+\begin{document}
+\tableofcontents
+
+\section{Introduction}
+Sample document about \glspl{function} and \glspl{set}.
+
+\termdef{set}
+
+More detailed information about \glspl{set} with examples.
+
+\termdef{function}
+
+More detailed information about \glspl{function} with examples.
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example008.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,15 @@
+% This file is embedded in glossaries-user.pdf
+% Example 22 Simple document with acronyms
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage{glossaries}
+\setacronymstyle{long-short}
+\newacronym{html}{HTML}{hypertext markup language}
+\newacronym{xml}{XML}{extensible markup language}
+\begin{document}
+First use: \gls{html} and \gls{xml}.
+
+Next use: \gls{html} and \gls{xml}.
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example022.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,16 @@
+% This file is embedded in glossaries-user.pdf
+% Example 23 Defining and Using an Acronym
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage{glossaries}
+\setacronymstyle{long-short}
+\newacronym{idn}{IDN}{identification number}
+\begin{document}
+First use: \gls{idn}. Next use: \gls{idn}.
+
+\glsreset{idn}% reset first use
+ The \gls{idn}['s] prefix is a capital letter.
+Next use: the \gls{idn}['s] prefix is a capital letter.
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example023.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,16 @@
+% This file is embedded in glossaries-user.pdf
+% Example 24 Defining and Using an Acronym (Rollback)
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage{glossaries}[=v4.46]% rollback to v4.46
+ % no \setacronymstyle so old style used
+ \newacronym{idn}{IDN}{identification number}
+\begin{document}
+First use: \gls{idn}. Next use: \gls{idn}.
+
+\glsreset{idn}% reset first use
+ The \gls{idn}['s] prefix is a capital letter.
+Next use: the \gls{idn}['s] prefix is a capital letter.
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example024.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,12 @@
+% This file is embedded in glossaries-user.pdf
+% Example 25 Small-Caps Acronym
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage{glossaries}
+\setacronymstyle{long-sc-short}
+\newacronym{mathml}{MathML}{mathematical markup language}
+\begin{document}
+\acrshort{mathml}
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example025.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png 2022-10-18 20:52:44 UTC (rev 64741)
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.tex (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.tex 2022-10-18 20:52:44 UTC (rev 64741)
@@ -0,0 +1,31 @@
+% This file is embedded in glossaries-user.pdf
+% Example 30 Don't index entries that are only used once
+% arara: pdflatex
+% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+% arara: pdfcrop
+\documentclass[12pt]{article}
+\pagestyle{empty}
+\usepackage[colorlinks]{hyperref}
+\usepackage[acronym]{glossaries}
+\makeglossaries
+
+\glsenableentrycount
+
+\setacronymstyle{long-short}
+
+\newacronym{html}{HTML}{hypertext markup language}
+\newacronym{css}{CSS}{cascading style sheets}
+\newacronym{xml}{XML}{extensible markup language}
+\newacronym{sql}{SQL}{structured query language}
+\newacronym{rdbms}{RDBMS}{relational database management system}
+\newacronym{rdsms}{RDSMS}{relational data stream management system}
+\begin{document}
+These entries are only used once: \cgls{sql}, \cgls{rdbms},
+\cgls{xml}. These entries are used multiple times:
+\cgls{html}, \cgls{html}, \cgls{css}, \cgls{css}, \cgls{css},
+\cgls{rdsms}, \cgls{rdsms}.
+
+\printglossaries
+\end{document}
Property changes on: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user-examples/glossaries-user-example030.tex
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html
===================================================================
--- trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html 2022-10-18 20:50:45 UTC (rev 64740)
+++ trunk/Master/texmf-dist/doc/latex/glossaries/glossaries-user.html 2022-10-18 20:52:44 UTC (rev 64741)
@@ -1,49888 +1,16735 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
-<html xmlns="http://www.w3.org/1999/xhtml"
->
-<head><title></title>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="TeX4ht (https://tug.org/tex4ht/)" />
-<meta name="originator" content="TeX4ht (https://tug.org/tex4ht/)" />
-<!-- xhtml,fn-in,css-in,uni-html4,utf8 -->
-<meta name="src" content="glossaries-user.tex" />
+ <!DOCTYPE html>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta name="generator" content="TeX Parser Library">
+<!-- MathJax -->
+<script type="text/x-mathjax-config">
+MathJax.Hub.Config({tex2jax:
+{
+ inlineMath: [['\\(','\\)']],
+ displayMath: [ ['\\[','\\]'] ]
+}});
+</script>
+<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+</script>
+ !
!
<title>User Manual for glossaries.sty v4.50</title>
+<style type="text/css">
+#main {margin-left: 5%; margin-right: 15%}
+div.tomain {position: absolute; left: 0pt; width: 5%; text-align: right; font-size: x-small;}
+div.tomain a {text-decoration: none;}
+div.labellink {display: inline; font-size: x-small; margin-left: 1em; margin-right: 1em;}
+div.marginleft {position: absolute; left: 0pt; width: 5%;}
+div.marginright {position: absolute; right: 0pt; width: 15%;}
+div.displaymath { display: block; text-align: center; }
+span.eqno { float: right; }
+div.table { display: block; text-align: center; }
+table.tabular-cm
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: center;
+ vertical-align: middle;
+}
+table.tabular-cb
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: center;
+ vertical-align: bottom;
+}
+table.tabular-ct
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: center;
+ vertical-align: top;
+}
+table.tabular-lm
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: left;
+ vertical-align: middle;
+}
+table.tabular-lb
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: left;
+ vertical-align: bottom;
+}
+table.tabular-lt
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: left;
+ vertical-align: top;
+}
+table.tabular-rm
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: right;
+ vertical-align: middle;
+}
+table.tabular-rb
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: right;
+ vertical-align: bottom;
+}
+table.tabular-rt
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: right;
+ vertical-align: top;
+}
+table.tabular-m
+{
+ display: inline-table;
+ border-collapse: collapse;
+ vertical-align: middle;
+}
+table.tabular-b
+{
+ display: inline-table;
+ border-collapse: collapse;
+ vertical-align: bottom;
+}
+table.tabular-t
+{
+ display: inline-table;
+ border-collapse: collapse;
+ vertical-align: top;
+}
+table.tabular-l
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: left;
+}
+table.tabular-c
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: center;
+}
+table.tabular-r
+{
+ display: inline-table;
+ border-collapse: collapse;
+ align: right;
+}
+pre { white-space: pre-wrap; }
+div.figure { display: block; text-align: center; }
+div.caption { display: block; text-align: center; }
+div.marginpar { float: right; }
+div.abstract { display: block; margin-right: 4em; margin-left: 4em;}
+div.title { display: block; text-align: center; font-size: x-large;}
+div.author { display: block; text-align: center; font-size: large;}
+div.date { display: block; text-align: center; font-size: medium;}
+div.bibliography { display: block; margin-left: 4em; }
+div.bibitem { display: inline; float: left; text-indent: -3em; }
+span.numberline { display: inline-block; width: 3em; }
+.toc-subsection span.numberline { display: inline-block; width: 3em; }
+.toc-subsubsection span.numberline { display: inline-block; width: 4em; }
+.toc-paragraph span.numberline { display: inline-block; width: 5em; }
+.toc-subparagraph span.numberline { display: inline-block; width: 6em; }
+nav ul { list-style-type: none; }
+.toc-part { padding-left: 0em; padding-bottom: 1ex; padding-top: 1ex; font-weight: bold; font-size: large;}
+.toc-chapter { padding-left: 0em; padding-bottom: .25ex; padding-top: .25ex; font-weight: bold; }
+.toc-section { padding-left: .5em; }
+.toc-subsection { padding-left: 1.5em; }
+.toc-subsubsection { padding-left: 2em; }
+.toc-paragraph { padding-left: 2.5em; }
+.toc-subparagraph { padding-left: 3em; }
+.part { font-size: x-large; font-weight: bold; }
+div.bigskip { padding-left: 0pt; padding-right: 0pt; padding-top: 0pt; padding-bottom: 2ex;}
+div.medskip { padding-left: 0pt; padding-right: 0pt; padding-top: 0pt; padding-bottom: 1ex;}
+div.smallskip { padding-left: 0pt; padding-right: 0pt; padding-top: 0pt; padding-bottom: .5ex;}
+span.quad { padding-left: 0pt; padding-right: 1em; padding-top: 0pt; padding-bottom: 0pt;}
+span.qquad { padding-left: 0pt; padding-right: 2em; padding-top: 0pt; padding-bottom: 0pt;}
+.displaylist { display: block; list-style-type: none; }
+.inlinelist { display: inline; }
+dl.inlinetitle dt { display: inline-block; margin-left: 0; margin-right: 1em;}
+dl.inlinetitle dd { display: inline; margin: 0; }
+dl.inlinetitle dd::after { display: block; content: ''; }
+dl.inlineblock dt { display: inline-block; margin-left: 0; margin-right: 1em;}
+dl.inlineblock dd { display: inline; margin: 0; }
+dl.inlineblock dd::after { display: block; content: ''; }
+.clearfix::after { content: ""; clear: both; display: table; }
+span.inlineitem { margin-right: .5em; margin-left: .5em; }
+span.numitem { float: left; margin-left: -3em; text-align: right; min-width: 2.5em; }
+span.bulletitem { float: left; margin-left: -1em; }
+span.descitem { font: normal; font-weight: bold; }
+div.indexspace { min-height: 2ex; }
+.cell-noborder-nosep-r {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 0px; text-align: right; }
+.cell-noborder-bothsep-l {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-bothsep-r {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 6.000000pt; text-align: right; }
+.cell-noborder-bothsep-halfwidth {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 50.000000%; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-nosep-l {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 0px; text-align: left; }
+.cell-noborder-rightsep-l {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 0px; text-align: left; }
+.cell-noborder-leftsep-r {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 0px; text-align: right; }
+.cell-noborder-bothsep-c {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 6.000000pt; text-align: center; }
+.cell-noborder-bothsep-eightypc {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 80.000000%; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-rightsep-c {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 6.000000pt; text-align: center; }
+.cell-noborder-bothsep-threequarterwidth {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 75.000000%; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-rightsep-r {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 6.000000pt; text-align: right; }
+.cell-noborder-bothsep-quarterwidth {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 25.000000%; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-rightsep-c {border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; padding-right: 0px; text-align: center; }
+.cell-noborder-rightsep-l {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 6.000000pt; text-align: left; }
+.cell-noborder-nosep-c {border-top: none; border-right: none; border-left: none; padding-left: 0px; padding-right: 0px; text-align: center; }
+span.mbox {border-style: none; }
+span.frame {border-style: solid; border-width: 1.000000pt; padding: 0.000000pt; }
+span.boxed {text-align: center; vertical-align: middle; border-style: solid; border-width: 2.000000pt; padding: 0.000000pt; width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.circled {text-align: center; vertical-align: middle; border-style: solid; border-width: 2.000000pt; padding: 1.000000pt; border-radius: 5000.000000%;width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.overlapped {text-align: center; border-style: none; padding: 0.000000pt; width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.overlapper {text-align: center; border-style: none; padding: 0.000000pt; margin-left: -1.000000em; width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.overlappertop {text-align: center; vertical-align: top; border-style: none; padding: 0.000000pt; margin-left: -1.000000em; width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.partialoverlapper {text-align: center; border-style: none; padding: 0.000000pt; margin-left: -0.750000em; width: 1.000000em; height: 1.000000em; display: inline-block; }
+span.quarterleft {text-align: center; vertical-align: middle; border-style: none; padding: 0.000000pt; transform: rotate(-90.000000deg); -ms-transform: rotate(-90.000000deg); -webkit-transform: rotate(-90.000000deg); display: inline-block; }
+span.quarterright {text-align: center; vertical-align: middle; border-style: none; padding: 0.000000pt; transform: rotate(90.000000deg); -ms-transform: rotate(90.000000deg); -webkit-transform: rotate(90.000000deg); display: inline-block; }
+span.eighthleft {text-align: center; vertical-align: middle; border-style: none; padding: 0.000000pt; transform: rotate(-45.000000deg); -ms-transform: rotate(-45.000000deg); -webkit-transform: rotate(-45.000000deg); display: inline-block; }
+span.eighthright {text-align: center; vertical-align: middle; border-style: none; padding: 0.000000pt; transform: rotate(45.000000deg); -ms-transform: rotate(45.000000deg); -webkit-transform: rotate(45.000000deg); display: inline-block; }
+span.halfturn {text-align: center; vertical-align: middle; border-style: none; padding: 0.000000pt; transform: rotate(180.000000deg); -ms-transform: rotate(180.000000deg); -webkit-transform: rotate(180.000000deg); display: inline-block; }
+span.fwsdisabledicon {border-style: none; color: gray; }
+span.fwsactiveicon {border-style: none; color: green; }
+span.glsshowtargetfonttext {font-family: monospace; font-size: x-small; border-style: none; }
+dfn { font-style: normal; font-weight: bold; } a { text-decoration: none; } a:hover { text-decoration: underline; } div.tablefns { border-top: solid; } div.example { border-bottom: solid silver; padding: 20px; } div.example div.title { font-weight: bold; font-size: large; }
+div.sidenote {font-size: x-small; float: right; border-style: none; }
+span.advantage {border-style: none; color: green; }
+span.disadvantage {border-style: none; color: red; }
+strong.strong {font-weight: bold; border-style: none; }
+em.booktitle {font-style: italic; font-variant: normal; border-style: none; }
+code.code {font-family: monospace; border-style: none; }
+code.cmd {font-family: monospace; border-style: none; }
+span.cmdfmt {font-family: monospace; border-style: none; }
+span.comment {border-style: none; color: rgb(94,94,94); }
+code.csfmt {font-family: monospace; border-style: none; color: rgb(84,111,26); }
+span.csfmtfont {font-family: monospace; border-style: none; }
+span.csfmtcolourfont {font-family: monospace; border-style: none; color: rgb(84,111,26); }
+span.appfmt {font-family: monospace; border-style: none; }
+span.styfmt {font-family: monospace; border-style: none; }
+span.clsfmt {font-family: monospace; border-style: none; }
+span.envfmt {font-family: monospace; border-style: none; }
+span.optfmt {font-family: monospace; border-style: none; }
+span.csoptfmt {font-family: monospace; border-style: none; color: rgb(104,34,139); }
+span.styoptfmt {font-family: monospace; border-style: none; color: rgb(104,34,139); }
+span.clsoptfmt {font-family: monospace; border-style: none; }
+span.ctrfmt {font-family: monospace; border-style: none; }
+span.filefmt {font-family: monospace; border-style: none; }
+span.extfmt {font-family: monospace; border-style: none; }
+span.deprecatedorbannedfmt {border-style: none; color: rgb(204,0,0); }
+span.summarylocfmt {font-style: italic; font-variant: normal; border-style: none; }
+span.menufmt {font-family: monospace; border-style: none; }
+code.cbeg {font-family: monospace; border-style: none; }
+code.cend {font-family: monospace; border-style: none; }
+span.termslocfmt {font-style: italic; font-variant: normal; border-style: none; }
+span.crossreftag {font-style: italic; font-variant: normal; border-style: none; }
+div.crossref {border-style: none; margin-left: 1.000000em; }
+span.longargfmt {font-family: monospace; border-style: none; }
+span.shortargfmt {font-family: monospace; border-style: none; }
+span.qt {border-style: none; }
+code.qtt {font-family: monospace; border-style: none; }
+em.metainner {font-style: italic; font-variant: normal; border-style: none; }
+span.meta {font-family: serif; border-style: none; color: black; }
+em.initvalnotefmtinner {font-style: italic; font-variant: normal; border-style: none; }
+span.initvalnotefmt {font-family: serif; border-style: none; color: black; }
+span.summarytag {font-style: italic; font-variant: normal; border-style: none; }
+div.importanttitle {text-align: right; border-style: none; color: red; }
+div.important {border-style: solid; border-color: red; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,235,235); }
+div.warningtitle {text-align: right; border-style: none; color: red; }
+div.warning {border-style: solid; border-color: red; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,235,235); }
+div.informationtitle {text-align: right; border-style: none; color: rgb(0,128,128); }
+div.information {border-style: solid; border-color: rgb(0,128,128); border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(240,255,255); }
+div.pinnedboxtitle {text-align: right; border-style: none; color: black; }
+div.pinnedbox {border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,255,191); }
+div.terminaltitle {text-align: right; border-style: none; color: black; }
+pre.terminal {font-family: monospace; border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+div.transcripttitle {text-align: right; border-style: none; color: black; }
+pre.transcript {font-family: monospace; border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+div.ctrboxtitle {text-align: right; border-style: none; color: black; }
+div.ctrbox {border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,255,191); }
+div.codeboxtitle {text-align: right; border-style: none; color: black; }
+pre.codebox {font-family: monospace; border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+div.resultboxtitle {text-align: right; border-style: none; color: black; }
+div.resultbox {border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; }
+div.badcodeboxtitle {text-align: right; border-style: none; color: black; }
+pre.badcodebox {font-family: monospace; border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+div.unicodeboxtitle {text-align: right; border-style: none; color: black; }
+pre.unicodebox {font-family: monospace; border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+pre.compactcodebox {font-family: monospace; border-style: solid; border-color: black; border-width: 1.000000pt; padding: 2.000000pt; background-color: rgb(250,250,250); }
+pre.sidebysidecode {font-family: monospace; font-size: small; vertical-align: top; border-style: solid; border-color: black; border-width: 1.000000pt; padding: 2.000000pt; margin-right: 3.000000%; margin-top: 0.000000pt; background-color: rgb(250,250,250); width: 47.000000%; display: inline-block; }
+div.sidebysideresult {vertical-align: top; border-style: solid; border-color: black; border-width: 1.000000pt; padding: 2.000000pt; margin-top: 0.000000pt; width: 47.000000%; display: inline-block; }
+div.defnbox {border-style: solid; border-color: black; border-width: 1.000000pt; padding: 2.000000pt; background-color: rgb(255,255,191); }
+div.optionsummarybox {border-style: solid; border-color: black; border-width: 1.000000pt; padding: 2.000000pt; background-color: rgb(255,255,191); }
+div.optionvaluesummarybox {border-style: none; margin-left: 40.000000pt; }
+span.floatrightbox {float: right; border-style: none; }
+div.noteBox {border-style: none; }
+div.settingsboxtitle {text-align: right; border-style: none; color: black; }
+div.settingsbox {border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,255,227); }
+div.optionvalueboxtitle {text-align: right; border-style: none; color: black; }
+div.optionvaluebox {border-style: solid; border-color: black; border-width: 2.000000pt; padding: 2.000000pt; background-color: rgb(255,255,245); }
+div.nlctuserguideidx0 {border-style: none; margin-left: 0.000000pt; }
+div.nlctuserguideidx1 {border-style: none; margin-left: 20.000000pt; }
+div.nlctuserguideidx2 {border-style: none; margin-left: 40.000000pt; }
+div.nlctusernavbox {border-style: none; }
+div.abstractheader {font-weight: bold; text-align: center; border-style: none; }
+div.filedef {font-family: monospace; text-align: left; border-style: none; }
+div.tablefn {font-size: x-small; border-style: none; }
+div.tablefns {text-align: left; border-style: none; width: 80.000000%; }
+code.glostypefmt {font-family: monospace; border-style: none; color: rgb(54,100,139); }
+code.fieldfmt {font-family: monospace; border-style: none; color: rgb(82,139,139); }
+code.entryfmt {font-family: monospace; border-style: none; color: rgb(139,90,43); }
+span.acrstylefmt {font-family: sans-serif; border-style: none; color: rgb(0,0,139); }
+span.glostylefmt {font-family: sans-serif; border-style: none; }
+span.catfmt {font-family: sans-serif; border-style: none; color: rgb(139,90,43); }
+span.catattrfmt {font-family: sans-serif; border-style: none; color: rgb(139,90,43); }
+span.xtrfmt {border-style: none; color: rgb(139,90,43); }
+code.xtrcsfmt {font-family: monospace; border-style: none; color: rgb(139,90,43); }
+span.xtrcsoptfmt {border-style: none; color: rgb(139,90,43); }
+span.xtrstyoptfmt {border-style: none; color: rgb(139,90,43); }
+span.xtroptfmt {border-style: none; color: rgb(139,90,43); }
+span.xtrctrfmt {border-style: none; color: rgb(139,90,43); }
+span.abbrstylefmt {font-family: sans-serif; border-style: none; color: rgb(139,90,43); }
+span.xtrglostylefmt {font-family: sans-serif; border-style: none; color: rgb(139,90,43); }
+</style>
+</head>
+<body>
+<div id="main">
+ <header><div class="title">User Manual for glossaries.sty v4.50</div><!-- end of title --><div class="author">Nicola L.C. Talbot<br>
+
+<a href="http://www.dickimaw-books.com/contact">dickimaw-books.com/contact</a></div><!-- end of author --><div class="date">2022-10-14</div><!-- end of date --></header><p>
+<p>
+
+<div class="abstract"><div class="abstractheader">Abstract</div><!-- end of abstractheader -->
+ The <a id="wrglossary.1"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package provides a means to define terms or <a id="wrglossary.2"></a><a href="#glo:idx.acronym">acronyms</a> or symbols that can be referenced within your document. Sorted lists with collated <a id="wrglossary.3"></a><a href="#glo:@@glslabel at entrylocation">locations</a> can be generated either using TeX or using a supplementary <a id="wrglossary.4"></a><a href="#glo:dual.indexingapp">indexing application</a>. Sample documents are provided with the <a id="wrglossary.5"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. These are listed in §<a href="#sec:samples">18</a>. </div><!-- end of abstract -->
+<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.6"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ Additional features not provided here may be available through the extension package <a id="wrglossary.7"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> which, if required, needs to be installed separately. New features will be added to <a id="wrglossary.8"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>. Versions of the <a id="wrglossary.9"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package after v4.21 will mostly be just bug fixes or minor maintenance. The most significant update to the <a id="wrglossary.10"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package since then is version 4.50, which involved the integration of <a id="wrglossary.11"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> v2.08 and the phasing out the use of the now deprecated <a id="wrglossary.12"></a><a href="#glo:pkg.textcase"><span class="styfmt">textcase</span></a> package.<p>
+Note that <a id="wrglossary.13"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> provides an extra indexing option (<a id="wrglossary.14"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>) which isn’t available with just the base <a id="wrglossary.15"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. </div><!-- end of information -->
+<p>
+If you require multilingual support you must also install the relevant language module. Each language module is called <a id="wrglossary.16"></a><a href="#glo:file.glossaries-language"><span class="filefmt">glossaries-</span><span class="meta">〈<em class="metainner">language</em>〉</span><span class="filefmt"></span></a>, where <span class="meta">〈<em class="metainner">language</em>〉</span> is the root language name. For example, <a id="wrglossary.17"></a><a href="#glo:file.glossaries-french"><span class="filefmt">glossaries-french</span></a> or <a id="wrglossary.18"></a><a href="#glo:file.glossaries-german"><span class="filefmt">glossaries-german</span></a>. If a language module is required, the <a id="wrglossary.19"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package will automatically try to load it and will give a warning if the module isn’t found. See §<a href="#sec:languages">1.5</a> for further details. If there isn’t any support available for your language, use the <a id="wrglossary.20"></a><a href="#glo:opt.nolangwarn"><span class="styoptfmt">nolangwarn</span></a> package option to suppress the warning and provide your own translations. (For example, use the <a id="wrglossary.21"></a><a href="#glo:opt.printgloss.title"><span class="csoptfmt">title</span></a> key in <a id="wrglossary.22"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a>.)<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.23"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Documents have wide-ranging styles when it comes to presenting <a id="wrglossary.24"></a><a href="#glo:dual.glossary">glossaries</a> 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 <a id="wrglossary.25"></a><a href="#glo:dual.glossary">glossary</a>. They may just have symbols with terse descriptions or they may have long technical words with complicated descriptions. The <a id="wrglossary.26"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package is flexible enough to accommodate such varied requirements, but this flexibility comes at a price: a big manual.<p>
+1f631 If you’re freaking out at the size of this manual, start with <a href="glossariesbegin.html"><span class="qt">“The <span class="styfmt">glossaries</span> package: a guide for beginners”</span></a>. You should find it in the same directory as this document or try <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.27"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div><a href="https://www.tug.org/texdoc/">texdoc</a> glossariesbegin</pre> Once you’ve got to grips with the basics, then come back to this manual to find out how to adjust the settings. </div><!-- end of important -->
+<p>
+The <a id="wrglossary.28"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> bundle includes the following documentation:
+<dl>
+ <dt><a href="glossariesbegin.html">The <span class="styfmt">glossaries</span> package: a guide for beginners</a></dt>
-<style type="text/css">
-<!--
+<dd> If you want some brief information and examples to get you going, start with the guide for beginners. </dd>
+<p>
+<dt>User Manual for glossaries.sty (<span class="filefmt">glossaries-user.pdf)</span></dt>
+<p>
+
+<dd> This document is the main user guide for the <a id="wrglossary.29"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. </dd>
+<p>
+<dt>Documented Code for glossaries (<a href="glossaries-code.pdf">glossaries-code.pdf</a>)</dt>
+<p>
+
+<dd> Advanced users wishing to know more about the inner workings of all the packages provided in the <span class="styfmt">glossaries</span> bundle should read <span class="qt">“Documented Code for glossaries v4.50”</span>. </dd>
+<p>
+<dt><a href="CHANGES">CHANGES</a></dt>
-/* start css.sty */
-.cmr-7{font-size:70%;}
-.cmmi-7{font-size:70%;font-style: italic;}
-.cmmi-10{font-style: italic;}
-.cmr-17{font-size:170%;}
-.cmr-12{font-size:120%;}
-.cmr-8{font-size:80%;}
-.cmtt-12{font-size:120%;font-family: monospace,monospace;}
-.cmtt-12{font-family: monospace,monospace;}
-.cmtt-12{font-family: monospace,monospace;}
-.cmtt-12{font-family: monospace,monospace;}
-.cmtt-12{font-family: monospace,monospace;}
-.cmbx-10{ font-weight: bold;}
-.cmbx-10{ font-weight: bold;}
-.cmbx-10{ font-weight: bold;}
-.cmss-10{ font-family: sans-serif;}
-.cmss-10{ font-family: sans-serif;}
-.cmss-10{ font-family: sans-serif;}
-.cmss-10{ font-family: sans-serif;}
-.cmss-10{ font-family: sans-serif;}
-.cmtt-10{font-family: monospace,monospace;}
-.cmtt-10{font-family: monospace,monospace;}
-.cmtt-10{font-family: monospace,monospace;}
-.cmtt-10{font-family: monospace,monospace;}
-.cmtt-10{font-family: monospace,monospace;}
-.cmti-10{ font-style: italic;}
-.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
-.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
-.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
-.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
-.cmssbx-10{ font-family: sans-serif; font-weight: bold;}
-.cmr-9{font-size:90%;}
-.cmbx-8{font-size:80%; font-weight: bold;}
-.cmbx-8{ font-weight: bold;}
-.cmbx-8{ font-weight: bold;}
-.cmtt-8{font-size:80%;font-family: monospace,monospace;}
-.cmtt-8{font-family: monospace,monospace;}
-.cmtt-8{font-family: monospace,monospace;}
-.cmtt-8{font-family: monospace,monospace;}
-.cmtt-8{font-family: monospace,monospace;}
-.cmtt-9{font-size:90%;font-family: monospace,monospace;}
-.cmtt-9{font-family: monospace,monospace;}
-.cmtt-9{font-family: monospace,monospace;}
-.cmtt-9{font-family: monospace,monospace;}
-.cmtt-9{font-family: monospace,monospace;}
-.cmss-9{font-size:90%; font-family: sans-serif;}
-.cmss-9{ font-family: sans-serif;}
-.cmss-9{ font-family: sans-serif;}
-.cmss-9{ font-family: sans-serif;}
-.cmss-9{ font-family: sans-serif;}
-.tcrm-0900{font-size:90%;}
-.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;}
-.cmbx-12{ font-weight: bold;}
-.tctt-1000{font-family: monospace,monospace;}
-.cmti-8{font-size:80%; font-style: italic;}
-.cmitt-10{font-family: monospace,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;}
-.small-caps{font-variant: small-caps; }
-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;}
-a { overflow-wrap: break-word; word-wrap: break-word; word-break: break-word; hyphens: auto; }
- at media print {div.crosslinks {visibility:hidden;}}
-a img { border-top: 0; border-left: 0; border-right: 0; }
-center { margin-top:1em; margin-bottom:1em; }
-td center { margin-top:0em; margin-bottom:0em; }
-.Canvas { position:relative; }
-img.math{vertical-align:middle;}
-div.par-math-display, div.math-display{text-align:center;}
-li p.indent { text-indent: 0em }
-li p:first-child{ margin-top:0em; }
-li p:last-child, li div:last-child { margin-bottom:0.5em; }
-li p:first-child{ margin-bottom:0; }
-li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; }
-.enumerate1 {list-style-type:decimal;}
-.enumerate2 {list-style-type:lower-alpha;}
-.enumerate3 {list-style-type:lower-roman;}
-.enumerate4 {list-style-type:upper-alpha;}
-div.newtheorem { margin-bottom: 2em; margin-top: 2em;}
-.obeylines-h,.obeylines-v {white-space: nowrap; }
-div.obeylines-v p { margin-top:0; margin-bottom:0; }
-.overline{ text-decoration:overline; }
-.overline img{ border-top: 1px solid black; }
-td.displaylines {text-align:center; white-space:nowrap;}
-.centerline {text-align:center;}
-.rightline {text-align:right;}
-pre.verbatim {font-family: monospace,monospace; 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; }
-div.minipage{width:100%;}
-div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;}
-div.center div {text-align: left;}
-div.flushright, div.flushright div.flushright {text-align: right;}
-div.flushright div {text-align: left;}
-div.flushleft {text-align: left;}
-.underline{ text-decoration:underline; }
-.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; }
-.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
-.framebox-c {text-align:center;}
-.framebox-l {text-align:left;}
-.framebox-r {text-align:right;}
-span.thank-mark{ vertical-align: super }
-span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; }
-div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;}
-div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;}
-div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; }
-table.tabular td p{margin-top:0em;}
-table.tabular {margin-left: auto; margin-right: auto;}
-td p:first-child{ margin-top:0em; }
-td p:last-child{ margin-bottom:0em; }
-div.td00{ margin-left:0pt; margin-right:0pt; }
-div.td01{ margin-left:0pt; margin-right:5pt; }
-div.td10{ margin-left:5pt; margin-right:0pt; }
-div.td11{ margin-left:5pt; margin-right:5pt; }
-table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
-td.td00{ padding-left:0pt; padding-right:0pt; }
-td.td01{ padding-left:0pt; padding-right:5pt; }
-td.td10{ padding-left:5pt; padding-right:0pt; }
-td.td11{ padding-left:5pt; padding-right:5pt; }
-table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
-.hline hr, .cline hr{ height : 0px; margin:0px; }
-.hline td, .cline td{ padding: 0; }
-.hline hr, .cline hr{border:none;border-top:1px solid black;}
-.hline {border-top: 1px solid black;}
-.tabbing-right {text-align:right;}
-div.float, div.figure {margin-left: auto; margin-right: auto;}
-div.float img {text-align:center;}
-div.figure img {text-align:center;}
-.marginpar,.reversemarginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;}
-.marginpar p,.reversemarginpar p{margin-top:0.4em; margin-bottom:0.4em;}
-.reversemarginpar{float:left;}
-table.equation {width:100%;}
-.equation td{text-align:center; }
-td.equation { margin-top:1em; margin-bottom:1em; }
-td.equation-label { width:5%; text-align:center; }
-td.eqnarray4 { width:5%; white-space: normal; }
-td.eqnarray2 { width:5%; }
-table.eqnarray-star, table.eqnarray {width:100%;}
-div.eqnarray{text-align:center;}
-div.array {text-align:center;}
-div.pmatrix {text-align:center;}
-table.pmatrix {width:100%;}
-span.pmatrix img{vertical-align:middle;}
-div.pmatrix {text-align:center;}
-table.pmatrix {width:100%;}
-span.bar-css {text-decoration:overline;}
-img.cdots{vertical-align:middle;}
-.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;}
-.chapterToc a, .chapterToc, .likechapterToc a, .likechapterToc, .appendixToc a, .appendixToc {line-height: 200%; font-weight:bold;}
-.index-item, .index-subitem, .index-subsubitem {display:block}
-div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;}
-div.caption span.id{font-weight: bold; white-space: nowrap; }
-h1.partHead{text-align: center}
-p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; }
-p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; }
-.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;}
-.subparagraphHead, .likesubparagraphHead { font-weight: bold;}
-.verse{white-space:nowrap; margin-left:2em}
-div.maketitle {text-align:center;}
-h2.titleHead{text-align:center;}
-div.maketitle{ margin-bottom: 2em; }
-div.author, div.date {text-align:center;}
-div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; }
-h1.partHead{text-align: center}
-div.abstract p {margin-left:5%; margin-right:5%;}
-div.abstract {width:100%;}
-.abstracttitle{text-align:center;margin-bottom:1em;}
-div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; }
-table.tabular td p{margin-top:0em;}
-table.tabular {margin-left: auto; margin-right: auto;}
-td p:first-child{ margin-top:0em; }
-td p:last-child{ margin-bottom:0em; }
-div.td00{ margin-left:0pt; margin-right:0pt; }
-div.td01{ margin-left:0pt; margin-right:5pt; }
-div.td10{ margin-left:5pt; margin-right:0pt; }
-div.td11{ margin-left:5pt; margin-right:5pt; }
-table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
-td.td00{ padding-left:0pt; padding-right:0pt; }
-td.td01{ padding-left:0pt; padding-right:5pt; }
-td.td10{ padding-left:5pt; padding-right:0pt; }
-td.td11{ padding-left:5pt; padding-right:5pt; }
-table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
-.hline hr, .cline hr{ height : 0px; margin:0px; }
-.hline td, .cline td{ padding: 0; }
-.hline hr, .cline hr{border:none;border-top:1px solid black;}
-.hline {border-top: 1px solid black;}
-div.array {text-align:center;}
-.alltt P { margin-bottom : 0em; margin-top : 0em; }
-.alltt { margin-bottom : 1em; margin-top : 1em; font-family:monospace,monospace; }
-.equation td{text-align:center; }
-.equation-star td{text-align:center; }
-table.equation-star { width:100%; }
-table.equation { width:100%; }
-table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:95%; margin-left:5%; white-space: nowrap;}
-table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;}
-td.align-label { width:5%; text-align:center; }
-td.align-odd { text-align:right; padding-right:0.3em;}
-td.align-even { text-align:left; padding-right:0.6em;}
-table.multline, table.multline-star {width:100%;}
-td.gather {text-align:center; }
-table.gather {width:100%;}
-div.gather-star {text-align:center;}
-table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
-div.longtable{text-align:center;}
-table.longtable{margin-left:auto; margin-right: auto;}
-.supertabular {text-align:center}
-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:#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:#FF0000}
-span#textcolor21{color:#00FF00}
-span#textcolor22{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:#FF0000}
-span#textcolor29{color:#00FF00}
-span#textcolor30{color:#00FF00}
-span#textcolor31{color:#00FF00}
-span#textcolor32{color:#00FF00}
-span#textcolor33{color:#00FF00}
-span#textcolor34{color:#FF0000}
-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:#00FF00}
-span#textcolor44{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:#FF0000}
-span#textcolor51{color:#00FF00}
-span#textcolor52{color:#00FF00}
-span#textcolor53{color:#00FF00}
-span#textcolor54{color:#00FF00}
-span#textcolor55{color:#FF0000}
-span#textcolor56{color:#00FF00}
-span#textcolor57{color:#00FF00}
-span#textcolor58{color:#FF0000}
-span#textcolor59{color:#00FF00}
-span#textcolor60{color:#00FF00}
-span#textcolor61{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#textcolor1054{color:#008080}
-span#textcolor1055{color:#008080}
-span#textcolor1056{color:#008080}
-span#textcolor1057{color:#008080}
-span#textcolor1058{color:#008080}
-span#textcolor1059{color:#008080}
-span#textcolor1060{color:#008080}
-span#textcolor1061{color:#008080}
-span#textcolor1062{color:#008080}
-span#textcolor1063{color:#008080}
-span#textcolor1064{color:#008080}
-span#textcolor1065{color:#008080}
-span#textcolor1066{color:#008080}
-span#textcolor1067{color:#008080}
-span#textcolor1068{color:#008080}
-span#textcolor1069{color:#008080}
-span#textcolor1070{color:#008080}
-span#textcolor1071{color:#008080}
-span#textcolor1072{color:#008080}
-span#textcolor1073{color:#008080}
-span#textcolor1074{color:#008080}
-span#textcolor1075{color:#008080}
-span#textcolor1076{color:#008080}
-span#textcolor1077{color:#008080}
-span#textcolor1078{color:#008080}
-span#textcolor1079{color:#008080}
-span#textcolor3{color:#008080}
-/* end css.sty */
+<dd> Change log. </dd>
+<p>
+<dt><a href="README.md">README.md</a></dt>
+<p>
+
+<dd> Package summary. </dd>
+<p>
+<dt><a href="Depends.txt">Depends.txt</a></dt>
+<p>
+
+<dd> List of all packages unconditionally required by <a id="wrglossary.30"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>. Other unlisted packages may be required under certain circumstances. For help on installing packages see, for example, <a href="https://tex.stackexchange.com/questions/55437">How do I update my TeX distribution?</a> or (for Linux users) <a href="https://tex.stackexchange.com/questions/14925">Updating TeX on Linux</a>. </dd>
+<p>
+
+</dl>
+ Related resources:
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span><a href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf"><span class="styfmt">glossaries-extra</span> and <span class="appfmt">bib2gls</span>: An Introductory Guide</a>.<p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/faqs/glossariesfaq.html"><span class="styfmt">glossaries</span> FAQ</a><p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/gallery/#glossaries"><span class="styfmt">glossaries</span> gallery</a><p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/gallery/glossaries-styles/">a summary of all glossary styles provided by <span class="styfmt">glossaries</span> and <span class="styfmt">glossaries-extra</span></a><p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/gallery/glossaries-performance.shtml"><span class="styfmt">glossaries</span> performance</a> (comparing document build times for the different options provided by <span class="styfmt">glossaries</span> and <span class="styfmt">glossaries-extra</span>).<p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/latex/thesis/">Using LaTeX to Write a PhD Thesis</a> (chapter 6).<p>
+<li><span class="bulletitem">•</span><a href="https://www.dickimaw-books.com/latex/buildglossaries/">Incorporating <span class="appfmt">makeglossaries</span> or <span class="appfmt">makeglossaries-lite</span> or <span class="appfmt">bib2gls</span> into the document build</a><p>
+<li><span class="bulletitem">•</span>The <a href="https://ctan.org/pkg/glossaries-extra"><span class="styfmt">glossaries-extra</span> package</a><p>
+<li><span class="bulletitem">•</span><a href="https://ctan.org/pkg/bib2gls"><span class="appfmt">bib2gls</span></a>
+</ul>
+<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.31"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+If you use <a id="wrglossary.32"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> and <a id="wrglossary.33"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>, you must load <a id="wrglossary.34"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> <span style="font-style: italic; font-variant: normal; ">first</span> (although, in general, <a id="wrglossary.35"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> should be loaded after other packages). </div><!-- end of important -->
+<p>
+<nav class="toc">
+<section id="toc"><!-- start of section toc --><div class="tomain"><a href="#main">[top]</a></div>
+<h1><!-- start of chapter header -->Contents<div class="labellink"><a href="#toc">[link]</a></div></h1><!-- end of chapter header -->
+
+<ul>
+<li class="toc-chapter"><a href="#chapter*.2">List of Tables</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#sec:listofexamples">List of Examples</a></li><!-- end of toc-chapter -->
+
+<li class="toc-part"><a href="#userguide"><span class="numberline">I</span>User Guide</a></li><!-- end of toc-part -->
+
+<li class="toc-chapter"><a href="#sec:intro"><span class="numberline">1</span>Introduction</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:rollback"><span class="numberline">1.1</span>Rollback</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgintegration"><span class="numberline">1.2</span>Integrating Other Packages and Known Issues</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:indexingoptions"><span class="numberline">1.3</span>Indexing Options</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#wrglossary.285"><span class="numberline">1.3.1</span>Option 1 (<span class="qt">“noidx”</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#wrglossary.386"><span class="numberline">1.3.2</span>Option 2 (<span class="appfmt">makeindex</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#wrglossary.527"><span class="numberline">1.3.3</span>Option 3 (<span class="appfmt">xindy</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#wrglossary.670"><span class="numberline">1.3.4</span>Option 4 (<span class="appfmt">bib2gls</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#wrglossary.787"><span class="numberline">1.3.5</span>Option 5 (<span class="qt">“unsrt”</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#wrglossary.848"><span class="numberline">1.3.6</span>Option 6 (<span class="qt">“standalone”</span>)</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:lipsum"><span class="numberline">1.4</span>Dummy Entries for Testing</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:languages"><span class="numberline">1.5</span>Multi-Lingual Support</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:fixednames"><span class="numberline">1.5.1</span>Changing the Fixed Names</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:newlang"><span class="numberline">1.5.2</span>Creating a New Language Module</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:makeglossaries"><span class="numberline">1.6</span>Generating the Associated Glossary Files</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:makeglossariesapp"><span class="numberline">1.6.1</span>Using the <span class="appfmt">makeglossaries</span> Perl Script</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:makeglossarieslua"><span class="numberline">1.6.2</span>Using the <span class="appfmt">makeglossaries-lite</span> Lua Script</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:xindyapp"><span class="numberline">1.6.3</span>Using <span class="appfmt">xindy</span> explicitly (Option 3)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:makeindexapp"><span class="numberline">1.6.4</span>Using <span class="appfmt">makeindex</span> explicitly (Option 2)</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:notedev"><span class="numberline">1.7</span>Note to Front-End and Script Developers</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:notedev.makeindex.xindy"><span class="numberline">1.7.1</span>MakeIndex and Xindy</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:notedev.labels"><span class="numberline">1.7.2</span>Entry Labels</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:notedev.bib2gls"><span class="numberline">1.7.3</span>Bib2Gls</a></li><!-- end of toc-subsection -->
+</ul></ul>
+<li class="toc-chapter"><a href="#sec:pkgopts"><span class="numberline">2</span>Package Options</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:pkgopts-general"><span class="numberline">2.1</span>General Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-sec"><span class="numberline">2.2</span>Sectioning, Headings and TOC Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-printglos"><span class="numberline">2.3</span>Glossary Appearance Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-indexing"><span class="numberline">2.4</span>Indexing Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-sort"><span class="numberline">2.5</span>Sorting Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-type"><span class="numberline">2.6</span>Glossary Type Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-acronym"><span class="numberline">2.7</span>acronym and <span class="xtrfmt">abbreviation</span> Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-old-acronym"><span class="numberline">2.8</span>Deprecated Acronym Style Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pkgopts-other"><span class="numberline">2.9</span>Other Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:setupglossaries"><span class="numberline">2.10</span>Setting Options After the Package is Loaded</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:setup"><span class="numberline">3</span>Setting Up</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:setupopt1"><span class="numberline">3.1</span>Option 1</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:setupopt23"><span class="numberline">3.2</span>Options 2 and 3</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:newglosentry"><span class="numberline">4</span>Defining glossary entries</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:plurals"><span class="numberline">4.1</span>Plurals</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:grammar"><span class="numberline">4.2</span>Other Grammatical Constructs</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:addkey"><span class="numberline">4.3</span>Additional Keys</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:glsaddkey"><span class="numberline">4.3.1</span>Document Keys</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:glsaddstoragekey"><span class="numberline">4.3.2</span>Storage Keys</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:expansion"><span class="numberline">4.4</span>Expansion</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:subentries"><span class="numberline">4.5</span>Sub-Entries</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:hierarchical"><span class="numberline">4.5.1</span>Hierarchy</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:homographs"><span class="numberline">4.5.2</span>homographs</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:loadglsentries"><span class="numberline">4.6</span>Loading Entries From a File</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:moveentry"><span class="numberline">4.7</span>Moving Entries to Another Glossary</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:docdefs"><span class="numberline">4.8</span>Drawbacks With Defining Entries in the Document Environment</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:techissues"><span class="numberline">4.8.1</span>Technical Issues</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:goodpractice"><span class="numberline">4.8.2</span>Good Practice Issues</a></li><!-- end of toc-subsection -->
+</ul></ul>
+<li class="toc-chapter"><a href="#sec:usingentries"><span class="numberline">5</span>Referencing Entries in the Document</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:glslink"><span class="numberline">5.1</span>Links to Glossary Entries</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:glslinkoptions"><span class="numberline">5.1.1</span>Options</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:gls-like"><span class="numberline">5.1.2</span>The <code class="csfmt">\gls</code>-Like Commands (First Use Flag Queried)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:glstext-like"><span class="numberline">5.1.3</span>The <code class="csfmt">\glstext</code>-Like Commands (First Use Flag Not Queried)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:glsdisplay"><span class="numberline">5.1.4</span>Changing the Format of the <code class="csfmt">\gls</code>-like Link Text</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:glshooks"><span class="numberline">5.1.5</span>Hooks</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:disablehyperlinks"><span class="numberline">5.1.6</span>Enabling and Disabling hyperlinks to Glossary Entries</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:glsnolink"><span class="numberline">5.2</span>Using Glossary Terms Without Indexing</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:acronyms"><span class="numberline">6</span>Acronyms and Other Abbreviations</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:longshortfull"><span class="numberline">6.1</span>Displaying the Long, Short and Full Forms (Independent of First Use)</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:setacronymstyle"><span class="numberline">6.2</span>Changing the Acronym Style</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:predefinedacrstyles"><span class="numberline">6.2.1</span>Predefined Acronym Styles</a></li><!-- end of toc-subsection -->
+
+<ul>
+<li class="toc-subsubsection"><a href="#sec:acrstyleslongshort"><span class="numberline">6.2.1.1</span>Long (Short)</a></li><!-- end of toc-subsubsection -->
+
+<li class="toc-subsubsection"><a href="#sec:acrstylesshortlong"><span class="numberline">6.2.1.2</span>Short (Long)</a></li><!-- end of toc-subsubsection -->
+
+<li class="toc-subsubsection"><a href="#sec:acrstyleslongshortdesc"><span class="numberline">6.2.1.3</span>Long (Short) User Supplied Description</a></li><!-- end of toc-subsubsection -->
+
+<li class="toc-subsubsection"><a href="#sec:acrstylesshortlongdesc"><span class="numberline">6.2.1.4</span>Short (Long) User Supplied Description</a></li><!-- end of toc-subsubsection -->
+
+<li class="toc-subsubsection"><a href="#sec:acrstylesdua"><span class="numberline">6.2.1.5</span>Do Not Use Acronym (DUA)</a></li><!-- end of toc-subsubsection -->
+
+<li class="toc-subsubsection"><a href="#sec:acrstylesfootnote"><span class="numberline">6.2.1.6</span>Footnote</a></li><!-- end of toc-subsubsection -->
+</ul>
+<li class="toc-subsection"><a href="#sec:customacronym"><span class="numberline">6.2.2</span>Defining A Custom Acronym Style</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:disploa"><span class="numberline">6.3</span>Displaying the List of Acronyms</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:oldacronym"><span class="numberline">6.4</span>Upgrading From the <span class="styfmt">glossary</span> Package</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:glsunset"><span class="numberline">7</span>Unsetting and Resetting Entry Flags</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:enableentrycount"><span class="numberline">7.1</span>Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:printglossary"><span class="numberline">8</span>Displaying a Glossary</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:printglossoptions"><span class="numberline">8.1</span><code class="csfmt">\print<span class="meta">〈<em class="metainner">…</em>〉</span>glossary</code> Options</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:glossmarkup"><span class="numberline">8.2</span>Glossary Markup</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:newglossary"><span class="numberline">9</span>Defining New Glossaries</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#sec:glsadd"><span class="numberline">10</span>Adding an Entry to the Glossary Without Generating Text</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#sec:crossref"><span class="numberline">11</span>Cross-Referencing Entries</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:customxr"><span class="numberline">11.1</span>Customising Cross-Reference Text</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:numberlists"><span class="numberline">12</span>Number Lists</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:encap"><span class="numberline">12.1</span>Encap Values (Location Formats)</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:ranges"><span class="numberline">12.2</span>Range Formations</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:locationsyntax"><span class="numberline">12.3</span>Locations</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:pageprecedence"><span class="numberline">12.4</span>Page Precedence</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:problemlocations"><span class="numberline">12.5</span>Problematic Locations</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:numberlistloop"><span class="numberline">12.6</span>Iterating Over Locations</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:styles"><span class="numberline">13</span>Glossary Styles</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:predefinedstyles"><span class="numberline">13.1</span>Predefined Styles</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:liststyles"><span class="numberline">13.1.1</span>List Styles</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:longstyles"><span class="numberline">13.1.2</span>Longtable Styles</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:longraggedstyles"><span class="numberline">13.1.3</span>Longtable Styles (Ragged Right)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:longbooktabsstyles"><span class="numberline">13.1.4</span>Longtable Styles (<span style="font-family: sans-serif; ">booktabs</span>)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:superstyles"><span class="numberline">13.1.5</span>Supertabular Styles</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:superraggedstyles"><span class="numberline">13.1.6</span>Supertabular Styles (Ragged Right)</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:treestyles"><span class="numberline">13.1.7</span>Tree-Like Styles</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:mcolstyles"><span class="numberline">13.1.8</span>Multicols Style</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:inline"><span class="numberline">13.1.9</span>In-Line Style</a></li><!-- end of toc-subsection -->
+</ul>
+<li class="toc-section"><a href="#sec:newglossarystyle"><span class="numberline">13.2</span>Defining your own glossary style</a></li><!-- end of toc-section -->
+
+<ul>
+<li class="toc-subsection"><a href="#sec:glossarycmds"><span class="numberline">13.2.1</span>Commands For Use in Glossary Styles</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:hypernav"><span class="numberline">13.2.2</span>Hyper Group Navigation</a></li><!-- end of toc-subsection -->
+
+<li class="toc-subsection"><a href="#sec:glossarystylecmds"><span class="numberline">13.2.3</span>Glossary Style Commands</a></li><!-- end of toc-subsection -->
+</ul></ul>
+<li class="toc-chapter"><a href="#sec:xindy"><span class="numberline">14</span>Xindy (Option 3)</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:xdystyles"><span class="numberline">14.1</span>Required Styles</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:langenc"><span class="numberline">14.2</span>Language and Encodings</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:xindyloc"><span class="numberline">14.3</span>Locations and Number lists</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:groups"><span class="numberline">14.4</span>Glossary Groups</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:utilities"><span class="numberline">15</span>Utilities</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:hyperref"><span class="numberline">15.1</span><span class="styfmt">hyperref</span></a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:casechanging"><span class="numberline">15.2</span>Case-Changing</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:loops"><span class="numberline">15.3</span>Loops</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:conditionals"><span class="numberline">15.4</span>Conditionals</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:fetchset"><span class="numberline">15.5</span>Fetching and Updating the Value of a Field</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:prefix"><span class="numberline">16</span>Prefixes or Determiners</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#sec:accsupp"><span class="numberline">17</span>Accessibility Support</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:accsuppkeys"><span class="numberline">17.1</span>Accessibility Keys</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:accsuppcmds"><span class="numberline">17.2</span>Incorporating Accessibility Support</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:glsentryaccessdisplay"><span class="numberline">17.3</span>Incorporating the Access Field Values</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:glsentryaccess"><span class="numberline">17.4</span>Obtaining the Access Field Values</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:accsuppdevnote"><span class="numberline">17.5</span>Developer’s Note</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:samples"><span class="numberline">18</span>Sample Documents</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#sec:samplesbasic"><span class="numberline">18.1</span>Basic</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:sampleacronyms"><span class="numberline">18.2</span>Acronyms and First Use</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplecounter"><span class="numberline">18.3</span>Non-Page Locations</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplestype"><span class="numberline">18.4</span>Multiple Glossaries</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplessort"><span class="numberline">18.5</span>Sorting</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplesparent"><span class="numberline">18.6</span>Child Entries</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplescrossref"><span class="numberline">18.7</span>Cross-Referencing</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplescustomkeys"><span class="numberline">18.8</span>Custom Keys</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplesxindy"><span class="numberline">18.9</span>Xindy (Option 3)</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplesnoidx"><span class="numberline">18.10</span>No Indexing Application (Option 1)</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#sec:samplesother"><span class="numberline">18.11</span>Other</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#sec:trouble"><span class="numberline">19</span>Troubleshooting</a></li><!-- end of toc-chapter -->
+
+<li class="toc-part"><a href="#summaries"><span class="numberline">II</span>Summaries and Index</a></li><!-- end of toc-part -->
+
+<li class="toc-chapter"><a href="#symbols">Symbols</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#glossary">Terms</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#sec:gloskeys">Glossary Entry Keys Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#idx.glsopt-optionsummary"><span style="font-family: monospace; ">\Gls</span>-Like and <span style="font-family: monospace; ">\Glstext</span>-Like Options Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#idx.printglossopt-optionsummary"><span style="font-family: monospace; ">\print<span class="meta">〈<em class="metainner">…</em>〉</span>glossary</span> Options Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#idx.acronymstyle-optionsummary">Acronym Style Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#idx.glossarystyle-optionsummary">Glossary Styles Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#cmdsummary">Command Summary</a></li><!-- end of toc-chapter -->
+
+<ul>
+<li class="toc-section"><a href="#summary.index@">Command Summary: @</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6553600">Command Summary: A</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6619136">Command Summary: B</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6684672">Command Summary: C</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6750208">Command Summary: D</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6815744">Command Summary: E</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6881280">Command Summary: F</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index6946816">Command Summary: G</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7012352">Command Summary: Glo</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7077888">Command Summary: Gls</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7143424">Command Summary: Glsxtr</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7208960">Command Summary: H</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7274496">Command Summary: I</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7471104">Command Summary: L</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7536640">Command Summary: M</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7602176">Command Summary: N</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7667712">Command Summary: O</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7733248">Command Summary: P</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7864320">Command Summary: R</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7929856">Command Summary: S</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index7995392">Command Summary: T</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index8192000">Command Summary: W</a></li><!-- end of toc-section -->
+
+<li class="toc-section"><a href="#summary.index8257536">Command Summary: X</a></li><!-- end of toc-section -->
+</ul>
+<li class="toc-chapter"><a href="#envsummary">Environment Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#styoptsummary">Package Option Summary</a></li><!-- end of toc-chapter -->
+
+<li class="toc-chapter"><a href="#index">Index</a></li><!-- end of toc-chapter -->
+ </ul></nav><!-- end of toc -->
+</section><!-- end of section toc -->
+
+<section id="chapter*.2"><!-- start of section chapter*.2 --><div class="tomain"><a href="#main">[top]</a></div>
+<h1><!-- start of chapter header -->List of Tables<div class="labellink"><a href="#chapter*.2">[link]</a></div></h1><!-- end of chapter header -->
+<div class="lot">
+<div class="toc-table"><a href="#tab:options"><span class="numberline">1.1</span>Glossary Options: Pros and Cons</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:predefinednames"><span class="numberline">1.2</span>Customised Text</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:makeglossariesCmds"><span class="numberline">1.3</span>Commands and package options that have no effect when using <span class="appfmt">xindy</span> or <span class="appfmt">makeindex</span> explicitly</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:fieldmap"><span class="numberline">4.1</span>Key to Field Mappings</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:shortcuts"><span class="numberline">6.1</span>Synonyms provided by the <span class="styoptfmt">shortcuts</span> package option</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:xspace"><span class="numberline">6.2</span>The effect of using <span class="styfmt">xspace</span> with <code class="csfmt">\oldacronym</code></a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:hyperxx"><span class="numberline">12.1</span>Predefined Hyperlinked Location Formats</a></div><!-- end of toc-table -->
-
--->
-</style>
-</head><body
->
-<!--l. 690--><p class="noindent" ><a
- id="top"></a>
-</p><!--l. 690--><p class="indent" >
-
-
-</p><!--l. 690--><p class="indent" >
-
-
-</p>
-<div class="center"
->
-<!--l. 690--><p class="noindent" >
-</p><!--l. 690--><p class="noindent" ><span
-class="cmr-17">User Manual for glossaries.sty v4.49</span>
-</p>
-<div class="tabular"> <table id="TBL-1" class="tabular"
-
-><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>
-</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/contact" ><span
-class="cmtt-12">dickimaw-books.com/contact</span></a> </td></tr></table>
-</div>
-<!--l. 690--><p class="noindent" ><span
-class="cmr-12">2021-11-01</span></p></div>
- <div
-class="abstract"
->
-<!--l. 692--><p class="indent" >
-
-
-</p>
- <h3 class="abstracttitle">
-<span
-class="cmbx-10">Abstract</span>
-</h3>
-<!--l. 693--><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 TeX 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">§18 </a><a
-href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>.
-</p><!--l. 699--><p class="indent" >
-
-
-</p>
- </div>
-<!--l. 701--><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 or minor maintenance. Note that <a
-href="#glo:glossaries-extra"><span
-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>package.
-</div>
-</p><!--l. 709--><p class="noindent" >
-</p><!--l. 711--><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="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">§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">nolangwarn</span><a
- 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. 724--><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-5"></a>, <span
-class="cmss-10">mfirstuc</span><a
- id="dx1-6"></a>,
-<span
-class="cmss-10">etoolbox</span><a
- id="dx1-7"></a>, <span
-class="cmss-10">xkeyval</span><a
- id="dx1-8"></a> (at least version dated 2006/11/18), <span
-class="cmss-10">textcase</span><a
- id="dx1-9"></a>, <span
-class="cmss-10">xfor</span><a
- id="dx1-10"></a>, <span
-class="cmss-10">datatool-base</span><a
- id="dx1-11"></a> (part of the <span
-class="cmss-10">datatool</span><a
- id="dx1-12"></a> bundle)
-and <span
-class="cmss-10">amsgen</span><a
- id="dx1-13"></a>. These packages are all available in the latest TeX Live and MikTeX distributions. If any of them
-are missing, please update your TeX 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 TeX distribution?</a> or (for Linux users) <a
-href="http://tex.stackexchange.com/questions/14925/updating-tex-on-linux" >Updating TeX on
-Linux</a>.
-</p><!--l. 739--><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="cmss-10">amsgen</span><a
- id="dx1-14"></a>. In which case, load the required
-package first (for example, <span
-class="cmss-10">amsgen</span><a
- id="dx1-15"></a>), then ⟨<span
-class="cmti-10">X</span>⟩, and finally load <span
-class="cmss-10">glossaries</span>.
-</p><!--l. 745--><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. 755--><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. 761--><p class="noindent" >
-</p><!--l. 763--><p class="noindent" >The <span
-class="cmss-10">glossaries </span>bundle includes the following documentation:
- </p><dl class="description"><dt class="description">
- <!--l. 766--><p class="noindent" >
-<a
-href="glossariesbegin.pdf" class="url" ><span
-class="cmtt-10">glossariesbegin.pdf</span></a> </p></dt><dd
-class="description">
- <!--l. 766--><p class="noindent" >If you are a complete beginner, start with <a
-href="glossariesbegin.html" >“The glossaries package: a guide for beginners”</a>.
- </p></dd><dt class="description">
- <!--l. 771--><p class="noindent" >
-
-
-<span
-class="cmbx-10">glossaries-user.pdf</span> </p></dt><dd
-class="description">
- <!--l. 771--><p class="noindent" >This document is the main user guide for the <span
-class="cmss-10">glossaries </span>package.
- </p></dd><dt class="description">
- <!--l. 775--><p class="noindent" >
-<a
-href="glossaries-code.pdf" class="url" ><span
-class="cmtt-10">glossaries-code.pdf</span></a> </p></dt><dd
-class="description">
- <!--l. 775--><p class="noindent" >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.49”.
- </p></dd><dt class="description">
- <!--l. 780--><p class="noindent" >
-<span
-class="cmbx-10">CHANGES</span> </p></dt><dd
-class="description">
- <!--l. 780--><p class="noindent" >Change log.
- </p></dd><dt class="description">
- <!--l. 782--><p class="noindent" >
-<span
-class="cmbx-10">README.md</span> </p></dt><dd
-class="description">
- <!--l. 782--><p class="noindent" >Package summary.
-</p>
- </dd></dl>
-<!--l. 785--><p class="noindent" >Related resources: </p>
- <ul class="itemize1">
- <li class="itemize">
- <!--l. 787--><p class="noindent" ><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>.
- </p></li>
- <li class="itemize">
- <!--l. 789--><p class="noindent" ><a
-href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" ><span
-class="cmss-10">glossaries </span>FAQ</a>
- </p></li>
- <li class="itemize">
- <!--l. 792--><p class="noindent" ><a
-href="https://www.dickimaw-books.com/gallery/#glossaries" ><span
-class="cmss-10">glossaries </span>gallery</a>
- </p></li>
- <li class="itemize">
- <!--l. 795--><p class="noindent" ><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>
- </p></li>
- <li class="itemize">
- <!--l. 799--><p class="noindent" ><a
-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>).
-
-
- </p></li>
- <li class="itemize">
- <!--l. 803--><p class="noindent" ><a
-href="http://www.dickimaw-books.com/latex/thesis/" >Using LaTeX to Write a PhD Thesis</a> (chapter 6).
- </p></li>
- <li class="itemize">
- <!--l. 807--><p class="noindent" ><a
-href="https://www.dickimaw-books.com/latex/buildglossaries/" >Incorporating makeglossaries or makeglossaries-lite or bib2gls into the document build</a>
- </p></li>
- <li class="itemize">
- <!--l. 809--><p class="noindent" >The <a
-href="http://ctan.org/pkg/glossaries-extra" ><span
-class="cmss-10">glossaries-extra </span>package</a>
- </p></li>
- <li class="itemize">
- <!--l. 812--><p class="noindent" ><a
-href="http://ctan.org/pkg/bib2gls" ><span
-class="cmtt-10">bib2gls</span></a></p></li></ul>
-<!--l. 815--><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-16"></a> and <span
-class="cmss-10">glossaries</span>, you must load <span
-class="cmss-10">hyperref</span><a
- id="dx1-17"></a> <span
-class="cmti-10">first </span>(although <span
-class="cmss-10">hyperref</span><a
- id="dx1-18"></a> should be loaded after
-most other packages). Similarly the <span
-class="cmss-10">doc</span><a
- id="dx1-19"></a> package must also be loaded before <span
-class="cmss-10">glossaries</span>. (If <span
-class="cmss-10">doc</span><a
- id="dx1-20"></a> is loaded, the file
-extensions for the default main glossary are changed to <span
-class="cmtt-10">gls2</span><a
- id="dx1-21"></a>, <span
-class="cmtt-10">glo2</span><a
- id="dx1-22"></a> and <span
-class="cmtt-10">glg2</span><a
- id="dx1-23"></a> to avoid conflict with <span
-class="cmss-10">doc</span><a
- id="dx1-24"></a>’s changes
-glossary.)<a
- id="pdflatexnote"></a>
-</p><!--l. 825--><p class="indent" > If you are using <span
-class="cmss-10">hyperref</span><a
- id="dx1-25"></a>, it’s best to use <span
-class="cmtt-10">pdflatex</span><a
- id="dx1-26"></a> rather than <span
-class="cmtt-10">latex</span><a
- id="dx1-27"></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 id="textcolor1"><span
-class="cmss-10">hyperoutside</span></span><a
- id="dx1-28"></a> and <span id="textcolor2"><span
-class="cmss-10">textformat</span></span><a
- id="dx1-29"></a> attributes set to appropriate values for problematic entries.
-</div>
-</p><!--l. 835--><p class="noindent" >
-</p><!--l. 838--><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>
- <div class="tableofcontents">
- <span class="chapterToc" > <a
-href="#glossary">Glossary</a></span>
-<br /> <span class="chapterToc" >1 <a
-href="#sec:intro" id="QQ2-1-5">Introduction</a></span>
-<br />  <span class="sectionToc" >1.1 <a
-href="#sec:rollback" id="QQ2-1-6">Rollback</a></span>
-<br />  <span class="sectionToc" >1.2 <a
-href="#sec:indexingoptions" id="QQ2-1-7">Indexing Options</a></span>
-<br />  <span class="sectionToc" >1.3 <a
-href="#sec:lipsum" id="QQ2-1-15">Dummy Entries for Testing</a></span>
-<br />  <span class="sectionToc" >1.4 <a
-href="#sec:languages" id="QQ2-1-16">Multi-Lingual Support</a></span>
-<br />   <span class="subsectionToc" >1.4.1 <a
-href="#sec:fixednames" id="QQ2-1-17">Changing the Fixed Names</a></span>
-<br />   <span class="subsectionToc" >1.4.2 <a
-href="#sec:newlang" id="QQ2-1-19">Creating a New Language Module</a></span>
-<br />  <span class="sectionToc" >1.5 <a
-href="#sec:makeglossaries" id="QQ2-1-20">Generating the Associated Glossary Files</a></span>
-<br />   <span class="subsectionToc" >1.5.1 <a
-href="#sec:makeglossariesapp" id="QQ2-1-22">Using the makeglossaries Perl Script</a></span>
-<br />   <span class="subsectionToc" >1.5.2 <a
-href="#sec:makeglossarieslua" id="QQ2-1-23">Using the makeglossaries-lite Lua Script</a></span>
-<br />   <span class="subsectionToc" >1.5.3 <a
-href="#sec:xindyapp" id="QQ2-1-24">Using xindy explicitly (Option 3)</a></span>
-<br />   <span class="subsectionToc" >1.5.4 <a
-href="#sec:makeindexapp" id="QQ2-1-25">Using makeindex explicitly (Option 2)</a></span>
-<br />  <span class="sectionToc" >1.6 <a
-href="#sec:notedev" id="QQ2-1-26">Note to Front-End and Script Developers</a></span>
-<br />   <span class="subsectionToc" >1.6.1 <a
-href="#makeindexandxindy" id="QQ2-1-27">MakeIndex and Xindy</a></span>
-<br />   <span class="subsectionToc" >1.6.2 <a
-href="#entrylabels" id="QQ2-1-28">Entry Labels</a></span>
-<br />   <span class="subsectionToc" >1.6.3 <a
-href="#bib2gls" id="QQ2-1-29">Bib2Gls</a></span>
-<br /> <span class="chapterToc" >2 <a
-href="#sec:pkgopts" id="QQ2-1-30">Package Options</a></span>
-<br />  <span class="sectionToc" >2.1 <a
-href="#sec:pkgopts-general" id="QQ2-1-31">General Options</a></span>
-<br />  <span class="sectionToc" >2.2 <a
-href="#sec:pkgopts-sec" id="QQ2-1-44">Sectioning, Headings and TOC Options</a></span>
-<br />  <span class="sectionToc" >2.3 <a
-href="#sec:pkgopts-printglos" id="QQ2-1-50">Glossary Appearance Options</a></span>
-<br />  <span class="sectionToc" >2.4 <a
-href="#sec:pkgopts-indexing" id="QQ2-1-67">Indexing Options</a></span>
-<br />  <span class="sectionToc" >2.5 <a
-href="#sec:pkgopts-sort" id="QQ2-1-77">Sorting Options</a></span>
-<br />  <span class="sectionToc" >2.6 <a
-href="#sec:pkgopts-type" id="QQ2-1-88">Glossary Type Options</a></span>
-<br />  <span class="sectionToc" >2.7 <a
-href="#sec:pkgopts-acronym" id="QQ2-1-95">Acronym and Abbreviation Options</a></span>
-<br />  <span class="sectionToc" >2.8 <a
-href="#sec:pkgopts-old-acronym" id="QQ2-1-101">Deprecated Acronym Style Options</a></span>
-<br />  <span class="sectionToc" >2.9 <a
-href="#sec:pkgopts-other" id="QQ2-1-107">Other Options</a></span>
-<br />  <span class="sectionToc" >2.10 <a
-href="#sec:setupglossaries" id="QQ2-1-114">Setting Options After the Package is Loaded</a></span>
-<br /> <span class="chapterToc" >3 <a
-href="#sec:setup" id="QQ2-1-115">Setting Up</a></span>
-<br />  <span class="sectionToc" >3.1 <a
-href="#sec:setupopt1" id="QQ2-1-116">Option 1</a></span>
-<br />  <span class="sectionToc" >3.2 <a
-href="#sec:setupopt23" id="QQ2-1-117">Options 2 and 3</a></span>
-<br /> <span class="chapterToc" >4 <a
-href="#sec:newglosentry" id="QQ2-1-118">Defining Glossary Entries</a></span>
-<br />  <span class="sectionToc" >4.1 <a
-href="#sec:plurals" id="QQ2-1-119">Plurals</a></span>
-<br />  <span class="sectionToc" >4.2 <a
-href="#sec:grammar" id="QQ2-1-120">Other Grammatical Constructs</a></span>
-<br />  <span class="sectionToc" >4.3 <a
-href="#sec:addkey" id="QQ2-1-121">Additional Keys</a></span>
-
-
-<br />   <span class="subsectionToc" >4.3.1 <a
-href="#sec:glsaddkey" id="QQ2-1-122">Document Keys</a></span>
-<br />   <span class="subsectionToc" >4.3.2 <a
-href="#sec:glsaddstoragekey" id="QQ2-1-123">Storage Keys</a></span>
-<br />  <span class="sectionToc" >4.4 <a
-href="#sec:expansion" id="QQ2-1-124">Expansion</a></span>
-<br />  <span class="sectionToc" >4.5 <a
-href="#sec:subentries" id="QQ2-1-126">Sub-Entries</a></span>
-<br />   <span class="subsectionToc" >4.5.1 <a
-href="#sec:hierarchical" id="QQ2-1-127">Hierarchical Categories</a></span>
-<br />   <span class="subsectionToc" >4.5.2 <a
-href="#sec:homographs" id="QQ2-1-128">Homographs</a></span>
-<br />  <span class="sectionToc" >4.6 <a
-href="#sec:loadglsentries" id="QQ2-1-129">Loading Entries From a File</a></span>
-<br />  <span class="sectionToc" >4.7 <a
-href="#sec:moveentry" id="QQ2-1-130">Moving Entries to Another Glossary</a></span>
-<br />  <span class="sectionToc" >4.8 <a
-href="#sec:docdefs" id="QQ2-1-131">Drawbacks With Defining Entries in the Document Environment</a></span>
-<br />   <span class="subsectionToc" >4.8.1 <a
-href="#sec:techissues" id="QQ2-1-132">Technical Issues</a></span>
-<br />   <span class="subsectionToc" >4.8.2 <a
-href="#sec:goodpractice" id="QQ2-1-133">Good Practice Issues</a></span>
-<br /> <span class="chapterToc" >5 <a
-href="#sec:usingentries" id="QQ2-1-134">Referencing Entries in the Document</a></span>
-<br />  <span class="sectionToc" >5.1 <a
-href="#sec:glslink" id="QQ2-1-135">Links to Glossary Entries</a></span>
-<br />   <span class="subsectionToc" >5.1.1 <a
-href="#x1-1310005.1.1" id="QQ2-1-137">The <span
-class="cmtt-10">\gls</span>-Like Commands (First Use Flag Queried)</a></span>
-<br />   <span class="subsectionToc" >5.1.2 <a
-href="#x1-1320005.1.2" id="QQ2-1-138">The <span
-class="cmtt-10">\glstext</span>-Like Commands (First Use Flag Not Queried)</a></span>
-<br />   <span class="subsectionToc" >5.1.3 <a
-href="#sec:glsdisplay" id="QQ2-1-139">Changing the format of the link text</a></span>
-<br />   <span class="subsectionToc" >5.1.4 <a
-href="#sec:disablehyperlinks" id="QQ2-1-140">Enabling and disabling hyperlinks to glossary entries</a></span>
-<br />  <span class="sectionToc" >5.2 <a
-href="#sec:glsnolink" id="QQ2-1-141">Using Glossary Terms Without Links</a></span>
-<br /> <span class="chapterToc" >6 <a
-href="#sec:acronyms" id="QQ2-1-142">Acronyms and Other Abbreviations</a></span>
-<br />  <span class="sectionToc" >6.1 <a
-href="#sec:longshortfull" id="QQ2-1-143">Displaying the Long, Short and Full Forms (Independent of First Use)</a></span>
-<br />  <span class="sectionToc" >6.2 <a
-href="#sec:setacronymstyle" id="QQ2-1-145">Changing the Acronym Style</a></span>
-<br />   <span class="subsectionToc" >6.2.1 <a
-href="#sec:predefinedacrstyles" id="QQ2-1-146">Predefined Acronym Styles</a></span>
-<br />   <span class="subsectionToc" >6.2.2 <a
-href="#sec:customacronym" id="QQ2-1-147">Defining A Custom Acronym Style</a></span>
-<br />  <span class="sectionToc" >6.3 <a
-href="#sec:disploa" id="QQ2-1-148">Displaying the List of Acronyms</a></span>
-<br />  <span class="sectionToc" >6.4 <a
-href="#sec:oldacronym" id="QQ2-1-149">Upgrading From the glossary Package</a></span>
-<br /> <span class="chapterToc" >7 <a
-href="#sec:glsunset" id="QQ2-1-151">Unsetting and Resetting Entry Flags</a></span>
-<br />  <span class="sectionToc" >7.1 <a
-href="#sec:enableentrycount" id="QQ2-1-152">Counting the Number of Times an Entry has been Used (First Use Flag Unset)</a></span>
-<br /> <span class="chapterToc" >8 <a
-href="#sec:printglossary" id="QQ2-1-153">Displaying a Glossary</a></span>
-<br /> <span class="chapterToc" >9 <a
-href="#sec:newglossary" id="QQ2-1-154">Defining New Glossaries</a></span>
-<br /> <span class="chapterToc" >10 <a
-href="#sec:glsadd" id="QQ2-1-155">Adding an Entry to the Glossary Without Generating Text</a></span>
-<br /> <span class="chapterToc" >11 <a
-href="#sec:crossref" id="QQ2-1-156">Cross-Referencing Entries</a></span>
-<br />  <span class="sectionToc" >11.1 <a
-href="#sec:customxr" id="QQ2-1-157">Customising Cross-reference Text</a></span>
-<br /> <span class="chapterToc" >12 <a
-href="#sec:numberlists" id="QQ2-1-158">Number Lists</a></span>
-<br />  <span class="sectionToc" >12.1 <a
-href="#sec:encap" id="QQ2-1-159">Encap Values (Location Formats)</a></span>
-<br />  <span class="sectionToc" >12.2 <a
-href="#sec:locationsyntax" id="QQ2-1-160">Locations</a></span>
-<br />  <span class="sectionToc" >12.3 <a
-href="#sec:ranges" id="QQ2-1-161">Range Formations</a></span>
-<br />  <span class="sectionToc" >12.4 <a
-href="#sec:isthook" id="QQ2-1-162">Style Hook</a></span>
-<br /> <span class="chapterToc" >13 <a
-href="#sec:styles" id="QQ2-1-163">Glossary Styles</a></span>
-<br />  <span class="sectionToc" >13.1 <a
-href="#sec:predefinedstyles" id="QQ2-1-164">Predefined Styles</a></span>
-<br />   <span class="subsectionToc" >13.1.1 <a
-href="#sec:liststyles" id="QQ2-1-166">List Styles</a></span>
-<br />   <span class="subsectionToc" >13.1.2 <a
-href="#sec:longstyles" id="QQ2-1-167">Longtable Styles</a></span>
-<br />   <span class="subsectionToc" >13.1.3 <a
-href="#sec:longraggedstyles" id="QQ2-1-168">Longtable Styles (Ragged Right)</a></span>
-<br />   <span class="subsectionToc" >13.1.4 <a
-href="#x1-16000013.1.4" id="QQ2-1-169">Longtable Styles (<span
-class="cmss-10">booktabs</span>)</a></span>
-<br />   <span class="subsectionToc" >13.1.5 <a
-href="#sec:superstyles" id="QQ2-1-170">Supertabular Styles</a></span>
-<br />   <span class="subsectionToc" >13.1.6 <a
-href="#sec:superraggedstyles" id="QQ2-1-171">Supertabular Styles (Ragged Right)</a></span>
-<br />   <span class="subsectionToc" >13.1.7 <a
-href="#sec:treestyles" id="QQ2-1-172">Tree-Like Styles</a></span>
-
-
-<br />   <span class="subsectionToc" >13.1.8 <a
-href="#sec:mcolstyles" id="QQ2-1-173">Multicols Style</a></span>
-<br />   <span class="subsectionToc" >13.1.9 <a
-href="#sec:inline" id="QQ2-1-175">In-Line Style</a></span>
-<br />  <span class="sectionToc" >13.2 <a
-href="#sec:newglossarystyle" id="QQ2-1-176">Defining your own glossary style</a></span>
-<br /> <span class="chapterToc" >14 <a
-href="#sec:xindy" id="QQ2-1-177">Xindy (Option 3)</a></span>
-<br />  <span class="sectionToc" >14.1 <a
-href="#sec:langenc" id="QQ2-1-178">Language and Encodings</a></span>
-<br />  <span class="sectionToc" >14.2 <a
-href="#sec:xindyloc" id="QQ2-1-179">Locations and Number lists</a></span>
-<br />  <span class="sectionToc" >14.3 <a
-href="#sec:groups" id="QQ2-1-180">Glossary Groups</a></span>
-<br /> <span class="chapterToc" >15 <a
-href="#sec:utilities" id="QQ2-1-181">Utilities</a></span>
-<br />  <span class="sectionToc" >15.1 <a
-href="#sec:loops" id="QQ2-1-182">Loops</a></span>
-<br />  <span class="sectionToc" >15.2 <a
-href="#sec:conditionals" id="QQ2-1-183">Conditionals</a></span>
-<br />  <span class="sectionToc" >15.3 <a
-href="#sec:fetchset" id="QQ2-1-184">Fetching and Updating the Value of a Field</a></span>
-<br /> <span class="chapterToc" >16 <a
-href="#sec:prefix" id="QQ2-1-185">Prefixes or Determiners</a></span>
-<br /> <span class="chapterToc" >17 <a
-href="#sec:accsupp" id="QQ2-1-186">Accessibility Support</a></span>
-<br /> <span class="chapterToc" >18 <a
-href="#sec:samples" id="QQ2-1-187">Sample Documents</a></span>
-<br />  <span class="sectionToc" >18.1 <a
-href="#sec:samplesbasic" id="QQ2-1-188">Basic</a></span>
-<br />  <span class="sectionToc" >18.2 <a
-href="#sec:sampleacronyms" id="QQ2-1-191">Acronyms and First Use</a></span>
-<br />  <span class="sectionToc" >18.3 <a
-href="#sec:samplecounter" id="QQ2-1-201">Non-Page Locations</a></span>
-<br />  <span class="sectionToc" >18.4 <a
-href="#sec:samplestype" id="QQ2-1-205">Multiple Glossaries</a></span>
-<br />  <span class="sectionToc" >18.5 <a
-href="#sec:samplessort" id="QQ2-1-210">Sorting</a></span>
-<br />  <span class="sectionToc" >18.6 <a
-href="#sec:samplesparent" id="QQ2-1-213">Child Entries</a></span>
-<br />  <span class="sectionToc" >18.7 <a
-href="#sec:samplescrossref" id="QQ2-1-217">Cross-Referencing</a></span>
-<br />  <span class="sectionToc" >18.8 <a
-href="#sec:samplescustomkeys" id="QQ2-1-219">Custom Keys</a></span>
-<br />  <span class="sectionToc" >18.9 <a
-href="#sec:samplesxindy" id="QQ2-1-224">Xindy (Option 3)</a></span>
-<br />  <span class="sectionToc" >18.10 <a
-href="#sec:samplesnoidx" id="QQ2-1-229">No Indexing Application (Option 1)</a></span>
-<br />  <span class="sectionToc" >18.11 <a
-href="#sec:samplesother" id="QQ2-1-232">Other</a></span>
-<br /> <span class="chapterToc" >19 <a
-href="#sec:trouble" id="QQ2-1-241">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
-href="#tab:options">Glossary Options: Pros and Cons</a></span><br /><span class="lotToc" >1.2 <a
-href="#tab:predefinednames">Customised Text</a></span><br /><span class="lotToc" >1.3 <a
-href="#tab:makeglossariesCmds">Commands
-and package options that have no effect when using xindy or makeindex
-explicitly</a></span><br /><span class="lotToc" >4.1 <a
-href="#tab:fieldmap">Key to Field Mappings</a></span><br /><span class="lotToc" >5.1 <a
-href="#tab:hyperxx">Predefined Hyperlinked Location
-Formats</a></span><br /><span class="lotToc" >6.1 <a
-href="#tab:shortcuts">Synonyms provided by the package option <span
-class="cmss-10">shortcuts</span></a></span><br /><span class="lotToc" >6.2 <a
-href="#tab:xspace">The effect
-of using xspace</a></span><br /><span class="lotToc" >13.1 <a
-href="#tab:styles">Glossary Styles</a></span><br /><span class="lotToc" >13.2 <a
-href="#tab:mcols">Multicolumn Styles</a></span><br />
- </div>
-
-
-
-
-<!--l. 1--><p class="indent" > <a
- id="likesection.1"></a><a
- id="x1-2001x1"></a><a
- id="glossary"></a>
-
-
-</p>
- <h2 class="likechapterHead"><a
- id="x1-30001"></a>Glossary</h2>
-<!--l. 1--><p class="noindent" ><span
-class="cmti-10">This glossary style was setup using:</span> </p>
-<table
-cellpadding="0" border="0"
-class="tabbing"><tr
-style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
-class="tabbing"><span
-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
-cellpadding="0" border="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
-cellpadding="0" border="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
-cellpadding="0" border="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
-cellpadding="0" border="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
-cellpadding="0" border="0"
-class="tabbing"><tr
-style="vertical-align:baseline;" class="tabbing"><td style="width:94;"
-class="tabbing"></td><td
-class="tabbing"><span
-class="cmtt-10">nogroupskip]</span><span
-class="cmsy-10">{</span><span
-class="cmtt-10">glossaries</span><span
-class="cmsy-10">}</span></td></tr></table>
-<!--l. 1--><p class="indent" >
- </p><dl class="description"><dt class="description">
- <!--l. 88--><p class="noindent" >
-<a
- id="glo:bib2gls"></a><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-3001"></a> </p></dt><dd
-class="description">
- <!--l. 88--><p class="noindent" ><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><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" />
- </p></dd><dt class="description">
- <!--l. 93--><p class="noindent" >
-<a
- id="glo:cli"></a><span
-class="cmbx-10">Command Line Interface (CLI)</span> </p></dt><dd
-class="description">
- <!--l. 93--><p class="noindent" ><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" />
- </p></dd><dt class="description">
- <!--l. 105--><p class="noindent" >
-<a
- id="glo:convertgls2bib"></a><span
-class="cmtt-10">convertgls2bib</span><a
- id="dx1-3006"></a> </p></dt><dd
-class="description">
- <!--l. 105--><p class="noindent" ><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" />
- </p></dd><dt class="description">
- <!--l. 108--><p class="noindent" >
-<a
- id="glo:entrylocation"></a><span
-class="cmbx-10">Entry location</span><a
- id="dx1-3013"></a> </p></dt><dd
-class="description">
- <!--l. 108--><p class="noindent" ><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" />
- </p></dd><dt class="description">
- <!--l. 115--><p class="noindent" >
-<a
- id="glo:exlatinalph"></a><span
-class="cmbx-10">Extended Latin Alphabet</span><a
- id="dx1-3014"></a> </p></dt><dd
-class="description">
- <!--l. 115--><p class="noindent" ><br
-class="newline" />An alphabet consisting of <a
-href="#glo:latinchar">Latin character<a
- id="dx1-3015"></a>s</a> and <a
-href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3016"></a>s</a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 118--><p class="noindent" >
-<a
- id="glo:exlatinchar"></a><span
-class="cmbx-10">Extended Latin Character</span><a
- id="dx1-3017"></a> </p></dt><dd
-class="description">
- <!--l. 118--><p class="noindent" ><br
-class="newline" />A character that’s created by combining <a
-href="#glo:latinchar">Latin character<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-3020"></a></a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 152--><p class="noindent" >
-<a
- id="glo:firstuse"></a><span
-class="cmbx-10">First use</span><a
- id="dx1-3021"></a> </p></dt><dd
-class="description">
- <!--l. 152--><p class="noindent" ><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="cmtt-10">\gls</span><a
- id="dx1-3022"></a>, <span
-class="cmtt-10">\Gls</span><a
- id="dx1-3023"></a>, <span
-class="cmtt-10">\GLS</span><a
- id="dx1-3024"></a>, <span
-class="cmtt-10">\glspl</span><a
- id="dx1-3025"></a>, <span
-class="cmtt-10">\Glspl</span><a
- id="dx1-3026"></a>, <span
-class="cmtt-10">\GLSpl</span><a
- id="dx1-3027"></a> or <span
-class="cmtt-10">\glsdisp</span><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" />
- </p></dd><dt class="description">
- <!--l. 171--><p class="noindent" >
-<a
- id="glo:firstuseflag"></a><span
-class="cmbx-10">First use flag</span><a
- id="dx1-3029"></a> </p></dt><dd
-class="description">
- <!--l. 171--><p class="noindent" ><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="cmbx-10">7</span> </a><a
-href="#sec:glsunset">Unsetting
- and Resetting Entry Flags<!--tex4ht:ref: sec:glsunset --></a>. <br
-class="newline" />
-
-
- </p></dd><dt class="description">
- <!--l. 173--><p class="noindent" >
-<a
- id="glo:firstusetext"></a><span
-class="cmbx-10">First use text</span><a
- id="dx1-3030"></a> </p></dt><dd
-class="description">
- <!--l. 173--><p class="noindent" ><br
-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="cmtt-10">\newglossaryentry</span><a
- id="dx1-3033"></a>. (May be overridden by <span
-class="cmtt-10">\glsdisp</span><a
- id="dx1-3034"></a> or by <span
-class="cmtt-10">\defglsentry</span><a
- id="dx1-3035"></a>.) <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 268--><p class="noindent" >
-<a
- id="glo:glossaries-extra"></a><span
-class="cmssbx-10">glossaries-extra</span> </p></dt><dd
-class="description">
- <!--l. 268--><p class="noindent" ><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-extra </span>package installed. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 286--><p class="noindent" >
-<a
- id="glo:indexingapp"></a><span
-class="cmbx-10">Indexing application</span> </p></dt><dd
-class="description">
- <!--l. 286--><p class="noindent" ><br
-class="newline" />An application (piece of software) separate from TeX/LaTeX 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
- TeX: <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-3036"></a></a> and <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-3037"></a></a>. These are both <a
-href="#glo:cli">command line interface (CLI)</a> applications. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 290--><p class="noindent" >
-<a
- id="glo:latinalph"></a><span
-class="cmbx-10">Latin Alphabet</span><a
- id="dx1-3038"></a> </p></dt><dd
-class="description">
- <!--l. 290--><p class="noindent" ><br
-class="newline" />The alphabet consisting of <a
-href="#glo:latinchar">Latin character<a
- id="dx1-3039"></a>s</a>. See also <a
-href="#glo:exlatinalph">extended Latin alphabet</a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 292--><p class="noindent" >
-<a
- id="glo:latinchar"></a><span
-class="cmbx-10">Latin Character</span><a
- id="dx1-3040"></a> </p></dt><dd
-class="description">
- <!--l. 292--><p class="noindent" ><br
-class="newline" />One of the letters <span
-class="cmtt-10">a</span>, …, <span
-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-3041"></a></a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 312--><p class="noindent" >
-<a
- id="glo:linktext"></a><span
-class="cmbx-10">Link text</span><a
- id="dx1-3042"></a> </p></dt><dd
-class="description">
-
-
- <!--l. 312--><p class="noindent" ><br
-class="newline" />The text produced by commands such as <span
-class="cmtt-10">\gls</span><a
- id="dx1-3043"></a>. It may or may not be a hyperlink to the glossary.
- <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 346--><p class="noindent" >
-<a
- id="glo:makeglossaries"></a><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-3044"></a> </p></dt><dd
-class="description">
- <!--l. 346--><p class="noindent" ><br
-class="newline" />A custom designed Perl script interface to <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-3045"></a></a> and <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-3046"></a></a> provided with the <span
-class="cmss-10">glossaries</span>
- package. TeX 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" />
- </p></dd><dt class="description">
- <!--l. 349--><p class="noindent" >
-<a
- id="glo:makeglossariesgui"></a><span
-class="cmtt-10">makeglossariesgui</span><a
- id="dx1-3047"></a> </p></dt><dd
-class="description">
- <!--l. 349--><p class="noindent" ><br
-class="newline" />A Java GUI alternative to <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><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" />
- </p></dd><dt class="description">
- <!--l. 368--><p class="noindent" >
-<a
- id="glo:makeglossaries-lite.lua"></a><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-3049"></a> </p></dt><dd
-class="description">
- <!--l. 368--><p class="noindent" ><br
-class="newline" />A custom designed Lua script interface to <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-3050"></a></a> and <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- 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 TeX 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" />
- </p></dd><dt class="description">
- <!--l. 419--><p class="noindent" >
-<a
- id="glo:makeindex"></a><span
-class="cmtt-10">makeindex</span><a
- id="dx1-3053"></a> </p></dt><dd
-class="description">
- <!--l. 419--><p class="noindent" ><br
-class="newline" />An <a
-href="#glo:indexingapp">indexing application</a>. See <a
-href="#option2">Option 2</a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 427--><p class="noindent" >
-<a
- id="glo:nonlatinalph"></a><span
-class="cmbx-10">Non-Latin Alphabet</span><a
- id="dx1-3054"></a> </p></dt><dd
-class="description">
-
-
- <!--l. 427--><p class="noindent" ><br
-class="newline" />An alphabet consisting of <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-3055"></a>s</a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 435--><p class="noindent" >
-<a
- id="glo:nonlatinchar"></a><span
-class="cmbx-10">Non-Latin Character</span><a
- id="dx1-3056"></a> </p></dt><dd
-class="description">
- <!--l. 435--><p class="noindent" ><br
-class="newline" />An <a
-href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3057"></a></a> or a character that isn’t a <a
-href="#glo:latinchar">Latin character<a
- id="dx1-3058"></a></a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 483--><p class="noindent" >
-<a
- id="glo:numberlist"></a><span
-class="cmbx-10">Number list</span><a
- id="dx1-3059"></a> </p></dt><dd
-class="description">
- <!--l. 483--><p class="noindent" ><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
-class="cmss-10">nonumberlist</span><a
- id="dx1-3060"></a> package option. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 489--><p class="noindent" >
-<a
- id="glo:sanitize"></a><span
-class="cmbx-10">Sanitize</span><a
- id="dx1-3061"></a> </p></dt><dd
-class="description">
- <!--l. 489--><p class="noindent" ><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="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">\foo </span>will appear as: —foo.
- </p><!--l. 489--><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">
- <!--l. 498--><p class="noindent" >
-<a
- id="glo:smallcaps"></a><span
-class="cmbx-10">Small caps</span><a
- id="dx1-3063"></a> </p></dt><dd
-class="description">
- <!--l. 498--><p class="noindent" ><br
-class="newline" />Small capitals. The LaTeX 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" />
-
-
- </p></dd><dt class="description">
- <!--l. 502--><p class="noindent" >
-<a
- id="glo:latexexlatinchar"></a><span
-class="cmbx-10">Standard LaTeX</span><span
-class="cmbx-10"> Extended Latin Character</span><a
- id="dx1-3067"></a> </p></dt><dd
-class="description">
- <!--l. 502--><p class="noindent" ><br
-class="newline" />An <a
-href="#glo:exlatinchar">extended Latin character<a
- id="dx1-3068"></a></a> that can be created by a core LaTeX 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" />
- </p></dd><dt class="description">
- <!--l. 512--><p class="noindent" >
-<a
- id="glo:UTF-8"></a><span
-class="cmbx-10">UTF-8</span><a
- id="dx1-3069"></a> </p></dt><dd
-class="description">
- <!--l. 512--><p class="noindent" ><br
-class="newline" />A variable-width character encoding. This means that some characters are represented by more
- that one byte. XeLaTeX and LuaLaTeX treat the multi-byte sequence as a single token, but the
- older LaTeX formats have single-byte tokens, which causes complications. Related blog article:
- <a
-href="https://www.dickimaw-books.com/blog/binary-files-text-files-and-file-encodings/" >Binary Files, Text Files and File Encodings</a>. <br
-class="newline" />
- </p></dd><dt class="description">
- <!--l. 565--><p class="noindent" >
-<a
- id="glo:xindy"></a><span
-class="cmtt-10">xindy</span><a
- id="dx1-3070"></a> </p></dt><dd
-class="description">
- <!--l. 565--><p class="noindent" ><br
-class="newline" />A flexible <a
-href="#glo:indexingapp">indexing application</a> with multilingual support written in Perl. See <a
-href="#option3">Option 3</a>. <br
-class="newline" /></p></dd></dl>
-
-
-<!--l. 857--><p class="indent" > <div class="chapter"><h2 class="chapterHead">1. <a
- id="sec:intro"></a>Introduction</h2>
-</p><!--l. 860--><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. 870--><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 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. 879--><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. 885--><p class="indent" > The simplest document is one without a glossary:
-
-
-</p>
- <pre class="verbatim" id="verbatim-1">
-\documentclass{article}
-\usepackage[
-  sort=none % no sorting or indexing required
+<div class="toc-table"><a href="#tab:styles"><span class="numberline">13.1</span>Glossary Styles</a></div><!-- end of toc-table -->
+
+<div class="toc-table"><a href="#tab:mcols"><span class="numberline">13.2</span>Multicolumn Styles</a></div><!-- end of toc-table -->
+ </div><!-- end of lot -->
+</section><!-- end of section chapter*.2 -->
+
+<section id="sec:listofexamples"><!-- start of section sec:listofexamples --><div class="tomain"><a href="#main">[top]</a></div>
+<h1><!-- start of chapter header -->List of Examples<div class="labellink"><a href="#sec:listofexamples">[link]</a></div></h1><!-- end of chapter header -->
+<div class="loe">
+<div class="toc-example"><a href="#ex:simplenogloss"><span class="numberline">1</span>Simple document with no glossary</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:simpleunsrt"><span class="numberline">2</span>Simple document with unsorted glossaries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:noidx"><span class="numberline">3</span>Simple document that uses TeX to sort entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:mkidx"><span class="numberline">4</span>Simple document that uses <span class="appfmt">makeindex</span> to sort entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:xdy"><span class="numberline">5</span>Simple document that uses <span class="appfmt">xindy</span> to sort entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:b2g"><span class="numberline">6</span>Simple document that uses <span class="appfmt">bib2gls</span> to sort entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:unsrt"><span class="numberline">7</span>Simple document with an unsorted list of all defined entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:standalone"><span class="numberline">8</span>Simple document with standalone entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:diffsorts"><span class="numberline">9</span>Mixing Alphabetical and Order of Definition Sorting</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:customsort"><span class="numberline">10</span>Customizing Standard Sort (Options 2 or 3)</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:addkey"><span class="numberline">11</span>Defining Custom Keys</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:addstoragekey"><span class="numberline">12</span>Defining Custom Storage Key (Acronyms and Initialisms)</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:addstoragekey2"><span class="numberline">13</span>Defining Custom Storage Key (Acronyms and Non-Acronyms with Descriptions)</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:hierarchical"><span class="numberline">14</span>Hierarchical Divisions — Greek and Roman Mathematical Symbols</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:loadgls"><span class="numberline">15</span>Loading Entries from Another File</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:customfmt"><span class="numberline">16</span>Custom Entry Display in Text</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:defglsentryfmt"><span class="numberline">17</span>Custom Format for Particular Glossary</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:hyperdesc"><span class="numberline">18</span>First Use With Hyperlinked Footnote Description</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:hyperfirst"><span class="numberline">19</span>Suppressing Hyperlinks on First Use Just For Acronyms</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:nomathhyper"><span class="numberline">20</span>Only Hyperlink in Text Mode Not Math Mode</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:chap-hyperfirst"><span class="numberline">21</span>One Hyper Link Per Entry Per Chapter</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:simpleacronyms"><span class="numberline">22</span>Simple document with acronyms</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:newacronym"><span class="numberline">23</span>Defining and Using an Acronym</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:newacronymrollback"><span class="numberline">24</span>Defining and Using an Acronym (Rollback)</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:longscshort"><span class="numberline">25</span>Small-Caps Acronym</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:acrstyle"><span class="numberline">26</span>Adapting a Predefined Acronym Style</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:customacrstyle"><span class="numberline">27</span>Defining a Custom Acronym Style</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:font-abbr"><span class="numberline">28</span>Italic and Upright Abbreviations</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:dotabbr"><span class="numberline">29</span>Abbreviations with Full Stops (Periods)</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#sec:entrycount"><span class="numberline">30</span>Don’t index entries that are only used once</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:twocolumn"><span class="numberline">31</span>Switch to Two Column Mode for Glossary</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:dual"><span class="numberline">32</span>Dual Entries</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:glsnamefont"><span class="numberline">33</span>Changing the Font Used to Display Entry Names in the Glossary</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#sec:exnewstyle"><span class="numberline">34</span>Creating a completely new style</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#sec:exadaptstyle"><span class="numberline">35</span>Creating a new glossary style based on an existing style</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#sec:exuserstyle"><span class="numberline">36</span>Example: creating a glossary style that uses the <span class="csoptfmt">user1</span>, …, <span class="csoptfmt">user6</span> keys</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:hyperbfit"><span class="numberline">37</span>Custom Font for Displaying a Location</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:customloc"><span class="numberline">38</span>Custom Numbering System for Locations</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:dice"><span class="numberline">39</span>Locations as Dice</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:fmtcount"><span class="numberline">40</span>Locations as Words not Digits</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:determiners"><span class="numberline">41</span>Defining Determiners</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:prefixes"><span class="numberline">42</span>Using Prefixes</a></div><!-- end of toc-example -->
+
+<div class="toc-example"><a href="#ex:plist"><span class="numberline">43</span>Adding Determiner to Glossary Style</a></div><!-- end of toc-example -->
+</div><!-- end of loe --><p>
+
+</section><!-- end of section sec:listofexamples -->
+
+<section id="userguide"><!-- start of section userguide --><div class="tomain"><a href="#main">[top]</a></div>
+<div class="part"><!-- start of part header -->I. User Guide<div class="labellink"><a href="#userguide">[link]</a></div></div><!-- end of part header -->
+<p>
+
+</section><!-- end of section userguide -->
+
+<section id="sec:intro"><!-- start of section sec:intro --><div class="tomain"><a href="#main">[top]</a></div>
+<h1><!-- start of chapter header -->1. Introduction<div class="labellink"><a href="#sec:intro">[link]</a></div></h1><!-- end of chapter header -->
+<p>
+<div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.36"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.37"></a><code class="code"><code class="cmd">\usepackage</code>[<span class="meta">〈<em class="metainner">options</em>〉</span>]{<dfn id="glo:pkg.glossaries"><span class="styfmt">glossaries</span></dfn>}</code></div><!-- end of pinnedbox -->
+<p>
+The <a id="wrglossary.38"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package is provided to assist generating lists of terms, symbols or <a id="wrglossary.39"></a><a href="#glo:idx.acronym">acronyms</a>. For convenience, these lists are all referred to as <a id="wrglossary.40"></a><a href="#glo:dual.glossary">glossaries</a> in this manual. The terms, symbols and <a id="wrglossary.41"></a><a href="#glo:idx.acronym">acronyms</a> are collectively referred to as <a id="wrglossary.42"></a><dfn id="glo:idx.glossaryentry">glossary entries</dfn>.<p>
+The package has a certain amount of flexibility, allowing the user to customize the format of the <a id="wrglossary.43"></a><a href="#glo:dual.glossary">glossary</a> and define multiple <a id="wrglossary.44"></a><a href="#glo:dual.glossary">glossaries</a>. It also supports <a id="wrglossary.45"></a><a href="#glo:idx.glossarystyle">glossary styles</a> that include an associated symbol (in addition to a name and description) for each <a id="wrglossary.46"></a><a href="#glo:idx.glossaryentry">glossary entry</a>.<p>
+There is provision for loading a database of glossary entries. Only those entries <a id="wrglossary.47"></a><a href="#glo:@@glslabel at indexing">indexed</a> in the document will be displayed in the <a id="wrglossary.48"></a><a href="#glo:dual.glossary">glossary</a>. (Unless you use <a id="wrglossary.49"></a><a href="#glo:idx.opt.unsrt">Option 5</a>, which doesn’t use any <a id="wrglossary.50"></a><a href="#glo:dual.indexing">indexing</a> but will instead list all defined entries in order of definition.)<p>
+It’s not necessary to actually have a <a id="wrglossary.51"></a><a href="#glo:dual.glossary">glossary</a> in the document. You may be interested in using this package just as means to consistently format certain types of terms, such as <a id="wrglossary.52"></a><a href="#glo:idx.acronym">acronyms</a>, or you may prefer to have descriptions scattered about the document and be able to easily link to the relevant description (<a id="wrglossary.53"></a><a href="#glo:idx.opt.standalone">Option 6</a>).<p>
+The simplest document is one without a glossary: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.54"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[
+ <a id="wrglossary.55"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.56"></a><a href="#glo:optval.sort.none"><span class="optfmt">none</span></a> <span class="comment">% no sorting or <a id="wrglossary.57"></a><a href="#glo:dual.indexing">indexing</a> required</span>
]
{glossaries}
-\newglossaryentry
- {cafe}% label
- {% definition:
-   name={caf\'e},
-   description={small restaurant selling refreshments}
- }
-\setacronymstyle{long-short}
-\newacronym
- {html}% label
- {HTML}% short form
- {hypertext markup language}% long form
-\newglossaryentry
- {pi}% label
- {% 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}.
-\Gls{distance} (\glsentrydesc{distance}) is measured in
-\glssymbol{distance}.
-\end{document}
-</pre>
-<!--l. 929--><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. 933--><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>
- <pre class="verbatim" id="verbatim-2">
-\documentclass{article}
-</pre>
-<!--l. 941--><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>
-
-
- <pre class="verbatim" id="verbatim-3">
-\newglossaryentry % provided by glossaries.sty
- {cafe}% label
- {% definition:
-   name={caf\'e},
-   description={small restaurant selling refreshments}
- }
-</pre>
-<!--l. 958--><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>
-
-
- <pre class="verbatim" id="verbatim-4">
-\newglossaryentry % provided by glossaries.sty
- {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}.
-\Gls{distance} is measured in \glssymbol{distance}.
-</pre>
-<!--l. 988--><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. 999--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> In this user manual, 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. 1007--><p class="noindent" >
-</p><!--l. 1009--><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. 1015--><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. 1021--><p class="noindent" >
-</p><!--l. 1023--><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-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-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 generate 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-4018"></a> to
-run them.
-</p><!--l. 1035--><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. 1040--><p class="indent" > The remainder of this introductory section covers the following: </p>
- <ul class="itemize1">
- <li class="itemize">
- <!--l. 1042--><p class="noindent" ><a
-href="#sec:indexingoptions">§<span
-class="cmbx-10">1.2</span> </a><a
-href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> lists the available indexing options.
- </p></li>
- <li class="itemize">
- <!--l. 1045--><p class="noindent" ><a
-href="#sec:lipsum">§<span
-class="cmbx-10">1.3</span> </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.
- </p></li>
- <li class="itemize">
- <!--l. 1048--><p class="noindent" ><a
-href="#sec:languages">§<span
-class="cmbx-10">1.4</span> </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.
- </p></li>
- <li class="itemize">
- <!--l. 1051--><p class="noindent" ><a
-href="#sec:makeglossaries">§<span
-class="cmbx-10">1.5</span> </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="#option2">2</a> or <a
-href="#option3">3</a>).
-</p>
- </li></ul>
-<!--l. 1057--><p class="indent" > There are some sample documents provided with this package. They are described in <a
-href="#sec:samples">§<span
-class="cmbx-10">18</span> </a><a
-href="#sec:samples">Sample
-Documents<!--tex4ht:ref: sec:samples --></a>.
-</p>
-<!--l. 1060--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.1 </span> <a
- id="sec:rollback"></a>Rollback</h3>
-<!--l. 1063--><p class="noindent" >There is one rollback release: v4.46 (2020-03-19) for <span
-class="cmss-10">glossaries.sty </span>and <span
-class="cmss-10">glossary-list.sty</span>. The other associated
-packages haven’t been changed since that release (apart from the version numbers, which are always updated for
-each new release, regardless of whether or not the file has otherwise been changed). If you rollback to v4.46
-using:
-
-
-</p>
- <pre class="verbatim" id="verbatim-5">
-\usepackage{glossaries}[=v4.46]
-</pre>
-<!--l. 1071--><p class="nopar" > then the 4.46 version of <span
-class="cmss-10">glossary-list.sty</span><a
- id="dx1-5001"></a> will automatically be loaded. If you use <span
-class="cmss-10">nostyles</span><a
- id="dx1-5002"></a> and subsequently load
-<span
-class="cmss-10">glossary-list</span><a
- id="dx1-5003"></a> you will also need to add the rollback version:
-
-
-</p>
- <pre class="verbatim" id="verbatim-6">
-\usepackage[nostyles]{glossaries}[=v4.46]
-\usepackage{glossary-list}[=v4.46]
-</pre>
-<!--l. 1078--><p class="nopar" > If you rollback using <span
-class="cmss-10">latexrelease</span><a
- id="dx1-5004"></a> to an earlier date, then you will need to specify v4.46 for <span
-class="cmss-10">glossaries</span><a
- id="dx1-5005"></a> as there are
-no earlier rollback versions available.
-</p><!--l. 1083--><p class="noindent" >
-</p>
-<!--l. 1083--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.2 </span> <a
- id="sec:indexingoptions"></a>Indexing Options</h3>
-<!--l. 1086--><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. 1097--><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 <span
-class="cmbx-10">1.1</span></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. 1103--><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. 1112--><p class="noindent" >
-</p><!--l. 1114--><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. 1121--><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-60011 -->
-
-
-<div class="tabular"> <table id="TBL-2" class="tabular"
-
-><colgroup id="TBL-2-1g"><col
-id="TBL-2-1" /><col
-id="TBL-2-2" /><col
-id="TBL-2-3" /><col
-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. 1129--><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
-class="cmbx-10"> 1</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-3"
-class="td11"> <a
-href="#option2"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 2</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-4"
-class="td11"> <a
-href="#option3"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 3</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-5"
-class="td11"> <a
-href="#option4"><span
-class="cmbx-10">Option</span><span
-class="cmbx-10"> 4</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-6"
-class="td10"> <a
-href="#option5"><span
-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. 1131--><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="textcolor16"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
-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="textcolor18"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-5"
-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="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. 1133--><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="textcolor21"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
-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="textcolor23"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-5"
-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="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. 1135--><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="textcolor26"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
-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="textcolor28"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-5"
-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="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. 1137--><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="textcolor31"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
-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="textcolor33"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-5"
-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="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. 1139--><p class="noindent" ><span
-class="cmr-9">Can</span>
-<span
-class="cmr-9">sort</span>
-<a
-href="#glo:exlatinalph"><span
-class="cmr-9">extended</span>
-<span
-class="cmr-9">Latin</span>
-<span
-class="cmr-9">alphabets</span></a>
-<span
-class="cmr-9">or</span>
-<a
-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="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="textcolor37"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
-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="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. 1142--><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="textcolor40"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
-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="textcolor42"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-5"
-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. 1144--><p class="noindent" ><span
-class="cmr-9">Can</span>
-<span
-class="cmr-9">use</span>
-<span
-class="cmr-9">a</span>
-<span
-class="cmr-9">different</span>
-<span
-class="cmr-9">sort</span>
-<span
-class="cmr-9">method</span>
-<span
-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="textcolor44"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-8-3"
-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="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="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. 1148--><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="textcolor48"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-3"
-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="textcolor50"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-9-5"
-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="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. 1150--><p class="noindent" ><span
-class="cmr-9">Are</span>
-<span
-class="cmr-9">entries</span>
-<span
-class="cmr-9">with</span>
-<span
-class="cmr-9">identical</span>
-<span
-class="cmr-9">sort</span>
-<span
-class="cmr-9">values</span>
-<span
-class="cmr-9">treated</span>
-<span
-class="cmr-9">as</span>
-<span
-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="textcolor53"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-3"
-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="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="textcolor56"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-10-6"
-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. 1153--><p class="noindent" ><span
-class="cmr-9">Can</span>
-<span
-class="cmr-9">automatically</span>
-<span
-class="cmr-9">form</span>
-<span
-class="cmr-9">ranges</span>
-<span
-class="cmr-9">in</span>
-<span
-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="textcolor58"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-3"
-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="textcolor60"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-11-5"
-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="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. 1155--><p class="noindent" ><span
-class="cmr-9">Can</span>
-<span
-class="cmr-9">have</span>
-<span
-class="cmr-9">non-standard</span>
-<span
-class="cmr-9">locations</span>
-<span
-class="cmr-9">in</span>
-<span
-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="textcolor63"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-3"
-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="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="textcolor66"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-12-6"
-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. 1160--><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="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"
-class="td11"> 3 </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-4"
-class="td11"> <span
-class="cmsy-10">∞ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-5"
-class="td11"> <span
-class="cmsy-10">∞ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-13-6"
-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. 1162--><p class="noindent" ><span
-class="cmtt-9">\glsdisplaynumberlist</span><a
- id="dx1-6002"></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="textcolor68"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-3"
-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="textcolor70"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-14-5"
-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="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. 1164--><p class="noindent" ><span
-class="cmtt-9">\newglossaryentry</span><a
- id="dx1-6003"></a>
-<span
-class="cmr-9">allowed</span>
-<span
-class="cmr-9">in</span>
-<span
-class="cmss-9">document</span><a
- id="dx1-6004"></a><a
- id="dx1-6005"></a>
-<span
-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="td11"> <span
-class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-3"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-4"
-class="td11"> <span
-class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-5"
-class="td11"> <span
-class="pzdr-">✘</span><sup class="textsuperscript"><span
-class="tcrm-0900">※</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-15-6"
-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. 1167--><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="textcolor73"><span
-class="pzdr-">✘</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-3"
-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="textcolor75"><span
-class="pzdr-">✔</span></span> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-16-5"
-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="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. 1169--><p class="noindent" ><span
-class="cmr-9">Default</span>
-<span
-class="cmr-9">value</span>
-<span
-class="cmr-9">of</span>
-<span
-class="cmss-9">sanitizesort</span><a
- id="dx1-6006"></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="td11"> <span
-class="cmtt-10">false </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-3"
-class="td11"> <span
-class="cmtt-10">true </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-4"
-class="td11"> <span
-class="cmtt-10">true </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-5"
-class="td11"> <span
-class="cmtt-10">true</span><sup class="textsuperscript"><span
-class="pzdr-x-x-90">✾</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-17-6"
-class="td10"> <span
-class="cmtt-10">true</span><sup class="textsuperscript"><span
-class="pzdr-x-x-90">✾</span></sup> </td>
-</tr></table>
-
-</div>
-<!--l. 1177--><p class="noindent" >______________________________________________________________________________________
-</p><!--l. 1179--><p class="noindent" ><sup class="textsuperscript"><span
-class="tcrm-0900">*</span></sup> <span
-class="cmr-8">Strips standard LaTeX</span><span
-class="cmr-8"> accents (that is, accents generated by core LaTeX</span><span
-class="cmr-8"> commands) so, for example, </span><span
-class="cmtt-8">\AA</span><a
- id="dx1-6007"></a> <span
-class="cmr-8">is treated the</span>
-<span
-class="cmr-8">same as A.</span>
-</p><!--l. 1182--><p class="noindent" ><sup class="textsuperscript"><span
-class="tcrm-0900">†</span></sup> <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. 1183--><p class="noindent" ><sup class="textsuperscript"><span
-class="tcrm-0900">‡</span></sup> <span
-class="cmr-8">Provided </span><span
-class="cmss-8">sort</span><span
-class="cmtt-8">=</span><span
-class="cmss-8">none</span><a
- id="dx1-6008"></a> <span
-class="cmr-8">is used.</span>
-</p><!--l. 1184--><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. 1185--><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. 1186--><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 id="textcolor78"><span
-class="cmtt-8">location</span></span><a
- id="dx1-6009"></a> <span
-class="cmr-8">field provided by </span><span
-class="cmss-8">glossaries-extra</span><span
-class="cmr-8">.</span>
-</p><!--l. 1189--><p class="noindent" ><sup class="textsuperscript"><span
-class="cmr-9">#</span></sup> <span
-class="cmr-8">Unlimited but unreliable.</span>
-</p><!--l. 1190--><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><a
- id="dx1-6010"></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. 1192--><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-6011"></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-6012"></a> <span
-class="cmr-8">but not recommended.</span>
-</p><!--l. 1194--><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-6013"></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-6014"></a><span
-class="cmr-8">.</span>
-</p><!--l. 1196--><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</span><span
-class="cmtt-8">=</span><span
-class="cmss-8">none</span><a
- id="dx1-6015"></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-6016"></a> <span
-class="cmr-8">option automatically switches this on.)</span>
-
-
-</p>
- </div><hr class="endfloat" />
- </div>
-<a
- id="x1-6017r1"></a>
- <h4 class="likesubsectionHead"><a
- id="x1-70001"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option1">🔗</a><a
- id="option1"></a>Option 1 (TeX)</h4>
-<!--l. 1203--><p class="noindent" >This option isn’t generally recommended for reasons given below. Example Document:
-
-
-</p>
- <pre class="verbatim" id="verbatim-7">
-\documentclass{article}
-\usepackage{glossaries}
-</pre>
-<!--l. 1208--><p class="nopar" > </p><div class="alltt">
-<div class="obeylines-v">
-<strong><span
-class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-7001"></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>
-
-
- <pre class="verbatim" id="verbatim-8">
-\newglossaryentry{sample}{name={sample},
-  description={an example}}
-\begin{document}
-\gls{sample}.
-</pre>
-<!--l. 1217--><p class="nopar" > </p><div class="alltt">
-<div class="obeylines-v">
-<strong><span
-class="cmtt-10">\printnoidxglossary</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">\makenoidxglossaries</span><a
- id="dx1-7004"></a>).
-<!--l. 1226--><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> and there’s no guarantee that it will work with <a
-href="#glo:UTF-8">UTF-8</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-7005"></a> package option (the default for Option 1) then the <a
-href="#glo:latexexlatinchar">standard LaTeX 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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">false</span><a
- id="dx1-7006"></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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-7007"></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-7008"></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-7009"></a> or <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">def</span><a
- id="dx1-7010"></a>) in the
-package options or explicitly set the <span
-class="cmtt-10">sort</span><a
- id="dx1-7011"></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-7012"></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. 1247--><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-7013"></a> package option that provides <span id="textcolor84"><span
-class="cmtt-10">\glsxtrnewsymbol</span></span><a
- id="dx1-7014"></a>, which
-automatically sets the <span
-class="cmtt-10">sort</span><a
- id="dx1-7015"></a> key to the entry label (instead of the <span
-class="cmtt-10">name</span><a
- id="dx1-7016"></a>). </div>
-</p><!--l. 1251--><p class="noindent" >
-</p><!--l. 1253--><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-7017"></a> or <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">use</span><a
- id="dx1-7018"></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-7019"></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. 1264--><p class="indent" > Summary:
-
-
- </p><ol class="enumerate1" >
-<li
- class="enumerate" id="x1-7021x1">
- <!--l. 1266--><p class="noindent" >Add
-
-
-</p>
- <pre class="verbatim" id="verbatim-9">
- \makenoidxglossaries
-</pre>
- <!--l. 1269--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
-href="#sec:newglosentry">§<span
-class="cmbx-10">4</span> </a><a
-href="#sec:newglosentry">Defining
- Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </p></li>
-<li
- class="enumerate" id="x1-7023x2">
- <!--l. 1273--><p class="noindent" >Put
-
-
-</p>
- <pre class="verbatim" id="verbatim-10">
- \printnoidxglossary
-</pre>
- <!--l. 1276--><p class="nopar" > where you want your list of entries to appear (described in <a
-href="#sec:printglossary">§<span
-class="cmbx-10">8</span> </a><a
-href="#sec:printglossary">Displaying a Glossary<!--tex4ht:ref: sec:printglossary --></a>).
- Alternatively, to display all glossaries use the iterative command:
-
-
-</p>
- <pre class="verbatim" id="verbatim-11">
- \printnoidxglossaries
-</pre>
- <!--l. 1282--><p class="nopar" >
- </p></li>
-<li
- class="enumerate" id="x1-7025x3">
- <!--l. 1284--><p class="noindent" >Run LaTeX 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 “PDFLaTeX” button in your editor.</p></li></ol>
-<a
- id="x1-7026r2"></a>
-<!--l. 1289--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-80002"></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. 1291--><p class="noindent" >Example document:
-
-
-</p>
- <pre class="verbatim" id="verbatim-12">
-\documentclass{article}
-\usepackage{glossaries}
-</pre>
-<!--l. 1295--><p class="nopar" > </p><div class="alltt">
-<div class="obeylines-v">
-<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>
-
-
- <pre class="verbatim" id="verbatim-13">
-\newglossaryentry{sample}{name={sample},
- description={an example}}
-\begin{document}
-\gls{sample}.
-</pre>
-<!--l. 1304--><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. 1313--><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-8005"></a></a> to sort the entries. This application comes with all
-modern TeX distributions, but it’s hard-coded for the non-extended <a
-href="#glo:latinalph">Latin alphabet<a
- id="dx1-8006"></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 <a
-href="#glo:UTF-8">UTF-8</a> characters, especially for any sort values that start
-with a <a
-href="#glo:UTF-8">UTF-8</a> character (as it separates the octets resulting in an invalid file encoding). This process involves
-making LaTeX write the glossary information to a temporary file which <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8007"></a></a> reads. Then <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8008"></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. 1325--><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-8009"></a></a> is considered a
-trusted application. (So you should be able to use the <span
-class="cmss-10">automake</span><a
- id="dx1-8010"></a> package option provided the shell escape hasn’t
-been completely disabled.)
-</p><!--l. 1332--><p class="indent" > This method can form ranges in the <a
-href="#glo:numberlist">number list<a
- id="dx1-8011"></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">\alph </span>and <span
-class="cmtt-10">\Alph</span>.
-</p><!--l. 1336--><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-8012"></a></a> for each glossary
-type.
-</p><!--l. 1343--><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 <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">§<span
-class="cmbx-10">18.5</span> </a><a
-href="#sec:samplessort">Sorting<!--tex4ht:ref: sec:samplessort --></a>.
-</div>
-</p><!--l. 1350--><p class="noindent" >
-</p><!--l. 1352--><p class="indent" > Summary:
- </p><ol class="enumerate1" >
-<li
- class="enumerate" id="x1-8014x1">
- <!--l. 1354--><p class="noindent" >If you want to use <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8015"></a>’s</a> <span
-class="cmtt-10">-g</span><a
- id="dx1-8016"></a> option you must change the quote character using <span
-class="cmtt-10">\GlsSetQuote</span><a
- id="dx1-8017"></a>. For
- example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-14">
- \GlsSetQuote{+}
-</pre>
- <!--l. 1358--><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-8018"></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-8020x2">
- <!--l. 1364--><p class="noindent" >Add
-
-
-</p>
- <pre class="verbatim" id="verbatim-15">
- \makeglossaries
-</pre>
- <!--l. 1367--><p class="nopar" > to your preamble (before you start defining your entries, as described in <a
-href="#sec:newglosentry">§<span
-class="cmbx-10">4</span> </a><a
-href="#sec:newglosentry">Defining
- Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </p></li>
-<li
- class="enumerate" id="x1-8022x3">
- <!--l. 1372--><p class="noindent" >Put
-
-
-</p>
- <pre class="verbatim" id="verbatim-16">
- \printglossary
-</pre>
- <!--l. 1375--><p class="nopar" > where you want your list of entries to appear (described in <a
-href="#sec:printglossary">§<span
-class="cmbx-10">8</span> </a><a
-href="#sec:printglossary">Displaying a Glossary<!--tex4ht:ref: sec:printglossary --></a>).
- Alternatively, to display all glossaries use the iterative command:
-
-
-</p>
- <pre class="verbatim" id="verbatim-17">
- \printglossaries
-</pre>
- <!--l. 1381--><p class="nopar" >
- </p></li>
-<li
- class="enumerate" id="x1-8024x4">
- <!--l. 1383--><p class="noindent" >Run LaTeX on your document. This creates files with the extensions <span
-class="cmtt-10">glo</span><a
- id="dx1-8025"></a> and <span
-class="cmtt-10">ist</span><a
- id="dx1-8026"></a> (for example, if your
- LaTeX 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 <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> you’ll see the section heading and some boilerplate
- text.)
- </p><!--l. 1392--><p class="noindent" >If you have used package options such as <span
-class="cmss-10">symbols</span><a
- id="dx1-8027"></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-8029x5">
- <!--l. 1396--><p class="noindent" ><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.run">🔗</a><a
- id="x1-80285"></a> Run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8030"></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:
- </p><!--l. 1402--><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 LaTeX 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. 1409--><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-8031"></a>. See <a
-href="#sec:makeindexapp">§<span
-class="cmbx-10">1.5.4</span> </a><a
-href="#sec:makeindexapp">Using <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8032"></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-8033"></a></a> must be called for each set of files. </div>
- </p><!--l. 1413--><p class="noindent" >
- </p><!--l. 1415--><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-8034"></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. 1421--><p class="noindent" >Alternatively, run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8035"></a></a> indirectly via the <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-8036"></a></a> script:
- </p><!--l. 1423--><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-8037"></a></a> with
- <a
-href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-8038"></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-8039"></a> file and run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8040"></a></a> the appropriate number of times with all the necessary
- switches.
- </p><!--l. 1433--><p class="noindent" >The simplest approach is to use <span
-class="cmtt-10">arara</span><a
- id="dx1-8041"></a> and add the following comment lines to the start of your document:
- </p><div class="alltt">
- <div class="obeylines-v">
- <span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
- <br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> makeglossaries</span>
- <br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
-</div>
- </div> (Replace <span
-class="cmtt-10">makeglossaries </span>with <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. 1444--><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-8042"></a> switch:
- </p><!--l. 1447--><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">§<span
-class="cmbx-10">1.5.4</span> </a><a
-href="#sec:makeindexapp">Using <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-8043"></a></a> explicitly (Option 2)<!--tex4ht:ref: sec:makeindexapp --></a> for further details on using <span
-class="cmtt-10">makeindex</span><a
- id="dx1-8044"></a>
- explicitly.) If you use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-8045"></a></a> or <a
-href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-8046"></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-8047"></a> package option
- and the <span
-class="cmtt-10">-l</span><a
- id="dx1-8048"></a> option will be added automatically.
- </p></li>
-<li
- class="enumerate" id="x1-8050x6">
- <!--l. 1456--><p class="noindent" ><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#makeindex.relatex">🔗</a><a
- id="x1-80496"></a> Once you have successfully completed the previous step, you can now run LaTeX on your document
- again.</p></li></ol>
-<!--l. 1459--><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-8051"></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="#x1-80285">5<!--tex4ht:ref: makeindex.run --></a> and <a
-href="#x1-80496">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-8052r3"></a>
-
-
-</p><!--l. 1466--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-90003"></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. 1468--><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-9001"></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>
-
-
- <pre class="verbatim" id="verbatim-18">
-\newglossaryentry{sample}{name={sample},
- description={an example}}
-\begin{document}
-\gls{sample}.
-</pre>
-<!--l. 1479--><p class="nopar" > </p><div class="alltt">
-<div class="obeylines-v">
-<strong><span
-class="cmtt-10">\printglossary</span><a
- id="dx1-9002"></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-9003"></a>
-(<span
-class="cmti-10">after </span><span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-9004"></a>).
-<!--l. 1488--><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-9005"></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. 1493--><p class="indent" > The <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9006"></a></a> application comes with both TeX Live and MiKTeX, but since <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9007"></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
-LaTeX write the glossary information to a temporary file which <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9008"></a></a> reads. Then <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9009"></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. 1501--><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="cmbx-10">14</span> </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">
- <!--l. 1507--><p class="noindent" >entries with the same sort value are merged by <span
-class="cmtt-10">xindy</span><a
- id="dx1-9010"></a> into a single glossary line so you must make
- sure that each entry has a unique sort value;
- </p></li>
- <li class="itemize">
- <!--l. 1510--><p class="noindent" ><span
-class="cmtt-10">xindy</span><a
- id="dx1-9011"></a> forbids empty sort values;
- </p></li>
- <li class="itemize">
- <!--l. 1511--><p class="noindent" ><span
-class="cmtt-10">xindy</span><a
- id="dx1-9012"></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-9013"></a> forbids.</p></li></ul>
-<!--l. 1516--><p class="noindent" >In these problematic cases, you must set the <span
-class="cmtt-10">sort</span><a
- id="dx1-9014"></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. 1522--><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-9015"></a> package option that provides <span id="textcolor85"><span
-class="cmtt-10">\glsxtrnewsymbol</span></span><a
- id="dx1-9016"></a>, which
-automatically sets the <span
-class="cmtt-10">sort</span><a
- id="dx1-9017"></a> key to the entry label (instead of the <span
-class="cmtt-10">name</span><a
- id="dx1-9018"></a>). </div>
-</p><!--l. 1526--><p class="noindent" >
-</p><!--l. 1528--><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. 1531--><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 <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> documentation for further details.
-</div>
-</p><!--l. 1536--><p class="noindent" >
-</p><!--l. 1538--><p class="indent" > Summary:
- </p><ol class="enumerate1" >
-<li
- class="enumerate" id="x1-9020x1">
- <!--l. 1540--><p class="noindent" >Add the <span
-class="cmss-10">xindy</span><a
- id="dx1-9021"></a> option to the <span
-class="cmss-10">glossaries </span>package option list:
-
-
-</p>
- <pre class="verbatim" id="verbatim-19">
- \usepackage[xindy]{glossaries}
-</pre>
- <!--l. 1544--><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>
- <pre class="verbatim" id="verbatim-20">
- \usepackage[xindy={glsnumbers=false}]{glossaries}
-</pre>
- <!--l. 1549--><p class="nopar" > or use either <span
-class="cmtt-10">\GlsSetXdyFirstLetterAfterDigits{</span>⟨<span
-class="cmti-10">letter</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="cmbx-10">14</span> </a><a
-href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a>).
- </p></li>
-<li
- class="enumerate" id="x1-9023x2">
- <!--l. 1555--><p class="noindent" >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="cmbx-10">4</span> </a><a
-href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>).
- </p></li>
-<li
- class="enumerate" id="x1-9025x3">
- <!--l. 1558--><p class="noindent" >Run LaTeX on your document. This creates files with the extensions <span
-class="cmtt-10">glo</span><a
- id="dx1-9026"></a> and <span
-class="cmtt-10">xdy</span><a
- id="dx1-9027"></a> (for example, if your
- LaTeX 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.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.)
- </p><!--l. 1567--><p class="noindent" >If you have used package options such as <span
-class="cmss-10">symbols</span><a
- id="dx1-9028"></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-9030x4">
- <!--l. 1571--><p class="noindent" >Run <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9031"></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
- line):
- </p><!--l. 1579--><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 LaTeX 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">-L</span><a
- id="dx1-9032"></a> <span
-class="cmtt-10">german -C</span><a
- id="dx1-9033"></a> <span
-class="cmtt-10">din5007-utf8</span>.)
-
-
- </p><!--l. 1588--><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-9034"></a>. See <a
-href="#sec:xindyapp">§<span
-class="cmbx-10">1.5.3</span> </a><a
-href="#sec:xindyapp">Using <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9035"></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-9036"></a></a> must be called for each set of files. </div>
- </p><!--l. 1592--><p class="noindent" >
- </p><!--l. 1594--><p class="noindent" >It’s much simpler to use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-9037"></a></a> instead:
- </p><!--l. 1595--><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-9038"></a>
- file and run <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9039"></a></a> the appropriate number of times with all the necessary switches.
- </p><!--l. 1603--><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-9040"></a></a> with <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9041"></a></a>. (Remember that <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9042"></a></a> is a Perl
- script so if you can use <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9043"></a></a> then you can also use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-9044"></a></a>, and if you don’t want
- to use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-9045"></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-9046"></a></a>
- either.)
- </p><!--l. 1609--><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-9047"></a></a> or
- <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-9048"></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. 1615--><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
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
- <br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> makeglossaries</span>
- <br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
-</div>
- </div>
- <!--l. 1623--><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-9049"></a> package option:
-
-
-</p>
- <pre class="verbatim" id="verbatim-21">
- \usepackage[xindy,order=letter]{glossaries}
-</pre>
- <!--l. 1628--><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-9050"></a></a>. If you are explicitly using
- <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9051"></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="cmbx-10">1.5.3</span> </a><a
-href="#sec:xindyapp">Using <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-9052"></a></a>
- explicitly (Option 3)<!--tex4ht:ref: sec:xindyapp --></a> for further details on using <span
-class="cmtt-10">xindy</span><a
- id="dx1-9053"></a> explicitly.
- </p></li>
-<li
- class="enumerate" id="x1-9055x5">
- <!--l. 1635--><p class="noindent" >Once you have successfully completed the previous step, you can now run LaTeX on your document
- again. As with <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-9056"></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.
-</p>
- </li></ol>
-<a
- id="x1-9057r4"></a>
-<!--l. 1642--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-100004"></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. 1644--><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. This method uses
-<a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-10001"></a></a> to both fetch entry definitions from <span
-class="cmtt-10">bib</span><a
- id="dx1-10002"></a> files and to hierarchically sort and collate.
-</p><!--l. 1649--><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-10003"></a><span
-class="cmtt-10">[</span><span id="textcolor88"><span
-class="cmtt-10">src</span></span><a
- id="dx1-10004"></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-10005"></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-10006"></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-10007"></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-10008"></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. 1675--><p class="indent" > All entries must be provided in one or more <span
-class="cmtt-10">bib</span><a
- id="dx1-10009"></a> files. See the <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-10010"></a></a> user manual for the required
-format.
-</p><!--l. 1678--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
-class="cmtt-10">sort</span><a
- id="dx1-10011"></a> key should not be used. Each entry type (<span id="textcolor93"><span
-class="cmtt-10">@entry</span></span><a
- id="dx1-10012"></a>, <span id="textcolor94"><span
-class="cmtt-10">@symbol</span></span><a
- id="dx1-10013"></a>, <span id="textcolor95"><span
-class="cmtt-10">@abbreviation</span></span><a
- id="dx1-10014"></a>)
-has a particular field that’s used for the sort value by default (<span
-class="cmtt-10">name</span><a
- id="dx1-10015"></a>, the label, <span
-class="cmtt-10">short</span><a
- id="dx1-10016"></a>). You will
-break this mechanism if you explicitly use the <span
-class="cmtt-10">sort</span><a
- id="dx1-10017"></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. 1685--><p class="noindent" >
-</p><!--l. 1687--><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-10018"></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>
-</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>
-</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-10019"></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-10020"></a> option is the best method.
-<!--l. 1702--><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 id="textcolor101"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">hybrid</span></span><a
- id="dx1-10021"></a> but in general there is
-little need for this and it complicates the build process.)
-</p><!--l. 1706--><p class="indent" > Each resource set is loaded with <span id="textcolor102"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-10022"></a><span
-class="cmtt-10">[</span>⟨<span
-class="cmti-10">options</span>⟩<span
-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-10023"></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-10024"></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-10025"></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>
-</div> The <span
-class="cmtt-10">bib</span><a
- id="dx1-10026"></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-10027"></a> key. The <span id="textcolor107"><span
-class="cmtt-10">sort</span></span><a
- id="dx1-10028"></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. 1723--><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-10029"></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-10030"></a></a> user manual for further
-details.)
-</p><!--l. 1729--><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-10031"></a>
-</div>
-</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-10032"></a>
-</div>
-</div> The document is built using:
-<!--l. 1739--><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-10033"></a> switch:
-</p><!--l. 1745--><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-10034"></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. 1754--><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. 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. 1763--><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-10035"></a></a>.<span class="footnote-mark"><a
-href="#fn2x1" id="fn2x1-bk"><sup class="textsuperscript">1.2</sup></a></span><a
- id="x1-10036f2"></a> The
-locations in the <a
-href="#glo:numberlist">number list<a
- id="dx1-10038"></a></a> may be in any format. If <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-10039"></a></a> can deduce a numerical value it will attempt to
-form ranges otherwise it will simply list the locations.
-</p><!--l. 1771--><p class="indent" > Summary:
- </p><ol class="enumerate1" >
-<li
- class="enumerate" id="x1-10041x1">
- <!--l. 1773--><p class="noindent" >Use <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> with the <span id="textcolor112"><span
-class="cmss-10">p</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">record</span></span><a
- id="dx1-10042"></a>ackage option:
-
-
-</p>
- <pre class="verbatim" id="verbatim-22">
- \usepackage[record]{glossaries-extra}
-</pre>
- <!--l. 1777--><p class="nopar" >
- </p></li>
-<li
- class="enumerate" id="x1-10044x2">
- <!--l. 1779--><p class="noindent" >Use <span
-class="cmtt-10">\*</span>GlsXtrLoadResources to identify the <span
-class="cmtt-10">bib</span><a
- id="dx1-10045"></a> file(s) and <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-10046"></a></a> options:
-
-
-</p>
- <pre class="verbatim" id="verbatim-23">
- \GlsXtrLoadResources[src={terms.bib,abbreviations.bib},sort=en]
-</pre>
- <!--l. 1783--><p class="nopar" >
- </p></li>
-<li
- class="enumerate" id="x1-10048x3">
- <!--l. 1785--><p class="noindent" >Put </p><div class="alltt">
- <div class="obeylines-v">
- <span
-class="cmtt-10">\*printunsrtglossary</span>
-</div>
- </div> where you want your list of entries to appear. Alternatively to display all glossaries use the iterative
- command: <div class="alltt">
- <div class="obeylines-v">
- <span
-class="cmtt-10">\*printunsrtglossaries</span>
-</div>
- </div>
- </li>
-<li
- class="enumerate" id="x1-10050x4">
- <!--l. 1795--><p class="noindent" >Run LaTeX on your document.
- </p></li>
-<li
- class="enumerate" id="x1-10052x5">
- <!--l. 1797--><p class="noindent" >Run <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-10053"></a></a> with just the document base name.
- </p></li>
-<li
- class="enumerate" id="x1-10055x6">
- <!--l. 1799--><p class="noindent" >Run LaTeX on your document.
-</p>
- </li></ol>
-
-
-<!--l. 1803--><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-10056"></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-10057r5"></a>
-</p><!--l. 1809--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-110005"></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. 1811--><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.
-</p><!--l. 1815--><p class="indent" > Example document:
-
-
-</p>
- <pre class="verbatim" id="verbatim-24">
-\documentclass{article}
-\usepackage[sort=none]{glossaries-extra}
-\newglossaryentry{sample}{name={sample},
- description={an example}}
-\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
- description={...}}
-\begin{document}
-\gls{sample}.
-</pre>
-<!--l. 1825--><p class="nopar" > </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor113"><span
-class="cmtt-10">\printunsrtglossary</span></span><a
- id="dx1-11001"></a>
-<br /><span
-class="cmtt-10">\end{document}</span>
-</div>
-</div>
-<!--l. 1831--><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-11002"></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>). In general it’s best to use a style that doesn’t show
-letter group headings. If you do want letter headings then you must ensure that you have defined
-your entries in alphabetical order, and use XeLaTeX or LuaLaTeX if you require <a
-href="#glo:UTF-8">UTF-8</a> letter
-groups.
-</p><!--l. 1839--><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-11003"></a>.
-</p><!--l. 1850--><p class="indent" > The glossary is displayed using: </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor114"><span
-class="cmtt-10">\printunsrtglossary</span></span><a
- id="dx1-11004"></a>
-</div>
-</div> Alternatively all glossaries can be displayed using the iterative command: <div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor115"><span
-class="cmtt-10">\printunsrtglossaries</span></span><a
- id="dx1-11005"></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-11006"></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-11007"></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).
-<!--l. 1867--><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. 1872--><p class="indent" > This just requires a single LaTeX call:
-</p><!--l. 1873--><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. 1878--><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. 1886--><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-11008r6"></a>
-</p><!--l. 1888--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-120006"></a><a title="anchor" style="font-size: x-small; text-decoration: none;" href="#option6">🔗</a><a
- id="option6"></a>Option 6 (standalone)</h4>
-<!--l. 1890--><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-12001f3"></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. 1900--><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-12004"></a>), as
-with <a
-href="#option5">Option 5</a>, for example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-25">
-\documentclass{article}
-\usepackage[colorlinks]{hyperref}
-\usepackage[sort=none,
-   nostyles% <- no glossary styles are required
- ]{glossaries-extra}
-\newglossaryentry{set}{name={set},
-  description={a collection of any kind of objects},
-  symbol={\ensuremath{\mathcal{S}}}
+
+<a id="wrglossary.58"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>
+ {cafe}<span class="comment">% label</span>
+ {<span class="comment">% definition:</span>
+ <a id="wrglossary.59"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={café}</span>,
+ <a id="wrglossary.60"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={small restaurant selling refreshments}</span>
+ }
+
+<a id="wrglossary.61"></a><a href="#glo:setacronymstyle"><code class="csfmt">\setacronymstyle</code></a>{<a id="wrglossary.62"></a><a href="#glo:opt.acrstyle.long-short"><span class="acrstylefmt">long-short</span></a>}
+<a id="wrglossary.63"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>
+ {html}<span class="comment">% label</span>
+ {HTML}<span class="comment">% short form</span>
+ {hypertext markup language}<span class="comment">% long form</span>
+
+<a id="wrglossary.64"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>
+ {pi}<span class="comment">% label</span>
+ {<span class="comment">% definition:</span>
+ <a id="wrglossary.65"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.66"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<code class="cmd">\pi</code>}}</span>,
+ <a id="wrglossary.67"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={Archimedes' Constant}</span>
+ }
+
+<a id="wrglossary.68"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>
+ {distance}<span class="comment">% label</span>
+ {<span class="comment">% definition:</span>
+ <a id="wrglossary.69"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={distance}</span>,
+ <a id="wrglossary.70"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={the length between two points}</span>,
+ <a id="wrglossary.71"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={m}</span>
+ }
+
+<code class="cbeg">\begin{document}</code>
+First use: <a id="wrglossary.72"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{cafe}, <a id="wrglossary.73"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{html}, <a id="wrglossary.74"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{pi}.
+Next use: <a id="wrglossary.75"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{cafe}, <a id="wrglossary.76"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{html}, <a id="wrglossary.77"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{pi}.
+
+<a id="wrglossary.78"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{distance} (<a id="wrglossary.79"></a><a href="#glo:glsentrydesc"><code class="csfmt">\glsentrydesc</code></a>{distance}) is measured in
+<a id="wrglossary.80"></a><a href="#glo:glssymbol"><code class="csfmt">\glssymbol</code></a>{distance}.
+<code class="cend">\end{document}</code>
+</pre> (This is a trivial example. For a real document I recommend you use <a id="wrglossary.81"></a><a href="#glo:pkg.siunitx"><span class="styfmt">siunitx</span></a> for units.) <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.82"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:simplenogloss"></a>Example 1: Simple document with no glossary <a href="glossaries-user-examples/glossaries-user-example001.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example001.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example001.png" type="image/png" width="388" height="42">Example document that defines some glossary entries and references them in the text..</object> </div><!-- end of resultbox -->
+<p>
+<div class="sidenote"><a id="wrglossary.83"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+The <a id="wrglossary.84"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package, which is distributed as a separate bundle, extends the capabilities of the <a id="wrglossary.85"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. The simplest document with a <a id="wrglossary.86"></a><a href="#glo:dual.glossary">glossary</a> can be created with <a id="wrglossary.87"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> (which internally loads the <a id="wrglossary.88"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package): <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.89"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[
+ <a id="wrglossary.90"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=none</span>,<span class="comment">% no sorting or indexing required</span>
+ <a id="wrglossary.91"></a><a href="#glo:opt.abbreviations"><span class="xtrstyoptfmt">abbreviations</span></a>,<span class="comment">% create list of <a id="wrglossary.92"></a><a href="#glo:idx.abbreviation"><span class="xtrfmt">abbreviations</span></a></span>
+ <a id="wrglossary.93"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a>,<span class="comment">% create list of symbols</span>
+ <a id="wrglossary.94"></a><a href="#glo:opt.postdot"><span class="xtrstyoptfmt">postdot</span></a>, <span class="comment">% append a full stop after the descriptions</span>
+ <a id="wrglossary.95"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a>,<a id="wrglossary.96"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=index</span> <span class="comment">% set the default glossary style</span>
+]{glossaries-extra}
+
+<a id="wrglossary.97"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> <span class="comment">% <a id="wrglossary.98"></a><a href="#glo:pkg.glossaries-extra">glossaries.sty</a></span> {cafe}<span class="comment">% label</span>
+ {<span class="comment">% definition:</span>
+ <a id="wrglossary.99"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={café}</span>,
+ <a id="wrglossary.100"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={small restaurant selling refreshments}</span>
+ }
+
+<a id="wrglossary.101"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>{<a id="wrglossary.102"></a><a href="#glo:opt.abbrstyle.long-short"><span class="abbrstylefmt">long-short</span></a>}<span class="comment">% <a id="wrglossary.103"></a><a href="#glo:pkg.glossaries-extra">glossaries-extra.sty</a></span>
+<a id="wrglossary.104"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a> <span class="comment">% <a id="wrglossary.105"></a><a href="#glo:pkg.glossaries-extra">glossaries-extra.sty</a></span> {html}<span class="comment">% label</span>
+ {HTML}<span class="comment">% short form</span>
+ {hypertext markup language}<span class="comment">% long form</span>
+
+<span class="comment">% requires <a id="wrglossary.106"></a><a href="#glo:pkg.glossaries-extra">glossaries-extra.sty</a> '<a id="wrglossary.107"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a>' option</span>
+<a id="wrglossary.108"></a><a href="#glo:glsxtrnewsymbol"><code class="xtrcsfmt">\glsxtrnewsymbol</code></a>
+ [<a id="wrglossary.109"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={Archimedes' constant}</span>]<span class="comment">% options</span>
+ {pi}<span class="comment">% label</span>
+ {<a id="wrglossary.110"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<code class="cmd">\pi</code>}}<span class="comment">% symbol</span>
+
+<a id="wrglossary.111"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> <span class="comment">% <a id="wrglossary.112"></a><a href="#glo:pkg.glossaries-extra">glossaries.sty</a></span> {distance}<span class="comment">% label</span>
+ {<span class="comment">% definition:</span>
+ <a id="wrglossary.113"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={distance}</span>,
+ <a id="wrglossary.114"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={the length between two points}</span>,
+ <a id="wrglossary.115"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={m}</span>
+ }
+
+<code class="cbeg">\begin{document}</code>
+First use: <a id="wrglossary.116"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{cafe}, <a id="wrglossary.117"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{html}, <a id="wrglossary.118"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{pi}.
+Next use: <a id="wrglossary.119"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{cafe}, <a id="wrglossary.120"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{html}, <a id="wrglossary.121"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{pi}.
+
+<a id="wrglossary.122"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{distance} is measured in <a id="wrglossary.123"></a><a href="#glo:glssymbol"><code class="csfmt">\glssymbol</code></a>{distance}.
+<a id="wrglossary.124"></a><a href="#glo:printunsrtglossaries"><code class="xtrcsfmt">\printunsrtglossaries</code></a> <span class="comment">% list all defined entries</span>
+<code class="cend">\end{document}</code>
+</pre><p>
+<div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.125"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:simpleunsrt"></a>Example 2: Simple document with unsorted glossaries <a href="glossaries-user-examples/glossaries-user-example002.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example002.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example002.png" type="image/png" width="388" height="265">Example document that defines some glossary entries, references them in the text, and displays three simple unsorted glossaries..</object> </div><!-- end of resultbox -->
+<p>
+Note the difference in the way the <a id="wrglossary.126"></a><a href="#glo:idx.abbreviation"><span class="xtrfmt">abbreviation</span></a> (HTML) and symbol (\(𝜋\)) are defined in the two above examples. The <a id="wrglossary.127"></a><a href="#glo:opt.abbreviations"><span class="xtrstyoptfmt">abbreviations</span></a>, <a id="wrglossary.128"></a><a href="#glo:opt.postdot"><span class="xtrstyoptfmt">postdot</span></a> and <a id="wrglossary.129"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a> options are specific to <a id="wrglossary.130"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>. Other options are passed to the base <a id="wrglossary.131"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package.<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.132"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ In this user manual, commands and options displayed in <span class="xtrfmt">tan</span>, such as <a id="wrglossary.133"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a> and <a id="wrglossary.134"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a>, are only available with the <a id="wrglossary.135"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package. There are also some commands and options (such as <a id="wrglossary.136"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> and <a id="wrglossary.137"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a>) that are provided by the base <a id="wrglossary.138"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package but are redefined by the <a id="wrglossary.139"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package. See the <a id="wrglossary.140"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> user manual for further details of those commands. </div><!-- end of information -->
+<p>
+One of the strengths of the <a id="wrglossary.141"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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>
+<div class="important"><div class="importanttitle"><a id="wrglossary.142"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+There’s a common misconception that you have to have Perl installed in order to use the <a id="wrglossary.143"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. Perl is <span style="font-style: italic; font-variant: normal; ">not</span> a requirement (as demonstrated by the above examples) but it does increase the available options, particularly if you use an <a id="wrglossary.144"></a><a href="#glo:dual.exlatinalph">extended Latin alphabet</a> or a <a id="wrglossary.145"></a><a href="#glo:dual.nonlatinalph">non-Latin alphabet</a>. </div><!-- end of important -->
+<p>
+This document uses the <a id="wrglossary.146"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package with <a id="wrglossary.147"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> (<a id="wrglossary.148"></a><a href="#glo:idx.opt.b2g">Option 4</a>). For example, when viewing the <a id="wrglossary.149"></a><a href="#glo:PDF">PDF</a> version of this document in a <a id="wrglossary.150"></a><a href="#glo:@@glslabel at hyperlink">hyperlinked-enabled</a> <a id="wrglossary.151"></a><a href="#glo:PDF">PDF</a> viewer (such as Adobe Reader or Okular) if you click on the word <span class="qt">“<a id="wrglossary.152"></a><a href="#glo:dual.indexing">indexing</a>”</span> you’ll be taken to the <a id="wrglossary.153"></a><a href="#glo:idx.glossaryentry">entry</a> in the <a href="#glossary">main glossary</a> where there’s a brief description of the term. This is the way the <a id="wrglossary.154"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> mechanism works. An <a id="wrglossary.155"></a><a href="#glo:dual.indexingapp">indexing application</a> (<a id="wrglossary.156"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> in this case) is used to generate the sorted list of terms. The <a id="wrglossary.157"></a><a href="#glo:dual.indexingapp">indexing applications</a> are <a id="wrglossary.158"></a><a href="#glo:cli">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 <a id="wrglossary.159"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> to run them.<p>
+In addition to standard <a id="wrglossary.160"></a><a href="#glo:dual.glossary">glossaries</a>, this document has <span class="qt">“standalone”</span> definitions (<a id="wrglossary.161"></a><a href="#glo:idx.opt.standalone">Option 6</a>). For example, if you click on the command <a id="wrglossary.162"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>, the <a id="wrglossary.163"></a><a href="#glo:idx.hyperlink">hyperlink</a> will take you to main part of the document where the command is described. The <a href="#index">index</a> and <a href="#summaries">summaries</a> are also glossaries. The technique used is too complicated to describe in this manual, but an example can be found in <a href="https://tug.org/TUGboat/tb2022-1/tb133talbot-bib2gls-reorder.pdf"><span class="qt">“<span class="appfmt">bib2gls</span>: Standalone entries and repeated lists (a little book of poisons)”</span> <span style="font-style: italic; font-variant: normal; ">TUGboat</span>, Volume 43 (2022), No. 1</a>.<p>
+Neither of the above two examples require an <a id="wrglossary.164"></a><a href="#glo:dual.indexingapp">indexing application</a>. The first is just using the <a id="wrglossary.165"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package for consistent formatting, and there is no list. The second has lists but they are unsorted (see <a id="wrglossary.166"></a><a href="#glo:idx.opt.unsrt">Option 5</a>).<p>
+The remainder of this introductory section covers the following:
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span>§<a href="#sec:indexingoptions">1.3</a> lists the available indexing options.<p>
+<li><span class="bulletitem">•</span>§<a href="#sec:lipsum">1.4</a> lists the files provided that contain dummy glossary entries which may be used for testing.<p>
+<li><span class="bulletitem">•</span>§<a href="#sec:languages">1.5</a> provides information for users who wish to write in a language other than English.<p>
+<li><span class="bulletitem">•</span>§<a href="#sec:makeglossaries">1.6</a> describes how to use an <a id="wrglossary.167"></a><a href="#glo:indexingapp">indexing application</a> to create the sorted glossaries for your document (Options <a href="#glo:idx.opt.mkidx">2</a> or <a href="#glo:idx.opt.xdy">3</a>).<p>
+
+</ul>
+<p>
+In addition to the examples provided in this document, there are some sample documents provided with the <a id="wrglossary.168"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. They are described in §<a href="#sec:samples">18</a>.<p>
+The <a id="wrglossary.169"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package comes with a number of sample documents that illustrate the various functions. These are listed in §<a href="#sec:samples">18</a>.<p>
+
+</section><!-- end of section sec:intro -->
+
+<section id="sec:rollback"><!-- start of section sec:rollback --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.1. Rollback<div class="labellink"><a href="#sec:rollback">[link]</a></div></h2><!-- end of section header -->
+<p>
+The following rollback releases are available: <p>
+
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span>Version 4.49 (2021-11-01): <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.170"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>{glossaries}[=v4.49]
+</pre> Note that this should also rollback <a id="wrglossary.171"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> to version 2.07 if you have a later version installed.<p>
+<li><span class="bulletitem">•</span>Version 4.46 (2020-03-19): <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.172"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>{glossaries}[=v4.46]
+</pre><p>
+
+</ul>
+<p>
+If you rollback using <a id="wrglossary.173"></a><a href="#glo:pkg.latexrelease"><span class="styfmt">latexrelease</span></a> to an earlier date, then you will need to specify v4.46 for <a id="wrglossary.174"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> as there are no earlier rollback versions available. You may want to consider using one of the historic TeX Live Docker images instead. See, for example, <a href="https://www.dickimaw-books.com/blog/legacy-documents-and-tex-live-docker-images">Legacy Documents and TeX Live Docker Images</a>.<p>
+
+</section><!-- end of section sec:rollback -->
+
+<section id="sec:pkgintegration"><!-- start of section sec:pkgintegration --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.2. Integrating Other Packages and Known Issues<div class="labellink"><a href="#sec:pkgintegration">[link]</a></div></h2><!-- end of section header -->
+<p>
+If you use <a id="wrglossary.175"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> and <a id="wrglossary.176"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>, you must load <a id="wrglossary.177"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> <span style="font-style: italic; font-variant: normal; ">first</span> (although, in general, <a id="wrglossary.178"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> should be loaded after other packages).<p>
+Occasionally you may find that certain packages need to be loaded <span style="font-style: italic; font-variant: normal; ">after</span> packages that are required by <a id="wrglossary.179"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> but need to also be loaded before <a id="wrglossary.180"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>. For example, a package <span class="meta">〈<em class="metainner">X</em>〉</span> might need to be loaded after <a id="wrglossary.181"></a><a href="#glo:pkg.amsgen"><span class="styfmt">amsgen</span></a> but before <a id="wrglossary.182"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> (which needs to be loaded before <a id="wrglossary.183"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>). In which case, load the required package first (for example, <a id="wrglossary.184"></a><a href="#glo:pkg.amsgen"><span class="styfmt">amsgen</span></a>), then <span class="meta">〈<em class="metainner">X</em>〉</span>, and finally load <a id="wrglossary.185"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>. <pre class="compactcodebox"><code class="cmd">\usepackage</code>{amsgen}<span class="comment">% load before <span class="meta">〈<em class="metainner">X</em>〉</span></span>
+<code class="cmd">\usepackage</code>{<span class="meta">〈<em class="metainner">X</em>〉</span>}<span class="comment">% must be loaded after <a id="wrglossary.186"></a><a href="#glo:pkg.amsgen"><span class="styfmt">amsgen</span></a></span>
+<code class="cmd">\usepackage</code>{hyperref}<span class="comment">% load after <span class="meta">〈<em class="metainner">X</em>〉</span></span>
+<code class="cmd">\usepackage</code>{glossaries}<span class="comment">% load after <a id="wrglossary.187"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a></span>
+</pre><p>
+Some packages don’t work with some <a id="wrglossary.188"></a><a href="#glo:idx.glossarystyle">glossary styles</a>. For example, <a id="wrglossary.189"></a><a href="#glo:pkg.classicthesis"><span class="styfmt">classicthesis</span></a> doesn’t work with the styles that use the <a id="wrglossary.190"></a><a href="#glo:env.description"><span class="envfmt">description</span></a> environment, such as the <a id="wrglossary.191"></a><a href="#glo:opt.glostyle.list"><span class="glostylefmt">list</span></a> style. Since this is the default style, the <a id="wrglossary.192"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package checks for <a id="wrglossary.193"></a><a href="#glo:pkg.classicthesis"><span class="styfmt">classicthesis</span></a> and will change the default to the <a id="wrglossary.194"></a><a href="#glo:opt.glostyle.index"><span class="glostylefmt">index</span></a> style if it has been loaded.<p>
+Some packages conflict with a package that’s required by a <a id="wrglossary.195"></a><a href="#glo:idx.glossarystyle">glossary style</a> style package. For example, <a id="wrglossary.196"></a><a href="#glo:pkg.xtab"><span class="styfmt">xtab</span></a> conflicts with <a id="wrglossary.197"></a><a href="#glo:pkg.supertabular"><span class="styfmt">supertabular</span></a>, which is required by <a id="wrglossary.198"></a><a href="#glo:pkg.glossary-super"><span class="styfmt">glossary-super</span></a>. In this case, ensure the problematic <a id="wrglossary.199"></a><a href="#glo:idx.glossarystyle">glossary style</a> package isn’t loaded. For example, use the <a id="wrglossary.200"></a><a href="#glo:opt.nosuper"><span class="styoptfmt">nosuper</span></a> option and (with <a id="wrglossary.201"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>) don’t use <a id="wrglossary.202"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a><span class="optfmt">=super</span> or <a id="wrglossary.203"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a><span class="optfmt">=all</span>. The <a id="wrglossary.204"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package now (v4.50+) checks for <a id="wrglossary.205"></a><a href="#glo:pkg.xtab"><span class="styfmt">xtab</span></a> and will automatically implement <a id="wrglossary.206"></a><a href="#glo:opt.nosuper"><span class="styoptfmt">nosuper</span></a> if it has been loaded.<p>
+The language-support is implemented using <a id="wrglossary.207"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a>. This needs to know the document languages that have to be supported. It currently (version 1.6 at the time of writing) can’t detect the use of <a id="wrglossary.208"></a><a href="#glo:babelprovide"><code class="csfmt">\babelprovide</code></a>. The <a id="wrglossary.209"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> package is able to pick up known language labels from the document class options, for example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.210"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[german]{article}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.211"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=true</span>]{glossaries}
+</pre> The above doesn’t load <a id="wrglossary.212"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.213"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a> or <a id="wrglossary.214"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a>, but the <a id="wrglossary.215"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=true</span> setting will ensure that <a id="wrglossary.216"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> is loaded and the language-sensitive command provided by <a id="wrglossary.217"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> will use the definitions in <a id="wrglossary.218"></a><a href="#glo:file.glossaries-german.ldf"><span class="filefmt">glossaries-german.ldf</span></a> (which needs to be installed separately, see §<a href="#sec:languages">1.5</a>) because <a id="wrglossary.219"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> can pick up the <span class="optfmt">german</span> document class option.<p>
+The <a id="wrglossary.220"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> package is also able to pick up languages passed as package options to <a id="wrglossary.221"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.222"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a>, provided they were loaded before <a id="wrglossary.223"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a>. For example, <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.224"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[french]{babel}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.225"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>]{glossaries}
+</pre> The <a id="wrglossary.226"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> package used to be able to detect languages identified by <a id="wrglossary.227"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span>’s</a> <a id="wrglossary.228"></a><a href="#glo:setmainlanguage"><code class="csfmt">\setmainlanguage</code></a> and <a id="wrglossary.229"></a><a href="#glo:setotherlanguage"><code class="csfmt">\setotherlanguage</code></a>, but <a id="wrglossary.230"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> v1.5 can’t with newer versions of <a id="wrglossary.231"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a>. You will need to upgrade to <a id="wrglossary.232"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> v1.6+ to allow this to work again.<p>
+In the event that <a id="wrglossary.233"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> can’t pick up the required languages, it’s also possible to identify them with the <a id="wrglossary.234"></a><a href="#glo:opt.languages"><span class="styoptfmt">languages</span></a> option. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.235"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[nil]{babel}
+<a id="wrglossary.236"></a><a href="#glo:babelprovide"><code class="csfmt">\babelprovide</code></a>{french}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.237"></a><a href="#glo:opt.languages"><span class="styoptfmt">languages</span></a><span class="optfmt">=french</span>]{glossaries}
+</pre><p>
+
+</section><!-- end of section sec:pkgintegration -->
+
+<section id="sec:indexingoptions"><!-- start of section sec:indexingoptions --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.3. Indexing Options<div class="labellink"><a href="#sec:indexingoptions">[link]</a></div></h2><!-- end of section header -->
+<p>
+<a id="wrglossary.238"></a>The basic idea behind the <a id="wrglossary.239"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package is that you first define your <a id="wrglossary.240"></a><a href="#glo:idx.glossaryentry">entries</a> (terms, symbols or <a id="wrglossary.241"></a><a href="#glo:idx.acronym">acronyms</a>). Then you can reference these within your document (analogous to <a id="wrglossary.242"></a><a href="#glo:cite"><code class="csfmt">\cite</code></a> or <a id="wrglossary.243"></a><a href="#glo:ref"><code class="csfmt">\ref</code></a>). You can also, optionally, display a list of the <a id="wrglossary.244"></a><a href="#glo:idx.glossaryentry">entries</a> you have referenced in your document (the <a id="wrglossary.245"></a><a href="#glo:dual.glossary">glossary</a>). This last part, displaying the <a id="wrglossary.246"></a><a href="#glo:dual.glossary">glossary</a>, is the part that most new users find difficult. There are three options available with the base <a id="wrglossary.247"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package (Options <a id="wrglossary.248"></a><a href="#glo:idx.opt.noidx">1</a>–<a id="wrglossary.249"></a><a href="#glo:idx.opt.xdy">3</a>). The <a id="wrglossary.250"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package provides two extra options for lists (Options <a href="#glo:idx.opt.b2g">4</a> and <a href="#glo:idx.opt.unsrt">5</a>) as well as an option for standalone descriptions within the document body (<a id="wrglossary.251"></a><a href="#glo:idx.opt.standalone">Option 6</a>).<p>
+An overview of Options <a id="wrglossary.252"></a><a href="#glo:idx.opt.noidx">1</a>–<a id="wrglossary.253"></a><a href="#glo:idx.opt.unsrt">5</a> is given in Table <a href="#tab:options">1.1</a>. <a id="wrglossary.254"></a><a href="#glo:idx.opt.standalone">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="styfmt">glossaries</span> performance page</a>. If, for some reason, you want to know what <a id="wrglossary.255"></a><a href="#glo:dual.indexing">indexing</a> option is in effect, you can test the value of: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.256"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.257"></a><code class="code"><dfn id="glo:glsindexingsetting"><code class="csfmt">\glsindexingsetting</code></dfn></code></div><!-- end of pinnedbox -->
+ This is initialised to: <pre class="compactcodebox"><a id="wrglossary.258"></a><a href="#glo:ifglsxindy"><code class="csfmt">\ifglsxindy</code></a> xindy<code class="cmd">\else</code> makeindex<code class="cmd">\fi</code>
+</pre> If the <a id="wrglossary.259"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.260"></a><a href="#glo:optval.sort.none"><span class="optfmt">none</span></a> or <a id="wrglossary.261"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.262"></a><a href="#glo:optval.sort.clear"><span class="optfmt">clear</span></a> options are used, <a id="wrglossary.263"></a><a href="#glo:glsindexingsetting"><code class="csfmt">\glsindexingsetting</code></a> will be redefined to <code class="code">none</code>. If <a id="wrglossary.264"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> is used <a id="wrglossary.265"></a><a href="#glo:glsindexingsetting"><code class="csfmt">\glsindexingsetting</code></a> will be updated to either <code class="code">makeindex</code> or <code class="code">xindy</code> as appropriate (that is, the conditional will no longer be part of the definition). If <a id="wrglossary.266"></a><a href="#glo:makenoidxglossaries"><code class="csfmt">\makenoidxglossaries</code></a> is used then <a id="wrglossary.267"></a><a href="#glo:glsindexingsetting"><code class="csfmt">\glsindexingsetting</code></a> will be updated to <code class="code">noidx</code>. This means that <a id="wrglossary.268"></a><a href="#glo:glsindexingsetting"><code class="csfmt">\glsindexingsetting</code></a> can’t be fully relied on until the start of the <a id="wrglossary.269"></a><a href="#glo:env.document"><span class="envfmt">document</span></a> environment. (If you are using <a id="wrglossary.270"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.49+, then this command will also be updated to take the <a id="wrglossary.271"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a> setting into account.)<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.272"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+If you are developing a class or package that loads <a id="wrglossary.273"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>, I recommend that you don’t force the user into a particular <a id="wrglossary.274"></a><a href="#glo:dual.indexing">indexing</a> method by adding an unconditional <a id="wrglossary.275"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> 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 <a id="wrglossary.276"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> (such as <a id="wrglossary.277"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>) and they can’t switch off the indexing whilst working on a draft document. (If you are using a class or package that has done this, pass the <a id="wrglossary.278"></a><a href="#glo:opt.disablemakegloss"><span class="styoptfmt">disablemakegloss</span></a> option to <a id="wrglossary.279"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a>. For example, via the document class options.) </div><!-- end of important -->
+<p>
+Strictly speaking, Options <a href="#glo:idx.opt.unsrt">5</a> and <a href="#glo:idx.opt.standalone">6</a> aren’t actually <a id="wrglossary.280"></a><a href="#glo:dual.indexing">indexing</a> options as no <a id="wrglossary.281"></a><a href="#glo:dual.indexing">indexing</a> is performed. In the case of <a id="wrglossary.282"></a><a href="#glo:idx.opt.unsrt">Option 5</a>, all defined entries are listed in order of definition. In the case of <a id="wrglossary.283"></a><a href="#glo:idx.opt.standalone">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 <a id="wrglossary.284"></a><a href="#glo:dual.indexing">indexing</a> options.<p>
+<div class="table"> <div id="tab:options" class="caption">Table 1: Glossary Options: Pros and Cons</div><table class="tabular-c">
+<tr style=""><th style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Option </span></th>
+<td class="cell-noborder-bothsep-c"> <span style="font-weight: bold; "><a href="#glo:idx.opt.noidx">1</a> </span></td>
+<td class="cell-noborder-bothsep-c"> <span style="font-weight: bold; "><a href="#glo:idx.opt.mkidx">2</a> </span></td>
+<td class="cell-noborder-bothsep-c"> <span style="font-weight: bold; "><a href="#glo:idx.opt.xdy">3</a> </span></td>
+<td class="cell-noborder-bothsep-c"> <span style="font-weight: bold; "><a href="#glo:idx.opt.b2g">4</a> </span></td>
+<td class="cell-noborder-rightsep-c"> <span style="font-weight: bold; "><a href="#glo:idx.opt.unsrt">5</a> </span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Requires <a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Requires an external application? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Requires Perl? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Requires Java? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Can sort <a href="#glo:exlatinalph">extended Latin alphabets</a> or <a href="#glo:nonlatinalph">non-Latin alphabets</a>? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span><sup><span title="asterisk marker" class="icon">∗</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> N/A</td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Efficient sort algorithm? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> N/A</td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Can use a different sort method for each glossary? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span><sup><span title="dagger marker" class="icon">†</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span><sup><span title="dagger marker" class="icon">†</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> N/A</td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Any problematic sort values? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span><sup><span title="double dagger marker" class="icon">‡</span></sup></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Are entries with identical sort values treated as separate unique entries? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span><sup><span title="section marker" class="icon">§</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Can automatically form <a href="#glo:idx.range">ranges</a> in the <a href="#glo:dual.locationlist">location lists</a>? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Can have non-standard <a href="#glo:@@glslabel at entrylocation">locations</a> in the <a href="#glo:dual.locationlist">location lists</a>? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span><sup><span title="lozenge marker" class="icon">⧫</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span><sup><span title="pilcrow marker" class="icon">¶</span></sup></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Maximum hierarchical depth (style-dependent) </span></td>
+<td class="cell-noborder-bothsep-c"> <span title="unlimited" class="icon">∞</span><sup><span title="hash marker" class="icon">#</span></sup> </td>
+<td class="cell-noborder-bothsep-c"> 3 </td>
+<td class="cell-noborder-bothsep-c"> <span title="unlimited" class="icon">∞</span></td>
+<td class="cell-noborder-bothsep-c"> <span title="unlimited" class="icon">∞</span></td>
+<td class="cell-noborder-rightsep-c"> <span title="unlimited" class="icon">∞</span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; "><a href="#glo:glsdisplaynumberlist"><code class="csfmt">\glsdisplaynumberlist</code></a> reliable? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="disadvantage"><span title="no" class="icon">✖</span></span></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; "><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> allowed in <a href="#glo:env.document"><span class="envfmt">document</span></a> environment? (Not recommended.) </span></td>
+<td class="cell-noborder-bothsep-c"> <span title="no" class="icon">✖</span></td>
+<td class="cell-noborder-bothsep-c"> <span title="yes" class="icon">✔</span></td>
+<td class="cell-noborder-bothsep-c"> <span title="yes" class="icon">✔</span></td>
+<td class="cell-noborder-bothsep-c"> <span title="no" class="icon">✖</span><sup><span title="reference marker" class="icon">※</span></sup> </td>
+<td class="cell-noborder-rightsep-c"> <span title="yes" class="icon">✔</span><sup><span title="vertical double asterisk marker" class="icon">⁑</span></sup></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Requires additional write registers? </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="disadvantage"><span title="yes" class="icon">✔</span></span></td>
+<td class="cell-noborder-bothsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span></td>
+<td class="cell-noborder-rightsep-c"> <span class="advantage"><span title="no" class="icon">✖</span></span><sup><span title="star marker" class="icon">★</span></sup></td>
+</tr><tr style=""><td style="border-top: none; border-right: none; border-left: none; padding-left: 0px; width: 3500.000000%; padding-right: 6.000000pt; text-align: left; "><span style="font-size: small; ">Default value of <a href="#glo:opt.sanitizesort"><span class="styoptfmt">sanitizesort</span></a> package option </span></td>
+<td class="cell-noborder-bothsep-c"> <span class="optfmt">false</span> </td>
+<td class="cell-noborder-bothsep-c"> <span class="optfmt">true</span> </td>
+<td class="cell-noborder-bothsep-c"> <span class="optfmt">true</span> </td>
+<td class="cell-noborder-bothsep-c"> <span class="optfmt">true</span><sup><span title="florette marker" class="icon">✾</span></sup> </td>
+<td class="cell-noborder-rightsep-c"> <span class="optfmt">true</span><sup><span title="florette marker" class="icon">✾</span></sup> </td>
+</tr></table>
+ <p>
+<div class="tablefns"><div class="tablefn"><sup><span title="asterisk marker" class="icon">∗</span></sup>Strips standard LaTeX accents (that is, accents generated by core LaTeX commands) so, for example, <code class="csfmt">\AA</code> is treated the same as A.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="dagger marker" class="icon">†</span></sup>Only with the hybrid method provided with <a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="double dagger marker" class="icon">‡</span></sup>Provided <a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a href="#glo:optval.sort.none"><span class="optfmt">none</span></a> is used.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="section marker" class="icon">§</span></sup>Entries with the same sort value are merged.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="lozenge marker" class="icon">⧫</span></sup>Requires some setting up.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="pilcrow marker" class="icon">¶</span></sup>The locations must be set explicitly through the custom <a href="#glo:opt.gloskey.location"><span class="xtrcsoptfmt">location</span></a> field provided by <a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="hash marker" class="icon">#</span></sup>Unlimited but unreliable.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="reference marker" class="icon">※</span></sup>Entries are defined in <a href="#glo:ext.bib"><span class="extfmt">bib</span></a> format. <a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> should not be used explicitly.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="vertical double asterisk marker" class="icon">⁑</span></sup>Provided <a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=true</span> or <a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=restricted</span> but not recommended.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="star marker" class="icon">★</span></sup>Provided <a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=false</span> or <a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=restricted</span>.</div><!-- end of tablefn -->
+ <div class="tablefn"><sup><span title="florette marker" class="icon">✾</span></sup>Irrelevant with <a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a href="#glo:optval.sort.none"><span class="optfmt">none</span></a>. (The <a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=only</span> option automatically switches this on.)</div><!-- end of tablefn -->
+ </div><!-- end of tablefns -->
+ </div><p>
+
+</section><!-- end of section sec:indexingoptions -->
+
+<section id="option1"><!-- start of section option1 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.1. <a id="wrglossary.285"></a><dfn id="glo:idx.opt.noidx">Option 1 (<span class="qt">“noidx”</span>)</dfn><div class="labellink"><a href="#option1">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+This option isn’t generally recommended for reasons given below. It’s best used with <a id="wrglossary.286"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.287"></a><a href="#glo:optval.sort.use"><span class="optfmt">use</span></a> (order of use) or <a id="wrglossary.288"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.289"></a><a href="#glo:optval.sort.def"><span class="optfmt">def</span></a> (order of definition). Example Document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.290"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.291"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.292"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a></span>]{glossaries}
+<strong class="strong"><a id="wrglossary.293"></a><a href="#glo:makenoidxglossaries"><code class="csfmt">\makenoidxglossaries</code></a></strong> <span class="comment">% use TeX to sort</span>
+<a id="wrglossary.294"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{parrot}{<a id="wrglossary.295"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={parrot}</span>,
+ <a id="wrglossary.296"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a brightly coloured tropical bird}</span>}
+<a id="wrglossary.297"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{duck}{<a id="wrglossary.298"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={duck}</span>,
+ <a id="wrglossary.299"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a waterbird}</span>}
+<a id="wrglossary.300"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{puffin}{<a id="wrglossary.301"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={puffin}</span>,
+ <a id="wrglossary.302"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a seabird with a brightly coloured bill}</span>}
+<a id="wrglossary.303"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{penguin}{<a id="wrglossary.304"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={penguin}</span>,
+ <a id="wrglossary.305"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a flightless black and white seabird}</span>}
+<span class="comment">% a symbol:</span>
+<a id="wrglossary.306"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.307"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.308"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.309"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <strong class="strong"><a id="wrglossary.310"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span></strong>,<a id="wrglossary.311"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>}
+<span class="comment">% an <a id="wrglossary.312"></a><a href="#glo:idx.acronym">acronym</a>:</span>
+<a id="wrglossary.313"></a><a href="#glo:setacronymstyle"><code class="csfmt">\setacronymstyle</code></a>{<a id="wrglossary.314"></a><a href="#glo:opt.acrstyle.short-long"><span class="acrstylefmt">short-long</span></a>}
+<a id="wrglossary.315"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.316"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{puffin}, <a id="wrglossary.317"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{duck} and <a id="wrglossary.318"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{parrot}.
+<a id="wrglossary.319"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet} and <a id="wrglossary.320"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{alpha}.
+Next use: <a id="wrglossary.321"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet}.
+<strong class="strong"><a id="wrglossary.322"></a><a href="#glo:printnoidxglossary"><code class="csfmt">\printnoidxglossary</code></a></strong>
+<code class="cend">\end{document}</code>
+</pre> You can place all your entry definitions in a separate file and load it in the <a id="wrglossary.323"></a><a href="#glo:idx.documentpreamble">document preamble</a> with <a id="wrglossary.324"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a> (<span style="font-style: italic; font-variant: normal; ">after</span> <a id="wrglossary.325"></a><a href="#glo:makenoidxglossaries"><code class="csfmt">\makenoidxglossaries</code></a>). Note that six entries have been defined but only five are referenced (<a id="wrglossary.326"></a><a href="#glo:@@glslabel at indexing">indexed</a>) in the document so only those five appear in the <a id="wrglossary.327"></a><a href="#glo:dual.glossary">glossary</a>. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.328"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:noidx"></a>Example 3: Simple document that uses TeX to sort entries <a href="glossaries-user-examples/glossaries-user-example003.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example003.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example003.png" type="image/png" width="391" height="244">Example document that defines some entries, references a subset of them in the document and displays a sorted list of the referenced entries: alpha, ARPANET, duck, parrot and puffin. There are three letter groups, headed A, D and P.</object> </div><!-- end of resultbox -->
+ This uses the <a id="wrglossary.329"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a> style, which puts a heading at the start of each <a id="wrglossary.330"></a><a href="#glo:idx.group">letter group</a>. The <a id="wrglossary.331"></a><a href="#glo:idx.group">letter group</a> is determined by the first character of the sort value. For a preview of all available styles, see <a href="https://www.dickimaw-books.com/gallery/index.php?label=glossaries-styles">Gallery: Predefined Styles</a>. The number 1 after each description is the <a id="wrglossary.332"></a><a href="#glo:locationlist">number list</a> (or <a id="wrglossary.333"></a><a href="#glo:dual.locationlist">location list</a>). This is the list of <a id="wrglossary.334"></a><a href="#glo:@@glslabel at entrylocation">locations</a> (page numbers, in this case) where the entry was <a id="wrglossary.335"></a><a href="#glo:@@glslabel at indexing">indexed</a>. In this example, all entries were <a id="wrglossary.336"></a><a href="#glo:@@glslabel at indexing">indexed</a> on page 1.<p>
+This option doesn’t require an external <a id="wrglossary.337"></a><a href="#glo:dual.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 id="wrglossary.338"></a><a href="#glo:dual.exlatinalph">extended Latin alphabets</a> or <a id="wrglossary.339"></a><a href="#glo:dual.nonlatinalph">non-Latin alphabets</a>. However, if you use the <a id="wrglossary.340"></a><a href="#glo:opt.sanitizesort"><span class="styoptfmt">sanitizesort</span></a><span class="optfmt">=false</span> package option (the default for <a id="wrglossary.341"></a><a href="#glo:idx.opt.noidx">Option 1</a>) then the <a id="wrglossary.342"></a><a href="#glo:@@glslabel at latexexlatinchar">standard LaTeX accent commands</a> will be ignored, so if an entry’s name is set to <code class="code"><a id="wrglossary.343"></a><a href="#glo:cs.apos"><code class="csfmt">\'</code></a>elite</code> then the sort value will default to <code class="code">elite</code> if <a id="wrglossary.344"></a><a href="#glo:opt.sanitizesort"><span class="styoptfmt">sanitizesort</span></a><span class="optfmt">=false</span> is used and will default to the literal string \’elite if <a id="wrglossary.345"></a><a href="#glo:opt.sanitizesort"><span class="styoptfmt">sanitizesort</span></a><span class="optfmt">=true</span> is used. <p>
+<div class="warning"><div class="warningtitle"><a id="wrglossary.346"></a><a href="#glo:sym.warning"><span title="Warning" class="icon">⚠</span></a></div><!-- end of warningtitle -->
+Previously, it was also possible to strip accents from <a id="wrglossary.347"></a><a href="#glo:dual.utf8">UTF-8</a> characters, but that’s not possible following updates to the LaTeX kernel. The kernel updates are beneficial as they make it possible to use <a id="wrglossary.348"></a><a href="#glo:dual.utf8">UTF-8</a> characters in labels, but the trick of stripping accents was a hack that no longer works. </div><!-- end of warning -->
+<p>
+If you have any other kinds of commands that don’t expand to <a id="wrglossary.349"></a><a href="#glo:dual.ascii">ASCII</a> characters, such as <a id="wrglossary.350"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>, then you must use <a id="wrglossary.351"></a><a href="#glo:opt.sanitizesort"><span class="styoptfmt">sanitizesort</span></a><span class="optfmt">=true</span> or change the sort method (<a id="wrglossary.352"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.353"></a><a href="#glo:optval.sort.use"><span class="optfmt">use</span></a> or <a id="wrglossary.354"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.355"></a><a href="#glo:optval.sort.def"><span class="optfmt">def</span></a>) in the package options or explicitly set the <a id="wrglossary.356"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key when you define the relevant entries, as shown in the above example which has: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.357"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.358"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.359"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.360"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.361"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <strong class="strong"><a id="wrglossary.362"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span>,</strong><a id="wrglossary.363"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>
}
-\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)}}
+</pre><p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.364"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.365"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package has a modified <a id="wrglossary.366"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a> package option that provides <a id="wrglossary.367"></a><a href="#glo:glsxtrnewsymbol"><code class="xtrcsfmt">\glsxtrnewsymbol</code></a>, which automatically sets the <a id="wrglossary.368"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key to the entry label (instead of the <a id="wrglossary.369"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a>). </div><!-- end of information -->
+<p>
+This option works best with the <a id="wrglossary.370"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.371"></a><a href="#glo:optval.sort.def"><span class="optfmt">def</span></a> or <a id="wrglossary.372"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=</span><a id="wrglossary.373"></a><a href="#glo:optval.sort.use"><span class="optfmt">use</span></a> setting. For any other setting, be prepared for a long document build time, especially if you have a lot of entries defined. <strong class="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 <a id="wrglossary.374"></a><a href="#glo:hierarchicallevel">hierarchical</a> glossaries and does not form <a id="wrglossary.375"></a><a href="#glo:idx.range">ranges</a> in the <a id="wrglossary.376"></a><a href="#glo:dual.locationlist">location lists</a>. If you really can’t use an <a id="wrglossary.377"></a><a href="#glo:dual.indexingapp">indexing application</a> consider using <a id="wrglossary.378"></a><a href="#glo:idx.opt.unsrt">Option 5</a> instead.<p>
+Summary:
+<ol class="displaylist">
+ <li><span class="numitem">1.</span>Add <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.379"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.380"></a><a href="#glo:makenoidxglossaries"><code class="csfmt">\makenoidxglossaries</code></a>
+</pre> to your <a id="wrglossary.381"></a><a href="#glo:idx.documentpreamble">preamble</a> (before you start defining your entries, as described in §<a href="#sec:newglosentry">4</a>).<p>
+<li><span class="numitem">2.</span>Put <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.382"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.383"></a><a href="#glo:printnoidxglossary"><code class="csfmt">\printnoidxglossary</code></a>
+</pre> where you want your list of entries to appear (described in §<a href="#sec:printglossary">8</a>). Alternatively, to display all glossaries use the iterative command: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.384"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.385"></a><a href="#glo:printnoidxglossaries"><code class="csfmt">\printnoidxglossaries</code></a>
+</pre><p>
+<li><span class="numitem">3.</span>Run LaTeX twice on your document. (As you would do to make a table of contents appear.) For example, click twice on the <span class="qt">“typeset”</span> or <span class="qt">“build”</span> or <span class="qt">“pdfLaTeX”</span> button in your editor.
+</ol>
+<p>
+
+</section><!-- end of section option1 -->
+
+<section id="option2"><!-- start of section option2 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.2. <a id="wrglossary.386"></a><dfn id="glo:idx.opt.mkidx">Option 2 (<span class="appfmt">makeindex</span>)</dfn><div class="labellink"><a href="#option2">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<a id="wrglossary.387"></a>Example document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.388"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.389"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.390"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a></span>]{glossaries}
+<strong class="strong"><a id="wrglossary.391"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a></strong> <span class="comment">% open <a id="wrglossary.392"></a><a href="#glo:dual.indexingfile">indexing files</a></span>
+<a id="wrglossary.393"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{parrot}{<a id="wrglossary.394"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={parrot}</span>,
+ <a id="wrglossary.395"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a brightly coloured tropical bird}</span>}
+<a id="wrglossary.396"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{duck}{<a id="wrglossary.397"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={duck}</span>,
+ <a id="wrglossary.398"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a waterbird}</span>}
+<a id="wrglossary.399"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{puffin}{<a id="wrglossary.400"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={puffin}</span>,
+ <a id="wrglossary.401"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a seabird with a brightly coloured bill}</span>}
+<a id="wrglossary.402"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{penguin}{<a id="wrglossary.403"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={penguin}</span>,
+ <a id="wrglossary.404"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a flightless black and white seabird}</span>}
+<span class="comment">% a symbol:</span>
+<a id="wrglossary.405"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.406"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.407"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.408"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <strong class="strong"><a id="wrglossary.409"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span></strong>,<a id="wrglossary.410"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>}
+<span class="comment">% an <a id="wrglossary.411"></a><a href="#glo:idx.acronym">acronym</a>:</span>
+<a id="wrglossary.412"></a><a href="#glo:setacronymstyle"><code class="csfmt">\setacronymstyle</code></a>{<a id="wrglossary.413"></a><a href="#glo:opt.acrstyle.short-long"><span class="acrstylefmt">short-long</span></a>}
+<a id="wrglossary.414"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.415"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{puffin}, <a id="wrglossary.416"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{duck} and <a id="wrglossary.417"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{parrot}.
+<a id="wrglossary.418"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet} and <a id="wrglossary.419"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{alpha}.
+Next use: <a id="wrglossary.420"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet}.
+<strong class="strong"><a id="wrglossary.421"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a></strong>
+<code class="cend">\end{document}</code>
+</pre> You can place all your entry definitions in a separate file and load it in the <a id="wrglossary.422"></a><a href="#glo:idx.documentpreamble">preamble</a> with <a id="wrglossary.423"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a> (<span style="font-style: italic; font-variant: normal; ">after</span> <a id="wrglossary.424"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>). The result is the same as for Example <a href="#ex:noidx">3</a>. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.425"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:mkidx"></a>Example 4: Simple document that uses <span class="appfmt">makeindex</span> to sort entries <a href="glossaries-user-examples/glossaries-user-example004.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example004.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example004.png" type="image/png" width="391" height="244">Example document that defines some entries, references a subset of them in the document and displays a sorted list of the referenced entries: alpha, ARPANET, duck, parrot and puffin. There are three letter groups, headed A, D and P.</object> </div><!-- end of resultbox -->
+<p>
+This option uses a <a id="wrglossary.426"></a><a href="#glo:dual.cli">CLI</a> application called <a id="wrglossary.427"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> to sort the entries. This application comes with all modern TeX distributions, but it’s hard-coded for the non-extended <a id="wrglossary.428"></a><a href="#glo:dual.latinalph">Latin alphabet</a>. It can’t correctly sort accent commands (such as <a id="wrglossary.429"></a><a href="#glo:cs.apos"><code class="csfmt">\'</code></a> or <a id="wrglossary.430"></a><a href="#glo:c"><code class="csfmt">\c</code></a>) and fails with <a id="wrglossary.431"></a><a href="#glo:dual.utf8">UTF-8</a> characters, especially for any sort values that start with a <a id="wrglossary.432"></a><a href="#glo:dual.utf8">UTF-8</a> character (as it separates the octets resulting in an invalid file <a id="wrglossary.433"></a><a href="#glo:idx.encoding">encoding</a>). This process involves making LaTeX write the <a id="wrglossary.434"></a><a href="#glo:dual.glossary">glossary</a> information to a temporary file which <a id="wrglossary.435"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> reads. Then <a id="wrglossary.436"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> writes a new file containing the code to typeset the <a id="wrglossary.437"></a><a href="#glo:dual.glossary">glossary</a>. Then <a id="wrglossary.438"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a> reads this file in on the next run.<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.439"></a><a href="#glo:sym.information"><span title="Information" class="icon">🛈</span></a></div><!-- end of informationtitle -->
+There are other applications that can read <a id="wrglossary.440"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> files, such as <a id="wrglossary.441"></a><a href="#glo:app.texindy"><span class="appfmt">texindy</span></a> and <a id="wrglossary.442"></a><a href="#glo:app.xindex"><span class="appfmt">xindex</span></a>, but the <a id="wrglossary.443"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package uses a customized <a id="wrglossary.444"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a> style file (created by <a id="wrglossary.445"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>) that adjusts the special characters and input keyword and also ensures that the resulting file (which is input by <a id="wrglossary.446"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a>) adheres to the <a id="wrglossary.447"></a><a href="#glo:dual.glossary">glossary</a> style. If you want to use an alternative, you will need to ensure that it can honour the settings in the <a id="wrglossary.448"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a> file. </div><!-- end of information -->
+<p>
+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 <a id="wrglossary.449"></a><a href="#glo:dual.shellescape">shell escape</a> since <a id="wrglossary.450"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> is considered a trusted application, which means you should be able to use the <a id="wrglossary.451"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a><span class="optfmt">=</span><a id="wrglossary.452"></a><a href="#glo:optval.automake.immediate"><span class="optfmt">immediate</span></a> or <a id="wrglossary.453"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a><span class="optfmt">=</span><a id="wrglossary.454"></a><a href="#glo:optval.automake.delayed"><span class="optfmt">true</span></a> package option provided the <a id="wrglossary.455"></a><a href="#glo:dual.shellescape">shell escape</a> hasn’t been completely disabled.<p>
+This method can form <a id="wrglossary.456"></a><a href="#glo:idx.range">ranges</a> in the <a id="wrglossary.457"></a><a href="#glo:locationlist">number list</a> but only accepts limited number formats: <a id="wrglossary.458"></a><a href="#glo:arabic"><code class="csfmt">\arabic</code></a>, <a id="wrglossary.459"></a><a href="#glo:roman"><code class="csfmt">\roman</code></a>, <a id="wrglossary.460"></a><a href="#glo:Roman"><code class="csfmt">\Roman</code></a>, <a id="wrglossary.461"></a><a href="#glo:alph"><code class="csfmt">\alph</code></a> and <a id="wrglossary.462"></a><a href="#glo:Alph"><code class="csfmt">\Alph</code></a>. <p>
+This option does not allow a mixture of sort methods. All <a id="wrglossary.463"></a><a href="#glo:dual.glossary">glossaries</a> 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 <a id="wrglossary.464"></a><a href="#glo:dual.glossary">glossary</a> and letter ordering for another you’ll have to explicitly call <a id="wrglossary.465"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> for each <a id="wrglossary.466"></a><a href="#glo:dual.glossary">glossary</a> type.<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.467"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.468"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package allows a hybrid mix of Options <a href="#glo:idx.opt.noidx">1</a> and <a href="#glo:idx.opt.mkidx">2</a> to provide word/letter ordering with <a id="wrglossary.469"></a><a href="#glo:idx.opt.mkidx">Option 2</a> and order of use/definition with <a id="wrglossary.470"></a><a href="#glo:idx.opt.noidx">Option 1</a>. See the <a id="wrglossary.471"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> documentation for further details. See also the <a id="wrglossary.472"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> alternative to <a id="wrglossary.473"></a><a href="#glo:file.sampleSort.tex"><span class="filefmt">sampleSort.tex</span></a> in §<a href="#sec:samplessort">18.5</a>. </div><!-- end of information -->
+<p>
+Summary:
+<ol class="displaylist">
+ <li><span class="numitem">1.</span>If you want to use <a id="wrglossary.474"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span>’s</a> <a id="wrglossary.475"></a><a href="#glo:switch.mkidx.g"><span class="shortargfmt">-g</span></a> option you must change the quote character using <a id="wrglossary.476"></a><a href="#glo:GlsSetQuote"><code class="csfmt">\GlsSetQuote</code></a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.477"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.478"></a><a href="#glo:GlsSetQuote"><code class="csfmt">\GlsSetQuote</code></a>{+}
+</pre> This must be used before <a id="wrglossary.479"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>. Note that if you are using <a id="wrglossary.480"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>, the shorthands aren’t enabled until the start of the document, so you won’t be able to use the shorthands in definitions that occur in the <a id="wrglossary.481"></a><a href="#glo:idx.documentpreamble">preamble</a>.<p>
+<li><span class="numitem">2.</span>Add <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.482"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.483"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>
+</pre> to your <a id="wrglossary.484"></a><a href="#glo:idx.documentpreamble">preamble</a> (before you start defining your entries, as described in §<a href="#sec:newglosentry">4</a>).<p>
+<li><span class="numitem">3.</span>Put <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.485"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.486"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a>
+</pre> where you want your list of entries to appear (described in §<a href="#sec:printglossary">8</a>). Alternatively, to display all glossaries use the iterative command: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.487"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.488"></a><a href="#glo:printglossaries"><code class="csfmt">\printglossaries</code></a>
+</pre><p>
+<li><span class="numitem">4.</span>Run LaTeX on your document. This creates files with the extensions <a id="wrglossary.489"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> and <a id="wrglossary.490"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a> (for example, if your LaTeX document is called <span class="filefmt">myDoc.tex</span>, then you’ll have two extra files called <span class="filefmt">myDoc.glo</span> and <span class="filefmt">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 id="wrglossary.491"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> you’ll see the section heading and some boilerplate text.)<p>
+If you have used package options such as <a id="wrglossary.492"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a> there will also be other sets of files corresponding to the extra glossaries that were created by those options.<p>
+<li><span class="numitem">5.</span><a id="makeindex.run"></a> Run <a id="wrglossary.493"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> with the <a id="wrglossary.494"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> file as the input file and the <a id="wrglossary.495"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a> file as the style so that it creates an output file with the extension <a id="wrglossary.496"></a><a href="#glo:ext.gls"><span class="extfmt">gls</span></a>: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.497"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeindex <a id="wrglossary.498"></a><a href="#glo:switch.mkidx.s"><span class="shortargfmt">-s</span></a> myDoc.ist <a id="wrglossary.499"></a><a href="#glo:switch.mkidx.o"><span class="shortargfmt">-o</span></a> myDoc.gls myDoc.glo
+</pre> (Replace <code class="code">myDoc</code> with the base name of your LaTeX document file. Avoid spaces in the file name if possible.)<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.500"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+The file extensions vary according to the <a id="wrglossary.501"></a><a href="#glo:dual.glossary">glossary</a> <a id="wrglossary.502"></a><a href="#glo:opt.gloskey.type"><span class="csoptfmt">type</span></a>. See §<a href="#sec:makeindexapp">1.6.4</a> for further details. <a id="wrglossary.503"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> must be called for each set of files. </div><!-- end of important -->
+<p>
+If you don’t know how to use the command prompt, then you can probably access <a id="wrglossary.504"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></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>
+Alternatively, run <a id="wrglossary.505"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> indirectly via the <a id="wrglossary.506"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> script: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.507"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeglossaries myDoc
+</pre> Note that the file extension isn’t supplied in this case. (Replace <a id="wrglossary.508"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> with <a id="wrglossary.509"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> if you don’t have Perl installed.) This will pick up all the file extensions from the <a id="wrglossary.510"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file and run <a id="wrglossary.511"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> the appropriate number of times with all the necessary switches.<p>
+The simplest approach is to use <a id="wrglossary.512"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> and add the following comment lines to the start of your document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.513"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+</pre> (Replace <code class="code">makeglossaries</code> with <code class="code">makeglossarieslite</code> in the second line above if you don’t have Perl installed. Note that there’s no hyphen in this case.)<p>
+The default sort is word order (<span class="qt">“sea lion”</span> comes before <span class="qt">“seal”</span>). If you want letter ordering you need to add the <a id="wrglossary.514"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> switch: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.515"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeindex <a id="wrglossary.516"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> <a id="wrglossary.517"></a><a href="#glo:switch.mkidx.s"><span class="shortargfmt">-s</span></a> myDoc.ist -o myDoc.gls myDoc.glo
+</pre> (See §<a href="#sec:makeindexapp">1.6.4</a> for further details on using <a id="wrglossary.518"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> explicitly.) If you use <a id="wrglossary.519"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> or <a id="wrglossary.520"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> then use the <a id="wrglossary.521"></a><a href="#glo:opt.order"><span class="styoptfmt">order</span></a><span class="optfmt">=letter</span> package option and the <a id="wrglossary.522"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> option will be added automatically.<p>
+<li><span class="numitem">6.</span><a id="makeindex.relatex"></a> Once you have successfully completed the previous step, you can now run LaTeX on your document again.
+</ol>
+ You’ll need to repeat the last step if you have used the <a id="wrglossary.523"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a> option (unless you’re using <a id="wrglossary.524"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">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</a> and <a href="#makeindex.relatex">6</a> if you have any cross-references which can’t be <a id="wrglossary.525"></a><a href="#glo:@@glslabel at indexing">indexed</a> until the <a id="wrglossary.526"></a><a href="#glo:dual.indexingfile">indexing file</a> has been created.<p>
+
+</section><!-- end of section option2 -->
+
+<section id="option3"><!-- start of section option3 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.3. <a id="wrglossary.527"></a><dfn id="glo:idx.opt.xdy">Option 3 (<span class="appfmt">xindy</span>)</dfn><div class="labellink"><a href="#option3">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<a id="wrglossary.528"></a>Example document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.529"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[<strong class="strong"><a id="wrglossary.530"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a></strong>,<a id="wrglossary.531"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.532"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a></span>]{glossaries}
+<strong class="strong"><a id="wrglossary.533"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a></strong> <span class="comment">% open <a id="wrglossary.534"></a><a href="#glo:dual.indexingfile">indexing files</a></span>
+<a id="wrglossary.535"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{parrot}{<a id="wrglossary.536"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={parrot}</span>,
+ <a id="wrglossary.537"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a brightly coloured tropical bird}</span>}
+<a id="wrglossary.538"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{duck}{<a id="wrglossary.539"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={duck}</span>,
+ <a id="wrglossary.540"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a waterbird}</span>}
+<a id="wrglossary.541"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{puffin}{<a id="wrglossary.542"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={puffin}</span>,
+ <a id="wrglossary.543"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a seabird with a brightly coloured bill}</span>}
+<a id="wrglossary.544"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{penguin}{<a id="wrglossary.545"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={penguin}</span>,
+ <a id="wrglossary.546"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a flightless black and white seabird}</span>}
+<span class="comment">% a symbol:</span>
+<a id="wrglossary.547"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.548"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.549"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.550"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <strong class="strong"><a id="wrglossary.551"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span></strong>,<a id="wrglossary.552"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>}
+<span class="comment">% an <a id="wrglossary.553"></a><a href="#glo:idx.acronym">acronym</a>:</span>
+<a id="wrglossary.554"></a><a href="#glo:setacronymstyle"><code class="csfmt">\setacronymstyle</code></a>{<a id="wrglossary.555"></a><a href="#glo:opt.acrstyle.short-long"><span class="acrstylefmt">short-long</span></a>}
+<a id="wrglossary.556"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.557"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{puffin}, <a id="wrglossary.558"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{duck} and <a id="wrglossary.559"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{parrot}.
+<a id="wrglossary.560"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet} and <a id="wrglossary.561"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{alpha}.
+Next use: <a id="wrglossary.562"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet}.
+<strong class="strong"><a id="wrglossary.563"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a></strong>
+<code class="cend">\end{document}</code>
+</pre> You can place all your entry definitions in a separate file and load it in the <a id="wrglossary.564"></a><a href="#glo:idx.documentpreamble">preamble</a> with <a id="wrglossary.565"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a> (<span style="font-style: italic; font-variant: normal; ">after</span> <a id="wrglossary.566"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>). The result is the same as for Example <a href="#ex:noidx">3</a> and Example <a href="#ex:mkidx">4</a>. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.567"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:xdy"></a>Example 5: Simple document that uses <span class="appfmt">xindy</span> to sort entries <a href="glossaries-user-examples/glossaries-user-example005.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example005.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example005.png" type="image/png" width="391" height="244">Example document that defines some entries, references a subset of them in the document and displays a sorted list of the referenced entries: alpha, ARPANET, duck, parrot and puffin. There are three letter groups, headed A, D and P.</object> </div><!-- end of resultbox -->
+<p>
+This option uses a <a id="wrglossary.568"></a><a href="#glo:dual.cli">CLI</a> application called <a id="wrglossary.569"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> to sort the entries. This application is more flexible than <a id="wrglossary.570"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> and is able to sort <a id="wrglossary.571"></a><a href="#glo:dual.exlatinalph">extended Latin alphabets</a> or <a id="wrglossary.572"></a><a href="#glo:dual.nonlatinalph">non-Latin alphabets</a>, however it does still have some limitations.<p>
+The <a id="wrglossary.573"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> application comes with both TeX Live and MikTeX, but since <a id="wrglossary.574"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></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 id="wrglossary.575"></a><a href="#glo:idx.opt.mkidx">Option 2</a>, this option involves making LaTeX write the <a id="wrglossary.576"></a><a href="#glo:dual.glossary">glossary</a> information to a temporary file which <a id="wrglossary.577"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> reads. Then <a id="wrglossary.578"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> writes a new file containing the code to typeset the glossary. Then <a id="wrglossary.579"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a> reads this file in on the next run.<p>
+This is the best option with just the base <a id="wrglossary.580"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package if you want to sort according to a language other than English or if you want non-standard <a id="wrglossary.581"></a><a href="#glo:dual.locationlist">location lists</a>, but it can require some setting up (see §<a href="#sec:xindy">14</a>). There are some problems with certain sort values:
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span>entries with the same sort value are merged by <a id="wrglossary.582"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> into a single glossary line so you must make sure that each entry has a unique sort value; <li><span class="bulletitem">•</span><a id="wrglossary.583"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> forbids empty sort values; <li><span class="bulletitem">•</span><a id="wrglossary.584"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> automatically strips control sequences, the math-shift character <a id="wrglossary.585"></a><a href="#glo:idx.sym.dollar"><code class="code">$</code></a> and braces <a id="wrglossary.586"></a><a href="#glo:idx.sym.bg"><code class="code">{</code></a><a id="wrglossary.587"></a><a href="#glo:idx.sym.eg"><code class="code">}</code></a> from the sort value, which is usually desired but this can cause the sort value to collapse to an empty string which <a id="wrglossary.588"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> forbids.
+</ul>
+ In these problematic cases, you must set the <a id="wrglossary.589"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> field explicitly, as in the above example which has: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.590"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.591"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.592"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.593"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.594"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <strong class="strong"><a id="wrglossary.595"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span>,</strong><a id="wrglossary.596"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>
}
-</pre>
-<!--l. 1920--><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="textcolor116"><span
-class="cmtt-10">\glsxtrglossentry</span></span><a
- id="dx1-12005"></a><span
-class="cmtt-10">{#1}</span><span
-class="cmtt-10"> \glsentrysymbol</span><a
- id="dx1-12006"></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-12007"></a><span
-class="cmtt-10">{#1}.\end{quote}%</span>
-<br /><span
-class="cmtt-10">}</span>
-</div>
-</div>
-
-
- <pre class="verbatim" id="verbatim-26">
-\begin{document}
-\tableofcontents
-\section{Introduction}
-Sample document about \glspl{function} and \glspl{set}.
-\termdef{set}
-More detailed information about \glspl{set} with examples.
-\termdef{function}
-More detailed information about \glspl{function} with examples.
-\end{document}
-</pre>
-<!--l. 1943--><p class="nopar" > Or you can use <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12008"></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>
-v1.42, see below): </p><div class="alltt">
-<div class="obeylines-v">
-<span
-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="textcolor117"><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="textcolor118"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-12009"></a><span
-class="cmtt-10">[</span><span id="textcolor119"><span
-class="cmtt-10">src</span></span><a
- id="dx1-12010"></a><span
-class="cmtt-10">=terms,</span><span id="textcolor120"><span
-class="cmtt-10">sort</span></span><a
- id="dx1-12011"></a><span
-class="cmtt-10">=none,</span><span id="textcolor121"><span
-class="cmtt-10">save-locations</span></span><a
- id="dx1-12012"></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="textcolor122"><span
-class="cmtt-10">\glsxtrglossentry</span></span><a
- id="dx1-12013"></a><span
-class="cmtt-10">{#1}</span><span
-class="cmtt-10"> </span><strong><span
-class="cmtt-10">\glossentrysymbol</span><a
- id="dx1-12014"></a></strong><span
-class="cmtt-10">{#1}}%</span>
-<br /><span
-class="cmtt-10"> </span><span
-class="cmtt-10"> \glsadd</span><a
- id="dx1-12015"></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-12016"></a><span
-class="cmtt-10">{#1}.\end{quote}%</span>
-<br /><span
-class="cmtt-10">}</span>
-</div>
-</div>
-
-
- <pre class="verbatim" id="verbatim-27">
-\begin{document}
-\tableofcontents
-\section{Introduction}
-Sample document about \glspl{function} and \glspl{set}.
-\termdef{set}
-More detailed information about \glspl{set} with examples.
-\termdef{function}
-More detailed information about \glspl{function} with examples.
-\end{document}
-</pre>
-<!--l. 1978--><p class="nopar" > Where the file <span
-class="cmtt-10">terms.bib </span>contains: </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor123"><span
-class="cmtt-10">@entry</span></span><a
- id="dx1-12017"></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="textcolor124"><span
-class="cmtt-10">@entry</span></span><a
- id="dx1-12018"></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-12019"></a> or <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12020"></a></a>) is that you can use an existing database
-of entries shared across multiple documents, ensuring consistent notation for all of them.
-<!--l. 1998--><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-12021"></a> package option to prevent them from being loaded.
-</p><!--l. 2002--><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-12022"></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 LaTeX as normal. (Twice to ensure that the table of contents is
-up to date.)
-</p><!--l. 2006--><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. 2011--><p class="indent" > In the second case, you need the <span id="textcolor125"><span
-class="cmss-10">record</span></span><a
- id="dx1-12023"></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-12024"></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="textcolor126"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-12025"></a><span
-class="cmtt-10">[</span><span id="textcolor127"><span
-class="cmtt-10">src</span></span><a
- id="dx1-12026"></a><span
-class="cmtt-10">={terms},</span><strong><span id="textcolor128"><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-12027"></a> or <span
-class="cmtt-10">\glsadd</span><a
- id="dx1-12028"></a>) will be
-selected by <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12029"></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="textcolor129"><span
-class="cmtt-10">save-locations</span></span><span
-class="cmtt-10">=false</span><a
- id="dx1-12030"></a>.)
-<!--l. 2023--><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-12031"></a></a> as per <a
-href="#option4">Option 4</a>:
-</p><!--l. 2024--><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. 2031--><p class="indent" > For both cases (with or without <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12032"></a></a>), instead of listing all the entries using <span id="textcolor130"><span
-class="cmtt-10">\printunsrtglossary</span></span>, you
-use <span id="textcolor131"><span
-class="cmtt-10">\glsxtrglossentry</span></span><a
- id="dx1-12033"></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-12034"></a>) to appear in the
-document. This will allow the <a
-href="#glo:linktext">link text<a
- id="dx1-12035"></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-12036"></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-12037"></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. 2044--><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-12038"></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="textcolor132"><span
-class="cmss-10">glossdesc</span></span><a
- id="dx1-12039"></a> and <span id="textcolor133"><span
-class="cmss-10">glossdescfont</span></span><a
- id="dx1-12040"></a>. See the <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> manual for further
-details.)
-</p><!--l. 2049--><p class="indent" > The symbol (if required) can be displayed with either <span
-class="cmtt-10">\glsentrysymbol</span><a
- id="dx1-12041"></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-12042"></a>
-<span
-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-12043"></a>. The
-latter is necessary with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12044"></a></a> if the symbol needs to go in a section title as the entries aren’t defined on the
-first LaTeX run.
-</p><!--l. 2056--><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-12045"></a> file,
-which triggers an error.
-</p><!--l. 2061--><p class="indent" > The <span
-class="cmtt-10">\glossentrysymbol</span><a
- id="dx1-12046"></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-12047"></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-12048f4"></a>
-If <span
-class="cmss-10">hyperref</span><a
- id="dx1-12049"></a> has been loaded, this will use <span
-class="cmtt-10">\texorpdfstring</span><a
- id="dx1-12050"></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. 2072--><p class="indent" > If you want to test if the <span
-class="cmtt-10">symbol</span><a
- id="dx1-12051"></a> field has been set, you need to use <span
-class="cmtt-10">\ifglshassymbol</span><a
- id="dx1-12052"></a> outside of the section
-title. For example: </p><div class="alltt">
-
-
-<div class="obeylines-v">
-<span
-class="cmtt-10">\ifglshassymbol{#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><span
-class="cmtt-10"> \glossentrysymbol{#1}}}</span>
-<br /><span
-class="cmtt-10">{\section{</span><span id="textcolor135"><span
-class="cmtt-10">\glsxtrglossentry</span></span><span
-class="cmtt-10">{#1}}}</span>
-</div>
-</div>
-<!--l. 2081--><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-12053"></a> value is
-all lowercase in entry definitions). You can apply automatic case-change with the <span id="textcolor136"><span
-class="cmss-10">glossname</span></span><a
- id="dx1-12054"></a> attribute. For
-example: </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor137"><span
-class="cmtt-10">\glssetcategoryattribute</span></span><a
- id="dx1-12055"></a><span
-class="cmtt-10">{general}{glossname}{firstuc}</span>
-</div>
-</div> or (for title-case) <div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor138"><span
-class="cmtt-10">\glssetcategoryattribute</span></span><a
- id="dx1-12056"></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. 2095--><p class="indent" > In the second example, you can instead use <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12057"></a></a> to apply a case-change: </p><div class="alltt">
-<div class="obeylines-v">
-<span
-class="cmtt-10">\GlsXtrLoadResources[</span><span id="textcolor139"><span
-class="cmtt-10">src</span></span><a
- id="dx1-12058"></a><span
-class="cmtt-10">=terms,</span>
-<br /><span
-class="cmtt-10"> </span><span id="textcolor140"><span
-class="cmtt-10">sort</span></span><a
- id="dx1-12059"></a><span
-class="cmtt-10">=none,</span><span id="textcolor141"><span
-class="cmtt-10">save-locations</span></span><a
- id="dx1-12060"></a><span
-class="cmtt-10">=false</span><strong><span
-class="cmtt-10">,</span>
-<br /><span
-class="cmtt-10"> </span><span id="textcolor142"><span
-class="cmtt-10">replicate-fields</span></span><a
- id="dx1-12061"></a><span
-class="cmtt-10">={name=text},</span>
-<br /><span
-class="cmtt-10"> </span><span id="textcolor143"><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="textcolor144"><span
-class="cmtt-10">name-case-change</span></span><span
-class="cmtt-10">=title</span><a
- id="dx1-12062"></a> for title-case.) This copies the <span
-class="cmtt-10">name</span><a
- id="dx1-12063"></a> value to the <span
-class="cmtt-10">text</span><a
- id="dx1-12064"></a> field and
-then applies a case-change to the <span
-class="cmtt-10">name</span><a
- id="dx1-12065"></a> field (leaving the <span
-class="cmtt-10">text</span><a
- id="dx1-12066"></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-12067"></a></a> produced by commands like <span
-class="cmtt-10">\gls</span><a
- id="dx1-12068"></a> is still
-lowercase.
-<!--l. 2111--><p class="indent" > In the first example (without <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12069"></a></a>) you need to do this manually. For example: </p><div class="alltt">
-<div class="obeylines-v">
-<span
-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. 2120--><p class="indent" > Note that if you use the default <span id="textcolor145"><span
-class="cmtt-10">save-locations</span></span><span
-class="cmtt-10">=true</span><a
- id="dx1-12070"></a> with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-12071"></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="textcolor146"><span
-class="cmss-10">bookindex</span></span><a
- id="dx1-12072"></a>, which is provided in the <span
-class="cmss-10">glossary-bookindex</span><a
- id="dx1-12073"></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-12074"></a> option and just load <span
-class="cmss-10">glossary-bookindex</span><a
- id="dx1-12075"></a>:
-</p><div class="alltt">
-<div class="obeylines-v">
-<span
-class="cmtt-10">\usepackage[</span><span id="textcolor147"><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="textcolor148"><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="textcolor149"><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="textcolor150"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-12076"></a><span
-class="cmtt-10">[</span><span id="textcolor151"><span
-class="cmtt-10">src</span></span><a
- id="dx1-12077"></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="textcolor152"><span
-class="cmtt-10">sort</span></span><a
- id="dx1-12078"></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="textcolor153"><span
-class="cmtt-10">replicate-fields</span></span><a
- id="dx1-12079"></a><span
-class="cmtt-10">={name=text},</span>
-<br /><span
-class="cmtt-10"> </span><span id="textcolor154"><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="textcolor155"><span
-class="cmtt-10">\printunsrtglossary</span></span><a
- id="dx1-12080"></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-12081"></a><span id="textcolor156"><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="textcolor157"><span
-class="cmtt-10">--group</span></span><a
- id="dx1-12082"></a> switch:
-<!--l. 2151--><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-12083"></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>
-
-
-<!--l. 2159--><p class="indent" > The <span id="textcolor158"><span
-class="cmss-10">bookindex</span></span><a
- id="dx1-12084"></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="textcolor159"><span
-class="cmss-10">bookindex</span></span><a
- id="dx1-12085"></a> style so that it uses the <span
-class="cmtt-10">text</span><a
- id="dx1-12086"></a> field instead. For example:
-</p><div class="alltt">
-<div class="obeylines-v">
-<span
-class="cmtt-10">\renewcommand*{</span><span id="textcolor160"><span
-class="cmtt-10">\glsxtrbookindexname</span></span><a
- id="dx1-12087"></a><span
-class="cmtt-10">}[1]{%</span>
-<br /><span
-class="cmtt-10"> </span><span
-class="cmtt-10"> </span><span id="textcolor161"><span
-class="cmtt-10">\glossentrynameother</span></span><a
- id="dx1-12088"></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. 2172--><p class="indent" > 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.
-</p><!--l. 2177--><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="textcolor162"><span
-class="cmtt-10">@index</span></span><a
- id="dx1-12089"></a> in the <span
-class="cmtt-10">bib</span><a
- id="dx1-12090"></a> file. For example: </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor163"><span
-class="cmtt-10">@index</span></span><a
- id="dx1-12091"></a><span
-class="cmtt-10">{element}</span>
-<br /><span id="textcolor164"><span
-class="cmtt-10">@index</span></span><a
- id="dx1-12092"></a><span
-class="cmtt-10">{member,</span><span id="textcolor165"><span id="textcolor166"><span
-class="cmtt-10">alias</span></span><a
- id="dx1-12093"></a></span><span
-class="cmtt-10">={element}}</span>
-</div>
-</div> They can be used in the document as usual:
-
-
- <pre class="verbatim" id="verbatim-28">
-The objects that make up a set are the \glspl{element}
-or \glspl{member}.
-</pre>
-<!--l. 2188--><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-12094"></a></a> user manual for further
-details.
-</p><!--l. 2192--><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">§<span
-class="cmbx-10">18</span> </a><a
-href="#sec:samples">Sample Documents<!--tex4ht:ref: sec:samples --></a>.
-</p><!--l. 2196--><p class="noindent" >
-</p>
-<!--l. 2196--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.3 </span> <a
- id="sec:lipsum"></a>Dummy Entries for Testing</h3>
-<!--l. 2199--><p class="noindent" >In addition to the sample files described above, <span
-class="cmss-10">glossaries</span><a
- id="dx1-13001"></a> also provides some files containing lorum
-ipsum dummy entries. These are provided for testing purposes and are on TeX’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-13002"></a> or <span
-class="cmtt-10">\loadglsentries</span><a
- id="dx1-13003"></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-13004"></a> versions of all these files for use with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-13005"></a></a>. The files are as
-follows:
- </p><dl class="description"><dt class="description">
- <!--l. 2209--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-brief.tex</span> </p></dt><dd
-class="description">
- <!--l. 2209--><p class="noindent" >These entries all have brief descriptions. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-29">
- \newglossaryentry{lorem}{name={lorem},description={ipsum}}
-</pre>
- <!--l. 2213--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2215--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-long.tex</span> </p></dt><dd
-class="description">
- <!--l. 2215--><p class="noindent" >These entries all have long descriptions. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-30">
- \newglossaryentry{loremipsum}{name={lorem ipsum},
- description={dolor sit amet, consectetuer adipiscing
- elit. Ut purus elit, vestibulum ut, placerat ac,
- adipiscing vitae, felis. Curabitur dictum gravida
- mauris.}}
-</pre>
- <!--l. 2223--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2225--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-multipar.tex</span> </p></dt><dd
-class="description">
- <!--l. 2225--><p class="noindent" >These entries all have multi-paragraph descriptions. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-31">
- \longnewglossaryentry{loremi-ii}{name={lorem 1--2}}%
- {%
- Lorem ipsum ...
- Nam dui ligula...
- }
-</pre>
- <!--l. 2234--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2236--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-symbols.tex</span> </p></dt><dd
-class="description">
- <!--l. 2236--><p class="noindent" >These entries all use the <span
-class="cmtt-10">symbol</span><a
- id="dx1-13006"></a> key. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-32">
- \newglossaryentry{alpha}{name={alpha},
- symbol={\ensuremath{\alpha}},
- description={Quisque ullamcorper placerat ipsum.}}
-</pre>
- <!--l. 2242--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2244--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-symbolnames.tex</span> </p></dt><dd
-class="description">
- <!--l. 2244--><p class="noindent" >Similar to the previous file but the <span
-class="cmtt-10">symbol</span><a
- id="dx1-13007"></a> key isn’t used. Instead the symbol is stored in the <span
-class="cmtt-10">name</span><a
- id="dx1-13008"></a> key.
- For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-33">
- \newglossaryentry{sym.alpha}{sort={alpha},
- name={\ensuremath{\alpha}},
- description={Quisque ullamcorper placerat ipsum.}}
-</pre>
- <!--l. 2251--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2253--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-images.tex</span> </p></dt><dd
-class="description">
- <!--l. 2253--><p class="noindent" >These entries use the <span
-class="cmtt-10">user1</span><a
- id="dx1-13009"></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-13010"></a>
- 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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-34">
- \longnewglossaryentry{sedfeugiat}{name={sed feugiat},
- user1={example-image}}%
- {%
- Cum sociis natoque...
- Etiam...
- }
-</pre>
- <!--l. 2267--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2269--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-acronym.tex</span> </p></dt><dd
-class="description">
- <!--l. 2269--><p class="noindent" >These entries are all abbreviations. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-35">
- \newacronym[type=\glsdefaulttype]{lid}{LID}{lorem ipsum
- dolor}
-</pre>
- <!--l. 2274--><p class="nopar" >
- </p><!--l. 2275--><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-13011"></a> is redefined to use <span id="textcolor167"><span
-class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-13012"></a>
- with the <span id="textcolor168"><span id="textcolor169"><span
-class="cmtt-10">category</span></span><a
- id="dx1-13013"></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>
- <pre class="verbatim" id="verbatim-36">
- \setabbreviationstyle[acronym]{long-short}
-</pre>
- <!--l. 2284--><p class="nopar" > </div>
- </p><!--l. 2285--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 2287--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-acronym-desc.tex</span> </p></dt><dd
-class="description">
- <!--l. 2287--><p class="noindent" >This file contains entries that are all abbreviations that use the <span
-class="cmtt-10">description</span><a
- id="dx1-13014"></a> key. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-37">
- \newacronym[type=\glsdefaulttype,
-   description={fringilla a, euismod sodales,
-   sollicitudin vel, wisi}]{ndl}{NDL}{nam dui ligula}
-</pre>
- <!--l. 2295--><p class="nopar" >
- </p><!--l. 2296--><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-13015"></a> is redefined to use <span id="textcolor170"><span
-class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-13016"></a>
- with the <span id="textcolor171"><span id="textcolor172"><span
-class="cmtt-10">category</span></span><a
- id="dx1-13017"></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>
- <pre class="verbatim" id="verbatim-38">
- \setabbreviationstyle[acronym]{long-short-desc}
-</pre>
- <!--l. 2305--><p class="nopar" > </div>
- </p><!--l. 2306--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 2308--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-acronyms-lang.tex</span> </p></dt><dd
-class="description">
- <!--l. 2308--><p class="noindent" >These entries are all abbreviations, where some of them have a translation supplied in the <span
-class="cmtt-10">user1</span><a
- id="dx1-13018"></a> key. For
- example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-39">
- \newacronym[type=\glsdefaulttype,user1={love itself}]
-  {li}{LI}{lorem ipsum}
-</pre>
- <!--l. 2315--><p class="nopar" >
- </p><!--l. 2316--><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-13019"></a> is redefined to use <span id="textcolor173"><span
-class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-13020"></a>
- with the <span id="textcolor174"><span id="textcolor175"><span
-class="cmtt-10">category</span></span><a
- id="dx1-13021"></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>
- <pre class="verbatim" id="verbatim-40">
- \setabbreviationstyle[acronym]{long-short-user}
-</pre>
- <!--l. 2325--><p class="nopar" > </div>
- </p><!--l. 2326--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 2328--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-parent.tex</span> </p></dt><dd
-class="description">
- <!--l. 2328--><p class="noindent" >These are hierarchical entries where the child entries use the <span
-class="cmtt-10">name</span><a
- id="dx1-13022"></a> key. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-41">
- \newglossaryentry{sedmattis}{name={sed mattis},
- description={erat sit amet}
- \newglossaryentry{gravida}{parent={sedmattis},
-   name={gravida},description={malesuada}}
-</pre>
- <!--l. 2337--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2339--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-childnoname.tex</span> </p></dt><dd
-class="description">
- <!--l. 2339--><p class="noindent" >These are hierarchical entries where the child entries don’t use the <span
-class="cmtt-10">name</span><a
- id="dx1-13023"></a> key. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-42">
- \newglossaryentry{scelerisque}{name={scelerisque},
-   description={at}}
- \newglossaryentry{vestibulum}{parent={scelerisque},
-   description={eu, nulla}}
-</pre>
- <!--l. 2348--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2350--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-longchild.tex</span> </p></dt><dd
-class="description">
- <!--l. 2350--><p class="noindent" >(New to v4.47.) These entries all have long descriptions and there are some child entries. For
- example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-43">
- \newglossaryentry{longsedmattis}{name={sed mattis},
-  description={erat sit amet dolor sit amet, consectetuer adipiscing elit.
-  Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis.
-  Curabitur dictum gravida mauris.}}
- \newglossaryentry{longgravida}{parent={longsedmattis},name={gravida},
-  description={malesuada libero, nonummy eget, consectetuer id, vulputate a,
-  magna. Donec vehicula augue eu neque. Pellentesque habitant morbi tristique
- senectus et netus et malesuada fames ac turpis egestas. Mauris ut
- leo.}}
-</pre>
- <!--l. 2363--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2365--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-childmultipar.tex</span> </p></dt><dd
-class="description">
- <!--l. 2365--><p class="noindent" >(New to v4.47.) This consists of parent entries with single paragraph descriptions and child entries with
- multi-paragraph descriptions. Some entries have the <span
-class="cmtt-10">user1</span><a
- id="dx1-13024"></a> key set to the name of an image file provided
- by the <span
-class="cmss-10">mwe</span><a
- id="dx1-13025"></a> package. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-44">
- \newglossaryentry{hiersedmattis}{name={sed mattis},user1={example-image},
-  description={Erat sit amet dolor sit amet, consectetuer adipiscing elit.
-  Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur
- dictum gravida mauris. Ut pellentesque augue sed urna. Vestibulum
- diam eros, fringilla et, consectetuer eu, nonummy id, sapien. Nullam
- at lectus. In sagittis ultrices mauris. Curabitur malesuada erat sit
- amet massa. Fusce blandit. Aliquam erat volutpat.}}
- \longnewglossaryentry{hierloremi-ii}
- {name={lorem 1--2},parent={hiersedmattis}}%
- {%
- Lorem ipsum ...
- Nam dui ligula...
- }
-</pre>
- <!--l. 2386--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2388--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-cite.tex</span> </p></dt><dd
-class="description">
- <!--l. 2388--><p class="noindent" >These entries use the <span
-class="cmtt-10">user1</span><a
- id="dx1-13026"></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 TeX distributions. One entry
- doesn’t have an associated citation to help test for a missing key. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-45">
- \newglossaryentry{fusce}{name={fusce},
- description={suscipit cursus sem},user1={article-minimal}}
-</pre>
- <!--l. 2398--><p class="nopar" >
- </p></dd><dt class="description">
- <!--l. 2400--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-url.tex</span> </p></dt><dd
-class="description">
- <!--l. 2400--><p class="noindent" >These entries use the <span
-class="cmtt-10">user1</span><a
- id="dx1-13027"></a> key to store an URL associated with the entry. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-46">
- \newglossaryentry{aenean-url}{name={aenean},
-  description={adipiscing auctor est},
-  user1={http://uk.tug.org/}}
-</pre>
- <!--l. 2407--><p class="nopar" ></p></dd></dl>
-<!--l. 2410--><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="cmss-10">glossaries </span>gallery</a>.
-</p><!--l. 2414--><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">
- <!--l. 2418--><p class="noindent" >
-<span
-class="cmbx-10">example-glossaries-xr.tex</span> </p></dt><dd
-class="description">
- <!--l. 2418--><p class="noindent" >These entries use the <span
-class="cmtt-10">see</span><a
- id="dx1-13028"></a> key provided by the base <span
-class="cmss-10">glossaries </span>package and also the <span id="textcolor176"><span id="textcolor177"><span
-class="cmtt-10">alias</span></span><a
- id="dx1-13029"></a></span> and <span id="textcolor178"><span id="textcolor179"><span
-class="cmtt-10">seealso</span></span><a
- id="dx1-13030"></a></span>
- keys that require <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-47">
- \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}}
-</pre>
- <!--l. 2431--><p class="nopar" ></p></dd></dl>
-<!--l. 2434--><p class="noindent" >
-</p>
-<!--l. 2434--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.4 </span> <a
- id="sec:languages"></a>Multi-Lingual Support</h3>
-<!--l. 2437--><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 LaTeX, <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. 2447--><p class="noindent" >
-</p><!--l. 2449--><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-14001"></a></a> as well as <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-14002"></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="#option3">Option 3</a> (<span
-class="cmtt-10">xindy</span><a
- id="dx1-14003"></a>) or
-<a
-href="#option4">Option 4</a> (<a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-14004"></a></a>) as <span
-class="cmtt-10">makeindex</span><a
- id="dx1-14005"></a> (<a
-href="#option2">Option 2</a>) is hard-coded for the non-extended <a
-href="#glo:latinalph">Latin alphabet<a
- id="dx1-14006"></a></a> and <a
-href="#option1">Option 1</a>
-can only perform limited ASCII comparisons.
-</p><!--l. 2457--><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
-class="cmtt-10">xindy</span><a
- id="dx1-14007"></a>, remember to use the <span
-class="cmss-10">xindy</span><a
- id="dx1-14008"></a> package option. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-48">
-\documentclass[french]{article}
-\usepackage[utf8]{inputenc}
-\usepackage[T1]{fontenc}
-\usepackage{babel}
-\usepackage[xindy]{glossaries}
-</pre>
-<!--l. 2466--><p class="nopar" > If you want to use <span
-class="cmtt-10">bib2gls</span><a
- id="dx1-14009"></a>, you need to use the <span id="textcolor180"><span
-class="cmss-10">record</span></span><a
- id="dx1-14010"></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-14011"></a> files. (See the <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-14012"></a></a> user manual for further details.)
-</p><!--l. 2472--><p class="indent" > <div class="important" title="Important Note"> Note that although a <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-14013"></a></a>, such as é, looks like a plain character in your <span
-class="cmtt-10">tex</span><a
- id="dx1-14014"></a> 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 <span
-class="cmtt-10">\glsnoexpandfields</span>. This issue doesn’t occur with XeLaTeX or LuaLaTeX.
-</div>
-</p><!--l. 2478--><p class="noindent" >
-</p><!--l. 2480--><p class="indent" > With <span
-class="cmss-10">inputenc</span><a
- id="dx1-14015"></a>, if you use a <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-14016"></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-14017"></a>). For example: </p><div class="alltt">
-<div class="obeylines-v">
-<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={select</span><span
-class="cmtt-10"> group</span><span
-class="cmtt-10"> or</span><span
-class="cmtt-10"> class}}</span>
-</div>
-</div> For further details, see the “UTF-8” section in the <span
-class="cmss-10">mfirstuc</span><a
- id="dx1-14018"></a> user manual.
-<!--l. 2491--><p class="indent" > If you are using <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-14019"></a></a> or <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-14020"></a></a>, the application needs to know the encoding of the <span
-class="cmtt-10">tex</span><a
- id="dx1-14021"></a> file. This
-information is added to the <span
-class="cmtt-10">aux</span><a
- id="dx1-14022"></a> file and can be picked up by <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-14023"></a></a> and <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-14024"></a></a>. If you use <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-14025"></a></a>
-explicitly instead of via <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-14026"></a>, you may need to specify the encoding using the <span
-class="cmtt-10">-C</span><a
- id="dx1-14027"></a> option. Read the
-<span
-class="cmtt-10">xindy</span><a
- id="dx1-14028"></a> manual for further details of this option.
-</p><!--l. 2500--><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-14029"></a>
-package<span class="footnote-mark"><a
-href="#fn5x1" id="fn5x1-bk"><sup class="textsuperscript">1.5</sup></a></span><a
- id="x1-14030f5"></a>
-or <span
-class="cmss-10">babel</span><a
- id="dx1-14031"></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-14032"></a>’s</a> <span
-class="cmtt-10">-g</span><a
- id="dx1-14033"></a> option, you’ll need to change
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-14034"></a>’s</a> quote character using:
-</p><!--l. 2505--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-14035"></a> <span
-class="cmtt-10">\GlsSetQuote{</span>⟨<span
-class="cmitt-10">character</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 2507--><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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-49">
-\GlsSetQuote{+}
-</pre>
-<!--l. 2513--><p class="nopar" > This must be done before <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-14036"></a> and any entry definitions. It’s only applicable for <span
-class="cmtt-10">makeindex</span><a
- id="dx1-14037"></a>. This
-option in conjunction with <span
-class="cmss-10">ngerman</span><a
- id="dx1-14038"></a> will also cause <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-14039"></a> to use the <span
-class="cmtt-10">-g</span><a
- id="dx1-14040"></a> switch when invoking
-<span
-class="cmtt-10">makeindex</span><a
- id="dx1-14041"></a>.
-</p><!--l. 2520--><p class="indent" > <div class="important" title="Important Note"> Be careful of <span
-class="cmss-10">babel</span><a
- id="dx1-14042"></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-14043"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-14044"></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-14045"></a> key. </div>
-</p><!--l. 2529--><p class="noindent" >
-</p><!--l. 2531--><p class="indent" > In general, it’s best not to use <span
-class="cmss-10">babel</span><a
- id="dx1-14046"></a>’s shorthands in entry definitions. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-50">
-\documentclass{article}
-\usepackage[ngerman]{babel}
-\usepackage{glossaries}
-\GlsSetQuote{+}
-\makeglossaries
-\newglossaryentry{rna}{name={ribonukleins\"aure},
-  sort={ribonukleins"aure},
-  description={eine Nukleins\"aure}}
-\begin{document}
-\gls{rna}
-\printglossaries
-\end{document}
-</pre>
-<!--l. 2552--><p class="nopar" >
-</p><!--l. 2554--><p class="indent" > The <span
-class="cmss-10">ngerman</span><a
- id="dx1-14047"></a> package has the shorthands on in the preamble, so they can be used in definitions if
-<span
-class="cmtt-10">\GlsSetQuote </span>has been used to change the <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-14048"></a></a> quote character. Example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-51">
-\documentclass{article}
-\usepackage[ngerman]{babel}
-\usepackage{glossaries}
-\GlsSetQuote{+}
-\makeglossaries
-\newglossaryentry{rna}{name={ribonukleins"aure},
-  description={eine Nukleins"aure}}
-\begin{document}
-\gls{rna}
-\printglossaries
-\end{document}
-</pre>
-<!--l. 2575--><p class="nopar" >
-</p><!--l. 2577--><p class="noindent" >
-</p>
-<!--l. 2577--><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:fixednames"></a>Changing the Fixed Names</h4>
-<!--l. 2580--><p class="noindent" >The fixed names are produced using the commands listed in <a
-href="#tab:predefinednames">table <span
-class="cmbx-10">1.2</span></a>. If you aren’t using a
-language package such as <span
-class="cmss-10">babel</span><a
- id="dx1-15001"></a> or <span
-class="cmss-10">polyglossia</span><a
- id="dx1-15002"></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-15003"></a> or <span
-class="cmss-10">polyglossia</span><a
- id="dx1-15004"></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-15005"></a> or <span
-class="cmss-10">polyglossia</span><a
- id="dx1-15006"></a> documentation. If you have
-loaded <span
-class="cmss-10">babel</span><a
- id="dx1-15007"></a>, then <span
-class="cmss-10">glossaries</span><a
- id="dx1-15008"></a> will attempt to load <span
-class="cmss-10">translator</span><a
- id="dx1-15009"></a>, unless you have used the <span
-class="cmss-10">notranslate</span><a
- id="dx1-15010"></a>,
-<span
-class="cmss-10">translate</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">false</span><a
- id="dx1-15011"></a> or <span
-class="cmss-10">translate</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">babel</span><a
- id="dx1-15012"></a> package options. If the <span
-class="cmss-10">translator</span><a
- id="dx1-15013"></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-15014"></a> package for advice on changing translations provided by <span
-class="cmss-10">translator</span><a
- id="dx1-15015"></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-15016"></a>’s interface using
-<span
-class="cmss-10">translate</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">babel</span><a
- id="dx1-15017"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-52">
-\documentclass[english,french]{article}
-\usepackage{babel}
-\usepackage[translate=babel]{glossaries}
-</pre>
-<!--l. 2601--><p class="nopar" > and then use <span
-class="cmss-10">babel</span><a
- id="dx1-15018"></a>’s caption hook mechanism. Note that if you pass the language options directly to <span
-class="cmss-10">babel</span><a
- id="dx1-15019"></a>
-rather that using the document class options or otherwise passing the same options to <span
-class="cmss-10">translator</span><a
- id="dx1-15020"></a>, then <span
-class="cmss-10">translator</span><a
- id="dx1-15021"></a>
-won’t pick up the language and no dictionaries will be loaded and <span
-class="cmss-10">babel</span><a
- id="dx1-15022"></a>’s caption hooks will be used
-instead.
-</p>
- <div class="table">
-
-
-<!--l. 2609--><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-150232 -->
-
-
-<div class="tabular"> <table id="TBL-3" class="tabular"
-
-><colgroup id="TBL-3-1g"><col
-id="TBL-3-1" /><col
-id="TBL-3-2" /><col
-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. 2615--><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. 2616--><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-15024"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-2-2"
-class="td11"> <!--l. 2617--><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. 2617--><p class="noindent" >Title
- of
- the
- main
- 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-15025"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-3-2"
-class="td11"> <!--l. 2618--><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. 2618--><p class="noindent" >Title
- of
- the
- list
- of
- acronyms
- (when
- used
- with
- package
- option
- <span
-class="cmss-10">acronym</span><a
- id="dx1-15026"></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-15027"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-4-2"
-class="td11"> <!--l. 2620--><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. 2621--><p class="noindent" >Header
- for
- first
- column
- in
- the
- glossary
- (for
- 2,
- 3
- or
- 4
- column
- glossaries
- that
- support
- 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-15028"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-5-2"
-class="td11"> <!--l. 2623--><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. 2624--><p class="noindent" >Header
- for
- second
- column
- in
- the
- glossary
- (for
- 2,
- 3
- or
- 4
- column
- glossaries
- that
- support
- 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-15029"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-6-2"
-class="td11"> <!--l. 2626--><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. 2626--><p class="noindent" >Header
- for
- symbol
- column
- in
- the
- glossary
- for
- glossary
- styles
- that
- support
- this
- 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-15030"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-7-2"
-class="td11"> <!--l. 2628--><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. 2629--><p class="noindent" >Header
- for
- page
- list
- column
- in
- the
- glossary
- for
- glossaries
- that
- support
- this
- 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-15031"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-8-2"
-class="td11"> <!--l. 2631--><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. 2632--><p class="noindent" >Header
- for
- symbols
- section
- of
- the
- glossary
- for
- glossary
- styles
- that
- support
- this
- 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-15032"></a> </td><td style="white-space:normal; text-align:left;" id="TBL-3-9-2"
-class="td11"> <!--l. 2634--><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. 2634--><p class="noindent" >Header
- for
- numbers
- section
- of
- the
- glossary
- for
- glossary
- styles
- that
- support
- this
- option. </p></td>
-</tr></table>
-
-</div>
-
-
- </div><hr class="endfloat" />
- </div>
-<!--l. 2640--><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-15033"></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. 2652--><p class="indent" > Examples of use: </p>
- <ul class="itemize1">
- <li class="itemize">
- <!--l. 2654--><p class="noindent" >Using <span
-class="cmss-10">babel</span><a
- id="dx1-15034"></a> and <span
-class="cmss-10">translator</span><a
- id="dx1-15035"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-53">
- \documentclass[english,french]{article}
- \usepackage{babel}
- \usepackage{glossaries}
-</pre>
- <!--l. 2659--><p class="nopar" > (<span
-class="cmss-10">translator</span><a
- id="dx1-15036"></a> is automatically loaded).
- </p></li>
- <li class="itemize">
- <!--l. 2662--><p class="noindent" >Using <span
-class="cmss-10">babel</span><a
- id="dx1-15037"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-54">
- \documentclass[english,french]{article}
- \usepackage{babel}
- \usepackage[translate=babel]{glossaries}
-</pre>
- <!--l. 2667--><p class="nopar" > (<span
-class="cmss-10">translator</span><a
- id="dx1-15038"></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-15039"></a> as the default if <span
-class="cmss-10">babel</span><a
- id="dx1-15040"></a> has been
- loaded.
- </p></li>
- <li class="itemize">
- <!--l. 2672--><p class="noindent" >Using <span
-class="cmss-10">polyglossia</span><a
- id="dx1-15041"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-55">
- \documentclass{article}
- \usepackage{polyglossia}
- \setmainlanguage{english}
- \usepackage{glossaries}
-</pre>
- <!--l. 2678--><p class="nopar" >
-</p>
- </li></ul>
-<!--l. 2682--><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-15042"></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-15043"></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">translator</span><a
- id="dx1-15044"></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 <span
-class="cmtt-10">title</span><a
- id="dx1-15045"></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. 2694--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
-class="cmss-10">translator</span><a
- id="dx1-15046"></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-15047"></a> documentation for further details. (Now with <span
-class="cmss-10">beamer</span><a
- id="dx1-15048"></a> documentation.)
-</div>
-</p><!--l. 2701--><p class="noindent" >
-</p><!--l. 2703--><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>
- <pre class="verbatim" id="verbatim-56">
-myinstitute-glossaries-dictionary-English.dict
-</pre>
-<!--l. 2711--><p class="nopar" > that contains the following:
-
-
-</p>
- <pre class="verbatim" id="verbatim-57">
-\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
-\deftranslation{Glossary}{Nomenclature}
-\deftranslation{Page List (glossaries)}{Location}
-</pre>
-<!--l. 2717--><p class="nopar" > You can now load it using:
-
-
-</p>
- <pre class="verbatim" id="verbatim-58">
-\usedictionary{myinstitute-glossaries-dictionary}
-</pre>
-<!--l. 2721--><p class="nopar" > (Make sure that <span
-class="cmtt-10">myinstitute-glossaries-dictionary-English.dict </span>can be found by TeX.) If you want to
-share your custom dictionary, you can upload it to <a
-href="http://www.ctan.org/" >CTAN</a>.
-</p><!--l. 2726--><p class="indent" > If you are using <span
-class="cmss-10">babel</span><a
- id="dx1-15049"></a> and don’t want to use the <span
-class="cmss-10">translator</span><a
- id="dx1-15050"></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-15051"></a>. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-59">
-\documentclass[british]{article}
-\usepackage{babel}
-\usepackage[translate=babel]{glossaries}
-\addto\captionsbritish{%
-    \renewcommand*{\glossaryname}{List of Terms}%
-    \renewcommand*{\acronymname}{List of Acronyms}%
+</pre> <div class="information"><div class="informationtitle"><a id="wrglossary.597"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.598"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package has a modified <a id="wrglossary.599"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a> package option that provides <a id="wrglossary.600"></a><a href="#glo:glsxtrnewsymbol"><code class="xtrcsfmt">\glsxtrnewsymbol</code></a>, which automatically sets the <a id="wrglossary.601"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key to the entry label (instead of the <a id="wrglossary.602"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a>). </div><!-- end of information -->
+<p>
+All <a id="wrglossary.603"></a><a href="#glo:dual.glossary">glossaries</a> must be sorted according to the same method (word/letter ordering, order of use, or order of definition).<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.604"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.605"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package allows a hybrid mix of Options <a href="#glo:idx.opt.noidx">1</a> and <a href="#glo:idx.opt.xdy">3</a> to provide word/letter ordering with <a id="wrglossary.606"></a><a href="#glo:idx.opt.xdy">Option 3</a> and order of use/definition with <a id="wrglossary.607"></a><a href="#glo:idx.opt.mkidx">Option 2</a>. See the <a id="wrglossary.608"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> documentation for further details. </div><!-- end of information -->
+<p>
+Summary:
+<ol class="displaylist">
+ <li><span class="numitem">1.</span>Add the <a id="wrglossary.609"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a> option to the <a id="wrglossary.610"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package option list: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.611"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.612"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a>]{glossaries}
+</pre> If you are using a non-Latin script you’ll also need to either switch off the creation of the number <a id="wrglossary.613"></a><a href="#glo:idx.group">group</a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.614"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.615"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a><span class="optfmt">={<a id="wrglossary.616"></a><a href="#glo:opt.xindy.glsnumbers"><span class="optfmt">glsnumbers</span></a><span class="optfmt">=false</span>}</span>]{glossaries}
+</pre> or use either <code class="code"><a id="wrglossary.617"></a><a href="#glo:GlsSetXdyFirstLetterAfterDigits"><code class="csfmt">\GlsSetXdyFirstLetterAfterDigits</code></a>{<span class="meta">〈<em class="metainner">letter</em>〉</span>}</code> (to indicate the first <a id="wrglossary.618"></a><a href="#glo:idx.group">letter group</a> to follow the digits) or <code class="code"><a id="wrglossary.619"></a><a href="#glo:GlsSetXdyNumberGroupOrder"><code class="csfmt">\GlsSetXdyNumberGroupOrder</code></a>{<span class="meta">〈<em class="metainner">spec</em>〉</span>}</code> to indicate where the number <a id="wrglossary.620"></a><a href="#glo:idx.group">group</a> should be placed (see §<a href="#sec:xindy">14</a>).<p>
+<li><span class="numitem">2.</span>Add <a id="wrglossary.621"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> to your <a id="wrglossary.622"></a><a href="#glo:idx.documentpreamble">preamble</a> (before you start defining your entries, as described in §<a href="#sec:newglosentry">4</a>).<p>
+<li><span class="numitem">3.</span>Run LaTeX on your document. This creates files with the extensions <a id="wrglossary.623"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> and <a id="wrglossary.624"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> (for example, if your LaTeX document is called <span class="filefmt">myDoc.tex</span>, then you’ll have two extra files called <span class="filefmt">myDoc.glo</span> and <span class="filefmt">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 id="wrglossary.625"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package, you’ll see the section header and some boilerplate text.)<p>
+If you have used package options such as <a id="wrglossary.626"></a><a href="#glo:opt.symbols"><span class="styoptfmt">symbols</span></a> there will also be other sets of files corresponding to the extra glossaries that were created by those options.<p>
+<li><span class="numitem">4.</span>Run <a id="wrglossary.627"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> with the <a id="wrglossary.628"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> file as the input file and the <a id="wrglossary.629"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> file as a module so that it creates an output file with the extension <a id="wrglossary.630"></a><a href="#glo:ext.gls"><span class="extfmt">gls</span></a>. You also need to set the language name and input <a id="wrglossary.631"></a><a href="#glo:idx.encoding">encoding</a>, as follows (all on one line): <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.632"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>xindy <a id="wrglossary.633"></a><a href="#glo:switch.xdy.L"><span class="shortargfmt">-L</span></a> english <a id="wrglossary.634"></a><a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> utf8 <a id="wrglossary.635"></a><a href="#glo:switch.xdy.I"><span class="shortargfmt">-I</span></a> xindy <a id="wrglossary.636"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> myDoc <a id="wrglossary.637"></a><a href="#glo:switch.xdy.t"><span class="shortargfmt">-t</span></a> myDoc.glg <a id="wrglossary.638"></a><a href="#glo:switch.xdy.o"><span class="shortargfmt">-o</span></a> myDoc.gls myDoc.glo
+</pre> (Replace <code class="code">myDoc</code> with the base name of your LaTeX document file. Avoid spaces in the file name. If necessary, also replace <code class="code">english</code> with the name of your language and <code class="code">utf8</code> with your input <a id="wrglossary.639"></a><a href="#glo:idx.encoding">encoding</a>, for example, <code class="code"><a id="wrglossary.640"></a><a href="#glo:switch.xdy.L"><span class="shortargfmt">-L</span></a> german <a id="wrglossary.641"></a><a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> din5007-utf8</code>.)<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.642"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+The file extensions vary according to the glossary <a id="wrglossary.643"></a><a href="#glo:opt.gloskey.type"><span class="csoptfmt">type</span></a>. See §<a href="#sec:xindyapp">1.6.3</a> for further details. <a id="wrglossary.644"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> must be called for each set of files. </div><!-- end of important -->
+<p>
+It’s much simpler to use <a id="wrglossary.645"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> instead: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.646"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeglossaries myDoc
+</pre> Note that the file extension isn’t supplied in this case. This will pick up all the file extensions from the <a id="wrglossary.647"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file and run <a id="wrglossary.648"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> the appropriate number of times with all the necessary switches.<p>
+There’s no benefit in using <a id="wrglossary.649"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> with <a id="wrglossary.650"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. (Remember that <a id="wrglossary.651"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> is a Perl script so if you can use <a id="wrglossary.652"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> then you can also use <a id="wrglossary.653"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>, and if you don’t want to use <a id="wrglossary.654"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> because you don’t want to install Perl, then you can’t use <a id="wrglossary.655"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> either.) If you don’t know how to use the command prompt, then you can probably access <a id="wrglossary.656"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> or <a id="wrglossary.657"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></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>
+Again, a convenient method is to use <a id="wrglossary.658"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> and add the follow comment lines to the start of your document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.659"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+</pre><p>
+The default sort is word order (<span class="qt">“sea lion”</span> comes before <span class="qt">“seal”</span>). If you want letter ordering you need to add the <a id="wrglossary.660"></a><a href="#glo:opt.order"><span class="styoptfmt">order</span></a><span class="optfmt">=letter</span> package option: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.661"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.662"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a>,<a id="wrglossary.663"></a><a href="#glo:opt.order"><span class="styoptfmt">order</span></a><span class="optfmt">=letter</span>]{glossaries}
+</pre> (and return to the previous step). This option is picked up by <a id="wrglossary.664"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. If you are explicitly using <a id="wrglossary.665"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> then you’ll need to add <code class="code"><a id="wrglossary.666"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> ord/letorder</code> to the options list. See §<a href="#sec:xindyapp">1.6.3</a> for further details on using <a id="wrglossary.667"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> explicitly.<p>
+<li><span class="numitem">5.</span>Once you have successfully completed the previous step, you can now run LaTeX on your document again. As with <a id="wrglossary.668"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> (<a id="wrglossary.669"></a><a href="#glo:idx.opt.mkidx">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.<p>
+
+</ol>
+<p>
+
+</section><!-- end of section option3 -->
+
+<section id="option4"><!-- start of section option4 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.4. <a id="wrglossary.670"></a><dfn id="glo:idx.opt.b2g">Option 4 (<span class="appfmt">bib2gls</span>)</dfn><div class="labellink"><a href="#option4">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<div class="sidenote"><a id="wrglossary.671"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+<a id="wrglossary.672"></a>This option is only available with the <a id="wrglossary.673"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package. This method uses <a id="wrglossary.674"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> to both fetch <a id="wrglossary.675"></a><a href="#glo:idx.glossaryentry">entry</a> definitions from <a id="wrglossary.676"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> files and to hierarchically sort and collate.<p>
+Example document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.677"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[<strong class="strong"><a id="wrglossary.678"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a></strong>,<a id="wrglossary.679"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.680"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a></span>]{<strong class="strong">glossaries-extra</strong>}
+<a id="wrglossary.681"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>{<a id="wrglossary.682"></a><a href="#glo:opt.abbrstyle.short-long"><span class="abbrstylefmt">short-long</span></a>}
+<span class="comment">% data in sample-entries.bib:</span>
+<strong class="strong"><a id="wrglossary.683"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a></strong>[<a id="wrglossary.684"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={sample-entries}</span>]
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.685"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{puffin}, <a id="wrglossary.686"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{duck} and <a id="wrglossary.687"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{parrot}.
+<a id="wrglossary.688"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet} and <a id="wrglossary.689"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{alpha}.
+Next use: <a id="wrglossary.690"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet}.
+<strong class="strong"><a id="wrglossary.691"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a></strong>
+<code class="cend">\end{document}</code>
+</pre> Note that the <a id="wrglossary.692"></a><a href="#glo:idx.abbrvstyle"><span class="xtrfmt">abbreviation</span> style</a> must be set before <a id="wrglossary.693"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>. The file <span class="filefmt">sample-entries.bib</span> contains: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.694"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="code">@entry</code>{parrot,
+ <a id="wrglossary.695"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={parrot}</span>,
+ <a id="wrglossary.696"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a brightly coloured tropical bird}</span>
}
-</pre>
-<!--l. 2739--><p class="nopar" >
-</p><!--l. 2741--><p class="indent" > Note that <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-15052"></a></a> and <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-15053"></a></a> provide much better multi-lingual support than <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-15054"></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="#glo:nonlatinchar">non-Latin character<a
- id="dx1-15055"></a>s</a>. See <a
-href="#sec:xindy">§<span
-class="cmbx-10">14</span>
-</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-15056"></a></a>, and see the <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-15057"></a></a> user manual for further details of that
-application.
-</p>
-<!--l. 2748--><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:newlang"></a>Creating a New Language Module</h4>
-<!--l. 2751--><p class="noindent" >The <span
-class="cmss-10">glossaries </span>package now uses the <span
-class="cmss-10">tracklang</span><a
- id="dx1-16001"></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-16002"></a>
-documentation.
-</p><!--l. 2756--><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><a
- id="dx1-16003"></a> and
-<span
-class="cmtt-10">glossaries-dictionary-</span>⟨<span
-class="cmti-10">Lang</span>⟩<span
-class="cmtt-10">.dict</span><a
- id="dx1-16004"></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="cmss-10">translator</span><a
- id="dx1-16005"></a> (for example, <span
-class="cmtt-10">English</span>).
-</p><!--l. 2763--><p class="indent" > Here’s an example of <span
-class="cmtt-10">glossaries-dictionary-English.dict</span>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-60">
-\ProvidesDictionary{glossaries-dictionary}{English}
-\providetranslation{Glossary}{Glossary}
-\providetranslation{Acronyms}{Acronyms}
-\providetranslation{Notation (glossaries)}{Notation}
-\providetranslation{Description (glossaries)}{Description}
-\providetranslation{Symbol (glossaries)}{Symbol}
-\providetranslation{Page List (glossaries)}{Page List}
-\providetranslation{Symbols (glossaries)}{Symbols}
-\providetranslation{Numbers (glossaries)}{Numbers}
-</pre>
-<!--l. 2775--><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-16006"></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. 2783--><p class="indent" > Here’s an example of <span
-class="cmtt-10">glossaries-english.ldf</span>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-61">
-\ProvidesGlossariesLang{english}
-\glsifusedtranslatordict{English}
-{%
-  \addglossarytocaptions{\CurrentTrackedLanguage}%
-  \addglossarytocaptions{\CurrentTrackedDialect}%
+<code class="code">@entry</code>{duck,
+ <a id="wrglossary.697"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={duck}</span>,
+ <a id="wrglossary.698"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a waterbird}</span>
}
-{%
-  \@ifpackageloaded{polyglossia}%
-  {%
-    \newcommand*{\glossariescaptionsenglish}{%
-      \renewcommand*{\glossaryname}{\textenglish{Glossary}}%
-      \renewcommand*{\acronymname}{\textenglish{Acronyms}}%
-      \renewcommand*{\entryname}{\textenglish{Notation}}%
-      \renewcommand*{\descriptionname}{\textenglish{Description}}%
-      \renewcommand*{\symbolname}{\textenglish{Symbol}}%
-      \renewcommand*{\pagelistname}{\textenglish{Page List}}%
-      \renewcommand*{\glssymbolsgroupname}{\textenglish{Symbols}}%
-      \renewcommand*{\glsnumbersgroupname}{\textenglish{Numbers}}%
-    }%
-  }%
-  {%
-    \newcommand*{\glossariescaptionsenglish}{%
-      \renewcommand*{\glossaryname}{Glossary}%
-      \renewcommand*{\acronymname}{Acronyms}%
-      \renewcommand*{\entryname}{Notation}%
-      \renewcommand*{\descriptionname}{Description}%
-      \renewcommand*{\symbolname}{Symbol}%
-      \renewcommand*{\pagelistname}{Page List}%
-      \renewcommand*{\glssymbolsgroupname}{Symbols}%
-      \renewcommand*{\glsnumbersgroupname}{Numbers}%
-    }%
-  }%
-  \ifcsdef{captions\CurrentTrackedDialect}
-  {%
-    \csappto{captions\CurrentTrackedDialect}%
-    {%
-      \glossariescaptionsenglish
-    }%
-  }%
-  {%
-    \ifcsdef{captions\CurrentTrackedLanguage}
-    {
-      \csappto{captions\CurrentTrackedLanguage}%
-      {%
-        \glossariescaptionsenglish
-
-
-      }%
-    }%
-    {%
-    }%
-  }%
-  \glossariescaptionsenglish
+<code class="code">@entry</code>{puffin,
+ <a id="wrglossary.699"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={puffin}</span>,
+ <a id="wrglossary.700"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a seabird with a brightly coloured bill}</span>
}
-\renewcommand*{\glspluralsuffix}{s}
-\renewcommand*{\glsacrpluralsuffix}{\glspluralsuffix}
-\renewcommand*{\glsupacrpluralsuffix}{\glstextup{\glspluralsuffix}}
-</pre>
-<!--l. 2841--><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-16007"></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">\glossariescaptions</span>⟨<span
-class="cmti-10">lang</span>⟩, replace the English text (such as “Glossaries”) with the
-appropriate translation.
-</p><!--l. 2851--><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. 2862--><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-16008"></a>, <span
-class="cmtt-10">longplural</span><a
- id="dx1-16009"></a>, <span
-class="cmtt-10">shortplural</span><a
- id="dx1-16010"></a> etc keys to override exceptions.
-</div>
-</p><!--l. 2871--><p class="noindent" >
-</p><!--l. 2873--><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 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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-62">
- \ProvidesGlossariesLang{en-GB}
- \RequireGlossariesLang{english}
- \glsifusedtranslatordict{British}
- {%
-   \addglossarytocaptions{\CurrentTrackedLanguage}%
-   \addglossarytocaptions{\CurrentTrackedDialect}%
- }
- {%
-   \@ifpackageloaded{polyglossia}%
-   {%
-     % Modify \glossariescaptionsenglish as appropriate for
-     % polyglossia
-   }%
-   {%
-     % Modify \glossariescaptionsenglish as appropriate for
-     % non-polyglossia
-   }%
- }
-</pre>
-<!--l. 2898--><p class="nopar" >
-</p><!--l. 2900--><p class="indent" > If the translations includes <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-16011"></a>s</a>, it’s necessary to provide code that’s independent of the
-input encoding. Remember that while some users may use <a
-href="#glo:UTF-8">UTF-8</a>, 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 <a
-href="#glo:UTF-8">UTF-8</a> version for XeLaTeX and LuaLaTeX users.
-</p><!--l. 2907--><p class="indent" > The <span
-class="cmtt-10">glossaries-irish.ldf </span>file provides this as follows:
-
-
-</p>
- <pre class="verbatim" id="verbatim-63">
-\ProvidesGlossariesLang{irish}
-\glsifusedtranslatordict{Irish}
-{%
-  \addglossarytocaptions{\CurrentTrackedLanguage}%
-  \addglossarytocaptions{\CurrentTrackedDialect}%
+<code class="code">@entry</code>{penguin,
+ <a id="wrglossary.701"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={penguin}</span>,
+ <a id="wrglossary.702"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a flightless black and white seabird}</span>
}
-{%
-  \ifdefstring{\inputencodingname}{utf8}
-  {\input{glossaries-irish-utf8.ldf}}%
-  {%
-    \ifdef{\XeTeXinputencoding}% XeTeX defaults to UTF-8
-    {\input{glossaries-irish-utf8.ldf}}%
-    {\input{glossaries-irish-noenc.ldf}}
-  }
-  \ifcsdef{captions\CurrentTrackedDialect}
-  {%
-    \csappto{captions\CurrentTrackedDialect}%
-    {%
-      \glossariescaptionsirish
-    }%
-  }%
-  {%
-    \ifcsdef{captions\CurrentTrackedLanguage}
-    {
-      \csappto{captions\CurrentTrackedLanguage}%
-      {%
-        \glossariescaptionsirish
-      }%
-    }%
-    {%
-    }%
-  }%
-  \glossariescaptionsirish
+<code class="code">@symbol</code>{alpha,
+ <a id="wrglossary.703"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.704"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.705"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <a id="wrglossary.706"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>
}
-</pre>
-<!--l. 2944--><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="cmss-10">translator</span><a
- id="dx1-16012"></a> dictionary label.)
-</p><!--l. 2949--><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>(<a
-href="#glo:UTF-8">UTF-8</a>).
-</p><!--l. 2953--><p class="indent" > These both define <span
-class="cmtt-10">\glossariescaptionsirish </span>but the <span
-class="cmtt-10">*-noenc.ldf </span>uses LaTeX accent commands:
-
-
-</p>
- <pre class="verbatim" id="verbatim-64">
-\@ifpackageloaded{polyglossia}%
-{%
-  \newcommand*{\glossariescaptionsirish}{%
-    \renewcommand*{\glossaryname}{\textirish{Gluais}}%
-    \renewcommand*{\acronymname}{\textirish{Acrainmneacha}}%
-    \renewcommand*{\entryname}{\textirish{Ciall}}%
-    \renewcommand*{\descriptionname}{\textirish{Tuairisc}}%
-    \renewcommand*{\symbolname}{\textirish{Comhartha}}%
-    \renewcommand*{\glssymbolsgroupname}{\textirish{Comhartha\'{\i}}}%
-    \renewcommand*{\pagelistname}{\textirish{Leathanaigh}}%
-    \renewcommand*{\glsnumbersgroupname}{\textirish{Uimhreacha}}%
-  }%
-}%
-{%
-  \newcommand*{\glossariescaptionsirish}{%
-    \renewcommand*{\glossaryname}{Gluais}%
-    \renewcommand*{\acronymname}{Acrainmneacha}%
-    \renewcommand*{\entryname}{Ciall}%
-    \renewcommand*{\descriptionname}{Tuairisc}%
-    \renewcommand*{\symbolname}{Comhartha}%
-    \renewcommand*{\glssymbolsgroupname}{Comhartha\'{\i}}%
-    \renewcommand*{\pagelistname}{Leathanaigh}%
-    \renewcommand*{\glsnumbersgroupname}{Uimhreacha}%
-  }%
+<code class="code">@abbreviation</code>{arpanet,
+ <a id="wrglossary.707"></a><a href="#glo:opt.gloskey.short"><span class="csoptfmt">short</span></a><span class="optfmt">={ARPANET}</span>,
+ <a id="wrglossary.708"></a><a href="#glo:opt.gloskey.long"><span class="csoptfmt">long</span></a><span class="optfmt">={Advanced Research Projects Agency Network}</span>
}
-</pre>
-<!--l. 2981--><p class="nopar" > whereas the <span
-class="cmtt-10">*-utf8.ldf </span>replaces the accent commands with the appropriate <a
-href="#glo:UTF-8">UTF-8</a> characters.
-</p><!--l. 2986--><p class="noindent" >
-</p>
-<!--l. 2986--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.5 </span> <a
- id="sec:makeglossaries"></a>Generating the Associated Glossary Files</h3>
-<!--l. 2989--><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="cmtt-10">sort</span><a
- id="dx1-17001"></a> key if the <span
-class="cmtt-10">name</span><a
- id="dx1-17002"></a> contains any LaTeX commands (except if you’re using <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-17003"></a></a>).
-</div>
-</p><!--l. 2995--><p class="noindent" >
-</p><!--l. 2997--><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-17004"></a></a> or
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17005"></a></a>, you can try using the <span
-class="cmss-10">automake</span><a
- id="dx1-17006"></a> package option, described in <a
-href="#sec:pkgopts-sort">§<span
-class="cmbx-10">2.5</span> </a><a
-href="#sec:pkgopts-sort">Sorting Options<!--tex4ht:ref: sec:pkgopts-sort --></a>,
-but you will need TeX’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. 3006--><p class="indent" > In order to generate a sorted glossary with compact <a
-href="#glo:numberlist">number list<a
- id="dx1-17007"></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 TeX 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 LaTeX are
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17008"></a></a> and <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17009"></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-17010"></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-17011"></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-17012"></a></a>
-user manuals for further details.) Note that <span
-class="cmtt-10">xindy</span><a
- id="dx1-17013"></a> and <span
-class="cmtt-10">bib2gls</span><a
- id="dx1-17014"></a> have much better multi-lingual
-support than <span
-class="cmtt-10">makeindex</span><a
- id="dx1-17015"></a>, so <span
-class="cmtt-10">xindy</span><a
- id="dx1-17016"></a> or <span
-class="cmtt-10">bib2gls</span><a
- id="dx1-17017"></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-17018"></a> is used are described in <a
-href="#sec:xindy">§<span
-class="cmbx-10">14</span> </a><a
-href="#sec:xindy">Xindy (Option
-3)<!--tex4ht:ref: sec:xindy --></a>.
-</p><!--l. 3026--><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-17019"></a> and <span
-class="cmtt-10">arara</span><a
- id="dx1-17020"></a>. With <span
-class="cmtt-10">arara</span><a
- id="dx1-17021"></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
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
-<br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> makeglossaries</span>
-<br /><span
-class="cmtt-10">%</span><span
-class="cmtt-10"> arara:</span><span
-class="cmtt-10"> pdflatex</span>
-</div>
-</div> With <span
-class="cmtt-10">latexmk</span><a
- id="dx1-17022"></a> you need to set up the required dependencies. </div>
-<!--l. 3037--><p class="noindent" >
-</p><!--l. 3039--><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-17023"></a></a> which will run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17024"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17025"></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-17026"></a>). See
-<a
-href="#sec:makeglossariesapp">§<span
-class="cmbx-10">1.5.1</span> </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 TeX-related applications (including <span
-class="cmtt-10">xindy</span><a
- id="dx1-17027"></a> and <span
-class="cmtt-10">latexmk</span><a
- id="dx1-17028"></a>).
-Most Unix-like operating systems come with a Perl interpreter. TeX Live also comes with a Perl
-interpreter. MiKTeX doesn’t come with a Perl interpreter so if you are a Windows MiKTeX 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-17029"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17030"></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. 3055--><p class="indent" > The advantages of using <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17031"></a>: </p>
- <ul class="itemize1">
- <li class="itemize">
- <!--l. 3057--><p class="noindent" >It automatically detects whether to use <span
-class="cmtt-10">makeindex</span><a
- id="dx1-17032"></a> or <span
-class="cmtt-10">xindy</span><a
- id="dx1-17033"></a> and sets the relevant application
- switches.
- </p></li>
- <li class="itemize">
- <!--l. 3060--><p class="noindent" >One call of <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17034"></a> will run <span
-class="cmtt-10">makeindex</span><a
- id="dx1-17035"></a>/<span
-class="cmtt-10">xindy</span><a
- id="dx1-17036"></a> for each glossary type.
- </p></li>
- <li class="itemize">
-
-
- <!--l. 3063--><p class="noindent" >If things go wrong, <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17037"></a></a> will scan the messages from <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17038"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17039"></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-17040"></a> or <span
-class="cmtt-10">xindy</span><a
- id="dx1-17041"></a> messages.
- </p></li>
- <li class="itemize">
- <!--l. 3071--><p class="noindent" >If <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17042"></a></a> warns about multiple encap values, <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17043"></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-17044f6"></a>
- This correction is only provided by <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17046"></a></a> when <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17047"></a></a> is used since <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17048"></a></a> uses the
- order of the <a
- id="dx1-17049"></a>attributes list to determine which format should take precedence. (see <a
-href="#sec:xindyloc">§<span
-class="cmbx-10">14.2</span>
- </a><a
-href="#sec:xindyloc">Locations and Number lists<!--tex4ht:ref: sec:xindyloc --></a>.)
-</p>
- </li></ul>
-<!--l. 3081--><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-17050"></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-17051"></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 TeX distributions come
-with LuaTeX (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-17052"></a></a> so it’s an alternative to <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17053"></a></a> if you want to use <a
-href="#option2">Option 2</a>
-(<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17054"></a></a>).
-</p><!--l. 3091--><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-17055"></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-17056"></a></a> or <a
-href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-17057"></a></a>.
-</p><!--l. 3097--><p class="indent" > Whilst I strongly recommended that you use the <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17058"></a></a> Perl script or the <a
-href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-17059"></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-17060"></a></a>/<a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17061"></a></a>. These are listed in
-<a
-href="#tab:makeglossariesCmds">table <span
-class="cmbx-10">1.3</span></a>.
-</p><!--l. 3104--><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-17062"></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-17063"></a> as <span
-class="cmtt-10">xindy</span><a
- id="dx1-17064"></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. 3110--><p class="noindent" >
-</p><!--l. 3112--><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-17065"></a></a>, <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17066"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17067"></a></a> run, as appropriate. For example, suppose you have defined the following
-entries:<span class="footnote-mark"><a
-href="#fn7x1" id="fn7x1-bk"><sup class="textsuperscript">1.7</sup></a></span><a
- id="x1-17068f7"></a>
-
-
-</p>
- <pre class="verbatim" id="verbatim-65">
-\newglossaryentry{citrusfruit}{name={citrus fruit},
-description={fruit of any citrus tree. (See also
-\gls{orange})}}
-\newglossaryentry{orange}{name={orange},
-description={an orange coloured fruit.}}
-</pre>
-<!--l. 3125--><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-17070"></a></a>, <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17071"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17072"></a></a>. For example, if the document is called <span
-class="cmtt-10">myDoc.tex</span>, then you must
-do:
-</p><!--l. 3133--><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-17073"></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-17074"></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-17075"></a></a> manual for further details.)
-</p><!--l. 3146--><p class="indent" > Likewise, an additional <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-17076"></a></a> and LaTeX 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 LaTeX run may push glossary entries across page boundaries, which means that the
-<a
-href="#glo:numberlist">number list<a
- id="dx1-17077"></a>s</a> in the glossary may need updating.
-</p><!--l. 3154--><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-17078"></a></a>, <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-17079"></a></a> or <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17080"></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">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. 3160--><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. 3166--><p class="indent" > If any problems occur, remember to check the transcript files (e.g. <span
-class="cmtt-10">glg</span><a
- id="dx1-17081"></a> or <span
-class="cmtt-10">alg</span><a
- id="dx1-17082"></a>) for messages.
-</p>
- <div class="table">
-
-
-<!--l. 3169--><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-17084"></a></a> or <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17085"></a></a> explicitly</span></div><!--tex4ht:label?: x1-170833 -->
-<div class="tabular"> <table id="TBL-4" class="tabular"
-
-><colgroup id="TBL-4-1g"><col
-id="TBL-4-1" /><col
-id="TBL-4-2" /><col
-id="TBL-4-3" /></colgroup><tr
- style="vertical-align:baseline;" id="TBL-4-1-"><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-1"
-class="td01"><span
-class="cmbx-10">Command or Package Option </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-1-2"
-class="td11"> <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-17086"></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-17087"></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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">letter</span><a
- id="dx1-17088"></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-17089"></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-17090"></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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">word</span><a
- id="dx1-17091"></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-17092"></a>=<span
-class="cmsy-10">{</span><span
-class="cmss-10">language=</span>⟨<span
-class="cmti-10">lang</span>⟩<span
-class="cmss-10">,codename=</span>⟨<span
-class="cmti-10">code</span>⟩<span
-class="cmsy-10">} </span></td><td style="white-space:nowrap; text-align:left;" id="TBL-4-4-2"
-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-17093"></a> ⟨<span
-class="cmti-10">lang</span>⟩ <span
-class="cmtt-10">-C</span><a
- id="dx1-17094"></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-17095"></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-17096"></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-17097"></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-17098"></a> ⟨<span
-class="cmti-10">code</span>⟩ </td></tr></table>
-</div>
-
-
- </div><hr class="endfloat" />
- </div>
-<!--l. 3192--><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:makeglossariesapp"></a>Using the makeglossaries Perl Script</h4>
-<!--l. 3195--><p class="noindent" >The <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18001"></a></a> script picks up the relevant information from the auxiliary (<span
-class="cmtt-10">aux</span><a
- id="dx1-18002"></a>) file and will either call
-<a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-18003"></a></a> or <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-18004"></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-18005"></a>. For example, if your document is called <span
-class="cmtt-10">myDoc.tex</span>, type the
-following in your terminal:
-</p><!--l. 3202--><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-18006"></a></a> into Perl:
-</p><!--l. 3208--><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. 3212--><p class="indent" > Windows users: TeX 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
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18007"></a></a> Perl script. MiKTeX also
-provides a wrapper <span
-class="cmtt-10">makeglossaries.exe </span>but doesn’t provide a Perl interpreter, which is still
-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="#fn8x1" id="fn8x1-bk"><sup class="textsuperscript">1.8</sup></a></span><a
- id="x1-18008f8"></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. 3224--><p class="indent" > The <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18009"></a></a> script attempts to fork the <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-18010"></a></a>/<a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-18011"></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
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18012"></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-18013"></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-18014"></a>
-switch to suppress this warning or you can use the <span
-class="cmtt-10">-k</span><a
- id="dx1-18015"></a> switch to make <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18016"></a></a> automatically use the
-fallback method without attempting the redirection. Without this redirection, the <span
-class="cmtt-10">-q</span><a
- id="dx1-18017"></a> (quiet) switch doesn’t
-work as well.
-</p><!--l. 3236--><p class="indent" > You can specify in which directory the <span
-class="cmtt-10">aux</span><a
- id="dx1-18018"></a>, <span
-class="cmtt-10">glo</span><a
- id="dx1-18019"></a> etc files are located using the <span
-class="cmtt-10">-d </span>switch. For
-example:
-</p><!--l. 3239--><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-18020"></a> assumes by default that <span
-class="cmtt-10">makeindex</span><a
- id="dx1-18021"></a>/<span
-class="cmtt-10">xindy</span><a
- id="dx1-18022"></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-18023"></a> ⟨<span
-class="cmti-10">path/to/makeindex</span>⟩ for <span
-class="cmtt-10">makeindex</span><a
- id="dx1-18024"></a> or <span
-class="cmtt-10">-x</span><a
- id="dx1-18025"></a>
-⟨<span
-class="cmti-10">path/to/xindy</span>⟩ for <span
-class="cmtt-10">xindy</span><a
- id="dx1-18026"></a>.
-
-
-</p><!--l. 3249--><p class="indent" > As from <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-18027"></a></a> v2.18, if you are using <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-18028"></a></a>, there’s a check for <span
-class="cmtt-10">makeindex</span><a
- id="dx1-18029"></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>
- <pre class="verbatim" id="verbatim-66">
-\documentclass{article}
-\usepackage{glossaries}
-\makeglossaries
-\newglossaryentry{sample}{name={sample},description={an example}}
-\begin{document}
-\gls{sample}, \gls[format=textbf]{sample}.
-\printglossaries
-\end{document}
-</pre>
-<!--l. 3265--><p class="nopar" > If you explicitly use <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-18030"></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-18031"></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-18032"></a></a> as <span
-class="cmtt-10">xindy</span><a
- id="dx1-18033"></a> won’t produce any warning and will simply discard
-duplicates.
-</p><!--l. 3274--><p class="indent" > For a complete list of options do <span
-class="cmtt-10">makeglossaries --help</span>.
-</p><!--l. 3276--><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-18034"></a></a>. The
-current version is 4.49. </div>
-</p><!--l. 3280--><p class="noindent" >
-</p><!--l. 3282--><p class="noindent" >
-</p>
-<!--l. 3282--><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:makeglossarieslua"></a>Using the makeglossaries-lite Lua Script</h4>
-<!--l. 3285--><p class="noindent" >The Lua alternative to the <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-19001"></a></a> Perl script requires a Lua interpreter, which should already be
-available if you have a modern TeX distribution that includes LuaTeX. 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-19002"></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-19003"></a></a> Perl script aren’t available here. (In particular the <span
-class="cmtt-10">-d</span><a
- id="dx1-19004"></a>
-option.)
-</p><!--l. 3295--><p class="indent" > <div class="important" title="Important Note"> Note that TeX 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-19005"></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. 3301--><p class="noindent" >
-</p><!--l. 3303--><p class="indent" > The <a
-href="#glo:makeglossaries-lite.lua"><span
-class="cmtt-10">makeglossaries-lite</span><a
- id="dx1-19006"></a></a> script can be invoked in the same way as <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-19007"></a></a>. For example, if your
-document is called <span
-class="cmtt-10">myDoc.tex</span>, then do
-</p><!--l. 3306--><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. 3310--><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. 3314--><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-19008"></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-19009"></a></a> script. For a complete list of available options, do
-</p><!--l. 3317--><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. 3323--><p class="noindent" >
-</p>
-<!--l. 3323--><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:xindyapp"></a>Using <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span></a> explicitly (Option 3)</h4>
-<!--l. 3326--><p class="noindent" ><a
-href="#glo:xindy"><span
-class="cmtt-10">Xindy</span><a
- id="dx1-20001"></a></a> comes with TeX Live. It has also been added to MikTeX, 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/" >TeX on StackExchange</a>.
-</p><!--l. 3332--><p class="indent" > If you want to use <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-20002"></a></a> to process the glossary files, you must make sure you have used the <span
-class="cmss-10">xindy</span><a
- id="dx1-20003"></a> package
-option:
-
-
-</p>
- <pre class="verbatim" id="verbatim-67">
-\usepackage[xindy]{glossaries}
-</pre>
-<!--l. 3337--><p class="nopar" > This is required regardless of whether you use <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-20004"></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-20005"></a></a>. This causes the glossary entries to be written in raw <span
-class="cmtt-10">xindy</span><a
- id="dx1-20006"></a> format, so you need to use
-<span
-class="cmtt-10">-I</span><a
- id="dx1-20007"></a> <span
-class="cmtt-10">xindy </span><span
-class="cmti-10">not </span><span
-class="cmtt-10">-I</span><a
- id="dx1-20008"></a> <span
-class="cmtt-10">tex</span>.
-</p><!--l. 3344--><p class="indent" > To run <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-20009"></a></a> type the following in your terminal (all on one line):
-</p><!--l. 3346--><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
- id="dx1-20010"></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-20011"></a></a> style file without the <span
-class="cmtt-10">xdy</span><a
- id="dx1-20012"></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-20013"></a> but can be changed via <span
-class="cmtt-10">\setStyleFile</span><a
- id="dx1-20014"></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. 3359--><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. 3362--><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. 3366--><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-20015"></a> package option), substituting <span
-class="cmtt-10">glg</span><a
- id="dx1-20016"></a>, <span
-class="cmtt-10">gls</span><a
- id="dx1-20017"></a> and <span
-class="cmtt-10">glo</span><a
- id="dx1-20018"></a>
-with the relevant extensions. For example, if you have used the <span
-class="cmss-10">acronym</span><a
- id="dx1-20019"></a> package option, then you would need to
-do:
-</p><!--l. 3373--><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">\newglossary</span><a
- id="dx1-20020"></a>.
-</p><!--l. 3379--><p class="indent" > Note that if you use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-20021"></a></a> instead, you can replace all those calls to <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-20022"></a></a> with just one call to
-<span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-20023"></a>:
-</p><!--l. 3382--><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-20024"></a></a> explicitly instead of using
-<span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-20025"></a>. These are listed in <a
-href="#tab:makeglossariesCmds">table <span
-class="cmbx-10">1.3</span></a>.
-
-
-</p><!--l. 3392--><p class="noindent" >
-</p>
-<!--l. 3392--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.5.4 </span> <a
- id="sec:makeindexapp"></a>Using <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span></a> explicitly (Option 2)</h4>
-<!--l. 3395--><p class="noindent" >If you want to use <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-21001"></a></a> explicitly, you must make sure that you haven’t used the <span
-class="cmss-10">xindy</span><a
- id="dx1-21002"></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-21003"></a>, type the following in your
-terminal:
-</p><!--l. 3400--><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
- id="dx1-21004"></a> extension and ⟨<span
-class="cmti-10">style</span>⟩<span
-class="cmtt-10">ist</span><a
- id="dx1-21005"></a> is the name of the
-<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-21006"></a></a> style file. By default, this is ⟨<span
-class="cmti-10">base</span>⟩<span
-class="cmtt-10">ist</span><a
- id="dx1-21007"></a>, but may be changed via <span
-class="cmtt-10">\setStyleFile</span><a
- id="dx1-21008"></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">-l</span><a
- id="dx1-21009"></a> (letter ordering). See the <span
-class="cmtt-10">makeindex</span><a
- id="dx1-21010"></a> manual for further
-details.
-</p><!--l. 3411--><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. 3413--><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-21011"></a> package option) then you must call <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-21012"></a></a> for each glossary, substituting <span
-class="cmtt-10">glg</span><a
- id="dx1-21013"></a>, <span
-class="cmtt-10">gls</span><a
- id="dx1-21014"></a> and <span
-class="cmtt-10">glo</span><a
- id="dx1-21015"></a> with
-the relevant extensions. For example, if you have used the <span
-class="cmss-10">acronym</span><a
- id="dx1-21016"></a> package option, then you need to type the
-following in your terminal:
-</p><!--l. 3424--><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-21017"></a>.
-</p><!--l. 3430--><p class="indent" > Note that if you use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-21018"></a></a> instead, you can replace all those calls to <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-21019"></a></a> with just one call
-to <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-21020"></a>:
-</p><!--l. 3433--><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-21021"></a> explicitly instead of
-using <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-21022"></a></a>. These are listed in <a
-href="#tab:makeglossariesCmds">table <span
-class="cmbx-10">1.3</span></a>.
-</p><!--l. 3441--><p class="noindent" >
-</p>
-<!--l. 3441--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1.6 </span> <a
- id="sec:notedev"></a>Note to Front-End and Script Developers</h3>
-<!--l. 3444--><p class="noindent" >The information needed to determine whether to use <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-22001"></a></a>, <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-22002"></a></a> or <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-22003"></a></a> is stored in the <span
-class="cmtt-10">aux</span><a
- id="dx1-22004"></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. 3450--><p class="noindent" >
-</p>
-<!--l. 3450--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.6.1 </span> <a
- id="makeindexandxindy"></a>MakeIndex and Xindy</h4>
-<!--l. 3453--><p class="noindent" >The file extensions used by each defined (but not ignored) glossary are given by
-</p><!--l. 3454--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-23001"></a> <span
-class="cmtt-10">\@newglossary{</span>⟨<span
-class="cmitt-10">label</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-class="cmitt-10">log</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-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. 3456--><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">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. This isn’t required with <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-23002"></a></a>, but with <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-23003"></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>
- <pre class="verbatim" id="verbatim-68">
-\@newglossary{main}{glg}{gls}{glo}
-</pre>
-<!--l. 3470--><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="textcolor181"><span
-class="cmtt-10">\glsxtr at makeglossaries</span></span><a
- id="dx1-23004"></a><span
-class="cmtt-10">{</span>⟨<span
-class="cmitt-10">list</span>⟩<span
-class="cmtt-10">}</span>
-</div>
-</div>
-<!--l. 3478--><p class="indent" > The <a
-href="#glo:indexingapp">indexing application’s</a> style file is specified by
-</p><!--l. 3479--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-23005"></a> <span
-class="cmtt-10">\@istfilename{</span>⟨<span
-class="cmitt-10">filename</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 3481--><p class="noindent" >
-The file extension indicates whether to use <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-23006"></a></a> (<span
-class="cmtt-10">ist</span><a
- id="dx1-23007"></a>) or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-23008"></a></a> (<span
-class="cmtt-10">xdy</span><a
- id="dx1-23009"></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. 3488--><p class="indent" > For example, with <span
-class="cmtt-10">arara</span><a
- id="dx1-23010"></a> you can easily determine whether to run <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-23011"></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-23012"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-23013"></a></a>
-<!--l. 3495--><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-23014"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-23015"></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-23016"></a></a> also provides. </div>
-</p><!--l. 3500--><p class="noindent" >
-</p><!--l. 3502--><p class="indent" > Word or letter ordering is specified by:
-</p><!--l. 3503--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-23017"></a> <span
-class="cmtt-10">\@glsorder{</span>⟨<span
-class="cmitt-10">order</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 3505--><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. 3508--><p class="indent" > If <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-23018"></a></a> should be used, the language and code page for each glossary is specified by
-</p><!--l. 3510--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-23019"></a><a
- id="dx1-23020"></a> <span
-class="cmtt-10">\@xdylanguage{</span>⟨<span
-class="cmitt-10">label</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-class="cmitt-10">language</span>⟩<span
-class="cmtt-10">}</span><br
-class="newline" /><span
-class="cmtt-10">\@gls at codepage{</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. 3513--><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="cmtt-10">utf8</span>). These commands are omitted if <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-23021"></a></a> should be used.
-</p><!--l. 3519--><p class="indent" > If <a
-href="#option1">Option 1</a> has been used, the <span
-class="cmtt-10">aux</span><a
- id="dx1-23022"></a> file will contain
-</p><!--l. 3520--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-23023"></a> <span
-class="cmtt-10">\@gls at reference{</span>⟨<span
-class="cmitt-10">type</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-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. 3522--><p class="noindent" >
-for every time an entry has been referenced.
-
-
-</p><!--l. 3525--><p class="noindent" >
-</p>
-<!--l. 3525--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.6.2 </span> <a
- id="entrylabels"></a>Entry Labels</h4>
-<!--l. 3528--><p class="noindent" >If you need to gather labels for auto-completion, the <span
-class="cmss-10">writeglslabels</span><a
- id="dx1-24001"></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). As from
-v4.47, there is a similar option <span
-class="cmss-10">writeglslabelnames</span><a
- id="dx1-24002"></a> that writes both the label and name (separated by a
-tab).
-</p><!--l. 3535--><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 also provides <span id="textcolor182"><span
-class="cmss-10">docdef</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">atom</span></span><a
- id="dx1-24003"></a>, which will create the <span
-class="cmtt-10">glsdefs</span><a
- id="dx1-24004"></a> file but will act like
-<span id="textcolor183"><span
-class="cmss-10">docdef</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">restricted</span></span><a
- id="dx1-24005"></a>. </div>
-</p><!--l. 3539--><p class="noindent" >
-</p><!--l. 3541--><p class="noindent" >
-</p>
-<!--l. 3541--><p class="noindent" ><a
-href="#top">Top</a><h4 class="subsectionHead"></p><h4 class="subsectionHead"><span class="titlemark">1.6.3 </span> <a
- id="bib2gls"></a>Bib2Gls</h4>
-<!--l. 3544--><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-25001"></a></a></span>If <a
-href="#option4">Option 4</a> has been used, the <span
-class="cmtt-10">aux</span><a
- id="dx1-25002"></a> file will contain one or more instances of </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor184"><span
-class="cmtt-10">\glsxtr at resource</span></span><a
- id="dx1-25003"></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>
-</div> where ⟨<span
-class="cmti-10">basename</span>⟩ is the basename of the <span
-class="cmtt-10">glstex</span><a
- id="dx1-25004"></a> file that needs to be created by <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-25005"></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-25006"></a>
-file.
-<!--l. 3554--><p class="indent" > For example, with <span
-class="cmtt-10">arara</span><a
- id="dx1-25007"></a> you can easily determine whether or not to run <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-25008"></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 at resource")</span>
-</div>
-</div> (It gets more complicated if both <span id="textcolor185"><span
-class="cmtt-10">\glsxtr at resource</span></span><a
- id="dx1-25009"></a> and <span
-class="cmtt-10">\@istfilename </span>are present as that indicates the
-hybrid <span id="textcolor186"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">hybrid</span></span><a
- id="dx1-25010"></a> option.)
-<!--l. 3563--><p class="indent" > Remember that with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-25011"></a></a>, the entries will never be defined on the first LaTeX call (because their
-definitions are contained in the <span
-class="cmtt-10">glstex</span><a
- id="dx1-25012"></a> file created by <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-25013"></a></a>). You can also pick up labels from the records in
-<span
-class="cmtt-10">aux</span><a
- id="dx1-25014"></a> file, which will be in the form: </p><div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor187"><span
-class="cmtt-10">\glsxtr at record</span></span><a
- id="dx1-25015"></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="textcolor188"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">nameref</span></span><a
- id="dx1-25016"></a>) <div class="alltt">
-
-
-<div class="obeylines-v">
-<span id="textcolor189"><span
-class="cmtt-10">\glsxtr at record@nameref</span></span><a
- id="dx1-25017"></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="textcolor190"><span
-class="cmtt-10">\glsxtr at recordsee</span></span><a
- id="dx1-25018"></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="textcolor191"><span
-class="cmtt-10">\glsxtrnewglslike</span></span><a
- id="dx1-25019"></a>, which are added to the <span
-class="cmtt-10">aux</span><a
- id="dx1-25020"></a> file for
-<a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-25021"></a>’s</a> benefit: <div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor192"><span
-class="cmtt-10">\@glsxtr at newglslike</span></span><a
- id="dx1-25022"></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="textcolor193"><span
-class="cmtt-10">\GlsXtrSetAltModifier</span></span><a
- id="dx1-25023"></a> is used, then the modifier is identified with: <div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor194"><span
-class="cmtt-10">\@glsxtr at altmodifier</span></span><a
- id="dx1-25024"></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="textcolor195"><span
-class="cmtt-10">\dgls</span></span><a
- id="dx1-25025"></a> set of commands) are identified with: <div class="alltt">
-<div class="obeylines-v">
-<span id="textcolor196"><span
-class="cmtt-10">\@glsxtr at prefixlabellist</span></span><a
- id="dx1-25026"></a><span
-class="cmtt-10">{</span>⟨<span
-class="cmitt-10">list</span>⟩<span
-class="cmtt-10">}</span>
-</div>
-</div>
-
-
-<!--l. 3596--><p class="indent" > </div>
-</p><!--l. 3596--><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. 3599--><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-26001"></a> is equivalent to <span
-class="cmss-10">acronym</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-26002"></a>).
-</p><!--l. 3603--><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. 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. 3610--><p class="noindent" >
-</p><!--l. 3612--><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>⟩ part may be omitted, such as <span
-class="cmss-10">acronym</span><a
- id="dx1-26003"></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-26004"></a>) may be passed via the document class
-options. </div>
-</p><!--l. 3619--><p class="noindent" >
-</p>
-<!--l. 3621--><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>
-<!--l. 3624--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-280002.1"></a><a
- id="pkgopt:nowarn"></a><span
-class="cmss-10">nowarn</span></h4>
-<!--l. 3624--><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-28001"></a>). Note that if you use <span
-class="cmss-10">debug</span><a
- id="dx1-28002"></a> with any value other than <span
-class="cmss-10">false </span>it will override this
-option.
-</p><!--l. 3631--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-290002.1"></a><a
- id="pkgopt:nolangwarn"></a><span
-class="cmss-10">nolangwarn</span></h4>
-<!--l. 3631--><p class="noindent" >This suppresses the warning generated by a missing language module.
-</p><!--l. 3634--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-300002.1"></a><a
- id="pkgopt:noredefwarn"></a><span
-class="cmss-10">noredefwarn</span></h4>
-<!--l. 3634--><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-30001"></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. 3644--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-310002.1"></a><a
- id="pkgopt:debug"></a><span
-class="cmss-10">debug=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 3644--><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-31001"></a>. The following values are available: <span
-class="cmss-10">false</span>, <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-31002"></a> is assumed.
-</p><!--l. 3650--><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="textcolor197"><span
-class="cmss-10">showwrgloss</span></span><a
- id="dx1-31003"></a>, that may be used to show where the indexing
-is occurring, and <span id="textcolor198"><span
-class="cmss-10">all</span></span><a
- id="dx1-31004"></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. 3656--><p class="noindent" >
-</p><!--l. 3658--><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-31005"></a> switch on the debug mode (and will automatically cancel the <span
-class="cmss-10">nowarn</span><a
- id="dx1-31006"></a>
-option). The <span
-class="cmss-10">debug</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">showtargets</span><a
- id="dx1-31007"></a> option will additionally use:
-</p><!--l. 3661--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-31008"></a> <span
-class="cmtt-10">\glsshowtarget{</span>⟨<span
-class="cmitt-10">target name</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 3663--><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>. 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. 3669--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-31009"></a> <span
-class="cmtt-10">\glsshowtargetouter{</span>⟨<span
-class="cmitt-10">label</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 3671--><p class="noindent" >
-which by default places the target name in the margin. The font is given by:
-</p><!--l. 3674--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-31010"></a> <span
-class="cmtt-10">\glsshowtargetfont </span></div><hr>
-</p><!--l. 3676--><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>
- <pre class="verbatim" id="verbatim-69">
-\renewcommand*{\glsshowtargetouter}[1]{%
- {\glsshowtargetfont [#1]}}
-</pre>
-<!--l. 3684--><p class="nopar" >
-</p><!--l. 3686--><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-31011"></a> will add the accessibility support information using:
-</p><!--l. 3688--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-31012"></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. 3690--><p class="noindent" >
-This internally uses <span
-class="cmtt-10">\glsshowtarget</span><a
- id="dx1-31013"></a>. This option is provided for use with <span
-class="cmss-10">glossaries-accsupp</span><a
- id="dx1-31014"></a>.
-</p><!--l. 3694--><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-31015"></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-31016"></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>
-</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">\makeglossaries</span><a
- id="dx1-31017"></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. 3715--><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. 3718--><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, 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. 3728--><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-31018"></a> key as that’s a more
-common problem. See below.)
-</p><!--l. 3733--><p class="indent" > The debug mode, enabled with the <span
-class="cmss-10">debug</span><a
- id="dx1-31019"></a> option,
-
-
-</p>
- <pre class="verbatim" id="verbatim-70">
-\usepackage[debug]{glossaries}
-</pre>
-<!--l. 3736--><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><blockquote class="quote">
- <!--l. 3741--><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 number</span>⟩.</p></blockquote>
-<!--l. 3744--><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="cmss-10">debug</span><a
- id="dx1-31020"></a> option and see if any information has been written to the log
-file.
-</p><!--l. 3751--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-320002.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. 3751--><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-32001"></a>. With Options <a
-href="#option2">2</a> and <a
-href="#option3">3</a>, one write register is required per (non-ignored) glossary and one for the
-style file.
-</p><!--l. 3757--><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-32002"></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-32003"></a> file). If you really need document definitions
-but you want to minimise the number of write registers then consider using <span id="textcolor199"><span
-class="cmss-10">docdef</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">restricted</span></span><a
- id="dx1-32004"></a> with
-<a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>.
-</p><!--l. 3766--><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-32005"></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. 3774--><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-32006"></a></a> will be incorrect on page boundaries due to TeX’s asynchronous output routine. As an
-alternative, you can use the <span
-class="cmss-10">scrwfile</span><a
- id="dx1-32007"></a> package (part of the KOMA-Script bundle) and not use this option.
-</div>
-</p><!--l. 3780--><p class="noindent" >
-</p><!--l. 3782--><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-32008"></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-32009f1"></a>
-With <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-32011"></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. 3792--><p class="indent" > <span class="warningsymbol">⚠</span> If you want to use TeX’s <span
-class="cmtt-10">\write18</span><a
- id="dx1-32012"></a> mechanism to call <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-32013"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-32014"></a></a> from your document and use
-<span
-class="cmss-10">savewrites</span><a
- id="dx1-32015"></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-32016"></a>/<span
-class="cmtt-10">xindy</span><a
- id="dx1-32017"></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>
- <pre class="verbatim" id="verbatim-71">
-\glswritefiles
-\write18{makeindex -s \istfilename\space
--t \jobname.glg -o \jobname.gls \jobname}
-\let\glswritefiles\relax
-</pre>
-<!--l. 3804--><p class="nopar" >
-</p><!--l. 3806--><p class="noindent" >In general, this package option is best avoided.
-</p><!--l. 3809--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-330002.1"></a><a
- id="pkgopt:translate"></a><span
-class="cmss-10">translate=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 3809--><p class="noindent" >This can take the following values:
- </p><dl class="description"><dt class="description">
- <!--l. 3812--><p class="noindent" >
-<span
-class="cmssbx-10">true</span><a
- id="dx1-33001"></a> </p></dt><dd
-class="description">
- <!--l. 3812--><p class="noindent" >If <span
-class="cmss-10">babel</span><a
- id="dx1-33002"></a> has been loaded and the <span
-class="cmss-10">translator</span><a
- id="dx1-33003"></a> package is installed, <span
-class="cmss-10">translator</span><a
- id="dx1-33004"></a> will be loaded and the
- translations will be provided by the <span
-class="cmss-10">translator</span><a
- id="dx1-33005"></a> package interface. You can modify the translations
- by providing your own dictionary. If the <span
-class="cmss-10">translator</span><a
- id="dx1-33006"></a> package isn’t installed and <span
-class="cmss-10">babel</span><a
- id="dx1-33007"></a> is loaded,
- the <span
-class="cmss-10">glossaries-babel</span><a
- id="dx1-33008"></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="cmss-10">polyglossia</span><a
- id="dx1-33009"></a> has been loaded, <span
-class="cmss-10">glossaries-polyglossia</span><a
- id="dx1-33010"></a> will be
- loaded.
- </p></dd><dt class="description">
- <!--l. 3824--><p class="noindent" >
-<span
-class="cmssbx-10">false</span><a
- id="dx1-33011"></a> </p></dt><dd
-class="description">
- <!--l. 3824--><p class="noindent" >Don’t provide translations, even if <span
-class="cmss-10">babel</span><a
- id="dx1-33012"></a> or <span
-class="cmss-10">polyglossia</span><a
- id="dx1-33013"></a> has been loaded. (Note that <span
-class="cmss-10">babel</span><a
- id="dx1-33014"></a> provides
- the command <span
-class="cmtt-10">\glossaryname</span><a
- id="dx1-33015"></a> so that will still be translated if you have loaded <span
-class="cmss-10">babel</span><a
- id="dx1-33016"></a>.)
- </p></dd><dt class="description">
- <!--l. 3829--><p class="noindent" >
-<span
-class="cmssbx-10">babel</span><a
- id="dx1-33017"></a> </p></dt><dd
-class="description">
- <!--l. 3829--><p class="noindent" >Don’t load the <span
-class="cmss-10">translator</span><a
- id="dx1-33018"></a> package. Instead load <span
-class="cmss-10">glossaries-babel</span><a
- id="dx1-33019"></a>.
- </p><!--l. 3832--><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-33020"></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-33021"></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-33022"></a>.
- </div>
- </p><!--l. 3837--><p class="noindent" >
-
-
-</p>
- </dd></dl>
-<!--l. 3841--><p class="indent" > If <span
-class="cmss-10">translate</span><a
- id="dx1-33023"></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-33024"></a> is assumed. If <span
-class="cmss-10">translate</span><a
- id="dx1-33025"></a> isn’t specified,
-<span
-class="cmss-10">translate</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-33026"></a> is assumed if <span
-class="cmss-10">babel</span><a
- id="dx1-33027"></a>, <span
-class="cmss-10">polyglossia</span><a
- id="dx1-33028"></a> or <span
-class="cmss-10">translator</span><a
- id="dx1-33029"></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-33030"></a> is
-assumed.
-</p><!--l. 3847--><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-33031"></a> is detected then <span
-class="cmss-10">translate</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">babel</span><a
- id="dx1-33032"></a> is automatically passed to the base <span
-class="cmss-10">glossaries</span><a
- id="dx1-33033"></a>
-package. </div>
-</p><!--l. 3851--><p class="noindent" >
-</p><!--l. 3853--><p class="indent" > See <a
-href="#sec:fixednames">§<span
-class="cmbx-10">1.4.1</span> </a><a
-href="#sec:fixednames">Changing the Fixed Names<!--tex4ht:ref: sec:fixednames --></a> for further details.
-</p><!--l. 3855--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-340002.1"></a><a
- id="pkgopt:notranslate"></a><span
-class="cmss-10">notranslate</span></h4>
-<!--l. 3855--><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-34001"></a> and may be passed via the document class options.
-</p><!--l. 3859--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-350002.1"></a><a
- id="pkgopt:hyperfirst"></a><span
-class="cmss-10">hyperfirst=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 3859--><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-35001"></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-35002"></a> or by identifying the glossary with <span
-class="cmss-10">nohypertypes</span><a
- id="dx1-35003"></a>, described above). Note that
-<span
-class="cmss-10">nohypertypes</span><a
- id="dx1-35004"></a> overrides <span
-class="cmss-10">hyperfirst</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-35005"></a>. This option only affects commands that check the <a
-href="#glo:firstuseflag">first use flag</a>, such as
-the <a
-href="#x1-1310005.1.1"><span
-class="cmtt-10">\gls</span>-like</a> commands (for example, <span
-class="cmtt-10">\gls</span><a
- id="dx1-35006"></a> or <span
-class="cmtt-10">\glsdisp</span><a
- id="dx1-35007"></a>), but not the <a
-href="#x1-1320005.1.2"><span
-class="cmtt-10">\glstext</span>-like</a> commands (for example,
-<span
-class="cmtt-10">\glslink</span><a
- id="dx1-35008"></a> or <span
-class="cmtt-10">\glstext</span><a
- id="dx1-35009"></a>).
-</p><!--l. 3871--><p class="indent" > The <span
-class="cmss-10">hyperfirst</span><a
- id="dx1-35010"></a> setting applies to all glossary types (unless identified by <span
-class="cmss-10">nohypertypes</span><a
- id="dx1-35011"></a> or defined
-with <span
-class="cmtt-10">\newignoredglossary</span><a
- id="dx1-35012"></a>). It can be overridden on an individual basis by explicitly setting the
-<span
-class="cmtt-10">hyper</span><a
- id="dx1-35013"></a> key when referencing an entry (or by using the plus or starred version of the referencing
-command).
-</p><!--l. 3878--><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-35014"></a> and apply <span
-class="cmtt-10">\glsunsetall </span>to all the regular (non-acronym) glossaries. For
-example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-72">
- \usepackage[acronym,hyperfirst=false]{glossaries}
- % acronym and glossary entry definitions
- % at the end of the preamble
- \glsunsetall[main]
-</pre>
-<!--l. 3890--><p class="nopar" >
-</p><!--l. 3892--><p class="indent" > Alternatively you can redefine the hook
-</p><!--l. 3893--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-35015"></a> <span
-class="cmtt-10">\glslinkcheckfirsthyperhook </span></div><hr>
-</p><!--l. 3895--><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-35016"></a>. Within the definition of this
-command, you can use <span
-class="cmtt-10">\glslabel</span><a
- id="dx1-35017"></a> to reference the entry label and <span
-class="cmtt-10">\glstype</span><a
- id="dx1-35018"></a> to reference the glossary type. You
-can also use <span
-class="cmtt-10">\ifglsused</span><a
- id="dx1-35019"></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-35020"></a> key set using <span
-class="cmtt-10">\ifglshaslong</span><a
- id="dx1-35021"></a>. For example, to switch off the hyperlink on first use
-just for acronyms:
-
-
-</p>
- <pre class="verbatim" id="verbatim-73">
-\renewcommand*{\glslinkcheckfirsthyperhook}{%
- \ifglsused{\glslabel}{}%
- {%
-   \ifglshaslong{\glslabel}{\setkeys{glslink}{hyper=false}}{}%
- }%
+</pre> The result is slightly different from the previous examples. Letter groups aren’t created by default with <a id="wrglossary.709"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> so, even though the <a id="wrglossary.710"></a><a href="#glo:idx.glossarystyle">glossary style</a> supports <a id="wrglossary.711"></a><a href="#glo:idx.group">letter groups</a>, there’s no <a id="wrglossary.712"></a><a href="#glo:idx.group">group</a> information. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.713"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:b2g"></a>Example 6: Simple document that uses <span class="appfmt">bib2gls</span> to sort entries <a href="glossaries-user-examples/glossaries-user-example006.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example006.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example006.png" type="image/png" width="391" height="151">Example document that defines some entries, references a subset of them in the document and displays a sorted list of the referenced entries: alpha, ARPANET, duck, parrot and puffin. There are no letter groups.</object> </div><!-- end of resultbox -->
+<p>
+All entries must be provided in one or more <a id="wrglossary.714"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> files. (See the <a id="wrglossary.715"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> user manual for the required format.) In this example, the terms <span class="qt">“parrot”</span>, <span class="qt">“duck”</span>, <span class="qt">“puffin”</span> and <span class="qt">“penguin”</span> are defined using <code class="code">@atentry</code>, the symbol alpha (\(𝛼\)) is defined using <code class="code">@symbol</code> and the <a id="wrglossary.716"></a><a href="#glo:idx.abbreviation"><span class="xtrfmt">abbreviation</span></a> <span class="qt">“ARPANET”</span> is defined using <code class="code">@abbreviation</code>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.717"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Note that the <a id="wrglossary.718"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key should not be used. Each entry type (<code class="code">@entry</code>, <code class="code">@symbol</code>, <code class="code">@abbreviation</code>) has a particular field that’s used for the sort value by default (<a id="wrglossary.719"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a>, the label, <a id="wrglossary.720"></a><a href="#glo:opt.gloskey.short"><span class="csoptfmt">short</span></a>). You will break this mechanism if you explicitly use the <a id="wrglossary.721"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key. See <a href="https://www.dickimaw-books.com/gallery/index.php?label=label=bib2gls-sorting"><span class="appfmt">bib2gls</span> gallery: sorting</a> for examples. </div><!-- end of important -->
+<p>
+The <a id="wrglossary.722"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package needs to be loaded with the <a id="wrglossary.723"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a> package option: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.724"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.725"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a>]{glossaries-extra}
+</pre> or (equivalently) <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.726"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.727"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=only</span>]{glossaries-extra}
+</pre> or (with <a id="wrglossary.728"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.37+ and <a id="wrglossary.729"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> v1.8+): <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.730"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.731"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=nameref</span>]{glossaries-extra}
+</pre> The <a id="wrglossary.732"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=nameref</span> option is the best method if you are using <a id="wrglossary.733"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a>.<p>
+Each resource set is loaded with <a id="wrglossary.734"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.735"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.736"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>
+[<span class="comment">% definitions in entries1.bib and entries2.bib:</span>
+ <a id="wrglossary.737"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={entries1,entries2}</span>,
+ <a id="wrglossary.738"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">={de-CH-1996}</span><span class="comment">% sort according to this locale</span>
+]
+</pre> The <a id="wrglossary.739"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> files are identified as a comma-separated list in the value of the <a id="wrglossary.740"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a> key. The <a id="wrglossary.741"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></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 <a id="wrglossary.742"></a><a href="#glo:dual.glossary">glossaries</a> or one <a id="wrglossary.743"></a><a href="#glo:dual.glossary">glossary</a> may be split across multiple resource sets, forming logical sub-blocks.<p>
+If you want to ensure that all entries are selected, even if they haven’t been referenced in the document, then add the option <a id="wrglossary.744"></a><a href="#glo:opt.resource.selection"><span class="xtrcsoptfmt">selection</span></a><span class="optfmt">=all</span>. (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 id="wrglossary.745"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> user manual for further details.)<p>
+The <a id="wrglossary.746"></a><a href="#glo:dual.glossary">glossary</a> is displayed using: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.747"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.748"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a>
+</pre> Alternatively all glossaries can be displayed using the iterative command: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.749"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.750"></a><a href="#glo:printunsrtglossaries"><code class="xtrcsfmt">\printunsrtglossaries</code></a>
+</pre> The document is built using: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.751"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+bib2gls myDoc
+pdflatex myDoc
+</pre> If <a id="wrglossary.752"></a><a href="#glo:idx.group">letter groups</a> are required, you need the <a id="wrglossary.753"></a><a href="#glo:switch.group"><span class="longargfmt">--group</span></a> switch: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.754"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>bib2gls <a id="wrglossary.755"></a><a href="#glo:switch.group"><span class="longargfmt">--group</span></a> myDoc
+</pre> or with <a id="wrglossary.756"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.757"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: bib2gls: { group: on }
+</pre> (You will also need an appropriate <a id="wrglossary.758"></a><a href="#glo:idx.glossarystyle">glossary style</a>.)<p>
+Unlike Options <a href="#glo:idx.opt.mkidx">2</a> and <a href="#glo:idx.opt.xdy">3</a>, this method doesn’t create a file containing the typeset <a id="wrglossary.759"></a><a href="#glo:dual.glossary">glossary</a> but simply determines which entries are needed for the document, their associated locations and (if required) their associated <a id="wrglossary.760"></a><a href="#glo:idx.group">letter group</a>. 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 <a id="wrglossary.761"></a><a href="#glo:dual.glossary">glossary</a> differently to another block in the same <a id="wrglossary.762"></a><a href="#glo:dual.glossary">glossary</a>. See <a href="https://www.dickimaw-books.com/gallery/index.php?label=label=bib2gls-sorting"><span class="appfmt">bib2gls</span> gallery: sorting</a>.<p>
+This method supports Unicode and uses the Common Locale Data Repository, which provides more extensive language support than <a id="wrglossary.763"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. (Except for Klingon, which is supported by <a id="wrglossary.764"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>, but not by the CLDR.) The locations in the <a id="wrglossary.765"></a><a href="#glo:locationlist">number list</a> may be in any format. If <a id="wrglossary.766"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> can deduce a numerical value it will attempt to form <a id="wrglossary.767"></a><a href="#glo:idx.range">ranges</a> otherwise it will simply list the <a id="wrglossary.768"></a><a href="#glo:@@glslabel at entrylocation">locations</a>.<p>
+Summary:
+<ol class="displaylist">
+ <li><span class="numitem">1.</span>Use <a id="wrglossary.769"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> with the <a id="wrglossary.770"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a> package option: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.771"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.772"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a>]{glossaries-extra}
+</pre><p>
+<li><span class="numitem">2.</span>Use <a id="wrglossary.773"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a> to identify the <a id="wrglossary.774"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> file(s) and <a id="wrglossary.775"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> options. The <a id="wrglossary.776"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> extension may be omitted: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.777"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.778"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>[<a id="wrglossary.779"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={terms.bib,abbreviations.bib}</span>,<a id="wrglossary.780"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">=en</span>]
+</pre><p>
+<li><span class="numitem">3.</span>Put <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.781"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.782"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a>
+</pre> where you want your list of entries to appear. Alternatively to display all glossaries use the iterative command: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.783"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.784"></a><a href="#glo:printunsrtglossaries"><code class="xtrcsfmt">\printunsrtglossaries</code></a>
+</pre><p>
+<li><span class="numitem">4.</span>Run LaTeX on your document.<p>
+<li><span class="numitem">5.</span>Run <a id="wrglossary.785"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> with just the document base name.<p>
+<li><span class="numitem">6.</span>Run LaTeX on your document.<p>
+
+</ol>
+<p>
+See <a href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf"><span class="styfmt">glossaries-extra</span> and <span class="appfmt">bib2gls</span>: An Introductory Guide</a> or the <a id="wrglossary.786"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></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>.<p>
+
+</section><!-- end of section option4 -->
+
+<section id="option5"><!-- start of section option5 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.5. <a id="wrglossary.787"></a><dfn id="glo:idx.opt.unsrt">Option 5 (<span class="qt">“unsrt”</span>)</dfn><div class="labellink"><a href="#option5">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<div class="sidenote"><a id="wrglossary.788"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+This option is only available with the extension package <a id="wrglossary.789"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>. No <a id="wrglossary.790"></a><a href="#glo:dual.indexingapp">indexing application</a> is required. <p>
+Example document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.791"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.792"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.793"></a><a href="#glo:opt.glostyle.indexgroup"><span class="glostylefmt">indexgroup</span></a></span>]{glossaries-extra}
+<a id="wrglossary.794"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{parrot}{<a id="wrglossary.795"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={parrot}</span>,
+ <a id="wrglossary.796"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a brightly coloured tropical bird}</span>}
+<a id="wrglossary.797"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{duck}{<a id="wrglossary.798"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={duck}</span>,
+ <a id="wrglossary.799"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a waterbird}</span>}
+<a id="wrglossary.800"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{puffin}{<a id="wrglossary.801"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={puffin}</span>,
+ <a id="wrglossary.802"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a seabird with a brightly coloured bill}</span>}
+<a id="wrglossary.803"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{penguin}{<a id="wrglossary.804"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={penguin}</span>,
+ <a id="wrglossary.805"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a flightless black and white seabird}</span>}
+<span class="comment">% a symbol:</span>
+<a id="wrglossary.806"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.807"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.808"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.809"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+ <a id="wrglossary.810"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a variable}</span>}
+<span class="comment">% an <a id="wrglossary.811"></a><a href="#glo:idx.abbreviation"><span class="xtrfmt">abbreviation</span></a>:</span>
+<a id="wrglossary.812"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>{<a id="wrglossary.813"></a><a href="#glo:opt.abbrstyle.short-long"><span class="abbrstylefmt">short-long</span></a>}
+<a id="wrglossary.814"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a>{arpanet}{ARPANET}{Advanced Research Projects Agency Network}
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.815"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>{puffin}, <a id="wrglossary.816"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{duck} and <a id="wrglossary.817"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{parrot}.
+<a id="wrglossary.818"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet} and <a id="wrglossary.819"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{alpha}.
+Next use: <a id="wrglossary.820"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{arpanet}.
+<strong class="strong"><a id="wrglossary.821"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a></strong>
+<code class="cend">\end{document}</code>
+</pre> You can place all your entry definitions in a separate file and load it in the <a id="wrglossary.822"></a><a href="#glo:idx.documentpreamble">preamble</a> with <a id="wrglossary.823"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a>. There’s no <span class="qt">“activation”</span> command (such as <a id="wrglossary.824"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> for Options <a href="#glo:idx.opt.mkidx">2</a> and <a href="#glo:idx.opt.xdy">3</a>). <p>
+The result is different from the previous examples. Now all entries are listed in the <a id="wrglossary.825"></a><a href="#glo:dual.glossary">glossary</a>, including <span class="qt">“penguin”</span> which hasn’t been referenced in the document, and the list is in the order that the entries were defined. There are no <a id="wrglossary.826"></a><a href="#glo:locationlist">number lists</a>. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.827"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:unsrt"></a>Example 7: Simple document with an unsorted list of all defined entries <a href="glossaries-user-examples/glossaries-user-example007.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example007.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example007.png" type="image/png" width="391" height="293">Example document that defines some entries, references a subset of them in the document and displays an unsorted list of the defined entries: parrot, duck, puffin, penguin, alpha and ARPANET. There are four letter groups with a repeated letter: P, D, P, A.</object> </div><!-- end of resultbox -->
+ Note that the letter groups are fragmented because the list isn’t in alphabetical order, so there are two <span class="qt">“P”</span> letter groups.<p>
+The <a id="wrglossary.828"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a> command simply iterates over the set of all defined entries associated with the given <a id="wrglossary.829"></a><a href="#glo:dual.glossary">glossary</a> and lists them in the order of definition. This means that child entries must be defined immediately after their parent entry if they must be kept together in the glossary. Some <a id="wrglossary.830"></a><a href="#glo:idx.glossarystyle">glossary styles</a> indent entries that have a parent but it’s the <a id="wrglossary.831"></a><a href="#glo:dual.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.<p>
+The <a id="wrglossary.832"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package requires entries to be defined in the <a id="wrglossary.833"></a><a href="#glo:idx.documentpreamble">preamble</a> by default. It’s possible to remove this restriction, but bear in mind that any entries defined after <a id="wrglossary.834"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a> won’t be listed.<p>
+The <a id="wrglossary.835"></a><a href="#glo:dual.glossary">glossary</a> is displayed using: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.836"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.837"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a>
+</pre> Alternatively all glossaries can be displayed using the iterative command: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.838"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.839"></a><a href="#glo:printunsrtglossaries"><code class="xtrcsfmt">\printunsrtglossaries</code></a>
+</pre><p>
+This method will display <span style="font-style: italic; font-variant: normal; ">all</span> defined entries, regardless of whether or not they have been used in the document. Note that this uses the same command for displaying the <a id="wrglossary.840"></a><a href="#glo:dual.glossary">glossary</a> as <a id="wrglossary.841"></a><a href="#glo:idx.opt.b2g">Option 4</a>. This is because <a id="wrglossary.842"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> takes advantage of this method by defining the wanted entries in the required order and setting the locations (and <a id="wrglossary.843"></a><a href="#glo:idx.group">letter group</a> information, if required). See the <a id="wrglossary.844"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> manual for further details.<p>
+Therefore, the above example document has a glossary containing the entries: parrot, duck, puffin, penguin, \(𝛼\) and ARPANET (in that order). Note that the <span class="qt">“penguin”</span> entry has been included even though it wasn’t referenced in the document.<p>
+This just requires a single LaTeX call: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.845"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+</pre> unless the glossary needs to appear in the table of contents, in which case a second run is required: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.846"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+pdflatex myDoc
+</pre> (Naturally if the document also contains citations, and so on, then additional steps are required. Similarly for all the other options above.)<p>
+See the <a id="wrglossary.847"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> documentation for further details of this method.<p>
+
+</section><!-- end of section option5 -->
+
+<section id="option6"><!-- start of section option6 --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.3.6. <a id="wrglossary.848"></a><dfn id="glo:idx.opt.standalone">Option 6 (<span class="qt">“standalone”</span>)</dfn><div class="labellink"><a href="#option6">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<div class="sidenote"><a id="wrglossary.849"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+This option is only available with the <a id="wrglossary.850"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package. (You can just use the base <a id="wrglossary.851"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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 <code class="code"><a id="wrglossary.852"></a><a href="#glo:glsentryname"><code class="csfmt">\glsentryname</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code> or <code class="code"><a id="wrglossary.853"></a><a href="#glo:Glsentryname"><code class="csfmt">\Glsentryname</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code> 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.<p>
+You can either define entries in the <a id="wrglossary.854"></a><a href="#glo:idx.documentpreamble">preamble</a> (or in an external file loaded with <a id="wrglossary.855"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a>), as with <a id="wrglossary.856"></a><a href="#glo:idx.opt.unsrt">Option 5</a>, for example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.857"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+
+<code class="cmd">\usepackage</code>[colorlinks]{hyperref}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.858"></a><a href="#glo:opt.sort"><span class="styoptfmt">sort</span></a><span class="optfmt">=none</span>,
+ <a id="wrglossary.859"></a><a href="#glo:opt.nostyles"><span class="styoptfmt">nostyles</span></a><span class="comment">% <- no glossary styles are required</span>
+ ]{glossaries-extra}
+
+<a id="wrglossary.860"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{set}{<a id="wrglossary.861"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={set}</span>,
+ <a id="wrglossary.862"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a collection of any kind of objects}</span>,
+ <a id="wrglossary.863"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.864"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<code class="cmd">\mathcal</code>{S}}}</span>
}
-</pre>
-<!--l. 3911--><p class="nopar" >
-</p><!--l. 3913--><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-35022"></a>. (You can, instead, redefine <span
-class="cmtt-10">\glslinkpostsetkeys</span><a
- id="dx1-35023"></a>, which is used by both the <a
-href="#x1-1310005.1.1"><span
-class="cmtt-10">\gls</span>-like</a> and
-<a
-href="#x1-1320005.1.2"><span
-class="cmtt-10">\glstext</span>-like</a> commands.)
-</p><!--l. 3918--><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="textcolor200"><span
-class="cmss-10">nohyperfirst</span></span><a
- id="dx1-35024"></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">nohyperfirst</span><a
- id="dx1-35025"></a> package option.) See the <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> manual for further
-details.
-</p><!--l. 3927--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-360002.1"></a><a
- id="pkgopt:writeglslabels"></a><span
-class="cmss-10">writeglslabels</span></h4>
-<!--l. 3927--><p class="noindent" >This is a valueless option that will create a file called <span
-class="cmtt-10">\jobname.glslabels</span><a
- id="dx1-36001"></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-36002"></a>. If you also want the name, use
-<span
-class="cmss-10">writeglslabelnames</span><a
- id="dx1-36003"></a>. (See also <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span>’s</a> <span id="textcolor201"><span
-class="cmss-10">docdef</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">atom</span></span><a
- id="dx1-36004"></a> package option.)
-</p><!--l. 3936--><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-36005"></a></a> the file will only contain the entries that <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-36006"></a></a> has selected from the <span
-class="cmtt-10">bib</span><a
- id="dx1-36007"></a> files.
-</div>
-</p><!--l. 3939--><p class="noindent" >
-</p><!--l. 3941--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-370002.1"></a><a
- id="pkgopt:writeglslabelnames"></a><span
-class="cmss-10">writeglslabelnames</span></h4>
-<!--l. 3941--><p class="noindent" >Similar to the above but writes both the label and name (separated by a tab).
-</p><!--l. 3944--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-380002.1"></a><span id="textcolor202"><a
- id="pkgopt:undefaction"></a><span id="textcolor203"><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. 3946--><p class="noindent" >The value may be one of:
-
-
- </p><dl class="description"><dt class="description">
- <!--l. 3948--><p class="noindent" >
-<span
-class="cmssbx-10">error</span> </p></dt><dd
-class="description">
- <!--l. 3948--><p class="noindent" >generate an error if a referenced entry is undefined (default, and the only available setting with
- just <span
-class="cmss-10">glossaries</span>);
- </p></dd><dt class="description">
- <!--l. 3951--><p class="noindent" >
-<span
-class="cmssbx-10">warn</span> </p></dt><dd
-class="description">
- <!--l. 3951--><p class="noindent" >only warn if a referenced entry is undefined (automatically activated with <a
-href="#option4">Option 4</a>).</p></dd></dl>
-<!--l. 3955--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-390002.1"></a><span id="textcolor204"><a
- id="pkgopt:docdef"></a><span id="textcolor205"><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. 3957--><p class="noindent" >This option governs the use of <span
-class="cmtt-10">\newglossaryentry</span>. Available values:
- </p><dl class="description"><dt class="description">
- <!--l. 3960--><p class="noindent" >
-<span
-class="cmssbx-10">false</span> </p></dt><dd
-class="description">
- <!--l. 3960--><p class="noindent" ><span
-class="cmtt-10">\newglossaryentry </span>is not permitted in the <span
-class="cmss-10">document</span><a
- id="dx1-39001"></a><a
- id="dx1-39002"></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);
- </p></dd><dt class="description">
- <!--l. 3964--><p class="noindent" >
-<span
-class="cmssbx-10">restricted</span> </p></dt><dd
-class="description">
- <!--l. 3964--><p class="noindent" ><span
-class="cmtt-10">\newglossaryentry </span>is only permitted in the <span
-class="cmss-10">document</span><a
- id="dx1-39003"></a><a
- id="dx1-39004"></a> environment if it occurs before
- <span
-class="cmtt-10">\printglossary </span>(not available for some indexing options);
- </p></dd><dt class="description">
- <!--l. 3968--><p class="noindent" >
-<span
-class="cmssbx-10">atom</span> </p></dt><dd
-class="description">
- <!--l. 3968--><p class="noindent" >as <span
-class="cmss-10">restricted </span>but creates the <span
-class="cmtt-10">docdefs</span><a
- id="dx1-39005"></a> file for use by <span
-class="cmtt-10">atom</span><a
- id="dx1-39006"></a> (without the limitations of <span id="textcolor206"><span
-class="cmss-10">docdef</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span></span><a
- id="dx1-39007"></a>);
- </p></dd><dt class="description">
- <!--l. 3972--><p class="noindent" >
-<span
-class="cmssbx-10">true</span> </p></dt><dd
-class="description">
- <!--l. 3972--><p class="noindent" ><span
-class="cmtt-10">\newglossaryentry </span>is permitted in the <span
-class="cmss-10">document</span><a
- id="dx1-39008"></a><a
- id="dx1-39009"></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-39010"></a> file if <span
-class="cmtt-10">\newglossaryentry</span>
- is found in the <span
-class="cmss-10">document</span><a
- id="dx1-39011"></a><a
- id="dx1-39012"></a> environment.</p></dd></dl>
-
-
-<!--l. 3979--><p class="noindent" >
-</p>
-<!--l. 3979--><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>
-<!--l. 3982--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-410002.2"></a><a
- id="pkgopt:toc"></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. 3982--><p class="noindent" >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
-</p><!--l. 3985--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-41001"></a> <span
-class="cmtt-10">\glstoctrue </span></div><hr>
-</p><!--l. 3987--><p class="noindent" >
-and
-</p><!--l. 3989--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-41002"></a> <span
-class="cmtt-10">\glstocfalse </span></div><hr>
-</p><!--l. 3991--><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-41003"></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-41004"></a> for <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>.
-</p><!--l. 3996--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-420002.2"></a><a
- id="pkgopt:numberline"></a><span
-class="cmss-10">numberline=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 3996--><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-42001"></a> option, this will add <span
-class="cmtt-10">\numberline</span><a
- id="dx1-42002"></a><span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">{}</span></span></span> in the final argument of
-<span
-class="cmtt-10">\addcontentsline</span><a
- id="dx1-42003"></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-42004"></a> option is omitted. If <span
-class="cmss-10">toc</span><a
- id="dx1-42005"></a> is used without <span
-class="cmss-10">numberline</span><a
- id="dx1-42006"></a>, the title will be aligned with
-the section numbers rather than the section titles.
-</p><!--l. 4005--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-430002.2"></a><a
- id="pkgopt:section"></a><span
-class="cmss-10">section=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4007--><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. 4012--><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-43001"></a> option.
-</p><!--l. 4016--><p class="indent" > Example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-74">
-\usepackage[section=subsection]{glossaries}
-</pre>
-<!--l. 4019--><p class="nopar" > You can omit the value if you want to use <span
-class="cmtt-10">\section</span>, i.e. 
-
-
-</p>
- <pre class="verbatim" id="verbatim-75">
-\usepackage[section]{glossaries}
-</pre>
-<!--l. 4023--><p class="nopar" > is equivalent to
-
-
-</p>
- <pre class="verbatim" id="verbatim-76">
-\usepackage[section=section]{glossaries}
-</pre>
-<!--l. 4027--><p class="nopar" > You can change this value later in the document using
-</p><!--l. 4029--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-43002"></a> <span
-class="cmtt-10">\setglossarysection{</span>⟨<span
-class="cmitt-10">name</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 4031--><p class="noindent" >
-where ⟨<span
-class="cmti-10">name</span>⟩ is the sectional unit.
-</p><!--l. 4034--><p class="indent" > The start of each glossary adds information to the page header via
-</p><!--l. 4035--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-43003"></a> <span
-class="cmtt-10">\glsglossarymark{</span>⟨<span
-class="cmitt-10">glossary title</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 4037--><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-43004f2"></a>
-but you may need to redefine it. For example, to only change the right header:
-
-
-</p>
- <pre class="verbatim" id="verbatim-77">
-\renewcommand{\glsglossarymark}[1]{\markright{#1}}
-</pre>
-<!--l. 4044--><p class="nopar" > or to prevent it from changing the headers:
-
-
-</p>
- <pre class="verbatim" id="verbatim-78">
-\renewcommand{\glsglossarymark}[1]{}
-</pre>
-<!--l. 4048--><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-43007"></a> option described
-below.
-</p><!--l. 4052--><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-43008"></a><span
-class="cmtt-10">\glsclearpage</span>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-79">
-\renewcommand*{\glsclearpage}{\clearpage}
-</pre>
-<!--l. 4058--><p class="nopar" >
-</p><!--l. 4060--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-440002.2"></a><a
- id="pkgopt:ucmark"></a><span
-class="cmss-10">ucmark=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4060--><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-44001"></a>, unless <span
-class="cmss-10">memoir</span><a
- id="dx1-44002"></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-44003"></a>.
-</p><!--l. 4064--><p class="indent" > If set, <span
-class="cmtt-10">\glsglossarymark</span><a
- id="dx1-44004"></a> uses
-<span
-class="cmtt-10">\MakeTextUppercase</span><a
- id="dx1-44005"></a><span class="footnote-mark"><a
-href="#fn3x2" id="fn3x2-bk"><sup class="textsuperscript">2.3</sup></a></span><a
- id="x1-44006f3"></a>.
-You can test whether this option has been set or not using
-</p><!--l. 4073--><p class="indent" > <hr><div title="Definition"><span
-class="cmtt-10">\ifglsucmark</span><a
- id="dx1-44011"></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. 4074--><p class="noindent" >
-For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-80">
-\renewcommand{\glsglossarymark}[1]{%
-  \ifglsucmark
-    \markright{\MakeTextUppercase{#1}}%
-  \else
-    \markright{#1}%
-  \fi}
-</pre>
-<!--l. 4083--><p class="nopar" > If <span
-class="cmss-10">memoir</span><a
- id="dx1-44012"></a> has been loaded and <span
-class="cmss-10">ucmark</span><a
- id="dx1-44013"></a> is set, then <span
-class="cmss-10">memoir</span><a
- id="dx1-44014"></a>’s <span
-class="cmtt-10">\memUChead</span><a
- id="dx1-44015"></a> is used.
-</p><!--l. 4087--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-450002.2"></a><a
- id="pkgopt:numberedsection"></a><span
-class="cmss-10">numberedsection=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4088--><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-45001"></a>. This option can take one of the following values: </p>
- <ul class="itemize1">
- <li class="itemize">
- <!--l. 4092--><p class="noindent" ><span
-class="cmss-10">false</span><a
- id="dx1-45002"></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>);
- </p></li>
- <li class="itemize">
- <!--l. 4095--><p class="noindent" ><span
-class="cmss-10">nolabel</span><a
- id="dx1-45003"></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;
- </p></li>
- <li class="itemize">
- <!--l. 4100--><p class="noindent" ><span
-class="cmss-10">autolabel</span><a
- id="dx1-45004"></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">\label</span><a
- id="dx1-45005"></a>). The label is formed
- from
- </p><!--l. 4104--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-45006"></a> <span
-class="cmtt-10">\glsautoprefix </span>⟨<span
-class="cmitt-10">type</span>⟩ </div><hr>
- </p><!--l. 4106--><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>
- <pre class="verbatim" id="verbatim-81">
- \usepackage[section,numberedsection=autolabel]
-   {glossaries}
-</pre>
- <!--l. 4114--><p class="nopar" > then each glossary will appear in a numbered section, and can be referenced using something
- like:
-
-
-</p>
- <pre class="verbatim" id="verbatim-82">
- The main glossary is in section~\ref{main} and
- the list of acronyms is in section~\ref{acronym}.
-</pre>
- <!--l. 4120--><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-45007"></a> which is set to <span
-class="cmtt-10">main </span>if the <span
-class="cmss-10">acronym</span><a
- id="dx1-45008"></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-45009"></a> option is used. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-83">
- The list of acronyms is in section~\ref{\acronymtype}.
-</pre>
- <!--l. 4128--><p class="nopar" > You can redefine the prefix if the default label clashes with another label in your document. For
- example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-84">
- \renewcommand*{\glsautoprefix}{glo:}
-</pre>
- <!--l. 4134--><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>
- <pre class="verbatim" id="verbatim-85">
- The list of acronyms is in
- section~\ref{glo:\acronymtype}.
-</pre>
- <!--l. 4140--><p class="nopar" > Or, if you are undecided on a prefix:
-
-
-</p>
- <pre class="verbatim" id="verbatim-86">
- The list of acronyms is in
- section~\ref{\glsautoprefix\acronymtype}.
-</pre>
- <!--l. 4145--><p class="nopar" >
- </p></li>
- <li class="itemize">
- <!--l. 4147--><p class="noindent" ><span
-class="cmss-10">nameref</span><a
- id="dx1-45010"></a>: this is like <span
-class="cmss-10">autolabel</span><a
- id="dx1-45011"></a> but uses an unnumbered sectioning command (e.g. <span
-class="cmtt-10">\chapter*</span><a
- id="dx1-45012"></a> or
- <span
-class="cmtt-10">\section*</span><a
- id="dx1-45013"></a>). It’s designed for use with the <span
-class="cmss-10">nameref</span><a
- id="dx1-45014"></a> package. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-87">
- \usepackage{nameref}
- \usepackage[numberedsection=nameref]{glossaries}
-</pre>
- <!--l. 4154--><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. 4160--><p class="noindent" >
-</p>
-<!--l. 4160--><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>
-<!--l. 4163--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-470002.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. 4163--><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-47001"></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-47002"></a>. (See <span
-class="cmtt-10">\glsentrynumberlist</span><a
- id="dx1-47003"></a> and <span
-class="cmtt-10">\glsdisplaynumberlist</span><a
- id="dx1-47004"></a> in <a
-href="#sec:glsnolink">§<span
-class="cmbx-10">5.2</span>
-</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. 4170--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you use the <span id="textcolor207"><span
-class="cmss-10">record</span></span><a
- id="dx1-47005"></a> option (with either no value or <span id="textcolor208"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">only</span></span><a
- id="dx1-47006"></a> or <span id="textcolor209"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">nameref</span></span><a
- id="dx1-47007"></a>) then this package option
-has no effect. With <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-47008"></a></a>, the <a
-href="#glo:numberlist">number list<a
- id="dx1-47009"></a>s</a> are automatically saved with the default <span id="textcolor210"><span
-class="cmtt-10">save-locations</span></span><span
-class="cmtt-10">=true</span><a
- id="dx1-47010"></a>
-and <span id="textcolor211"><span
-class="cmtt-10">save-loclist</span></span><span
-class="cmtt-10">=true</span><a
- id="dx1-47011"></a> resource settings. </div>
-</p><!--l. 4177--><p class="noindent" >
-</p><!--l. 4179--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-480002.3"></a><a
- id="pkgopt:entrycounter"></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. 4179--><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-48001"></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-48002"></a><a
- id="dx1-48003"></a><span
-class="cmss-10">glossaryentry</span>.
-</p><!--l. 4185--><p class="indent" > If you use this option, you can reference the entry number within the document using
-</p><!--l. 4187--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-48004"></a> <span
-class="cmtt-10">\glsrefentry{</span>⟨<span
-class="cmitt-10">label</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 4189--><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. 4193--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-48005"></a> <span
-class="cmtt-10">\GlsEntryCounterLabelPrefix </span></div><hr>
-</p><!--l. 4195--><p class="noindent" >
-(which defaults to <span
-class="cmtt-10">glsentry-</span>).
-
-
-</p><!--l. 4198--><p class="indent" > <div class="important" title="Important Note"> If you use <span
-class="cmtt-10">\glsrefentry</span>, you must run LaTeX twice after creating the glossary files using
-<a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-48006"></a></a>, <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-48007"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-48008"></a></a> to ensure the cross-references are up-to-date. </div>
-</p><!--l. 4203--><p class="noindent" >
-</p><!--l. 4205--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-490002.3"></a><a
- id="pkgopt:counterwithin"></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. 4205--><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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-49001"></a> and the <span
-class="cmss-10">glossaryentry</span><a
- id="dx1-49002"></a> counter will be reset every time ⟨<span
-class="cmti-10">value</span>⟩ is incremented.
-</p><!--l. 4212--><p class="indent" > <div class="important" title="Important Note"> The <span
-class="cmss-10">glossaryentry</span><a
- id="dx1-49003"></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-49004"></a> is the same as the counter used in the glossary’s
-sectioning command. </div>
-</p><!--l. 4217--><p class="noindent" >
-</p><!--l. 4219--><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-49005"></a>) to use
-</p><!--l. 4221--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-49006"></a> <span
-class="cmtt-10">\glsresetentrycounter </span></div><hr>
-</p><!--l. 4223--><p class="noindent" >
-which sets <span
-class="cmss-10">glossaryentry</span><a
- id="dx1-49007"></a> to zero:
-
-
-</p>
- <pre class="verbatim" id="verbatim-88">
-\renewcommand{\glossarypreamble}{%
-  \glsresetentrycounter
+
+<a id="wrglossary.865"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{function}{<a id="wrglossary.866"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={function}</span>,
+ <a id="wrglossary.867"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a rule that assigns every element in the domain <a id="wrglossary.868"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{set} to an element in the range <a id="wrglossary.869"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{set}}</span>,
+ <a id="wrglossary.870"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.871"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{f(x)}}</span>
}
-</pre>
-<!--l. 4229--><p class="nopar" > or if you are using <span
-class="cmtt-10">\setglossarypreamble</span><a
- id="dx1-49008"></a>, add it to each glossary preamble, as required. For
-example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-89">
-\setglossarypreamble[acronym]{%
-  \glsresetentrycounter
-  The preamble text here for the list of acronyms.
+<code class="cmd">\newcommand</code>*{<code class="cmd">\termdef</code>}[1]{<span class="comment">% </span>
+ <a id="wrglossary.872"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{<a id="wrglossary.873"></a><a href="#glo:glsxtrglossentry"><code class="csfmt">\glsxtrglossentry</code></a>{#1} <a id="wrglossary.874"></a><a href="#glo:glsentrysymbol"><code class="csfmt">\glsentrysymbol</code></a>{#1}}<span class="comment">% </span>
+ <code class="cbeg">\begin{quote}</code><code class="cmd">\em</code><a id="wrglossary.875"></a><a href="#glo:Glsentrydesc"><code class="csfmt">\Glsentrydesc</code></a>{#1}.<code class="cend">\end{quote}</code><span class="comment">% </span>
}
-\setglossarypreamble{%
-  \glsresetentrycounter
-  The preamble text here for the main glossary.
+<code class="cbeg">\begin{document}</code>
+<code class="cmd">\tableofcontents</code>
+
+<a id="wrglossary.876"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{Introduction}
+Sample document about <a id="wrglossary.877"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{function} and <a id="wrglossary.878"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{set}.
+
+<code class="cmd">\termdef</code>{set}
+
+More detailed information about <a id="wrglossary.879"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{set} with examples.
+
+<code class="cmd">\termdef</code>{function}
+
+More detailed information about <a id="wrglossary.880"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{function} with examples.
+
+<code class="cend">\end{document}</code>
+</pre> This allows the references to <a id="wrglossary.881"></a><a href="#glo:idx.hyperlink">hyperlink</a> to the standalone definitions rather than to a <a id="wrglossary.882"></a><a href="#glo:dual.glossary">glossary</a>. <div class="resultbox"><div class="resultboxtitle"><a id="wrglossary.883"></a><a href="#glo:sym.result"><span title="Result" class="icon">🖺</span></a></div><!-- end of resultboxtitle -->
+<a id="ex:standalone"></a>Example 8: Simple document with standalone entries <a href="glossaries-user-examples/glossaries-user-example008.tex" class="icon"><span title="Download TeX File" class="icon">📥<sup>🖹</sup></span></a> <a href="glossaries-user-examples/glossaries-user-example008.pdf" class="icon"><span title="Download PDF" class="icon">📥<sup>🖺</sup></span></a><p>
+<object data="glossaries-user-examples/glossaries-user-example008.png" type="image/png" width="388" height="362">Example document that defines entries and displays them in the document..</object> </div><!-- end of resultbox -->
+<p>
+Or you can use <a id="wrglossary.884"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> if you want to manage a large database of terms. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.885"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+
+<code class="cmd">\usepackage</code>[colorlinks]{hyperref}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.886"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a>,
+ <a id="wrglossary.887"></a><a href="#glo:opt.nostyles"><span class="styoptfmt">nostyles</span></a><span class="comment">% <- no glossary styles are required</span>
+ ]{glossaries-extra}
+
+<a id="wrglossary.888"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>[<a id="wrglossary.889"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={terms}</span>,<a id="wrglossary.890"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">=none</span>,<a id="wrglossary.891"></a><a href="#glo:opt.resource.save-locations"><span class="xtrcsoptfmt">save-locations</span></a><span class="optfmt">=false</span>]
+
+<code class="cmd">\newcommand</code>*{<code class="cmd">\termdef</code>}[1]{<span class="comment">% </span>
+ <a id="wrglossary.892"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{<a id="wrglossary.893"></a><a href="#glo:glsxtrglossentry"><code class="csfmt">\glsxtrglossentry</code></a>{#1} <strong class="strong"><a id="wrglossary.894"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a></strong>{#1}}<span class="comment">% </span>
+ <a id="wrglossary.895"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a>{#1}<span class="comment">% <- index this entry</span>
+ <code class="cbeg">\begin{quote}</code><code class="cmd">\em</code><a id="wrglossary.896"></a><a href="#glo:Glsentrydesc"><code class="csfmt">\Glsentrydesc</code></a>{#1}.<code class="cend">\end{quote}</code><span class="comment">% </span>
}
-</pre>
-<!--l. 4241--><p class="nopar" >
-</p><!--l. 4243--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-500002.3"></a><a
- id="pkgopt:subentrycounter"></a><span
-class="cmss-10">subentrycounter=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4243--><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-50001"></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-50002"></a><a
- id="dx1-50003"></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-50004"></a>. You can reference
-the number within the document using <span
-class="cmtt-10">\glsrefentry</span><a
- id="dx1-50005"></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.
-</p><!--l. 4254--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-510002.3"></a><a
- id="pkgopt:style"></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. 4254--><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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">list</span><a
- id="dx1-51001"></a>, unless <span
-class="cmss-10">classicthesis</span><a
- id="dx1-51002"></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-51003"></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-51004"></a>, <span
-class="cmss-10">glossary-long</span><a
- id="dx1-51005"></a>, <span
-class="cmss-10">glossary-super</span><a
- id="dx1-51006"></a> or <span
-class="cmss-10">glossary-tree</span><a
- id="dx1-51007"></a>. Alternatively, you can set the style
-using
-</p><!--l. 4262--><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. 4263--><p class="noindent" >
-(See <a
-href="#sec:styles">§<span
-class="cmbx-10">13</span> </a><a
-href="#sec:styles">Glossary Styles<!--tex4ht:ref: sec:styles --></a> for further details.)
-</p><!--l. 4266--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-520002.3"></a><a
- id="pkgopt:nolong"></a><span
-class="cmss-10">nolong</span></h4>
-<!--l. 4266--><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-52001"></a> (which means that the <span
-class="cmss-10">longtable</span><a
- id="dx1-52002"></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-52003"></a>).
-
-
-</p><!--l. 4274--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-530002.3"></a><a
- id="pkgopt:nosuper"></a><span
-class="cmss-10">nosuper</span></h4>
-<!--l. 4274--><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-53001"></a> (which means that the
-<span
-class="cmss-10">supertabular</span><a
- id="dx1-53002"></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-53003"></a>).
-</p><!--l. 4282--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-540002.3"></a><a
- id="pkgopt:nolist"></a><span
-class="cmss-10">nolist</span></h4>
-<!--l. 4282--><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-54001"></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-54002"></a>). Note that since the default style is <span
-class="cmss-10">list</span><a
- id="dx1-54003"></a>
-(unless <span
-class="cmss-10">classicthesis</span><a
- id="dx1-54004"></a> has been loaded), you will also need to use the <span
-class="cmss-10">style</span><a
- id="dx1-54005"></a> option to set the style to something
-else.
-</p><!--l. 4293--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-550002.3"></a><a
- id="pkgopt:notree"></a><span
-class="cmss-10">notree</span></h4>
-<!--l. 4293--><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-55001"></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-55002"></a>). Note that if <span
-class="cmss-10">classicthesis</span><a
- id="dx1-55003"></a> has been
-loaded, the default style is <span
-class="cmss-10">index</span><a
- id="dx1-55004"></a>, which is provided by <span
-class="cmss-10">glossary-tree</span><a
- id="dx1-55005"></a>.
-</p><!--l. 4302--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-560002.3"></a><a
- id="pkgopt:nostyles"></a><span
-class="cmss-10">nostyles</span></h4>
-<!--l. 4302--><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-56001"></a>). Also if you use this option, you can’t use the <span
-class="cmss-10">style</span><a
- id="dx1-56002"></a> package option. Instead
-you must either use <span
-class="cmtt-10">\setglossarystyle</span><a
- id="dx1-56003"></a><span
-class="cmtt-10">{</span>⟨<span
-class="cmti-10">style</span>⟩<span
-class="cmtt-10">} </span>or the <span
-class="cmtt-10">style</span><a
- id="dx1-56004"></a> key in the optional argument to <span
-class="cmtt-10">\printglossary</span><a
- id="dx1-56005"></a>.
-Example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-90">
-\usepackage[nostyles]{glossaries}
-\usepackage{glossary-mcols}
-\setglossarystyle{mcoltree}
-</pre>
-<!--l. 4313--><p class="nopar" >
-</p><!--l. 4315--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-570002.3"></a><a
- id="pkgopt:nonumberlist"></a><span
-class="cmss-10">nonumberlist</span></h4>
-<!--l. 4315--><p class="noindent" >This option will suppress the associated <a
-href="#glo:numberlist">number list<a
- id="dx1-57001"></a>s</a> in the glossaries (see also <a
-href="#sec:numberlists">§<span
-class="cmbx-10">12</span> </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-57002"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-57003"></a></a>) then the locations must still be valid. This
-package option merely prevents the <a
-href="#glo:numberlist">number list<a
- id="dx1-57004"></a></a> from being displayed, but both <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-57005"></a></a> and <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-57006"></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-57007"></a></a>
-includes any cross-references, so suppressing the <a
-href="#glo:numberlist">number list<a
- id="dx1-57008"></a></a> will also hide the cross-references (see
-below).
-</p><!--l. 4326--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-580002.3"></a><a
- id="pkgopt:seeautonumberlist"></a><span
-class="cmss-10">seeautonumberlist</span></h4>
-<!--l. 4326--><p class="noindent" >If you suppress the <a
-href="#glo:numberlist">number list<a
- id="dx1-58001"></a>s</a> with <span
-class="cmss-10">nonumberlist</span><a
- id="dx1-58002"></a>, described above, this will also suppress any
-cross-referencing information supplied by the <span
-class="cmtt-10">see</span><a
- id="dx1-58003"></a> key in <span
-class="cmtt-10">\newglossaryentry</span><a
- id="dx1-58004"></a> or <span
-class="cmtt-10">\glssee</span><a
- id="dx1-58005"></a>. If you
-use <span
-class="cmss-10">seeautonumberlist</span><a
- id="dx1-58006"></a>, the <span
-class="cmtt-10">see</span><a
- id="dx1-58007"></a> key will automatically implement <span
-class="cmtt-10">nonumberlist=false</span><a
- id="dx1-58008"></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="cmbx-10">11</span> </a><a
-href="#sec:crossref">Cross-Referencing
-Entries<!--tex4ht:ref: sec:crossref --></a>.
-</p><!--l. 4335--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-590002.3"></a><a
- id="pkgopt:counter"></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. 4335--><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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">page</span><a
- id="dx1-59001"></a>.) The value should be the name of the default counter to
-use in the <a
-href="#glo:numberlist">number list<a
- id="dx1-59002"></a>s</a> (see <a
-href="#sec:numberlists">§<span
-class="cmbx-10">12</span> </a><a
-href="#sec:numberlists">Number Lists<!--tex4ht:ref: sec:numberlists --></a>).
-</p><!--l. 4340--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-600002.3"></a><a
- id="pkgopt:nopostdot"></a><span
-class="cmss-10">nopostdot=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4340--><p class="noindent" >This is a boolean option. If no value is specified, <span
-class="cmss-10">true</span><a
- id="dx1-60001"></a> is assumed. When set to <span
-class="cmss-10">true</span><a
- id="dx1-60002"></a>, this option suppresses the
-default post description dot used by some of the predefined styles.
-
-
-</p><!--l. 4345--><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-60003"></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-60004"></a> for
-<a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a>.
-</p><!--l. 4349--><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="textcolor212"><span
-class="cmss-10">postdot</span></span><a
- id="dx1-60005"></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-60006"></a>, and also <span id="textcolor213"><span
-class="cmss-10">postpunc</span></span><a
- id="dx1-60007"></a>,
-which allows you to choose a different punctuation character. </div>
-</p><!--l. 4354--><p class="noindent" >
-</p><!--l. 4356--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-610002.3"></a><a
- id="pkgopt:nogroupskip"></a><span
-class="cmss-10">nogroupskip=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">boolean</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4356--><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-61001"></a>.
-</p><!--l. 4362--><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-61002"></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. 4367--><p class="noindent" >
-</p><!--l. 4369--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-620002.3"></a><span id="textcolor214"><a
- id="pkgopt:stylemods"></a><span id="textcolor215"><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. 4371--><p class="noindent" >Load the <span
-class="cmss-10">glossaries-extra-stylemods</span><a
- id="dx1-62001"></a> package, which patches 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. 4376--><p class="noindent" >
-</p>
-<!--l. 4376--><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. 4379--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-640002.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. 4379--><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-64001"></a> key
-automatically indexes the cross-referenced entry using <span
-class="cmtt-10">\glssee</span><a
- id="dx1-64002"></a>. 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-64003"></a> key is used before <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-64004"></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-64005"></a>) or ignore it (<span
-class="cmss-10">seenoindex</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">ignore</span><a
- id="dx1-64006"></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. 4393--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-650002.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. 4393--><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-65001"></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-65002"></a> changes it to <span
-class="cmss-10">esclocations</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">false</span><a
- id="dx1-65003"></a>. With <a
-href="#option4">Option 4</a> (<a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-65004"></a></a>), this setting is
-ignored.
-</p><!--l. 4399--><p class="indent" > Both <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-65005"></a></a> and <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-65006"></a></a> are fussy about the location formats (<a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-65007"></a></a> more so than <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-65008"></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 TeX’s asynchronous output routine, which can go wrong and also adds to the complexity of
-the document build.
-</p><!--l. 4408--><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-65009"></a> to
-avoid the complex escaping of location values. (See “Writing information to associated files” in the documented
-code for further details.)
-</p><!--l. 4416--><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-65010"></a> file so no syntax conversion is
-required.
-</p><!--l. 4419--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-660002.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. 4419--><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-66001"></a>, which will add a line to the file every time one of the <a
-href="#x1-1310005.1.1"><span
-class="cmtt-10">\gls</span>-like</a> or
-<a
-href="#x1-1320005.1.2"><span
-class="cmtt-10">\glstext</span>-like</a> commands are used. Note that <span
-class="cmtt-10">\glsadd</span><a
- id="dx1-66002"></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-66003f4"></a> (since
-that’s the purpose of that command).
-</p><!--l. 4428--><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-66004"></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. 4435--><p class="noindent" >
-</p><!--l. 4437--><p class="indent" > You can customise this by redefining
-</p><!--l. 4438--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-66005"></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. 4440--><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>
- <pre class="verbatim" id="verbatim-91">
-\newcommand*{\glswriteentry}[2]{%
-  \ifglsindexonlyfirst
-    \ifglsused{#1}{}{#2}%
-  \else
-    #2%
-  \fi
+<code class="cbeg">\begin{document}</code>
+<code class="cmd">\tableofcontents</code>
+
+<a id="wrglossary.897"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{Introduction}
+Sample document about <a id="wrglossary.898"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{function} and <a id="wrglossary.899"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{set}.
+
+<code class="cmd">\termdef</code>{set}
+
+More detailed information about <a id="wrglossary.900"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{set} with examples.
+
+<code class="cmd">\termdef</code>{function}
+
+More detailed information about <a id="wrglossary.901"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{function} with examples.
+<code class="cend">\end{document}</code>
+</pre> Where the file <span class="filefmt">terms.bib</span> contains: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.902"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="code">@entry</code>{set,
+ <a id="wrglossary.903"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={set}</span>,
+ <a id="wrglossary.904"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a collection of any kind of objects}</span>,
+ <a id="wrglossary.905"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.906"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<code class="cmd">\mathcal</code>{S}}}</span>
}
-</pre>
-<!--l. 4452--><p class="nopar" > This checks the <span
-class="cmss-10">indexonlyfirst</span><a
- id="dx1-66006"></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. 4458--><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>
- <pre class="verbatim" id="verbatim-92">
-\renewcommand*{\glswriteentry}[2]{%
- \ifthenelse{\equal{\glsentrytype{#1}}{acronym}}
- {\ifglsused{#1}{}{#2}}%
- {#2}%
+<code class="code">@entry</code>{function,
+ <a id="wrglossary.907"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={function}</span>,
+ <a id="wrglossary.908"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a rule that assigns every element in the domain <a id="wrglossary.909"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{set} to an element in the range <a id="wrglossary.910"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{set}}</span>,
+ <a id="wrglossary.911"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.912"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{f(x)}}</span>
}
-</pre>
-<!--l. 4467--><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. 4471--><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="textcolor216"><span
-class="cmss-10">indexonlyfirst</span></span><a
- id="dx1-66007"></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-66008"></a> package option.) See the
-<a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> manual for further details.
-</p><!--l. 4479--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-670002.4"></a><span id="textcolor217"><a
- id="pkgopt:indexcrossrefs"></a><span id="textcolor218"><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. 4481--><p class="noindent" >If <span
-class="cmss-10">true</span>, this will automatically index (<span
-class="cmtt-10">\glsadd</span><a
- id="dx1-67001"></a>) 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. 4486--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> Note that <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-67002"></a></a> can automatically find dependent entries when it parses the <span
-class="cmtt-10">bib</span><a
- id="dx1-67003"></a> file. Use the <span id="textcolor219">selection</span>
-option to <span id="textcolor220"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-67004"></a> to determine the selection of dependencies. </div>
-</p><!--l. 4491--><p class="noindent" >
-</p><!--l. 4493--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-680002.4"></a><span id="textcolor221"><a
- id="pkgopt:autoseeindex"></a><span id="textcolor222"><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. 4495--><p class="noindent" >If <span
-class="cmss-10">true</span>, makes the <span
-class="cmtt-10">see</span><a
- id="dx1-68001"></a> and <span id="textcolor223"><span id="textcolor224"><span
-class="cmtt-10">seealso</span></span><a
- id="dx1-68002"></a></span> keys automatically index the cross-reference (with <span
-class="cmtt-10">\glssee</span><a
- id="dx1-68003"></a>) when the entry
-is defined (default, and the only option with just the base <span
-class="cmss-10">glossaries </span>package).
-</p><!--l. 4500--><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-68004"></a></a>, use the <span id="textcolor225">selection</span> option to <span id="textcolor226"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-68005"></a> to determine the selection of
-dependencies. </div>
-</p><!--l. 4504--><p class="noindent" >
-</p><!--l. 4506--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-690002.4"></a><span id="textcolor227"><a
- id="pkgopt:record"></a><span id="textcolor228"><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. 4508--><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-69001"></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">
- <!--l. 4511--><p class="noindent" >
-<span
-class="cmssbx-10">off</span> </p></dt><dd
-class="description">
- <!--l. 4511--><p class="noindent" ><a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-69002"></a></a> isn’t being used;
- </p></dd><dt class="description">
- <!--l. 4513--><p class="noindent" >
-<span
-class="cmssbx-10">only</span> </p></dt><dd
-class="description">
- <!--l. 4513--><p class="noindent" ><a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-69003"></a></a> is being used to fetch entries from a <span
-class="cmtt-10">bib</span><a
- id="dx1-69004"></a> file, to sort the entries and collate the <a
-href="#glo:numberlist">number
- list<a
- id="dx1-69005"></a>s</a>, where the location information is the same as for Options <a
-href="#option1">1</a>–<a
-href="#option3">3</a>;
- </p></dd><dt class="description">
- <!--l. 4518--><p class="noindent" >
-<span
-class="cmssbx-10">nameref</span> </p></dt><dd
-class="description">
- <!--l. 4518--><p class="noindent" >like <span
-class="cmss-10">only </span>but provides extra information that allows the associated title to be used instead of the
- location number and provides better support for hyperlinked locations;
- </p></dd><dt class="description">
- <!--l. 4523--><p class="noindent" >
-<span
-class="cmssbx-10">hybrid</span> </p></dt><dd
-class="description">
- <!--l. 4523--><p class="noindent" >a hybrid approach where <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-69006"></a></a> is used to fetch entries from a <span
-class="cmtt-10">bib</span><a
- id="dx1-69007"></a> file but <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-69008"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-69009"></a></a>
- are used for the indexing. This requires a more complicated document build and isn’t recommended.</p></dd></dl>
-<!--l. 4528--><p class="noindent" >See <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> manual for further details.
-</p><!--l. 4530--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-700002.4"></a><span id="textcolor229"><a
- id="pkgopt:equations"></a><span id="textcolor230"><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. 4532--><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. 4536--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-710002.4"></a><span id="textcolor231"><a
- id="pkgopt:floats"></a><span id="textcolor232"><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. 4538--><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. 4544--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-720002.4"></a><span id="textcolor233"><a
- id="pkgopt:indexcounter"></a><span id="textcolor234"><span
-class="cmss-10">indexcounter</span></span> (glossaries-extra.sty)</span></h4>
-<!--l. 4546--><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-72001"></a></a> and <span
-class="cmss-10">hyperref</span><a
- id="dx1-72002"></a> allowing the page location
-hyperlink target to be set to the relevant point within 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. 4553--><p class="noindent" >
-</p>
-<!--l. 4553--><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>
-<!--l. 4556--><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-73001"></a> and <span
-class="cmss-10">order</span><a
- id="dx1-73002"></a> options are applicable for
-<a
-href="#option1">Option 1</a>.
-</p><!--l. 4559--><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-73003"></a> is applicable (and this is automatically implemented by
-<span id="textcolor235"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">only</span></span><a
- id="dx1-73004"></a> and <span id="textcolor236"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">nameref</span></span><a
- id="dx1-73005"></a>). With <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-73006"></a></a>, the sort method is provided in the optional argument of
-<span id="textcolor237"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-73007"></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. 4566--><p class="noindent" >
-</p><!--l. 4568--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-740002.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. 4568--><p class="noindent" >This is a boolean option that determines whether or not to <a
-href="#glo:sanitize">sanitize<a
- id="dx1-74001"></a></a> the sort value when writing to the external
-glossary file. For example, suppose you define an entry as follows:
-
-
-</p>
- <pre class="verbatim" id="verbatim-93">
-\newglossaryentry{hash}{name={\#},sort={#},
- description={hash symbol}}
-</pre>
-<!--l. 4575--><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 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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-94">
-\newcommand{\mysortvalue}{AAA}
-\newglossaryentry{sample}{%
-  name={sample},
-  sort={\mysortvalue},
-  description={an example}}
-</pre>
-<!--l. 4587--><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-74002"></a>.
-</p><!--l. 4592--><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-74003"></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-74004"></a>.
-</p><!--l. 4595--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-750002.5"></a><a
- id="pkgopt:sort"></a><span
-class="cmss-10">sort=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4595--><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="cmtt-10">sort</span><a
- id="dx1-75001"></a> key in the optional argument
-of <span
-class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-75002"></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-75003"></a> or <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">use</span><a
- id="dx1-75004"></a> if you want to set this sort method for <span
-class="cmti-10">all </span>your
-glossaries.
-</p><!--l. 4605--><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">
- <!--l. 4608--><p class="noindent" ><span
-class="cmss-10">standard</span><a
- id="dx1-75005"></a> : entries are sorted according to the value of the <span
-class="cmtt-10">sort</span><a
- id="dx1-75006"></a> key used in <span
-class="cmtt-10">\newglossaryentry</span><a
- id="dx1-75007"></a> (if
- present) or the <span
-class="cmtt-10">name</span><a
- id="dx1-75008"></a> key (if <span
-class="cmtt-10">sort</span><a
- id="dx1-75009"></a> key is missing);
- </p></li>
- <li class="itemize">
- <!--l. 4613--><p class="noindent" ><span
-class="cmss-10">def</span><a
- id="dx1-75010"></a> : entries are sorted in the order in which they were defined (the <span
-class="cmtt-10">sort</span><a
- id="dx1-75011"></a> key in <span
-class="cmtt-10">\newglossaryentry</span>
- is ignored);
- </p></li>
- <li class="itemize">
- <!--l. 4617--><p class="noindent" ><span
-class="cmss-10">use</span><a
- id="dx1-75012"></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-75013"></a>
- key in <span
-class="cmtt-10">\newglossaryentry </span>is ignored).
- </p><!--l. 4621--><p class="noindent" >Both <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">def</span><a
- id="dx1-75014"></a> and <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">use</span><a
- id="dx1-75015"></a> set the sort key to a six digit number via
- </p><!--l. 4623--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-75016"></a> <span
-class="cmtt-10">\glssortnumberfmt{</span>⟨<span
-class="cmitt-10">number</span>⟩<span
-class="cmtt-10">} </span></div><hr>
- </p><!--l. 4625--><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-75017"></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-75018"></a>).
-
-
- </p></li>
- <li class="itemize">
- <!--l. 4631--><p class="noindent" ><span
-class="cmss-10">none</span><a
- id="dx1-75019"></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.
- </p><!--l. 4638--><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">\printglossaries </span>or <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>).</p></li></ul>
-<!--l. 4644--><p class="noindent" >Note that the group styles (such as <span
-class="cmss-10">listgroup</span><a
- id="dx1-75020"></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-75021"></a> and <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">def</span><a
- id="dx1-75022"></a> options.
-</p><!--l. 4648--><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-75023"></a>. When the standard sort option is in use, you can hook into the sort mechanism
-by redefining:
-</p><!--l. 4651--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-75024"></a> <span
-class="cmtt-10">\glsprestandardsort{</span>⟨<span
-class="cmitt-10">sort cs</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-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. 4653--><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-75025"></a> key or implicitly set via the <span
-class="cmtt-10">name</span><a
- id="dx1-75026"></a> key) before any escaping of the <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-75027"></a></a>/<a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-75028"></a></a> special characters is
-performed. By default <span
-class="cmtt-10">\glsprestandardsort </span>just does:
-</p><!--l. 4659--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-75029"></a> <span
-class="cmtt-10">\glsdosanitizesort </span></div><hr>
-</p><!--l. 4661--><p class="noindent" >
-which <a
-href="#glo:sanitize">sanitize<a
- id="dx1-75030"></a>s</a> ⟨<span
-class="cmti-10">sort cs</span>⟩ if the <span
-class="cmss-10">sanitizesort</span><a
- id="dx1-75031"></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-75032"></a> is used).
-</p><!--l. 4666--><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">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="cmtt-10">\newglossaryentry</span><a
- id="dx1-75033"></a>.
-</p><!--l. 4671--><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-75034"></a> or <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">use</span><a
- id="dx1-75035"></a>. </div>
-</p><!--l. 4675--><p class="noindent" >
-<a
- id="x1-75036r1"></a>
-</p><!--l. 4677--><p class="noindent" ><span
-class="cmbx-12">Example 1</span><span
-class="cmbx-12"> (Mixing Alphabetical and Order of Definition Sorting)</span><a
- id="x1-75037"></a>
-</p><!--l. 4678--><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">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. 4684--><p class="indent" > For <a
-href="#option1">Option 1</a>, the <span
-class="cmtt-10">sort</span><a
- id="dx1-75038"></a> option can be used in <span
-class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-75039"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-95">
-\printnoidxglossary[sort=word]
-\printnoidxglossary[type=acronym,sort=word]
-\printnoidxglossary[type=notation,sort=def]
-</pre>
-<!--l. 4690--><p class="nopar" >
-</p><!--l. 4692--><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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">standard</span><a
- id="dx1-75040"></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="cmtt-10">\glsprestandardsort </span>to check for the glossary type and only modify ⟨<span
-class="cmti-10">sort cs</span>⟩ if
-⟨<span
-class="cmti-10">type</span>⟩ is <span
-class="cmtt-10">notation</span>.
-</p><!--l. 4702--><p class="indent" > The first option can be achieved as follows:
-
-
-</p>
- <pre class="verbatim" id="verbatim-96">
-\newcounter{sortcount}
-\renewcommand{\glsprestandardsort}[3]{%
-  \stepcounter{sortcount}%
-  \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
+</pre> The advantage in this approach (with <a id="wrglossary.913"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a> or <a id="wrglossary.914"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>) is that you can use an existing database of entries shared across multiple documents, ensuring consistent notation for all of them.<p>
+In both cases, there’s no need to load all the <a id="wrglossary.915"></a><a href="#glo:idx.glossarystyle">glossary styles</a> packages, as they’re not required, so I’ve used the <a id="wrglossary.916"></a><a href="#glo:opt.nostyles"><span class="styoptfmt">nostyles</span></a> package option to prevent them from being loaded.<p>
+In the first case, you just need to define the terms (preferably in the <a id="wrglossary.917"></a><a href="#glo:idx.documentpreamble">preamble</a> or in a file that’s input in the <a id="wrglossary.918"></a><a href="#glo:idx.documentpreamble">preamble</a>). No external tool is required. Just run LaTeX as normal. (Twice to ensure that the table of contents is up to date.) <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.919"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+pdflatex myDoc
+</pre><p>
+In the second case, you need the <a id="wrglossary.920"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a> package option (as in <a id="wrglossary.921"></a><a href="#glo:idx.opt.b2g">Option 4</a>) since <a id="wrglossary.922"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> is needed to select the required entries, but you don’t need a sorted list: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.923"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.924"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>[<a id="wrglossary.925"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={terms}</span>,<strong class="strong"><a id="wrglossary.926"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">=none</span></strong>]
+</pre> This will ensure that any entries <a id="wrglossary.927"></a><a href="#glo:@@glslabel at indexing">indexed</a> in the document (through commands like <a id="wrglossary.928"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> or <a id="wrglossary.929"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a>) will be selected by <a id="wrglossary.930"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>, but it will skip the sorting step. (The chances are you probably also won’t need <a id="wrglossary.931"></a><a href="#glo:dual.locationlist">location lists</a> either. If so, you can add the option <a id="wrglossary.932"></a><a href="#glo:opt.resource.save-locations"><span class="xtrcsoptfmt">save-locations</span></a><span class="optfmt">=false</span>.)<p>
+Remember that for this second case you need to run <a id="wrglossary.933"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> as per <a id="wrglossary.934"></a><a href="#glo:idx.opt.b2g">Option 4</a>: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.935"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+bib2gls myDoc
+pdflatex myDoc
+pdflatex myDoc
+</pre><p>
+For both cases (with or without <a id="wrglossary.936"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>), instead of listing all the entries using <a id="wrglossary.937"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a>, you use <code class="code"><a id="wrglossary.938"></a><a href="#glo:glsxtrglossentry"><code class="csfmt">\glsxtrglossentry</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code> where you want the name (and anchor with <a id="wrglossary.939"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a>) to appear in the document. This will allow the <a id="wrglossary.940"></a><a href="#glo:dual.linktext">link text</a> created by commands like <a id="wrglossary.941"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> to link to that point in the document. The description can simply be displayed with <code class="code"><a id="wrglossary.942"></a><a href="#glo:glsentrydesc"><code class="csfmt">\glsentrydesc</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code> or <code class="code"><a id="wrglossary.943"></a><a href="#glo:Glsentrydesc"><code class="csfmt">\Glsentrydesc</code></a>{label}</code>, as in the above examples. In both examples, I’ve defined a custom command <code class="csfmt">\termdef</code> 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>
+(Instead of using <a id="wrglossary.944"></a><a href="#glo:glsentrydesc"><code class="csfmt">\glsentrydesc</code></a> or <a id="wrglossary.945"></a><a href="#glo:Glsentrydesc"><code class="csfmt">\Glsentrydesc</code></a>, you can use <code class="code"><a id="wrglossary.946"></a><a href="#glo:glossentrydesc"><code class="csfmt">\glossentrydesc</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code>, which will obey <a id="wrglossary.947"></a><a href="#glo:idx.categoryattribute">category attributes</a> such as <a id="wrglossary.948"></a><a href="#glo:opt.catattr.glossdesc"><span class="csoptfmt">glossdesc</span></a> and <a id="wrglossary.949"></a><a href="#glo:opt.catattr.glossdescfont"><span class="csoptfmt">glossdescfont</span></a>. See the <a id="wrglossary.950"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> manual for further details.)<p>
+The symbol (if required) can be displayed with either <code class="code"><a id="wrglossary.951"></a><a href="#glo:glsentrysymbol"><code class="csfmt">\glsentrysymbol</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code> or <code class="code"><a id="wrglossary.952"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a>{<span class="meta">〈<em class="metainner">label</em>〉</span>}</code>. In the first example, I’ve used <a id="wrglossary.953"></a><a href="#glo:glsentrysymbol"><code class="csfmt">\glsentrysymbol</code></a>. In the second I’ve used <a id="wrglossary.954"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a>. The latter is necessary with <a id="wrglossary.955"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> if the symbol needs to go in a section title as the entries aren’t defined on the first LaTeX run.<p>
+In normal document text, <a id="wrglossary.956"></a><a href="#glo:glsentrysymbol"><code class="csfmt">\glsentrysymbol</code></a> 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 <a id="wrglossary.957"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file, which triggers an error. <p>
+The <a id="wrglossary.958"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a> command performs an existence check, which triggers a warning if the entry is undefined. (All entries will be undefined before the first <a id="wrglossary.959"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> call.) You need at least <a id="wrglossary.960"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.42 to use this command in a section title. (<a id="wrglossary.961"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a> is defined by the base <a id="wrglossary.962"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package but is redefined by <a id="wrglossary.963"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.) If <a id="wrglossary.964"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a> has been loaded, this will use <a id="wrglossary.965"></a><a href="#glo:texorpdfstring"><code class="csfmt">\texorpdfstring</code></a> to allow a simple expansion for the <a id="wrglossary.966"></a><a href="#glo:idx.PDFbookmark">PDF bookmarks</a> (see the <a id="wrglossary.967"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> user manual for further details).<p>
+If you want to test if the <a id="wrglossary.968"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a> field has been set, you need to use <a id="wrglossary.969"></a><a href="#glo:ifglshassymbol"><code class="csfmt">\ifglshassymbol</code></a> outside of the section title. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.970"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.971"></a><a href="#glo:ifglshassymbol"><code class="csfmt">\ifglshassymbol</code></a>{#1}<span class="comment">% </span>
+{<a id="wrglossary.972"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{<a id="wrglossary.973"></a><a href="#glo:glsxtrglossentry"><code class="csfmt">\glsxtrglossentry</code></a>{#1} <a id="wrglossary.974"></a><a href="#glo:glossentrysymbol"><code class="csfmt">\glossentrysymbol</code></a>{#1}}}
+{<a id="wrglossary.975"></a><a href="#glo:section"><code class="csfmt">\section</code></a>{<a id="wrglossary.976"></a><a href="#glo:glsxtrglossentry"><code class="csfmt">\glsxtrglossentry</code></a>{#1}}}
+</pre><p>
+In both of the above examples, the section titles start with a <a id="wrglossary.977"></a><a href="#glo:idx.lowercase">lowercase</a> character (because the <a id="wrglossary.978"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> value is all <a id="wrglossary.979"></a><a href="#glo:idx.lowercase">lowercase</a> in entry definitions). You can apply automatic <a id="wrglossary.980"></a><a href="#glo:dual.casechange">case change</a> with the <a id="wrglossary.981"></a><a href="#glo:opt.catattr.glossname"><span class="csoptfmt">glossname</span></a> <a id="wrglossary.982"></a><a href="#glo:idx.categoryattribute">category attribute</a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.983"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.984"></a><a href="#glo:glssetcategoryattribute"><code class="xtrcsfmt">\glssetcategoryattribute</code></a>{<a id="wrglossary.985"></a><a href="#glo:opt.cat.general"><span class="catfmt">general</span></a>}{<a id="wrglossary.986"></a><a href="#glo:opt.catattr.glossname"><span class="csoptfmt">glossname</span></a>}{firstuc}
+</pre> or (for title-case) <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.987"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.988"></a><a href="#glo:glssetcategoryattribute"><code class="xtrcsfmt">\glssetcategoryattribute</code></a>{<a id="wrglossary.989"></a><a href="#glo:opt.cat.general"><span class="catfmt">general</span></a>}{<a id="wrglossary.990"></a><a href="#glo:opt.catattr.glossname"><span class="csoptfmt">glossname</span></a>}{title}
+</pre> However, this won’t apply the <a id="wrglossary.991"></a><a href="#glo:dual.casechange">case change</a> in the table of contents or bookmarks. Instead you can use helper commands provided by <a id="wrglossary.992"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.49+ but make sure you have up-to-date versions of <a id="wrglossary.993"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> and <a id="wrglossary.994"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a>.<p>
+In the second example, you can instead use <a id="wrglossary.995"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> to apply a <a id="wrglossary.996"></a><a href="#glo:dual.casechange">case change</a>. For example, to apply <a id="wrglossary.997"></a><a href="#glo:idx.sentencecase">sentence case</a> to the <a id="wrglossary.998"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> field: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.999"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1000"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>[<a id="wrglossary.1001"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={terms}</span>,
+ <a id="wrglossary.1002"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">=none</span>,<a id="wrglossary.1003"></a><a href="#glo:opt.resource.save-locations"><span class="xtrcsoptfmt">save-locations</span></a><span class="optfmt">=false</span><strong class="strong">,
+ <a id="wrglossary.1004"></a><a href="#glo:opt.resource.replicate-fields"><span class="xtrcsoptfmt">replicate-fields</span></a><span class="optfmt">={name=text}</span>,
+ <a id="wrglossary.1005"></a><a href="#glo:opt.resource.name-case-change"><span class="xtrcsoptfmt">name-case-change</span></a><span class="optfmt">=firstuc</span></strong>
+]
+</pre> (Or <a id="wrglossary.1006"></a><a href="#glo:opt.resource.name-case-change"><span class="xtrcsoptfmt">name-case-change</span></a><span class="optfmt">=title</span> for <a id="wrglossary.1007"></a><a href="#glo:idx.titlecase">title case</a>.) This copies the <a id="wrglossary.1008"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> value to the <a id="wrglossary.1009"></a><a href="#glo:opt.gloskey.text"><span class="csoptfmt">text</span></a> field and then applies a <a id="wrglossary.1010"></a><a href="#glo:dual.casechange">case change</a> to the <a id="wrglossary.1011"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> field (leaving the <a id="wrglossary.1012"></a><a href="#glo:opt.gloskey.text"><span class="csoptfmt">text</span></a> field unchanged). The name in the section titles now starts with a capital but the <a id="wrglossary.1013"></a><a href="#glo:dual.linktext">link text</a> produced by commands like <a id="wrglossary.1014"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> is still <a id="wrglossary.1015"></a><a href="#glo:idx.lowercase">lowercase</a>.<p>
+In the first example (without <a id="wrglossary.1016"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>) you can do this manually. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1017"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1018"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{set}{<a id="wrglossary.1019"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<strong class="strong">S</strong>et}</span>,<strong class="strong"><a id="wrglossary.1020"></a><a href="#glo:opt.gloskey.text"><span class="csoptfmt">text</span></a><span class="optfmt">={set}</span></strong>,
+ <a id="wrglossary.1021"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={a collection of any kind of objects}</span>,
+ <a id="wrglossary.1022"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.1023"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<code class="cmd">\mathcal</code>{S}}}</span>
}
-</pre>
-<!--l. 4710--><p class="nopar" > The second option can be achieved as follows:
-
-
-</p>
- <pre class="verbatim" id="verbatim-97">
-\newcounter{sortcount}
-\renewcommand{\glsprestandardsort}[3]{%
-  \ifdefstring{#2}{notation}%
-  {%
-     \stepcounter{sortcount}%
-     \edef#1{\glssortnumberfmt{\arabic{sortcount}}}%
-  }%
-  {%
-     \glsdosanitizesort
-  }%
+</pre> A more automated solution can be obtained with the standalone helper commands for the <a id="wrglossary.1024"></a><a href="#glo:idx.PDFbookmark">PDF bookmark</a> and heading text (<a id="wrglossary.1025"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.49+).<p>
+Note that if you use the default <a id="wrglossary.1026"></a><a href="#glo:opt.resource.save-locations"><span class="xtrcsoptfmt">save-locations</span></a><span class="optfmt">=true</span> with <a id="wrglossary.1027"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>, it’s possible to combine Options <a href="#glo:idx.opt.b2g">4</a> and <a href="#glo:idx.opt.standalone">6</a> to have both standalone definitions and an index. In this case, a <a id="wrglossary.1028"></a><a href="#glo:idx.glossarystyle">glossary style</a> is required. In the example below, I’ve use <a id="wrglossary.1029"></a><a href="#glo:opt.glostyle.bookindex"><span class="xtrglostylefmt">bookindex</span></a>, which is provided in the <a id="wrglossary.1030"></a><a href="#glo:pkg.glossary-bookindex"><span class="styfmt">glossary-bookindex</span></a> package (bundled with <a id="wrglossary.1031"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>). I don’t need any of the other style packages, so I can still keep the <a id="wrglossary.1032"></a><a href="#glo:opt.nostyles"><span class="styoptfmt">nostyles</span></a> option and just load <a id="wrglossary.1033"></a><a href="#glo:pkg.glossary-bookindex"><span class="styfmt">glossary-bookindex</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1034"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.1035"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=nameref</span>,<span class="comment">% <- using <a id="wrglossary.1036"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a></span>
+ <a id="wrglossary.1037"></a><a href="#glo:opt.nostyles"><span class="styoptfmt">nostyles</span></a>,<span class="comment">% <- don't load default style packages</span>
+ <a id="wrglossary.1038"></a><a href="#glo:opt.stylemods"><span class="xtrstyoptfmt">stylemods</span></a><span class="optfmt">=bookindex</span>,<span class="comment">% <- load glossary-bookindex.sty</span>
+ <a id="wrglossary.1039"></a><a href="#glo:opt.style"><span class="styoptfmt">style</span></a><span class="optfmt">=<a id="wrglossary.1040"></a><a href="#glo:opt.glostyle.bookindex"><span class="xtrglostylefmt">bookindex</span></a></span><span class="comment">% <- set the default style to 'bookindex'</span>
+]{glossaries-extra}
+</pre> I also need to sort the entries, so the resource command is now: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1041"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1042"></a><a href="#glo:GlsXtrLoadResources"><code class="xtrcsfmt">\GlsXtrLoadResources</code></a>[<a id="wrglossary.1043"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={terms}</span>,<span class="comment">% definitions in terms.bib</span>
+ <a id="wrglossary.1044"></a><a href="#glo:opt.resource.sort"><span class="xtrcsoptfmt">sort</span></a><span class="optfmt">=en-GB</span>,<span class="comment">% sort by this locale</span>
+ <a id="wrglossary.1045"></a><a href="#glo:opt.resource.replicate-fields"><span class="xtrcsoptfmt">replicate-fields</span></a><span class="optfmt">={name=text}</span>,
+ <a id="wrglossary.1046"></a><a href="#glo:opt.resource.name-case-change"><span class="xtrcsoptfmt">name-case-change</span></a><span class="optfmt">=firstuc</span>
+]
+</pre> At the end of the document, I can add the <a id="wrglossary.1047"></a><a href="#glo:dual.glossary">glossary</a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1048"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1049"></a><a href="#glo:printunsrtglossary"><code class="xtrcsfmt">\printunsrtglossary</code></a>[<a id="wrglossary.1050"></a><a href="#glo:opt.printgloss.title"><span class="csoptfmt">title</span></a><span class="optfmt">=Index</span>,<a id="wrglossary.1051"></a><a href="#glo:opt.printgloss.target"><span class="xtrcsoptfmt">target</span></a><span class="optfmt">=false</span>]
+</pre> Note that I’ve had to switch off the hypertargets with <a id="wrglossary.1052"></a><a href="#glo:opt.printgloss.target"><span class="xtrcsoptfmt">target</span></a><span class="optfmt">=false</span> (otherwise there would be duplicate targets). If you want <a id="wrglossary.1053"></a><a href="#glo:idx.group">letter group</a> headings you need to use the <a id="wrglossary.1054"></a><a href="#glo:switch.group"><span class="longargfmt">--group</span></a> switch: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1055"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>bib2gls <a id="wrglossary.1056"></a><a href="#glo:switch.group"><span class="longargfmt">--group</span></a> myDoc
+</pre> or if you are using <a id="wrglossary.1057"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1058"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: bib2gls: { group: on }
+</pre><p>
+The <a id="wrglossary.1059"></a><a href="#glo:opt.glostyle.bookindex"><span class="xtrglostylefmt">bookindex</span></a> style doesn’t show the description, so only the name and location is displayed. Remember that the name has had a <a id="wrglossary.1060"></a><a href="#glo:dual.casechange">case change</a> so it now starts with an initial capital. If you feel this is inappropriate for the index, you can adjust the <a id="wrglossary.1061"></a><a href="#glo:opt.glostyle.bookindex"><span class="xtrglostylefmt">bookindex</span></a> style so that it uses the <a id="wrglossary.1062"></a><a href="#glo:opt.gloskey.text"><span class="csoptfmt">text</span></a> field instead. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1063"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\renewcommand</code>*{<a id="wrglossary.1064"></a><a href="#glo:glsxtrbookindexname"><code class="xtrcsfmt">\glsxtrbookindexname</code></a>}[1]{<span class="comment">% </span>
+ <a id="wrglossary.1065"></a><a href="#glo:glossentrynameother"><code class="xtrcsfmt">\glossentrynameother</code></a>{#1}{text}}
+</pre> See the <a id="wrglossary.1066"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> user manual for further details about this style.<p>
+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.<p>
+If there are extra terms that need to be included in the index that don’t have a description, you can define them with <code class="code">@index</code> in the <a id="wrglossary.1067"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> file. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1068"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="code">@index</code>{element}
+<code class="code">@index</code>{member,<a id="wrglossary.1069"></a><a href="#glo:opt.gloskey.alias"><span class="xtrcsoptfmt">alias</span></a><span class="optfmt">={element}</span>}
+</pre> They can be used in the document as usual: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1070"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>The objects that make up a set are the <a id="wrglossary.1071"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{element}
+or <a id="wrglossary.1072"></a><a href="#glo:glspl"><code class="csfmt">\glspl</code></a>{member}.
+</pre> See <a href="http://mirrors.ctan.org/support/bib2gls/bib2gls-begin.pdf"><span class="styfmt">glossaries-extra</span> and <span class="appfmt">bib2gls</span>: An Introductory Guide</a> or the <a id="wrglossary.1073"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> user manual for further details.<p>
+
+</section><!-- end of section option6 -->
+
+<section id="sec:lipsum"><!-- start of section sec:lipsum --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.4. Dummy Entries for Testing<div class="labellink"><a href="#sec:lipsum">[link]</a></div></h2><!-- end of section header -->
+<p>
+In addition to the sample files described in §<a href="#sec:samples">18</a>, <a id="wrglossary.1074"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> also provides some files containing lorum ipsum dummy <a id="wrglossary.1075"></a><a href="#glo:idx.glossaryentry">entries</a>. These are provided for testing purposes and are on TeX’s path (in <span class="filefmt">tex/latex/glossaries/test-entries</span>) so they can be included via <a id="wrglossary.1076"></a><a href="#glo:input"><code class="csfmt">\input</code></a> or <a id="wrglossary.1077"></a><a href="#glo:loadglsentries"><code class="csfmt">\loadglsentries</code></a>. The <a id="wrglossary.1078"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package provides <a id="wrglossary.1079"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> versions of all these files for use with <a id="wrglossary.1080"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>. The files are as follows:<p>
+<div class="filedef">🗋 <a id="wrglossary.1081"></a><dfn id="glo:file.example-glossaries-brief.tex"><span class="filefmt">example-glossaries-brief.tex</span></dfn></div><!-- end of filedef -->
+ These entries all have brief descriptions. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1082"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1083"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{lorem}{<a id="wrglossary.1084"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={lorem}</span>,<a id="wrglossary.1085"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={ipsum}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1086"></a><dfn id="glo:file.example-glossaries-long.tex"><span class="filefmt">example-glossaries-long.tex</span></dfn></div><!-- end of filedef -->
+ These entries all have long descriptions. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1087"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1088"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{loremipsum}{<a id="wrglossary.1089"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={lorem ipsum}</span>,
+<a id="wrglossary.1090"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris.}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1091"></a><dfn id="glo:file.example-glossaries-multipar.tex"><span class="filefmt">example-glossaries-multipar.tex</span></dfn></div><!-- end of filedef -->
+ These entries all have multi-paragraph descriptions. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1092"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1093"></a><a href="#glo:longnewglossaryentry"><code class="csfmt">\longnewglossaryentry</code></a>{loremi-ii}{<a id="wrglossary.1094"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={lorem 1--2}</span>}<span class="comment">% </span>
+{<span class="comment">% </span>
+Lorem ipsum ...
+
+Nam dui ligula...
}
-</pre>
-<!--l. 4725--><p class="nopar" > (<span
-class="cmtt-10">\ifdefstring </span>is defined by the <span
-class="cmss-10">etoolbox</span><a
- id="dx1-75041"></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"
->
-<!--l. 4728--><p class="noindent" >
-</p><!--l. 4728--><p class="noindent" >____________________________</p></div>
-<a
- id="x1-75042r2"></a>
-<!--l. 4730--><p class="noindent" ><span
-class="cmbx-12">Example 2</span><span
-class="cmbx-12"> (Customizing Standard Sort (Options 2 or 3))</span><a
- id="x1-75043"></a>
-</p><!--l. 4731--><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="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="cmtt-10">name</span><a
- id="dx1-75044"></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. 4740--><p class="indent" > First, define two commands to set the person’s name:
-
-
-</p>
- <pre class="verbatim" id="verbatim-98">
-\newcommand{\sortname}[2]{#2, #1}
-\newcommand{\textname}[2]{#1 #2}
-</pre>
-<!--l. 4744--><p class="nopar" > and <span
-class="cmtt-10">\name </span>needs to be initialised to <span
-class="cmtt-10">\textname</span>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-99">
-\let\name\textname
-</pre>
-<!--l. 4748--><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">\name </span>to <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>
- <pre class="verbatim" id="verbatim-100">
-\renewcommand{\glsprestandardsort}[3]{%
- \let\name\sortname
- \edef#1{\expandafter\expandonce\expandafter{#1}}%
- \let\name\textname
- \glsdosanitizesort
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1095"></a><dfn id="glo:file.example-glossaries-symbols.tex"><span class="filefmt">example-glossaries-symbols.tex</span></dfn></div><!-- end of filedef -->
+ These entries all use the <a id="wrglossary.1096"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1097"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1098"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alpha}{<a id="wrglossary.1099"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={alpha}</span>,
+<a id="wrglossary.1100"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a><span class="optfmt">={<a id="wrglossary.1101"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.1102"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+<a id="wrglossary.1103"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={Quisque ullamcorper placerat ipsum.}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1104"></a><dfn id="glo:file.example-glossaries-symbolnames.tex"><span class="filefmt">example-glossaries-symbolnames.tex</span></dfn></div><!-- end of filedef -->
+ Similar to the previous file but the <a id="wrglossary.1105"></a><a href="#glo:opt.gloskey.symbol"><span class="csoptfmt">symbol</span></a> key isn’t used. Instead the symbol is stored in the <a id="wrglossary.1106"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1107"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1108"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{sym.alpha}{<a id="wrglossary.1109"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={alpha}</span>,
+<a id="wrglossary.1110"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={<a id="wrglossary.1111"></a><a href="#glo:ensuremath"><code class="csfmt">\ensuremath</code></a>{<a id="wrglossary.1112"></a><a href="#glo:alpha"><code class="csfmt">\alpha</code></a>}}</span>,
+<a id="wrglossary.1113"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={Quisque ullamcorper placerat ipsum.}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1114"></a><dfn id="glo:file.example-glossaries-images.tex"><span class="filefmt">example-glossaries-images.tex</span></dfn></div><!-- end of filedef -->
+ These entries use the <a id="wrglossary.1115"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a> key to store the name of an image file. (The images are provided by the <a id="wrglossary.1116"></a><a href="#glo:pkg.mwe"><span class="styfmt">mwe</span></a> 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: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1117"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1118"></a><a href="#glo:longnewglossaryentry"><code class="csfmt">\longnewglossaryentry</code></a>{sedfeugiat}{<a id="wrglossary.1119"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sed feugiat}</span>,
+<a id="wrglossary.1120"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a><span class="optfmt">={example-image}</span>}<span class="comment">% </span>
+{<span class="comment">% </span>
+Cum sociis natoque...
+
+Etiam...
}
-</pre>
-<!--l. 4760--><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. 4764--><p class="indent" > Now the entries can be defined:
-
-
-</p>
- <pre class="verbatim" id="verbatim-101">
-\newglossaryentry{joebloggs}{name={\name{Joe}{Bloggs}},
-  description={some information about Joe Bloggs}}
-\newglossaryentry{johnsmith}{name={\name{John}{Smith}},
-  description={some information about John Smith}}
-</pre>
-<!--l. 4771--><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"
->
-<!--l. 4773--><p class="noindent" >
-</p><!--l. 4773--><p class="noindent" >____________________________</p></div>
-<!--l. 4775--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-760002.5"></a><a
- id="pkgopt:order"></a><span
-class="cmss-10">order=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4775--><p class="noindent" >This may take two values: <span
-class="cmss-10">word</span><a
- id="dx1-76001"></a> or <span
-class="cmss-10">letter</span><a
- id="dx1-76002"></a>. The default is word ordering.
-</p><!--l. 4779--><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-76003"></a> option has no effect if you don’t use <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-76004"></a></a>.
-</div>
-</p><!--l. 4782--><p class="noindent" >
-</p><!--l. 4784--><p class="indent" > If you use <a
-href="#option1">Option 1</a>, this setting will be used if you use <span
-class="cmtt-10">sort</span><a
- id="dx1-76005"></a><span
-class="cmtt-10">=standard </span>in the optional argument of
-<span
-class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-76006"></a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-102">
-\printnoidxglossary[sort=standard]
-</pre>
-<!--l. 4789--><p class="nopar" > Alternatively, you can specify the order for individual glossaries:
-
-
-</p>
- <pre class="verbatim" id="verbatim-103">
-\printnoidxglossary[sort=word]
-\printnoidxglossary[type=acronym,sort=letter]
-</pre>
-<!--l. 4794--><p class="nopar" >
-</p><!--l. 4796--><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-76007"></a></a>, use the <span id="textcolor238"><span
-class="cmtt-10">break-at</span></span><a
- id="dx1-76008"></a> option in <span id="textcolor239"><span
-class="cmtt-10">\GlsXtrLoadResources</span></span><a
- id="dx1-76009"></a> instead of <span
-class="cmss-10">order</span>. </div>
-</p><!--l. 4799--><p class="noindent" >
-</p><!--l. 4801--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-770002.5"></a><a
- id="pkgopt:makeindex"></a><span
-class="cmss-10">makeindex</span></h4>
-<!--l. 4801--><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-77001"></a></a> format. If you use
-<a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-77002"></a></a>, it will automatically detect that it needs to call <span
-class="cmtt-10">makeindex</span><a
- id="dx1-77003"></a>. If you don’t use <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-77004"></a>,
-you need to remember to use <span
-class="cmtt-10">makeindex</span><a
- id="dx1-77005"></a> not <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-77006"></a></a>. The indexing style file will been given a <span
-class="cmtt-10">ist</span><a
- id="dx1-77007"></a>
-extension.
-</p><!--l. 4809--><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-77008"></a> in the package option list.
-</p><!--l. 4813--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-780002.5"></a><a
- id="pkgopt:xindy"></a><span
-class="cmss-10">xindy</span></h4>
-<!--l. 4813--><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-78001"></a></a> format. If you use
-<a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-78002"></a></a>, it will automatically detect that it needs to call <span
-class="cmtt-10">xindy</span><a
- id="dx1-78003"></a>. If you don’t use <span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-78004"></a>,
-you need to remember to use <span
-class="cmtt-10">xindy</span><a
- id="dx1-78005"></a> not <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-78006"></a></a>. The indexing style file will been given a <span
-class="cmtt-10">xdy</span><a
- id="dx1-78007"></a>
-extension.
-</p><!--l. 4820--><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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-104">
-\usepackage[xindy={language=english,codepage=utf8}]
-  {glossaries}
-</pre>
-<!--l. 4826--><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>
- <pre class="verbatim" id="verbatim-105">
-\usepackage[xindy={glsnumbers=false}]{glossaries}
-</pre>
-<!--l. 4831--><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="cmbx-10">14</span> </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-78008"></a></a> with the <span
-class="cmss-10">glossaries </span>package.
-</p><!--l. 4838--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-790002.5"></a><a
- id="pkgopt:xindygloss"></a><span
-class="cmss-10">xindygloss</span></h4>
-<!--l. 4838--><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-79001"></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-79002"></a> and
-<span
-class="cmtt-10">\GlsSetXdyCodePage</span><a
- id="dx1-79003"></a> (see <a
-href="#sec:langenc">§<span
-class="cmbx-10">14.1</span> </a><a
-href="#sec:langenc">Language and Encodings<!--tex4ht:ref: sec:langenc --></a>.)
-</p><!--l. 4844--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-800002.5"></a><a
- id="pkgopt:xindynoglsnumbers"></a><span
-class="cmss-10">xindynoglsnumbers</span></h4>
-<!--l. 4844--><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.
-</p><!--l. 4848--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-810002.5"></a><a
- id="pkgopt:automake"></a><span
-class="cmss-10">automake=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 4848--><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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-81001"></a> will attempt to run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-81002"></a></a> or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-81003"></a></a> using TeX’s <span
-class="cmtt-10">\write18</span><a
- id="dx1-81004"></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-81005"></a> will attempt to run <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-81006"></a></a> or
-<a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-81007"></a></a> at the start of <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-81008"></a> using <span
-class="cmtt-10">\immediate </span>(before the glossary files have been
-opened).
-</p><!--l. 4859--><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-81009"></a>, the associated files are created at the end of the document ready
-for the next LaTeX 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</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">immediate</span><a
- id="dx1-81010"></a>
-instead.
-</p><!--l. 4869--><p class="indent" > With <span
-class="cmss-10">automake</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">immediate</span><a
- id="dx1-81011"></a>, you will get a warning on the first LaTeX run as the associated glossary files
-don’t exist yet.
-
-
-</p><!--l. 4873--><p class="indent" > Since this mechanism can be a security risk, some TeX 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. 4879--><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-81012"></a></a> but may not include <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-81013"></a></a>. So if you have the restricted mode
-on, <span
-class="cmss-10">automake</span><a
- id="dx1-81014"></a> should work with <span
-class="cmtt-10">makeindex</span><a
- id="dx1-81015"></a> but may not work with <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-81016"></a></a>.
-</p><!--l. 4885--><p class="indent" > However even in unrestricted mode this option may not work with <span
-class="cmtt-10">xindy</span><a
- id="dx1-81017"></a> as <span
-class="cmtt-10">xindy</span><a
- id="dx1-81018"></a> uses language names that
-don’t always correspond with <span
-class="cmss-10">babel</span><a
- id="dx1-81019"></a>’s language names. (The <a
-href="#glo:makeglossaries"><span
-class="cmtt-10">makeglossaries</span><a
- id="dx1-81020"></a></a> script applies mappings to assist
-you.) Note that you still need at least two LaTeX runs to ensure the document is up-to-date with this
-setting.
-</p><!--l. 4892--><p class="indent" > Since this package option attempts to run the <a
-href="#glo:indexingapp">indexing application</a> on every LaTeX 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-81021"></a>.
-</p><!--l. 4898--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-820002.5"></a><a
- id="pkgopt:disablemakegloss"></a><span
-class="cmss-10">disablemakegloss</span></h4>
-<!--l. 4898--><p class="noindent" >This valueless option indicates that <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-82001"></a> and <span
-class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-82002"></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">§<span
-class="cmbx-10">1.2</span> </a><a
-href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a> and automatically performs <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-82003"></a> or
-<span
-class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-82004"></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. 4908--><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-82005"></a> is loaded. Note that this does nothing if <span
-class="cmtt-10">\makeglossaries</span><a
- id="dx1-82006"></a> or <span
-class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-82007"></a> has
-already been used whilst enabled.
-</p><!--l. 4914--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-830002.5"></a><a
- id="pkgopt:restoremakegloss"></a><span
-class="cmss-10">restoremakegloss</span></h4>
-<!--l. 4914--><p class="noindent" >Cancels the effect of <span
-class="cmss-10">disablemakegloss</span><a
- id="dx1-83001"></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-83002"></a> or <span
-class="cmtt-10">\makenoidxglossaries</span><a
- id="dx1-83003"></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>
- <pre class="verbatim" id="verbatim-106">
-\documentclass[disablemakegloss]{customclass}
-\newglossary*{functions}{Functions}
-\setupglossaries{restoremakegloss}
-\makeglossaries
-</pre>
-<!--l. 4927--><p class="nopar" > or
-
-
-</p>
- <pre class="verbatim" id="verbatim-107">
-\PassOptionsToPackage{disablemakegloss}{glossaries}
-\documentclass{customclass}
-\newglossary*{functions}{Functions}
-\setupglossaries{restoremakegloss}
-\makeglossaries
-</pre>
-<!--l. 4935--><p class="nopar" >
-</p><!--l. 4937--><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="textcolor240"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">only</span></span><a
- id="dx1-83004"></a> or <span id="textcolor241"><span
-class="cmss-10">record</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">nameref</span></span><a
- id="dx1-83005"></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-83006"></a>.
-</p><!--l. 4944--><p class="noindent" >
-</p>
-<!--l. 4944--><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. 4947--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-850002.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. 4947--><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-85001"></a>
-etc shouldn’t have hyperlinks by default. Make sure you enclose the value in braces if it contains any commas.
-Example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-108">
-\usepackage[acronym,nohypertypes={acronym,notation}]
-  {glossaries}
-\newglossary[nlg]{notation}{not}{ntn}{Notation}
-</pre>
-<!--l. 4957--><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-85002"></a>. You may also
-use
-</p><!--l. 4961--><p class="indent" > <hr><div title="Definition"><span
-class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-85003"></a><span
-class="cmtt-10">{</span>⟨<span
-class="cmitt-10">list</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 4962--><p class="noindent" >
-instead or additionally. See <a
-href="#sec:glslink">§<span
-class="cmbx-10">5.1</span> </a><a
-href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a> for further details.
-</p><!--l. 4966--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-860002.6"></a><a
- id="pkgopt:nomain"></a><span
-class="cmss-10">nomain</span></h4>
-<!--l. 4966--><p class="noindent" >This suppresses the creation of the main glossary and associated <span
-class="cmtt-10">glo</span><a
- id="dx1-86001"></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-86002"></a> (or <span
-class="cmss-10">acronyms</span><a
- id="dx1-86003"></a>)
-package option described in <a
-href="#sec:pkgopts-acronym">§<span
-class="cmbx-10">2.7</span> </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-86004"></a>,
-<span
-class="cmss-10">numbers</span><a
- id="dx1-86005"></a> or <span
-class="cmss-10">index</span><a
- id="dx1-86006"></a> options described in <a
-href="#sec:pkgopts-other">§<span
-class="cmbx-10">2.9</span> </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-86007"></a> described in
-<a
-href="#sec:newglossary">§<span
-class="cmbx-10">9</span> </a><a
-href="#sec:newglossary">Defining New Glossaries<!--tex4ht:ref: sec:newglossary --></a>).
-</p><!--l. 4976--><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-86008"></a></a> will produce a warning.
-</div>
-</p><!--l. 4979--><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-86009"></a>.
-<!--l. 4991--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-870002.6"></a><a
- id="pkgopt:symbols"></a><span
-class="cmss-10">symbols</span></h4>
-<!--l. 4991--><p class="noindent" >This valueless option defines a new glossary type with the label <span
-class="cmtt-10">symbols </span>via
-
-
-</p>
- <pre class="verbatim" id="verbatim-109">
-\newglossary[slg]{symbols}{sls}{slo}{\glssymbolsgroupname}
-</pre>
-<!--l. 4995--><p class="nopar" > It also defines
-</p><!--l. 4997--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-87001"></a> <span
-class="cmtt-10">\printsymbols[</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">] </span></div><hr>
-</p><!--l. 4999--><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-87002"></a><span
-class="cmtt-10">[type=symbols,</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">]</span>
-</div>
-</div>
-<!--l. 5005--><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-87003"></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. 5011--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
-class="cmss-10">nomain</span><a
- id="dx1-87004"></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. 5015--><p class="noindent" >
-</p><!--l. 5017--><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="textcolor242"><span
-class="cmtt-10">\glsxtrnewsymbol</span></span><a
- id="dx1-87005"></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. 5022--><p class="noindent" >
-</p><!--l. 5024--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-880002.6"></a><a
- id="pkgopt:numbers"></a><span
-class="cmss-10">numbers</span></h4>
-<!--l. 5024--><p class="noindent" >This valueless option defines a new glossary type with the label <span
-class="cmtt-10">numbers </span>via
-
-
-</p>
- <pre class="verbatim" id="verbatim-110">
-\newglossary[nlg]{numbers}{nls}{nlo}{\glsnumbersgroupname}
-</pre>
-<!--l. 5028--><p class="nopar" > It also defines
-</p><!--l. 5030--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-88001"></a> <span
-class="cmtt-10">\printnumbers[</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">] </span></div><hr>
-</p><!--l. 5032--><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-88002"></a><span
-class="cmtt-10">[type=numbers,</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">]</span>
-</div>
-</div>
-<!--l. 5038--><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-88003"></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. 5044--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
-class="cmss-10">nomain</span><a
- id="dx1-88004"></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. 5048--><p class="noindent" >
-</p><!--l. 5050--><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="textcolor243"><span
-class="cmtt-10">\glsxtrnewnumber</span></span><a
- id="dx1-88005"></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. 5055--><p class="noindent" >
-</p><!--l. 5057--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-890002.6"></a><a
- id="pkgopt:index"></a><span
-class="cmss-10">index</span></h4>
-<!--l. 5057--><p class="noindent" >This valueless option defines a new glossary type with the label <span
-class="cmtt-10">index </span>via
-
-
-</p>
- <pre class="verbatim" id="verbatim-111">
-\newglossary[ilg]{index}{ind}{idx}{\indexname}%
-</pre>
-<!--l. 5061--><p class="nopar" > It also defines
-</p><!--l. 5063--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-89001"></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. 5065--><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-89002"></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-89003"></a><span
-class="cmtt-10">,</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">]</span>
-</div>
-</div> and
-<!--l. 5072--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-89004"></a> <span
-class="cmtt-10">\printindex[</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">] </span></div><hr>
-</p><!--l. 5074--><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-89005"></a><span
-class="cmtt-10">[type=index,</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">]</span>
-</div>
-</div>
-<!--l. 5080--><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-89006"></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. 5086--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
-class="cmss-10">nomain</span><a
- id="dx1-89007"></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-89008"></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-89009"></a>, <span
-class="cmss-10">index</span><a
- id="dx1-89010"></a> or <span
-class="cmss-10">imakeidx</span><a
- id="dx1-89011"></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-89012"></a> package option.)
-</div>
-</p><!--l. 5095--><p class="noindent" >
-</p><!--l. 5097--><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-89013"></a> or the command <spacer type=vertical size=10><span class="obeylines-h">
- <br /><span
-class="cmtt-10">\GlsDeclareNoHyperList</span><a
- id="dx1-89014"></a><span class="verb"><span
-class="cmtt-10">{index}</span></span>
- <br /><spacer type=vertical size=10></span>
-</p><!--l. 5104--><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-89015"></a> package option.
-
-
-</p><!--l. 5107--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-900002.6"></a><a
- id="pkgopt:noglossaryindex"></a><span
-class="cmss-10">noglossaryindex</span></h4>
-<!--l. 5107--><p class="noindent" >This valueless option switches off <span
-class="cmss-10">index</span><a
- id="dx1-90001"></a> if <span
-class="cmss-10">index</span><a
- id="dx1-90002"></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. 5113--><p class="noindent" >
-</p>
-<!--l. 5113--><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. 5116--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-920002.7"></a><a
- id="pkgopt:acronym"></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. 5116--><p class="noindent" >If true, this creates a new glossary with the label <span
-class="cmtt-10">acronym</span>. This is equivalent to:
-
-
-</p>
- <pre class="verbatim" id="verbatim-112">
-\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
-</pre>
-<!--l. 5120--><p class="nopar" > It will also define
-</p><!--l. 5122--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-92001"></a> <span
-class="cmtt-10">\printacronyms[</span>⟨<span
-class="cmitt-10">options</span>⟩<span
-class="cmtt-10">] </span></div><hr>
-</p><!--l. 5124--><p class="noindent" >
-that’s equivalent to </p><div class="alltt">
-<div class="obeylines-v">
-<span
-class="cmtt-10">\printglossary</span><a
- id="dx1-92002"></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
-class="cmss-10">compatible-3.07</span><a
- id="dx1-92003"></a> is used).
-<!--l. 5132--><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
-class="cmtt-10">\printnoidxglossary</span><a
- id="dx1-92004"></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. 5138--><p class="indent" > If the <span
-class="cmss-10">acronym</span><a
- id="dx1-92005"></a> package option is used, <span
-class="cmtt-10">\acronymtype</span><a
- id="dx1-92006"></a> is set to <span
-class="cmtt-10">acronym </span>otherwise it is set to
-<span
-class="cmtt-10">main</span>.<span class="footnote-mark"><a
-href="#fn5x2" id="fn5x2-bk"><sup class="textsuperscript">2.5</sup></a></span><a
- id="x1-92007f5"></a>
-Entries that are defined using <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-92013"></a> are placed in the glossary whose label is given by <span
-class="cmtt-10">\acronymtype</span><a
- id="dx1-92014"></a>,
-unless another glossary is explicitly specified.
-</p><!--l. 5148--><p class="indent" > <div class="important" title="Important Note"> Remember to use the <span
-class="cmss-10">nomain</span><a
- id="dx1-92015"></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. 5152--><p class="noindent" >
-</p><!--l. 5154--><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="textcolor244"><span
-class="cmss-10">abbreviations</span></span><a
- id="dx1-92016"></a> option, which creates a new
-glossary with the label <span
-class="cmtt-10">abbreviations </span>and sets the command <span id="textcolor245"><span
-class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-92017"></a> to this. If the <span
-class="cmss-10">acronym</span><a
- id="dx1-92018"></a> option
-hasn’t also been used, then <span
-class="cmtt-10">\acronymtype</span><a
- id="dx1-92019"></a> will be set to <span id="textcolor246"><span
-class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-92020"></a>. This enables both <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-92021"></a>
-and <span id="textcolor247"><span
-class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-92022"></a> to use the same glossary.
-</p><!--l. 5163--><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-92023"></a> (or <span
-class="cmss-10">acronyms</span><a
- id="dx1-92024"></a>) package option
-with the extension package to avoid a bug that interferes with the abbreviation style. </div>
-</p><!--l. 5167--><p class="noindent" >
-</p><!--l. 5169--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-930002.7"></a><a
- id="pkgopt:acronyms"></a><span
-class="cmss-10">acronyms</span></h4>
-<!--l. 5169--><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-93001"></a> and may be used in the document class option list.
-
-
-</p><!--l. 5173--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-940002.7"></a><span id="textcolor248"><a
- id="pkgopt:abbreviations"></a><span id="textcolor249"><span
-class="cmss-10">abbreviations</span></span> (glossaries-extra.sty)</span></h4>
-<!--l. 5175--><p class="noindent" >This valueless option creates a new glossary type using:
-
-
-</p>
- <pre class="verbatim" id="verbatim-113">
-\newglossary[glg-abr]{abbreviations}{gls-abr}{glo-abr}{\abbreviationsname}
-</pre>
-<!--l. 5178--><p class="nopar" > The label can be accessed with <span id="textcolor250"><span
-class="cmtt-10">\glsxtrabbrvtype</span></span><a
- id="dx1-94001"></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. 5183--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-950002.7"></a><a
- id="pkgopt:acronymlists"></a><span
-class="cmss-10">acronymlists=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 5183--><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-95001"></a>. For example, if you use
-the <span
-class="cmss-10">acronym</span><a
- id="dx1-95002"></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>
- <pre class="verbatim" id="verbatim-114">
-\usepackage[acronym,acronymlists={main}]{glossaries}
-</pre>
-<!--l. 5191--><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>
- <pre class="verbatim" id="verbatim-115">
-\usepackage[acronym,acronymlists={main,acronym2}]
-  {glossaries}
-\newglossary[alg2]{acronym2}{acr2}{acn2}%
-  {Statistical Acronyms}
-</pre>
-<!--l. 5199--><p class="nopar" > You can use
-</p><!--l. 5201--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-95003"></a> <span
-class="cmtt-10">\DeclareAcronymList{</span>⟨<span
-class="cmitt-10">list</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5203--><p class="noindent" >
-instead of or in addition to the <span
-class="cmss-10">acronymlists</span><a
- id="dx1-95004"></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. 5208--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-95005"></a> <span
-class="cmtt-10">\SetAcronymLists{</span>⟨<span
-class="cmitt-10">list</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5210--><p class="noindent" >
-</p><!--l. 5212--><p class="indent" > You can determine if a glossary has been identified as being a list of acronyms using:
-</p><!--l. 5214--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-95006"></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. 5216--><p class="noindent" >
-</p><!--l. 5218--><p class="indent" > <div title="glossaries-extra.sty" style="border: solid 2pt green;"> This option and associated commands are incompatible with <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span>’s</a> abbreviation mechanism.
-</div>
-</p><!--l. 5221--><p class="noindent" >
-</p><!--l. 5223--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-960002.7"></a><a
- id="pkgopt:shortcuts"></a><span
-class="cmss-10">shortcuts</span></h4>
-<!--l. 5223--><p class="noindent" >This option provides shortcut commands for acronyms. See <a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>
-for further details. Alternatively you can use:
-</p><!--l. 5226--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-96001"></a> <span
-class="cmtt-10">\DefineAcronymSynonyms </span></div><hr>
-</p><!--l. 5228--><p class="noindent" >
-</p><!--l. 5230--><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. 5232--><p class="noindent" >
-</p><!--l. 5234--><p class="noindent" >
-</p>
-<!--l. 5234--><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-old-acronym"></a>Deprecated Acronym Style Options</h3>
-<!--l. 5237--><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-97001"></a> instead. See <a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> for further
-details.
-</p><!--l. 5241--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-980002.8"></a><a
- id="pkgopt:description"></a><span
-class="cmss-10">description</span></h4>
-<!--l. 5241--><p class="noindent" >This option changes the definition of <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-98001"></a> to allow a description. This option may be replaced
-by
-
-
-</p>
- <pre class="verbatim" id="verbatim-116">
-\setacronymstyle{long-short-desc}
-</pre>
-<!--l. 5246--><p class="nopar" > or (with <span
-class="cmss-10">smallcaps</span><a
- id="dx1-98002"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-117">
-\setacronymstyle{long-sc-short-desc}
-</pre>
-<!--l. 5250--><p class="nopar" > or (with <span
-class="cmss-10">smaller</span><a
- id="dx1-98003"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-118">
-\setacronymstyle{long-sm-short-desc}
-</pre>
-<!--l. 5254--><p class="nopar" > or (with <span
-class="cmss-10">footnote</span><a
- id="dx1-98004"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-119">
-\setacronymstyle{footnote-desc}
-</pre>
-<!--l. 5258--><p class="nopar" > or (with <span
-class="cmss-10">footnote</span><a
- id="dx1-98005"></a> and <span
-class="cmss-10">smallcaps</span><a
- id="dx1-98006"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-120">
-\setacronymstyle{footnote-sc-desc}
-</pre>
-<!--l. 5262--><p class="nopar" > or (with <span
-class="cmss-10">footnote</span><a
- id="dx1-98007"></a> and <span
-class="cmss-10">smaller</span><a
- id="dx1-98008"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-121">
-\setacronymstyle{footnote-sm-desc}
-</pre>
-<!--l. 5266--><p class="nopar" > or (with <span
-class="cmss-10">dua</span><a
- id="dx1-98009"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-122">
-\setacronymstyle{dua-desc}
-</pre>
-<!--l. 5270--><p class="nopar" >
-</p><!--l. 5272--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-990002.8"></a><a
- id="pkgopt:smallcaps"></a><span
-class="cmss-10">smallcaps</span></h4>
-<!--l. 5272--><p class="noindent" >This option changes the definition of <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-99001"></a> and the way that acronyms are displayed. This option may
-be replaced by:
-
-
-</p>
- <pre class="verbatim" id="verbatim-123">
-\setacronymstyle{long-sc-short}
-</pre>
-<!--l. 5277--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-99002"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-124">
-\setacronymstyle{long-sc-short-desc}
-</pre>
-<!--l. 5281--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-99003"></a> and <span
-class="cmss-10">footnote</span><a
- id="dx1-99004"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-125">
-\setacronymstyle{footnote-sc-desc}
-</pre>
-<!--l. 5285--><p class="nopar" >
-</p><!--l. 5287--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1000002.8"></a><a
- id="pkgopt:smaller"></a><span
-class="cmss-10">smaller</span></h4>
-<!--l. 5287--><p class="noindent" >This option changes the definition of <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-100001"></a> and the way that acronyms are displayed.
-</p><!--l. 5289--><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-100002"></a> package or otherwise define <span
-class="cmtt-10">\textsmaller</span><a
- id="dx1-100003"></a> or
-redefine <span
-class="cmtt-10">\acronymfont</span><a
- id="dx1-100004"></a>. </div>
-</p><!--l. 5293--><p class="noindent" >
-This option may be replaced by:
-
-
-</p>
- <pre class="verbatim" id="verbatim-126">
-\setacronymstyle{long-sm-short}
-</pre>
-<!--l. 5297--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-100005"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-127">
-\setacronymstyle{long-sm-short-desc}
-</pre>
-<!--l. 5301--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-100006"></a> and <span
-class="cmss-10">footnote</span><a
- id="dx1-100007"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-128">
-\setacronymstyle{footnote-sm-desc}
-</pre>
-<!--l. 5305--><p class="nopar" >
-</p><!--l. 5307--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1010002.8"></a><a
- id="pkgopt:footnote"></a><span
-class="cmss-10">footnote</span></h4>
-<!--l. 5307--><p class="noindent" >This option changes the definition of <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-101001"></a> and the way that acronyms are displayed. This option may
-be replaced by:
-
-
-</p>
- <pre class="verbatim" id="verbatim-129">
-\setacronymstyle{footnote}
-</pre>
-<!--l. 5312--><p class="nopar" > or (with <span
-class="cmss-10">smallcaps</span><a
- id="dx1-101002"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-130">
-\setacronymstyle{footnote-sc}
-</pre>
-<!--l. 5316--><p class="nopar" > or (with <span
-class="cmss-10">smaller</span><a
- id="dx1-101003"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-131">
-\setacronymstyle{footnote-sm}
-</pre>
-<!--l. 5320--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-101004"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-132">
-\setacronymstyle{footnote-desc}
-</pre>
-<!--l. 5324--><p class="nopar" > or (with <span
-class="cmss-10">smallcaps</span><a
- id="dx1-101005"></a> and <span
-class="cmss-10">description</span><a
- id="dx1-101006"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-133">
-\setacronymstyle{footnote-sc-desc}
-</pre>
-<!--l. 5328--><p class="nopar" > or (with <span
-class="cmss-10">smaller</span><a
- id="dx1-101007"></a> and <span
-class="cmss-10">description</span><a
- id="dx1-101008"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-134">
-\setacronymstyle{footnote-sm-desc}
-</pre>
-<!--l. 5332--><p class="nopar" >
-</p><!--l. 5334--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1020002.8"></a><a
- id="pkgopt:dua"></a><span
-class="cmss-10">dua</span></h4>
-<!--l. 5334--><p class="noindent" >This option changes the definition of <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-102001"></a> so that acronyms are always expanded. This option may be
-replaced by:
-
-
-</p>
- <pre class="verbatim" id="verbatim-135">
-\setacronymstyle{dua}
-</pre>
-<!--l. 5339--><p class="nopar" > or (with <span
-class="cmss-10">description</span><a
- id="dx1-102002"></a>)
-
-
-</p>
- <pre class="verbatim" id="verbatim-136">
-\setacronymstyle{dua-desc}
-</pre>
-<!--l. 5343--><p class="nopar" >
-</p><!--l. 5345--><p class="noindent" >
-</p>
-<!--l. 5345--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.9 </span> <a
- id="sec:pkgopts-other"></a>Other Options</h3>
-<!--l. 5348--><p class="noindent" >Other available options that don’t fit any of the above categories are described below.
-</p><!--l. 5351--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1040002.9"></a><span id="textcolor251"><a
- id="pkgopt:accsupp"></a><span id="textcolor252"><span
-class="cmss-10">accsupp</span></span> (glossaries-extra.sty)</span></h4>
-<!--l. 5353--><p class="noindent" >Load the <span
-class="cmss-10">glossaries-accsupp</span><a
- id="dx1-104001"></a> package.
-</p><!--l. 5355--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1050002.9"></a><span id="textcolor253"><a
- id="pkgopt:prefix"></a><span id="textcolor254"><span
-class="cmss-10">prefix</span></span> (glossaries-extra.sty)</span></h4>
-<!--l. 5357--><p class="noindent" >Load the <span
-class="cmss-10">glossaries-prefix</span><a
- id="dx1-105001"></a> package.
-</p><!--l. 5359--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1060002.9"></a><span id="textcolor255"><a
- id="pkgopt:nomissingglstext"></a><span id="textcolor256"><span
-class="cmss-10">nomissingglstext</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. 5361--><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. 5364--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1070002.9"></a><a
- id="pkgopt:compatible-2.07"></a><span
-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. 5364--><p class="noindent" >Compatibility mode for old documents created using version 2.07 or below.
-
-
-</p><!--l. 5367--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1080002.9"></a><a
- id="pkgopt:compatible-3.07"></a><span
-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. 5367--><p class="noindent" >Compatibility mode for old documents created using version 3.07 or below.
-</p><!--l. 5370--><p class="noindent" >
-</p>
- <h4 class="likesubsectionHead"><a
- id="x1-1090002.9"></a><a
- id="pkgopt:kernelglossredefs"></a><span
-class="cmss-10">kernelglossredefs=</span><span
-class="cmtt-10">{</span>⟨<span
-class="cmssi-10">value</span>⟩<span
-class="cmtt-10">}</span></h4>
-<!--l. 5370--><p class="noindent" >As a legacy from the precursor <span
-class="cmss-10">glossary</span><a
- id="dx1-109001"></a> package, the standard glossary commands provided by the LaTeX 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.
-</p><!--l. 5379--><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. 5383--><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-109002"></a>. You may also need to use the <span
-class="cmss-10">nomain</span><a
- id="dx1-109003"></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-109004"></a>
-package.)
-</p><!--l. 5394--><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. 5399--><p class="indent" > The only glossary-related commands provided by the LaTeX 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">\printglossary </span>and <span
-class="cmss-10">theglossary</span><a
- id="dx1-109005"></a><a
- id="dx1-109006"></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-109007"></a> package will override the existing definitions of <span
-class="cmtt-10">\printglossary </span>and
-<span
-class="cmss-10">theglossary</span><a
- id="dx1-109008"></a><a
- id="dx1-109009"></a>.)
-</p><!--l. 5409--><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-109010"></a> package and patches <span
-class="cmtt-10">\PrintChanges</span>.)
-</p><!--l. 5413--><p class="noindent" >
-</p>
-<!--l. 5413--><p class="noindent" ><a
-href="#top">Top</a><h3 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2.10 </span> <a
- id="sec:setupglossaries"></a>Setting Options After the Package is Loaded</h3>
-<!--l. 5416--><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. 5418--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-110001"></a> <span
-class="cmtt-10">\setupglossaries{</span>⟨<span
-class="cmitt-10">key-val list</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5420--><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-110002"></a>, <span
-class="cmss-10">xindygloss</span><a
- id="dx1-110003"></a>, <span
-class="cmss-10">xindynoglsnumbers</span><a
- id="dx1-110004"></a>,
-<span
-class="cmss-10">makeindex</span><a
- id="dx1-110005"></a>, <span
-class="cmss-10">nolong</span><a
- id="dx1-110006"></a>, <span
-class="cmss-10">nosuper</span><a
- id="dx1-110007"></a>, <span
-class="cmss-10">nolist</span><a
- id="dx1-110008"></a>, <span
-class="cmss-10">notree</span><a
- id="dx1-110009"></a>, <span
-class="cmss-10">nostyles</span><a
- id="dx1-110010"></a>, <span
-class="cmss-10">nomain</span><a
- id="dx1-110011"></a>, <span
-class="cmss-10">compatible-2.07</span><a
- id="dx1-110012"></a>, <span
-class="cmss-10">translate</span><a
- id="dx1-110013"></a>, <span
-class="cmss-10">notranslate</span><a
- id="dx1-110014"></a>, <span
-class="cmss-10">acronym</span><a
- id="dx1-110015"></a>. These
-options have to be set while the package is loading, except for the <span
-class="cmss-10">xindy</span><a
- id="dx1-110016"></a> sub-options which can
-be set using commands like <span
-class="cmtt-10">\GlsSetXdyLanguage</span><a
- id="dx1-110017"></a> (see <a
-href="#sec:xindy">§<span
-class="cmbx-10">14</span> </a><a
-href="#sec:xindy">Xindy (Option 3)<!--tex4ht:ref: sec:xindy --></a> for further
-details).
-
-
-</p><!--l. 5432--><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-110018"></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. 5440--><p class="noindent" >
-</p><!--l. 5442--><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>, use <span id="textcolor257"><span
-class="cmtt-10">\glossariesextrasetup</span></span><a
- id="dx1-110019"></a> instead. </div>
-</p><!--l. 5445--><p class="noindent" >
-
-
-</p>
-<!--l. 5447--><p class="indent" > </div>
-</p><!--l. 5447--><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. 5450--><p class="indent" > In the preamble you need to indicate which method you want to use to generate the glossary
-(or glossaries). The available options with both <span
-class="cmss-10">glossaries </span>and <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> are summarized in
-<a
-href="#sec:indexingoptions">§<span
-class="cmbx-10">1.2</span> </a><a
-href="#sec:indexingoptions">Indexing Options<!--tex4ht:ref: sec:indexingoptions --></a>. This chapter documents Options <a
-href="#option1">1</a>–<a
-href="#option3">3</a>, which are provided by the
-base package. 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-111001"></a></a> manuals for the full documentation of the other
-options.
-</p><!--l. 5458--><p class="indent" > If you don’t need to display any glossaries, for example, if you are just using the <span
-class="cmss-10">glossaries </span>package to enable
-consistent formatting, then skip ahead to <a
-href="#sec:newglosentry">§<span
-class="cmbx-10">4</span> </a><a
-href="#sec:newglosentry">Defining Glossary Entries<!--tex4ht:ref: sec:newglosentry --></a>.
-</p>
-<!--l. 5462--><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. 5465--><p class="noindent" >The command
-</p><!--l. 5466--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-112001"></a> <span
-class="cmtt-10">\makenoidxglossaries </span></div><hr>
-</p><!--l. 5468--><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. 5474--><p class="noindent" >
-</p>
-<!--l. 5474--><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. 5477--><p class="noindent" >The command
-</p><!--l. 5478--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113001"></a> <span
-class="cmtt-10">\makeglossaries </span></div><hr>
-</p><!--l. 5480--><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-113002"></a></a> (<span
-class="cmtt-10">ist</span><a
- id="dx1-113003"></a>) or <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-113004"></a></a> (<span
-class="cmtt-10">xdy</span><a
- id="dx1-113005"></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. <strong>If
-you omit <span
-class="cmtt-10">\makeglossaries </span>none of the glossary files will be created.</strong>
-</p><!--l. 5488--><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. 5492--><p class="noindent" >
-</p><!--l. 5495--><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. 5503--><p class="indent" > You can suppress the creation of the customised <a
-href="#glo:xindy"><span
-class="cmtt-10">xindy</span><a
- id="dx1-113006"></a></a> or <a
-href="#glo:makeindex"><span
-class="cmtt-10">makeindex</span><a
- id="dx1-113007"></a></a> style file using
-</p><!--l. 5505--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113008"></a> <span
-class="cmtt-10">\noist </span></div><hr>
-</p><!--l. 5507--><p class="noindent" >
-That this command must not be used after <span
-class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5509--><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-113009"></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-113010"></a> package option with it. </div>
-
-
-</p><!--l. 5513--><p class="noindent" >
-</p><!--l. 5515--><p class="indent" > The default name for the customised style file is given by <span
-class="cmtt-10">\jobname</span><a
- id="dx1-113011"></a><span
-class="cmtt-10">.ist</span><a
- id="dx1-113012"></a> (<a
-href="#option2">Option 2</a>) or <span
-class="cmtt-10">\jobname</span><a
- id="dx1-113013"></a><span
-class="cmtt-10">.xdy</span><a
- id="dx1-113014"></a>
-(<a
-href="#option3">Option 3</a>). This name may be changed using:
-</p><!--l. 5519--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113015"></a> <span
-class="cmtt-10">\setStyleFile{</span>⟨<span
-class="cmitt-10">name</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5521--><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="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5526--><p class="indent" > Each glossary entry is assigned a <a
-href="#glo:numberlist">number list<a
- id="dx1-113016"></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-113017"></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. 5533--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113018"></a> <span
-class="cmtt-10">\glsSetCompositor{</span>⟨<span
-class="cmitt-10">symbol</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5535--><p class="noindent" >
-For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-137">
-\glsSetCompositor{-}
-</pre>
-<!--l. 5539--><p class="nopar" > This command must not be used after <span
-class="cmtt-10">\makeglossaries</span>.
-</p><!--l. 5542--><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. 5544--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-113019"></a> <span
-class="cmtt-10">\glsSetAlphaCompositor{</span>⟨<span
-class="cmitt-10">symbol</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5546--><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-113020"></a>s</a> containing a mixture of
-A-1 and 2.3 style formats, then do:
-
-
-</p>
- <pre class="verbatim" id="verbatim-138">
-\glsSetCompositor{.}\glsSetAlphaCompositor{-}
-</pre>
-<!--l. 5552--><p class="nopar" > See <a
-href="#sec:numberlists">§<span
-class="cmbx-10">12</span> </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-113021"></a>s</a>.
-
-
-</p>
-<!--l. 5556--><p class="indent" > </div>
-</p><!--l. 5556--><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. 5559--><p class="indent" > <div title="bib2gls" style="border: solid 2pt green;"> If you want to use <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114001"></a></a>, entries must be defined in <span
-class="cmtt-10">bib</span><a
- id="dx1-114002"></a> files using the syntax described in the <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114003"></a></a>
-user manual. </div>
-</p><!--l. 5563--><p class="noindent" >
-</p><!--l. 5565--><p class="indent" > Acronyms are covered in <a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a> but they use the same
-underlying mechanism as all the other entries, so it’s a good idea to read this chapter first. The keys provided
-for <span
-class="cmtt-10">\newglossaryentry </span>can also be used in the optional argument of <span
-class="cmtt-10">\newacronym</span>, although some of them,
-such as <span
-class="cmtt-10">first</span><a
- id="dx1-114004"></a> and <span
-class="cmtt-10">plural</span><a
- id="dx1-114005"></a>, interfere with the acronym styles.
-</p><!--l. 5572--><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="cmbx-10">4.8</span> </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="cmbx-10">4.8</span> </a><a
-href="#sec:docdefs">Drawbacks With Defining Entries in the Document
-Environment<!--tex4ht:ref: sec:docdefs --></a>.)
-</p><!--l. 5581--><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-114006"></a>. <a
-href="#option4">Option 4</a> requires that definitions
-are provided in <span
-class="cmtt-10">bib</span><a
- id="dx1-114007"></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. 5587--><p class="noindent" >
-</p><!--l. 5589--><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="cmbx-10">5.1</span>
-</a><a
-href="#sec:glslink">Links to Glossary Entries<!--tex4ht:ref: sec:glslink --></a>, <a
-href="#sec:glsadd">§<span
-class="cmbx-10">10</span> </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="cmbx-10">11</span> </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="cmbx-10">8</span> </a><a
-href="#sec:printglossary">Displaying a
-Glossary<!--tex4ht:ref: sec:printglossary --></a> to find out how to display the glossary.
-</p><!--l. 5597--><p class="indent" > New glossary entries are defined using the command:
-</p><!--l. 5598--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-114008"></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. 5600--><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="cmtt-10">,</span>) or equal signs (<span
-class="cmtt-10">=</span>) with braces to hide them from the key=value list
-parser.
-</p><!--l. 5606--><p class="indent" > If you have a long description that needs to span multiple paragraphs, use
-</p><!--l. 5608--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-114009"></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 description</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-</p><!--l. 5611--><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. 5621--><p class="indent" > There are also commands that will only define the entry if it hasn’t already been defined:
-</p><!--l. 5623--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-114010"></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. 5625--><p class="noindent" >
-and
-</p><!--l. 5627--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-114011"></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="cmitt-10">long description</span>⟩<span
-class="cmtt-10">} </span></div><hr>
-
-
-</p><!--l. 5630--><p class="noindent" >
-(These are both preamble-only commands.)
-</p><!--l. 5633--><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. 5641--><p class="indent" > <div class="important" title="Important Note"> Note that although an <a
-href="#glo:exlatinchar">extended Latin character<a
- id="dx1-114012"></a></a> or other <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-114013"></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 LaTeX rather than XeLaTeX.) Also be careful of
-<span
-class="cmss-10">babel</span><a
- id="dx1-114014"></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. 5649--><p class="noindent" >
-</p><!--l. 5651--><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="cmtt-10">description</span><a
- id="dx1-114015"></a> and either <span
-class="cmtt-10">name</span><a
- id="dx1-114016"></a> or <span
-class="cmtt-10">parent</span><a
- id="dx1-114017"></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-114018"></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="cmss-10">glossaries-prefix</span><a
- id="dx1-114019"></a> (<a
-href="#sec:prefix">§<span
-class="cmbx-10">16</span> </a><a
-href="#sec:prefix">Prefixes or Determiners<!--tex4ht:ref: sec:prefix --></a>) and <span
-class="cmss-10">glossaries-accsupp</span><a
- id="dx1-114020"></a> (<a
-href="#sec:accsupp">§<span
-class="cmbx-10">17</span>
-</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="cmbx-10">4.3</span>
-</a><a
-href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>).
- </p><dl class="description"><dt class="description">
- <!--l. 5668--><p class="noindent" >
-<span
-class="cmtt-10">name</span><a
- id="dx1-114021"></a> </p></dt><dd
-class="description">
- <!--l. 5668--><p class="noindent" >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-114022"></a> key
- is supplied, this value will be the same as the parent’s name.
- </p><!--l. 5672--><p class="noindent" ><div class="important" title="Important Note"> If the <span
-class="cmtt-10">name</span><a
- id="dx1-114023"></a> key contains any commands, you must also use the <span
-class="cmtt-10">sort</span><a
- id="dx1-114024"></a> key (described below) if
- you intend sorting the entries alphabetically, otherwise the entries can’t be sorted correctly.
- </div>
- </p><!--l. 5676--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 5678--><p class="noindent" >
-<span
-class="cmtt-10">description</span><a
- id="dx1-114025"></a> </p></dt><dd
-class="description">
- <!--l. 5678--><p class="noindent" >A brief description of this term (to appear in the glossary). Within this value, you can use:
- </p><!--l. 5680--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-114026"></a> <span
-class="cmtt-10">\nopostdesc </span></div><hr>
- </p><!--l. 5682--><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. 5688--><p class="noindent" ><hr><div title="Definition"><a
- id="dx1-114027"></a> <span
-class="cmtt-10">\glspar </span></div><hr>
-
-
- </p><!--l. 5690--><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">\newline</span><a
- id="dx1-114028"></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. 5697--><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="textcolor258"><span
-class="cmtt-10">\glsxtrnopostpunc</span></span><a
- id="dx1-114029"></a> instead of <span
-class="cmtt-10">\nopostdesc </span>to suppress the post-description
- punctuation. </div>
- </p><!--l. 5700--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 5702--><p class="noindent" >
-<span
-class="cmtt-10">parent</span><a
- id="dx1-114030"></a> </p></dt><dd
-class="description">
- <!--l. 5702--><p class="noindent" >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="cmbx-10">4.5</span> </a><a
-href="#sec:subentries">Sub-Entries<!--tex4ht:ref: sec:subentries --></a> for further details.
- </p></dd><dt class="description">
- <!--l. 5706--><p class="noindent" >
-<span
-class="cmtt-10">descriptionplural</span><a
- id="dx1-114031"></a> </p></dt><dd
-class="description">
- <!--l. 5706--><p class="noindent" >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-114032"></a>
- key.
- </p></dd><dt class="description">
- <!--l. 5710--><p class="noindent" >
-<span
-class="cmtt-10">text</span><a
- id="dx1-114033"></a> </p></dt><dd
-class="description">
- <!--l. 5710--><p class="noindent" >How this entry will appear in the document text when using <span
-class="cmtt-10">\gls</span><a
- id="dx1-114034"></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-114035"></a> key is used.
- </p><!--l. 5714--><p class="noindent" >This key is automatically set by <span
-class="cmtt-10">\newacronym</span>. Although it is possible to override it by using <span
-class="cmtt-10">text</span><a
- id="dx1-114036"></a> in the
- optional argument of <span
-class="cmtt-10">\newacronym</span>, it will interfere with the acronym style and cause unexpected
- results.
- </p></dd><dt class="description">
- <!--l. 5719--><p class="noindent" >
-<span
-class="cmtt-10">first</span><a
- id="dx1-114037"></a> </p></dt><dd
-class="description">
- <!--l. 5719--><p class="noindent" >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-114038"></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-114039"></a> key is used. Note that if you use
- <span
-class="cmtt-10">\glspl</span><a
- id="dx1-114040"></a>, <span
-class="cmtt-10">\Glspl</span><a
- id="dx1-114041"></a>, <span
-class="cmtt-10">\GLSpl</span><a
- id="dx1-114042"></a>, <span
-class="cmtt-10">\glsdisp</span><a
- id="dx1-114043"></a> before using <span
-class="cmtt-10">\gls</span><a
- id="dx1-114044"></a>, the <span
-class="cmtt-10">first</span><a
- id="dx1-114045"></a> value won’t be used with
- <span
-class="cmtt-10">\gls</span><a
- id="dx1-114046"></a>.
- </p><!--l. 5726--><p class="noindent" >You may prefer to use abbreviations (<a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>) or the
- category post-link hook (<span id="textcolor259"><span
-class="cmtt-10">\glsdefpostlink</span></span><a
- id="dx1-114047"></a>) provided by <a
-href="#glo:glossaries-extra"><span
-class="cmss-10">glossaries-extra</span></a> if you would like to
- automatically append content on <a
-href="#glo:firstuse">first use</a> in a consistent manner. See, for example, <a
-href="https://www.dickimaw-books.com/gallery/index.php?label=sample-units" >Gallery: Units
- (<span
-class="cmss-10">glossaries-extra.sty</span>)</a>.
- </p><!--l. 5733--><p class="noindent" >Although it is possible to use <span
-class="cmtt-10">first</span><a
- id="dx1-114048"></a> in the optional argument of <span
-class="cmtt-10">\newacronym</span>, it can interfere with the
- acronym style and cause unexpected results.
-
-
- </p></dd><dt class="description">
- <!--l. 5737--><p class="noindent" >
-<span
-class="cmtt-10">plural</span><a
- id="dx1-114049"></a> </p></dt><dd
-class="description">
- <!--l. 5737--><p class="noindent" >How the entry will appear in the document text when using <span
-class="cmtt-10">\glspl</span><a
- id="dx1-114050"></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-114051"></a> to the value of the <span
-class="cmtt-10">text</span><a
- id="dx1-114052"></a> field.
- The default value of <span
-class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-114053"></a> is the letter “s”.
- </p><!--l. 5743--><p class="noindent" >Although it is possible to use <span
-class="cmtt-10">plural</span><a
- id="dx1-114054"></a> in the optional argument of <span
-class="cmtt-10">\newacronym</span>, it can interfere with the
- acronym style and cause unexpected results. Use <span
-class="cmtt-10">shortplural</span><a
- id="dx1-114055"></a> instead, if the default value is
- inappropriate.
- </p></dd><dt class="description">
- <!--l. 5748--><p class="noindent" >
-<span
-class="cmtt-10">firstplural</span><a
- id="dx1-114056"></a> </p></dt><dd
-class="description">
- <!--l. 5748--><p class="noindent" >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-114057"></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-114058"></a> key, if the <span
-class="cmtt-10">first</span><a
- id="dx1-114059"></a> key is omitted, or
- by appending <span
-class="cmtt-10">\glspluralsuffix</span><a
- id="dx1-114060"></a> to the value of the <span
-class="cmtt-10">first</span><a
- id="dx1-114061"></a> field, if the <span
-class="cmtt-10">first</span><a
- id="dx1-114062"></a> field is present. Note that if
- you use <span
-class="cmtt-10">\gls</span><a
- id="dx1-114063"></a>, <span
-class="cmtt-10">\Gls</span><a
- id="dx1-114064"></a>, <span
-class="cmtt-10">\GLS</span><a
- id="dx1-114065"></a>, <span
-class="cmtt-10">\glsdisp </span>before using <span
-class="cmtt-10">\glspl</span><a
- id="dx1-114066"></a>, the <span
-class="cmtt-10">firstplural</span><a
- id="dx1-114067"></a> value won’t be used with
- <span
-class="cmtt-10">\glspl</span><a
- id="dx1-114068"></a>.
- </p><!--l. 5758--><p class="noindent" >Although it is possible to use <span
-class="cmtt-10">firstplural</span><a
- id="dx1-114069"></a> in the optional argument of <span
-class="cmtt-10">\newacronym</span>, it can interfere with
- the acronym style and cause unexpected results. Use <span
-class="cmtt-10">shortplural</span><a
- id="dx1-114070"></a> and <span
-class="cmtt-10">longplural</span><a
- id="dx1-114071"></a> instead, if the default
- value is inappropriate.
- </p><!--l. 5764--><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-114072"></a> was always taken by appending “s” to the
- <span
-class="cmtt-10">first</span><a
- id="dx1-114073"></a> key, which meant that you had to specify both <span
-class="cmtt-10">plural</span><a
- id="dx1-114074"></a> and <span
-class="cmtt-10">firstplural</span><a
- id="dx1-114075"></a>, even if you hadn’t used
- the <span
-class="cmtt-10">first</span><a
- id="dx1-114076"></a> key.
- </p></dd><dt class="description">
- <!--l. 5770--><p class="noindent" >
-<span
-class="cmtt-10">symbol</span><a
- id="dx1-114077"></a> </p></dt><dd
-class="description">
- <!--l. 5770--><p class="noindent" >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.
- </p></dd><dt class="description">
- <!--l. 5774--><p class="noindent" >
-<span
-class="cmtt-10">symbolplural</span><a
- id="dx1-114078"></a> </p></dt><dd
-class="description">
- <!--l. 5774--><p class="noindent" >This is the plural form of the symbol (as passed to <span
-class="cmtt-10">\glsdisplay</span><a
- id="dx1-114079"></a> and <span
-class="cmtt-10">\glsdisplayfirst</span><a
- id="dx1-114080"></a> by <span
-class="cmtt-10">\glspl</span><a
- id="dx1-114081"></a>,
- <span
-class="cmtt-10">\Glspl</span><a
- id="dx1-114082"></a> and <span
-class="cmtt-10">\GLSpl</span><a
- id="dx1-114083"></a>). If omitted, the value is set to the same as the <span
-class="cmtt-10">symbol</span><a
- id="dx1-114084"></a> key.
- </p></dd><dt class="description">
- <!--l. 5779--><p class="noindent" >
-<span
-class="cmtt-10">sort</span><a
- id="dx1-114085"></a> </p></dt><dd
-class="description">
- <!--l. 5779--><p class="noindent" >This value indicates the text to be used by the sort comparator when ordering all the entries. If omitted,
- the value is given by the <span
-class="cmtt-10">name</span><a
- id="dx1-114086"></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-114087"></a> and <span
-class="cmss-10">sort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">use</span><a
- id="dx1-114088"></a> have been used.
- With <a
-href="#option2">Option 2</a> it’s best to use the <span
-class="cmtt-10">sort</span><a
- id="dx1-114089"></a> key if the <span
-class="cmtt-10">name</span><a
- id="dx1-114090"></a> contains commands (e.g. <span class="obeylines-h"><span class="verb"><span
-class="cmtt-10">\ensuremath{\alpha}</span></span></span>)
-
-
- and with Options <a
-href="#option1">1</a> and <a
-href="#option3">3</a>, it’s strongly recommended as the indexing may fail if you don’t (see
- below).
- </p><!--l. 5788--><p class="noindent" >You can also override the <span
-class="cmtt-10">sort</span><a
- id="dx1-114091"></a> key by redefining <span
-class="cmtt-10">\glsprestandardsort</span><a
- id="dx1-114092"></a> (see <a
-href="#sec:pkgopts-sort">§<span
-class="cmbx-10">2.5</span> </a><a
-href="#sec:pkgopts-sort">Sorting
- Options<!--tex4ht:ref: sec:pkgopts-sort --></a>).
- </p><!--l. 5791--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> The <span
-class="cmtt-10">sort</span><a
- id="dx1-114093"></a> key shouldn’t be used with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114094"></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-114095"></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. 5797--><p class="noindent" >
- </p><!--l. 5799--><p class="noindent" ><a
-href="#option1">Option 1</a> by default strips the <a
-href="#glo:latexexlatinchar">standard LaTeX accents</a> (that is, accents generated by core
- LaTeX commands) from the <span
-class="cmtt-10">name</span><a
- id="dx1-114096"></a> key when it sets the <span
-class="cmtt-10">sort</span><a
- id="dx1-114097"></a> key. So with <a
-href="#option1">Option 1</a>:
-
-
-</p>
- <pre class="verbatim" id="verbatim-139">
- \newglossaryentry{elite}{%
-   name={{\'e}lite},
-   description={select group of people}
- }
-</pre>
- <!--l. 5808--><p class="nopar" > This is equivalent to:
-
-
-</p>
- <pre class="verbatim" id="verbatim-140">
- \newglossaryentry{elite}{%
-   name={{\'e}lite},
-   description={select group of people},
-   sort={elite}
- }
-</pre>
- <!--l. 5816--><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-114098"></a>, in which case it’s equivalent to:
-
-
-</p>
- <pre class="verbatim" id="verbatim-141">
- \newglossaryentry{elite}{%
-   name={{\'e}lite},
-   description={select group of people},
-   sort={\'elite}
- }
-</pre>
- <!--l. 5825--><p class="nopar" > This will place the entry before the “A” letter group since the sort value starts with a symbol.
- </p><!--l. 5829--><p class="noindent" >Similarly if you use the <span
-class="cmss-10">inputenc</span><a
- id="dx1-114099"></a> package: </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><span
-class="cmtt-10">é</span><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 equivalent to <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><span
-class="cmtt-10">é</span><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><span
-class="cmtt-10"> sort=elite</span>
- <br /><span
-class="cmtt-10">}</span>
-</div>
- </div> 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-114100"></a>, in which case it’s equivalent to: <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><span
-class="cmtt-10">é</span><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><span
-class="cmtt-10"> sort=</span><span
-class="cmtt-10">é</span><span
-class="cmtt-10">lite</span>
- <br /><span
-class="cmtt-10">}</span>
-</div>
- </div> Again, this will place the entry before the “A” group.
- <!--l. 5855--><p class="noindent" >With Options <a
-href="#option2">2</a> and <a
-href="#option3">3</a>, the default value of <span
-class="cmtt-10">sort</span><a
- id="dx1-114101"></a> will either be set to the <span
-class="cmtt-10">name</span><a
- id="dx1-114102"></a> key (if <span
-class="cmss-10">sanitizesort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">true</span><a
- id="dx1-114103"></a>) or
- it will set it to the expansion of the <span
-class="cmtt-10">name</span><a
- id="dx1-114104"></a> key (if <span
-class="cmss-10">sanitizesort</span><span
-class="cmtt-10">=</span><span
-class="cmss-10">false</span><a
- id="dx1-114105"></a>).
-
-
- </p><!--l. 5860--><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-114106"></a></a> (<a
-href="#option3">Option 3</a>): if you have entries with the same <span
-class="cmtt-10">sort</span><a
- id="dx1-114107"></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-114108"></a></a> and aren’t using the <span
-class="cmtt-10">def </span>or <span
-class="cmtt-10">use </span>sort methods, <strong>always</strong> use
- the <span
-class="cmtt-10">sort</span><a
- id="dx1-114109"></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. 5868--><p class="noindent" >Take care if you use <a
-href="#option1">Option 1</a> and the <span
-class="cmtt-10">name</span><a
- id="dx1-114110"></a> contains fragile commands. You will either need to explicitly
- set the <span
-class="cmtt-10">sort</span><a
- id="dx1-114111"></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-114112"></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. 5872--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 5874--><p class="noindent" >
-<span
-class="cmtt-10">type</span><a
- id="dx1-114113"></a> </p></dt><dd
-class="description">
- <!--l. 5874--><p class="noindent" >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-114114"></a> is used (see <a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other
- Abbreviations<!--tex4ht:ref: sec:acronyms --></a>).
- </p></dd><dt class="description">
- <!--l. 5880--><p class="noindent" >
-<span
-class="cmtt-10">user1</span><a
- id="dx1-114115"></a><span
-class="cmbx-10">, </span><span
-class="cmbx-10">…, </span><span
-class="cmtt-10">user6</span><a
- id="dx1-114116"></a><a
- id="dx1-114117"></a><a
- id="dx1-114118"></a><a
- id="dx1-114119"></a><a
- id="dx1-114120"></a> </p></dt><dd
-class="description">
- <!--l. 5880--><p class="noindent" >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-114121"></a> or <span
-class="cmtt-10">\glsaddstoragekey</span><a
- id="dx1-114122"></a> (see <a
-href="#sec:addkey">§<span
-class="cmbx-10">4.3</span> </a><a
-href="#sec:addkey">Additional
- Keys<!--tex4ht:ref: sec:addkey --></a>).
- </p></dd><dt class="description">
- <!--l. 5886--><p class="noindent" >
-<span
-class="cmtt-10">nonumberlist</span><a
- id="dx1-114123"></a> </p></dt><dd
-class="description">
- <!--l. 5886--><p class="noindent" >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-114124"></a></a> just for this
- entry. Conversely, if you have used the package option <span
-class="cmss-10">nonumberlist</span><a
- id="dx1-114125"></a>, you can activate the
- number list<a
- id="dx1-114126"></a> just for this entry with <span
-class="cmtt-10">nonumberlist=false</span><a
- id="dx1-114127"></a>. (See <a
-href="#sec:numberlists">§<span
-class="cmbx-10">12</span> </a><a
-href="#sec:numberlists">Number
- Lists<!--tex4ht:ref: sec:numberlists --></a>.)
- </p></dd><dt class="description">
- <!--l. 5893--><p class="noindent" >
-<span
-class="cmtt-10">see</span><a
- id="dx1-114128"></a> </p></dt><dd
-class="description">
- <!--l. 5893--><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
-class="cmitt-10">tag</span>⟩<span
-class="cmtt-10">]{</span>⟨<span
-class="cmitt-10">label</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-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. (See <a
-href="#sec:crossref">§<span
-class="cmbx-10">11</span> </a><a
-href="#sec:crossref">Cross-Referencing Entries<!--tex4ht:ref: sec:crossref --></a>.) It was originally designed
- for synonyms that may not occur in the document text but needed to be included in the glossary in order
- to redirect the reader. Note that it doesn’t index the cross-referenced entry (or entries) as that would
- interfere with their <a
-href="#glo:numberlist">number list<a
- id="dx1-114129"></a>s</a>.
- <!--l. 5904--><p class="noindent" ><div class="important" title="Important Note"> Using the <span
-class="cmtt-10">see</span><a
- id="dx1-114130"></a> key will <span
-class="cmti-10">automatically add this entry to the glossary</span>, but will not automatically add the
- cross-referenced entry. </div>
- </p><!--l. 5908--><p class="noindent" >
- </p><!--l. 5910--><p class="noindent" >For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-142">
- \newglossaryentry{courgette}{name={courgette},
-   description={variety of small marrow}}
- \newglossaryentry{zucchini}{name={zucchini},
-   description={(North American)},
-   see={courgette}}
-</pre>
- <!--l. 5917--><p class="nopar" > This defines two entries (courgette and zucchini) and automatically adds a cross-reference from zucchini
- to courgette. (That is, it adds “<span
-class="cmti-10">see </span>courgette” to zucchini’s <a
-href="#glo:numberlist">number list<a
- id="dx1-114131"></a></a>.) This doesn’t automatically index
- courgette since this would create an unwanted location in courgette’s <a
-href="#glo:numberlist">number list<a
- id="dx1-114132"></a></a>. (Page 1, if the
- definitions occur in the preamble.)
- </p><!--l. 5925--><p class="noindent" >Note that while it’s possible to put the cross-reference in the description instead, for example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-143">
- \newglossaryentry{zucchini}{name={zucchini},
-   description={(North American) see \gls{courgette}}}
-</pre>
- <!--l. 5930--><p class="nopar" > this won’t index the zucchini entry, so if zucchini isn’t indexed elsewhere (with commands like <span
-class="cmtt-10">\gls </span>or
- <span
-class="cmtt-10">\glsadd</span>) then it won’t appear in the glossary even if courgette does.
- </p><!--l. 5935--><p class="noindent" >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>. <strong>Note that if you have suppressed the <a
-href="#glo:numberlist">number list<a
- id="dx1-114133"></a></a>, the cross-referencing
- information won’t appear in the glossary, as it forms part of the number list<a
- id="dx1-114134"></a>.</strong> You can override this for
- individual glossary entries using <span
-class="cmtt-10">nonumberlist=false</span><a
- id="dx1-114135"></a> (see above). Alternatively, you can use the
- <span
-class="cmss-10">seeautonumberlist</span><a
- id="dx1-114136"></a> package option. For further details, see <a
-href="#sec:crossref">§<span
-class="cmbx-10">11</span> </a><a
-href="#sec:crossref">Cross-Referencing
- Entries<!--tex4ht:ref: sec:crossref --></a>.
- </p><!--l. 5946--><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-114137"></a> must be used before any occurrence of <span
-class="cmtt-10">\newglossaryentry</span><a
- id="dx1-114138"></a> that
- contains the <span
-class="cmtt-10">see</span><a
- id="dx1-114139"></a> key. This key should not be used with entries defined in the <span
-class="cmss-10">document</span><a
- id="dx1-114140"></a><a
- id="dx1-114141"></a> environment.
- </div>
- </p><!--l. 5950--><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-114142"></a> package option to warn or ignore the <span
-class="cmtt-10">see</span><a
- id="dx1-114143"></a> key while <span
-class="cmtt-10">\makeglossaries </span>is commented
- out.
- </p><!--l. 5956--><p class="noindent" >If you use the <span
-class="cmtt-10">see</span><a
- id="dx1-114144"></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="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="cmtt-10">see</span><a
- id="dx1-114145"></a> key,
- consider using <a
-href="#option4">Option 4</a>. See also the FAQ item <a
-href="https://www.dickimaw-books.com/faq.php?action=view&category=glossaries&itemlabel=whyseekeyautoindex" >Why does the see key automatically index the
- entry?</a>
- </p><!--l. 5963--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> The analogous <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114146"></a></a> <span
-class="cmtt-10">see</span><a
- id="dx1-114147"></a> field (and <span id="textcolor260"><span id="textcolor261"><span
-class="cmtt-10">seealso</span></span><a
- id="dx1-114148"></a></span>) have a slightly different meaning. The <span id="textcolor262"><span
-class="cmtt-10">selection</span></span><a
- id="dx1-114149"></a>
- resource option determines the behaviour. </div>
- </p><!--l. 5967--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 5969--><p class="noindent" >
-<span id="textcolor263"><span id="textcolor264"><span
-class="cmtt-10">seealso</span></span><a
- id="dx1-114150"></a></span> </p></dt><dd
-class="description">
- <!--l. 5969--><p class="noindent" >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-114151"></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="textcolor265"><span
-class="cmtt-10">\seealsoname</span></span><a
- id="dx1-114152"></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="textcolor266"><span
-class="cmtt-10">\seealsoname</span></span><a
- id="dx1-114153"></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).
- </p></dd><dt class="description">
- <!--l. 5977--><p class="noindent" >
-<span id="textcolor267"><span id="textcolor268"><span
-class="cmtt-10">alias</span></span><a
- id="dx1-114154"></a></span> </p></dt><dd
-class="description">
-
-
- <!--l. 5977--><p class="noindent" >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.
- (See, for example, <a
-href="https://www.dickimaw-books.com/gallery/index.php?label=aliases" >Gallery: Aliases</a>.)
- </p><!--l. 5986--><p class="noindent" ><div title="bib2gls" style="border: solid 2pt green;"> More variations with the key are available with <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114155"></a></a>. </div>
- </p><!--l. 5988--><p class="noindent" >
- </p></dd><dt class="description">
- <!--l. 5990--><p class="noindent" >
-<span id="textcolor269"><span id="textcolor270"><span
-class="cmtt-10">category</span></span><a
- id="dx1-114156"></a></span> </p></dt><dd
-class="description">
- <!--l. 5990--><p class="noindent" >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.
-</p>
- </dd></dl>
-<!--l. 5998--><p class="indent" > The following keys are reserved for <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-114157"></a> (see <a
-href="#sec:acronyms">§<span
-class="cmbx-10">6</span> </a><a
-href="#sec:acronyms">Acronyms and Other Abbreviations<!--tex4ht:ref: sec:acronyms --></a>)
-and also for <span id="textcolor271"><span
-class="cmtt-10">\newabbreviation</span></span><a
- id="dx1-114158"></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-114159"></a>, <span
-class="cmtt-10">longplural</span><a
- id="dx1-114160"></a>, <span
-class="cmtt-10">short</span><a
- id="dx1-114161"></a> and
-<span
-class="cmtt-10">shortplural</span><a
- id="dx1-114162"></a>.
-</p><!--l. 6003--><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-114163"></a></a>. See the <a
-href="#glo:bib2gls"><span
-class="cmtt-10">bib2gls</span><a
- id="dx1-114164"></a></a> manual for further details.
-</div>
-</p><!--l. 6006--><p class="noindent" >
-</p><!--l. 6008--><p class="indent" > The supplementary packages <span
-class="cmss-10">glossaries-prefix </span>(<a
-href="#sec:prefix">§<span
-class="cmbx-10">16</span> </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">§<span
-class="cmbx-10">17</span> </a><a
-href="#sec:accsupp">Accessibility Support<!--tex4ht:ref: sec:accsupp --></a>) provide additional keys.
-</p><!--l. 6011--><p class="indent" > <div class="important" title="Important Note"> Avoid using any of the <a
-href="#x1-1310005.1.1"><span
-class="cmtt-10">\gls</span>-like</a> or <a
-href="#x1-1320005.1.2"><span
-class="cmtt-10">\glstext</span>-like</a> commands within the <span
-class="cmtt-10">text</span><a
- id="dx1-114165"></a>, <span
-class="cmtt-10">first</span><a
- id="dx1-114166"></a>, <span
-class="cmtt-10">short</span><a
- id="dx1-114167"></a> or <span
-class="cmtt-10">long</span><a
- id="dx1-114168"></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-114169"></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-114170"></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. 6024--><p class="noindent" >
-</p><!--l. 6026--><p class="indent" > Note that if the name starts with <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-114171"></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-114172"></a> and <span
-class="cmtt-10">\Glspl</span><a
- id="dx1-114173"></a>. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-144">
-\newglossaryentry{elite}{name={{\'e}lite},
-description={select group or class}}
-</pre>
-<!--l. 6033--><p class="nopar" > Note that the same applies if you are using the <span
-class="cmss-10">inputenc</span><a
- id="dx1-114174"></a> package: </p><div class="alltt">
-<div class="obeylines-v">
-<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={select</span><span
-class="cmtt-10"> group</span><span
-class="cmtt-10"> or</span><span
-class="cmtt-10"> class}}</span>
-</div>
-</div> (This doesn’t apply for XeLaTeX or LuaLaTeX documents. For further details, see the “UTF-8” section in the
-<span
-class="cmss-10">mfirstuc</span><a
- id="dx1-114175"></a> user manual.)
-<!--l. 6044--><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-114176"></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-114177"></a></a> (<a
-href="#option3">Option 3</a>) is usually able to sort <a
-href="#glo:nonlatinchar">non-Latin character<a
- id="dx1-114178"></a>s</a> correctly.
-<a
-href="#option1">Option 1</a> discards accents from <a
-href="#glo:latexexlatinchar">standard LaTeX extended Latin character<a
- id="dx1-114179"></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-114180"></a>.
-</p>
-<!--l. 6052--><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. 6055--><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. 6058--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-115001"></a> <span
-class="cmtt-10">\glspluralsuffix </span></div><hr>
-</p><!--l. 6060--><p class="noindent" >
-to the singular form. This command defaults to the letter “s”. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-145">
-\newglossaryentry{cow}{name=cow,description={a fully grown
-female of any bovine animal}}
-</pre>
-<!--l. 6066--><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>
- <pre class="verbatim" id="verbatim-146">
-\newglossaryentry{cow}{name=cow,plural=kine,
-description={a fully grown female of any bovine animal}}
-</pre>
-<!--l. 6074--><p class="nopar" >
-</p><!--l. 6076--><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-115002"></a> key for
-one of them and one of the user keys to specify the other plural form. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-147">
-\newglossaryentry{cow}{%
-  name=cow,%
-  description={a fully grown female of any bovine animal
-               (plural cows, archaic plural kine)},%
-  user1={kine}}
-</pre>
-<!--l. 6086--><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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-148">
-\let\glsaltpl\glsuseri
-</pre>
-<!--l. 6092--><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-115003"></a>, described in <a
-href="#sec:addkey">§<span
-class="cmbx-10">4.3</span> </a><a
-href="#sec:addkey">Additional Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 6097--><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-115004"></a> key (and the <span
-class="cmtt-10">firstplural</span><a
- id="dx1-115005"></a> key where necessary).
-</p><!--l. 6105--><p class="noindent" >
-</p>
-<!--l. 6105--><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. 6108--><p class="noindent" >You can use the six user keys to provide alternatives, such as participles. For example:
-
-
-</p>
- <pre class="verbatim" id="verbatim-149">
-\let\glsing\glsuseri
-\let\glsd\glsuserii
-\newcommand*{\ingkey}{user1}
-\newcommand*{\edkey}{user2}
-\newcommand*{\newword}[3][]{%
-  \newglossaryentry{#2}{%
-   name={#2},%
-   description={#3},%
-   \edkey={#2ed},%
-   \ingkey={#2ing},#1%
-  }%
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1121"></a><dfn id="glo:file.example-glossaries-acronym.tex"><span class="filefmt">example-glossaries-acronym.tex</span></dfn></div><!-- end of filedef -->
+ These entries are all <a id="wrglossary.1122"></a><a href="#glo:idx.acronym">acronyms</a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1123"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1124"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>[<a id="wrglossary.1125"></a><a href="#glo:opt.gloskey.type"><span class="csoptfmt">type</span></a><span class="optfmt">={<a id="wrglossary.1126"></a><a href="#glo:glsdefaulttype"><code class="csfmt">\glsdefaulttype</code></a>}</span>]{lid}{LID}{lorem ipsum
+dolor}
+</pre> <div class="information"><div class="informationtitle"><a id="wrglossary.1127"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ If you use the <a id="wrglossary.1128"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package, then <a id="wrglossary.1129"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a> is redefined to use <a id="wrglossary.1130"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a> with the <a id="wrglossary.1131"></a><a href="#glo:opt.gloskey.category"><span class="xtrcsoptfmt">category</span></a> key set to <a id="wrglossary.1132"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> (rather than the default <a id="wrglossary.1133"></a><a href="#glo:opt.cat.abbreviation"><span class="catfmt">abbreviation</span></a>). This means that you need to set the <a id="wrglossary.1134"></a><a href="#glo:idx.abbrvstyle"><span class="xtrfmt">abbreviation</span> style</a> for the <a id="wrglossary.1135"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> category. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1136"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1137"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>[acronym]{<a id="wrglossary.1138"></a><a href="#glo:opt.abbrstyle.long-short"><span class="abbrstylefmt">long-short</span></a>}
+</pre> </div><!-- end of information -->
+<p>
+<div class="filedef">🗋 <a id="wrglossary.1139"></a><dfn id="glo:file.example-glossaries-acronym-desc.tex"><span class="filefmt">example-glossaries-acronym-desc.tex</span></dfn></div><!-- end of filedef -->
+ This file contains entries that are all <a id="wrglossary.1140"></a><a href="#glo:idx.acronym">acronyms</a> that use the <a id="wrglossary.1141"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1142"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1143"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>[<a id="wrglossary.1144"></a><a href="#glo:opt.gloskey.type"><span class="csoptfmt">type</span></a><span class="optfmt">={<a id="wrglossary.1145"></a><a href="#glo:glsdefaulttype"><code class="csfmt">\glsdefaulttype</code></a>}</span>,
+ <a id="wrglossary.1146"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={fringilla a, euismod sodales, sollicitudin vel, wisi}</span>]{ndl}{NDL}{nam dui ligula}
+</pre> <div class="information"><div class="informationtitle"><a id="wrglossary.1147"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ If you use the <a id="wrglossary.1148"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package, then <a id="wrglossary.1149"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a> is redefined to use <a id="wrglossary.1150"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a> with the <a id="wrglossary.1151"></a><a href="#glo:opt.gloskey.category"><span class="xtrcsoptfmt">category</span></a> key set to <a id="wrglossary.1152"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> (rather than the default <a id="wrglossary.1153"></a><a href="#glo:opt.cat.abbreviation"><span class="catfmt">abbreviation</span></a>). This means that you need to set the <a id="wrglossary.1154"></a><a href="#glo:idx.abbrvstyle"><span class="xtrfmt">abbreviation</span> style</a> for the <a id="wrglossary.1155"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> category. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1156"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1157"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>[<a id="wrglossary.1158"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a>]{<a id="wrglossary.1159"></a><a href="#glo:opt.abbrstyle.long-short-desc"><span class="abbrstylefmt">long-short-desc</span></a>}
+</pre> </div><!-- end of information -->
+<p>
+<div class="filedef">🗋 <a id="wrglossary.1160"></a><dfn id="glo:file.example-glossaries-acronyms-lang.tex"><span class="filefmt">example-glossaries-acronyms-lang.tex</span></dfn></div><!-- end of filedef -->
+ These entries are all <a id="wrglossary.1161"></a><a href="#glo:idx.acronym">acronyms</a>, where some of them have a translation supplied in the <a id="wrglossary.1162"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1163"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1164"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>[<a id="wrglossary.1165"></a><a href="#glo:opt.gloskey.type"><span class="csoptfmt">type</span></a><span class="optfmt">={<a id="wrglossary.1166"></a><a href="#glo:glsdefaulttype"><code class="csfmt">\glsdefaulttype</code></a>}</span>,<a id="wrglossary.1167"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a><span class="optfmt">={love itself}</span>]
+ {li}{LI}{lorem ipsum}
+</pre> <div class="information"><div class="informationtitle"><a id="wrglossary.1168"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ If you use the <a id="wrglossary.1169"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> extension package, then <a id="wrglossary.1170"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a> is redefined to use <a id="wrglossary.1171"></a><a href="#glo:newabbreviation"><code class="xtrcsfmt">\newabbreviation</code></a> with the <a id="wrglossary.1172"></a><a href="#glo:opt.gloskey.category"><span class="xtrcsoptfmt">category</span></a> key set to <a id="wrglossary.1173"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> (rather than the default <a id="wrglossary.1174"></a><a href="#glo:opt.cat.abbreviation"><span class="catfmt">abbreviation</span></a>). This means that you need to set the <a id="wrglossary.1175"></a><a href="#glo:idx.abbrvstyle"><span class="xtrfmt">abbreviation</span> style</a> for the <a id="wrglossary.1176"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> category. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1177"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1178"></a><a href="#glo:setabbreviationstyle"><code class="xtrcsfmt">\setabbreviationstyle</code></a>[<a id="wrglossary.1179"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a>]{<a id="wrglossary.1180"></a><a href="#glo:opt.abbrstyle.long-short-user"><span class="abbrstylefmt">long-short-user</span></a>}
+</pre> </div><!-- end of information -->
+<p>
+<div class="filedef">🗋 <a id="wrglossary.1181"></a><dfn id="glo:file.example-glossaries-parent.tex"><span class="filefmt">example-glossaries-parent.tex</span></dfn></div><!-- end of filedef -->
+ These are hierarchical entries where the child entries use the <a id="wrglossary.1182"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1183"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1184"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{sedmattis}{<a id="wrglossary.1185"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sed mattis}</span>,
+<a id="wrglossary.1186"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={erat sit amet}</span>}
+
+<a id="wrglossary.1187"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{gravida}{<a id="wrglossary.1188"></a><a href="#glo:opt.gloskey.parent"><span class="csoptfmt">parent</span></a><span class="optfmt">={sedmattis}</span>,
+ <a id="wrglossary.1189"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={gravida}</span>,<a id="wrglossary.1190"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={malesuada}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1191"></a><dfn id="glo:file.example-glossaries-childnoname.tex"><span class="filefmt">example-glossaries-childnoname.tex</span></dfn></div><!-- end of filedef -->
+ These are hierarchical entries where the child entries don’t use the <a id="wrglossary.1192"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1193"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1194"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{scelerisque}{<a id="wrglossary.1195"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={scelerisque}</span>,
+ <a id="wrglossary.1196"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={at}</span>}
+
+<a id="wrglossary.1197"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{vestibulum}{<a id="wrglossary.1198"></a><a href="#glo:opt.gloskey.parent"><span class="csoptfmt">parent</span></a><span class="optfmt">={scelerisque}</span>,
+ <a id="wrglossary.1199"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={eu, nulla}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1200"></a><dfn id="glo:file.example-glossaries-longchild.tex"><span class="filefmt">example-glossaries-longchild.tex</span></dfn></div><!-- end of filedef -->
+ These entries all have long descriptions and there are some child entries. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1201"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1202"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{longsedmattis}{<a id="wrglossary.1203"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sed mattis}</span>,
+ <a id="wrglossary.1204"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={erat sit amet dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris.}</span>}
+
+<a id="wrglossary.1205"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{longgravida}{<a id="wrglossary.1206"></a><a href="#glo:opt.gloskey.parent"><span class="csoptfmt">parent</span></a><span class="optfmt">={longsedmattis}</span>,<a id="wrglossary.1207"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={gravida}</span>,
+ <a id="wrglossary.1208"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={malesuada libero, nonummy eget, consectetuer id, vulputate a, magna. Donec vehicula augue eu neque. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Mauris ut leo.}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1209"></a><dfn id="glo:file.example-glossaries-childmultipar.tex"><span class="filefmt">example-glossaries-childmultipar.tex</span></dfn></div><!-- end of filedef -->
+ This consists of parent entries with single paragraph descriptions and child entries with multi-paragraph descriptions. Some entries have the <a id="wrglossary.1210"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a> key set to the name of an image file provided by the <a id="wrglossary.1211"></a><a href="#glo:pkg.mwe"><span class="styfmt">mwe</span></a> package. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1212"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1213"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{hiersedmattis}{<a id="wrglossary.1214"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sed mattis}</span>,<a id="wrglossary.1215"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a><span class="optfmt">={example-image}</span>,
+ <a id="wrglossary.1216"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={Erat sit amet dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum gravida mauris. Ut pellentesque augue sed urna. Vestibulum diam eros, fringilla et, consectetuer eu, nonummy id, sapien. Nullam at lectus. In sagittis ultrices mauris. Curabitur malesuada erat sit amet massa. Fusce blandit. Aliquam erat volutpat.}</span>}
+
+<a id="wrglossary.1217"></a><a href="#glo:longnewglossaryentry"><code class="csfmt">\longnewglossaryentry</code></a>{hierloremi-ii}
+{<a id="wrglossary.1218"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={lorem 1--2}</span>,<a id="wrglossary.1219"></a><a href="#glo:opt.gloskey.parent"><span class="csoptfmt">parent</span></a><span class="optfmt">={hiersedmattis}</span>}<span class="comment">% </span>
+{<span class="comment">% </span>
+Lorem ipsum ...
+
+Nam dui ligula...
}
-</pre>
-<!--l. 6125--><p class="nopar" > With the above definitions, I can now define terms like this:
-
-
-</p>
- <pre class="verbatim" id="verbatim-150">
-\newword{play}{to take part in activities for enjoyment}
-\newword[\edkey={ran},\ingkey={running}]{run}{to move fast using
-the legs}
-</pre>
-<!--l. 6131--><p class="nopar" > and use them in the text:
-
-
-</p>
- <pre class="verbatim" id="verbatim-151">
-Peter is \glsing{play} in the park today.
-Jane \glsd{play} in the park yesterday.
-Peter and Jane \glsd{run} in the park last week.
-</pre>
-<!--l. 6139--><p class="nopar" >
-</p><!--l. 6141--><p class="indent" > Alternatively, you can define your own keys using <span
-class="cmtt-10">\glsaddkey</span><a
- id="dx1-116001"></a>, described below in <a
-href="#sec:addkey">§<span
-class="cmbx-10">4.3</span> </a><a
-href="#sec:addkey">Additional
-Keys<!--tex4ht:ref: sec:addkey --></a>.
-</p><!--l. 6144--><p class="noindent" >
-</p>
-<!--l. 6144--><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. 6147--><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. 6152--><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="cmbx-10">4.3.1</span> </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="cmbx-10">4.3.2</span> </a><a
-href="#sec:glsaddstoragekey">Storage Keys<!--tex4ht:ref: sec:glsaddstoragekey --></a>.
-</p><!--l. 6160--><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. 6167--><p class="noindent" >
-</p>
-<!--l. 6167--><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. 6170--><p class="noindent" >A custom key that can be used in the document is defined using:
-</p><!--l. 6171--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-118001"></a> <span
-class="cmtt-10">\glsaddkey{</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>⟨<span
-class="cmitt-10">no link ucfirst cs</span>⟩<span
-class="cmtt-10">}{</span>⟨<span
-class="cmitt-10">link cs</span>⟩<span
-class="cmtt-10">}{</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. 6179--><p class="noindent" >
-where:
- </p><dl class="description"><dt class="description">
- <!--l. 6182--><p class="noindent" >
-⟨<span
-class="cmbxti-10">key</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6182--><p class="noindent" >is the new key to use in <span
-class="cmtt-10">\newglossaryentry</span><a
- id="dx1-118002"></a> (or similar commands such as
- <span
-class="cmtt-10">\longnewglossaryentry</span><a
- id="dx1-118003"></a>);
-
-
- </p></dd><dt class="description">
- <!--l. 6184--><p class="noindent" >
-⟨<span
-class="cmbxti-10">default value</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6184--><p class="noindent" >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);
- </p></dd><dt class="description">
- <!--l. 6189--><p class="noindent" >
-⟨<span
-class="cmbxti-10">no link cs</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6189--><p class="noindent" >is the control sequence to use analogous to commands like <span
-class="cmtt-10">\glsentrytext</span><a
- id="dx1-118004"></a>;
- </p></dd><dt class="description">
- <!--l. 6191--><p class="noindent" >
-⟨<span
-class="cmbxti-10">no link ucfirst cs</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6191--><p class="noindent" >is the control sequence to use analogous to commands like <span
-class="cmtt-10">\Glsentrytext</span><a
- id="dx1-118005"></a>;
- </p></dd><dt class="description">
- <!--l. 6193--><p class="noindent" >
-⟨<span
-class="cmbxti-10">link cs</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6193--><p class="noindent" >is the control sequence to use analogous to commands like <span
-class="cmtt-10">\glstext</span><a
- id="dx1-118006"></a>;
- </p></dd><dt class="description">
- <!--l. 6195--><p class="noindent" >
-⟨<span
-class="cmbxti-10">link ucfirst cs</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6195--><p class="noindent" >is the control sequence to use analogous to commands like <span
-class="cmtt-10">\Glstext</span><a
- id="dx1-118007"></a>;
- </p></dd><dt class="description">
- <!--l. 6197--><p class="noindent" >
-⟨<span
-class="cmbxti-10">link allcaps cs</span>⟩ </p></dt><dd
-class="description">
- <!--l. 6197--><p class="noindent" >is the control sequence to use analogous to commands like <span
-class="cmtt-10">\GLStext</span><a
- id="dx1-118008"></a>.</p></dd></dl>
-<!--l. 6200--><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-118009r3"></a>
-</p><!--l. 6204--><p class="noindent" ><span
-class="cmbx-12">Example 3</span><span
-class="cmbx-12"> (Defining Custom Keys)</span><a
- id="x1-118010"></a>
-</p><!--l. 6205--><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:
-
-
-</p>
- <pre class="verbatim" id="verbatim-152">
- % Define "ed" key:
- \glsaddkey*
-  {ed}% key
-  {\glsentrytext{\glslabel}ed}% default value
-  {\glsentryed}% command analogous to \glsentrytext
-  {\Glsentryed}% command analogous to \Glsentrytext
-  {\glsed}% command analogous to \glstext
-  {\Glsed}% command analogous to \Glstext
-  {\GLSed}% command analogous to \GLStext
- % Define "ing" key:
- \glsaddkey*
-  {ing}% key
-  {\glsentrytext{\glslabel}ing}% default value
-  {\glsentrying}% command analogous to \glsentrytext
-  {\Glsentrying}% command analogous to \Glsentrytext
-  {\glsing}% command analogous to \glstext
-  {\Glsing}% command analogous to \Glstext
-  {\GLSing}% command analogous to \GLStext
-</pre>
-<!--l. 6229--><p class="nopar" > Now I can define some entries:
-
-
-</p>
- <pre class="verbatim" id="verbatim-153">
- % No need to override defaults for this entry:
- \newglossaryentry{jump}{name={jump},description={}}
- % Need to override defaults on these entries:
- \newglossaryentry{run}{name={run},%
-   ed={ran},%
-   ing={running},%
-   description={}}
- \newglossaryentry{waddle}{name={waddle},%
-   ed={waddled},%
-   ing={waddling},%
-   description={}}
-</pre>
-<!--l. 6247--><p class="nopar" >
-</p><!--l. 6249--><p class="indent" > These entries can later be used in the document:
-
-
-</p>
- <pre class="verbatim" id="verbatim-154">
-The dog \glsed{jump} over the duck.
-The duck was \glsing{waddle} round the dog.
-The dog \glsed{run} away from the duck.
-</pre>
-<!--l. 6256--><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. 6258--><p class="noindent" >
-</p><!--l. 6258--><p class="noindent" >____________________________</p></div>
-<!--l. 6260--><p class="noindent" >
-</p>
-<!--l. 6260--><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. 6263--><p class="noindent" >A custom key that can be used for simply storing information is defined using:
-</p><!--l. 6265--><p class="indent" > <hr><div title="Definition"><a
- id="dx1-119001"></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. 6267--><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="cmbx-10">4.3.1</span>
-</a><a
-href="#sec:glsaddkey">Document Keys<!--tex4ht:ref: sec:glsaddkey --></a>.
-</p><!--l. 6271--><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="cmbx-10">15.3</span> </a><a
-href="#sec:fetchset">Fetching and
-Updating the Value of a Field<!--tex4ht:ref: sec:fetchset --></a>.
-<a
- id="x1-119002r4"></a>
-</p><!--l. 6276--><p class="noindent" ><span
-class="cmbx-12">Example 4</span><span
-class="cmbx-12"> (Defining Custom Storage Key (Acronyms and Initialisms))</span><a
- id="x1-119003"></a>
-</p><!--l. 6277--><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. 6284--><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):
-
-
-</p>
- <pre class="verbatim" id="verbatim-155">
-\glsaddstoragekey
- {abbrtype}% key/field name
- {word}% default value if not explicitly set
- {\abbrtype}% custom command to access the value if required
-</pre>
-<!--l. 6293--><p class="nopar" >
-</p><!--l. 6295--><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>
- <pre class="verbatim" id="verbatim-156">
-\newacronymstyle
- {mystyle}% style name
- {% Use the generic display
-   \ifglshaslong{\glslabel}{\glsgenacfmt}{\glsgenentryfmt}%
- }
- {% Put the long form in the description
-   \renewcommand*{\GenericAcronymFields}{%
-       description={\the\glslongtok}}%
-   % For the full format, test the value of the "abbrtype" key.
-   % If it's set to "word" put the short form first with
-   % the long form in brackets.
-   \renewcommand*{\genacrfullformat}[2]{%
-    \ifglsfieldeq{##1}{abbrtype}{word}
-    {% is a proper acronym
-      \protect\firstacronymfont{\glsentryshort{##1}}##2\space
-       (\glsentrylong{##1})%
-    }
-    {% is another form of abbreviation
-     \glsentrylong{##1}##2\space
-      (\protect\firstacronymfont{\glsentryshort{##1}})%
-    }%
-  }%
-  % first letter upper case version:
-   \renewcommand*{\Genacrfullformat}[2]{%
-    \ifglsfieldeq{##1}{abbrtype}{word}
-    {% is a proper acronym
-      \protect\firstacronymfont{\Glsentryshort{##1}}##2\space
-       (\glsentrylong{##1})%
-    }
-    {% is another form of abbreviation
-     \Glsentrylong{##1}##2\space
-      (\protect\firstacronymfont{\glsentryshort{##1}})%
-    }%
-  }%
-  % plural
-   \renewcommand*{\genplacrfullformat}[2]{%
-    \ifglsfieldeq{##1}{abbrtype}{word}
-    {% is a proper acronym
-      \protect\firstacronymfont{\glsentryshortpl{##1}}##2\space
-       (\glsentrylong{##1})%
-    }
-    {% is another form of abbreviation
-     \glsentrylongpl{##1}##2\space
-      (\protect\firstacronymfont{\glsentryshortpl{##1}})%
-    }%
-  }%
-
-
-  % plural and first letter upper case
-  \renewcommand*{\Genplacrfullformat}[2]{%
-    \ifglsfieldeq{##1}{abbrtype}{word}
-    {% is a proper acronym
-      \protect\firstacronymfont{\Glsentryshortpl{##1}}##2\space
-       (\glsentrylong{##1})%
-    }
-    {% is another form of abbreviation
-     \Glsentrylongpl{##1}##2\space
-      (\protect\firstacronymfont{\glsentryshortpl{##1}})%
-    }%
-  }%
-  % Just use the short form as the name part in the glossary:
-  \renewcommand*{\acronymentry}[1]{%
-     \acronymfont{\glsentryshort{##1}}}%
-  % Sort by the short form:
-  \renewcommand*{\acronymsort}[2]{##1}%
-  % Just use the surrounding font for the short form:
-  \renewcommand*{\acronymfont}[1]{##1}%
-  % Same for first use:
-  \renewcommand*{\firstacronymfont}[1]{\acronymfont{##1}}%
-  % Default plural suffix if the plural isn't explicitly set
-  \renewcommand*{\acrpluralsuffix}{\glspluralsuffix}%
- }
-</pre>
-<!--l. 6368--><p class="nopar" > Remember that the new style needs to be set before defining any terms:
-
-
-</p>
- <pre class="verbatim" id="verbatim-157">
-\setacronymstyle{mystyle}
-</pre>
-<!--l. 6373--><p class="nopar" >
-</p><!--l. 6375--><p class="indent" > Since it’s a bit confusing to use <span
-class="cmtt-10">\newacronym</span><a
- id="dx1-119004"></a> for something that’s not technically an acronym, let’s define a
-new command for initialisms:
-
-
-</p>
- <pre class="verbatim" id="verbatim-158">
-\newcommand*{\newinitialism}[4][]{%
-  \newacronym[abbrtype=initialism,#1]{#2}{#3}{#4}%
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1220"></a><dfn id="glo:file.example-glossaries-cite.tex"><span class="filefmt">example-glossaries-cite.tex</span></dfn></div><!-- end of filedef -->
+ These entries use the <a id="wrglossary.1221"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a> key to store a citation key (or comma-separated list of citation keys). The citations are defined in <span class="filefmt">xampl.bib</span>, which should be available on all modern TeX distributions. One entry doesn’t have an associated citation to help test for a missing key. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1222"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1223"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{fusce}{<a id="wrglossary.1224"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={fusce}</span>,
+<a id="wrglossary.1225"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={suscipit cursus sem}</span>,<a id="wrglossary.1226"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a><span class="optfmt">={article-minimal}</span>}
+</pre><p>
+<div class="filedef">🗋 <a id="wrglossary.1227"></a><dfn id="glo:file.example-glossaries-url.tex"><span class="filefmt">example-glossaries-url.tex</span></dfn></div><!-- end of filedef -->
+ These entries use the <a id="wrglossary.1228"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a> key to store an <a id="wrglossary.1229"></a><a href="#glo:URL">URL</a> associated with the entry. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1230"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1231"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{aenean-url}{<a id="wrglossary.1232"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={aenean}</span>,
+ <a id="wrglossary.1233"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={adipiscing auctor est}</span>,
+ <a id="wrglossary.1234"></a><a href="#glo:opt.gloskey.user1"><span class="csoptfmt">user1</span></a><span class="optfmt">={http://uk.tug.org/}</span>}
+</pre><p>
+The sample file <a href="http://mirrors.ctan.org/macros/latex/contrib/glossaries/samples//glossary-lipsum-examples.tex"><span class="filefmt">glossary-lipsum-examples.tex</span></a> in the <span class="filefmt">doc/latex/glossaries/samples</span> directory uses all these files. See also <a href="https://www.dickimaw-books.com/gallery/#glossaries"><span class="styfmt">glossaries</span> gallery</a>.<p>
+<div class="sidenote"><a id="wrglossary.1235"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+The <a id="wrglossary.1236"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package provides the additional test file: <div class="filedef">🗋 <a id="wrglossary.1237"></a><dfn id="glo:file.example-glossaries-xr.tex"><span class="filefmt">example-glossaries-xr.tex</span></dfn></div><!-- end of filedef -->
+ These entries use the <a id="wrglossary.1238"></a><a href="#glo:opt.gloskey.see"><span class="csoptfmt">see</span></a> key provided by the base <span class="styfmt">glossaries</span> package and also the <a id="wrglossary.1239"></a><a href="#glo:opt.gloskey.alias"><span class="xtrcsoptfmt">alias</span></a> and <a id="wrglossary.1240"></a><a href="#glo:opt.gloskey.seealso"><span class="xtrcsoptfmt">seealso</span></a> keys that require <a id="wrglossary.1241"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1242"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1243"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{alias-lorem}{<a id="wrglossary.1244"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={alias-lorem}</span>,
+ <a id="wrglossary.1245"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={ipsum}</span>,<a id="wrglossary.1246"></a><a href="#glo:opt.gloskey.alias"><span class="xtrcsoptfmt">alias</span></a><span class="optfmt">={lorem}</span>}
+
+<a id="wrglossary.1247"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{amet}{<a id="wrglossary.1248"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={amet}</span>,<a id="wrglossary.1249"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={consectetuer}</span>,
+ <a id="wrglossary.1250"></a><a href="#glo:opt.gloskey.see"><span class="csoptfmt">see</span></a><span class="optfmt">={dolor}</span>}
+
+<a id="wrglossary.1251"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{arcu}<a id="wrglossary.1252"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={arcu}</span>,<a id="wrglossary.1253"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={libero}</span>,
+ <a id="wrglossary.1254"></a><a href="#glo:opt.gloskey.seealso"><span class="xtrcsoptfmt">seealso</span></a><span class="optfmt">={placerat,vitae,curabitur}</span>
+</pre> <p>
+
+</section><!-- end of section sec:lipsum -->
+
+<section id="sec:languages"><!-- start of section sec:languages --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.5. Multi-Lingual Support<div class="labellink"><a href="#sec:languages">[link]</a></div></h2><!-- end of section header -->
+<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1255"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+The <a id="wrglossary.1256"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package uses the <a id="wrglossary.1257"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> package to determine the document languages. Unfortunately, because there isn’t a standard language identification framework provided with LaTeX, <a id="wrglossary.1258"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> 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. In particular, <a id="wrglossary.1259"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> can’t pick up languages specified using <a id="wrglossary.1260"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span>’s</a> <a id="wrglossary.1261"></a><a href="#glo:babelprovide"><code class="csfmt">\babelprovide</code></a>. In the event that <a id="wrglossary.1262"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> can’t detect the language, use the <a id="wrglossary.1263"></a><a href="#glo:opt.languages"><span class="styoptfmt">languages</span></a> package option. See §<a href="#sec:pkgintegration">1.2</a> and also <a href="https://www.dickimaw-books.com/latex/tracklang/">Localisation with <span class="filefmt">tracklang.tex</span></a> for further details. </div><!-- end of important -->
+<p>
+As from version 1.17, the <a id="wrglossary.1264"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package can be used with <a id="wrglossary.1265"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> as well as <a id="wrglossary.1266"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. If you are writing in a language that uses an <a id="wrglossary.1267"></a><a href="#glo:dual.exlatinalph">extended Latin alphabet</a> or <a id="wrglossary.1268"></a><a href="#glo:dual.nonlatinalph">non-Latin alphabet</a> it’s best to use <a id="wrglossary.1269"></a><a href="#glo:idx.opt.xdy">Option 3</a> (<a id="wrglossary.1270"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>) or <a id="wrglossary.1271"></a><a href="#glo:idx.opt.b2g">Option 4</a> (<a id="wrglossary.1272"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>) as <a id="wrglossary.1273"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> (<a id="wrglossary.1274"></a><a href="#glo:idx.opt.mkidx">Option 2</a>) is hard-coded for the non-extended <a id="wrglossary.1275"></a><a href="#glo:dual.latinalph">Latin alphabet</a> and <a id="wrglossary.1276"></a><a href="#glo:idx.opt.noidx">Option 1</a> can only perform limited ASCII comparisons.<p>
+This means that with Options <a href="#glo:idx.opt.xdy">3</a> or <a href="#glo:idx.opt.b2g">4</a> you are not restricted to the A, …, Z letter groups. If you want to use <a id="wrglossary.1277"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>, remember to use the <a id="wrglossary.1278"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a> package option. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1279"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[french]{article}
+<code class="cmd">\usepackage</code>[utf8]{inputenc}
+<code class="cmd">\usepackage</code>[T1]{fontenc}
+<code class="cmd">\usepackage</code>{babel}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.1280"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a>]{glossaries}
+</pre> If you are using a non-Latin script, you may need the <a id="wrglossary.1281"></a><a href="#glo:opt.xindynoglsnumbers"><span class="styoptfmt">xindynoglsnumbers</span></a><span class="optfmt">=o</span>ption or use <a id="wrglossary.1282"></a><a href="#glo:GlsSetXdyFirstLetterAfterDigits"><code class="csfmt">\GlsSetXdyFirstLetterAfterDigits</code></a> to indicate the first <a id="wrglossary.1283"></a><a href="#glo:idx.group">letter group</a> that should follow the number <a id="wrglossary.1284"></a><a href="#glo:idx.group">group</a>.<p>
+If you want to use <a id="wrglossary.1285"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>, you need to use the <a id="wrglossary.1286"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a> option with <a id="wrglossary.1287"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> and supply the definitions in <a id="wrglossary.1288"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> files. (See the <a id="wrglossary.1289"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> user manual for further details.)<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1290"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Note that although a <a id="wrglossary.1291"></a><a href="#glo:dual.nonlatinchar">non-Latin character</a>, such as é, looks like a plain character in your <a id="wrglossary.1292"></a><a href="#glo:ext.tex"><span class="extfmt">tex</span></a> file, with standard LaTeX it’s actually a macro and can therefore cause problems. (This issue doesn’t occur with XeLaTeX or LuaLaTeX which both natively support <a id="wrglossary.1293"></a><a href="#glo:dual.utf8">UTF-8</a>.) Recent versions of the LaTeX kernel have made significant improvements in handling <a id="wrglossary.1294"></a><a href="#glo:dual.utf8">UTF-8</a>. To ensure you have the best <a id="wrglossary.1295"></a><a href="#glo:dual.utf8">UTF-8</a> support, use at least <a id="wrglossary.1296"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> v2.08+ with <a id="wrglossary.1297"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> v4.50+ (and, if required, <a id="wrglossary.1298"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> v1.49+). </div><!-- end of important -->
+<p>
+With old versions of <a id="wrglossary.1299"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> (pre v2.08), if you use a <a id="wrglossary.1300"></a><a href="#glo:dual.utf8">UTF-8</a> character at the start of an <a id="wrglossary.1301"></a><a href="#glo:idx.glossaryentry">entry</a> name, you must place it in a group, or it will cause a problem for <a id="wrglossary.1302"></a><a href="#glo:idx.sentencecase">sentence case</a> commands (e.g. <a id="wrglossary.1303"></a><a href="#glo:Gls"><code class="csfmt">\Gls</code></a>). For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1304"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><span class="comment">% <a id="wrglossary.1305"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> v2.07:</span>
+<a id="wrglossary.1306"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{elite}{<a id="wrglossary.1307"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={{é}lite}</span>,
+<a id="wrglossary.1308"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={select group or class}</span>}
+</pre> This isn’t necessary with <a id="wrglossary.1309"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> v4.50+ and <a id="wrglossary.1310"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> v2.08+. <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1311"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><span class="comment">% <a id="wrglossary.1312"></a><a href="#glo:pkg.mfirstuc"><span class="styfmt">mfirstuc</span></a> v2.08:</span>
+<a id="wrglossary.1313"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{elite}{<a id="wrglossary.1314"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={élite}</span>,
+<a id="wrglossary.1315"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={select group or class}</span>}
+</pre><p>
+If you are using <a id="wrglossary.1316"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> or <a id="wrglossary.1317"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>, the application needs to know the <a id="wrglossary.1318"></a><a href="#glo:idx.encoding">encoding</a> of the <a id="wrglossary.1319"></a><a href="#glo:ext.tex"><span class="extfmt">tex</span></a> file. This information is added to the <a id="wrglossary.1320"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file and can be picked up by <a id="wrglossary.1321"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> and <a id="wrglossary.1322"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>. If you use <a id="wrglossary.1323"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> explicitly instead of via <a id="wrglossary.1324"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>, you may need to specify the <a id="wrglossary.1325"></a><a href="#glo:idx.encoding">encoding</a> using the <a id="wrglossary.1326"></a><a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> option. Read the <a id="wrglossary.1327"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> manual for further details of this option.<p>
+If you have the double-quote character (<a id="wrglossary.1328"></a><a href="#glo:idx.sym.dblquote"><code class="code">"</code></a>) as an active character (for example, a <a id="wrglossary.1329"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> shorthand) and you want to use <a id="wrglossary.1330"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span>’s</a> <a id="wrglossary.1331"></a><a href="#glo:switch.mkidx.g"><span class="shortargfmt">-g</span></a> option, you’ll need to change <a id="wrglossary.1332"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span>’s</a> quote character using: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.1333"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.1334"></a><code class="code"><dfn id="glo:GlsSetQuote"><code class="csfmt">\GlsSetQuote</code></dfn>{<span class="meta">〈<em class="metainner">character</em>〉</span>}</code><p>
+<div class="noteBox"></div><!-- end of noteBox -->
+</div><!-- end of pinnedbox -->
+ Note that <span class="meta">〈<em class="metainner">character</em>〉</span> may not be one of <a id="wrglossary.1335"></a><a href="#glo:idx.sym.questionmark"><code class="code">?</code> (question mark)</a>, <a id="wrglossary.1336"></a><a href="#glo:idx.sym.pipe"><code class="code">|</code> (pipe)</a> or <a id="wrglossary.1337"></a><a href="#glo:idx.sym.exclammark"><code class="code">!</code> (exclamation mark)</a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1338"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1339"></a><a href="#glo:GlsSetQuote"><code class="csfmt">\GlsSetQuote</code></a>{+}
+</pre> This must be done before <a id="wrglossary.1340"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> and any entry definitions. It’s only applicable for <a id="wrglossary.1341"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. This option in conjunction with <span class="optfmt">ngerman</span> will also cause <a id="wrglossary.1342"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> to use the <a id="wrglossary.1343"></a><a href="#glo:switch.mkidx.g"><span class="shortargfmt">-g</span></a> switch when invoking <a id="wrglossary.1344"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1345"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Be careful of <a id="wrglossary.1346"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span>’s</a> shorthands. These aren’t switched on until the start of the document, so any entries defined in the <a id="wrglossary.1347"></a><a href="#glo:idx.documentpreamble">preamble</a> 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="wrglossary.1348"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1349"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> (such as the double-quote) then this will interfere with code that tries to escape any of those characters that occur in the <a id="wrglossary.1350"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key. </div><!-- end of important -->
+<p>
+In general, it’s best not to use <a id="wrglossary.1351"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>’s shorthands in entry definitions. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1352"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+
+<code class="cmd">\usepackage</code>[ngerman]{babel}
+<code class="cmd">\usepackage</code>{glossaries}
+
+<a id="wrglossary.1353"></a><a href="#glo:GlsSetQuote"><code class="csfmt">\GlsSetQuote</code></a>{+}
+
+<a id="wrglossary.1354"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>
+
+<a id="wrglossary.1355"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{rna}{name=ribonukleinsäure,
+ <a id="wrglossary.1356"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a><span class="optfmt">={ribonukleins"aure}</span>,
+ <a id="wrglossary.1357"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={eine Nukleinsäure}</span>}
+
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.1358"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{rna}
+
+<a id="wrglossary.1359"></a><a href="#glo:printglossaries"><code class="csfmt">\printglossaries</code></a>
+<code class="cend">\end{document}</code>
+</pre><p>
+
+</section><!-- end of section sec:languages -->
+
+<section id="sec:fixednames"><!-- start of section sec:fixednames --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.5.1. Changing the Fixed Names<div class="labellink"><a href="#sec:fixednames">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+The fixed names are produced using the commands listed in Table <a href="#tab:predefinednames">1.2</a>. If you aren’t using a language package such as <a id="wrglossary.1360"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.1361"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a> that uses caption hooks, you can just redefine these commands as appropriate. If you are using <a id="wrglossary.1362"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.1363"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></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 <a id="wrglossary.1364"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.1365"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a> documentation. If you have loaded <a id="wrglossary.1366"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>, then <a id="wrglossary.1367"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> will attempt to load <a id="wrglossary.1368"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a>, unless you have used the <a id="wrglossary.1369"></a><a href="#glo:opt.notranslate"><span class="styoptfmt">notranslate</span></a>, <a id="wrglossary.1370"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=false</span> or <a id="wrglossary.1371"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span> package options. If the <a id="wrglossary.1372"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package is loaded, the translations are provided by dictionary files (for example, <span class="filefmt">glossaries-dictionary-English.dict</span>). See th!
e <a id="wrglossary.1373"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package for advice on changing translations provided by <a id="wrglossary.1374"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> dictionaries. If you can’t work out how to modify these dictionary definitions, try switching to <a id="wrglossary.1375"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>’s interface using <a id="wrglossary.1376"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1377"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[english,french]{article}
+<code class="cmd">\usepackage</code>{babel}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.1378"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>]{glossaries}
+</pre> and then use <a id="wrglossary.1379"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>’s caption hook mechanism. Note that if you pass the language options directly to <a id="wrglossary.1380"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> rather that using the document class options or otherwise passing the same options to <a id="wrglossary.1381"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a>, then <a id="wrglossary.1382"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> won’t pick up the language and no dictionaries will be loaded and <a id="wrglossary.1383"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>’s caption hooks will be used instead.<p>
+<div class="table"> <div id="tab:predefinednames" class="caption">Table 2: Customised Text</div> <table class="tabular-c">
+<tr style=""><th class="cell-noborder-rightsep-l">Command Name </th>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <span style="font-weight: bold; ">Translator Key Word </span></td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> <span style="font-weight: bold; ">Purpose</span></td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:glossaryname"><code class="csfmt">\glossaryname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Glossary</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Title of the main glossary.</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:acronymname"><code class="csfmt">\acronymname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Acronyms</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Title of the list of acronyms (when used with package option <a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a>).</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:entryname"><code class="csfmt">\entryname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Notation (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for first column in the glossary (for 2, 3 or 4 column glossaries that support headers).</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:descriptionname"><code class="csfmt">\descriptionname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Description (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for second column in the glossary (for 2, 3 or 4 column glossaries that support headers).</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:symbolname"><code class="csfmt">\symbolname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Symbol (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for symbol column in the glossary for glossary styles that support this option.</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:pagelistname"><code class="csfmt">\pagelistname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Page List (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for the <a href="#glo:idx.pagelist">page list</a> column in the glossary for glossaries that support this option.</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:glssymbolsgroupname"><code class="csfmt">\glssymbolsgroupname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Symbols (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for symbols section of the glossary for glossary styles that support this option.</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><dfn id="glo:glsnumbersgroupname"><code class="csfmt">\glsnumbersgroupname</code></dfn> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 3000.000244%; padding-right: 6.000000pt; text-align: left; "> <code class="code">Numbers (glossaries)</code> </td>
+<td style="border-top: none; border-right: none; border-left: none; padding-left: 6.000000pt; width: 4000.000000%; padding-right: 0px; text-align: left; "> Header for numbers section of the glossary for glossary styles that support this option. </td>
+</tr></table>
+ </div><p>
+As from version 4.12, multilingual support is provided by separate language modules that need to be installed in addition to installing the <a id="wrglossary.1384"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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">http://www.dickimaw-books.com/contact.html</a>. The <a id="wrglossary.1385"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> dictionary files for <a id="wrglossary.1386"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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>
+Examples of use:
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span>Using <a id="wrglossary.1387"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> and <a id="wrglossary.1388"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1389"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[english,french]{article}
+<code class="cmd">\usepackage</code>{babel}
+<code class="cmd">\usepackage</code>{glossaries}
+</pre> (<a id="wrglossary.1390"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> is automatically loaded).<p>
+<li><span class="bulletitem">•</span>Using <a id="wrglossary.1391"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1392"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[english,french]{article}
+<code class="cmd">\usepackage</code>{babel}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.1393"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>]{glossaries}
+</pre> (<a id="wrglossary.1394"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> isn’t loaded). The <a id="wrglossary.1395"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package has <a id="wrglossary.1396"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span> as the default if <a id="wrglossary.1397"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> has been loaded.<p>
+<li><span class="bulletitem">•</span>Using <a id="wrglossary.1398"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1399"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>{polyglossia}
+<code class="cmd">\setmainlanguage</code>{english}
+<code class="cmd">\usepackage</code>{glossaries}
+</pre><p>
+
+</ul>
+<p>
+Due to the varied nature of <a id="wrglossary.1400"></a><a href="#glo:dual.glossary">glossaries</a>, it’s likely that the predefined translations may not be appropriate. If you are using the <a id="wrglossary.1401"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> package and the <a id="wrglossary.1402"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package option <a id="wrglossary.1403"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>, 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 <a id="wrglossary.1404"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package, then you can provide your own dictionary with the necessary modifications (using <code class="csfmt">\deftranslation</code>) and load it using <code class="csfmt">\usedictionary</code>. If you simply want to change the title of a <a id="wrglossary.1405"></a><a href="#glo:dual.glossary">glossary</a>, you can use the <a id="wrglossary.1406"></a><a href="#glo:opt.printgloss.title"><span class="csoptfmt">title</span></a> key in commands like <a id="wrglossary.1407"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a> (but not the iterative commands like <a id="wrglossary.1408"></a><a href="#glo:printglossaries"><code class="csfmt">\printglossaries</code></a>).<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1409"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Note that the <a id="wrglossary.1410"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> dictionaries are loaded at the beginning of the document, so it won’t have any effect if you put <code class="csfmt">\deftranslation</code> in the <a id="wrglossary.1411"></a><a href="#glo:idx.documentpreamble">preamble</a>. It should be put in your personal dictionary instead (as in the example below). See the <a id="wrglossary.1412"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> documentation for further details. </div><!-- end of important -->
+<p>
+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 <span class="qt">“Nomenclature”</span> and the <a id="wrglossary.1413"></a><a href="#glo:dual.locationlist">location list</a> should be labelled <span class="qt">“Location”</span>, then you can create a file called, say, <span class="filefmt">myinstitute-glossaries-dictionary-English.dict</span> that contains the following: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1414"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\ProvidesDictionary</code>{myinstitute-glossaries-dictionary}{English}
+<code class="cmd">\deftranslation</code>{Glossary}{Nomenclature}
+<code class="cmd">\deftranslation</code>{Page List (glossaries)}{Location}
+</pre> You can now load it using: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1415"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usedictionary</code>{myinstitute-glossaries-dictionary}
+</pre> (Make sure that <span class="filefmt">myinstitute-glossaries-dictionary-English.dict</span> can be found by TeX.) If you want to share your custom dictionary, you can upload it to <a href="http://www.ctan.org/">CTAN</a>.<p>
+If you are using <a id="wrglossary.1416"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> and don’t want to use the <a id="wrglossary.1417"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> interface, you can use the package option <a id="wrglossary.1418"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1419"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>[british]{article}
+
+<code class="cmd">\usepackage</code>{babel}
+<code class="cmd">\usepackage</code>[<a id="wrglossary.1420"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=babel</span>]{glossaries}
+
+<code class="cmd">\addto</code><a id="wrglossary.1421"></a><a href="#glo:captionslanguage"><code class="csfmt">\captionsbritish</code></a>{<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1422"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a>}{List of Terms}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1423"></a><a href="#glo:acronymname"><code class="csfmt">\acronymname</code></a>}{List of Acronyms}<span class="comment">% </span>
}
-</pre>
-<!--l. 6382--><p class="nopar" > Now the entries can all be defined:
-
-
-</p>
- <pre class="verbatim" id="verbatim-159">
-\newacronym{radar}{radar}{radio detecting and ranging}
-\newacronym{laser}{laser}{light amplification by stimulated
-emission of radiation}
-\newacronym{scuba}{scuba}{self-contained underwater breathing
+</pre><p>
+Note that <a id="wrglossary.1424"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> and <a id="wrglossary.1425"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> provide much better multi-lingual support than <a id="wrglossary.1426"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, so I recommend that you use Options <a href="#glo:idx.opt.mkidx">2</a> or <a href="#glo:idx.opt.xdy">3</a> if you have <a id="wrglossary.1427"></a><a href="#glo:dual.glossary">glossary</a> entries that contain <a id="wrglossary.1428"></a><a href="#glo:dual.nonlatinchar">non-Latin characters</a>. See §<a href="#sec:xindy">14</a> for further details on <a id="wrglossary.1429"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>, and see the <a id="wrglossary.1430"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> user manual for further details of that application.<p>
+
+</section><!-- end of section sec:fixednames -->
+
+<section id="sec:newlang"><!-- start of section sec:newlang --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.5.2. Creating a New Language Module<div class="labellink"><a href="#sec:newlang">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+The <a id="wrglossary.1431"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package now uses the <a id="wrglossary.1432"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></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 <a id="wrglossary.1433"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span></a> documentation.<p>
+To create a new language module, you need to at least create two files called: <a id="wrglossary.1434"></a><a href="#glo:file.glossaries-lang.ldf"><span class="filefmt">glossaries-</span><span class="meta">〈<em class="metainner">lang</em>〉</span><span class="filefmt">.ldf</span></a> and <a id="wrglossary.1435"></a><a href="#glo:file.glossaries-dictionary-Lang.dict"><span class="filefmt">glossaries-dictionary-</span><span class="meta">〈<em class="metainner">Lang</em>〉</span><span class="filefmt">.dict</span></a> where <span class="meta">〈<em class="metainner">lang</em>〉</span> is the root language name (for example, <code class="code">english</code>) and <span class="meta">〈<em class="metainner">Lang</em>〉</span> is the language name used by <a id="wrglossary.1436"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> (for example, <code class="code">English</code>).<p>
+Here’s an example of <a id="wrglossary.1437"></a><a href="#glo:file.glossaries-dictionary-English.dict"><span class="filefmt">glossaries-dictionary-English.dict</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1438"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\ProvidesDictionary</code>{glossaries-dictionary}{English}
+
+<code class="cmd">\providetranslation</code>{Glossary}{Glossary}
+<code class="cmd">\providetranslation</code>{Acronyms}{Acronyms}
+<code class="cmd">\providetranslation</code>{Notation (glossaries)}{Notation}
+<code class="cmd">\providetranslation</code>{Description (glossaries)}{Description}
+<code class="cmd">\providetranslation</code>{Symbol (glossaries)}{Symbol}
+<code class="cmd">\providetranslation</code>{Page List (glossaries)}{Page List}
+<code class="cmd">\providetranslation</code>{Symbols (glossaries)}{Symbols}
+<code class="cmd">\providetranslation</code>{Numbers (glossaries)}{Numbers}
+</pre> You can use this as a template for your dictionary file. Change <code class="code">English</code> to the <a id="wrglossary.1439"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> name for your language (so that it matches the file name <a id="wrglossary.1440"></a><a href="#glo:file.glossaries-dictionary-Lang.dict"><span class="filefmt">glossaries-dictionary-</span><span class="meta">〈<em class="metainner">Lang</em>〉</span><span class="filefmt">.dict</span></a>) and, for each <code class="csfmt">\providetranslation</code>, change the second argument to the appropriate translation.<p>
+Here’s an example of <a id="wrglossary.1441"></a><a href="#glo:file.glossaries-english.ldf"><span class="filefmt">glossaries-english.ldf</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1442"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1443"></a><a href="#glo:ProvidesGlossariesLang"><code class="csfmt">\ProvidesGlossariesLang</code></a>{english}
+
+<a id="wrglossary.1444"></a><a href="#glo:glsifusedtranslatordict"><code class="csfmt">\glsifusedtranslatordict</code></a>{English}
+{<span class="comment">% </span>
+ <a id="wrglossary.1445"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1446"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}<span class="comment">% </span>
+ <a id="wrglossary.1447"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1448"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}<span class="comment">% </span>
+}
+{<span class="comment">% </span>
+ <code class="cmd">\@ifpackageloaded</code>{polyglossia}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\newcommand</code>*{<code class="cmd">\glossariescaptionsenglish</code>}{<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1449"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a>}{<code class="cmd">\textenglish</code>{Glossary}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1450"></a><a href="#glo:acronymname"><code class="csfmt">\acronymname</code></a>}{<code class="cmd">\textenglish</code>{Acronyms}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1451"></a><a href="#glo:entryname"><code class="csfmt">\entryname</code></a>}{<code class="cmd">\textenglish</code>{Notation}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1452"></a><a href="#glo:descriptionname"><code class="csfmt">\descriptionname</code></a>}{<code class="cmd">\textenglish</code>{Description}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1453"></a><a href="#glo:symbolname"><code class="csfmt">\symbolname</code></a>}{<code class="cmd">\textenglish</code>{Symbol}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1454"></a><a href="#glo:pagelistname"><code class="csfmt">\pagelistname</code></a>}{<code class="cmd">\textenglish</code>{Page List}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1455"></a><a href="#glo:glssymbolsgroupname"><code class="csfmt">\glssymbolsgroupname</code></a>}{<code class="cmd">\textenglish</code>{Symbols}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1456"></a><a href="#glo:glsnumbersgroupname"><code class="csfmt">\glsnumbersgroupname</code></a>}{<code class="cmd">\textenglish</code>{Numbers}}<span class="comment">% </span>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\newcommand</code>*{<code class="cmd">\glossariescaptionsenglish</code>}{<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1457"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a>}{Glossary}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1458"></a><a href="#glo:acronymname"><code class="csfmt">\acronymname</code></a>}{Acronyms}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1459"></a><a href="#glo:entryname"><code class="csfmt">\entryname</code></a>}{Notation}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1460"></a><a href="#glo:descriptionname"><code class="csfmt">\descriptionname</code></a>}{Description}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1461"></a><a href="#glo:symbolname"><code class="csfmt">\symbolname</code></a>}{Symbol}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1462"></a><a href="#glo:pagelistname"><code class="csfmt">\pagelistname</code></a>}{Page List}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1463"></a><a href="#glo:glssymbolsgroupname"><code class="csfmt">\glssymbolsgroupname</code></a>}{Symbols}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1464"></a><a href="#glo:glsnumbersgroupname"><code class="csfmt">\glsnumbersgroupname</code></a>}{Numbers}<span class="comment">% </span>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ <code class="cmd">\ifcsdef</code>{captions<a id="wrglossary.1465"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}
+ {<span class="comment">% </span>
+ <code class="cmd">\csappto</code>{captions<a id="wrglossary.1466"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsenglish</code>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\ifcsdef</code>{captions<a id="wrglossary.1467"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}
+ {<span class="comment">% </span>
+ <code class="cmd">\csappto</code>{captions<a id="wrglossary.1468"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsenglish</code>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ <span class="comment">% </span>
+ <span class="comment">% </span>
+ }<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsenglish</code>
+}
+<code class="cmd">\renewcommand</code>*{<a id="wrglossary.1469"></a><a href="#glo:glspluralsuffix"><code class="csfmt">\glspluralsuffix</code></a>}{s}
+<code class="cmd">\renewcommand</code>*{<a id="wrglossary.1470"></a><a href="#glo:glsacrpluralsuffix"><code class="csfmt">\glsacrpluralsuffix</code></a>}{<a id="wrglossary.1471"></a><a href="#glo:glspluralsuffix"><code class="csfmt">\glspluralsuffix</code></a>}
+<code class="cmd">\renewcommand</code>*{<a id="wrglossary.1472"></a><a href="#glo:glsupacrpluralsuffix"><code class="csfmt">\glsupacrpluralsuffix</code></a>}{<a id="wrglossary.1473"></a><a href="#glo:glstextup"><code class="csfmt">\glstextup</code></a>{<a id="wrglossary.1474"></a><a href="#glo:glspluralsuffix"><code class="csfmt">\glspluralsuffix</code></a>}}
+</pre> This is a somewhat longer file, but again you can use it as a template. Replace <code class="code">English</code> with the <a id="wrglossary.1475"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> language label <span class="meta">〈<em class="metainner">Lang</em>〉</span> used for the dictionary file and replace <code class="code">english</code> with the root language name <span class="meta">〈<em class="metainner">lang</em>〉</span>. Within the definition of <code class="csfmt">\glossariescaptions</code><span class="meta">〈<em class="metainner">lang</em>〉</span>, replace the English text (such as <span class="qt">“Glossaries”</span>) with the appropriate translation.<p>
+<a id="pluralsuffix"></a>The suffixes used to generate the plural forms when the plural hasn’t been specified are given by <a id="wrglossary.1476"></a><a href="#glo:glspluralsuffix"><code class="csfmt">\glspluralsuffix</code></a> (for general entries). For <a id="wrglossary.1477"></a><a href="#glo:idx.acronym">acronyms</a> defined with the base <a id="wrglossary.1478"></a><a href="#glo:newacronym"><code class="csfmt">\newacronym</code></a>, <a id="wrglossary.1479"></a><a href="#glo:glsupacrpluralsuffix"><code class="csfmt">\glsupacrpluralsuffix</code></a> is used for the <a id="wrglossary.1480"></a><a href="#glo:dual.smallcaps">small caps</a> <a id="wrglossary.1481"></a><a href="#glo:idx.acronymstyle">acronym styles</a> where the suffix needs to be set using <a id="wrglossary.1482"></a><a href="#glo:glstextup"><code class="csfmt">\glstextup</code></a> to counteract the effects of <a id="wrglossary.1483"></a><a href="#glo:textsc"><code class="csfmt">\textsc</code></a> and <a id="wrglossary.1484"></a><a href="#glo:glsacrpluralsuffix"><code class="csfmt">\glsacrpluralsuffix</code></a> for other <a id="wrglossary.1485"></a><a href="#glo:idx.acronymstyle">acronym styles</a>. 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 <a id="wrglossary.1486"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> configuration.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1487"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Therefore these plural suffix command definitions aren’t included in the <a id="wrglossary.1488"></a><a href="#glo:captionslanguage"><code class="csfmt">\captions<span class="meta">〈<em class="metainner">language</em>〉</span></code></a> hook as that’s typically not switched used until the start of the document. <strong class="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 <a id="wrglossary.1489"></a><a href="#glo:opt.gloskey.plural"><span class="csoptfmt">plural</span></a>, <a id="wrglossary.1490"></a><a href="#glo:opt.gloskey.longplural"><span class="csoptfmt">longplural</span></a>, <a id="wrglossary.1491"></a><a href="#glo:opt.gloskey.shortplural"><span class="csoptfmt">shortplural</span></a> etc keys to override exceptions. </div><!-- end of important -->
+<p>
+If you want to add a regional variation, create a file called <a id="wrglossary.1492"></a><a href="#glo:file.glossaries-iso-lang-iso-region.ldf"><span class="filefmt">glossaries-</span><span class="meta">〈<em class="metainner">iso-lang</em>〉</span><span class="filefmt">-</span><span class="meta">〈<em class="metainner">iso-region</em>〉</span><span class="filefmt">.ldf</span></a>, where <span class="meta">〈<em class="metainner">iso-lang</em>〉</span> is the ISO language code and <span class="meta">〈<em class="metainner">iso-region</em>〉</span> is the ISO country code. For example, <span class="filefmt">glossaries-en-GB.ldf</span>. This file can load the root language file and make the appropriate changes, for example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1493"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1494"></a><a href="#glo:ProvidesGlossariesLang"><code class="csfmt">\ProvidesGlossariesLang</code></a>{en-GB}
+ <a id="wrglossary.1495"></a><a href="#glo:RequireGlossariesLang"><code class="csfmt">\RequireGlossariesLang</code></a>{english}
+ <a id="wrglossary.1496"></a><a href="#glo:glsifusedtranslatordict"><code class="csfmt">\glsifusedtranslatordict</code></a>{British}
+ {<span class="comment">% </span>
+ <a id="wrglossary.1497"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1498"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}<span class="comment">% </span>
+ <a id="wrglossary.1499"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1500"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}<span class="comment">% </span>
+ }
+ {<span class="comment">% </span>
+ <code class="cmd">\@ifpackageloaded</code>{polyglossia}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <span class="comment">% Modify <code class="cmd">\glossariescaptionsenglish</code> as appropriate for</span>
+ <span class="comment">% polyglossia</span>
+ }<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <span class="comment">% Modify <code class="cmd">\glossariescaptionsenglish</code> as appropriate for</span>
+ <span class="comment">% non-polyglossia</span>
+ }<span class="comment">% </span>
+ }
+</pre><p>
+If the translations includes <a id="wrglossary.1501"></a><a href="#glo:dual.nonlatinchar">non-Latin characters</a>, it’s a good idea to provide code that’s independent of the input <a id="wrglossary.1502"></a><a href="#glo:idx.encoding">encoding</a>. Remember that while some users may use <a id="wrglossary.1503"></a><a href="#glo:dual.utf8">UTF-8</a> (and it’s now the default <a id="wrglossary.1504"></a><a href="#glo:idx.encoding">encoding</a> with modern LaTeX kernels), others may use Latin-1 or any other supported <a id="wrglossary.1505"></a><a href="#glo:idx.encoding">encoding</a>, but while users won’t appreciate you enforcing your preference on them, it’s useful to provide a <a id="wrglossary.1506"></a><a href="#glo:dual.utf8">UTF-8</a> version.<p>
+The <a id="wrglossary.1507"></a><a href="#glo:file.glossaries-irish.ldf"><span class="filefmt">glossaries-irish.ldf</span></a> file provides this as follows: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1508"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1509"></a><a href="#glo:ProvidesGlossariesLang"><code class="csfmt">\ProvidesGlossariesLang</code></a>{irish}
+
+<a id="wrglossary.1510"></a><a href="#glo:glsifusedtranslatordict"><code class="csfmt">\glsifusedtranslatordict</code></a>{Irish}
+{<span class="comment">% </span>
+ <a id="wrglossary.1511"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1512"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}<span class="comment">% </span>
+ <a id="wrglossary.1513"></a><a href="#glo:addglossarytocaptions"><code class="csfmt">\addglossarytocaptions</code></a>{<a id="wrglossary.1514"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}<span class="comment">% </span>
+}
+{<span class="comment">% </span>
+ <code class="cmd">\ifdefstring</code>{<a id="wrglossary.1515"></a><a href="#glo:inputencodingname"><code class="csfmt">\inputencodingname</code></a>}{utf8}
+ {<code class="cmd">\input</code>{glossaries-irish-utf8.ldf}}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\ifdef</code><code class="cmd">\XeTeXinputencoding</code><span class="comment">% XeTeX defaults to UTF-8</span>
+ {<code class="cmd">\input</code>{glossaries-irish-utf8.ldf}}<span class="comment">% </span>
+ {<code class="cmd">\input</code>{glossaries-irish-noenc.ldf}}
+ }
+ <code class="cmd">\ifcsdef</code>{captions<a id="wrglossary.1516"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}
+ {<span class="comment">% </span>
+ <code class="cmd">\csappto</code>{captions<a id="wrglossary.1517"></a><a href="#glo:CurrentTrackedDialect"><code class="csfmt">\CurrentTrackedDialect</code></a>}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsirish</code>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\ifcsdef</code>{captions<a id="wrglossary.1518"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}
+ {
+ <code class="cmd">\csappto</code>{captions<a id="wrglossary.1519"></a><a href="#glo:CurrentTrackedLanguage"><code class="csfmt">\CurrentTrackedLanguage</code></a>}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsirish</code>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ {<span class="comment">% </span>
+ }<span class="comment">% </span>
+ }<span class="comment">% </span>
+ <code class="cmd">\glossariescaptionsirish</code>
+}
+</pre> (Again you can use this as a template. Replace <code class="code">irish</code> with your root language label and <code class="code">Irish</code> with the <a id="wrglossary.1520"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> dictionary label.)<p>
+There are now two extra files: <span class="filefmt">glossaries-irish-noenc.ldf</span> (no <a id="wrglossary.1521"></a><a href="#glo:idx.encoding">encoding</a> information) and <span class="filefmt">glossaries-irish-utf8.ldf</span> (<a id="wrglossary.1522"></a><a href="#glo:dual.utf8">UTF-8</a>).<p>
+These both define <code class="csfmt">\glossariescaptionsirish</code> but the <span class="filefmt">*-noenc.ldf</span> file uses LaTeX accent commands: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1523"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\@ifpackageloaded</code>{polyglossia}<span class="comment">% </span>
+{<span class="comment">% </span>
+ <code class="cmd">\newcommand</code>*{<code class="cmd">\glossariescaptionsirish</code>}{<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1524"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a>}{<code class="cmd">\textirish</code>{Gluais}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1525"></a><a href="#glo:acronymname"><code class="csfmt">\acronymname</code></a>}{<code class="cmd">\textirish</code>{Acrainmneacha}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1526"></a><a href="#glo:entryname"><code class="csfmt">\entryname</code></a>}{<code class="cmd">\textirish</code>{Ciall}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1527"></a><a href="#glo:descriptionname"><code class="csfmt">\descriptionname</code></a>}{<code class="cmd">\textirish</code>{Tuairisc}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1528"></a><a href="#glo:symbolname"><code class="csfmt">\symbolname</code></a>}{<code class="cmd">\textirish</code>{Comhartha}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1529"></a><a href="#glo:glssymbolsgroupname"><code class="csfmt">\glssymbolsgroupname</code></a>}{<code class="cmd">\textirish</code>{Comhartha<a id="wrglossary.1530"></a><a href="#glo:cs.apos"><code class="csfmt">\'</code></a><code class="cmd">\i</code>}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1531"></a><a href="#glo:pagelistname"><code class="csfmt">\pagelistname</code></a>}{<code class="cmd">\textirish</code>{Leathanaigh}}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1532"></a><a href="#glo:glsnumbersgroupname"><code class="csfmt">\glsnumbersgroupname</code></a>}{<code class="cmd">\textirish</code>{Uimhreacha}}<span class="comment">% </span>
+ }<span class="comment">% </span>
+}<span class="comment">% </span>
+{<span class="comment">% </span>
+ <code class="cmd">\newcommand</code>*{<code class="cmd">\glossariescaptionsirish</code>}{<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1533"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a>}{Gluais}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1534"></a><a href="#glo:acronymname"><code class="csfmt">\acronymname</code></a>}{Acrainmneacha}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1535"></a><a href="#glo:entryname"><code class="csfmt">\entryname</code></a>}{Ciall}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1536"></a><a href="#glo:descriptionname"><code class="csfmt">\descriptionname</code></a>}{Tuairisc}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1537"></a><a href="#glo:symbolname"><code class="csfmt">\symbolname</code></a>}{Comhartha}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1538"></a><a href="#glo:glssymbolsgroupname"><code class="csfmt">\glssymbolsgroupname</code></a>}{Comhartha<a id="wrglossary.1539"></a><a href="#glo:cs.apos"><code class="csfmt">\'</code></a><code class="cmd">\i</code>}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1540"></a><a href="#glo:pagelistname"><code class="csfmt">\pagelistname</code></a>}{Leathanaigh}<span class="comment">% </span>
+ <code class="cmd">\renewcommand</code>*{<a id="wrglossary.1541"></a><a href="#glo:glsnumbersgroupname"><code class="csfmt">\glsnumbersgroupname</code></a>}{Uimhreacha}<span class="comment">% </span>
+ }<span class="comment">% </span>
+}
+</pre> whereas the <span class="filefmt">*-utf8.ldf</span> file replaces the accent commands with the appropriate <a id="wrglossary.1542"></a><a href="#glo:dual.utf8">UTF-8</a> characters.<p>
+
+</section><!-- end of section sec:newlang -->
+
+<section id="sec:makeglossaries"><!-- start of section sec:makeglossaries --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.6. Generating the Associated Glossary Files<div class="labellink"><a href="#sec:makeglossaries">[link]</a></div></h2><!-- end of section header -->
+<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1543"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+This section is only applicable if you have chosen Options <a href="#glo:idx.opt.mkidx">2</a> or <a href="#glo:idx.opt.b2g">4</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 <a id="wrglossary.1544"></a><a href="#glo:opt.gloskey.sort"><span class="csoptfmt">sort</span></a> key if the <a id="wrglossary.1545"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a> contains any LaTeX commands (except if you’re using <a id="wrglossary.1546"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>). </div><!-- end of important -->
+<p>
+If this section seriously confuses you, and you can’t work out how to run external tools like <a id="wrglossary.1547"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> or <a id="wrglossary.1548"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, you can try using the <a id="wrglossary.1549"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a> package option, described in §<a href="#sec:pkgopts-sort">2.5</a>, but you will need TeX’s <a id="wrglossary.1550"></a><a href="#glo:dual.shellescape">shell escape</a> 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>
+In order to generate a sorted <a id="wrglossary.1551"></a><a href="#glo:dual.glossary">glossary</a> with compact <a id="wrglossary.1552"></a><a href="#glo:locationlist">number lists</a>, it is necessary to use an external <a id="wrglossary.1553"></a><a href="#glo:dual.indexingapp">indexing application</a> as an intermediate step (unless you have chosen <a id="wrglossary.1554"></a><a href="#glo:idx.opt.noidx">Option 1</a>, which uses TeX to do the sorting or <a id="wrglossary.1555"></a><a href="#glo:idx.opt.unsrt">Option 5</a>, which doesn’t perform any sorting). It is this application that creates the file containing the code required to typeset the <a id="wrglossary.1556"></a><a href="#glo:dual.glossary">glossary</a>. <strong class="strong">If this step is omitted, the <a id="wrglossary.1557"></a><a href="#glo:dual.glossary">glossaries</a> will not appear in your document.</strong> The two <a id="wrglossary.1558"></a><a href="#glo:dual.indexingapp">indexing applications</a> that are most commonly used with LaTeX are <a id="wrglossary.1559"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> and <a id="wrglossary.1560"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. As from version 1.17, the <span class="styfmt">glossaries</span> package can be used with either of these applications. Previous versions were designed to be used with <a id="wrglossary.1561"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> only. With the <a id="wrglossary.1562"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package, you can also use <a id="wrglossary.1563"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> as the <a id="wrglossary.1564"></a><a href="#glo:dual.indexingapp">indexing application</a>. (See the <a id="wrglossary.1565"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> and <a id="wrglossary.1566"></a><a href="#glo:app.bib2gls"><span class="app!
fmt">bib2gls</span></a> user manuals for further details.) Note that <a id="wrglossary.1567"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> and <a id="wrglossary.1568"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> have much better multi-lingual support than <a id="wrglossary.1569"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, so <a id="wrglossary.1570"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> or <a id="wrglossary.1571"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> are recommended if you’re not writing in English. Commands that only have an effect when <a id="wrglossary.1572"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> is used are described in §<a href="#sec:xindy">14</a>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1573"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+This is a multi-stage process, but there are methods of automating document compilation using applications such as <a id="wrglossary.1574"></a><a href="#glo:app.latexmk"><span class="appfmt">latexmk</span></a> and <a id="wrglossary.1575"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a>. With <a id="wrglossary.1576"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> you can just add special comments to your document source: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1577"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: pdflatex
+% arara: makeglossaries
+% arara: pdflatex
+</pre> With <a id="wrglossary.1578"></a><a href="#glo:app.latexmk"><span class="appfmt">latexmk</span></a> you need to set up the required dependencies. </div><!-- end of important -->
+<p>
+The <a id="wrglossary.1579"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package comes with the Perl script <a id="wrglossary.1580"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> which will run <a id="wrglossary.1581"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1582"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> on all the <a id="wrglossary.1583"></a><a href="#glo:dual.indexingfile">indexing files</a> using a customized style file (which is created by <a id="wrglossary.1584"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>). See §<a href="#sec:makeglossariesapp">1.6.1</a> for further details. Perl is stable, cross-platform, open source software that is used by a number of TeX-related applications (including <a id="wrglossary.1585"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> and <a id="wrglossary.1586"></a><a href="#glo:app.latexmk"><span class="appfmt">latexmk</span></a>). Most Unix-like operating systems come with a Perl interpreter. TeX Live also comes with a Perl interpreter. As far as I know, MikTeX doesn’t come with a Perl interpreter so if you are a Windows MikTeX user you will need to install Perl if you want to use <a id="wrglossary.1587"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> or <a id="wrglossary.1588"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. Further information is available at <a href="http://www.perl.org/about.html">http://www.perl.org/about.html</a> and <a href="https://tex.stackexchange.com/questions/158796">MikTeX and Perl scripts (and one Python script)</a>.<p>
+The advantages of using <a id="wrglossary.1589"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>:
+<ul class="displaylist">
+ <li><span class="bulletitem">•</span>It automatically detects whether to use <a id="wrglossary.1590"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1591"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> and sets the relevant application switches.<p>
+<li><span class="bulletitem">•</span>One call of <a id="wrglossary.1592"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will run <a id="wrglossary.1593"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>/<a id="wrglossary.1594"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> for each <a id="wrglossary.1595"></a><a href="#glo:dual.glossary">glossary</a> type.<p>
+<li><span class="bulletitem">•</span>If things go wrong, <a id="wrglossary.1596"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will scan the messages from <a id="wrglossary.1597"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1598"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> and attempt to diagnose the problem in relation to the <a id="wrglossary.1599"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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 <a id="wrglossary.1600"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1601"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> messages.<p>
+<li><span class="bulletitem">•</span>If <a id="wrglossary.1602"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> warns about <a id="wrglossary.1603"></a><a href="#glo:idx.multipleencap">multiple encap</a> values, <a id="wrglossary.1604"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> v2.18+ will detect this and attempt to correct the problem. This correction is only provided by <a id="wrglossary.1605"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> when <a id="wrglossary.1606"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> is used since <a id="wrglossary.1607"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> uses the order of the <a id="wrglossary.1608"></a><a href="#glo:@@glslabel at xindyattr">attributes list</a> to determine which format should take precedence. (see §<a href="#sec:xindyloc">14.3</a>.) This correction can be switched off with the <a id="wrglossary.1609"></a><a href="#glo:switch.mkgls.e"><span class="shortargfmt">-e</span></a> switch.<p>
+<li><span class="bulletitem">•</span>If <a id="wrglossary.1610"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> warns about invalid or <a id="wrglossary.1611"></a><a href="#glo:idx.emptylocation">empty locations</a>, <a id="wrglossary.1612"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> v4.50+ will detect this and attempt to alter the location to fit <a id="wrglossary.1613"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span>’s</a> syntax. This may or may not cause unexpected results in the <a id="wrglossary.1614"></a><a href="#glo:dual.locationlist">location list</a>, but it’s useful if the <a id="wrglossary.1615"></a><a href="#glo:opt.nonumberlist"><span class="styoptfmt">nonumberlist</span></a> option is used.<p>
+<li><span class="bulletitem">•</span>If <a id="wrglossary.1616"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> has a warning that could be the result of a command occurring within the <a id="wrglossary.1617"></a><a href="#glo:@@glslabel at entrylocation">location</a>, <a id="wrglossary.1618"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> v4.50+ will attempt to repair it by moving the command out of the location and into the <a id="wrglossary.1619"></a><a href="#glo:locationencap">encap</a>.<p>
+
+</ul>
+ The first two items also apply to <a id="wrglossary.1620"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a>.<p>
+As from version 4.16, the <a id="wrglossary.1621"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package also comes with a Lua script called <a id="wrglossary.1622"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a>. This is a <span style="font-style: italic; font-variant: normal; ">trimmed-down</span> alternative to the <a id="wrglossary.1623"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></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 TeX distributions come with LuaTeX (and therefore have a Lua interpreter) you don’t need to install anything else in order to use <a id="wrglossary.1624"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> so it’s an alternative to <a id="wrglossary.1625"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> if you want to use <a id="wrglossary.1626"></a><a href="#glo:idx.opt.mkidx">Option 2</a> (<a id="wrglossary.1627"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>).<p>
+If things go wrong and you can’t work out why your <a id="wrglossary.1628"></a><a href="#glo:dual.glossary">glossaries</a> aren’t being generated correctly, you can use <a id="wrglossary.1629"></a><a href="#glo:app.makeglossariesgui"><span class="appfmt">makeglossariesgui</span></a> as a diagnostic tool. Once you’ve fixed the problem, you can then go back to using <a id="wrglossary.1630"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> or <a id="wrglossary.1631"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a>.<p>
+Whilst I strongly recommended that you use the <a id="wrglossary.1632"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> Perl script or the <a id="wrglossary.1633"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> Lua script, it is possible to use the <a id="wrglossary.1634"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package without using those applications. However, note that some commands and package options have no effect if you explicitly run <a id="wrglossary.1635"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>/<a id="wrglossary.1636"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. These are listed in Table <a href="#tab:makeglossariesCmds">1.3</a>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1637"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+If you are choosing not to use <a id="wrglossary.1638"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> because you don’t want to install Perl, you will only be able to use <a id="wrglossary.1639"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> as <a id="wrglossary.1640"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> also requires Perl. (Other useful Perl scripts include <span class="appfmt">epstopdf</span> and <a id="wrglossary.1641"></a><a href="#glo:app.latexmk"><span class="appfmt">latexmk</span></a>, so it’s well-worth the effort to install Perl.) </div><!-- end of important -->
+<p>
+Below, references to <a id="wrglossary.1642"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> can usually be substituted with <a id="wrglossary.1643"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a>, except where noted otherwise.<p>
+If any of your entries use an entry that is not referenced outside the <a id="wrglossary.1644"></a><a href="#glo:dual.glossary">glossary</a> (for example, the entry is only referenced in the description of another entry), you will need to do an additional <a id="wrglossary.1645"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>, <a id="wrglossary.1646"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1647"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> run, as appropriate. For example, suppose you have defined the following entries: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1648"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.1649"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{citrusfruit}{<a id="wrglossary.1650"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={citrus fruit}</span>,
+<a id="wrglossary.1651"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={fruit of any citrus tree. (See also <a id="wrglossary.1652"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{orange})}</span>}
+
+<a id="wrglossary.1653"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{orange}{<a id="wrglossary.1654"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={orange}</span>,
+<a id="wrglossary.1655"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={an orange coloured fruit.}</span>}
+</pre> and suppose you have <code class="code"><a id="wrglossary.1656"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{citrusfruit}</code> in your document but don’t reference the <span class="qt">“orange”</span> entry, then the orange entry won’t appear in your <a id="wrglossary.1657"></a><a href="#glo:dual.glossary">glossary</a> until you first create the <a id="wrglossary.1658"></a><a href="#glo:dual.glossary">glossary</a> and then do another run of <a id="wrglossary.1659"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>, <a id="wrglossary.1660"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1661"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. For example, if the document is called <span class="filefmt">myDoc.tex</span>, then you must do: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1662"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+makeglossaries myDoc
+pdflatex myDoc
+makeglossaries myDoc
+pdflatex myDoc
+</pre> (In the case of <a id="wrglossary.1663"></a><a href="#glo:idx.opt.b2g">Option 4</a>, <a id="wrglossary.1664"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> will scan the description for instances of commands like <a id="wrglossary.1665"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> to ensure they are selected but an extra <a id="wrglossary.1666"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> call is required to ensure the <a id="wrglossary.1667"></a><a href="#glo:@@glslabel at entrylocation">locations</a> are included, if <a id="wrglossary.1668"></a><a href="#glo:dual.locationlist">location lists</a> are required. See the and <a id="wrglossary.1669"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> manual for further details.)<p>
+Likewise, an additional <a id="wrglossary.1670"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> and LaTeX 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 LaTeX run may push glossary entries across page boundaries, which means that the <a id="wrglossary.1671"></a><a href="#glo:locationlist">number lists</a> in the glossary may need updating.<p>
+The examples in this document assume that you are accessing <a id="wrglossary.1672"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>, <a id="wrglossary.1673"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> or <a id="wrglossary.1674"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> via a terminal. Windows users can use the command prompt which is usually accessed via the <kbd class="menu"><kbd class="menuitem"><samp>Start</samp></kbd><span title="menu separator" class="icon">➜</span><kbd class="menuitem"><samp>All Programs</samp></kbd></kbd> menu or <kbd class="menu"><kbd class="menuitem"><samp>Start</samp></kbd><span title="menu separator" class="icon">➜</span><kbd class="menuitem"><samp>All Programs</samp></kbd><span title="menu separator" class="icon">➜</span><kbd class="menuitem"><samp>Accessories</samp></kbd></kbd> menu or <kbd class="menu"><kbd class="menuitem"><samp>Start</samp></kbd><span title="menu separator" class="icon">➜</span><kbd class="menuitem"><samp>Windows System</samp></kbd></kbd>.<p>
+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>
+If any problems occur, remember to check the transcript files (e.g. <a id="wrglossary.1675"></a><a href="#glo:ext.glg"><span class="extfmt">glg</span></a> or <a id="wrglossary.1676"></a><a href="#glo:ext.alg"><span class="extfmt">alg</span></a>) for messages.<p>
+<div class="table"> <table class="tabular-c">
+<caption id="tab:makeglossariesCmds">Table 3: Commands and package options that have no effect when using <span class="appfmt">xindy</span> or <span class="appfmt">makeindex</span> explicitly</caption><tr style=""><th class="cell-noborder-rightsep-l">Command or Package Option </th>
+<td class="cell-noborder-bothsep-l"> <span style="font-weight: bold; "><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> </span></td>
+<td class="cell-noborder-rightsep-l"> <span style="font-weight: bold; "><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> </span></td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><a href="#glo:opt.order"><span class="styoptfmt">order</span></a><span class="optfmt">=letter</span> </td>
+<td class="cell-noborder-bothsep-l"> use <a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> </td>
+<td class="cell-noborder-rightsep-l"> use <code class="code"><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> ord/letorder</code></td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><a href="#glo:opt.order"><span class="styoptfmt">order</span></a><span class="optfmt">=word</span> </td>
+<td class="cell-noborder-bothsep-l"> default </td>
+<td class="cell-noborder-rightsep-l"> default</td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a><span class="optfmt">=<a href="#glo:opt.xindy.language"><span class="optfmt">language</span></a><span class="optfmt">={lang}</span>,<a href="#glo:opt.xindy.codepage"><span class="optfmt">codepage</span></a><span class="optfmt">={code}</span></span> </td>
+<td class="cell-noborder-bothsep-l"> N/A </td>
+<td class="cell-noborder-rightsep-l"> use <code class="code"><a href="#glo:switch.xdy.L"><span class="shortargfmt">-L</span></a> <span class="meta">〈<em class="metainner">lang</em>〉</span> <a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> <span class="meta">〈<em class="metainner">code</em>〉</span></code></td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><code class="code"><a href="#glo:GlsSetXdyLanguage"><code class="csfmt">\GlsSetXdyLanguage</code></a>{<span class="meta">〈<em class="metainner">lang</em>〉</span>}</code> </td>
+<td class="cell-noborder-bothsep-l"> N/A </td>
+<td class="cell-noborder-rightsep-l"> use <code class="code"><a href="#glo:switch.xdy.L"><span class="shortargfmt">-L</span></a> <span class="meta">〈<em class="metainner">lang</em>〉</span></code></td>
+</tr><tr style=""><td class="cell-noborder-rightsep-l"><code class="code"><a href="#glo:GlsSetXdyCodePage"><code class="csfmt">\GlsSetXdyCodePage</code></a>{<span class="meta">〈<em class="metainner">code</em>〉</span>}</code> </td>
+<td class="cell-noborder-bothsep-l"> N/A </td>
+<td class="cell-noborder-rightsep-l"> use <code class="code"><a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> <span class="meta">〈<em class="metainner">code</em>〉</span></code> </td>
+</tr></table>
+ <p>
+</div><p>
+
+</section><!-- end of section sec:makeglossaries -->
+
+<section id="sec:makeglossariesapp"><!-- start of section sec:makeglossariesapp --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.6.1. Using the <span class="appfmt">makeglossaries</span> Perl Script<div class="labellink"><a href="#sec:makeglossariesapp">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1677"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div><a id="wrglossary.1678"></a><code class="code"><dfn id="glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></dfn> <span class="meta">〈<em class="metainner">options</em>〉</span> <span class="meta">〈<em class="metainner">aux-file</em>〉</span></code></pre><p>
+The <a id="wrglossary.1679"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> script picks up the relevant information from the auxiliary (<a id="wrglossary.1680"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a>) file and will either call <a id="wrglossary.1681"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> or <a id="wrglossary.1682"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, depending on the supplied information. Therefore, you only need to pass the document’s name without the extension to <a id="wrglossary.1683"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. For example, if your document is called <span class="filefmt">myDoc.tex</span>, type the following in your terminal: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1684"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex myDoc
+makeglossaries myDoc
+pdflatex myDoc
+</pre> If you only want one <a id="wrglossary.1685"></a><a href="#glo:dual.glossary">glossary</a> processed (for example, if you are working on a draft of a large document and want to concentrate on one specific <a id="wrglossary.1686"></a><a href="#glo:dual.glossary">glossary</a>) then include the <span class="meta">〈<em class="metainner">out-ext</em>〉</span> extension supplied to <a id="wrglossary.1687"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>, such as <a id="wrglossary.1688"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> for the <a id="wrglossary.1689"></a><a href="#glo:opt.glostype.main"><code class="glostypefmt">main</code></a> glossary. Note that if you do specify the extension and your document has multiple <a id="wrglossary.1690"></a><a href="#glo:dual.glossary">glossaries</a> defined, then <a id="wrglossary.1691"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will tell you how many <a id="wrglossary.1692"></a><a href="#glo:dual.glossary">glossaries</a> have been ignored unless the <a id="wrglossary.1693"></a><a href="#glo:switch.mkgls.q"><span class="shortargfmt">-q</span></a> has been used.<p>
+Windows users: TeX Live on Windows has its own internal Perl interpreter and provides <span class="filefmt">makeglossaries.exe</span> as a convenient wrapper for the <a id="wrglossary.1694"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> Perl script. MikTeX also provides a wrapper <span class="filefmt">makeglossaries.exe</span> but doesn’t provide a Perl interpreter (as far as I know), which is still required even if you run MikTeX’s <span class="filefmt">makeglossaries.exe</span>, so with MikTeX you’ll need to install Perl. There’s more information about this at <a href="https://tex.stackexchange.com/questions/158796">MikTeX and Perl scripts (and one Python script)</a>. <p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.1695"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+When upgrading the <a id="wrglossary.1696"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package, make sure you also upgrade your version of <a id="wrglossary.1697"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. The current version is 4.50. </div><!-- end of important -->
+<p>
+Some of the options are only applicable to <a id="wrglossary.1698"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> and some are only applicable to <a id="wrglossary.1699"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1700"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1701"></a><code class="code"><dfn id="glo:switch.mkgls.help"><span class="longargfmt">--help</span></dfn></code></div><!-- end of settingsbox -->
+ Shows a summary of all available options.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1702"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1703"></a><code class="code"><dfn id="glo:switch.mkgls.version"><span class="longargfmt">--version</span></dfn></code></div><!-- end of settingsbox -->
+ Shows the version details.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1704"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1705"></a><code class="code"><dfn id="glo:switch.mkgls.n"><span class="shortargfmt">-n</span></dfn></code></div><!-- end of settingsbox -->
+ Dry run mode. This doesn’t actually run <a id="wrglossary.1706"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>/<a id="wrglossary.1707"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> but just prints the command it would execute based on the information given in the <a id="wrglossary.1708"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file and the supplied options.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1709"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1710"></a><code class="code"><dfn id="glo:switch.mkgls.d"><span class="shortargfmt">-d</span></dfn> <span class="meta">〈<em class="metainner">directory</em>〉</span></code></div><!-- end of settingsbox -->
+ Instructs <a id="wrglossary.1711"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> to change to the given directory, which should be where the <a id="wrglossary.1712"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a>, <a id="wrglossary.1713"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> etc files are located. For example: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1714"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>pdflatex -output-directory myTmpDir myDoc
+makeglossaries <a id="wrglossary.1715"></a><a href="#glo:switch.mkgls.d"><span class="shortargfmt">-d</span></a> myTmpDir myDoc
+</pre><p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1716"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1717"></a><code class="code"><dfn id="glo:switch.mkgls.e"><span class="shortargfmt">-e</span></dfn></code></div><!-- end of settingsbox -->
+ Don’t check for <a id="wrglossary.1718"></a><a href="#glo:idx.multipleencap">multiple encaps</a> (only applicable with <a id="wrglossary.1719"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>). By default, if you are using <a id="wrglossary.1720"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, <a id="wrglossary.1721"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will check the <a id="wrglossary.1722"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> transcript for <a id="wrglossary.1723"></a><a href="#glo:idx.multipleencap">multiple encap</a> warnings. <p>
+The <a id="wrglossary.1724"></a><a href="#glo:idx.multipleencap">multiple encap</a> warning is where different <a id="wrglossary.1725"></a><a href="#glo:dual.locationencap">location encap</a> values (location formats) are used on the same <a id="wrglossary.1726"></a><a href="#glo:@@glslabel at entrylocation">location</a> for the same entry. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1727"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+
+<code class="cmd">\usepackage</code>{glossaries}
+<a id="wrglossary.1728"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>
+
+<a id="wrglossary.1729"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>{sample}{<a id="wrglossary.1730"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sample}</span>,<a id="wrglossary.1731"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={an example}</span>}
+
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.1732"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{sample}, <a id="wrglossary.1733"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>[<a id="wrglossary.1734"></a><a href="#glo:opt.glsopt.format"><span class="csoptfmt">format</span></a><span class="optfmt">=textbf</span>]{sample}.
+<a id="wrglossary.1735"></a><a href="#glo:printglossaries"><code class="csfmt">\printglossaries</code></a>
+<code class="cend">\end{document}</code>
+</pre> If you explicitly use <a id="wrglossary.1736"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, this will cause a warning and the <a id="wrglossary.1737"></a><a href="#glo:dual.locationlist">location list</a> will be <span class="qt">“1, <span style="font-weight: bold; ">1</span>”</span>. That is, the page number will be repeated with each format. As from v2.18, <a id="wrglossary.1738"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will check for this warning and, if found, will attempt to correct the problem by removing duplicate locations and retrying. If you actually want the duplicate location, you can prevent <a id="wrglossary.1739"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> from checking and correcting the duplicates with <a id="wrglossary.1740"></a><a href="#glo:switch.mkgls.e"><span class="shortargfmt">-e</span></a>.<p>
+There’s no similar check for <a id="wrglossary.1741"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> as <a id="wrglossary.1742"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> won’t produce any warning and will simply discard duplicates.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1743"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1744"></a><code class="code"><dfn id="glo:switch.mkgls.q"><span class="shortargfmt">-q</span></dfn></code></div><!-- end of settingsbox -->
+ Suppresses messages. The <a id="wrglossary.1745"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> script attempts to fork the <a id="wrglossary.1746"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>/<a id="wrglossary.1747"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> process using <code class="code">open()</code> on the piped redirection <code class="code">2>&1 |</code> and parses the processor output to help diagnose problems. If this method fails <a id="wrglossary.1748"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> will print an <span class="qt">“Unable to fork”</span> warning and will retry without redirection. Without this redirection, the <a id="wrglossary.1749"></a><a href="#glo:switch.mkgls.q"><span class="shortargfmt">-q</span></a> switch doesn’t work as well. Some operating systems don’t support redirection.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1750"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1751"></a><code class="code"><dfn id="glo:switch.mkgls.Q"><span class="shortargfmt">-Q</span></dfn></code></div><!-- end of settingsbox -->
+ Suppresses the <span class="qt">“Unable to fork”</span> warning.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1752"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1753"></a><code class="code"><dfn id="glo:switch.mkgls.k"><span class="shortargfmt">-k</span></dfn></code></div><!-- end of settingsbox -->
+ Don’t attempt redirection.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1754"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1755"></a><code class="code"><dfn id="glo:switch.mkgls.m"><span class="shortargfmt">-m</span></dfn> <span class="meta">〈<em class="metainner">application</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>makeindex</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ The <a id="wrglossary.1756"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> application. Only the name is required if it’s on the operating system’s path, otherwise the full path name will be needed.<p>
+If you want to use an application that is capable of reading <a id="wrglossary.1757"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> files (including support for <a id="wrglossary.1758"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> style files via <a id="wrglossary.1759"></a><a href="#glo:switch.mkidx.s"><span class="shortargfmt">-s</span></a>), then you can use <a id="wrglossary.1760"></a><a href="#glo:switch.mkgls.m"><span class="shortargfmt">-m</span></a> to specify the alternative application to use instead of <a id="wrglossary.1761"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. Note that both <a id="wrglossary.1762"></a><a href="#glo:app.xindex"><span class="appfmt">xindex</span></a> and <a id="wrglossary.1763"></a><a href="#glo:app.texindy"><span class="appfmt">texindy</span></a> can read <a id="wrglossary.1764"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> files using the default <a id="wrglossary.1765"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> syntax but, as of the time of writing this, they don’t support <a id="wrglossary.1766"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> style files.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1767"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1768"></a><code class="code"><dfn id="glo:switch.mkgls.x"><span class="shortargfmt">-x</span></dfn> <span class="meta">〈<em class="metainner">application</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>xindy</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ The <a id="wrglossary.1769"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> application. Only the name is required if it’s on the operating system’s path, otherwise the full path name will be needed.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1770"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1771"></a><code class="code"><dfn id="glo:switch.mkgls.c"><span class="shortargfmt">-c</span></dfn></code></div><!-- end of settingsbox -->
+ Compress intermediate blanks. This will pass <a id="wrglossary.1772"></a><a href="#glo:switch.mkidx.c"><span class="shortargfmt">-c</span></a> to <a id="wrglossary.1773"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1774"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1775"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1776"></a><code class="code"><dfn id="glo:switch.mkgls.r"><span class="shortargfmt">-r</span></dfn></code></div><!-- end of settingsbox -->
+ Disable implicit page <a id="wrglossary.1777"></a><a href="#glo:idx.range">range</a> formation. This will pass <a id="wrglossary.1778"></a><a href="#glo:switch.mkidx.r"><span class="shortargfmt">-r</span></a> to <a id="wrglossary.1779"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1780"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1781"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1782"></a><code class="code"><dfn id="glo:switch.mkgls.p"><span class="shortargfmt">-p</span></dfn> <span class="meta">〈<em class="metainner">num</em>〉</span></code></div><!-- end of settingsbox -->
+ Set the starting page number. This will pass <code class="code"><a id="wrglossary.1783"></a><a href="#glo:switch.mkidx.p"><span class="shortargfmt">-p</span></a> <span class="meta">〈<em class="metainner">num</em>〉</span></code> to <a id="wrglossary.1784"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1785"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+The following switches may be used to override settings written to the <a id="wrglossary.1786"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1787"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1788"></a><code class="code"><dfn id="glo:switch.mkgls.l"><span class="shortargfmt">-l</span></dfn></code></div><!-- end of settingsbox -->
+ Use letter ordering. This will pass <a id="wrglossary.1789"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> to <a id="wrglossary.1790"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <code class="code"><a id="wrglossary.1791"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> ord/letorder</code> to <a id="wrglossary.1792"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1793"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1794"></a><code class="code"><dfn id="glo:switch.mkgls.L"><span class="shortargfmt">-L</span></dfn> <span class="meta">〈<em class="metainner">language</em>〉</span></code></div><!-- end of settingsbox -->
+ The language to pass to <a id="wrglossary.1795"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. (Ignored if <a id="wrglossary.1796"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1797"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1798"></a><code class="code"><dfn id="glo:switch.mkgls.g"><span class="shortargfmt">-g</span></dfn></code></div><!-- end of settingsbox -->
+ Employ German word ordering. This will pass <a id="wrglossary.1799"></a><a href="#glo:switch.mkidx.g"><span class="shortargfmt">-g</span></a> to <a id="wrglossary.1800"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1801"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1802"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1803"></a><code class="code"><dfn id="glo:switch.mkgls.s"><span class="shortargfmt">-s</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Set the style file. This will pass <code class="code"><a id="wrglossary.1804"></a><a href="#glo:switch.mkidx.s"><span class="shortargfmt">-s</span></a> <span class="meta">〈<em class="metainner">filename</em>〉</span></code> to <a id="wrglossary.1805"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <code class="code"><a id="wrglossary.1806"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> <span class="meta">〈<em class="metainner">basename</em>〉</span></code> to <a id="wrglossary.1807"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> (where <span class="meta">〈<em class="metainner">basename</em>〉</span> is <span class="meta">〈<em class="metainner">filename</em>〉</span> with the <a id="wrglossary.1808"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> extension removed). This will generate an error if the extension is <a id="wrglossary.1809"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> when <a id="wrglossary.1810"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> should be called, or if the extension isn’t <a id="wrglossary.1811"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> when <a id="wrglossary.1812"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1813"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1814"></a><code class="code"><dfn id="glo:switch.mkgls.o"><span class="shortargfmt">-o</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Sets the output file name. Note that this should only be used when only one <a id="wrglossary.1815"></a><a href="#glo:dual.glossary">glossary</a> should be processed. The default is to set the output filename to the basename supplied to <a id="wrglossary.1816"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> with the extension associated with the <a id="wrglossary.1817"></a><a href="#glo:dual.glossary">glossary</a> (the <span class="meta">〈<em class="metainner">in-ext</em>〉</span> argument of <a id="wrglossary.1818"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>).<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1819"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1820"></a><code class="code"><dfn id="glo:switch.mkgls.t"><span class="shortargfmt">-t</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Sets the transcript file name. Note that this should only be used when only one <a id="wrglossary.1821"></a><a href="#glo:dual.glossary">glossary</a> should be processed. The default is to set the transcript filename to the basename supplied to <a id="wrglossary.1822"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> with the extension associated with the <a id="wrglossary.1823"></a><a href="#glo:dual.glossary">glossary</a> (the <span class="meta">〈<em class="metainner">log-ext</em>〉</span> argument of <a id="wrglossary.1824"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>).<p>
+
+</section><!-- end of section sec:makeglossariesapp -->
+
+<section id="sec:makeglossarieslua"><!-- start of section sec:makeglossarieslua --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.6.2. Using the <span class="appfmt">makeglossaries-lite</span> Lua Script<div class="labellink"><a href="#sec:makeglossarieslua">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1825"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div><a id="wrglossary.1826"></a><code class="code"><dfn id="glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></dfn> <span class="meta">〈<em class="metainner">options</em>〉</span> <span class="meta">〈<em class="metainner">aux-file</em>〉</span></code></pre><p>
+The Lua alternative to the <a id="wrglossary.1827"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> Perl script requires a Lua interpreter, which should already be available if you have a modern TeX distribution that includes LuaTeX. 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 id="wrglossary.1828"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> script is therefore limited by this and some of the options available to the <a id="wrglossary.1829"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> Perl script aren’t available here. (In particular the <a id="wrglossary.1830"></a><a href="#glo:switch.mkgls.d"><span class="shortargfmt">-d</span></a> option.) Whilst it may be possible to implement those features by requiring Lua packages, this would defeat the purpose of providing this script for those don’t want the inconvenience of learning how to install interpreters or their associated packages.<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.1831"></a><a href="#glo:sym.information"><span title="Information" class="icon">🛈</span></a></div><!-- end of informationtitle -->
+The script is actually supplied as <span class="filefmt">makeglossaries-lite.lua</span> but TeX distributions on Windows convert this to an executable wrapper <span class="filefmt">makeglossaries-lite.exe</span> and TeX Live on Unix-like systems provide a symbolic link without the extension. </div><!-- end of information -->
+<p>
+The <a id="wrglossary.1832"></a><a href="#glo:app.makeglossaries-lite"><span class="appfmt">makeglossaries-lite</span></a> script can be invoked in the same way as <a id="wrglossary.1833"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. For example, if your document is called <span class="filefmt">myDoc.tex</span>, then do <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1834"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeglossaries-lite myDoc
+</pre> Note that the <a id="wrglossary.1835"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> rule doesn’t contain the hyphen: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1836"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: makeglossarieslite
+</pre><p>
+Some of the options are only applicable to <a id="wrglossary.1837"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> and some are only applicable to <a id="wrglossary.1838"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1839"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1840"></a><code class="code"><dfn id="glo:switch.mkglslite.help"><span class="longargfmt">--help</span></dfn></code></div><!-- end of settingsbox -->
+ Shows a summary of all available options.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1841"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1842"></a><code class="code"><dfn id="glo:switch.mkglslite.version"><span class="longargfmt">--version</span></dfn></code></div><!-- end of settingsbox -->
+ Shows the version details.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1843"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1844"></a><code class="code"><dfn id="glo:switch.mkglslite.n"><span class="shortargfmt">-n</span></dfn></code></div><!-- end of settingsbox -->
+ Dry run mode. This doesn’t actually run <a id="wrglossary.1845"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>/<a id="wrglossary.1846"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> but just prints the command it would execute based on the information given in the <a id="wrglossary.1847"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file and the supplied options.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1848"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1849"></a><code class="code"><dfn id="glo:switch.mkglslite.q"><span class="shortargfmt">-q</span></dfn></code></div><!-- end of settingsbox -->
+ Quiet mode. This suppresses some but not all messages.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1850"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1851"></a><code class="code"><dfn id="glo:switch.mkglslite.m"><span class="shortargfmt">-m</span></dfn> <span class="meta">〈<em class="metainner">application</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>makeindex</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ The <a id="wrglossary.1852"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> application. Only the name is required if it’s on the operating system’s path, otherwise the full path name will be needed.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1853"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1854"></a><code class="code"><dfn id="glo:switch.mkglslite.x"><span class="shortargfmt">-x</span></dfn> <span class="meta">〈<em class="metainner">application</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>xindy</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ The <a id="wrglossary.1855"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> application. Only the name is required if it’s on the operating system’s path, otherwise the full path name will be needed.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1856"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1857"></a><code class="code"><dfn id="glo:switch.mkglslite.c"><span class="shortargfmt">-c</span></dfn></code></div><!-- end of settingsbox -->
+ Compress intermediate blanks. This will pass <a id="wrglossary.1858"></a><a href="#glo:switch.mkidx.c"><span class="shortargfmt">-c</span></a> to <a id="wrglossary.1859"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1860"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1861"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1862"></a><code class="code"><dfn id="glo:switch.mkglslite.r"><span class="shortargfmt">-r</span></dfn></code></div><!-- end of settingsbox -->
+ Disable implicit page <a id="wrglossary.1863"></a><a href="#glo:idx.range">range</a> formation. This will pass <a id="wrglossary.1864"></a><a href="#glo:switch.mkidx.r"><span class="shortargfmt">-r</span></a> to <a id="wrglossary.1865"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1866"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1867"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1868"></a><code class="code"><dfn id="glo:switch.mkglslite.p"><span class="shortargfmt">-p</span></dfn> <span class="meta">〈<em class="metainner">num</em>〉</span></code></div><!-- end of settingsbox -->
+ Set the starting page number. This will pass <code class="code"><a id="wrglossary.1869"></a><a href="#glo:switch.mkidx.p"><span class="shortargfmt">-p</span></a> <span class="meta">〈<em class="metainner">num</em>〉</span></code> to <a id="wrglossary.1870"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1871"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+The following switches may be used to override settings written to the <a id="wrglossary.1872"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1873"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1874"></a><code class="code"><dfn id="glo:switch.mkglslite.l"><span class="shortargfmt">-l</span></dfn></code></div><!-- end of settingsbox -->
+ Use letter ordering. This will pass <a id="wrglossary.1875"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> to <a id="wrglossary.1876"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <code class="code"><a id="wrglossary.1877"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> ord/letorder</code> to <a id="wrglossary.1878"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1879"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1880"></a><code class="code"><dfn id="glo:switch.mkglslite.L"><span class="shortargfmt">-L</span></dfn> <span class="meta">〈<em class="metainner">language</em>〉</span></code></div><!-- end of settingsbox -->
+ The language to pass to <a id="wrglossary.1881"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>. (Ignored if <a id="wrglossary.1882"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1883"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1884"></a><code class="code"><dfn id="glo:switch.mkglslite.g"><span class="shortargfmt">-g</span></dfn></code></div><!-- end of settingsbox -->
+ Employ German word ordering. This will pass <a id="wrglossary.1885"></a><a href="#glo:switch.mkidx.g"><span class="shortargfmt">-g</span></a> to <a id="wrglossary.1886"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>. (Ignored if <a id="wrglossary.1887"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be called.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1888"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1889"></a><code class="code"><dfn id="glo:switch.mkglslite.s"><span class="shortargfmt">-s</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Set the style file.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1890"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1891"></a><code class="code"><dfn id="glo:switch.mkglslite.o"><span class="shortargfmt">-o</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Sets the output file name. Note that this should only be used when only one <a id="wrglossary.1892"></a><a href="#glo:dual.glossary">glossary</a> should be processed. The default is to set the output filename to the basename supplied to <a id="wrglossary.1893"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> with the extension associated with the <a id="wrglossary.1894"></a><a href="#glo:dual.glossary">glossary</a> (the <span class="meta">〈<em class="metainner">in-ext</em>〉</span> argument of <a id="wrglossary.1895"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>).<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.1896"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.1897"></a><code class="code"><dfn id="glo:switch.mkglslite.t"><span class="shortargfmt">-t</span></dfn> <span class="meta">〈<em class="metainner">filename</em>〉</span></code></div><!-- end of settingsbox -->
+ Sets the transcript file name. Note that this should only be used when only one <a id="wrglossary.1898"></a><a href="#glo:dual.glossary">glossary</a> should be processed. The default is to set the transcript filename to the basename supplied to <a id="wrglossary.1899"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> with the extension associated with the <a id="wrglossary.1900"></a><a href="#glo:dual.glossary">glossary</a> (the <span class="meta">〈<em class="metainner">log-ext</em>〉</span> argument of <a id="wrglossary.1901"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>).<p>
+
+</section><!-- end of section sec:makeglossarieslua -->
+
+<section id="sec:xindyapp"><!-- start of section sec:xindyapp --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.6.3. Using <span class="appfmt">xindy</span> explicitly (Option 3)<div class="labellink"><a href="#sec:xindyapp">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<a id="wrglossary.1902"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> comes with TeX Live. It has also been added to MikTeX, but if you don’t have it installed, see <a href="https://tex.stackexchange.com/questions/71167">How to use Xindy with MikTeX</a>.<p>
+If you want to use <a id="wrglossary.1903"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> to process the glossary files, you must make sure you have used the <a id="wrglossary.1904"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a> package option: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.1905"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.1906"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a>]{glossaries}
+</pre> This is required regardless of whether you use <a id="wrglossary.1907"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> explicitly or whether it’s called implicitly via applications such as <a id="wrglossary.1908"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. This causes the glossary entries to be written in raw <a id="wrglossary.1909"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> format, so you need to use <code class="code"><a id="wrglossary.1910"></a><a href="#glo:switch.xdy.I"><span class="shortargfmt">-I</span></a> xindy</code> <span style="font-style: italic; font-variant: normal; ">not</span> <code class="code"><a id="wrglossary.1911"></a><a href="#glo:switch.xdy.I"><span class="shortargfmt">-I</span></a> tex</code>.<p>
+To run <a id="wrglossary.1912"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> type the following in your terminal (all on one line): <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1913"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>xindy <a id="wrglossary.1914"></a><a href="#glo:switch.xdy.L"><span class="shortargfmt">-L</span></a> <span class="meta">〈<em class="metainner">language</em>〉</span> <a id="wrglossary.1915"></a><a href="#glo:switch.xdy.C"><span class="shortargfmt">-C</span></a> <span class="meta">〈<em class="metainner">encoding</em>〉</span> <a id="wrglossary.1916"></a><a href="#glo:switch.xdy.I"><span class="shortargfmt">-I</span></a> xindy <a id="wrglossary.1917"></a><a href="#glo:switch.xdy.M"><span class="shortargfmt">-M</span></a> <span class="meta">〈<em class="metainner">style</em>〉</span> <a id="wrglossary.1918"></a><a href="#glo:switch.xdy.t"><span class="shortargfmt">-t</span></a> <span class="meta">〈<em class="metainner">base</em>〉</span>.glg <a id="wrglossary.1919"></a><a href="#glo:switch.xdy.o"><span class="shortargfmt">-o</span></a> <span class="meta">〈<em class="metainner">base</em>〉</span>.gls <span class="meta">〈<em class="metainner">base</em>〉</span>.glo
+</pre> where <span class="meta">〈<em class="metainner">language</em>〉</span> is the required language name, <span class="meta">〈<em class="metainner">encoding</em>〉</span> is the <a id="wrglossary.1920"></a><a href="#glo:idx.encoding">encoding</a>, <span class="meta">〈<em class="metainner">base</em>〉</span> is the name of the document without the <a id="wrglossary.1921"></a><a href="#glo:ext.tex"><span class="extfmt">tex</span></a> extension and <span class="meta">〈<em class="metainner">style</em>〉</span> is the name of the <a id="wrglossary.1922"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> style file without the <a id="wrglossary.1923"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> extension. The default name for this style file is <span class="meta">〈<em class="metainner">base</em>〉</span><a id="wrglossary.1924"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a> but can be changed via <a id="wrglossary.1925"></a><a href="#glo:setStyleFile"><code class="csfmt">\setStyleFile</code></a>. 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>
+For example, if your document is called <span class="filefmt">myDoc.tex</span> and you are using <a id="wrglossary.1926"></a><a href="#glo:dual.utf8">UTF-8</a> <a id="wrglossary.1927"></a><a href="#glo:idx.encoding">encoding</a> in English, then type the following in your terminal: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1928"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.glg -o myDoc.gls myDoc.glo
+</pre><p>
+Note that this just creates the <a id="wrglossary.1929"></a><a href="#glo:opt.glostype.main"><code class="glostypefmt">main</code></a> <a id="wrglossary.1930"></a><a href="#glo:dual.glossary">glossary</a>. You need to do the same for each of the other <a id="wrglossary.1931"></a><a href="#glo:dual.glossary">glossaries</a> (including the list of <a id="wrglossary.1932"></a><a href="#glo:idx.acronym">acronyms</a> if you have used the <a id="wrglossary.1933"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a> package option), substituting <a id="wrglossary.1934"></a><a href="#glo:ext.glg"><span class="extfmt">glg</span></a>, <a id="wrglossary.1935"></a><a href="#glo:ext.gls"><span class="extfmt">gls</span></a> and <a id="wrglossary.1936"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> with the relevant extensions. For example, if you have used the <a id="wrglossary.1937"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a> package option, then you would need to do: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1938"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>xindy -L english -C utf8 -I xindy -M myDoc -t myDoc.alg -o myDoc.acr myDoc.acn
+</pre> For additional <a id="wrglossary.1939"></a><a href="#glo:dual.glossary">glossaries</a>, the extensions are those supplied when you created the <a id="wrglossary.1940"></a><a href="#glo:dual.glossary">glossary</a> with <a id="wrglossary.1941"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>.<p>
+Note that if you use <a id="wrglossary.1942"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> instead, you can replace all those calls to <a id="wrglossary.1943"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> with just one call to <a id="wrglossary.1944"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1945"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeglossaries myDoc
+</pre> Note also that some commands and package options have no effect if you use <a id="wrglossary.1946"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> explicitly instead of using <a id="wrglossary.1947"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. These are listed in Table <a href="#tab:makeglossariesCmds">1.3</a>.<p>
+
+</section><!-- end of section sec:xindyapp -->
+
+<section id="sec:makeindexapp"><!-- start of section sec:makeindexapp --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.6.4. Using <span class="appfmt">makeindex</span> explicitly (Option 2)<div class="labellink"><a href="#sec:makeindexapp">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+If you want to use <a id="wrglossary.1948"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> explicitly, you must make sure that you haven’t used the <a id="wrglossary.1949"></a><a href="#glo:opt.xindy"><span class="styoptfmt">xindy</span></a> package option or the <a id="wrglossary.1950"></a><a href="#glo:idx.glossaryentry">glossary entries</a> will be written in the wrong format. To run <a id="wrglossary.1951"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, type the following in your terminal: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1952"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeindex <a id="wrglossary.1953"></a><a href="#glo:switch.mkidx.s"><span class="shortargfmt">-s</span></a> <span class="meta">〈<em class="metainner">style</em>〉</span>.ist <a id="wrglossary.1954"></a><a href="#glo:switch.mkidx.t"><span class="shortargfmt">-t</span></a> <span class="meta">〈<em class="metainner">base</em>〉</span>.glg <a id="wrglossary.1955"></a><a href="#glo:switch.mkidx.o"><span class="shortargfmt">-o</span></a> <span class="meta">〈<em class="metainner">base</em>〉</span>.gls <span class="meta">〈<em class="metainner">base</em>〉</span>.glo
+</pre> where <span class="meta">〈<em class="metainner">base</em>〉</span> is the name of your document without the <a id="wrglossary.1956"></a><a href="#glo:ext.tex"><span class="extfmt">tex</span></a> extension and <span class="meta">〈<em class="metainner">style</em>〉</span><a id="wrglossary.1957"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a> is the name of the <a id="wrglossary.1958"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> style file. By default, this is <span class="meta">〈<em class="metainner">base</em>〉</span><a id="wrglossary.1959"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a>, but may be changed via <a id="wrglossary.1960"></a><a href="#glo:setStyleFile"><code class="csfmt">\setStyleFile</code></a>. Note that there are other options, such as <a id="wrglossary.1961"></a><a href="#glo:switch.mkidx.l"><span class="shortargfmt">-l</span></a> (letter ordering). See the <a id="wrglossary.1962"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> manual for further details.<p>
+For example, if your document is called <span class="filefmt">myDoc.tex</span>, then type the following at the terminal: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1963"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeindex -s myDoc.ist -t myDoc.glg -o myDoc.gls myDoc.glo
+</pre> Note that this only creates the <a id="wrglossary.1964"></a><a href="#glo:opt.glostype.main"><code class="glostypefmt">main</code></a> <a id="wrglossary.1965"></a><a href="#glo:dual.glossary">glossary</a>. If you have additional <a id="wrglossary.1966"></a><a href="#glo:dual.glossary">glossaries</a> (for example, if you have used the <a id="wrglossary.1967"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a> package option) then you must call <a id="wrglossary.1968"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> for each glossary, substituting <a id="wrglossary.1969"></a><a href="#glo:ext.glg"><span class="extfmt">glg</span></a>, <a id="wrglossary.1970"></a><a href="#glo:ext.gls"><span class="extfmt">gls</span></a> and <a id="wrglossary.1971"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a> with the relevant extensions. For example, if you have used the <a id="wrglossary.1972"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a> package option, then you need to type the following in your terminal: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1973"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeindex -s myDoc.ist -t myDoc.alg -o myDoc.acr myDoc.acn
+</pre> For additional glossaries, the extensions are those supplied when you created the glossary with <a id="wrglossary.1974"></a><a href="#glo:newglossary"><code class="csfmt">\newglossary</code></a>.<p>
+Note that if you use <a id="wrglossary.1975"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> instead, you can replace all those calls to <a id="wrglossary.1976"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> with just one call to <a id="wrglossary.1977"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>: <pre class="terminal"><div class="terminaltitle"><a id="wrglossary.1978"></a><a href="#glo:sym.terminal"><span title="Terminal" class="icon">🔎</span></a></div>makeglossaries myDoc
+</pre> Note also that some commands and package options have no effect if you use <a id="wrglossary.1979"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> explicitly instead of using <a id="wrglossary.1980"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>. These are listed in Table <a href="#tab:makeglossariesCmds">1.3</a>.<p>
+
+</section><!-- end of section sec:makeindexapp -->
+
+<section id="sec:notedev"><!-- start of section sec:notedev --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->1.7. Note to Front-End and Script Developers<div class="labellink"><a href="#sec:notedev">[link]</a></div></h2><!-- end of section header -->
+<p>
+The information needed to determine whether to use <a id="wrglossary.1981"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>, <a id="wrglossary.1982"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.1983"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> is stored in the <a id="wrglossary.1984"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file. This information can be gathered by a front-end, editor or script to make the <a id="wrglossary.1985"></a><a href="#glo:dual.glossary">glossaries</a> where appropriate. This section describes how the information is stored in the auxiliary file.<p>
+
+</section><!-- end of section sec:notedev -->
+
+<section id="sec:notedev.makeindex.xindy"><!-- start of section sec:notedev.makeindex.xindy --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.7.1. MakeIndex and Xindy<div class="labellink"><a href="#sec:notedev.makeindex.xindy">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+The <a id="wrglossary.1986"></a><a href="#glo:idx.fileextension">file extension</a> of the <a id="wrglossary.1987"></a><a href="#glo:dual.indexingfile">indexing files</a> used for each defined <a id="wrglossary.1988"></a><a href="#glo:dual.glossary">glossary</a> (not including any <a id="wrglossary.1989"></a><a href="#glo:dual.ignoredglossary">ignored glossaries</a>) are given by: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.1990"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.1991"></a><code class="code"><dfn id="glo:@newglossary"><code class="csfmt">\@newglossary</code></dfn>{<span class="meta">〈<em class="metainner">glossary-label</em>〉</span>}{<span class="meta">〈<em class="metainner">log</em>〉</span>}{<span class="meta">〈<em class="metainner">out-ext</em>〉</span>}{<span class="meta">〈<em class="metainner">in-ext</em>〉</span>}</code></div><!-- end of pinnedbox -->
+where <span class="meta">〈<em class="metainner">in-ext</em>〉</span> is the extension of the <span style="font-style: italic; font-variant: normal; "><a id="wrglossary.1992"></a><a href="#glo:dual.indexingapp">indexing application’s</a></span> input file (the output file from the <a id="wrglossary.1993"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package’s point of view), such as <a id="wrglossary.1994"></a><a href="#glo:ext.glo"><span class="extfmt">glo</span></a>, <span class="meta">〈<em class="metainner">out-ext</em>〉</span> is the extension of the <span style="font-style: italic; font-variant: normal; "><a id="wrglossary.1995"></a><a href="#glo:dual.indexingapp">indexing application’s</a></span> output file (the input file from the <a id="wrglossary.1996"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package’s point of view), such as <a id="wrglossary.1997"></a><a href="#glo:ext.gls"><span class="extfmt">gls</span></a>, and <span class="meta">〈<em class="metainner">log</em>〉</span> is the extension of the <a id="wrglossary.1998"></a><a href="#glo:dual.indexingapp">indexing application’s</a> transcript file, such as <a id="wrglossary.1999"></a><a href="#glo:ext.glg"><span class="extfmt">glg</span></a>. The label for the <a id="wrglossary.2000"></a><a href="#glo:dual.glossary">glossary</a> is also given. This isn’t required with <a id="wrglossary.2001"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a>, but with <a id="wrglossary.2002"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> it’s needed to pick up the associated language and <a id="wrglossary.2003"></a><a href="#glo:idx.encoding">encoding</a> (see below). For example, the information for the default <a id="wrglossary.2004"></a><a href="#glo:opt.glostype.main"><code class="glostypefmt">main</code></a> <a id="wrglossary.2005"></a><a href="#glo:dual.glossary">glossary</a> is written as: <pre class="codebox"><div clas!
s="codeboxtitle"><a id="wrglossary.2006"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><a id="wrglossary.2007"></a><a href="#glo:@newglossary"><code class="csfmt">\@newglossary</code></a>{main}{glg}{gls}{glo}
+</pre> If <a id="wrglossary.2008"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span>’s</a> hybrid method has been used (with <a id="wrglossary.2009"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>[<span class="meta">〈<em class="metainner">sub-list</em>〉</span>]), then the sub-list of <a id="wrglossary.2010"></a><a href="#glo:dual.glossary">glossaries</a> that need to be processed will be identified with: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2011"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2012"></a><code class="code"><dfn id="glo:glsxtr at makeglossaries"><code class="csfmt">\glsxtr at makeglossaries</code></dfn>{<span class="meta">〈<em class="metainner">label-list</em>〉</span>}</code></div><!-- end of pinnedbox -->
+<p>
+The <a id="wrglossary.2013"></a><a href="#glo:dual.indexingapp">indexing application’s</a> style file is specified by: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2014"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2015"></a><code class="code"><dfn id="glo:@istfilename"><code class="csfmt">\@istfilename</code></dfn>{<span class="meta">〈<em class="metainner">filename</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ The file extension indicates whether to use <a id="wrglossary.2016"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> (<a id="wrglossary.2017"></a><a href="#glo:ext.ist"><span class="extfmt">ist</span></a>) or <a id="wrglossary.2018"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> (<a id="wrglossary.2019"></a><a href="#glo:ext.xdy"><span class="extfmt">xdy</span></a>). Note that the <a id="wrglossary.2020"></a><a href="#glo:dual.glossary">glossary</a> information has a different syntax depending on which <a id="wrglossary.2021"></a><a href="#glo:dual.indexingapp">indexing application</a> is supposed to be used, so it’s important to call the correct one.<p>
+For example, with <a id="wrglossary.2022"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> you can easily determine whether to run <a id="wrglossary.2023"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2024"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: makeglossaries if found("aux", "@istfilename")
+</pre> It’s more complicated if you want to explicitly run <a id="wrglossary.2025"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.2026"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.2027"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Note that if you choose to explicitly call <a id="wrglossary.2028"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.2029"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> then the user will miss out on the diagnostic information and the <a id="wrglossary.2030"></a><a href="#glo:locationencap">encap</a>-clash fix that <a id="wrglossary.2031"></a><a href="#glo:app.makeglossaries"><span class="appfmt">makeglossaries</span></a> also provides. </div><!-- end of important -->
+<p>
+Word or letter ordering is specified by: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2032"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2033"></a><code class="code"><dfn id="glo:@glsorder"><code class="csfmt">\@glsorder</code></dfn>{<span class="meta">〈<em class="metainner">order</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ where <span class="meta">〈<em class="metainner">order</em>〉</span> can be either <code class="code">word</code> or <code class="code">letter</code> (obtained from the <a id="wrglossary.2034"></a><a href="#glo:opt.order"><span class="styoptfmt">order</span></a> package option).<p>
+If <a id="wrglossary.2035"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> should be used, the language for each <a id="wrglossary.2036"></a><a href="#glo:dual.glossary">glossary</a> is specified by: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2037"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2038"></a><code class="code"><dfn id="glo:@xdylanguage"><code class="csfmt">\@xdylanguage</code></dfn>{<span class="meta">〈<em class="metainner">glossary-label</em>〉</span>}{<span class="meta">〈<em class="metainner">language</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ where <span class="meta">〈<em class="metainner">glossary-label</em>〉</span> identifies the <a id="wrglossary.2039"></a><a href="#glo:dual.glossary">glossary</a> and <span class="meta">〈<em class="metainner">language</em>〉</span> is the root language (for example, <code class="code">english</code>).<p>
+The <a id="wrglossary.2040"></a><a href="#glo:idx.codepage">codepage</a> (file <a id="wrglossary.2041"></a><a href="#glo:idx.encoding">encoding</a>) for all <a id="wrglossary.2042"></a><a href="#glo:dual.glossary">glossaries</a> is specified by: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2043"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2044"></a><code class="code"><dfn id="glo:@gls at codepage"><code class="csfmt">\@gls at codepage</code></dfn>{<span class="meta">〈<em class="metainner">code-page</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ where <span class="meta">〈<em class="metainner">code</em>〉</span> is the <a id="wrglossary.2045"></a><a href="#glo:idx.encoding">encoding</a> (for example, <code class="code">utf8</code>). The above two commands are omitted if <a id="wrglossary.2046"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> should be used.<p>
+If <a id="wrglossary.2047"></a><a href="#glo:idx.opt.noidx">Option 1</a> has been used, the <a id="wrglossary.2048"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file will contain <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2049"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2050"></a><code class="code"><dfn id="glo:@gls at reference"><code class="csfmt">\@gls at reference</code></dfn>{<span class="meta">〈<em class="metainner">type</em>〉</span>}{<span class="meta">〈<em class="metainner">label</em>〉</span>}{<span class="meta">〈<em class="metainner">location</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ for every time an entry has been referenced. <p>
+
+</section><!-- end of section sec:notedev.makeindex.xindy -->
+
+<section id="sec:notedev.labels"><!-- start of section sec:notedev.labels --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.7.2. Entry Labels<div class="labellink"><a href="#sec:notedev.labels">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+If you need to gather labels for <a id="wrglossary.2051"></a><a href="#glo:idx.auto-completion">auto-completion</a>, the <a id="wrglossary.2052"></a><a href="#glo:opt.writeglslabels"><span class="styoptfmt">writeglslabels</span></a> package option will create a file containing the labels of all defined <a id="wrglossary.2053"></a><a href="#glo:idx.glossaryentry">entries</a> (regardless of whether or not the <a id="wrglossary.2054"></a><a href="#glo:idx.glossaryentry">entry</a> has been used in the document). As from v4.47, there is a similar option <a id="wrglossary.2055"></a><a href="#glo:opt.writeglslabelnames"><span class="styoptfmt">writeglslabelnames</span></a> that writes both the label and name (separated by a tab).<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2056"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.2057"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package also provides <a id="wrglossary.2058"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=atom</span>, which will create the <a id="wrglossary.2059"></a><a href="#glo:ext.glsdefs"><span class="extfmt">glsdefs</span></a> file but will act like <a id="wrglossary.2060"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=restricted</span>. </div><!-- end of information -->
+<p>
+
+</section><!-- end of section sec:notedev.labels -->
+
+<section id="sec:notedev.bib2gls"><!-- start of section sec:notedev.bib2gls --><div class="tomain"><a href="#main">[top]</a></div>
+<h3><!-- start of subsection header -->1.7.3. Bib2Gls<div class="labellink"><a href="#sec:notedev.bib2gls">[link]</a></div></h3><!-- end of subsection header -->
+<p>
+<div class="sidenote"><a id="wrglossary.2061"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a></div><span class="clearfix"></span><!-- end of sidenote -->
+If <a id="wrglossary.2062"></a><a href="#glo:idx.opt.b2g">Option 4</a> has been used, the <a id="wrglossary.2063"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file will contain one or more instances of: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2064"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2065"></a><code class="code"><dfn id="glo:glsxtr at resource"><code class="csfmt">\glsxtr at resource</code></dfn>{<span class="meta">〈<em class="metainner">options</em>〉</span>}{<span class="meta">〈<em class="metainner">basename</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ where <span class="meta">〈<em class="metainner">basename</em>〉</span> is the basename of the <a id="wrglossary.2066"></a><a href="#glo:ext.glstex"><span class="extfmt">glstex</span></a> file that needs to be created by <a id="wrglossary.2067"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>. If <a id="wrglossary.2068"></a><a href="#glo:opt.resource.src"><span class="xtrcsoptfmt">src</span></a><span class="optfmt">={<span class="meta">〈<em class="metainner">bib list</em>〉</span>}</span> isn’t present in <span class="meta">〈<em class="metainner">options</em>〉</span> then <span class="meta">〈<em class="metainner">basename</em>〉</span> also indicates the name of the associated <a id="wrglossary.2069"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> file.<p>
+For example, with <a id="wrglossary.2070"></a><a href="#glo:app.arara"><span class="appfmt">arara</span></a> you can easily determine whether or not to run <a id="wrglossary.2071"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2072"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div>% arara: bib2gls if found("aux", "glsxtr at resource")
+</pre> (It gets more complicated if both <a id="wrglossary.2073"></a><a href="#glo:glsxtr at resource"><code class="csfmt">\glsxtr at resource</code></a> and <a id="wrglossary.2074"></a><a href="#glo:@istfilename"><code class="csfmt">\@istfilename</code></a> are present as that indicates the hybrid <a id="wrglossary.2075"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=hybrid</span> option.)<p>
+Remember that with <a id="wrglossary.2076"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>, the <a id="wrglossary.2077"></a><a href="#glo:idx.glossaryentry">glossary entries</a> will never be defined on the first LaTeX call (because their definitions are contained in the <a id="wrglossary.2078"></a><a href="#glo:ext.glstex"><span class="extfmt">glstex</span></a> file created by <a id="wrglossary.2079"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a>). You can also pick up labels from the <a id="wrglossary.2080"></a><a href="#glo:@@glslabel at indexing">records</a> in <a id="wrglossary.2081"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file, which will be in the form: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2082"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2083"></a><code class="code"><dfn id="glo:glsxtr at record"><code class="csfmt">\glsxtr at record</code></dfn>{<span class="meta">〈<em class="metainner">label</em>〉</span>}{<span class="meta">〈<em class="metainner">h-prefix</em>〉</span>}{<span class="meta">〈<em class="metainner">counter</em>〉</span>}{<span class="meta">〈<em class="metainner">format</em>〉</span>}{<span class="meta">〈<em class="metainner">loc</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ or (with <a id="wrglossary.2084"></a><a href="#glo:opt.record"><span class="xtrstyoptfmt">record</span></a><span class="optfmt">=nameref</span>): <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2085"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2086"></a><code class="code"><dfn id="glo:glsxtr at record@nameref"><code class="csfmt">\glsxtr at record@nameref</code></dfn>{<span class="meta">〈<em class="metainner">label</em>〉</span>}{<span class="meta">〈<em class="metainner">href prefix</em>〉</span>}{<span class="meta">〈<em class="metainner">counter</em>〉</span>}{<span class="meta">〈<em class="metainner">format</em>〉</span>}{<span class="meta">〈<em class="metainner">location</em>〉</span>}{<span class="meta">〈<em class="metainner">title</em>〉</span>}{<span class="meta">〈<em class="metainner">href anchor</em>〉</span>}{<span class="meta">〈<em class="metainner">href value</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ or (with <a id="wrglossary.2087"></a><a href="#glo:glssee"><code class="csfmt">\glssee</code></a>): <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2088"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2089"></a><code class="code"><dfn id="glo:glsxtr at recordsee"><code class="csfmt">\glsxtr at recordsee</code></dfn>{<span class="meta">〈<em class="metainner">label</em>〉</span>}{<span class="meta">〈<em class="metainner">xr list</em>〉</span>}</code></div><!-- end of pinnedbox -->
+{label}{xr list} You can also pick up the commands defined with <a id="wrglossary.2090"></a><a href="#glo:glsxtrnewglslike"><code class="xtrcsfmt">\glsxtrnewglslike</code></a>, which are added to the <a id="wrglossary.2091"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file for <a id="wrglossary.2092"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span>’s</a> benefit: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2093"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2094"></a><code class="code"><dfn id="glo:@glsxtr at newglslike"><code class="csfmt">\@glsxtr at newglslike</code></dfn>{<span class="meta">〈<em class="metainner">label-prefix</em>〉</span>}{<span class="meta">〈<em class="metainner">cs</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ If <a id="wrglossary.2095"></a><a href="#glo:GlsXtrSetAltModifier"><code class="xtrcsfmt">\GlsXtrSetAltModifier</code></a> is used, then the modifier is identified with: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2096"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2097"></a><code class="code"><dfn id="glo:@glsxtr at altmodifier"><code class="csfmt">\@glsxtr at altmodifier</code></dfn>{<span class="meta">〈<em class="metainner">character</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ Label prefixes (for the <a id="wrglossary.2098"></a><a href="#glo:dgls"><code class="xtrcsfmt">\dgls</code></a> set of commands) are identified with: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2099"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2100"></a><code class="code"><dfn id="glo:@glsxtr at prefixlabellist"><code class="csfmt">\@glsxtr at prefixlabellist</code></dfn>{<span class="meta">〈<em class="metainner">list</em>〉</span>}</code></div><!-- end of pinnedbox -->
+<p>
+
+</section><!-- end of section sec:notedev.bib2gls -->
+
+<section id="sec:pkgopts"><!-- start of section sec:pkgopts --><div class="tomain"><a href="#main">[top]</a></div>
+<h1><!-- start of chapter header -->2. Package Options<div class="labellink"><a href="#sec:pkgopts">[link]</a></div></h1><!-- end of chapter header -->
+<p>
+This section describes the available <a id="wrglossary.2101"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package options. You may omit the <code class="code">=true</code> for boolean options. (For example, <a id="wrglossary.2102"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a> is equivalent to <a id="wrglossary.2103"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a><span class="optfmt">=true</span>).<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2104"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.2105"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package has additional options described in the <a id="wrglossary.2106"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> 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 id="wrglossary.2107"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> may have additional package options or new values for existing settings that aren’t listed here. </div><!-- end of information -->
+<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.2108"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+Note that <span class="meta">〈<em class="metainner">key</em>〉</span>=<span class="meta">〈<em class="metainner">value</em>〉</span> package options can’t be passed via the document class options. (This includes options where the <span class="meta">〈<em class="metainner">value</em>〉</span> part may be omitted, such as <a id="wrglossary.2109"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a>.) This is a general limitation not restricted to the <a id="wrglossary.2110"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. Options that aren’t <span class="meta">〈<em class="metainner">key</em>〉</span>=<span class="meta">〈<em class="metainner">value</em>〉</span> (such as <a id="wrglossary.2111"></a><a href="#glo:opt.makeindex"><span class="styoptfmt">makeindex</span></a>) may be passed via the document class options. </div><!-- end of important -->
+<p>
+<p>
+
+</section><!-- end of section sec:pkgopts -->
+
+<section id="sec:pkgopts-general"><!-- start of section sec:pkgopts-general --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->2.1. General Options<div class="labellink"><a href="#sec:pkgopts-general">[link]</a></div></h2><!-- end of section header -->
+<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2112"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2113"></a><code class="code"><dfn id="glo:opt.nowarn"><span class="styoptfmt">nowarn</span></dfn></code></div><!-- end of settingsbox -->
+ This suppresses all warnings generated by the <a id="wrglossary.2114"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. Don’t use this option if you’re new to using <a id="wrglossary.2115"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> as the warnings are designed to help detect common mistakes (such as forgetting to use <a id="wrglossary.2116"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>). Note that if you use <a id="wrglossary.2117"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a> with any value other than <span class="optfmt">false</span> it will override this option.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2118"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2119"></a><code class="code"><dfn id="glo:opt.nolangwarn"><span class="styoptfmt">nolangwarn</span></dfn></code></div><!-- end of settingsbox -->
+ This suppresses the warning generated by a missing language module.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2120"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2121"></a><code class="code"><dfn id="glo:opt.noredefwarn"><span class="styoptfmt">noredefwarn</span></dfn></code></div><!-- end of settingsbox -->
+ If you load <a id="wrglossary.2122"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> with a class or another package that already defines glossary related commands, by default <a id="wrglossary.2123"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> will warn you that it’s redefining those commands. If you are aware of the consequences of using <a id="wrglossary.2124"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> 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 <a id="wrglossary.2125"></a><a href="#glo:opt.nowarn"><span class="styoptfmt">nowarn</span></a> option described above. (This option is automatically switched on by <a id="wrglossary.2126"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.)<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2127"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2128"></a><code class="code"><dfn id="glo:opt.debug"><span class="styoptfmt">debug</span></dfn>=<span class="meta">〈<em class="metainner">value</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>false</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ Debugging mode may write information to the transcript file or add markers to the document. The following values are available: <div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2129"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2130"></a><a id="wrglossary.2131"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a>=<code class="code"><dfn id="glo:optval.debug.false"><span class="optfmt">false</span></dfn></code></div><!-- end of optionvaluebox -->
+ Switches off debugging mode.<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2132"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2133"></a><a id="wrglossary.2134"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a>=<code class="code"><dfn id="glo:optval.debug.true"><span class="optfmt">true</span></dfn></code></div><!-- end of optionvaluebox -->
+ This will write the following line to the transcript file if any attempt at indexing occurs before the associated files have been opened by <a id="wrglossary.2135"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>: <pre class="compactcodebox">wrglossary(<span class="meta">〈<em class="metainner">glossary-type</em>〉</span>)(<span class="meta">〈<em class="metainner">indexing info</em>〉</span>)
+</pre> Note that this setting will also cancel <a id="wrglossary.2136"></a><a href="#glo:opt.nowarn"><span class="styoptfmt">nowarn</span></a>.<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2137"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2138"></a><a id="wrglossary.2139"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a>=<code class="code"><dfn id="glo:optval.debug.showtargets"><span class="optfmt">showtargets</span></dfn></code></div><!-- end of optionvaluebox -->
+ As <a id="wrglossary.2140"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a><span class="optfmt">=</span><a id="wrglossary.2141"></a><a href="#glo:optval.debug.true"><span class="optfmt">true</span></a> but also adds a marker where the <a id="wrglossary.2142"></a><a href="#glo:dual.glossary">glossary</a>-related <a id="wrglossary.2143"></a><a href="#glo:idx.hyperlink">hyperlinks</a> and targets occur in the document.<p>
+The <a id="wrglossary.2144"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a><span class="optfmt">=</span><a id="wrglossary.2145"></a><a href="#glo:optval.debug.showtargets"><span class="optfmt">showtargets</span></a> option will additionally use: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2146"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2147"></a><code class="code"><dfn id="glo:glsshowtarget"><code class="csfmt">\glsshowtarget</code></dfn>{<span class="meta">〈<em class="metainner">target name</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ to show the <a id="wrglossary.2148"></a><a href="#glo:idx.hypertarget">hypertarget</a> or <a id="wrglossary.2149"></a><a href="#glo:idx.hyperlink">hyperlink</a> name when <a id="wrglossary.2150"></a><a href="#glo:glsdohypertarget"><code class="csfmt">\glsdohypertarget</code></a> is used by commands like <a id="wrglossary.2151"></a><a href="#glo:glstarget"><code class="csfmt">\glstarget</code></a> and when <a id="wrglossary.2152"></a><a href="#glo:glsdohyperlink"><code class="csfmt">\glsdohyperlink</code></a> is used by commands like <a id="wrglossary.2153"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>. In <a id="wrglossary.2154"></a><a href="#glo:idx.mathmode">math mode</a> or inner mode, this uses: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2155"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2156"></a><code class="code"><dfn id="glo:glsshowtargetinner"><code class="csfmt">\glsshowtargetinner</code></dfn>{<span class="meta">〈<em class="metainner">target name</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ which typesets the target name as: <pre class="compactcodebox">[<a id="wrglossary.2157"></a><a href="#glo:glsshowtargetfonttext"><code class="csfmt">\glsshowtargetfonttext</code></a>{<span class="meta">〈<em class="metainner">target name</em>〉</span>}]
+</pre> just before the link or anchor. This uses the text-block command: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2158"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2159"></a><code class="code"><dfn id="glo:glsshowtargetfonttext"><code class="csfmt">\glsshowtargetfonttext</code></dfn>{<span class="meta">〈<em class="metainner">text</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ which checks for math-mode before applying the font change. In outer mode <a id="wrglossary.2160"></a><a href="#glo:glsshowtarget"><code class="csfmt">\glsshowtarget</code></a> uses: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2161"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2162"></a><code class="code"><dfn id="glo:glsshowtargetouter"><code class="csfmt">\glsshowtargetouter</code></dfn>{<span class="meta">〈<em class="metainner">target name</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ which by default places the target name in the margin with a symbol produced with: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2163"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2164"></a><code class="code"><dfn id="glo:glsshowtargetsymbol"><code class="csfmt">\glsshowtargetsymbol</code></dfn>{<span class="meta">〈<em class="metainner">target name</em>〉</span>}</code></div><!-- end of pinnedbox -->
+ which defaults to a small right facing triangle.<p>
+The font used by both <a id="wrglossary.2165"></a><a href="#glo:glsshowtargetfonttext"><code class="csfmt">\glsshowtargetfonttext</code></a> and <a id="wrglossary.2166"></a><a href="#glo:glsshowtargetouter"><code class="csfmt">\glsshowtargetouter</code></a> is given by the declaration: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2167"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2168"></a><code class="code"><dfn id="glo:glsshowtargetfont"><code class="csfmt">\glsshowtargetfont</code></dfn></code><span class="floatrightbox"><span class="summarytag">initial: </span><code class="csfmt">\ttfamily</code><code class="csfmt">\footnotesize</code></span><span class="clearfix"></span></div><!-- end of pinnedbox -->
+<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2169"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2170"></a><a id="wrglossary.2171"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a>=<code class="code"><dfn id="glo:optval.debug.showaccsupp"><span class="optfmt">showaccsupp</span></dfn></code></div><!-- end of optionvaluebox -->
+ As <a id="wrglossary.2172"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a><span class="optfmt">=</span><a id="wrglossary.2173"></a><a href="#glo:optval.debug.true"><span class="optfmt">true</span></a> but also adds a marker where the <a id="wrglossary.2174"></a><a href="#glo:dual.glossary">glossary</a>-related accessibility information occurs (see <a id="wrglossary.2175"></a><a href="#glo:pkg.glossaries-accsupp"><span class="styfmt">glossaries-accsupp</span></a>) using: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2176"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2177"></a><code class="code"><dfn id="glo:glsshowaccsupp"><code class="csfmt">\glsshowaccsupp</code></dfn>{<span class="meta">〈<em class="metainner">options</em>〉</span>}{<span class="meta">〈<em class="metainner">PDF element</em>〉</span>}{<span class="meta">〈<em class="metainner">value</em>〉</span>}</code></div><!-- end of pinnedbox -->
+<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2178"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.2179"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package provides extra values <a id="wrglossary.2180"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a><span class="optfmt">=showwrgloss</span>, that may be used to show where the <a id="wrglossary.2181"></a><a href="#glo:dual.indexing">indexing</a> is occurring, and <a id="wrglossary.2182"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a><span class="optfmt">=all</span>, which switches on all debugging options. See the <a id="wrglossary.2183"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> manual for further details. </div><!-- end of information -->
+<p>
+The purpose of the debug mode can be demonstrated with the following example document: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2184"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\documentclass</code>{article}
+<code class="cmd">\usepackage</code>{glossaries}
+<code class="cmd">\newglossaryentry</code>{sample1}{<a id="wrglossary.2185"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sample1}</span>,<a id="wrglossary.2186"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={example}</span>}
+<code class="cmd">\newglossaryentry</code>{sample2}{<a id="wrglossary.2187"></a><a href="#glo:opt.gloskey.name"><span class="csoptfmt">name</span></a><span class="optfmt">={sample2}</span>,<a id="wrglossary.2188"></a><a href="#glo:opt.gloskey.description"><span class="csoptfmt">description</span></a><span class="optfmt">={example}</span>}
+<strong class="strong"><a id="wrglossary.2189"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a></strong>{sample2}<span class="comment">% <- does nothing here</span>
+<strong class="strong"><a id="wrglossary.2190"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a></strong>
+<code class="cbeg">\begin{document}</code>
+<a id="wrglossary.2191"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>{sample1}.
+<a id="wrglossary.2192"></a><a href="#glo:printglossaries"><code class="csfmt">\printglossaries</code></a>
+<code class="cend">\end{document}</code>
+</pre> In this case, only the <span class="qt">“sample1”</span> entry has been <a id="wrglossary.2193"></a><a href="#glo:@@glslabel at indexing">indexed</a>, even though <code class="code"><a id="wrglossary.2194"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a>{sample2}</code> appears in the source code. This is because <code class="code"><a id="wrglossary.2195"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a>{sample2}</code> has been used before the associated file is opened by <a id="wrglossary.2196"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>. Since the file isn’t open yet, the information can’t be written to it, which is why the <span class="qt">“sample2”</span> entry doesn’t appear in the <a id="wrglossary.2197"></a><a href="#glo:dual.glossary">glossary</a>.<p>
+Without <a id="wrglossary.2198"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> the <a id="wrglossary.2199"></a><a href="#glo:dual.indexing">indexing</a> is suppressed with Options <a href="#glo:idx.opt.mkidx">2</a> and <a href="#glo:idx.opt.xdy">3</a> but, other than that, commands like <a id="wrglossary.2200"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> behave as usual.<p>
+This situation doesn’t cause any errors or warnings as it’s perfectly legitimate for a user to want to use <a id="wrglossary.2201"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> to format the entries (for example, to show a different form on <a id="wrglossary.2202"></a><a href="#glo:dual.firstuse">first use</a>) but not display any <a id="wrglossary.2203"></a><a href="#glo:dual.glossary">glossaries</a> (or the user may prefer to use the unsorted Options <a href="#glo:idx.opt.unsrt">5</a> or <a href="#glo:idx.opt.standalone">6</a>). It’s also possible that the user may want to temporarily comment out <a id="wrglossary.2204"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> in order to suppress the <a id="wrglossary.2205"></a><a href="#glo:dual.indexing">indexing</a> while working on a draft version to speed compilation, or the user may prefer to use Options <a href="#glo:idx.opt.noidx">1</a> or <a href="#glo:idx.opt.b2g">4</a> for <a id="wrglossary.2206"></a><a href="#glo:dual.indexing">indexing</a>, which don’t use <a id="wrglossary.2207"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a>.<p>
+Therefore <a id="wrglossary.2208"></a><a href="#glo:makeglossaries"><code class="csfmt">\makeglossaries</code></a> can’t be used to enable <a id="wrglossary.2209"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> and commands like <a id="wrglossary.2210"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> and <a id="wrglossary.2211"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a>. These commands must be enabled by default. (It does, however, enable the <a id="wrglossary.2212"></a><a href="#glo:opt.gloskey.see"><span class="csoptfmt">see</span></a> key as that’s a more common problem. See below.)<p>
+The debug mode, enabled with the <a id="wrglossary.2213"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a> option, <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2214"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.2215"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a>]{glossaries}
+</pre> will write information to the log file when the <a id="wrglossary.2216"></a><a href="#glo:dual.indexing">indexing</a> can’t occur because the associated file isn’t open. The message is written in the form <pre class="transcript"><div class="transcripttitle"><a id="wrglossary.2217"></a><a href="#glo:sym.transcript"><span title="Transcript" class="icon">🔎</span></a></div>Package glossaries Info: wrglossary(<span class="meta">〈<em class="metainner">type</em>〉</span>)(<span class="meta">〈<em class="metainner">text</em>〉</span>) on
+input line <span class="meta">〈<em class="metainner">line number</em>〉</span>.
+</pre> where <span class="meta">〈<em class="metainner">type</em>〉</span> is the glossary label and <span class="meta">〈<em class="metainner">text</em>〉</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 <a id="wrglossary.2218"></a><a href="#glo:glsadd"><code class="csfmt">\glsadd</code></a> or <a id="wrglossary.2219"></a><a href="#glo:glsaddall"><code class="csfmt">\glsaddall</code></a>, try switching on the <a id="wrglossary.2220"></a><a href="#glo:opt.debug"><span class="styoptfmt">debug</span></a> option and see if any information has been written to the log file.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2221"></a><a href="#glo:sym.toggleoffsetting"><span title="Toggle (Off)" class="icon"><span class="fwsdisabledicon">🔘︎</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2222"></a><code class="code"><dfn id="glo:opt.savewrites"><span class="styoptfmt">savewrites</span></dfn>=<span class="meta">〈<em class="metainner">boolean</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span>false</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ This is a boolean option to minimise the number of write registers used by the <a id="wrglossary.2223"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. The default is <a id="wrglossary.2224"></a><a href="#glo:opt.savewrites"><span class="styoptfmt">savewrites</span></a><span class="optfmt">=false</span>. With Options <a href="#glo:idx.opt.mkidx">2</a> and <a href="#glo:idx.opt.xdy">3</a>, one write register is required per (non-ignored) <a id="wrglossary.2225"></a><a href="#glo:dual.glossary">glossary</a> and one for the style file.<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2226"></a><a href="#glo:sym.information"><span title="Information" class="icon">🛈</span></a></div><!-- end of informationtitle -->
+In general, this package option is best avoided. </div><!-- end of information -->
+<p>
+With all options except Options <a href="#glo:idx.opt.noidx">1</a> and <a href="#glo:idx.opt.b2g">4</a>14, another write register is required if the <a id="wrglossary.2227"></a><a href="#glo:ext.glsdefs"><span class="extfmt">glsdefs</span></a> file is needed to save document definitions. With both Options <a href="#glo:idx.opt.noidx">1</a> and <a href="#glo:idx.opt.b2g">4</a>, no write registers are required (document definitions aren’t permitted and <a id="wrglossary.2228"></a><a href="#glo:dual.indexing">indexing</a> information is written to the <a id="wrglossary.2229"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> file). If you really need document definitions but you want to minimise the number of write registers then consider using <a id="wrglossary.2230"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=restricted</span> with <a id="wrglossary.2231"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.<p>
+There are only a limited number of write registers, and if you have a large number of <a id="wrglossary.2232"></a><a href="#glo:dual.glossary">glossaries</a> 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 <a id="wrglossary.2233"></a><a href="#glo:opt.savewrites"><span class="styoptfmt">savewrites</span></a> is set, the <a id="wrglossary.2234"></a><a href="#glo:dual.glossary">glossary</a> information will be stored in token registers until the end of the document when they will be written to the external files.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.2235"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+This option can significantly slow document compilation and may cause the <a id="wrglossary.2236"></a><a href="#glo:dual.indexing">indexing</a> to fail. Page numbers in the <a id="wrglossary.2237"></a><a href="#glo:locationlist">number list</a> will be incorrect on page boundaries due to TeX’s asynchronous output routine. As an alternative, you can use the <a id="wrglossary.2238"></a><a href="#glo:pkg.scrwfile"><span class="styfmt">scrwfile</span></a> package (part of the KOMA-Script bundle) and not use this option. </div><!-- end of important -->
+<p>
+By way of comparison, <span class="filefmt">sample-multi2.tex</span> provided with <a id="wrglossary.2239"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> has a total of 15 <a id="wrglossary.2240"></a><a href="#glo:dual.glossary">glossaries</a>. With Options <a href="#glo:idx.opt.mkidx">2</a> or <a href="#glo:idx.opt.xdy">3</a>, this would require 46 associated files and 16 write registers. (These figures don’t include standard files and registers provided by the kernel or <a id="wrglossary.2241"></a><a href="#glo:pkg.hyperref"><span class="styfmt">hyperref</span></a>, such as <a id="wrglossary.2242"></a><a href="#glo:ext.aux"><span class="extfmt">aux</span></a> and <span class="filefmt">out</span>.) With <a id="wrglossary.2243"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></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>
+<div class="important"><div class="importanttitle"><a id="wrglossary.2244"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+If you want to use TeX’s <a id="wrglossary.2245"></a><a href="#glo:dual.shellescape">shell escape</a> to call <a id="wrglossary.2246"></a><a href="#glo:app.makeindex"><span class="appfmt">makeindex</span></a> or <a id="wrglossary.2247"></a><a href="#glo:app.xindy"><span class="appfmt">xindy</span></a> from your document and use <a id="wrglossary.2248"></a><a href="#glo:opt.savewrites"><span class="styoptfmt">savewrites</span></a>, then use <a id="wrglossary.2249"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a><span class="optfmt">=</span><a id="wrglossary.2250"></a><a href="#glo:optval.automake.immediate"><span class="optfmt">immediate</span></a> or <a id="wrglossary.2251"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a><span class="optfmt">=</span><a id="wrglossary.2252"></a><a href="#glo:optval.automake.makegloss"><span class="optfmt">makegloss</span></a> or <a id="wrglossary.2253"></a><a href="#glo:opt.automake"><span class="styoptfmt">automake</span></a><span class="optfmt">=</span><a id="wrglossary.2254"></a><a href="#glo:optval.automake.lite"><span class="optfmt">lite</span></a>. </div><!-- end of important -->
+<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2255"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2256"></a><code class="code"><dfn id="glo:opt.translate"><span class="styoptfmt">translate</span></dfn>=<span class="meta">〈<em class="metainner">value</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span><span class="initvalnotefmt"><em class="initvalnotefmtinner">varies</em></span></span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ This can take one of the values listed below. If no supported language package has been loaded the default is <a id="wrglossary.2257"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2258"></a><a href="#glo:optval.translate.false"><span class="optfmt">false</span></a> otherwise the default is <a id="wrglossary.2259"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2260"></a><a href="#glo:optval.translate.true"><span class="optfmt">true</span></a> for the base <a id="wrglossary.2261"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package and <a id="wrglossary.2262"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2263"></a><a href="#glo:optval.translate.babel"><span class="optfmt">babel</span></a> for <a id="wrglossary.2264"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2265"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2266"></a><a id="wrglossary.2267"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a>=<code class="code"><dfn id="glo:optval.translate.true"><span class="optfmt">true</span></dfn></code></div><!-- end of optionvaluebox -->
+ If <a id="wrglossary.2268"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> has been loaded and the <a id="wrglossary.2269"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package is installed, <a id="wrglossary.2270"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> will be loaded and the translations will be provided by the <a id="wrglossary.2271"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package interface. You can modify the translations by providing your own dictionary. If the <a id="wrglossary.2272"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package isn’t installed and <a id="wrglossary.2273"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> is loaded, the <a id="wrglossary.2274"></a><a href="#glo:pkg.glossaries-babel"><span class="styfmt">glossaries-babel</span></a> package will be loaded and the translations will be provided using <a id="wrglossary.2275"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span>’s</a> <code class="csfmt">\addto</code><a id="wrglossary.2276"></a><a href="#glo:captionslanguage"><code class="csfmt">\captions<span class="meta">〈<em class="metainner">language</em>〉</span></code></a> mechanism. If <a id="wrglossary.2277"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a> has been loaded, <a id="wrglossary.2278"></a><a href="#glo:pkg.glossaries-polyglossia"><span class="styfmt">glossaries-polyglossia</span></a> will be loaded.<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2279"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2280"></a><a id="wrglossary.2281"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a>=<code class="code"><dfn id="glo:optval.translate.false"><span class="optfmt">false</span></dfn></code></div><!-- end of optionvaluebox -->
+ Don’t provide translations, even if <a id="wrglossary.2282"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> or <a id="wrglossary.2283"></a><a href="#glo:pkg.polyglossia"><span class="styfmt">polyglossia</span></a> has been loaded. (Note that <a id="wrglossary.2284"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> provides the command <a id="wrglossary.2285"></a><a href="#glo:glossaryname"><code class="csfmt">\glossaryname</code></a> so that will still be translated if you have loaded <a id="wrglossary.2286"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a>.)<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2287"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2288"></a><a id="wrglossary.2289"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a>=<code class="code"><dfn id="glo:optval.translate.babel"><span class="optfmt">babel</span></dfn></code></div><!-- end of optionvaluebox -->
+ Don’t load the <a id="wrglossary.2290"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> package. Instead load <a id="wrglossary.2291"></a><a href="#glo:pkg.glossaries-babel"><span class="styfmt">glossaries-babel</span></a>.<p>
+<div class="important"><div class="importanttitle"><a id="wrglossary.2292"></a><a href="#glo:sym.important"><span title="Important" class="icon">ℹ</span></a></div><!-- end of importanttitle -->
+I recommend you use <a id="wrglossary.2293"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2294"></a><a href="#glo:optval.translate.babel"><span class="optfmt">babel</span></a> if you have any problems with the translations or with <a id="wrglossary.2295"></a><a href="#glo:idx.PDFbookmark">PDF bookmarks</a>, but to maintain backward compatibility, if <a id="wrglossary.2296"></a><a href="#glo:pkg.babel"><span class="styfmt">babel</span></a> has been loaded the default is <a id="wrglossary.2297"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2298"></a><a href="#glo:optval.translate.true"><span class="optfmt">true</span></a>. </div><!-- end of important -->
+<p>
+See §<a href="#sec:fixednames">1.5.1</a> for further details.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2299"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2300"></a><code class="code"><dfn id="glo:opt.notranslate"><span class="styoptfmt">notranslate</span></dfn></code></div><!-- end of settingsbox -->
+ This is equivalent to <a id="wrglossary.2301"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2302"></a><a href="#glo:optval.translate.false"><span class="optfmt">false</span></a> and may be passed via the document class options.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2303"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2304"></a><code class="code"><dfn id="glo:opt.languages"><span class="styoptfmt">languages</span></dfn></code></div><!-- end of settingsbox -->
+ This automatically implements <a id="wrglossary.2305"></a><a href="#glo:opt.translate"><span class="styoptfmt">translate</span></a><span class="optfmt">=</span><a id="wrglossary.2306"></a><a href="#glo:optval.translate.babel"><span class="optfmt">babel</span></a> (which means that <a id="wrglossary.2307"></a><a href="#glo:pkg.translator"><span class="styfmt">translator</span></a> won’t automatically be loaded) but will also add the list of languages to <a id="wrglossary.2308"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span>’s</a> list of tracked languages. Each element in the <span class="meta">〈<em class="metainner">list</em>〉</span> may be an ISO language tag (such as <code class="code">pt-BR</code>) or one of <a id="wrglossary.2309"></a><a href="#glo:pkg.tracklang"><span class="styfmt">tracklang</span>’s</a> known language labels (such as <code class="code">british</code>).<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2310"></a><a href="#glo:sym.toggleonsetting"><span title="Toggle (On)" class="icon"><span class="fwsactiveicon">🔘</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2311"></a><code class="code"><dfn id="glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></dfn>=<span class="meta">〈<em class="metainner">boolean</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span>true</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ If true, terms on <a id="wrglossary.2312"></a><a href="#glo:dual.firstuse">first use</a> will have a <a id="wrglossary.2313"></a><a href="#glo:idx.hyperlink">hyperlink</a>, if supported, unless the <a id="wrglossary.2314"></a><a href="#glo:idx.hyperlink">hyperlink</a> is explicitly suppressed using starred versions of commands such as <code class="code"><a id="wrglossary.2315"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>*</code>. If false, only <a id="wrglossary.2316"></a><a href="#glo:dual.subsequentuse">subsequent use</a> instances will have a <a id="wrglossary.2317"></a><a href="#glo:idx.hyperlink">hyperlink</a> (if supported).<p>
+Note that <a id="wrglossary.2318"></a><a href="#glo:opt.nohypertypes"><span class="styoptfmt">nohypertypes</span></a> overrides <a id="wrglossary.2319"></a><a href="#glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></a><span class="optfmt">=true</span>. This option only affects commands that check the <a id="wrglossary.2320"></a><a href="#glo:dual.firstuseflag">first use flag</a>, such as the <a id="wrglossary.2321"></a><a href="#glo:glslike"><code class="csfmt">\gls</code>-like</a> commands (for example, <a id="wrglossary.2322"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a> or <a id="wrglossary.2323"></a><a href="#glo:glsdisp"><code class="csfmt">\glsdisp</code></a>), but not the <a id="wrglossary.2324"></a><a href="#glo:glstextlike"><code class="csfmt">\glstext</code>-like</a> commands (for example, <a id="wrglossary.2325"></a><a href="#glo:glslink"><code class="csfmt">\glslink</code></a> or <a id="wrglossary.2326"></a><a href="#glo:glstext"><code class="csfmt">\glstext</code></a>). <p>
+The <a id="wrglossary.2327"></a><a href="#glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></a> setting applies to all <a id="wrglossary.2328"></a><a href="#glo:dual.glossary">glossary</a> types (unless identified by <a id="wrglossary.2329"></a><a href="#glo:opt.nohypertypes"><span class="styoptfmt">nohypertypes</span></a> or defined with <a id="wrglossary.2330"></a><a href="#glo:newignoredglossary"><code class="csfmt">\newignoredglossary</code></a>). It can be overridden on an individual basis by explicitly setting the <a id="wrglossary.2331"></a><a href="#glo:opt.glsopt.hyper"><span class="csoptfmt">hyper</span></a> key when referencing an entry (or by using the plus or starred version of the referencing command).<p>
+It may be that you only want to suppress <a id="wrglossary.2332"></a><a href="#glo:idx.hyperlink">hyperlinks</a> for just the <a id="wrglossary.2333"></a><a href="#glo:idx.acronym">acronyms</a> (where the <a id="wrglossary.2334"></a><a href="#glo:dual.firstuse">first use</a> explains the meaning of the <a id="wrglossary.2335"></a><a href="#glo:idx.acronym">acronym</a>) but not for ordinary <a id="wrglossary.2336"></a><a href="#glo:idx.glossaryentry">glossary entries</a> (where the <a id="wrglossary.2337"></a><a href="#glo:dual.firstuse">first use</a> is identical to <a id="wrglossary.2338"></a><a href="#glo:dual.subsequentuse">subsequent use</a>). In this case, you can use <a id="wrglossary.2339"></a><a href="#glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></a><span class="optfmt">=false</span> and apply <a id="wrglossary.2340"></a><a href="#glo:glsunsetall"><code class="csfmt">\glsunsetall</code></a> to all the regular (non-<a id="wrglossary.2341"></a><a href="#glo:idx.acronym">acronym</a>) <a id="wrglossary.2342"></a><a href="#glo:dual.glossary">glossaries</a>. For example: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2343"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\usepackage</code>[<a id="wrglossary.2344"></a><a href="#glo:opt.acronym"><span class="styoptfmt">acronym</span></a>,<a id="wrglossary.2345"></a><a href="#glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></a><span class="optfmt">=false</span>]{glossaries}
+<span class="comment">% <a id="wrglossary.2346"></a><a href="#glo:idx.acronym">acronym</a> and <a id="wrglossary.2347"></a><a href="#glo:idx.glossaryentry">glossary entry</a> definitions</span>
+
+<span class="comment">% at the end of the preamble</span>
+<a id="wrglossary.2348"></a><a href="#glo:glsunsetall"><code class="csfmt">\glsunsetall</code></a>[<a id="wrglossary.2349"></a><a href="#glo:opt.glostype.main"><code class="glostypefmt">main</code></a>]
+</pre><p>
+Alternatively you can redefine the hook <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2350"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2351"></a><code class="code"><dfn id="glo:glslinkcheckfirsthyperhook"><code class="csfmt">\glslinkcheckfirsthyperhook</code></dfn></code></div><!-- end of pinnedbox -->
+ which is used by the commands that check the <a id="wrglossary.2352"></a><a href="#glo:dual.firstuseflag">first use flag</a>, such as <a id="wrglossary.2353"></a><a href="#glo:gls"><code class="csfmt">\gls</code></a>. Within the definition of this command, you can use <a id="wrglossary.2354"></a><a href="#glo:glslabel"><code class="csfmt">\glslabel</code></a> to reference the <a id="wrglossary.2355"></a><a href="#glo:idx.glossaryentry">entry</a> label and <a id="wrglossary.2356"></a><a href="#glo:glstype"><code class="csfmt">\glstype</code></a> to reference the <a id="wrglossary.2357"></a><a href="#glo:dual.glossary">glossary</a> type. You can also use <a id="wrglossary.2358"></a><a href="#glo:ifglsused"><code class="csfmt">\ifglsused</code></a> to determine if the <a id="wrglossary.2359"></a><a href="#glo:idx.glossaryentry">entry</a> has been used. You can test if an <a id="wrglossary.2360"></a><a href="#glo:idx.glossaryentry">entry</a> is an <a id="wrglossary.2361"></a><a href="#glo:idx.acronym">acronym</a> by checking if it has the <a id="wrglossary.2362"></a><a href="#glo:opt.gloskey.long"><span class="csoptfmt">long</span></a> key set using <a id="wrglossary.2363"></a><a href="#glo:ifglshaslong"><code class="csfmt">\ifglshaslong</code></a> (or if the <a id="wrglossary.2364"></a><a href="#glo:opt.gloskey.short"><span class="csoptfmt">short</span></a> key has been set using <a id="wrglossary.2365"></a><a href="#glo:ifglshasshort"><code class="csfmt">\ifglshasshort</code></a>). For example, to switch off the <a id="wrglossary.2366"></a><a href="#glo:idx.hyperlink">hyperlink</a> on <a id="wrglossary.2367"></a><a href="#glo:dual.firstuse">first use</a> just for <a id="wrglossary.2368"></a><a href="#glo:idx.acronym">acronyms</a>: <pre class="codebox"><div class="codeboxtitle"><a id="wrglossary.2369"></a><a href="#glo:sym.code"><span title="Input" class="icon">🖹</span></a></div><code class="cmd">\renewcommand</code>*{<a id="wrglossary.2370"></a><a href="#glo:glslinkcheckfirsthyperhook"><code class="cs!
fmt">\glslinkcheckfirsthyperhook</code></a>}{<span class="comment">% </span>
+ <a id="wrglossary.2371"></a><a href="#glo:ifglsused"><code class="csfmt">\ifglsused</code></a>{<a id="wrglossary.2372"></a><a href="#glo:glslabel"><code class="csfmt">\glslabel</code></a>}{}<span class="comment">% </span>
+ {<span class="comment">% </span>
+ <a id="wrglossary.2373"></a><a href="#glo:ifglshaslong"><code class="csfmt">\ifglshaslong</code></a>{<a id="wrglossary.2374"></a><a href="#glo:glslabel"><code class="csfmt">\glslabel</code></a>}{<code class="cmd">\setkeys</code>{glslink}{<a id="wrglossary.2375"></a><a href="#glo:opt.glsopt.hyper"><span class="csoptfmt">hyper</span></a><span class="optfmt">=false</span>}}<span class="comment">% </span>
+ }<span class="comment">% </span>
+}
+</pre><p>
+Note that this hook isn’t used by the commands that don’t check the <a id="wrglossary.2376"></a><a href="#glo:dual.firstuseflag">first use flag</a>, such as <a id="wrglossary.2377"></a><a href="#glo:glstext"><code class="csfmt">\glstext</code></a>. (You can, instead, redefine <a id="wrglossary.2378"></a><a href="#glo:glslinkpostsetkeys"><code class="csfmt">\glslinkpostsetkeys</code></a>, which is used by both the <a id="wrglossary.2379"></a><a href="#glo:glslike"><code class="csfmt">\gls</code>-like</a> and <a id="wrglossary.2380"></a><a href="#glo:glstextlike"><code class="csfmt">\glstext</code>-like</a> commands.)<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2381"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a></div><!-- end of informationtitle -->
+ The <a id="wrglossary.2382"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> package provides a method of disabling the <a id="wrglossary.2383"></a><a href="#glo:dual.firstuse">first use</a> <a id="wrglossary.2384"></a><a href="#glo:idx.hyperlink">hyperlink</a> according to the <a id="wrglossary.2385"></a><a href="#glo:idx.glossaryentry">entry’s</a> associated <a id="wrglossary.2386"></a><a href="#glo:opt.gloskey.category"><span class="xtrcsoptfmt">category</span></a>. For example, if you only want to switch off the <a id="wrglossary.2387"></a><a href="#glo:dual.firstuse">first use</a> hyperlink for <a id="wrglossary.2388"></a><a href="#glo:idx.abbreviation"><span class="xtrfmt">abbreviations</span></a> then you simply need to set the <a id="wrglossary.2389"></a><a href="#glo:opt.catattr.nohyperfirst"><span class="csoptfmt">nohyperfirst</span></a> <a id="wrglossary.2390"></a><a href="#glo:@@glslabel at categoryattribute">attribute</a> for the <a id="wrglossary.2391"></a><a href="#glo:opt.cat.abbreviation"><span class="catfmt">abbreviation</span></a> and, if appropriate, <a id="wrglossary.2392"></a><a href="#glo:opt.cat.acronym"><span class="catfmt">acronym</span></a> categories. (Instead of using the <a id="wrglossary.2393"></a><a href="#glo:opt.hyperfirst"><span class="styoptfmt">hyperfirst</span></a> package option.) See the <a id="wrglossary.2394"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> manual for further details. </div><!-- end of information -->
+<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2395"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2396"></a><code class="code"><dfn id="glo:opt.writeglslabels"><span class="styoptfmt">writeglslabels</span></dfn></code></div><!-- end of settingsbox -->
+ This option will create a file called <code class="code"><a id="wrglossary.2397"></a><a href="#glo:jobname"><code class="csfmt">\jobname</code></a>.<a id="wrglossary.2398"></a><a href="#glo:ext.glslabels"><span class="extfmt">glslabels</span></a></code> at the end of the document. This file simply contains a list of all defined entry labels (including those in any <a id="wrglossary.2399"></a><a href="#glo:dual.ignoredglossary">ignored glossaries</a>). It’s provided for the benefit of text editors that need to know labels for <a id="wrglossary.2400"></a><a href="#glo:idx.auto-completion">auto-completion</a>. If you also want the name, use <a id="wrglossary.2401"></a><a href="#glo:opt.writeglslabelnames"><span class="styoptfmt">writeglslabelnames</span></a>. (See also <a id="wrglossary.2402"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span>’s</a> <a id="wrglossary.2403"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=atom</span> package option.)<p>
+<div class="information"><div class="informationtitle"><a id="wrglossary.2404"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a></div><!-- end of informationtitle -->
+ Note that with <a id="wrglossary.2405"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> the file will only contain the entries that <a id="wrglossary.2406"></a><a href="#glo:app.bib2gls"><span class="appfmt">bib2gls</span></a> has selected from the <a id="wrglossary.2407"></a><a href="#glo:ext.bib"><span class="extfmt">bib</span></a> files. </div><!-- end of information -->
+<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2408"></a><a href="#glo:sym.novaluesetting"><span title="Valueless Setting" class="icon">𝍢</span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2409"></a><code class="code"><dfn id="glo:opt.writeglslabelnames"><span class="styoptfmt">writeglslabelnames</span></dfn></code></div><!-- end of settingsbox -->
+ Similar to <a id="wrglossary.2410"></a><a href="#glo:opt.writeglslabels"><span class="styoptfmt">writeglslabels</span></a> but writes both the label and name (separated by a tab).<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2411"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2412"></a><code class="code"><dfn id="glo:opt.undefaction"><span class="xtrstyoptfmt">undefaction</span></dfn>=<span class="meta">〈<em class="metainner">value</em>〉</span></code><span class="floatrightbox"><span class="summarytag">initial: </span>error</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+<p>
+Only available with <a id="wrglossary.2413"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>, the value for this option may be one of:<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2414"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2415"></a><a id="wrglossary.2416"></a><a href="#glo:opt.undefaction"><span class="xtrstyoptfmt">undefaction</span></a>=<code class="code"><dfn id="glo:optval.undefaction.error"><span class="xtroptfmt">error</span></dfn></code></div><!-- end of optionvaluebox -->
+ Generates an error if a referenced entry is undefined (default, and the only available setting with just the base <a id="wrglossary.2417"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package).<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2418"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2419"></a><a id="wrglossary.2420"></a><a href="#glo:opt.undefaction"><span class="xtrstyoptfmt">undefaction</span></a>=<code class="code"><dfn id="glo:optval.undefaction.warn"><span class="xtroptfmt">warn</span></dfn></code></div><!-- end of optionvaluebox -->
+ Only warns if a referenced entry is undefined (automatically activated with <a id="wrglossary.2421"></a><a href="#glo:idx.opt.b2g">Option 4</a>).<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2422"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2423"></a><code class="code"><dfn id="glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></dfn>=<span class="meta">〈<em class="metainner">value</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span>false</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+<p>
+Only available with <a id="wrglossary.2424"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>, this option governs the use of <a id="wrglossary.2425"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a>. Available values:<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2426"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2427"></a><a id="wrglossary.2428"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a>=<code class="code"><dfn id="glo:optval.docdef.false"><span class="xtroptfmt">false</span></dfn></code></div><!-- end of optionvaluebox -->
+ This setting means that <a id="wrglossary.2429"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> is not permitted in the <a id="wrglossary.2430"></a><a href="#glo:env.document"><span class="envfmt">document</span></a> environment (default with <a id="wrglossary.2431"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a> and for <a id="wrglossary.2432"></a><a href="#glo:idx.opt.noidx">Option 1</a> with just the base <a id="wrglossary.2433"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package).<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2434"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2435"></a><a id="wrglossary.2436"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a>=<code class="code"><dfn id="glo:optval.docdef.restricted"><span class="xtroptfmt">restricted</span></dfn></code></div><!-- end of optionvaluebox -->
+ This setting means that <a id="wrglossary.2437"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> is only permitted in the <a id="wrglossary.2438"></a><a href="#glo:env.document"><span class="envfmt">document</span></a> environment if it occurs before <a id="wrglossary.2439"></a><a href="#glo:printglossary"><code class="csfmt">\printglossary</code></a> (not available for some indexing options, such as Option <a href="#glo:idx.opt.b2g">4</a>).<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2440"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2441"></a><a id="wrglossary.2442"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a>=<code class="code"><dfn id="glo:optval.docdef.atom"><span class="xtroptfmt">atom</span></dfn></code></div><!-- end of optionvaluebox -->
+ This setting is as <a id="wrglossary.2443"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=</span><a id="wrglossary.2444"></a><a href="#glo:optval.docdef.restricted"><span class="xtroptfmt">restricted</span></a> but creates the <a id="wrglossary.2445"></a><a href="#glo:ext.glsdefs"><span class="extfmt">glsdefs</span></a> file for use by <a id="wrglossary.2446"></a><a href="#glo:app.atom"><span class="appfmt">atom</span></a> (without the limitations of <a id="wrglossary.2447"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a><span class="optfmt">=</span><a id="wrglossary.2448"></a><a href="#glo:optval.docdef.true"><span class="xtroptfmt">true</span></a>).<p>
+<div class="optionvaluebox"><div class="optionvalueboxtitle"><a id="wrglossary.2449"></a><a href="#glo:sym.optionvalue"><span title="Option Value Definition" class="icon">🔖</span></a></div><!-- end of optionvalueboxtitle -->
+<a id="wrglossary.2450"></a><a id="wrglossary.2451"></a><a href="#glo:opt.docdef"><span class="xtrstyoptfmt">docdef</span></a>=<code class="code"><dfn id="glo:optval.docdef.true"><span class="xtroptfmt">true</span></dfn></code></div><!-- end of optionvaluebox -->
+ This setting means that <a id="wrglossary.2452"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> is permitted in the <a id="wrglossary.2453"></a><a href="#glo:env.document"><span class="envfmt">document</span></a> environment where it would normally be permitted by the base <a id="wrglossary.2454"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package. This will create the <a id="wrglossary.2455"></a><a href="#glo:ext.glsdefs"><span class="extfmt">glsdefs</span></a> file if <a id="wrglossary.2456"></a><a href="#glo:newglossaryentry"><code class="csfmt">\newglossaryentry</code></a> is found in the <a id="wrglossary.2457"></a><a href="#glo:env.document"><span class="envfmt">document</span></a> environment.<p>
+
+</section><!-- end of section sec:pkgopts-general -->
+
+<section id="sec:pkgopts-sec"><!-- start of section sec:pkgopts-sec --><div class="tomain"><a href="#main">[top]</a></div>
+<h2><!-- start of section header -->2.2. Sectioning, Headings and TOC Options<div class="labellink"><a href="#sec:pkgopts-sec">[link]</a></div></h2><!-- end of section header -->
+<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2458"></a><a href="#glo:sym.toggleoffsetting"><span title="Toggle (Off)" class="icon"><span class="fwsdisabledicon">🔘︎</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2459"></a><code class="code"><dfn id="glo:opt.toc"><span class="styoptfmt">toc</span></dfn>=<span class="meta">〈<em class="metainner">boolean</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span><span class="initvalnotefmt"><em class="initvalnotefmtinner">varies</em></span></span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ Adds the <a id="wrglossary.2460"></a><a href="#glo:dual.glossary">glossaries</a> to the <a id="wrglossary.2461"></a><a href="#glo:idx.tableofcontents">table of contents</a> (<a id="wrglossary.2462"></a><a href="#glo:ext.toc"><span class="extfmt">toc</span></a> file). Note that an extra LaTeX run is required with this option. Alternatively, you can switch this function on and off using <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2463"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2464"></a><code class="code"><dfn id="glo:glstoctrue"><code class="csfmt">\glstoctrue</code></dfn></code></div><!-- end of pinnedbox -->
+ and <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2465"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2466"></a><code class="code"><dfn id="glo:glstocfalse"><code class="csfmt">\glstocfalse</code></dfn></code></div><!-- end of pinnedbox -->
+ You can test whether or not this option is set using: <div class="pinnedbox"><div class="pinnedboxtitle"><a id="wrglossary.2467"></a><a href="#glo:sym.definition"><span title="Definition" class="icon">📌</span></a></div><!-- end of pinnedboxtitle -->
+<a id="wrglossary.2468"></a><code class="code"><dfn id="glo:ifglstoc"><code class="csfmt">\ifglstoc</code></dfn> <span class="meta">〈<em class="metainner">true</em>〉</span><code class="csfmt">\else</code> <span class="meta">〈<em class="metainner">false</em>〉</span><code class="csfmt">\fi</code></code><span class="floatrightbox"><span class="summarytag">initial: </span><code class="csfmt">\iffalse</code></span><span class="clearfix"></span></div><!-- end of pinnedbox -->
+ The default value is <a id="wrglossary.2469"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a><span class="optfmt">=false</span> for the base <a id="wrglossary.2470"></a><a href="#glo:pkg.glossaries"><span class="styfmt">glossaries</span></a> package and <a id="wrglossary.2471"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a><span class="optfmt">=true</span> for <a id="wrglossary.2472"></a><a href="#glo:pkg.glossaries-extra"><span class="styfmt">glossaries-extra</span></a>.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2473"></a><a href="#glo:sym.toggleoffsetting"><span title="Toggle (Off)" class="icon"><span class="fwsdisabledicon">🔘︎</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2474"></a><code class="code"><dfn id="glo:opt.numberline"><span class="styoptfmt">numberline</span></dfn>=<span class="meta">〈<em class="metainner">boolean</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>true; <span class="summarytag">initial: </span>false</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ When used with <a id="wrglossary.2475"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a><span class="optfmt">=true</span> option, this will add <code class="code"><a id="wrglossary.2476"></a><a href="#glo:numberline"><code class="csfmt">\numberline</code></a>{}</code> in the final argument of <a id="wrglossary.2477"></a><a href="#glo:addcontentsline"><code class="csfmt">\addcontentsline</code></a>. This will align the <a id="wrglossary.2478"></a><a href="#glo:idx.tableofcontents">table of contents</a> entry with the numbered section titles. Note that this option has no effect with <a id="wrglossary.2479"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a><span class="optfmt">=false</span>. If <a id="wrglossary.2480"></a><a href="#glo:opt.toc"><span class="styoptfmt">toc</span></a><span class="optfmt">=true</span> is used without <a id="wrglossary.2481"></a><a href="#glo:opt.numberline"><span class="styoptfmt">numberline</span></a>, the <a id="wrglossary.2482"></a><a href="#glo:dual.glossary">glossary</a> title will be aligned with the section numbers rather than the section titles.<p>
+<div class="settingsbox"><div class="settingsboxtitle"><a id="wrglossary.2483"></a><a href="#glo:sym.valuesetting"><span title="Setting" class="icon"><span class="quarterleft">🎚</span></span></a></div><!-- end of settingsboxtitle -->
+<a id="wrglossary.2484"></a><code class="code"><dfn id="glo:opt.section"><span class="styoptfmt">section</span></dfn>=<span class="meta">〈<em class="metainner">name</em>〉</span></code><span class="floatrightbox"><span class="summarytag">default: </span>section</span><span class="clearfix"></span></div><!-- end of settingsbox -->
+ <p>
+This option indicates the sectional unit to use for the <a id="wrglossary.2485"></a><a href="#glo:dual.glossary">glossary</a>. The value <span class="meta">〈<em class="metainner">name</em>〉</span> should be the control sequence <span style="font-style: italic; font-variant: normal; ">name</span> without the leading backslash or following star (for example, just <code class="code">chapter</code> not <a id="wrglossary.2486"></a><a href="#glo:chapter"><code class="csfmt">\chapter</code></a> or <code class="code">chapter*</code>).<p>
+The default behaviour is for the glossary heading to use <a id="wrglossary.2487"></a><a href="#glo:chapter"><code class="csfmt">\chapter</code></a>, if that command exists, or <a id="wrglossary.2488"></a><a href="#glo:section"><code class="csfmt">\section</code></a> otherwise. The starred or unstarred form is determined by the <a id="wrglossary.2489"></a><a href="#glo:opt.numberedsection"><span class="styoptfmt">numberedsection</span></a> option.<p>
@@ Diff output truncated at 1234567 characters. @@
More information about the tex-live-commits
mailing list.